Annotation of loncom/interface/loncommon.pm, revision 1.705
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.705 ! tempelho 4: # $Id: loncommon.pm,v 1.704 2008/12/03 13:09:03 muellerd Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.479 albertel 70: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 71: use DateTime::TimeZone;
1.687 raeburn 72: use DateTime::Locale::Catalog;
1.117 www 73:
1.517 raeburn 74: # ---------------------------------------------- Designs
75: use vars qw(%defaultdesign);
76:
1.22 www 77: my $readit;
78:
1.517 raeburn 79:
1.157 matthew 80: ##
81: ## Global Variables
82: ##
1.46 matthew 83:
1.643 foxr 84:
85: # ----------------------------------------------- SSI with retries:
86: #
87:
88: =pod
89:
1.648 raeburn 90: =head1 Server Side include with retries:
1.643 foxr 91:
92: =over 4
93:
1.648 raeburn 94: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 95:
96: Performs an ssi with some number of retries. Retries continue either
97: until the result is ok or until the retry count supplied by the
98: caller is exhausted.
99:
100: Inputs:
1.648 raeburn 101:
102: =over 4
103:
1.643 foxr 104: resource - Identifies the resource to insert.
1.648 raeburn 105:
1.643 foxr 106: retries - Count of the number of retries allowed.
1.648 raeburn 107:
1.643 foxr 108: form - Hash that identifies the rendering options.
109:
1.648 raeburn 110: =back
111:
112: Returns:
113:
114: =over 4
115:
1.643 foxr 116: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 117:
1.643 foxr 118: response - The response from the last attempt (which may or may not have been successful.
119:
1.648 raeburn 120: =back
121:
122: =back
123:
1.643 foxr 124: =cut
125:
126: sub ssi_with_retries {
127: my ($resource, $retries, %form) = @_;
128:
129:
130: my $ok = 0; # True if we got a good response.
131: my $content;
132: my $response;
133:
134: # Try to get the ssi done. within the retries count:
135:
136: do {
137: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
138: $ok = $response->is_success;
1.650 www 139: if (!$ok) {
140: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
141: }
1.643 foxr 142: $retries--;
143: } while (!$ok && ($retries > 0));
144:
145: if (!$ok) {
146: $content = ''; # On error return an empty content.
147: }
148: return ($content, $response);
149:
150: }
151:
152:
153:
1.20 www 154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 155: my %language;
1.124 www 156: my %supported_language;
1.12 harris41 157: my %cprtag;
1.192 taceyjo1 158: my %scprtag;
1.351 www 159: my %fe; my %fd; my %fm;
1.41 ng 160: my %category_extensions;
1.12 harris41 161:
1.46 matthew 162: # ---------------------------------------------- Thesaurus variables
1.144 matthew 163: #
164: # %Keywords:
165: # A hash used by &keyword to determine if a word is considered a keyword.
166: # $thesaurus_db_file
167: # Scalar containing the full path to the thesaurus database.
1.46 matthew 168:
169: my %Keywords;
170: my $thesaurus_db_file;
171:
1.144 matthew 172: #
173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
174: # thesaurus.tab, and filecategories.tab.
175: #
1.18 www 176: BEGIN {
1.46 matthew 177: # Variable initialization
178: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
179: #
1.22 www 180: unless ($readit) {
1.12 harris41 181: # ------------------------------------------------------------------- languages
182: {
1.158 raeburn 183: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
184: '/language.tab';
185: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 186: while (my $line = <$fh>) {
187: next if ($line=~/^\#/);
188: chomp($line);
189: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158 raeburn 190: $language{$key}=$val.' - '.$enc;
191: if ($sup) {
192: $supported_language{$key}=$sup;
193: }
194: }
195: close($fh);
196: }
1.12 harris41 197: }
198: # ------------------------------------------------------------------ copyrights
199: {
1.158 raeburn 200: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
201: '/copyright.tab';
202: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 203: while (my $line = <$fh>) {
204: next if ($line=~/^\#/);
205: chomp($line);
206: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 207: $cprtag{$key}=$val;
208: }
209: close($fh);
210: }
1.12 harris41 211: }
1.351 www 212: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 213: {
214: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
215: '/source_copyright.tab';
216: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 217: while (my $line = <$fh>) {
218: next if ($line =~ /^\#/);
219: chomp($line);
220: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 221: $scprtag{$key}=$val;
222: }
223: close($fh);
224: }
225: }
1.63 www 226:
1.517 raeburn 227: # -------------------------------------------------------------- default domain designs
1.63 www 228: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 229: my $designfile = $designdir.'/default.tab';
230: if ( open (my $fh,"<$designfile") ) {
231: while (my $line = <$fh>) {
232: next if ($line =~ /^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\=/,$line));
235: if ($val) { $defaultdesign{$key}=$val; }
236: }
237: close($fh);
1.63 www 238: }
239:
1.15 harris41 240: # ------------------------------------------------------------- file categories
241: {
1.158 raeburn 242: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
243: '/filecategories.tab';
244: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 249: push @{$category_extensions{lc($category)}},$extension;
250: }
251: close($fh);
252: }
253:
1.15 harris41 254: }
1.12 harris41 255: # ------------------------------------------------------------------ file types
256: {
1.158 raeburn 257: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
258: '/filetypes.tab';
259: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 260: while (my $line = <$fh>) {
261: next if ($line =~ /^\#/);
262: chomp($line);
263: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 264: if ($descr ne '') {
265: $fe{$ending}=lc($emb);
266: $fd{$ending}=$descr;
1.351 www 267: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 268: }
269: }
270: close($fh);
271: }
1.12 harris41 272: }
1.22 www 273: &Apache::lonnet::logthis(
1.705 ! tempelho 274: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 275: $readit=1;
1.46 matthew 276: } # end of unless($readit)
1.32 matthew 277:
278: }
1.112 bowersj2 279:
1.42 matthew 280: ###############################################################
281: ## HTML and Javascript Helper Functions ##
282: ###############################################################
283:
284: =pod
285:
1.112 bowersj2 286: =head1 HTML and Javascript Functions
1.42 matthew 287:
1.112 bowersj2 288: =over 4
289:
1.648 raeburn 290: =item * &browser_and_searcher_javascript()
1.112 bowersj2 291:
292: X<browsing, javascript>X<searching, javascript>Returns a string
293: containing javascript with two functions, C<openbrowser> and
294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
295: tags.
1.42 matthew 296:
1.648 raeburn 297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 298:
299: inputs: formname, elementname, only, omit
300:
301: formname and elementname indicate the name of the html form and name of
302: the element that the results of the browsing selection are to be placed in.
303:
304: Specifying 'only' will restrict the browser to displaying only files
1.185 www 305: with the given extension. Can be a comma separated list.
1.42 matthew 306:
307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 308: with the given extension. Can be a comma separated list.
1.42 matthew 309:
1.648 raeburn 310: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 311:
312: Inputs: formname, elementname
313:
314: formname and elementname specify the name of the html form and the name
315: of the element the selection from the search results will be placed in.
1.542 raeburn 316:
1.42 matthew 317: =cut
318:
319: sub browser_and_searcher_javascript {
1.199 albertel 320: my ($mode)=@_;
321: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 322: my $resurl=&escape_single(&lastresurl());
1.42 matthew 323: return <<END;
1.219 albertel 324: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 325: var editbrowser = null;
1.135 albertel 326: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 327: var url = '$resurl/?';
1.42 matthew 328: if (editbrowser == null) {
329: url += 'launch=1&';
330: }
331: url += 'catalogmode=interactive&';
1.199 albertel 332: url += 'mode=$mode&';
1.611 albertel 333: url += 'inhibitmenu=yes&';
1.42 matthew 334: url += 'form=' + formname + '&';
335: if (only != null) {
336: url += 'only=' + only + '&';
1.217 albertel 337: } else {
338: url += 'only=&';
339: }
1.42 matthew 340: if (omit != null) {
341: url += 'omit=' + omit + '&';
1.217 albertel 342: } else {
343: url += 'omit=&';
344: }
1.135 albertel 345: if (titleelement != null) {
346: url += 'titleelement=' + titleelement + '&';
1.217 albertel 347: } else {
348: url += 'titleelement=&';
349: }
1.42 matthew 350: url += 'element=' + elementname + '';
351: var title = 'Browser';
1.435 albertel 352: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 353: options += ',width=700,height=600';
354: editbrowser = open(url,title,options,'1');
355: editbrowser.focus();
356: }
357: var editsearcher;
1.135 albertel 358: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 359: var url = '/adm/searchcat?';
360: if (editsearcher == null) {
361: url += 'launch=1&';
362: }
363: url += 'catalogmode=interactive&';
1.199 albertel 364: url += 'mode=$mode&';
1.42 matthew 365: url += 'form=' + formname + '&';
1.135 albertel 366: if (titleelement != null) {
367: url += 'titleelement=' + titleelement + '&';
1.217 albertel 368: } else {
369: url += 'titleelement=&';
370: }
1.42 matthew 371: url += 'element=' + elementname + '';
372: var title = 'Search';
1.435 albertel 373: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 374: options += ',width=700,height=600';
375: editsearcher = open(url,title,options,'1');
376: editsearcher.focus();
377: }
1.219 albertel 378: // END LON-CAPA Internal -->
1.42 matthew 379: END
1.170 www 380: }
381:
382: sub lastresurl {
1.258 albertel 383: if ($env{'environment.lastresurl'}) {
384: return $env{'environment.lastresurl'}
1.170 www 385: } else {
386: return '/res';
387: }
388: }
389:
390: sub storeresurl {
391: my $resurl=&Apache::lonnet::clutter(shift);
392: unless ($resurl=~/^\/res/) { return 0; }
393: $resurl=~s/\/$//;
394: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 395: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 396: return 1;
1.42 matthew 397: }
398:
1.74 www 399: sub studentbrowser_javascript {
1.111 www 400: unless (
1.258 albertel 401: (($env{'request.course.id'}) &&
1.302 albertel 402: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
403: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
404: '/'.$env{'request.course.sec'})
405: ))
1.258 albertel 406: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 407: ) { return ''; }
1.74 www 408: return (<<'ENDSTDBRW');
409: <script type="text/javascript" language="Javascript" >
410: var stdeditbrowser;
1.558 albertel 411: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter) {
1.74 www 412: var url = '/adm/pickstudent?';
413: var filter;
1.558 albertel 414: if (!ignorefilter) {
415: eval('filter=document.'+formname+'.'+uname+'.value;');
416: }
1.74 www 417: if (filter != null) {
418: if (filter != '') {
419: url += 'filter='+filter+'&';
420: }
421: }
422: url += 'form=' + formname + '&unameelement='+uname+
423: '&udomelement='+udom;
1.111 www 424: if (roleflag) { url+="&roles=1"; }
1.102 www 425: var title = 'Student_Browser';
1.74 www 426: var options = 'scrollbars=1,resizable=1,menubar=0';
427: options += ',width=700,height=600';
428: stdeditbrowser = open(url,title,options,'1');
429: stdeditbrowser.focus();
430: }
431: </script>
432: ENDSTDBRW
433: }
1.42 matthew 434:
1.74 www 435: sub selectstudent_link {
1.111 www 436: my ($form,$unameele,$udomele)=@_;
1.258 albertel 437: if ($env{'request.course.id'}) {
1.302 albertel 438: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
439: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
440: '/'.$env{'request.course.sec'})) {
1.111 www 441: return '';
442: }
443: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.607 albertel 444: '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
1.74 www 445: }
1.258 albertel 446: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.111 www 447: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.119 www 448: '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
1.111 www 449: }
450: return '';
1.91 www 451: }
452:
1.653 raeburn 453: sub authorbrowser_javascript {
454: return <<"ENDAUTHORBRW";
455: <script type="text/javascript">
456: var stdeditbrowser;
457:
458: function openauthorbrowser(formname,udom) {
459: var url = '/adm/pickauthor?';
460: url += 'form='+formname+'&roledom='+udom;
461: var title = 'Author_Browser';
462: var options = 'scrollbars=1,resizable=1,menubar=0';
463: options += ',width=700,height=600';
464: stdeditbrowser = open(url,title,options,'1');
465: stdeditbrowser.focus();
466: }
467:
468: </script>
469: ENDAUTHORBRW
470: }
471:
1.91 www 472: sub coursebrowser_javascript {
1.468 raeburn 473: my ($domainfilter,$sec_element,$formname)=@_;
1.377 raeburn 474: my $crs_or_grp_alert = &mt('Please select the type of LON-CAPA entity - Course or Group - for which you wish to add/modify a user role');
1.468 raeburn 475: my $output = '
1.538 albertel 476: <script type="text/javascript">
1.468 raeburn 477: var stdeditbrowser;'."\n";
478: $output .= <<"ENDSTDBRW";
1.377 raeburn 479: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
1.91 www 480: var url = '/adm/pickcourse?';
1.468 raeburn 481: var domainfilter = '';
482: var formid = getFormIdByName(formname);
483: if (formid > -1) {
484: var domid = getIndexByName(formid,udom);
485: if (domid > -1) {
486: if (document.forms[formid].elements[domid].type == 'select-one') {
487: domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
488: }
489: if (document.forms[formid].elements[domid].type == 'hidden') {
490: domainfilter=document.forms[formid].elements[domid].value;
491: }
492: }
1.91 www 493: }
1.128 albertel 494: if (domainfilter != null) {
495: if (domainfilter != '') {
496: url += 'domainfilter='+domainfilter+'&';
497: }
498: }
1.91 www 499: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 500: '&cdomelement='+udom+
501: '&cnameelement='+desc;
1.468 raeburn 502: if (extra_element !=null && extra_element != '') {
1.594 raeburn 503: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 504: url += '&roleelement='+extra_element;
505: if (domainfilter == null || domainfilter == '') {
506: url += '&domainfilter='+extra_element;
507: }
1.234 raeburn 508: }
1.468 raeburn 509: else {
510: if (formname == 'portform') {
511: url += '&setroles='+extra_element;
512: }
513: }
1.230 raeburn 514: }
1.293 raeburn 515: if (multflag !=null && multflag != '') {
516: url += '&multiple='+multflag;
517: }
1.377 raeburn 518: if (crstype == 'Course/Group') {
519: if (formname == 'cu') {
520: crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value;
521: if (crstype == "") {
522: alert("$crs_or_grp_alert");
523: return;
524: }
525: }
526: }
527: if (crstype !=null && crstype != '') {
528: url += '&type='+crstype;
529: }
1.102 www 530: var title = 'Course_Browser';
1.91 www 531: var options = 'scrollbars=1,resizable=1,menubar=0';
532: options += ',width=700,height=600';
533: stdeditbrowser = open(url,title,options,'1');
534: stdeditbrowser.focus();
535: }
1.468 raeburn 536:
537: function getFormIdByName(formname) {
538: for (var i=0;i<document.forms.length;i++) {
539: if (document.forms[i].name == formname) {
540: return i;
541: }
542: }
543: return -1;
544: }
545:
546: function getIndexByName(formid,item) {
547: for (var i=0;i<document.forms[formid].elements.length;i++) {
548: if (document.forms[formid].elements[i].name == item) {
549: return i;
550: }
551: }
552: return -1;
553: }
1.91 www 554: ENDSTDBRW
1.468 raeburn 555: if ($sec_element ne '') {
556: $output .= &setsec_javascript($sec_element,$formname);
557: }
558: $output .= '
559: </script>';
560: return $output;
561: }
562:
563: sub setsec_javascript {
564: my ($sec_element,$formname) = @_;
565: my $setsections = qq|
566: function setSect(sectionlist) {
1.629 raeburn 567: var sectionsArray = new Array();
568: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
569: sectionsArray = sectionlist.split(",");
570: }
1.468 raeburn 571: var numSections = sectionsArray.length;
572: document.$formname.$sec_element.length = 0;
573: if (numSections == 0) {
574: document.$formname.$sec_element.multiple=false;
575: document.$formname.$sec_element.size=1;
576: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
577: } else {
578: if (numSections == 1) {
579: document.$formname.$sec_element.multiple=false;
580: document.$formname.$sec_element.size=1;
581: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
582: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
583: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
584: } else {
585: for (var i=0; i<numSections; i++) {
586: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
587: }
588: document.$formname.$sec_element.multiple=true
589: if (numSections < 3) {
590: document.$formname.$sec_element.size=numSections;
591: } else {
592: document.$formname.$sec_element.size=3;
593: }
594: document.$formname.$sec_element.options[0].selected = false
595: }
596: }
1.91 www 597: }
1.468 raeburn 598: |;
599: return $setsections;
600: }
601:
1.91 www 602:
603: sub selectcourse_link {
1.377 raeburn 604: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.492 albertel 605: return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
606: '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'","'.$selecttype.'");'."'>".&mt('Select Course')."</a>";
1.74 www 607: }
1.42 matthew 608:
1.653 raeburn 609: sub selectauthor_link {
610: my ($form,$udom)=@_;
611: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
612: &mt('Select Author').'</a>';
613: }
614:
1.273 raeburn 615: sub check_uncheck_jscript {
616: my $jscript = <<"ENDSCRT";
617: function checkAll(field) {
618: if (field.length > 0) {
619: for (i = 0; i < field.length; i++) {
620: field[i].checked = true ;
621: }
622: } else {
623: field.checked = true
624: }
625: }
626:
627: function uncheckAll(field) {
628: if (field.length > 0) {
629: for (i = 0; i < field.length; i++) {
630: field[i].checked = false ;
1.543 albertel 631: }
632: } else {
1.273 raeburn 633: field.checked = false ;
634: }
635: }
636: ENDSCRT
637: return $jscript;
638: }
639:
1.656 www 640: sub select_timezone {
1.659 raeburn 641: my ($name,$selected,$onchange,$includeempty)=@_;
642: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
643: if ($includeempty) {
644: $output .= '<option value=""';
645: if (($selected eq '') || ($selected eq 'local')) {
646: $output .= ' selected="selected" ';
647: }
648: $output .= '> </option>';
649: }
1.657 raeburn 650: my @timezones = DateTime::TimeZone->all_names;
651: foreach my $tzone (@timezones) {
652: $output.= '<option value="'.$tzone.'"';
653: if ($tzone eq $selected) {
654: $output.=' selected="selected"';
655: }
656: $output.=">$tzone</option>\n";
1.656 www 657: }
658: $output.="</select>";
659: return $output;
660: }
1.273 raeburn 661:
1.687 raeburn 662: sub select_datelocale {
663: my ($name,$selected,$onchange,$includeempty)=@_;
664: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
665: if ($includeempty) {
666: $output .= '<option value=""';
667: if ($selected eq '') {
668: $output .= ' selected="selected" ';
669: }
670: $output .= '> </option>';
671: }
672: my (@possibles,%locale_names);
673: my @locales = DateTime::Locale::Catalog::Locales;
674: foreach my $locale (@locales) {
675: if (ref($locale) eq 'HASH') {
676: my $id = $locale->{'id'};
677: if ($id ne '') {
678: my $en_terr = $locale->{'en_territory'};
679: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 680: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 681: if (grep(/^en$/,@languages) || !@languages) {
682: if ($en_terr ne '') {
683: $locale_names{$id} = '('.$en_terr.')';
684: } elsif ($native_terr ne '') {
685: $locale_names{$id} = $native_terr;
686: }
687: } else {
688: if ($native_terr ne '') {
689: $locale_names{$id} = $native_terr.' ';
690: } elsif ($en_terr ne '') {
691: $locale_names{$id} = '('.$en_terr.')';
692: }
693: }
694: push (@possibles,$id);
695: }
696: }
697: }
698: foreach my $item (sort(@possibles)) {
699: $output.= '<option value="'.$item.'"';
700: if ($item eq $selected) {
701: $output.=' selected="selected"';
702: }
703: $output.=">$item";
704: if ($locale_names{$item} ne '') {
705: $output.=" $locale_names{$item}</option>\n";
706: }
707: $output.="</option>\n";
708: }
709: $output.="</select>";
710: return $output;
711: }
712:
1.42 matthew 713: =pod
1.36 matthew 714:
1.648 raeburn 715: =item * &linked_select_forms(...)
1.36 matthew 716:
717: linked_select_forms returns a string containing a <script></script> block
718: and html for two <select> menus. The select menus will be linked in that
719: changing the value of the first menu will result in new values being placed
720: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 721: order unless a defined order is provided.
1.36 matthew 722:
723: linked_select_forms takes the following ordered inputs:
724:
725: =over 4
726:
1.112 bowersj2 727: =item * $formname, the name of the <form> tag
1.36 matthew 728:
1.112 bowersj2 729: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 730:
1.112 bowersj2 731: =item * $firstdefault, the default value for the first menu
1.36 matthew 732:
1.112 bowersj2 733: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 734:
1.112 bowersj2 735: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 736:
1.112 bowersj2 737: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 738:
1.609 raeburn 739: =item * $menuorder, the order of values in the first menu
740:
1.41 ng 741: =back
742:
1.36 matthew 743: Below is an example of such a hash. Only the 'text', 'default', and
744: 'select2' keys must appear as stated. keys(%menu) are the possible
745: values for the first select menu. The text that coincides with the
1.41 ng 746: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 747: and text for the second menu are given in the hash pointed to by
748: $menu{$choice1}->{'select2'}.
749:
1.112 bowersj2 750: my %menu = ( A1 => { text =>"Choice A1" ,
751: default => "B3",
752: select2 => {
753: B1 => "Choice B1",
754: B2 => "Choice B2",
755: B3 => "Choice B3",
756: B4 => "Choice B4"
1.609 raeburn 757: },
758: order => ['B4','B3','B1','B2'],
1.112 bowersj2 759: },
760: A2 => { text =>"Choice A2" ,
761: default => "C2",
762: select2 => {
763: C1 => "Choice C1",
764: C2 => "Choice C2",
765: C3 => "Choice C3"
1.609 raeburn 766: },
767: order => ['C2','C1','C3'],
1.112 bowersj2 768: },
769: A3 => { text =>"Choice A3" ,
770: default => "D6",
771: select2 => {
772: D1 => "Choice D1",
773: D2 => "Choice D2",
774: D3 => "Choice D3",
775: D4 => "Choice D4",
776: D5 => "Choice D5",
777: D6 => "Choice D6",
778: D7 => "Choice D7"
1.609 raeburn 779: },
780: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 781: }
782: );
1.36 matthew 783:
784: =cut
785:
786: sub linked_select_forms {
787: my ($formname,
788: $middletext,
789: $firstdefault,
790: $firstselectname,
791: $secondselectname,
1.609 raeburn 792: $hashref,
793: $menuorder,
1.36 matthew 794: ) = @_;
795: my $second = "document.$formname.$secondselectname";
796: my $first = "document.$formname.$firstselectname";
797: # output the javascript to do the changing
798: my $result = '';
1.219 albertel 799: $result.="<script type=\"text/javascript\">\n";
1.36 matthew 800: $result.="var select2data = new Object();\n";
801: $" = '","';
802: my $debug = '';
803: foreach my $s1 (sort(keys(%$hashref))) {
804: $result.="select2data.d_$s1 = new Object();\n";
805: $result.="select2data.d_$s1.def = new String('".
806: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 807: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 808: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 809: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
810: @s2values = @{$hashref->{$s1}->{'order'}};
811: }
1.36 matthew 812: $result.="\"@s2values\");\n";
813: $result.="select2data.d_$s1.texts = new Array(";
814: my @s2texts;
815: foreach my $value (@s2values) {
816: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
817: }
818: $result.="\"@s2texts\");\n";
819: }
820: $"=' ';
821: $result.= <<"END";
822:
823: function select1_changed() {
824: // Determine new choice
825: var newvalue = "d_" + $first.value;
826: // update select2
827: var values = select2data[newvalue].values;
828: var texts = select2data[newvalue].texts;
829: var select2def = select2data[newvalue].def;
830: var i;
831: // out with the old
832: for (i = 0; i < $second.options.length; i++) {
833: $second.options[i] = null;
834: }
835: // in with the nuclear
836: for (i=0;i<values.length; i++) {
837: $second.options[i] = new Option(values[i]);
1.143 matthew 838: $second.options[i].value = values[i];
1.36 matthew 839: $second.options[i].text = texts[i];
840: if (values[i] == select2def) {
841: $second.options[i].selected = true;
842: }
843: }
844: }
845: </script>
846: END
847: # output the initial values for the selection lists
848: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 849: my @order = sort(keys(%{$hashref}));
850: if (ref($menuorder) eq 'ARRAY') {
851: @order = @{$menuorder};
852: }
853: foreach my $value (@order) {
1.36 matthew 854: $result.=" <option value=\"$value\" ";
1.253 albertel 855: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 856: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 857: }
858: $result .= "</select>\n";
859: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
860: $result .= $middletext;
861: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
862: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 863:
864: my @secondorder = sort(keys(%select2));
865: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
866: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
867: }
868: foreach my $value (@secondorder) {
1.36 matthew 869: $result.=" <option value=\"$value\" ";
1.253 albertel 870: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 871: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 872: }
873: $result .= "</select>\n";
874: # return $debug;
875: return $result;
876: } # end of sub linked_select_forms {
877:
1.45 matthew 878: =pod
1.44 bowersj2 879:
1.648 raeburn 880: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44 bowersj2 881:
1.112 bowersj2 882: Returns a string corresponding to an HTML link to the given help
883: $topic, where $topic corresponds to the name of a .tex file in
884: /home/httpd/html/adm/help/tex, with underscores replaced by
885: spaces.
886:
887: $text will optionally be linked to the same topic, allowing you to
888: link text in addition to the graphic. If you do not want to link
889: text, but wish to specify one of the later parameters, pass an
890: empty string.
891:
892: $stayOnPage is a value that will be interpreted as a boolean. If true,
893: the link will not open a new window. If false, the link will open
894: a new window using Javascript. (Default is false.)
895:
896: $width and $height are optional numerical parameters that will
897: override the width and height of the popped up window, which may
898: be useful for certain help topics with big pictures included.
1.44 bowersj2 899:
900: =cut
901:
902: sub help_open_topic {
1.48 bowersj2 903: my ($topic, $text, $stayOnPage, $width, $height) = @_;
904: $text = "" if (not defined $text);
1.44 bowersj2 905: $stayOnPage = 0 if (not defined $stayOnPage);
1.552 banghart 906: if ($env{'browser.interface'} eq 'textual') {
1.79 www 907: $stayOnPage=1;
908: }
1.44 bowersj2 909: $width = 350 if (not defined $width);
910: $height = 400 if (not defined $height);
911: my $filename = $topic;
912: $filename =~ s/ /_/g;
913:
1.48 bowersj2 914: my $template = "";
915: my $link;
1.572 banghart 916:
1.159 www 917: $topic=~s/\W/\_/g;
1.44 bowersj2 918:
1.572 banghart 919: if (!$stayOnPage) {
1.72 bowersj2 920: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 921: } else {
1.48 bowersj2 922: $link = "/adm/help/${filename}.hlp";
923: }
924:
925: # Add the text
1.572 banghart 926: if ($text ne "") {
1.77 www 927: $template .=
1.572 banghart 928: "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 ! tempelho 929: "<td bgcolor='#5555FF'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.48 bowersj2 930: }
931:
932: # Add the graphic
1.179 matthew 933: my $title = &mt('Online Help');
1.667 raeburn 934: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.48 bowersj2 935: $template .= <<"ENDTEMPLATE";
1.436 albertel 936: <a target="_top" href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
1.44 bowersj2 937: ENDTEMPLATE
1.705 ! tempelho 938: if ($text ne '') { $template.='</td></tr></table>' };
1.44 bowersj2 939: return $template;
940:
1.106 bowersj2 941: }
942:
943: # This is a quicky function for Latex cheatsheet editing, since it
944: # appears in at least four places
945: sub helpLatexCheatsheet {
946: my $other = shift;
947: my $addOther = '';
948: if ($other) {
949: $addOther = Apache::loncommon::help_open_topic($other, shift,
950: undef, undef, 600) .
951: '</td><td>';
952: }
953: return '<table><tr><td>'.
954: $addOther .
1.636 raeburn 955: &Apache::loncommon::help_open_topic("Greek_Symbols",&mt('Greek Symbols'),
1.106 bowersj2 956: undef,undef,600)
957: .'</td><td>'.
1.636 raeburn 958: &Apache::loncommon::help_open_topic("Other_Symbols",&mt('Other Symbols'),
1.106 bowersj2 959: undef,undef,600)
1.673 felicia 960: .'</td><td>'.
961: &Apache::loncommon::help_open_topic("Authoring_Output_Tags",&mt('Output Tags'),
962: undef,undef,600)
1.106 bowersj2 963: .'</td></tr></table>';
1.172 www 964: }
965:
1.430 albertel 966: sub general_help {
967: my $helptopic='Student_Intro';
968: if ($env{'request.role'}=~/^(ca|au)/) {
969: $helptopic='Authoring_Intro';
970: } elsif ($env{'request.role'}=~/^cc/) {
971: $helptopic='Course_Coordination_Intro';
1.672 raeburn 972: } elsif ($env{'request.role'}=~/^dc/) {
973: $helptopic='Domain_Coordination_Intro';
1.430 albertel 974: }
975: return $helptopic;
976: }
977:
978: sub update_help_link {
979: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
980: my $origurl = $ENV{'REQUEST_URI'};
981: $origurl=~s|^/~|/priv/|;
982: my $timestamp = time;
983: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
984: $$datum = &escape($$datum);
985: }
986:
987: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
988: my $output .= <<"ENDOUTPUT";
989: <script type="text/javascript">
990: banner_link = '$banner_link';
991: </script>
992: ENDOUTPUT
993: return $output;
994: }
995:
996: # now just updates the help link and generates a blue icon
1.193 raeburn 997: sub help_open_menu {
1.430 albertel 998: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 999: = @_;
1.430 albertel 1000: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 1001: # only use pop-up help (stayOnPage == 0)
1.552 banghart 1002: # if environment.remote is on (using remote control UI)
1.572 banghart 1003: if ($env{'browser.interface'} eq 'textual' ||
1004: $env{'environment.remote'} eq 'off' ) {
1.552 banghart 1005: $stayOnPage=1;
1.430 albertel 1006: }
1007: my $output;
1008: if ($component_help) {
1009: if (!$text) {
1010: $output=&help_open_topic($component_help,undef,$stayOnPage,
1011: $width,$height);
1012: } else {
1013: my $help_text;
1014: $help_text=&unescape($topic);
1015: $output='<table><tr><td>'.
1016: &help_open_topic($component_help,$help_text,$stayOnPage,
1017: $width,$height).'</td></tr></table>';
1018: }
1019: }
1020: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1021: return $output.$banner_link;
1022: }
1023:
1024: sub top_nav_help {
1025: my ($text) = @_;
1.436 albertel 1026: $text = &mt($text);
1.572 banghart 1027: my $stay_on_page =
1.436 albertel 1028: ($env{'browser.interface'} eq 'textual' ||
1029: $env{'environment.remote'} eq 'off' );
1.572 banghart 1030: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1031: : "javascript:helpMenu('open')";
1.572 banghart 1032: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1033:
1.201 raeburn 1034: my $title = &mt('Get help');
1.436 albertel 1035:
1036: return <<"END";
1037: $banner_link
1038: <a href="$link" title="$title">$text</a>
1039: END
1040: }
1041:
1042: sub help_menu_js {
1043: my ($text) = @_;
1044:
1045: my $stayOnPage =
1046: ($env{'browser.interface'} eq 'textual' ||
1047: $env{'environment.remote'} eq 'off' );
1048:
1049: my $width = 620;
1050: my $height = 600;
1.430 albertel 1051: my $helptopic=&general_help();
1052: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1053: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1054: my $start_page =
1055: &Apache::loncommon::start_page('Help Menu', undef,
1056: {'frameset' => 1,
1057: 'js_ready' => 1,
1058: 'add_entries' => {
1059: 'border' => '0',
1.579 raeburn 1060: 'rows' => "110,*",},});
1.331 albertel 1061: my $end_page =
1062: &Apache::loncommon::end_page({'frameset' => 1,
1063: 'js_ready' => 1,});
1064:
1.436 albertel 1065: my $template .= <<"ENDTEMPLATE";
1066: <script type="text/javascript">
1.253 albertel 1067: // <!-- BEGIN LON-CAPA Internal
1068: // <![CDATA[
1.430 albertel 1069: var banner_link = '';
1.243 raeburn 1070: function helpMenu(target) {
1071: var caller = this;
1072: if (target == 'open') {
1073: var newWindow = null;
1074: try {
1.262 albertel 1075: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1076: }
1077: catch(error) {
1078: writeHelp(caller);
1079: return;
1080: }
1081: if (newWindow) {
1082: caller = newWindow;
1083: }
1.193 raeburn 1084: }
1.243 raeburn 1085: writeHelp(caller);
1086: return;
1087: }
1088: function writeHelp(caller) {
1.430 albertel 1089: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1090: caller.document.close()
1091: caller.focus()
1.193 raeburn 1092: }
1.253 albertel 1093: // ]]>
1.219 albertel 1094: // END LON-CAPA Internal -->
1.436 albertel 1095: </script>
1.193 raeburn 1096: ENDTEMPLATE
1097: return $template;
1098: }
1099:
1.172 www 1100: sub help_open_bug {
1101: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1102: unless ($env{'user.adv'}) { return ''; }
1.172 www 1103: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1104: $text = "" if (not defined $text);
1105: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1106: if ($env{'browser.interface'} eq 'textual' ||
1107: $env{'environment.remote'} eq 'off' ) {
1.172 www 1108: $stayOnPage=1;
1109: }
1.184 albertel 1110: $width = 600 if (not defined $width);
1111: $height = 600 if (not defined $height);
1.172 www 1112:
1113: $topic=~s/\W+/\+/g;
1114: my $link='';
1115: my $template='';
1.379 albertel 1116: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1117: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1118: if (!$stayOnPage)
1119: {
1120: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1121: }
1122: else
1123: {
1124: $link = $url;
1125: }
1126: # Add the text
1127: if ($text ne "")
1128: {
1129: $template .=
1130: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 ! tempelho 1131: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1132: }
1133:
1134: # Add the graphic
1.179 matthew 1135: my $title = &mt('Report a Bug');
1.215 albertel 1136: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1137: $template .= <<"ENDTEMPLATE";
1.436 albertel 1138: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1139: ENDTEMPLATE
1140: if ($text ne '') { $template.='</td></tr></table>' };
1141: return $template;
1142:
1143: }
1144:
1145: sub help_open_faq {
1146: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1147: unless ($env{'user.adv'}) { return ''; }
1.172 www 1148: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1149: $text = "" if (not defined $text);
1150: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1151: if ($env{'browser.interface'} eq 'textual' ||
1152: $env{'environment.remote'} eq 'off' ) {
1.172 www 1153: $stayOnPage=1;
1154: }
1155: $width = 350 if (not defined $width);
1156: $height = 400 if (not defined $height);
1157:
1158: $topic=~s/\W+/\+/g;
1159: my $link='';
1160: my $template='';
1161: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1162: if (!$stayOnPage)
1163: {
1164: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1165: }
1166: else
1167: {
1168: $link = $url;
1169: }
1170:
1171: # Add the text
1172: if ($text ne "")
1173: {
1174: $template .=
1.173 www 1175: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 ! tempelho 1176: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1177: }
1178:
1179: # Add the graphic
1.179 matthew 1180: my $title = &mt('View the FAQ');
1.215 albertel 1181: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1182: $template .= <<"ENDTEMPLATE";
1.436 albertel 1183: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1184: ENDTEMPLATE
1185: if ($text ne '') { $template.='</td></tr></table>' };
1186: return $template;
1187:
1.44 bowersj2 1188: }
1.37 matthew 1189:
1.180 matthew 1190: ###############################################################
1191: ###############################################################
1192:
1.45 matthew 1193: =pod
1194:
1.648 raeburn 1195: =item * &change_content_javascript():
1.256 matthew 1196:
1197: This and the next function allow you to create small sections of an
1198: otherwise static HTML page that you can update on the fly with
1199: Javascript, even in Netscape 4.
1200:
1201: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1202: must be written to the HTML page once. It will prove the Javascript
1203: function "change(name, content)". Calling the change function with the
1204: name of the section
1205: you want to update, matching the name passed to C<changable_area>, and
1206: the new content you want to put in there, will put the content into
1207: that area.
1208:
1209: B<Note>: Netscape 4 only reserves enough space for the changable area
1210: to contain room for the original contents. You need to "make space"
1211: for whatever changes you wish to make, and be B<sure> to check your
1212: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1213: it's adequate for updating a one-line status display, but little more.
1214: This script will set the space to 100% width, so you only need to
1215: worry about height in Netscape 4.
1216:
1217: Modern browsers are much less limiting, and if you can commit to the
1218: user not using Netscape 4, this feature may be used freely with
1219: pretty much any HTML.
1220:
1221: =cut
1222:
1223: sub change_content_javascript {
1224: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1225: if ($env{'browser.type'} eq 'netscape' &&
1226: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1227: return (<<NETSCAPE4);
1228: function change(name, content) {
1229: doc = document.layers[name+"___escape"].layers[0].document;
1230: doc.open();
1231: doc.write(content);
1232: doc.close();
1233: }
1234: NETSCAPE4
1235: } else {
1236: # Otherwise, we need to use semi-standards-compliant code
1237: # (technically, "innerHTML" isn't standard but the equivalent
1238: # is really scary, and every useful browser supports it
1239: return (<<DOMBASED);
1240: function change(name, content) {
1241: element = document.getElementById(name);
1242: element.innerHTML = content;
1243: }
1244: DOMBASED
1245: }
1246: }
1247:
1248: =pod
1249:
1.648 raeburn 1250: =item * &changable_area($name,$origContent):
1.256 matthew 1251:
1252: This provides a "changable area" that can be modified on the fly via
1253: the Javascript code provided in C<change_content_javascript>. $name is
1254: the name you will use to reference the area later; do not repeat the
1255: same name on a given HTML page more then once. $origContent is what
1256: the area will originally contain, which can be left blank.
1257:
1258: =cut
1259:
1260: sub changable_area {
1261: my ($name, $origContent) = @_;
1262:
1.258 albertel 1263: if ($env{'browser.type'} eq 'netscape' &&
1264: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1265: # If this is netscape 4, we need to use the Layer tag
1266: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1267: } else {
1268: return "<span id='$name'>$origContent</span>";
1269: }
1270: }
1271:
1272: =pod
1273:
1.648 raeburn 1274: =item * &viewport_geometry_js
1.590 raeburn 1275:
1276: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1277:
1278: =cut
1279:
1280:
1281: sub viewport_geometry_js {
1282: return <<"GEOMETRY";
1283: var Geometry = {};
1284: function init_geometry() {
1285: if (Geometry.init) { return };
1286: Geometry.init=1;
1287: if (window.innerHeight) {
1288: Geometry.getViewportHeight = function() { return window.innerHeight; };
1289: Geometry.getViewportWidth = function() { return window.innerWidth; };
1290: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1291: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1292: }
1293: else if (document.documentElement && document.documentElement.clientHeight) {
1294: Geometry.getViewportHeight =
1295: function() { return document.documentElement.clientHeight; };
1296: Geometry.getViewportWidth =
1297: function() { return document.documentElement.clientWidth; };
1298:
1299: Geometry.getHorizontalScroll =
1300: function() { return document.documentElement.scrollLeft; };
1301: Geometry.getVerticalScroll =
1302: function() { return document.documentElement.scrollTop; };
1303: }
1304: else if (document.body.clientHeight) {
1305: Geometry.getViewportHeight =
1306: function() { return document.body.clientHeight; };
1307: Geometry.getViewportWidth =
1308: function() { return document.body.clientWidth; };
1309: Geometry.getHorizontalScroll =
1310: function() { return document.body.scrollLeft; };
1311: Geometry.getVerticalScroll =
1312: function() { return document.body.scrollTop; };
1313: }
1314: }
1315:
1316: GEOMETRY
1317: }
1318:
1319: =pod
1320:
1.648 raeburn 1321: =item * &viewport_size_js()
1.590 raeburn 1322:
1323: 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.
1324:
1325: =cut
1326:
1327: sub viewport_size_js {
1328: my $geometry = &viewport_geometry_js();
1329: return <<"DIMS";
1330:
1331: $geometry
1332:
1333: function getViewportDims(width,height) {
1334: init_geometry();
1335: width.value = Geometry.getViewportWidth();
1336: height.value = Geometry.getViewportHeight();
1337: return;
1338: }
1339:
1340: DIMS
1341: }
1342:
1343: =pod
1344:
1.648 raeburn 1345: =item * &resize_textarea_js()
1.565 albertel 1346:
1347: emits the needed javascript to resize a textarea to be as big as possible
1348:
1349: creates a function resize_textrea that takes two IDs first should be
1350: the id of the element to resize, second should be the id of a div that
1351: surrounds everything that comes after the textarea, this routine needs
1352: to be attached to the <body> for the onload and onresize events.
1353:
1.648 raeburn 1354: =back
1.565 albertel 1355:
1356: =cut
1357:
1358: sub resize_textarea_js {
1.590 raeburn 1359: my $geometry = &viewport_geometry_js();
1.565 albertel 1360: return <<"RESIZE";
1361: <script type="text/javascript">
1.590 raeburn 1362: $geometry
1.565 albertel 1363:
1.588 albertel 1364: function getX(element) {
1365: var x = 0;
1366: while (element) {
1367: x += element.offsetLeft;
1368: element = element.offsetParent;
1369: }
1370: return x;
1371: }
1372: function getY(element) {
1373: var y = 0;
1374: while (element) {
1375: y += element.offsetTop;
1376: element = element.offsetParent;
1377: }
1378: return y;
1379: }
1380:
1381:
1.565 albertel 1382: function resize_textarea(textarea_id,bottom_id) {
1383: init_geometry();
1384: var textarea = document.getElementById(textarea_id);
1385: //alert(textarea);
1386:
1.588 albertel 1387: var textarea_top = getY(textarea);
1.565 albertel 1388: var textarea_height = textarea.offsetHeight;
1389: var bottom = document.getElementById(bottom_id);
1.588 albertel 1390: var bottom_top = getY(bottom);
1.565 albertel 1391: var bottom_height = bottom.offsetHeight;
1392: var window_height = Geometry.getViewportHeight();
1.588 albertel 1393: var fudge = 23;
1.565 albertel 1394: var new_height = window_height-fudge-textarea_top-bottom_height;
1395: if (new_height < 300) {
1396: new_height = 300;
1397: }
1398: textarea.style.height=new_height+'px';
1399: }
1400: </script>
1401: RESIZE
1402:
1403: }
1404:
1405: =pod
1406:
1.256 matthew 1407: =head1 Excel and CSV file utility routines
1408:
1409: =over 4
1410:
1411: =cut
1412:
1413: ###############################################################
1414: ###############################################################
1415:
1416: =pod
1417:
1.648 raeburn 1418: =item * &csv_translate($text)
1.37 matthew 1419:
1.185 www 1420: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1421: format.
1422:
1423: =cut
1424:
1.180 matthew 1425: ###############################################################
1426: ###############################################################
1.37 matthew 1427: sub csv_translate {
1428: my $text = shift;
1429: $text =~ s/\"/\"\"/g;
1.209 albertel 1430: $text =~ s/\n/ /g;
1.37 matthew 1431: return $text;
1432: }
1.180 matthew 1433:
1434: ###############################################################
1435: ###############################################################
1436:
1437: =pod
1438:
1.648 raeburn 1439: =item * &define_excel_formats()
1.180 matthew 1440:
1441: Define some commonly used Excel cell formats.
1442:
1443: Currently supported formats:
1444:
1445: =over 4
1446:
1447: =item header
1448:
1449: =item bold
1450:
1451: =item h1
1452:
1453: =item h2
1454:
1455: =item h3
1456:
1.256 matthew 1457: =item h4
1458:
1459: =item i
1460:
1.180 matthew 1461: =item date
1462:
1463: =back
1464:
1465: Inputs: $workbook
1466:
1467: Returns: $format, a hash reference.
1468:
1469: =cut
1470:
1471: ###############################################################
1472: ###############################################################
1473: sub define_excel_formats {
1474: my ($workbook) = @_;
1475: my $format;
1476: $format->{'header'} = $workbook->add_format(bold => 1,
1477: bottom => 1,
1478: align => 'center');
1479: $format->{'bold'} = $workbook->add_format(bold=>1);
1480: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1481: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1482: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1483: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1484: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1485: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1486: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1487: return $format;
1488: }
1489:
1490: ###############################################################
1491: ###############################################################
1.113 bowersj2 1492:
1493: =pod
1494:
1.648 raeburn 1495: =item * &create_workbook()
1.255 matthew 1496:
1497: Create an Excel worksheet. If it fails, output message on the
1498: request object and return undefs.
1499:
1500: Inputs: Apache request object
1501:
1502: Returns (undef) on failure,
1503: Excel worksheet object, scalar with filename, and formats
1504: from &Apache::loncommon::define_excel_formats on success
1505:
1506: =cut
1507:
1508: ###############################################################
1509: ###############################################################
1510: sub create_workbook {
1511: my ($r) = @_;
1512: #
1513: # Create the excel spreadsheet
1514: my $filename = '/prtspool/'.
1.258 albertel 1515: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1516: time.'_'.rand(1000000000).'.xls';
1517: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1518: if (! defined($workbook)) {
1519: $r->log_error("Error creating excel spreadsheet $filename: $!");
1520: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1521: "This error has been logged. ".
1522: "Please alert your LON-CAPA administrator").
1523: '</p>');
1524: return (undef);
1525: }
1526: #
1527: $workbook->set_tempdir('/home/httpd/perl/tmp');
1528: #
1529: my $format = &Apache::loncommon::define_excel_formats($workbook);
1530: return ($workbook,$filename,$format);
1531: }
1532:
1533: ###############################################################
1534: ###############################################################
1535:
1536: =pod
1537:
1.648 raeburn 1538: =item * &create_text_file()
1.113 bowersj2 1539:
1.542 raeburn 1540: Create a file to write to and eventually make available to the user.
1.256 matthew 1541: If file creation fails, outputs an error message on the request object and
1542: return undefs.
1.113 bowersj2 1543:
1.256 matthew 1544: Inputs: Apache request object, and file suffix
1.113 bowersj2 1545:
1.256 matthew 1546: Returns (undef) on failure,
1547: Filehandle and filename on success.
1.113 bowersj2 1548:
1549: =cut
1550:
1.256 matthew 1551: ###############################################################
1552: ###############################################################
1553: sub create_text_file {
1554: my ($r,$suffix) = @_;
1555: if (! defined($suffix)) { $suffix = 'txt'; };
1556: my $fh;
1557: my $filename = '/prtspool/'.
1.258 albertel 1558: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1559: time.'_'.rand(1000000000).'.'.$suffix;
1560: $fh = Apache::File->new('>/home/httpd'.$filename);
1561: if (! defined($fh)) {
1562: $r->log_error("Couldn't open $filename for output $!");
1.683 bisitz 1563: $r->print(&mt('Problems occurred in creating the output file. '
1564: .'This error has been logged. '
1565: .'Please alert your LON-CAPA administrator.'));
1.113 bowersj2 1566: }
1.256 matthew 1567: return ($fh,$filename)
1.113 bowersj2 1568: }
1569:
1570:
1.256 matthew 1571: =pod
1.113 bowersj2 1572:
1573: =back
1574:
1575: =cut
1.37 matthew 1576:
1577: ###############################################################
1.33 matthew 1578: ## Home server <option> list generating code ##
1579: ###############################################################
1.35 matthew 1580:
1.169 www 1581: # ------------------------------------------
1582:
1583: sub domain_select {
1584: my ($name,$value,$multiple)=@_;
1585: my %domains=map {
1.514 albertel 1586: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1587: } &Apache::lonnet::all_domains();
1.169 www 1588: if ($multiple) {
1589: $domains{''}=&mt('Any domain');
1.550 albertel 1590: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1591: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1592: } else {
1.550 albertel 1593: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1594: return &select_form($name,$value,%domains);
1595: }
1596: }
1597:
1.282 albertel 1598: #-------------------------------------------
1599:
1600: =pod
1601:
1.519 raeburn 1602: =head1 Routines for form select boxes
1603:
1604: =over 4
1605:
1.648 raeburn 1606: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1607:
1608: Returns a string containing a <select> element int multiple mode
1609:
1610:
1611: Args:
1612: $name - name of the <select> element
1.506 raeburn 1613: $value - scalar or array ref of values that should already be selected
1.282 albertel 1614: $size - number of rows long the select element is
1.283 albertel 1615: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1616: (shown text should already have been &mt())
1.506 raeburn 1617: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1618:
1.282 albertel 1619: =cut
1620:
1621: #-------------------------------------------
1.169 www 1622: sub multiple_select_form {
1.284 albertel 1623: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1624: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1625: my $output='';
1.191 matthew 1626: if (! defined($size)) {
1627: $size = 4;
1.283 albertel 1628: if (scalar(keys(%$hash))<4) {
1629: $size = scalar(keys(%$hash));
1.191 matthew 1630: }
1631: }
1.169 www 1632: $output.="\n<select name='$name' size='$size' multiple='1'>";
1.501 banghart 1633: my @order;
1.506 raeburn 1634: if (ref($order) eq 'ARRAY') {
1635: @order = @{$order};
1636: } else {
1637: @order = sort(keys(%$hash));
1.501 banghart 1638: }
1639: if (exists($$hash{'select_form_order'})) {
1640: @order = @{$$hash{'select_form_order'}};
1641: }
1642:
1.284 albertel 1643: foreach my $key (@order) {
1.356 albertel 1644: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1645: $output.='selected="selected" ' if ($selected{$key});
1646: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1647: }
1648: $output.="</select>\n";
1649: return $output;
1650: }
1651:
1.88 www 1652: #-------------------------------------------
1653:
1654: =pod
1655:
1.648 raeburn 1656: =item * &select_form($defdom,$name,%hash)
1.88 www 1657:
1658: Returns a string containing a <select name='$name' size='1'> form to
1659: allow a user to select options from a hash option_name => displayed text.
1660: See lonrights.pm for an example invocation and use.
1661:
1662: =cut
1663:
1664: #-------------------------------------------
1665: sub select_form {
1666: my ($def,$name,%hash) = @_;
1667: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1668: my @keys;
1669: if (exists($hash{'select_form_order'})) {
1670: @keys=@{$hash{'select_form_order'}};
1671: } else {
1672: @keys=sort(keys(%hash));
1673: }
1.356 albertel 1674: foreach my $key (@keys) {
1675: $selectform.=
1676: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1677: ($key eq $def ? 'selected="selected" ' : '').
1678: ">".&mt($hash{$key})."</option>\n";
1.88 www 1679: }
1680: $selectform.="</select>";
1681: return $selectform;
1682: }
1683:
1.475 www 1684: # For display filters
1685:
1686: sub display_filter {
1687: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1688: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.475 www 1689: return '<nobr><label>'.&mt('Records [_1]',
1690: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1691: (&mt('all'),10,20,50,100,1000,10000))).
1.478 www 1692: '</label></nobr> <nobr>'.
1.475 www 1693: &mt('Filter [_1]',
1.477 www 1694: &select_form($env{'form.displayfilter'},
1695: 'displayfilter',
1696: ('currentfolder' => 'Current folder/page',
1697: 'containing' => 'Containing phrase',
1698: 'none' => 'None'))).
1.478 www 1699: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></nobr>';
1.475 www 1700: }
1701:
1.167 www 1702: sub gradeleveldescription {
1703: my $gradelevel=shift;
1704: my %gradelevels=(0 => 'Not specified',
1705: 1 => 'Grade 1',
1706: 2 => 'Grade 2',
1707: 3 => 'Grade 3',
1708: 4 => 'Grade 4',
1709: 5 => 'Grade 5',
1710: 6 => 'Grade 6',
1711: 7 => 'Grade 7',
1712: 8 => 'Grade 8',
1713: 9 => 'Grade 9',
1714: 10 => 'Grade 10',
1715: 11 => 'Grade 11',
1716: 12 => 'Grade 12',
1717: 13 => 'Grade 13',
1718: 14 => '100 Level',
1719: 15 => '200 Level',
1720: 16 => '300 Level',
1721: 17 => '400 Level',
1722: 18 => 'Graduate Level');
1723: return &mt($gradelevels{$gradelevel});
1724: }
1725:
1.163 www 1726: sub select_level_form {
1727: my ($deflevel,$name)=@_;
1728: unless ($deflevel) { $deflevel=0; }
1.167 www 1729: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1730: for (my $i=0; $i<=18; $i++) {
1731: $selectform.="<option value=\"$i\" ".
1.253 albertel 1732: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1733: ">".&gradeleveldescription($i)."</option>\n";
1734: }
1735: $selectform.="</select>";
1736: return $selectform;
1.163 www 1737: }
1.167 www 1738:
1.35 matthew 1739: #-------------------------------------------
1740:
1.45 matthew 1741: =pod
1742:
1.648 raeburn 1743: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc)
1.35 matthew 1744:
1745: Returns a string containing a <select name='$name' size='1'> form to
1746: allow a user to select the domain to preform an operation in.
1747: See loncreateuser.pm for an example invocation and use.
1748:
1.90 www 1749: If the $includeempty flag is set, it also includes an empty choice ("no domain
1750: selected");
1751:
1.563 raeburn 1752: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1753:
1.35 matthew 1754: =cut
1755:
1756: #-------------------------------------------
1.34 matthew 1757: sub select_dom_form {
1.563 raeburn 1758: my ($defdom,$name,$includeempty,$showdomdesc) = @_;
1.550 albertel 1759: my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90 www 1760: if ($includeempty) { @domains=('',@domains); }
1.34 matthew 1761: my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
1.356 albertel 1762: foreach my $dom (@domains) {
1763: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1764: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1765: if ($showdomdesc) {
1766: if ($dom ne '') {
1767: my $domdesc = &Apache::lonnet::domain($dom,'description');
1768: if ($domdesc ne '') {
1769: $selectdomain .= ' ('.$domdesc.')';
1770: }
1771: }
1772: }
1773: $selectdomain .= "</option>\n";
1.34 matthew 1774: }
1775: $selectdomain.="</select>";
1776: return $selectdomain;
1777: }
1778:
1.35 matthew 1779: #-------------------------------------------
1780:
1.45 matthew 1781: =pod
1782:
1.648 raeburn 1783: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1784:
1.586 raeburn 1785: input: 4 arguments (two required, two optional) -
1786: $domain - domain of new user
1787: $name - name of form element
1788: $default - Value of 'default' causes a default item to be first
1789: option, and selected by default.
1790: $hide - Value of 'hide' causes hiding of the name of the server,
1791: if 1 server found, or default, if 0 found.
1.594 raeburn 1792: output: returns 2 items:
1.586 raeburn 1793: (a) form element which contains either:
1794: (i) <select name="$name">
1795: <option value="$hostid1">$hostid $servers{$hostid}</option>
1796: <option value="$hostid2">$hostid $servers{$hostid}</option>
1797: </select>
1798: form item if there are multiple library servers in $domain, or
1799: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
1800: if there is only one library server in $domain.
1801:
1802: (b) number of library servers found.
1803:
1804: See loncreateuser.pm for example of use.
1.35 matthew 1805:
1806: =cut
1807:
1808: #-------------------------------------------
1.586 raeburn 1809: sub home_server_form_item {
1810: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 1811: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 1812: my $result;
1813: my $numlib = keys(%servers);
1814: if ($numlib > 1) {
1815: $result .= '<select name="'.$name.'" />'."\n";
1816: if ($default) {
1817: $result .= '<option value="default" selected>'.&mt('default').
1818: '</option>'."\n";
1819: }
1820: foreach my $hostid (sort(keys(%servers))) {
1821: $result.= '<option value="'.$hostid.'">'.
1822: $hostid.' '.$servers{$hostid}."</option>\n";
1823: }
1824: $result .= '</select>'."\n";
1825: } elsif ($numlib == 1) {
1826: my $hostid;
1827: foreach my $item (keys(%servers)) {
1828: $hostid = $item;
1829: }
1830: $result .= '<input type="hidden" name="'.$name.'" value="'.
1831: $hostid.'" />';
1832: if (!$hide) {
1833: $result .= $hostid.' '.$servers{$hostid};
1834: }
1835: $result .= "\n";
1836: } elsif ($default) {
1837: $result .= '<input type="hidden" name="'.$name.
1838: '" value="default" />';
1839: if (!$hide) {
1840: $result .= &mt('default');
1841: }
1842: $result .= "\n";
1.33 matthew 1843: }
1.586 raeburn 1844: return ($result,$numlib);
1.33 matthew 1845: }
1.112 bowersj2 1846:
1847: =pod
1848:
1.534 albertel 1849: =back
1850:
1.112 bowersj2 1851: =cut
1.87 matthew 1852:
1853: ###############################################################
1.112 bowersj2 1854: ## Decoding User Agent ##
1.87 matthew 1855: ###############################################################
1856:
1857: =pod
1858:
1.112 bowersj2 1859: =head1 Decoding the User Agent
1860:
1861: =over 4
1862:
1863: =item * &decode_user_agent()
1.87 matthew 1864:
1865: Inputs: $r
1866:
1867: Outputs:
1868:
1869: =over 4
1870:
1.112 bowersj2 1871: =item * $httpbrowser
1.87 matthew 1872:
1.112 bowersj2 1873: =item * $clientbrowser
1.87 matthew 1874:
1.112 bowersj2 1875: =item * $clientversion
1.87 matthew 1876:
1.112 bowersj2 1877: =item * $clientmathml
1.87 matthew 1878:
1.112 bowersj2 1879: =item * $clientunicode
1.87 matthew 1880:
1.112 bowersj2 1881: =item * $clientos
1.87 matthew 1882:
1883: =back
1884:
1.157 matthew 1885: =back
1886:
1.87 matthew 1887: =cut
1888:
1889: ###############################################################
1890: ###############################################################
1891: sub decode_user_agent {
1.247 albertel 1892: my ($r)=@_;
1.87 matthew 1893: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
1894: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
1895: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 1896: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 1897: my $clientbrowser='unknown';
1898: my $clientversion='0';
1899: my $clientmathml='';
1900: my $clientunicode='0';
1901: for (my $i=0;$i<=$#browsertype;$i++) {
1902: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
1903: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
1904: $clientbrowser=$bname;
1905: $httpbrowser=~/$vreg/i;
1906: $clientversion=$1;
1907: $clientmathml=($clientversion>=$minv);
1908: $clientunicode=($clientversion>=$univ);
1909: }
1910: }
1911: my $clientos='unknown';
1912: if (($httpbrowser=~/linux/i) ||
1913: ($httpbrowser=~/unix/i) ||
1914: ($httpbrowser=~/ux/i) ||
1915: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
1916: if (($httpbrowser=~/vax/i) ||
1917: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
1918: if ($httpbrowser=~/next/i) { $clientos='next'; }
1919: if (($httpbrowser=~/mac/i) ||
1920: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1921: if ($httpbrowser=~/win/i) { $clientos='win'; }
1922: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1923: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1924: $clientunicode,$clientos,);
1925: }
1926:
1.32 matthew 1927: ###############################################################
1928: ## Authentication changing form generation subroutines ##
1929: ###############################################################
1930: ##
1931: ## All of the authform_xxxxxxx subroutines take their inputs in a
1932: ## hash, and have reasonable default values.
1933: ##
1934: ## formname = the name given in the <form> tag.
1.35 matthew 1935: #-------------------------------------------
1936:
1.45 matthew 1937: =pod
1938:
1.112 bowersj2 1939: =head1 Authentication Routines
1940:
1941: =over 4
1942:
1.648 raeburn 1943: =item * &authform_xxxxxx()
1.35 matthew 1944:
1945: The authform_xxxxxx subroutines provide javascript and html forms which
1946: handle some of the conveniences required for authentication forms.
1947: This is not an optimal method, but it works.
1948:
1949: =over 4
1950:
1.112 bowersj2 1951: =item * authform_header
1.35 matthew 1952:
1.112 bowersj2 1953: =item * authform_authorwarning
1.35 matthew 1954:
1.112 bowersj2 1955: =item * authform_nochange
1.35 matthew 1956:
1.112 bowersj2 1957: =item * authform_kerberos
1.35 matthew 1958:
1.112 bowersj2 1959: =item * authform_internal
1.35 matthew 1960:
1.112 bowersj2 1961: =item * authform_filesystem
1.35 matthew 1962:
1963: =back
1964:
1.648 raeburn 1965: See loncreateuser.pm for invocation and use examples.
1.157 matthew 1966:
1.35 matthew 1967: =cut
1968:
1969: #-------------------------------------------
1.32 matthew 1970: sub authform_header{
1971: my %in = (
1972: formname => 'cu',
1.80 albertel 1973: kerb_def_dom => '',
1.32 matthew 1974: @_,
1975: );
1976: $in{'formname'} = 'document.' . $in{'formname'};
1977: my $result='';
1.80 albertel 1978:
1979: #---------------------------------------------- Code for upper case translation
1980: my $Javascript_toUpperCase;
1981: unless ($in{kerb_def_dom}) {
1982: $Javascript_toUpperCase =<<"END";
1983: switch (choice) {
1984: case 'krb': currentform.elements[choicearg].value =
1985: currentform.elements[choicearg].value.toUpperCase();
1986: break;
1987: default:
1988: }
1989: END
1990: } else {
1991: $Javascript_toUpperCase = "";
1992: }
1993:
1.165 raeburn 1994: my $radioval = "'nochange'";
1.591 raeburn 1995: if (defined($in{'curr_authtype'})) {
1996: if ($in{'curr_authtype'} ne '') {
1997: $radioval = "'".$in{'curr_authtype'}."arg'";
1998: }
1.174 matthew 1999: }
1.165 raeburn 2000: my $argfield = 'null';
1.591 raeburn 2001: if (defined($in{'mode'})) {
1.165 raeburn 2002: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2003: if (defined($in{'curr_autharg'})) {
2004: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2005: $argfield = "'$in{'curr_autharg'}'";
2006: }
2007: }
2008: }
2009: }
2010:
1.32 matthew 2011: $result.=<<"END";
2012: var current = new Object();
1.165 raeburn 2013: current.radiovalue = $radioval;
2014: current.argfield = $argfield;
1.32 matthew 2015:
2016: function changed_radio(choice,currentform) {
2017: var choicearg = choice + 'arg';
2018: // If a radio button in changed, we need to change the argfield
2019: if (current.radiovalue != choice) {
2020: current.radiovalue = choice;
2021: if (current.argfield != null) {
2022: currentform.elements[current.argfield].value = '';
2023: }
2024: if (choice == 'nochange') {
2025: current.argfield = null;
2026: } else {
2027: current.argfield = choicearg;
2028: switch(choice) {
2029: case 'krb':
2030: currentform.elements[current.argfield].value =
2031: "$in{'kerb_def_dom'}";
2032: break;
2033: default:
2034: break;
2035: }
2036: }
2037: }
2038: return;
2039: }
1.22 www 2040:
1.32 matthew 2041: function changed_text(choice,currentform) {
2042: var choicearg = choice + 'arg';
2043: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2044: $Javascript_toUpperCase
1.32 matthew 2045: // clear old field
2046: if ((current.argfield != choicearg) && (current.argfield != null)) {
2047: currentform.elements[current.argfield].value = '';
2048: }
2049: current.argfield = choicearg;
2050: }
2051: set_auth_radio_buttons(choice,currentform);
2052: return;
1.20 www 2053: }
1.32 matthew 2054:
2055: function set_auth_radio_buttons(newvalue,currentform) {
2056: var i=0;
2057: while (i < currentform.login.length) {
2058: if (currentform.login[i].value == newvalue) { break; }
2059: i++;
2060: }
2061: if (i == currentform.login.length) {
2062: return;
2063: }
2064: current.radiovalue = newvalue;
2065: currentform.login[i].checked = true;
2066: return;
2067: }
2068: END
2069: return $result;
2070: }
2071:
2072: sub authform_authorwarning{
2073: my $result='';
1.144 matthew 2074: $result='<i>'.
2075: &mt('As a general rule, only authors or co-authors should be '.
2076: 'filesystem authenticated '.
2077: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2078: return $result;
2079: }
2080:
2081: sub authform_nochange{
2082: my %in = (
2083: formname => 'document.cu',
2084: kerb_def_dom => 'MSU.EDU',
2085: @_,
2086: );
1.586 raeburn 2087: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2088: my $result;
2089: if (keys(%can_assign) == 0) {
2090: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2091: } else {
2092: $result = '<label>'.&mt('[_1] Do not change login data',
2093: '<input type="radio" name="login" value="nochange" '.
2094: 'checked="checked" onclick="'.
1.281 albertel 2095: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2096: '</label>';
1.586 raeburn 2097: }
1.32 matthew 2098: return $result;
2099: }
2100:
1.591 raeburn 2101: sub authform_kerberos {
1.32 matthew 2102: my %in = (
2103: formname => 'document.cu',
2104: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2105: kerb_def_auth => 'krb4',
1.32 matthew 2106: @_,
2107: );
1.586 raeburn 2108: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2109: $autharg,$jscall);
2110: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2111: if ($in{'kerb_def_auth'} eq 'krb5') {
1.586 raeburn 2112: $check5 = ' checked="on"';
1.80 albertel 2113: } else {
1.586 raeburn 2114: $check4 = ' checked="on"';
1.80 albertel 2115: }
1.165 raeburn 2116: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2117: if (defined($in{'curr_authtype'})) {
2118: if ($in{'curr_authtype'} eq 'krb') {
1.586 raeburn 2119: $krbcheck = ' checked="on"';
1.623 raeburn 2120: if (defined($in{'mode'})) {
2121: if ($in{'mode'} eq 'modifyuser') {
2122: $krbcheck = '';
2123: }
2124: }
1.591 raeburn 2125: if (defined($in{'curr_kerb_ver'})) {
2126: if ($in{'curr_krb_ver'} eq '5') {
2127: $check5 = ' checked="on"';
2128: $check4 = '';
2129: } else {
2130: $check4 = ' checked="on"';
2131: $check5 = '';
2132: }
1.586 raeburn 2133: }
1.591 raeburn 2134: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2135: $krbarg = $in{'curr_autharg'};
2136: }
1.586 raeburn 2137: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2138: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2139: $result =
2140: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2141: $in{'curr_autharg'},$krbver);
2142: } else {
2143: $result =
2144: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2145: }
2146: return $result;
2147: }
2148: }
2149: } else {
2150: if ($authnum == 1) {
2151: $authtype = '<input type="hidden" name="login" value="krb">';
1.165 raeburn 2152: }
2153: }
1.586 raeburn 2154: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2155: return;
1.587 raeburn 2156: } elsif ($authtype eq '') {
1.591 raeburn 2157: if (defined($in{'mode'})) {
1.587 raeburn 2158: if ($in{'mode'} eq 'modifycourse') {
2159: if ($authnum == 1) {
2160: $authtype = '<input type="hidden" name="login" value="krb">';
2161: }
2162: }
2163: }
1.586 raeburn 2164: }
2165: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2166: if ($authtype eq '') {
2167: $authtype = '<input type="radio" name="login" value="krb" '.
2168: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2169: $krbcheck.' />';
2170: }
2171: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2172: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2173: $in{'curr_authtype'} eq 'krb5') ||
2174: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2175: $in{'curr_authtype'} eq 'krb4')) {
2176: $result .= &mt
1.144 matthew 2177: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2178: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2179: '<label>'.$authtype,
1.281 albertel 2180: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2181: 'value="'.$krbarg.'" '.
1.144 matthew 2182: 'onchange="'.$jscall.'" />',
1.281 albertel 2183: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2184: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2185: '</label>');
1.586 raeburn 2186: } elsif ($can_assign{'krb4'}) {
2187: $result .= &mt
2188: ('[_1] Kerberos authenticated with domain [_2] '.
2189: '[_3] Version 4 [_4]',
2190: '<label>'.$authtype,
2191: '</label><input type="text" size="10" name="krbarg" '.
2192: 'value="'.$krbarg.'" '.
2193: 'onchange="'.$jscall.'" />',
2194: '<label><input type="hidden" name="krbver" value="4" />',
2195: '</label>');
2196: } elsif ($can_assign{'krb5'}) {
2197: $result .= &mt
2198: ('[_1] Kerberos authenticated with domain [_2] '.
2199: '[_3] Version 5 [_4]',
2200: '<label>'.$authtype,
2201: '</label><input type="text" size="10" name="krbarg" '.
2202: 'value="'.$krbarg.'" '.
2203: 'onchange="'.$jscall.'" />',
2204: '<label><input type="hidden" name="krbver" value="5" />',
2205: '</label>');
2206: }
1.32 matthew 2207: return $result;
2208: }
2209:
2210: sub authform_internal{
1.586 raeburn 2211: my %in = (
1.32 matthew 2212: formname => 'document.cu',
2213: kerb_def_dom => 'MSU.EDU',
2214: @_,
2215: );
1.586 raeburn 2216: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2217: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2218: if (defined($in{'curr_authtype'})) {
2219: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2220: if ($can_assign{'int'}) {
2221: $intcheck = 'checked="on" ';
1.623 raeburn 2222: if (defined($in{'mode'})) {
2223: if ($in{'mode'} eq 'modifyuser') {
2224: $intcheck = '';
2225: }
2226: }
1.591 raeburn 2227: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2228: $intarg = $in{'curr_autharg'};
2229: }
2230: } else {
2231: $result = &mt('Currently internally authenticated.');
2232: return $result;
1.165 raeburn 2233: }
2234: }
1.586 raeburn 2235: } else {
2236: if ($authnum == 1) {
2237: $authtype = '<input type="hidden" name="login" value="int">';
2238: }
2239: }
2240: if (!$can_assign{'int'}) {
2241: return;
1.587 raeburn 2242: } elsif ($authtype eq '') {
1.591 raeburn 2243: if (defined($in{'mode'})) {
1.587 raeburn 2244: if ($in{'mode'} eq 'modifycourse') {
2245: if ($authnum == 1) {
2246: $authtype = '<input type="hidden" name="login" value="int">';
2247: }
2248: }
2249: }
1.165 raeburn 2250: }
1.586 raeburn 2251: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2252: if ($authtype eq '') {
2253: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2254: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2255: }
1.605 bisitz 2256: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2257: $intarg.'" onchange="'.$jscall.'" />';
2258: $result = &mt
1.144 matthew 2259: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2260: '<label>'.$authtype,'</label>'.$autharg);
1.620 www 2261: $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 2262: return $result;
2263: }
2264:
2265: sub authform_local{
2266: my %in = (
2267: formname => 'document.cu',
2268: kerb_def_dom => 'MSU.EDU',
2269: @_,
2270: );
1.586 raeburn 2271: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2272: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2273: if (defined($in{'curr_authtype'})) {
2274: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2275: if ($can_assign{'loc'}) {
2276: $loccheck = 'checked="on" ';
1.623 raeburn 2277: if (defined($in{'mode'})) {
2278: if ($in{'mode'} eq 'modifyuser') {
2279: $loccheck = '';
2280: }
2281: }
1.591 raeburn 2282: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2283: $locarg = $in{'curr_autharg'};
2284: }
2285: } else {
2286: $result = &mt('Currently using local (institutional) authentication.');
2287: return $result;
1.165 raeburn 2288: }
2289: }
1.586 raeburn 2290: } else {
2291: if ($authnum == 1) {
2292: $authtype = '<input type="hidden" name="login" value="loc">';
2293: }
2294: }
2295: if (!$can_assign{'loc'}) {
2296: return;
1.587 raeburn 2297: } elsif ($authtype eq '') {
1.591 raeburn 2298: if (defined($in{'mode'})) {
1.587 raeburn 2299: if ($in{'mode'} eq 'modifycourse') {
2300: if ($authnum == 1) {
2301: $authtype = '<input type="hidden" name="login" value="loc">';
2302: }
2303: }
2304: }
1.165 raeburn 2305: }
1.586 raeburn 2306: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2307: if ($authtype eq '') {
2308: $authtype = '<input type="radio" name="login" value="loc" '.
2309: $loccheck.' onchange="'.$jscall.'" onclick="'.
2310: $jscall.'" />';
2311: }
2312: $autharg = '<input type="text" size="10" name="locarg" value="'.
2313: $locarg.'" onchange="'.$jscall.'" />';
2314: $result = &mt('[_1] Local Authentication with argument [_2]',
2315: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2316: return $result;
2317: }
2318:
2319: sub authform_filesystem{
2320: my %in = (
2321: formname => 'document.cu',
2322: kerb_def_dom => 'MSU.EDU',
2323: @_,
2324: );
1.586 raeburn 2325: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2326: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2327: if (defined($in{'curr_authtype'})) {
2328: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2329: if ($can_assign{'fsys'}) {
2330: $fsyscheck = 'checked="on" ';
1.623 raeburn 2331: if (defined($in{'mode'})) {
2332: if ($in{'mode'} eq 'modifyuser') {
2333: $fsyscheck = '';
2334: }
2335: }
1.586 raeburn 2336: } else {
2337: $result = &mt('Currently Filesystem Authenticated.');
2338: return $result;
2339: }
2340: }
2341: } else {
2342: if ($authnum == 1) {
2343: $authtype = '<input type="hidden" name="login" value="fsys">';
2344: }
2345: }
2346: if (!$can_assign{'fsys'}) {
2347: return;
1.587 raeburn 2348: } elsif ($authtype eq '') {
1.591 raeburn 2349: if (defined($in{'mode'})) {
1.587 raeburn 2350: if ($in{'mode'} eq 'modifycourse') {
2351: if ($authnum == 1) {
2352: $authtype = '<input type="hidden" name="login" value="fsys">';
2353: }
2354: }
2355: }
1.586 raeburn 2356: }
2357: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2358: if ($authtype eq '') {
2359: $authtype = '<input type="radio" name="login" value="fsys" '.
2360: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2361: $jscall.'" />';
2362: }
2363: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2364: ' onchange="'.$jscall.'" />';
2365: $result = &mt
1.144 matthew 2366: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2367: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2368: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2369: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2370: 'onchange="'.$jscall.'" />');
1.32 matthew 2371: return $result;
2372: }
2373:
1.586 raeburn 2374: sub get_assignable_auth {
2375: my ($dom) = @_;
2376: if ($dom eq '') {
2377: $dom = $env{'request.role.domain'};
2378: }
2379: my %can_assign = (
2380: krb4 => 1,
2381: krb5 => 1,
2382: int => 1,
2383: loc => 1,
2384: );
2385: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2386: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2387: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2388: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2389: my $context;
2390: if ($env{'request.role'} =~ /^au/) {
2391: $context = 'author';
2392: } elsif ($env{'request.role'} =~ /^dc/) {
2393: $context = 'domain';
2394: } elsif ($env{'request.course.id'}) {
2395: $context = 'course';
2396: }
2397: if ($context) {
2398: if (ref($authhash->{$context}) eq 'HASH') {
2399: %can_assign = %{$authhash->{$context}};
2400: }
2401: }
2402: }
2403: }
2404: my $authnum = 0;
2405: foreach my $key (keys(%can_assign)) {
2406: if ($can_assign{$key}) {
2407: $authnum ++;
2408: }
2409: }
2410: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2411: $authnum --;
2412: }
2413: return ($authnum,%can_assign);
2414: }
2415:
1.80 albertel 2416: ###############################################################
2417: ## Get Kerberos Defaults for Domain ##
2418: ###############################################################
2419: ##
2420: ## Returns default kerberos version and an associated argument
2421: ## as listed in file domain.tab. If not listed, provides
2422: ## appropriate default domain and kerberos version.
2423: ##
2424: #-------------------------------------------
2425:
2426: =pod
2427:
1.648 raeburn 2428: =item * &get_kerberos_defaults()
1.80 albertel 2429:
2430: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2431: version and domain. If not found, it defaults to version 4 and the
2432: domain of the server.
1.80 albertel 2433:
1.648 raeburn 2434: =over 4
2435:
1.80 albertel 2436: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2437:
1.648 raeburn 2438: =back
2439:
2440: =back
2441:
1.80 albertel 2442: =cut
2443:
2444: #-------------------------------------------
2445: sub get_kerberos_defaults {
2446: my $domain=shift;
1.641 raeburn 2447: my ($krbdef,$krbdefdom);
2448: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2449: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2450: $krbdef = $domdefaults{'auth_def'};
2451: $krbdefdom = $domdefaults{'auth_arg_def'};
2452: } else {
1.80 albertel 2453: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2454: my $krbdefdom=$1;
2455: $krbdefdom=~tr/a-z/A-Z/;
2456: $krbdef = "krb4";
2457: }
2458: return ($krbdef,$krbdefdom);
2459: }
1.112 bowersj2 2460:
1.32 matthew 2461:
1.46 matthew 2462: ###############################################################
2463: ## Thesaurus Functions ##
2464: ###############################################################
1.20 www 2465:
1.46 matthew 2466: =pod
1.20 www 2467:
1.112 bowersj2 2468: =head1 Thesaurus Functions
2469:
2470: =over 4
2471:
1.648 raeburn 2472: =item * &initialize_keywords()
1.46 matthew 2473:
2474: Initializes the package variable %Keywords if it is empty. Uses the
2475: package variable $thesaurus_db_file.
2476:
2477: =cut
2478:
2479: ###################################################
2480:
2481: sub initialize_keywords {
2482: return 1 if (scalar keys(%Keywords));
2483: # If we are here, %Keywords is empty, so fill it up
2484: # Make sure the file we need exists...
2485: if (! -e $thesaurus_db_file) {
2486: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2487: " failed because it does not exist");
2488: return 0;
2489: }
2490: # Set up the hash as a database
2491: my %thesaurus_db;
2492: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2493: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2494: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2495: $thesaurus_db_file);
2496: return 0;
2497: }
2498: # Get the average number of appearances of a word.
2499: my $avecount = $thesaurus_db{'average.count'};
2500: # Put keywords (those that appear > average) into %Keywords
2501: while (my ($word,$data)=each (%thesaurus_db)) {
2502: my ($count,undef) = split /:/,$data;
2503: $Keywords{$word}++ if ($count > $avecount);
2504: }
2505: untie %thesaurus_db;
2506: # Remove special values from %Keywords.
1.356 albertel 2507: foreach my $value ('total.count','average.count') {
2508: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2509: }
1.46 matthew 2510: return 1;
2511: }
2512:
2513: ###################################################
2514:
2515: =pod
2516:
1.648 raeburn 2517: =item * &keyword($word)
1.46 matthew 2518:
2519: Returns true if $word is a keyword. A keyword is a word that appears more
2520: than the average number of times in the thesaurus database. Calls
2521: &initialize_keywords
2522:
2523: =cut
2524:
2525: ###################################################
1.20 www 2526:
2527: sub keyword {
1.46 matthew 2528: return if (!&initialize_keywords());
2529: my $word=lc(shift());
2530: $word=~s/\W//g;
2531: return exists($Keywords{$word});
1.20 www 2532: }
1.46 matthew 2533:
2534: ###############################################################
2535:
2536: =pod
1.20 www 2537:
1.648 raeburn 2538: =item * &get_related_words()
1.46 matthew 2539:
1.160 matthew 2540: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2541: an array of words. If the keyword is not in the thesaurus, an empty array
2542: will be returned. The order of the words returned is determined by the
2543: database which holds them.
2544:
2545: Uses global $thesaurus_db_file.
2546:
2547: =cut
2548:
2549: ###############################################################
2550: sub get_related_words {
2551: my $keyword = shift;
2552: my %thesaurus_db;
2553: if (! -e $thesaurus_db_file) {
2554: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2555: "failed because the file does not exist");
2556: return ();
2557: }
2558: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2559: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2560: return ();
2561: }
2562: my @Words=();
1.429 www 2563: my $count=0;
1.46 matthew 2564: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2565: # The first element is the number of times
2566: # the word appears. We do not need it now.
1.429 www 2567: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2568: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2569: my $threshold=$mostfrequentcount/10;
2570: foreach my $possibleword (@RelatedWords) {
2571: my ($word,$wordcount)=split(/\,/,$possibleword);
2572: if ($wordcount>$threshold) {
2573: push(@Words,$word);
2574: $count++;
2575: if ($count>10) { last; }
2576: }
1.20 www 2577: }
2578: }
1.46 matthew 2579: untie %thesaurus_db;
2580: return @Words;
1.14 harris41 2581: }
1.46 matthew 2582:
1.112 bowersj2 2583: =pod
2584:
2585: =back
2586:
2587: =cut
1.61 www 2588:
2589: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2590: =pod
2591:
1.112 bowersj2 2592: =head1 User Name Functions
2593:
2594: =over 4
2595:
1.648 raeburn 2596: =item * &plainname($uname,$udom,$first)
1.81 albertel 2597:
1.112 bowersj2 2598: Takes a users logon name and returns it as a string in
1.226 albertel 2599: "first middle last generation" form
2600: if $first is set to 'lastname' then it returns it as
2601: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2602:
2603: =cut
1.61 www 2604:
1.295 www 2605:
1.81 albertel 2606: ###############################################################
1.61 www 2607: sub plainname {
1.226 albertel 2608: my ($uname,$udom,$first)=@_;
1.537 albertel 2609: return if (!defined($uname) || !defined($udom));
1.295 www 2610: my %names=&getnames($uname,$udom);
1.226 albertel 2611: my $name=&Apache::lonnet::format_name($names{'firstname'},
2612: $names{'middlename'},
2613: $names{'lastname'},
2614: $names{'generation'},$first);
2615: $name=~s/^\s+//;
1.62 www 2616: $name=~s/\s+$//;
2617: $name=~s/\s+/ /g;
1.353 albertel 2618: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2619: return $name;
1.61 www 2620: }
1.66 www 2621:
2622: # -------------------------------------------------------------------- Nickname
1.81 albertel 2623: =pod
2624:
1.648 raeburn 2625: =item * &nickname($uname,$udom)
1.81 albertel 2626:
2627: Gets a users name and returns it as a string as
2628:
2629: ""nickname""
1.66 www 2630:
1.81 albertel 2631: if the user has a nickname or
2632:
2633: "first middle last generation"
2634:
2635: if the user does not
2636:
2637: =cut
1.66 www 2638:
2639: sub nickname {
2640: my ($uname,$udom)=@_;
1.537 albertel 2641: return if (!defined($uname) || !defined($udom));
1.295 www 2642: my %names=&getnames($uname,$udom);
1.68 albertel 2643: my $name=$names{'nickname'};
1.66 www 2644: if ($name) {
2645: $name='"'.$name.'"';
2646: } else {
2647: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2648: $names{'lastname'}.' '.$names{'generation'};
2649: $name=~s/\s+$//;
2650: $name=~s/\s+/ /g;
2651: }
2652: return $name;
2653: }
2654:
1.295 www 2655: sub getnames {
2656: my ($uname,$udom)=@_;
1.537 albertel 2657: return if (!defined($uname) || !defined($udom));
1.433 albertel 2658: if ($udom eq 'public' && $uname eq 'public') {
2659: return ('lastname' => &mt('Public'));
2660: }
1.295 www 2661: my $id=$uname.':'.$udom;
2662: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2663: if ($cached) {
2664: return %{$names};
2665: } else {
2666: my %loadnames=&Apache::lonnet::get('environment',
2667: ['firstname','middlename','lastname','generation','nickname'],
2668: $udom,$uname);
2669: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2670: return %loadnames;
2671: }
2672: }
1.61 www 2673:
1.542 raeburn 2674: # -------------------------------------------------------------------- getemails
1.648 raeburn 2675:
1.542 raeburn 2676: =pod
2677:
1.648 raeburn 2678: =item * &getemails($uname,$udom)
1.542 raeburn 2679:
2680: Gets a user's email information and returns it as a hash with keys:
2681: notification, critnotification, permanentemail
2682:
2683: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2684: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2685:
1.648 raeburn 2686:
1.542 raeburn 2687: =cut
2688:
1.648 raeburn 2689:
1.466 albertel 2690: sub getemails {
2691: my ($uname,$udom)=@_;
2692: if ($udom eq 'public' && $uname eq 'public') {
2693: return;
2694: }
1.467 www 2695: if (!$udom) { $udom=$env{'user.domain'}; }
2696: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2697: my $id=$uname.':'.$udom;
2698: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2699: if ($cached) {
2700: return %{$names};
2701: } else {
2702: my %loadnames=&Apache::lonnet::get('environment',
2703: ['notification','critnotification',
2704: 'permanentemail'],
2705: $udom,$uname);
2706: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2707: return %loadnames;
2708: }
2709: }
2710:
1.551 albertel 2711: sub flush_email_cache {
2712: my ($uname,$udom)=@_;
2713: if (!$udom) { $udom =$env{'user.domain'}; }
2714: if (!$uname) { $uname=$env{'user.name'}; }
2715: return if ($udom eq 'public' && $uname eq 'public');
2716: my $id=$uname.':'.$udom;
2717: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2718: }
2719:
1.61 www 2720: # ------------------------------------------------------------------ Screenname
1.81 albertel 2721:
2722: =pod
2723:
1.648 raeburn 2724: =item * &screenname($uname,$udom)
1.81 albertel 2725:
2726: Gets a users screenname and returns it as a string
2727:
2728: =cut
1.61 www 2729:
2730: sub screenname {
2731: my ($uname,$udom)=@_;
1.258 albertel 2732: if ($uname eq $env{'user.name'} &&
2733: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2734: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2735: return $names{'screenname'};
1.62 www 2736: }
2737:
1.212 albertel 2738:
1.62 www 2739: # ------------------------------------------------------------- Message Wrapper
2740:
2741: sub messagewrapper {
1.369 www 2742: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 2743: return
1.441 albertel 2744: '<a href="/adm/email?compose=individual&'.
2745: 'recname='.$username.'&recdom='.$domain.
2746: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 2747: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 2748: }
2749: # --------------------------------------------------------------- Notes Wrapper
2750:
2751: sub noteswrapper {
2752: my ($link,$un,$do)=@_;
2753: return
2754: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 2755: }
2756: # ------------------------------------------------------------- Aboutme Wrapper
2757:
2758: sub aboutmewrapper {
1.166 www 2759: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 2760: if (!defined($username) && !defined($domain)) {
2761: return;
2762: }
1.205 www 2763: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.454 banghart 2764: ($target?' target="$target"':'').' title="'.&mt("View this user's personal page").'">'.$link.'</a>';
1.62 www 2765: }
2766:
2767: # ------------------------------------------------------------ Syllabus Wrapper
2768:
2769:
2770: sub syllabuswrapper {
1.109 matthew 2771: my ($linktext,$coursedir,$domain,$fontcolor)=@_;
2772: if ($fontcolor) {
1.705 ! tempelho 2773: $linktext='<span style="color:'.$fontcolor.';">'.$linktext.'</span>';
1.109 matthew 2774: }
1.208 matthew 2775: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 2776: }
1.14 harris41 2777:
1.208 matthew 2778: sub track_student_link {
1.268 albertel 2779: my ($linktext,$sname,$sdom,$target,$start) = @_;
2780: my $link ="/adm/trackstudent?";
1.208 matthew 2781: my $title = 'View recent activity';
2782: if (defined($sname) && $sname !~ /^\s*$/ &&
2783: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 2784: $link .= "selected_student=$sname:$sdom";
1.208 matthew 2785: $title .= ' of this student';
1.268 albertel 2786: }
1.208 matthew 2787: if (defined($target) && $target !~ /^\s*$/) {
2788: $target = qq{target="$target"};
2789: } else {
2790: $target = '';
2791: }
1.268 albertel 2792: if ($start) { $link.='&start='.$start; }
1.554 albertel 2793: $title = &mt($title);
2794: $linktext = &mt($linktext);
1.448 albertel 2795: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
2796: &help_open_topic('View_recent_activity');
1.208 matthew 2797: }
2798:
1.508 www 2799: # ===================================================== Display a student photo
2800:
2801:
1.509 albertel 2802: sub student_image_tag {
1.508 www 2803: my ($domain,$user)=@_;
2804: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
2805: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
2806: return '<img src="'.$imgsrc.'" align="right" />';
2807: } else {
2808: return '';
2809: }
2810: }
2811:
1.112 bowersj2 2812: =pod
2813:
2814: =back
2815:
2816: =head1 Access .tab File Data
2817:
2818: =over 4
2819:
1.648 raeburn 2820: =item * &languageids()
1.112 bowersj2 2821:
2822: returns list of all language ids
2823:
2824: =cut
2825:
1.14 harris41 2826: sub languageids {
1.16 harris41 2827: return sort(keys(%language));
1.14 harris41 2828: }
2829:
1.112 bowersj2 2830: =pod
2831:
1.648 raeburn 2832: =item * &languagedescription()
1.112 bowersj2 2833:
2834: returns description of a specified language id
2835:
2836: =cut
2837:
1.14 harris41 2838: sub languagedescription {
1.125 www 2839: my $code=shift;
2840: return ($supported_language{$code}?'* ':'').
2841: $language{$code}.
1.126 www 2842: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 2843: }
2844:
2845: sub plainlanguagedescription {
2846: my $code=shift;
2847: return $language{$code};
2848: }
2849:
2850: sub supportedlanguagecode {
2851: my $code=shift;
2852: return $supported_language{$code};
1.97 www 2853: }
2854:
1.112 bowersj2 2855: =pod
2856:
1.648 raeburn 2857: =item * ©rightids()
1.112 bowersj2 2858:
2859: returns list of all copyrights
2860:
2861: =cut
2862:
2863: sub copyrightids {
2864: return sort(keys(%cprtag));
2865: }
2866:
2867: =pod
2868:
1.648 raeburn 2869: =item * ©rightdescription()
1.112 bowersj2 2870:
2871: returns description of a specified copyright id
2872:
2873: =cut
2874:
2875: sub copyrightdescription {
1.166 www 2876: return &mt($cprtag{shift(@_)});
1.112 bowersj2 2877: }
1.197 matthew 2878:
2879: =pod
2880:
1.648 raeburn 2881: =item * &source_copyrightids()
1.192 taceyjo1 2882:
2883: returns list of all source copyrights
2884:
2885: =cut
2886:
2887: sub source_copyrightids {
2888: return sort(keys(%scprtag));
2889: }
2890:
2891: =pod
2892:
1.648 raeburn 2893: =item * &source_copyrightdescription()
1.192 taceyjo1 2894:
2895: returns description of a specified source copyright id
2896:
2897: =cut
2898:
2899: sub source_copyrightdescription {
2900: return &mt($scprtag{shift(@_)});
2901: }
1.112 bowersj2 2902:
2903: =pod
2904:
1.648 raeburn 2905: =item * &filecategories()
1.112 bowersj2 2906:
2907: returns list of all file categories
2908:
2909: =cut
2910:
2911: sub filecategories {
2912: return sort(keys(%category_extensions));
2913: }
2914:
2915: =pod
2916:
1.648 raeburn 2917: =item * &filecategorytypes()
1.112 bowersj2 2918:
2919: returns list of file types belonging to a given file
2920: category
2921:
2922: =cut
2923:
2924: sub filecategorytypes {
1.356 albertel 2925: my ($cat) = @_;
2926: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 2927: }
2928:
2929: =pod
2930:
1.648 raeburn 2931: =item * &fileembstyle()
1.112 bowersj2 2932:
2933: returns embedding style for a specified file type
2934:
2935: =cut
2936:
2937: sub fileembstyle {
2938: return $fe{lc(shift(@_))};
1.169 www 2939: }
2940:
1.351 www 2941: sub filemimetype {
2942: return $fm{lc(shift(@_))};
2943: }
2944:
1.169 www 2945:
2946: sub filecategoryselect {
2947: my ($name,$value)=@_;
1.189 matthew 2948: return &select_form($value,$name,
1.169 www 2949: '' => &mt('Any category'),
2950: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 2951: }
2952:
2953: =pod
2954:
1.648 raeburn 2955: =item * &filedescription()
1.112 bowersj2 2956:
2957: returns description for a specified file type
2958:
2959: =cut
2960:
2961: sub filedescription {
1.188 matthew 2962: my $file_description = $fd{lc(shift())};
2963: $file_description =~ s:([\[\]]):~$1:g;
2964: return &mt($file_description);
1.112 bowersj2 2965: }
2966:
2967: =pod
2968:
1.648 raeburn 2969: =item * &filedescriptionex()
1.112 bowersj2 2970:
2971: returns description for a specified file type with
2972: extra formatting
2973:
2974: =cut
2975:
2976: sub filedescriptionex {
2977: my $ex=shift;
1.188 matthew 2978: my $file_description = $fd{lc($ex)};
2979: $file_description =~ s:([\[\]]):~$1:g;
2980: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 2981: }
2982:
2983: # End of .tab access
2984: =pod
2985:
2986: =back
2987:
2988: =cut
2989:
2990: # ------------------------------------------------------------------ File Types
2991: sub fileextensions {
2992: return sort(keys(%fe));
2993: }
2994:
1.97 www 2995: # ----------------------------------------------------------- Display Languages
2996: # returns a hash with all desired display languages
2997: #
2998:
2999: sub display_languages {
3000: my %languages=();
1.695 raeburn 3001: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3002: $languages{$lang}=1;
1.97 www 3003: }
3004: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3005: if ($env{'form.displaylanguage'}) {
1.356 albertel 3006: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3007: $languages{$lang}=1;
1.97 www 3008: }
3009: }
3010: return %languages;
1.14 harris41 3011: }
3012:
1.582 albertel 3013: sub languages {
3014: my ($possible_langs) = @_;
1.695 raeburn 3015: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3016: if (!ref($possible_langs)) {
3017: if( wantarray ) {
3018: return @preferred_langs;
3019: } else {
3020: return $preferred_langs[0];
3021: }
3022: }
3023: my %possibilities = map { $_ => 1 } (@$possible_langs);
3024: my @preferred_possibilities;
3025: foreach my $preferred_lang (@preferred_langs) {
3026: if (exists($possibilities{$preferred_lang})) {
3027: push(@preferred_possibilities, $preferred_lang);
3028: }
3029: }
3030: if( wantarray ) {
3031: return @preferred_possibilities;
3032: }
3033: return $preferred_possibilities[0];
3034: }
3035:
1.112 bowersj2 3036: ###############################################################
3037: ## Student Answer Attempts ##
3038: ###############################################################
3039:
3040: =pod
3041:
3042: =head1 Alternate Problem Views
3043:
3044: =over 4
3045:
1.648 raeburn 3046: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3047: $getattempt, $regexp, $gradesub)
3048:
3049: Return string with previous attempt on problem. Arguments:
3050:
3051: =over 4
3052:
3053: =item * $symb: Problem, including path
3054:
3055: =item * $username: username of the desired student
3056:
3057: =item * $domain: domain of the desired student
1.14 harris41 3058:
1.112 bowersj2 3059: =item * $course: Course ID
1.14 harris41 3060:
1.112 bowersj2 3061: =item * $getattempt: Leave blank for all attempts, otherwise put
3062: something
1.14 harris41 3063:
1.112 bowersj2 3064: =item * $regexp: if string matches this regexp, the string will be
3065: sent to $gradesub
1.14 harris41 3066:
1.112 bowersj2 3067: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3068:
1.112 bowersj2 3069: =back
1.14 harris41 3070:
1.112 bowersj2 3071: The output string is a table containing all desired attempts, if any.
1.16 harris41 3072:
1.112 bowersj2 3073: =cut
1.1 albertel 3074:
3075: sub get_previous_attempt {
1.43 ng 3076: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3077: my $prevattempts='';
1.43 ng 3078: no strict 'refs';
1.1 albertel 3079: if ($symb) {
1.3 albertel 3080: my (%returnhash)=
3081: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3082: if ($returnhash{'version'}) {
3083: my %lasthash=();
3084: my $version;
3085: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3086: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3087: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3088: }
1.1 albertel 3089: }
1.596 albertel 3090: $prevattempts=&start_data_table().&start_data_table_header_row();
3091: $prevattempts.='<th>'.&mt('History').'</th>';
1.356 albertel 3092: foreach my $key (sort(keys(%lasthash))) {
3093: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3094: if ($#parts > 0) {
1.31 albertel 3095: my $data=$parts[-1];
3096: pop(@parts);
1.596 albertel 3097: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.31 albertel 3098: } else {
1.41 ng 3099: if ($#parts == 0) {
3100: $prevattempts.='<th>'.$parts[0].'</th>';
3101: } else {
3102: $prevattempts.='<th>'.$ign.'</th>';
3103: }
1.31 albertel 3104: }
1.16 harris41 3105: }
1.596 albertel 3106: $prevattempts.=&end_data_table_header_row();
1.40 ng 3107: if ($getattempt eq '') {
3108: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596 albertel 3109: $prevattempts.=&start_data_table_row().
3110: '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356 albertel 3111: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3112: my $value = &format_previous_attempt_value($key,
3113: $returnhash{$version.':'.$key});
3114: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 3115: }
1.596 albertel 3116: $prevattempts.=&end_data_table_row();
1.40 ng 3117: }
1.1 albertel 3118: }
1.596 albertel 3119: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3120: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3121: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 3122: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 3123: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 3124: }
1.596 albertel 3125: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3126: } else {
1.596 albertel 3127: $prevattempts=
3128: &start_data_table().&start_data_table_row().
3129: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3130: &end_data_table_row().&end_data_table();
1.1 albertel 3131: }
3132: } else {
1.596 albertel 3133: $prevattempts=
3134: &start_data_table().&start_data_table_row().
3135: '<td>'.&mt('No data.').'</td>'.
3136: &end_data_table_row().&end_data_table();
1.1 albertel 3137: }
1.10 albertel 3138: }
3139:
1.581 albertel 3140: sub format_previous_attempt_value {
3141: my ($key,$value) = @_;
3142: if ($key =~ /timestamp/) {
3143: $value = &Apache::lonlocal::locallocaltime($value);
3144: } elsif (ref($value) eq 'ARRAY') {
3145: $value = '('.join(', ', @{ $value }).')';
3146: } else {
3147: $value = &unescape($value);
3148: }
3149: return $value;
3150: }
3151:
3152:
1.107 albertel 3153: sub relative_to_absolute {
3154: my ($url,$output)=@_;
3155: my $parser=HTML::TokeParser->new(\$output);
3156: my $token;
3157: my $thisdir=$url;
3158: my @rlinks=();
3159: while ($token=$parser->get_token) {
3160: if ($token->[0] eq 'S') {
3161: if ($token->[1] eq 'a') {
3162: if ($token->[2]->{'href'}) {
3163: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3164: }
3165: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3166: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3167: } elsif ($token->[1] eq 'base') {
3168: $thisdir=$token->[2]->{'href'};
3169: }
3170: }
3171: }
3172: $thisdir=~s-/[^/]*$--;
1.356 albertel 3173: foreach my $link (@rlinks) {
3174: unless (($link=~/^http:\/\//i) ||
3175: ($link=~/^\//) ||
3176: ($link=~/^javascript:/i) ||
3177: ($link=~/^mailto:/i) ||
3178: ($link=~/^\#/)) {
3179: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3180: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3181: }
3182: }
3183: # -------------------------------------------------- Deal with Applet codebases
3184: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3185: return $output;
3186: }
3187:
1.112 bowersj2 3188: =pod
3189:
1.648 raeburn 3190: =item * &get_student_view()
1.112 bowersj2 3191:
3192: show a snapshot of what student was looking at
3193:
3194: =cut
3195:
1.10 albertel 3196: sub get_student_view {
1.186 albertel 3197: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3198: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3199: my (%form);
1.10 albertel 3200: my @elements=('symb','courseid','domain','username');
3201: foreach my $element (@elements) {
1.186 albertel 3202: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3203: }
1.186 albertel 3204: if (defined($moreenv)) {
3205: %form=(%form,%{$moreenv});
3206: }
1.236 albertel 3207: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3208: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3209: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3210: $userview=~s/\<body[^\>]*\>//gi;
3211: $userview=~s/\<\/body\>//gi;
3212: $userview=~s/\<html\>//gi;
3213: $userview=~s/\<\/html\>//gi;
3214: $userview=~s/\<head\>//gi;
3215: $userview=~s/\<\/head\>//gi;
3216: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3217: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3218: if (wantarray) {
3219: return ($userview,$response);
3220: } else {
3221: return $userview;
3222: }
3223: }
3224:
3225: sub get_student_view_with_retries {
3226: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3227:
3228: my $ok = 0; # True if we got a good response.
3229: my $content;
3230: my $response;
3231:
3232: # Try to get the student_view done. within the retries count:
3233:
3234: do {
3235: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3236: $ok = $response->is_success;
3237: if (!$ok) {
3238: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3239: }
3240: $retries--;
3241: } while (!$ok && ($retries > 0));
3242:
3243: if (!$ok) {
3244: $content = ''; # On error return an empty content.
3245: }
1.651 www 3246: if (wantarray) {
3247: return ($content, $response);
3248: } else {
3249: return $content;
3250: }
1.11 albertel 3251: }
3252:
1.112 bowersj2 3253: =pod
3254:
1.648 raeburn 3255: =item * &get_student_answers()
1.112 bowersj2 3256:
3257: show a snapshot of how student was answering problem
3258:
3259: =cut
3260:
1.11 albertel 3261: sub get_student_answers {
1.100 sakharuk 3262: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3263: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3264: my (%moreenv);
1.11 albertel 3265: my @elements=('symb','courseid','domain','username');
3266: foreach my $element (@elements) {
1.186 albertel 3267: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3268: }
1.186 albertel 3269: $moreenv{'grade_target'}='answer';
3270: %moreenv=(%form,%moreenv);
1.497 raeburn 3271: $feedurl = &Apache::lonnet::clutter($feedurl);
3272: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3273: return $userview;
1.1 albertel 3274: }
1.116 albertel 3275:
3276: =pod
3277:
3278: =item * &submlink()
3279:
1.242 albertel 3280: Inputs: $text $uname $udom $symb $target
1.116 albertel 3281:
3282: Returns: A link to grades.pm such as to see the SUBM view of a student
3283:
3284: =cut
3285:
3286: ###############################################
3287: sub submlink {
1.242 albertel 3288: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3289: if (!($uname && $udom)) {
3290: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3291: &Apache::lonnet::whichuser($symb);
1.116 albertel 3292: if (!$symb) { $symb=$cursymb; }
3293: }
1.254 matthew 3294: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3295: $symb=&escape($symb);
1.242 albertel 3296: if ($target) { $target="target=\"$target\""; }
3297: return '<a href="/adm/grades?&command=submission&'.
3298: 'symb='.$symb.'&student='.$uname.
3299: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3300: }
3301: ##############################################
3302:
3303: =pod
3304:
3305: =item * &pgrdlink()
3306:
3307: Inputs: $text $uname $udom $symb $target
3308:
3309: Returns: A link to grades.pm such as to see the PGRD view of a student
3310:
3311: =cut
3312:
3313: ###############################################
3314: sub pgrdlink {
3315: my $link=&submlink(@_);
3316: $link=~s/(&command=submission)/$1&showgrading=yes/;
3317: return $link;
3318: }
3319: ##############################################
3320:
3321: =pod
3322:
3323: =item * &pprmlink()
3324:
3325: Inputs: $text $uname $udom $symb $target
3326:
3327: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3328: student and a specific resource
1.242 albertel 3329:
3330: =cut
3331:
3332: ###############################################
3333: sub pprmlink {
3334: my ($text,$uname,$udom,$symb,$target)=@_;
3335: if (!($uname && $udom)) {
3336: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3337: &Apache::lonnet::whichuser($symb);
1.242 albertel 3338: if (!$symb) { $symb=$cursymb; }
3339: }
1.254 matthew 3340: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3341: $symb=&escape($symb);
1.242 albertel 3342: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3343: return '<a href="/adm/parmset?command=set&'.
3344: 'symb='.$symb.'&uname='.$uname.
3345: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3346: }
3347: ##############################################
1.37 matthew 3348:
1.112 bowersj2 3349: =pod
3350:
3351: =back
3352:
3353: =cut
3354:
1.37 matthew 3355: ###############################################
1.51 www 3356:
3357:
3358: sub timehash {
1.687 raeburn 3359: my ($thistime) = @_;
3360: my $timezone = &Apache::lonlocal::gettimezone();
3361: my $dt = DateTime->from_epoch(epoch => $thistime)
3362: ->set_time_zone($timezone);
3363: my $wday = $dt->day_of_week();
3364: if ($wday == 7) { $wday = 0; }
3365: return ( 'second' => $dt->second(),
3366: 'minute' => $dt->minute(),
3367: 'hour' => $dt->hour(),
3368: 'day' => $dt->day_of_month(),
3369: 'month' => $dt->month(),
3370: 'year' => $dt->year(),
3371: 'weekday' => $wday,
3372: 'dayyear' => $dt->day_of_year(),
3373: 'dlsav' => $dt->is_dst() );
1.51 www 3374: }
3375:
1.370 www 3376: sub utc_string {
3377: my ($date)=@_;
1.371 www 3378: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3379: }
3380:
1.51 www 3381: sub maketime {
3382: my %th=@_;
1.687 raeburn 3383: my ($epoch_time,$timezone,$dt);
3384: $timezone = &Apache::lonlocal::gettimezone();
3385: eval {
3386: $dt = DateTime->new( year => $th{'year'},
3387: month => $th{'month'},
3388: day => $th{'day'},
3389: hour => $th{'hour'},
3390: minute => $th{'minute'},
3391: second => $th{'second'},
3392: time_zone => $timezone,
3393: );
3394: };
3395: if (!$@) {
3396: $epoch_time = $dt->epoch;
3397: if ($epoch_time) {
3398: return $epoch_time;
3399: }
3400: }
1.51 www 3401: return POSIX::mktime(
3402: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3403: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3404: }
3405:
3406: #########################################
1.51 www 3407:
3408: sub findallcourses {
1.482 raeburn 3409: my ($roles,$uname,$udom) = @_;
1.355 albertel 3410: my %roles;
3411: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3412: my %courses;
1.51 www 3413: my $now=time;
1.482 raeburn 3414: if (!defined($uname)) {
3415: $uname = $env{'user.name'};
3416: }
3417: if (!defined($udom)) {
3418: $udom = $env{'user.domain'};
3419: }
3420: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3421: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3422: if (!%roles) {
3423: %roles = (
3424: cc => 1,
3425: in => 1,
3426: ep => 1,
3427: ta => 1,
3428: cr => 1,
3429: st => 1,
3430: );
3431: }
3432: foreach my $entry (keys(%roleshash)) {
3433: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3434: if ($trole =~ /^cr/) {
3435: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3436: } else {
3437: next if (!exists($roles{$trole}));
3438: }
3439: if ($tend) {
3440: next if ($tend < $now);
3441: }
3442: if ($tstart) {
3443: next if ($tstart > $now);
3444: }
3445: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3446: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3447: if ($secpart eq '') {
3448: ($cnum,$role) = split(/_/,$cnumpart);
3449: $sec = 'none';
3450: $realsec = '';
3451: } else {
3452: $cnum = $cnumpart;
3453: ($sec,$role) = split(/_/,$secpart);
3454: $realsec = $sec;
1.490 raeburn 3455: }
1.482 raeburn 3456: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3457: }
3458: } else {
3459: foreach my $key (keys(%env)) {
1.483 albertel 3460: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3461: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3462: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3463: next if ($role eq 'ca' || $role eq 'aa');
3464: next if (%roles && !exists($roles{$role}));
3465: my ($starttime,$endtime)=split(/\./,$env{$key});
3466: my $active=1;
3467: if ($starttime) {
3468: if ($now<$starttime) { $active=0; }
3469: }
3470: if ($endtime) {
3471: if ($now>$endtime) { $active=0; }
3472: }
3473: if ($active) {
3474: if ($sec eq '') {
3475: $sec = 'none';
3476: }
3477: $courses{$cdom.'_'.$cnum}{$sec} =
3478: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3479: }
3480: }
1.51 www 3481: }
3482: }
1.474 raeburn 3483: return %courses;
1.51 www 3484: }
1.37 matthew 3485:
1.54 www 3486: ###############################################
1.474 raeburn 3487:
3488: sub blockcheck {
1.482 raeburn 3489: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3490:
3491: if (!defined($udom)) {
3492: $udom = $env{'user.domain'};
3493: }
3494: if (!defined($uname)) {
3495: $uname = $env{'user.name'};
3496: }
3497:
3498: # If uname and udom are for a course, check for blocks in the course.
3499:
3500: if (&Apache::lonnet::is_course($udom,$uname)) {
3501: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3502: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3503: return ($startblock,$endblock);
3504: }
1.474 raeburn 3505:
1.502 raeburn 3506: my $startblock = 0;
3507: my $endblock = 0;
1.482 raeburn 3508: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3509:
1.490 raeburn 3510: # If uname is for a user, and activity is course-specific, i.e.,
3511: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3512:
1.490 raeburn 3513: if (($activity eq 'boards' || $activity eq 'chat' ||
3514: $activity eq 'groups') && ($env{'request.course.id'})) {
3515: foreach my $key (keys(%live_courses)) {
3516: if ($key ne $env{'request.course.id'}) {
3517: delete($live_courses{$key});
3518: }
3519: }
3520: }
3521:
3522: my $otheruser = 0;
3523: my %own_courses;
3524: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3525: # Resource belongs to user other than current user.
3526: $otheruser = 1;
3527: # Gather courses for current user
3528: %own_courses =
3529: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3530: }
3531:
3532: # Gather active course roles - course coordinator, instructor,
3533: # exam proctor, ta, student, or custom role.
1.474 raeburn 3534:
3535: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3536: my ($cdom,$cnum);
3537: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3538: $cdom = $env{'course.'.$course.'.domain'};
3539: $cnum = $env{'course.'.$course.'.num'};
3540: } else {
1.490 raeburn 3541: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3542: }
3543: my $no_ownblock = 0;
3544: my $no_userblock = 0;
1.533 raeburn 3545: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3546: # Check if current user has 'evb' priv for this
3547: if (defined($own_courses{$course})) {
3548: foreach my $sec (keys(%{$own_courses{$course}})) {
3549: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3550: if ($sec ne 'none') {
3551: $checkrole .= '/'.$sec;
3552: }
3553: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3554: $no_ownblock = 1;
3555: last;
3556: }
3557: }
3558: }
3559: # if they have 'evb' priv and are currently not playing student
3560: next if (($no_ownblock) &&
3561: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3562: }
1.474 raeburn 3563: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3564: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3565: if ($sec ne 'none') {
1.482 raeburn 3566: $checkrole .= '/'.$sec;
1.474 raeburn 3567: }
1.490 raeburn 3568: if ($otheruser) {
3569: # Resource belongs to user other than current user.
3570: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3571: my ($trole,$tdom,$tnum,$tsec);
3572: my $entry = $live_courses{$course}{$sec};
3573: if ($entry =~ /^cr/) {
3574: ($trole,$tdom,$tnum,$tsec) =
3575: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3576: } else {
3577: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3578: }
3579: my ($spec,$area,$trest,%allroles,%userroles);
3580: $area = '/'.$tdom.'/'.$tnum;
3581: $trest = $tnum;
3582: if ($tsec ne '') {
3583: $area .= '/'.$tsec;
3584: $trest .= '/'.$tsec;
3585: }
3586: $spec = $trole.'.'.$area;
3587: if ($trole =~ /^cr/) {
3588: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3589: $tdom,$spec,$trest,$area);
3590: } else {
3591: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3592: $tdom,$spec,$trest,$area);
3593: }
3594: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3595: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3596: if ($1) {
3597: $no_userblock = 1;
3598: last;
3599: }
3600: }
1.490 raeburn 3601: } else {
3602: # Resource belongs to current user
3603: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3604: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3605: $no_ownblock = 1;
3606: last;
3607: }
1.474 raeburn 3608: }
3609: }
3610: # if they have the evb priv and are currently not playing student
1.482 raeburn 3611: next if (($no_ownblock) &&
1.491 albertel 3612: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3613: next if ($no_userblock);
1.474 raeburn 3614:
1.490 raeburn 3615: # Retrieve blocking times and identity of blocker for course
3616: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3617:
3618: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3619: if (($start != 0) &&
3620: (($startblock == 0) || ($startblock > $start))) {
3621: $startblock = $start;
3622: }
3623: if (($end != 0) &&
3624: (($endblock == 0) || ($endblock < $end))) {
3625: $endblock = $end;
3626: }
1.490 raeburn 3627: }
3628: return ($startblock,$endblock);
3629: }
3630:
3631: sub get_blocks {
3632: my ($setters,$activity,$cdom,$cnum) = @_;
3633: my $startblock = 0;
3634: my $endblock = 0;
3635: my $course = $cdom.'_'.$cnum;
3636: $setters->{$course} = {};
3637: $setters->{$course}{'staff'} = [];
3638: $setters->{$course}{'times'} = [];
3639: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3640: foreach my $record (keys(%records)) {
3641: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3642: if ($start <= time && $end >= time) {
3643: my ($staff_name,$staff_dom,$title,$blocks) =
3644: &parse_block_record($records{$record});
3645: if ($blocks->{$activity} eq 'on') {
3646: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3647: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3648: if ( ($startblock == 0) || ($startblock > $start) ) {
3649: $startblock = $start;
1.490 raeburn 3650: }
1.491 albertel 3651: if ( ($endblock == 0) || ($endblock < $end) ) {
3652: $endblock = $end;
1.474 raeburn 3653: }
3654: }
3655: }
3656: }
3657: return ($startblock,$endblock);
3658: }
3659:
3660: sub parse_block_record {
3661: my ($record) = @_;
3662: my ($setuname,$setudom,$title,$blocks);
3663: if (ref($record) eq 'HASH') {
3664: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3665: $title = &unescape($record->{'event'});
3666: $blocks = $record->{'blocks'};
3667: } else {
3668: my @data = split(/:/,$record,3);
3669: if (scalar(@data) eq 2) {
3670: $title = $data[1];
3671: ($setuname,$setudom) = split(/@/,$data[0]);
3672: } else {
3673: ($setuname,$setudom,$title) = @data;
3674: }
3675: $blocks = { 'com' => 'on' };
3676: }
3677: return ($setuname,$setudom,$title,$blocks);
3678: }
3679:
3680: sub build_block_table {
3681: my ($startblock,$endblock,$setters) = @_;
3682: my %lt = &Apache::lonlocal::texthash(
3683: 'cacb' => 'Currently active communication blocks',
3684: 'cour' => 'Course',
3685: 'dura' => 'Duration',
3686: 'blse' => 'Block set by'
3687: );
3688: my $output;
1.476 raeburn 3689: $output = '<br />'.$lt{'cacb'}.':<br />';
1.474 raeburn 3690: $output .= &start_data_table();
3691: $output .= '
3692: <tr>
3693: <th>'.$lt{'cour'}.'</th>
3694: <th>'.$lt{'dura'}.'</th>
3695: <th>'.$lt{'blse'}.'</th>
3696: </tr>
3697: ';
3698: foreach my $course (keys(%{$setters})) {
3699: my %courseinfo=&Apache::lonnet::coursedescription($course);
3700: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
3701: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490 raeburn 3702: my $fullname = &plainname($uname,$udom);
3703: if (defined($env{'user.name'}) && defined($env{'user.domain'})
3704: && $env{'user.name'} ne 'public'
3705: && $env{'user.domain'} ne 'public') {
3706: $fullname = &aboutmewrapper($fullname,$uname,$udom);
3707: }
1.474 raeburn 3708: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
3709: $openblock = &Apache::lonlocal::locallocaltime($openblock);
3710: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
3711: $output .= &Apache::loncommon::start_data_table_row().
3712: '<td>'.$courseinfo{'description'}.'</td>'.
3713: '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490 raeburn 3714: '<td>'.$fullname.'</td>'.
1.474 raeburn 3715: &Apache::loncommon::end_data_table_row();
3716: }
3717: }
3718: $output .= &end_data_table();
3719: }
3720:
1.490 raeburn 3721: sub blocking_status {
3722: my ($activity,$uname,$udom) = @_;
3723: my %setters;
3724: my ($blocked,$output,$ownitem,$is_course);
3725: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
3726: if ($startblock && $endblock) {
3727: $blocked = 1;
3728: if (wantarray) {
3729: my $category;
3730: if ($activity eq 'boards') {
3731: $category = 'Discussion posts in this course';
3732: } elsif ($activity eq 'blogs') {
3733: $category = 'Blogs';
3734: } elsif ($activity eq 'port') {
3735: if (defined($uname) && defined($udom)) {
3736: if ($uname eq $env{'user.name'} &&
3737: $udom eq $env{'user.domain'}) {
3738: $ownitem = 1;
3739: }
3740: }
3741: $is_course = &Apache::lonnet::is_course($udom,$uname);
3742: if ($ownitem) {
3743: $category = 'Your portfolio files';
3744: } elsif ($is_course) {
3745: my $coursedesc;
3746: foreach my $course (keys(%setters)) {
3747: my %courseinfo =
3748: &Apache::lonnet::coursedescription($course);
3749: $coursedesc = $courseinfo{'description'};
3750: }
3751: $category = "Group files in the course '$coursedesc'";
3752: } else {
3753: $category = 'Portfolio files belonging to ';
3754: if ($env{'user.name'} eq 'public' &&
3755: $env{'user.domain'} eq 'public') {
3756: $category .= &plainname($uname,$udom);
3757: } else {
3758: $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);
3759: }
3760: }
3761: } elsif ($activity eq 'groups') {
3762: $category = 'Groups in this course';
3763: }
3764: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
3765: my $showend = &Apache::lonlocal::locallocaltime($endblock);
3766: $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
3767: if (!($activity eq 'port' && !($ownitem) && !($is_course))) {
3768: $output .= &build_block_table($startblock,$endblock,\%setters);
3769: }
3770: }
3771: }
3772: if (wantarray) {
3773: return ($blocked,$output);
3774: } else {
3775: return $blocked;
3776: }
3777: }
3778:
1.60 matthew 3779: ###############################################
3780:
1.682 raeburn 3781: sub check_ip_acc {
3782: my ($acc)=@_;
3783: &Apache::lonxml::debug("acc is $acc");
3784: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
3785: return 1;
3786: }
3787: my $allowed=0;
3788: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
3789:
3790: my $name;
3791: foreach my $pattern (split(',',$acc)) {
3792: $pattern =~ s/^\s*//;
3793: $pattern =~ s/\s*$//;
3794: if ($pattern =~ /\*$/) {
3795: #35.8.*
3796: $pattern=~s/\*//;
3797: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3798: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
3799: #35.8.3.[34-56]
3800: my $low=$2;
3801: my $high=$3;
3802: $pattern=$1;
3803: if ($ip =~ /^\Q$pattern\E/) {
3804: my $last=(split(/\./,$ip))[3];
3805: if ($last <=$high && $last >=$low) { $allowed=1; }
3806: }
3807: } elsif ($pattern =~ /^\*/) {
3808: #*.msu.edu
3809: $pattern=~s/\*//;
3810: if (!defined($name)) {
3811: use Socket;
3812: my $netaddr=inet_aton($ip);
3813: ($name)=gethostbyaddr($netaddr,AF_INET);
3814: }
3815: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3816: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
3817: #127.0.0.1
3818: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3819: } else {
3820: #some.name.com
3821: if (!defined($name)) {
3822: use Socket;
3823: my $netaddr=inet_aton($ip);
3824: ($name)=gethostbyaddr($netaddr,AF_INET);
3825: }
3826: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3827: }
3828: if ($allowed) { last; }
3829: }
3830: return $allowed;
3831: }
3832:
3833: ###############################################
3834:
1.60 matthew 3835: =pod
3836:
1.112 bowersj2 3837: =head1 Domain Template Functions
3838:
3839: =over 4
3840:
3841: =item * &determinedomain()
1.60 matthew 3842:
3843: Inputs: $domain (usually will be undef)
3844:
1.63 www 3845: Returns: Determines which domain should be used for designs
1.60 matthew 3846:
3847: =cut
1.54 www 3848:
1.60 matthew 3849: ###############################################
1.63 www 3850: sub determinedomain {
3851: my $domain=shift;
1.531 albertel 3852: if (! $domain) {
1.60 matthew 3853: # Determine domain if we have not been given one
3854: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258 albertel 3855: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
3856: if ($env{'request.role.domain'}) {
3857: $domain=$env{'request.role.domain'};
1.60 matthew 3858: }
3859: }
1.63 www 3860: return $domain;
3861: }
3862: ###############################################
1.517 raeburn 3863:
1.518 albertel 3864: sub devalidate_domconfig_cache {
3865: my ($udom)=@_;
3866: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
3867: }
3868:
3869: # ---------------------- Get domain configuration for a domain
3870: sub get_domainconf {
3871: my ($udom) = @_;
3872: my $cachetime=1800;
3873: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
3874: if (defined($cached)) { return %{$result}; }
3875:
3876: my %domconfig = &Apache::lonnet::get_dom('configuration',
3877: ['login','rolecolors'],$udom);
1.632 raeburn 3878: my (%designhash,%legacy);
1.518 albertel 3879: if (keys(%domconfig) > 0) {
3880: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 3881: if (keys(%{$domconfig{'login'}})) {
3882: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 3883: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
3884: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
3885: $designhash{$udom.'.login.'.$key.'_'.$img} =
3886: $domconfig{'login'}{$key}{$img};
3887: }
3888: } else {
3889: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
3890: }
1.632 raeburn 3891: }
3892: } else {
3893: $legacy{'login'} = 1;
1.518 albertel 3894: }
1.632 raeburn 3895: } else {
3896: $legacy{'login'} = 1;
1.518 albertel 3897: }
3898: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 3899: if (keys(%{$domconfig{'rolecolors'}})) {
3900: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
3901: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
3902: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
3903: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
3904: }
1.518 albertel 3905: }
3906: }
1.632 raeburn 3907: } else {
3908: $legacy{'rolecolors'} = 1;
1.518 albertel 3909: }
1.632 raeburn 3910: } else {
3911: $legacy{'rolecolors'} = 1;
1.518 albertel 3912: }
1.632 raeburn 3913: if (keys(%legacy) > 0) {
3914: my %legacyhash = &get_legacy_domconf($udom);
3915: foreach my $item (keys(%legacyhash)) {
3916: if ($item =~ /^\Q$udom\E\.login/) {
3917: if ($legacy{'login'}) {
3918: $designhash{$item} = $legacyhash{$item};
3919: }
3920: } else {
3921: if ($legacy{'rolecolors'}) {
3922: $designhash{$item} = $legacyhash{$item};
3923: }
1.518 albertel 3924: }
3925: }
3926: }
1.632 raeburn 3927: } else {
3928: %designhash = &get_legacy_domconf($udom);
1.518 albertel 3929: }
3930: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
3931: $cachetime);
3932: return %designhash;
3933: }
3934:
1.632 raeburn 3935: sub get_legacy_domconf {
3936: my ($udom) = @_;
3937: my %legacyhash;
3938: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
3939: my $designfile = $designdir.'/'.$udom.'.tab';
3940: if (-e $designfile) {
3941: if ( open (my $fh,"<$designfile") ) {
3942: while (my $line = <$fh>) {
3943: next if ($line =~ /^\#/);
3944: chomp($line);
3945: my ($key,$val)=(split(/\=/,$line));
3946: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
3947: }
3948: close($fh);
3949: }
3950: }
3951: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
3952: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
3953: }
3954: return %legacyhash;
3955: }
3956:
1.63 www 3957: =pod
3958:
1.112 bowersj2 3959: =item * &domainlogo()
1.63 www 3960:
3961: Inputs: $domain (usually will be undef)
3962:
3963: Returns: A link to a domain logo, if the domain logo exists.
3964: If the domain logo does not exist, a description of the domain.
3965:
3966: =cut
1.112 bowersj2 3967:
1.63 www 3968: ###############################################
3969: sub domainlogo {
1.517 raeburn 3970: my $domain = &determinedomain(shift);
1.518 albertel 3971: my %designhash = &get_domainconf($domain);
1.517 raeburn 3972: # See if there is a logo
3973: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 3974: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 3975: if ($imgsrc =~ m{^/(adm|res)/}) {
3976: if ($imgsrc =~ m{^/res/}) {
3977: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
3978: &Apache::lonnet::repcopy($local_name);
3979: }
3980: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 3981: }
3982: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 3983: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
3984: return &Apache::lonnet::domain($domain,'description');
1.59 www 3985: } else {
1.60 matthew 3986: return '';
1.59 www 3987: }
3988: }
1.63 www 3989: ##############################################
3990:
3991: =pod
3992:
1.112 bowersj2 3993: =item * &designparm()
1.63 www 3994:
3995: Inputs: $which parameter; $domain (usually will be undef)
3996:
3997: Returns: value of designparamter $which
3998:
3999: =cut
1.112 bowersj2 4000:
1.397 albertel 4001:
1.400 albertel 4002: ##############################################
1.397 albertel 4003: sub designparm {
4004: my ($which,$domain)=@_;
1.258 albertel 4005: if ($env{'browser.blackwhite'} eq 'on') {
1.635 raeburn 4006: if ($which=~/\.(font|alink|vlink|link|textcol)$/) {
1.110 www 4007: return '#000000';
4008: }
1.635 raeburn 4009: if ($which=~/\.(pgbg|sidebg|bgcol)$/) {
1.110 www 4010: return '#FFFFFF';
4011: }
4012: if ($which=~/\.tabbg$/) {
4013: return '#CCCCCC';
4014: }
4015: }
1.397 albertel 4016: if (exists($env{'environment.color.'.$which})) {
1.258 albertel 4017: return $env{'environment.color.'.$which};
1.96 www 4018: }
1.63 www 4019: $domain=&determinedomain($domain);
1.518 albertel 4020: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4021: my $output;
1.517 raeburn 4022: if ($domdesign{$domain.'.'.$which} ne '') {
1.520 raeburn 4023: $output = $domdesign{$domain.'.'.$which};
1.63 www 4024: } else {
1.520 raeburn 4025: $output = $defaultdesign{$which};
4026: }
4027: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4028: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4029: if ($output =~ m{^/(adm|res)/}) {
4030: if ($output =~ m{^/res/}) {
4031: my $local_name = &Apache::lonnet::filelocation('',$output);
4032: &Apache::lonnet::repcopy($local_name);
4033: }
1.520 raeburn 4034: $output = &lonhttpdurl($output);
4035: }
1.63 www 4036: }
1.520 raeburn 4037: return $output;
1.63 www 4038: }
1.59 www 4039:
1.60 matthew 4040: ###############################################
4041: ###############################################
4042:
4043: =pod
4044:
1.112 bowersj2 4045: =back
4046:
1.549 albertel 4047: =head1 HTML Helpers
1.112 bowersj2 4048:
4049: =over 4
4050:
4051: =item * &bodytag()
1.60 matthew 4052:
4053: Returns a uniform header for LON-CAPA web pages.
4054:
4055: Inputs:
4056:
1.112 bowersj2 4057: =over 4
4058:
4059: =item * $title, A title to be displayed on the page.
4060:
4061: =item * $function, the current role (can be undef).
4062:
4063: =item * $addentries, extra parameters for the <body> tag.
4064:
4065: =item * $bodyonly, if defined, only return the <body> tag.
4066:
4067: =item * $domain, if defined, force a given domain.
4068:
4069: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4070: text interface only)
1.60 matthew 4071:
1.326 albertel 4072: =item * $customtitle, alternate text to use instead of $title
4073: in the title box that appears, this text
4074: is not auto translated like the $title is
1.309 albertel 4075:
4076: =item * $notopbar, if true, keep the 'what is this' info but remove the
4077: navigational links
1.317 albertel 4078:
1.338 albertel 4079: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4080:
4081: =item * $notitle, if true keep the nav controls, but remove the title bar
4082:
1.361 albertel 4083: =item * $no_inline_link, if true and in remote mode, don't show the
4084: 'Switch To Inline Menu' link
4085:
1.460 albertel 4086: =item * $args, optional argument valid values are
4087: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4088: inherit_jsmath -> when creating popup window in a page,
4089: should it have jsmath forced on by the
4090: current page
1.460 albertel 4091:
1.112 bowersj2 4092: =back
4093:
1.60 matthew 4094: Returns: A uniform header for LON-CAPA web pages.
4095: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4096: If $bodyonly is undef or zero, an html string containing a <body> tag and
4097: other decorations will be returned.
4098:
4099: =cut
4100:
1.54 www 4101: sub bodytag {
1.309 albertel 4102: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.460 albertel 4103: $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
1.339 albertel 4104:
1.460 albertel 4105: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4106:
1.183 matthew 4107: $function = &get_users_function() if (!$function);
1.339 albertel 4108: my $img = &designparm($function.'.img',$domain);
4109: my $font = &designparm($function.'.font',$domain);
4110: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4111:
4112: my %design = ( 'style' => 'margin-top: 0px',
1.535 albertel 4113: 'bgcolor' => $pgbg,
1.339 albertel 4114: 'text' => $font,
4115: 'alink' => &designparm($function.'.alink',$domain),
4116: 'vlink' => &designparm($function.'.vlink',$domain),
4117: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4118: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4119:
1.63 www 4120: # role and realm
1.378 raeburn 4121: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4122: if ($role eq 'ca') {
1.479 albertel 4123: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4124: $realm = &plainname($rname,$rdom);
1.378 raeburn 4125: }
1.55 www 4126: # realm
1.258 albertel 4127: if ($env{'request.course.id'}) {
1.378 raeburn 4128: if ($env{'request.role'} !~ /^cr/) {
4129: $role = &Apache::lonnet::plaintext($role,&course_type());
4130: }
1.359 albertel 4131: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4132: } else {
4133: $role = &Apache::lonnet::plaintext($role);
1.54 www 4134: }
1.433 albertel 4135:
1.359 albertel 4136: if (!$realm) { $realm=' '; }
1.55 www 4137: # Set messages
1.60 matthew 4138: my $messages=&domainlogo($domain);
1.330 albertel 4139:
1.438 albertel 4140: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4141:
1.101 www 4142: # construct main body tag
1.359 albertel 4143: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4144: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4145:
1.530 albertel 4146: if ($bodyonly) {
1.60 matthew 4147: return $bodytag;
1.258 albertel 4148: } elsif ($env{'browser.interface'} eq 'textual') {
1.95 www 4149: # Accessibility
1.224 raeburn 4150:
1.337 albertel 4151: $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
1.338 albertel 4152: if (!$notitle) {
1.337 albertel 4153: $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
4154: }
4155: return $bodytag;
1.359 albertel 4156: }
4157:
1.410 albertel 4158: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4159: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4160: undef($role);
1.434 albertel 4161: } else {
4162: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4163: }
1.359 albertel 4164:
4165: my $roleinfo=(<<ENDROLE);
4166: <td class="LC_title_bar_who">
4167: <div class="LC_title_bar_name">
1.410 albertel 4168: $name
1.361 albertel 4169:
1.359 albertel 4170: </div>
4171: <div class="LC_title_bar_role">
1.361 albertel 4172: $role
1.359 albertel 4173: </div>
4174: <div class="LC_title_bar_realm">
1.361 albertel 4175: $realm
1.359 albertel 4176: </div>
1.206 albertel 4177: </td>
4178: ENDROLE
1.235 raeburn 4179:
1.359 albertel 4180: my $titleinfo = '<span class="LC_title_bar_title">'.$title.'</span>';
4181: if ($customtitle) {
4182: $titleinfo = $customtitle;
4183: }
4184: #
4185: # Extra info if you are the DC
4186: my $dc_info = '';
4187: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4188: $env{'course.'.$env{'request.course.id'}.
4189: '.domain'}.'/'})) {
4190: my $cid = $env{'request.course.id'};
4191: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4192: $dc_info =~ s/\s+$//;
1.359 albertel 4193: $dc_info = '('.$dc_info.')';
4194: }
4195:
1.644 www 4196: if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359 albertel 4197: # No Remote
1.258 albertel 4198: if ($env{'request.state'} eq 'construct') {
1.359 albertel 4199: $forcereg=1;
4200: }
4201:
4202: if (!$customtitle && $env{'request.state'} eq 'construct') {
4203: # this is for resources; directories have customtitle, and crumbs
4204: # and select recent are created in lonpubdir.pm
1.229 albertel 4205: my ($uname,$thisdisfn)=
1.258 albertel 4206: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229 albertel 4207: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4208: $formaction=~s/\/+/\//g;
4209:
1.359 albertel 4210: my $parentpath = '';
4211: my $lastitem = '';
4212: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4213: $parentpath = $1;
4214: $lastitem = $2;
4215: } else {
4216: $lastitem = $thisdisfn;
4217: }
4218: $titleinfo =
1.640 bisitz 4219: &Apache::loncommon::help_open_menu('','',3,'Authoring')
4220: .'<b>'.&mt('Construction Space').'</b>: '
4221: .'<form name="dirs" method="post" action="'.$formaction
1.359 albertel 4222: .'" target="_top"><tt><b>'
1.705 ! tempelho 4223: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<span class=\"LC_fontsize_big\">$lastitem</span></b></tt><br />"
1.359 albertel 4224: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4225: .'</form>'
4226: .&Apache::lonmenu::constspaceform();
1.235 raeburn 4227: }
1.359 albertel 4228:
1.337 albertel 4229: my $titletable;
1.338 albertel 4230: if (!$notitle) {
1.337 albertel 4231: $titletable =
1.359 albertel 4232: '<table id="LC_title_bar">'.
4233: "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
4234: '</tr></table>';
1.337 albertel 4235: }
1.359 albertel 4236: if ($notopbar) {
4237: $bodytag .= $titletable;
4238: } else {
4239: if ($env{'request.state'} eq 'construct') {
1.337 albertel 4240: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
4241: $titletable);
1.272 raeburn 4242: } else {
1.336 albertel 4243: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359 albertel 4244: $titletable;
1.272 raeburn 4245: }
1.235 raeburn 4246: }
4247: return $bodytag;
1.94 www 4248: }
1.95 www 4249:
1.93 www 4250: #
1.95 www 4251: # Top frame rendering, Remote is up
1.93 www 4252: #
1.359 albertel 4253:
1.517 raeburn 4254: my $imgsrc = $img;
4255: if ($img =~ /^\/adm/) {
1.575 albertel 4256: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4257: }
4258: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4259:
1.305 www 4260: # Explicit link to get inline menu
1.361 albertel 4261: my $menu= ($no_inline_link?''
4262: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245 matthew 4263: #
1.338 albertel 4264: if ($notitle) {
1.337 albertel 4265: return $bodytag;
4266: }
1.94 www 4267: return(<<ENDBODY);
1.60 matthew 4268: $bodytag
1.359 albertel 4269: <table id="LC_title_bar" class="LC_with_remote">
1.368 albertel 4270: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
1.359 albertel 4271: <td class="LC_title_bar_domain_logo">$messages </td>
1.54 www 4272: </tr>
1.359 albertel 4273: <tr><td>$titleinfo $dc_info $menu</td>
4274: $roleinfo
1.368 albertel 4275: </tr>
1.356 albertel 4276: </table>
1.54 www 4277: ENDBODY
1.182 matthew 4278: }
4279:
1.330 albertel 4280: sub make_attr_string {
4281: my ($register,$attr_ref) = @_;
4282:
4283: if ($attr_ref && !ref($attr_ref)) {
4284: die("addentries Must be a hash ref ".
4285: join(':',caller(1))." ".
4286: join(':',caller(0))." ");
4287: }
4288:
4289: if ($register) {
1.339 albertel 4290: my ($on_load,$on_unload);
4291: foreach my $key (keys(%{$attr_ref})) {
4292: if (lc($key) eq 'onload') {
4293: $on_load.=$attr_ref->{$key}.';';
4294: delete($attr_ref->{$key});
4295:
4296: } elsif (lc($key) eq 'onunload') {
4297: $on_unload.=$attr_ref->{$key}.';';
4298: delete($attr_ref->{$key});
4299: }
4300: }
4301: $attr_ref->{'onload'} =
4302: &Apache::lonmenu::loadevents(). $on_load;
4303: $attr_ref->{'onunload'}=
4304: &Apache::lonmenu::unloadevents().$on_unload;
4305: }
4306:
4307: # Accessibility font enhance
4308: if ($env{'browser.fontenhance'} eq 'on') {
4309: my $style;
4310: foreach my $key (keys(%{$attr_ref})) {
4311: if (lc($key) eq 'style') {
4312: $style.=$attr_ref->{$key}.';';
4313: delete($attr_ref->{$key});
4314: }
4315: }
4316: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4317: }
1.339 albertel 4318:
4319: if ($env{'browser.blackwhite'} eq 'on') {
4320: delete($attr_ref->{'font'});
4321: delete($attr_ref->{'link'});
4322: delete($attr_ref->{'alink'});
4323: delete($attr_ref->{'vlink'});
4324: delete($attr_ref->{'bgcolor'});
4325: delete($attr_ref->{'background'});
4326: }
4327:
1.330 albertel 4328: my $attr_string;
4329: foreach my $attr (keys(%$attr_ref)) {
4330: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4331: }
4332: return $attr_string;
4333: }
4334:
4335:
1.182 matthew 4336: ###############################################
1.251 albertel 4337: ###############################################
4338:
4339: =pod
4340:
4341: =item * &endbodytag()
4342:
4343: Returns a uniform footer for LON-CAPA web pages.
4344:
1.635 raeburn 4345: Inputs: 1 - optional reference to an args hash
4346: If in the hash, key for noredirectlink has a value which evaluates to true,
4347: a 'Continue' link is not displayed if the page contains an
4348: internal redirect in the <head></head> section,
4349: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4350:
4351: =cut
4352:
4353: sub endbodytag {
1.635 raeburn 4354: my ($args) = @_;
1.251 albertel 4355: my $endbodytag='</body>';
1.269 albertel 4356: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4357: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4358: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4359: $endbodytag=
4360: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4361: &mt('Continue').'</a>'.
4362: $endbodytag;
4363: }
1.315 albertel 4364: }
1.251 albertel 4365: return $endbodytag;
4366: }
4367:
1.352 albertel 4368: =pod
4369:
4370: =item * &standard_css()
4371:
4372: Returns a style sheet
4373:
4374: Inputs: (all optional)
4375: domain -> force to color decorate a page for a specific
4376: domain
4377: function -> force usage of a specific rolish color scheme
4378: bgcolor -> override the default page bgcolor
4379:
4380: =cut
4381:
1.343 albertel 4382: sub standard_css {
1.345 albertel 4383: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4384: $function = &get_users_function() if (!$function);
4385: my $img = &designparm($function.'.img', $domain);
4386: my $tabbg = &designparm($function.'.tabbg', $domain);
4387: my $font = &designparm($function.'.font', $domain);
1.345 albertel 4388: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4389: my $pgbg_or_bgcolor =
4390: $bgcolor ||
1.352 albertel 4391: &designparm($function.'.pgbg', $domain);
1.382 albertel 4392: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4393: my $alink = &designparm($function.'.alink', $domain);
4394: my $vlink = &designparm($function.'.vlink', $domain);
4395: my $link = &designparm($function.'.link', $domain);
4396:
1.704 muellerd 4397: my $loginbg = &designparm('login.sidebg',$domain);
4398:
1.602 albertel 4399: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4400: my $mono = 'monospace';
1.352 albertel 4401: my $data_table_head = $tabbg;
4402: my $data_table_light = '#EEEEEE';
1.470 banghart 4403: my $data_table_dark = '#DDDDDD';
4404: my $data_table_darker = '#CCCCCC';
1.349 albertel 4405: my $data_table_highlight = '#FFFF00';
1.352 albertel 4406: my $mail_new = '#FFBB77';
4407: my $mail_new_hover = '#DD9955';
4408: my $mail_read = '#BBBB77';
4409: my $mail_read_hover = '#999944';
4410: my $mail_replied = '#AAAA88';
4411: my $mail_replied_hover = '#888855';
4412: my $mail_other = '#99BBBB';
4413: my $mail_other_hover = '#669999';
1.391 albertel 4414: my $table_header = '#DDDDDD';
1.489 raeburn 4415: my $feedback_link_bg = '#BBBBBB';
1.701 harmsja 4416: my $lg_border_color = '#C8C8C8';
1.392 albertel 4417:
1.608 albertel 4418: my $border = ($env{'browser.type'} eq 'explorer' ||
4419: $env{'browser.type'} eq 'safari' ) ? '0px 2px 0px 2px'
4420: : '0px 3px 0px 4px';
1.448 albertel 4421:
1.523 albertel 4422:
1.343 albertel 4423: return <<END;
1.698 harmsja 4424: body{
4425: font-family: $sans;
4426: line-height:130%;
1.701 harmsja 4427: font-size:0.83em;
1.698 harmsja 4428: color:$font;
4429: }
1.701 harmsja 4430: a:link, a:visited { font-size:100%; }
1.698 harmsja 4431:
1.343 albertel 4432: a:focus { color: red; background: yellow }
1.510 albertel 4433: table.thinborder,
4434: table.thinborder tr th {
4435: border-style: solid;
4436: border-width: 1px;
1.698 harmsja 4437: border-color: $lg_border_color;
1.510 albertel 4438: background: $tabbg;
4439: }
1.523 albertel 4440: table.thinborder tr td {
1.510 albertel 4441: border-style: solid;
1.698 harmsja 4442: border-width: 1px;
4443: border-color: $lg_border_color;
1.510 albertel 4444: }
1.426 albertel 4445:
1.343 albertel 4446: form, .inline { display: inline; }
4447: .center { text-align: center; }
1.701 harmsja 4448: .left { text-align:left; }
4449: .right {text-align:right;}
4450: .middle {vertical-align:middle;}
4451: .top {vertical-align:top;}
4452: .bottom {vertical-align:bottom;}
1.593 albertel 4453: .LC_filename {font-family: $mono; white-space:pre;}
1.350 albertel 4454: .LC_error {
4455: color: red;
4456: font-size: larger;
4457: }
1.457 albertel 4458: .LC_warning,
4459: .LC_diff_removed {
1.394 albertel 4460: color: red;
4461: }
1.532 albertel 4462:
4463: .LC_info,
1.457 albertel 4464: .LC_success,
4465: .LC_diff_added {
1.350 albertel 4466: color: green;
4467: }
1.543 albertel 4468: .LC_unknown {
4469: color: yellow;
4470: }
4471:
1.440 albertel 4472: .LC_icon {
4473: border: 0px;
4474: }
1.539 albertel 4475: .LC_indexer_icon {
4476: border: 0px;
4477: height: 22px;
4478: }
1.543 albertel 4479: .LC_docs_spacer {
4480: width: 25px;
4481: height: 1px;
4482: border: 0px;
4483: }
1.346 albertel 4484:
1.532 albertel 4485: .LC_internal_info {
4486: color: #999;
4487: }
4488:
1.458 albertel 4489: table.LC_pastsubmission {
4490: border: 1px solid black;
4491: margin: 2px;
4492: }
4493:
1.606 albertel 4494: table#LC_top_nav, table#LC_menubuttons,table#LC_nav_location {
1.345 albertel 4495: width: 100%;
4496: background: $pgbg;
1.392 albertel 4497: border: 2px;
1.402 albertel 4498: border-collapse: separate;
1.403 albertel 4499: padding: 0px;
1.345 albertel 4500: }
1.392 albertel 4501:
1.606 albertel 4502: table#LC_title_bar, table.LC_breadcrumbs,
1.393 albertel 4503: table#LC_title_bar.LC_with_remote {
1.359 albertel 4504: width: 100%;
1.392 albertel 4505: border-color: $pgbg;
4506: border-style: solid;
4507: border-width: $border;
4508:
1.379 albertel 4509: background: $pgbg;
4510: font-family: $sans;
1.392 albertel 4511: border-collapse: collapse;
1.403 albertel 4512: padding: 0px;
1.359 albertel 4513: }
1.409 albertel 4514: table.LC_docs_path {
4515: width: 100%;
4516: border: 0;
4517: background: $pgbg;
4518: font-family: $sans;
4519: border-collapse: collapse;
4520: padding: 0px;
4521: }
4522:
1.359 albertel 4523: table#LC_title_bar td {
4524: background: $tabbg;
4525: }
4526: table#LC_title_bar td.LC_title_bar_who {
4527: background: $tabbg;
4528: color: $font;
1.427 albertel 4529: font: small $sans;
1.359 albertel 4530: text-align: right;
4531: }
1.469 banghart 4532: span.LC_metadata {
4533: font-family: $sans;
4534: }
1.359 albertel 4535: span.LC_title_bar_title {
1.416 albertel 4536: font: bold x-large $sans;
1.359 albertel 4537: }
4538: table#LC_title_bar td.LC_title_bar_domain_logo {
4539: background: $sidebg;
4540: text-align: right;
1.368 albertel 4541: padding: 0px;
4542: }
4543: table#LC_title_bar td.LC_title_bar_role_logo {
4544: background: $sidebg;
4545: padding: 0px;
1.359 albertel 4546: }
4547:
1.346 albertel 4548: table#LC_menubuttons_mainmenu {
1.526 www 4549: width: 100%;
1.346 albertel 4550: border: 0px;
4551: border-spacing: 1px;
1.372 albertel 4552: padding: 0px 1px;
1.346 albertel 4553: margin: 0px;
4554: border-collapse: separate;
4555: }
4556: table#LC_menubuttons img, table#LC_menubuttons_mainmenu img {
4557: border: 0px;
4558: }
1.345 albertel 4559: table#LC_top_nav td {
4560: background: $tabbg;
1.392 albertel 4561: border: 0px;
1.407 albertel 4562: font-size: small;
1.345 albertel 4563: }
4564: table#LC_top_nav td a, div#LC_top_nav a {
4565: color: $font;
4566: font-family: $sans;
4567: }
1.364 albertel 4568: table#LC_top_nav td.LC_top_nav_logo {
4569: background: $tabbg;
1.432 albertel 4570: text-align: left;
1.408 albertel 4571: white-space: nowrap;
1.432 albertel 4572: width: 31px;
1.408 albertel 4573: }
4574: table#LC_top_nav td.LC_top_nav_logo img {
1.432 albertel 4575: border: 0px;
1.408 albertel 4576: vertical-align: bottom;
1.364 albertel 4577: }
1.432 albertel 4578: table#LC_top_nav td.LC_top_nav_exit,
4579: table#LC_top_nav td.LC_top_nav_help {
4580: width: 2.0em;
4581: }
1.442 albertel 4582: table#LC_top_nav td.LC_top_nav_login {
4583: width: 4.0em;
4584: text-align: center;
4585: }
1.409 albertel 4586: table.LC_breadcrumbs td, table.LC_docs_path td {
1.357 albertel 4587: background: $tabbg;
4588: color: $font;
4589: font-family: $sans;
1.358 albertel 4590: font-size: smaller;
1.357 albertel 4591: }
1.411 albertel 4592: table.LC_breadcrumbs td.LC_breadcrumbs_component,
1.409 albertel 4593: table.LC_docs_path td.LC_docs_path_component {
1.357 albertel 4594: background: $tabbg;
4595: color: $font;
4596: font-family: $sans;
4597: font-size: larger;
4598: text-align: right;
4599: }
1.383 albertel 4600: td.LC_table_cell_checkbox {
4601: text-align: center;
4602: }
1.522 albertel 4603: table#LC_mainmenu td.LC_mainmenu_column {
4604: vertical-align: top;
4605: }
4606:
1.705 ! tempelho 4607: .LC_fontsize_small
! 4608: {
! 4609: font-size: 70%;
! 4610: }
! 4611:
! 4612: .LC_fontsize_medium
! 4613: {
! 4614: font-size: 85%;
! 4615: }
! 4616:
! 4617: .LC_fontsize_large
! 4618: {
! 4619: font-size: 120%;
! 4620: }
! 4621:
! 4622: .LC_fontcolor_red
! 4623: {
! 4624: color: #FF0000;
! 4625: }
! 4626:
1.346 albertel 4627: .LC_menubuttons_inline_text {
4628: color: $font;
4629: font-family: $sans;
1.698 harmsja 4630: font-size: 90%;
1.701 harmsja 4631: padding-left:3px;
1.346 albertel 4632: }
4633:
1.526 www 4634: .LC_menubuttons_link {
4635: text-decoration: none;
4636: }
1.698 harmsja 4637: /*2008--9-5: new menu style sheet.Changed category*/
1.522 albertel 4638: .LC_menubuttons_category {
1.521 www 4639: color: $font;
1.526 www 4640: background: $pgbg;
1.521 www 4641: font-family: $sans;
4642: font-size: larger;
4643: font-weight: bold;
4644: }
4645:
1.346 albertel 4646: td.LC_menubuttons_text {
1.701 harmsja 4647: color: $font;
1.346 albertel 4648: }
4649: td.LC_menubuttons_img {
4650: }
1.526 www 4651:
1.346 albertel 4652: .LC_current_location {
4653: font-family: $sans;
4654: background: $tabbg;
4655: }
4656: .LC_new_mail {
4657: font-family: $sans;
1.634 www 4658: background: $tabbg;
1.346 albertel 4659: font-weight: bold;
4660: }
1.347 albertel 4661:
1.526 www 4662: .LC_rolesmenu_is {
4663: font-family: $sans;
4664: }
4665:
4666: .LC_rolesmenu_selected {
4667: font-family: $sans;
4668: }
4669:
4670: .LC_rolesmenu_future {
4671: font-family: $sans;
4672: }
4673:
4674:
4675: .LC_rolesmenu_will {
4676: font-family: $sans;
4677: }
4678:
4679: .LC_rolesmenu_will_not {
4680: font-family: $sans;
4681: }
4682:
4683: .LC_rolesmenu_expired {
4684: font-family: $sans;
4685: }
4686:
4687: .LC_rolesinfo {
4688: font-family: $sans;
4689: }
4690:
1.527 www 4691: .LC_dropadd_labeltext {
4692: font-family: $sans;
4693: text-align: right;
4694: }
4695:
4696: .LC_preferences_labeltext {
4697: font-family: $sans;
4698: text-align: right;
4699: }
4700:
1.666 raeburn 4701: .LC_roleslog_note {
1.701 harmsja 4702: font-size: small;
1.666 raeburn 4703: }
4704:
1.440 albertel 4705: table.LC_aboutme_port {
4706: border: 0px;
4707: border-collapse: collapse;
4708: border-spacing: 0px;
4709: }
1.349 albertel 4710: table.LC_data_table, table.LC_mail_list {
1.347 albertel 4711: border: 1px solid #000000;
1.402 albertel 4712: border-collapse: separate;
1.426 albertel 4713: border-spacing: 1px;
1.610 albertel 4714: background: $pgbg;
1.347 albertel 4715: }
1.422 albertel 4716: .LC_data_table_dense {
4717: font-size: small;
4718: }
1.507 raeburn 4719: table.LC_nested_outer {
4720: border: 1px solid #000000;
1.589 raeburn 4721: border-collapse: collapse;
1.507 raeburn 4722: border-spacing: 0px;
4723: width: 100%;
4724: }
4725: table.LC_nested {
4726: border: 0px;
1.589 raeburn 4727: border-collapse: collapse;
1.507 raeburn 4728: border-spacing: 0px;
4729: width: 100%;
4730: }
1.523 albertel 4731: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
4732: table.LC_prior_tries tr th {
1.349 albertel 4733: font-weight: bold;
4734: background-color: $data_table_head;
1.701 harmsja 4735: font-size:90%;
1.347 albertel 4736: }
1.610 albertel 4737: table.LC_data_table tr.LC_odd_row > td,
1.440 albertel 4738: table.LC_aboutme_port tr td {
1.349 albertel 4739: background-color: $data_table_light;
1.425 albertel 4740: padding: 2px;
1.347 albertel 4741: }
1.610 albertel 4742: table.LC_data_table tr.LC_even_row > td,
1.440 albertel 4743: table.LC_aboutme_port tr.LC_even_row td {
1.349 albertel 4744: background-color: $data_table_dark;
1.347 albertel 4745: }
1.425 albertel 4746: table.LC_data_table tr.LC_data_table_highlight td {
4747: background-color: $data_table_darker;
4748: }
1.639 raeburn 4749: table.LC_data_table tr td.LC_leftcol_header {
4750: background-color: $data_table_head;
4751: font-weight: bold;
4752: }
1.451 albertel 4753: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 4754: table.LC_nested tr.LC_empty_row td {
1.347 albertel 4755: background-color: #FFFFFF;
1.421 albertel 4756: font-weight: bold;
4757: font-style: italic;
4758: text-align: center;
4759: padding: 8px;
1.347 albertel 4760: }
1.507 raeburn 4761: table.LC_nested tr.LC_empty_row td {
1.465 albertel 4762: padding: 4ex
4763: }
1.507 raeburn 4764: table.LC_nested_outer tr th {
4765: font-weight: bold;
4766: background-color: $data_table_head;
1.701 harmsja 4767: font-size: small;
1.507 raeburn 4768: border-bottom: 1px solid #000000;
4769: }
4770: table.LC_nested_outer tr td.LC_subheader {
4771: background-color: $data_table_head;
4772: font-weight: bold;
4773: font-size: small;
4774: border-bottom: 1px solid #000000;
4775: text-align: right;
1.451 albertel 4776: }
1.507 raeburn 4777: table.LC_nested tr.LC_info_row td {
1.451 albertel 4778: background-color: #CCC;
4779: font-weight: bold;
4780: font-size: small;
1.507 raeburn 4781: text-align: center;
4782: }
1.589 raeburn 4783: table.LC_nested tr.LC_info_row td.LC_left_item,
4784: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 4785: text-align: left;
1.451 albertel 4786: }
1.507 raeburn 4787: table.LC_nested td {
1.451 albertel 4788: background-color: #FFF;
4789: font-size: small;
1.507 raeburn 4790: }
4791: table.LC_nested_outer tr th.LC_right_item,
4792: table.LC_nested tr.LC_info_row td.LC_right_item,
4793: table.LC_nested tr.LC_odd_row td.LC_right_item,
4794: table.LC_nested tr td.LC_right_item {
1.451 albertel 4795: text-align: right;
4796: }
4797:
1.507 raeburn 4798: table.LC_nested tr.LC_odd_row td {
1.451 albertel 4799: background-color: #EEE;
4800: }
4801:
1.473 raeburn 4802: table.LC_createuser {
4803: }
4804:
4805: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 4806: font-size: small;
1.473 raeburn 4807: }
4808:
4809: table.LC_createuser tr.LC_info_row td {
4810: background-color: #CCC;
4811: font-weight: bold;
4812: text-align: center;
4813: }
4814:
1.349 albertel 4815: table.LC_calendar {
4816: border: 1px solid #000000;
4817: border-collapse: collapse;
4818: }
4819: table.LC_calendar_pickdate {
4820: font-size: xx-small;
4821: }
4822: table.LC_calendar tr td {
4823: border: 1px solid #000000;
4824: vertical-align: top;
4825: }
4826: table.LC_calendar tr td.LC_calendar_day_empty {
4827: background-color: $data_table_dark;
4828: }
4829: table.LC_calendar tr td.LC_calendar_day_current {
4830: background-color: $data_table_highlight;
4831: }
4832:
4833: table.LC_mail_list tr.LC_mail_new {
4834: background-color: $mail_new;
4835: }
4836: table.LC_mail_list tr.LC_mail_new:hover {
4837: background-color: $mail_new_hover;
4838: }
4839: table.LC_mail_list tr.LC_mail_read {
4840: background-color: $mail_read;
4841: }
4842: table.LC_mail_list tr.LC_mail_read:hover {
4843: background-color: $mail_read_hover;
4844: }
4845: table.LC_mail_list tr.LC_mail_replied {
4846: background-color: $mail_replied;
4847: }
4848: table.LC_mail_list tr.LC_mail_replied:hover {
4849: background-color: $mail_replied_hover;
4850: }
4851: table.LC_mail_list tr.LC_mail_other {
4852: background-color: $mail_other;
4853: }
4854: table.LC_mail_list tr.LC_mail_other:hover {
4855: background-color: $mail_other_hover;
4856: }
1.494 raeburn 4857: table.LC_mail_list tr.LC_mail_even {
4858: }
4859: table.LC_mail_list tr.LC_mail_odd {
4860: }
4861:
1.391 albertel 4862: table#LC_cstr_controls {
4863: width: 100%;
4864: border-collapse: collapse;
4865: }
4866: table#LC_cstr_controls tr td {
4867: border: 4px solid $pgbg;
4868: padding: 4px;
4869: text-align: center;
4870: background: $tabbg;
4871: }
4872: table#LC_cstr_controls tr th {
4873: border: 4px solid $pgbg;
4874: background: $table_header;
4875: text-align: center;
4876: font-family: $sans;
4877: font-size: smaller;
4878: }
4879:
1.696 bisitz 4880: table.LC_data_table tr > td.LC_browser_file,
4881: table.LC_data_table tr > td.LC_browser_file_published {
1.389 albertel 4882: background: #CCFF88;
4883: }
1.696 bisitz 4884: table.LC_data_table tr > td.LC_browser_file_locked,
4885: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 4886: background: #FFAA99;
1.387 albertel 4887: }
1.696 bisitz 4888: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.389 albertel 4889: background: #AAAAAA;
1.387 albertel 4890: }
1.696 bisitz 4891: table.LC_data_table tr > td.LC_browser_file_modified,
4892: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.389 albertel 4893: background: #FFFF77;
1.387 albertel 4894: }
1.696 bisitz 4895: table.LC_data_table tr.LC_browser_folder > td {
1.389 albertel 4896: background: #CCCCFF;
1.387 albertel 4897: }
1.696 bisitz 4898:
1.388 albertel 4899: span.LC_current_location {
1.701 harmsja 4900: font-size:larger;
1.388 albertel 4901: background: $pgbg;
4902: }
1.387 albertel 4903:
1.395 albertel 4904: span.LC_parm_menu_item {
4905: font-size: larger;
4906: font-family: $sans;
4907: }
4908: span.LC_parm_scope_all {
4909: color: red;
4910: }
4911: span.LC_parm_scope_folder {
4912: color: green;
4913: }
4914: span.LC_parm_scope_resource {
4915: color: orange;
4916: }
4917: span.LC_parm_part {
4918: color: blue;
4919: }
4920: span.LC_parm_folder, span.LC_parm_symb {
4921: font-size: x-small;
4922: font-family: $mono;
4923: color: #AAAAAA;
4924: }
4925:
1.396 albertel 4926: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
4927: td.LC_parm_overview_parm_selectors, td.LC_parm_overview_parm_restrictions {
4928: border: 1px solid black;
4929: border-collapse: collapse;
4930: }
4931: table.LC_parm_overview_restrictions td {
4932: border-width: 1px 4px 1px 4px;
4933: border-style: solid;
4934: border-color: $pgbg;
4935: text-align: center;
4936: }
4937: table.LC_parm_overview_restrictions th {
4938: background: $tabbg;
4939: border-width: 1px 4px 1px 4px;
4940: border-style: solid;
4941: border-color: $pgbg;
4942: }
1.398 albertel 4943: table#LC_helpmenu {
4944: border: 0px;
4945: height: 55px;
4946: border-spacing: 0px;
4947: }
4948:
4949: table#LC_helpmenu fieldset legend {
4950: font-size: larger;
4951: font-weight: bold;
4952: }
1.397 albertel 4953: table#LC_helpmenu_links {
4954: width: 100%;
4955: border: 1px solid black;
4956: background: $pgbg;
4957: padding: 0px;
4958: border-spacing: 1px;
4959: }
4960: table#LC_helpmenu_links tr td {
4961: padding: 1px;
4962: background: $tabbg;
1.399 albertel 4963: text-align: center;
4964: font-weight: bold;
1.397 albertel 4965: }
1.396 albertel 4966:
1.397 albertel 4967: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
4968: table#LC_helpmenu_links a:active {
4969: text-decoration: none;
4970: color: $font;
4971: }
4972: table#LC_helpmenu_links a:hover {
4973: text-decoration: underline;
4974: color: $vlink;
4975: }
1.396 albertel 4976:
1.417 albertel 4977: .LC_chrt_popup_exists {
4978: border: 1px solid #339933;
4979: margin: -1px;
4980: }
4981: .LC_chrt_popup_up {
4982: border: 1px solid yellow;
4983: margin: -1px;
4984: }
4985: .LC_chrt_popup {
4986: border: 1px solid #8888FF;
4987: background: #CCCCFF;
4988: }
1.421 albertel 4989: table.LC_pick_box {
4990: border-collapse: separate;
4991: background: white;
4992: border: 1px solid black;
4993: border-spacing: 1px;
4994: }
4995: table.LC_pick_box td.LC_pick_box_title {
4996: background: $tabbg;
4997: font-weight: bold;
4998: text-align: right;
4999: width: 184px;
5000: padding: 8px;
5001: }
1.645 raeburn 5002: table.LC_pick_box td.LC_selfenroll_pick_box_title {
5003: background: $tabbg;
5004: font-weight: bold;
5005: text-align: right;
5006: width: 350px;
5007: padding: 8px;
5008: }
5009:
1.579 raeburn 5010: table.LC_pick_box td.LC_pick_box_value {
5011: text-align: left;
5012: padding: 8px;
5013: }
5014: table.LC_pick_box td.LC_pick_box_select {
5015: text-align: left;
5016: padding: 8px;
5017: }
1.424 albertel 5018: table.LC_pick_box td.LC_pick_box_separator {
1.421 albertel 5019: padding: 0px;
5020: height: 1px;
5021: background: black;
5022: }
5023: table.LC_pick_box td.LC_pick_box_submit {
5024: text-align: right;
5025: }
1.579 raeburn 5026: table.LC_pick_box td.LC_evenrow_value {
5027: text-align: left;
5028: padding: 8px;
5029: background-color: $data_table_light;
5030: }
5031: table.LC_pick_box td.LC_oddrow_value {
5032: text-align: left;
5033: padding: 8px;
5034: background-color: $data_table_light;
5035: }
5036: table.LC_helpform_receipt {
5037: width: 620px;
5038: border-collapse: separate;
5039: background: white;
5040: border: 1px solid black;
5041: border-spacing: 1px;
5042: }
5043: table.LC_helpform_receipt td.LC_pick_box_title {
5044: background: $tabbg;
5045: font-weight: bold;
5046: text-align: right;
5047: width: 184px;
5048: padding: 8px;
5049: }
5050: table.LC_helpform_receipt td.LC_evenrow_value {
5051: text-align: left;
5052: padding: 8px;
5053: background-color: $data_table_light;
5054: }
5055: table.LC_helpform_receipt td.LC_oddrow_value {
5056: text-align: left;
5057: padding: 8px;
5058: background-color: $data_table_light;
5059: }
5060: table.LC_helpform_receipt td.LC_pick_box_separator {
5061: padding: 0px;
5062: height: 1px;
5063: background: black;
5064: }
5065: span.LC_helpform_receipt_cat {
5066: font-weight: bold;
5067: }
1.424 albertel 5068: table.LC_group_priv_box {
5069: background: white;
5070: border: 1px solid black;
5071: border-spacing: 1px;
5072: }
5073: table.LC_group_priv_box td.LC_pick_box_title {
5074: background: $tabbg;
5075: font-weight: bold;
5076: text-align: right;
5077: width: 184px;
5078: }
5079: table.LC_group_priv_box td.LC_groups_fixed {
5080: background: $data_table_light;
5081: text-align: center;
5082: }
5083: table.LC_group_priv_box td.LC_groups_optional {
5084: background: $data_table_dark;
5085: text-align: center;
5086: }
5087: table.LC_group_priv_box td.LC_groups_functionality {
5088: background: $data_table_darker;
5089: text-align: center;
5090: font-weight: bold;
5091: }
5092: table.LC_group_priv td {
5093: text-align: left;
5094: padding: 0px;
5095: }
5096:
1.421 albertel 5097: table.LC_notify_front_page {
5098: background: white;
5099: border: 1px solid black;
5100: padding: 8px;
5101: }
5102: table.LC_notify_front_page td {
5103: padding: 8px;
5104: }
1.424 albertel 5105: .LC_navbuttons {
5106: margin: 2ex 0ex 2ex 0ex;
5107: }
1.423 albertel 5108: .LC_topic_bar {
5109: font-family: $sans;
5110: font-weight: bold;
5111: width: 100%;
5112: background: $tabbg;
5113: vertical-align: middle;
5114: margin: 2ex 0ex 2ex 0ex;
5115: }
5116: .LC_topic_bar span {
5117: vertical-align: middle;
5118: }
5119: .LC_topic_bar img {
5120: vertical-align: bottom;
5121: }
5122: table.LC_course_group_status {
5123: margin: 20px;
5124: }
5125: table.LC_status_selector td {
5126: vertical-align: top;
5127: text-align: center;
1.424 albertel 5128: padding: 4px;
5129: }
5130: table.LC_descriptive_input td.LC_description {
5131: vertical-align: top;
5132: text-align: right;
5133: font-weight: bold;
1.423 albertel 5134: }
1.599 albertel 5135: div.LC_feedback_link {
1.616 albertel 5136: clear: both;
1.599 albertel 5137: background: white;
5138: width: 100%;
1.489 raeburn 5139: }
5140: span.LC_feedback_link {
1.599 albertel 5141: background: $feedback_link_bg;
5142: font-size: larger;
5143: }
5144: span.LC_message_link {
5145: background: $feedback_link_bg;
5146: font-size: larger;
5147: position: absolute;
5148: right: 1em;
1.489 raeburn 5149: }
1.421 albertel 5150:
1.515 albertel 5151: table.LC_prior_tries {
1.524 albertel 5152: border: 1px solid #000000;
5153: border-collapse: separate;
5154: border-spacing: 1px;
1.515 albertel 5155: }
1.523 albertel 5156:
1.515 albertel 5157: table.LC_prior_tries td {
1.524 albertel 5158: padding: 2px;
1.515 albertel 5159: }
1.523 albertel 5160:
5161: .LC_answer_correct {
5162: background: #AAFFAA;
5163: color: black;
5164: }
5165: .LC_answer_charged_try {
5166: background: #FFAAAA ! important;
5167: color: black;
5168: }
5169: .LC_answer_not_charged_try,
5170: .LC_answer_no_grade,
5171: .LC_answer_late {
5172: background: #FFFFAA;
5173: color: black;
5174: }
5175: .LC_answer_previous {
5176: background: #AAAAFF;
5177: color: black;
5178: }
5179: .LC_answer_no_message {
5180: background: #FFFFFF;
5181: color: black;
5182: }
5183: .LC_answer_unknown {
5184: background: orange;
5185: color: black;
5186: }
5187:
5188:
1.529 albertel 5189: span.LC_prior_numerical,
5190: span.LC_prior_string,
5191: span.LC_prior_custom,
5192: span.LC_prior_reaction,
5193: span.LC_prior_math {
1.523 albertel 5194: font-family: monospace;
5195: white-space: pre;
5196: }
5197:
1.525 albertel 5198: span.LC_prior_string {
5199: font-family: monospace;
5200: white-space: pre;
5201: }
5202:
1.523 albertel 5203: table.LC_prior_option {
5204: width: 100%;
5205: border-collapse: collapse;
5206: }
1.528 albertel 5207: table.LC_prior_rank, table.LC_prior_match {
5208: border-collapse: collapse;
5209: }
5210: table.LC_prior_option tr td,
5211: table.LC_prior_rank tr td,
5212: table.LC_prior_match tr td {
1.524 albertel 5213: border: 1px solid #000000;
1.515 albertel 5214: }
5215:
1.519 raeburn 5216: span.LC_nobreak {
1.544 albertel 5217: white-space: nowrap;
1.519 raeburn 5218: }
5219:
1.576 raeburn 5220: span.LC_cusr_emph {
5221: font-style: italic;
5222: }
5223:
1.633 raeburn 5224: span.LC_cusr_subheading {
5225: font-weight: normal;
5226: font-size: 85%;
5227: }
5228:
1.545 albertel 5229: table.LC_docs_documents {
5230: background: #BBBBBB;
1.547 albertel 5231: border-width: 0px;
1.545 albertel 5232: border-collapse: collapse;
5233: }
5234:
5235: table.LC_docs_documents td.LC_docs_document {
5236: border: 2px solid black;
5237: padding: 4px;
5238: }
5239:
5240: .LC_docs_course_commands div {
5241: float: left;
5242: border: 4px solid #AAAAAA;
5243: padding: 4px;
5244: background: #DDDDCC;
5245: }
5246:
5247: .LC_docs_entry_move {
5248: border: 0px;
5249: border-collapse: collapse;
1.544 albertel 5250: }
5251:
1.545 albertel 5252: .LC_docs_entry_move td {
5253: border: 2px solid #BBBBBB;
5254: background: #DDDDDD;
5255: }
5256:
5257: .LC_docs_editor td.LC_docs_entry_commands {
5258: background: #DDDDDD;
5259: font-size: x-small;
5260: }
1.544 albertel 5261: .LC_docs_copy {
1.545 albertel 5262: color: #000099;
1.544 albertel 5263: }
5264: .LC_docs_cut {
1.545 albertel 5265: color: #550044;
1.544 albertel 5266: }
5267: .LC_docs_rename {
1.545 albertel 5268: color: #009900;
1.544 albertel 5269: }
5270: .LC_docs_remove {
1.545 albertel 5271: color: #990000;
5272: }
5273:
1.547 albertel 5274: .LC_docs_reinit_warn,
5275: .LC_docs_ext_edit {
5276: font-size: x-small;
5277: }
5278:
1.545 albertel 5279: .LC_docs_editor td.LC_docs_entry_title,
5280: .LC_docs_editor td.LC_docs_entry_icon {
5281: background: #FFFFBB;
5282: }
5283: .LC_docs_editor td.LC_docs_entry_parameter {
5284: background: #BBBBFF;
5285: font-size: x-small;
5286: white-space: nowrap;
5287: }
5288:
5289: table.LC_docs_adddocs td,
5290: table.LC_docs_adddocs th {
5291: border: 1px solid #BBBBBB;
5292: padding: 4px;
5293: background: #DDDDDD;
1.543 albertel 5294: }
5295:
1.584 albertel 5296: table.LC_sty_begin {
5297: background: #BBFFBB;
5298: }
5299: table.LC_sty_end {
5300: background: #FFBBBB;
5301: }
5302:
1.589 raeburn 5303: table.LC_double_column {
5304: border-width: 0px;
5305: border-collapse: collapse;
5306: width: 100%;
5307: padding: 2px;
5308: }
5309:
5310: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5311: top: 2px;
1.589 raeburn 5312: left: 2px;
5313: width: 47%;
5314: vertical-align: top;
5315: }
5316:
5317: table.LC_double_column tr td.LC_right_col {
5318: top: 2px;
5319: right: 2px;
5320: width: 47%;
5321: vertical-align: top;
5322: }
5323:
1.594 raeburn 5324: span.LC_role_level {
5325: font-weight: bold;
5326: }
5327:
1.591 raeburn 5328: div.LC_left_float {
5329: float: left;
5330: padding-right: 5%;
1.597 albertel 5331: padding-bottom: 4px;
1.591 raeburn 5332: }
5333:
5334: div.LC_clear_float_header {
1.597 albertel 5335: padding-bottom: 2px;
1.591 raeburn 5336: }
5337:
5338: div.LC_clear_float_footer {
1.597 albertel 5339: padding-top: 10px;
1.591 raeburn 5340: clear: both;
5341: }
5342:
1.597 albertel 5343:
1.601 albertel 5344: div.LC_grade_select_mode {
1.604 albertel 5345: font-family: $sans;
1.601 albertel 5346: }
5347: div.LC_grade_select_mode div div {
5348: margin: 5px;
5349: }
5350: div.LC_grade_select_mode_selector {
5351: margin: 5px;
5352: float: left;
5353: }
5354: div.LC_grade_select_mode_selector_header {
1.705 ! tempelho 5355: font-weight: bold;
! 5356: font-size: medium;
1.601 albertel 5357: }
5358: div.LC_grade_select_mode_type {
5359: clear: left;
5360: }
5361:
1.597 albertel 5362: div.LC_grade_show_user {
5363: margin-top: 20px;
5364: border: 1px solid black;
5365: }
5366: div.LC_grade_user_name {
5367: background: #DDDDEE;
5368: border-bottom: 1px solid black;
1.705 ! tempelho 5369: font-weight: bold;
! 5370: font-size: large;
1.597 albertel 5371: }
5372: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5373: background: #DDEEDD;
5374: }
5375:
5376: div.LC_grade_show_problem,
5377: div.LC_grade_submissions,
5378: div.LC_grade_message_center,
5379: div.LC_grade_info_links,
5380: div.LC_grade_assign {
5381: margin: 5px;
5382: width: 99%;
5383: background: #FFFFFF;
5384: }
5385: div.LC_grade_show_problem_header,
5386: div.LC_grade_submissions_header,
5387: div.LC_grade_message_center_header,
5388: div.LC_grade_assign_header {
1.705 ! tempelho 5389: font-weight: bold;
! 5390: font-size: large;
1.597 albertel 5391: }
5392: div.LC_grade_show_problem_problem,
5393: div.LC_grade_submissions_body,
5394: div.LC_grade_message_center_body,
5395: div.LC_grade_assign_body {
5396: border: 1px solid black;
5397: width: 99%;
5398: background: #FFFFFF;
5399: }
1.598 albertel 5400: span.LC_grade_check_note {
1.705 ! tempelho 5401: font-weight: normal;
! 5402: font-size: medium;
1.598 albertel 5403: display: inline;
5404: position: absolute;
5405: right: 1em;
5406: }
1.597 albertel 5407:
1.613 albertel 5408: table.LC_scantron_action {
5409: width: 100%;
5410: }
5411: table.LC_scantron_action tr th {
1.698 harmsja 5412: font-weight:bold;
5413: font-style:normal;
1.613 albertel 5414: }
1.698 harmsja 5415: .LC_edit_problem_header,
1.614 albertel 5416: div.LC_edit_problem_footer {
1.705 ! tempelho 5417: font-weight: normal;
! 5418: font-size: medium;
1.602 albertel 5419: margin: 2px;
1.600 albertel 5420: }
5421: div.LC_edit_problem_header,
1.602 albertel 5422: div.LC_edit_problem_header div,
1.614 albertel 5423: div.LC_edit_problem_footer,
5424: div.LC_edit_problem_footer div,
1.602 albertel 5425: div.LC_edit_problem_editxml_header,
5426: div.LC_edit_problem_editxml_header div {
1.600 albertel 5427: margin-top: 5px;
5428: }
1.602 albertel 5429: div.LC_edit_problem_header_edit_row {
5430: background: $tabbg;
5431: padding: 3px;
5432: margin-bottom: 5px;
5433: }
1.600 albertel 5434: div.LC_edit_problem_header_title {
1.705 ! tempelho 5435: font-weight: bold;
! 5436: font-size: larger;
1.602 albertel 5437: background: $tabbg;
5438: padding: 3px;
5439: }
5440: table.LC_edit_problem_header_title {
1.705 ! tempelho 5441: font-size: larger;
! 5442: font-weight: bold;
1.602 albertel 5443: width: 100%;
5444: border-color: $pgbg;
5445: border-style: solid;
5446: border-width: $border;
5447:
1.600 albertel 5448: background: $tabbg;
1.602 albertel 5449: border-collapse: collapse;
5450: padding: 0px
5451: }
5452:
5453: div.LC_edit_problem_discards {
5454: float: left;
5455: padding-bottom: 5px;
5456: }
5457: div.LC_edit_problem_saves {
5458: float: right;
5459: padding-bottom: 5px;
1.600 albertel 5460: }
5461: hr.LC_edit_problem_divide {
1.602 albertel 5462: clear: both;
1.600 albertel 5463: color: $tabbg;
5464: background-color: $tabbg;
5465: height: 3px;
5466: border: 0px;
5467: }
1.679 riegler 5468: img.stift{
1.678 riegler 5469: border-width:0;
1.679 riegler 5470: vertical-align:middle;
1.677 riegler 5471: }
1.680 riegler 5472:
1.681 riegler 5473: table#LC_mainmenu{
5474: margin-top:10px;
5475: width:80%;
5476:
5477: }
5478:
1.680 riegler 5479: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
5480: vertical-align: top;
5481: width: 45%;
5482: }
5483: .LC_mainmenu_fieldset_category {
5484: color: $font;
5485: background: $pgbg;
5486: font-family: $sans;
5487: font-size: small;
5488: font-weight: bold;
5489: }
5490: fieldset#LC_mainmenu_fieldset {
1.681 riegler 5491: margin:0px 10px 10px 0px;
1.680 riegler 5492:
5493: }
1.693 droeschl 5494: /* ---- Remove when done ----
5495: # The following styles is part of the redesign of LON-CAPA and are
5496: # subject to change during this project.
5497: # Don't rely on their current functionality as they might be
5498: # changed or removed.
5499: # --------------------------*/
5500:
1.698 harmsja 5501: a:hover,
5502: ol.smallMenu a:hover,
5503: ol#MenuBreadcrumbs a:hover,
5504: ul#TabMainMenuContent a:hover,
5505: .FormSectionClearButton input:hover{
5506: color:#BF2317;
5507: text-decoration:none;
1.693 droeschl 5508: }
5509:
5510: h1 {
1.701 harmsja 5511: padding:5px 10px 5px 0px;
1.693 droeschl 5512: line-height:130%;
5513: }
1.698 harmsja 5514:
1.693 droeschl 5515: h2,h3,h4,h5,h6
5516: {
5517: margin:5px 0px 5px 0px;
5518: line-height:130%;
5519: }
1.698 harmsja 5520: .hcell{
5521: padding:3px 15px 3px 15px;
5522: margin:0px;
1.703 harmsja 5523: background-color:$tabbg;
5524: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5525: }
1.698 harmsja 5526: .noBorder {
5527: border:0px;
5528: }
5529: /*
5530: .bgLightGrey { background:URL(images/TabMenuBG.png) repeat-x left top; }
5531: .bgLightGreyYellow {background-color:#EFECE0;}
5532: */
1.693 droeschl 5533:
5534:
1.698 harmsja 5535: /* Main Header with discription of Person, Course, etc. */
1.693 droeschl 5536: .HeadRight {
5537: text-align: right;
5538: float: right;
5539: margin: 0px;
5540: padding: 0px;
1.698 harmsja 5541: right:0;
1.693 droeschl 5542: position:absolute;
1.698 harmsja 5543: overflow:hidden;
1.693 droeschl 5544: }
5545:
1.698 harmsja 5546: p {
5547: padding: 10px;
5548:
5549: }
5550: .FormSectionClearButton input {
5551: background-color:transparent;
5552: border:0px;
5553: cursor:pointer;
5554: text-decoration:underline;
1.693 droeschl 5555: }
5556:
5557:
1.698 harmsja 5558: dl,ul,div,fieldset {
5559: margin: 10px 10px 10px 0px;
1.693 droeschl 5560: overflow:hidden;
5561: }
1.698 harmsja 5562: ol.smallMenu {
5563: margin: 0px;
1.693 droeschl 5564: }
5565:
1.698 harmsja 5566: ol.smallMenu li {
1.693 droeschl 5567: display: inline;
5568: padding: 5px 5px 0px 10px;
5569: vertical-align: top;
5570: }
5571:
1.698 harmsja 5572: ol.smallMenu li img {
1.693 droeschl 5573: vertical-align: bottom;
5574: }
5575:
1.698 harmsja 5576: ol.smallMenu a {
1.693 droeschl 5577: font-size: 90%;
5578: color: RGB(80, 80, 80);
5579: text-decoration: none;
5580: }
5581:
1.698 harmsja 5582: ol#TabMainMenuContent {
1.693 droeschl 5583:
5584: margin: 0px 0px 10px 0px;
5585: padding: 0px;
5586: }
5587:
1.698 harmsja 5588: ol#TabMainMenuContent li {
1.693 droeschl 5589: display: inline;
5590: vertical-align: bottom;
5591: border-bottom: solid 1px RGB(175, 175, 175);
5592: border-right: solid 1px RGB(175, 175, 175);
5593: padding: 5px 15px 5px 15px;
5594: margin-right:4px;
5595: line-height: 140%;
5596: font-weight: bold;
5597: overflow:hidden;
1.698 harmsja 5598: /* background: RGB(211, 206, 205) URL(images/TabMenuBG.png) repeat-x left top;*/
1.693 droeschl 5599: }
5600:
1.698 harmsja 5601: ol#TabMainMenuContent li a{
1.693 droeschl 5602: color: RGB(47, 47, 47);
5603: text-decoration: none;
5604: }
5605:
1.698 harmsja 5606: ol#TabMainMenuContent div.columnSection {
1.693 droeschl 5607: margin-bottom: 0px;
5608: }
5609:
1.698 harmsja 5610: ol#MenuBreadcrumbs, ol#PathBreadcrumbs {
1.693 droeschl 5611: border-top: solid 1px RGB(255, 255, 255);
5612: height: 20px;
5613: line-height: 20px;
5614: vertical-align: bottom;
5615: margin: 0px 0px 30px 0px;
5616: padding-left: 10px;
5617: list-style-position: inside;
1.698 harmsja 5618: /* background: RGB(211, 206, 205) URL(images/TabMenuBG.png) repeat-x left
5619: top;*/
1.693 droeschl 5620: }
5621:
1.698 harmsja 5622: ol#MenuBreadcrumbs li, ol#PathBreadcrumbs li {
5623: /* background: url(images/pfeil_white.png) no-repeat left center;*/
1.693 droeschl 5624: display: inline;
5625: padding: 0px 0px 0px 10px;
5626: vertical-align: bottom;
5627: overflow:hidden;
5628: }
5629:
1.698 harmsja 5630: ol#MenuBreadcrumbs li a {
1.693 droeschl 5631: text-decoration: none;
5632: font-size:90%;
5633: }
1.698 harmsja 5634: ol#PathBreadcrumbs li a{
5635: text-decoration:none;
5636: font-size:100%;
5637: font-weight:bold;
1.693 droeschl 5638: }
5639:
1.698 harmsja 5640: .ContentBoxSpecial
1.693 droeschl 5641: {
1.701 harmsja 5642: border: solid 1px $lg_border_color;
1.698 harmsja 5643: }
5644: .ContentBox {
5645: padding:10px;
1.693 droeschl 5646: }
1.698 harmsja 5647: .PopUp
1.693 droeschl 5648: {
1.698 harmsja 5649: padding:10px;
5650: border-left:solid 1px $lg_border_color;
5651: border-top:solid 1px $lg_border_color;
5652: border-bottom:outset 1px $lg_border_color;
5653: border-right:outset 1px $lg_border_color;
5654: display:none;
5655: position:absolute;
5656: right:0;
5657: background-color:white;
5658: z-index:5;
1.693 droeschl 5659: }
5660:
1.698 harmsja 5661: dl.ListStyleClean dt {
1.693 droeschl 5662: padding-right: 5px;
5663: display: table-header-group;
5664: }
5665:
1.698 harmsja 5666: dl.ListStyleClean dd {
1.693 droeschl 5667: display: table-row;
5668: }
5669:
5670: .ListStyleClean,
5671: .ListStyleSimple,
5672: .ListStyleNormal,
5673: .ListStyleNormal_Border,
5674: .ListStyleSpecial
5675: {
5676: /*display:block; */
5677: list-style-position: inside;
5678: list-style-type: none;
5679: overflow: hidden;
5680: padding: 0px;
5681: }
5682:
5683: .ListStyleSimple li,
1.698 harmsja 5684: .ListStyleSimple dd,
1.693 droeschl 5685: .ListStyleNormal li,
1.698 harmsja 5686: .ListStyleNormal dd,
1.693 droeschl 5687: .ListStyleSpecial li,
1.698 harmsja 5688: .ListStyleSpecial dd
1.693 droeschl 5689: {
5690: margin: 0px;
5691: padding: 5px 5px 5px 10px;
5692: clear: both;
5693: }
5694:
1.698 harmsja 5695: .ListStyleClean li,
5696: .ListStyleClean dd {
1.693 droeschl 5697: padding-top: 0px;
5698: padding-bottom: 0px;
5699: }
5700:
1.698 harmsja 5701: .ListStyleSimple dd,
5702: .ListStyleSimple li{
5703: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 5704: }
5705:
1.698 harmsja 5706: .ListStyleSpecial li,
5707: .ListStyleSpecial dd {
1.693 droeschl 5708: list-style-type: none;
5709: background-color: RGB(220, 220, 220);
5710: margin-bottom: 4px;
5711: }
5712:
1.698 harmsja 5713: table.SimpleTable {
5714: margin:5px;
5715: border:solid 1px $lg_border_color;
1.693 droeschl 5716: }
5717:
1.698 harmsja 5718: table.SimpleTable tr {
5719: padding:0px;
5720: border:solid 1px $lg_border_color;
1.693 droeschl 5721: }
5722: table.SimpleTable thead{
1.698 harmsja 5723: background:rgb(220,220,220);
1.693 droeschl 5724: }
5725:
1.698 harmsja 5726: div.columnSection {
1.693 droeschl 5727: display: block;
5728: clear: both;
5729: overflow: hidden;
5730: margin:0px;
5731: }
5732:
1.698 harmsja 5733: div.columnSection>* {
1.693 droeschl 5734: float: left;
5735: margin: 10px 20px 10px 0px;
5736: overflow:hidden;
5737: }
1.698 harmsja 5738: div.columnSection > .ContentBox,
5739: div.columnSection > .ContentBoxSpecial
1.693 droeschl 5740: {
1.698 harmsja 5741: width: 400px;
1.693 droeschl 5742:
5743: }
5744:
1.694 tempelho 5745: .LC_loginpage_container {
5746: text-align:left;
5747: margin : 0 auto;
5748: width:65%;
5749: padding: 10px;
5750: height: auto;
1.704 muellerd 5751: # background-color:#FFFFFF;
5752: background-color:$loginbg;
1.694 tempelho 5753: border:1px solid #CCCCCC;
5754: }
5755:
5756:
5757: .LC_loginpage_loginContainer {
5758: float:left;
5759: width:60%;
5760: }
5761:
5762: .LC_loginpage_loginInfo {
5763: margin-top:20px;
5764: margin-left:20px;
5765: float:left;
5766: width:30%;
5767: border:1px solid #CCCCCC;
5768: padding:10px;
5769: }
5770:
5771: .LC_loginpage_space {
5772: clear:both;
5773: margin-bottom:20px;
5774: border-bottom: 1px solid #CCCCCC;
5775: }
5776:
5777: .LC_loginpage_fieldset{
5778: border: 1px solid #CCCCCC;
5779: margin: 0 auto;
5780: }
5781:
5782: .LC_loginpage_legend{
5783: padding: 2px;
5784: margin: 0px;
5785: font-size:14px;
5786: font-weight:bold;
5787: }
5788:
5789:
1.693 droeschl 5790:
1.343 albertel 5791: END
5792: }
5793:
1.306 albertel 5794: =pod
5795:
5796: =item * &headtag()
5797:
5798: Returns a uniform footer for LON-CAPA web pages.
5799:
1.307 albertel 5800: Inputs: $title - optional title for the head
5801: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 5802: $args - optional arguments
1.319 albertel 5803: force_register - if is true call registerurl so the remote is
5804: informed
1.415 albertel 5805: redirect -> array ref of
5806: 1- seconds before redirect occurs
5807: 2- url to redirect to
5808: 3- whether the side effect should occur
1.315 albertel 5809: (side effect of setting
5810: $env{'internal.head.redirect'} to the url
5811: redirected too)
1.352 albertel 5812: domain -> force to color decorate a page for a specific
5813: domain
5814: function -> force usage of a specific rolish color scheme
5815: bgcolor -> override the default page bgcolor
1.460 albertel 5816: no_auto_mt_title
5817: -> prevent &mt()ing the title arg
1.464 albertel 5818:
1.306 albertel 5819: =cut
5820:
5821: sub headtag {
1.313 albertel 5822: my ($title,$head_extra,$args) = @_;
1.306 albertel 5823:
1.363 albertel 5824: my $function = $args->{'function'} || &get_users_function();
5825: my $domain = $args->{'domain'} || &determinedomain();
5826: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 5827: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 5828: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 5829: #time(),
1.418 albertel 5830: $env{'environment.color.timestamp'},
1.363 albertel 5831: $function,$domain,$bgcolor);
5832:
1.369 www 5833: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 5834:
1.308 albertel 5835: my $result =
5836: '<head>'.
1.461 albertel 5837: &font_settings();
1.319 albertel 5838:
1.461 albertel 5839: if (!$args->{'frameset'}) {
5840: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
5841: }
1.319 albertel 5842: if ($args->{'force_register'}) {
5843: $result .= &Apache::lonmenu::registerurl(1);
5844: }
1.436 albertel 5845: if (!$args->{'no_nav_bar'}
5846: && !$args->{'only_body'}
5847: && !$args->{'frameset'}) {
5848: $result .= &help_menu_js();
5849: }
1.319 albertel 5850:
1.314 albertel 5851: if (ref($args->{'redirect'})) {
1.414 albertel 5852: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 5853: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 5854: if (!$inhibit_continue) {
5855: $env{'internal.head.redirect'} = $url;
5856: }
1.313 albertel 5857: $result.=<<ADDMETA
5858: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 5859: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 5860: ADDMETA
5861: }
1.306 albertel 5862: if (!defined($title)) {
5863: $title = 'The LearningOnline Network with CAPA';
5864: }
1.460 albertel 5865: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
5866: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 5867: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
5868: .$head_extra;
1.306 albertel 5869: return $result;
5870: }
5871:
5872: =pod
5873:
1.340 albertel 5874: =item * &font_settings()
5875:
5876: Returns neccessary <meta> to set the proper encoding
5877:
5878: Inputs: none
5879:
5880: =cut
5881:
5882: sub font_settings {
5883: my $headerstring='';
1.647 www 5884: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 5885: $headerstring.=
5886: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
5887: }
5888: return $headerstring;
5889: }
5890:
1.341 albertel 5891: =pod
5892:
5893: =item * &xml_begin()
5894:
5895: Returns the needed doctype and <html>
5896:
5897: Inputs: none
5898:
5899: =cut
5900:
5901: sub xml_begin {
5902: my $output='';
5903:
1.592 albertel 5904: if ($env{'internal.start_page'}==1) {
5905: &Apache::lonhtmlcommon::init_htmlareafields();
5906: }
1.342 albertel 5907:
1.341 albertel 5908: if ($env{'browser.mathml'}) {
5909: $output='<?xml version="1.0"?>'
5910: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
5911: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
5912:
5913: # .'<!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">] >'
5914: .'<!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">'
5915: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
5916: .'xmlns="http://www.w3.org/1999/xhtml">';
5917: } else {
5918: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
5919: }
5920: return $output;
5921: }
1.340 albertel 5922:
5923: =pod
5924:
1.306 albertel 5925: =item * &endheadtag()
5926:
5927: Returns a uniform </head> for LON-CAPA web pages.
5928:
5929: Inputs: none
5930:
5931: =cut
5932:
5933: sub endheadtag {
5934: return '</head>';
5935: }
5936:
5937: =pod
5938:
5939: =item * &head()
5940:
5941: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
5942:
1.648 raeburn 5943: Inputs:
5944:
5945: =over 4
5946:
5947: $title - optional title for the page
5948:
5949: $head_extra - optional extra HTML to put inside the <head>
5950:
5951: =back
1.405 albertel 5952:
1.306 albertel 5953: =cut
5954:
5955: sub head {
1.325 albertel 5956: my ($title,$head_extra,$args) = @_;
5957: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 5958: }
5959:
5960: =pod
5961:
5962: =item * &start_page()
5963:
5964: Returns a complete <html> .. <body> section for LON-CAPA web pages.
5965:
1.648 raeburn 5966: Inputs:
5967:
5968: =over 4
5969:
5970: $title - optional title for the page
5971:
5972: $head_extra - optional extra HTML to incude inside the <head>
5973:
5974: $args - additional optional args supported are:
5975:
5976: =over 8
5977:
5978: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 5979: arg on
1.648 raeburn 5980: no_nav_bar -> is true will set &bodytag() notopbar arg on
5981: add_entries -> additional attributes to add to the <body>
5982: domain -> force to color decorate a page for a
1.317 albertel 5983: specific domain
1.648 raeburn 5984: function -> force usage of a specific rolish color
1.317 albertel 5985: scheme
1.648 raeburn 5986: redirect -> see &headtag()
5987: bgcolor -> override the default page bg color
5988: js_ready -> return a string ready for being used in
1.317 albertel 5989: a javascript writeln
1.648 raeburn 5990: html_encode -> return a string ready for being used in
1.320 albertel 5991: a html attribute
1.648 raeburn 5992: force_register -> if is true will turn on the &bodytag()
1.317 albertel 5993: $forcereg arg
1.648 raeburn 5994: body_title -> alternate text to use instead of $title
1.326 albertel 5995: in the title box that appears, this text
5996: is not auto translated like the $title is
1.648 raeburn 5997: frameset -> if true will start with a <frameset>
1.330 albertel 5998: rather than <body>
1.648 raeburn 5999: no_title -> if true the title bar won't be shown
6000: skip_phases -> hash ref of
1.338 albertel 6001: head -> skip the <html><head> generation
6002: body -> skip all <body> generation
1.648 raeburn 6003: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6004: 'Switch To Inline Menu' link
1.648 raeburn 6005: no_auto_mt_title -> prevent &mt()ing the title arg
6006: inherit_jsmath -> when creating popup window in a page,
6007: should it have jsmath forced on by the
6008: current page
1.361 albertel 6009:
1.648 raeburn 6010: =back
1.460 albertel 6011:
1.648 raeburn 6012: =back
1.562 albertel 6013:
1.306 albertel 6014: =cut
6015:
6016: sub start_page {
1.309 albertel 6017: my ($title,$head_extra,$args) = @_;
1.318 albertel 6018: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6019: my %head_args;
1.352 albertel 6020: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6021: 'bgcolor','frameset','no_nav_bar','only_body',
6022: 'no_auto_mt_title') {
1.319 albertel 6023: if (defined($args->{$arg})) {
1.324 raeburn 6024: $head_args{$arg} = $args->{$arg};
1.319 albertel 6025: }
1.313 albertel 6026: }
1.319 albertel 6027:
1.315 albertel 6028: $env{'internal.start_page'}++;
1.338 albertel 6029: my $result;
6030: if (! exists($args->{'skip_phases'}{'head'}) ) {
6031: $result.=
1.341 albertel 6032: &xml_begin().
1.338 albertel 6033: &headtag($title,$head_extra,\%head_args).&endheadtag();
6034: }
6035:
6036: if (! exists($args->{'skip_phases'}{'body'}) ) {
6037: if ($args->{'frameset'}) {
6038: my $attr_string = &make_attr_string($args->{'force_register'},
6039: $args->{'add_entries'});
6040: $result .= "\n<frameset $attr_string>\n";
6041: } else {
6042: $result .=
6043: &bodytag($title,
6044: $args->{'function'}, $args->{'add_entries'},
6045: $args->{'only_body'}, $args->{'domain'},
6046: $args->{'force_register'}, $args->{'body_title'},
6047: $args->{'no_nav_bar'}, $args->{'bgcolor'},
1.460 albertel 6048: $args->{'no_title'}, $args->{'no_inline_link'},
6049: $args);
1.338 albertel 6050: }
1.330 albertel 6051: }
1.338 albertel 6052:
1.315 albertel 6053: if ($args->{'js_ready'}) {
1.317 albertel 6054: $result = &js_ready($result);
1.315 albertel 6055: }
1.320 albertel 6056: if ($args->{'html_encode'}) {
6057: $result = &html_encode($result);
6058: }
1.315 albertel 6059: return $result;
1.306 albertel 6060: }
6061:
1.330 albertel 6062:
1.306 albertel 6063: =pod
6064:
6065: =item * &head()
6066:
6067: Returns a complete </body></html> section for LON-CAPA web pages.
6068:
1.315 albertel 6069: Inputs: $args - additional optional args supported are:
6070: js_ready -> return a string ready for being used in
6071: a javascript writeln
1.320 albertel 6072: html_encode -> return a string ready for being used in
6073: a html attribute
1.330 albertel 6074: frameset -> if true will start with a <frameset>
6075: rather than <body>
1.493 albertel 6076: dicsussion -> if true will get discussion from
6077: lonxml::xmlend
6078: (you can pass the target and parser arguments
6079: through optional 'target' and 'parser' args
6080: to this routine)
1.306 albertel 6081:
6082: =cut
6083:
6084: sub end_page {
1.315 albertel 6085: my ($args) = @_;
6086: $env{'internal.end_page'}++;
1.330 albertel 6087: my $result;
1.335 albertel 6088: if ($args->{'discussion'}) {
6089: my ($target,$parser);
6090: if (ref($args->{'discussion'})) {
6091: ($target,$parser) =($args->{'discussion'}{'target'},
6092: $args->{'discussion'}{'parser'});
6093: }
6094: $result .= &Apache::lonxml::xmlend($target,$parser);
6095: }
6096:
1.330 albertel 6097: if ($args->{'frameset'}) {
6098: $result .= '</frameset>';
6099: } else {
1.635 raeburn 6100: $result .= &endbodytag($args);
1.330 albertel 6101: }
6102: $result .= "\n</html>";
6103:
1.315 albertel 6104: if ($args->{'js_ready'}) {
1.317 albertel 6105: $result = &js_ready($result);
1.315 albertel 6106: }
1.335 albertel 6107:
1.320 albertel 6108: if ($args->{'html_encode'}) {
6109: $result = &html_encode($result);
6110: }
1.335 albertel 6111:
1.315 albertel 6112: return $result;
6113: }
6114:
1.320 albertel 6115: sub html_encode {
6116: my ($result) = @_;
6117:
1.322 albertel 6118: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6119:
6120: return $result;
6121: }
1.317 albertel 6122: sub js_ready {
6123: my ($result) = @_;
6124:
1.323 albertel 6125: $result =~ s/[\n\r]/ /xmsg;
6126: $result =~ s/\\/\\\\/xmsg;
6127: $result =~ s/'/\\'/xmsg;
1.372 albertel 6128: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6129:
6130: return $result;
6131: }
6132:
1.315 albertel 6133: sub validate_page {
6134: if ( exists($env{'internal.start_page'})
1.316 albertel 6135: && $env{'internal.start_page'} > 1) {
6136: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6137: $env{'internal.start_page'}.' '.
1.316 albertel 6138: $ENV{'request.filename'});
1.315 albertel 6139: }
6140: if ( exists($env{'internal.end_page'})
1.316 albertel 6141: && $env{'internal.end_page'} > 1) {
6142: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6143: $env{'internal.end_page'}.' '.
1.316 albertel 6144: $env{'request.filename'});
1.315 albertel 6145: }
6146: if ( exists($env{'internal.start_page'})
6147: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6148: &Apache::lonnet::logthis('start_page called without end_page '.
6149: $env{'request.filename'});
1.315 albertel 6150: }
6151: if ( ! exists($env{'internal.start_page'})
6152: && exists($env{'internal.end_page'})) {
1.316 albertel 6153: &Apache::lonnet::logthis('end_page called without start_page'.
6154: $env{'request.filename'});
1.315 albertel 6155: }
1.306 albertel 6156: }
1.315 albertel 6157:
1.318 albertel 6158: sub simple_error_page {
6159: my ($r,$title,$msg) = @_;
6160: my $page =
6161: &Apache::loncommon::start_page($title).
6162: &mt($msg).
6163: &Apache::loncommon::end_page();
6164: if (ref($r)) {
6165: $r->print($page);
1.327 albertel 6166: return;
1.318 albertel 6167: }
6168: return $page;
6169: }
1.347 albertel 6170:
6171: {
1.610 albertel 6172: my @row_count;
1.347 albertel 6173: sub start_data_table {
1.422 albertel 6174: my ($add_class) = @_;
6175: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6176: unshift(@row_count,0);
1.422 albertel 6177: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6178: }
6179:
6180: sub end_data_table {
1.610 albertel 6181: shift(@row_count);
1.389 albertel 6182: return '</table>'."\n";;
1.347 albertel 6183: }
6184:
6185: sub start_data_table_row {
1.422 albertel 6186: my ($add_class) = @_;
1.610 albertel 6187: $row_count[0]++;
6188: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428 albertel 6189: $css_class = (join(' ',$css_class,$add_class));
1.422 albertel 6190: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6191: }
1.471 banghart 6192:
6193: sub continue_data_table_row {
6194: my ($add_class) = @_;
1.610 albertel 6195: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471 banghart 6196: $css_class = (join(' ',$css_class,$add_class));
6197: return '<tr class="'.$css_class.'">'."\n";;
6198: }
1.347 albertel 6199:
6200: sub end_data_table_row {
1.389 albertel 6201: return '</tr>'."\n";;
1.347 albertel 6202: }
1.367 www 6203:
1.421 albertel 6204: sub start_data_table_empty_row {
1.610 albertel 6205: $row_count[0]++;
1.421 albertel 6206: return '<tr class="LC_empty_row" >'."\n";;
6207: }
6208:
6209: sub end_data_table_empty_row {
6210: return '</tr>'."\n";;
6211: }
6212:
1.367 www 6213: sub start_data_table_header_row {
1.389 albertel 6214: return '<tr class="LC_header_row">'."\n";;
1.367 www 6215: }
6216:
6217: sub end_data_table_header_row {
1.389 albertel 6218: return '</tr>'."\n";;
1.367 www 6219: }
1.347 albertel 6220: }
6221:
1.548 albertel 6222: =pod
6223:
6224: =item * &inhibit_menu_check($arg)
6225:
6226: Checks for a inhibitmenu state and generates output to preserve it
6227:
6228: Inputs: $arg - can be any of
6229: - undef - in which case the return value is a string
6230: to add into arguments list of a uri
6231: - 'input' - in which case the return value is a HTML
6232: <form> <input> field of type hidden to
6233: preserve the value
6234: - a url - in which case the return value is the url with
6235: the neccesary cgi args added to preserve the
6236: inhibitmenu state
6237: - a ref to a url - no return value, but the string is
6238: updated to include the neccessary cgi
6239: args to preserve the inhibitmenu state
6240:
6241: =cut
6242:
6243: sub inhibit_menu_check {
6244: my ($arg) = @_;
6245: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6246: if ($arg eq 'input') {
6247: if ($env{'form.inhibitmenu'}) {
6248: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6249: } else {
6250: return
6251: }
6252: }
6253: if ($env{'form.inhibitmenu'}) {
6254: if (ref($arg)) {
6255: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6256: } elsif ($arg eq '') {
6257: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6258: } else {
6259: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6260: }
6261: }
6262: if (!ref($arg)) {
6263: return $arg;
6264: }
6265: }
6266:
1.251 albertel 6267: ###############################################
1.182 matthew 6268:
6269: =pod
6270:
1.549 albertel 6271: =back
6272:
6273: =head1 User Information Routines
6274:
6275: =over 4
6276:
1.405 albertel 6277: =item * &get_users_function()
1.182 matthew 6278:
6279: Used by &bodytag to determine the current users primary role.
6280: Returns either 'student','coordinator','admin', or 'author'.
6281:
6282: =cut
6283:
6284: ###############################################
6285: sub get_users_function {
6286: my $function = 'student';
1.258 albertel 6287: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182 matthew 6288: $function='coordinator';
6289: }
1.258 albertel 6290: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 6291: $function='admin';
6292: }
1.258 albertel 6293: if (($env{'request.role'}=~/^(au|ca)/) ||
1.182 matthew 6294: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
6295: $function='author';
6296: }
6297: return $function;
1.54 www 6298: }
1.99 www 6299:
6300: ###############################################
6301:
1.233 raeburn 6302: =pod
6303:
1.542 raeburn 6304: =item * &check_user_status()
1.274 raeburn 6305:
6306: Determines current status of supplied role for a
6307: specific user. Roles can be active, previous or future.
6308:
6309: Inputs:
6310: user's domain, user's username, course's domain,
1.375 raeburn 6311: course's number, optional section ID.
1.274 raeburn 6312:
6313: Outputs:
6314: role status: active, previous or future.
6315:
6316: =cut
6317:
6318: sub check_user_status {
1.412 raeburn 6319: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 6320: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
6321: my @uroles = keys %userinfo;
6322: my $srchstr;
6323: my $active_chk = 'none';
1.412 raeburn 6324: my $now = time;
1.274 raeburn 6325: if (@uroles > 0) {
1.412 raeburn 6326: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 6327: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
6328: } else {
1.412 raeburn 6329: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
6330: }
6331: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 6332: my $role_end = 0;
6333: my $role_start = 0;
6334: $active_chk = 'active';
1.412 raeburn 6335: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
6336: $role_end = $1;
6337: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
6338: $role_start = $1;
1.274 raeburn 6339: }
6340: }
6341: if ($role_start > 0) {
1.412 raeburn 6342: if ($now < $role_start) {
1.274 raeburn 6343: $active_chk = 'future';
6344: }
6345: }
6346: if ($role_end > 0) {
1.412 raeburn 6347: if ($now > $role_end) {
1.274 raeburn 6348: $active_chk = 'previous';
6349: }
6350: }
6351: }
6352: }
6353: return $active_chk;
6354: }
6355:
6356: ###############################################
6357:
6358: =pod
6359:
1.405 albertel 6360: =item * &get_sections()
1.233 raeburn 6361:
6362: Determines all the sections for a course including
6363: sections with students and sections containing other roles.
1.419 raeburn 6364: Incoming parameters:
6365:
6366: 1. domain
6367: 2. course number
6368: 3. reference to array containing roles for which sections should
6369: be gathered (optional).
6370: 4. reference to array containing status types for which sections
6371: should be gathered (optional).
6372:
6373: If the third argument is undefined, sections are gathered for any role.
6374: If the fourth argument is undefined, sections are gathered for any status.
6375: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 6376:
1.374 raeburn 6377: Returns section hash (keys are section IDs, values are
6378: number of users in each section), subject to the
1.419 raeburn 6379: optional roles filter, optional status filter
1.233 raeburn 6380:
6381: =cut
6382:
6383: ###############################################
6384: sub get_sections {
1.419 raeburn 6385: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 6386: if (!defined($cdom) || !defined($cnum)) {
6387: my $cid = $env{'request.course.id'};
6388:
6389: return if (!defined($cid));
6390:
6391: $cdom = $env{'course.'.$cid.'.domain'};
6392: $cnum = $env{'course.'.$cid.'.num'};
6393: }
6394:
6395: my %sectioncount;
1.419 raeburn 6396: my $now = time;
1.240 albertel 6397:
1.366 albertel 6398: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 6399: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 6400: my $sec_index = &Apache::loncoursedata::CL_SECTION();
6401: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 6402: my $start_index = &Apache::loncoursedata::CL_START();
6403: my $end_index = &Apache::loncoursedata::CL_END();
6404: my $status;
1.366 albertel 6405: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 6406: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
6407: $data->[$status_index],
6408: $data->[$start_index],
6409: $data->[$end_index]);
6410: if ($stu_status eq 'Active') {
6411: $status = 'active';
6412: } elsif ($end < $now) {
6413: $status = 'previous';
6414: } elsif ($start > $now) {
6415: $status = 'future';
6416: }
6417: if ($section ne '-1' && $section !~ /^\s*$/) {
6418: if ((!defined($possible_status)) || (($status ne '') &&
6419: (grep/^\Q$status\E$/,@{$possible_status}))) {
6420: $sectioncount{$section}++;
6421: }
1.240 albertel 6422: }
6423: }
6424: }
6425: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6426: foreach my $user (sort(keys(%courseroles))) {
6427: if ($user !~ /^(\w{2})/) { next; }
6428: my ($role) = ($user =~ /^(\w{2})/);
6429: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 6430: my ($section,$status);
1.240 albertel 6431: if ($role eq 'cr' &&
6432: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
6433: $section=$1;
6434: }
6435: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
6436: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 6437: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
6438: if ($end == -1 && $start == -1) {
6439: next; #deleted role
6440: }
6441: if (!defined($possible_status)) {
6442: $sectioncount{$section}++;
6443: } else {
6444: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
6445: $status = 'active';
6446: } elsif ($end < $now) {
6447: $status = 'future';
6448: } elsif ($start > $now) {
6449: $status = 'previous';
6450: }
6451: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
6452: $sectioncount{$section}++;
6453: }
6454: }
1.233 raeburn 6455: }
1.366 albertel 6456: return %sectioncount;
1.233 raeburn 6457: }
6458:
1.274 raeburn 6459: ###############################################
1.294 raeburn 6460:
6461: =pod
1.405 albertel 6462:
6463: =item * &get_course_users()
6464:
1.275 raeburn 6465: Retrieves usernames:domains for users in the specified course
6466: with specific role(s), and access status.
6467:
6468: Incoming parameters:
1.277 albertel 6469: 1. course domain
6470: 2. course number
6471: 3. access status: users must have - either active,
1.275 raeburn 6472: previous, future, or all.
1.277 albertel 6473: 4. reference to array of permissible roles
1.288 raeburn 6474: 5. reference to array of section restrictions (optional)
6475: 6. reference to results object (hash of hashes).
6476: 7. reference to optional userdata hash
1.609 raeburn 6477: 8. reference to optional statushash
1.630 raeburn 6478: 9. flag if privileged users (except those set to unhide in
6479: course settings) should be excluded
1.609 raeburn 6480: Keys of top level results hash are roles.
1.275 raeburn 6481: Keys of inner hashes are username:domain, with
6482: values set to access type.
1.288 raeburn 6483: Optional userdata hash returns an array with arguments in the
6484: same order as loncoursedata::get_classlist() for student data.
6485:
1.609 raeburn 6486: Optional statushash returns
6487:
1.288 raeburn 6488: Entries for end, start, section and status are blank because
6489: of the possibility of multiple values for non-student roles.
6490:
1.275 raeburn 6491: =cut
1.405 albertel 6492:
1.275 raeburn 6493: ###############################################
1.405 albertel 6494:
1.275 raeburn 6495: sub get_course_users {
1.630 raeburn 6496: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 6497: my %idx = ();
1.419 raeburn 6498: my %seclists;
1.288 raeburn 6499:
6500: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
6501: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
6502: $idx{end} = &Apache::loncoursedata::CL_END();
6503: $idx{start} = &Apache::loncoursedata::CL_START();
6504: $idx{id} = &Apache::loncoursedata::CL_ID();
6505: $idx{section} = &Apache::loncoursedata::CL_SECTION();
6506: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
6507: $idx{status} = &Apache::loncoursedata::CL_STATUS();
6508:
1.290 albertel 6509: if (grep(/^st$/,@{$roles})) {
1.276 albertel 6510: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 6511: my $now = time;
1.277 albertel 6512: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 6513: my $match = 0;
1.412 raeburn 6514: my $secmatch = 0;
1.419 raeburn 6515: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 6516: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 6517: if ($section eq '') {
6518: $section = 'none';
6519: }
1.291 albertel 6520: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6521: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6522: $secmatch = 1;
6523: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 6524: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6525: $secmatch = 1;
6526: }
6527: } else {
1.419 raeburn 6528: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 6529: $secmatch = 1;
6530: }
1.290 albertel 6531: }
1.412 raeburn 6532: if (!$secmatch) {
6533: next;
6534: }
1.419 raeburn 6535: }
1.275 raeburn 6536: if (defined($$types{'active'})) {
1.288 raeburn 6537: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 6538: push(@{$$users{st}{$student}},'active');
1.288 raeburn 6539: $match = 1;
1.275 raeburn 6540: }
6541: }
6542: if (defined($$types{'previous'})) {
1.609 raeburn 6543: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 6544: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 6545: $match = 1;
1.275 raeburn 6546: }
6547: }
6548: if (defined($$types{'future'})) {
1.609 raeburn 6549: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 6550: push(@{$$users{st}{$student}},'future');
1.288 raeburn 6551: $match = 1;
1.275 raeburn 6552: }
6553: }
1.609 raeburn 6554: if ($match) {
6555: push(@{$seclists{$student}},$section);
6556: if (ref($userdata) eq 'HASH') {
6557: $$userdata{$student} = $$classlist{$student};
6558: }
6559: if (ref($statushash) eq 'HASH') {
6560: $statushash->{$student}{'st'}{$section} = $status;
6561: }
1.288 raeburn 6562: }
1.275 raeburn 6563: }
6564: }
1.412 raeburn 6565: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 6566: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6567: my $now = time;
1.609 raeburn 6568: my %displaystatus = ( previous => 'Expired',
6569: active => 'Active',
6570: future => 'Future',
6571: );
1.630 raeburn 6572: my %nothide;
6573: if ($hidepriv) {
6574: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
6575: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
6576: if ($user !~ /:/) {
6577: $nothide{join(':',split(/[\@]/,$user))}=1;
6578: } else {
6579: $nothide{$user} = 1;
6580: }
6581: }
6582: }
1.439 raeburn 6583: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 6584: my $match = 0;
1.412 raeburn 6585: my $secmatch = 0;
1.439 raeburn 6586: my $status;
1.412 raeburn 6587: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 6588: $user =~ s/:$//;
1.439 raeburn 6589: my ($end,$start) = split(/:/,$coursepersonnel{$person});
6590: if ($end == -1 || $start == -1) {
6591: next;
6592: }
6593: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
6594: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 6595: my ($uname,$udom) = split(/:/,$user);
6596: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6597: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6598: $secmatch = 1;
6599: } elsif ($usec eq '') {
1.420 albertel 6600: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6601: $secmatch = 1;
6602: }
6603: } else {
6604: if (grep(/^\Q$usec\E$/,@{$sections})) {
6605: $secmatch = 1;
6606: }
6607: }
6608: if (!$secmatch) {
6609: next;
6610: }
1.288 raeburn 6611: }
1.419 raeburn 6612: if ($usec eq '') {
6613: $usec = 'none';
6614: }
1.275 raeburn 6615: if ($uname ne '' && $udom ne '') {
1.630 raeburn 6616: if ($hidepriv) {
6617: if ((&Apache::lonnet::privileged($uname,$udom)) &&
6618: (!$nothide{$uname.':'.$udom})) {
6619: next;
6620: }
6621: }
1.503 raeburn 6622: if ($end > 0 && $end < $now) {
1.439 raeburn 6623: $status = 'previous';
6624: } elsif ($start > $now) {
6625: $status = 'future';
6626: } else {
6627: $status = 'active';
6628: }
1.277 albertel 6629: foreach my $type (keys(%{$types})) {
1.275 raeburn 6630: if ($status eq $type) {
1.420 albertel 6631: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 6632: push(@{$$users{$role}{$user}},$type);
6633: }
1.288 raeburn 6634: $match = 1;
6635: }
6636: }
1.419 raeburn 6637: if (($match) && (ref($userdata) eq 'HASH')) {
6638: if (!exists($$userdata{$uname.':'.$udom})) {
6639: &get_user_info($udom,$uname,\%idx,$userdata);
6640: }
1.420 albertel 6641: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 6642: push(@{$seclists{$uname.':'.$udom}},$usec);
6643: }
1.609 raeburn 6644: if (ref($statushash) eq 'HASH') {
6645: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
6646: }
1.275 raeburn 6647: }
6648: }
6649: }
6650: }
1.290 albertel 6651: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 6652: if ((defined($cdom)) && (defined($cnum))) {
6653: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
6654: if ( defined($csettings{'internal.courseowner'}) ) {
6655: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 6656: next if ($owner eq '');
6657: my ($ownername,$ownerdom);
6658: if ($owner =~ /^([^:]+):([^:]+)$/) {
6659: $ownername = $1;
6660: $ownerdom = $2;
6661: } else {
6662: $ownername = $owner;
6663: $ownerdom = $cdom;
6664: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 6665: }
6666: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 6667: if (defined($userdata) &&
1.609 raeburn 6668: !exists($$userdata{$owner})) {
6669: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
6670: if (!grep(/^none$/,@{$seclists{$owner}})) {
6671: push(@{$seclists{$owner}},'none');
6672: }
6673: if (ref($statushash) eq 'HASH') {
6674: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 6675: }
1.290 albertel 6676: }
1.279 raeburn 6677: }
6678: }
6679: }
1.419 raeburn 6680: foreach my $user (keys(%seclists)) {
6681: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
6682: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
6683: }
1.275 raeburn 6684: }
6685: return;
6686: }
6687:
1.288 raeburn 6688: sub get_user_info {
6689: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 6690: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
6691: &plainname($uname,$udom,'lastname');
1.291 albertel 6692: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 6693: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 6694: my %idhash = &Apache::lonnet::idrget($udom,($uname));
6695: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 6696: return;
6697: }
1.275 raeburn 6698:
1.472 raeburn 6699: ###############################################
6700:
6701: =pod
6702:
6703: =item * &get_user_quota()
6704:
6705: Retrieves quota assigned for storage of portfolio files for a user
6706:
6707: Incoming parameters:
6708: 1. user's username
6709: 2. user's domain
6710:
6711: Returns:
1.536 raeburn 6712: 1. Disk quota (in Mb) assigned to student.
6713: 2. (Optional) Type of setting: custom or default
6714: (individually assigned or default for user's
6715: institutional status).
6716: 3. (Optional) - User's institutional status (e.g., faculty, staff
6717: or student - types as defined in localenroll::inst_usertypes
6718: for user's domain, which determines default quota for user.
6719: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 6720:
6721: If a value has been stored in the user's environment,
1.536 raeburn 6722: it will return that, otherwise it returns the maximal default
6723: defined for the user's instituional status(es) in the domain.
1.472 raeburn 6724:
6725: =cut
6726:
6727: ###############################################
6728:
6729:
6730: sub get_user_quota {
6731: my ($uname,$udom) = @_;
1.536 raeburn 6732: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 6733: if (!defined($udom)) {
6734: $udom = $env{'user.domain'};
6735: }
6736: if (!defined($uname)) {
6737: $uname = $env{'user.name'};
6738: }
6739: if (($udom eq '' || $uname eq '') ||
6740: ($udom eq 'public') && ($uname eq 'public')) {
6741: $quota = 0;
1.536 raeburn 6742: $quotatype = 'default';
6743: $defquota = 0;
1.472 raeburn 6744: } else {
1.536 raeburn 6745: my $inststatus;
1.472 raeburn 6746: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
6747: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 6748: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 6749: } else {
1.536 raeburn 6750: my %userenv =
6751: &Apache::lonnet::get('environment',['portfolioquota',
6752: 'inststatus'],$udom,$uname);
1.472 raeburn 6753: my ($tmp) = keys(%userenv);
6754: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
6755: $quota = $userenv{'portfolioquota'};
1.536 raeburn 6756: $inststatus = $userenv{'inststatus'};
1.472 raeburn 6757: } else {
6758: undef(%userenv);
6759: }
6760: }
1.536 raeburn 6761: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 6762: if ($quota eq '') {
1.536 raeburn 6763: $quota = $defquota;
6764: $quotatype = 'default';
6765: } else {
6766: $quotatype = 'custom';
1.472 raeburn 6767: }
6768: }
1.536 raeburn 6769: if (wantarray) {
6770: return ($quota,$quotatype,$settingstatus,$defquota);
6771: } else {
6772: return $quota;
6773: }
1.472 raeburn 6774: }
6775:
6776: ###############################################
6777:
6778: =pod
6779:
6780: =item * &default_quota()
6781:
1.536 raeburn 6782: Retrieves default quota assigned for storage of user portfolio files,
6783: given an (optional) user's institutional status.
1.472 raeburn 6784:
6785: Incoming parameters:
6786: 1. domain
1.536 raeburn 6787: 2. (Optional) institutional status(es). This is a : separated list of
6788: status types (e.g., faculty, staff, student etc.)
6789: which apply to the user for whom the default is being retrieved.
6790: If the institutional status string in undefined, the domain
6791: default quota will be returned.
1.472 raeburn 6792:
6793: Returns:
6794: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 6795: 2. (Optional) institutional type which determined the value of the
6796: default quota.
1.472 raeburn 6797:
6798: If a value has been stored in the domain's configuration db,
6799: it will return that, otherwise it returns 20 (for backwards
6800: compatibility with domains which have not set up a configuration
6801: db file; the original statically defined portfolio quota was 20 Mb).
6802:
1.536 raeburn 6803: If the user's status includes multiple types (e.g., staff and student),
6804: the largest default quota which applies to the user determines the
6805: default quota returned.
6806:
1.472 raeburn 6807: =cut
6808:
6809: ###############################################
6810:
6811:
6812: sub default_quota {
1.536 raeburn 6813: my ($udom,$inststatus) = @_;
6814: my ($defquota,$settingstatus);
6815: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 6816: ['quotas'],$udom);
6817: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 6818: if ($inststatus ne '') {
6819: my @statuses = split(/:/,$inststatus);
6820: foreach my $item (@statuses) {
1.622 raeburn 6821: if ($quotahash{'quotas'}{$item} ne '') {
1.536 raeburn 6822: if ($defquota eq '') {
1.622 raeburn 6823: $defquota = $quotahash{'quotas'}{$item};
1.536 raeburn 6824: $settingstatus = $item;
1.622 raeburn 6825: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
6826: $defquota = $quotahash{'quotas'}{$item};
1.536 raeburn 6827: $settingstatus = $item;
6828: }
6829: }
6830: }
6831: }
6832: if ($defquota eq '') {
1.622 raeburn 6833: $defquota = $quotahash{'quotas'}{'default'};
1.536 raeburn 6834: $settingstatus = 'default';
6835: }
6836: } else {
6837: $settingstatus = 'default';
6838: $defquota = 20;
6839: }
6840: if (wantarray) {
6841: return ($defquota,$settingstatus);
1.472 raeburn 6842: } else {
1.536 raeburn 6843: return $defquota;
1.472 raeburn 6844: }
6845: }
6846:
1.384 raeburn 6847: sub get_secgrprole_info {
6848: my ($cdom,$cnum,$needroles,$type) = @_;
6849: my %sections_count = &get_sections($cdom,$cnum);
6850: my @sections = (sort {$a <=> $b} keys(%sections_count));
6851: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
6852: my @groups = sort(keys(%curr_groups));
6853: my $allroles = [];
6854: my $rolehash;
6855: my $accesshash = {
6856: active => 'Currently has access',
6857: future => 'Will have future access',
6858: previous => 'Previously had access',
6859: };
6860: if ($needroles) {
6861: $rolehash = {'all' => 'all'};
1.385 albertel 6862: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6863: if (&Apache::lonnet::error(%user_roles)) {
6864: undef(%user_roles);
6865: }
6866: foreach my $item (keys(%user_roles)) {
1.384 raeburn 6867: my ($role)=split(/\:/,$item,2);
6868: if ($role eq 'cr') { next; }
6869: if ($role =~ /^cr/) {
6870: $$rolehash{$role} = (split('/',$role))[3];
6871: } else {
6872: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
6873: }
6874: }
6875: foreach my $key (sort(keys(%{$rolehash}))) {
6876: push(@{$allroles},$key);
6877: }
6878: push (@{$allroles},'st');
6879: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
6880: }
6881: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
6882: }
6883:
1.555 raeburn 6884: sub user_picker {
1.627 raeburn 6885: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 6886: my $currdom = $dom;
6887: my %curr_selected = (
6888: srchin => 'dom',
1.580 raeburn 6889: srchby => 'lastname',
1.555 raeburn 6890: );
6891: my $srchterm;
1.625 raeburn 6892: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 6893: if ($srch->{'srchby'} ne '') {
6894: $curr_selected{'srchby'} = $srch->{'srchby'};
6895: }
6896: if ($srch->{'srchin'} ne '') {
6897: $curr_selected{'srchin'} = $srch->{'srchin'};
6898: }
6899: if ($srch->{'srchtype'} ne '') {
6900: $curr_selected{'srchtype'} = $srch->{'srchtype'};
6901: }
6902: if ($srch->{'srchdomain'} ne '') {
6903: $currdom = $srch->{'srchdomain'};
6904: }
6905: $srchterm = $srch->{'srchterm'};
6906: }
6907: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 6908: 'usr' => 'Search criteria',
1.563 raeburn 6909: 'doma' => 'Domain/institution to search',
1.558 albertel 6910: 'uname' => 'username',
6911: 'lastname' => 'last name',
1.555 raeburn 6912: 'lastfirst' => 'last name, first name',
1.558 albertel 6913: 'crs' => 'in this course',
1.576 raeburn 6914: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 6915: 'alc' => 'all LON-CAPA',
1.573 raeburn 6916: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 6917: 'exact' => 'is',
6918: 'contains' => 'contains',
1.569 raeburn 6919: 'begins' => 'begins with',
1.571 raeburn 6920: 'youm' => "You must include some text to search for.",
6921: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
6922: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
6923: 'yomc' => "You must choose a domain when using an institutional directory search.",
6924: 'ymcd' => "You must choose a domain when using a domain search.",
6925: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
6926: 'whse' => "When searching by last,first you must include at least one character in the first name.",
6927: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 6928: );
1.563 raeburn 6929: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
6930: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 6931:
6932: my @srchins = ('crs','dom','alc','instd');
6933:
6934: foreach my $option (@srchins) {
6935: # FIXME 'alc' option unavailable until
6936: # loncreateuser::print_user_query_page()
6937: # has been completed.
6938: next if ($option eq 'alc');
6939: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 6940: if ($curr_selected{'srchin'} eq $option) {
6941: $srchinsel .= '
6942: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6943: } else {
6944: $srchinsel .= '
6945: <option value="'.$option.'">'.$lt{$option}.'</option>';
6946: }
1.555 raeburn 6947: }
1.563 raeburn 6948: $srchinsel .= "\n </select>\n";
1.555 raeburn 6949:
6950: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 6951: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 6952: if ($curr_selected{'srchby'} eq $option) {
6953: $srchbysel .= '
6954: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6955: } else {
6956: $srchbysel .= '
6957: <option value="'.$option.'">'.$lt{$option}.'</option>';
6958: }
6959: }
6960: $srchbysel .= "\n </select>\n";
6961:
6962: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 6963: foreach my $option ('begins','contains','exact') {
1.555 raeburn 6964: if ($curr_selected{'srchtype'} eq $option) {
6965: $srchtypesel .= '
6966: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6967: } else {
6968: $srchtypesel .= '
6969: <option value="'.$option.'">'.$lt{$option}.'</option>';
6970: }
6971: }
6972: $srchtypesel .= "\n </select>\n";
6973:
1.558 albertel 6974: my ($newuserscript,$new_user_create);
1.556 raeburn 6975:
6976: if ($forcenewuser) {
1.576 raeburn 6977: if (ref($srch) eq 'HASH') {
6978: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 6979: if ($cancreate) {
6980: $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>';
6981: } else {
6982: my $helplink = ' href="javascript:helpMenu('."'display'".')"';
6983: my %usertypetext = (
6984: official => 'institutional',
6985: unofficial => 'non-institutional',
6986: );
6987: $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 />';
6988: }
1.576 raeburn 6989: }
6990: }
6991:
1.556 raeburn 6992: $newuserscript = <<"ENDSCRIPT";
6993:
1.570 raeburn 6994: function setSearch(createnew,callingForm) {
1.556 raeburn 6995: if (createnew == 1) {
1.570 raeburn 6996: for (var i=0; i<callingForm.srchby.length; i++) {
6997: if (callingForm.srchby.options[i].value == 'uname') {
6998: callingForm.srchby.selectedIndex = i;
1.556 raeburn 6999: }
7000: }
1.570 raeburn 7001: for (var i=0; i<callingForm.srchin.length; i++) {
7002: if ( callingForm.srchin.options[i].value == 'dom') {
7003: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7004: }
7005: }
1.570 raeburn 7006: for (var i=0; i<callingForm.srchtype.length; i++) {
7007: if (callingForm.srchtype.options[i].value == 'exact') {
7008: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7009: }
7010: }
1.570 raeburn 7011: for (var i=0; i<callingForm.srchdomain.length; i++) {
7012: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7013: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7014: }
7015: }
7016: }
7017: }
7018: ENDSCRIPT
1.558 albertel 7019:
1.556 raeburn 7020: }
7021:
1.555 raeburn 7022: my $output = <<"END_BLOCK";
1.556 raeburn 7023: <script type="text/javascript">
1.570 raeburn 7024: function validateEntry(callingForm) {
1.558 albertel 7025:
1.556 raeburn 7026: var checkok = 1;
1.558 albertel 7027: var srchin;
1.570 raeburn 7028: for (var i=0; i<callingForm.srchin.length; i++) {
7029: if ( callingForm.srchin[i].checked ) {
7030: srchin = callingForm.srchin[i].value;
1.558 albertel 7031: }
7032: }
7033:
1.570 raeburn 7034: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7035: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7036: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7037: var srchterm = callingForm.srchterm.value;
7038: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7039: var msg = "";
7040:
7041: if (srchterm == "") {
7042: checkok = 0;
1.571 raeburn 7043: msg += "$lt{'youm'}\\n";
1.556 raeburn 7044: }
7045:
1.569 raeburn 7046: if (srchtype== 'begins') {
7047: if (srchterm.length < 2) {
7048: checkok = 0;
1.571 raeburn 7049: msg += "$lt{'thte'}\\n";
1.569 raeburn 7050: }
7051: }
7052:
1.556 raeburn 7053: if (srchtype== 'contains') {
7054: if (srchterm.length < 3) {
7055: checkok = 0;
1.571 raeburn 7056: msg += "$lt{'thet'}\\n";
1.556 raeburn 7057: }
7058: }
7059: if (srchin == 'instd') {
7060: if (srchdomain == '') {
7061: checkok = 0;
1.571 raeburn 7062: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7063: }
7064: }
7065: if (srchin == 'dom') {
7066: if (srchdomain == '') {
7067: checkok = 0;
1.571 raeburn 7068: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7069: }
7070: }
7071: if (srchby == 'lastfirst') {
7072: if (srchterm.indexOf(",") == -1) {
7073: checkok = 0;
1.571 raeburn 7074: msg += "$lt{'whus'}\\n";
1.556 raeburn 7075: }
7076: if (srchterm.indexOf(",") == srchterm.length -1) {
7077: checkok = 0;
1.571 raeburn 7078: msg += "$lt{'whse'}\\n";
1.556 raeburn 7079: }
7080: }
7081: if (checkok == 0) {
1.571 raeburn 7082: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7083: return;
7084: }
7085: if (checkok == 1) {
1.570 raeburn 7086: callingForm.submit();
1.556 raeburn 7087: }
7088: }
7089:
7090: $newuserscript
7091:
7092: </script>
1.558 albertel 7093:
7094: $new_user_create
7095:
1.555 raeburn 7096: <table>
1.558 albertel 7097: <tr>
1.573 raeburn 7098: <td>$lt{'doma'}:</td>
7099: <td>$domform</td>
7100: </td>
7101: </tr>
7102: <tr>
7103: <td>$lt{'usr'}:</td>
1.563 raeburn 7104: <td>$srchbysel
7105: $srchtypesel
7106: <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564 albertel 7107: $srchinsel
1.563 raeburn 7108: </td>
7109: </tr>
1.555 raeburn 7110: </table>
7111: <br />
7112: END_BLOCK
1.558 albertel 7113:
1.555 raeburn 7114: return $output;
7115: }
7116:
1.612 raeburn 7117: sub user_rule_check {
1.615 raeburn 7118: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7119: my $response;
7120: if (ref($usershash) eq 'HASH') {
7121: foreach my $user (keys(%{$usershash})) {
7122: my ($uname,$udom) = split(/:/,$user);
7123: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7124: my ($id,$newuser);
1.612 raeburn 7125: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7126: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7127: $id = $usershash->{$user}->{'id'};
7128: }
7129: my $inst_response;
7130: if (ref($checks) eq 'HASH') {
7131: if (defined($checks->{'username'})) {
1.615 raeburn 7132: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7133: &Apache::lonnet::get_instuser($udom,$uname);
7134: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7135: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7136: &Apache::lonnet::get_instuser($udom,undef,$id);
7137: }
1.615 raeburn 7138: } else {
7139: ($inst_response,%{$inst_results->{$user}}) =
7140: &Apache::lonnet::get_instuser($udom,$uname);
7141: return;
1.612 raeburn 7142: }
1.615 raeburn 7143: if (!$got_rules->{$udom}) {
1.612 raeburn 7144: my %domconfig = &Apache::lonnet::get_dom('configuration',
7145: ['usercreation'],$udom);
7146: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7147: foreach my $item ('username','id') {
1.612 raeburn 7148: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7149: $$curr_rules{$udom}{$item} =
7150: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7151: }
7152: }
7153: }
1.615 raeburn 7154: $got_rules->{$udom} = 1;
1.585 raeburn 7155: }
1.612 raeburn 7156: foreach my $item (keys(%{$checks})) {
7157: if (ref($$curr_rules{$udom}) eq 'HASH') {
7158: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7159: if (@{$$curr_rules{$udom}{$item}} > 0) {
7160: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7161: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7162: if ($rule_check{$rule}) {
7163: $$rulematch{$user}{$item} = $rule;
7164: if ($inst_response eq 'ok') {
1.615 raeburn 7165: if (ref($inst_results) eq 'HASH') {
7166: if (ref($inst_results->{$user}) eq 'HASH') {
7167: if (keys(%{$inst_results->{$user}}) == 0) {
7168: $$alerts{$item}{$udom}{$uname} = 1;
7169: }
1.612 raeburn 7170: }
7171: }
1.615 raeburn 7172: }
7173: last;
1.585 raeburn 7174: }
7175: }
7176: }
7177: }
7178: }
7179: }
7180: }
7181: }
1.612 raeburn 7182: return;
7183: }
7184:
7185: sub user_rule_formats {
7186: my ($domain,$domdesc,$curr_rules,$check) = @_;
7187: my %text = (
7188: 'username' => 'Usernames',
7189: 'id' => 'IDs',
7190: );
7191: my $output;
7192: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7193: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7194: if (@{$ruleorder} > 0) {
7195: $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>';
7196: foreach my $rule (@{$ruleorder}) {
7197: if (ref($curr_rules) eq 'ARRAY') {
7198: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7199: if (ref($rules->{$rule}) eq 'HASH') {
7200: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7201: $rules->{$rule}{'desc'}.'</li>';
7202: }
7203: }
7204: }
7205: }
7206: $output .= '</ul>';
7207: }
7208: }
7209: return $output;
7210: }
7211:
7212: sub instrule_disallow_msg {
1.615 raeburn 7213: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7214: my $response;
7215: my %text = (
7216: item => 'username',
7217: items => 'usernames',
7218: match => 'matches',
7219: do => 'does',
7220: action => 'a username',
7221: one => 'one',
7222: );
7223: if ($count > 1) {
7224: $text{'item'} = 'usernames';
7225: $text{'match'} ='match';
7226: $text{'do'} = 'do';
7227: $text{'action'} = 'usernames',
7228: $text{'one'} = 'ones';
7229: }
7230: if ($checkitem eq 'id') {
7231: $text{'items'} = 'IDs';
7232: $text{'item'} = 'ID';
7233: $text{'action'} = 'an ID';
1.615 raeburn 7234: if ($count > 1) {
7235: $text{'item'} = 'IDs';
7236: $text{'action'} = 'IDs';
7237: }
1.612 raeburn 7238: }
1.674 bisitz 7239: $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 7240: if ($mode eq 'upload') {
7241: if ($checkitem eq 'username') {
7242: $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'}.");
7243: } elsif ($checkitem eq 'id') {
1.674 bisitz 7244: $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 7245: }
1.669 raeburn 7246: } elsif ($mode eq 'selfcreate') {
7247: if ($checkitem eq 'id') {
7248: $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.");
7249: }
1.615 raeburn 7250: } else {
7251: if ($checkitem eq 'username') {
7252: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
7253: } elsif ($checkitem eq 'id') {
7254: $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.");
7255: }
1.612 raeburn 7256: }
7257: return $response;
1.585 raeburn 7258: }
7259:
1.624 raeburn 7260: sub personal_data_fieldtitles {
7261: my %fieldtitles = &Apache::lonlocal::texthash (
7262: id => 'Student/Employee ID',
7263: permanentemail => 'E-mail address',
7264: lastname => 'Last Name',
7265: firstname => 'First Name',
7266: middlename => 'Middle Name',
7267: generation => 'Generation',
7268: gen => 'Generation',
7269: );
7270: return %fieldtitles;
7271: }
7272:
1.642 raeburn 7273: sub sorted_inst_types {
7274: my ($dom) = @_;
7275: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
7276: my $othertitle = &mt('All users');
7277: if ($env{'request.course.id'}) {
1.668 raeburn 7278: $othertitle = &mt('Any users');
1.642 raeburn 7279: }
7280: my @types;
7281: if (ref($order) eq 'ARRAY') {
7282: @types = @{$order};
7283: }
7284: if (@types == 0) {
7285: if (ref($usertypes) eq 'HASH') {
7286: @types = sort(keys(%{$usertypes}));
7287: }
7288: }
7289: if (keys(%{$usertypes}) > 0) {
7290: $othertitle = &mt('Other users');
7291: }
7292: return ($othertitle,$usertypes,\@types);
7293: }
7294:
1.645 raeburn 7295: sub get_institutional_codes {
7296: my ($settings,$allcourses,$LC_code) = @_;
7297: # Get complete list of course sections to update
7298: my @currsections = ();
7299: my @currxlists = ();
7300: my $coursecode = $$settings{'internal.coursecode'};
7301:
7302: if ($$settings{'internal.sectionnums'} ne '') {
7303: @currsections = split(/,/,$$settings{'internal.sectionnums'});
7304: }
7305:
7306: if ($$settings{'internal.crosslistings'} ne '') {
7307: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
7308: }
7309:
7310: if (@currxlists > 0) {
7311: foreach (@currxlists) {
7312: if (m/^([^:]+):(\w*)$/) {
7313: unless (grep/^$1$/,@{$allcourses}) {
7314: push @{$allcourses},$1;
7315: $$LC_code{$1} = $2;
7316: }
7317: }
7318: }
7319: }
7320:
7321: if (@currsections > 0) {
7322: foreach (@currsections) {
7323: if (m/^(\w+):(\w*)$/) {
7324: my $sec = $coursecode.$1;
7325: my $lc_sec = $2;
7326: unless (grep/^$sec$/,@{$allcourses}) {
7327: push @{$allcourses},$sec;
7328: $$LC_code{$sec} = $lc_sec;
7329: }
7330: }
7331: }
7332: }
7333: return;
7334: }
7335:
1.112 bowersj2 7336: =pod
7337:
1.549 albertel 7338: =back
7339:
7340: =head1 HTTP Helpers
7341:
7342: =over 4
7343:
1.648 raeburn 7344: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 7345:
1.258 albertel 7346: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 7347: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 7348: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 7349:
7350: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
7351: $possible_names is an ref to an array of form element names. As an example:
7352: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 7353: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 7354:
7355: =cut
1.1 albertel 7356:
1.6 albertel 7357: sub get_unprocessed_cgi {
1.25 albertel 7358: my ($query,$possible_names)= @_;
1.26 matthew 7359: # $Apache::lonxml::debug=1;
1.356 albertel 7360: foreach my $pair (split(/&/,$query)) {
7361: my ($name, $value) = split(/=/,$pair);
1.369 www 7362: $name = &unescape($name);
1.25 albertel 7363: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
7364: $value =~ tr/+/ /;
7365: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 7366: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 7367: }
1.16 harris41 7368: }
1.6 albertel 7369: }
7370:
1.112 bowersj2 7371: =pod
7372:
1.648 raeburn 7373: =item * &cacheheader()
1.112 bowersj2 7374:
7375: returns cache-controlling header code
7376:
7377: =cut
7378:
1.7 albertel 7379: sub cacheheader {
1.258 albertel 7380: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 7381: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
7382: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 7383: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
7384: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 7385: return $output;
1.7 albertel 7386: }
7387:
1.112 bowersj2 7388: =pod
7389:
1.648 raeburn 7390: =item * &no_cache($r)
1.112 bowersj2 7391:
7392: specifies header code to not have cache
7393:
7394: =cut
7395:
1.9 albertel 7396: sub no_cache {
1.216 albertel 7397: my ($r) = @_;
7398: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 7399: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 7400: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
7401: $r->no_cache(1);
7402: $r->header_out("Expires" => $date);
7403: $r->header_out("Pragma" => "no-cache");
1.123 www 7404: }
7405:
7406: sub content_type {
1.181 albertel 7407: my ($r,$type,$charset) = @_;
1.299 foxr 7408: if ($r) {
7409: # Note that printout.pl calls this with undef for $r.
7410: &no_cache($r);
7411: }
1.258 albertel 7412: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 7413: unless ($charset) {
7414: $charset=&Apache::lonlocal::current_encoding;
7415: }
7416: if ($charset) { $type.='; charset='.$charset; }
7417: if ($r) {
7418: $r->content_type($type);
7419: } else {
7420: print("Content-type: $type\n\n");
7421: }
1.9 albertel 7422: }
1.25 albertel 7423:
1.112 bowersj2 7424: =pod
7425:
1.648 raeburn 7426: =item * &add_to_env($name,$value)
1.112 bowersj2 7427:
1.258 albertel 7428: adds $name to the %env hash with value
1.112 bowersj2 7429: $value, if $name already exists, the entry is converted to an array
7430: reference and $value is added to the array.
7431:
7432: =cut
7433:
1.25 albertel 7434: sub add_to_env {
7435: my ($name,$value)=@_;
1.258 albertel 7436: if (defined($env{$name})) {
7437: if (ref($env{$name})) {
1.25 albertel 7438: #already have multiple values
1.258 albertel 7439: push(@{ $env{$name} },$value);
1.25 albertel 7440: } else {
7441: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 7442: my $first=$env{$name};
7443: undef($env{$name});
7444: push(@{ $env{$name} },$first,$value);
1.25 albertel 7445: }
7446: } else {
1.258 albertel 7447: $env{$name}=$value;
1.25 albertel 7448: }
1.31 albertel 7449: }
1.149 albertel 7450:
7451: =pod
7452:
1.648 raeburn 7453: =item * &get_env_multiple($name)
1.149 albertel 7454:
1.258 albertel 7455: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 7456: values may be defined and end up as an array ref.
7457:
7458: returns an array of values
7459:
7460: =cut
7461:
7462: sub get_env_multiple {
7463: my ($name) = @_;
7464: my @values;
1.258 albertel 7465: if (defined($env{$name})) {
1.149 albertel 7466: # exists is it an array
1.258 albertel 7467: if (ref($env{$name})) {
7468: @values=@{ $env{$name} };
1.149 albertel 7469: } else {
1.258 albertel 7470: $values[0]=$env{$name};
1.149 albertel 7471: }
7472: }
7473: return(@values);
7474: }
7475:
1.660 raeburn 7476: sub ask_for_embedded_content {
7477: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
7478: my $upload_output = '
7479: <form name="upload_embedded" action="'.$actionurl.'"
7480: method="post" enctype="multipart/form-data">';
7481: $upload_output .= $state;
1.661 raeburn 7482: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 7483:
7484: my $num = 0;
7485: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
7486: $upload_output .= &start_data_table_row().
7487: '<td>'.$embed_file.'</td><td>';
7488: if ($args->{'ignore_remote_references'}
7489: && $embed_file =~ m{^\w+://}) {
7490: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
7491: } elsif ($args->{'error_on_invalid_names'}
7492: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
7493:
7494: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
7495:
7496: } else {
7497: $upload_output .='
1.661 raeburn 7498: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 7499: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
7500: my $attrib = join(':',@{$$allfiles{$embed_file}});
7501: $upload_output .=
7502: "\n\t\t".
7503: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
7504: $attrib.'" />';
7505: if (exists($$codebase{$embed_file})) {
7506: $upload_output .=
7507: "\n\t\t".
7508: '<input name="codebase_'.$num.'" type="hidden" value="'.
7509: &escape($$codebase{$embed_file}).'" />';
7510: }
7511: }
7512: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
7513: $num++;
7514: }
7515: $upload_output .= &Apache::loncommon::end_data_table().'<br />
7516: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
7517: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
7518: '.&mt('(only files for which a location has been provided will be uploaded)').'
7519: </form>';
7520: return $upload_output;
7521: }
7522:
1.661 raeburn 7523: sub upload_embedded {
7524: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
7525: $current_disk_usage) = @_;
7526: my $output;
7527: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
7528: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
7529: my $orig_uploaded_filename =
7530: $env{'form.embedded_item_'.$i.'.filename'};
7531:
7532: $env{'form.embedded_orig_'.$i} =
7533: &unescape($env{'form.embedded_orig_'.$i});
7534: my ($path,$fname) =
7535: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
7536: # no path, whole string is fname
7537: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
7538:
7539: $path = $env{'form.currentpath'}.$path;
7540: $fname = &Apache::lonnet::clean_filename($fname);
7541: # See if there is anything left
7542: next if ($fname eq '');
7543:
7544: # Check if file already exists as a file or directory.
7545: my ($state,$msg);
7546: if ($context eq 'portfolio') {
7547: my $port_path = $dirpath;
7548: if ($group ne '') {
7549: $port_path = "groups/$group/$port_path";
7550: }
7551: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
7552: $dir_root,$port_path,$disk_quota,
7553: $current_disk_usage,$uname,$udom);
7554: if ($state eq 'will_exceed_quota'
7555: || $state eq 'file_locked'
7556: || $state eq 'file_exists' ) {
7557: $output .= $msg;
7558: next;
7559: }
7560: } elsif (($context eq 'author') || ($context eq 'testbank')) {
7561: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
7562: if ($state eq 'exists') {
7563: $output .= $msg;
7564: next;
7565: }
7566: }
7567: # Check if extension is valid
7568: if (($fname =~ /\.(\w+)$/) &&
7569: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
7570: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
7571: next;
7572: } elsif (($fname =~ /\.(\w+)$/) &&
7573: (!defined(&Apache::loncommon::fileembstyle($1)))) {
7574: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
7575: next;
7576: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
7577: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
7578: next;
7579: }
7580:
7581: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
7582: if ($context eq 'portfolio') {
7583: my $result=
7584: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
7585: $dirpath.$path);
7586: if ($result !~ m|^/uploaded/|) {
7587: $output .= '<span class="LC_error">'
7588: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
7589: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
7590: .'</span><br />';
7591: next;
7592: } else {
7593: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
7594: $path.$fname.'</span>').'</p>';
7595: }
7596: } else {
7597: # Save the file
7598: my $target = $env{'form.embedded_item_'.$i};
7599: my $fullpath = $dir_root.$dirpath.'/'.$path;
7600: my $dest = $fullpath.$fname;
7601: my $url = $url_root.$dirpath.'/'.$path.$fname;
7602: my @parts=split(/\//,$fullpath);
7603: my $count;
7604: my $filepath = $dir_root;
7605: for ($count=4;$count<=$#parts;$count++) {
7606: $filepath .= "/$parts[$count]";
7607: if ((-e $filepath)!=1) {
7608: mkdir($filepath,0770);
7609: }
7610: }
7611: my $fh;
7612: if (!open($fh,'>'.$dest)) {
7613: &Apache::lonnet::logthis('Failed to create '.$dest);
7614: $output .= '<span class="LC_error">'.
7615: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7616: '</span><br />';
7617: } else {
7618: if (!print $fh $env{'form.embedded_item_'.$i}) {
7619: &Apache::lonnet::logthis('Failed to write to '.$dest);
7620: $output .= '<span class="LC_error">'.
7621: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7622: '</span><br />';
7623: } else {
7624: if ($context eq 'testbank') {
7625: $output .= &mt('Embedded file uploaded successfully:').
7626: ' <a href="'.$url.'">'.
7627: $orig_uploaded_filename.'</a><br />';
7628: } else {
1.705 ! tempelho 7629: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 7630: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 ! tempelho 7631: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 7632: }
7633: }
7634: close($fh);
7635: }
7636: }
7637: }
7638: return $output;
7639: }
7640:
7641: sub check_for_existing {
7642: my ($path,$fname,$element) = @_;
7643: my ($state,$msg);
7644: if (-d $path.'/'.$fname) {
7645: $state = 'exists';
7646: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7647: } elsif (-e $path.'/'.$fname) {
7648: $state = 'exists';
7649: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7650: }
7651: if ($state eq 'exists') {
7652: $msg = '<span class="LC_error">'.$msg.'</span><br />';
7653: }
7654: return ($state,$msg);
7655: }
7656:
7657: sub check_for_upload {
7658: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
7659: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
7660: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
7661: my $getpropath = 1;
7662: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
7663: $getpropath);
7664: my $found_file = 0;
7665: my $locked_file = 0;
7666: foreach my $line (@dir_list) {
7667: my ($file_name)=split(/\&/,$line,2);
7668: if ($file_name eq $fname){
7669: $file_name = $path.$file_name;
7670: if ($group ne '') {
7671: $file_name = $group.$file_name;
7672: }
7673: $found_file = 1;
7674: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
7675: $locked_file = 1;
7676: }
7677: }
7678: }
7679: if (($current_disk_usage + $filesize) > $disk_quota){
7680: my $msg = '<span class="LC_error">'.
7681: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
7682: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
7683: return ('will_exceed_quota',$msg);
7684: } elsif ($found_file) {
7685: if ($locked_file) {
7686: my $msg = '<span class="LC_error">';
7687: $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>');
7688: $msg .= '</span><br />';
7689: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
7690: return ('file_locked',$msg);
7691: } else {
7692: my $msg = '<span class="LC_error">';
7693: $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'});
7694: $msg .= '</span>';
7695: $msg .= '<br />';
7696: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
7697: return ('file_exists',$msg);
7698: }
7699: }
7700: }
7701:
1.31 albertel 7702:
1.41 ng 7703: =pod
1.45 matthew 7704:
1.464 albertel 7705: =back
1.41 ng 7706:
1.112 bowersj2 7707: =head1 CSV Upload/Handling functions
1.38 albertel 7708:
1.41 ng 7709: =over 4
7710:
1.648 raeburn 7711: =item * &upfile_store($r)
1.41 ng 7712:
7713: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 7714: needs $env{'form.upfile'}
1.41 ng 7715: returns $datatoken to be put into hidden field
7716:
7717: =cut
1.31 albertel 7718:
7719: sub upfile_store {
7720: my $r=shift;
1.258 albertel 7721: $env{'form.upfile'}=~s/\r/\n/gs;
7722: $env{'form.upfile'}=~s/\f/\n/gs;
7723: $env{'form.upfile'}=~s/\n+/\n/gs;
7724: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 7725:
1.258 albertel 7726: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
7727: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 7728: {
1.158 raeburn 7729: my $datafile = $r->dir_config('lonDaemons').
7730: '/tmp/'.$datatoken.'.tmp';
7731: if ( open(my $fh,">$datafile") ) {
1.258 albertel 7732: print $fh $env{'form.upfile'};
1.158 raeburn 7733: close($fh);
7734: }
1.31 albertel 7735: }
7736: return $datatoken;
7737: }
7738:
1.56 matthew 7739: =pod
7740:
1.648 raeburn 7741: =item * &load_tmp_file($r)
1.41 ng 7742:
7743: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 7744: needs $env{'form.datatoken'},
7745: sets $env{'form.upfile'} to the contents of the file
1.41 ng 7746:
7747: =cut
1.31 albertel 7748:
7749: sub load_tmp_file {
7750: my $r=shift;
7751: my @studentdata=();
7752: {
1.158 raeburn 7753: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 7754: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 7755: if ( open(my $fh,"<$studentfile") ) {
7756: @studentdata=<$fh>;
7757: close($fh);
7758: }
1.31 albertel 7759: }
1.258 albertel 7760: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 7761: }
7762:
1.56 matthew 7763: =pod
7764:
1.648 raeburn 7765: =item * &upfile_record_sep()
1.41 ng 7766:
7767: Separate uploaded file into records
7768: returns array of records,
1.258 albertel 7769: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 7770:
7771: =cut
1.31 albertel 7772:
7773: sub upfile_record_sep {
1.258 albertel 7774: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 7775: } else {
1.248 albertel 7776: my @records;
1.258 albertel 7777: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 7778: if ($line=~/^\s*$/) { next; }
7779: push(@records,$line);
7780: }
7781: return @records;
1.31 albertel 7782: }
7783: }
7784:
1.56 matthew 7785: =pod
7786:
1.648 raeburn 7787: =item * &record_sep($record)
1.41 ng 7788:
1.258 albertel 7789: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 7790:
7791: =cut
7792:
1.263 www 7793: sub takeleft {
7794: my $index=shift;
7795: return substr('0000'.$index,-4,4);
7796: }
7797:
1.31 albertel 7798: sub record_sep {
7799: my $record=shift;
7800: my %components=();
1.258 albertel 7801: if ($env{'form.upfiletype'} eq 'xml') {
7802: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 7803: my $i=0;
1.356 albertel 7804: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 7805: $field=~s/^(\"|\')//;
7806: $field=~s/(\"|\')$//;
1.263 www 7807: $components{&takeleft($i)}=$field;
1.31 albertel 7808: $i++;
7809: }
1.258 albertel 7810: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 7811: my $i=0;
1.356 albertel 7812: foreach my $field (split(/\t/,$record)) {
1.31 albertel 7813: $field=~s/^(\"|\')//;
7814: $field=~s/(\"|\')$//;
1.263 www 7815: $components{&takeleft($i)}=$field;
1.31 albertel 7816: $i++;
7817: }
7818: } else {
1.561 www 7819: my $separator=',';
1.480 banghart 7820: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 7821: $separator=';';
1.480 banghart 7822: }
1.31 albertel 7823: my $i=0;
1.561 www 7824: # the character we are looking for to indicate the end of a quote or a record
7825: my $looking_for=$separator;
7826: # do not add the characters to the fields
7827: my $ignore=0;
7828: # we just encountered a separator (or the beginning of the record)
7829: my $just_found_separator=1;
7830: # store the field we are working on here
7831: my $field='';
7832: # work our way through all characters in record
7833: foreach my $character ($record=~/(.)/g) {
7834: if ($character eq $looking_for) {
7835: if ($character ne $separator) {
7836: # Found the end of a quote, again looking for separator
7837: $looking_for=$separator;
7838: $ignore=1;
7839: } else {
7840: # Found a separator, store away what we got
7841: $components{&takeleft($i)}=$field;
7842: $i++;
7843: $just_found_separator=1;
7844: $ignore=0;
7845: $field='';
7846: }
7847: next;
7848: }
7849: # single or double quotation marks after a separator indicate beginning of a quote
7850: # we are now looking for the end of the quote and need to ignore separators
7851: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
7852: $looking_for=$character;
7853: next;
7854: }
7855: # ignore would be true after we reached the end of a quote
7856: if ($ignore) { next; }
7857: if (($just_found_separator) && ($character=~/\s/)) { next; }
7858: $field.=$character;
7859: $just_found_separator=0;
1.31 albertel 7860: }
1.561 www 7861: # catch the very last entry, since we never encountered the separator
7862: $components{&takeleft($i)}=$field;
1.31 albertel 7863: }
7864: return %components;
7865: }
7866:
1.144 matthew 7867: ######################################################
7868: ######################################################
7869:
1.56 matthew 7870: =pod
7871:
1.648 raeburn 7872: =item * &upfile_select_html()
1.41 ng 7873:
1.144 matthew 7874: Return HTML code to select a file from the users machine and specify
7875: the file type.
1.41 ng 7876:
7877: =cut
7878:
1.144 matthew 7879: ######################################################
7880: ######################################################
1.31 albertel 7881: sub upfile_select_html {
1.144 matthew 7882: my %Types = (
7883: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 7884: semisv => &mt('Semicolon separated values'),
1.144 matthew 7885: space => &mt('Space separated'),
7886: tab => &mt('Tabulator separated'),
7887: # xml => &mt('HTML/XML'),
7888: );
7889: my $Str = '<input type="file" name="upfile" size="50" />'.
7890: '<br />Type: <select name="upfiletype">';
7891: foreach my $type (sort(keys(%Types))) {
7892: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
7893: }
7894: $Str .= "</select>\n";
7895: return $Str;
1.31 albertel 7896: }
7897:
1.301 albertel 7898: sub get_samples {
7899: my ($records,$toget) = @_;
7900: my @samples=({});
7901: my $got=0;
7902: foreach my $rec (@$records) {
7903: my %temp = &record_sep($rec);
7904: if (! grep(/\S/, values(%temp))) { next; }
7905: if (%temp) {
7906: $samples[$got]=\%temp;
7907: $got++;
7908: if ($got == $toget) { last; }
7909: }
7910: }
7911: return \@samples;
7912: }
7913:
1.144 matthew 7914: ######################################################
7915: ######################################################
7916:
1.56 matthew 7917: =pod
7918:
1.648 raeburn 7919: =item * &csv_print_samples($r,$records)
1.41 ng 7920:
7921: Prints a table of sample values from each column uploaded $r is an
7922: Apache Request ref, $records is an arrayref from
7923: &Apache::loncommon::upfile_record_sep
7924:
7925: =cut
7926:
1.144 matthew 7927: ######################################################
7928: ######################################################
1.31 albertel 7929: sub csv_print_samples {
7930: my ($r,$records) = @_;
1.662 bisitz 7931: my $samples = &get_samples($records,5);
1.301 albertel 7932:
1.594 raeburn 7933: $r->print(&mt('Samples').'<br />'.&start_data_table().
7934: &start_data_table_header_row());
1.356 albertel 7935: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
7936: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 7937: $r->print(&end_data_table_header_row());
1.301 albertel 7938: foreach my $hash (@$samples) {
1.594 raeburn 7939: $r->print(&start_data_table_row());
1.356 albertel 7940: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 7941: $r->print('<td>');
1.356 albertel 7942: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 7943: $r->print('</td>');
7944: }
1.594 raeburn 7945: $r->print(&end_data_table_row());
1.31 albertel 7946: }
1.594 raeburn 7947: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 7948: }
7949:
1.144 matthew 7950: ######################################################
7951: ######################################################
7952:
1.56 matthew 7953: =pod
7954:
1.648 raeburn 7955: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 7956:
7957: Prints a table to create associations between values and table columns.
1.144 matthew 7958:
1.41 ng 7959: $r is an Apache Request ref,
7960: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 7961: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 7962:
7963: =cut
7964:
1.144 matthew 7965: ######################################################
7966: ######################################################
1.31 albertel 7967: sub csv_print_select_table {
7968: my ($r,$records,$d) = @_;
1.301 albertel 7969: my $i=0;
7970: my $samples = &get_samples($records,1);
1.144 matthew 7971: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 7972: &start_data_table().&start_data_table_header_row().
1.144 matthew 7973: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 7974: '<th>'.&mt('Column').'</th>'.
7975: &end_data_table_header_row()."\n");
1.356 albertel 7976: foreach my $array_ref (@$d) {
7977: my ($value,$display,$defaultcol)=@{ $array_ref };
1.705 ! tempelho 7978: $r->print(&start_data_table_row().'<tr><td>'.$display.'</td>');
1.31 albertel 7979:
7980: $r->print('<td><select name=f'.$i.
1.32 matthew 7981: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 7982: $r->print('<option value="none"></option>');
1.356 albertel 7983: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
7984: $r->print('<option value="'.$sample.'"'.
7985: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 7986: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 7987: }
1.594 raeburn 7988: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 7989: $i++;
7990: }
1.594 raeburn 7991: $r->print(&end_data_table());
1.31 albertel 7992: $i--;
7993: return $i;
7994: }
1.56 matthew 7995:
1.144 matthew 7996: ######################################################
7997: ######################################################
7998:
1.56 matthew 7999: =pod
1.31 albertel 8000:
1.648 raeburn 8001: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8002:
8003: Prints a table of sample values from the upload and can make associate samples to internal names.
8004:
8005: $r is an Apache Request ref,
8006: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8007: $d is an array of 2 element arrays (internal name, displayed name)
8008:
8009: =cut
8010:
1.144 matthew 8011: ######################################################
8012: ######################################################
1.31 albertel 8013: sub csv_samples_select_table {
8014: my ($r,$records,$d) = @_;
8015: my $i=0;
1.144 matthew 8016: #
1.662 bisitz 8017: my $max_samples = 5;
8018: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8019: $r->print(&start_data_table().
8020: &start_data_table_header_row().'<th>'.
8021: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8022: &end_data_table_header_row());
1.301 albertel 8023:
8024: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8025: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8026: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8027: foreach my $option (@$d) {
8028: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8029: $r->print('<option value="'.$value.'"'.
1.253 albertel 8030: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8031: $display.'</option>');
1.31 albertel 8032: }
8033: $r->print('</select></td><td>');
1.662 bisitz 8034: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8035: if (defined($samples->[$line]{$key})) {
8036: $r->print($samples->[$line]{$key}."<br />\n");
8037: }
8038: }
1.594 raeburn 8039: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8040: $i++;
8041: }
1.594 raeburn 8042: $r->print(&end_data_table());
1.31 albertel 8043: $i--;
8044: return($i);
1.115 matthew 8045: }
8046:
1.144 matthew 8047: ######################################################
8048: ######################################################
8049:
1.115 matthew 8050: =pod
8051:
1.648 raeburn 8052: =item * &clean_excel_name($name)
1.115 matthew 8053:
8054: Returns a replacement for $name which does not contain any illegal characters.
8055:
8056: =cut
8057:
1.144 matthew 8058: ######################################################
8059: ######################################################
1.115 matthew 8060: sub clean_excel_name {
8061: my ($name) = @_;
8062: $name =~ s/[:\*\?\/\\]//g;
8063: if (length($name) > 31) {
8064: $name = substr($name,0,31);
8065: }
8066: return $name;
1.25 albertel 8067: }
1.84 albertel 8068:
1.85 albertel 8069: =pod
8070:
1.648 raeburn 8071: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8072:
8073: Returns either 1 or undef
8074:
8075: 1 if the part is to be hidden, undef if it is to be shown
8076:
8077: Arguments are:
8078:
8079: $id the id of the part to be checked
8080: $symb, optional the symb of the resource to check
8081: $udom, optional the domain of the user to check for
8082: $uname, optional the username of the user to check for
8083:
8084: =cut
1.84 albertel 8085:
8086: sub check_if_partid_hidden {
8087: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8088: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8089: $symb,$udom,$uname);
1.141 albertel 8090: my $truth=1;
8091: #if the string starts with !, then the list is the list to show not hide
8092: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8093: my @hiddenlist=split(/,/,$hiddenparts);
8094: foreach my $checkid (@hiddenlist) {
1.141 albertel 8095: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8096: }
1.141 albertel 8097: return !$truth;
1.84 albertel 8098: }
1.127 matthew 8099:
1.138 matthew 8100:
8101: ############################################################
8102: ############################################################
8103:
8104: =pod
8105:
1.157 matthew 8106: =back
8107:
1.138 matthew 8108: =head1 cgi-bin script and graphing routines
8109:
1.157 matthew 8110: =over 4
8111:
1.648 raeburn 8112: =item * &get_cgi_id()
1.138 matthew 8113:
8114: Inputs: none
8115:
8116: Returns an id which can be used to pass environment variables
8117: to various cgi-bin scripts. These environment variables will
8118: be removed from the users environment after a given time by
8119: the routine &Apache::lonnet::transfer_profile_to_env.
8120:
8121: =cut
8122:
8123: ############################################################
8124: ############################################################
1.152 albertel 8125: my $uniq=0;
1.136 matthew 8126: sub get_cgi_id {
1.154 albertel 8127: $uniq=($uniq+1)%100000;
1.280 albertel 8128: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8129: }
8130:
1.127 matthew 8131: ############################################################
8132: ############################################################
8133:
8134: =pod
8135:
1.648 raeburn 8136: =item * &DrawBarGraph()
1.127 matthew 8137:
1.138 matthew 8138: Facilitates the plotting of data in a (stacked) bar graph.
8139: Puts plot definition data into the users environment in order for
8140: graph.png to plot it. Returns an <img> tag for the plot.
8141: The bars on the plot are labeled '1','2',...,'n'.
8142:
8143: Inputs:
8144:
8145: =over 4
8146:
8147: =item $Title: string, the title of the plot
8148:
8149: =item $xlabel: string, text describing the X-axis of the plot
8150:
8151: =item $ylabel: string, text describing the Y-axis of the plot
8152:
8153: =item $Max: scalar, the maximum Y value to use in the plot
8154: If $Max is < any data point, the graph will not be rendered.
8155:
1.140 matthew 8156: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8157: they are plotted. If undefined, default values will be used.
8158:
1.178 matthew 8159: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8160:
1.138 matthew 8161: =item @Values: An array of array references. Each array reference holds data
8162: to be plotted in a stacked bar chart.
8163:
1.239 matthew 8164: =item If the final element of @Values is a hash reference the key/value
8165: pairs will be added to the graph definition.
8166:
1.138 matthew 8167: =back
8168:
8169: Returns:
8170:
8171: An <img> tag which references graph.png and the appropriate identifying
8172: information for the plot.
8173:
1.127 matthew 8174: =cut
8175:
8176: ############################################################
8177: ############################################################
1.134 matthew 8178: sub DrawBarGraph {
1.178 matthew 8179: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 8180: #
8181: if (! defined($colors)) {
8182: $colors = ['#33ff00',
8183: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
8184: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
8185: ];
8186: }
1.228 matthew 8187: my $extra_settings = {};
8188: if (ref($Values[-1]) eq 'HASH') {
8189: $extra_settings = pop(@Values);
8190: }
1.127 matthew 8191: #
1.136 matthew 8192: my $identifier = &get_cgi_id();
8193: my $id = 'cgi.'.$identifier;
1.129 matthew 8194: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 8195: return '';
8196: }
1.225 matthew 8197: #
8198: my @Labels;
8199: if (defined($labels)) {
8200: @Labels = @$labels;
8201: } else {
8202: for (my $i=0;$i<@{$Values[0]};$i++) {
8203: push (@Labels,$i+1);
8204: }
8205: }
8206: #
1.129 matthew 8207: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 8208: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 8209: my %ValuesHash;
8210: my $NumSets=1;
8211: foreach my $array (@Values) {
8212: next if (! ref($array));
1.136 matthew 8213: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 8214: join(',',@$array);
1.129 matthew 8215: }
1.127 matthew 8216: #
1.136 matthew 8217: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 8218: if ($NumBars < 3) {
8219: $width = 120+$NumBars*32;
1.220 matthew 8220: $xskip = 1;
1.225 matthew 8221: $bar_width = 30;
8222: } elsif ($NumBars < 5) {
8223: $width = 120+$NumBars*20;
8224: $xskip = 1;
8225: $bar_width = 20;
1.220 matthew 8226: } elsif ($NumBars < 10) {
1.136 matthew 8227: $width = 120+$NumBars*15;
8228: $xskip = 1;
8229: $bar_width = 15;
8230: } elsif ($NumBars <= 25) {
8231: $width = 120+$NumBars*11;
8232: $xskip = 5;
8233: $bar_width = 8;
8234: } elsif ($NumBars <= 50) {
8235: $width = 120+$NumBars*8;
8236: $xskip = 5;
8237: $bar_width = 4;
8238: } else {
8239: $width = 120+$NumBars*8;
8240: $xskip = 5;
8241: $bar_width = 4;
8242: }
8243: #
1.137 matthew 8244: $Max = 1 if ($Max < 1);
8245: if ( int($Max) < $Max ) {
8246: $Max++;
8247: $Max = int($Max);
8248: }
1.127 matthew 8249: $Title = '' if (! defined($Title));
8250: $xlabel = '' if (! defined($xlabel));
8251: $ylabel = '' if (! defined($ylabel));
1.369 www 8252: $ValuesHash{$id.'.title'} = &escape($Title);
8253: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
8254: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 8255: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 8256: $ValuesHash{$id.'.NumBars'} = $NumBars;
8257: $ValuesHash{$id.'.NumSets'} = $NumSets;
8258: $ValuesHash{$id.'.PlotType'} = 'bar';
8259: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8260: $ValuesHash{$id.'.height'} = $height;
8261: $ValuesHash{$id.'.width'} = $width;
8262: $ValuesHash{$id.'.xskip'} = $xskip;
8263: $ValuesHash{$id.'.bar_width'} = $bar_width;
8264: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 8265: #
1.228 matthew 8266: # Deal with other parameters
8267: while (my ($key,$value) = each(%$extra_settings)) {
8268: $ValuesHash{$id.'.'.$key} = $value;
8269: }
8270: #
1.646 raeburn 8271: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 8272: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8273: }
8274:
8275: ############################################################
8276: ############################################################
8277:
8278: =pod
8279:
1.648 raeburn 8280: =item * &DrawXYGraph()
1.137 matthew 8281:
1.138 matthew 8282: Facilitates the plotting of data in an XY graph.
8283: Puts plot definition data into the users environment in order for
8284: graph.png to plot it. Returns an <img> tag for the plot.
8285:
8286: Inputs:
8287:
8288: =over 4
8289:
8290: =item $Title: string, the title of the plot
8291:
8292: =item $xlabel: string, text describing the X-axis of the plot
8293:
8294: =item $ylabel: string, text describing the Y-axis of the plot
8295:
8296: =item $Max: scalar, the maximum Y value to use in the plot
8297: If $Max is < any data point, the graph will not be rendered.
8298:
8299: =item $colors: Array ref containing the hex color codes for the data to be
8300: plotted in. If undefined, default values will be used.
8301:
8302: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8303:
8304: =item $Ydata: Array ref containing Array refs.
1.185 www 8305: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 8306:
8307: =item %Values: hash indicating or overriding any default values which are
8308: passed to graph.png.
8309: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8310:
8311: =back
8312:
8313: Returns:
8314:
8315: An <img> tag which references graph.png and the appropriate identifying
8316: information for the plot.
8317:
1.137 matthew 8318: =cut
8319:
8320: ############################################################
8321: ############################################################
8322: sub DrawXYGraph {
8323: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
8324: #
8325: # Create the identifier for the graph
8326: my $identifier = &get_cgi_id();
8327: my $id = 'cgi.'.$identifier;
8328: #
8329: $Title = '' if (! defined($Title));
8330: $xlabel = '' if (! defined($xlabel));
8331: $ylabel = '' if (! defined($ylabel));
8332: my %ValuesHash =
8333: (
1.369 www 8334: $id.'.title' => &escape($Title),
8335: $id.'.xlabel' => &escape($xlabel),
8336: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 8337: $id.'.y_max_value'=> $Max,
8338: $id.'.labels' => join(',',@$Xlabels),
8339: $id.'.PlotType' => 'XY',
8340: );
8341: #
8342: if (defined($colors) && ref($colors) eq 'ARRAY') {
8343: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8344: }
8345: #
8346: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
8347: return '';
8348: }
8349: my $NumSets=1;
1.138 matthew 8350: foreach my $array (@{$Ydata}){
1.137 matthew 8351: next if (! ref($array));
8352: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
8353: }
1.138 matthew 8354: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 8355: #
8356: # Deal with other parameters
8357: while (my ($key,$value) = each(%Values)) {
8358: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 8359: }
8360: #
1.646 raeburn 8361: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 8362: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8363: }
8364:
8365: ############################################################
8366: ############################################################
8367:
8368: =pod
8369:
1.648 raeburn 8370: =item * &DrawXYYGraph()
1.138 matthew 8371:
8372: Facilitates the plotting of data in an XY graph with two Y axes.
8373: Puts plot definition data into the users environment in order for
8374: graph.png to plot it. Returns an <img> tag for the plot.
8375:
8376: Inputs:
8377:
8378: =over 4
8379:
8380: =item $Title: string, the title of the plot
8381:
8382: =item $xlabel: string, text describing the X-axis of the plot
8383:
8384: =item $ylabel: string, text describing the Y-axis of the plot
8385:
8386: =item $colors: Array ref containing the hex color codes for the data to be
8387: plotted in. If undefined, default values will be used.
8388:
8389: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8390:
8391: =item $Ydata1: The first data set
8392:
8393: =item $Min1: The minimum value of the left Y-axis
8394:
8395: =item $Max1: The maximum value of the left Y-axis
8396:
8397: =item $Ydata2: The second data set
8398:
8399: =item $Min2: The minimum value of the right Y-axis
8400:
8401: =item $Max2: The maximum value of the left Y-axis
8402:
8403: =item %Values: hash indicating or overriding any default values which are
8404: passed to graph.png.
8405: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8406:
8407: =back
8408:
8409: Returns:
8410:
8411: An <img> tag which references graph.png and the appropriate identifying
8412: information for the plot.
1.136 matthew 8413:
8414: =cut
8415:
8416: ############################################################
8417: ############################################################
1.137 matthew 8418: sub DrawXYYGraph {
8419: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
8420: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 8421: #
8422: # Create the identifier for the graph
8423: my $identifier = &get_cgi_id();
8424: my $id = 'cgi.'.$identifier;
8425: #
8426: $Title = '' if (! defined($Title));
8427: $xlabel = '' if (! defined($xlabel));
8428: $ylabel = '' if (! defined($ylabel));
8429: my %ValuesHash =
8430: (
1.369 www 8431: $id.'.title' => &escape($Title),
8432: $id.'.xlabel' => &escape($xlabel),
8433: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 8434: $id.'.labels' => join(',',@$Xlabels),
8435: $id.'.PlotType' => 'XY',
8436: $id.'.NumSets' => 2,
1.137 matthew 8437: $id.'.two_axes' => 1,
8438: $id.'.y1_max_value' => $Max1,
8439: $id.'.y1_min_value' => $Min1,
8440: $id.'.y2_max_value' => $Max2,
8441: $id.'.y2_min_value' => $Min2,
1.136 matthew 8442: );
8443: #
1.137 matthew 8444: if (defined($colors) && ref($colors) eq 'ARRAY') {
8445: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8446: }
8447: #
8448: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
8449: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 8450: return '';
8451: }
8452: my $NumSets=1;
1.137 matthew 8453: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 8454: next if (! ref($array));
8455: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 8456: }
8457: #
8458: # Deal with other parameters
8459: while (my ($key,$value) = each(%Values)) {
8460: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 8461: }
8462: #
1.646 raeburn 8463: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 8464: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 8465: }
8466:
8467: ############################################################
8468: ############################################################
8469:
8470: =pod
8471:
1.157 matthew 8472: =back
8473:
1.139 matthew 8474: =head1 Statistics helper routines?
8475:
8476: Bad place for them but what the hell.
8477:
1.157 matthew 8478: =over 4
8479:
1.648 raeburn 8480: =item * &chartlink()
1.139 matthew 8481:
8482: Returns a link to the chart for a specific student.
8483:
8484: Inputs:
8485:
8486: =over 4
8487:
8488: =item $linktext: The text of the link
8489:
8490: =item $sname: The students username
8491:
8492: =item $sdomain: The students domain
8493:
8494: =back
8495:
1.157 matthew 8496: =back
8497:
1.139 matthew 8498: =cut
8499:
8500: ############################################################
8501: ############################################################
8502: sub chartlink {
8503: my ($linktext, $sname, $sdomain) = @_;
8504: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 8505: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 8506: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 8507: '">'.$linktext.'</a>';
1.153 matthew 8508: }
8509:
8510: #######################################################
8511: #######################################################
8512:
8513: =pod
8514:
8515: =head1 Course Environment Routines
1.157 matthew 8516:
8517: =over 4
1.153 matthew 8518:
1.648 raeburn 8519: =item * &restore_course_settings()
1.153 matthew 8520:
1.648 raeburn 8521: =item * &store_course_settings()
1.153 matthew 8522:
8523: Restores/Store indicated form parameters from the course environment.
8524: Will not overwrite existing values of the form parameters.
8525:
8526: Inputs:
8527: a scalar describing the data (e.g. 'chart', 'problem_analysis')
8528:
8529: a hash ref describing the data to be stored. For example:
8530:
8531: %Save_Parameters = ('Status' => 'scalar',
8532: 'chartoutputmode' => 'scalar',
8533: 'chartoutputdata' => 'scalar',
8534: 'Section' => 'array',
1.373 raeburn 8535: 'Group' => 'array',
1.153 matthew 8536: 'StudentData' => 'array',
8537: 'Maps' => 'array');
8538:
8539: Returns: both routines return nothing
8540:
1.631 raeburn 8541: =back
8542:
1.153 matthew 8543: =cut
8544:
8545: #######################################################
8546: #######################################################
8547: sub store_course_settings {
1.496 albertel 8548: return &store_settings($env{'request.course.id'},@_);
8549: }
8550:
8551: sub store_settings {
1.153 matthew 8552: # save to the environment
8553: # appenv the same items, just to be safe
1.300 albertel 8554: my $udom = $env{'user.domain'};
8555: my $uname = $env{'user.name'};
1.496 albertel 8556: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8557: my %SaveHash;
8558: my %AppHash;
8559: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 8560: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 8561: my $envname = 'environment.'.$basename;
1.258 albertel 8562: if (exists($env{'form.'.$setting})) {
1.153 matthew 8563: # Save this value away
8564: if ($type eq 'scalar' &&
1.258 albertel 8565: (! exists($env{$envname}) ||
8566: $env{$envname} ne $env{'form.'.$setting})) {
8567: $SaveHash{$basename} = $env{'form.'.$setting};
8568: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 8569: } elsif ($type eq 'array') {
8570: my $stored_form;
1.258 albertel 8571: if (ref($env{'form.'.$setting})) {
1.153 matthew 8572: $stored_form = join(',',
8573: map {
1.369 www 8574: &escape($_);
1.258 albertel 8575: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 8576: } else {
8577: $stored_form =
1.369 www 8578: &escape($env{'form.'.$setting});
1.153 matthew 8579: }
8580: # Determine if the array contents are the same.
1.258 albertel 8581: if ($stored_form ne $env{$envname}) {
1.153 matthew 8582: $SaveHash{$basename} = $stored_form;
8583: $AppHash{$envname} = $stored_form;
8584: }
8585: }
8586: }
8587: }
8588: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 8589: $udom,$uname);
1.153 matthew 8590: if ($put_result !~ /^(ok|delayed)/) {
8591: &Apache::lonnet::logthis('unable to save form parameters, '.
8592: 'got error:'.$put_result);
8593: }
8594: # Make sure these settings stick around in this session, too
1.646 raeburn 8595: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 8596: return;
8597: }
8598:
8599: sub restore_course_settings {
1.499 albertel 8600: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 8601: }
8602:
8603: sub restore_settings {
8604: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8605: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 8606: next if (exists($env{'form.'.$setting}));
1.496 albertel 8607: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 8608: '.'.$setting;
1.258 albertel 8609: if (exists($env{$envname})) {
1.153 matthew 8610: if ($type eq 'scalar') {
1.258 albertel 8611: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 8612: } elsif ($type eq 'array') {
1.258 albertel 8613: $env{'form.'.$setting} = [
1.153 matthew 8614: map {
1.369 www 8615: &unescape($_);
1.258 albertel 8616: } split(',',$env{$envname})
1.153 matthew 8617: ];
8618: }
8619: }
8620: }
1.127 matthew 8621: }
8622:
1.618 raeburn 8623: #######################################################
8624: #######################################################
8625:
8626: =pod
8627:
8628: =head1 Domain E-mail Routines
8629:
8630: =over 4
8631:
1.648 raeburn 8632: =item * &build_recipient_list()
1.618 raeburn 8633:
8634: Build recipient lists for three types of e-mail:
8635: (a) Error Reports, (b) Package Updates, (c) Help requests, generated by
1.619 raeburn 8636: lonerrorhandler.pm, CHECKRPMS and lonsupportreq.pm respectively.
1.618 raeburn 8637:
8638: Inputs:
1.619 raeburn 8639: defmail (scalar - email address of default recipient),
1.618 raeburn 8640: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 8641: defdom (domain for which to retrieve configuration settings),
8642: origmail (scalar - email address of recipient from loncapa.conf,
8643: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 8644:
1.655 raeburn 8645: Returns: comma separated list of addresses to which to send e-mail.
8646:
8647: =back
1.618 raeburn 8648:
8649: =cut
8650:
8651: ############################################################
8652: ############################################################
8653: sub build_recipient_list {
1.619 raeburn 8654: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 8655: my @recipients;
8656: my $otheremails;
8657: my %domconfig =
8658: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
8659: if (ref($domconfig{'contacts'}) eq 'HASH') {
8660: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
8661: my @contacts = ('adminemail','supportemail');
8662: foreach my $item (@contacts) {
8663: if ($domconfig{'contacts'}{$mailing}{$item}) {
1.619 raeburn 8664: my $addr = $domconfig{'contacts'}{$item};
8665: if (!grep(/^\Q$addr\E$/,@recipients)) {
8666: push(@recipients,$addr);
8667: }
1.618 raeburn 8668: }
8669: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
8670: }
8671: }
1.619 raeburn 8672: } elsif ($origmail ne '') {
8673: push(@recipients,$origmail);
1.618 raeburn 8674: }
1.688 raeburn 8675: if (defined($defmail)) {
8676: if ($defmail ne '') {
8677: push(@recipients,$defmail);
8678: }
1.618 raeburn 8679: }
8680: if ($otheremails) {
1.619 raeburn 8681: my @others;
8682: if ($otheremails =~ /,/) {
8683: @others = split(/,/,$otheremails);
1.618 raeburn 8684: } else {
1.619 raeburn 8685: push(@others,$otheremails);
8686: }
8687: foreach my $addr (@others) {
8688: if (!grep(/^\Q$addr\E$/,@recipients)) {
8689: push(@recipients,$addr);
8690: }
1.618 raeburn 8691: }
8692: }
1.619 raeburn 8693: my $recipientlist = join(',',@recipients);
1.618 raeburn 8694: return $recipientlist;
8695: }
8696:
1.127 matthew 8697: ############################################################
8698: ############################################################
1.154 albertel 8699:
1.655 raeburn 8700: =pod
8701:
8702: =head1 Course Catalog Routines
8703:
8704: =over 4
8705:
8706: =item * &gather_categories()
8707:
8708: Converts category definitions - keys of categories hash stored in
8709: coursecategories in configuration.db on the primary library server in a
8710: domain - to an array. Also generates javascript and idx hash used to
8711: generate Domain Coordinator interface for editing Course Categories.
8712:
8713: Inputs:
1.663 raeburn 8714:
1.655 raeburn 8715: categories (reference to hash of category definitions).
1.663 raeburn 8716:
1.655 raeburn 8717: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8718: categories and subcategories).
1.663 raeburn 8719:
1.655 raeburn 8720: idx (reference to hash of counters used in Domain Coordinator interface for
8721: editing Course Categories).
1.663 raeburn 8722:
1.655 raeburn 8723: jsarray (reference to array of categories used to create Javascript arrays for
8724: Domain Coordinator interface for editing Course Categories).
8725:
8726: Returns: nothing
8727:
8728: Side effects: populates cats, idx and jsarray.
8729:
8730: =cut
8731:
8732: sub gather_categories {
8733: my ($categories,$cats,$idx,$jsarray) = @_;
8734: my %counters;
8735: my $num = 0;
8736: foreach my $item (keys(%{$categories})) {
8737: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
8738: if ($container eq '' && $depth == 0) {
8739: $cats->[$depth][$categories->{$item}] = $cat;
8740: } else {
8741: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
8742: }
8743: my ($escitem,$tail) = split(/:/,$item,2);
8744: if ($counters{$tail} eq '') {
8745: $counters{$tail} = $num;
8746: $num ++;
8747: }
8748: if (ref($idx) eq 'HASH') {
8749: $idx->{$item} = $counters{$tail};
8750: }
8751: if (ref($jsarray) eq 'ARRAY') {
8752: push(@{$jsarray->[$counters{$tail}]},$item);
8753: }
8754: }
8755: return;
8756: }
8757:
8758: =pod
8759:
8760: =item * &extract_categories()
8761:
8762: Used to generate breadcrumb trails for course categories.
8763:
8764: Inputs:
1.663 raeburn 8765:
1.655 raeburn 8766: categories (reference to hash of category definitions).
1.663 raeburn 8767:
1.655 raeburn 8768: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8769: categories and subcategories).
1.663 raeburn 8770:
1.655 raeburn 8771: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 8772:
1.655 raeburn 8773: allitems (reference to hash - key is category key
8774: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 8775:
1.655 raeburn 8776: idx (reference to hash of counters used in Domain Coordinator interface for
8777: editing Course Categories).
1.663 raeburn 8778:
1.655 raeburn 8779: jsarray (reference to array of categories used to create Javascript arrays for
8780: Domain Coordinator interface for editing Course Categories).
8781:
1.665 raeburn 8782: subcats (reference to hash of arrays containing all subcategories within each
8783: category, -recursive)
8784:
1.655 raeburn 8785: Returns: nothing
8786:
8787: Side effects: populates trails and allitems hash references.
8788:
8789: =cut
8790:
8791: sub extract_categories {
1.665 raeburn 8792: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 8793: if (ref($categories) eq 'HASH') {
8794: &gather_categories($categories,$cats,$idx,$jsarray);
8795: if (ref($cats->[0]) eq 'ARRAY') {
8796: for (my $i=0; $i<@{$cats->[0]}; $i++) {
8797: my $name = $cats->[0][$i];
8798: my $item = &escape($name).'::0';
8799: my $trailstr;
8800: if ($name eq 'instcode') {
8801: $trailstr = &mt('Official courses (with institutional codes)');
8802: } else {
8803: $trailstr = $name;
8804: }
8805: if ($allitems->{$item} eq '') {
8806: push(@{$trails},$trailstr);
8807: $allitems->{$item} = scalar(@{$trails})-1;
8808: }
8809: my @parents = ($name);
8810: if (ref($cats->[1]{$name}) eq 'ARRAY') {
8811: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
8812: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 8813: if (ref($subcats) eq 'HASH') {
8814: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
8815: }
8816: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
8817: }
8818: } else {
8819: if (ref($subcats) eq 'HASH') {
8820: $subcats->{$item} = [];
1.655 raeburn 8821: }
8822: }
8823: }
8824: }
8825: }
8826: return;
8827: }
8828:
8829: =pod
8830:
8831: =item *&recurse_categories()
8832:
8833: Recursively used to generate breadcrumb trails for course categories.
8834:
8835: Inputs:
1.663 raeburn 8836:
1.655 raeburn 8837: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8838: categories and subcategories).
1.663 raeburn 8839:
1.655 raeburn 8840: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 8841:
8842: category (current course category, for which breadcrumb trail is being generated).
8843:
8844: trails (reference to array of breadcrumb trails for each category).
8845:
1.655 raeburn 8846: allitems (reference to hash - key is category key
8847: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 8848:
1.655 raeburn 8849: parents (array containing containers directories for current category,
8850: back to top level).
8851:
8852: Returns: nothing
8853:
8854: Side effects: populates trails and allitems hash references
8855:
8856: =cut
8857:
8858: sub recurse_categories {
1.665 raeburn 8859: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 8860: my $shallower = $depth - 1;
8861: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
8862: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
8863: my $name = $cats->[$depth]{$category}[$k];
8864: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
8865: my $trailstr = join(' -> ',(@{$parents},$category));
8866: if ($allitems->{$item} eq '') {
8867: push(@{$trails},$trailstr);
8868: $allitems->{$item} = scalar(@{$trails})-1;
8869: }
8870: my $deeper = $depth+1;
8871: push(@{$parents},$category);
1.665 raeburn 8872: if (ref($subcats) eq 'HASH') {
8873: my $subcat = &escape($name).':'.$category.':'.$depth;
8874: for (my $j=@{$parents}; $j>=0; $j--) {
8875: my $higher;
8876: if ($j > 0) {
8877: $higher = &escape($parents->[$j]).':'.
8878: &escape($parents->[$j-1]).':'.$j;
8879: } else {
8880: $higher = &escape($parents->[$j]).'::'.$j;
8881: }
8882: push(@{$subcats->{$higher}},$subcat);
8883: }
8884: }
8885: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
8886: $subcats);
1.655 raeburn 8887: pop(@{$parents});
8888: }
8889: } else {
8890: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
8891: my $trailstr = join(' -> ',(@{$parents},$category));
8892: if ($allitems->{$item} eq '') {
8893: push(@{$trails},$trailstr);
8894: $allitems->{$item} = scalar(@{$trails})-1;
8895: }
8896: }
8897: return;
8898: }
8899:
1.663 raeburn 8900: =pod
8901:
8902: =item *&assign_categories_table()
8903:
8904: Create a datatable for display of hierarchical categories in a domain,
8905: with checkboxes to allow a course to be categorized.
8906:
8907: Inputs:
8908:
8909: cathash - reference to hash of categories defined for the domain (from
8910: configuration.db)
8911:
8912: currcat - scalar with an & separated list of categories assigned to a course.
8913:
8914: Returns: $output (markup to be displayed)
8915:
8916: =cut
8917:
8918: sub assign_categories_table {
8919: my ($cathash,$currcat) = @_;
8920: my $output;
8921: if (ref($cathash) eq 'HASH') {
8922: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
8923: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
8924: $maxdepth = scalar(@cats);
8925: if (@cats > 0) {
8926: my $itemcount = 0;
8927: if (ref($cats[0]) eq 'ARRAY') {
8928: $output = &Apache::loncommon::start_data_table();
8929: my @currcategories;
8930: if ($currcat ne '') {
8931: @currcategories = split('&',$currcat);
8932: }
8933: for (my $i=0; $i<@{$cats[0]}; $i++) {
8934: my $parent = $cats[0][$i];
8935: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
8936: next if ($parent eq 'instcode');
8937: my $item = &escape($parent).'::0';
8938: my $checked = '';
8939: if (@currcategories > 0) {
8940: if (grep(/^\Q$item\E$/,@currcategories)) {
8941: $checked = ' checked="checked" ';
8942: }
8943: }
1.675 raeburn 8944: $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
8945: '<input type="checkbox" name="usecategory" value="'.
8946: $item.'"'.$checked.' />'.$parent.'</span>'.
8947: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 8948: my $depth = 1;
8949: push(@path,$parent);
8950: $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
8951: pop(@path);
8952: $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
8953: $itemcount ++;
8954: }
8955: $output .= &Apache::loncommon::end_data_table();
8956: }
8957: }
8958: }
8959: return $output;
8960: }
8961:
8962: =pod
8963:
8964: =item *&assign_category_rows()
8965:
8966: Create a datatable row for display of nested categories in a domain,
8967: with checkboxes to allow a course to be categorized,called recursively.
8968:
8969: Inputs:
8970:
8971: itemcount - track row number for alternating colors
8972:
8973: cats - reference to array of arrays/hashes which encapsulates hierarchy of
8974: categories and subcategories.
8975:
8976: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
8977:
8978: parent - parent of current category item
8979:
8980: path - Array containing all categories back up through the hierarchy from the
8981: current category to the top level.
8982:
8983: currcategories - reference to array of current categories assigned to the course
8984:
8985: Returns: $output (markup to be displayed).
8986:
8987: =cut
8988:
8989: sub assign_category_rows {
8990: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
8991: my ($text,$name,$item,$chgstr);
8992: if (ref($cats) eq 'ARRAY') {
8993: my $maxdepth = scalar(@{$cats});
8994: if (ref($cats->[$depth]) eq 'HASH') {
8995: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
8996: my $numchildren = @{$cats->[$depth]{$parent}};
8997: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
8998: $text .= '<td><table class="LC_datatable">';
8999: for (my $j=0; $j<$numchildren; $j++) {
9000: $name = $cats->[$depth]{$parent}[$j];
9001: $item = &escape($name).':'.&escape($parent).':'.$depth;
9002: my $deeper = $depth+1;
9003: my $checked = '';
9004: if (ref($currcategories) eq 'ARRAY') {
9005: if (@{$currcategories} > 0) {
9006: if (grep(/^\Q$item\E$/,@{$currcategories})) {
9007: $checked = ' checked="checked" ';
9008: }
9009: }
9010: }
1.664 raeburn 9011: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9012: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9013: $item.'"'.$checked.' />'.$name.'</label></span>'.
9014: '<input type="hidden" name="catname" value="'.$name.'" />'.
9015: '</td><td>';
1.663 raeburn 9016: if (ref($path) eq 'ARRAY') {
9017: push(@{$path},$name);
9018: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9019: pop(@{$path});
9020: }
9021: $text .= '</td></tr>';
9022: }
9023: $text .= '</table></td>';
9024: }
9025: }
9026: }
9027: return $text;
9028: }
9029:
1.655 raeburn 9030: ############################################################
9031: ############################################################
9032:
9033:
1.443 albertel 9034: sub commit_customrole {
1.664 raeburn 9035: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9036: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9037: ($start?', '.&mt('starting').' '.localtime($start):'').
9038: ($end?', ending '.localtime($end):'').': <b>'.
9039: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9040: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9041: '</b><br />';
9042: return $output;
9043: }
9044:
9045: sub commit_standardrole {
1.541 raeburn 9046: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9047: my ($output,$logmsg,$linefeed);
9048: if ($context eq 'auto') {
9049: $linefeed = "\n";
9050: } else {
9051: $linefeed = "<br />\n";
9052: }
1.443 albertel 9053: if ($three eq 'st') {
1.541 raeburn 9054: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9055: $one,$two,$sec,$context);
9056: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9057: ($result eq 'unknown_course') || ($result eq 'refused')) {
9058: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9059: } else {
1.541 raeburn 9060: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9061: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9062: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9063: if ($context eq 'auto') {
9064: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9065: } else {
9066: $output .= '<b>'.$result.'</b>'.$linefeed.
9067: &mt('Add to classlist').': <b>ok</b>';
9068: }
9069: $output .= $linefeed;
1.443 albertel 9070: }
9071: } else {
9072: $output = &mt('Assigning').' '.$three.' in '.$url.
9073: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9074: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9075: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9076: if ($context eq 'auto') {
9077: $output .= $result.$linefeed;
9078: } else {
9079: $output .= '<b>'.$result.'</b>'.$linefeed;
9080: }
1.443 albertel 9081: }
9082: return $output;
9083: }
9084:
9085: sub commit_studentrole {
1.541 raeburn 9086: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9087: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9088: if ($context eq 'auto') {
9089: $linefeed = "\n";
9090: } else {
9091: $linefeed = '<br />'."\n";
9092: }
1.443 albertel 9093: if (defined($one) && defined($two)) {
9094: my $cid=$one.'_'.$two;
9095: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9096: my $secchange = 0;
9097: my $expire_role_result;
9098: my $modify_section_result;
1.628 raeburn 9099: if ($oldsec ne '-1') {
9100: if ($oldsec ne $sec) {
1.443 albertel 9101: $secchange = 1;
1.628 raeburn 9102: my $now = time;
1.443 albertel 9103: my $uurl='/'.$cid;
9104: $uurl=~s/\_/\//g;
9105: if ($oldsec) {
9106: $uurl.='/'.$oldsec;
9107: }
1.626 raeburn 9108: $oldsecurl = $uurl;
1.628 raeburn 9109: $expire_role_result =
1.652 raeburn 9110: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9111: if ($env{'request.course.sec'} ne '') {
9112: if ($expire_role_result eq 'refused') {
9113: my @roles = ('st');
9114: my @statuses = ('previous');
9115: my @roledoms = ($one);
9116: my $withsec = 1;
9117: my %roleshash =
9118: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9119: \@statuses,\@roles,\@roledoms,$withsec);
9120: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9121: my ($oldstart,$oldend) =
9122: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9123: if ($oldend > 0 && $oldend <= $now) {
9124: $expire_role_result = 'ok';
9125: }
9126: }
9127: }
9128: }
1.443 albertel 9129: $result = $expire_role_result;
9130: }
9131: }
9132: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9133: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9134: if ($modify_section_result =~ /^ok/) {
9135: if ($secchange == 1) {
1.628 raeburn 9136: if ($sec eq '') {
9137: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9138: } else {
9139: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9140: }
1.443 albertel 9141: } elsif ($oldsec eq '-1') {
1.628 raeburn 9142: if ($sec eq '') {
9143: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9144: } else {
9145: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9146: }
1.443 albertel 9147: } else {
1.628 raeburn 9148: if ($sec eq '') {
9149: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
9150: } else {
9151: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9152: }
1.443 albertel 9153: }
9154: } else {
1.628 raeburn 9155: if ($secchange) {
9156: $$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;
9157: } else {
9158: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
9159: }
1.443 albertel 9160: }
9161: $result = $modify_section_result;
9162: } elsif ($secchange == 1) {
1.628 raeburn 9163: if ($oldsec eq '') {
9164: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
9165: } else {
9166: $$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;
9167: }
1.626 raeburn 9168: if ($expire_role_result eq 'refused') {
9169: my $newsecurl = '/'.$cid;
9170: $newsecurl =~ s/\_/\//g;
9171: if ($sec ne '') {
9172: $newsecurl.='/'.$sec;
9173: }
9174: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
9175: if ($sec eq '') {
9176: $$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;
9177: } else {
9178: $$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;
9179: }
9180: }
9181: }
1.443 albertel 9182: }
9183: } else {
1.626 raeburn 9184: $$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 9185: $result = "error: incomplete course id\n";
9186: }
9187: return $result;
9188: }
9189:
9190: ############################################################
9191: ############################################################
9192:
1.566 albertel 9193: sub check_clone {
1.578 raeburn 9194: my ($args,$linefeed) = @_;
1.566 albertel 9195: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
9196: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
9197: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
9198: my $clonemsg;
9199: my $can_clone = 0;
9200:
9201: if ($clonehome eq 'no_host') {
1.578 raeburn 9202: $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 9203: } else {
9204: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568 albertel 9205: if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566 albertel 9206: $can_clone = 1;
9207: } else {
9208: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
9209: $args->{'clonedomain'},$args->{'clonecourse'});
9210: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 9211: if (grep(/^\*$/,@cloners)) {
9212: $can_clone = 1;
9213: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
9214: $can_clone = 1;
9215: } else {
9216: my %roleshash =
9217: &Apache::lonnet::get_my_roles($args->{'ccuname'},
9218: $args->{'ccdomain'},
9219: 'userroles',['active'],['cc'],
9220: [$args->{'clonedomain'}]);
9221: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
9222: $can_clone = 1;
9223: } else {
9224: $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'});
9225: }
1.566 albertel 9226: }
1.578 raeburn 9227: }
1.566 albertel 9228: }
9229: return ($can_clone, $clonemsg, $cloneid, $clonehome);
9230: }
9231:
1.444 albertel 9232: sub construct_course {
1.541 raeburn 9233: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444 albertel 9234: my $outcome;
1.541 raeburn 9235: my $linefeed = '<br />'."\n";
9236: if ($context eq 'auto') {
9237: $linefeed = "\n";
9238: }
1.566 albertel 9239:
9240: #
9241: # Are we cloning?
9242: #
9243: my ($can_clone, $clonemsg, $cloneid, $clonehome);
9244: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 9245: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 9246: if ($context ne 'auto') {
1.578 raeburn 9247: if ($clonemsg ne '') {
9248: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
9249: }
1.566 albertel 9250: }
9251: $outcome .= $clonemsg.$linefeed;
9252:
9253: if (!$can_clone) {
9254: return (0,$outcome);
9255: }
9256: }
9257:
1.444 albertel 9258: #
9259: # Open course
9260: #
9261: my $crstype = lc($args->{'crstype'});
9262: my %cenv=();
9263: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
9264: $args->{'cdescr'},
9265: $args->{'curl'},
9266: $args->{'course_home'},
9267: $args->{'nonstandard'},
9268: $args->{'crscode'},
9269: $args->{'ccuname'}.':'.
9270: $args->{'ccdomain'},
9271: $args->{'crstype'});
9272:
9273: # Note: The testing routines depend on this being output; see
9274: # Utils::Course. This needs to at least be output as a comment
9275: # if anyone ever decides to not show this, and Utils::Course::new
9276: # will need to be suitably modified.
1.541 raeburn 9277: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 9278: #
9279: # Check if created correctly
9280: #
1.479 albertel 9281: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 9282: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 9283: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 9284:
1.444 albertel 9285: #
1.566 albertel 9286: # Do the cloning
9287: #
9288: if ($can_clone && $cloneid) {
9289: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
9290: if ($context ne 'auto') {
9291: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
9292: }
9293: $outcome .= $clonemsg.$linefeed;
9294: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 9295: # Copy all files
1.637 www 9296: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 9297: # Restore URL
1.566 albertel 9298: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 9299: # Restore title
1.566 albertel 9300: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 9301: # Mark as cloned
1.566 albertel 9302: $cenv{'clonedfrom'}=$cloneid;
1.638 www 9303: # Need to clone grading mode
9304: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
9305: $cenv{'grading'}=$newenv{'grading'};
9306: # Do not clone these environment entries
9307: &Apache::lonnet::del('environment',
9308: ['default_enrollment_start_date',
9309: 'default_enrollment_end_date',
9310: 'question.email',
9311: 'policy.email',
9312: 'comment.email',
9313: 'pch.users.denied',
9314: 'plc.users.denied'],
9315: $$crsudom,$$crsunum);
1.444 albertel 9316: }
1.566 albertel 9317:
1.444 albertel 9318: #
9319: # Set environment (will override cloned, if existing)
9320: #
9321: my @sections = ();
9322: my @xlists = ();
9323: if ($args->{'crstype'}) {
9324: $cenv{'type'}=$args->{'crstype'};
9325: }
9326: if ($args->{'crsid'}) {
9327: $cenv{'courseid'}=$args->{'crsid'};
9328: }
9329: if ($args->{'crscode'}) {
9330: $cenv{'internal.coursecode'}=$args->{'crscode'};
9331: }
9332: if ($args->{'crsquota'} ne '') {
9333: $cenv{'internal.coursequota'}=$args->{'crsquota'};
9334: } else {
9335: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
9336: }
9337: if ($args->{'ccuname'}) {
9338: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
9339: ':'.$args->{'ccdomain'};
9340: } else {
9341: $cenv{'internal.courseowner'} = $args->{'curruser'};
9342: }
9343: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
9344: if ($args->{'crssections'}) {
9345: $cenv{'internal.sectionnums'} = '';
9346: if ($args->{'crssections'} =~ m/,/) {
9347: @sections = split/,/,$args->{'crssections'};
9348: } else {
9349: $sections[0] = $args->{'crssections'};
9350: }
9351: if (@sections > 0) {
9352: foreach my $item (@sections) {
9353: my ($sec,$gp) = split/:/,$item;
9354: my $class = $args->{'crscode'}.$sec;
9355: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
9356: $cenv{'internal.sectionnums'} .= $item.',';
9357: unless ($addcheck eq 'ok') {
9358: push @badclasses, $class;
9359: }
9360: }
9361: $cenv{'internal.sectionnums'} =~ s/,$//;
9362: }
9363: }
9364: # do not hide course coordinator from staff listing,
9365: # even if privileged
9366: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9367: # add crosslistings
9368: if ($args->{'crsxlist'}) {
9369: $cenv{'internal.crosslistings'}='';
9370: if ($args->{'crsxlist'} =~ m/,/) {
9371: @xlists = split/,/,$args->{'crsxlist'};
9372: } else {
9373: $xlists[0] = $args->{'crsxlist'};
9374: }
9375: if (@xlists > 0) {
9376: foreach my $item (@xlists) {
9377: my ($xl,$gp) = split/:/,$item;
9378: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
9379: $cenv{'internal.crosslistings'} .= $item.',';
9380: unless ($addcheck eq 'ok') {
9381: push @badclasses, $xl;
9382: }
9383: }
9384: $cenv{'internal.crosslistings'} =~ s/,$//;
9385: }
9386: }
9387: if ($args->{'autoadds'}) {
9388: $cenv{'internal.autoadds'}=$args->{'autoadds'};
9389: }
9390: if ($args->{'autodrops'}) {
9391: $cenv{'internal.autodrops'}=$args->{'autodrops'};
9392: }
9393: # check for notification of enrollment changes
9394: my @notified = ();
9395: if ($args->{'notify_owner'}) {
9396: if ($args->{'ccuname'} ne '') {
9397: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
9398: }
9399: }
9400: if ($args->{'notify_dc'}) {
9401: if ($uname ne '') {
1.630 raeburn 9402: push(@notified,$uname.':'.$udom);
1.444 albertel 9403: }
9404: }
9405: if (@notified > 0) {
9406: my $notifylist;
9407: if (@notified > 1) {
9408: $notifylist = join(',',@notified);
9409: } else {
9410: $notifylist = $notified[0];
9411: }
9412: $cenv{'internal.notifylist'} = $notifylist;
9413: }
9414: if (@badclasses > 0) {
9415: my %lt=&Apache::lonlocal::texthash(
9416: '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',
9417: 'dnhr' => 'does not have rights to access enrollment in these classes',
9418: 'adby' => 'as determined by the policies of your institution on access to official classlists'
9419: );
1.541 raeburn 9420: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
9421: ' ('.$lt{'adby'}.')';
9422: if ($context eq 'auto') {
9423: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 9424: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 9425: foreach my $item (@badclasses) {
9426: if ($context eq 'auto') {
9427: $outcome .= " - $item\n";
9428: } else {
9429: $outcome .= "<li>$item</li>\n";
9430: }
9431: }
9432: if ($context eq 'auto') {
9433: $outcome .= $linefeed;
9434: } else {
1.566 albertel 9435: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 9436: }
9437: }
1.444 albertel 9438: }
9439: if ($args->{'no_end_date'}) {
9440: $args->{'endaccess'} = 0;
9441: }
9442: $cenv{'internal.autostart'}=$args->{'enrollstart'};
9443: $cenv{'internal.autoend'}=$args->{'enrollend'};
9444: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
9445: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
9446: if ($args->{'showphotos'}) {
9447: $cenv{'internal.showphotos'}=$args->{'showphotos'};
9448: }
9449: $cenv{'internal.authtype'} = $args->{'authtype'};
9450: $cenv{'internal.autharg'} = $args->{'autharg'};
9451: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
9452: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 9453: 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');
9454: if ($context eq 'auto') {
9455: $outcome .= $krb_msg;
9456: } else {
1.566 albertel 9457: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 9458: }
9459: $outcome .= $linefeed;
1.444 albertel 9460: }
9461: }
9462: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
9463: if ($args->{'setpolicy'}) {
9464: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9465: }
9466: if ($args->{'setcontent'}) {
9467: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9468: }
9469: }
9470: if ($args->{'reshome'}) {
9471: $cenv{'reshome'}=$args->{'reshome'}.'/';
9472: $cenv{'reshome'}=~s/\/+$/\//;
9473: }
9474: #
9475: # course has keyed access
9476: #
9477: if ($args->{'setkeys'}) {
9478: $cenv{'keyaccess'}='yes';
9479: }
9480: # if specified, key authority is not course, but user
9481: # only active if keyaccess is yes
9482: if ($args->{'keyauth'}) {
1.487 albertel 9483: my ($user,$domain) = split(':',$args->{'keyauth'});
9484: $user = &LONCAPA::clean_username($user);
9485: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 9486: if ($user ne '' && $domain ne '') {
1.487 albertel 9487: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 9488: }
9489: }
9490:
9491: if ($args->{'disresdis'}) {
9492: $cenv{'pch.roles.denied'}='st';
9493: }
9494: if ($args->{'disablechat'}) {
9495: $cenv{'plc.roles.denied'}='st';
9496: }
9497:
9498: # Record we've not yet viewed the Course Initialization Helper for this
9499: # course
9500: $cenv{'course.helper.not.run'} = 1;
9501: #
9502: # Use new Randomseed
9503: #
9504: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
9505: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
9506: #
9507: # The encryption code and receipt prefix for this course
9508: #
9509: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
9510: $cenv{'internal.encpref'}=100+int(9*rand(99));
9511: #
9512: # By default, use standard grading
9513: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
9514:
1.541 raeburn 9515: $outcome .= $linefeed.&mt('Setting environment').': '.
9516: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9517: #
9518: # Open all assignments
9519: #
9520: if ($args->{'openall'}) {
9521: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
9522: my %storecontent = ($storeunder => time,
9523: $storeunder.'.type' => 'date_start');
9524:
9525: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 9526: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9527: }
9528: #
9529: # Set first page
9530: #
9531: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
9532: || ($cloneid)) {
1.445 albertel 9533: use LONCAPA::map;
1.444 albertel 9534: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 9535:
9536: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
9537: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
9538:
1.444 albertel 9539: $outcome .= ($fatal?$errtext:'read ok').' - ';
9540: my $title; my $url;
9541: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 9542: $title=&mt('Syllabus');
1.444 albertel 9543: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
9544: } else {
1.690 bisitz 9545: $title=&mt('Navigate Contents');
1.444 albertel 9546: $url='/adm/navmaps';
9547: }
1.445 albertel 9548:
9549: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
9550: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
9551:
9552: if ($errtext) { $fatal=2; }
1.541 raeburn 9553: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 9554: }
1.566 albertel 9555:
9556: return (1,$outcome);
1.444 albertel 9557: }
9558:
9559: ############################################################
9560: ############################################################
9561:
1.378 raeburn 9562: sub course_type {
9563: my ($cid) = @_;
9564: if (!defined($cid)) {
9565: $cid = $env{'request.course.id'};
9566: }
1.404 albertel 9567: if (defined($env{'course.'.$cid.'.type'})) {
9568: return $env{'course.'.$cid.'.type'};
1.378 raeburn 9569: } else {
9570: return 'Course';
1.377 raeburn 9571: }
9572: }
1.156 albertel 9573:
1.406 raeburn 9574: sub group_term {
9575: my $crstype = &course_type();
9576: my %names = (
9577: 'Course' => 'group',
9578: 'Group' => 'team',
9579: );
9580: return $names{$crstype};
9581: }
9582:
1.156 albertel 9583: sub icon {
9584: my ($file)=@_;
1.505 albertel 9585: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 9586: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 9587: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 9588: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
9589: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
9590: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9591: $curfext.".gif") {
9592: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9593: $curfext.".gif";
9594: }
9595: }
1.249 albertel 9596: return &lonhttpdurl($iconname);
1.154 albertel 9597: }
1.84 albertel 9598:
1.575 albertel 9599: sub lonhttpdurl {
1.692 www 9600: #
9601: # Had been used for "small fry" static images on separate port 8080.
9602: # Modify here if lightweight http functionality desired again.
9603: # Currently eliminated due to increasing firewall issues.
9604: #
1.575 albertel 9605: my ($url)=@_;
1.692 www 9606: return $url;
1.215 albertel 9607: }
9608:
1.213 albertel 9609: sub connection_aborted {
9610: my ($r)=@_;
9611: $r->print(" ");$r->rflush();
9612: my $c = $r->connection;
9613: return $c->aborted();
9614: }
9615:
1.221 foxr 9616: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 9617: # strings as 'strings'.
9618: sub escape_single {
1.221 foxr 9619: my ($input) = @_;
1.223 albertel 9620: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 9621: $input =~ s/\'/\\\'/g; # Esacpe the 's....
9622: return $input;
9623: }
1.223 albertel 9624:
1.222 foxr 9625: # Same as escape_single, but escape's "'s This
9626: # can be used for "strings"
9627: sub escape_double {
9628: my ($input) = @_;
9629: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
9630: $input =~ s/\"/\\\"/g; # Esacpe the "s....
9631: return $input;
9632: }
1.223 albertel 9633:
1.222 foxr 9634: # Escapes the last element of a full URL.
9635: sub escape_url {
9636: my ($url) = @_;
1.238 raeburn 9637: my @urlslices = split(/\//, $url,-1);
1.369 www 9638: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 9639: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 9640: }
1.462 albertel 9641:
9642: # -------------------------------------------------------- Initliaze user login
9643: sub init_user_environment {
1.463 albertel 9644: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 9645: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
9646:
9647: my $public=($username eq 'public' && $domain eq 'public');
9648:
9649: # See if old ID present, if so, remove
9650:
9651: my ($filename,$cookie,$userroles);
9652: my $now=time;
9653:
9654: if ($public) {
9655: my $max_public=100;
9656: my $oldest;
9657: my $oldest_time=0;
9658: for(my $next=1;$next<=$max_public;$next++) {
9659: if (-e $lonids."/publicuser_$next.id") {
9660: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
9661: if ($mtime<$oldest_time || !$oldest_time) {
9662: $oldest_time=$mtime;
9663: $oldest=$next;
9664: }
9665: } else {
9666: $cookie="publicuser_$next";
9667: last;
9668: }
9669: }
9670: if (!$cookie) { $cookie="publicuser_$oldest"; }
9671: } else {
1.463 albertel 9672: # if this isn't a robot, kill any existing non-robot sessions
9673: if (!$args->{'robot'}) {
9674: opendir(DIR,$lonids);
9675: while ($filename=readdir(DIR)) {
9676: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
9677: unlink($lonids.'/'.$filename);
9678: }
1.462 albertel 9679: }
1.463 albertel 9680: closedir(DIR);
1.462 albertel 9681: }
9682: # Give them a new cookie
1.463 albertel 9683: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 9684: : $now.$$.int(rand(10000)));
1.463 albertel 9685: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 9686:
9687: # Initialize roles
9688:
9689: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
9690: }
9691: # ------------------------------------ Check browser type and MathML capability
9692:
9693: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
9694: $clientunicode,$clientos) = &decode_user_agent($r);
9695:
9696: # -------------------------------------- Any accessibility options to remember?
9697: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
9698: foreach my $option ('imagesuppress','appletsuppress',
9699: 'embedsuppress','fontenhance','blackwhite') {
9700: if ($form->{$option} eq 'true') {
9701: &Apache::lonnet::put('environment',{$option => 'on'},
9702: $domain,$username);
9703: } else {
9704: &Apache::lonnet::del('environment',[$option],
9705: $domain,$username);
9706: }
9707: }
9708: }
9709: # ------------------------------------------------------------- Get environment
9710:
9711: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
9712: my ($tmp) = keys(%userenv);
9713: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9714: # default remote control to off
9715: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
9716: } else {
9717: undef(%userenv);
9718: }
9719: if (($userenv{'interface'}) && (!$form->{'interface'})) {
9720: $form->{'interface'}=$userenv{'interface'};
9721: }
9722: $env{'environment.remote'}=$userenv{'remote'};
9723: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
9724:
9725: # --------------- Do not trust query string to be put directly into environment
9726: foreach my $option ('imagesuppress','appletsuppress',
9727: 'embedsuppress','fontenhance','blackwhite',
9728: 'interface','localpath','localres') {
9729: $form->{$option}=~s/[\n\r\=]//gs;
9730: }
9731: # --------------------------------------------------------- Write first profile
9732:
9733: {
9734: my %initial_env =
9735: ("user.name" => $username,
9736: "user.domain" => $domain,
9737: "user.home" => $authhost,
9738: "browser.type" => $clientbrowser,
9739: "browser.version" => $clientversion,
9740: "browser.mathml" => $clientmathml,
9741: "browser.unicode" => $clientunicode,
9742: "browser.os" => $clientos,
9743: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
9744: "request.course.fn" => '',
9745: "request.course.uri" => '',
9746: "request.course.sec" => '',
9747: "request.role" => 'cm',
9748: "request.role.adv" => $env{'user.adv'},
9749: "request.host" => $ENV{'REMOTE_ADDR'},);
9750:
9751: if ($form->{'localpath'}) {
9752: $initial_env{"browser.localpath"} = $form->{'localpath'};
9753: $initial_env{"browser.localres"} = $form->{'localres'};
9754: }
9755:
9756: if ($public) {
9757: $initial_env{"environment.remote"} = "off";
9758: }
9759: if ($form->{'interface'}) {
9760: $form->{'interface'}=~s/\W//gs;
9761: $initial_env{"browser.interface"} = $form->{'interface'};
9762: $env{'browser.interface'}=$form->{'interface'};
9763: foreach my $option ('imagesuppress','appletsuppress',
9764: 'embedsuppress','fontenhance','blackwhite') {
9765: if (($form->{$option} eq 'true') ||
9766: ($userenv{$option} eq 'on')) {
9767: $initial_env{"browser.$option"} = "on";
9768: }
9769: }
9770: }
9771:
9772: $env{'user.environment'} = "$lonids/$cookie.id";
9773:
9774: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
9775: &GDBM_WRCREAT(),0640)) {
9776: &_add_to_env(\%disk_env,\%initial_env);
9777: &_add_to_env(\%disk_env,\%userenv,'environment.');
9778: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 9779: if (ref($args->{'extra_env'})) {
9780: &_add_to_env(\%disk_env,$args->{'extra_env'});
9781: }
1.462 albertel 9782: untie(%disk_env);
9783: } else {
1.705 ! tempelho 9784: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
! 9785: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 9786: return 'error: '.$!;
9787: }
9788: }
9789: $env{'request.role'}='cm';
9790: $env{'request.role.adv'}=$env{'user.adv'};
9791: $env{'browser.type'}=$clientbrowser;
9792:
9793: return $cookie;
9794:
9795: }
9796:
9797: sub _add_to_env {
9798: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 9799: if (ref($env_data) eq 'HASH') {
9800: while (my ($key,$value) = each(%$env_data)) {
9801: $idf->{$prefix.$key} = $value;
9802: $env{$prefix.$key} = $value;
9803: }
1.462 albertel 9804: }
9805: }
9806:
1.685 tempelho 9807: # --- Get the symbolic name of a problem and the url
9808: sub get_symb {
9809: my ($request,$silent) = @_;
9810: (my $url=$env{'form.url'}) =~ s-^http://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
9811: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
9812: if ($symb eq '') {
9813: if (!$silent) {
9814: $request->print("Unable to handle ambiguous references:$url:.");
9815: return ();
9816: }
9817: }
9818: &Apache::lonenc::check_decrypt(\$symb);
9819: return ($symb);
9820: }
9821:
9822: # --------------------------------------------------------------Get annotation
9823:
9824: sub get_annotation {
9825: my ($symb,$enc) = @_;
9826:
9827: my $key = $symb;
9828: if (!$enc) {
9829: $key =
9830: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
9831: }
9832: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
9833: return $annotation{$key};
9834: }
9835:
9836: sub clean_symb {
9837: my ($symb) = @_;
9838:
9839: &Apache::lonenc::check_decrypt(\$symb);
9840: my $enc = $env{'request.enc'};
9841: delete($env{'request.enc'});
9842:
9843: return ($symb,$enc);
9844: }
1.462 albertel 9845:
1.41 ng 9846: =pod
9847:
9848: =back
9849:
1.112 bowersj2 9850: =cut
1.41 ng 9851:
1.112 bowersj2 9852: 1;
9853: __END__;
1.41 ng 9854:
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