Annotation of loncom/interface/loncommon.pm, revision 1.790
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.790 ! droeschl 4: # $Id: loncommon.pm,v 1.789 2009/04/21 18:03:45 droeschl 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.787 bisitz 605: return '<span class="LC_nobreak">'
606: ."<a href='"
607: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
608: .'","'.$udomele.'","'.$desc.'","'.$extra_element
609: .'","'.$multflag.'","'.$selecttype.'");'
610: ."'>".&mt('Select Course').'</a>'
611: .'</span>';
1.74 www 612: }
1.42 matthew 613:
1.653 raeburn 614: sub selectauthor_link {
615: my ($form,$udom)=@_;
616: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
617: &mt('Select Author').'</a>';
618: }
619:
1.273 raeburn 620: sub check_uncheck_jscript {
621: my $jscript = <<"ENDSCRT";
622: function checkAll(field) {
623: if (field.length > 0) {
624: for (i = 0; i < field.length; i++) {
625: field[i].checked = true ;
626: }
627: } else {
628: field.checked = true
629: }
630: }
631:
632: function uncheckAll(field) {
633: if (field.length > 0) {
634: for (i = 0; i < field.length; i++) {
635: field[i].checked = false ;
1.543 albertel 636: }
637: } else {
1.273 raeburn 638: field.checked = false ;
639: }
640: }
641: ENDSCRT
642: return $jscript;
643: }
644:
1.656 www 645: sub select_timezone {
1.659 raeburn 646: my ($name,$selected,$onchange,$includeempty)=@_;
647: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
648: if ($includeempty) {
649: $output .= '<option value=""';
650: if (($selected eq '') || ($selected eq 'local')) {
651: $output .= ' selected="selected" ';
652: }
653: $output .= '> </option>';
654: }
1.657 raeburn 655: my @timezones = DateTime::TimeZone->all_names;
656: foreach my $tzone (@timezones) {
657: $output.= '<option value="'.$tzone.'"';
658: if ($tzone eq $selected) {
659: $output.=' selected="selected"';
660: }
661: $output.=">$tzone</option>\n";
1.656 www 662: }
663: $output.="</select>";
664: return $output;
665: }
1.273 raeburn 666:
1.687 raeburn 667: sub select_datelocale {
668: my ($name,$selected,$onchange,$includeempty)=@_;
669: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
670: if ($includeempty) {
671: $output .= '<option value=""';
672: if ($selected eq '') {
673: $output .= ' selected="selected" ';
674: }
675: $output .= '> </option>';
676: }
677: my (@possibles,%locale_names);
678: my @locales = DateTime::Locale::Catalog::Locales;
679: foreach my $locale (@locales) {
680: if (ref($locale) eq 'HASH') {
681: my $id = $locale->{'id'};
682: if ($id ne '') {
683: my $en_terr = $locale->{'en_territory'};
684: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 685: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 686: if (grep(/^en$/,@languages) || !@languages) {
687: if ($en_terr ne '') {
688: $locale_names{$id} = '('.$en_terr.')';
689: } elsif ($native_terr ne '') {
690: $locale_names{$id} = $native_terr;
691: }
692: } else {
693: if ($native_terr ne '') {
694: $locale_names{$id} = $native_terr.' ';
695: } elsif ($en_terr ne '') {
696: $locale_names{$id} = '('.$en_terr.')';
697: }
698: }
699: push (@possibles,$id);
700: }
701: }
702: }
703: foreach my $item (sort(@possibles)) {
704: $output.= '<option value="'.$item.'"';
705: if ($item eq $selected) {
706: $output.=' selected="selected"';
707: }
708: $output.=">$item";
709: if ($locale_names{$item} ne '') {
710: $output.=" $locale_names{$item}</option>\n";
711: }
712: $output.="</option>\n";
713: }
714: $output.="</select>";
715: return $output;
716: }
717:
1.42 matthew 718: =pod
1.36 matthew 719:
1.648 raeburn 720: =item * &linked_select_forms(...)
1.36 matthew 721:
722: linked_select_forms returns a string containing a <script></script> block
723: and html for two <select> menus. The select menus will be linked in that
724: changing the value of the first menu will result in new values being placed
725: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 726: order unless a defined order is provided.
1.36 matthew 727:
728: linked_select_forms takes the following ordered inputs:
729:
730: =over 4
731:
1.112 bowersj2 732: =item * $formname, the name of the <form> tag
1.36 matthew 733:
1.112 bowersj2 734: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 735:
1.112 bowersj2 736: =item * $firstdefault, the default value for the first menu
1.36 matthew 737:
1.112 bowersj2 738: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 739:
1.112 bowersj2 740: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 741:
1.112 bowersj2 742: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 743:
1.609 raeburn 744: =item * $menuorder, the order of values in the first menu
745:
1.41 ng 746: =back
747:
1.36 matthew 748: Below is an example of such a hash. Only the 'text', 'default', and
749: 'select2' keys must appear as stated. keys(%menu) are the possible
750: values for the first select menu. The text that coincides with the
1.41 ng 751: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 752: and text for the second menu are given in the hash pointed to by
753: $menu{$choice1}->{'select2'}.
754:
1.112 bowersj2 755: my %menu = ( A1 => { text =>"Choice A1" ,
756: default => "B3",
757: select2 => {
758: B1 => "Choice B1",
759: B2 => "Choice B2",
760: B3 => "Choice B3",
761: B4 => "Choice B4"
1.609 raeburn 762: },
763: order => ['B4','B3','B1','B2'],
1.112 bowersj2 764: },
765: A2 => { text =>"Choice A2" ,
766: default => "C2",
767: select2 => {
768: C1 => "Choice C1",
769: C2 => "Choice C2",
770: C3 => "Choice C3"
1.609 raeburn 771: },
772: order => ['C2','C1','C3'],
1.112 bowersj2 773: },
774: A3 => { text =>"Choice A3" ,
775: default => "D6",
776: select2 => {
777: D1 => "Choice D1",
778: D2 => "Choice D2",
779: D3 => "Choice D3",
780: D4 => "Choice D4",
781: D5 => "Choice D5",
782: D6 => "Choice D6",
783: D7 => "Choice D7"
1.609 raeburn 784: },
785: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 786: }
787: );
1.36 matthew 788:
789: =cut
790:
791: sub linked_select_forms {
792: my ($formname,
793: $middletext,
794: $firstdefault,
795: $firstselectname,
796: $secondselectname,
1.609 raeburn 797: $hashref,
798: $menuorder,
1.36 matthew 799: ) = @_;
800: my $second = "document.$formname.$secondselectname";
801: my $first = "document.$formname.$firstselectname";
802: # output the javascript to do the changing
803: my $result = '';
1.776 bisitz 804: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.36 matthew 805: $result.="var select2data = new Object();\n";
806: $" = '","';
807: my $debug = '';
808: foreach my $s1 (sort(keys(%$hashref))) {
809: $result.="select2data.d_$s1 = new Object();\n";
810: $result.="select2data.d_$s1.def = new String('".
811: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 812: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 813: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 814: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
815: @s2values = @{$hashref->{$s1}->{'order'}};
816: }
1.36 matthew 817: $result.="\"@s2values\");\n";
818: $result.="select2data.d_$s1.texts = new Array(";
819: my @s2texts;
820: foreach my $value (@s2values) {
821: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
822: }
823: $result.="\"@s2texts\");\n";
824: }
825: $"=' ';
826: $result.= <<"END";
827:
828: function select1_changed() {
829: // Determine new choice
830: var newvalue = "d_" + $first.value;
831: // update select2
832: var values = select2data[newvalue].values;
833: var texts = select2data[newvalue].texts;
834: var select2def = select2data[newvalue].def;
835: var i;
836: // out with the old
837: for (i = 0; i < $second.options.length; i++) {
838: $second.options[i] = null;
839: }
840: // in with the nuclear
841: for (i=0;i<values.length; i++) {
842: $second.options[i] = new Option(values[i]);
1.143 matthew 843: $second.options[i].value = values[i];
1.36 matthew 844: $second.options[i].text = texts[i];
845: if (values[i] == select2def) {
846: $second.options[i].selected = true;
847: }
848: }
849: }
850: </script>
851: END
852: # output the initial values for the selection lists
853: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 854: my @order = sort(keys(%{$hashref}));
855: if (ref($menuorder) eq 'ARRAY') {
856: @order = @{$menuorder};
857: }
858: foreach my $value (@order) {
1.36 matthew 859: $result.=" <option value=\"$value\" ";
1.253 albertel 860: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 861: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 862: }
863: $result .= "</select>\n";
864: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
865: $result .= $middletext;
866: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
867: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 868:
869: my @secondorder = sort(keys(%select2));
870: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
871: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
872: }
873: foreach my $value (@secondorder) {
1.36 matthew 874: $result.=" <option value=\"$value\" ";
1.253 albertel 875: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 876: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 877: }
878: $result .= "</select>\n";
879: # return $debug;
880: return $result;
881: } # end of sub linked_select_forms {
882:
1.45 matthew 883: =pod
1.44 bowersj2 884:
1.648 raeburn 885: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44 bowersj2 886:
1.112 bowersj2 887: Returns a string corresponding to an HTML link to the given help
888: $topic, where $topic corresponds to the name of a .tex file in
889: /home/httpd/html/adm/help/tex, with underscores replaced by
890: spaces.
891:
892: $text will optionally be linked to the same topic, allowing you to
893: link text in addition to the graphic. If you do not want to link
894: text, but wish to specify one of the later parameters, pass an
895: empty string.
896:
897: $stayOnPage is a value that will be interpreted as a boolean. If true,
898: the link will not open a new window. If false, the link will open
899: a new window using Javascript. (Default is false.)
900:
901: $width and $height are optional numerical parameters that will
902: override the width and height of the popped up window, which may
903: be useful for certain help topics with big pictures included.
1.44 bowersj2 904:
905: =cut
906:
907: sub help_open_topic {
1.48 bowersj2 908: my ($topic, $text, $stayOnPage, $width, $height) = @_;
909: $text = "" if (not defined $text);
1.44 bowersj2 910: $stayOnPage = 0 if (not defined $stayOnPage);
1.552 banghart 911: if ($env{'browser.interface'} eq 'textual') {
1.79 www 912: $stayOnPage=1;
913: }
1.44 bowersj2 914: $width = 350 if (not defined $width);
915: $height = 400 if (not defined $height);
916: my $filename = $topic;
917: $filename =~ s/ /_/g;
918:
1.48 bowersj2 919: my $template = "";
920: my $link;
1.572 banghart 921:
1.159 www 922: $topic=~s/\W/\_/g;
1.44 bowersj2 923:
1.572 banghart 924: if (!$stayOnPage) {
1.72 bowersj2 925: $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 926: } else {
1.48 bowersj2 927: $link = "/adm/help/${filename}.hlp";
928: }
929:
930: # Add the text
1.755 neumanie 931: if ($text ne "") {
1.763 bisitz 932: $template.='<span class="LC_help_open_topic">'
933: .'<a target="_top" href="'.$link.'">'
934: .$text.'</a>';
1.48 bowersj2 935: }
936:
1.763 bisitz 937: # (Always) Add the graphic
1.179 matthew 938: my $title = &mt('Online Help');
1.667 raeburn 939: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763 bisitz 940: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
941: .'<img src="'.$helpicon.'" border="0"'
942: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.783 amueller 943: .' title="'.$title.'"'
1.763 bisitz 944: .' /></a>';
945: if ($text ne "") {
946: $template.='</span>';
947: }
1.44 bowersj2 948: return $template;
949:
1.106 bowersj2 950: }
951:
952: # This is a quicky function for Latex cheatsheet editing, since it
953: # appears in at least four places
954: sub helpLatexCheatsheet {
1.732 raeburn 955: my ($topic,$text,$not_author) = @_;
956: my $out;
1.106 bowersj2 957: my $addOther = '';
1.732 raeburn 958: if ($topic) {
1.763 bisitz 959: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
960: undef, undef, 600).
961: '</span> ';
962: }
963: $out = '<span>' # Start cheatsheet
964: .$addOther
965: .'<span>'
966: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
967: undef,undef,600)
968: .'</span> <span>'
969: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
970: undef,undef,600)
971: .'</span>';
1.732 raeburn 972: unless ($not_author) {
1.763 bisitz 973: $out .= ' <span>'
974: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
975: undef,undef,600)
976: .'</span>';
1.732 raeburn 977: }
1.763 bisitz 978: $out .= '</span>'; # End cheatsheet
1.732 raeburn 979: return $out;
1.172 www 980: }
981:
1.430 albertel 982: sub general_help {
983: my $helptopic='Student_Intro';
984: if ($env{'request.role'}=~/^(ca|au)/) {
985: $helptopic='Authoring_Intro';
986: } elsif ($env{'request.role'}=~/^cc/) {
987: $helptopic='Course_Coordination_Intro';
1.672 raeburn 988: } elsif ($env{'request.role'}=~/^dc/) {
989: $helptopic='Domain_Coordination_Intro';
1.430 albertel 990: }
991: return $helptopic;
992: }
993:
994: sub update_help_link {
995: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
996: my $origurl = $ENV{'REQUEST_URI'};
997: $origurl=~s|^/~|/priv/|;
998: my $timestamp = time;
999: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1000: $$datum = &escape($$datum);
1001: }
1002:
1003: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1004: my $output .= <<"ENDOUTPUT";
1005: <script type="text/javascript">
1006: banner_link = '$banner_link';
1007: </script>
1008: ENDOUTPUT
1009: return $output;
1010: }
1011:
1012: # now just updates the help link and generates a blue icon
1.193 raeburn 1013: sub help_open_menu {
1.430 albertel 1014: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1015: = @_;
1.430 albertel 1016: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 1017: # only use pop-up help (stayOnPage == 0)
1.552 banghart 1018: # if environment.remote is on (using remote control UI)
1.572 banghart 1019: if ($env{'browser.interface'} eq 'textual' ||
1020: $env{'environment.remote'} eq 'off' ) {
1.552 banghart 1021: $stayOnPage=1;
1.430 albertel 1022: }
1023: my $output;
1024: if ($component_help) {
1025: if (!$text) {
1026: $output=&help_open_topic($component_help,undef,$stayOnPage,
1027: $width,$height);
1028: } else {
1029: my $help_text;
1030: $help_text=&unescape($topic);
1031: $output='<table><tr><td>'.
1032: &help_open_topic($component_help,$help_text,$stayOnPage,
1033: $width,$height).'</td></tr></table>';
1034: }
1035: }
1036: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1037: return $output.$banner_link;
1038: }
1039:
1040: sub top_nav_help {
1041: my ($text) = @_;
1.436 albertel 1042: $text = &mt($text);
1.572 banghart 1043: my $stay_on_page =
1.436 albertel 1044: ($env{'browser.interface'} eq 'textual' ||
1045: $env{'environment.remote'} eq 'off' );
1.572 banghart 1046: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1047: : "javascript:helpMenu('open')";
1.572 banghart 1048: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1049:
1.201 raeburn 1050: my $title = &mt('Get help');
1.436 albertel 1051:
1052: return <<"END";
1053: $banner_link
1054: <a href="$link" title="$title">$text</a>
1055: END
1056: }
1057:
1058: sub help_menu_js {
1059: my ($text) = @_;
1060:
1061: my $stayOnPage =
1062: ($env{'browser.interface'} eq 'textual' ||
1063: $env{'environment.remote'} eq 'off' );
1064:
1065: my $width = 620;
1066: my $height = 600;
1.430 albertel 1067: my $helptopic=&general_help();
1068: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1069: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1070: my $start_page =
1071: &Apache::loncommon::start_page('Help Menu', undef,
1072: {'frameset' => 1,
1073: 'js_ready' => 1,
1074: 'add_entries' => {
1075: 'border' => '0',
1.579 raeburn 1076: 'rows' => "110,*",},});
1.331 albertel 1077: my $end_page =
1078: &Apache::loncommon::end_page({'frameset' => 1,
1079: 'js_ready' => 1,});
1080:
1.436 albertel 1081: my $template .= <<"ENDTEMPLATE";
1082: <script type="text/javascript">
1.253 albertel 1083: // <!-- BEGIN LON-CAPA Internal
1084: // <![CDATA[
1.430 albertel 1085: var banner_link = '';
1.243 raeburn 1086: function helpMenu(target) {
1087: var caller = this;
1088: if (target == 'open') {
1089: var newWindow = null;
1090: try {
1.262 albertel 1091: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1092: }
1093: catch(error) {
1094: writeHelp(caller);
1095: return;
1096: }
1097: if (newWindow) {
1098: caller = newWindow;
1099: }
1.193 raeburn 1100: }
1.243 raeburn 1101: writeHelp(caller);
1102: return;
1103: }
1104: function writeHelp(caller) {
1.430 albertel 1105: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1106: caller.document.close()
1107: caller.focus()
1.193 raeburn 1108: }
1.253 albertel 1109: // ]]>
1.219 albertel 1110: // END LON-CAPA Internal -->
1.436 albertel 1111: </script>
1.193 raeburn 1112: ENDTEMPLATE
1113: return $template;
1114: }
1115:
1.172 www 1116: sub help_open_bug {
1117: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1118: unless ($env{'user.adv'}) { return ''; }
1.172 www 1119: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1120: $text = "" if (not defined $text);
1121: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1122: if ($env{'browser.interface'} eq 'textual' ||
1123: $env{'environment.remote'} eq 'off' ) {
1.172 www 1124: $stayOnPage=1;
1125: }
1.184 albertel 1126: $width = 600 if (not defined $width);
1127: $height = 600 if (not defined $height);
1.172 www 1128:
1129: $topic=~s/\W+/\+/g;
1130: my $link='';
1131: my $template='';
1.379 albertel 1132: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1133: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1134: if (!$stayOnPage)
1135: {
1136: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1137: }
1138: else
1139: {
1140: $link = $url;
1141: }
1142: # Add the text
1143: if ($text ne "")
1144: {
1145: $template .=
1146: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1147: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1148: }
1149:
1150: # Add the graphic
1.179 matthew 1151: my $title = &mt('Report a Bug');
1.215 albertel 1152: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1153: $template .= <<"ENDTEMPLATE";
1.436 albertel 1154: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1155: ENDTEMPLATE
1156: if ($text ne '') { $template.='</td></tr></table>' };
1157: return $template;
1158:
1159: }
1160:
1161: sub help_open_faq {
1162: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1163: unless ($env{'user.adv'}) { return ''; }
1.172 www 1164: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1165: $text = "" if (not defined $text);
1166: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1167: if ($env{'browser.interface'} eq 'textual' ||
1168: $env{'environment.remote'} eq 'off' ) {
1.172 www 1169: $stayOnPage=1;
1170: }
1171: $width = 350 if (not defined $width);
1172: $height = 400 if (not defined $height);
1173:
1174: $topic=~s/\W+/\+/g;
1175: my $link='';
1176: my $template='';
1177: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1178: if (!$stayOnPage)
1179: {
1180: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1181: }
1182: else
1183: {
1184: $link = $url;
1185: }
1186:
1187: # Add the text
1188: if ($text ne "")
1189: {
1190: $template .=
1.173 www 1191: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1192: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1193: }
1194:
1195: # Add the graphic
1.179 matthew 1196: my $title = &mt('View the FAQ');
1.215 albertel 1197: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1198: $template .= <<"ENDTEMPLATE";
1.436 albertel 1199: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1200: ENDTEMPLATE
1201: if ($text ne '') { $template.='</td></tr></table>' };
1202: return $template;
1203:
1.44 bowersj2 1204: }
1.37 matthew 1205:
1.180 matthew 1206: ###############################################################
1207: ###############################################################
1208:
1.45 matthew 1209: =pod
1210:
1.648 raeburn 1211: =item * &change_content_javascript():
1.256 matthew 1212:
1213: This and the next function allow you to create small sections of an
1214: otherwise static HTML page that you can update on the fly with
1215: Javascript, even in Netscape 4.
1216:
1217: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1218: must be written to the HTML page once. It will prove the Javascript
1219: function "change(name, content)". Calling the change function with the
1220: name of the section
1221: you want to update, matching the name passed to C<changable_area>, and
1222: the new content you want to put in there, will put the content into
1223: that area.
1224:
1225: B<Note>: Netscape 4 only reserves enough space for the changable area
1226: to contain room for the original contents. You need to "make space"
1227: for whatever changes you wish to make, and be B<sure> to check your
1228: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1229: it's adequate for updating a one-line status display, but little more.
1230: This script will set the space to 100% width, so you only need to
1231: worry about height in Netscape 4.
1232:
1233: Modern browsers are much less limiting, and if you can commit to the
1234: user not using Netscape 4, this feature may be used freely with
1235: pretty much any HTML.
1236:
1237: =cut
1238:
1239: sub change_content_javascript {
1240: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1241: if ($env{'browser.type'} eq 'netscape' &&
1242: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1243: return (<<NETSCAPE4);
1244: function change(name, content) {
1245: doc = document.layers[name+"___escape"].layers[0].document;
1246: doc.open();
1247: doc.write(content);
1248: doc.close();
1249: }
1250: NETSCAPE4
1251: } else {
1252: # Otherwise, we need to use semi-standards-compliant code
1253: # (technically, "innerHTML" isn't standard but the equivalent
1254: # is really scary, and every useful browser supports it
1255: return (<<DOMBASED);
1256: function change(name, content) {
1257: element = document.getElementById(name);
1258: element.innerHTML = content;
1259: }
1260: DOMBASED
1261: }
1262: }
1263:
1264: =pod
1265:
1.648 raeburn 1266: =item * &changable_area($name,$origContent):
1.256 matthew 1267:
1268: This provides a "changable area" that can be modified on the fly via
1269: the Javascript code provided in C<change_content_javascript>. $name is
1270: the name you will use to reference the area later; do not repeat the
1271: same name on a given HTML page more then once. $origContent is what
1272: the area will originally contain, which can be left blank.
1273:
1274: =cut
1275:
1276: sub changable_area {
1277: my ($name, $origContent) = @_;
1278:
1.258 albertel 1279: if ($env{'browser.type'} eq 'netscape' &&
1280: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1281: # If this is netscape 4, we need to use the Layer tag
1282: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1283: } else {
1284: return "<span id='$name'>$origContent</span>";
1285: }
1286: }
1287:
1288: =pod
1289:
1.648 raeburn 1290: =item * &viewport_geometry_js
1.590 raeburn 1291:
1292: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1293:
1294: =cut
1295:
1296:
1297: sub viewport_geometry_js {
1298: return <<"GEOMETRY";
1299: var Geometry = {};
1300: function init_geometry() {
1301: if (Geometry.init) { return };
1302: Geometry.init=1;
1303: if (window.innerHeight) {
1304: Geometry.getViewportHeight = function() { return window.innerHeight; };
1305: Geometry.getViewportWidth = function() { return window.innerWidth; };
1306: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1307: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1308: }
1309: else if (document.documentElement && document.documentElement.clientHeight) {
1310: Geometry.getViewportHeight =
1311: function() { return document.documentElement.clientHeight; };
1312: Geometry.getViewportWidth =
1313: function() { return document.documentElement.clientWidth; };
1314:
1315: Geometry.getHorizontalScroll =
1316: function() { return document.documentElement.scrollLeft; };
1317: Geometry.getVerticalScroll =
1318: function() { return document.documentElement.scrollTop; };
1319: }
1320: else if (document.body.clientHeight) {
1321: Geometry.getViewportHeight =
1322: function() { return document.body.clientHeight; };
1323: Geometry.getViewportWidth =
1324: function() { return document.body.clientWidth; };
1325: Geometry.getHorizontalScroll =
1326: function() { return document.body.scrollLeft; };
1327: Geometry.getVerticalScroll =
1328: function() { return document.body.scrollTop; };
1329: }
1330: }
1331:
1332: GEOMETRY
1333: }
1334:
1335: =pod
1336:
1.648 raeburn 1337: =item * &viewport_size_js()
1.590 raeburn 1338:
1339: 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.
1340:
1341: =cut
1342:
1343: sub viewport_size_js {
1344: my $geometry = &viewport_geometry_js();
1345: return <<"DIMS";
1346:
1347: $geometry
1348:
1349: function getViewportDims(width,height) {
1350: init_geometry();
1351: width.value = Geometry.getViewportWidth();
1352: height.value = Geometry.getViewportHeight();
1353: return;
1354: }
1355:
1356: DIMS
1357: }
1358:
1359: =pod
1360:
1.648 raeburn 1361: =item * &resize_textarea_js()
1.565 albertel 1362:
1363: emits the needed javascript to resize a textarea to be as big as possible
1364:
1365: creates a function resize_textrea that takes two IDs first should be
1366: the id of the element to resize, second should be the id of a div that
1367: surrounds everything that comes after the textarea, this routine needs
1368: to be attached to the <body> for the onload and onresize events.
1369:
1.648 raeburn 1370: =back
1.565 albertel 1371:
1372: =cut
1373:
1374: sub resize_textarea_js {
1.590 raeburn 1375: my $geometry = &viewport_geometry_js();
1.565 albertel 1376: return <<"RESIZE";
1377: <script type="text/javascript">
1.590 raeburn 1378: $geometry
1.565 albertel 1379:
1.588 albertel 1380: function getX(element) {
1381: var x = 0;
1382: while (element) {
1383: x += element.offsetLeft;
1384: element = element.offsetParent;
1385: }
1386: return x;
1387: }
1388: function getY(element) {
1389: var y = 0;
1390: while (element) {
1391: y += element.offsetTop;
1392: element = element.offsetParent;
1393: }
1394: return y;
1395: }
1396:
1397:
1.565 albertel 1398: function resize_textarea(textarea_id,bottom_id) {
1399: init_geometry();
1400: var textarea = document.getElementById(textarea_id);
1401: //alert(textarea);
1402:
1.588 albertel 1403: var textarea_top = getY(textarea);
1.565 albertel 1404: var textarea_height = textarea.offsetHeight;
1405: var bottom = document.getElementById(bottom_id);
1.588 albertel 1406: var bottom_top = getY(bottom);
1.565 albertel 1407: var bottom_height = bottom.offsetHeight;
1408: var window_height = Geometry.getViewportHeight();
1.588 albertel 1409: var fudge = 23;
1.565 albertel 1410: var new_height = window_height-fudge-textarea_top-bottom_height;
1411: if (new_height < 300) {
1412: new_height = 300;
1413: }
1414: textarea.style.height=new_height+'px';
1415: }
1416: </script>
1417: RESIZE
1418:
1419: }
1420:
1421: =pod
1422:
1.256 matthew 1423: =head1 Excel and CSV file utility routines
1424:
1425: =over 4
1426:
1427: =cut
1428:
1429: ###############################################################
1430: ###############################################################
1431:
1432: =pod
1433:
1.648 raeburn 1434: =item * &csv_translate($text)
1.37 matthew 1435:
1.185 www 1436: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1437: format.
1438:
1439: =cut
1440:
1.180 matthew 1441: ###############################################################
1442: ###############################################################
1.37 matthew 1443: sub csv_translate {
1444: my $text = shift;
1445: $text =~ s/\"/\"\"/g;
1.209 albertel 1446: $text =~ s/\n/ /g;
1.37 matthew 1447: return $text;
1448: }
1.180 matthew 1449:
1450: ###############################################################
1451: ###############################################################
1452:
1453: =pod
1454:
1.648 raeburn 1455: =item * &define_excel_formats()
1.180 matthew 1456:
1457: Define some commonly used Excel cell formats.
1458:
1459: Currently supported formats:
1460:
1461: =over 4
1462:
1463: =item header
1464:
1465: =item bold
1466:
1467: =item h1
1468:
1469: =item h2
1470:
1471: =item h3
1472:
1.256 matthew 1473: =item h4
1474:
1475: =item i
1476:
1.180 matthew 1477: =item date
1478:
1479: =back
1480:
1481: Inputs: $workbook
1482:
1483: Returns: $format, a hash reference.
1484:
1485: =cut
1486:
1487: ###############################################################
1488: ###############################################################
1489: sub define_excel_formats {
1490: my ($workbook) = @_;
1491: my $format;
1492: $format->{'header'} = $workbook->add_format(bold => 1,
1493: bottom => 1,
1494: align => 'center');
1495: $format->{'bold'} = $workbook->add_format(bold=>1);
1496: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1497: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1498: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1499: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1500: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1501: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1502: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1503: return $format;
1504: }
1505:
1506: ###############################################################
1507: ###############################################################
1.113 bowersj2 1508:
1509: =pod
1510:
1.648 raeburn 1511: =item * &create_workbook()
1.255 matthew 1512:
1513: Create an Excel worksheet. If it fails, output message on the
1514: request object and return undefs.
1515:
1516: Inputs: Apache request object
1517:
1518: Returns (undef) on failure,
1519: Excel worksheet object, scalar with filename, and formats
1520: from &Apache::loncommon::define_excel_formats on success
1521:
1522: =cut
1523:
1524: ###############################################################
1525: ###############################################################
1526: sub create_workbook {
1527: my ($r) = @_;
1528: #
1529: # Create the excel spreadsheet
1530: my $filename = '/prtspool/'.
1.258 albertel 1531: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1532: time.'_'.rand(1000000000).'.xls';
1533: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1534: if (! defined($workbook)) {
1535: $r->log_error("Error creating excel spreadsheet $filename: $!");
1536: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1537: "This error has been logged. ".
1538: "Please alert your LON-CAPA administrator").
1539: '</p>');
1540: return (undef);
1541: }
1542: #
1543: $workbook->set_tempdir('/home/httpd/perl/tmp');
1544: #
1545: my $format = &Apache::loncommon::define_excel_formats($workbook);
1546: return ($workbook,$filename,$format);
1547: }
1548:
1549: ###############################################################
1550: ###############################################################
1551:
1552: =pod
1553:
1.648 raeburn 1554: =item * &create_text_file()
1.113 bowersj2 1555:
1.542 raeburn 1556: Create a file to write to and eventually make available to the user.
1.256 matthew 1557: If file creation fails, outputs an error message on the request object and
1558: return undefs.
1.113 bowersj2 1559:
1.256 matthew 1560: Inputs: Apache request object, and file suffix
1.113 bowersj2 1561:
1.256 matthew 1562: Returns (undef) on failure,
1563: Filehandle and filename on success.
1.113 bowersj2 1564:
1565: =cut
1566:
1.256 matthew 1567: ###############################################################
1568: ###############################################################
1569: sub create_text_file {
1570: my ($r,$suffix) = @_;
1571: if (! defined($suffix)) { $suffix = 'txt'; };
1572: my $fh;
1573: my $filename = '/prtspool/'.
1.258 albertel 1574: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1575: time.'_'.rand(1000000000).'.'.$suffix;
1576: $fh = Apache::File->new('>/home/httpd'.$filename);
1577: if (! defined($fh)) {
1578: $r->log_error("Couldn't open $filename for output $!");
1.683 bisitz 1579: $r->print(&mt('Problems occurred in creating the output file. '
1580: .'This error has been logged. '
1581: .'Please alert your LON-CAPA administrator.'));
1.113 bowersj2 1582: }
1.256 matthew 1583: return ($fh,$filename)
1.113 bowersj2 1584: }
1585:
1586:
1.256 matthew 1587: =pod
1.113 bowersj2 1588:
1589: =back
1590:
1591: =cut
1.37 matthew 1592:
1593: ###############################################################
1.33 matthew 1594: ## Home server <option> list generating code ##
1595: ###############################################################
1.35 matthew 1596:
1.169 www 1597: # ------------------------------------------
1598:
1599: sub domain_select {
1600: my ($name,$value,$multiple)=@_;
1601: my %domains=map {
1.514 albertel 1602: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1603: } &Apache::lonnet::all_domains();
1.169 www 1604: if ($multiple) {
1605: $domains{''}=&mt('Any domain');
1.550 albertel 1606: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1607: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1608: } else {
1.550 albertel 1609: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1610: return &select_form($name,$value,%domains);
1611: }
1612: }
1613:
1.282 albertel 1614: #-------------------------------------------
1615:
1616: =pod
1617:
1.519 raeburn 1618: =head1 Routines for form select boxes
1619:
1620: =over 4
1621:
1.648 raeburn 1622: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1623:
1624: Returns a string containing a <select> element int multiple mode
1625:
1626:
1627: Args:
1628: $name - name of the <select> element
1.506 raeburn 1629: $value - scalar or array ref of values that should already be selected
1.282 albertel 1630: $size - number of rows long the select element is
1.283 albertel 1631: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1632: (shown text should already have been &mt())
1.506 raeburn 1633: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1634:
1.282 albertel 1635: =cut
1636:
1637: #-------------------------------------------
1.169 www 1638: sub multiple_select_form {
1.284 albertel 1639: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1640: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1641: my $output='';
1.191 matthew 1642: if (! defined($size)) {
1643: $size = 4;
1.283 albertel 1644: if (scalar(keys(%$hash))<4) {
1645: $size = scalar(keys(%$hash));
1.191 matthew 1646: }
1647: }
1.734 bisitz 1648: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1649: my @order;
1.506 raeburn 1650: if (ref($order) eq 'ARRAY') {
1651: @order = @{$order};
1652: } else {
1653: @order = sort(keys(%$hash));
1.501 banghart 1654: }
1655: if (exists($$hash{'select_form_order'})) {
1656: @order = @{$$hash{'select_form_order'}};
1657: }
1658:
1.284 albertel 1659: foreach my $key (@order) {
1.356 albertel 1660: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1661: $output.='selected="selected" ' if ($selected{$key});
1662: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1663: }
1664: $output.="</select>\n";
1665: return $output;
1666: }
1667:
1.88 www 1668: #-------------------------------------------
1669:
1670: =pod
1671:
1.648 raeburn 1672: =item * &select_form($defdom,$name,%hash)
1.88 www 1673:
1674: Returns a string containing a <select name='$name' size='1'> form to
1675: allow a user to select options from a hash option_name => displayed text.
1676: See lonrights.pm for an example invocation and use.
1677:
1678: =cut
1679:
1680: #-------------------------------------------
1681: sub select_form {
1682: my ($def,$name,%hash) = @_;
1683: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1684: my @keys;
1685: if (exists($hash{'select_form_order'})) {
1686: @keys=@{$hash{'select_form_order'}};
1687: } else {
1688: @keys=sort(keys(%hash));
1689: }
1.356 albertel 1690: foreach my $key (@keys) {
1691: $selectform.=
1692: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1693: ($key eq $def ? 'selected="selected" ' : '').
1694: ">".&mt($hash{$key})."</option>\n";
1.88 www 1695: }
1696: $selectform.="</select>";
1697: return $selectform;
1698: }
1699:
1.475 www 1700: # For display filters
1701:
1702: sub display_filter {
1703: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1704: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1705: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1706: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1707: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1708: '</label></span> <span class="LC_nobreak">'.
1.475 www 1709: &mt('Filter [_1]',
1.477 www 1710: &select_form($env{'form.displayfilter'},
1711: 'displayfilter',
1712: ('currentfolder' => 'Current folder/page',
1713: 'containing' => 'Containing phrase',
1714: 'none' => 'None'))).
1.714 bisitz 1715: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1716: }
1717:
1.167 www 1718: sub gradeleveldescription {
1719: my $gradelevel=shift;
1720: my %gradelevels=(0 => 'Not specified',
1721: 1 => 'Grade 1',
1722: 2 => 'Grade 2',
1723: 3 => 'Grade 3',
1724: 4 => 'Grade 4',
1725: 5 => 'Grade 5',
1726: 6 => 'Grade 6',
1727: 7 => 'Grade 7',
1728: 8 => 'Grade 8',
1729: 9 => 'Grade 9',
1730: 10 => 'Grade 10',
1731: 11 => 'Grade 11',
1732: 12 => 'Grade 12',
1733: 13 => 'Grade 13',
1734: 14 => '100 Level',
1735: 15 => '200 Level',
1736: 16 => '300 Level',
1737: 17 => '400 Level',
1738: 18 => 'Graduate Level');
1739: return &mt($gradelevels{$gradelevel});
1740: }
1741:
1.163 www 1742: sub select_level_form {
1743: my ($deflevel,$name)=@_;
1744: unless ($deflevel) { $deflevel=0; }
1.167 www 1745: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1746: for (my $i=0; $i<=18; $i++) {
1747: $selectform.="<option value=\"$i\" ".
1.253 albertel 1748: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1749: ">".&gradeleveldescription($i)."</option>\n";
1750: }
1751: $selectform.="</select>";
1752: return $selectform;
1.163 www 1753: }
1.167 www 1754:
1.35 matthew 1755: #-------------------------------------------
1756:
1.45 matthew 1757: =pod
1758:
1.743 raeburn 1759: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$autosubmit)
1.35 matthew 1760:
1761: Returns a string containing a <select name='$name' size='1'> form to
1762: allow a user to select the domain to preform an operation in.
1763: See loncreateuser.pm for an example invocation and use.
1764:
1.90 www 1765: If the $includeempty flag is set, it also includes an empty choice ("no domain
1766: selected");
1767:
1.743 raeburn 1768: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1769:
1770: If the $autosubmit flag is set, the form containing the domain selector will be auto-submitted by an onchange action.
1.563 raeburn 1771:
1.35 matthew 1772: =cut
1773:
1774: #-------------------------------------------
1.34 matthew 1775: sub select_dom_form {
1.743 raeburn 1776: my ($defdom,$name,$includeempty,$showdomdesc,$autosubmit) = @_;
1777: my $onchange;
1778: if ($autosubmit) {
1779: $onchange = ' onchange="this.form.submit()"';
1780: }
1.550 albertel 1781: my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90 www 1782: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1783: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1784: foreach my $dom (@domains) {
1785: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1786: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1787: if ($showdomdesc) {
1788: if ($dom ne '') {
1789: my $domdesc = &Apache::lonnet::domain($dom,'description');
1790: if ($domdesc ne '') {
1791: $selectdomain .= ' ('.$domdesc.')';
1792: }
1793: }
1794: }
1795: $selectdomain .= "</option>\n";
1.34 matthew 1796: }
1797: $selectdomain.="</select>";
1798: return $selectdomain;
1799: }
1800:
1.35 matthew 1801: #-------------------------------------------
1802:
1.45 matthew 1803: =pod
1804:
1.648 raeburn 1805: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1806:
1.586 raeburn 1807: input: 4 arguments (two required, two optional) -
1808: $domain - domain of new user
1809: $name - name of form element
1810: $default - Value of 'default' causes a default item to be first
1811: option, and selected by default.
1812: $hide - Value of 'hide' causes hiding of the name of the server,
1813: if 1 server found, or default, if 0 found.
1.594 raeburn 1814: output: returns 2 items:
1.586 raeburn 1815: (a) form element which contains either:
1816: (i) <select name="$name">
1817: <option value="$hostid1">$hostid $servers{$hostid}</option>
1818: <option value="$hostid2">$hostid $servers{$hostid}</option>
1819: </select>
1820: form item if there are multiple library servers in $domain, or
1821: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
1822: if there is only one library server in $domain.
1823:
1824: (b) number of library servers found.
1825:
1826: See loncreateuser.pm for example of use.
1.35 matthew 1827:
1828: =cut
1829:
1830: #-------------------------------------------
1.586 raeburn 1831: sub home_server_form_item {
1832: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 1833: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 1834: my $result;
1835: my $numlib = keys(%servers);
1836: if ($numlib > 1) {
1837: $result .= '<select name="'.$name.'" />'."\n";
1838: if ($default) {
1839: $result .= '<option value="default" selected>'.&mt('default').
1840: '</option>'."\n";
1841: }
1842: foreach my $hostid (sort(keys(%servers))) {
1843: $result.= '<option value="'.$hostid.'">'.
1844: $hostid.' '.$servers{$hostid}."</option>\n";
1845: }
1846: $result .= '</select>'."\n";
1847: } elsif ($numlib == 1) {
1848: my $hostid;
1849: foreach my $item (keys(%servers)) {
1850: $hostid = $item;
1851: }
1852: $result .= '<input type="hidden" name="'.$name.'" value="'.
1853: $hostid.'" />';
1854: if (!$hide) {
1855: $result .= $hostid.' '.$servers{$hostid};
1856: }
1857: $result .= "\n";
1858: } elsif ($default) {
1859: $result .= '<input type="hidden" name="'.$name.
1860: '" value="default" />';
1861: if (!$hide) {
1862: $result .= &mt('default');
1863: }
1864: $result .= "\n";
1.33 matthew 1865: }
1.586 raeburn 1866: return ($result,$numlib);
1.33 matthew 1867: }
1.112 bowersj2 1868:
1869: =pod
1870:
1.534 albertel 1871: =back
1872:
1.112 bowersj2 1873: =cut
1.87 matthew 1874:
1875: ###############################################################
1.112 bowersj2 1876: ## Decoding User Agent ##
1.87 matthew 1877: ###############################################################
1878:
1879: =pod
1880:
1.112 bowersj2 1881: =head1 Decoding the User Agent
1882:
1883: =over 4
1884:
1885: =item * &decode_user_agent()
1.87 matthew 1886:
1887: Inputs: $r
1888:
1889: Outputs:
1890:
1891: =over 4
1892:
1.112 bowersj2 1893: =item * $httpbrowser
1.87 matthew 1894:
1.112 bowersj2 1895: =item * $clientbrowser
1.87 matthew 1896:
1.112 bowersj2 1897: =item * $clientversion
1.87 matthew 1898:
1.112 bowersj2 1899: =item * $clientmathml
1.87 matthew 1900:
1.112 bowersj2 1901: =item * $clientunicode
1.87 matthew 1902:
1.112 bowersj2 1903: =item * $clientos
1.87 matthew 1904:
1905: =back
1906:
1.157 matthew 1907: =back
1908:
1.87 matthew 1909: =cut
1910:
1911: ###############################################################
1912: ###############################################################
1913: sub decode_user_agent {
1.247 albertel 1914: my ($r)=@_;
1.87 matthew 1915: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
1916: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
1917: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 1918: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 1919: my $clientbrowser='unknown';
1920: my $clientversion='0';
1921: my $clientmathml='';
1922: my $clientunicode='0';
1923: for (my $i=0;$i<=$#browsertype;$i++) {
1924: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
1925: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
1926: $clientbrowser=$bname;
1927: $httpbrowser=~/$vreg/i;
1928: $clientversion=$1;
1929: $clientmathml=($clientversion>=$minv);
1930: $clientunicode=($clientversion>=$univ);
1931: }
1932: }
1933: my $clientos='unknown';
1934: if (($httpbrowser=~/linux/i) ||
1935: ($httpbrowser=~/unix/i) ||
1936: ($httpbrowser=~/ux/i) ||
1937: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
1938: if (($httpbrowser=~/vax/i) ||
1939: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
1940: if ($httpbrowser=~/next/i) { $clientos='next'; }
1941: if (($httpbrowser=~/mac/i) ||
1942: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1943: if ($httpbrowser=~/win/i) { $clientos='win'; }
1944: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1945: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1946: $clientunicode,$clientos,);
1947: }
1948:
1.32 matthew 1949: ###############################################################
1950: ## Authentication changing form generation subroutines ##
1951: ###############################################################
1952: ##
1953: ## All of the authform_xxxxxxx subroutines take their inputs in a
1954: ## hash, and have reasonable default values.
1955: ##
1956: ## formname = the name given in the <form> tag.
1.35 matthew 1957: #-------------------------------------------
1958:
1.45 matthew 1959: =pod
1960:
1.112 bowersj2 1961: =head1 Authentication Routines
1962:
1963: =over 4
1964:
1.648 raeburn 1965: =item * &authform_xxxxxx()
1.35 matthew 1966:
1967: The authform_xxxxxx subroutines provide javascript and html forms which
1968: handle some of the conveniences required for authentication forms.
1969: This is not an optimal method, but it works.
1970:
1971: =over 4
1972:
1.112 bowersj2 1973: =item * authform_header
1.35 matthew 1974:
1.112 bowersj2 1975: =item * authform_authorwarning
1.35 matthew 1976:
1.112 bowersj2 1977: =item * authform_nochange
1.35 matthew 1978:
1.112 bowersj2 1979: =item * authform_kerberos
1.35 matthew 1980:
1.112 bowersj2 1981: =item * authform_internal
1.35 matthew 1982:
1.112 bowersj2 1983: =item * authform_filesystem
1.35 matthew 1984:
1985: =back
1986:
1.648 raeburn 1987: See loncreateuser.pm for invocation and use examples.
1.157 matthew 1988:
1.35 matthew 1989: =cut
1990:
1991: #-------------------------------------------
1.32 matthew 1992: sub authform_header{
1993: my %in = (
1994: formname => 'cu',
1.80 albertel 1995: kerb_def_dom => '',
1.32 matthew 1996: @_,
1997: );
1998: $in{'formname'} = 'document.' . $in{'formname'};
1999: my $result='';
1.80 albertel 2000:
2001: #---------------------------------------------- Code for upper case translation
2002: my $Javascript_toUpperCase;
2003: unless ($in{kerb_def_dom}) {
2004: $Javascript_toUpperCase =<<"END";
2005: switch (choice) {
2006: case 'krb': currentform.elements[choicearg].value =
2007: currentform.elements[choicearg].value.toUpperCase();
2008: break;
2009: default:
2010: }
2011: END
2012: } else {
2013: $Javascript_toUpperCase = "";
2014: }
2015:
1.165 raeburn 2016: my $radioval = "'nochange'";
1.591 raeburn 2017: if (defined($in{'curr_authtype'})) {
2018: if ($in{'curr_authtype'} ne '') {
2019: $radioval = "'".$in{'curr_authtype'}."arg'";
2020: }
1.174 matthew 2021: }
1.165 raeburn 2022: my $argfield = 'null';
1.591 raeburn 2023: if (defined($in{'mode'})) {
1.165 raeburn 2024: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2025: if (defined($in{'curr_autharg'})) {
2026: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2027: $argfield = "'$in{'curr_autharg'}'";
2028: }
2029: }
2030: }
2031: }
2032:
1.32 matthew 2033: $result.=<<"END";
2034: var current = new Object();
1.165 raeburn 2035: current.radiovalue = $radioval;
2036: current.argfield = $argfield;
1.32 matthew 2037:
2038: function changed_radio(choice,currentform) {
2039: var choicearg = choice + 'arg';
2040: // If a radio button in changed, we need to change the argfield
2041: if (current.radiovalue != choice) {
2042: current.radiovalue = choice;
2043: if (current.argfield != null) {
2044: currentform.elements[current.argfield].value = '';
2045: }
2046: if (choice == 'nochange') {
2047: current.argfield = null;
2048: } else {
2049: current.argfield = choicearg;
2050: switch(choice) {
2051: case 'krb':
2052: currentform.elements[current.argfield].value =
2053: "$in{'kerb_def_dom'}";
2054: break;
2055: default:
2056: break;
2057: }
2058: }
2059: }
2060: return;
2061: }
1.22 www 2062:
1.32 matthew 2063: function changed_text(choice,currentform) {
2064: var choicearg = choice + 'arg';
2065: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2066: $Javascript_toUpperCase
1.32 matthew 2067: // clear old field
2068: if ((current.argfield != choicearg) && (current.argfield != null)) {
2069: currentform.elements[current.argfield].value = '';
2070: }
2071: current.argfield = choicearg;
2072: }
2073: set_auth_radio_buttons(choice,currentform);
2074: return;
1.20 www 2075: }
1.32 matthew 2076:
2077: function set_auth_radio_buttons(newvalue,currentform) {
2078: var i=0;
2079: while (i < currentform.login.length) {
2080: if (currentform.login[i].value == newvalue) { break; }
2081: i++;
2082: }
2083: if (i == currentform.login.length) {
2084: return;
2085: }
2086: current.radiovalue = newvalue;
2087: currentform.login[i].checked = true;
2088: return;
2089: }
2090: END
2091: return $result;
2092: }
2093:
2094: sub authform_authorwarning{
2095: my $result='';
1.144 matthew 2096: $result='<i>'.
2097: &mt('As a general rule, only authors or co-authors should be '.
2098: 'filesystem authenticated '.
2099: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2100: return $result;
2101: }
2102:
2103: sub authform_nochange{
2104: my %in = (
2105: formname => 'document.cu',
2106: kerb_def_dom => 'MSU.EDU',
2107: @_,
2108: );
1.586 raeburn 2109: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2110: my $result;
2111: if (keys(%can_assign) == 0) {
2112: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2113: } else {
2114: $result = '<label>'.&mt('[_1] Do not change login data',
2115: '<input type="radio" name="login" value="nochange" '.
2116: 'checked="checked" onclick="'.
1.281 albertel 2117: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2118: '</label>';
1.586 raeburn 2119: }
1.32 matthew 2120: return $result;
2121: }
2122:
1.591 raeburn 2123: sub authform_kerberos {
1.32 matthew 2124: my %in = (
2125: formname => 'document.cu',
2126: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2127: kerb_def_auth => 'krb4',
1.32 matthew 2128: @_,
2129: );
1.586 raeburn 2130: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2131: $autharg,$jscall);
2132: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2133: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2134: $check5 = ' checked="checked"';
1.80 albertel 2135: } else {
1.772 bisitz 2136: $check4 = ' checked="checked"';
1.80 albertel 2137: }
1.165 raeburn 2138: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2139: if (defined($in{'curr_authtype'})) {
2140: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2141: $krbcheck = ' checked="checked"';
1.623 raeburn 2142: if (defined($in{'mode'})) {
2143: if ($in{'mode'} eq 'modifyuser') {
2144: $krbcheck = '';
2145: }
2146: }
1.591 raeburn 2147: if (defined($in{'curr_kerb_ver'})) {
2148: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2149: $check5 = ' checked="checked"';
1.591 raeburn 2150: $check4 = '';
2151: } else {
1.772 bisitz 2152: $check4 = ' checked="checked"';
1.591 raeburn 2153: $check5 = '';
2154: }
1.586 raeburn 2155: }
1.591 raeburn 2156: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2157: $krbarg = $in{'curr_autharg'};
2158: }
1.586 raeburn 2159: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2160: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2161: $result =
2162: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2163: $in{'curr_autharg'},$krbver);
2164: } else {
2165: $result =
2166: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2167: }
2168: return $result;
2169: }
2170: }
2171: } else {
2172: if ($authnum == 1) {
1.784 bisitz 2173: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2174: }
2175: }
1.586 raeburn 2176: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2177: return;
1.587 raeburn 2178: } elsif ($authtype eq '') {
1.591 raeburn 2179: if (defined($in{'mode'})) {
1.587 raeburn 2180: if ($in{'mode'} eq 'modifycourse') {
2181: if ($authnum == 1) {
1.784 bisitz 2182: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2183: }
2184: }
2185: }
1.586 raeburn 2186: }
2187: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2188: if ($authtype eq '') {
2189: $authtype = '<input type="radio" name="login" value="krb" '.
2190: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2191: $krbcheck.' />';
2192: }
2193: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2194: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2195: $in{'curr_authtype'} eq 'krb5') ||
2196: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2197: $in{'curr_authtype'} eq 'krb4')) {
2198: $result .= &mt
1.144 matthew 2199: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2200: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2201: '<label>'.$authtype,
1.281 albertel 2202: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2203: 'value="'.$krbarg.'" '.
1.144 matthew 2204: 'onchange="'.$jscall.'" />',
1.281 albertel 2205: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2206: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2207: '</label>');
1.586 raeburn 2208: } elsif ($can_assign{'krb4'}) {
2209: $result .= &mt
2210: ('[_1] Kerberos authenticated with domain [_2] '.
2211: '[_3] Version 4 [_4]',
2212: '<label>'.$authtype,
2213: '</label><input type="text" size="10" name="krbarg" '.
2214: 'value="'.$krbarg.'" '.
2215: 'onchange="'.$jscall.'" />',
2216: '<label><input type="hidden" name="krbver" value="4" />',
2217: '</label>');
2218: } elsif ($can_assign{'krb5'}) {
2219: $result .= &mt
2220: ('[_1] Kerberos authenticated with domain [_2] '.
2221: '[_3] Version 5 [_4]',
2222: '<label>'.$authtype,
2223: '</label><input type="text" size="10" name="krbarg" '.
2224: 'value="'.$krbarg.'" '.
2225: 'onchange="'.$jscall.'" />',
2226: '<label><input type="hidden" name="krbver" value="5" />',
2227: '</label>');
2228: }
1.32 matthew 2229: return $result;
2230: }
2231:
2232: sub authform_internal{
1.586 raeburn 2233: my %in = (
1.32 matthew 2234: formname => 'document.cu',
2235: kerb_def_dom => 'MSU.EDU',
2236: @_,
2237: );
1.586 raeburn 2238: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2239: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2240: if (defined($in{'curr_authtype'})) {
2241: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2242: if ($can_assign{'int'}) {
1.772 bisitz 2243: $intcheck = 'checked="checked" ';
1.623 raeburn 2244: if (defined($in{'mode'})) {
2245: if ($in{'mode'} eq 'modifyuser') {
2246: $intcheck = '';
2247: }
2248: }
1.591 raeburn 2249: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2250: $intarg = $in{'curr_autharg'};
2251: }
2252: } else {
2253: $result = &mt('Currently internally authenticated.');
2254: return $result;
1.165 raeburn 2255: }
2256: }
1.586 raeburn 2257: } else {
2258: if ($authnum == 1) {
1.784 bisitz 2259: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2260: }
2261: }
2262: if (!$can_assign{'int'}) {
2263: return;
1.587 raeburn 2264: } elsif ($authtype eq '') {
1.591 raeburn 2265: if (defined($in{'mode'})) {
1.587 raeburn 2266: if ($in{'mode'} eq 'modifycourse') {
2267: if ($authnum == 1) {
1.784 bisitz 2268: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2269: }
2270: }
2271: }
1.165 raeburn 2272: }
1.586 raeburn 2273: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2274: if ($authtype eq '') {
2275: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2276: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2277: }
1.605 bisitz 2278: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2279: $intarg.'" onchange="'.$jscall.'" />';
2280: $result = &mt
1.144 matthew 2281: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2282: '<label>'.$authtype,'</label>'.$autharg);
1.620 www 2283: $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 2284: return $result;
2285: }
2286:
2287: sub authform_local{
2288: my %in = (
2289: formname => 'document.cu',
2290: kerb_def_dom => 'MSU.EDU',
2291: @_,
2292: );
1.586 raeburn 2293: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2294: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2295: if (defined($in{'curr_authtype'})) {
2296: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2297: if ($can_assign{'loc'}) {
1.772 bisitz 2298: $loccheck = 'checked="checked" ';
1.623 raeburn 2299: if (defined($in{'mode'})) {
2300: if ($in{'mode'} eq 'modifyuser') {
2301: $loccheck = '';
2302: }
2303: }
1.591 raeburn 2304: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2305: $locarg = $in{'curr_autharg'};
2306: }
2307: } else {
2308: $result = &mt('Currently using local (institutional) authentication.');
2309: return $result;
1.165 raeburn 2310: }
2311: }
1.586 raeburn 2312: } else {
2313: if ($authnum == 1) {
1.784 bisitz 2314: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2315: }
2316: }
2317: if (!$can_assign{'loc'}) {
2318: return;
1.587 raeburn 2319: } elsif ($authtype eq '') {
1.591 raeburn 2320: if (defined($in{'mode'})) {
1.587 raeburn 2321: if ($in{'mode'} eq 'modifycourse') {
2322: if ($authnum == 1) {
1.784 bisitz 2323: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2324: }
2325: }
2326: }
1.165 raeburn 2327: }
1.586 raeburn 2328: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2329: if ($authtype eq '') {
2330: $authtype = '<input type="radio" name="login" value="loc" '.
2331: $loccheck.' onchange="'.$jscall.'" onclick="'.
2332: $jscall.'" />';
2333: }
2334: $autharg = '<input type="text" size="10" name="locarg" value="'.
2335: $locarg.'" onchange="'.$jscall.'" />';
2336: $result = &mt('[_1] Local Authentication with argument [_2]',
2337: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2338: return $result;
2339: }
2340:
2341: sub authform_filesystem{
2342: my %in = (
2343: formname => 'document.cu',
2344: kerb_def_dom => 'MSU.EDU',
2345: @_,
2346: );
1.586 raeburn 2347: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2348: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2349: if (defined($in{'curr_authtype'})) {
2350: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2351: if ($can_assign{'fsys'}) {
1.772 bisitz 2352: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2353: if (defined($in{'mode'})) {
2354: if ($in{'mode'} eq 'modifyuser') {
2355: $fsyscheck = '';
2356: }
2357: }
1.586 raeburn 2358: } else {
2359: $result = &mt('Currently Filesystem Authenticated.');
2360: return $result;
2361: }
2362: }
2363: } else {
2364: if ($authnum == 1) {
1.784 bisitz 2365: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2366: }
2367: }
2368: if (!$can_assign{'fsys'}) {
2369: return;
1.587 raeburn 2370: } elsif ($authtype eq '') {
1.591 raeburn 2371: if (defined($in{'mode'})) {
1.587 raeburn 2372: if ($in{'mode'} eq 'modifycourse') {
2373: if ($authnum == 1) {
1.784 bisitz 2374: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2375: }
2376: }
2377: }
1.586 raeburn 2378: }
2379: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2380: if ($authtype eq '') {
2381: $authtype = '<input type="radio" name="login" value="fsys" '.
2382: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2383: $jscall.'" />';
2384: }
2385: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2386: ' onchange="'.$jscall.'" />';
2387: $result = &mt
1.144 matthew 2388: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2389: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2390: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2391: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2392: 'onchange="'.$jscall.'" />');
1.32 matthew 2393: return $result;
2394: }
2395:
1.586 raeburn 2396: sub get_assignable_auth {
2397: my ($dom) = @_;
2398: if ($dom eq '') {
2399: $dom = $env{'request.role.domain'};
2400: }
2401: my %can_assign = (
2402: krb4 => 1,
2403: krb5 => 1,
2404: int => 1,
2405: loc => 1,
2406: );
2407: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2408: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2409: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2410: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2411: my $context;
2412: if ($env{'request.role'} =~ /^au/) {
2413: $context = 'author';
2414: } elsif ($env{'request.role'} =~ /^dc/) {
2415: $context = 'domain';
2416: } elsif ($env{'request.course.id'}) {
2417: $context = 'course';
2418: }
2419: if ($context) {
2420: if (ref($authhash->{$context}) eq 'HASH') {
2421: %can_assign = %{$authhash->{$context}};
2422: }
2423: }
2424: }
2425: }
2426: my $authnum = 0;
2427: foreach my $key (keys(%can_assign)) {
2428: if ($can_assign{$key}) {
2429: $authnum ++;
2430: }
2431: }
2432: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2433: $authnum --;
2434: }
2435: return ($authnum,%can_assign);
2436: }
2437:
1.80 albertel 2438: ###############################################################
2439: ## Get Kerberos Defaults for Domain ##
2440: ###############################################################
2441: ##
2442: ## Returns default kerberos version and an associated argument
2443: ## as listed in file domain.tab. If not listed, provides
2444: ## appropriate default domain and kerberos version.
2445: ##
2446: #-------------------------------------------
2447:
2448: =pod
2449:
1.648 raeburn 2450: =item * &get_kerberos_defaults()
1.80 albertel 2451:
2452: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2453: version and domain. If not found, it defaults to version 4 and the
2454: domain of the server.
1.80 albertel 2455:
1.648 raeburn 2456: =over 4
2457:
1.80 albertel 2458: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2459:
1.648 raeburn 2460: =back
2461:
2462: =back
2463:
1.80 albertel 2464: =cut
2465:
2466: #-------------------------------------------
2467: sub get_kerberos_defaults {
2468: my $domain=shift;
1.641 raeburn 2469: my ($krbdef,$krbdefdom);
2470: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2471: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2472: $krbdef = $domdefaults{'auth_def'};
2473: $krbdefdom = $domdefaults{'auth_arg_def'};
2474: } else {
1.80 albertel 2475: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2476: my $krbdefdom=$1;
2477: $krbdefdom=~tr/a-z/A-Z/;
2478: $krbdef = "krb4";
2479: }
2480: return ($krbdef,$krbdefdom);
2481: }
1.112 bowersj2 2482:
1.32 matthew 2483:
1.46 matthew 2484: ###############################################################
2485: ## Thesaurus Functions ##
2486: ###############################################################
1.20 www 2487:
1.46 matthew 2488: =pod
1.20 www 2489:
1.112 bowersj2 2490: =head1 Thesaurus Functions
2491:
2492: =over 4
2493:
1.648 raeburn 2494: =item * &initialize_keywords()
1.46 matthew 2495:
2496: Initializes the package variable %Keywords if it is empty. Uses the
2497: package variable $thesaurus_db_file.
2498:
2499: =cut
2500:
2501: ###################################################
2502:
2503: sub initialize_keywords {
2504: return 1 if (scalar keys(%Keywords));
2505: # If we are here, %Keywords is empty, so fill it up
2506: # Make sure the file we need exists...
2507: if (! -e $thesaurus_db_file) {
2508: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2509: " failed because it does not exist");
2510: return 0;
2511: }
2512: # Set up the hash as a database
2513: my %thesaurus_db;
2514: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2515: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2516: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2517: $thesaurus_db_file);
2518: return 0;
2519: }
2520: # Get the average number of appearances of a word.
2521: my $avecount = $thesaurus_db{'average.count'};
2522: # Put keywords (those that appear > average) into %Keywords
2523: while (my ($word,$data)=each (%thesaurus_db)) {
2524: my ($count,undef) = split /:/,$data;
2525: $Keywords{$word}++ if ($count > $avecount);
2526: }
2527: untie %thesaurus_db;
2528: # Remove special values from %Keywords.
1.356 albertel 2529: foreach my $value ('total.count','average.count') {
2530: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2531: }
1.46 matthew 2532: return 1;
2533: }
2534:
2535: ###################################################
2536:
2537: =pod
2538:
1.648 raeburn 2539: =item * &keyword($word)
1.46 matthew 2540:
2541: Returns true if $word is a keyword. A keyword is a word that appears more
2542: than the average number of times in the thesaurus database. Calls
2543: &initialize_keywords
2544:
2545: =cut
2546:
2547: ###################################################
1.20 www 2548:
2549: sub keyword {
1.46 matthew 2550: return if (!&initialize_keywords());
2551: my $word=lc(shift());
2552: $word=~s/\W//g;
2553: return exists($Keywords{$word});
1.20 www 2554: }
1.46 matthew 2555:
2556: ###############################################################
2557:
2558: =pod
1.20 www 2559:
1.648 raeburn 2560: =item * &get_related_words()
1.46 matthew 2561:
1.160 matthew 2562: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2563: an array of words. If the keyword is not in the thesaurus, an empty array
2564: will be returned. The order of the words returned is determined by the
2565: database which holds them.
2566:
2567: Uses global $thesaurus_db_file.
2568:
2569: =cut
2570:
2571: ###############################################################
2572: sub get_related_words {
2573: my $keyword = shift;
2574: my %thesaurus_db;
2575: if (! -e $thesaurus_db_file) {
2576: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2577: "failed because the file does not exist");
2578: return ();
2579: }
2580: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2581: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2582: return ();
2583: }
2584: my @Words=();
1.429 www 2585: my $count=0;
1.46 matthew 2586: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2587: # The first element is the number of times
2588: # the word appears. We do not need it now.
1.429 www 2589: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2590: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2591: my $threshold=$mostfrequentcount/10;
2592: foreach my $possibleword (@RelatedWords) {
2593: my ($word,$wordcount)=split(/\,/,$possibleword);
2594: if ($wordcount>$threshold) {
2595: push(@Words,$word);
2596: $count++;
2597: if ($count>10) { last; }
2598: }
1.20 www 2599: }
2600: }
1.46 matthew 2601: untie %thesaurus_db;
2602: return @Words;
1.14 harris41 2603: }
1.46 matthew 2604:
1.112 bowersj2 2605: =pod
2606:
2607: =back
2608:
2609: =cut
1.61 www 2610:
2611: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2612: =pod
2613:
1.112 bowersj2 2614: =head1 User Name Functions
2615:
2616: =over 4
2617:
1.648 raeburn 2618: =item * &plainname($uname,$udom,$first)
1.81 albertel 2619:
1.112 bowersj2 2620: Takes a users logon name and returns it as a string in
1.226 albertel 2621: "first middle last generation" form
2622: if $first is set to 'lastname' then it returns it as
2623: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2624:
2625: =cut
1.61 www 2626:
1.295 www 2627:
1.81 albertel 2628: ###############################################################
1.61 www 2629: sub plainname {
1.226 albertel 2630: my ($uname,$udom,$first)=@_;
1.537 albertel 2631: return if (!defined($uname) || !defined($udom));
1.295 www 2632: my %names=&getnames($uname,$udom);
1.226 albertel 2633: my $name=&Apache::lonnet::format_name($names{'firstname'},
2634: $names{'middlename'},
2635: $names{'lastname'},
2636: $names{'generation'},$first);
2637: $name=~s/^\s+//;
1.62 www 2638: $name=~s/\s+$//;
2639: $name=~s/\s+/ /g;
1.353 albertel 2640: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2641: return $name;
1.61 www 2642: }
1.66 www 2643:
2644: # -------------------------------------------------------------------- Nickname
1.81 albertel 2645: =pod
2646:
1.648 raeburn 2647: =item * &nickname($uname,$udom)
1.81 albertel 2648:
2649: Gets a users name and returns it as a string as
2650:
2651: ""nickname""
1.66 www 2652:
1.81 albertel 2653: if the user has a nickname or
2654:
2655: "first middle last generation"
2656:
2657: if the user does not
2658:
2659: =cut
1.66 www 2660:
2661: sub nickname {
2662: my ($uname,$udom)=@_;
1.537 albertel 2663: return if (!defined($uname) || !defined($udom));
1.295 www 2664: my %names=&getnames($uname,$udom);
1.68 albertel 2665: my $name=$names{'nickname'};
1.66 www 2666: if ($name) {
2667: $name='"'.$name.'"';
2668: } else {
2669: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2670: $names{'lastname'}.' '.$names{'generation'};
2671: $name=~s/\s+$//;
2672: $name=~s/\s+/ /g;
2673: }
2674: return $name;
2675: }
2676:
1.295 www 2677: sub getnames {
2678: my ($uname,$udom)=@_;
1.537 albertel 2679: return if (!defined($uname) || !defined($udom));
1.433 albertel 2680: if ($udom eq 'public' && $uname eq 'public') {
2681: return ('lastname' => &mt('Public'));
2682: }
1.295 www 2683: my $id=$uname.':'.$udom;
2684: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2685: if ($cached) {
2686: return %{$names};
2687: } else {
2688: my %loadnames=&Apache::lonnet::get('environment',
2689: ['firstname','middlename','lastname','generation','nickname'],
2690: $udom,$uname);
2691: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2692: return %loadnames;
2693: }
2694: }
1.61 www 2695:
1.542 raeburn 2696: # -------------------------------------------------------------------- getemails
1.648 raeburn 2697:
1.542 raeburn 2698: =pod
2699:
1.648 raeburn 2700: =item * &getemails($uname,$udom)
1.542 raeburn 2701:
2702: Gets a user's email information and returns it as a hash with keys:
2703: notification, critnotification, permanentemail
2704:
2705: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2706: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2707:
1.648 raeburn 2708:
1.542 raeburn 2709: =cut
2710:
1.648 raeburn 2711:
1.466 albertel 2712: sub getemails {
2713: my ($uname,$udom)=@_;
2714: if ($udom eq 'public' && $uname eq 'public') {
2715: return;
2716: }
1.467 www 2717: if (!$udom) { $udom=$env{'user.domain'}; }
2718: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2719: my $id=$uname.':'.$udom;
2720: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2721: if ($cached) {
2722: return %{$names};
2723: } else {
2724: my %loadnames=&Apache::lonnet::get('environment',
2725: ['notification','critnotification',
2726: 'permanentemail'],
2727: $udom,$uname);
2728: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2729: return %loadnames;
2730: }
2731: }
2732:
1.551 albertel 2733: sub flush_email_cache {
2734: my ($uname,$udom)=@_;
2735: if (!$udom) { $udom =$env{'user.domain'}; }
2736: if (!$uname) { $uname=$env{'user.name'}; }
2737: return if ($udom eq 'public' && $uname eq 'public');
2738: my $id=$uname.':'.$udom;
2739: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2740: }
2741:
1.728 raeburn 2742: # -------------------------------------------------------------------- getlangs
2743:
2744: =pod
2745:
2746: =item * &getlangs($uname,$udom)
2747:
2748: Gets a user's language preference and returns it as a hash with key:
2749: language.
2750:
2751: =cut
2752:
2753:
2754: sub getlangs {
2755: my ($uname,$udom) = @_;
2756: if (!$udom) { $udom =$env{'user.domain'}; }
2757: if (!$uname) { $uname=$env{'user.name'}; }
2758: my $id=$uname.':'.$udom;
2759: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2760: if ($cached) {
2761: return %{$langs};
2762: } else {
2763: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2764: $udom,$uname);
2765: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2766: return %loadlangs;
2767: }
2768: }
2769:
2770: sub flush_langs_cache {
2771: my ($uname,$udom)=@_;
2772: if (!$udom) { $udom =$env{'user.domain'}; }
2773: if (!$uname) { $uname=$env{'user.name'}; }
2774: return if ($udom eq 'public' && $uname eq 'public');
2775: my $id=$uname.':'.$udom;
2776: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2777: }
2778:
1.61 www 2779: # ------------------------------------------------------------------ Screenname
1.81 albertel 2780:
2781: =pod
2782:
1.648 raeburn 2783: =item * &screenname($uname,$udom)
1.81 albertel 2784:
2785: Gets a users screenname and returns it as a string
2786:
2787: =cut
1.61 www 2788:
2789: sub screenname {
2790: my ($uname,$udom)=@_;
1.258 albertel 2791: if ($uname eq $env{'user.name'} &&
2792: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2793: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2794: return $names{'screenname'};
1.62 www 2795: }
2796:
1.212 albertel 2797:
1.62 www 2798: # ------------------------------------------------------------- Message Wrapper
2799:
2800: sub messagewrapper {
1.369 www 2801: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 2802: return
1.441 albertel 2803: '<a href="/adm/email?compose=individual&'.
2804: 'recname='.$username.'&recdom='.$domain.
2805: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 2806: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 2807: }
2808: # --------------------------------------------------------------- Notes Wrapper
2809:
2810: sub noteswrapper {
2811: my ($link,$un,$do)=@_;
2812: return
2813: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 2814: }
2815: # ------------------------------------------------------------- Aboutme Wrapper
2816:
2817: sub aboutmewrapper {
1.166 www 2818: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 2819: if (!defined($username) && !defined($domain)) {
2820: return;
2821: }
1.205 www 2822: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.756 weissno 2823: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 2824: }
2825:
2826: # ------------------------------------------------------------ Syllabus Wrapper
2827:
2828:
2829: sub syllabuswrapper {
1.707 bisitz 2830: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 2831: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 2832: }
1.14 harris41 2833:
1.208 matthew 2834: sub track_student_link {
1.268 albertel 2835: my ($linktext,$sname,$sdom,$target,$start) = @_;
2836: my $link ="/adm/trackstudent?";
1.208 matthew 2837: my $title = 'View recent activity';
2838: if (defined($sname) && $sname !~ /^\s*$/ &&
2839: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 2840: $link .= "selected_student=$sname:$sdom";
1.208 matthew 2841: $title .= ' of this student';
1.268 albertel 2842: }
1.208 matthew 2843: if (defined($target) && $target !~ /^\s*$/) {
2844: $target = qq{target="$target"};
2845: } else {
2846: $target = '';
2847: }
1.268 albertel 2848: if ($start) { $link.='&start='.$start; }
1.554 albertel 2849: $title = &mt($title);
2850: $linktext = &mt($linktext);
1.448 albertel 2851: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
2852: &help_open_topic('View_recent_activity');
1.208 matthew 2853: }
2854:
1.781 raeburn 2855: sub slot_reservations_link {
2856: my ($linktext,$sname,$sdom,$target) = @_;
2857: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
2858: my $title = 'View slot reservation history';
2859: if (defined($sname) && $sname !~ /^\s*$/ &&
2860: defined($sdom) && $sdom !~ /^\s*$/) {
2861: $link .= "&uname=$sname&udom=$sdom";
2862: $title .= ' of this student';
2863: }
2864: if (defined($target) && $target !~ /^\s*$/) {
2865: $target = qq{target="$target"};
2866: } else {
2867: $target = '';
2868: }
2869: $title = &mt($title);
2870: $linktext = &mt($linktext);
2871: return qq{<a href="$link" title="$title" $target>$linktext</a>};
2872: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
2873:
2874: }
2875:
1.508 www 2876: # ===================================================== Display a student photo
2877:
2878:
1.509 albertel 2879: sub student_image_tag {
1.508 www 2880: my ($domain,$user)=@_;
2881: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
2882: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
2883: return '<img src="'.$imgsrc.'" align="right" />';
2884: } else {
2885: return '';
2886: }
2887: }
2888:
1.112 bowersj2 2889: =pod
2890:
2891: =back
2892:
2893: =head1 Access .tab File Data
2894:
2895: =over 4
2896:
1.648 raeburn 2897: =item * &languageids()
1.112 bowersj2 2898:
2899: returns list of all language ids
2900:
2901: =cut
2902:
1.14 harris41 2903: sub languageids {
1.16 harris41 2904: return sort(keys(%language));
1.14 harris41 2905: }
2906:
1.112 bowersj2 2907: =pod
2908:
1.648 raeburn 2909: =item * &languagedescription()
1.112 bowersj2 2910:
2911: returns description of a specified language id
2912:
2913: =cut
2914:
1.14 harris41 2915: sub languagedescription {
1.125 www 2916: my $code=shift;
2917: return ($supported_language{$code}?'* ':'').
2918: $language{$code}.
1.126 www 2919: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 2920: }
2921:
2922: sub plainlanguagedescription {
2923: my $code=shift;
2924: return $language{$code};
2925: }
2926:
2927: sub supportedlanguagecode {
2928: my $code=shift;
2929: return $supported_language{$code};
1.97 www 2930: }
2931:
1.112 bowersj2 2932: =pod
2933:
1.648 raeburn 2934: =item * ©rightids()
1.112 bowersj2 2935:
2936: returns list of all copyrights
2937:
2938: =cut
2939:
2940: sub copyrightids {
2941: return sort(keys(%cprtag));
2942: }
2943:
2944: =pod
2945:
1.648 raeburn 2946: =item * ©rightdescription()
1.112 bowersj2 2947:
2948: returns description of a specified copyright id
2949:
2950: =cut
2951:
2952: sub copyrightdescription {
1.166 www 2953: return &mt($cprtag{shift(@_)});
1.112 bowersj2 2954: }
1.197 matthew 2955:
2956: =pod
2957:
1.648 raeburn 2958: =item * &source_copyrightids()
1.192 taceyjo1 2959:
2960: returns list of all source copyrights
2961:
2962: =cut
2963:
2964: sub source_copyrightids {
2965: return sort(keys(%scprtag));
2966: }
2967:
2968: =pod
2969:
1.648 raeburn 2970: =item * &source_copyrightdescription()
1.192 taceyjo1 2971:
2972: returns description of a specified source copyright id
2973:
2974: =cut
2975:
2976: sub source_copyrightdescription {
2977: return &mt($scprtag{shift(@_)});
2978: }
1.112 bowersj2 2979:
2980: =pod
2981:
1.648 raeburn 2982: =item * &filecategories()
1.112 bowersj2 2983:
2984: returns list of all file categories
2985:
2986: =cut
2987:
2988: sub filecategories {
2989: return sort(keys(%category_extensions));
2990: }
2991:
2992: =pod
2993:
1.648 raeburn 2994: =item * &filecategorytypes()
1.112 bowersj2 2995:
2996: returns list of file types belonging to a given file
2997: category
2998:
2999: =cut
3000:
3001: sub filecategorytypes {
1.356 albertel 3002: my ($cat) = @_;
3003: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3004: }
3005:
3006: =pod
3007:
1.648 raeburn 3008: =item * &fileembstyle()
1.112 bowersj2 3009:
3010: returns embedding style for a specified file type
3011:
3012: =cut
3013:
3014: sub fileembstyle {
3015: return $fe{lc(shift(@_))};
1.169 www 3016: }
3017:
1.351 www 3018: sub filemimetype {
3019: return $fm{lc(shift(@_))};
3020: }
3021:
1.169 www 3022:
3023: sub filecategoryselect {
3024: my ($name,$value)=@_;
1.189 matthew 3025: return &select_form($value,$name,
1.169 www 3026: '' => &mt('Any category'),
3027: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 3028: }
3029:
3030: =pod
3031:
1.648 raeburn 3032: =item * &filedescription()
1.112 bowersj2 3033:
3034: returns description for a specified file type
3035:
3036: =cut
3037:
3038: sub filedescription {
1.188 matthew 3039: my $file_description = $fd{lc(shift())};
3040: $file_description =~ s:([\[\]]):~$1:g;
3041: return &mt($file_description);
1.112 bowersj2 3042: }
3043:
3044: =pod
3045:
1.648 raeburn 3046: =item * &filedescriptionex()
1.112 bowersj2 3047:
3048: returns description for a specified file type with
3049: extra formatting
3050:
3051: =cut
3052:
3053: sub filedescriptionex {
3054: my $ex=shift;
1.188 matthew 3055: my $file_description = $fd{lc($ex)};
3056: $file_description =~ s:([\[\]]):~$1:g;
3057: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3058: }
3059:
3060: # End of .tab access
3061: =pod
3062:
3063: =back
3064:
3065: =cut
3066:
3067: # ------------------------------------------------------------------ File Types
3068: sub fileextensions {
3069: return sort(keys(%fe));
3070: }
3071:
1.97 www 3072: # ----------------------------------------------------------- Display Languages
3073: # returns a hash with all desired display languages
3074: #
3075:
3076: sub display_languages {
3077: my %languages=();
1.695 raeburn 3078: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3079: $languages{$lang}=1;
1.97 www 3080: }
3081: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3082: if ($env{'form.displaylanguage'}) {
1.356 albertel 3083: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3084: $languages{$lang}=1;
1.97 www 3085: }
3086: }
3087: return %languages;
1.14 harris41 3088: }
3089:
1.582 albertel 3090: sub languages {
3091: my ($possible_langs) = @_;
1.695 raeburn 3092: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3093: if (!ref($possible_langs)) {
3094: if( wantarray ) {
3095: return @preferred_langs;
3096: } else {
3097: return $preferred_langs[0];
3098: }
3099: }
3100: my %possibilities = map { $_ => 1 } (@$possible_langs);
3101: my @preferred_possibilities;
3102: foreach my $preferred_lang (@preferred_langs) {
3103: if (exists($possibilities{$preferred_lang})) {
3104: push(@preferred_possibilities, $preferred_lang);
3105: }
3106: }
3107: if( wantarray ) {
3108: return @preferred_possibilities;
3109: }
3110: return $preferred_possibilities[0];
3111: }
3112:
1.742 raeburn 3113: sub user_lang {
3114: my ($touname,$toudom,$fromcid) = @_;
3115: my @userlangs;
3116: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3117: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3118: $env{'course.'.$fromcid.'.languages'}));
3119: } else {
3120: my %langhash = &getlangs($touname,$toudom);
3121: if ($langhash{'languages'} ne '') {
3122: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3123: } else {
3124: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3125: if ($domdefs{'lang_def'} ne '') {
3126: @userlangs = ($domdefs{'lang_def'});
3127: }
3128: }
3129: }
3130: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3131: my $user_lh = Apache::localize->get_handle(@languages);
3132: return $user_lh;
3133: }
3134:
3135:
1.112 bowersj2 3136: ###############################################################
3137: ## Student Answer Attempts ##
3138: ###############################################################
3139:
3140: =pod
3141:
3142: =head1 Alternate Problem Views
3143:
3144: =over 4
3145:
1.648 raeburn 3146: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3147: $getattempt, $regexp, $gradesub)
3148:
3149: Return string with previous attempt on problem. Arguments:
3150:
3151: =over 4
3152:
3153: =item * $symb: Problem, including path
3154:
3155: =item * $username: username of the desired student
3156:
3157: =item * $domain: domain of the desired student
1.14 harris41 3158:
1.112 bowersj2 3159: =item * $course: Course ID
1.14 harris41 3160:
1.112 bowersj2 3161: =item * $getattempt: Leave blank for all attempts, otherwise put
3162: something
1.14 harris41 3163:
1.112 bowersj2 3164: =item * $regexp: if string matches this regexp, the string will be
3165: sent to $gradesub
1.14 harris41 3166:
1.112 bowersj2 3167: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3168:
1.112 bowersj2 3169: =back
1.14 harris41 3170:
1.112 bowersj2 3171: The output string is a table containing all desired attempts, if any.
1.16 harris41 3172:
1.112 bowersj2 3173: =cut
1.1 albertel 3174:
3175: sub get_previous_attempt {
1.43 ng 3176: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3177: my $prevattempts='';
1.43 ng 3178: no strict 'refs';
1.1 albertel 3179: if ($symb) {
1.3 albertel 3180: my (%returnhash)=
3181: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3182: if ($returnhash{'version'}) {
3183: my %lasthash=();
3184: my $version;
3185: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3186: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3187: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3188: }
1.1 albertel 3189: }
1.596 albertel 3190: $prevattempts=&start_data_table().&start_data_table_header_row();
3191: $prevattempts.='<th>'.&mt('History').'</th>';
1.356 albertel 3192: foreach my $key (sort(keys(%lasthash))) {
3193: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3194: if ($#parts > 0) {
1.31 albertel 3195: my $data=$parts[-1];
3196: pop(@parts);
1.596 albertel 3197: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.31 albertel 3198: } else {
1.41 ng 3199: if ($#parts == 0) {
3200: $prevattempts.='<th>'.$parts[0].'</th>';
3201: } else {
3202: $prevattempts.='<th>'.$ign.'</th>';
3203: }
1.31 albertel 3204: }
1.16 harris41 3205: }
1.596 albertel 3206: $prevattempts.=&end_data_table_header_row();
1.40 ng 3207: if ($getattempt eq '') {
3208: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596 albertel 3209: $prevattempts.=&start_data_table_row().
3210: '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356 albertel 3211: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3212: my $value = &format_previous_attempt_value($key,
3213: $returnhash{$version.':'.$key});
3214: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 3215: }
1.596 albertel 3216: $prevattempts.=&end_data_table_row();
1.40 ng 3217: }
1.1 albertel 3218: }
1.596 albertel 3219: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3220: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3221: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 3222: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 3223: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 3224: }
1.596 albertel 3225: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3226: } else {
1.596 albertel 3227: $prevattempts=
3228: &start_data_table().&start_data_table_row().
3229: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3230: &end_data_table_row().&end_data_table();
1.1 albertel 3231: }
3232: } else {
1.596 albertel 3233: $prevattempts=
3234: &start_data_table().&start_data_table_row().
3235: '<td>'.&mt('No data.').'</td>'.
3236: &end_data_table_row().&end_data_table();
1.1 albertel 3237: }
1.10 albertel 3238: }
3239:
1.581 albertel 3240: sub format_previous_attempt_value {
3241: my ($key,$value) = @_;
3242: if ($key =~ /timestamp/) {
3243: $value = &Apache::lonlocal::locallocaltime($value);
3244: } elsif (ref($value) eq 'ARRAY') {
3245: $value = '('.join(', ', @{ $value }).')';
3246: } else {
3247: $value = &unescape($value);
3248: }
3249: return $value;
3250: }
3251:
3252:
1.107 albertel 3253: sub relative_to_absolute {
3254: my ($url,$output)=@_;
3255: my $parser=HTML::TokeParser->new(\$output);
3256: my $token;
3257: my $thisdir=$url;
3258: my @rlinks=();
3259: while ($token=$parser->get_token) {
3260: if ($token->[0] eq 'S') {
3261: if ($token->[1] eq 'a') {
3262: if ($token->[2]->{'href'}) {
3263: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3264: }
3265: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3266: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3267: } elsif ($token->[1] eq 'base') {
3268: $thisdir=$token->[2]->{'href'};
3269: }
3270: }
3271: }
3272: $thisdir=~s-/[^/]*$--;
1.356 albertel 3273: foreach my $link (@rlinks) {
1.726 raeburn 3274: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3275: ($link=~/^\//) ||
3276: ($link=~/^javascript:/i) ||
3277: ($link=~/^mailto:/i) ||
3278: ($link=~/^\#/)) {
3279: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3280: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3281: }
3282: }
3283: # -------------------------------------------------- Deal with Applet codebases
3284: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3285: return $output;
3286: }
3287:
1.112 bowersj2 3288: =pod
3289:
1.648 raeburn 3290: =item * &get_student_view()
1.112 bowersj2 3291:
3292: show a snapshot of what student was looking at
3293:
3294: =cut
3295:
1.10 albertel 3296: sub get_student_view {
1.186 albertel 3297: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3298: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3299: my (%form);
1.10 albertel 3300: my @elements=('symb','courseid','domain','username');
3301: foreach my $element (@elements) {
1.186 albertel 3302: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3303: }
1.186 albertel 3304: if (defined($moreenv)) {
3305: %form=(%form,%{$moreenv});
3306: }
1.236 albertel 3307: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3308: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3309: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3310: $userview=~s/\<body[^\>]*\>//gi;
3311: $userview=~s/\<\/body\>//gi;
3312: $userview=~s/\<html\>//gi;
3313: $userview=~s/\<\/html\>//gi;
3314: $userview=~s/\<head\>//gi;
3315: $userview=~s/\<\/head\>//gi;
3316: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3317: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3318: if (wantarray) {
3319: return ($userview,$response);
3320: } else {
3321: return $userview;
3322: }
3323: }
3324:
3325: sub get_student_view_with_retries {
3326: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3327:
3328: my $ok = 0; # True if we got a good response.
3329: my $content;
3330: my $response;
3331:
3332: # Try to get the student_view done. within the retries count:
3333:
3334: do {
3335: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3336: $ok = $response->is_success;
3337: if (!$ok) {
3338: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3339: }
3340: $retries--;
3341: } while (!$ok && ($retries > 0));
3342:
3343: if (!$ok) {
3344: $content = ''; # On error return an empty content.
3345: }
1.651 www 3346: if (wantarray) {
3347: return ($content, $response);
3348: } else {
3349: return $content;
3350: }
1.11 albertel 3351: }
3352:
1.112 bowersj2 3353: =pod
3354:
1.648 raeburn 3355: =item * &get_student_answers()
1.112 bowersj2 3356:
3357: show a snapshot of how student was answering problem
3358:
3359: =cut
3360:
1.11 albertel 3361: sub get_student_answers {
1.100 sakharuk 3362: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3363: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3364: my (%moreenv);
1.11 albertel 3365: my @elements=('symb','courseid','domain','username');
3366: foreach my $element (@elements) {
1.186 albertel 3367: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3368: }
1.186 albertel 3369: $moreenv{'grade_target'}='answer';
3370: %moreenv=(%form,%moreenv);
1.497 raeburn 3371: $feedurl = &Apache::lonnet::clutter($feedurl);
3372: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3373: return $userview;
1.1 albertel 3374: }
1.116 albertel 3375:
3376: =pod
3377:
3378: =item * &submlink()
3379:
1.242 albertel 3380: Inputs: $text $uname $udom $symb $target
1.116 albertel 3381:
3382: Returns: A link to grades.pm such as to see the SUBM view of a student
3383:
3384: =cut
3385:
3386: ###############################################
3387: sub submlink {
1.242 albertel 3388: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3389: if (!($uname && $udom)) {
3390: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3391: &Apache::lonnet::whichuser($symb);
1.116 albertel 3392: if (!$symb) { $symb=$cursymb; }
3393: }
1.254 matthew 3394: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3395: $symb=&escape($symb);
1.242 albertel 3396: if ($target) { $target="target=\"$target\""; }
3397: return '<a href="/adm/grades?&command=submission&'.
3398: 'symb='.$symb.'&student='.$uname.
3399: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3400: }
3401: ##############################################
3402:
3403: =pod
3404:
3405: =item * &pgrdlink()
3406:
3407: Inputs: $text $uname $udom $symb $target
3408:
3409: Returns: A link to grades.pm such as to see the PGRD view of a student
3410:
3411: =cut
3412:
3413: ###############################################
3414: sub pgrdlink {
3415: my $link=&submlink(@_);
3416: $link=~s/(&command=submission)/$1&showgrading=yes/;
3417: return $link;
3418: }
3419: ##############################################
3420:
3421: =pod
3422:
3423: =item * &pprmlink()
3424:
3425: Inputs: $text $uname $udom $symb $target
3426:
3427: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3428: student and a specific resource
1.242 albertel 3429:
3430: =cut
3431:
3432: ###############################################
3433: sub pprmlink {
3434: my ($text,$uname,$udom,$symb,$target)=@_;
3435: if (!($uname && $udom)) {
3436: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3437: &Apache::lonnet::whichuser($symb);
1.242 albertel 3438: if (!$symb) { $symb=$cursymb; }
3439: }
1.254 matthew 3440: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3441: $symb=&escape($symb);
1.242 albertel 3442: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3443: return '<a href="/adm/parmset?command=set&'.
3444: 'symb='.$symb.'&uname='.$uname.
3445: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3446: }
3447: ##############################################
1.37 matthew 3448:
1.112 bowersj2 3449: =pod
3450:
3451: =back
3452:
3453: =cut
3454:
1.37 matthew 3455: ###############################################
1.51 www 3456:
3457:
3458: sub timehash {
1.687 raeburn 3459: my ($thistime) = @_;
3460: my $timezone = &Apache::lonlocal::gettimezone();
3461: my $dt = DateTime->from_epoch(epoch => $thistime)
3462: ->set_time_zone($timezone);
3463: my $wday = $dt->day_of_week();
3464: if ($wday == 7) { $wday = 0; }
3465: return ( 'second' => $dt->second(),
3466: 'minute' => $dt->minute(),
3467: 'hour' => $dt->hour(),
3468: 'day' => $dt->day_of_month(),
3469: 'month' => $dt->month(),
3470: 'year' => $dt->year(),
3471: 'weekday' => $wday,
3472: 'dayyear' => $dt->day_of_year(),
3473: 'dlsav' => $dt->is_dst() );
1.51 www 3474: }
3475:
1.370 www 3476: sub utc_string {
3477: my ($date)=@_;
1.371 www 3478: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3479: }
3480:
1.51 www 3481: sub maketime {
3482: my %th=@_;
1.687 raeburn 3483: my ($epoch_time,$timezone,$dt);
3484: $timezone = &Apache::lonlocal::gettimezone();
3485: eval {
3486: $dt = DateTime->new( year => $th{'year'},
3487: month => $th{'month'},
3488: day => $th{'day'},
3489: hour => $th{'hour'},
3490: minute => $th{'minute'},
3491: second => $th{'second'},
3492: time_zone => $timezone,
3493: );
3494: };
3495: if (!$@) {
3496: $epoch_time = $dt->epoch;
3497: if ($epoch_time) {
3498: return $epoch_time;
3499: }
3500: }
1.51 www 3501: return POSIX::mktime(
3502: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3503: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3504: }
3505:
3506: #########################################
1.51 www 3507:
3508: sub findallcourses {
1.482 raeburn 3509: my ($roles,$uname,$udom) = @_;
1.355 albertel 3510: my %roles;
3511: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3512: my %courses;
1.51 www 3513: my $now=time;
1.482 raeburn 3514: if (!defined($uname)) {
3515: $uname = $env{'user.name'};
3516: }
3517: if (!defined($udom)) {
3518: $udom = $env{'user.domain'};
3519: }
3520: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3521: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3522: if (!%roles) {
3523: %roles = (
3524: cc => 1,
3525: in => 1,
3526: ep => 1,
3527: ta => 1,
3528: cr => 1,
3529: st => 1,
3530: );
3531: }
3532: foreach my $entry (keys(%roleshash)) {
3533: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3534: if ($trole =~ /^cr/) {
3535: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3536: } else {
3537: next if (!exists($roles{$trole}));
3538: }
3539: if ($tend) {
3540: next if ($tend < $now);
3541: }
3542: if ($tstart) {
3543: next if ($tstart > $now);
3544: }
3545: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3546: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3547: if ($secpart eq '') {
3548: ($cnum,$role) = split(/_/,$cnumpart);
3549: $sec = 'none';
3550: $realsec = '';
3551: } else {
3552: $cnum = $cnumpart;
3553: ($sec,$role) = split(/_/,$secpart);
3554: $realsec = $sec;
1.490 raeburn 3555: }
1.482 raeburn 3556: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3557: }
3558: } else {
3559: foreach my $key (keys(%env)) {
1.483 albertel 3560: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3561: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3562: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3563: next if ($role eq 'ca' || $role eq 'aa');
3564: next if (%roles && !exists($roles{$role}));
3565: my ($starttime,$endtime)=split(/\./,$env{$key});
3566: my $active=1;
3567: if ($starttime) {
3568: if ($now<$starttime) { $active=0; }
3569: }
3570: if ($endtime) {
3571: if ($now>$endtime) { $active=0; }
3572: }
3573: if ($active) {
3574: if ($sec eq '') {
3575: $sec = 'none';
3576: }
3577: $courses{$cdom.'_'.$cnum}{$sec} =
3578: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3579: }
3580: }
1.51 www 3581: }
3582: }
1.474 raeburn 3583: return %courses;
1.51 www 3584: }
1.37 matthew 3585:
1.54 www 3586: ###############################################
1.474 raeburn 3587:
3588: sub blockcheck {
1.482 raeburn 3589: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3590:
3591: if (!defined($udom)) {
3592: $udom = $env{'user.domain'};
3593: }
3594: if (!defined($uname)) {
3595: $uname = $env{'user.name'};
3596: }
3597:
3598: # If uname and udom are for a course, check for blocks in the course.
3599:
3600: if (&Apache::lonnet::is_course($udom,$uname)) {
3601: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3602: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3603: return ($startblock,$endblock);
3604: }
1.474 raeburn 3605:
1.502 raeburn 3606: my $startblock = 0;
3607: my $endblock = 0;
1.482 raeburn 3608: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3609:
1.490 raeburn 3610: # If uname is for a user, and activity is course-specific, i.e.,
3611: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3612:
1.490 raeburn 3613: if (($activity eq 'boards' || $activity eq 'chat' ||
3614: $activity eq 'groups') && ($env{'request.course.id'})) {
3615: foreach my $key (keys(%live_courses)) {
3616: if ($key ne $env{'request.course.id'}) {
3617: delete($live_courses{$key});
3618: }
3619: }
3620: }
3621:
3622: my $otheruser = 0;
3623: my %own_courses;
3624: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3625: # Resource belongs to user other than current user.
3626: $otheruser = 1;
3627: # Gather courses for current user
3628: %own_courses =
3629: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3630: }
3631:
3632: # Gather active course roles - course coordinator, instructor,
3633: # exam proctor, ta, student, or custom role.
1.474 raeburn 3634:
3635: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3636: my ($cdom,$cnum);
3637: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3638: $cdom = $env{'course.'.$course.'.domain'};
3639: $cnum = $env{'course.'.$course.'.num'};
3640: } else {
1.490 raeburn 3641: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3642: }
3643: my $no_ownblock = 0;
3644: my $no_userblock = 0;
1.533 raeburn 3645: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3646: # Check if current user has 'evb' priv for this
3647: if (defined($own_courses{$course})) {
3648: foreach my $sec (keys(%{$own_courses{$course}})) {
3649: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3650: if ($sec ne 'none') {
3651: $checkrole .= '/'.$sec;
3652: }
3653: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3654: $no_ownblock = 1;
3655: last;
3656: }
3657: }
3658: }
3659: # if they have 'evb' priv and are currently not playing student
3660: next if (($no_ownblock) &&
3661: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3662: }
1.474 raeburn 3663: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3664: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3665: if ($sec ne 'none') {
1.482 raeburn 3666: $checkrole .= '/'.$sec;
1.474 raeburn 3667: }
1.490 raeburn 3668: if ($otheruser) {
3669: # Resource belongs to user other than current user.
3670: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3671: my ($trole,$tdom,$tnum,$tsec);
3672: my $entry = $live_courses{$course}{$sec};
3673: if ($entry =~ /^cr/) {
3674: ($trole,$tdom,$tnum,$tsec) =
3675: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3676: } else {
3677: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3678: }
3679: my ($spec,$area,$trest,%allroles,%userroles);
3680: $area = '/'.$tdom.'/'.$tnum;
3681: $trest = $tnum;
3682: if ($tsec ne '') {
3683: $area .= '/'.$tsec;
3684: $trest .= '/'.$tsec;
3685: }
3686: $spec = $trole.'.'.$area;
3687: if ($trole =~ /^cr/) {
3688: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3689: $tdom,$spec,$trest,$area);
3690: } else {
3691: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3692: $tdom,$spec,$trest,$area);
3693: }
3694: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3695: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3696: if ($1) {
3697: $no_userblock = 1;
3698: last;
3699: }
3700: }
1.490 raeburn 3701: } else {
3702: # Resource belongs to current user
3703: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3704: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3705: $no_ownblock = 1;
3706: last;
3707: }
1.474 raeburn 3708: }
3709: }
3710: # if they have the evb priv and are currently not playing student
1.482 raeburn 3711: next if (($no_ownblock) &&
1.491 albertel 3712: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3713: next if ($no_userblock);
1.474 raeburn 3714:
1.490 raeburn 3715: # Retrieve blocking times and identity of blocker for course
3716: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3717:
3718: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3719: if (($start != 0) &&
3720: (($startblock == 0) || ($startblock > $start))) {
3721: $startblock = $start;
3722: }
3723: if (($end != 0) &&
3724: (($endblock == 0) || ($endblock < $end))) {
3725: $endblock = $end;
3726: }
1.490 raeburn 3727: }
3728: return ($startblock,$endblock);
3729: }
3730:
3731: sub get_blocks {
3732: my ($setters,$activity,$cdom,$cnum) = @_;
3733: my $startblock = 0;
3734: my $endblock = 0;
3735: my $course = $cdom.'_'.$cnum;
3736: $setters->{$course} = {};
3737: $setters->{$course}{'staff'} = [];
3738: $setters->{$course}{'times'} = [];
3739: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3740: foreach my $record (keys(%records)) {
3741: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3742: if ($start <= time && $end >= time) {
3743: my ($staff_name,$staff_dom,$title,$blocks) =
3744: &parse_block_record($records{$record});
3745: if ($blocks->{$activity} eq 'on') {
3746: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3747: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3748: if ( ($startblock == 0) || ($startblock > $start) ) {
3749: $startblock = $start;
1.490 raeburn 3750: }
1.491 albertel 3751: if ( ($endblock == 0) || ($endblock < $end) ) {
3752: $endblock = $end;
1.474 raeburn 3753: }
3754: }
3755: }
3756: }
3757: return ($startblock,$endblock);
3758: }
3759:
3760: sub parse_block_record {
3761: my ($record) = @_;
3762: my ($setuname,$setudom,$title,$blocks);
3763: if (ref($record) eq 'HASH') {
3764: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3765: $title = &unescape($record->{'event'});
3766: $blocks = $record->{'blocks'};
3767: } else {
3768: my @data = split(/:/,$record,3);
3769: if (scalar(@data) eq 2) {
3770: $title = $data[1];
3771: ($setuname,$setudom) = split(/@/,$data[0]);
3772: } else {
3773: ($setuname,$setudom,$title) = @data;
3774: }
3775: $blocks = { 'com' => 'on' };
3776: }
3777: return ($setuname,$setudom,$title,$blocks);
3778: }
3779:
3780: sub build_block_table {
3781: my ($startblock,$endblock,$setters) = @_;
3782: my %lt = &Apache::lonlocal::texthash(
3783: 'cacb' => 'Currently active communication blocks',
3784: 'cour' => 'Course',
3785: 'dura' => 'Duration',
3786: 'blse' => 'Block set by'
3787: );
3788: my $output;
1.476 raeburn 3789: $output = '<br />'.$lt{'cacb'}.':<br />';
1.474 raeburn 3790: $output .= &start_data_table();
3791: $output .= '
3792: <tr>
3793: <th>'.$lt{'cour'}.'</th>
3794: <th>'.$lt{'dura'}.'</th>
3795: <th>'.$lt{'blse'}.'</th>
3796: </tr>
3797: ';
3798: foreach my $course (keys(%{$setters})) {
3799: my %courseinfo=&Apache::lonnet::coursedescription($course);
3800: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
3801: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490 raeburn 3802: my $fullname = &plainname($uname,$udom);
3803: if (defined($env{'user.name'}) && defined($env{'user.domain'})
3804: && $env{'user.name'} ne 'public'
3805: && $env{'user.domain'} ne 'public') {
3806: $fullname = &aboutmewrapper($fullname,$uname,$udom);
3807: }
1.474 raeburn 3808: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
3809: $openblock = &Apache::lonlocal::locallocaltime($openblock);
3810: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
3811: $output .= &Apache::loncommon::start_data_table_row().
3812: '<td>'.$courseinfo{'description'}.'</td>'.
3813: '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490 raeburn 3814: '<td>'.$fullname.'</td>'.
1.474 raeburn 3815: &Apache::loncommon::end_data_table_row();
3816: }
3817: }
3818: $output .= &end_data_table();
3819: }
3820:
1.490 raeburn 3821: sub blocking_status {
3822: my ($activity,$uname,$udom) = @_;
3823: my %setters;
3824: my ($blocked,$output,$ownitem,$is_course);
3825: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
3826: if ($startblock && $endblock) {
3827: $blocked = 1;
3828: if (wantarray) {
3829: my $category;
3830: if ($activity eq 'boards') {
3831: $category = 'Discussion posts in this course';
3832: } elsif ($activity eq 'blogs') {
3833: $category = 'Blogs';
3834: } elsif ($activity eq 'port') {
3835: if (defined($uname) && defined($udom)) {
3836: if ($uname eq $env{'user.name'} &&
3837: $udom eq $env{'user.domain'}) {
3838: $ownitem = 1;
3839: }
3840: }
3841: $is_course = &Apache::lonnet::is_course($udom,$uname);
3842: if ($ownitem) {
3843: $category = 'Your portfolio files';
3844: } elsif ($is_course) {
3845: my $coursedesc;
3846: foreach my $course (keys(%setters)) {
3847: my %courseinfo =
3848: &Apache::lonnet::coursedescription($course);
3849: $coursedesc = $courseinfo{'description'};
3850: }
1.764 weissno 3851: $category = "Group portfolio in the course '$coursedesc'";
1.490 raeburn 3852: } else {
3853: $category = 'Portfolio files belonging to ';
3854: if ($env{'user.name'} eq 'public' &&
3855: $env{'user.domain'} eq 'public') {
3856: $category .= &plainname($uname,$udom);
3857: } else {
3858: $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);
3859: }
3860: }
3861: } elsif ($activity eq 'groups') {
3862: $category = 'Groups in this course';
3863: }
3864: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
3865: my $showend = &Apache::lonlocal::locallocaltime($endblock);
3866: $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
3867: if (!($activity eq 'port' && !($ownitem) && !($is_course))) {
3868: $output .= &build_block_table($startblock,$endblock,\%setters);
3869: }
3870: }
3871: }
3872: if (wantarray) {
3873: return ($blocked,$output);
3874: } else {
3875: return $blocked;
3876: }
3877: }
3878:
1.60 matthew 3879: ###############################################
3880:
1.682 raeburn 3881: sub check_ip_acc {
3882: my ($acc)=@_;
3883: &Apache::lonxml::debug("acc is $acc");
3884: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
3885: return 1;
3886: }
3887: my $allowed=0;
3888: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
3889:
3890: my $name;
3891: foreach my $pattern (split(',',$acc)) {
3892: $pattern =~ s/^\s*//;
3893: $pattern =~ s/\s*$//;
3894: if ($pattern =~ /\*$/) {
3895: #35.8.*
3896: $pattern=~s/\*//;
3897: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3898: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
3899: #35.8.3.[34-56]
3900: my $low=$2;
3901: my $high=$3;
3902: $pattern=$1;
3903: if ($ip =~ /^\Q$pattern\E/) {
3904: my $last=(split(/\./,$ip))[3];
3905: if ($last <=$high && $last >=$low) { $allowed=1; }
3906: }
3907: } elsif ($pattern =~ /^\*/) {
3908: #*.msu.edu
3909: $pattern=~s/\*//;
3910: if (!defined($name)) {
3911: use Socket;
3912: my $netaddr=inet_aton($ip);
3913: ($name)=gethostbyaddr($netaddr,AF_INET);
3914: }
3915: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3916: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
3917: #127.0.0.1
3918: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3919: } else {
3920: #some.name.com
3921: if (!defined($name)) {
3922: use Socket;
3923: my $netaddr=inet_aton($ip);
3924: ($name)=gethostbyaddr($netaddr,AF_INET);
3925: }
3926: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3927: }
3928: if ($allowed) { last; }
3929: }
3930: return $allowed;
3931: }
3932:
3933: ###############################################
3934:
1.60 matthew 3935: =pod
3936:
1.112 bowersj2 3937: =head1 Domain Template Functions
3938:
3939: =over 4
3940:
3941: =item * &determinedomain()
1.60 matthew 3942:
3943: Inputs: $domain (usually will be undef)
3944:
1.63 www 3945: Returns: Determines which domain should be used for designs
1.60 matthew 3946:
3947: =cut
1.54 www 3948:
1.60 matthew 3949: ###############################################
1.63 www 3950: sub determinedomain {
3951: my $domain=shift;
1.531 albertel 3952: if (! $domain) {
1.60 matthew 3953: # Determine domain if we have not been given one
3954: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258 albertel 3955: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
3956: if ($env{'request.role.domain'}) {
3957: $domain=$env{'request.role.domain'};
1.60 matthew 3958: }
3959: }
1.63 www 3960: return $domain;
3961: }
3962: ###############################################
1.517 raeburn 3963:
1.518 albertel 3964: sub devalidate_domconfig_cache {
3965: my ($udom)=@_;
3966: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
3967: }
3968:
3969: # ---------------------- Get domain configuration for a domain
3970: sub get_domainconf {
3971: my ($udom) = @_;
3972: my $cachetime=1800;
3973: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
3974: if (defined($cached)) { return %{$result}; }
3975:
3976: my %domconfig = &Apache::lonnet::get_dom('configuration',
3977: ['login','rolecolors'],$udom);
1.632 raeburn 3978: my (%designhash,%legacy);
1.518 albertel 3979: if (keys(%domconfig) > 0) {
3980: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 3981: if (keys(%{$domconfig{'login'}})) {
3982: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 3983: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
3984: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
3985: $designhash{$udom.'.login.'.$key.'_'.$img} =
3986: $domconfig{'login'}{$key}{$img};
3987: }
3988: } else {
3989: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
3990: }
1.632 raeburn 3991: }
3992: } else {
3993: $legacy{'login'} = 1;
1.518 albertel 3994: }
1.632 raeburn 3995: } else {
3996: $legacy{'login'} = 1;
1.518 albertel 3997: }
3998: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 3999: if (keys(%{$domconfig{'rolecolors'}})) {
4000: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4001: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4002: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4003: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4004: }
1.518 albertel 4005: }
4006: }
1.632 raeburn 4007: } else {
4008: $legacy{'rolecolors'} = 1;
1.518 albertel 4009: }
1.632 raeburn 4010: } else {
4011: $legacy{'rolecolors'} = 1;
1.518 albertel 4012: }
1.632 raeburn 4013: if (keys(%legacy) > 0) {
4014: my %legacyhash = &get_legacy_domconf($udom);
4015: foreach my $item (keys(%legacyhash)) {
4016: if ($item =~ /^\Q$udom\E\.login/) {
4017: if ($legacy{'login'}) {
4018: $designhash{$item} = $legacyhash{$item};
4019: }
4020: } else {
4021: if ($legacy{'rolecolors'}) {
4022: $designhash{$item} = $legacyhash{$item};
4023: }
1.518 albertel 4024: }
4025: }
4026: }
1.632 raeburn 4027: } else {
4028: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4029: }
4030: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4031: $cachetime);
4032: return %designhash;
4033: }
4034:
1.632 raeburn 4035: sub get_legacy_domconf {
4036: my ($udom) = @_;
4037: my %legacyhash;
4038: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4039: my $designfile = $designdir.'/'.$udom.'.tab';
4040: if (-e $designfile) {
4041: if ( open (my $fh,"<$designfile") ) {
4042: while (my $line = <$fh>) {
4043: next if ($line =~ /^\#/);
4044: chomp($line);
4045: my ($key,$val)=(split(/\=/,$line));
4046: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4047: }
4048: close($fh);
4049: }
4050: }
4051: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4052: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4053: }
4054: return %legacyhash;
4055: }
4056:
1.63 www 4057: =pod
4058:
1.112 bowersj2 4059: =item * &domainlogo()
1.63 www 4060:
4061: Inputs: $domain (usually will be undef)
4062:
4063: Returns: A link to a domain logo, if the domain logo exists.
4064: If the domain logo does not exist, a description of the domain.
4065:
4066: =cut
1.112 bowersj2 4067:
1.63 www 4068: ###############################################
4069: sub domainlogo {
1.517 raeburn 4070: my $domain = &determinedomain(shift);
1.518 albertel 4071: my %designhash = &get_domainconf($domain);
1.517 raeburn 4072: # See if there is a logo
4073: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4074: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4075: if ($imgsrc =~ m{^/(adm|res)/}) {
4076: if ($imgsrc =~ m{^/res/}) {
4077: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4078: &Apache::lonnet::repcopy($local_name);
4079: }
4080: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4081: }
4082: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4083: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4084: return &Apache::lonnet::domain($domain,'description');
1.59 www 4085: } else {
1.60 matthew 4086: return '';
1.59 www 4087: }
4088: }
1.63 www 4089: ##############################################
4090:
4091: =pod
4092:
1.112 bowersj2 4093: =item * &designparm()
1.63 www 4094:
4095: Inputs: $which parameter; $domain (usually will be undef)
4096:
4097: Returns: value of designparamter $which
4098:
4099: =cut
1.112 bowersj2 4100:
1.397 albertel 4101:
1.400 albertel 4102: ##############################################
1.397 albertel 4103: sub designparm {
4104: my ($which,$domain)=@_;
1.258 albertel 4105: if ($env{'browser.blackwhite'} eq 'on') {
1.635 raeburn 4106: if ($which=~/\.(font|alink|vlink|link|textcol)$/) {
1.110 www 4107: return '#000000';
4108: }
1.635 raeburn 4109: if ($which=~/\.(pgbg|sidebg|bgcol)$/) {
1.110 www 4110: return '#FFFFFF';
4111: }
4112: if ($which=~/\.tabbg$/) {
4113: return '#CCCCCC';
4114: }
4115: }
1.397 albertel 4116: if (exists($env{'environment.color.'.$which})) {
1.258 albertel 4117: return $env{'environment.color.'.$which};
1.96 www 4118: }
1.63 www 4119: $domain=&determinedomain($domain);
1.518 albertel 4120: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4121: my $output;
1.517 raeburn 4122: if ($domdesign{$domain.'.'.$which} ne '') {
1.520 raeburn 4123: $output = $domdesign{$domain.'.'.$which};
1.63 www 4124: } else {
1.520 raeburn 4125: $output = $defaultdesign{$which};
4126: }
4127: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4128: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4129: if ($output =~ m{^/(adm|res)/}) {
4130: if ($output =~ m{^/res/}) {
4131: my $local_name = &Apache::lonnet::filelocation('',$output);
4132: &Apache::lonnet::repcopy($local_name);
4133: }
1.520 raeburn 4134: $output = &lonhttpdurl($output);
4135: }
1.63 www 4136: }
1.520 raeburn 4137: return $output;
1.63 www 4138: }
1.59 www 4139:
1.60 matthew 4140: ###############################################
4141: ###############################################
4142:
4143: =pod
4144:
1.112 bowersj2 4145: =back
4146:
1.549 albertel 4147: =head1 HTML Helpers
1.112 bowersj2 4148:
4149: =over 4
4150:
4151: =item * &bodytag()
1.60 matthew 4152:
4153: Returns a uniform header for LON-CAPA web pages.
4154:
4155: Inputs:
4156:
1.112 bowersj2 4157: =over 4
4158:
4159: =item * $title, A title to be displayed on the page.
4160:
4161: =item * $function, the current role (can be undef).
4162:
4163: =item * $addentries, extra parameters for the <body> tag.
4164:
4165: =item * $bodyonly, if defined, only return the <body> tag.
4166:
4167: =item * $domain, if defined, force a given domain.
4168:
4169: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4170: text interface only)
1.60 matthew 4171:
1.326 albertel 4172: =item * $customtitle, alternate text to use instead of $title
4173: in the title box that appears, this text
4174: is not auto translated like the $title is
1.309 albertel 4175:
4176: =item * $notopbar, if true, keep the 'what is this' info but remove the
4177: navigational links
1.317 albertel 4178:
1.338 albertel 4179: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4180:
4181: =item * $notitle, if true keep the nav controls, but remove the title bar
4182:
1.361 albertel 4183: =item * $no_inline_link, if true and in remote mode, don't show the
4184: 'Switch To Inline Menu' link
4185:
1.460 albertel 4186: =item * $args, optional argument valid values are
4187: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4188: inherit_jsmath -> when creating popup window in a page,
4189: should it have jsmath forced on by the
4190: current page
1.460 albertel 4191:
1.112 bowersj2 4192: =back
4193:
1.60 matthew 4194: Returns: A uniform header for LON-CAPA web pages.
4195: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4196: If $bodyonly is undef or zero, an html string containing a <body> tag and
4197: other decorations will be returned.
4198:
4199: =cut
4200:
1.54 www 4201: sub bodytag {
1.309 albertel 4202: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.460 albertel 4203: $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
1.339 albertel 4204:
1.460 albertel 4205: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4206:
1.183 matthew 4207: $function = &get_users_function() if (!$function);
1.339 albertel 4208: my $img = &designparm($function.'.img',$domain);
4209: my $font = &designparm($function.'.font',$domain);
4210: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4211:
4212: my %design = ( 'style' => 'margin-top: 0px',
1.535 albertel 4213: 'bgcolor' => $pgbg,
1.339 albertel 4214: 'text' => $font,
4215: 'alink' => &designparm($function.'.alink',$domain),
4216: 'vlink' => &designparm($function.'.vlink',$domain),
4217: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4218: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4219:
1.63 www 4220: # role and realm
1.378 raeburn 4221: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4222: if ($role eq 'ca') {
1.479 albertel 4223: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4224: $realm = &plainname($rname,$rdom);
1.378 raeburn 4225: }
1.55 www 4226: # realm
1.258 albertel 4227: if ($env{'request.course.id'}) {
1.378 raeburn 4228: if ($env{'request.role'} !~ /^cr/) {
4229: $role = &Apache::lonnet::plaintext($role,&course_type());
4230: }
1.359 albertel 4231: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4232: } else {
4233: $role = &Apache::lonnet::plaintext($role);
1.54 www 4234: }
1.433 albertel 4235:
1.359 albertel 4236: if (!$realm) { $realm=' '; }
1.55 www 4237: # Set messages
1.60 matthew 4238: my $messages=&domainlogo($domain);
1.330 albertel 4239:
1.438 albertel 4240: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4241:
1.101 www 4242: # construct main body tag
1.359 albertel 4243: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4244: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4245:
1.530 albertel 4246: if ($bodyonly) {
1.60 matthew 4247: return $bodytag;
1.258 albertel 4248: } elsif ($env{'browser.interface'} eq 'textual') {
1.95 www 4249: # Accessibility
1.224 raeburn 4250:
1.337 albertel 4251: $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
1.338 albertel 4252: if (!$notitle) {
1.337 albertel 4253: $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
4254: }
4255: return $bodytag;
1.359 albertel 4256: }
4257:
1.410 albertel 4258: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4259: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4260: undef($role);
1.434 albertel 4261: } else {
4262: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4263: }
1.359 albertel 4264:
4265: my $roleinfo=(<<ENDROLE);
4266: <td class="LC_title_bar_who">
4267: <div class="LC_title_bar_name">
1.410 albertel 4268: $name
1.361 albertel 4269:
1.359 albertel 4270: </div>
4271: <div class="LC_title_bar_role">
1.361 albertel 4272: $role
1.359 albertel 4273: </div>
4274: <div class="LC_title_bar_realm">
1.361 albertel 4275: $realm
1.359 albertel 4276: </div>
1.206 albertel 4277: </td>
4278: ENDROLE
1.235 raeburn 4279:
1.762 bisitz 4280: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4281: if ($customtitle) {
4282: $titleinfo = $customtitle;
4283: }
4284: #
4285: # Extra info if you are the DC
4286: my $dc_info = '';
4287: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4288: $env{'course.'.$env{'request.course.id'}.
4289: '.domain'}.'/'})) {
4290: my $cid = $env{'request.course.id'};
4291: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4292: $dc_info =~ s/\s+$//;
1.359 albertel 4293: $dc_info = '('.$dc_info.')';
4294: }
4295:
1.644 www 4296: if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359 albertel 4297: # No Remote
1.258 albertel 4298: if ($env{'request.state'} eq 'construct') {
1.359 albertel 4299: $forcereg=1;
4300: }
4301:
4302: if (!$customtitle && $env{'request.state'} eq 'construct') {
4303: # this is for resources; directories have customtitle, and crumbs
4304: # and select recent are created in lonpubdir.pm
1.229 albertel 4305: my ($uname,$thisdisfn)=
1.258 albertel 4306: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229 albertel 4307: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4308: $formaction=~s/\/+/\//g;
4309:
1.359 albertel 4310: my $parentpath = '';
4311: my $lastitem = '';
4312: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4313: $parentpath = $1;
4314: $lastitem = $2;
4315: } else {
4316: $lastitem = $thisdisfn;
4317: }
4318: $titleinfo =
1.640 bisitz 4319: &Apache::loncommon::help_open_menu('','',3,'Authoring')
4320: .'<b>'.&mt('Construction Space').'</b>: '
4321: .'<form name="dirs" method="post" action="'.$formaction
1.359 albertel 4322: .'" target="_top"><tt><b>'
1.705 tempelho 4323: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<span class=\"LC_fontsize_big\">$lastitem</span></b></tt><br />"
1.359 albertel 4324: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4325: .'</form>'
4326: .&Apache::lonmenu::constspaceform();
1.235 raeburn 4327: }
1.359 albertel 4328:
1.337 albertel 4329: my $titletable;
1.338 albertel 4330: if (!$notitle) {
1.337 albertel 4331: $titletable =
1.359 albertel 4332: '<table id="LC_title_bar">'.
4333: "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
4334: '</tr></table>';
1.337 albertel 4335: }
1.359 albertel 4336: if ($notopbar) {
4337: $bodytag .= $titletable;
4338: } else {
4339: if ($env{'request.state'} eq 'construct') {
1.337 albertel 4340: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
4341: $titletable);
1.272 raeburn 4342: } else {
1.336 albertel 4343: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359 albertel 4344: $titletable;
1.272 raeburn 4345: }
1.235 raeburn 4346: }
4347: return $bodytag;
1.94 www 4348: }
1.95 www 4349:
1.93 www 4350: #
1.95 www 4351: # Top frame rendering, Remote is up
1.93 www 4352: #
1.359 albertel 4353:
1.517 raeburn 4354: my $imgsrc = $img;
4355: if ($img =~ /^\/adm/) {
1.575 albertel 4356: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4357: }
4358: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4359:
1.305 www 4360: # Explicit link to get inline menu
1.361 albertel 4361: my $menu= ($no_inline_link?''
4362: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245 matthew 4363: #
1.338 albertel 4364: if ($notitle) {
1.337 albertel 4365: return $bodytag;
4366: }
1.94 www 4367: return(<<ENDBODY);
1.60 matthew 4368: $bodytag
1.359 albertel 4369: <table id="LC_title_bar" class="LC_with_remote">
1.368 albertel 4370: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
1.359 albertel 4371: <td class="LC_title_bar_domain_logo">$messages </td>
1.54 www 4372: </tr>
1.359 albertel 4373: <tr><td>$titleinfo $dc_info $menu</td>
4374: $roleinfo
1.368 albertel 4375: </tr>
1.356 albertel 4376: </table>
1.54 www 4377: ENDBODY
1.182 matthew 4378: }
4379:
1.330 albertel 4380: sub make_attr_string {
4381: my ($register,$attr_ref) = @_;
4382:
4383: if ($attr_ref && !ref($attr_ref)) {
4384: die("addentries Must be a hash ref ".
4385: join(':',caller(1))." ".
4386: join(':',caller(0))." ");
4387: }
4388:
4389: if ($register) {
1.339 albertel 4390: my ($on_load,$on_unload);
4391: foreach my $key (keys(%{$attr_ref})) {
4392: if (lc($key) eq 'onload') {
4393: $on_load.=$attr_ref->{$key}.';';
4394: delete($attr_ref->{$key});
4395:
4396: } elsif (lc($key) eq 'onunload') {
4397: $on_unload.=$attr_ref->{$key}.';';
4398: delete($attr_ref->{$key});
4399: }
4400: }
4401: $attr_ref->{'onload'} =
4402: &Apache::lonmenu::loadevents(). $on_load;
4403: $attr_ref->{'onunload'}=
4404: &Apache::lonmenu::unloadevents().$on_unload;
4405: }
4406:
4407: # Accessibility font enhance
4408: if ($env{'browser.fontenhance'} eq 'on') {
4409: my $style;
4410: foreach my $key (keys(%{$attr_ref})) {
4411: if (lc($key) eq 'style') {
4412: $style.=$attr_ref->{$key}.';';
4413: delete($attr_ref->{$key});
4414: }
4415: }
4416: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4417: }
1.339 albertel 4418:
4419: if ($env{'browser.blackwhite'} eq 'on') {
4420: delete($attr_ref->{'font'});
4421: delete($attr_ref->{'link'});
4422: delete($attr_ref->{'alink'});
4423: delete($attr_ref->{'vlink'});
4424: delete($attr_ref->{'bgcolor'});
4425: delete($attr_ref->{'background'});
4426: }
4427:
1.330 albertel 4428: my $attr_string;
4429: foreach my $attr (keys(%$attr_ref)) {
4430: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4431: }
4432: return $attr_string;
4433: }
4434:
4435:
1.182 matthew 4436: ###############################################
1.251 albertel 4437: ###############################################
4438:
4439: =pod
4440:
4441: =item * &endbodytag()
4442:
4443: Returns a uniform footer for LON-CAPA web pages.
4444:
1.635 raeburn 4445: Inputs: 1 - optional reference to an args hash
4446: If in the hash, key for noredirectlink has a value which evaluates to true,
4447: a 'Continue' link is not displayed if the page contains an
4448: internal redirect in the <head></head> section,
4449: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4450:
4451: =cut
4452:
4453: sub endbodytag {
1.635 raeburn 4454: my ($args) = @_;
1.251 albertel 4455: my $endbodytag='</body>';
1.269 albertel 4456: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4457: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4458: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4459: $endbodytag=
4460: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4461: &mt('Continue').'</a>'.
4462: $endbodytag;
4463: }
1.315 albertel 4464: }
1.251 albertel 4465: return $endbodytag;
4466: }
4467:
1.352 albertel 4468: =pod
4469:
4470: =item * &standard_css()
4471:
4472: Returns a style sheet
4473:
4474: Inputs: (all optional)
4475: domain -> force to color decorate a page for a specific
4476: domain
4477: function -> force usage of a specific rolish color scheme
4478: bgcolor -> override the default page bgcolor
4479:
4480: =cut
4481:
1.343 albertel 4482: sub standard_css {
1.345 albertel 4483: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4484: $function = &get_users_function() if (!$function);
4485: my $img = &designparm($function.'.img', $domain);
4486: my $tabbg = &designparm($function.'.tabbg', $domain);
4487: my $font = &designparm($function.'.font', $domain);
1.345 albertel 4488: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4489: my $pgbg_or_bgcolor =
4490: $bgcolor ||
1.352 albertel 4491: &designparm($function.'.pgbg', $domain);
1.382 albertel 4492: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4493: my $alink = &designparm($function.'.alink', $domain);
4494: my $vlink = &designparm($function.'.vlink', $domain);
4495: my $link = &designparm($function.'.link', $domain);
4496:
1.704 muellerd 4497: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4498: my $bgcol = &designparm('login.bgcol',$domain);
4499: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4500:
1.602 albertel 4501: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4502: my $mono = 'monospace';
1.352 albertel 4503: my $data_table_head = $tabbg;
4504: my $data_table_light = '#EEEEEE';
1.470 banghart 4505: my $data_table_dark = '#DDDDDD';
4506: my $data_table_darker = '#CCCCCC';
1.349 albertel 4507: my $data_table_highlight = '#FFFF00';
1.352 albertel 4508: my $mail_new = '#FFBB77';
4509: my $mail_new_hover = '#DD9955';
4510: my $mail_read = '#BBBB77';
4511: my $mail_read_hover = '#999944';
4512: my $mail_replied = '#AAAA88';
4513: my $mail_replied_hover = '#888855';
4514: my $mail_other = '#99BBBB';
4515: my $mail_other_hover = '#669999';
1.391 albertel 4516: my $table_header = '#DDDDDD';
1.489 raeburn 4517: my $feedback_link_bg = '#BBBBBB';
1.701 harmsja 4518: my $lg_border_color = '#C8C8C8';
1.392 albertel 4519:
1.608 albertel 4520: my $border = ($env{'browser.type'} eq 'explorer' ||
4521: $env{'browser.type'} eq 'safari' ) ? '0px 2px 0px 2px'
4522: : '0px 3px 0px 4px';
1.448 albertel 4523:
1.523 albertel 4524:
1.343 albertel 4525: return <<END;
1.698 harmsja 4526: body{
4527: font-family: $sans;
4528: line-height:130%;
1.701 harmsja 4529: font-size:0.83em;
1.698 harmsja 4530: color:$font;
4531: }
1.701 harmsja 4532: a:link, a:visited { font-size:100%; }
1.698 harmsja 4533:
1.779 bisitz 4534: a:focus { color: red; background: yellow }
1.510 albertel 4535: table.thinborder,
4536: table.thinborder tr th {
4537: border-style: solid;
4538: border-width: 1px;
1.698 harmsja 4539: border-color: $lg_border_color;
1.510 albertel 4540: background: $tabbg;
4541: }
1.523 albertel 4542: table.thinborder tr td {
1.510 albertel 4543: border-style: solid;
1.698 harmsja 4544: border-width: 1px;
4545: border-color: $lg_border_color;
1.510 albertel 4546: }
1.426 albertel 4547:
1.343 albertel 4548: form, .inline { display: inline; }
1.721 harmsja 4549:
4550: .LC_right {text-align:right;}
4551: .LC_middle {vertical-align:middle;}
4552:
4553: /* just for tests */
1.754 droeschl 4554: .LC_400Box {width:400px; }
1.721 harmsja 4555: /* end */
4556:
1.778 bisitz 4557: .LC_filename {
4558: font-family: $mono;
4559: white-space:pre;
4560: }
4561:
4562: .LC_fileicon {
4563: border: none;
4564: height: 1.3em;
4565: vertical-align: text-bottom;
4566: margin-right: 0.3em;
4567: text-decoration:none;
4568: }
4569:
1.350 albertel 4570: .LC_error {
4571: color: red;
4572: font-size: larger;
4573: }
1.457 albertel 4574: .LC_warning,
4575: .LC_diff_removed {
1.733 bisitz 4576: color: red;
1.394 albertel 4577: }
1.532 albertel 4578:
4579: .LC_info,
1.457 albertel 4580: .LC_success,
4581: .LC_diff_added {
1.350 albertel 4582: color: green;
4583: }
1.543 albertel 4584: .LC_unknown {
4585: color: yellow;
4586: }
4587:
1.440 albertel 4588: .LC_icon {
1.771 droeschl 4589: border: none;
1.790 ! droeschl 4590: vertical-align: middle;
1.771 droeschl 4591: }
4592:
1.539 albertel 4593: .LC_indexer_icon {
4594: border: 0px;
4595: height: 22px;
4596: }
1.543 albertel 4597: .LC_docs_spacer {
4598: width: 25px;
4599: height: 1px;
1.771 droeschl 4600: border: none;
1.543 albertel 4601: }
1.346 albertel 4602:
1.532 albertel 4603: .LC_internal_info {
1.735 bisitz 4604: color: #999999;
1.532 albertel 4605: }
4606:
1.458 albertel 4607: table.LC_pastsubmission {
4608: border: 1px solid black;
4609: margin: 2px;
4610: }
4611:
1.606 albertel 4612: table#LC_top_nav, table#LC_menubuttons,table#LC_nav_location {
1.345 albertel 4613: width: 100%;
4614: background: $pgbg;
1.392 albertel 4615: border: 2px;
1.402 albertel 4616: border-collapse: separate;
1.403 albertel 4617: padding: 0px;
1.345 albertel 4618: }
1.392 albertel 4619:
1.779 bisitz 4620: table#LC_title_bar, table.LC_breadcrumbs,
1.393 albertel 4621: table#LC_title_bar.LC_with_remote {
1.359 albertel 4622: width: 100%;
1.392 albertel 4623: border-color: $pgbg;
4624: border-style: solid;
4625: border-width: $border;
4626:
1.379 albertel 4627: background: $pgbg;
4628: font-family: $sans;
1.392 albertel 4629: border-collapse: collapse;
1.403 albertel 4630: padding: 0px;
1.359 albertel 4631: }
1.409 albertel 4632: table.LC_docs_path {
4633: width: 100%;
4634: border: 0;
4635: background: $pgbg;
4636: font-family: $sans;
4637: border-collapse: collapse;
4638: padding: 0px;
4639: }
4640:
1.359 albertel 4641: table#LC_title_bar td {
4642: background: $tabbg;
4643: }
1.773 ehlerst 4644: table#LC_title_bar .LC_title_bar_who {
1.359 albertel 4645: background: $tabbg;
4646: color: $font;
1.427 albertel 4647: font: small $sans;
1.359 albertel 4648: text-align: right;
1.773 ehlerst 4649: margin: 0px;
4650: }
4651: table#LC_title_bar .LC_title_bar_name {
4652: margin: 0px;
4653: }
4654: table#LC_title_bar .LC_title_bar_role {
4655: margin: 0px;
4656: }
1.775 bisitz 4657: table#LC_title_bar .LC_title_bar_realm {
1.773 ehlerst 4658: margin: 0px;
1.359 albertel 4659: }
1.469 banghart 4660: span.LC_metadata {
4661: font-family: $sans;
4662: }
1.359 albertel 4663: table#LC_title_bar td.LC_title_bar_domain_logo {
4664: background: $sidebg;
4665: text-align: right;
1.368 albertel 4666: padding: 0px;
4667: }
4668: table#LC_title_bar td.LC_title_bar_role_logo {
4669: background: $sidebg;
4670: padding: 0px;
1.359 albertel 4671: }
4672:
1.706 harmsja 4673: table#LC_menubuttons img{
1.346 albertel 4674: border: 0px;
4675: }
1.345 albertel 4676: table#LC_top_nav td {
4677: background: $tabbg;
1.392 albertel 4678: border: 0px;
1.407 albertel 4679: font-size: small;
1.706 harmsja 4680: vertical-align:top;
4681: padding:2px 5px 2px 5px;
1.345 albertel 4682: }
4683: table#LC_top_nav td a, div#LC_top_nav a {
4684: color: $font;
4685: font-family: $sans;
4686: }
1.364 albertel 4687: table#LC_top_nav td.LC_top_nav_logo {
4688: background: $tabbg;
1.432 albertel 4689: text-align: left;
1.408 albertel 4690: white-space: nowrap;
1.432 albertel 4691: width: 31px;
1.408 albertel 4692: }
4693: table#LC_top_nav td.LC_top_nav_logo img {
1.432 albertel 4694: border: 0px;
1.408 albertel 4695: vertical-align: bottom;
1.364 albertel 4696: }
1.777 tempelho 4697: table#LC_top_nav td.LC_top_nav_exit,
1.779 bisitz 4698: table#LC_top_nav td.LC_top_nav_help {
1.777 tempelho 4699: width: 2.0em;
4700: }
1.442 albertel 4701: table#LC_top_nav td.LC_top_nav_login {
4702: width: 4.0em;
4703: text-align: center;
4704: }
1.409 albertel 4705: table.LC_breadcrumbs td, table.LC_docs_path td {
1.357 albertel 4706: background: $tabbg;
4707: color: $font;
4708: font-family: $sans;
1.358 albertel 4709: font-size: smaller;
1.357 albertel 4710: }
1.777 tempelho 4711: table.LC_breadcrumbs td.LC_breadcrumbs_component,
4712: table.LC_docs_path td.LC_docs_path_component {
1.779 bisitz 4713: background: $tabbg;
1.777 tempelho 4714: color: $font;
4715: font-family: $sans;
1.779 bisitz 4716: font-size: larger;
4717: text-align: right;
1.777 tempelho 4718: }
1.383 albertel 4719: td.LC_table_cell_checkbox {
4720: text-align: center;
4721: }
1.779 bisitz 4722: table#LC_mainmenu td.LC_mainmenu_column {
4723: vertical-align: top;
1.777 tempelho 4724: }
1.522 albertel 4725:
1.705 tempelho 4726: .LC_fontsize_small
4727: {
4728: font-size: 70%;
4729: }
4730:
4731: .LC_fontsize_medium
4732: {
4733: font-size: 85%;
4734: }
4735:
4736: .LC_fontsize_large
4737: {
4738: font-size: 120%;
4739: }
4740:
1.346 albertel 4741: .LC_menubuttons_inline_text {
4742: color: $font;
4743: font-family: $sans;
1.698 harmsja 4744: font-size: 90%;
1.701 harmsja 4745: padding-left:3px;
1.346 albertel 4746: }
4747:
1.526 www 4748: .LC_menubuttons_link {
4749: text-decoration: none;
4750: }
1.698 harmsja 4751: /*2008--9-5: new menu style sheet.Changed category*/
1.522 albertel 4752: .LC_menubuttons_category {
1.521 www 4753: color: $font;
1.526 www 4754: background: $pgbg;
1.521 www 4755: font-family: $sans;
4756: font-size: larger;
4757: font-weight: bold;
4758: }
4759:
1.346 albertel 4760: td.LC_menubuttons_text {
1.779 bisitz 4761: color: $font;
1.346 albertel 4762: }
1.706 harmsja 4763:
4764:
1.526 www 4765:
1.346 albertel 4766: .LC_current_location {
4767: font-family: $sans;
4768: background: $tabbg;
4769: }
4770: .LC_new_mail {
4771: font-family: $sans;
1.634 www 4772: background: $tabbg;
1.346 albertel 4773: font-weight: bold;
4774: }
1.347 albertel 4775:
1.526 www 4776:
1.527 www 4777: .LC_dropadd_labeltext {
4778: font-family: $sans;
4779: text-align: right;
4780: }
4781:
4782: .LC_preferences_labeltext {
4783: font-family: $sans;
4784: text-align: right;
4785: }
4786:
1.666 raeburn 4787: .LC_roleslog_note {
1.701 harmsja 4788: font-size: small;
1.666 raeburn 4789: }
4790:
1.715 raeburn 4791: .LC_mail_functions {
4792: font-weight: bold;
4793: }
4794:
1.440 albertel 4795: table.LC_aboutme_port {
4796: border: 0px;
4797: border-collapse: collapse;
4798: border-spacing: 0px;
4799: }
1.349 albertel 4800: table.LC_data_table, table.LC_mail_list {
1.347 albertel 4801: border: 1px solid #000000;
1.402 albertel 4802: border-collapse: separate;
1.426 albertel 4803: border-spacing: 1px;
1.610 albertel 4804: background: $pgbg;
1.347 albertel 4805: }
1.422 albertel 4806: .LC_data_table_dense {
4807: font-size: small;
4808: }
1.507 raeburn 4809: table.LC_nested_outer {
4810: border: 1px solid #000000;
1.589 raeburn 4811: border-collapse: collapse;
1.507 raeburn 4812: border-spacing: 0px;
4813: width: 100%;
4814: }
4815: table.LC_nested {
4816: border: 0px;
1.589 raeburn 4817: border-collapse: collapse;
1.507 raeburn 4818: border-spacing: 0px;
4819: width: 100%;
4820: }
1.523 albertel 4821: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
4822: table.LC_prior_tries tr th {
1.349 albertel 4823: font-weight: bold;
4824: background-color: $data_table_head;
1.701 harmsja 4825: font-size:90%;
1.347 albertel 4826: }
1.711 raeburn 4827: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 4828: background-color: #CCCCCC;
1.711 raeburn 4829: font-weight: bold;
4830: text-align: left;
4831: }
1.779 bisitz 4832: table.LC_data_table tr.LC_odd_row > td,
1.709 bisitz 4833: table.LC_pick_box tr > td.LC_odd_row,
1.440 albertel 4834: table.LC_aboutme_port tr td {
1.349 albertel 4835: background-color: $data_table_light;
1.425 albertel 4836: padding: 2px;
1.347 albertel 4837: }
1.610 albertel 4838: table.LC_data_table tr.LC_even_row > td,
1.709 bisitz 4839: table.LC_pick_box tr > td.LC_even_row,
1.440 albertel 4840: table.LC_aboutme_port tr.LC_even_row td {
1.349 albertel 4841: background-color: $data_table_dark;
1.709 bisitz 4842: padding: 2px;
1.347 albertel 4843: }
1.425 albertel 4844: table.LC_data_table tr.LC_data_table_highlight td {
4845: background-color: $data_table_darker;
4846: }
1.639 raeburn 4847: table.LC_data_table tr td.LC_leftcol_header {
4848: background-color: $data_table_head;
4849: font-weight: bold;
4850: }
1.451 albertel 4851: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 4852: table.LC_nested tr.LC_empty_row td {
1.347 albertel 4853: background-color: #FFFFFF;
1.421 albertel 4854: font-weight: bold;
4855: font-style: italic;
4856: text-align: center;
4857: padding: 8px;
1.347 albertel 4858: }
1.507 raeburn 4859: table.LC_nested tr.LC_empty_row td {
1.465 albertel 4860: padding: 4ex
4861: }
1.507 raeburn 4862: table.LC_nested_outer tr th {
4863: font-weight: bold;
4864: background-color: $data_table_head;
1.701 harmsja 4865: font-size: small;
1.507 raeburn 4866: border-bottom: 1px solid #000000;
4867: }
4868: table.LC_nested_outer tr td.LC_subheader {
4869: background-color: $data_table_head;
4870: font-weight: bold;
4871: font-size: small;
4872: border-bottom: 1px solid #000000;
4873: text-align: right;
1.451 albertel 4874: }
1.507 raeburn 4875: table.LC_nested tr.LC_info_row td {
1.735 bisitz 4876: background-color: #CCCCCC;
1.451 albertel 4877: font-weight: bold;
4878: font-size: small;
1.507 raeburn 4879: text-align: center;
4880: }
1.589 raeburn 4881: table.LC_nested tr.LC_info_row td.LC_left_item,
4882: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 4883: text-align: left;
1.451 albertel 4884: }
1.507 raeburn 4885: table.LC_nested td {
1.735 bisitz 4886: background-color: #FFFFFF;
1.451 albertel 4887: font-size: small;
1.507 raeburn 4888: }
4889: table.LC_nested_outer tr th.LC_right_item,
4890: table.LC_nested tr.LC_info_row td.LC_right_item,
4891: table.LC_nested tr.LC_odd_row td.LC_right_item,
4892: table.LC_nested tr td.LC_right_item {
1.451 albertel 4893: text-align: right;
4894: }
4895:
1.507 raeburn 4896: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 4897: background-color: #EEEEEE;
1.451 albertel 4898: }
4899:
1.473 raeburn 4900: table.LC_createuser {
4901: }
4902:
4903: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 4904: font-size: small;
1.473 raeburn 4905: }
4906:
4907: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 4908: background-color: #CCCCCC;
1.473 raeburn 4909: font-weight: bold;
4910: text-align: center;
4911: }
4912:
1.349 albertel 4913: table.LC_calendar {
4914: border: 1px solid #000000;
4915: border-collapse: collapse;
4916: }
4917: table.LC_calendar_pickdate {
4918: font-size: xx-small;
4919: }
4920: table.LC_calendar tr td {
4921: border: 1px solid #000000;
4922: vertical-align: top;
4923: }
4924: table.LC_calendar tr td.LC_calendar_day_empty {
4925: background-color: $data_table_dark;
4926: }
1.779 bisitz 4927: table.LC_calendar tr td.LC_calendar_day_current {
4928: background-color: $data_table_highlight;
1.777 tempelho 4929: }
1.349 albertel 4930: table.LC_mail_list tr.LC_mail_new {
4931: background-color: $mail_new;
4932: }
4933: table.LC_mail_list tr.LC_mail_new:hover {
4934: background-color: $mail_new_hover;
4935: }
1.777 tempelho 4936: table.LC_mail_list tr.LC_mail_even{
4937: }
4938: table.LC_mail_list tr.LC_mail_odd{
4939: }
1.349 albertel 4940: table.LC_mail_list tr.LC_mail_read {
4941: background-color: $mail_read;
4942: }
4943: table.LC_mail_list tr.LC_mail_read:hover {
4944: background-color: $mail_read_hover;
4945: }
4946: table.LC_mail_list tr.LC_mail_replied {
4947: background-color: $mail_replied;
4948: }
4949: table.LC_mail_list tr.LC_mail_replied:hover {
4950: background-color: $mail_replied_hover;
4951: }
4952: table.LC_mail_list tr.LC_mail_other {
4953: background-color: $mail_other;
4954: }
4955: table.LC_mail_list tr.LC_mail_other:hover {
4956: background-color: $mail_other_hover;
4957: }
1.494 raeburn 4958:
1.777 tempelho 4959: table.LC_data_table tr > td.LC_browser_file,
4960: table.LC_data_table tr > td.LC_browser_file_published {
1.389 albertel 4961: background: #CCFF88;
4962: }
1.777 tempelho 4963: table.LC_data_table tr > td.LC_browser_file_locked,
4964: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 4965: background: #FFAA99;
1.387 albertel 4966: }
1.777 tempelho 4967: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.779 bisitz 4968: background: #AAAAAA;
4969: }
1.777 tempelho 4970: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 4971: table.LC_data_table tr > td.LC_browser_file_metamodified {
4972: background: #FFFF77;
1.777 tempelho 4973: }
1.696 bisitz 4974: table.LC_data_table tr.LC_browser_folder > td {
1.389 albertel 4975: background: #CCCCFF;
1.387 albertel 4976: }
1.696 bisitz 4977:
1.707 bisitz 4978: table.LC_data_table tr > td.LC_roles_is {
4979: /* background: #77FF77; */
4980: }
4981: table.LC_data_table tr > td.LC_roles_future {
4982: background: #FFFF77;
4983: }
4984: table.LC_data_table tr > td.LC_roles_will {
4985: background: #FFAA77;
4986: }
4987: table.LC_data_table tr > td.LC_roles_expired {
4988: background: #FF7777;
4989: }
4990: table.LC_data_table tr > td.LC_roles_will_not {
4991: background: #AAFF77;
4992: }
4993: table.LC_data_table tr > td.LC_roles_selected {
4994: background: #11CC55;
4995: }
4996:
1.388 albertel 4997: span.LC_current_location {
1.701 harmsja 4998: font-size:larger;
1.388 albertel 4999: background: $pgbg;
5000: }
1.387 albertel 5001:
1.395 albertel 5002: span.LC_parm_menu_item {
5003: font-size: larger;
5004: font-family: $sans;
5005: }
5006: span.LC_parm_scope_all {
5007: color: red;
5008: }
5009: span.LC_parm_scope_folder {
5010: color: green;
5011: }
5012: span.LC_parm_scope_resource {
5013: color: orange;
5014: }
5015: span.LC_parm_part {
5016: color: blue;
5017: }
5018: span.LC_parm_folder, span.LC_parm_symb {
5019: font-size: x-small;
5020: font-family: $mono;
5021: color: #AAAAAA;
5022: }
5023:
1.396 albertel 5024: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
1.777 tempelho 5025: td.LC_parm_overview_parm_selectors,td.LC_parm_overview_restrictions {
1.396 albertel 5026: border: 1px solid black;
5027: border-collapse: collapse;
5028: }
5029: table.LC_parm_overview_restrictions td {
5030: border-width: 1px 4px 1px 4px;
5031: border-style: solid;
5032: border-color: $pgbg;
5033: text-align: center;
5034: }
5035: table.LC_parm_overview_restrictions th {
5036: background: $tabbg;
5037: border-width: 1px 4px 1px 4px;
5038: border-style: solid;
5039: border-color: $pgbg;
5040: }
1.398 albertel 5041: table#LC_helpmenu {
5042: border: 0px;
5043: height: 55px;
5044: border-spacing: 0px;
5045: }
5046:
5047: table#LC_helpmenu fieldset legend {
5048: font-size: larger;
5049: font-weight: bold;
5050: }
1.397 albertel 5051: table#LC_helpmenu_links {
5052: width: 100%;
5053: border: 1px solid black;
5054: background: $pgbg;
5055: padding: 0px;
5056: border-spacing: 1px;
5057: }
5058: table#LC_helpmenu_links tr td {
5059: padding: 1px;
5060: background: $tabbg;
1.399 albertel 5061: text-align: center;
5062: font-weight: bold;
1.397 albertel 5063: }
1.396 albertel 5064:
1.397 albertel 5065: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
5066: table#LC_helpmenu_links a:active {
5067: text-decoration: none;
5068: color: $font;
5069: }
5070: table#LC_helpmenu_links a:hover {
5071: text-decoration: underline;
5072: color: $vlink;
5073: }
1.396 albertel 5074:
1.417 albertel 5075: .LC_chrt_popup_exists {
5076: border: 1px solid #339933;
5077: margin: -1px;
5078: }
5079: .LC_chrt_popup_up {
5080: border: 1px solid yellow;
5081: margin: -1px;
5082: }
5083: .LC_chrt_popup {
5084: border: 1px solid #8888FF;
5085: background: #CCCCFF;
5086: }
1.421 albertel 5087: table.LC_pick_box {
5088: border-collapse: separate;
5089: background: white;
5090: border: 1px solid black;
5091: border-spacing: 1px;
5092: }
5093: table.LC_pick_box td.LC_pick_box_title {
5094: background: $tabbg;
5095: font-weight: bold;
5096: text-align: right;
1.740 bisitz 5097: vertical-align: top;
1.421 albertel 5098: width: 184px;
5099: padding: 8px;
5100: }
1.645 raeburn 5101: table.LC_pick_box td.LC_selfenroll_pick_box_title {
5102: background: $tabbg;
5103: font-weight: bold;
5104: text-align: right;
5105: width: 350px;
5106: padding: 8px;
5107: }
5108:
1.579 raeburn 5109: table.LC_pick_box td.LC_pick_box_value {
5110: text-align: left;
5111: padding: 8px;
5112: }
5113: table.LC_pick_box td.LC_pick_box_select {
5114: text-align: left;
5115: padding: 8px;
5116: }
1.424 albertel 5117: table.LC_pick_box td.LC_pick_box_separator {
1.421 albertel 5118: padding: 0px;
5119: height: 1px;
5120: background: black;
5121: }
5122: table.LC_pick_box td.LC_pick_box_submit {
5123: text-align: right;
5124: }
1.579 raeburn 5125: table.LC_pick_box td.LC_evenrow_value {
5126: text-align: left;
5127: padding: 8px;
5128: background-color: $data_table_light;
5129: }
5130: table.LC_pick_box td.LC_oddrow_value {
5131: text-align: left;
5132: padding: 8px;
5133: background-color: $data_table_light;
5134: }
5135: table.LC_helpform_receipt {
5136: width: 620px;
5137: border-collapse: separate;
5138: background: white;
5139: border: 1px solid black;
5140: border-spacing: 1px;
5141: }
5142: table.LC_helpform_receipt td.LC_pick_box_title {
5143: background: $tabbg;
5144: font-weight: bold;
5145: text-align: right;
5146: width: 184px;
5147: padding: 8px;
5148: }
5149: table.LC_helpform_receipt td.LC_evenrow_value {
5150: text-align: left;
5151: padding: 8px;
5152: background-color: $data_table_light;
5153: }
5154: table.LC_helpform_receipt td.LC_oddrow_value {
5155: text-align: left;
5156: padding: 8px;
5157: background-color: $data_table_light;
5158: }
5159: table.LC_helpform_receipt td.LC_pick_box_separator {
5160: padding: 0px;
5161: height: 1px;
5162: background: black;
5163: }
5164: span.LC_helpform_receipt_cat {
5165: font-weight: bold;
5166: }
1.424 albertel 5167: table.LC_group_priv_box {
5168: background: white;
5169: border: 1px solid black;
5170: border-spacing: 1px;
5171: }
5172: table.LC_group_priv_box td.LC_pick_box_title {
5173: background: $tabbg;
5174: font-weight: bold;
5175: text-align: right;
5176: width: 184px;
5177: }
5178: table.LC_group_priv_box td.LC_groups_fixed {
5179: background: $data_table_light;
5180: text-align: center;
5181: }
5182: table.LC_group_priv_box td.LC_groups_optional {
5183: background: $data_table_dark;
5184: text-align: center;
5185: }
5186: table.LC_group_priv_box td.LC_groups_functionality {
5187: background: $data_table_darker;
5188: text-align: center;
5189: font-weight: bold;
5190: }
5191: table.LC_group_priv td {
5192: text-align: left;
5193: padding: 0px;
5194: }
5195:
1.421 albertel 5196: table.LC_notify_front_page {
5197: background: white;
5198: border: 1px solid black;
5199: padding: 8px;
5200: }
5201: table.LC_notify_front_page td {
5202: padding: 8px;
5203: }
1.424 albertel 5204: .LC_navbuttons {
5205: margin: 2ex 0ex 2ex 0ex;
5206: }
1.423 albertel 5207: .LC_topic_bar {
5208: font-family: $sans;
5209: font-weight: bold;
5210: width: 100%;
5211: background: $tabbg;
5212: vertical-align: middle;
5213: margin: 2ex 0ex 2ex 0ex;
5214: }
5215: .LC_topic_bar span {
5216: vertical-align: middle;
5217: }
5218: .LC_topic_bar img {
5219: vertical-align: bottom;
5220: }
5221: table.LC_course_group_status {
5222: margin: 20px;
5223: }
5224: table.LC_status_selector td {
5225: vertical-align: top;
5226: text-align: center;
1.424 albertel 5227: padding: 4px;
5228: }
5229: table.LC_descriptive_input td.LC_description {
5230: vertical-align: top;
5231: text-align: right;
5232: font-weight: bold;
1.423 albertel 5233: }
1.599 albertel 5234: div.LC_feedback_link {
1.616 albertel 5235: clear: both;
1.599 albertel 5236: background: white;
1.779 bisitz 5237: width: 100%;
1.489 raeburn 5238: }
5239: span.LC_feedback_link {
1.599 albertel 5240: background: $feedback_link_bg;
5241: font-size: larger;
5242: }
5243: span.LC_message_link {
5244: background: $feedback_link_bg;
5245: font-size: larger;
5246: position: absolute;
5247: right: 1em;
1.489 raeburn 5248: }
1.421 albertel 5249:
1.515 albertel 5250: table.LC_prior_tries {
1.524 albertel 5251: border: 1px solid #000000;
5252: border-collapse: separate;
5253: border-spacing: 1px;
1.515 albertel 5254: }
1.523 albertel 5255:
1.515 albertel 5256: table.LC_prior_tries td {
1.524 albertel 5257: padding: 2px;
1.515 albertel 5258: }
1.523 albertel 5259:
5260: .LC_answer_correct {
5261: background: #AAFFAA;
5262: color: black;
5263: }
5264: .LC_answer_charged_try {
5265: background: #FFAAAA ! important;
5266: color: black;
5267: }
1.779 bisitz 5268: .LC_answer_not_charged_try,
1.523 albertel 5269: .LC_answer_no_grade,
5270: .LC_answer_late {
5271: background: #FFFFAA;
5272: color: black;
5273: }
5274: .LC_answer_previous {
5275: background: #AAAAFF;
5276: color: black;
5277: }
1.779 bisitz 5278: .LC_answer_no_message {
1.777 tempelho 5279: background: #FFFFFF;
5280: color: black;
1.779 bisitz 5281: }
5282: .LC_answer_unknown {
5283: background: orange;
5284: color: black;
1.777 tempelho 5285: }
1.529 albertel 5286: span.LC_prior_numerical,
5287: span.LC_prior_string,
5288: span.LC_prior_custom,
5289: span.LC_prior_reaction,
5290: span.LC_prior_math {
1.523 albertel 5291: font-family: monospace;
5292: white-space: pre;
5293: }
5294:
1.525 albertel 5295: span.LC_prior_string {
5296: font-family: monospace;
5297: white-space: pre;
5298: }
5299:
1.523 albertel 5300: table.LC_prior_option {
5301: width: 100%;
5302: border-collapse: collapse;
5303: }
1.528 albertel 5304: table.LC_prior_rank, table.LC_prior_match {
5305: border-collapse: collapse;
5306: }
5307: table.LC_prior_option tr td,
5308: table.LC_prior_rank tr td,
5309: table.LC_prior_match tr td {
1.524 albertel 5310: border: 1px solid #000000;
1.515 albertel 5311: }
5312:
1.770 droeschl 5313: td.LC_nobreak,
1.519 raeburn 5314: span.LC_nobreak {
1.544 albertel 5315: white-space: nowrap;
1.519 raeburn 5316: }
5317:
1.576 raeburn 5318: span.LC_cusr_emph {
5319: font-style: italic;
5320: }
5321:
1.633 raeburn 5322: span.LC_cusr_subheading {
5323: font-weight: normal;
5324: font-size: 85%;
5325: }
5326:
1.545 albertel 5327: table.LC_docs_documents {
5328: background: #BBBBBB;
1.547 albertel 5329: border-width: 0px;
1.545 albertel 5330: border-collapse: collapse;
5331: }
1.777 tempelho 5332: table.LC_docs_documents td.LC_docs_document {
1.779 bisitz 5333: border: 2px solid black;
5334: padding: 4px;
1.777 tempelho 5335: }
1.545 albertel 5336: .LC_docs_entry_move {
5337: border: 0px;
5338: border-collapse: collapse;
1.544 albertel 5339: }
5340:
1.545 albertel 5341: .LC_docs_entry_move td {
5342: border: 2px solid #BBBBBB;
5343: background: #DDDDDD;
5344: }
5345:
5346: .LC_docs_editor td.LC_docs_entry_commands {
5347: background: #DDDDDD;
5348: font-size: x-small;
5349: }
1.544 albertel 5350: .LC_docs_copy {
1.545 albertel 5351: color: #000099;
1.544 albertel 5352: }
5353: .LC_docs_cut {
1.545 albertel 5354: color: #550044;
1.544 albertel 5355: }
5356: .LC_docs_rename {
1.545 albertel 5357: color: #009900;
1.544 albertel 5358: }
5359: .LC_docs_remove {
1.545 albertel 5360: color: #990000;
5361: }
5362:
1.547 albertel 5363: .LC_docs_reinit_warn,
5364: .LC_docs_ext_edit {
5365: font-size: x-small;
5366: }
5367:
1.545 albertel 5368: .LC_docs_editor td.LC_docs_entry_title,
5369: .LC_docs_editor td.LC_docs_entry_icon {
5370: background: #FFFFBB;
5371: }
5372: .LC_docs_editor td.LC_docs_entry_parameter {
5373: background: #BBBBFF;
5374: font-size: x-small;
5375: white-space: nowrap;
5376: }
5377:
5378: table.LC_docs_adddocs td,
5379: table.LC_docs_adddocs th {
5380: border: 1px solid #BBBBBB;
5381: padding: 4px;
5382: background: #DDDDDD;
1.543 albertel 5383: }
5384:
1.584 albertel 5385: table.LC_sty_begin {
5386: background: #BBFFBB;
5387: }
5388: table.LC_sty_end {
5389: background: #FFBBBB;
5390: }
5391:
1.589 raeburn 5392: table.LC_double_column {
5393: border-width: 0px;
5394: border-collapse: collapse;
5395: width: 100%;
5396: padding: 2px;
5397: }
5398:
5399: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5400: top: 2px;
1.589 raeburn 5401: left: 2px;
5402: width: 47%;
5403: vertical-align: top;
5404: }
5405:
5406: table.LC_double_column tr td.LC_right_col {
5407: top: 2px;
1.779 bisitz 5408: right: 2px;
1.589 raeburn 5409: width: 47%;
5410: vertical-align: top;
5411: }
5412:
1.594 raeburn 5413: span.LC_role_level {
5414: font-weight: bold;
5415: }
5416:
1.591 raeburn 5417: div.LC_left_float {
5418: float: left;
5419: padding-right: 5%;
1.597 albertel 5420: padding-bottom: 4px;
1.591 raeburn 5421: }
5422:
5423: div.LC_clear_float_header {
1.597 albertel 5424: padding-bottom: 2px;
1.591 raeburn 5425: }
5426:
5427: div.LC_clear_float_footer {
1.597 albertel 5428: padding-top: 10px;
1.591 raeburn 5429: clear: both;
5430: }
5431:
1.597 albertel 5432:
5433: div.LC_grade_show_user {
5434: margin-top: 20px;
5435: border: 1px solid black;
5436: }
5437: div.LC_grade_user_name {
5438: background: #DDDDEE;
5439: border-bottom: 1px solid black;
1.705 tempelho 5440: font-weight: bold;
5441: font-size: large;
1.597 albertel 5442: }
5443: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5444: background: #DDEEDD;
5445: }
5446:
5447: div.LC_grade_show_problem,
5448: div.LC_grade_submissions,
5449: div.LC_grade_message_center,
5450: div.LC_grade_info_links,
5451: div.LC_grade_assign {
5452: margin: 5px;
5453: width: 99%;
5454: background: #FFFFFF;
5455: }
5456: div.LC_grade_show_problem_header,
5457: div.LC_grade_submissions_header,
5458: div.LC_grade_message_center_header,
5459: div.LC_grade_assign_header {
1.705 tempelho 5460: font-weight: bold;
5461: font-size: large;
1.597 albertel 5462: }
5463: div.LC_grade_show_problem_problem,
5464: div.LC_grade_submissions_body,
5465: div.LC_grade_message_center_body,
5466: div.LC_grade_assign_body {
5467: border: 1px solid black;
5468: width: 99%;
5469: background: #FFFFFF;
5470: }
1.598 albertel 5471: span.LC_grade_check_note {
1.705 tempelho 5472: font-weight: normal;
5473: font-size: medium;
1.598 albertel 5474: display: inline;
5475: position: absolute;
5476: right: 1em;
5477: }
1.597 albertel 5478:
1.613 albertel 5479: table.LC_scantron_action {
5480: width: 100%;
5481: }
5482: table.LC_scantron_action tr th {
1.698 harmsja 5483: font-weight:bold;
5484: font-style:normal;
1.613 albertel 5485: }
1.779 bisitz 5486: .LC_edit_problem_header,
1.614 albertel 5487: div.LC_edit_problem_footer {
1.705 tempelho 5488: font-weight: normal;
5489: font-size: medium;
1.602 albertel 5490: margin: 2px;
1.600 albertel 5491: }
5492: div.LC_edit_problem_header,
1.602 albertel 5493: div.LC_edit_problem_header div,
1.614 albertel 5494: div.LC_edit_problem_footer,
5495: div.LC_edit_problem_footer div,
1.602 albertel 5496: div.LC_edit_problem_editxml_header,
5497: div.LC_edit_problem_editxml_header div {
1.600 albertel 5498: margin-top: 5px;
5499: }
1.602 albertel 5500: div.LC_edit_problem_header_edit_row {
5501: background: $tabbg;
5502: padding: 3px;
5503: margin-bottom: 5px;
5504: }
1.600 albertel 5505: div.LC_edit_problem_header_title {
1.705 tempelho 5506: font-weight: bold;
5507: font-size: larger;
1.602 albertel 5508: background: $tabbg;
5509: padding: 3px;
5510: }
5511: table.LC_edit_problem_header_title {
1.705 tempelho 5512: font-size: larger;
5513: font-weight: bold;
1.602 albertel 5514: width: 100%;
5515: border-color: $pgbg;
5516: border-style: solid;
5517: border-width: $border;
5518:
1.600 albertel 5519: background: $tabbg;
1.602 albertel 5520: border-collapse: collapse;
5521: padding: 0px
5522: }
5523:
5524: div.LC_edit_problem_discards {
5525: float: left;
5526: padding-bottom: 5px;
5527: }
5528: div.LC_edit_problem_saves {
5529: float: right;
5530: padding-bottom: 5px;
1.600 albertel 5531: }
5532: hr.LC_edit_problem_divide {
1.602 albertel 5533: clear: both;
1.600 albertel 5534: color: $tabbg;
5535: background-color: $tabbg;
5536: height: 3px;
5537: border: 0px;
5538: }
1.679 riegler 5539: img.stift{
1.678 riegler 5540: border-width:0;
1.679 riegler 5541: vertical-align:middle;
1.677 riegler 5542: }
1.680 riegler 5543:
1.681 riegler 5544: table#LC_mainmenu{
5545: margin-top:10px;
5546: width:80%;
5547:
5548: }
5549:
1.680 riegler 5550: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
5551: vertical-align: top;
5552: width: 45%;
5553: }
1.779 bisitz 5554: .LC_mainmenu_fieldset_category {
5555: color: $font;
5556: background: $pgbg;
5557: font-family: $sans;
5558: font-size: small;
5559: font-weight: bold;
1.777 tempelho 5560: }
1.716 raeburn 5561: div.LC_createcourse {
5562: margin: 10px 10px 10px 10px;
5563: }
5564:
1.693 droeschl 5565: /* ---- Remove when done ----
5566: # The following styles is part of the redesign of LON-CAPA and are
5567: # subject to change during this project.
5568: # Don't rely on their current functionality as they might be
5569: # changed or removed.
5570: # --------------------------*/
5571:
1.698 harmsja 5572: a:hover,
1.721 harmsja 5573: ol.LC_smallMenu a:hover,
5574: ol#LC_MenuBreadcrumbs a:hover,
5575: ol#LC_PathBreadcrumbs a:hover,
5576: ul#LC_TabMainMenuContent a:hover,
5577: .LC_FormSectionClearButton input:hover
5578: ul.LC_TabContent li:hover a{
1.698 harmsja 5579: color:#BF2317;
5580: text-decoration:none;
1.693 droeschl 5581: }
5582:
1.779 bisitz 5583: h1 {
1.721 harmsja 5584: padding:5px 10px 5px 20px;
1.693 droeschl 5585: line-height:130%;
5586: }
1.698 harmsja 5587:
1.693 droeschl 5588: h2,h3,h4,h5,h6
5589: {
1.721 harmsja 5590: margin:5px 0px 5px 0px;
5591: padding:0px;
5592: line-height:130%;
1.693 droeschl 5593: }
1.721 harmsja 5594: .LC_hcell{
1.698 harmsja 5595: padding:3px 15px 3px 15px;
5596: margin:0px;
1.703 harmsja 5597: background-color:$tabbg;
1.779 bisitz 5598: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5599: }
1.721 harmsja 5600: .LC_noBorder {
1.698 harmsja 5601: border:0px;
5602: }
1.693 droeschl 5603:
5604:
1.698 harmsja 5605: /* Main Header with discription of Person, Course, etc. */
1.693 droeschl 5606:
1.761 tempelho 5607: .LC_Right {
5608: float: right;
5609: margin: 0px;
5610: padding: 0px;
5611: }
5612:
1.721 harmsja 5613: p, .LC_ContentBox {
1.698 harmsja 5614: padding: 10px;
5615:
5616: }
1.721 harmsja 5617: .LC_FormSectionClearButton input {
1.779 bisitz 5618: background-color:transparent;
1.698 harmsja 5619: border:0px;
5620: cursor:pointer;
5621: text-decoration:underline;
1.693 droeschl 5622: }
1.763 bisitz 5623:
5624: .LC_help_open_topic {
5625: color: #FFFFFF;
5626: background-color: #EEEEFF;
5627: margin: 1px;
5628: padding: 4px;
5629: border: 1px solid #000033;
5630: white-space: nowrap;
1.783 amueller 5631: /* vertical-align: middle; */
1.759 neumanie 5632: }
1.693 droeschl 5633:
1.698 harmsja 5634: dl,ul,div,fieldset {
5635: margin: 10px 10px 10px 0px;
1.693 droeschl 5636: overflow:hidden;
5637: }
1.721 harmsja 5638: ol.LC_smallMenu, ol#LC_PathBreadcrumbs {
1.698 harmsja 5639: margin: 0px;
1.693 droeschl 5640: }
5641:
1.721 harmsja 5642: ol.LC_smallMenu li {
1.693 droeschl 5643: display: inline;
5644: padding: 5px 5px 0px 10px;
5645: vertical-align: top;
5646: }
5647:
1.721 harmsja 5648: ol.LC_smallMenu li img {
1.693 droeschl 5649: vertical-align: bottom;
5650: }
5651:
1.721 harmsja 5652: ol.LC_smallMenu a {
1.693 droeschl 5653: font-size: 90%;
5654: color: RGB(80, 80, 80);
5655: text-decoration: none;
5656: }
1.760 harmsja 5657: ol#LC_TabMainMenuContent, ul.LC_TabContent ,
1.741 harmsja 5658: ul.LC_TabContentBigger {
1.721 harmsja 5659: display:block;
5660: list-style:none;
1.741 harmsja 5661: margin: 0px;
1.693 droeschl 5662: padding: 0px;
5663: }
5664:
1.744 ehlerst 5665: ol#LC_TabMainMenuContent li, ul.LC_TabContent li,
1.741 harmsja 5666: ul.LC_TabContentBigger li{
1.693 droeschl 5667: display: inline;
1.741 harmsja 5668: border-right: solid 1px $lg_border_color;
5669: float:left;
5670: line-height:140%;
5671: white-space:nowrap;
5672: }
5673: ol#LC_TabMainMenuContent li{
1.693 droeschl 5674: vertical-align: bottom;
5675: border-bottom: solid 1px RGB(175, 175, 175);
1.721 harmsja 5676: padding: 5px 10px 5px 10px;
1.741 harmsja 5677: margin-right:5px;
5678: margin-bottom:3px;
1.693 droeschl 5679: font-weight: bold;
1.723 riegler 5680: background: url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
1.693 droeschl 5681: }
5682:
1.721 harmsja 5683: ol#LC_TabMainMenuContent li a{
1.693 droeschl 5684: color: RGB(47, 47, 47);
5685: text-decoration: none;
5686: }
1.721 harmsja 5687: ul.LC_TabContent {
1.741 harmsja 5688: min-height:1.6em;
1.721 harmsja 5689: }
5690: ul.LC_TabContent li{
1.741 harmsja 5691: vertical-align:middle;
5692: padding:0px 10px 0px 10px;
1.745 ehlerst 5693: background-color:$tabbg;
5694: border-bottom:solid 1px $lg_border_color;
1.721 harmsja 5695: }
1.779 bisitz 5696: ul.LC_TabContent li a, ul.LC_TabContent li{
1.721 harmsja 5697: color:rgb(47,47,47);
5698: text-decoration:none;
5699: font-size:95%;
5700: font-weight:bold;
1.761 tempelho 5701: padding-right: 16px;
1.721 harmsja 5702: }
1.744 ehlerst 5703: ul.LC_TabContent li:hover, ul.LC_TabContent li.active{
1.761 tempelho 5704: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.745 ehlerst 5705: border-bottom:solid 1px #FFFFFF;
1.761 tempelho 5706: padding-right: 16px;
1.744 ehlerst 5707: }
1.741 harmsja 5708: ul.LC_TabContentBigger li{
5709: vertical-align:bottom;
5710: border-top:solid 1px $lg_border_color;
5711: border-left:solid 1px $lg_border_color;
5712: padding:5px 10px 5px 10px;
5713: margin-left:2px;
5714: background:url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
5715: }
1.744 ehlerst 5716: ul.LC_TabContentBigger li:hover, ul.LC_TabContentBigger li.active{
5717: background:url(/adm/lonIcons/lightGreyBG.png) repeat-x right bottom;
5718: }
1.741 harmsja 5719: ul.LC_TabContentBigger li, ul.LC_TabContentBigger li a{
5720: font-size:110%;
5721: font-weight:bold;
5722: }
1.693 droeschl 5723:
1.783 amueller 5724: ol#LC_MenuBreadcrumbs, ol#LC_PathBreadcrumbs, ul.LC_CourseBreadcrumbs{
1.693 droeschl 5725: border-top: solid 1px RGB(255, 255, 255);
5726: height: 20px;
5727: line-height: 20px;
5728: vertical-align: bottom;
5729: margin: 0px 0px 30px 0px;
5730: padding-left: 10px;
5731: list-style-position: inside;
1.723 riegler 5732: background: url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
1.693 droeschl 5733: }
5734:
1.783 amueller 5735: ol#LC_MenuBreadcrumbs li, ol#LC_PathBreadcrumbs li, ul.LC_CourseBreadcrumbs li {
1.741 harmsja 5736: /*
1.723 riegler 5737: background: url(/adm/lonIcons/arrow_white.png) no-repeat left center;
1.779 bisitz 5738: */
1.693 droeschl 5739: display: inline;
5740: padding: 0px 0px 0px 10px;
1.783 amueller 5741: /* vertical-align: bottom; */
1.693 droeschl 5742: overflow:hidden;
5743: }
5744:
1.783 amueller 5745: ol#LC_MenuBreadcrumbs li a, ul.LC_CourseBreadcrumbs li a {
1.693 droeschl 5746: text-decoration: none;
5747: font-size:90%;
5748: }
1.721 harmsja 5749: ol#LC_PathBreadcrumbs li a{
1.698 harmsja 5750: text-decoration:none;
5751: font-size:100%;
5752: font-weight:bold;
1.693 droeschl 5753: }
1.786 neumanie 5754: .LC_BoxPadding
5755: {
5756: padding: 10px;
5757: }
1.721 harmsja 5758: .LC_ContentBoxSpecial
1.693 droeschl 5759: {
1.701 harmsja 5760: border: solid 1px $lg_border_color;
1.746 neumanie 5761: }
5762: .LC_ContentBoxSpecialContactInfo
5763: {
5764: border: solid 1px $lg_border_color;
5765: max-width:25%;
5766: min-width:25%;
1.698 harmsja 5767: }
1.747 neumanie 5768: .LC_AboutMe_Image
5769: {
5770: float:left;
5771: margin-right:10px;
5772: }
5773: .LC_Clear_AboutMe_Image
5774: {
5775: clear:left;
5776: }
1.721 harmsja 5777: dl.LC_ListStyleClean dt {
1.693 droeschl 5778: padding-right: 5px;
5779: display: table-header-group;
5780: }
5781:
1.721 harmsja 5782: dl.LC_ListStyleClean dd {
1.693 droeschl 5783: display: table-row;
5784: }
5785:
1.721 harmsja 5786: .LC_ListStyleClean,
5787: .LC_ListStyleSimple,
5788: .LC_ListStyleNormal,
1.777 tempelho 5789: .LC_ListStyle_Border,
1.721 harmsja 5790: .LC_ListStyleSpecial
1.693 droeschl 5791: {
5792: /*display:block; */
5793: list-style-position: inside;
5794: list-style-type: none;
5795: overflow: hidden;
5796: padding: 0px;
5797: }
5798:
1.721 harmsja 5799: .LC_ListStyleSimple li,
5800: .LC_ListStyleSimple dd,
5801: .LC_ListStyleNormal li,
5802: .LC_ListStyleNormal dd,
5803: .LC_ListStyleSpecial li,
5804: .LC_ListStyleSpecial dd
1.693 droeschl 5805: {
5806: margin: 0px;
5807: padding: 5px 5px 5px 10px;
5808: clear: both;
5809: }
5810:
1.721 harmsja 5811: .LC_ListStyleClean li,
5812: .LC_ListStyleClean dd {
1.693 droeschl 5813: padding-top: 0px;
5814: padding-bottom: 0px;
5815: }
5816:
1.721 harmsja 5817: .LC_ListStyleSimple dd,
5818: .LC_ListStyleSimple li{
1.698 harmsja 5819: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 5820: }
5821:
1.721 harmsja 5822: .LC_ListStyleSpecial li,
5823: .LC_ListStyleSpecial dd {
1.693 droeschl 5824: list-style-type: none;
5825: background-color: RGB(220, 220, 220);
5826: margin-bottom: 4px;
5827: }
5828:
1.721 harmsja 5829: table.LC_SimpleTable {
1.698 harmsja 5830: margin:5px;
5831: border:solid 1px $lg_border_color;
1.693 droeschl 5832: }
5833:
1.721 harmsja 5834: table.LC_SimpleTable tr {
1.698 harmsja 5835: padding:0px;
5836: border:solid 1px $lg_border_color;
1.693 droeschl 5837: }
1.721 harmsja 5838: table.LC_SimpleTable thead{
1.698 harmsja 5839: background:rgb(220,220,220);
1.693 droeschl 5840: }
5841:
1.721 harmsja 5842: div.LC_columnSection {
1.693 droeschl 5843: display: block;
5844: clear: both;
5845: overflow: hidden;
5846: margin:0px;
5847: }
5848:
1.721 harmsja 5849: div.LC_columnSection>* {
1.693 droeschl 5850: float: left;
5851: margin: 10px 20px 10px 0px;
1.747 neumanie 5852: overflow:hidden;
1.693 droeschl 5853: }
1.721 harmsja 5854:
1.719 ehlerst 5855: .ContentBoxSpecialTemplate
5856: {
1.747 neumanie 5857: border: solid 1px $lg_border_color;
1.719 ehlerst 5858: }
5859: .ContentBoxTemplate {
5860: padding:10px;
5861: }
5862:
1.721 harmsja 5863: div.LC_columnSection > .ContentBoxTemplate,
5864: div.LC_columnSection > .ContentBoxSpecialTemplate
1.719 ehlerst 5865: {
5866: width: 600px;
5867: }
1.753 droeschl 5868:
1.720 ehlerst 5869: .clear{
5870: clear: both;
5871: line-height: 0px;
5872: font-size: 0px;
5873: height: 0px;
5874: }
1.693 droeschl 5875:
1.694 tempelho 5876: .LC_loginpage_container {
5877: text-align:left;
5878: margin : 0 auto;
1.785 tempelho 5879: width:90%;
1.694 tempelho 5880: padding: 10px;
5881: height: auto;
1.712 muellerd 5882: background-color:#FFFFFF;
1.694 tempelho 5883: border:1px solid #CCCCCC;
5884: }
5885:
5886:
5887: .LC_loginpage_loginContainer {
5888: float:left;
1.712 muellerd 5889: width: 182px;
1.785 tempelho 5890: padding: 2px;
1.712 muellerd 5891: border:1px solid #CCCCCC;
5892: background-color:$loginbg;
1.694 tempelho 5893: }
5894:
1.717 tempelho 5895: .LC_loginpage_loginContainer h2{
1.712 muellerd 5896: margin-top:0;
5897: display:block;
5898: background:$bgcol;
5899: color:$textcol;
5900: padding-left:5px;
5901: }
1.785 tempelho 5902:
1.694 tempelho 5903: .LC_loginpage_loginInfo {
5904: float:left;
1.785 tempelho 5905: width:182px;
1.694 tempelho 5906: border:1px solid #CCCCCC;
1.785 tempelho 5907: padding:2px;
1.712 muellerd 5908: }
5909:
1.694 tempelho 5910: .LC_loginpage_space {
1.754 droeschl 5911: clear: both;
5912: margin-bottom: 20px;
1.694 tempelho 5913: border-bottom: 1px solid #CCCCCC;
5914: }
5915:
1.785 tempelho 5916: .LC_loginpage_floatLeft {
5917: float: left;
5918: width: 200px;
5919: margin: 0;
5920: }
5921:
1.748 schulted 5922: table em{
1.754 droeschl 5923: font-weight: bold;
5924: font-style: normal;
1.748 schulted 5925: }
1.779 bisitz 5926: table.LC_tableBrowseRes,
1.768 schulted 5927: table.LC_tableOfContent{
1.769 schulted 5928: border:none;
5929: border-spacing: 1;
1.754 droeschl 5930: padding: 3px;
5931: background-color: #FFFFFF;
5932: font-size: 90%;
1.753 droeschl 5933: }
1.789 droeschl 5934:
5935: table.LC_tableOfContent{
5936: border-collapse: collapse;
5937: }
5938:
1.771 droeschl 5939: table.LC_tableBrowseRes a,
1.768 schulted 5940: table.LC_tableOfContent a {
1.771 droeschl 5941: background-color: transparent;
1.753 droeschl 5942: text-decoration: none;
5943: }
5944:
1.771 droeschl 5945: table.LC_tableBrowseRes tr.LC_trOdd,
1.768 schulted 5946: table.LC_tableOfContent tr.LC_trOdd{
1.754 droeschl 5947: background-color: #EEEEEE;
1.753 droeschl 5948: }
5949:
1.768 schulted 5950: table.LC_tableOfContent img{
1.753 droeschl 5951: border: none;
5952: height: 1.3em;
5953: vertical-align: text-bottom;
5954: margin-right: 0.3em;
5955: }
1.757 schulted 5956:
1.774 ehlerst 5957: a#LC_content_toolbar_firsthomework{
5958: background-image:url(/res/adm/pages/open-first-problem.gif);
5959: }
5960:
5961: a#LC_content_toolbar_launchnav{
5962: background-image:url(/res/adm/pages/start-navigation.gif);
5963: }
5964:
5965: a#LC_content_toolbar_closenav{
5966: background-image:url(/res/adm/pages/close-navigation.gif);
5967: }
5968:
5969: a#LC_content_toolbar_everything{
5970: background-image:url(/res/adm/pages/show-all.gif);
5971: }
5972:
5973: a#LC_content_toolbar_uncompleted{
5974: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
5975: }
5976:
5977: #LC_content_toolbar_clearbubbles{
5978: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
5979: }
5980:
1.757 schulted 5981: a#LC_content_toolbar_changefolder{
5982: background : url(/res/adm/pages/close-all-folders.gif) top center ;
5983: }
5984:
5985: a#LC_content_toolbar_changefolder_toggled{
5986: background-image:url(/res/adm/pages/open-all-folders.gif);
5987: }
5988:
5989: ul#LC_toolbar li a:hover{
5990: background-position: bottom center;
5991: }
5992:
5993: ul#LC_toolbar{
1.779 bisitz 5994: padding:0;
1.757 schulted 5995: margin: 2px;
5996: list-style:none;
5997: position:relative;
5998: background-color:white;
5999: }
6000:
6001: ul#LC_toolbar li{
6002: border:1px solid white;
6003: padding:0;
6004: margin: 0;
1.767 droeschl 6005: float: left;
6006: display:inline;
1.757 schulted 6007: vertical-align:middle;
6008: }
6009:
1.783 amueller 6010:
1.757 schulted 6011: a.LC_toolbarItem{
1.767 droeschl 6012: display:block;
1.757 schulted 6013: padding:0;
6014: margin:0;
6015: height: 32px;
6016: width: 32px;
1.779 bisitz 6017: color:white;
6018: border:0 none;
1.757 schulted 6019: background-repeat:no-repeat;
6020: background-color:transparent;
6021: }
6022:
1.782 bisitz 6023: ul.LC_functionslist li {
6024: float: left;
6025: white-space: nowrap;
6026: height: 35px; /* at least as high as heighest list item */
6027: margin: 0px 15px 15px 10px;
6028: }
6029:
1.757 schulted 6030:
1.343 albertel 6031: END
6032: }
6033:
1.306 albertel 6034: =pod
6035:
6036: =item * &headtag()
6037:
6038: Returns a uniform footer for LON-CAPA web pages.
6039:
1.307 albertel 6040: Inputs: $title - optional title for the head
6041: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6042: $args - optional arguments
1.319 albertel 6043: force_register - if is true call registerurl so the remote is
6044: informed
1.415 albertel 6045: redirect -> array ref of
6046: 1- seconds before redirect occurs
6047: 2- url to redirect to
6048: 3- whether the side effect should occur
1.315 albertel 6049: (side effect of setting
6050: $env{'internal.head.redirect'} to the url
6051: redirected too)
1.352 albertel 6052: domain -> force to color decorate a page for a specific
6053: domain
6054: function -> force usage of a specific rolish color scheme
6055: bgcolor -> override the default page bgcolor
1.460 albertel 6056: no_auto_mt_title
6057: -> prevent &mt()ing the title arg
1.464 albertel 6058:
1.306 albertel 6059: =cut
6060:
6061: sub headtag {
1.313 albertel 6062: my ($title,$head_extra,$args) = @_;
1.306 albertel 6063:
1.363 albertel 6064: my $function = $args->{'function'} || &get_users_function();
6065: my $domain = $args->{'domain'} || &determinedomain();
6066: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6067: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6068: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6069: #time(),
1.418 albertel 6070: $env{'environment.color.timestamp'},
1.363 albertel 6071: $function,$domain,$bgcolor);
6072:
1.369 www 6073: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6074:
1.308 albertel 6075: my $result =
6076: '<head>'.
1.461 albertel 6077: &font_settings();
1.319 albertel 6078:
1.461 albertel 6079: if (!$args->{'frameset'}) {
6080: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6081: }
1.319 albertel 6082: if ($args->{'force_register'}) {
6083: $result .= &Apache::lonmenu::registerurl(1);
6084: }
1.436 albertel 6085: if (!$args->{'no_nav_bar'}
6086: && !$args->{'only_body'}
6087: && !$args->{'frameset'}) {
6088: $result .= &help_menu_js();
6089: }
1.319 albertel 6090:
1.314 albertel 6091: if (ref($args->{'redirect'})) {
1.414 albertel 6092: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6093: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6094: if (!$inhibit_continue) {
6095: $env{'internal.head.redirect'} = $url;
6096: }
1.313 albertel 6097: $result.=<<ADDMETA
6098: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6099: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6100: ADDMETA
6101: }
1.306 albertel 6102: if (!defined($title)) {
6103: $title = 'The LearningOnline Network with CAPA';
6104: }
1.460 albertel 6105: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6106: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6107: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6108: .$head_extra;
1.306 albertel 6109: return $result;
6110: }
6111:
6112: =pod
6113:
1.340 albertel 6114: =item * &font_settings()
6115:
6116: Returns neccessary <meta> to set the proper encoding
6117:
6118: Inputs: none
6119:
6120: =cut
6121:
6122: sub font_settings {
6123: my $headerstring='';
1.647 www 6124: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6125: $headerstring.=
6126: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6127: }
6128: return $headerstring;
6129: }
6130:
1.341 albertel 6131: =pod
6132:
6133: =item * &xml_begin()
6134:
6135: Returns the needed doctype and <html>
6136:
6137: Inputs: none
6138:
6139: =cut
6140:
6141: sub xml_begin {
6142: my $output='';
6143:
1.592 albertel 6144: if ($env{'internal.start_page'}==1) {
6145: &Apache::lonhtmlcommon::init_htmlareafields();
6146: }
1.342 albertel 6147:
1.341 albertel 6148: if ($env{'browser.mathml'}) {
6149: $output='<?xml version="1.0"?>'
6150: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6151: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6152:
6153: # .'<!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">] >'
6154: .'<!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">'
6155: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6156: .'xmlns="http://www.w3.org/1999/xhtml">';
6157: } else {
6158: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
6159: }
6160: return $output;
6161: }
1.340 albertel 6162:
6163: =pod
6164:
1.306 albertel 6165: =item * &endheadtag()
6166:
6167: Returns a uniform </head> for LON-CAPA web pages.
6168:
6169: Inputs: none
6170:
6171: =cut
6172:
6173: sub endheadtag {
6174: return '</head>';
6175: }
6176:
6177: =pod
6178:
6179: =item * &head()
6180:
6181: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6182:
1.648 raeburn 6183: Inputs:
6184:
6185: =over 4
6186:
6187: $title - optional title for the page
6188:
6189: $head_extra - optional extra HTML to put inside the <head>
6190:
6191: =back
1.405 albertel 6192:
1.306 albertel 6193: =cut
6194:
6195: sub head {
1.325 albertel 6196: my ($title,$head_extra,$args) = @_;
6197: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6198: }
6199:
6200: =pod
6201:
6202: =item * &start_page()
6203:
6204: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6205:
1.648 raeburn 6206: Inputs:
6207:
6208: =over 4
6209:
6210: $title - optional title for the page
6211:
6212: $head_extra - optional extra HTML to incude inside the <head>
6213:
6214: $args - additional optional args supported are:
6215:
6216: =over 8
6217:
6218: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6219: arg on
1.648 raeburn 6220: no_nav_bar -> is true will set &bodytag() notopbar arg on
6221: add_entries -> additional attributes to add to the <body>
6222: domain -> force to color decorate a page for a
1.317 albertel 6223: specific domain
1.648 raeburn 6224: function -> force usage of a specific rolish color
1.317 albertel 6225: scheme
1.648 raeburn 6226: redirect -> see &headtag()
6227: bgcolor -> override the default page bg color
6228: js_ready -> return a string ready for being used in
1.317 albertel 6229: a javascript writeln
1.648 raeburn 6230: html_encode -> return a string ready for being used in
1.320 albertel 6231: a html attribute
1.648 raeburn 6232: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6233: $forcereg arg
1.648 raeburn 6234: body_title -> alternate text to use instead of $title
1.326 albertel 6235: in the title box that appears, this text
6236: is not auto translated like the $title is
1.648 raeburn 6237: frameset -> if true will start with a <frameset>
1.330 albertel 6238: rather than <body>
1.648 raeburn 6239: no_title -> if true the title bar won't be shown
6240: skip_phases -> hash ref of
1.338 albertel 6241: head -> skip the <html><head> generation
6242: body -> skip all <body> generation
1.648 raeburn 6243: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6244: 'Switch To Inline Menu' link
1.648 raeburn 6245: no_auto_mt_title -> prevent &mt()ing the title arg
6246: inherit_jsmath -> when creating popup window in a page,
6247: should it have jsmath forced on by the
6248: current page
1.361 albertel 6249:
1.648 raeburn 6250: =back
1.460 albertel 6251:
1.648 raeburn 6252: =back
1.562 albertel 6253:
1.306 albertel 6254: =cut
6255:
6256: sub start_page {
1.309 albertel 6257: my ($title,$head_extra,$args) = @_;
1.318 albertel 6258: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6259: my %head_args;
1.352 albertel 6260: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6261: 'bgcolor','frameset','no_nav_bar','only_body',
6262: 'no_auto_mt_title') {
1.319 albertel 6263: if (defined($args->{$arg})) {
1.324 raeburn 6264: $head_args{$arg} = $args->{$arg};
1.319 albertel 6265: }
1.313 albertel 6266: }
1.319 albertel 6267:
1.315 albertel 6268: $env{'internal.start_page'}++;
1.338 albertel 6269: my $result;
6270: if (! exists($args->{'skip_phases'}{'head'}) ) {
6271: $result.=
1.341 albertel 6272: &xml_begin().
1.338 albertel 6273: &headtag($title,$head_extra,\%head_args).&endheadtag();
6274: }
6275:
6276: if (! exists($args->{'skip_phases'}{'body'}) ) {
6277: if ($args->{'frameset'}) {
6278: my $attr_string = &make_attr_string($args->{'force_register'},
6279: $args->{'add_entries'});
6280: $result .= "\n<frameset $attr_string>\n";
6281: } else {
6282: $result .=
6283: &bodytag($title,
6284: $args->{'function'}, $args->{'add_entries'},
6285: $args->{'only_body'}, $args->{'domain'},
6286: $args->{'force_register'}, $args->{'body_title'},
6287: $args->{'no_nav_bar'}, $args->{'bgcolor'},
1.460 albertel 6288: $args->{'no_title'}, $args->{'no_inline_link'},
6289: $args);
1.338 albertel 6290: }
1.330 albertel 6291: }
1.338 albertel 6292:
1.315 albertel 6293: if ($args->{'js_ready'}) {
1.713 kaisler 6294: $result = &js_ready($result);
1.315 albertel 6295: }
1.320 albertel 6296: if ($args->{'html_encode'}) {
1.713 kaisler 6297: $result = &html_encode($result);
6298: }
6299:
1.758 kaisler 6300: #Breadcrumbs
6301: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6302: &Apache::lonhtmlcommon::clear_breadcrumbs();
6303: #if any br links exists, add them to the breadcrumbs
6304: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6305: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6306: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6307: }
6308: }
6309:
6310: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6311: if(exists($args->{'bread_crumbs_component'})){
6312: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6313: }else{
6314: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6315: }
1.320 albertel 6316: }
1.315 albertel 6317: return $result;
1.306 albertel 6318: }
6319:
1.330 albertel 6320:
1.306 albertel 6321: =pod
6322:
6323: =item * &head()
6324:
6325: Returns a complete </body></html> section for LON-CAPA web pages.
6326:
1.315 albertel 6327: Inputs: $args - additional optional args supported are:
6328: js_ready -> return a string ready for being used in
6329: a javascript writeln
1.320 albertel 6330: html_encode -> return a string ready for being used in
6331: a html attribute
1.330 albertel 6332: frameset -> if true will start with a <frameset>
6333: rather than <body>
1.493 albertel 6334: dicsussion -> if true will get discussion from
6335: lonxml::xmlend
6336: (you can pass the target and parser arguments
6337: through optional 'target' and 'parser' args
6338: to this routine)
1.306 albertel 6339:
6340: =cut
6341:
6342: sub end_page {
1.315 albertel 6343: my ($args) = @_;
6344: $env{'internal.end_page'}++;
1.330 albertel 6345: my $result;
1.335 albertel 6346: if ($args->{'discussion'}) {
6347: my ($target,$parser);
6348: if (ref($args->{'discussion'})) {
6349: ($target,$parser) =($args->{'discussion'}{'target'},
6350: $args->{'discussion'}{'parser'});
6351: }
6352: $result .= &Apache::lonxml::xmlend($target,$parser);
6353: }
6354:
1.330 albertel 6355: if ($args->{'frameset'}) {
6356: $result .= '</frameset>';
6357: } else {
1.635 raeburn 6358: $result .= &endbodytag($args);
1.330 albertel 6359: }
6360: $result .= "\n</html>";
6361:
1.315 albertel 6362: if ($args->{'js_ready'}) {
1.317 albertel 6363: $result = &js_ready($result);
1.315 albertel 6364: }
1.335 albertel 6365:
1.320 albertel 6366: if ($args->{'html_encode'}) {
6367: $result = &html_encode($result);
6368: }
1.335 albertel 6369:
1.315 albertel 6370: return $result;
6371: }
6372:
1.320 albertel 6373: sub html_encode {
6374: my ($result) = @_;
6375:
1.322 albertel 6376: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6377:
6378: return $result;
6379: }
1.317 albertel 6380: sub js_ready {
6381: my ($result) = @_;
6382:
1.323 albertel 6383: $result =~ s/[\n\r]/ /xmsg;
6384: $result =~ s/\\/\\\\/xmsg;
6385: $result =~ s/'/\\'/xmsg;
1.372 albertel 6386: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6387:
6388: return $result;
6389: }
6390:
1.315 albertel 6391: sub validate_page {
6392: if ( exists($env{'internal.start_page'})
1.316 albertel 6393: && $env{'internal.start_page'} > 1) {
6394: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6395: $env{'internal.start_page'}.' '.
1.316 albertel 6396: $ENV{'request.filename'});
1.315 albertel 6397: }
6398: if ( exists($env{'internal.end_page'})
1.316 albertel 6399: && $env{'internal.end_page'} > 1) {
6400: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6401: $env{'internal.end_page'}.' '.
1.316 albertel 6402: $env{'request.filename'});
1.315 albertel 6403: }
6404: if ( exists($env{'internal.start_page'})
6405: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6406: &Apache::lonnet::logthis('start_page called without end_page '.
6407: $env{'request.filename'});
1.315 albertel 6408: }
6409: if ( ! exists($env{'internal.start_page'})
6410: && exists($env{'internal.end_page'})) {
1.316 albertel 6411: &Apache::lonnet::logthis('end_page called without start_page'.
6412: $env{'request.filename'});
1.315 albertel 6413: }
1.306 albertel 6414: }
1.315 albertel 6415:
1.318 albertel 6416: sub simple_error_page {
6417: my ($r,$title,$msg) = @_;
6418: my $page =
6419: &Apache::loncommon::start_page($title).
6420: &mt($msg).
6421: &Apache::loncommon::end_page();
6422: if (ref($r)) {
6423: $r->print($page);
1.327 albertel 6424: return;
1.318 albertel 6425: }
6426: return $page;
6427: }
1.347 albertel 6428:
6429: {
1.610 albertel 6430: my @row_count;
1.347 albertel 6431: sub start_data_table {
1.422 albertel 6432: my ($add_class) = @_;
6433: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6434: unshift(@row_count,0);
1.422 albertel 6435: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6436: }
6437:
6438: sub end_data_table {
1.610 albertel 6439: shift(@row_count);
1.389 albertel 6440: return '</table>'."\n";;
1.347 albertel 6441: }
6442:
6443: sub start_data_table_row {
1.422 albertel 6444: my ($add_class) = @_;
1.610 albertel 6445: $row_count[0]++;
6446: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428 albertel 6447: $css_class = (join(' ',$css_class,$add_class));
1.422 albertel 6448: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6449: }
1.471 banghart 6450:
6451: sub continue_data_table_row {
6452: my ($add_class) = @_;
1.610 albertel 6453: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471 banghart 6454: $css_class = (join(' ',$css_class,$add_class));
6455: return '<tr class="'.$css_class.'">'."\n";;
6456: }
1.347 albertel 6457:
6458: sub end_data_table_row {
1.389 albertel 6459: return '</tr>'."\n";;
1.347 albertel 6460: }
1.367 www 6461:
1.421 albertel 6462: sub start_data_table_empty_row {
1.707 bisitz 6463: # $row_count[0]++;
1.421 albertel 6464: return '<tr class="LC_empty_row" >'."\n";;
6465: }
6466:
6467: sub end_data_table_empty_row {
6468: return '</tr>'."\n";;
6469: }
6470:
1.367 www 6471: sub start_data_table_header_row {
1.389 albertel 6472: return '<tr class="LC_header_row">'."\n";;
1.367 www 6473: }
6474:
6475: sub end_data_table_header_row {
1.389 albertel 6476: return '</tr>'."\n";;
1.367 www 6477: }
1.347 albertel 6478: }
6479:
1.548 albertel 6480: =pod
6481:
6482: =item * &inhibit_menu_check($arg)
6483:
6484: Checks for a inhibitmenu state and generates output to preserve it
6485:
6486: Inputs: $arg - can be any of
6487: - undef - in which case the return value is a string
6488: to add into arguments list of a uri
6489: - 'input' - in which case the return value is a HTML
6490: <form> <input> field of type hidden to
6491: preserve the value
6492: - a url - in which case the return value is the url with
6493: the neccesary cgi args added to preserve the
6494: inhibitmenu state
6495: - a ref to a url - no return value, but the string is
6496: updated to include the neccessary cgi
6497: args to preserve the inhibitmenu state
6498:
6499: =cut
6500:
6501: sub inhibit_menu_check {
6502: my ($arg) = @_;
6503: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6504: if ($arg eq 'input') {
6505: if ($env{'form.inhibitmenu'}) {
6506: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6507: } else {
6508: return
6509: }
6510: }
6511: if ($env{'form.inhibitmenu'}) {
6512: if (ref($arg)) {
6513: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6514: } elsif ($arg eq '') {
6515: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6516: } else {
6517: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6518: }
6519: }
6520: if (!ref($arg)) {
6521: return $arg;
6522: }
6523: }
6524:
1.251 albertel 6525: ###############################################
1.182 matthew 6526:
6527: =pod
6528:
1.549 albertel 6529: =back
6530:
6531: =head1 User Information Routines
6532:
6533: =over 4
6534:
1.405 albertel 6535: =item * &get_users_function()
1.182 matthew 6536:
6537: Used by &bodytag to determine the current users primary role.
6538: Returns either 'student','coordinator','admin', or 'author'.
6539:
6540: =cut
6541:
6542: ###############################################
6543: sub get_users_function {
6544: my $function = 'student';
1.258 albertel 6545: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182 matthew 6546: $function='coordinator';
6547: }
1.258 albertel 6548: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 6549: $function='admin';
6550: }
1.258 albertel 6551: if (($env{'request.role'}=~/^(au|ca)/) ||
1.182 matthew 6552: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
6553: $function='author';
6554: }
6555: return $function;
1.54 www 6556: }
1.99 www 6557:
6558: ###############################################
6559:
1.233 raeburn 6560: =pod
6561:
1.542 raeburn 6562: =item * &check_user_status()
1.274 raeburn 6563:
6564: Determines current status of supplied role for a
6565: specific user. Roles can be active, previous or future.
6566:
6567: Inputs:
6568: user's domain, user's username, course's domain,
1.375 raeburn 6569: course's number, optional section ID.
1.274 raeburn 6570:
6571: Outputs:
6572: role status: active, previous or future.
6573:
6574: =cut
6575:
6576: sub check_user_status {
1.412 raeburn 6577: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 6578: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
6579: my @uroles = keys %userinfo;
6580: my $srchstr;
6581: my $active_chk = 'none';
1.412 raeburn 6582: my $now = time;
1.274 raeburn 6583: if (@uroles > 0) {
1.412 raeburn 6584: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 6585: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
6586: } else {
1.412 raeburn 6587: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
6588: }
6589: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 6590: my $role_end = 0;
6591: my $role_start = 0;
6592: $active_chk = 'active';
1.412 raeburn 6593: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
6594: $role_end = $1;
6595: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
6596: $role_start = $1;
1.274 raeburn 6597: }
6598: }
6599: if ($role_start > 0) {
1.412 raeburn 6600: if ($now < $role_start) {
1.274 raeburn 6601: $active_chk = 'future';
6602: }
6603: }
6604: if ($role_end > 0) {
1.412 raeburn 6605: if ($now > $role_end) {
1.274 raeburn 6606: $active_chk = 'previous';
6607: }
6608: }
6609: }
6610: }
6611: return $active_chk;
6612: }
6613:
6614: ###############################################
6615:
6616: =pod
6617:
1.405 albertel 6618: =item * &get_sections()
1.233 raeburn 6619:
6620: Determines all the sections for a course including
6621: sections with students and sections containing other roles.
1.419 raeburn 6622: Incoming parameters:
6623:
6624: 1. domain
6625: 2. course number
6626: 3. reference to array containing roles for which sections should
6627: be gathered (optional).
6628: 4. reference to array containing status types for which sections
6629: should be gathered (optional).
6630:
6631: If the third argument is undefined, sections are gathered for any role.
6632: If the fourth argument is undefined, sections are gathered for any status.
6633: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 6634:
1.374 raeburn 6635: Returns section hash (keys are section IDs, values are
6636: number of users in each section), subject to the
1.419 raeburn 6637: optional roles filter, optional status filter
1.233 raeburn 6638:
6639: =cut
6640:
6641: ###############################################
6642: sub get_sections {
1.419 raeburn 6643: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 6644: if (!defined($cdom) || !defined($cnum)) {
6645: my $cid = $env{'request.course.id'};
6646:
6647: return if (!defined($cid));
6648:
6649: $cdom = $env{'course.'.$cid.'.domain'};
6650: $cnum = $env{'course.'.$cid.'.num'};
6651: }
6652:
6653: my %sectioncount;
1.419 raeburn 6654: my $now = time;
1.240 albertel 6655:
1.366 albertel 6656: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 6657: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 6658: my $sec_index = &Apache::loncoursedata::CL_SECTION();
6659: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 6660: my $start_index = &Apache::loncoursedata::CL_START();
6661: my $end_index = &Apache::loncoursedata::CL_END();
6662: my $status;
1.366 albertel 6663: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 6664: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
6665: $data->[$status_index],
6666: $data->[$start_index],
6667: $data->[$end_index]);
6668: if ($stu_status eq 'Active') {
6669: $status = 'active';
6670: } elsif ($end < $now) {
6671: $status = 'previous';
6672: } elsif ($start > $now) {
6673: $status = 'future';
6674: }
6675: if ($section ne '-1' && $section !~ /^\s*$/) {
6676: if ((!defined($possible_status)) || (($status ne '') &&
6677: (grep/^\Q$status\E$/,@{$possible_status}))) {
6678: $sectioncount{$section}++;
6679: }
1.240 albertel 6680: }
6681: }
6682: }
6683: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6684: foreach my $user (sort(keys(%courseroles))) {
6685: if ($user !~ /^(\w{2})/) { next; }
6686: my ($role) = ($user =~ /^(\w{2})/);
6687: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 6688: my ($section,$status);
1.240 albertel 6689: if ($role eq 'cr' &&
6690: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
6691: $section=$1;
6692: }
6693: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
6694: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 6695: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
6696: if ($end == -1 && $start == -1) {
6697: next; #deleted role
6698: }
6699: if (!defined($possible_status)) {
6700: $sectioncount{$section}++;
6701: } else {
6702: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
6703: $status = 'active';
6704: } elsif ($end < $now) {
6705: $status = 'future';
6706: } elsif ($start > $now) {
6707: $status = 'previous';
6708: }
6709: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
6710: $sectioncount{$section}++;
6711: }
6712: }
1.233 raeburn 6713: }
1.366 albertel 6714: return %sectioncount;
1.233 raeburn 6715: }
6716:
1.274 raeburn 6717: ###############################################
1.294 raeburn 6718:
6719: =pod
1.405 albertel 6720:
6721: =item * &get_course_users()
6722:
1.275 raeburn 6723: Retrieves usernames:domains for users in the specified course
6724: with specific role(s), and access status.
6725:
6726: Incoming parameters:
1.277 albertel 6727: 1. course domain
6728: 2. course number
6729: 3. access status: users must have - either active,
1.275 raeburn 6730: previous, future, or all.
1.277 albertel 6731: 4. reference to array of permissible roles
1.288 raeburn 6732: 5. reference to array of section restrictions (optional)
6733: 6. reference to results object (hash of hashes).
6734: 7. reference to optional userdata hash
1.609 raeburn 6735: 8. reference to optional statushash
1.630 raeburn 6736: 9. flag if privileged users (except those set to unhide in
6737: course settings) should be excluded
1.609 raeburn 6738: Keys of top level results hash are roles.
1.275 raeburn 6739: Keys of inner hashes are username:domain, with
6740: values set to access type.
1.288 raeburn 6741: Optional userdata hash returns an array with arguments in the
6742: same order as loncoursedata::get_classlist() for student data.
6743:
1.609 raeburn 6744: Optional statushash returns
6745:
1.288 raeburn 6746: Entries for end, start, section and status are blank because
6747: of the possibility of multiple values for non-student roles.
6748:
1.275 raeburn 6749: =cut
1.405 albertel 6750:
1.275 raeburn 6751: ###############################################
1.405 albertel 6752:
1.275 raeburn 6753: sub get_course_users {
1.630 raeburn 6754: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 6755: my %idx = ();
1.419 raeburn 6756: my %seclists;
1.288 raeburn 6757:
6758: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
6759: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
6760: $idx{end} = &Apache::loncoursedata::CL_END();
6761: $idx{start} = &Apache::loncoursedata::CL_START();
6762: $idx{id} = &Apache::loncoursedata::CL_ID();
6763: $idx{section} = &Apache::loncoursedata::CL_SECTION();
6764: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
6765: $idx{status} = &Apache::loncoursedata::CL_STATUS();
6766:
1.290 albertel 6767: if (grep(/^st$/,@{$roles})) {
1.276 albertel 6768: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 6769: my $now = time;
1.277 albertel 6770: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 6771: my $match = 0;
1.412 raeburn 6772: my $secmatch = 0;
1.419 raeburn 6773: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 6774: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 6775: if ($section eq '') {
6776: $section = 'none';
6777: }
1.291 albertel 6778: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6779: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6780: $secmatch = 1;
6781: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 6782: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6783: $secmatch = 1;
6784: }
6785: } else {
1.419 raeburn 6786: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 6787: $secmatch = 1;
6788: }
1.290 albertel 6789: }
1.412 raeburn 6790: if (!$secmatch) {
6791: next;
6792: }
1.419 raeburn 6793: }
1.275 raeburn 6794: if (defined($$types{'active'})) {
1.288 raeburn 6795: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 6796: push(@{$$users{st}{$student}},'active');
1.288 raeburn 6797: $match = 1;
1.275 raeburn 6798: }
6799: }
6800: if (defined($$types{'previous'})) {
1.609 raeburn 6801: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 6802: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 6803: $match = 1;
1.275 raeburn 6804: }
6805: }
6806: if (defined($$types{'future'})) {
1.609 raeburn 6807: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 6808: push(@{$$users{st}{$student}},'future');
1.288 raeburn 6809: $match = 1;
1.275 raeburn 6810: }
6811: }
1.609 raeburn 6812: if ($match) {
6813: push(@{$seclists{$student}},$section);
6814: if (ref($userdata) eq 'HASH') {
6815: $$userdata{$student} = $$classlist{$student};
6816: }
6817: if (ref($statushash) eq 'HASH') {
6818: $statushash->{$student}{'st'}{$section} = $status;
6819: }
1.288 raeburn 6820: }
1.275 raeburn 6821: }
6822: }
1.412 raeburn 6823: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 6824: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6825: my $now = time;
1.609 raeburn 6826: my %displaystatus = ( previous => 'Expired',
6827: active => 'Active',
6828: future => 'Future',
6829: );
1.630 raeburn 6830: my %nothide;
6831: if ($hidepriv) {
6832: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
6833: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
6834: if ($user !~ /:/) {
6835: $nothide{join(':',split(/[\@]/,$user))}=1;
6836: } else {
6837: $nothide{$user} = 1;
6838: }
6839: }
6840: }
1.439 raeburn 6841: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 6842: my $match = 0;
1.412 raeburn 6843: my $secmatch = 0;
1.439 raeburn 6844: my $status;
1.412 raeburn 6845: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 6846: $user =~ s/:$//;
1.439 raeburn 6847: my ($end,$start) = split(/:/,$coursepersonnel{$person});
6848: if ($end == -1 || $start == -1) {
6849: next;
6850: }
6851: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
6852: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 6853: my ($uname,$udom) = split(/:/,$user);
6854: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6855: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6856: $secmatch = 1;
6857: } elsif ($usec eq '') {
1.420 albertel 6858: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6859: $secmatch = 1;
6860: }
6861: } else {
6862: if (grep(/^\Q$usec\E$/,@{$sections})) {
6863: $secmatch = 1;
6864: }
6865: }
6866: if (!$secmatch) {
6867: next;
6868: }
1.288 raeburn 6869: }
1.419 raeburn 6870: if ($usec eq '') {
6871: $usec = 'none';
6872: }
1.275 raeburn 6873: if ($uname ne '' && $udom ne '') {
1.630 raeburn 6874: if ($hidepriv) {
6875: if ((&Apache::lonnet::privileged($uname,$udom)) &&
6876: (!$nothide{$uname.':'.$udom})) {
6877: next;
6878: }
6879: }
1.503 raeburn 6880: if ($end > 0 && $end < $now) {
1.439 raeburn 6881: $status = 'previous';
6882: } elsif ($start > $now) {
6883: $status = 'future';
6884: } else {
6885: $status = 'active';
6886: }
1.277 albertel 6887: foreach my $type (keys(%{$types})) {
1.275 raeburn 6888: if ($status eq $type) {
1.420 albertel 6889: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 6890: push(@{$$users{$role}{$user}},$type);
6891: }
1.288 raeburn 6892: $match = 1;
6893: }
6894: }
1.419 raeburn 6895: if (($match) && (ref($userdata) eq 'HASH')) {
6896: if (!exists($$userdata{$uname.':'.$udom})) {
6897: &get_user_info($udom,$uname,\%idx,$userdata);
6898: }
1.420 albertel 6899: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 6900: push(@{$seclists{$uname.':'.$udom}},$usec);
6901: }
1.609 raeburn 6902: if (ref($statushash) eq 'HASH') {
6903: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
6904: }
1.275 raeburn 6905: }
6906: }
6907: }
6908: }
1.290 albertel 6909: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 6910: if ((defined($cdom)) && (defined($cnum))) {
6911: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
6912: if ( defined($csettings{'internal.courseowner'}) ) {
6913: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 6914: next if ($owner eq '');
6915: my ($ownername,$ownerdom);
6916: if ($owner =~ /^([^:]+):([^:]+)$/) {
6917: $ownername = $1;
6918: $ownerdom = $2;
6919: } else {
6920: $ownername = $owner;
6921: $ownerdom = $cdom;
6922: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 6923: }
6924: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 6925: if (defined($userdata) &&
1.609 raeburn 6926: !exists($$userdata{$owner})) {
6927: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
6928: if (!grep(/^none$/,@{$seclists{$owner}})) {
6929: push(@{$seclists{$owner}},'none');
6930: }
6931: if (ref($statushash) eq 'HASH') {
6932: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 6933: }
1.290 albertel 6934: }
1.279 raeburn 6935: }
6936: }
6937: }
1.419 raeburn 6938: foreach my $user (keys(%seclists)) {
6939: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
6940: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
6941: }
1.275 raeburn 6942: }
6943: return;
6944: }
6945:
1.288 raeburn 6946: sub get_user_info {
6947: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 6948: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
6949: &plainname($uname,$udom,'lastname');
1.291 albertel 6950: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 6951: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 6952: my %idhash = &Apache::lonnet::idrget($udom,($uname));
6953: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 6954: return;
6955: }
1.275 raeburn 6956:
1.472 raeburn 6957: ###############################################
6958:
6959: =pod
6960:
6961: =item * &get_user_quota()
6962:
6963: Retrieves quota assigned for storage of portfolio files for a user
6964:
6965: Incoming parameters:
6966: 1. user's username
6967: 2. user's domain
6968:
6969: Returns:
1.536 raeburn 6970: 1. Disk quota (in Mb) assigned to student.
6971: 2. (Optional) Type of setting: custom or default
6972: (individually assigned or default for user's
6973: institutional status).
6974: 3. (Optional) - User's institutional status (e.g., faculty, staff
6975: or student - types as defined in localenroll::inst_usertypes
6976: for user's domain, which determines default quota for user.
6977: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 6978:
6979: If a value has been stored in the user's environment,
1.536 raeburn 6980: it will return that, otherwise it returns the maximal default
6981: defined for the user's instituional status(es) in the domain.
1.472 raeburn 6982:
6983: =cut
6984:
6985: ###############################################
6986:
6987:
6988: sub get_user_quota {
6989: my ($uname,$udom) = @_;
1.536 raeburn 6990: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 6991: if (!defined($udom)) {
6992: $udom = $env{'user.domain'};
6993: }
6994: if (!defined($uname)) {
6995: $uname = $env{'user.name'};
6996: }
6997: if (($udom eq '' || $uname eq '') ||
6998: ($udom eq 'public') && ($uname eq 'public')) {
6999: $quota = 0;
1.536 raeburn 7000: $quotatype = 'default';
7001: $defquota = 0;
1.472 raeburn 7002: } else {
1.536 raeburn 7003: my $inststatus;
1.472 raeburn 7004: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7005: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7006: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7007: } else {
1.536 raeburn 7008: my %userenv =
7009: &Apache::lonnet::get('environment',['portfolioquota',
7010: 'inststatus'],$udom,$uname);
1.472 raeburn 7011: my ($tmp) = keys(%userenv);
7012: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7013: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7014: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7015: } else {
7016: undef(%userenv);
7017: }
7018: }
1.536 raeburn 7019: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7020: if ($quota eq '') {
1.536 raeburn 7021: $quota = $defquota;
7022: $quotatype = 'default';
7023: } else {
7024: $quotatype = 'custom';
1.472 raeburn 7025: }
7026: }
1.536 raeburn 7027: if (wantarray) {
7028: return ($quota,$quotatype,$settingstatus,$defquota);
7029: } else {
7030: return $quota;
7031: }
1.472 raeburn 7032: }
7033:
7034: ###############################################
7035:
7036: =pod
7037:
7038: =item * &default_quota()
7039:
1.536 raeburn 7040: Retrieves default quota assigned for storage of user portfolio files,
7041: given an (optional) user's institutional status.
1.472 raeburn 7042:
7043: Incoming parameters:
7044: 1. domain
1.536 raeburn 7045: 2. (Optional) institutional status(es). This is a : separated list of
7046: status types (e.g., faculty, staff, student etc.)
7047: which apply to the user for whom the default is being retrieved.
7048: If the institutional status string in undefined, the domain
7049: default quota will be returned.
1.472 raeburn 7050:
7051: Returns:
7052: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7053: 2. (Optional) institutional type which determined the value of the
7054: default quota.
1.472 raeburn 7055:
7056: If a value has been stored in the domain's configuration db,
7057: it will return that, otherwise it returns 20 (for backwards
7058: compatibility with domains which have not set up a configuration
7059: db file; the original statically defined portfolio quota was 20 Mb).
7060:
1.536 raeburn 7061: If the user's status includes multiple types (e.g., staff and student),
7062: the largest default quota which applies to the user determines the
7063: default quota returned.
7064:
1.780 raeburn 7065: =back
7066:
1.472 raeburn 7067: =cut
7068:
7069: ###############################################
7070:
7071:
7072: sub default_quota {
1.536 raeburn 7073: my ($udom,$inststatus) = @_;
7074: my ($defquota,$settingstatus);
7075: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7076: ['quotas'],$udom);
7077: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7078: if ($inststatus ne '') {
1.765 raeburn 7079: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7080: foreach my $item (@statuses) {
1.711 raeburn 7081: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7082: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7083: if ($defquota eq '') {
7084: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7085: $settingstatus = $item;
7086: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7087: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7088: $settingstatus = $item;
7089: }
7090: }
7091: } else {
7092: if ($quotahash{'quotas'}{$item} ne '') {
7093: if ($defquota eq '') {
7094: $defquota = $quotahash{'quotas'}{$item};
7095: $settingstatus = $item;
7096: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7097: $defquota = $quotahash{'quotas'}{$item};
7098: $settingstatus = $item;
7099: }
1.536 raeburn 7100: }
7101: }
7102: }
7103: }
7104: if ($defquota eq '') {
1.711 raeburn 7105: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7106: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7107: } else {
7108: $defquota = $quotahash{'quotas'}{'default'};
7109: }
1.536 raeburn 7110: $settingstatus = 'default';
7111: }
7112: } else {
7113: $settingstatus = 'default';
7114: $defquota = 20;
7115: }
7116: if (wantarray) {
7117: return ($defquota,$settingstatus);
1.472 raeburn 7118: } else {
1.536 raeburn 7119: return $defquota;
1.472 raeburn 7120: }
7121: }
7122:
1.384 raeburn 7123: sub get_secgrprole_info {
7124: my ($cdom,$cnum,$needroles,$type) = @_;
7125: my %sections_count = &get_sections($cdom,$cnum);
7126: my @sections = (sort {$a <=> $b} keys(%sections_count));
7127: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7128: my @groups = sort(keys(%curr_groups));
7129: my $allroles = [];
7130: my $rolehash;
7131: my $accesshash = {
7132: active => 'Currently has access',
7133: future => 'Will have future access',
7134: previous => 'Previously had access',
7135: };
7136: if ($needroles) {
7137: $rolehash = {'all' => 'all'};
1.385 albertel 7138: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7139: if (&Apache::lonnet::error(%user_roles)) {
7140: undef(%user_roles);
7141: }
7142: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7143: my ($role)=split(/\:/,$item,2);
7144: if ($role eq 'cr') { next; }
7145: if ($role =~ /^cr/) {
7146: $$rolehash{$role} = (split('/',$role))[3];
7147: } else {
7148: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7149: }
7150: }
7151: foreach my $key (sort(keys(%{$rolehash}))) {
7152: push(@{$allroles},$key);
7153: }
7154: push (@{$allroles},'st');
7155: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7156: }
7157: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7158: }
7159:
1.555 raeburn 7160: sub user_picker {
1.627 raeburn 7161: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7162: my $currdom = $dom;
7163: my %curr_selected = (
7164: srchin => 'dom',
1.580 raeburn 7165: srchby => 'lastname',
1.555 raeburn 7166: );
7167: my $srchterm;
1.625 raeburn 7168: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7169: if ($srch->{'srchby'} ne '') {
7170: $curr_selected{'srchby'} = $srch->{'srchby'};
7171: }
7172: if ($srch->{'srchin'} ne '') {
7173: $curr_selected{'srchin'} = $srch->{'srchin'};
7174: }
7175: if ($srch->{'srchtype'} ne '') {
7176: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7177: }
7178: if ($srch->{'srchdomain'} ne '') {
7179: $currdom = $srch->{'srchdomain'};
7180: }
7181: $srchterm = $srch->{'srchterm'};
7182: }
7183: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7184: 'usr' => 'Search criteria',
1.563 raeburn 7185: 'doma' => 'Domain/institution to search',
1.558 albertel 7186: 'uname' => 'username',
7187: 'lastname' => 'last name',
1.555 raeburn 7188: 'lastfirst' => 'last name, first name',
1.558 albertel 7189: 'crs' => 'in this course',
1.576 raeburn 7190: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7191: 'alc' => 'all LON-CAPA',
1.573 raeburn 7192: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7193: 'exact' => 'is',
7194: 'contains' => 'contains',
1.569 raeburn 7195: 'begins' => 'begins with',
1.571 raeburn 7196: 'youm' => "You must include some text to search for.",
7197: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7198: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7199: 'yomc' => "You must choose a domain when using an institutional directory search.",
7200: 'ymcd' => "You must choose a domain when using a domain search.",
7201: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7202: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7203: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7204: );
1.563 raeburn 7205: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7206: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7207:
7208: my @srchins = ('crs','dom','alc','instd');
7209:
7210: foreach my $option (@srchins) {
7211: # FIXME 'alc' option unavailable until
7212: # loncreateuser::print_user_query_page()
7213: # has been completed.
7214: next if ($option eq 'alc');
7215: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7216: if ($curr_selected{'srchin'} eq $option) {
7217: $srchinsel .= '
7218: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7219: } else {
7220: $srchinsel .= '
7221: <option value="'.$option.'">'.$lt{$option}.'</option>';
7222: }
1.555 raeburn 7223: }
1.563 raeburn 7224: $srchinsel .= "\n </select>\n";
1.555 raeburn 7225:
7226: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7227: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7228: if ($curr_selected{'srchby'} eq $option) {
7229: $srchbysel .= '
7230: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7231: } else {
7232: $srchbysel .= '
7233: <option value="'.$option.'">'.$lt{$option}.'</option>';
7234: }
7235: }
7236: $srchbysel .= "\n </select>\n";
7237:
7238: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7239: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7240: if ($curr_selected{'srchtype'} eq $option) {
7241: $srchtypesel .= '
7242: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7243: } else {
7244: $srchtypesel .= '
7245: <option value="'.$option.'">'.$lt{$option}.'</option>';
7246: }
7247: }
7248: $srchtypesel .= "\n </select>\n";
7249:
1.558 albertel 7250: my ($newuserscript,$new_user_create);
1.556 raeburn 7251:
7252: if ($forcenewuser) {
1.576 raeburn 7253: if (ref($srch) eq 'HASH') {
7254: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7255: if ($cancreate) {
7256: $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>';
7257: } else {
7258: my $helplink = ' href="javascript:helpMenu('."'display'".')"';
7259: my %usertypetext = (
7260: official => 'institutional',
7261: unofficial => 'non-institutional',
7262: );
7263: $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 />';
7264: }
1.576 raeburn 7265: }
7266: }
7267:
1.556 raeburn 7268: $newuserscript = <<"ENDSCRIPT";
7269:
1.570 raeburn 7270: function setSearch(createnew,callingForm) {
1.556 raeburn 7271: if (createnew == 1) {
1.570 raeburn 7272: for (var i=0; i<callingForm.srchby.length; i++) {
7273: if (callingForm.srchby.options[i].value == 'uname') {
7274: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7275: }
7276: }
1.570 raeburn 7277: for (var i=0; i<callingForm.srchin.length; i++) {
7278: if ( callingForm.srchin.options[i].value == 'dom') {
7279: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7280: }
7281: }
1.570 raeburn 7282: for (var i=0; i<callingForm.srchtype.length; i++) {
7283: if (callingForm.srchtype.options[i].value == 'exact') {
7284: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7285: }
7286: }
1.570 raeburn 7287: for (var i=0; i<callingForm.srchdomain.length; i++) {
7288: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7289: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7290: }
7291: }
7292: }
7293: }
7294: ENDSCRIPT
1.558 albertel 7295:
1.556 raeburn 7296: }
7297:
1.555 raeburn 7298: my $output = <<"END_BLOCK";
1.556 raeburn 7299: <script type="text/javascript">
1.570 raeburn 7300: function validateEntry(callingForm) {
1.558 albertel 7301:
1.556 raeburn 7302: var checkok = 1;
1.558 albertel 7303: var srchin;
1.570 raeburn 7304: for (var i=0; i<callingForm.srchin.length; i++) {
7305: if ( callingForm.srchin[i].checked ) {
7306: srchin = callingForm.srchin[i].value;
1.558 albertel 7307: }
7308: }
7309:
1.570 raeburn 7310: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7311: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7312: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7313: var srchterm = callingForm.srchterm.value;
7314: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7315: var msg = "";
7316:
7317: if (srchterm == "") {
7318: checkok = 0;
1.571 raeburn 7319: msg += "$lt{'youm'}\\n";
1.556 raeburn 7320: }
7321:
1.569 raeburn 7322: if (srchtype== 'begins') {
7323: if (srchterm.length < 2) {
7324: checkok = 0;
1.571 raeburn 7325: msg += "$lt{'thte'}\\n";
1.569 raeburn 7326: }
7327: }
7328:
1.556 raeburn 7329: if (srchtype== 'contains') {
7330: if (srchterm.length < 3) {
7331: checkok = 0;
1.571 raeburn 7332: msg += "$lt{'thet'}\\n";
1.556 raeburn 7333: }
7334: }
7335: if (srchin == 'instd') {
7336: if (srchdomain == '') {
7337: checkok = 0;
1.571 raeburn 7338: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7339: }
7340: }
7341: if (srchin == 'dom') {
7342: if (srchdomain == '') {
7343: checkok = 0;
1.571 raeburn 7344: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7345: }
7346: }
7347: if (srchby == 'lastfirst') {
7348: if (srchterm.indexOf(",") == -1) {
7349: checkok = 0;
1.571 raeburn 7350: msg += "$lt{'whus'}\\n";
1.556 raeburn 7351: }
7352: if (srchterm.indexOf(",") == srchterm.length -1) {
7353: checkok = 0;
1.571 raeburn 7354: msg += "$lt{'whse'}\\n";
1.556 raeburn 7355: }
7356: }
7357: if (checkok == 0) {
1.571 raeburn 7358: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7359: return;
7360: }
7361: if (checkok == 1) {
1.570 raeburn 7362: callingForm.submit();
1.556 raeburn 7363: }
7364: }
7365:
7366: $newuserscript
7367:
7368: </script>
1.558 albertel 7369:
7370: $new_user_create
7371:
1.555 raeburn 7372: <table>
1.558 albertel 7373: <tr>
1.573 raeburn 7374: <td>$lt{'doma'}:</td>
7375: <td>$domform</td>
7376: </td>
7377: </tr>
7378: <tr>
7379: <td>$lt{'usr'}:</td>
1.563 raeburn 7380: <td>$srchbysel
7381: $srchtypesel
7382: <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564 albertel 7383: $srchinsel
1.563 raeburn 7384: </td>
7385: </tr>
1.555 raeburn 7386: </table>
7387: <br />
7388: END_BLOCK
1.558 albertel 7389:
1.555 raeburn 7390: return $output;
7391: }
7392:
1.612 raeburn 7393: sub user_rule_check {
1.615 raeburn 7394: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7395: my $response;
7396: if (ref($usershash) eq 'HASH') {
7397: foreach my $user (keys(%{$usershash})) {
7398: my ($uname,$udom) = split(/:/,$user);
7399: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7400: my ($id,$newuser);
1.612 raeburn 7401: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7402: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7403: $id = $usershash->{$user}->{'id'};
7404: }
7405: my $inst_response;
7406: if (ref($checks) eq 'HASH') {
7407: if (defined($checks->{'username'})) {
1.615 raeburn 7408: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7409: &Apache::lonnet::get_instuser($udom,$uname);
7410: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7411: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7412: &Apache::lonnet::get_instuser($udom,undef,$id);
7413: }
1.615 raeburn 7414: } else {
7415: ($inst_response,%{$inst_results->{$user}}) =
7416: &Apache::lonnet::get_instuser($udom,$uname);
7417: return;
1.612 raeburn 7418: }
1.615 raeburn 7419: if (!$got_rules->{$udom}) {
1.612 raeburn 7420: my %domconfig = &Apache::lonnet::get_dom('configuration',
7421: ['usercreation'],$udom);
7422: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7423: foreach my $item ('username','id') {
1.612 raeburn 7424: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7425: $$curr_rules{$udom}{$item} =
7426: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7427: }
7428: }
7429: }
1.615 raeburn 7430: $got_rules->{$udom} = 1;
1.585 raeburn 7431: }
1.612 raeburn 7432: foreach my $item (keys(%{$checks})) {
7433: if (ref($$curr_rules{$udom}) eq 'HASH') {
7434: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7435: if (@{$$curr_rules{$udom}{$item}} > 0) {
7436: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7437: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7438: if ($rule_check{$rule}) {
7439: $$rulematch{$user}{$item} = $rule;
7440: if ($inst_response eq 'ok') {
1.615 raeburn 7441: if (ref($inst_results) eq 'HASH') {
7442: if (ref($inst_results->{$user}) eq 'HASH') {
7443: if (keys(%{$inst_results->{$user}}) == 0) {
7444: $$alerts{$item}{$udom}{$uname} = 1;
7445: }
1.612 raeburn 7446: }
7447: }
1.615 raeburn 7448: }
7449: last;
1.585 raeburn 7450: }
7451: }
7452: }
7453: }
7454: }
7455: }
7456: }
7457: }
1.612 raeburn 7458: return;
7459: }
7460:
7461: sub user_rule_formats {
7462: my ($domain,$domdesc,$curr_rules,$check) = @_;
7463: my %text = (
7464: 'username' => 'Usernames',
7465: 'id' => 'IDs',
7466: );
7467: my $output;
7468: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7469: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7470: if (@{$ruleorder} > 0) {
7471: $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>';
7472: foreach my $rule (@{$ruleorder}) {
7473: if (ref($curr_rules) eq 'ARRAY') {
7474: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7475: if (ref($rules->{$rule}) eq 'HASH') {
7476: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7477: $rules->{$rule}{'desc'}.'</li>';
7478: }
7479: }
7480: }
7481: }
7482: $output .= '</ul>';
7483: }
7484: }
7485: return $output;
7486: }
7487:
7488: sub instrule_disallow_msg {
1.615 raeburn 7489: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7490: my $response;
7491: my %text = (
7492: item => 'username',
7493: items => 'usernames',
7494: match => 'matches',
7495: do => 'does',
7496: action => 'a username',
7497: one => 'one',
7498: );
7499: if ($count > 1) {
7500: $text{'item'} = 'usernames';
7501: $text{'match'} ='match';
7502: $text{'do'} = 'do';
7503: $text{'action'} = 'usernames',
7504: $text{'one'} = 'ones';
7505: }
7506: if ($checkitem eq 'id') {
7507: $text{'items'} = 'IDs';
7508: $text{'item'} = 'ID';
7509: $text{'action'} = 'an ID';
1.615 raeburn 7510: if ($count > 1) {
7511: $text{'item'} = 'IDs';
7512: $text{'action'} = 'IDs';
7513: }
1.612 raeburn 7514: }
1.674 bisitz 7515: $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 7516: if ($mode eq 'upload') {
7517: if ($checkitem eq 'username') {
7518: $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'}.");
7519: } elsif ($checkitem eq 'id') {
1.674 bisitz 7520: $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 7521: }
1.669 raeburn 7522: } elsif ($mode eq 'selfcreate') {
7523: if ($checkitem eq 'id') {
7524: $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.");
7525: }
1.615 raeburn 7526: } else {
7527: if ($checkitem eq 'username') {
7528: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
7529: } elsif ($checkitem eq 'id') {
7530: $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.");
7531: }
1.612 raeburn 7532: }
7533: return $response;
1.585 raeburn 7534: }
7535:
1.624 raeburn 7536: sub personal_data_fieldtitles {
7537: my %fieldtitles = &Apache::lonlocal::texthash (
7538: id => 'Student/Employee ID',
7539: permanentemail => 'E-mail address',
7540: lastname => 'Last Name',
7541: firstname => 'First Name',
7542: middlename => 'Middle Name',
7543: generation => 'Generation',
7544: gen => 'Generation',
1.765 raeburn 7545: inststatus => 'Affiliation',
1.624 raeburn 7546: );
7547: return %fieldtitles;
7548: }
7549:
1.642 raeburn 7550: sub sorted_inst_types {
7551: my ($dom) = @_;
7552: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
7553: my $othertitle = &mt('All users');
7554: if ($env{'request.course.id'}) {
1.668 raeburn 7555: $othertitle = &mt('Any users');
1.642 raeburn 7556: }
7557: my @types;
7558: if (ref($order) eq 'ARRAY') {
7559: @types = @{$order};
7560: }
7561: if (@types == 0) {
7562: if (ref($usertypes) eq 'HASH') {
7563: @types = sort(keys(%{$usertypes}));
7564: }
7565: }
7566: if (keys(%{$usertypes}) > 0) {
7567: $othertitle = &mt('Other users');
7568: }
7569: return ($othertitle,$usertypes,\@types);
7570: }
7571:
1.645 raeburn 7572: sub get_institutional_codes {
7573: my ($settings,$allcourses,$LC_code) = @_;
7574: # Get complete list of course sections to update
7575: my @currsections = ();
7576: my @currxlists = ();
7577: my $coursecode = $$settings{'internal.coursecode'};
7578:
7579: if ($$settings{'internal.sectionnums'} ne '') {
7580: @currsections = split(/,/,$$settings{'internal.sectionnums'});
7581: }
7582:
7583: if ($$settings{'internal.crosslistings'} ne '') {
7584: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
7585: }
7586:
7587: if (@currxlists > 0) {
7588: foreach (@currxlists) {
7589: if (m/^([^:]+):(\w*)$/) {
7590: unless (grep/^$1$/,@{$allcourses}) {
7591: push @{$allcourses},$1;
7592: $$LC_code{$1} = $2;
7593: }
7594: }
7595: }
7596: }
7597:
7598: if (@currsections > 0) {
7599: foreach (@currsections) {
7600: if (m/^(\w+):(\w*)$/) {
7601: my $sec = $coursecode.$1;
7602: my $lc_sec = $2;
7603: unless (grep/^$sec$/,@{$allcourses}) {
7604: push @{$allcourses},$sec;
7605: $$LC_code{$sec} = $lc_sec;
7606: }
7607: }
7608: }
7609: }
7610: return;
7611: }
7612:
1.112 bowersj2 7613: =pod
7614:
1.780 raeburn 7615: =head1 Slot Helpers
7616:
7617: =over 4
7618:
7619: =item * sorted_slots()
7620:
7621: Sorts an array of slot names in order of slot start time (earliest first).
7622:
7623: Inputs:
7624:
7625: =over 4
7626:
7627: slotsarr - Reference to array of unsorted slot names.
7628:
7629: slots - Reference to hash of hash, where outer hash keys are slot names.
7630:
1.549 albertel 7631: =back
7632:
1.780 raeburn 7633: Returns:
7634:
7635: =over 4
7636:
7637: sorted - An array of slot names sorted by the start time of the slot.
7638:
7639: =back
7640:
7641: =back
7642:
7643: =cut
7644:
7645:
7646: sub sorted_slots {
7647: my ($slotsarr,$slots) = @_;
7648: my @sorted;
7649: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
7650: @sorted =
7651: sort {
7652: if (ref($slots->{$a}) && ref($slots->{$b})) {
7653: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
7654: }
7655: if (ref($slots->{$a})) { return -1;}
7656: if (ref($slots->{$b})) { return 1;}
7657: return 0;
7658: } @{$slotsarr};
7659: }
7660: return @sorted;
7661: }
7662:
7663:
7664: =pod
7665:
1.549 albertel 7666: =head1 HTTP Helpers
7667:
7668: =over 4
7669:
1.648 raeburn 7670: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 7671:
1.258 albertel 7672: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 7673: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 7674: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 7675:
7676: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
7677: $possible_names is an ref to an array of form element names. As an example:
7678: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 7679: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 7680:
7681: =cut
1.1 albertel 7682:
1.6 albertel 7683: sub get_unprocessed_cgi {
1.25 albertel 7684: my ($query,$possible_names)= @_;
1.26 matthew 7685: # $Apache::lonxml::debug=1;
1.356 albertel 7686: foreach my $pair (split(/&/,$query)) {
7687: my ($name, $value) = split(/=/,$pair);
1.369 www 7688: $name = &unescape($name);
1.25 albertel 7689: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
7690: $value =~ tr/+/ /;
7691: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 7692: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 7693: }
1.16 harris41 7694: }
1.6 albertel 7695: }
7696:
1.112 bowersj2 7697: =pod
7698:
1.648 raeburn 7699: =item * &cacheheader()
1.112 bowersj2 7700:
7701: returns cache-controlling header code
7702:
7703: =cut
7704:
1.7 albertel 7705: sub cacheheader {
1.258 albertel 7706: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 7707: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
7708: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 7709: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
7710: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 7711: return $output;
1.7 albertel 7712: }
7713:
1.112 bowersj2 7714: =pod
7715:
1.648 raeburn 7716: =item * &no_cache($r)
1.112 bowersj2 7717:
7718: specifies header code to not have cache
7719:
7720: =cut
7721:
1.9 albertel 7722: sub no_cache {
1.216 albertel 7723: my ($r) = @_;
7724: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 7725: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 7726: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
7727: $r->no_cache(1);
7728: $r->header_out("Expires" => $date);
7729: $r->header_out("Pragma" => "no-cache");
1.123 www 7730: }
7731:
7732: sub content_type {
1.181 albertel 7733: my ($r,$type,$charset) = @_;
1.299 foxr 7734: if ($r) {
7735: # Note that printout.pl calls this with undef for $r.
7736: &no_cache($r);
7737: }
1.258 albertel 7738: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 7739: unless ($charset) {
7740: $charset=&Apache::lonlocal::current_encoding;
7741: }
7742: if ($charset) { $type.='; charset='.$charset; }
7743: if ($r) {
7744: $r->content_type($type);
7745: } else {
7746: print("Content-type: $type\n\n");
7747: }
1.9 albertel 7748: }
1.25 albertel 7749:
1.112 bowersj2 7750: =pod
7751:
1.648 raeburn 7752: =item * &add_to_env($name,$value)
1.112 bowersj2 7753:
1.258 albertel 7754: adds $name to the %env hash with value
1.112 bowersj2 7755: $value, if $name already exists, the entry is converted to an array
7756: reference and $value is added to the array.
7757:
7758: =cut
7759:
1.25 albertel 7760: sub add_to_env {
7761: my ($name,$value)=@_;
1.258 albertel 7762: if (defined($env{$name})) {
7763: if (ref($env{$name})) {
1.25 albertel 7764: #already have multiple values
1.258 albertel 7765: push(@{ $env{$name} },$value);
1.25 albertel 7766: } else {
7767: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 7768: my $first=$env{$name};
7769: undef($env{$name});
7770: push(@{ $env{$name} },$first,$value);
1.25 albertel 7771: }
7772: } else {
1.258 albertel 7773: $env{$name}=$value;
1.25 albertel 7774: }
1.31 albertel 7775: }
1.149 albertel 7776:
7777: =pod
7778:
1.648 raeburn 7779: =item * &get_env_multiple($name)
1.149 albertel 7780:
1.258 albertel 7781: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 7782: values may be defined and end up as an array ref.
7783:
7784: returns an array of values
7785:
7786: =cut
7787:
7788: sub get_env_multiple {
7789: my ($name) = @_;
7790: my @values;
1.258 albertel 7791: if (defined($env{$name})) {
1.149 albertel 7792: # exists is it an array
1.258 albertel 7793: if (ref($env{$name})) {
7794: @values=@{ $env{$name} };
1.149 albertel 7795: } else {
1.258 albertel 7796: $values[0]=$env{$name};
1.149 albertel 7797: }
7798: }
7799: return(@values);
7800: }
7801:
1.660 raeburn 7802: sub ask_for_embedded_content {
7803: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
7804: my $upload_output = '
7805: <form name="upload_embedded" action="'.$actionurl.'"
7806: method="post" enctype="multipart/form-data">';
7807: $upload_output .= $state;
1.661 raeburn 7808: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 7809:
7810: my $num = 0;
7811: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
7812: $upload_output .= &start_data_table_row().
7813: '<td>'.$embed_file.'</td><td>';
7814: if ($args->{'ignore_remote_references'}
7815: && $embed_file =~ m{^\w+://}) {
7816: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
7817: } elsif ($args->{'error_on_invalid_names'}
7818: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
7819:
7820: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
7821:
7822: } else {
7823: $upload_output .='
1.661 raeburn 7824: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 7825: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
7826: my $attrib = join(':',@{$$allfiles{$embed_file}});
7827: $upload_output .=
7828: "\n\t\t".
7829: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
7830: $attrib.'" />';
7831: if (exists($$codebase{$embed_file})) {
7832: $upload_output .=
7833: "\n\t\t".
7834: '<input name="codebase_'.$num.'" type="hidden" value="'.
7835: &escape($$codebase{$embed_file}).'" />';
7836: }
7837: }
7838: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
7839: $num++;
7840: }
7841: $upload_output .= &Apache::loncommon::end_data_table().'<br />
7842: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
7843: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
7844: '.&mt('(only files for which a location has been provided will be uploaded)').'
7845: </form>';
7846: return $upload_output;
7847: }
7848:
1.661 raeburn 7849: sub upload_embedded {
7850: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
7851: $current_disk_usage) = @_;
7852: my $output;
7853: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
7854: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
7855: my $orig_uploaded_filename =
7856: $env{'form.embedded_item_'.$i.'.filename'};
7857:
7858: $env{'form.embedded_orig_'.$i} =
7859: &unescape($env{'form.embedded_orig_'.$i});
7860: my ($path,$fname) =
7861: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
7862: # no path, whole string is fname
7863: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
7864:
7865: $path = $env{'form.currentpath'}.$path;
7866: $fname = &Apache::lonnet::clean_filename($fname);
7867: # See if there is anything left
7868: next if ($fname eq '');
7869:
7870: # Check if file already exists as a file or directory.
7871: my ($state,$msg);
7872: if ($context eq 'portfolio') {
7873: my $port_path = $dirpath;
7874: if ($group ne '') {
7875: $port_path = "groups/$group/$port_path";
7876: }
7877: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
7878: $dir_root,$port_path,$disk_quota,
7879: $current_disk_usage,$uname,$udom);
7880: if ($state eq 'will_exceed_quota'
7881: || $state eq 'file_locked'
7882: || $state eq 'file_exists' ) {
7883: $output .= $msg;
7884: next;
7885: }
7886: } elsif (($context eq 'author') || ($context eq 'testbank')) {
7887: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
7888: if ($state eq 'exists') {
7889: $output .= $msg;
7890: next;
7891: }
7892: }
7893: # Check if extension is valid
7894: if (($fname =~ /\.(\w+)$/) &&
7895: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
7896: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
7897: next;
7898: } elsif (($fname =~ /\.(\w+)$/) &&
7899: (!defined(&Apache::loncommon::fileembstyle($1)))) {
7900: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
7901: next;
7902: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
7903: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
7904: next;
7905: }
7906:
7907: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
7908: if ($context eq 'portfolio') {
7909: my $result=
7910: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
7911: $dirpath.$path);
7912: if ($result !~ m|^/uploaded/|) {
7913: $output .= '<span class="LC_error">'
7914: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
7915: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
7916: .'</span><br />';
7917: next;
7918: } else {
7919: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
7920: $path.$fname.'</span>').'</p>';
7921: }
7922: } else {
7923: # Save the file
7924: my $target = $env{'form.embedded_item_'.$i};
7925: my $fullpath = $dir_root.$dirpath.'/'.$path;
7926: my $dest = $fullpath.$fname;
7927: my $url = $url_root.$dirpath.'/'.$path.$fname;
7928: my @parts=split(/\//,$fullpath);
7929: my $count;
7930: my $filepath = $dir_root;
7931: for ($count=4;$count<=$#parts;$count++) {
7932: $filepath .= "/$parts[$count]";
7933: if ((-e $filepath)!=1) {
7934: mkdir($filepath,0770);
7935: }
7936: }
7937: my $fh;
7938: if (!open($fh,'>'.$dest)) {
7939: &Apache::lonnet::logthis('Failed to create '.$dest);
7940: $output .= '<span class="LC_error">'.
7941: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7942: '</span><br />';
7943: } else {
7944: if (!print $fh $env{'form.embedded_item_'.$i}) {
7945: &Apache::lonnet::logthis('Failed to write to '.$dest);
7946: $output .= '<span class="LC_error">'.
7947: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7948: '</span><br />';
7949: } else {
7950: if ($context eq 'testbank') {
7951: $output .= &mt('Embedded file uploaded successfully:').
7952: ' <a href="'.$url.'">'.
7953: $orig_uploaded_filename.'</a><br />';
7954: } else {
1.705 tempelho 7955: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 7956: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 7957: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 7958: }
7959: }
7960: close($fh);
7961: }
7962: }
7963: }
7964: return $output;
7965: }
7966:
7967: sub check_for_existing {
7968: my ($path,$fname,$element) = @_;
7969: my ($state,$msg);
7970: if (-d $path.'/'.$fname) {
7971: $state = 'exists';
7972: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7973: } elsif (-e $path.'/'.$fname) {
7974: $state = 'exists';
7975: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7976: }
7977: if ($state eq 'exists') {
7978: $msg = '<span class="LC_error">'.$msg.'</span><br />';
7979: }
7980: return ($state,$msg);
7981: }
7982:
7983: sub check_for_upload {
7984: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
7985: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
7986: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
7987: my $getpropath = 1;
7988: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
7989: $getpropath);
7990: my $found_file = 0;
7991: my $locked_file = 0;
7992: foreach my $line (@dir_list) {
7993: my ($file_name)=split(/\&/,$line,2);
7994: if ($file_name eq $fname){
7995: $file_name = $path.$file_name;
7996: if ($group ne '') {
7997: $file_name = $group.$file_name;
7998: }
7999: $found_file = 1;
8000: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8001: $locked_file = 1;
8002: }
8003: }
8004: }
8005: if (($current_disk_usage + $filesize) > $disk_quota){
8006: my $msg = '<span class="LC_error">'.
8007: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8008: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8009: return ('will_exceed_quota',$msg);
8010: } elsif ($found_file) {
8011: if ($locked_file) {
8012: my $msg = '<span class="LC_error">';
8013: $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>');
8014: $msg .= '</span><br />';
8015: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8016: return ('file_locked',$msg);
8017: } else {
8018: my $msg = '<span class="LC_error">';
8019: $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'});
8020: $msg .= '</span>';
8021: $msg .= '<br />';
8022: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8023: return ('file_exists',$msg);
8024: }
8025: }
8026: }
8027:
1.31 albertel 8028:
1.41 ng 8029: =pod
1.45 matthew 8030:
1.464 albertel 8031: =back
1.41 ng 8032:
1.112 bowersj2 8033: =head1 CSV Upload/Handling functions
1.38 albertel 8034:
1.41 ng 8035: =over 4
8036:
1.648 raeburn 8037: =item * &upfile_store($r)
1.41 ng 8038:
8039: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 8040: needs $env{'form.upfile'}
1.41 ng 8041: returns $datatoken to be put into hidden field
8042:
8043: =cut
1.31 albertel 8044:
8045: sub upfile_store {
8046: my $r=shift;
1.258 albertel 8047: $env{'form.upfile'}=~s/\r/\n/gs;
8048: $env{'form.upfile'}=~s/\f/\n/gs;
8049: $env{'form.upfile'}=~s/\n+/\n/gs;
8050: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 8051:
1.258 albertel 8052: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8053: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 8054: {
1.158 raeburn 8055: my $datafile = $r->dir_config('lonDaemons').
8056: '/tmp/'.$datatoken.'.tmp';
8057: if ( open(my $fh,">$datafile") ) {
1.258 albertel 8058: print $fh $env{'form.upfile'};
1.158 raeburn 8059: close($fh);
8060: }
1.31 albertel 8061: }
8062: return $datatoken;
8063: }
8064:
1.56 matthew 8065: =pod
8066:
1.648 raeburn 8067: =item * &load_tmp_file($r)
1.41 ng 8068:
8069: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 8070: needs $env{'form.datatoken'},
8071: sets $env{'form.upfile'} to the contents of the file
1.41 ng 8072:
8073: =cut
1.31 albertel 8074:
8075: sub load_tmp_file {
8076: my $r=shift;
8077: my @studentdata=();
8078: {
1.158 raeburn 8079: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 8080: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 8081: if ( open(my $fh,"<$studentfile") ) {
8082: @studentdata=<$fh>;
8083: close($fh);
8084: }
1.31 albertel 8085: }
1.258 albertel 8086: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 8087: }
8088:
1.56 matthew 8089: =pod
8090:
1.648 raeburn 8091: =item * &upfile_record_sep()
1.41 ng 8092:
8093: Separate uploaded file into records
8094: returns array of records,
1.258 albertel 8095: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8096:
8097: =cut
1.31 albertel 8098:
8099: sub upfile_record_sep {
1.258 albertel 8100: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8101: } else {
1.248 albertel 8102: my @records;
1.258 albertel 8103: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8104: if ($line=~/^\s*$/) { next; }
8105: push(@records,$line);
8106: }
8107: return @records;
1.31 albertel 8108: }
8109: }
8110:
1.56 matthew 8111: =pod
8112:
1.648 raeburn 8113: =item * &record_sep($record)
1.41 ng 8114:
1.258 albertel 8115: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8116:
8117: =cut
8118:
1.263 www 8119: sub takeleft {
8120: my $index=shift;
8121: return substr('0000'.$index,-4,4);
8122: }
8123:
1.31 albertel 8124: sub record_sep {
8125: my $record=shift;
8126: my %components=();
1.258 albertel 8127: if ($env{'form.upfiletype'} eq 'xml') {
8128: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8129: my $i=0;
1.356 albertel 8130: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8131: $field=~s/^(\"|\')//;
8132: $field=~s/(\"|\')$//;
1.263 www 8133: $components{&takeleft($i)}=$field;
1.31 albertel 8134: $i++;
8135: }
1.258 albertel 8136: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8137: my $i=0;
1.356 albertel 8138: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8139: $field=~s/^(\"|\')//;
8140: $field=~s/(\"|\')$//;
1.263 www 8141: $components{&takeleft($i)}=$field;
1.31 albertel 8142: $i++;
8143: }
8144: } else {
1.561 www 8145: my $separator=',';
1.480 banghart 8146: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8147: $separator=';';
1.480 banghart 8148: }
1.31 albertel 8149: my $i=0;
1.561 www 8150: # the character we are looking for to indicate the end of a quote or a record
8151: my $looking_for=$separator;
8152: # do not add the characters to the fields
8153: my $ignore=0;
8154: # we just encountered a separator (or the beginning of the record)
8155: my $just_found_separator=1;
8156: # store the field we are working on here
8157: my $field='';
8158: # work our way through all characters in record
8159: foreach my $character ($record=~/(.)/g) {
8160: if ($character eq $looking_for) {
8161: if ($character ne $separator) {
8162: # Found the end of a quote, again looking for separator
8163: $looking_for=$separator;
8164: $ignore=1;
8165: } else {
8166: # Found a separator, store away what we got
8167: $components{&takeleft($i)}=$field;
8168: $i++;
8169: $just_found_separator=1;
8170: $ignore=0;
8171: $field='';
8172: }
8173: next;
8174: }
8175: # single or double quotation marks after a separator indicate beginning of a quote
8176: # we are now looking for the end of the quote and need to ignore separators
8177: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8178: $looking_for=$character;
8179: next;
8180: }
8181: # ignore would be true after we reached the end of a quote
8182: if ($ignore) { next; }
8183: if (($just_found_separator) && ($character=~/\s/)) { next; }
8184: $field.=$character;
8185: $just_found_separator=0;
1.31 albertel 8186: }
1.561 www 8187: # catch the very last entry, since we never encountered the separator
8188: $components{&takeleft($i)}=$field;
1.31 albertel 8189: }
8190: return %components;
8191: }
8192:
1.144 matthew 8193: ######################################################
8194: ######################################################
8195:
1.56 matthew 8196: =pod
8197:
1.648 raeburn 8198: =item * &upfile_select_html()
1.41 ng 8199:
1.144 matthew 8200: Return HTML code to select a file from the users machine and specify
8201: the file type.
1.41 ng 8202:
8203: =cut
8204:
1.144 matthew 8205: ######################################################
8206: ######################################################
1.31 albertel 8207: sub upfile_select_html {
1.144 matthew 8208: my %Types = (
8209: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8210: semisv => &mt('Semicolon separated values'),
1.144 matthew 8211: space => &mt('Space separated'),
8212: tab => &mt('Tabulator separated'),
8213: # xml => &mt('HTML/XML'),
8214: );
8215: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8216: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8217: foreach my $type (sort(keys(%Types))) {
8218: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8219: }
8220: $Str .= "</select>\n";
8221: return $Str;
1.31 albertel 8222: }
8223:
1.301 albertel 8224: sub get_samples {
8225: my ($records,$toget) = @_;
8226: my @samples=({});
8227: my $got=0;
8228: foreach my $rec (@$records) {
8229: my %temp = &record_sep($rec);
8230: if (! grep(/\S/, values(%temp))) { next; }
8231: if (%temp) {
8232: $samples[$got]=\%temp;
8233: $got++;
8234: if ($got == $toget) { last; }
8235: }
8236: }
8237: return \@samples;
8238: }
8239:
1.144 matthew 8240: ######################################################
8241: ######################################################
8242:
1.56 matthew 8243: =pod
8244:
1.648 raeburn 8245: =item * &csv_print_samples($r,$records)
1.41 ng 8246:
8247: Prints a table of sample values from each column uploaded $r is an
8248: Apache Request ref, $records is an arrayref from
8249: &Apache::loncommon::upfile_record_sep
8250:
8251: =cut
8252:
1.144 matthew 8253: ######################################################
8254: ######################################################
1.31 albertel 8255: sub csv_print_samples {
8256: my ($r,$records) = @_;
1.662 bisitz 8257: my $samples = &get_samples($records,5);
1.301 albertel 8258:
1.594 raeburn 8259: $r->print(&mt('Samples').'<br />'.&start_data_table().
8260: &start_data_table_header_row());
1.356 albertel 8261: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8262: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8263: $r->print(&end_data_table_header_row());
1.301 albertel 8264: foreach my $hash (@$samples) {
1.594 raeburn 8265: $r->print(&start_data_table_row());
1.356 albertel 8266: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8267: $r->print('<td>');
1.356 albertel 8268: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8269: $r->print('</td>');
8270: }
1.594 raeburn 8271: $r->print(&end_data_table_row());
1.31 albertel 8272: }
1.594 raeburn 8273: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8274: }
8275:
1.144 matthew 8276: ######################################################
8277: ######################################################
8278:
1.56 matthew 8279: =pod
8280:
1.648 raeburn 8281: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8282:
8283: Prints a table to create associations between values and table columns.
1.144 matthew 8284:
1.41 ng 8285: $r is an Apache Request ref,
8286: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8287: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8288:
8289: =cut
8290:
1.144 matthew 8291: ######################################################
8292: ######################################################
1.31 albertel 8293: sub csv_print_select_table {
8294: my ($r,$records,$d) = @_;
1.301 albertel 8295: my $i=0;
8296: my $samples = &get_samples($records,1);
1.144 matthew 8297: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8298: &start_data_table().&start_data_table_header_row().
1.144 matthew 8299: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8300: '<th>'.&mt('Column').'</th>'.
8301: &end_data_table_header_row()."\n");
1.356 albertel 8302: foreach my $array_ref (@$d) {
8303: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8304: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8305:
8306: $r->print('<td><select name=f'.$i.
1.32 matthew 8307: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8308: $r->print('<option value="none"></option>');
1.356 albertel 8309: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8310: $r->print('<option value="'.$sample.'"'.
8311: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8312: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8313: }
1.594 raeburn 8314: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8315: $i++;
8316: }
1.594 raeburn 8317: $r->print(&end_data_table());
1.31 albertel 8318: $i--;
8319: return $i;
8320: }
1.56 matthew 8321:
1.144 matthew 8322: ######################################################
8323: ######################################################
8324:
1.56 matthew 8325: =pod
1.31 albertel 8326:
1.648 raeburn 8327: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8328:
8329: Prints a table of sample values from the upload and can make associate samples to internal names.
8330:
8331: $r is an Apache Request ref,
8332: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8333: $d is an array of 2 element arrays (internal name, displayed name)
8334:
8335: =cut
8336:
1.144 matthew 8337: ######################################################
8338: ######################################################
1.31 albertel 8339: sub csv_samples_select_table {
8340: my ($r,$records,$d) = @_;
8341: my $i=0;
1.144 matthew 8342: #
1.662 bisitz 8343: my $max_samples = 5;
8344: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8345: $r->print(&start_data_table().
8346: &start_data_table_header_row().'<th>'.
8347: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8348: &end_data_table_header_row());
1.301 albertel 8349:
8350: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8351: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8352: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8353: foreach my $option (@$d) {
8354: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8355: $r->print('<option value="'.$value.'"'.
1.253 albertel 8356: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8357: $display.'</option>');
1.31 albertel 8358: }
8359: $r->print('</select></td><td>');
1.662 bisitz 8360: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8361: if (defined($samples->[$line]{$key})) {
8362: $r->print($samples->[$line]{$key}."<br />\n");
8363: }
8364: }
1.594 raeburn 8365: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8366: $i++;
8367: }
1.594 raeburn 8368: $r->print(&end_data_table());
1.31 albertel 8369: $i--;
8370: return($i);
1.115 matthew 8371: }
8372:
1.144 matthew 8373: ######################################################
8374: ######################################################
8375:
1.115 matthew 8376: =pod
8377:
1.648 raeburn 8378: =item * &clean_excel_name($name)
1.115 matthew 8379:
8380: Returns a replacement for $name which does not contain any illegal characters.
8381:
8382: =cut
8383:
1.144 matthew 8384: ######################################################
8385: ######################################################
1.115 matthew 8386: sub clean_excel_name {
8387: my ($name) = @_;
8388: $name =~ s/[:\*\?\/\\]//g;
8389: if (length($name) > 31) {
8390: $name = substr($name,0,31);
8391: }
8392: return $name;
1.25 albertel 8393: }
1.84 albertel 8394:
1.85 albertel 8395: =pod
8396:
1.648 raeburn 8397: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8398:
8399: Returns either 1 or undef
8400:
8401: 1 if the part is to be hidden, undef if it is to be shown
8402:
8403: Arguments are:
8404:
8405: $id the id of the part to be checked
8406: $symb, optional the symb of the resource to check
8407: $udom, optional the domain of the user to check for
8408: $uname, optional the username of the user to check for
8409:
8410: =cut
1.84 albertel 8411:
8412: sub check_if_partid_hidden {
8413: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8414: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8415: $symb,$udom,$uname);
1.141 albertel 8416: my $truth=1;
8417: #if the string starts with !, then the list is the list to show not hide
8418: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8419: my @hiddenlist=split(/,/,$hiddenparts);
8420: foreach my $checkid (@hiddenlist) {
1.141 albertel 8421: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8422: }
1.141 albertel 8423: return !$truth;
1.84 albertel 8424: }
1.127 matthew 8425:
1.138 matthew 8426:
8427: ############################################################
8428: ############################################################
8429:
8430: =pod
8431:
1.157 matthew 8432: =back
8433:
1.138 matthew 8434: =head1 cgi-bin script and graphing routines
8435:
1.157 matthew 8436: =over 4
8437:
1.648 raeburn 8438: =item * &get_cgi_id()
1.138 matthew 8439:
8440: Inputs: none
8441:
8442: Returns an id which can be used to pass environment variables
8443: to various cgi-bin scripts. These environment variables will
8444: be removed from the users environment after a given time by
8445: the routine &Apache::lonnet::transfer_profile_to_env.
8446:
8447: =cut
8448:
8449: ############################################################
8450: ############################################################
1.152 albertel 8451: my $uniq=0;
1.136 matthew 8452: sub get_cgi_id {
1.154 albertel 8453: $uniq=($uniq+1)%100000;
1.280 albertel 8454: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8455: }
8456:
1.127 matthew 8457: ############################################################
8458: ############################################################
8459:
8460: =pod
8461:
1.648 raeburn 8462: =item * &DrawBarGraph()
1.127 matthew 8463:
1.138 matthew 8464: Facilitates the plotting of data in a (stacked) bar graph.
8465: Puts plot definition data into the users environment in order for
8466: graph.png to plot it. Returns an <img> tag for the plot.
8467: The bars on the plot are labeled '1','2',...,'n'.
8468:
8469: Inputs:
8470:
8471: =over 4
8472:
8473: =item $Title: string, the title of the plot
8474:
8475: =item $xlabel: string, text describing the X-axis of the plot
8476:
8477: =item $ylabel: string, text describing the Y-axis of the plot
8478:
8479: =item $Max: scalar, the maximum Y value to use in the plot
8480: If $Max is < any data point, the graph will not be rendered.
8481:
1.140 matthew 8482: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8483: they are plotted. If undefined, default values will be used.
8484:
1.178 matthew 8485: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8486:
1.138 matthew 8487: =item @Values: An array of array references. Each array reference holds data
8488: to be plotted in a stacked bar chart.
8489:
1.239 matthew 8490: =item If the final element of @Values is a hash reference the key/value
8491: pairs will be added to the graph definition.
8492:
1.138 matthew 8493: =back
8494:
8495: Returns:
8496:
8497: An <img> tag which references graph.png and the appropriate identifying
8498: information for the plot.
8499:
1.127 matthew 8500: =cut
8501:
8502: ############################################################
8503: ############################################################
1.134 matthew 8504: sub DrawBarGraph {
1.178 matthew 8505: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 8506: #
8507: if (! defined($colors)) {
8508: $colors = ['#33ff00',
8509: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
8510: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
8511: ];
8512: }
1.228 matthew 8513: my $extra_settings = {};
8514: if (ref($Values[-1]) eq 'HASH') {
8515: $extra_settings = pop(@Values);
8516: }
1.127 matthew 8517: #
1.136 matthew 8518: my $identifier = &get_cgi_id();
8519: my $id = 'cgi.'.$identifier;
1.129 matthew 8520: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 8521: return '';
8522: }
1.225 matthew 8523: #
8524: my @Labels;
8525: if (defined($labels)) {
8526: @Labels = @$labels;
8527: } else {
8528: for (my $i=0;$i<@{$Values[0]};$i++) {
8529: push (@Labels,$i+1);
8530: }
8531: }
8532: #
1.129 matthew 8533: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 8534: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 8535: my %ValuesHash;
8536: my $NumSets=1;
8537: foreach my $array (@Values) {
8538: next if (! ref($array));
1.136 matthew 8539: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 8540: join(',',@$array);
1.129 matthew 8541: }
1.127 matthew 8542: #
1.136 matthew 8543: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 8544: if ($NumBars < 3) {
8545: $width = 120+$NumBars*32;
1.220 matthew 8546: $xskip = 1;
1.225 matthew 8547: $bar_width = 30;
8548: } elsif ($NumBars < 5) {
8549: $width = 120+$NumBars*20;
8550: $xskip = 1;
8551: $bar_width = 20;
1.220 matthew 8552: } elsif ($NumBars < 10) {
1.136 matthew 8553: $width = 120+$NumBars*15;
8554: $xskip = 1;
8555: $bar_width = 15;
8556: } elsif ($NumBars <= 25) {
8557: $width = 120+$NumBars*11;
8558: $xskip = 5;
8559: $bar_width = 8;
8560: } elsif ($NumBars <= 50) {
8561: $width = 120+$NumBars*8;
8562: $xskip = 5;
8563: $bar_width = 4;
8564: } else {
8565: $width = 120+$NumBars*8;
8566: $xskip = 5;
8567: $bar_width = 4;
8568: }
8569: #
1.137 matthew 8570: $Max = 1 if ($Max < 1);
8571: if ( int($Max) < $Max ) {
8572: $Max++;
8573: $Max = int($Max);
8574: }
1.127 matthew 8575: $Title = '' if (! defined($Title));
8576: $xlabel = '' if (! defined($xlabel));
8577: $ylabel = '' if (! defined($ylabel));
1.369 www 8578: $ValuesHash{$id.'.title'} = &escape($Title);
8579: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
8580: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 8581: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 8582: $ValuesHash{$id.'.NumBars'} = $NumBars;
8583: $ValuesHash{$id.'.NumSets'} = $NumSets;
8584: $ValuesHash{$id.'.PlotType'} = 'bar';
8585: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8586: $ValuesHash{$id.'.height'} = $height;
8587: $ValuesHash{$id.'.width'} = $width;
8588: $ValuesHash{$id.'.xskip'} = $xskip;
8589: $ValuesHash{$id.'.bar_width'} = $bar_width;
8590: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 8591: #
1.228 matthew 8592: # Deal with other parameters
8593: while (my ($key,$value) = each(%$extra_settings)) {
8594: $ValuesHash{$id.'.'.$key} = $value;
8595: }
8596: #
1.646 raeburn 8597: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 8598: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8599: }
8600:
8601: ############################################################
8602: ############################################################
8603:
8604: =pod
8605:
1.648 raeburn 8606: =item * &DrawXYGraph()
1.137 matthew 8607:
1.138 matthew 8608: Facilitates the plotting of data in an XY graph.
8609: Puts plot definition data into the users environment in order for
8610: graph.png to plot it. Returns an <img> tag for the plot.
8611:
8612: Inputs:
8613:
8614: =over 4
8615:
8616: =item $Title: string, the title of the plot
8617:
8618: =item $xlabel: string, text describing the X-axis of the plot
8619:
8620: =item $ylabel: string, text describing the Y-axis of the plot
8621:
8622: =item $Max: scalar, the maximum Y value to use in the plot
8623: If $Max is < any data point, the graph will not be rendered.
8624:
8625: =item $colors: Array ref containing the hex color codes for the data to be
8626: plotted in. If undefined, default values will be used.
8627:
8628: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8629:
8630: =item $Ydata: Array ref containing Array refs.
1.185 www 8631: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 8632:
8633: =item %Values: hash indicating or overriding any default values which are
8634: passed to graph.png.
8635: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8636:
8637: =back
8638:
8639: Returns:
8640:
8641: An <img> tag which references graph.png and the appropriate identifying
8642: information for the plot.
8643:
1.137 matthew 8644: =cut
8645:
8646: ############################################################
8647: ############################################################
8648: sub DrawXYGraph {
8649: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
8650: #
8651: # Create the identifier for the graph
8652: my $identifier = &get_cgi_id();
8653: my $id = 'cgi.'.$identifier;
8654: #
8655: $Title = '' if (! defined($Title));
8656: $xlabel = '' if (! defined($xlabel));
8657: $ylabel = '' if (! defined($ylabel));
8658: my %ValuesHash =
8659: (
1.369 www 8660: $id.'.title' => &escape($Title),
8661: $id.'.xlabel' => &escape($xlabel),
8662: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 8663: $id.'.y_max_value'=> $Max,
8664: $id.'.labels' => join(',',@$Xlabels),
8665: $id.'.PlotType' => 'XY',
8666: );
8667: #
8668: if (defined($colors) && ref($colors) eq 'ARRAY') {
8669: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8670: }
8671: #
8672: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
8673: return '';
8674: }
8675: my $NumSets=1;
1.138 matthew 8676: foreach my $array (@{$Ydata}){
1.137 matthew 8677: next if (! ref($array));
8678: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
8679: }
1.138 matthew 8680: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 8681: #
8682: # Deal with other parameters
8683: while (my ($key,$value) = each(%Values)) {
8684: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 8685: }
8686: #
1.646 raeburn 8687: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 8688: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8689: }
8690:
8691: ############################################################
8692: ############################################################
8693:
8694: =pod
8695:
1.648 raeburn 8696: =item * &DrawXYYGraph()
1.138 matthew 8697:
8698: Facilitates the plotting of data in an XY graph with two Y axes.
8699: Puts plot definition data into the users environment in order for
8700: graph.png to plot it. Returns an <img> tag for the plot.
8701:
8702: Inputs:
8703:
8704: =over 4
8705:
8706: =item $Title: string, the title of the plot
8707:
8708: =item $xlabel: string, text describing the X-axis of the plot
8709:
8710: =item $ylabel: string, text describing the Y-axis of the plot
8711:
8712: =item $colors: Array ref containing the hex color codes for the data to be
8713: plotted in. If undefined, default values will be used.
8714:
8715: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8716:
8717: =item $Ydata1: The first data set
8718:
8719: =item $Min1: The minimum value of the left Y-axis
8720:
8721: =item $Max1: The maximum value of the left Y-axis
8722:
8723: =item $Ydata2: The second data set
8724:
8725: =item $Min2: The minimum value of the right Y-axis
8726:
8727: =item $Max2: The maximum value of the left Y-axis
8728:
8729: =item %Values: hash indicating or overriding any default values which are
8730: passed to graph.png.
8731: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8732:
8733: =back
8734:
8735: Returns:
8736:
8737: An <img> tag which references graph.png and the appropriate identifying
8738: information for the plot.
1.136 matthew 8739:
8740: =cut
8741:
8742: ############################################################
8743: ############################################################
1.137 matthew 8744: sub DrawXYYGraph {
8745: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
8746: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 8747: #
8748: # Create the identifier for the graph
8749: my $identifier = &get_cgi_id();
8750: my $id = 'cgi.'.$identifier;
8751: #
8752: $Title = '' if (! defined($Title));
8753: $xlabel = '' if (! defined($xlabel));
8754: $ylabel = '' if (! defined($ylabel));
8755: my %ValuesHash =
8756: (
1.369 www 8757: $id.'.title' => &escape($Title),
8758: $id.'.xlabel' => &escape($xlabel),
8759: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 8760: $id.'.labels' => join(',',@$Xlabels),
8761: $id.'.PlotType' => 'XY',
8762: $id.'.NumSets' => 2,
1.137 matthew 8763: $id.'.two_axes' => 1,
8764: $id.'.y1_max_value' => $Max1,
8765: $id.'.y1_min_value' => $Min1,
8766: $id.'.y2_max_value' => $Max2,
8767: $id.'.y2_min_value' => $Min2,
1.136 matthew 8768: );
8769: #
1.137 matthew 8770: if (defined($colors) && ref($colors) eq 'ARRAY') {
8771: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8772: }
8773: #
8774: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
8775: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 8776: return '';
8777: }
8778: my $NumSets=1;
1.137 matthew 8779: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 8780: next if (! ref($array));
8781: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 8782: }
8783: #
8784: # Deal with other parameters
8785: while (my ($key,$value) = each(%Values)) {
8786: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 8787: }
8788: #
1.646 raeburn 8789: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 8790: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 8791: }
8792:
8793: ############################################################
8794: ############################################################
8795:
8796: =pod
8797:
1.157 matthew 8798: =back
8799:
1.139 matthew 8800: =head1 Statistics helper routines?
8801:
8802: Bad place for them but what the hell.
8803:
1.157 matthew 8804: =over 4
8805:
1.648 raeburn 8806: =item * &chartlink()
1.139 matthew 8807:
8808: Returns a link to the chart for a specific student.
8809:
8810: Inputs:
8811:
8812: =over 4
8813:
8814: =item $linktext: The text of the link
8815:
8816: =item $sname: The students username
8817:
8818: =item $sdomain: The students domain
8819:
8820: =back
8821:
1.157 matthew 8822: =back
8823:
1.139 matthew 8824: =cut
8825:
8826: ############################################################
8827: ############################################################
8828: sub chartlink {
8829: my ($linktext, $sname, $sdomain) = @_;
8830: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 8831: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 8832: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 8833: '">'.$linktext.'</a>';
1.153 matthew 8834: }
8835:
8836: #######################################################
8837: #######################################################
8838:
8839: =pod
8840:
8841: =head1 Course Environment Routines
1.157 matthew 8842:
8843: =over 4
1.153 matthew 8844:
1.648 raeburn 8845: =item * &restore_course_settings()
1.153 matthew 8846:
1.648 raeburn 8847: =item * &store_course_settings()
1.153 matthew 8848:
8849: Restores/Store indicated form parameters from the course environment.
8850: Will not overwrite existing values of the form parameters.
8851:
8852: Inputs:
8853: a scalar describing the data (e.g. 'chart', 'problem_analysis')
8854:
8855: a hash ref describing the data to be stored. For example:
8856:
8857: %Save_Parameters = ('Status' => 'scalar',
8858: 'chartoutputmode' => 'scalar',
8859: 'chartoutputdata' => 'scalar',
8860: 'Section' => 'array',
1.373 raeburn 8861: 'Group' => 'array',
1.153 matthew 8862: 'StudentData' => 'array',
8863: 'Maps' => 'array');
8864:
8865: Returns: both routines return nothing
8866:
1.631 raeburn 8867: =back
8868:
1.153 matthew 8869: =cut
8870:
8871: #######################################################
8872: #######################################################
8873: sub store_course_settings {
1.496 albertel 8874: return &store_settings($env{'request.course.id'},@_);
8875: }
8876:
8877: sub store_settings {
1.153 matthew 8878: # save to the environment
8879: # appenv the same items, just to be safe
1.300 albertel 8880: my $udom = $env{'user.domain'};
8881: my $uname = $env{'user.name'};
1.496 albertel 8882: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8883: my %SaveHash;
8884: my %AppHash;
8885: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 8886: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 8887: my $envname = 'environment.'.$basename;
1.258 albertel 8888: if (exists($env{'form.'.$setting})) {
1.153 matthew 8889: # Save this value away
8890: if ($type eq 'scalar' &&
1.258 albertel 8891: (! exists($env{$envname}) ||
8892: $env{$envname} ne $env{'form.'.$setting})) {
8893: $SaveHash{$basename} = $env{'form.'.$setting};
8894: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 8895: } elsif ($type eq 'array') {
8896: my $stored_form;
1.258 albertel 8897: if (ref($env{'form.'.$setting})) {
1.153 matthew 8898: $stored_form = join(',',
8899: map {
1.369 www 8900: &escape($_);
1.258 albertel 8901: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 8902: } else {
8903: $stored_form =
1.369 www 8904: &escape($env{'form.'.$setting});
1.153 matthew 8905: }
8906: # Determine if the array contents are the same.
1.258 albertel 8907: if ($stored_form ne $env{$envname}) {
1.153 matthew 8908: $SaveHash{$basename} = $stored_form;
8909: $AppHash{$envname} = $stored_form;
8910: }
8911: }
8912: }
8913: }
8914: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 8915: $udom,$uname);
1.153 matthew 8916: if ($put_result !~ /^(ok|delayed)/) {
8917: &Apache::lonnet::logthis('unable to save form parameters, '.
8918: 'got error:'.$put_result);
8919: }
8920: # Make sure these settings stick around in this session, too
1.646 raeburn 8921: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 8922: return;
8923: }
8924:
8925: sub restore_course_settings {
1.499 albertel 8926: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 8927: }
8928:
8929: sub restore_settings {
8930: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8931: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 8932: next if (exists($env{'form.'.$setting}));
1.496 albertel 8933: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 8934: '.'.$setting;
1.258 albertel 8935: if (exists($env{$envname})) {
1.153 matthew 8936: if ($type eq 'scalar') {
1.258 albertel 8937: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 8938: } elsif ($type eq 'array') {
1.258 albertel 8939: $env{'form.'.$setting} = [
1.153 matthew 8940: map {
1.369 www 8941: &unescape($_);
1.258 albertel 8942: } split(',',$env{$envname})
1.153 matthew 8943: ];
8944: }
8945: }
8946: }
1.127 matthew 8947: }
8948:
1.618 raeburn 8949: #######################################################
8950: #######################################################
8951:
8952: =pod
8953:
8954: =head1 Domain E-mail Routines
8955:
8956: =over 4
8957:
1.648 raeburn 8958: =item * &build_recipient_list()
1.618 raeburn 8959:
1.766 raeburn 8960: Build recipient lists for four types of e-mail:
8961: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
8962: (d) Help requests, generated by
8963: lonerrorhandler.pm, CHECKRPMS, loncron, and lonsupportreq.pm respectively.
1.618 raeburn 8964:
8965: Inputs:
1.619 raeburn 8966: defmail (scalar - email address of default recipient),
1.618 raeburn 8967: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 8968: defdom (domain for which to retrieve configuration settings),
8969: origmail (scalar - email address of recipient from loncapa.conf,
8970: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 8971:
1.655 raeburn 8972: Returns: comma separated list of addresses to which to send e-mail.
8973:
8974: =back
1.618 raeburn 8975:
8976: =cut
8977:
8978: ############################################################
8979: ############################################################
8980: sub build_recipient_list {
1.619 raeburn 8981: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 8982: my @recipients;
8983: my $otheremails;
8984: my %domconfig =
8985: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
8986: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 8987: if (exists($domconfig{'contacts'}{$mailing})) {
8988: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
8989: my @contacts = ('adminemail','supportemail');
8990: foreach my $item (@contacts) {
8991: if ($domconfig{'contacts'}{$mailing}{$item}) {
8992: my $addr = $domconfig{'contacts'}{$item};
8993: if (!grep(/^\Q$addr\E$/,@recipients)) {
8994: push(@recipients,$addr);
8995: }
1.619 raeburn 8996: }
1.766 raeburn 8997: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 8998: }
8999: }
1.766 raeburn 9000: } elsif ($origmail ne '') {
9001: push(@recipients,$origmail);
1.618 raeburn 9002: }
1.619 raeburn 9003: } elsif ($origmail ne '') {
9004: push(@recipients,$origmail);
1.618 raeburn 9005: }
1.688 raeburn 9006: if (defined($defmail)) {
9007: if ($defmail ne '') {
9008: push(@recipients,$defmail);
9009: }
1.618 raeburn 9010: }
9011: if ($otheremails) {
1.619 raeburn 9012: my @others;
9013: if ($otheremails =~ /,/) {
9014: @others = split(/,/,$otheremails);
1.618 raeburn 9015: } else {
1.619 raeburn 9016: push(@others,$otheremails);
9017: }
9018: foreach my $addr (@others) {
9019: if (!grep(/^\Q$addr\E$/,@recipients)) {
9020: push(@recipients,$addr);
9021: }
1.618 raeburn 9022: }
9023: }
1.619 raeburn 9024: my $recipientlist = join(',',@recipients);
1.618 raeburn 9025: return $recipientlist;
9026: }
9027:
1.127 matthew 9028: ############################################################
9029: ############################################################
1.154 albertel 9030:
1.655 raeburn 9031: =pod
9032:
9033: =head1 Course Catalog Routines
9034:
9035: =over 4
9036:
9037: =item * &gather_categories()
9038:
9039: Converts category definitions - keys of categories hash stored in
9040: coursecategories in configuration.db on the primary library server in a
9041: domain - to an array. Also generates javascript and idx hash used to
9042: generate Domain Coordinator interface for editing Course Categories.
9043:
9044: Inputs:
1.663 raeburn 9045:
1.655 raeburn 9046: categories (reference to hash of category definitions).
1.663 raeburn 9047:
1.655 raeburn 9048: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9049: categories and subcategories).
1.663 raeburn 9050:
1.655 raeburn 9051: idx (reference to hash of counters used in Domain Coordinator interface for
9052: editing Course Categories).
1.663 raeburn 9053:
1.655 raeburn 9054: jsarray (reference to array of categories used to create Javascript arrays for
9055: Domain Coordinator interface for editing Course Categories).
9056:
9057: Returns: nothing
9058:
9059: Side effects: populates cats, idx and jsarray.
9060:
9061: =cut
9062:
9063: sub gather_categories {
9064: my ($categories,$cats,$idx,$jsarray) = @_;
9065: my %counters;
9066: my $num = 0;
9067: foreach my $item (keys(%{$categories})) {
9068: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9069: if ($container eq '' && $depth == 0) {
9070: $cats->[$depth][$categories->{$item}] = $cat;
9071: } else {
9072: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9073: }
9074: my ($escitem,$tail) = split(/:/,$item,2);
9075: if ($counters{$tail} eq '') {
9076: $counters{$tail} = $num;
9077: $num ++;
9078: }
9079: if (ref($idx) eq 'HASH') {
9080: $idx->{$item} = $counters{$tail};
9081: }
9082: if (ref($jsarray) eq 'ARRAY') {
9083: push(@{$jsarray->[$counters{$tail}]},$item);
9084: }
9085: }
9086: return;
9087: }
9088:
9089: =pod
9090:
9091: =item * &extract_categories()
9092:
9093: Used to generate breadcrumb trails for course categories.
9094:
9095: Inputs:
1.663 raeburn 9096:
1.655 raeburn 9097: categories (reference to hash of category definitions).
1.663 raeburn 9098:
1.655 raeburn 9099: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9100: categories and subcategories).
1.663 raeburn 9101:
1.655 raeburn 9102: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9103:
1.655 raeburn 9104: allitems (reference to hash - key is category key
9105: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9106:
1.655 raeburn 9107: idx (reference to hash of counters used in Domain Coordinator interface for
9108: editing Course Categories).
1.663 raeburn 9109:
1.655 raeburn 9110: jsarray (reference to array of categories used to create Javascript arrays for
9111: Domain Coordinator interface for editing Course Categories).
9112:
1.665 raeburn 9113: subcats (reference to hash of arrays containing all subcategories within each
9114: category, -recursive)
9115:
1.655 raeburn 9116: Returns: nothing
9117:
9118: Side effects: populates trails and allitems hash references.
9119:
9120: =cut
9121:
9122: sub extract_categories {
1.665 raeburn 9123: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9124: if (ref($categories) eq 'HASH') {
9125: &gather_categories($categories,$cats,$idx,$jsarray);
9126: if (ref($cats->[0]) eq 'ARRAY') {
9127: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9128: my $name = $cats->[0][$i];
9129: my $item = &escape($name).'::0';
9130: my $trailstr;
9131: if ($name eq 'instcode') {
9132: $trailstr = &mt('Official courses (with institutional codes)');
9133: } else {
9134: $trailstr = $name;
9135: }
9136: if ($allitems->{$item} eq '') {
9137: push(@{$trails},$trailstr);
9138: $allitems->{$item} = scalar(@{$trails})-1;
9139: }
9140: my @parents = ($name);
9141: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9142: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9143: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9144: if (ref($subcats) eq 'HASH') {
9145: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9146: }
9147: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9148: }
9149: } else {
9150: if (ref($subcats) eq 'HASH') {
9151: $subcats->{$item} = [];
1.655 raeburn 9152: }
9153: }
9154: }
9155: }
9156: }
9157: return;
9158: }
9159:
9160: =pod
9161:
9162: =item *&recurse_categories()
9163:
9164: Recursively used to generate breadcrumb trails for course categories.
9165:
9166: Inputs:
1.663 raeburn 9167:
1.655 raeburn 9168: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9169: categories and subcategories).
1.663 raeburn 9170:
1.655 raeburn 9171: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9172:
9173: category (current course category, for which breadcrumb trail is being generated).
9174:
9175: trails (reference to array of breadcrumb trails for each category).
9176:
1.655 raeburn 9177: allitems (reference to hash - key is category key
9178: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9179:
1.655 raeburn 9180: parents (array containing containers directories for current category,
9181: back to top level).
9182:
9183: Returns: nothing
9184:
9185: Side effects: populates trails and allitems hash references
9186:
9187: =cut
9188:
9189: sub recurse_categories {
1.665 raeburn 9190: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9191: my $shallower = $depth - 1;
9192: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9193: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9194: my $name = $cats->[$depth]{$category}[$k];
9195: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9196: my $trailstr = join(' -> ',(@{$parents},$category));
9197: if ($allitems->{$item} eq '') {
9198: push(@{$trails},$trailstr);
9199: $allitems->{$item} = scalar(@{$trails})-1;
9200: }
9201: my $deeper = $depth+1;
9202: push(@{$parents},$category);
1.665 raeburn 9203: if (ref($subcats) eq 'HASH') {
9204: my $subcat = &escape($name).':'.$category.':'.$depth;
9205: for (my $j=@{$parents}; $j>=0; $j--) {
9206: my $higher;
9207: if ($j > 0) {
9208: $higher = &escape($parents->[$j]).':'.
9209: &escape($parents->[$j-1]).':'.$j;
9210: } else {
9211: $higher = &escape($parents->[$j]).'::'.$j;
9212: }
9213: push(@{$subcats->{$higher}},$subcat);
9214: }
9215: }
9216: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9217: $subcats);
1.655 raeburn 9218: pop(@{$parents});
9219: }
9220: } else {
9221: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9222: my $trailstr = join(' -> ',(@{$parents},$category));
9223: if ($allitems->{$item} eq '') {
9224: push(@{$trails},$trailstr);
9225: $allitems->{$item} = scalar(@{$trails})-1;
9226: }
9227: }
9228: return;
9229: }
9230:
1.663 raeburn 9231: =pod
9232:
9233: =item *&assign_categories_table()
9234:
9235: Create a datatable for display of hierarchical categories in a domain,
9236: with checkboxes to allow a course to be categorized.
9237:
9238: Inputs:
9239:
9240: cathash - reference to hash of categories defined for the domain (from
9241: configuration.db)
9242:
9243: currcat - scalar with an & separated list of categories assigned to a course.
9244:
9245: Returns: $output (markup to be displayed)
9246:
9247: =cut
9248:
9249: sub assign_categories_table {
9250: my ($cathash,$currcat) = @_;
9251: my $output;
9252: if (ref($cathash) eq 'HASH') {
9253: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9254: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9255: $maxdepth = scalar(@cats);
9256: if (@cats > 0) {
9257: my $itemcount = 0;
9258: if (ref($cats[0]) eq 'ARRAY') {
9259: $output = &Apache::loncommon::start_data_table();
9260: my @currcategories;
9261: if ($currcat ne '') {
9262: @currcategories = split('&',$currcat);
9263: }
9264: for (my $i=0; $i<@{$cats[0]}; $i++) {
9265: my $parent = $cats[0][$i];
9266: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9267: next if ($parent eq 'instcode');
9268: my $item = &escape($parent).'::0';
9269: my $checked = '';
9270: if (@currcategories > 0) {
9271: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9272: $checked = ' checked="checked"';
1.663 raeburn 9273: }
9274: }
1.675 raeburn 9275: $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9276: '<input type="checkbox" name="usecategory" value="'.
9277: $item.'"'.$checked.' />'.$parent.'</span>'.
9278: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9279: my $depth = 1;
9280: push(@path,$parent);
9281: $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
9282: pop(@path);
9283: $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
9284: $itemcount ++;
9285: }
9286: $output .= &Apache::loncommon::end_data_table();
9287: }
9288: }
9289: }
9290: return $output;
9291: }
9292:
9293: =pod
9294:
9295: =item *&assign_category_rows()
9296:
9297: Create a datatable row for display of nested categories in a domain,
9298: with checkboxes to allow a course to be categorized,called recursively.
9299:
9300: Inputs:
9301:
9302: itemcount - track row number for alternating colors
9303:
9304: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9305: categories and subcategories.
9306:
9307: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9308:
9309: parent - parent of current category item
9310:
9311: path - Array containing all categories back up through the hierarchy from the
9312: current category to the top level.
9313:
9314: currcategories - reference to array of current categories assigned to the course
9315:
9316: Returns: $output (markup to be displayed).
9317:
9318: =cut
9319:
9320: sub assign_category_rows {
9321: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9322: my ($text,$name,$item,$chgstr);
9323: if (ref($cats) eq 'ARRAY') {
9324: my $maxdepth = scalar(@{$cats});
9325: if (ref($cats->[$depth]) eq 'HASH') {
9326: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9327: my $numchildren = @{$cats->[$depth]{$parent}};
9328: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9329: $text .= '<td><table class="LC_datatable">';
9330: for (my $j=0; $j<$numchildren; $j++) {
9331: $name = $cats->[$depth]{$parent}[$j];
9332: $item = &escape($name).':'.&escape($parent).':'.$depth;
9333: my $deeper = $depth+1;
9334: my $checked = '';
9335: if (ref($currcategories) eq 'ARRAY') {
9336: if (@{$currcategories} > 0) {
9337: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9338: $checked = ' checked="checked"';
1.663 raeburn 9339: }
9340: }
9341: }
1.664 raeburn 9342: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9343: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9344: $item.'"'.$checked.' />'.$name.'</label></span>'.
9345: '<input type="hidden" name="catname" value="'.$name.'" />'.
9346: '</td><td>';
1.663 raeburn 9347: if (ref($path) eq 'ARRAY') {
9348: push(@{$path},$name);
9349: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9350: pop(@{$path});
9351: }
9352: $text .= '</td></tr>';
9353: }
9354: $text .= '</table></td>';
9355: }
9356: }
9357: }
9358: return $text;
9359: }
9360:
1.655 raeburn 9361: ############################################################
9362: ############################################################
9363:
9364:
1.443 albertel 9365: sub commit_customrole {
1.664 raeburn 9366: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9367: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9368: ($start?', '.&mt('starting').' '.localtime($start):'').
9369: ($end?', ending '.localtime($end):'').': <b>'.
9370: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9371: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9372: '</b><br />';
9373: return $output;
9374: }
9375:
9376: sub commit_standardrole {
1.541 raeburn 9377: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9378: my ($output,$logmsg,$linefeed);
9379: if ($context eq 'auto') {
9380: $linefeed = "\n";
9381: } else {
9382: $linefeed = "<br />\n";
9383: }
1.443 albertel 9384: if ($three eq 'st') {
1.541 raeburn 9385: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9386: $one,$two,$sec,$context);
9387: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9388: ($result eq 'unknown_course') || ($result eq 'refused')) {
9389: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9390: } else {
1.541 raeburn 9391: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9392: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9393: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9394: if ($context eq 'auto') {
9395: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9396: } else {
9397: $output .= '<b>'.$result.'</b>'.$linefeed.
9398: &mt('Add to classlist').': <b>ok</b>';
9399: }
9400: $output .= $linefeed;
1.443 albertel 9401: }
9402: } else {
9403: $output = &mt('Assigning').' '.$three.' in '.$url.
9404: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9405: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9406: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9407: if ($context eq 'auto') {
9408: $output .= $result.$linefeed;
9409: } else {
9410: $output .= '<b>'.$result.'</b>'.$linefeed;
9411: }
1.443 albertel 9412: }
9413: return $output;
9414: }
9415:
9416: sub commit_studentrole {
1.541 raeburn 9417: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9418: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9419: if ($context eq 'auto') {
9420: $linefeed = "\n";
9421: } else {
9422: $linefeed = '<br />'."\n";
9423: }
1.443 albertel 9424: if (defined($one) && defined($two)) {
9425: my $cid=$one.'_'.$two;
9426: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9427: my $secchange = 0;
9428: my $expire_role_result;
9429: my $modify_section_result;
1.628 raeburn 9430: if ($oldsec ne '-1') {
9431: if ($oldsec ne $sec) {
1.443 albertel 9432: $secchange = 1;
1.628 raeburn 9433: my $now = time;
1.443 albertel 9434: my $uurl='/'.$cid;
9435: $uurl=~s/\_/\//g;
9436: if ($oldsec) {
9437: $uurl.='/'.$oldsec;
9438: }
1.626 raeburn 9439: $oldsecurl = $uurl;
1.628 raeburn 9440: $expire_role_result =
1.652 raeburn 9441: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9442: if ($env{'request.course.sec'} ne '') {
9443: if ($expire_role_result eq 'refused') {
9444: my @roles = ('st');
9445: my @statuses = ('previous');
9446: my @roledoms = ($one);
9447: my $withsec = 1;
9448: my %roleshash =
9449: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9450: \@statuses,\@roles,\@roledoms,$withsec);
9451: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9452: my ($oldstart,$oldend) =
9453: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9454: if ($oldend > 0 && $oldend <= $now) {
9455: $expire_role_result = 'ok';
9456: }
9457: }
9458: }
9459: }
1.443 albertel 9460: $result = $expire_role_result;
9461: }
9462: }
9463: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9464: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9465: if ($modify_section_result =~ /^ok/) {
9466: if ($secchange == 1) {
1.628 raeburn 9467: if ($sec eq '') {
9468: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9469: } else {
9470: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9471: }
1.443 albertel 9472: } elsif ($oldsec eq '-1') {
1.628 raeburn 9473: if ($sec eq '') {
9474: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9475: } else {
9476: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9477: }
1.443 albertel 9478: } else {
1.628 raeburn 9479: if ($sec eq '') {
9480: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
9481: } else {
9482: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9483: }
1.443 albertel 9484: }
9485: } else {
1.628 raeburn 9486: if ($secchange) {
9487: $$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;
9488: } else {
9489: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
9490: }
1.443 albertel 9491: }
9492: $result = $modify_section_result;
9493: } elsif ($secchange == 1) {
1.628 raeburn 9494: if ($oldsec eq '') {
9495: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
9496: } else {
9497: $$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;
9498: }
1.626 raeburn 9499: if ($expire_role_result eq 'refused') {
9500: my $newsecurl = '/'.$cid;
9501: $newsecurl =~ s/\_/\//g;
9502: if ($sec ne '') {
9503: $newsecurl.='/'.$sec;
9504: }
9505: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
9506: if ($sec eq '') {
9507: $$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;
9508: } else {
9509: $$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;
9510: }
9511: }
9512: }
1.443 albertel 9513: }
9514: } else {
1.626 raeburn 9515: $$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 9516: $result = "error: incomplete course id\n";
9517: }
9518: return $result;
9519: }
9520:
9521: ############################################################
9522: ############################################################
9523:
1.566 albertel 9524: sub check_clone {
1.578 raeburn 9525: my ($args,$linefeed) = @_;
1.566 albertel 9526: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
9527: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
9528: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
9529: my $clonemsg;
9530: my $can_clone = 0;
9531:
9532: if ($clonehome eq 'no_host') {
1.578 raeburn 9533: $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 9534: } else {
9535: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568 albertel 9536: if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566 albertel 9537: $can_clone = 1;
9538: } else {
9539: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
9540: $args->{'clonedomain'},$args->{'clonecourse'});
9541: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 9542: if (grep(/^\*$/,@cloners)) {
9543: $can_clone = 1;
9544: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
9545: $can_clone = 1;
9546: } else {
9547: my %roleshash =
9548: &Apache::lonnet::get_my_roles($args->{'ccuname'},
9549: $args->{'ccdomain'},
9550: 'userroles',['active'],['cc'],
9551: [$args->{'clonedomain'}]);
9552: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
9553: $can_clone = 1;
9554: } else {
9555: $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'});
9556: }
1.566 albertel 9557: }
1.578 raeburn 9558: }
1.566 albertel 9559: }
9560: return ($can_clone, $clonemsg, $cloneid, $clonehome);
9561: }
9562:
1.444 albertel 9563: sub construct_course {
1.541 raeburn 9564: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444 albertel 9565: my $outcome;
1.541 raeburn 9566: my $linefeed = '<br />'."\n";
9567: if ($context eq 'auto') {
9568: $linefeed = "\n";
9569: }
1.566 albertel 9570:
9571: #
9572: # Are we cloning?
9573: #
9574: my ($can_clone, $clonemsg, $cloneid, $clonehome);
9575: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 9576: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 9577: if ($context ne 'auto') {
1.578 raeburn 9578: if ($clonemsg ne '') {
9579: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
9580: }
1.566 albertel 9581: }
9582: $outcome .= $clonemsg.$linefeed;
9583:
9584: if (!$can_clone) {
9585: return (0,$outcome);
9586: }
9587: }
9588:
1.444 albertel 9589: #
9590: # Open course
9591: #
9592: my $crstype = lc($args->{'crstype'});
9593: my %cenv=();
9594: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
9595: $args->{'cdescr'},
9596: $args->{'curl'},
9597: $args->{'course_home'},
9598: $args->{'nonstandard'},
9599: $args->{'crscode'},
9600: $args->{'ccuname'}.':'.
9601: $args->{'ccdomain'},
9602: $args->{'crstype'});
9603:
9604: # Note: The testing routines depend on this being output; see
9605: # Utils::Course. This needs to at least be output as a comment
9606: # if anyone ever decides to not show this, and Utils::Course::new
9607: # will need to be suitably modified.
1.541 raeburn 9608: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 9609: #
9610: # Check if created correctly
9611: #
1.479 albertel 9612: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 9613: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 9614: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 9615:
1.444 albertel 9616: #
1.566 albertel 9617: # Do the cloning
9618: #
9619: if ($can_clone && $cloneid) {
9620: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
9621: if ($context ne 'auto') {
9622: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
9623: }
9624: $outcome .= $clonemsg.$linefeed;
9625: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 9626: # Copy all files
1.637 www 9627: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 9628: # Restore URL
1.566 albertel 9629: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 9630: # Restore title
1.566 albertel 9631: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 9632: # Mark as cloned
1.566 albertel 9633: $cenv{'clonedfrom'}=$cloneid;
1.638 www 9634: # Need to clone grading mode
9635: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
9636: $cenv{'grading'}=$newenv{'grading'};
9637: # Do not clone these environment entries
9638: &Apache::lonnet::del('environment',
9639: ['default_enrollment_start_date',
9640: 'default_enrollment_end_date',
9641: 'question.email',
9642: 'policy.email',
9643: 'comment.email',
9644: 'pch.users.denied',
1.725 raeburn 9645: 'plc.users.denied',
9646: 'hidefromcat',
9647: 'categories'],
1.638 www 9648: $$crsudom,$$crsunum);
1.444 albertel 9649: }
1.566 albertel 9650:
1.444 albertel 9651: #
9652: # Set environment (will override cloned, if existing)
9653: #
9654: my @sections = ();
9655: my @xlists = ();
9656: if ($args->{'crstype'}) {
9657: $cenv{'type'}=$args->{'crstype'};
9658: }
9659: if ($args->{'crsid'}) {
9660: $cenv{'courseid'}=$args->{'crsid'};
9661: }
9662: if ($args->{'crscode'}) {
9663: $cenv{'internal.coursecode'}=$args->{'crscode'};
9664: }
9665: if ($args->{'crsquota'} ne '') {
9666: $cenv{'internal.coursequota'}=$args->{'crsquota'};
9667: } else {
9668: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
9669: }
9670: if ($args->{'ccuname'}) {
9671: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
9672: ':'.$args->{'ccdomain'};
9673: } else {
9674: $cenv{'internal.courseowner'} = $args->{'curruser'};
9675: }
9676: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
9677: if ($args->{'crssections'}) {
9678: $cenv{'internal.sectionnums'} = '';
9679: if ($args->{'crssections'} =~ m/,/) {
9680: @sections = split/,/,$args->{'crssections'};
9681: } else {
9682: $sections[0] = $args->{'crssections'};
9683: }
9684: if (@sections > 0) {
9685: foreach my $item (@sections) {
9686: my ($sec,$gp) = split/:/,$item;
9687: my $class = $args->{'crscode'}.$sec;
9688: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
9689: $cenv{'internal.sectionnums'} .= $item.',';
9690: unless ($addcheck eq 'ok') {
9691: push @badclasses, $class;
9692: }
9693: }
9694: $cenv{'internal.sectionnums'} =~ s/,$//;
9695: }
9696: }
9697: # do not hide course coordinator from staff listing,
9698: # even if privileged
9699: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9700: # add crosslistings
9701: if ($args->{'crsxlist'}) {
9702: $cenv{'internal.crosslistings'}='';
9703: if ($args->{'crsxlist'} =~ m/,/) {
9704: @xlists = split/,/,$args->{'crsxlist'};
9705: } else {
9706: $xlists[0] = $args->{'crsxlist'};
9707: }
9708: if (@xlists > 0) {
9709: foreach my $item (@xlists) {
9710: my ($xl,$gp) = split/:/,$item;
9711: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
9712: $cenv{'internal.crosslistings'} .= $item.',';
9713: unless ($addcheck eq 'ok') {
9714: push @badclasses, $xl;
9715: }
9716: }
9717: $cenv{'internal.crosslistings'} =~ s/,$//;
9718: }
9719: }
9720: if ($args->{'autoadds'}) {
9721: $cenv{'internal.autoadds'}=$args->{'autoadds'};
9722: }
9723: if ($args->{'autodrops'}) {
9724: $cenv{'internal.autodrops'}=$args->{'autodrops'};
9725: }
9726: # check for notification of enrollment changes
9727: my @notified = ();
9728: if ($args->{'notify_owner'}) {
9729: if ($args->{'ccuname'} ne '') {
9730: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
9731: }
9732: }
9733: if ($args->{'notify_dc'}) {
9734: if ($uname ne '') {
1.630 raeburn 9735: push(@notified,$uname.':'.$udom);
1.444 albertel 9736: }
9737: }
9738: if (@notified > 0) {
9739: my $notifylist;
9740: if (@notified > 1) {
9741: $notifylist = join(',',@notified);
9742: } else {
9743: $notifylist = $notified[0];
9744: }
9745: $cenv{'internal.notifylist'} = $notifylist;
9746: }
9747: if (@badclasses > 0) {
9748: my %lt=&Apache::lonlocal::texthash(
9749: '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',
9750: 'dnhr' => 'does not have rights to access enrollment in these classes',
9751: 'adby' => 'as determined by the policies of your institution on access to official classlists'
9752: );
1.541 raeburn 9753: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
9754: ' ('.$lt{'adby'}.')';
9755: if ($context eq 'auto') {
9756: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 9757: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 9758: foreach my $item (@badclasses) {
9759: if ($context eq 'auto') {
9760: $outcome .= " - $item\n";
9761: } else {
9762: $outcome .= "<li>$item</li>\n";
9763: }
9764: }
9765: if ($context eq 'auto') {
9766: $outcome .= $linefeed;
9767: } else {
1.566 albertel 9768: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 9769: }
9770: }
1.444 albertel 9771: }
9772: if ($args->{'no_end_date'}) {
9773: $args->{'endaccess'} = 0;
9774: }
9775: $cenv{'internal.autostart'}=$args->{'enrollstart'};
9776: $cenv{'internal.autoend'}=$args->{'enrollend'};
9777: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
9778: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
9779: if ($args->{'showphotos'}) {
9780: $cenv{'internal.showphotos'}=$args->{'showphotos'};
9781: }
9782: $cenv{'internal.authtype'} = $args->{'authtype'};
9783: $cenv{'internal.autharg'} = $args->{'autharg'};
9784: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
9785: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 9786: 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');
9787: if ($context eq 'auto') {
9788: $outcome .= $krb_msg;
9789: } else {
1.566 albertel 9790: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 9791: }
9792: $outcome .= $linefeed;
1.444 albertel 9793: }
9794: }
9795: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
9796: if ($args->{'setpolicy'}) {
9797: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9798: }
9799: if ($args->{'setcontent'}) {
9800: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9801: }
9802: }
9803: if ($args->{'reshome'}) {
9804: $cenv{'reshome'}=$args->{'reshome'}.'/';
9805: $cenv{'reshome'}=~s/\/+$/\//;
9806: }
9807: #
9808: # course has keyed access
9809: #
9810: if ($args->{'setkeys'}) {
9811: $cenv{'keyaccess'}='yes';
9812: }
9813: # if specified, key authority is not course, but user
9814: # only active if keyaccess is yes
9815: if ($args->{'keyauth'}) {
1.487 albertel 9816: my ($user,$domain) = split(':',$args->{'keyauth'});
9817: $user = &LONCAPA::clean_username($user);
9818: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 9819: if ($user ne '' && $domain ne '') {
1.487 albertel 9820: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 9821: }
9822: }
9823:
9824: if ($args->{'disresdis'}) {
9825: $cenv{'pch.roles.denied'}='st';
9826: }
9827: if ($args->{'disablechat'}) {
9828: $cenv{'plc.roles.denied'}='st';
9829: }
9830:
9831: # Record we've not yet viewed the Course Initialization Helper for this
9832: # course
9833: $cenv{'course.helper.not.run'} = 1;
9834: #
9835: # Use new Randomseed
9836: #
9837: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
9838: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
9839: #
9840: # The encryption code and receipt prefix for this course
9841: #
9842: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
9843: $cenv{'internal.encpref'}=100+int(9*rand(99));
9844: #
9845: # By default, use standard grading
9846: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
9847:
1.541 raeburn 9848: $outcome .= $linefeed.&mt('Setting environment').': '.
9849: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9850: #
9851: # Open all assignments
9852: #
9853: if ($args->{'openall'}) {
9854: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
9855: my %storecontent = ($storeunder => time,
9856: $storeunder.'.type' => 'date_start');
9857:
9858: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 9859: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9860: }
9861: #
9862: # Set first page
9863: #
9864: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
9865: || ($cloneid)) {
1.445 albertel 9866: use LONCAPA::map;
1.444 albertel 9867: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 9868:
9869: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
9870: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
9871:
1.444 albertel 9872: $outcome .= ($fatal?$errtext:'read ok').' - ';
9873: my $title; my $url;
9874: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 9875: $title=&mt('Syllabus');
1.444 albertel 9876: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
9877: } else {
1.690 bisitz 9878: $title=&mt('Navigate Contents');
1.444 albertel 9879: $url='/adm/navmaps';
9880: }
1.445 albertel 9881:
9882: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
9883: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
9884:
9885: if ($errtext) { $fatal=2; }
1.541 raeburn 9886: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 9887: }
1.566 albertel 9888:
9889: return (1,$outcome);
1.444 albertel 9890: }
9891:
9892: ############################################################
9893: ############################################################
9894:
1.378 raeburn 9895: sub course_type {
9896: my ($cid) = @_;
9897: if (!defined($cid)) {
9898: $cid = $env{'request.course.id'};
9899: }
1.404 albertel 9900: if (defined($env{'course.'.$cid.'.type'})) {
9901: return $env{'course.'.$cid.'.type'};
1.378 raeburn 9902: } else {
9903: return 'Course';
1.377 raeburn 9904: }
9905: }
1.156 albertel 9906:
1.406 raeburn 9907: sub group_term {
9908: my $crstype = &course_type();
9909: my %names = (
9910: 'Course' => 'group',
9911: 'Group' => 'team',
9912: );
9913: return $names{$crstype};
9914: }
9915:
1.156 albertel 9916: sub icon {
9917: my ($file)=@_;
1.505 albertel 9918: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 9919: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 9920: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 9921: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
9922: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
9923: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9924: $curfext.".gif") {
9925: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9926: $curfext.".gif";
9927: }
9928: }
1.249 albertel 9929: return &lonhttpdurl($iconname);
1.154 albertel 9930: }
1.84 albertel 9931:
1.575 albertel 9932: sub lonhttpdurl {
1.692 www 9933: #
9934: # Had been used for "small fry" static images on separate port 8080.
9935: # Modify here if lightweight http functionality desired again.
9936: # Currently eliminated due to increasing firewall issues.
9937: #
1.575 albertel 9938: my ($url)=@_;
1.692 www 9939: return $url;
1.215 albertel 9940: }
9941:
1.213 albertel 9942: sub connection_aborted {
9943: my ($r)=@_;
9944: $r->print(" ");$r->rflush();
9945: my $c = $r->connection;
9946: return $c->aborted();
9947: }
9948:
1.221 foxr 9949: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 9950: # strings as 'strings'.
9951: sub escape_single {
1.221 foxr 9952: my ($input) = @_;
1.223 albertel 9953: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 9954: $input =~ s/\'/\\\'/g; # Esacpe the 's....
9955: return $input;
9956: }
1.223 albertel 9957:
1.222 foxr 9958: # Same as escape_single, but escape's "'s This
9959: # can be used for "strings"
9960: sub escape_double {
9961: my ($input) = @_;
9962: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
9963: $input =~ s/\"/\\\"/g; # Esacpe the "s....
9964: return $input;
9965: }
1.223 albertel 9966:
1.222 foxr 9967: # Escapes the last element of a full URL.
9968: sub escape_url {
9969: my ($url) = @_;
1.238 raeburn 9970: my @urlslices = split(/\//, $url,-1);
1.369 www 9971: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 9972: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 9973: }
1.462 albertel 9974:
9975: # -------------------------------------------------------- Initliaze user login
9976: sub init_user_environment {
1.463 albertel 9977: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 9978: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
9979:
9980: my $public=($username eq 'public' && $domain eq 'public');
9981:
9982: # See if old ID present, if so, remove
9983:
9984: my ($filename,$cookie,$userroles);
9985: my $now=time;
9986:
9987: if ($public) {
9988: my $max_public=100;
9989: my $oldest;
9990: my $oldest_time=0;
9991: for(my $next=1;$next<=$max_public;$next++) {
9992: if (-e $lonids."/publicuser_$next.id") {
9993: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
9994: if ($mtime<$oldest_time || !$oldest_time) {
9995: $oldest_time=$mtime;
9996: $oldest=$next;
9997: }
9998: } else {
9999: $cookie="publicuser_$next";
10000: last;
10001: }
10002: }
10003: if (!$cookie) { $cookie="publicuser_$oldest"; }
10004: } else {
1.463 albertel 10005: # if this isn't a robot, kill any existing non-robot sessions
10006: if (!$args->{'robot'}) {
10007: opendir(DIR,$lonids);
10008: while ($filename=readdir(DIR)) {
10009: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10010: unlink($lonids.'/'.$filename);
10011: }
1.462 albertel 10012: }
1.463 albertel 10013: closedir(DIR);
1.462 albertel 10014: }
10015: # Give them a new cookie
1.463 albertel 10016: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10017: : $now.$$.int(rand(10000)));
1.463 albertel 10018: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10019:
10020: # Initialize roles
10021:
10022: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10023: }
10024: # ------------------------------------ Check browser type and MathML capability
10025:
10026: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10027: $clientunicode,$clientos) = &decode_user_agent($r);
10028:
10029: # -------------------------------------- Any accessibility options to remember?
10030: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
10031: foreach my $option ('imagesuppress','appletsuppress',
10032: 'embedsuppress','fontenhance','blackwhite') {
10033: if ($form->{$option} eq 'true') {
10034: &Apache::lonnet::put('environment',{$option => 'on'},
10035: $domain,$username);
10036: } else {
10037: &Apache::lonnet::del('environment',[$option],
10038: $domain,$username);
10039: }
10040: }
10041: }
10042: # ------------------------------------------------------------- Get environment
10043:
10044: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10045: my ($tmp) = keys(%userenv);
10046: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10047: # default remote control to off
10048: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
10049: } else {
10050: undef(%userenv);
10051: }
10052: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10053: $form->{'interface'}=$userenv{'interface'};
10054: }
10055: $env{'environment.remote'}=$userenv{'remote'};
10056: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10057:
10058: # --------------- Do not trust query string to be put directly into environment
10059: foreach my $option ('imagesuppress','appletsuppress',
10060: 'embedsuppress','fontenhance','blackwhite',
10061: 'interface','localpath','localres') {
10062: $form->{$option}=~s/[\n\r\=]//gs;
10063: }
10064: # --------------------------------------------------------- Write first profile
10065:
10066: {
10067: my %initial_env =
10068: ("user.name" => $username,
10069: "user.domain" => $domain,
10070: "user.home" => $authhost,
10071: "browser.type" => $clientbrowser,
10072: "browser.version" => $clientversion,
10073: "browser.mathml" => $clientmathml,
10074: "browser.unicode" => $clientunicode,
10075: "browser.os" => $clientos,
10076: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10077: "request.course.fn" => '',
10078: "request.course.uri" => '',
10079: "request.course.sec" => '',
10080: "request.role" => 'cm',
10081: "request.role.adv" => $env{'user.adv'},
10082: "request.host" => $ENV{'REMOTE_ADDR'},);
10083:
10084: if ($form->{'localpath'}) {
10085: $initial_env{"browser.localpath"} = $form->{'localpath'};
10086: $initial_env{"browser.localres"} = $form->{'localres'};
10087: }
10088:
10089: if ($public) {
10090: $initial_env{"environment.remote"} = "off";
10091: }
10092: if ($form->{'interface'}) {
10093: $form->{'interface'}=~s/\W//gs;
10094: $initial_env{"browser.interface"} = $form->{'interface'};
10095: $env{'browser.interface'}=$form->{'interface'};
10096: foreach my $option ('imagesuppress','appletsuppress',
10097: 'embedsuppress','fontenhance','blackwhite') {
10098: if (($form->{$option} eq 'true') ||
10099: ($userenv{$option} eq 'on')) {
10100: $initial_env{"browser.$option"} = "on";
10101: }
10102: }
10103: }
10104:
1.724 raeburn 10105: foreach my $tool ('aboutme','blog','portfolio') {
10106: $userenv{'availabletools.'.$tool} =
10107: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10108: }
10109:
1.765 raeburn 10110: foreach my $crstype ('official','unofficial') {
10111: $userenv{'canrequest.'.$crstype} =
10112: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10113: 'reload','requestcourses');
10114: }
10115:
1.462 albertel 10116: $env{'user.environment'} = "$lonids/$cookie.id";
10117:
10118: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10119: &GDBM_WRCREAT(),0640)) {
10120: &_add_to_env(\%disk_env,\%initial_env);
10121: &_add_to_env(\%disk_env,\%userenv,'environment.');
10122: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10123: if (ref($args->{'extra_env'})) {
10124: &_add_to_env(\%disk_env,$args->{'extra_env'});
10125: }
1.462 albertel 10126: untie(%disk_env);
10127: } else {
1.705 tempelho 10128: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10129: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10130: return 'error: '.$!;
10131: }
10132: }
10133: $env{'request.role'}='cm';
10134: $env{'request.role.adv'}=$env{'user.adv'};
10135: $env{'browser.type'}=$clientbrowser;
10136:
10137: return $cookie;
10138:
10139: }
10140:
10141: sub _add_to_env {
10142: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10143: if (ref($env_data) eq 'HASH') {
10144: while (my ($key,$value) = each(%$env_data)) {
10145: $idf->{$prefix.$key} = $value;
10146: $env{$prefix.$key} = $value;
10147: }
1.462 albertel 10148: }
10149: }
10150:
1.685 tempelho 10151: # --- Get the symbolic name of a problem and the url
10152: sub get_symb {
10153: my ($request,$silent) = @_;
1.726 raeburn 10154: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10155: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10156: if ($symb eq '') {
10157: if (!$silent) {
10158: $request->print("Unable to handle ambiguous references:$url:.");
10159: return ();
10160: }
10161: }
10162: &Apache::lonenc::check_decrypt(\$symb);
10163: return ($symb);
10164: }
10165:
10166: # --------------------------------------------------------------Get annotation
10167:
10168: sub get_annotation {
10169: my ($symb,$enc) = @_;
10170:
10171: my $key = $symb;
10172: if (!$enc) {
10173: $key =
10174: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10175: }
10176: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10177: return $annotation{$key};
10178: }
10179:
10180: sub clean_symb {
1.731 raeburn 10181: my ($symb,$delete_enc) = @_;
1.685 tempelho 10182:
10183: &Apache::lonenc::check_decrypt(\$symb);
10184: my $enc = $env{'request.enc'};
1.731 raeburn 10185: if ($delete_enc) {
1.730 raeburn 10186: delete($env{'request.enc'});
10187: }
1.685 tempelho 10188:
10189: return ($symb,$enc);
10190: }
1.462 albertel 10191:
1.41 ng 10192: =pod
10193:
10194: =back
10195:
1.112 bowersj2 10196: =cut
1.41 ng 10197:
1.112 bowersj2 10198: 1;
10199: __END__;
1.41 ng 10200:
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