Annotation of loncom/interface/loncommon.pm, revision 1.816
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.816 ! bisitz 4: # $Id: loncommon.pm,v 1.815 2009/05/15 09:33:22 tempelho Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.479 albertel 70: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 71: use DateTime::TimeZone;
1.687 raeburn 72: use DateTime::Locale::Catalog;
1.117 www 73:
1.517 raeburn 74: # ---------------------------------------------- Designs
75: use vars qw(%defaultdesign);
76:
1.22 www 77: my $readit;
78:
1.517 raeburn 79:
1.157 matthew 80: ##
81: ## Global Variables
82: ##
1.46 matthew 83:
1.643 foxr 84:
85: # ----------------------------------------------- SSI with retries:
86: #
87:
88: =pod
89:
1.648 raeburn 90: =head1 Server Side include with retries:
1.643 foxr 91:
92: =over 4
93:
1.648 raeburn 94: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 95:
96: Performs an ssi with some number of retries. Retries continue either
97: until the result is ok or until the retry count supplied by the
98: caller is exhausted.
99:
100: Inputs:
1.648 raeburn 101:
102: =over 4
103:
1.643 foxr 104: resource - Identifies the resource to insert.
1.648 raeburn 105:
1.643 foxr 106: retries - Count of the number of retries allowed.
1.648 raeburn 107:
1.643 foxr 108: form - Hash that identifies the rendering options.
109:
1.648 raeburn 110: =back
111:
112: Returns:
113:
114: =over 4
115:
1.643 foxr 116: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 117:
1.643 foxr 118: response - The response from the last attempt (which may or may not have been successful.
119:
1.648 raeburn 120: =back
121:
122: =back
123:
1.643 foxr 124: =cut
125:
126: sub ssi_with_retries {
127: my ($resource, $retries, %form) = @_;
128:
129:
130: my $ok = 0; # True if we got a good response.
131: my $content;
132: my $response;
133:
134: # Try to get the ssi done. within the retries count:
135:
136: do {
137: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
138: $ok = $response->is_success;
1.650 www 139: if (!$ok) {
140: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
141: }
1.643 foxr 142: $retries--;
143: } while (!$ok && ($retries > 0));
144:
145: if (!$ok) {
146: $content = ''; # On error return an empty content.
147: }
148: return ($content, $response);
149:
150: }
151:
152:
153:
1.20 www 154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 155: my %language;
1.124 www 156: my %supported_language;
1.12 harris41 157: my %cprtag;
1.192 taceyjo1 158: my %scprtag;
1.351 www 159: my %fe; my %fd; my %fm;
1.41 ng 160: my %category_extensions;
1.12 harris41 161:
1.46 matthew 162: # ---------------------------------------------- Thesaurus variables
1.144 matthew 163: #
164: # %Keywords:
165: # A hash used by &keyword to determine if a word is considered a keyword.
166: # $thesaurus_db_file
167: # Scalar containing the full path to the thesaurus database.
1.46 matthew 168:
169: my %Keywords;
170: my $thesaurus_db_file;
171:
1.144 matthew 172: #
173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
174: # thesaurus.tab, and filecategories.tab.
175: #
1.18 www 176: BEGIN {
1.46 matthew 177: # Variable initialization
178: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
179: #
1.22 www 180: unless ($readit) {
1.12 harris41 181: # ------------------------------------------------------------------- languages
182: {
1.158 raeburn 183: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
184: '/language.tab';
185: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 186: while (my $line = <$fh>) {
187: next if ($line=~/^\#/);
188: chomp($line);
189: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158 raeburn 190: $language{$key}=$val.' - '.$enc;
191: if ($sup) {
192: $supported_language{$key}=$sup;
193: }
194: }
195: close($fh);
196: }
1.12 harris41 197: }
198: # ------------------------------------------------------------------ copyrights
199: {
1.158 raeburn 200: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
201: '/copyright.tab';
202: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 203: while (my $line = <$fh>) {
204: next if ($line=~/^\#/);
205: chomp($line);
206: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 207: $cprtag{$key}=$val;
208: }
209: close($fh);
210: }
1.12 harris41 211: }
1.351 www 212: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 213: {
214: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
215: '/source_copyright.tab';
216: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 217: while (my $line = <$fh>) {
218: next if ($line =~ /^\#/);
219: chomp($line);
220: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 221: $scprtag{$key}=$val;
222: }
223: close($fh);
224: }
225: }
1.63 www 226:
1.517 raeburn 227: # -------------------------------------------------------------- default domain designs
1.63 www 228: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 229: my $designfile = $designdir.'/default.tab';
230: if ( open (my $fh,"<$designfile") ) {
231: while (my $line = <$fh>) {
232: next if ($line =~ /^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\=/,$line));
235: if ($val) { $defaultdesign{$key}=$val; }
236: }
237: close($fh);
1.63 www 238: }
239:
1.15 harris41 240: # ------------------------------------------------------------- file categories
241: {
1.158 raeburn 242: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
243: '/filecategories.tab';
244: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 249: push @{$category_extensions{lc($category)}},$extension;
250: }
251: close($fh);
252: }
253:
1.15 harris41 254: }
1.12 harris41 255: # ------------------------------------------------------------------ file types
256: {
1.158 raeburn 257: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
258: '/filetypes.tab';
259: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 260: while (my $line = <$fh>) {
261: next if ($line =~ /^\#/);
262: chomp($line);
263: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 264: if ($descr ne '') {
265: $fe{$ending}=lc($emb);
266: $fd{$ending}=$descr;
1.351 www 267: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 268: }
269: }
270: close($fh);
271: }
1.12 harris41 272: }
1.22 www 273: &Apache::lonnet::logthis(
1.705 tempelho 274: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 275: $readit=1;
1.46 matthew 276: } # end of unless($readit)
1.32 matthew 277:
278: }
1.112 bowersj2 279:
1.42 matthew 280: ###############################################################
281: ## HTML and Javascript Helper Functions ##
282: ###############################################################
283:
284: =pod
285:
1.112 bowersj2 286: =head1 HTML and Javascript Functions
1.42 matthew 287:
1.112 bowersj2 288: =over 4
289:
1.648 raeburn 290: =item * &browser_and_searcher_javascript()
1.112 bowersj2 291:
292: X<browsing, javascript>X<searching, javascript>Returns a string
293: containing javascript with two functions, C<openbrowser> and
294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
295: tags.
1.42 matthew 296:
1.648 raeburn 297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 298:
299: inputs: formname, elementname, only, omit
300:
301: formname and elementname indicate the name of the html form and name of
302: the element that the results of the browsing selection are to be placed in.
303:
304: Specifying 'only' will restrict the browser to displaying only files
1.185 www 305: with the given extension. Can be a comma separated list.
1.42 matthew 306:
307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 308: with the given extension. Can be a comma separated list.
1.42 matthew 309:
1.648 raeburn 310: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 311:
312: Inputs: formname, elementname
313:
314: formname and elementname specify the name of the html form and the name
315: of the element the selection from the search results will be placed in.
1.542 raeburn 316:
1.42 matthew 317: =cut
318:
319: sub browser_and_searcher_javascript {
1.199 albertel 320: my ($mode)=@_;
321: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 322: my $resurl=&escape_single(&lastresurl());
1.42 matthew 323: return <<END;
1.219 albertel 324: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 325: var editbrowser = null;
1.135 albertel 326: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 327: var url = '$resurl/?';
1.42 matthew 328: if (editbrowser == null) {
329: url += 'launch=1&';
330: }
331: url += 'catalogmode=interactive&';
1.199 albertel 332: url += 'mode=$mode&';
1.611 albertel 333: url += 'inhibitmenu=yes&';
1.42 matthew 334: url += 'form=' + formname + '&';
335: if (only != null) {
336: url += 'only=' + only + '&';
1.217 albertel 337: } else {
338: url += 'only=&';
339: }
1.42 matthew 340: if (omit != null) {
341: url += 'omit=' + omit + '&';
1.217 albertel 342: } else {
343: url += 'omit=&';
344: }
1.135 albertel 345: if (titleelement != null) {
346: url += 'titleelement=' + titleelement + '&';
1.217 albertel 347: } else {
348: url += 'titleelement=&';
349: }
1.42 matthew 350: url += 'element=' + elementname + '';
351: var title = 'Browser';
1.435 albertel 352: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 353: options += ',width=700,height=600';
354: editbrowser = open(url,title,options,'1');
355: editbrowser.focus();
356: }
357: var editsearcher;
1.135 albertel 358: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 359: var url = '/adm/searchcat?';
360: if (editsearcher == null) {
361: url += 'launch=1&';
362: }
363: url += 'catalogmode=interactive&';
1.199 albertel 364: url += 'mode=$mode&';
1.42 matthew 365: url += 'form=' + formname + '&';
1.135 albertel 366: if (titleelement != null) {
367: url += 'titleelement=' + titleelement + '&';
1.217 albertel 368: } else {
369: url += 'titleelement=&';
370: }
1.42 matthew 371: url += 'element=' + elementname + '';
372: var title = 'Search';
1.435 albertel 373: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 374: options += ',width=700,height=600';
375: editsearcher = open(url,title,options,'1');
376: editsearcher.focus();
377: }
1.219 albertel 378: // END LON-CAPA Internal -->
1.42 matthew 379: END
1.170 www 380: }
381:
382: sub lastresurl {
1.258 albertel 383: if ($env{'environment.lastresurl'}) {
384: return $env{'environment.lastresurl'}
1.170 www 385: } else {
386: return '/res';
387: }
388: }
389:
390: sub storeresurl {
391: my $resurl=&Apache::lonnet::clutter(shift);
392: unless ($resurl=~/^\/res/) { return 0; }
393: $resurl=~s/\/$//;
394: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 395: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 396: return 1;
1.42 matthew 397: }
398:
1.74 www 399: sub studentbrowser_javascript {
1.111 www 400: unless (
1.258 albertel 401: (($env{'request.course.id'}) &&
1.302 albertel 402: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
403: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
404: '/'.$env{'request.course.sec'})
405: ))
1.258 albertel 406: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 407: ) { return ''; }
1.74 www 408: return (<<'ENDSTDBRW');
1.776 bisitz 409: <script type="text/javascript" language="Javascript">
1.74 www 410: var stdeditbrowser;
1.793 raeburn 411: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
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.793 raeburn 425: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 426: var title = 'Student_Browser';
1.74 www 427: var options = 'scrollbars=1,resizable=1,menubar=0';
428: options += ',width=700,height=600';
429: stdeditbrowser = open(url,title,options,'1');
430: stdeditbrowser.focus();
431: }
432: </script>
433: ENDSTDBRW
434: }
1.42 matthew 435:
1.74 www 436: sub selectstudent_link {
1.793 raeburn 437: my ($form,$unameele,$udomele,$courseadvonly)=@_;
438: my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258 albertel 439: if ($env{'request.course.id'}) {
1.302 albertel 440: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
441: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
442: '/'.$env{'request.course.sec'})) {
1.111 www 443: return '';
444: }
1.793 raeburn 445: if ($courseadvonly) {
446: $callargs .= ",'',1,1";
447: }
448: return '<span class="LC_nobreak">'.
449: '<a href="javascript:openstdbrowser('.$callargs.');">'.
450: &mt('Select User').'</a></span>';
1.74 www 451: }
1.258 albertel 452: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793 raeburn 453: $callargs .= ",1";
454: return '<span class="LC_nobreak">'.
455: '<a href="javascript:openstdbrowser('.$callargs.');">'.
456: &mt('Select User').'</a></span>';
1.111 www 457: }
458: return '';
1.91 www 459: }
460:
1.653 raeburn 461: sub authorbrowser_javascript {
462: return <<"ENDAUTHORBRW";
1.776 bisitz 463: <script type="text/javascript" language="JavaScript">
1.653 raeburn 464: var stdeditbrowser;
465:
466: function openauthorbrowser(formname,udom) {
467: var url = '/adm/pickauthor?';
468: url += 'form='+formname+'&roledom='+udom;
469: var title = 'Author_Browser';
470: var options = 'scrollbars=1,resizable=1,menubar=0';
471: options += ',width=700,height=600';
472: stdeditbrowser = open(url,title,options,'1');
473: stdeditbrowser.focus();
474: }
475:
476: </script>
477: ENDAUTHORBRW
478: }
479:
1.91 www 480: sub coursebrowser_javascript {
1.468 raeburn 481: my ($domainfilter,$sec_element,$formname)=@_;
1.377 raeburn 482: 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 483: my $output = '
1.776 bisitz 484: <script type="text/javascript" language="JavaScript">
1.468 raeburn 485: var stdeditbrowser;'."\n";
486: $output .= <<"ENDSTDBRW";
1.377 raeburn 487: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
1.91 www 488: var url = '/adm/pickcourse?';
1.468 raeburn 489: var domainfilter = '';
490: var formid = getFormIdByName(formname);
491: if (formid > -1) {
492: var domid = getIndexByName(formid,udom);
493: if (domid > -1) {
494: if (document.forms[formid].elements[domid].type == 'select-one') {
495: domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
496: }
497: if (document.forms[formid].elements[domid].type == 'hidden') {
498: domainfilter=document.forms[formid].elements[domid].value;
499: }
500: }
1.91 www 501: }
1.128 albertel 502: if (domainfilter != null) {
503: if (domainfilter != '') {
504: url += 'domainfilter='+domainfilter+'&';
505: }
506: }
1.91 www 507: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 508: '&cdomelement='+udom+
509: '&cnameelement='+desc;
1.468 raeburn 510: if (extra_element !=null && extra_element != '') {
1.594 raeburn 511: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 512: url += '&roleelement='+extra_element;
513: if (domainfilter == null || domainfilter == '') {
514: url += '&domainfilter='+extra_element;
515: }
1.234 raeburn 516: }
1.468 raeburn 517: else {
518: if (formname == 'portform') {
519: url += '&setroles='+extra_element;
1.800 raeburn 520: } else {
521: if (formname == 'rules') {
522: url += '&fixeddom='+extra_element;
523: }
1.468 raeburn 524: }
525: }
1.230 raeburn 526: }
1.293 raeburn 527: if (multflag !=null && multflag != '') {
528: url += '&multiple='+multflag;
529: }
1.377 raeburn 530: if (crstype == 'Course/Group') {
531: if (formname == 'cu') {
532: crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value;
533: if (crstype == "") {
534: alert("$crs_or_grp_alert");
535: return;
536: }
537: }
538: }
539: if (crstype !=null && crstype != '') {
540: url += '&type='+crstype;
541: }
1.102 www 542: var title = 'Course_Browser';
1.91 www 543: var options = 'scrollbars=1,resizable=1,menubar=0';
544: options += ',width=700,height=600';
545: stdeditbrowser = open(url,title,options,'1');
546: stdeditbrowser.focus();
547: }
1.468 raeburn 548:
549: function getFormIdByName(formname) {
550: for (var i=0;i<document.forms.length;i++) {
551: if (document.forms[i].name == formname) {
552: return i;
553: }
554: }
555: return -1;
556: }
557:
558: function getIndexByName(formid,item) {
559: for (var i=0;i<document.forms[formid].elements.length;i++) {
560: if (document.forms[formid].elements[i].name == item) {
561: return i;
562: }
563: }
564: return -1;
565: }
1.91 www 566: ENDSTDBRW
1.468 raeburn 567: if ($sec_element ne '') {
568: $output .= &setsec_javascript($sec_element,$formname);
569: }
570: $output .= '
571: </script>';
572: return $output;
573: }
574:
575: sub setsec_javascript {
576: my ($sec_element,$formname) = @_;
577: my $setsections = qq|
578: function setSect(sectionlist) {
1.629 raeburn 579: var sectionsArray = new Array();
580: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
581: sectionsArray = sectionlist.split(",");
582: }
1.468 raeburn 583: var numSections = sectionsArray.length;
584: document.$formname.$sec_element.length = 0;
585: if (numSections == 0) {
586: document.$formname.$sec_element.multiple=false;
587: document.$formname.$sec_element.size=1;
588: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
589: } else {
590: if (numSections == 1) {
591: document.$formname.$sec_element.multiple=false;
592: document.$formname.$sec_element.size=1;
593: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
594: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
595: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
596: } else {
597: for (var i=0; i<numSections; i++) {
598: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
599: }
600: document.$formname.$sec_element.multiple=true
601: if (numSections < 3) {
602: document.$formname.$sec_element.size=numSections;
603: } else {
604: document.$formname.$sec_element.size=3;
605: }
606: document.$formname.$sec_element.options[0].selected = false
607: }
608: }
1.91 www 609: }
1.468 raeburn 610: |;
611: return $setsections;
612: }
613:
1.91 www 614:
615: sub selectcourse_link {
1.377 raeburn 616: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.787 bisitz 617: return '<span class="LC_nobreak">'
618: ."<a href='"
619: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
620: .'","'.$udomele.'","'.$desc.'","'.$extra_element
621: .'","'.$multflag.'","'.$selecttype.'");'
622: ."'>".&mt('Select Course').'</a>'
623: .'</span>';
1.74 www 624: }
1.42 matthew 625:
1.653 raeburn 626: sub selectauthor_link {
627: my ($form,$udom)=@_;
628: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
629: &mt('Select Author').'</a>';
630: }
631:
1.273 raeburn 632: sub check_uncheck_jscript {
633: my $jscript = <<"ENDSCRT";
634: function checkAll(field) {
635: if (field.length > 0) {
636: for (i = 0; i < field.length; i++) {
637: field[i].checked = true ;
638: }
639: } else {
640: field.checked = true
641: }
642: }
643:
644: function uncheckAll(field) {
645: if (field.length > 0) {
646: for (i = 0; i < field.length; i++) {
647: field[i].checked = false ;
1.543 albertel 648: }
649: } else {
1.273 raeburn 650: field.checked = false ;
651: }
652: }
653: ENDSCRT
654: return $jscript;
655: }
656:
1.656 www 657: sub select_timezone {
1.659 raeburn 658: my ($name,$selected,$onchange,$includeempty)=@_;
659: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
660: if ($includeempty) {
661: $output .= '<option value=""';
662: if (($selected eq '') || ($selected eq 'local')) {
663: $output .= ' selected="selected" ';
664: }
665: $output .= '> </option>';
666: }
1.657 raeburn 667: my @timezones = DateTime::TimeZone->all_names;
668: foreach my $tzone (@timezones) {
669: $output.= '<option value="'.$tzone.'"';
670: if ($tzone eq $selected) {
671: $output.=' selected="selected"';
672: }
673: $output.=">$tzone</option>\n";
1.656 www 674: }
675: $output.="</select>";
676: return $output;
677: }
1.273 raeburn 678:
1.687 raeburn 679: sub select_datelocale {
680: my ($name,$selected,$onchange,$includeempty)=@_;
681: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
682: if ($includeempty) {
683: $output .= '<option value=""';
684: if ($selected eq '') {
685: $output .= ' selected="selected" ';
686: }
687: $output .= '> </option>';
688: }
689: my (@possibles,%locale_names);
690: my @locales = DateTime::Locale::Catalog::Locales;
691: foreach my $locale (@locales) {
692: if (ref($locale) eq 'HASH') {
693: my $id = $locale->{'id'};
694: if ($id ne '') {
695: my $en_terr = $locale->{'en_territory'};
696: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 697: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 698: if (grep(/^en$/,@languages) || !@languages) {
699: if ($en_terr ne '') {
700: $locale_names{$id} = '('.$en_terr.')';
701: } elsif ($native_terr ne '') {
702: $locale_names{$id} = $native_terr;
703: }
704: } else {
705: if ($native_terr ne '') {
706: $locale_names{$id} = $native_terr.' ';
707: } elsif ($en_terr ne '') {
708: $locale_names{$id} = '('.$en_terr.')';
709: }
710: }
711: push (@possibles,$id);
712: }
713: }
714: }
715: foreach my $item (sort(@possibles)) {
716: $output.= '<option value="'.$item.'"';
717: if ($item eq $selected) {
718: $output.=' selected="selected"';
719: }
720: $output.=">$item";
721: if ($locale_names{$item} ne '') {
722: $output.=" $locale_names{$item}</option>\n";
723: }
724: $output.="</option>\n";
725: }
726: $output.="</select>";
727: return $output;
728: }
729:
1.792 raeburn 730: sub select_language {
731: my ($name,$selected,$includeempty) = @_;
732: my %langchoices;
733: if ($includeempty) {
734: %langchoices = ('' => 'No language preference');
735: }
736: foreach my $id (&languageids()) {
737: my $code = &supportedlanguagecode($id);
738: if ($code) {
739: $langchoices{$code} = &plainlanguagedescription($id);
740: }
741: }
742: return &select_form($selected,$name,%langchoices);
743: }
744:
1.42 matthew 745: =pod
1.36 matthew 746:
1.648 raeburn 747: =item * &linked_select_forms(...)
1.36 matthew 748:
749: linked_select_forms returns a string containing a <script></script> block
750: and html for two <select> menus. The select menus will be linked in that
751: changing the value of the first menu will result in new values being placed
752: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 753: order unless a defined order is provided.
1.36 matthew 754:
755: linked_select_forms takes the following ordered inputs:
756:
757: =over 4
758:
1.112 bowersj2 759: =item * $formname, the name of the <form> tag
1.36 matthew 760:
1.112 bowersj2 761: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 762:
1.112 bowersj2 763: =item * $firstdefault, the default value for the first menu
1.36 matthew 764:
1.112 bowersj2 765: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 766:
1.112 bowersj2 767: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 768:
1.112 bowersj2 769: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 770:
1.609 raeburn 771: =item * $menuorder, the order of values in the first menu
772:
1.41 ng 773: =back
774:
1.36 matthew 775: Below is an example of such a hash. Only the 'text', 'default', and
776: 'select2' keys must appear as stated. keys(%menu) are the possible
777: values for the first select menu. The text that coincides with the
1.41 ng 778: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 779: and text for the second menu are given in the hash pointed to by
780: $menu{$choice1}->{'select2'}.
781:
1.112 bowersj2 782: my %menu = ( A1 => { text =>"Choice A1" ,
783: default => "B3",
784: select2 => {
785: B1 => "Choice B1",
786: B2 => "Choice B2",
787: B3 => "Choice B3",
788: B4 => "Choice B4"
1.609 raeburn 789: },
790: order => ['B4','B3','B1','B2'],
1.112 bowersj2 791: },
792: A2 => { text =>"Choice A2" ,
793: default => "C2",
794: select2 => {
795: C1 => "Choice C1",
796: C2 => "Choice C2",
797: C3 => "Choice C3"
1.609 raeburn 798: },
799: order => ['C2','C1','C3'],
1.112 bowersj2 800: },
801: A3 => { text =>"Choice A3" ,
802: default => "D6",
803: select2 => {
804: D1 => "Choice D1",
805: D2 => "Choice D2",
806: D3 => "Choice D3",
807: D4 => "Choice D4",
808: D5 => "Choice D5",
809: D6 => "Choice D6",
810: D7 => "Choice D7"
1.609 raeburn 811: },
812: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 813: }
814: );
1.36 matthew 815:
816: =cut
817:
818: sub linked_select_forms {
819: my ($formname,
820: $middletext,
821: $firstdefault,
822: $firstselectname,
823: $secondselectname,
1.609 raeburn 824: $hashref,
825: $menuorder,
1.36 matthew 826: ) = @_;
827: my $second = "document.$formname.$secondselectname";
828: my $first = "document.$formname.$firstselectname";
829: # output the javascript to do the changing
830: my $result = '';
1.776 bisitz 831: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.36 matthew 832: $result.="var select2data = new Object();\n";
833: $" = '","';
834: my $debug = '';
835: foreach my $s1 (sort(keys(%$hashref))) {
836: $result.="select2data.d_$s1 = new Object();\n";
837: $result.="select2data.d_$s1.def = new String('".
838: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 839: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 840: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 841: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
842: @s2values = @{$hashref->{$s1}->{'order'}};
843: }
1.36 matthew 844: $result.="\"@s2values\");\n";
845: $result.="select2data.d_$s1.texts = new Array(";
846: my @s2texts;
847: foreach my $value (@s2values) {
848: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
849: }
850: $result.="\"@s2texts\");\n";
851: }
852: $"=' ';
853: $result.= <<"END";
854:
855: function select1_changed() {
856: // Determine new choice
857: var newvalue = "d_" + $first.value;
858: // update select2
859: var values = select2data[newvalue].values;
860: var texts = select2data[newvalue].texts;
861: var select2def = select2data[newvalue].def;
862: var i;
863: // out with the old
864: for (i = 0; i < $second.options.length; i++) {
865: $second.options[i] = null;
866: }
867: // in with the nuclear
868: for (i=0;i<values.length; i++) {
869: $second.options[i] = new Option(values[i]);
1.143 matthew 870: $second.options[i].value = values[i];
1.36 matthew 871: $second.options[i].text = texts[i];
872: if (values[i] == select2def) {
873: $second.options[i].selected = true;
874: }
875: }
876: }
877: </script>
878: END
879: # output the initial values for the selection lists
880: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 881: my @order = sort(keys(%{$hashref}));
882: if (ref($menuorder) eq 'ARRAY') {
883: @order = @{$menuorder};
884: }
885: foreach my $value (@order) {
1.36 matthew 886: $result.=" <option value=\"$value\" ";
1.253 albertel 887: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 888: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 889: }
890: $result .= "</select>\n";
891: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
892: $result .= $middletext;
893: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
894: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 895:
896: my @secondorder = sort(keys(%select2));
897: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
898: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
899: }
900: foreach my $value (@secondorder) {
1.36 matthew 901: $result.=" <option value=\"$value\" ";
1.253 albertel 902: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 903: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 904: }
905: $result .= "</select>\n";
906: # return $debug;
907: return $result;
908: } # end of sub linked_select_forms {
909:
1.45 matthew 910: =pod
1.44 bowersj2 911:
1.648 raeburn 912: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44 bowersj2 913:
1.112 bowersj2 914: Returns a string corresponding to an HTML link to the given help
915: $topic, where $topic corresponds to the name of a .tex file in
916: /home/httpd/html/adm/help/tex, with underscores replaced by
917: spaces.
918:
919: $text will optionally be linked to the same topic, allowing you to
920: link text in addition to the graphic. If you do not want to link
921: text, but wish to specify one of the later parameters, pass an
922: empty string.
923:
924: $stayOnPage is a value that will be interpreted as a boolean. If true,
925: the link will not open a new window. If false, the link will open
926: a new window using Javascript. (Default is false.)
927:
928: $width and $height are optional numerical parameters that will
929: override the width and height of the popped up window, which may
930: be useful for certain help topics with big pictures included.
1.44 bowersj2 931:
932: =cut
933:
934: sub help_open_topic {
1.48 bowersj2 935: my ($topic, $text, $stayOnPage, $width, $height) = @_;
936: $text = "" if (not defined $text);
1.44 bowersj2 937: $stayOnPage = 0 if (not defined $stayOnPage);
938: $width = 350 if (not defined $width);
939: $height = 400 if (not defined $height);
940: my $filename = $topic;
941: $filename =~ s/ /_/g;
942:
1.48 bowersj2 943: my $template = "";
944: my $link;
1.572 banghart 945:
1.159 www 946: $topic=~s/\W/\_/g;
1.44 bowersj2 947:
1.572 banghart 948: if (!$stayOnPage) {
1.72 bowersj2 949: $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 950: } else {
1.48 bowersj2 951: $link = "/adm/help/${filename}.hlp";
952: }
953:
954: # Add the text
1.755 neumanie 955: if ($text ne "") {
1.763 bisitz 956: $template.='<span class="LC_help_open_topic">'
957: .'<a target="_top" href="'.$link.'">'
958: .$text.'</a>';
1.48 bowersj2 959: }
960:
1.763 bisitz 961: # (Always) Add the graphic
1.179 matthew 962: my $title = &mt('Online Help');
1.667 raeburn 963: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763 bisitz 964: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
965: .'<img src="'.$helpicon.'" border="0"'
966: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.783 amueller 967: .' title="'.$title.'"'
1.763 bisitz 968: .' /></a>';
969: if ($text ne "") {
970: $template.='</span>';
971: }
1.44 bowersj2 972: return $template;
973:
1.106 bowersj2 974: }
975:
976: # This is a quicky function for Latex cheatsheet editing, since it
977: # appears in at least four places
978: sub helpLatexCheatsheet {
1.732 raeburn 979: my ($topic,$text,$not_author) = @_;
980: my $out;
1.106 bowersj2 981: my $addOther = '';
1.732 raeburn 982: if ($topic) {
1.763 bisitz 983: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
984: undef, undef, 600).
985: '</span> ';
986: }
987: $out = '<span>' # Start cheatsheet
988: .$addOther
989: .'<span>'
990: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
991: undef,undef,600)
992: .'</span> <span>'
993: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
994: undef,undef,600)
995: .'</span>';
1.732 raeburn 996: unless ($not_author) {
1.763 bisitz 997: $out .= ' <span>'
998: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
999: undef,undef,600)
1000: .'</span>';
1.732 raeburn 1001: }
1.763 bisitz 1002: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1003: return $out;
1.172 www 1004: }
1005:
1.430 albertel 1006: sub general_help {
1007: my $helptopic='Student_Intro';
1008: if ($env{'request.role'}=~/^(ca|au)/) {
1009: $helptopic='Authoring_Intro';
1010: } elsif ($env{'request.role'}=~/^cc/) {
1011: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1012: } elsif ($env{'request.role'}=~/^dc/) {
1013: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1014: }
1015: return $helptopic;
1016: }
1017:
1018: sub update_help_link {
1019: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1020: my $origurl = $ENV{'REQUEST_URI'};
1021: $origurl=~s|^/~|/priv/|;
1022: my $timestamp = time;
1023: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1024: $$datum = &escape($$datum);
1025: }
1026:
1027: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1028: my $output .= <<"ENDOUTPUT";
1029: <script type="text/javascript">
1030: banner_link = '$banner_link';
1031: </script>
1032: ENDOUTPUT
1033: return $output;
1034: }
1035:
1036: # now just updates the help link and generates a blue icon
1.193 raeburn 1037: sub help_open_menu {
1.430 albertel 1038: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1039: = @_;
1.430 albertel 1040: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 1041: # only use pop-up help (stayOnPage == 0)
1.552 banghart 1042: # if environment.remote is on (using remote control UI)
1.798 tempelho 1043: if ($env{'environment.remote'} eq 'off' ) {
1.552 banghart 1044: $stayOnPage=1;
1.430 albertel 1045: }
1046: my $output;
1047: if ($component_help) {
1048: if (!$text) {
1049: $output=&help_open_topic($component_help,undef,$stayOnPage,
1050: $width,$height);
1051: } else {
1052: my $help_text;
1053: $help_text=&unescape($topic);
1054: $output='<table><tr><td>'.
1055: &help_open_topic($component_help,$help_text,$stayOnPage,
1056: $width,$height).'</td></tr></table>';
1057: }
1058: }
1059: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1060: return $output.$banner_link;
1061: }
1062:
1063: sub top_nav_help {
1064: my ($text) = @_;
1.436 albertel 1065: $text = &mt($text);
1.572 banghart 1066: my $stay_on_page =
1.798 tempelho 1067: ($env{'environment.remote'} eq 'off' );
1.572 banghart 1068: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1069: : "javascript:helpMenu('open')";
1.572 banghart 1070: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1071:
1.201 raeburn 1072: my $title = &mt('Get help');
1.436 albertel 1073:
1074: return <<"END";
1075: $banner_link
1076: <a href="$link" title="$title">$text</a>
1077: END
1078: }
1079:
1080: sub help_menu_js {
1081: my ($text) = @_;
1082:
1083: my $stayOnPage =
1.798 tempelho 1084: ($env{'environment.remote'} eq 'off' );
1.436 albertel 1085:
1086: my $width = 620;
1087: my $height = 600;
1.430 albertel 1088: my $helptopic=&general_help();
1089: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1090: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1091: my $start_page =
1092: &Apache::loncommon::start_page('Help Menu', undef,
1093: {'frameset' => 1,
1094: 'js_ready' => 1,
1095: 'add_entries' => {
1096: 'border' => '0',
1.579 raeburn 1097: 'rows' => "110,*",},});
1.331 albertel 1098: my $end_page =
1099: &Apache::loncommon::end_page({'frameset' => 1,
1100: 'js_ready' => 1,});
1101:
1.436 albertel 1102: my $template .= <<"ENDTEMPLATE";
1103: <script type="text/javascript">
1.253 albertel 1104: // <!-- BEGIN LON-CAPA Internal
1105: // <![CDATA[
1.430 albertel 1106: var banner_link = '';
1.243 raeburn 1107: function helpMenu(target) {
1108: var caller = this;
1109: if (target == 'open') {
1110: var newWindow = null;
1111: try {
1.262 albertel 1112: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1113: }
1114: catch(error) {
1115: writeHelp(caller);
1116: return;
1117: }
1118: if (newWindow) {
1119: caller = newWindow;
1120: }
1.193 raeburn 1121: }
1.243 raeburn 1122: writeHelp(caller);
1123: return;
1124: }
1125: function writeHelp(caller) {
1.430 albertel 1126: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1127: caller.document.close()
1128: caller.focus()
1.193 raeburn 1129: }
1.253 albertel 1130: // ]]>
1.219 albertel 1131: // END LON-CAPA Internal -->
1.436 albertel 1132: </script>
1.193 raeburn 1133: ENDTEMPLATE
1134: return $template;
1135: }
1136:
1.172 www 1137: sub help_open_bug {
1138: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1139: unless ($env{'user.adv'}) { return ''; }
1.172 www 1140: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1141: $text = "" if (not defined $text);
1142: $stayOnPage = 0 if (not defined $stayOnPage);
1.798 tempelho 1143: if ($env{'environment.remote'} eq 'off' ) {
1.172 www 1144: $stayOnPage=1;
1145: }
1.184 albertel 1146: $width = 600 if (not defined $width);
1147: $height = 600 if (not defined $height);
1.172 www 1148:
1149: $topic=~s/\W+/\+/g;
1150: my $link='';
1151: my $template='';
1.379 albertel 1152: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1153: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1154: if (!$stayOnPage)
1155: {
1156: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1157: }
1158: else
1159: {
1160: $link = $url;
1161: }
1162: # Add the text
1163: if ($text ne "")
1164: {
1165: $template .=
1166: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1167: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1168: }
1169:
1170: # Add the graphic
1.179 matthew 1171: my $title = &mt('Report a Bug');
1.215 albertel 1172: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1173: $template .= <<"ENDTEMPLATE";
1.436 albertel 1174: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1175: ENDTEMPLATE
1176: if ($text ne '') { $template.='</td></tr></table>' };
1177: return $template;
1178:
1179: }
1180:
1181: sub help_open_faq {
1182: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1183: unless ($env{'user.adv'}) { return ''; }
1.172 www 1184: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1185: $text = "" if (not defined $text);
1186: $stayOnPage = 0 if (not defined $stayOnPage);
1.798 tempelho 1187: if ($env{'environment.remote'} eq 'off' ) {
1.172 www 1188: $stayOnPage=1;
1189: }
1190: $width = 350 if (not defined $width);
1191: $height = 400 if (not defined $height);
1192:
1193: $topic=~s/\W+/\+/g;
1194: my $link='';
1195: my $template='';
1196: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1197: if (!$stayOnPage)
1198: {
1199: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1200: }
1201: else
1202: {
1203: $link = $url;
1204: }
1205:
1206: # Add the text
1207: if ($text ne "")
1208: {
1209: $template .=
1.173 www 1210: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1211: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1212: }
1213:
1214: # Add the graphic
1.179 matthew 1215: my $title = &mt('View the FAQ');
1.215 albertel 1216: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1217: $template .= <<"ENDTEMPLATE";
1.436 albertel 1218: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1219: ENDTEMPLATE
1220: if ($text ne '') { $template.='</td></tr></table>' };
1221: return $template;
1222:
1.44 bowersj2 1223: }
1.37 matthew 1224:
1.180 matthew 1225: ###############################################################
1226: ###############################################################
1227:
1.45 matthew 1228: =pod
1229:
1.648 raeburn 1230: =item * &change_content_javascript():
1.256 matthew 1231:
1232: This and the next function allow you to create small sections of an
1233: otherwise static HTML page that you can update on the fly with
1234: Javascript, even in Netscape 4.
1235:
1236: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1237: must be written to the HTML page once. It will prove the Javascript
1238: function "change(name, content)". Calling the change function with the
1239: name of the section
1240: you want to update, matching the name passed to C<changable_area>, and
1241: the new content you want to put in there, will put the content into
1242: that area.
1243:
1244: B<Note>: Netscape 4 only reserves enough space for the changable area
1245: to contain room for the original contents. You need to "make space"
1246: for whatever changes you wish to make, and be B<sure> to check your
1247: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1248: it's adequate for updating a one-line status display, but little more.
1249: This script will set the space to 100% width, so you only need to
1250: worry about height in Netscape 4.
1251:
1252: Modern browsers are much less limiting, and if you can commit to the
1253: user not using Netscape 4, this feature may be used freely with
1254: pretty much any HTML.
1255:
1256: =cut
1257:
1258: sub change_content_javascript {
1259: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1260: if ($env{'browser.type'} eq 'netscape' &&
1261: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1262: return (<<NETSCAPE4);
1263: function change(name, content) {
1264: doc = document.layers[name+"___escape"].layers[0].document;
1265: doc.open();
1266: doc.write(content);
1267: doc.close();
1268: }
1269: NETSCAPE4
1270: } else {
1271: # Otherwise, we need to use semi-standards-compliant code
1272: # (technically, "innerHTML" isn't standard but the equivalent
1273: # is really scary, and every useful browser supports it
1274: return (<<DOMBASED);
1275: function change(name, content) {
1276: element = document.getElementById(name);
1277: element.innerHTML = content;
1278: }
1279: DOMBASED
1280: }
1281: }
1282:
1283: =pod
1284:
1.648 raeburn 1285: =item * &changable_area($name,$origContent):
1.256 matthew 1286:
1287: This provides a "changable area" that can be modified on the fly via
1288: the Javascript code provided in C<change_content_javascript>. $name is
1289: the name you will use to reference the area later; do not repeat the
1290: same name on a given HTML page more then once. $origContent is what
1291: the area will originally contain, which can be left blank.
1292:
1293: =cut
1294:
1295: sub changable_area {
1296: my ($name, $origContent) = @_;
1297:
1.258 albertel 1298: if ($env{'browser.type'} eq 'netscape' &&
1299: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1300: # If this is netscape 4, we need to use the Layer tag
1301: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1302: } else {
1303: return "<span id='$name'>$origContent</span>";
1304: }
1305: }
1306:
1307: =pod
1308:
1.648 raeburn 1309: =item * &viewport_geometry_js
1.590 raeburn 1310:
1311: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1312:
1313: =cut
1314:
1315:
1316: sub viewport_geometry_js {
1317: return <<"GEOMETRY";
1318: var Geometry = {};
1319: function init_geometry() {
1320: if (Geometry.init) { return };
1321: Geometry.init=1;
1322: if (window.innerHeight) {
1323: Geometry.getViewportHeight = function() { return window.innerHeight; };
1324: Geometry.getViewportWidth = function() { return window.innerWidth; };
1325: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1326: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1327: }
1328: else if (document.documentElement && document.documentElement.clientHeight) {
1329: Geometry.getViewportHeight =
1330: function() { return document.documentElement.clientHeight; };
1331: Geometry.getViewportWidth =
1332: function() { return document.documentElement.clientWidth; };
1333:
1334: Geometry.getHorizontalScroll =
1335: function() { return document.documentElement.scrollLeft; };
1336: Geometry.getVerticalScroll =
1337: function() { return document.documentElement.scrollTop; };
1338: }
1339: else if (document.body.clientHeight) {
1340: Geometry.getViewportHeight =
1341: function() { return document.body.clientHeight; };
1342: Geometry.getViewportWidth =
1343: function() { return document.body.clientWidth; };
1344: Geometry.getHorizontalScroll =
1345: function() { return document.body.scrollLeft; };
1346: Geometry.getVerticalScroll =
1347: function() { return document.body.scrollTop; };
1348: }
1349: }
1350:
1351: GEOMETRY
1352: }
1353:
1354: =pod
1355:
1.648 raeburn 1356: =item * &viewport_size_js()
1.590 raeburn 1357:
1358: 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.
1359:
1360: =cut
1361:
1362: sub viewport_size_js {
1363: my $geometry = &viewport_geometry_js();
1364: return <<"DIMS";
1365:
1366: $geometry
1367:
1368: function getViewportDims(width,height) {
1369: init_geometry();
1370: width.value = Geometry.getViewportWidth();
1371: height.value = Geometry.getViewportHeight();
1372: return;
1373: }
1374:
1375: DIMS
1376: }
1377:
1378: =pod
1379:
1.648 raeburn 1380: =item * &resize_textarea_js()
1.565 albertel 1381:
1382: emits the needed javascript to resize a textarea to be as big as possible
1383:
1384: creates a function resize_textrea that takes two IDs first should be
1385: the id of the element to resize, second should be the id of a div that
1386: surrounds everything that comes after the textarea, this routine needs
1387: to be attached to the <body> for the onload and onresize events.
1388:
1.648 raeburn 1389: =back
1.565 albertel 1390:
1391: =cut
1392:
1393: sub resize_textarea_js {
1.590 raeburn 1394: my $geometry = &viewport_geometry_js();
1.565 albertel 1395: return <<"RESIZE";
1396: <script type="text/javascript">
1.590 raeburn 1397: $geometry
1.565 albertel 1398:
1.588 albertel 1399: function getX(element) {
1400: var x = 0;
1401: while (element) {
1402: x += element.offsetLeft;
1403: element = element.offsetParent;
1404: }
1405: return x;
1406: }
1407: function getY(element) {
1408: var y = 0;
1409: while (element) {
1410: y += element.offsetTop;
1411: element = element.offsetParent;
1412: }
1413: return y;
1414: }
1415:
1416:
1.565 albertel 1417: function resize_textarea(textarea_id,bottom_id) {
1418: init_geometry();
1419: var textarea = document.getElementById(textarea_id);
1420: //alert(textarea);
1421:
1.588 albertel 1422: var textarea_top = getY(textarea);
1.565 albertel 1423: var textarea_height = textarea.offsetHeight;
1424: var bottom = document.getElementById(bottom_id);
1.588 albertel 1425: var bottom_top = getY(bottom);
1.565 albertel 1426: var bottom_height = bottom.offsetHeight;
1427: var window_height = Geometry.getViewportHeight();
1.588 albertel 1428: var fudge = 23;
1.565 albertel 1429: var new_height = window_height-fudge-textarea_top-bottom_height;
1430: if (new_height < 300) {
1431: new_height = 300;
1432: }
1433: textarea.style.height=new_height+'px';
1434: }
1435: </script>
1436: RESIZE
1437:
1438: }
1439:
1440: =pod
1441:
1.256 matthew 1442: =head1 Excel and CSV file utility routines
1443:
1444: =over 4
1445:
1446: =cut
1447:
1448: ###############################################################
1449: ###############################################################
1450:
1451: =pod
1452:
1.648 raeburn 1453: =item * &csv_translate($text)
1.37 matthew 1454:
1.185 www 1455: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1456: format.
1457:
1458: =cut
1459:
1.180 matthew 1460: ###############################################################
1461: ###############################################################
1.37 matthew 1462: sub csv_translate {
1463: my $text = shift;
1464: $text =~ s/\"/\"\"/g;
1.209 albertel 1465: $text =~ s/\n/ /g;
1.37 matthew 1466: return $text;
1467: }
1.180 matthew 1468:
1469: ###############################################################
1470: ###############################################################
1471:
1472: =pod
1473:
1.648 raeburn 1474: =item * &define_excel_formats()
1.180 matthew 1475:
1476: Define some commonly used Excel cell formats.
1477:
1478: Currently supported formats:
1479:
1480: =over 4
1481:
1482: =item header
1483:
1484: =item bold
1485:
1486: =item h1
1487:
1488: =item h2
1489:
1490: =item h3
1491:
1.256 matthew 1492: =item h4
1493:
1494: =item i
1495:
1.180 matthew 1496: =item date
1497:
1498: =back
1499:
1500: Inputs: $workbook
1501:
1502: Returns: $format, a hash reference.
1503:
1504: =cut
1505:
1506: ###############################################################
1507: ###############################################################
1508: sub define_excel_formats {
1509: my ($workbook) = @_;
1510: my $format;
1511: $format->{'header'} = $workbook->add_format(bold => 1,
1512: bottom => 1,
1513: align => 'center');
1514: $format->{'bold'} = $workbook->add_format(bold=>1);
1515: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1516: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1517: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1518: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1519: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1520: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1521: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1522: return $format;
1523: }
1524:
1525: ###############################################################
1526: ###############################################################
1.113 bowersj2 1527:
1528: =pod
1529:
1.648 raeburn 1530: =item * &create_workbook()
1.255 matthew 1531:
1532: Create an Excel worksheet. If it fails, output message on the
1533: request object and return undefs.
1534:
1535: Inputs: Apache request object
1536:
1537: Returns (undef) on failure,
1538: Excel worksheet object, scalar with filename, and formats
1539: from &Apache::loncommon::define_excel_formats on success
1540:
1541: =cut
1542:
1543: ###############################################################
1544: ###############################################################
1545: sub create_workbook {
1546: my ($r) = @_;
1547: #
1548: # Create the excel spreadsheet
1549: my $filename = '/prtspool/'.
1.258 albertel 1550: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1551: time.'_'.rand(1000000000).'.xls';
1552: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1553: if (! defined($workbook)) {
1554: $r->log_error("Error creating excel spreadsheet $filename: $!");
1555: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1556: "This error has been logged. ".
1557: "Please alert your LON-CAPA administrator").
1558: '</p>');
1559: return (undef);
1560: }
1561: #
1562: $workbook->set_tempdir('/home/httpd/perl/tmp');
1563: #
1564: my $format = &Apache::loncommon::define_excel_formats($workbook);
1565: return ($workbook,$filename,$format);
1566: }
1567:
1568: ###############################################################
1569: ###############################################################
1570:
1571: =pod
1572:
1.648 raeburn 1573: =item * &create_text_file()
1.113 bowersj2 1574:
1.542 raeburn 1575: Create a file to write to and eventually make available to the user.
1.256 matthew 1576: If file creation fails, outputs an error message on the request object and
1577: return undefs.
1.113 bowersj2 1578:
1.256 matthew 1579: Inputs: Apache request object, and file suffix
1.113 bowersj2 1580:
1.256 matthew 1581: Returns (undef) on failure,
1582: Filehandle and filename on success.
1.113 bowersj2 1583:
1584: =cut
1585:
1.256 matthew 1586: ###############################################################
1587: ###############################################################
1588: sub create_text_file {
1589: my ($r,$suffix) = @_;
1590: if (! defined($suffix)) { $suffix = 'txt'; };
1591: my $fh;
1592: my $filename = '/prtspool/'.
1.258 albertel 1593: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1594: time.'_'.rand(1000000000).'.'.$suffix;
1595: $fh = Apache::File->new('>/home/httpd'.$filename);
1596: if (! defined($fh)) {
1597: $r->log_error("Couldn't open $filename for output $!");
1.683 bisitz 1598: $r->print(&mt('Problems occurred in creating the output file. '
1599: .'This error has been logged. '
1600: .'Please alert your LON-CAPA administrator.'));
1.113 bowersj2 1601: }
1.256 matthew 1602: return ($fh,$filename)
1.113 bowersj2 1603: }
1604:
1605:
1.256 matthew 1606: =pod
1.113 bowersj2 1607:
1608: =back
1609:
1610: =cut
1.37 matthew 1611:
1612: ###############################################################
1.33 matthew 1613: ## Home server <option> list generating code ##
1614: ###############################################################
1.35 matthew 1615:
1.169 www 1616: # ------------------------------------------
1617:
1618: sub domain_select {
1619: my ($name,$value,$multiple)=@_;
1620: my %domains=map {
1.514 albertel 1621: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1622: } &Apache::lonnet::all_domains();
1.169 www 1623: if ($multiple) {
1624: $domains{''}=&mt('Any domain');
1.550 albertel 1625: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1626: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1627: } else {
1.550 albertel 1628: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1629: return &select_form($name,$value,%domains);
1630: }
1631: }
1632:
1.282 albertel 1633: #-------------------------------------------
1634:
1635: =pod
1636:
1.519 raeburn 1637: =head1 Routines for form select boxes
1638:
1639: =over 4
1640:
1.648 raeburn 1641: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1642:
1643: Returns a string containing a <select> element int multiple mode
1644:
1645:
1646: Args:
1647: $name - name of the <select> element
1.506 raeburn 1648: $value - scalar or array ref of values that should already be selected
1.282 albertel 1649: $size - number of rows long the select element is
1.283 albertel 1650: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1651: (shown text should already have been &mt())
1.506 raeburn 1652: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1653:
1.282 albertel 1654: =cut
1655:
1656: #-------------------------------------------
1.169 www 1657: sub multiple_select_form {
1.284 albertel 1658: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1659: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1660: my $output='';
1.191 matthew 1661: if (! defined($size)) {
1662: $size = 4;
1.283 albertel 1663: if (scalar(keys(%$hash))<4) {
1664: $size = scalar(keys(%$hash));
1.191 matthew 1665: }
1666: }
1.734 bisitz 1667: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1668: my @order;
1.506 raeburn 1669: if (ref($order) eq 'ARRAY') {
1670: @order = @{$order};
1671: } else {
1672: @order = sort(keys(%$hash));
1.501 banghart 1673: }
1674: if (exists($$hash{'select_form_order'})) {
1675: @order = @{$$hash{'select_form_order'}};
1676: }
1677:
1.284 albertel 1678: foreach my $key (@order) {
1.356 albertel 1679: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1680: $output.='selected="selected" ' if ($selected{$key});
1681: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1682: }
1683: $output.="</select>\n";
1684: return $output;
1685: }
1686:
1.88 www 1687: #-------------------------------------------
1688:
1689: =pod
1690:
1.648 raeburn 1691: =item * &select_form($defdom,$name,%hash)
1.88 www 1692:
1693: Returns a string containing a <select name='$name' size='1'> form to
1694: allow a user to select options from a hash option_name => displayed text.
1695: See lonrights.pm for an example invocation and use.
1696:
1697: =cut
1698:
1699: #-------------------------------------------
1700: sub select_form {
1701: my ($def,$name,%hash) = @_;
1702: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1703: my @keys;
1704: if (exists($hash{'select_form_order'})) {
1705: @keys=@{$hash{'select_form_order'}};
1706: } else {
1707: @keys=sort(keys(%hash));
1708: }
1.356 albertel 1709: foreach my $key (@keys) {
1710: $selectform.=
1711: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1712: ($key eq $def ? 'selected="selected" ' : '').
1713: ">".&mt($hash{$key})."</option>\n";
1.88 www 1714: }
1715: $selectform.="</select>";
1716: return $selectform;
1717: }
1718:
1.475 www 1719: # For display filters
1720:
1721: sub display_filter {
1722: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1723: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1724: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1725: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1726: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1727: '</label></span> <span class="LC_nobreak">'.
1.475 www 1728: &mt('Filter [_1]',
1.477 www 1729: &select_form($env{'form.displayfilter'},
1730: 'displayfilter',
1731: ('currentfolder' => 'Current folder/page',
1732: 'containing' => 'Containing phrase',
1733: 'none' => 'None'))).
1.714 bisitz 1734: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1735: }
1736:
1.167 www 1737: sub gradeleveldescription {
1738: my $gradelevel=shift;
1739: my %gradelevels=(0 => 'Not specified',
1740: 1 => 'Grade 1',
1741: 2 => 'Grade 2',
1742: 3 => 'Grade 3',
1743: 4 => 'Grade 4',
1744: 5 => 'Grade 5',
1745: 6 => 'Grade 6',
1746: 7 => 'Grade 7',
1747: 8 => 'Grade 8',
1748: 9 => 'Grade 9',
1749: 10 => 'Grade 10',
1750: 11 => 'Grade 11',
1751: 12 => 'Grade 12',
1752: 13 => 'Grade 13',
1753: 14 => '100 Level',
1754: 15 => '200 Level',
1755: 16 => '300 Level',
1756: 17 => '400 Level',
1757: 18 => 'Graduate Level');
1758: return &mt($gradelevels{$gradelevel});
1759: }
1760:
1.163 www 1761: sub select_level_form {
1762: my ($deflevel,$name)=@_;
1763: unless ($deflevel) { $deflevel=0; }
1.167 www 1764: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1765: for (my $i=0; $i<=18; $i++) {
1766: $selectform.="<option value=\"$i\" ".
1.253 albertel 1767: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1768: ">".&gradeleveldescription($i)."</option>\n";
1769: }
1770: $selectform.="</select>";
1771: return $selectform;
1.163 www 1772: }
1.167 www 1773:
1.35 matthew 1774: #-------------------------------------------
1775:
1.45 matthew 1776: =pod
1777:
1.743 raeburn 1778: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$autosubmit)
1.35 matthew 1779:
1780: Returns a string containing a <select name='$name' size='1'> form to
1781: allow a user to select the domain to preform an operation in.
1782: See loncreateuser.pm for an example invocation and use.
1783:
1.90 www 1784: If the $includeempty flag is set, it also includes an empty choice ("no domain
1785: selected");
1786:
1.743 raeburn 1787: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1788:
1789: If the $autosubmit flag is set, the form containing the domain selector will be auto-submitted by an onchange action.
1.563 raeburn 1790:
1.35 matthew 1791: =cut
1792:
1793: #-------------------------------------------
1.34 matthew 1794: sub select_dom_form {
1.743 raeburn 1795: my ($defdom,$name,$includeempty,$showdomdesc,$autosubmit) = @_;
1796: my $onchange;
1797: if ($autosubmit) {
1798: $onchange = ' onchange="this.form.submit()"';
1799: }
1.550 albertel 1800: my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90 www 1801: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1802: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1803: foreach my $dom (@domains) {
1804: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1805: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1806: if ($showdomdesc) {
1807: if ($dom ne '') {
1808: my $domdesc = &Apache::lonnet::domain($dom,'description');
1809: if ($domdesc ne '') {
1810: $selectdomain .= ' ('.$domdesc.')';
1811: }
1812: }
1813: }
1814: $selectdomain .= "</option>\n";
1.34 matthew 1815: }
1816: $selectdomain.="</select>";
1817: return $selectdomain;
1818: }
1819:
1.35 matthew 1820: #-------------------------------------------
1821:
1.45 matthew 1822: =pod
1823:
1.648 raeburn 1824: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1825:
1.586 raeburn 1826: input: 4 arguments (two required, two optional) -
1827: $domain - domain of new user
1828: $name - name of form element
1829: $default - Value of 'default' causes a default item to be first
1830: option, and selected by default.
1831: $hide - Value of 'hide' causes hiding of the name of the server,
1832: if 1 server found, or default, if 0 found.
1.594 raeburn 1833: output: returns 2 items:
1.586 raeburn 1834: (a) form element which contains either:
1835: (i) <select name="$name">
1836: <option value="$hostid1">$hostid $servers{$hostid}</option>
1837: <option value="$hostid2">$hostid $servers{$hostid}</option>
1838: </select>
1839: form item if there are multiple library servers in $domain, or
1840: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
1841: if there is only one library server in $domain.
1842:
1843: (b) number of library servers found.
1844:
1845: See loncreateuser.pm for example of use.
1.35 matthew 1846:
1847: =cut
1848:
1849: #-------------------------------------------
1.586 raeburn 1850: sub home_server_form_item {
1851: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 1852: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 1853: my $result;
1854: my $numlib = keys(%servers);
1855: if ($numlib > 1) {
1856: $result .= '<select name="'.$name.'" />'."\n";
1857: if ($default) {
1.804 bisitz 1858: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 1859: '</option>'."\n";
1860: }
1861: foreach my $hostid (sort(keys(%servers))) {
1862: $result.= '<option value="'.$hostid.'">'.
1863: $hostid.' '.$servers{$hostid}."</option>\n";
1864: }
1865: $result .= '</select>'."\n";
1866: } elsif ($numlib == 1) {
1867: my $hostid;
1868: foreach my $item (keys(%servers)) {
1869: $hostid = $item;
1870: }
1871: $result .= '<input type="hidden" name="'.$name.'" value="'.
1872: $hostid.'" />';
1873: if (!$hide) {
1874: $result .= $hostid.' '.$servers{$hostid};
1875: }
1876: $result .= "\n";
1877: } elsif ($default) {
1878: $result .= '<input type="hidden" name="'.$name.
1879: '" value="default" />';
1880: if (!$hide) {
1881: $result .= &mt('default');
1882: }
1883: $result .= "\n";
1.33 matthew 1884: }
1.586 raeburn 1885: return ($result,$numlib);
1.33 matthew 1886: }
1.112 bowersj2 1887:
1888: =pod
1889:
1.534 albertel 1890: =back
1891:
1.112 bowersj2 1892: =cut
1.87 matthew 1893:
1894: ###############################################################
1.112 bowersj2 1895: ## Decoding User Agent ##
1.87 matthew 1896: ###############################################################
1897:
1898: =pod
1899:
1.112 bowersj2 1900: =head1 Decoding the User Agent
1901:
1902: =over 4
1903:
1904: =item * &decode_user_agent()
1.87 matthew 1905:
1906: Inputs: $r
1907:
1908: Outputs:
1909:
1910: =over 4
1911:
1.112 bowersj2 1912: =item * $httpbrowser
1.87 matthew 1913:
1.112 bowersj2 1914: =item * $clientbrowser
1.87 matthew 1915:
1.112 bowersj2 1916: =item * $clientversion
1.87 matthew 1917:
1.112 bowersj2 1918: =item * $clientmathml
1.87 matthew 1919:
1.112 bowersj2 1920: =item * $clientunicode
1.87 matthew 1921:
1.112 bowersj2 1922: =item * $clientos
1.87 matthew 1923:
1924: =back
1925:
1.157 matthew 1926: =back
1927:
1.87 matthew 1928: =cut
1929:
1930: ###############################################################
1931: ###############################################################
1932: sub decode_user_agent {
1.247 albertel 1933: my ($r)=@_;
1.87 matthew 1934: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
1935: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
1936: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 1937: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 1938: my $clientbrowser='unknown';
1939: my $clientversion='0';
1940: my $clientmathml='';
1941: my $clientunicode='0';
1942: for (my $i=0;$i<=$#browsertype;$i++) {
1943: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
1944: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
1945: $clientbrowser=$bname;
1946: $httpbrowser=~/$vreg/i;
1947: $clientversion=$1;
1948: $clientmathml=($clientversion>=$minv);
1949: $clientunicode=($clientversion>=$univ);
1950: }
1951: }
1952: my $clientos='unknown';
1953: if (($httpbrowser=~/linux/i) ||
1954: ($httpbrowser=~/unix/i) ||
1955: ($httpbrowser=~/ux/i) ||
1956: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
1957: if (($httpbrowser=~/vax/i) ||
1958: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
1959: if ($httpbrowser=~/next/i) { $clientos='next'; }
1960: if (($httpbrowser=~/mac/i) ||
1961: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1962: if ($httpbrowser=~/win/i) { $clientos='win'; }
1963: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1964: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1965: $clientunicode,$clientos,);
1966: }
1967:
1.32 matthew 1968: ###############################################################
1969: ## Authentication changing form generation subroutines ##
1970: ###############################################################
1971: ##
1972: ## All of the authform_xxxxxxx subroutines take their inputs in a
1973: ## hash, and have reasonable default values.
1974: ##
1975: ## formname = the name given in the <form> tag.
1.35 matthew 1976: #-------------------------------------------
1977:
1.45 matthew 1978: =pod
1979:
1.112 bowersj2 1980: =head1 Authentication Routines
1981:
1982: =over 4
1983:
1.648 raeburn 1984: =item * &authform_xxxxxx()
1.35 matthew 1985:
1986: The authform_xxxxxx subroutines provide javascript and html forms which
1987: handle some of the conveniences required for authentication forms.
1988: This is not an optimal method, but it works.
1989:
1990: =over 4
1991:
1.112 bowersj2 1992: =item * authform_header
1.35 matthew 1993:
1.112 bowersj2 1994: =item * authform_authorwarning
1.35 matthew 1995:
1.112 bowersj2 1996: =item * authform_nochange
1.35 matthew 1997:
1.112 bowersj2 1998: =item * authform_kerberos
1.35 matthew 1999:
1.112 bowersj2 2000: =item * authform_internal
1.35 matthew 2001:
1.112 bowersj2 2002: =item * authform_filesystem
1.35 matthew 2003:
2004: =back
2005:
1.648 raeburn 2006: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2007:
1.35 matthew 2008: =cut
2009:
2010: #-------------------------------------------
1.32 matthew 2011: sub authform_header{
2012: my %in = (
2013: formname => 'cu',
1.80 albertel 2014: kerb_def_dom => '',
1.32 matthew 2015: @_,
2016: );
2017: $in{'formname'} = 'document.' . $in{'formname'};
2018: my $result='';
1.80 albertel 2019:
2020: #---------------------------------------------- Code for upper case translation
2021: my $Javascript_toUpperCase;
2022: unless ($in{kerb_def_dom}) {
2023: $Javascript_toUpperCase =<<"END";
2024: switch (choice) {
2025: case 'krb': currentform.elements[choicearg].value =
2026: currentform.elements[choicearg].value.toUpperCase();
2027: break;
2028: default:
2029: }
2030: END
2031: } else {
2032: $Javascript_toUpperCase = "";
2033: }
2034:
1.165 raeburn 2035: my $radioval = "'nochange'";
1.591 raeburn 2036: if (defined($in{'curr_authtype'})) {
2037: if ($in{'curr_authtype'} ne '') {
2038: $radioval = "'".$in{'curr_authtype'}."arg'";
2039: }
1.174 matthew 2040: }
1.165 raeburn 2041: my $argfield = 'null';
1.591 raeburn 2042: if (defined($in{'mode'})) {
1.165 raeburn 2043: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2044: if (defined($in{'curr_autharg'})) {
2045: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2046: $argfield = "'$in{'curr_autharg'}'";
2047: }
2048: }
2049: }
2050: }
2051:
1.32 matthew 2052: $result.=<<"END";
2053: var current = new Object();
1.165 raeburn 2054: current.radiovalue = $radioval;
2055: current.argfield = $argfield;
1.32 matthew 2056:
2057: function changed_radio(choice,currentform) {
2058: var choicearg = choice + 'arg';
2059: // If a radio button in changed, we need to change the argfield
2060: if (current.radiovalue != choice) {
2061: current.radiovalue = choice;
2062: if (current.argfield != null) {
2063: currentform.elements[current.argfield].value = '';
2064: }
2065: if (choice == 'nochange') {
2066: current.argfield = null;
2067: } else {
2068: current.argfield = choicearg;
2069: switch(choice) {
2070: case 'krb':
2071: currentform.elements[current.argfield].value =
2072: "$in{'kerb_def_dom'}";
2073: break;
2074: default:
2075: break;
2076: }
2077: }
2078: }
2079: return;
2080: }
1.22 www 2081:
1.32 matthew 2082: function changed_text(choice,currentform) {
2083: var choicearg = choice + 'arg';
2084: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2085: $Javascript_toUpperCase
1.32 matthew 2086: // clear old field
2087: if ((current.argfield != choicearg) && (current.argfield != null)) {
2088: currentform.elements[current.argfield].value = '';
2089: }
2090: current.argfield = choicearg;
2091: }
2092: set_auth_radio_buttons(choice,currentform);
2093: return;
1.20 www 2094: }
1.32 matthew 2095:
2096: function set_auth_radio_buttons(newvalue,currentform) {
2097: var i=0;
2098: while (i < currentform.login.length) {
2099: if (currentform.login[i].value == newvalue) { break; }
2100: i++;
2101: }
2102: if (i == currentform.login.length) {
2103: return;
2104: }
2105: current.radiovalue = newvalue;
2106: currentform.login[i].checked = true;
2107: return;
2108: }
2109: END
2110: return $result;
2111: }
2112:
2113: sub authform_authorwarning{
2114: my $result='';
1.144 matthew 2115: $result='<i>'.
2116: &mt('As a general rule, only authors or co-authors should be '.
2117: 'filesystem authenticated '.
2118: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2119: return $result;
2120: }
2121:
2122: sub authform_nochange{
2123: my %in = (
2124: formname => 'document.cu',
2125: kerb_def_dom => 'MSU.EDU',
2126: @_,
2127: );
1.586 raeburn 2128: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2129: my $result;
2130: if (keys(%can_assign) == 0) {
2131: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2132: } else {
2133: $result = '<label>'.&mt('[_1] Do not change login data',
2134: '<input type="radio" name="login" value="nochange" '.
2135: 'checked="checked" onclick="'.
1.281 albertel 2136: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2137: '</label>';
1.586 raeburn 2138: }
1.32 matthew 2139: return $result;
2140: }
2141:
1.591 raeburn 2142: sub authform_kerberos {
1.32 matthew 2143: my %in = (
2144: formname => 'document.cu',
2145: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2146: kerb_def_auth => 'krb4',
1.32 matthew 2147: @_,
2148: );
1.586 raeburn 2149: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2150: $autharg,$jscall);
2151: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2152: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2153: $check5 = ' checked="checked"';
1.80 albertel 2154: } else {
1.772 bisitz 2155: $check4 = ' checked="checked"';
1.80 albertel 2156: }
1.165 raeburn 2157: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2158: if (defined($in{'curr_authtype'})) {
2159: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2160: $krbcheck = ' checked="checked"';
1.623 raeburn 2161: if (defined($in{'mode'})) {
2162: if ($in{'mode'} eq 'modifyuser') {
2163: $krbcheck = '';
2164: }
2165: }
1.591 raeburn 2166: if (defined($in{'curr_kerb_ver'})) {
2167: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2168: $check5 = ' checked="checked"';
1.591 raeburn 2169: $check4 = '';
2170: } else {
1.772 bisitz 2171: $check4 = ' checked="checked"';
1.591 raeburn 2172: $check5 = '';
2173: }
1.586 raeburn 2174: }
1.591 raeburn 2175: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2176: $krbarg = $in{'curr_autharg'};
2177: }
1.586 raeburn 2178: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2179: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2180: $result =
2181: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2182: $in{'curr_autharg'},$krbver);
2183: } else {
2184: $result =
2185: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2186: }
2187: return $result;
2188: }
2189: }
2190: } else {
2191: if ($authnum == 1) {
1.784 bisitz 2192: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2193: }
2194: }
1.586 raeburn 2195: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2196: return;
1.587 raeburn 2197: } elsif ($authtype eq '') {
1.591 raeburn 2198: if (defined($in{'mode'})) {
1.587 raeburn 2199: if ($in{'mode'} eq 'modifycourse') {
2200: if ($authnum == 1) {
1.784 bisitz 2201: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2202: }
2203: }
2204: }
1.586 raeburn 2205: }
2206: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2207: if ($authtype eq '') {
2208: $authtype = '<input type="radio" name="login" value="krb" '.
2209: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2210: $krbcheck.' />';
2211: }
2212: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2213: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2214: $in{'curr_authtype'} eq 'krb5') ||
2215: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2216: $in{'curr_authtype'} eq 'krb4')) {
2217: $result .= &mt
1.144 matthew 2218: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2219: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2220: '<label>'.$authtype,
1.281 albertel 2221: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2222: 'value="'.$krbarg.'" '.
1.144 matthew 2223: 'onchange="'.$jscall.'" />',
1.281 albertel 2224: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2225: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2226: '</label>');
1.586 raeburn 2227: } elsif ($can_assign{'krb4'}) {
2228: $result .= &mt
2229: ('[_1] Kerberos authenticated with domain [_2] '.
2230: '[_3] Version 4 [_4]',
2231: '<label>'.$authtype,
2232: '</label><input type="text" size="10" name="krbarg" '.
2233: 'value="'.$krbarg.'" '.
2234: 'onchange="'.$jscall.'" />',
2235: '<label><input type="hidden" name="krbver" value="4" />',
2236: '</label>');
2237: } elsif ($can_assign{'krb5'}) {
2238: $result .= &mt
2239: ('[_1] Kerberos authenticated with domain [_2] '.
2240: '[_3] Version 5 [_4]',
2241: '<label>'.$authtype,
2242: '</label><input type="text" size="10" name="krbarg" '.
2243: 'value="'.$krbarg.'" '.
2244: 'onchange="'.$jscall.'" />',
2245: '<label><input type="hidden" name="krbver" value="5" />',
2246: '</label>');
2247: }
1.32 matthew 2248: return $result;
2249: }
2250:
2251: sub authform_internal{
1.586 raeburn 2252: my %in = (
1.32 matthew 2253: formname => 'document.cu',
2254: kerb_def_dom => 'MSU.EDU',
2255: @_,
2256: );
1.586 raeburn 2257: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2258: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2259: if (defined($in{'curr_authtype'})) {
2260: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2261: if ($can_assign{'int'}) {
1.772 bisitz 2262: $intcheck = 'checked="checked" ';
1.623 raeburn 2263: if (defined($in{'mode'})) {
2264: if ($in{'mode'} eq 'modifyuser') {
2265: $intcheck = '';
2266: }
2267: }
1.591 raeburn 2268: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2269: $intarg = $in{'curr_autharg'};
2270: }
2271: } else {
2272: $result = &mt('Currently internally authenticated.');
2273: return $result;
1.165 raeburn 2274: }
2275: }
1.586 raeburn 2276: } else {
2277: if ($authnum == 1) {
1.784 bisitz 2278: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2279: }
2280: }
2281: if (!$can_assign{'int'}) {
2282: return;
1.587 raeburn 2283: } elsif ($authtype eq '') {
1.591 raeburn 2284: if (defined($in{'mode'})) {
1.587 raeburn 2285: if ($in{'mode'} eq 'modifycourse') {
2286: if ($authnum == 1) {
1.784 bisitz 2287: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2288: }
2289: }
2290: }
1.165 raeburn 2291: }
1.586 raeburn 2292: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2293: if ($authtype eq '') {
2294: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2295: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2296: }
1.605 bisitz 2297: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2298: $intarg.'" onchange="'.$jscall.'" />';
2299: $result = &mt
1.144 matthew 2300: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2301: '<label>'.$authtype,'</label>'.$autharg);
1.620 www 2302: $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 2303: return $result;
2304: }
2305:
2306: sub authform_local{
2307: my %in = (
2308: formname => 'document.cu',
2309: kerb_def_dom => 'MSU.EDU',
2310: @_,
2311: );
1.586 raeburn 2312: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2313: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2314: if (defined($in{'curr_authtype'})) {
2315: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2316: if ($can_assign{'loc'}) {
1.772 bisitz 2317: $loccheck = 'checked="checked" ';
1.623 raeburn 2318: if (defined($in{'mode'})) {
2319: if ($in{'mode'} eq 'modifyuser') {
2320: $loccheck = '';
2321: }
2322: }
1.591 raeburn 2323: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2324: $locarg = $in{'curr_autharg'};
2325: }
2326: } else {
2327: $result = &mt('Currently using local (institutional) authentication.');
2328: return $result;
1.165 raeburn 2329: }
2330: }
1.586 raeburn 2331: } else {
2332: if ($authnum == 1) {
1.784 bisitz 2333: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2334: }
2335: }
2336: if (!$can_assign{'loc'}) {
2337: return;
1.587 raeburn 2338: } elsif ($authtype eq '') {
1.591 raeburn 2339: if (defined($in{'mode'})) {
1.587 raeburn 2340: if ($in{'mode'} eq 'modifycourse') {
2341: if ($authnum == 1) {
1.784 bisitz 2342: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2343: }
2344: }
2345: }
1.165 raeburn 2346: }
1.586 raeburn 2347: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2348: if ($authtype eq '') {
2349: $authtype = '<input type="radio" name="login" value="loc" '.
2350: $loccheck.' onchange="'.$jscall.'" onclick="'.
2351: $jscall.'" />';
2352: }
2353: $autharg = '<input type="text" size="10" name="locarg" value="'.
2354: $locarg.'" onchange="'.$jscall.'" />';
2355: $result = &mt('[_1] Local Authentication with argument [_2]',
2356: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2357: return $result;
2358: }
2359:
2360: sub authform_filesystem{
2361: my %in = (
2362: formname => 'document.cu',
2363: kerb_def_dom => 'MSU.EDU',
2364: @_,
2365: );
1.586 raeburn 2366: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2367: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2368: if (defined($in{'curr_authtype'})) {
2369: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2370: if ($can_assign{'fsys'}) {
1.772 bisitz 2371: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2372: if (defined($in{'mode'})) {
2373: if ($in{'mode'} eq 'modifyuser') {
2374: $fsyscheck = '';
2375: }
2376: }
1.586 raeburn 2377: } else {
2378: $result = &mt('Currently Filesystem Authenticated.');
2379: return $result;
2380: }
2381: }
2382: } else {
2383: if ($authnum == 1) {
1.784 bisitz 2384: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2385: }
2386: }
2387: if (!$can_assign{'fsys'}) {
2388: return;
1.587 raeburn 2389: } elsif ($authtype eq '') {
1.591 raeburn 2390: if (defined($in{'mode'})) {
1.587 raeburn 2391: if ($in{'mode'} eq 'modifycourse') {
2392: if ($authnum == 1) {
1.784 bisitz 2393: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2394: }
2395: }
2396: }
1.586 raeburn 2397: }
2398: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2399: if ($authtype eq '') {
2400: $authtype = '<input type="radio" name="login" value="fsys" '.
2401: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2402: $jscall.'" />';
2403: }
2404: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2405: ' onchange="'.$jscall.'" />';
2406: $result = &mt
1.144 matthew 2407: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2408: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2409: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2410: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2411: 'onchange="'.$jscall.'" />');
1.32 matthew 2412: return $result;
2413: }
2414:
1.586 raeburn 2415: sub get_assignable_auth {
2416: my ($dom) = @_;
2417: if ($dom eq '') {
2418: $dom = $env{'request.role.domain'};
2419: }
2420: my %can_assign = (
2421: krb4 => 1,
2422: krb5 => 1,
2423: int => 1,
2424: loc => 1,
2425: );
2426: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2427: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2428: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2429: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2430: my $context;
2431: if ($env{'request.role'} =~ /^au/) {
2432: $context = 'author';
2433: } elsif ($env{'request.role'} =~ /^dc/) {
2434: $context = 'domain';
2435: } elsif ($env{'request.course.id'}) {
2436: $context = 'course';
2437: }
2438: if ($context) {
2439: if (ref($authhash->{$context}) eq 'HASH') {
2440: %can_assign = %{$authhash->{$context}};
2441: }
2442: }
2443: }
2444: }
2445: my $authnum = 0;
2446: foreach my $key (keys(%can_assign)) {
2447: if ($can_assign{$key}) {
2448: $authnum ++;
2449: }
2450: }
2451: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2452: $authnum --;
2453: }
2454: return ($authnum,%can_assign);
2455: }
2456:
1.80 albertel 2457: ###############################################################
2458: ## Get Kerberos Defaults for Domain ##
2459: ###############################################################
2460: ##
2461: ## Returns default kerberos version and an associated argument
2462: ## as listed in file domain.tab. If not listed, provides
2463: ## appropriate default domain and kerberos version.
2464: ##
2465: #-------------------------------------------
2466:
2467: =pod
2468:
1.648 raeburn 2469: =item * &get_kerberos_defaults()
1.80 albertel 2470:
2471: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2472: version and domain. If not found, it defaults to version 4 and the
2473: domain of the server.
1.80 albertel 2474:
1.648 raeburn 2475: =over 4
2476:
1.80 albertel 2477: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2478:
1.648 raeburn 2479: =back
2480:
2481: =back
2482:
1.80 albertel 2483: =cut
2484:
2485: #-------------------------------------------
2486: sub get_kerberos_defaults {
2487: my $domain=shift;
1.641 raeburn 2488: my ($krbdef,$krbdefdom);
2489: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2490: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2491: $krbdef = $domdefaults{'auth_def'};
2492: $krbdefdom = $domdefaults{'auth_arg_def'};
2493: } else {
1.80 albertel 2494: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2495: my $krbdefdom=$1;
2496: $krbdefdom=~tr/a-z/A-Z/;
2497: $krbdef = "krb4";
2498: }
2499: return ($krbdef,$krbdefdom);
2500: }
1.112 bowersj2 2501:
1.32 matthew 2502:
1.46 matthew 2503: ###############################################################
2504: ## Thesaurus Functions ##
2505: ###############################################################
1.20 www 2506:
1.46 matthew 2507: =pod
1.20 www 2508:
1.112 bowersj2 2509: =head1 Thesaurus Functions
2510:
2511: =over 4
2512:
1.648 raeburn 2513: =item * &initialize_keywords()
1.46 matthew 2514:
2515: Initializes the package variable %Keywords if it is empty. Uses the
2516: package variable $thesaurus_db_file.
2517:
2518: =cut
2519:
2520: ###################################################
2521:
2522: sub initialize_keywords {
2523: return 1 if (scalar keys(%Keywords));
2524: # If we are here, %Keywords is empty, so fill it up
2525: # Make sure the file we need exists...
2526: if (! -e $thesaurus_db_file) {
2527: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2528: " failed because it does not exist");
2529: return 0;
2530: }
2531: # Set up the hash as a database
2532: my %thesaurus_db;
2533: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2534: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2535: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2536: $thesaurus_db_file);
2537: return 0;
2538: }
2539: # Get the average number of appearances of a word.
2540: my $avecount = $thesaurus_db{'average.count'};
2541: # Put keywords (those that appear > average) into %Keywords
2542: while (my ($word,$data)=each (%thesaurus_db)) {
2543: my ($count,undef) = split /:/,$data;
2544: $Keywords{$word}++ if ($count > $avecount);
2545: }
2546: untie %thesaurus_db;
2547: # Remove special values from %Keywords.
1.356 albertel 2548: foreach my $value ('total.count','average.count') {
2549: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2550: }
1.46 matthew 2551: return 1;
2552: }
2553:
2554: ###################################################
2555:
2556: =pod
2557:
1.648 raeburn 2558: =item * &keyword($word)
1.46 matthew 2559:
2560: Returns true if $word is a keyword. A keyword is a word that appears more
2561: than the average number of times in the thesaurus database. Calls
2562: &initialize_keywords
2563:
2564: =cut
2565:
2566: ###################################################
1.20 www 2567:
2568: sub keyword {
1.46 matthew 2569: return if (!&initialize_keywords());
2570: my $word=lc(shift());
2571: $word=~s/\W//g;
2572: return exists($Keywords{$word});
1.20 www 2573: }
1.46 matthew 2574:
2575: ###############################################################
2576:
2577: =pod
1.20 www 2578:
1.648 raeburn 2579: =item * &get_related_words()
1.46 matthew 2580:
1.160 matthew 2581: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2582: an array of words. If the keyword is not in the thesaurus, an empty array
2583: will be returned. The order of the words returned is determined by the
2584: database which holds them.
2585:
2586: Uses global $thesaurus_db_file.
2587:
2588: =cut
2589:
2590: ###############################################################
2591: sub get_related_words {
2592: my $keyword = shift;
2593: my %thesaurus_db;
2594: if (! -e $thesaurus_db_file) {
2595: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2596: "failed because the file does not exist");
2597: return ();
2598: }
2599: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2600: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2601: return ();
2602: }
2603: my @Words=();
1.429 www 2604: my $count=0;
1.46 matthew 2605: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2606: # The first element is the number of times
2607: # the word appears. We do not need it now.
1.429 www 2608: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2609: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2610: my $threshold=$mostfrequentcount/10;
2611: foreach my $possibleword (@RelatedWords) {
2612: my ($word,$wordcount)=split(/\,/,$possibleword);
2613: if ($wordcount>$threshold) {
2614: push(@Words,$word);
2615: $count++;
2616: if ($count>10) { last; }
2617: }
1.20 www 2618: }
2619: }
1.46 matthew 2620: untie %thesaurus_db;
2621: return @Words;
1.14 harris41 2622: }
1.46 matthew 2623:
1.112 bowersj2 2624: =pod
2625:
2626: =back
2627:
2628: =cut
1.61 www 2629:
2630: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2631: =pod
2632:
1.112 bowersj2 2633: =head1 User Name Functions
2634:
2635: =over 4
2636:
1.648 raeburn 2637: =item * &plainname($uname,$udom,$first)
1.81 albertel 2638:
1.112 bowersj2 2639: Takes a users logon name and returns it as a string in
1.226 albertel 2640: "first middle last generation" form
2641: if $first is set to 'lastname' then it returns it as
2642: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2643:
2644: =cut
1.61 www 2645:
1.295 www 2646:
1.81 albertel 2647: ###############################################################
1.61 www 2648: sub plainname {
1.226 albertel 2649: my ($uname,$udom,$first)=@_;
1.537 albertel 2650: return if (!defined($uname) || !defined($udom));
1.295 www 2651: my %names=&getnames($uname,$udom);
1.226 albertel 2652: my $name=&Apache::lonnet::format_name($names{'firstname'},
2653: $names{'middlename'},
2654: $names{'lastname'},
2655: $names{'generation'},$first);
2656: $name=~s/^\s+//;
1.62 www 2657: $name=~s/\s+$//;
2658: $name=~s/\s+/ /g;
1.353 albertel 2659: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2660: return $name;
1.61 www 2661: }
1.66 www 2662:
2663: # -------------------------------------------------------------------- Nickname
1.81 albertel 2664: =pod
2665:
1.648 raeburn 2666: =item * &nickname($uname,$udom)
1.81 albertel 2667:
2668: Gets a users name and returns it as a string as
2669:
2670: ""nickname""
1.66 www 2671:
1.81 albertel 2672: if the user has a nickname or
2673:
2674: "first middle last generation"
2675:
2676: if the user does not
2677:
2678: =cut
1.66 www 2679:
2680: sub nickname {
2681: my ($uname,$udom)=@_;
1.537 albertel 2682: return if (!defined($uname) || !defined($udom));
1.295 www 2683: my %names=&getnames($uname,$udom);
1.68 albertel 2684: my $name=$names{'nickname'};
1.66 www 2685: if ($name) {
2686: $name='"'.$name.'"';
2687: } else {
2688: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2689: $names{'lastname'}.' '.$names{'generation'};
2690: $name=~s/\s+$//;
2691: $name=~s/\s+/ /g;
2692: }
2693: return $name;
2694: }
2695:
1.295 www 2696: sub getnames {
2697: my ($uname,$udom)=@_;
1.537 albertel 2698: return if (!defined($uname) || !defined($udom));
1.433 albertel 2699: if ($udom eq 'public' && $uname eq 'public') {
2700: return ('lastname' => &mt('Public'));
2701: }
1.295 www 2702: my $id=$uname.':'.$udom;
2703: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2704: if ($cached) {
2705: return %{$names};
2706: } else {
2707: my %loadnames=&Apache::lonnet::get('environment',
2708: ['firstname','middlename','lastname','generation','nickname'],
2709: $udom,$uname);
2710: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2711: return %loadnames;
2712: }
2713: }
1.61 www 2714:
1.542 raeburn 2715: # -------------------------------------------------------------------- getemails
1.648 raeburn 2716:
1.542 raeburn 2717: =pod
2718:
1.648 raeburn 2719: =item * &getemails($uname,$udom)
1.542 raeburn 2720:
2721: Gets a user's email information and returns it as a hash with keys:
2722: notification, critnotification, permanentemail
2723:
2724: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2725: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2726:
1.648 raeburn 2727:
1.542 raeburn 2728: =cut
2729:
1.648 raeburn 2730:
1.466 albertel 2731: sub getemails {
2732: my ($uname,$udom)=@_;
2733: if ($udom eq 'public' && $uname eq 'public') {
2734: return;
2735: }
1.467 www 2736: if (!$udom) { $udom=$env{'user.domain'}; }
2737: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2738: my $id=$uname.':'.$udom;
2739: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2740: if ($cached) {
2741: return %{$names};
2742: } else {
2743: my %loadnames=&Apache::lonnet::get('environment',
2744: ['notification','critnotification',
2745: 'permanentemail'],
2746: $udom,$uname);
2747: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2748: return %loadnames;
2749: }
2750: }
2751:
1.551 albertel 2752: sub flush_email_cache {
2753: my ($uname,$udom)=@_;
2754: if (!$udom) { $udom =$env{'user.domain'}; }
2755: if (!$uname) { $uname=$env{'user.name'}; }
2756: return if ($udom eq 'public' && $uname eq 'public');
2757: my $id=$uname.':'.$udom;
2758: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2759: }
2760:
1.728 raeburn 2761: # -------------------------------------------------------------------- getlangs
2762:
2763: =pod
2764:
2765: =item * &getlangs($uname,$udom)
2766:
2767: Gets a user's language preference and returns it as a hash with key:
2768: language.
2769:
2770: =cut
2771:
2772:
2773: sub getlangs {
2774: my ($uname,$udom) = @_;
2775: if (!$udom) { $udom =$env{'user.domain'}; }
2776: if (!$uname) { $uname=$env{'user.name'}; }
2777: my $id=$uname.':'.$udom;
2778: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2779: if ($cached) {
2780: return %{$langs};
2781: } else {
2782: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2783: $udom,$uname);
2784: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2785: return %loadlangs;
2786: }
2787: }
2788:
2789: sub flush_langs_cache {
2790: my ($uname,$udom)=@_;
2791: if (!$udom) { $udom =$env{'user.domain'}; }
2792: if (!$uname) { $uname=$env{'user.name'}; }
2793: return if ($udom eq 'public' && $uname eq 'public');
2794: my $id=$uname.':'.$udom;
2795: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2796: }
2797:
1.61 www 2798: # ------------------------------------------------------------------ Screenname
1.81 albertel 2799:
2800: =pod
2801:
1.648 raeburn 2802: =item * &screenname($uname,$udom)
1.81 albertel 2803:
2804: Gets a users screenname and returns it as a string
2805:
2806: =cut
1.61 www 2807:
2808: sub screenname {
2809: my ($uname,$udom)=@_;
1.258 albertel 2810: if ($uname eq $env{'user.name'} &&
2811: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2812: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2813: return $names{'screenname'};
1.62 www 2814: }
2815:
1.212 albertel 2816:
1.802 bisitz 2817: # ------------------------------------------------------------- Confirm Wrapper
2818: =pod
2819:
2820: =item confirmwrapper
2821:
2822: Wrap messages about completion of operation in box
2823:
2824: =cut
2825:
2826: sub confirmwrapper {
2827: my ($message)=@_;
2828: if ($message) {
2829: return "\n".'<div class="LC_confirm_box">'."\n"
2830: .$message."\n"
2831: .'</div>'."\n";
2832: } else {
2833: return $message;
2834: }
2835: }
2836:
1.62 www 2837: # ------------------------------------------------------------- Message Wrapper
2838:
2839: sub messagewrapper {
1.369 www 2840: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 2841: return
1.441 albertel 2842: '<a href="/adm/email?compose=individual&'.
2843: 'recname='.$username.'&recdom='.$domain.
2844: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 2845: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 2846: }
1.802 bisitz 2847:
1.74 www 2848: # --------------------------------------------------------------- Notes Wrapper
2849:
2850: sub noteswrapper {
2851: my ($link,$un,$do)=@_;
2852: return
2853: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 2854: }
1.802 bisitz 2855:
1.62 www 2856: # ------------------------------------------------------------- Aboutme Wrapper
2857:
2858: sub aboutmewrapper {
1.166 www 2859: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 2860: if (!defined($username) && !defined($domain)) {
2861: return;
2862: }
1.205 www 2863: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.756 weissno 2864: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 2865: }
2866:
2867: # ------------------------------------------------------------ Syllabus Wrapper
2868:
2869: sub syllabuswrapper {
1.707 bisitz 2870: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 2871: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 2872: }
1.14 harris41 2873:
1.802 bisitz 2874: # -----------------------------------------------------------------------------
2875:
1.208 matthew 2876: sub track_student_link {
1.268 albertel 2877: my ($linktext,$sname,$sdom,$target,$start) = @_;
2878: my $link ="/adm/trackstudent?";
1.208 matthew 2879: my $title = 'View recent activity';
2880: if (defined($sname) && $sname !~ /^\s*$/ &&
2881: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 2882: $link .= "selected_student=$sname:$sdom";
1.208 matthew 2883: $title .= ' of this student';
1.268 albertel 2884: }
1.208 matthew 2885: if (defined($target) && $target !~ /^\s*$/) {
2886: $target = qq{target="$target"};
2887: } else {
2888: $target = '';
2889: }
1.268 albertel 2890: if ($start) { $link.='&start='.$start; }
1.554 albertel 2891: $title = &mt($title);
2892: $linktext = &mt($linktext);
1.448 albertel 2893: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
2894: &help_open_topic('View_recent_activity');
1.208 matthew 2895: }
2896:
1.781 raeburn 2897: sub slot_reservations_link {
2898: my ($linktext,$sname,$sdom,$target) = @_;
2899: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
2900: my $title = 'View slot reservation history';
2901: if (defined($sname) && $sname !~ /^\s*$/ &&
2902: defined($sdom) && $sdom !~ /^\s*$/) {
2903: $link .= "&uname=$sname&udom=$sdom";
2904: $title .= ' of this student';
2905: }
2906: if (defined($target) && $target !~ /^\s*$/) {
2907: $target = qq{target="$target"};
2908: } else {
2909: $target = '';
2910: }
2911: $title = &mt($title);
2912: $linktext = &mt($linktext);
2913: return qq{<a href="$link" title="$title" $target>$linktext</a>};
2914: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
2915:
2916: }
2917:
1.508 www 2918: # ===================================================== Display a student photo
2919:
2920:
1.509 albertel 2921: sub student_image_tag {
1.508 www 2922: my ($domain,$user)=@_;
2923: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
2924: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
2925: return '<img src="'.$imgsrc.'" align="right" />';
2926: } else {
2927: return '';
2928: }
2929: }
2930:
1.112 bowersj2 2931: =pod
2932:
2933: =back
2934:
2935: =head1 Access .tab File Data
2936:
2937: =over 4
2938:
1.648 raeburn 2939: =item * &languageids()
1.112 bowersj2 2940:
2941: returns list of all language ids
2942:
2943: =cut
2944:
1.14 harris41 2945: sub languageids {
1.16 harris41 2946: return sort(keys(%language));
1.14 harris41 2947: }
2948:
1.112 bowersj2 2949: =pod
2950:
1.648 raeburn 2951: =item * &languagedescription()
1.112 bowersj2 2952:
2953: returns description of a specified language id
2954:
2955: =cut
2956:
1.14 harris41 2957: sub languagedescription {
1.125 www 2958: my $code=shift;
2959: return ($supported_language{$code}?'* ':'').
2960: $language{$code}.
1.126 www 2961: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 2962: }
2963:
2964: sub plainlanguagedescription {
2965: my $code=shift;
2966: return $language{$code};
2967: }
2968:
2969: sub supportedlanguagecode {
2970: my $code=shift;
2971: return $supported_language{$code};
1.97 www 2972: }
2973:
1.112 bowersj2 2974: =pod
2975:
1.648 raeburn 2976: =item * ©rightids()
1.112 bowersj2 2977:
2978: returns list of all copyrights
2979:
2980: =cut
2981:
2982: sub copyrightids {
2983: return sort(keys(%cprtag));
2984: }
2985:
2986: =pod
2987:
1.648 raeburn 2988: =item * ©rightdescription()
1.112 bowersj2 2989:
2990: returns description of a specified copyright id
2991:
2992: =cut
2993:
2994: sub copyrightdescription {
1.166 www 2995: return &mt($cprtag{shift(@_)});
1.112 bowersj2 2996: }
1.197 matthew 2997:
2998: =pod
2999:
1.648 raeburn 3000: =item * &source_copyrightids()
1.192 taceyjo1 3001:
3002: returns list of all source copyrights
3003:
3004: =cut
3005:
3006: sub source_copyrightids {
3007: return sort(keys(%scprtag));
3008: }
3009:
3010: =pod
3011:
1.648 raeburn 3012: =item * &source_copyrightdescription()
1.192 taceyjo1 3013:
3014: returns description of a specified source copyright id
3015:
3016: =cut
3017:
3018: sub source_copyrightdescription {
3019: return &mt($scprtag{shift(@_)});
3020: }
1.112 bowersj2 3021:
3022: =pod
3023:
1.648 raeburn 3024: =item * &filecategories()
1.112 bowersj2 3025:
3026: returns list of all file categories
3027:
3028: =cut
3029:
3030: sub filecategories {
3031: return sort(keys(%category_extensions));
3032: }
3033:
3034: =pod
3035:
1.648 raeburn 3036: =item * &filecategorytypes()
1.112 bowersj2 3037:
3038: returns list of file types belonging to a given file
3039: category
3040:
3041: =cut
3042:
3043: sub filecategorytypes {
1.356 albertel 3044: my ($cat) = @_;
3045: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3046: }
3047:
3048: =pod
3049:
1.648 raeburn 3050: =item * &fileembstyle()
1.112 bowersj2 3051:
3052: returns embedding style for a specified file type
3053:
3054: =cut
3055:
3056: sub fileembstyle {
3057: return $fe{lc(shift(@_))};
1.169 www 3058: }
3059:
1.351 www 3060: sub filemimetype {
3061: return $fm{lc(shift(@_))};
3062: }
3063:
1.169 www 3064:
3065: sub filecategoryselect {
3066: my ($name,$value)=@_;
1.189 matthew 3067: return &select_form($value,$name,
1.169 www 3068: '' => &mt('Any category'),
3069: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 3070: }
3071:
3072: =pod
3073:
1.648 raeburn 3074: =item * &filedescription()
1.112 bowersj2 3075:
3076: returns description for a specified file type
3077:
3078: =cut
3079:
3080: sub filedescription {
1.188 matthew 3081: my $file_description = $fd{lc(shift())};
3082: $file_description =~ s:([\[\]]):~$1:g;
3083: return &mt($file_description);
1.112 bowersj2 3084: }
3085:
3086: =pod
3087:
1.648 raeburn 3088: =item * &filedescriptionex()
1.112 bowersj2 3089:
3090: returns description for a specified file type with
3091: extra formatting
3092:
3093: =cut
3094:
3095: sub filedescriptionex {
3096: my $ex=shift;
1.188 matthew 3097: my $file_description = $fd{lc($ex)};
3098: $file_description =~ s:([\[\]]):~$1:g;
3099: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3100: }
3101:
3102: # End of .tab access
3103: =pod
3104:
3105: =back
3106:
3107: =cut
3108:
3109: # ------------------------------------------------------------------ File Types
3110: sub fileextensions {
3111: return sort(keys(%fe));
3112: }
3113:
1.97 www 3114: # ----------------------------------------------------------- Display Languages
3115: # returns a hash with all desired display languages
3116: #
3117:
3118: sub display_languages {
3119: my %languages=();
1.695 raeburn 3120: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3121: $languages{$lang}=1;
1.97 www 3122: }
3123: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3124: if ($env{'form.displaylanguage'}) {
1.356 albertel 3125: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3126: $languages{$lang}=1;
1.97 www 3127: }
3128: }
3129: return %languages;
1.14 harris41 3130: }
3131:
1.582 albertel 3132: sub languages {
3133: my ($possible_langs) = @_;
1.695 raeburn 3134: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3135: if (!ref($possible_langs)) {
3136: if( wantarray ) {
3137: return @preferred_langs;
3138: } else {
3139: return $preferred_langs[0];
3140: }
3141: }
3142: my %possibilities = map { $_ => 1 } (@$possible_langs);
3143: my @preferred_possibilities;
3144: foreach my $preferred_lang (@preferred_langs) {
3145: if (exists($possibilities{$preferred_lang})) {
3146: push(@preferred_possibilities, $preferred_lang);
3147: }
3148: }
3149: if( wantarray ) {
3150: return @preferred_possibilities;
3151: }
3152: return $preferred_possibilities[0];
3153: }
3154:
1.742 raeburn 3155: sub user_lang {
3156: my ($touname,$toudom,$fromcid) = @_;
3157: my @userlangs;
3158: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3159: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3160: $env{'course.'.$fromcid.'.languages'}));
3161: } else {
3162: my %langhash = &getlangs($touname,$toudom);
3163: if ($langhash{'languages'} ne '') {
3164: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3165: } else {
3166: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3167: if ($domdefs{'lang_def'} ne '') {
3168: @userlangs = ($domdefs{'lang_def'});
3169: }
3170: }
3171: }
3172: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3173: my $user_lh = Apache::localize->get_handle(@languages);
3174: return $user_lh;
3175: }
3176:
3177:
1.112 bowersj2 3178: ###############################################################
3179: ## Student Answer Attempts ##
3180: ###############################################################
3181:
3182: =pod
3183:
3184: =head1 Alternate Problem Views
3185:
3186: =over 4
3187:
1.648 raeburn 3188: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3189: $getattempt, $regexp, $gradesub)
3190:
3191: Return string with previous attempt on problem. Arguments:
3192:
3193: =over 4
3194:
3195: =item * $symb: Problem, including path
3196:
3197: =item * $username: username of the desired student
3198:
3199: =item * $domain: domain of the desired student
1.14 harris41 3200:
1.112 bowersj2 3201: =item * $course: Course ID
1.14 harris41 3202:
1.112 bowersj2 3203: =item * $getattempt: Leave blank for all attempts, otherwise put
3204: something
1.14 harris41 3205:
1.112 bowersj2 3206: =item * $regexp: if string matches this regexp, the string will be
3207: sent to $gradesub
1.14 harris41 3208:
1.112 bowersj2 3209: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3210:
1.112 bowersj2 3211: =back
1.14 harris41 3212:
1.112 bowersj2 3213: The output string is a table containing all desired attempts, if any.
1.16 harris41 3214:
1.112 bowersj2 3215: =cut
1.1 albertel 3216:
3217: sub get_previous_attempt {
1.43 ng 3218: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3219: my $prevattempts='';
1.43 ng 3220: no strict 'refs';
1.1 albertel 3221: if ($symb) {
1.3 albertel 3222: my (%returnhash)=
3223: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3224: if ($returnhash{'version'}) {
3225: my %lasthash=();
3226: my $version;
3227: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3228: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3229: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3230: }
1.1 albertel 3231: }
1.596 albertel 3232: $prevattempts=&start_data_table().&start_data_table_header_row();
3233: $prevattempts.='<th>'.&mt('History').'</th>';
1.356 albertel 3234: foreach my $key (sort(keys(%lasthash))) {
3235: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3236: if ($#parts > 0) {
1.31 albertel 3237: my $data=$parts[-1];
3238: pop(@parts);
1.596 albertel 3239: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.31 albertel 3240: } else {
1.41 ng 3241: if ($#parts == 0) {
3242: $prevattempts.='<th>'.$parts[0].'</th>';
3243: } else {
3244: $prevattempts.='<th>'.$ign.'</th>';
3245: }
1.31 albertel 3246: }
1.16 harris41 3247: }
1.596 albertel 3248: $prevattempts.=&end_data_table_header_row();
1.40 ng 3249: if ($getattempt eq '') {
3250: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596 albertel 3251: $prevattempts.=&start_data_table_row().
3252: '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356 albertel 3253: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3254: my $value = &format_previous_attempt_value($key,
3255: $returnhash{$version.':'.$key});
3256: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 3257: }
1.596 albertel 3258: $prevattempts.=&end_data_table_row();
1.40 ng 3259: }
1.1 albertel 3260: }
1.596 albertel 3261: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3262: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3263: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 3264: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 3265: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 3266: }
1.596 albertel 3267: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3268: } else {
1.596 albertel 3269: $prevattempts=
3270: &start_data_table().&start_data_table_row().
3271: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3272: &end_data_table_row().&end_data_table();
1.1 albertel 3273: }
3274: } else {
1.596 albertel 3275: $prevattempts=
3276: &start_data_table().&start_data_table_row().
3277: '<td>'.&mt('No data.').'</td>'.
3278: &end_data_table_row().&end_data_table();
1.1 albertel 3279: }
1.10 albertel 3280: }
3281:
1.581 albertel 3282: sub format_previous_attempt_value {
3283: my ($key,$value) = @_;
3284: if ($key =~ /timestamp/) {
3285: $value = &Apache::lonlocal::locallocaltime($value);
3286: } elsif (ref($value) eq 'ARRAY') {
3287: $value = '('.join(', ', @{ $value }).')';
3288: } else {
3289: $value = &unescape($value);
3290: }
3291: return $value;
3292: }
3293:
3294:
1.107 albertel 3295: sub relative_to_absolute {
3296: my ($url,$output)=@_;
3297: my $parser=HTML::TokeParser->new(\$output);
3298: my $token;
3299: my $thisdir=$url;
3300: my @rlinks=();
3301: while ($token=$parser->get_token) {
3302: if ($token->[0] eq 'S') {
3303: if ($token->[1] eq 'a') {
3304: if ($token->[2]->{'href'}) {
3305: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3306: }
3307: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3308: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3309: } elsif ($token->[1] eq 'base') {
3310: $thisdir=$token->[2]->{'href'};
3311: }
3312: }
3313: }
3314: $thisdir=~s-/[^/]*$--;
1.356 albertel 3315: foreach my $link (@rlinks) {
1.726 raeburn 3316: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3317: ($link=~/^\//) ||
3318: ($link=~/^javascript:/i) ||
3319: ($link=~/^mailto:/i) ||
3320: ($link=~/^\#/)) {
3321: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3322: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3323: }
3324: }
3325: # -------------------------------------------------- Deal with Applet codebases
3326: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3327: return $output;
3328: }
3329:
1.112 bowersj2 3330: =pod
3331:
1.648 raeburn 3332: =item * &get_student_view()
1.112 bowersj2 3333:
3334: show a snapshot of what student was looking at
3335:
3336: =cut
3337:
1.10 albertel 3338: sub get_student_view {
1.186 albertel 3339: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3340: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3341: my (%form);
1.10 albertel 3342: my @elements=('symb','courseid','domain','username');
3343: foreach my $element (@elements) {
1.186 albertel 3344: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3345: }
1.186 albertel 3346: if (defined($moreenv)) {
3347: %form=(%form,%{$moreenv});
3348: }
1.236 albertel 3349: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3350: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3351: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3352: $userview=~s/\<body[^\>]*\>//gi;
3353: $userview=~s/\<\/body\>//gi;
3354: $userview=~s/\<html\>//gi;
3355: $userview=~s/\<\/html\>//gi;
3356: $userview=~s/\<head\>//gi;
3357: $userview=~s/\<\/head\>//gi;
3358: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3359: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3360: if (wantarray) {
3361: return ($userview,$response);
3362: } else {
3363: return $userview;
3364: }
3365: }
3366:
3367: sub get_student_view_with_retries {
3368: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3369:
3370: my $ok = 0; # True if we got a good response.
3371: my $content;
3372: my $response;
3373:
3374: # Try to get the student_view done. within the retries count:
3375:
3376: do {
3377: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3378: $ok = $response->is_success;
3379: if (!$ok) {
3380: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3381: }
3382: $retries--;
3383: } while (!$ok && ($retries > 0));
3384:
3385: if (!$ok) {
3386: $content = ''; # On error return an empty content.
3387: }
1.651 www 3388: if (wantarray) {
3389: return ($content, $response);
3390: } else {
3391: return $content;
3392: }
1.11 albertel 3393: }
3394:
1.112 bowersj2 3395: =pod
3396:
1.648 raeburn 3397: =item * &get_student_answers()
1.112 bowersj2 3398:
3399: show a snapshot of how student was answering problem
3400:
3401: =cut
3402:
1.11 albertel 3403: sub get_student_answers {
1.100 sakharuk 3404: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3405: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3406: my (%moreenv);
1.11 albertel 3407: my @elements=('symb','courseid','domain','username');
3408: foreach my $element (@elements) {
1.186 albertel 3409: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3410: }
1.186 albertel 3411: $moreenv{'grade_target'}='answer';
3412: %moreenv=(%form,%moreenv);
1.497 raeburn 3413: $feedurl = &Apache::lonnet::clutter($feedurl);
3414: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3415: return $userview;
1.1 albertel 3416: }
1.116 albertel 3417:
3418: =pod
3419:
3420: =item * &submlink()
3421:
1.242 albertel 3422: Inputs: $text $uname $udom $symb $target
1.116 albertel 3423:
3424: Returns: A link to grades.pm such as to see the SUBM view of a student
3425:
3426: =cut
3427:
3428: ###############################################
3429: sub submlink {
1.242 albertel 3430: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3431: if (!($uname && $udom)) {
3432: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3433: &Apache::lonnet::whichuser($symb);
1.116 albertel 3434: if (!$symb) { $symb=$cursymb; }
3435: }
1.254 matthew 3436: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3437: $symb=&escape($symb);
1.242 albertel 3438: if ($target) { $target="target=\"$target\""; }
3439: return '<a href="/adm/grades?&command=submission&'.
3440: 'symb='.$symb.'&student='.$uname.
3441: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3442: }
3443: ##############################################
3444:
3445: =pod
3446:
3447: =item * &pgrdlink()
3448:
3449: Inputs: $text $uname $udom $symb $target
3450:
3451: Returns: A link to grades.pm such as to see the PGRD view of a student
3452:
3453: =cut
3454:
3455: ###############################################
3456: sub pgrdlink {
3457: my $link=&submlink(@_);
3458: $link=~s/(&command=submission)/$1&showgrading=yes/;
3459: return $link;
3460: }
3461: ##############################################
3462:
3463: =pod
3464:
3465: =item * &pprmlink()
3466:
3467: Inputs: $text $uname $udom $symb $target
3468:
3469: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3470: student and a specific resource
1.242 albertel 3471:
3472: =cut
3473:
3474: ###############################################
3475: sub pprmlink {
3476: my ($text,$uname,$udom,$symb,$target)=@_;
3477: if (!($uname && $udom)) {
3478: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3479: &Apache::lonnet::whichuser($symb);
1.242 albertel 3480: if (!$symb) { $symb=$cursymb; }
3481: }
1.254 matthew 3482: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3483: $symb=&escape($symb);
1.242 albertel 3484: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3485: return '<a href="/adm/parmset?command=set&'.
3486: 'symb='.$symb.'&uname='.$uname.
3487: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3488: }
3489: ##############################################
1.37 matthew 3490:
1.112 bowersj2 3491: =pod
3492:
3493: =back
3494:
3495: =cut
3496:
1.37 matthew 3497: ###############################################
1.51 www 3498:
3499:
3500: sub timehash {
1.687 raeburn 3501: my ($thistime) = @_;
3502: my $timezone = &Apache::lonlocal::gettimezone();
3503: my $dt = DateTime->from_epoch(epoch => $thistime)
3504: ->set_time_zone($timezone);
3505: my $wday = $dt->day_of_week();
3506: if ($wday == 7) { $wday = 0; }
3507: return ( 'second' => $dt->second(),
3508: 'minute' => $dt->minute(),
3509: 'hour' => $dt->hour(),
3510: 'day' => $dt->day_of_month(),
3511: 'month' => $dt->month(),
3512: 'year' => $dt->year(),
3513: 'weekday' => $wday,
3514: 'dayyear' => $dt->day_of_year(),
3515: 'dlsav' => $dt->is_dst() );
1.51 www 3516: }
3517:
1.370 www 3518: sub utc_string {
3519: my ($date)=@_;
1.371 www 3520: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3521: }
3522:
1.51 www 3523: sub maketime {
3524: my %th=@_;
1.687 raeburn 3525: my ($epoch_time,$timezone,$dt);
3526: $timezone = &Apache::lonlocal::gettimezone();
3527: eval {
3528: $dt = DateTime->new( year => $th{'year'},
3529: month => $th{'month'},
3530: day => $th{'day'},
3531: hour => $th{'hour'},
3532: minute => $th{'minute'},
3533: second => $th{'second'},
3534: time_zone => $timezone,
3535: );
3536: };
3537: if (!$@) {
3538: $epoch_time = $dt->epoch;
3539: if ($epoch_time) {
3540: return $epoch_time;
3541: }
3542: }
1.51 www 3543: return POSIX::mktime(
3544: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3545: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3546: }
3547:
3548: #########################################
1.51 www 3549:
3550: sub findallcourses {
1.482 raeburn 3551: my ($roles,$uname,$udom) = @_;
1.355 albertel 3552: my %roles;
3553: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3554: my %courses;
1.51 www 3555: my $now=time;
1.482 raeburn 3556: if (!defined($uname)) {
3557: $uname = $env{'user.name'};
3558: }
3559: if (!defined($udom)) {
3560: $udom = $env{'user.domain'};
3561: }
3562: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3563: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3564: if (!%roles) {
3565: %roles = (
3566: cc => 1,
3567: in => 1,
3568: ep => 1,
3569: ta => 1,
3570: cr => 1,
3571: st => 1,
3572: );
3573: }
3574: foreach my $entry (keys(%roleshash)) {
3575: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3576: if ($trole =~ /^cr/) {
3577: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3578: } else {
3579: next if (!exists($roles{$trole}));
3580: }
3581: if ($tend) {
3582: next if ($tend < $now);
3583: }
3584: if ($tstart) {
3585: next if ($tstart > $now);
3586: }
3587: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3588: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3589: if ($secpart eq '') {
3590: ($cnum,$role) = split(/_/,$cnumpart);
3591: $sec = 'none';
3592: $realsec = '';
3593: } else {
3594: $cnum = $cnumpart;
3595: ($sec,$role) = split(/_/,$secpart);
3596: $realsec = $sec;
1.490 raeburn 3597: }
1.482 raeburn 3598: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3599: }
3600: } else {
3601: foreach my $key (keys(%env)) {
1.483 albertel 3602: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3603: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3604: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3605: next if ($role eq 'ca' || $role eq 'aa');
3606: next if (%roles && !exists($roles{$role}));
3607: my ($starttime,$endtime)=split(/\./,$env{$key});
3608: my $active=1;
3609: if ($starttime) {
3610: if ($now<$starttime) { $active=0; }
3611: }
3612: if ($endtime) {
3613: if ($now>$endtime) { $active=0; }
3614: }
3615: if ($active) {
3616: if ($sec eq '') {
3617: $sec = 'none';
3618: }
3619: $courses{$cdom.'_'.$cnum}{$sec} =
3620: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3621: }
3622: }
1.51 www 3623: }
3624: }
1.474 raeburn 3625: return %courses;
1.51 www 3626: }
1.37 matthew 3627:
1.54 www 3628: ###############################################
1.474 raeburn 3629:
3630: sub blockcheck {
1.482 raeburn 3631: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3632:
3633: if (!defined($udom)) {
3634: $udom = $env{'user.domain'};
3635: }
3636: if (!defined($uname)) {
3637: $uname = $env{'user.name'};
3638: }
3639:
3640: # If uname and udom are for a course, check for blocks in the course.
3641:
3642: if (&Apache::lonnet::is_course($udom,$uname)) {
3643: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3644: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3645: return ($startblock,$endblock);
3646: }
1.474 raeburn 3647:
1.502 raeburn 3648: my $startblock = 0;
3649: my $endblock = 0;
1.482 raeburn 3650: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3651:
1.490 raeburn 3652: # If uname is for a user, and activity is course-specific, i.e.,
3653: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3654:
1.490 raeburn 3655: if (($activity eq 'boards' || $activity eq 'chat' ||
3656: $activity eq 'groups') && ($env{'request.course.id'})) {
3657: foreach my $key (keys(%live_courses)) {
3658: if ($key ne $env{'request.course.id'}) {
3659: delete($live_courses{$key});
3660: }
3661: }
3662: }
3663:
3664: my $otheruser = 0;
3665: my %own_courses;
3666: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3667: # Resource belongs to user other than current user.
3668: $otheruser = 1;
3669: # Gather courses for current user
3670: %own_courses =
3671: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3672: }
3673:
3674: # Gather active course roles - course coordinator, instructor,
3675: # exam proctor, ta, student, or custom role.
1.474 raeburn 3676:
3677: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3678: my ($cdom,$cnum);
3679: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3680: $cdom = $env{'course.'.$course.'.domain'};
3681: $cnum = $env{'course.'.$course.'.num'};
3682: } else {
1.490 raeburn 3683: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3684: }
3685: my $no_ownblock = 0;
3686: my $no_userblock = 0;
1.533 raeburn 3687: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3688: # Check if current user has 'evb' priv for this
3689: if (defined($own_courses{$course})) {
3690: foreach my $sec (keys(%{$own_courses{$course}})) {
3691: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3692: if ($sec ne 'none') {
3693: $checkrole .= '/'.$sec;
3694: }
3695: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3696: $no_ownblock = 1;
3697: last;
3698: }
3699: }
3700: }
3701: # if they have 'evb' priv and are currently not playing student
3702: next if (($no_ownblock) &&
3703: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3704: }
1.474 raeburn 3705: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3706: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3707: if ($sec ne 'none') {
1.482 raeburn 3708: $checkrole .= '/'.$sec;
1.474 raeburn 3709: }
1.490 raeburn 3710: if ($otheruser) {
3711: # Resource belongs to user other than current user.
3712: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3713: my ($trole,$tdom,$tnum,$tsec);
3714: my $entry = $live_courses{$course}{$sec};
3715: if ($entry =~ /^cr/) {
3716: ($trole,$tdom,$tnum,$tsec) =
3717: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3718: } else {
3719: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3720: }
3721: my ($spec,$area,$trest,%allroles,%userroles);
3722: $area = '/'.$tdom.'/'.$tnum;
3723: $trest = $tnum;
3724: if ($tsec ne '') {
3725: $area .= '/'.$tsec;
3726: $trest .= '/'.$tsec;
3727: }
3728: $spec = $trole.'.'.$area;
3729: if ($trole =~ /^cr/) {
3730: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3731: $tdom,$spec,$trest,$area);
3732: } else {
3733: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3734: $tdom,$spec,$trest,$area);
3735: }
3736: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3737: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3738: if ($1) {
3739: $no_userblock = 1;
3740: last;
3741: }
3742: }
1.490 raeburn 3743: } else {
3744: # Resource belongs to current user
3745: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3746: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3747: $no_ownblock = 1;
3748: last;
3749: }
1.474 raeburn 3750: }
3751: }
3752: # if they have the evb priv and are currently not playing student
1.482 raeburn 3753: next if (($no_ownblock) &&
1.491 albertel 3754: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3755: next if ($no_userblock);
1.474 raeburn 3756:
1.490 raeburn 3757: # Retrieve blocking times and identity of blocker for course
3758: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3759:
3760: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3761: if (($start != 0) &&
3762: (($startblock == 0) || ($startblock > $start))) {
3763: $startblock = $start;
3764: }
3765: if (($end != 0) &&
3766: (($endblock == 0) || ($endblock < $end))) {
3767: $endblock = $end;
3768: }
1.490 raeburn 3769: }
3770: return ($startblock,$endblock);
3771: }
3772:
3773: sub get_blocks {
3774: my ($setters,$activity,$cdom,$cnum) = @_;
3775: my $startblock = 0;
3776: my $endblock = 0;
3777: my $course = $cdom.'_'.$cnum;
3778: $setters->{$course} = {};
3779: $setters->{$course}{'staff'} = [];
3780: $setters->{$course}{'times'} = [];
3781: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3782: foreach my $record (keys(%records)) {
3783: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3784: if ($start <= time && $end >= time) {
3785: my ($staff_name,$staff_dom,$title,$blocks) =
3786: &parse_block_record($records{$record});
3787: if ($blocks->{$activity} eq 'on') {
3788: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3789: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3790: if ( ($startblock == 0) || ($startblock > $start) ) {
3791: $startblock = $start;
1.490 raeburn 3792: }
1.491 albertel 3793: if ( ($endblock == 0) || ($endblock < $end) ) {
3794: $endblock = $end;
1.474 raeburn 3795: }
3796: }
3797: }
3798: }
3799: return ($startblock,$endblock);
3800: }
3801:
3802: sub parse_block_record {
3803: my ($record) = @_;
3804: my ($setuname,$setudom,$title,$blocks);
3805: if (ref($record) eq 'HASH') {
3806: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3807: $title = &unescape($record->{'event'});
3808: $blocks = $record->{'blocks'};
3809: } else {
3810: my @data = split(/:/,$record,3);
3811: if (scalar(@data) eq 2) {
3812: $title = $data[1];
3813: ($setuname,$setudom) = split(/@/,$data[0]);
3814: } else {
3815: ($setuname,$setudom,$title) = @data;
3816: }
3817: $blocks = { 'com' => 'on' };
3818: }
3819: return ($setuname,$setudom,$title,$blocks);
3820: }
3821:
3822: sub build_block_table {
3823: my ($startblock,$endblock,$setters) = @_;
3824: my %lt = &Apache::lonlocal::texthash(
3825: 'cacb' => 'Currently active communication blocks',
3826: 'cour' => 'Course',
3827: 'dura' => 'Duration',
3828: 'blse' => 'Block set by'
3829: );
3830: my $output;
1.476 raeburn 3831: $output = '<br />'.$lt{'cacb'}.':<br />';
1.474 raeburn 3832: $output .= &start_data_table();
3833: $output .= '
3834: <tr>
3835: <th>'.$lt{'cour'}.'</th>
3836: <th>'.$lt{'dura'}.'</th>
3837: <th>'.$lt{'blse'}.'</th>
3838: </tr>
3839: ';
3840: foreach my $course (keys(%{$setters})) {
3841: my %courseinfo=&Apache::lonnet::coursedescription($course);
3842: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
3843: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490 raeburn 3844: my $fullname = &plainname($uname,$udom);
3845: if (defined($env{'user.name'}) && defined($env{'user.domain'})
3846: && $env{'user.name'} ne 'public'
3847: && $env{'user.domain'} ne 'public') {
3848: $fullname = &aboutmewrapper($fullname,$uname,$udom);
3849: }
1.474 raeburn 3850: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
3851: $openblock = &Apache::lonlocal::locallocaltime($openblock);
3852: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
3853: $output .= &Apache::loncommon::start_data_table_row().
3854: '<td>'.$courseinfo{'description'}.'</td>'.
3855: '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490 raeburn 3856: '<td>'.$fullname.'</td>'.
1.474 raeburn 3857: &Apache::loncommon::end_data_table_row();
3858: }
3859: }
3860: $output .= &end_data_table();
3861: }
3862:
1.490 raeburn 3863: sub blocking_status {
3864: my ($activity,$uname,$udom) = @_;
3865: my %setters;
3866: my ($blocked,$output,$ownitem,$is_course);
3867: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
3868: if ($startblock && $endblock) {
3869: $blocked = 1;
3870: if (wantarray) {
3871: my $category;
3872: if ($activity eq 'boards') {
3873: $category = 'Discussion posts in this course';
3874: } elsif ($activity eq 'blogs') {
3875: $category = 'Blogs';
3876: } elsif ($activity eq 'port') {
3877: if (defined($uname) && defined($udom)) {
3878: if ($uname eq $env{'user.name'} &&
3879: $udom eq $env{'user.domain'}) {
3880: $ownitem = 1;
3881: }
3882: }
3883: $is_course = &Apache::lonnet::is_course($udom,$uname);
3884: if ($ownitem) {
3885: $category = 'Your portfolio files';
3886: } elsif ($is_course) {
3887: my $coursedesc;
3888: foreach my $course (keys(%setters)) {
3889: my %courseinfo =
3890: &Apache::lonnet::coursedescription($course);
3891: $coursedesc = $courseinfo{'description'};
3892: }
1.764 weissno 3893: $category = "Group portfolio in the course '$coursedesc'";
1.490 raeburn 3894: } else {
3895: $category = 'Portfolio files belonging to ';
3896: if ($env{'user.name'} eq 'public' &&
3897: $env{'user.domain'} eq 'public') {
3898: $category .= &plainname($uname,$udom);
3899: } else {
3900: $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);
3901: }
3902: }
3903: } elsif ($activity eq 'groups') {
3904: $category = 'Groups in this course';
3905: }
3906: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
3907: my $showend = &Apache::lonlocal::locallocaltime($endblock);
3908: $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
3909: if (!($activity eq 'port' && !($ownitem) && !($is_course))) {
3910: $output .= &build_block_table($startblock,$endblock,\%setters);
3911: }
3912: }
3913: }
3914: if (wantarray) {
3915: return ($blocked,$output);
3916: } else {
3917: return $blocked;
3918: }
3919: }
3920:
1.60 matthew 3921: ###############################################
3922:
1.682 raeburn 3923: sub check_ip_acc {
3924: my ($acc)=@_;
3925: &Apache::lonxml::debug("acc is $acc");
3926: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
3927: return 1;
3928: }
3929: my $allowed=0;
3930: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
3931:
3932: my $name;
3933: foreach my $pattern (split(',',$acc)) {
3934: $pattern =~ s/^\s*//;
3935: $pattern =~ s/\s*$//;
3936: if ($pattern =~ /\*$/) {
3937: #35.8.*
3938: $pattern=~s/\*//;
3939: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3940: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
3941: #35.8.3.[34-56]
3942: my $low=$2;
3943: my $high=$3;
3944: $pattern=$1;
3945: if ($ip =~ /^\Q$pattern\E/) {
3946: my $last=(split(/\./,$ip))[3];
3947: if ($last <=$high && $last >=$low) { $allowed=1; }
3948: }
3949: } elsif ($pattern =~ /^\*/) {
3950: #*.msu.edu
3951: $pattern=~s/\*//;
3952: if (!defined($name)) {
3953: use Socket;
3954: my $netaddr=inet_aton($ip);
3955: ($name)=gethostbyaddr($netaddr,AF_INET);
3956: }
3957: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3958: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
3959: #127.0.0.1
3960: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3961: } else {
3962: #some.name.com
3963: if (!defined($name)) {
3964: use Socket;
3965: my $netaddr=inet_aton($ip);
3966: ($name)=gethostbyaddr($netaddr,AF_INET);
3967: }
3968: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3969: }
3970: if ($allowed) { last; }
3971: }
3972: return $allowed;
3973: }
3974:
3975: ###############################################
3976:
1.60 matthew 3977: =pod
3978:
1.112 bowersj2 3979: =head1 Domain Template Functions
3980:
3981: =over 4
3982:
3983: =item * &determinedomain()
1.60 matthew 3984:
3985: Inputs: $domain (usually will be undef)
3986:
1.63 www 3987: Returns: Determines which domain should be used for designs
1.60 matthew 3988:
3989: =cut
1.54 www 3990:
1.60 matthew 3991: ###############################################
1.63 www 3992: sub determinedomain {
3993: my $domain=shift;
1.531 albertel 3994: if (! $domain) {
1.60 matthew 3995: # Determine domain if we have not been given one
3996: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258 albertel 3997: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
3998: if ($env{'request.role.domain'}) {
3999: $domain=$env{'request.role.domain'};
1.60 matthew 4000: }
4001: }
1.63 www 4002: return $domain;
4003: }
4004: ###############################################
1.517 raeburn 4005:
1.518 albertel 4006: sub devalidate_domconfig_cache {
4007: my ($udom)=@_;
4008: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4009: }
4010:
4011: # ---------------------- Get domain configuration for a domain
4012: sub get_domainconf {
4013: my ($udom) = @_;
4014: my $cachetime=1800;
4015: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4016: if (defined($cached)) { return %{$result}; }
4017:
4018: my %domconfig = &Apache::lonnet::get_dom('configuration',
4019: ['login','rolecolors'],$udom);
1.632 raeburn 4020: my (%designhash,%legacy);
1.518 albertel 4021: if (keys(%domconfig) > 0) {
4022: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4023: if (keys(%{$domconfig{'login'}})) {
4024: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4025: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
4026: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4027: $designhash{$udom.'.login.'.$key.'_'.$img} =
4028: $domconfig{'login'}{$key}{$img};
4029: }
4030: } else {
4031: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4032: }
1.632 raeburn 4033: }
4034: } else {
4035: $legacy{'login'} = 1;
1.518 albertel 4036: }
1.632 raeburn 4037: } else {
4038: $legacy{'login'} = 1;
1.518 albertel 4039: }
4040: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4041: if (keys(%{$domconfig{'rolecolors'}})) {
4042: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4043: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4044: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4045: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4046: }
1.518 albertel 4047: }
4048: }
1.632 raeburn 4049: } else {
4050: $legacy{'rolecolors'} = 1;
1.518 albertel 4051: }
1.632 raeburn 4052: } else {
4053: $legacy{'rolecolors'} = 1;
1.518 albertel 4054: }
1.632 raeburn 4055: if (keys(%legacy) > 0) {
4056: my %legacyhash = &get_legacy_domconf($udom);
4057: foreach my $item (keys(%legacyhash)) {
4058: if ($item =~ /^\Q$udom\E\.login/) {
4059: if ($legacy{'login'}) {
4060: $designhash{$item} = $legacyhash{$item};
4061: }
4062: } else {
4063: if ($legacy{'rolecolors'}) {
4064: $designhash{$item} = $legacyhash{$item};
4065: }
1.518 albertel 4066: }
4067: }
4068: }
1.632 raeburn 4069: } else {
4070: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4071: }
4072: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4073: $cachetime);
4074: return %designhash;
4075: }
4076:
1.632 raeburn 4077: sub get_legacy_domconf {
4078: my ($udom) = @_;
4079: my %legacyhash;
4080: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4081: my $designfile = $designdir.'/'.$udom.'.tab';
4082: if (-e $designfile) {
4083: if ( open (my $fh,"<$designfile") ) {
4084: while (my $line = <$fh>) {
4085: next if ($line =~ /^\#/);
4086: chomp($line);
4087: my ($key,$val)=(split(/\=/,$line));
4088: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4089: }
4090: close($fh);
4091: }
4092: }
4093: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4094: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4095: }
4096: return %legacyhash;
4097: }
4098:
1.63 www 4099: =pod
4100:
1.112 bowersj2 4101: =item * &domainlogo()
1.63 www 4102:
4103: Inputs: $domain (usually will be undef)
4104:
4105: Returns: A link to a domain logo, if the domain logo exists.
4106: If the domain logo does not exist, a description of the domain.
4107:
4108: =cut
1.112 bowersj2 4109:
1.63 www 4110: ###############################################
4111: sub domainlogo {
1.517 raeburn 4112: my $domain = &determinedomain(shift);
1.518 albertel 4113: my %designhash = &get_domainconf($domain);
1.517 raeburn 4114: # See if there is a logo
4115: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4116: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4117: if ($imgsrc =~ m{^/(adm|res)/}) {
4118: if ($imgsrc =~ m{^/res/}) {
4119: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4120: &Apache::lonnet::repcopy($local_name);
4121: }
4122: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4123: }
4124: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4125: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4126: return &Apache::lonnet::domain($domain,'description');
1.59 www 4127: } else {
1.60 matthew 4128: return '';
1.59 www 4129: }
4130: }
1.63 www 4131: ##############################################
4132:
4133: =pod
4134:
1.112 bowersj2 4135: =item * &designparm()
1.63 www 4136:
4137: Inputs: $which parameter; $domain (usually will be undef)
4138:
4139: Returns: value of designparamter $which
4140:
4141: =cut
1.112 bowersj2 4142:
1.397 albertel 4143:
1.400 albertel 4144: ##############################################
1.397 albertel 4145: sub designparm {
4146: my ($which,$domain)=@_;
1.258 albertel 4147: if ($env{'browser.blackwhite'} eq 'on') {
1.635 raeburn 4148: if ($which=~/\.(font|alink|vlink|link|textcol)$/) {
1.110 www 4149: return '#000000';
4150: }
1.635 raeburn 4151: if ($which=~/\.(pgbg|sidebg|bgcol)$/) {
1.110 www 4152: return '#FFFFFF';
4153: }
4154: if ($which=~/\.tabbg$/) {
4155: return '#CCCCCC';
4156: }
4157: }
1.397 albertel 4158: if (exists($env{'environment.color.'.$which})) {
1.258 albertel 4159: return $env{'environment.color.'.$which};
1.96 www 4160: }
1.63 www 4161: $domain=&determinedomain($domain);
1.518 albertel 4162: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4163: my $output;
1.517 raeburn 4164: if ($domdesign{$domain.'.'.$which} ne '') {
1.520 raeburn 4165: $output = $domdesign{$domain.'.'.$which};
1.63 www 4166: } else {
1.520 raeburn 4167: $output = $defaultdesign{$which};
4168: }
4169: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4170: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4171: if ($output =~ m{^/(adm|res)/}) {
4172: if ($output =~ m{^/res/}) {
4173: my $local_name = &Apache::lonnet::filelocation('',$output);
4174: &Apache::lonnet::repcopy($local_name);
4175: }
1.520 raeburn 4176: $output = &lonhttpdurl($output);
4177: }
1.63 www 4178: }
1.520 raeburn 4179: return $output;
1.63 www 4180: }
1.59 www 4181:
1.60 matthew 4182: ###############################################
4183: ###############################################
4184:
4185: =pod
4186:
1.112 bowersj2 4187: =back
4188:
1.549 albertel 4189: =head1 HTML Helpers
1.112 bowersj2 4190:
4191: =over 4
4192:
4193: =item * &bodytag()
1.60 matthew 4194:
4195: Returns a uniform header for LON-CAPA web pages.
4196:
4197: Inputs:
4198:
1.112 bowersj2 4199: =over 4
4200:
4201: =item * $title, A title to be displayed on the page.
4202:
4203: =item * $function, the current role (can be undef).
4204:
4205: =item * $addentries, extra parameters for the <body> tag.
4206:
4207: =item * $bodyonly, if defined, only return the <body> tag.
4208:
4209: =item * $domain, if defined, force a given domain.
4210:
4211: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4212: text interface only)
1.60 matthew 4213:
1.326 albertel 4214: =item * $customtitle, alternate text to use instead of $title
4215: in the title box that appears, this text
4216: is not auto translated like the $title is
1.309 albertel 4217:
1.814 bisitz 4218: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4219: navigational links
1.317 albertel 4220:
1.338 albertel 4221: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4222:
1.361 albertel 4223: =item * $no_inline_link, if true and in remote mode, don't show the
4224: 'Switch To Inline Menu' link
4225:
1.460 albertel 4226: =item * $args, optional argument valid values are
4227: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4228: inherit_jsmath -> when creating popup window in a page,
4229: should it have jsmath forced on by the
4230: current page
1.460 albertel 4231:
1.112 bowersj2 4232: =back
4233:
1.60 matthew 4234: Returns: A uniform header for LON-CAPA web pages.
4235: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4236: If $bodyonly is undef or zero, an html string containing a <body> tag and
4237: other decorations will be returned.
4238:
4239: =cut
4240:
1.54 www 4241: sub bodytag {
1.309 albertel 4242: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.816 ! bisitz 4243: $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339 albertel 4244:
1.460 albertel 4245: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4246:
1.183 matthew 4247: $function = &get_users_function() if (!$function);
1.339 albertel 4248: my $img = &designparm($function.'.img',$domain);
4249: my $font = &designparm($function.'.font',$domain);
4250: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4251:
1.803 bisitz 4252: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4253: 'bgcolor' => $pgbg,
1.339 albertel 4254: 'text' => $font,
4255: 'alink' => &designparm($function.'.alink',$domain),
4256: 'vlink' => &designparm($function.'.vlink',$domain),
4257: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4258: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4259:
1.63 www 4260: # role and realm
1.378 raeburn 4261: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4262: if ($role eq 'ca') {
1.479 albertel 4263: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4264: $realm = &plainname($rname,$rdom);
1.378 raeburn 4265: }
1.55 www 4266: # realm
1.258 albertel 4267: if ($env{'request.course.id'}) {
1.378 raeburn 4268: if ($env{'request.role'} !~ /^cr/) {
4269: $role = &Apache::lonnet::plaintext($role,&course_type());
4270: }
1.359 albertel 4271: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4272: } else {
4273: $role = &Apache::lonnet::plaintext($role);
1.54 www 4274: }
1.433 albertel 4275:
1.359 albertel 4276: if (!$realm) { $realm=' '; }
1.55 www 4277: # Set messages
1.60 matthew 4278: my $messages=&domainlogo($domain);
1.330 albertel 4279:
1.438 albertel 4280: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4281:
1.101 www 4282: # construct main body tag
1.359 albertel 4283: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4284: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4285:
1.530 albertel 4286: if ($bodyonly) {
1.60 matthew 4287: return $bodytag;
1.798 tempelho 4288: }
1.359 albertel 4289:
1.410 albertel 4290: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4291: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4292: undef($role);
1.434 albertel 4293: } else {
4294: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4295: }
1.359 albertel 4296:
4297: my $roleinfo=(<<ENDROLE);
4298: <td class="LC_title_bar_who">
4299: <div class="LC_title_bar_name">
1.410 albertel 4300: $name
1.361 albertel 4301:
1.359 albertel 4302: </div>
4303: <div class="LC_title_bar_role">
1.361 albertel 4304: $role
1.359 albertel 4305: </div>
4306: <div class="LC_title_bar_realm">
1.361 albertel 4307: $realm
1.359 albertel 4308: </div>
1.206 albertel 4309: </td>
4310: ENDROLE
1.235 raeburn 4311:
1.762 bisitz 4312: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4313: if ($customtitle) {
4314: $titleinfo = $customtitle;
4315: }
4316: #
4317: # Extra info if you are the DC
4318: my $dc_info = '';
4319: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4320: $env{'course.'.$env{'request.course.id'}.
4321: '.domain'}.'/'})) {
4322: my $cid = $env{'request.course.id'};
4323: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4324: $dc_info =~ s/\s+$//;
1.359 albertel 4325: $dc_info = '('.$dc_info.')';
4326: }
4327:
1.644 www 4328: if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359 albertel 4329: # No Remote
1.258 albertel 4330: if ($env{'request.state'} eq 'construct') {
1.359 albertel 4331: $forcereg=1;
4332: }
4333:
4334: if (!$customtitle && $env{'request.state'} eq 'construct') {
4335: # this is for resources; directories have customtitle, and crumbs
4336: # and select recent are created in lonpubdir.pm
1.229 albertel 4337: my ($uname,$thisdisfn)=
1.258 albertel 4338: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229 albertel 4339: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4340: $formaction=~s/\/+/\//g;
4341:
1.359 albertel 4342: my $parentpath = '';
4343: my $lastitem = '';
4344: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4345: $parentpath = $1;
4346: $lastitem = $2;
4347: } else {
4348: $lastitem = $thisdisfn;
4349: }
4350: $titleinfo =
1.640 bisitz 4351: &Apache::loncommon::help_open_menu('','',3,'Authoring')
4352: .'<b>'.&mt('Construction Space').'</b>: '
4353: .'<form name="dirs" method="post" action="'.$formaction
1.359 albertel 4354: .'" target="_top"><tt><b>'
1.705 tempelho 4355: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<span class=\"LC_fontsize_big\">$lastitem</span></b></tt><br />"
1.359 albertel 4356: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4357: .'</form>'
4358: .&Apache::lonmenu::constspaceform();
1.235 raeburn 4359: }
1.359 albertel 4360:
1.816 ! bisitz 4361: my $titletable = '<table id="LC_title_bar">'
! 4362: ."<tr><td> $titleinfo $dc_info</td>".$roleinfo
! 4363: .'</tr></table>';
! 4364:
1.814 bisitz 4365: if ($no_nav_bar) {
1.359 albertel 4366: $bodytag .= $titletable;
4367: } else {
1.813 bisitz 4368: $bodytag .= qq|<div id="LC_nav_bar">$name ($role)<br />
4369: <em>$realm</em> $dc_info</div>|;
1.359 albertel 4370: if ($env{'request.state'} eq 'construct') {
1.337 albertel 4371: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
4372: $titletable);
1.272 raeburn 4373: } else {
1.336 albertel 4374: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359 albertel 4375: $titletable;
1.272 raeburn 4376: }
1.235 raeburn 4377: }
4378: return $bodytag;
1.94 www 4379: }
1.95 www 4380:
1.93 www 4381: #
1.95 www 4382: # Top frame rendering, Remote is up
1.93 www 4383: #
1.359 albertel 4384:
1.517 raeburn 4385: my $imgsrc = $img;
4386: if ($img =~ /^\/adm/) {
1.575 albertel 4387: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4388: }
4389: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4390:
1.305 www 4391: # Explicit link to get inline menu
1.361 albertel 4392: my $menu= ($no_inline_link?''
4393: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245 matthew 4394: #
1.94 www 4395: return(<<ENDBODY);
1.60 matthew 4396: $bodytag
1.359 albertel 4397: <table id="LC_title_bar" class="LC_with_remote">
1.791 tempelho 4398: <tr><td>$upperleft</td>
4399: <td>$messages </td>
1.54 www 4400: </tr>
1.359 albertel 4401: <tr><td>$titleinfo $dc_info $menu</td>
4402: $roleinfo
1.368 albertel 4403: </tr>
1.356 albertel 4404: </table>
1.54 www 4405: ENDBODY
1.182 matthew 4406: }
4407:
1.330 albertel 4408: sub make_attr_string {
4409: my ($register,$attr_ref) = @_;
4410:
4411: if ($attr_ref && !ref($attr_ref)) {
4412: die("addentries Must be a hash ref ".
4413: join(':',caller(1))." ".
4414: join(':',caller(0))." ");
4415: }
4416:
4417: if ($register) {
1.339 albertel 4418: my ($on_load,$on_unload);
4419: foreach my $key (keys(%{$attr_ref})) {
4420: if (lc($key) eq 'onload') {
4421: $on_load.=$attr_ref->{$key}.';';
4422: delete($attr_ref->{$key});
4423:
4424: } elsif (lc($key) eq 'onunload') {
4425: $on_unload.=$attr_ref->{$key}.';';
4426: delete($attr_ref->{$key});
4427: }
4428: }
4429: $attr_ref->{'onload'} =
4430: &Apache::lonmenu::loadevents(). $on_load;
4431: $attr_ref->{'onunload'}=
4432: &Apache::lonmenu::unloadevents().$on_unload;
4433: }
4434:
4435: # Accessibility font enhance
4436: if ($env{'browser.fontenhance'} eq 'on') {
4437: my $style;
4438: foreach my $key (keys(%{$attr_ref})) {
4439: if (lc($key) eq 'style') {
4440: $style.=$attr_ref->{$key}.';';
4441: delete($attr_ref->{$key});
4442: }
4443: }
4444: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4445: }
1.339 albertel 4446:
4447: if ($env{'browser.blackwhite'} eq 'on') {
4448: delete($attr_ref->{'font'});
4449: delete($attr_ref->{'link'});
4450: delete($attr_ref->{'alink'});
4451: delete($attr_ref->{'vlink'});
4452: delete($attr_ref->{'bgcolor'});
4453: delete($attr_ref->{'background'});
4454: }
4455:
1.330 albertel 4456: my $attr_string;
4457: foreach my $attr (keys(%$attr_ref)) {
4458: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4459: }
4460: return $attr_string;
4461: }
4462:
4463:
1.182 matthew 4464: ###############################################
1.251 albertel 4465: ###############################################
4466:
4467: =pod
4468:
4469: =item * &endbodytag()
4470:
4471: Returns a uniform footer for LON-CAPA web pages.
4472:
1.635 raeburn 4473: Inputs: 1 - optional reference to an args hash
4474: If in the hash, key for noredirectlink has a value which evaluates to true,
4475: a 'Continue' link is not displayed if the page contains an
4476: internal redirect in the <head></head> section,
4477: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4478:
4479: =cut
4480:
4481: sub endbodytag {
1.635 raeburn 4482: my ($args) = @_;
1.251 albertel 4483: my $endbodytag='</body>';
1.269 albertel 4484: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4485: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4486: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4487: $endbodytag=
4488: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4489: &mt('Continue').'</a>'.
4490: $endbodytag;
4491: }
1.315 albertel 4492: }
1.251 albertel 4493: return $endbodytag;
4494: }
4495:
1.352 albertel 4496: =pod
4497:
4498: =item * &standard_css()
4499:
4500: Returns a style sheet
4501:
4502: Inputs: (all optional)
4503: domain -> force to color decorate a page for a specific
4504: domain
4505: function -> force usage of a specific rolish color scheme
4506: bgcolor -> override the default page bgcolor
4507:
4508: =cut
4509:
1.343 albertel 4510: sub standard_css {
1.345 albertel 4511: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4512: $function = &get_users_function() if (!$function);
4513: my $img = &designparm($function.'.img', $domain);
4514: my $tabbg = &designparm($function.'.tabbg', $domain);
4515: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4516: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4517: #second colour for later usage
1.345 albertel 4518: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4519: my $pgbg_or_bgcolor =
4520: $bgcolor ||
1.352 albertel 4521: &designparm($function.'.pgbg', $domain);
1.382 albertel 4522: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4523: my $alink = &designparm($function.'.alink', $domain);
4524: my $vlink = &designparm($function.'.vlink', $domain);
4525: my $link = &designparm($function.'.link', $domain);
4526:
1.704 muellerd 4527: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4528: my $bgcol = &designparm('login.bgcol',$domain);
4529: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4530:
1.602 albertel 4531: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4532: my $mono = 'monospace';
1.352 albertel 4533: my $data_table_head = $tabbg;
4534: my $data_table_light = '#EEEEEE';
1.470 banghart 4535: my $data_table_dark = '#DDDDDD';
4536: my $data_table_darker = '#CCCCCC';
1.349 albertel 4537: my $data_table_highlight = '#FFFF00';
1.352 albertel 4538: my $mail_new = '#FFBB77';
4539: my $mail_new_hover = '#DD9955';
4540: my $mail_read = '#BBBB77';
4541: my $mail_read_hover = '#999944';
4542: my $mail_replied = '#AAAA88';
4543: my $mail_replied_hover = '#888855';
4544: my $mail_other = '#99BBBB';
4545: my $mail_other_hover = '#669999';
1.391 albertel 4546: my $table_header = '#DDDDDD';
1.489 raeburn 4547: my $feedback_link_bg = '#BBBBBB';
1.701 harmsja 4548: my $lg_border_color = '#C8C8C8';
1.392 albertel 4549:
1.608 albertel 4550: my $border = ($env{'browser.type'} eq 'explorer' ||
1.803 bisitz 4551: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4552: : '0 3px 0 4px';
1.448 albertel 4553:
1.523 albertel 4554:
1.343 albertel 4555: return <<END;
1.795 www 4556: body {
4557: font-family: $sans;
4558: line-height:130%;
4559: font-size:0.83em;
4560: color:$font;
4561: }
4562:
4563: a:link, a:visited {
4564: font-size:100%;
4565: }
4566:
4567: a:focus {
4568: color: red;
4569: background: yellow
4570: }
1.698 harmsja 4571:
1.795 www 4572: form, .inline {
4573: display: inline;
4574: }
1.721 harmsja 4575:
1.795 www 4576: .LC_right {
4577: text-align:right;
4578: }
4579:
4580: .LC_middle {
4581: vertical-align:middle;
4582: }
1.721 harmsja 4583:
4584: /* just for tests */
1.754 droeschl 4585: .LC_400Box {width:400px; }
1.721 harmsja 4586: /* end */
4587:
1.778 bisitz 4588: .LC_filename {
4589: font-family: $mono;
4590: white-space:pre;
4591: }
4592:
4593: .LC_fileicon {
4594: border: none;
4595: height: 1.3em;
4596: vertical-align: text-bottom;
4597: margin-right: 0.3em;
4598: text-decoration:none;
4599: }
4600:
1.350 albertel 4601: .LC_error {
4602: color: red;
4603: font-size: larger;
4604: }
1.795 www 4605:
1.457 albertel 4606: .LC_warning,
4607: .LC_diff_removed {
1.733 bisitz 4608: color: red;
1.394 albertel 4609: }
1.532 albertel 4610:
4611: .LC_info,
1.457 albertel 4612: .LC_success,
4613: .LC_diff_added {
1.350 albertel 4614: color: green;
4615: }
1.795 www 4616:
1.802 bisitz 4617: div.LC_confirm_box {
4618: background-color: #FAFAFA;
4619: border: 1px solid $lg_border_color;
4620: margin-right: 0;
4621: padding: 5px;
4622: }
4623:
4624: div.LC_confirm_box .LC_error img,
4625: div.LC_confirm_box .LC_success img {
4626: vertical-align: middle;
4627: }
4628:
1.440 albertel 4629: .LC_icon {
1.771 droeschl 4630: border: none;
1.790 droeschl 4631: vertical-align: middle;
1.771 droeschl 4632: }
4633:
1.543 albertel 4634: .LC_docs_spacer {
4635: width: 25px;
4636: height: 1px;
1.771 droeschl 4637: border: none;
1.543 albertel 4638: }
1.346 albertel 4639:
1.532 albertel 4640: .LC_internal_info {
1.735 bisitz 4641: color: #999999;
1.532 albertel 4642: }
4643:
1.794 www 4644: .LC_discussion {
4645: background: $tabbg;
4646: border: 1px solid black;
4647: margin: 2px;
4648: }
4649:
4650: .LC_disc_action_links_bar {
4651: background: $tabbg;
4652: font-family: $sans;
1.803 bisitz 4653: border: none;
1.795 www 4654: margin: 4px;
1.794 www 4655: }
4656:
4657: .LC_disc_action_left {
4658: text-align: left;
4659: }
4660:
4661: .LC_disc_action_right {
4662: text-align: right;
4663: }
4664:
4665: .LC_disc_new_item {
4666: background: white;
4667: border: 2px solid red;
4668: margin: 2px;
4669: }
4670:
4671: .LC_disc_old_item {
4672: background: white;
4673: border: 1px solid black;
4674: margin: 2px;
4675: }
4676:
1.458 albertel 4677: table.LC_pastsubmission {
4678: border: 1px solid black;
4679: margin: 2px;
4680: }
4681:
1.795 www 4682: table#LC_top_nav,
4683: table#LC_menubuttons,
4684: table#LC_nav_location {
1.345 albertel 4685: width: 100%;
4686: background: $pgbg;
1.392 albertel 4687: border: 2px;
1.402 albertel 4688: border-collapse: separate;
1.803 bisitz 4689: padding: 0;
1.345 albertel 4690: }
1.392 albertel 4691:
1.801 tempelho 4692: table#LC_title_bar a {
4693: color: $fontmenu;
4694: }
1.808 droeschl 4695:
1.807 droeschl 4696: table#LC_title_bar {
4697: /*display: none;*/
4698: }
4699:
1.795 www 4700: table#LC_title_bar,
4701: table.LC_breadcrumbs,
1.393 albertel 4702: table#LC_title_bar.LC_with_remote {
1.359 albertel 4703: width: 100%;
1.392 albertel 4704: border-color: $pgbg;
4705: border-style: solid;
4706: border-width: $border;
1.379 albertel 4707: background: $pgbg;
1.801 tempelho 4708: color: $fontmenu;
1.379 albertel 4709: font-family: $sans;
1.392 albertel 4710: border-collapse: collapse;
1.803 bisitz 4711: padding: 0;
1.359 albertel 4712: }
1.795 www 4713:
1.409 albertel 4714: table.LC_docs_path {
4715: width: 100%;
4716: border: 0;
4717: background: $pgbg;
4718: font-family: $sans;
4719: border-collapse: collapse;
1.803 bisitz 4720: padding: 0;
1.409 albertel 4721: }
4722:
1.359 albertel 4723: table#LC_title_bar td {
4724: background: $tabbg;
4725: }
1.795 www 4726:
1.773 ehlerst 4727: table#LC_title_bar .LC_title_bar_who {
1.359 albertel 4728: background: $tabbg;
1.801 tempelho 4729: color: $fontmenu;
1.427 albertel 4730: font: small $sans;
1.359 albertel 4731: text-align: right;
1.803 bisitz 4732: margin: 0;
1.773 ehlerst 4733: }
1.795 www 4734:
1.773 ehlerst 4735: table#LC_title_bar .LC_title_bar_name {
1.803 bisitz 4736: margin: 0;
1.773 ehlerst 4737: }
1.795 www 4738:
1.773 ehlerst 4739: table#LC_title_bar .LC_title_bar_role {
1.803 bisitz 4740: margin: 0;
1.773 ehlerst 4741: }
1.795 www 4742:
1.775 bisitz 4743: table#LC_title_bar .LC_title_bar_realm {
1.803 bisitz 4744: margin: 0;
1.359 albertel 4745: }
1.795 www 4746:
1.469 banghart 4747: span.LC_metadata {
1.795 www 4748: font-family: $sans;
1.469 banghart 4749: }
1.359 albertel 4750:
1.706 harmsja 4751: table#LC_menubuttons img{
1.803 bisitz 4752: border: none;
1.346 albertel 4753: }
1.795 www 4754:
1.345 albertel 4755: table#LC_top_nav td {
4756: background: $tabbg;
1.803 bisitz 4757: border: none;
1.407 albertel 4758: font-size: small;
1.706 harmsja 4759: vertical-align:top;
4760: padding:2px 5px 2px 5px;
1.345 albertel 4761: }
1.795 www 4762:
4763: table#LC_top_nav td a,
4764: div#LC_top_nav a {
1.345 albertel 4765: color: $font;
4766: font-family: $sans;
4767: }
1.795 www 4768:
1.364 albertel 4769: table#LC_top_nav td.LC_top_nav_logo {
4770: background: $tabbg;
1.432 albertel 4771: text-align: left;
1.408 albertel 4772: white-space: nowrap;
1.432 albertel 4773: width: 31px;
1.408 albertel 4774: }
1.795 www 4775:
1.408 albertel 4776: table#LC_top_nav td.LC_top_nav_logo img {
1.803 bisitz 4777: border: none;
1.408 albertel 4778: vertical-align: bottom;
1.364 albertel 4779: }
1.795 www 4780:
1.777 tempelho 4781: table#LC_top_nav td.LC_top_nav_exit,
1.779 bisitz 4782: table#LC_top_nav td.LC_top_nav_help {
1.777 tempelho 4783: width: 2.0em;
4784: }
1.795 www 4785:
1.442 albertel 4786: table#LC_top_nav td.LC_top_nav_login {
4787: width: 4.0em;
4788: text-align: center;
4789: }
1.795 www 4790:
4791: table.LC_breadcrumbs td,
4792: table.LC_docs_path td {
1.357 albertel 4793: background: $tabbg;
1.801 tempelho 4794: color: $fontmenu;
1.357 albertel 4795: font-family: $sans;
1.358 albertel 4796: font-size: smaller;
1.357 albertel 4797: }
1.795 www 4798:
1.777 tempelho 4799: table.LC_breadcrumbs td.LC_breadcrumbs_component,
4800: table.LC_docs_path td.LC_docs_path_component {
1.779 bisitz 4801: background: $tabbg;
1.801 tempelho 4802: color: $fontmenu;
1.777 tempelho 4803: font-family: $sans;
1.779 bisitz 4804: font-size: larger;
4805: text-align: right;
1.777 tempelho 4806: }
1.795 www 4807:
1.383 albertel 4808: td.LC_table_cell_checkbox {
4809: text-align: center;
4810: }
1.795 www 4811:
1.779 bisitz 4812: table#LC_mainmenu td.LC_mainmenu_column {
4813: vertical-align: top;
1.777 tempelho 4814: }
1.522 albertel 4815:
1.795 www 4816: .LC_fontsize_small {
1.705 tempelho 4817: font-size: 70%;
4818: }
4819:
1.795 www 4820: .LC_fontsize_medium {
1.705 tempelho 4821: font-size: 85%;
4822: }
4823:
1.795 www 4824: .LC_fontsize_large {
1.705 tempelho 4825: font-size: 120%;
4826: }
4827:
1.346 albertel 4828: .LC_menubuttons_inline_text {
4829: color: $font;
4830: font-family: $sans;
1.698 harmsja 4831: font-size: 90%;
1.701 harmsja 4832: padding-left:3px;
1.346 albertel 4833: }
4834:
1.526 www 4835: .LC_menubuttons_link {
4836: text-decoration: none;
4837: }
1.795 www 4838:
1.522 albertel 4839: .LC_menubuttons_category {
1.521 www 4840: color: $font;
1.526 www 4841: background: $pgbg;
1.521 www 4842: font-family: $sans;
4843: font-size: larger;
4844: font-weight: bold;
4845: }
4846:
1.346 albertel 4847: td.LC_menubuttons_text {
1.779 bisitz 4848: color: $font;
1.346 albertel 4849: }
1.706 harmsja 4850:
1.346 albertel 4851: .LC_current_location {
4852: font-family: $sans;
4853: background: $tabbg;
4854: }
1.795 www 4855:
1.346 albertel 4856: .LC_new_mail {
4857: font-family: $sans;
1.634 www 4858: background: $tabbg;
1.346 albertel 4859: font-weight: bold;
4860: }
1.347 albertel 4861:
1.527 www 4862: .LC_preferences_labeltext {
4863: font-family: $sans;
4864: text-align: right;
4865: }
4866:
1.666 raeburn 4867: .LC_roleslog_note {
1.701 harmsja 4868: font-size: small;
1.666 raeburn 4869: }
4870:
1.715 raeburn 4871: .LC_mail_functions {
4872: font-weight: bold;
4873: }
4874:
1.795 www 4875: table.LC_data_table,
4876: table.LC_mail_list {
1.347 albertel 4877: border: 1px solid #000000;
1.402 albertel 4878: border-collapse: separate;
1.426 albertel 4879: border-spacing: 1px;
1.610 albertel 4880: background: $pgbg;
1.347 albertel 4881: }
1.795 www 4882:
1.422 albertel 4883: .LC_data_table_dense {
4884: font-size: small;
4885: }
1.795 www 4886:
1.507 raeburn 4887: table.LC_nested_outer {
4888: border: 1px solid #000000;
1.589 raeburn 4889: border-collapse: collapse;
1.803 bisitz 4890: border-spacing: 0;
1.507 raeburn 4891: width: 100%;
4892: }
1.795 www 4893:
1.507 raeburn 4894: table.LC_nested {
1.803 bisitz 4895: border: none;
1.589 raeburn 4896: border-collapse: collapse;
1.803 bisitz 4897: border-spacing: 0;
1.507 raeburn 4898: width: 100%;
4899: }
1.795 www 4900:
4901: table.LC_data_table tr th,
4902: table.LC_calendar tr th,
4903: table.LC_mail_list tr th,
1.523 albertel 4904: table.LC_prior_tries tr th {
1.349 albertel 4905: font-weight: bold;
4906: background-color: $data_table_head;
1.801 tempelho 4907: color:$fontmenu;
1.701 harmsja 4908: font-size:90%;
1.347 albertel 4909: }
1.795 www 4910:
1.711 raeburn 4911: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 4912: background-color: #CCCCCC;
1.711 raeburn 4913: font-weight: bold;
4914: text-align: left;
4915: }
1.795 www 4916:
1.779 bisitz 4917: table.LC_data_table tr.LC_odd_row > td,
1.809 bisitz 4918: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 4919: background-color: $data_table_light;
1.425 albertel 4920: padding: 2px;
1.347 albertel 4921: }
1.795 www 4922:
1.610 albertel 4923: table.LC_data_table tr.LC_even_row > td,
1.809 bisitz 4924: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 4925: background-color: $data_table_dark;
1.709 bisitz 4926: padding: 2px;
1.347 albertel 4927: }
1.795 www 4928:
1.425 albertel 4929: table.LC_data_table tr.LC_data_table_highlight td {
4930: background-color: $data_table_darker;
4931: }
1.795 www 4932:
1.639 raeburn 4933: table.LC_data_table tr td.LC_leftcol_header {
4934: background-color: $data_table_head;
4935: font-weight: bold;
4936: }
1.795 www 4937:
1.451 albertel 4938: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 4939: table.LC_nested tr.LC_empty_row td {
1.347 albertel 4940: background-color: #FFFFFF;
1.421 albertel 4941: font-weight: bold;
4942: font-style: italic;
4943: text-align: center;
4944: padding: 8px;
1.347 albertel 4945: }
1.795 www 4946:
1.507 raeburn 4947: table.LC_nested tr.LC_empty_row td {
1.465 albertel 4948: padding: 4ex
4949: }
1.795 www 4950:
1.507 raeburn 4951: table.LC_nested_outer tr th {
4952: font-weight: bold;
1.801 tempelho 4953: color:$fontmenu;
1.507 raeburn 4954: background-color: $data_table_head;
1.701 harmsja 4955: font-size: small;
1.507 raeburn 4956: border-bottom: 1px solid #000000;
4957: }
1.795 www 4958:
1.507 raeburn 4959: table.LC_nested_outer tr td.LC_subheader {
4960: background-color: $data_table_head;
4961: font-weight: bold;
4962: font-size: small;
4963: border-bottom: 1px solid #000000;
4964: text-align: right;
1.451 albertel 4965: }
1.795 www 4966:
1.507 raeburn 4967: table.LC_nested tr.LC_info_row td {
1.735 bisitz 4968: background-color: #CCCCCC;
1.451 albertel 4969: font-weight: bold;
4970: font-size: small;
1.507 raeburn 4971: text-align: center;
4972: }
1.795 www 4973:
1.589 raeburn 4974: table.LC_nested tr.LC_info_row td.LC_left_item,
4975: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 4976: text-align: left;
1.451 albertel 4977: }
1.795 www 4978:
1.507 raeburn 4979: table.LC_nested td {
1.735 bisitz 4980: background-color: #FFFFFF;
1.451 albertel 4981: font-size: small;
1.507 raeburn 4982: }
1.795 www 4983:
1.507 raeburn 4984: table.LC_nested_outer tr th.LC_right_item,
4985: table.LC_nested tr.LC_info_row td.LC_right_item,
4986: table.LC_nested tr.LC_odd_row td.LC_right_item,
4987: table.LC_nested tr td.LC_right_item {
1.451 albertel 4988: text-align: right;
4989: }
4990:
1.507 raeburn 4991: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 4992: background-color: #EEEEEE;
1.451 albertel 4993: }
4994:
1.473 raeburn 4995: table.LC_createuser {
4996: }
4997:
4998: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 4999: font-size: small;
1.473 raeburn 5000: }
5001:
5002: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5003: background-color: #CCCCCC;
1.473 raeburn 5004: font-weight: bold;
5005: text-align: center;
5006: }
5007:
1.349 albertel 5008: table.LC_calendar {
5009: border: 1px solid #000000;
5010: border-collapse: collapse;
5011: }
1.795 www 5012:
1.349 albertel 5013: table.LC_calendar_pickdate {
5014: font-size: xx-small;
5015: }
1.795 www 5016:
1.349 albertel 5017: table.LC_calendar tr td {
5018: border: 1px solid #000000;
5019: vertical-align: top;
5020: }
1.795 www 5021:
1.349 albertel 5022: table.LC_calendar tr td.LC_calendar_day_empty {
5023: background-color: $data_table_dark;
5024: }
1.795 www 5025:
1.779 bisitz 5026: table.LC_calendar tr td.LC_calendar_day_current {
5027: background-color: $data_table_highlight;
1.777 tempelho 5028: }
1.795 www 5029:
1.349 albertel 5030: table.LC_mail_list tr.LC_mail_new {
5031: background-color: $mail_new;
5032: }
1.795 www 5033:
1.349 albertel 5034: table.LC_mail_list tr.LC_mail_new:hover {
5035: background-color: $mail_new_hover;
5036: }
1.795 www 5037:
5038: table.LC_mail_list tr.LC_mail_even {
1.777 tempelho 5039: }
1.795 www 5040:
5041: table.LC_mail_list tr.LC_mail_odd {
1.777 tempelho 5042: }
1.795 www 5043:
1.349 albertel 5044: table.LC_mail_list tr.LC_mail_read {
5045: background-color: $mail_read;
5046: }
1.795 www 5047:
1.349 albertel 5048: table.LC_mail_list tr.LC_mail_read:hover {
5049: background-color: $mail_read_hover;
5050: }
1.795 www 5051:
1.349 albertel 5052: table.LC_mail_list tr.LC_mail_replied {
5053: background-color: $mail_replied;
5054: }
1.795 www 5055:
1.349 albertel 5056: table.LC_mail_list tr.LC_mail_replied:hover {
5057: background-color: $mail_replied_hover;
5058: }
1.795 www 5059:
1.349 albertel 5060: table.LC_mail_list tr.LC_mail_other {
5061: background-color: $mail_other;
5062: }
1.795 www 5063:
1.349 albertel 5064: table.LC_mail_list tr.LC_mail_other:hover {
5065: background-color: $mail_other_hover;
5066: }
1.494 raeburn 5067:
1.777 tempelho 5068: table.LC_data_table tr > td.LC_browser_file,
5069: table.LC_data_table tr > td.LC_browser_file_published {
1.389 albertel 5070: background: #CCFF88;
5071: }
1.795 www 5072:
1.777 tempelho 5073: table.LC_data_table tr > td.LC_browser_file_locked,
5074: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5075: background: #FFAA99;
1.387 albertel 5076: }
1.795 www 5077:
1.777 tempelho 5078: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.779 bisitz 5079: background: #AAAAAA;
5080: }
1.795 www 5081:
1.777 tempelho 5082: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5083: table.LC_data_table tr > td.LC_browser_file_metamodified {
5084: background: #FFFF77;
1.777 tempelho 5085: }
1.795 www 5086:
1.696 bisitz 5087: table.LC_data_table tr.LC_browser_folder > td {
1.389 albertel 5088: background: #CCCCFF;
1.387 albertel 5089: }
1.696 bisitz 5090:
1.707 bisitz 5091: table.LC_data_table tr > td.LC_roles_is {
5092: /* background: #77FF77; */
5093: }
1.795 www 5094:
1.707 bisitz 5095: table.LC_data_table tr > td.LC_roles_future {
5096: background: #FFFF77;
5097: }
1.795 www 5098:
1.707 bisitz 5099: table.LC_data_table tr > td.LC_roles_will {
5100: background: #FFAA77;
5101: }
1.795 www 5102:
1.707 bisitz 5103: table.LC_data_table tr > td.LC_roles_expired {
5104: background: #FF7777;
5105: }
1.795 www 5106:
1.707 bisitz 5107: table.LC_data_table tr > td.LC_roles_will_not {
5108: background: #AAFF77;
5109: }
1.795 www 5110:
1.707 bisitz 5111: table.LC_data_table tr > td.LC_roles_selected {
5112: background: #11CC55;
5113: }
5114:
1.388 albertel 5115: span.LC_current_location {
1.701 harmsja 5116: font-size:larger;
1.388 albertel 5117: background: $pgbg;
5118: }
1.387 albertel 5119:
1.395 albertel 5120: span.LC_parm_menu_item {
5121: font-size: larger;
5122: font-family: $sans;
5123: }
1.795 www 5124:
1.395 albertel 5125: span.LC_parm_scope_all {
5126: color: red;
5127: }
1.795 www 5128:
1.395 albertel 5129: span.LC_parm_scope_folder {
5130: color: green;
5131: }
1.795 www 5132:
1.395 albertel 5133: span.LC_parm_scope_resource {
5134: color: orange;
5135: }
1.795 www 5136:
1.395 albertel 5137: span.LC_parm_part {
5138: color: blue;
5139: }
1.795 www 5140:
1.395 albertel 5141: span.LC_parm_folder, span.LC_parm_symb {
5142: font-size: x-small;
5143: font-family: $mono;
5144: color: #AAAAAA;
5145: }
5146:
1.795 www 5147: td.LC_parm_overview_level_menu,
5148: td.LC_parm_overview_map_menu,
5149: td.LC_parm_overview_parm_selectors,
5150: td.LC_parm_overview_restrictions {
1.396 albertel 5151: border: 1px solid black;
5152: border-collapse: collapse;
5153: }
1.795 www 5154:
1.396 albertel 5155: table.LC_parm_overview_restrictions td {
5156: border-width: 1px 4px 1px 4px;
5157: border-style: solid;
5158: border-color: $pgbg;
5159: text-align: center;
5160: }
1.795 www 5161:
1.396 albertel 5162: table.LC_parm_overview_restrictions th {
5163: background: $tabbg;
5164: border-width: 1px 4px 1px 4px;
5165: border-style: solid;
5166: border-color: $pgbg;
5167: }
1.795 www 5168:
1.398 albertel 5169: table#LC_helpmenu {
1.803 bisitz 5170: border: none;
1.398 albertel 5171: height: 55px;
1.803 bisitz 5172: border-spacing: 0;
1.398 albertel 5173: }
5174:
5175: table#LC_helpmenu fieldset legend {
5176: font-size: larger;
5177: font-weight: bold;
5178: }
1.795 www 5179:
1.397 albertel 5180: table#LC_helpmenu_links {
5181: width: 100%;
5182: border: 1px solid black;
5183: background: $pgbg;
1.803 bisitz 5184: padding: 0;
1.397 albertel 5185: border-spacing: 1px;
5186: }
1.795 www 5187:
1.397 albertel 5188: table#LC_helpmenu_links tr td {
5189: padding: 1px;
5190: background: $tabbg;
1.399 albertel 5191: text-align: center;
5192: font-weight: bold;
1.397 albertel 5193: }
1.396 albertel 5194:
1.795 www 5195: table#LC_helpmenu_links a:link,
5196: table#LC_helpmenu_links a:visited,
1.397 albertel 5197: table#LC_helpmenu_links a:active {
5198: text-decoration: none;
5199: color: $font;
5200: }
1.795 www 5201:
1.397 albertel 5202: table#LC_helpmenu_links a:hover {
5203: text-decoration: underline;
5204: color: $vlink;
5205: }
1.396 albertel 5206:
1.417 albertel 5207: .LC_chrt_popup_exists {
5208: border: 1px solid #339933;
5209: margin: -1px;
5210: }
1.795 www 5211:
1.417 albertel 5212: .LC_chrt_popup_up {
5213: border: 1px solid yellow;
5214: margin: -1px;
5215: }
1.795 www 5216:
1.417 albertel 5217: .LC_chrt_popup {
5218: border: 1px solid #8888FF;
5219: background: #CCCCFF;
5220: }
1.795 www 5221:
1.421 albertel 5222: table.LC_pick_box {
5223: border-collapse: separate;
5224: background: white;
5225: border: 1px solid black;
5226: border-spacing: 1px;
5227: }
1.795 www 5228:
1.421 albertel 5229: table.LC_pick_box td.LC_pick_box_title {
5230: background: $tabbg;
5231: font-weight: bold;
5232: text-align: right;
1.740 bisitz 5233: vertical-align: top;
1.421 albertel 5234: width: 184px;
5235: padding: 8px;
5236: }
1.795 www 5237:
1.645 raeburn 5238: table.LC_pick_box td.LC_selfenroll_pick_box_title {
5239: background: $tabbg;
5240: font-weight: bold;
5241: text-align: right;
5242: width: 350px;
5243: padding: 8px;
5244: }
5245:
1.579 raeburn 5246: table.LC_pick_box td.LC_pick_box_value {
5247: text-align: left;
5248: padding: 8px;
5249: }
1.795 www 5250:
1.579 raeburn 5251: table.LC_pick_box td.LC_pick_box_select {
5252: text-align: left;
5253: padding: 8px;
5254: }
1.795 www 5255:
1.424 albertel 5256: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5257: padding: 0;
1.421 albertel 5258: height: 1px;
5259: background: black;
5260: }
1.795 www 5261:
1.421 albertel 5262: table.LC_pick_box td.LC_pick_box_submit {
5263: text-align: right;
5264: }
1.795 www 5265:
1.579 raeburn 5266: table.LC_pick_box td.LC_evenrow_value {
5267: text-align: left;
5268: padding: 8px;
5269: background-color: $data_table_light;
5270: }
1.795 www 5271:
1.579 raeburn 5272: table.LC_pick_box td.LC_oddrow_value {
5273: text-align: left;
5274: padding: 8px;
5275: background-color: $data_table_light;
5276: }
1.795 www 5277:
1.579 raeburn 5278: table.LC_helpform_receipt {
5279: width: 620px;
5280: border-collapse: separate;
5281: background: white;
5282: border: 1px solid black;
5283: border-spacing: 1px;
5284: }
1.795 www 5285:
1.579 raeburn 5286: table.LC_helpform_receipt td.LC_pick_box_title {
5287: background: $tabbg;
5288: font-weight: bold;
5289: text-align: right;
5290: width: 184px;
5291: padding: 8px;
5292: }
1.795 www 5293:
1.579 raeburn 5294: table.LC_helpform_receipt td.LC_evenrow_value {
5295: text-align: left;
5296: padding: 8px;
5297: background-color: $data_table_light;
5298: }
1.795 www 5299:
1.579 raeburn 5300: table.LC_helpform_receipt td.LC_oddrow_value {
5301: text-align: left;
5302: padding: 8px;
5303: background-color: $data_table_light;
5304: }
1.795 www 5305:
1.579 raeburn 5306: table.LC_helpform_receipt td.LC_pick_box_separator {
1.803 bisitz 5307: padding: 0;
1.579 raeburn 5308: height: 1px;
5309: background: black;
5310: }
1.795 www 5311:
1.579 raeburn 5312: span.LC_helpform_receipt_cat {
5313: font-weight: bold;
5314: }
1.795 www 5315:
1.424 albertel 5316: table.LC_group_priv_box {
5317: background: white;
5318: border: 1px solid black;
5319: border-spacing: 1px;
5320: }
1.795 www 5321:
1.424 albertel 5322: table.LC_group_priv_box td.LC_pick_box_title {
5323: background: $tabbg;
5324: font-weight: bold;
5325: text-align: right;
5326: width: 184px;
5327: }
1.795 www 5328:
1.424 albertel 5329: table.LC_group_priv_box td.LC_groups_fixed {
5330: background: $data_table_light;
5331: text-align: center;
5332: }
1.795 www 5333:
1.424 albertel 5334: table.LC_group_priv_box td.LC_groups_optional {
5335: background: $data_table_dark;
5336: text-align: center;
5337: }
1.795 www 5338:
1.424 albertel 5339: table.LC_group_priv_box td.LC_groups_functionality {
5340: background: $data_table_darker;
5341: text-align: center;
5342: font-weight: bold;
5343: }
1.795 www 5344:
1.424 albertel 5345: table.LC_group_priv td {
5346: text-align: left;
1.803 bisitz 5347: padding: 0;
1.424 albertel 5348: }
5349:
1.421 albertel 5350: table.LC_notify_front_page {
5351: background: white;
5352: border: 1px solid black;
5353: padding: 8px;
5354: }
1.795 www 5355:
1.421 albertel 5356: table.LC_notify_front_page td {
5357: padding: 8px;
5358: }
1.795 www 5359:
1.424 albertel 5360: .LC_navbuttons {
5361: margin: 2ex 0ex 2ex 0ex;
5362: }
1.795 www 5363:
1.423 albertel 5364: .LC_topic_bar {
5365: font-family: $sans;
5366: font-weight: bold;
5367: width: 100%;
5368: background: $tabbg;
5369: vertical-align: middle;
5370: margin: 2ex 0ex 2ex 0ex;
1.805 bisitz 5371: padding: 3px;
1.423 albertel 5372: }
1.795 www 5373:
1.423 albertel 5374: .LC_topic_bar span {
5375: vertical-align: middle;
5376: }
1.795 www 5377:
1.423 albertel 5378: .LC_topic_bar img {
5379: vertical-align: bottom;
5380: }
1.795 www 5381:
1.423 albertel 5382: table.LC_course_group_status {
5383: margin: 20px;
5384: }
1.795 www 5385:
1.423 albertel 5386: table.LC_status_selector td {
5387: vertical-align: top;
5388: text-align: center;
1.424 albertel 5389: padding: 4px;
5390: }
1.795 www 5391:
1.599 albertel 5392: div.LC_feedback_link {
1.616 albertel 5393: clear: both;
1.599 albertel 5394: background: white;
1.779 bisitz 5395: width: 100%;
1.489 raeburn 5396: }
1.795 www 5397:
1.489 raeburn 5398: span.LC_feedback_link {
1.599 albertel 5399: background: $feedback_link_bg;
5400: font-size: larger;
5401: }
1.795 www 5402:
1.599 albertel 5403: span.LC_message_link {
5404: background: $feedback_link_bg;
5405: font-size: larger;
5406: position: absolute;
5407: right: 1em;
1.489 raeburn 5408: }
1.421 albertel 5409:
1.515 albertel 5410: table.LC_prior_tries {
1.524 albertel 5411: border: 1px solid #000000;
5412: border-collapse: separate;
5413: border-spacing: 1px;
1.515 albertel 5414: }
1.523 albertel 5415:
1.515 albertel 5416: table.LC_prior_tries td {
1.524 albertel 5417: padding: 2px;
1.515 albertel 5418: }
1.523 albertel 5419:
5420: .LC_answer_correct {
1.795 www 5421: background: lightgreen;
5422: font-family: $sans;
5423: color: darkgreen;
5424: padding: 6px;
1.523 albertel 5425: }
1.795 www 5426:
1.523 albertel 5427: .LC_answer_charged_try {
1.797 www 5428: background: #FFAAAA;
1.795 www 5429: font-family: $sans;
5430: color: darkred;
5431: padding: 6px;
1.523 albertel 5432: }
1.795 www 5433:
1.779 bisitz 5434: .LC_answer_not_charged_try,
1.523 albertel 5435: .LC_answer_no_grade,
5436: .LC_answer_late {
1.795 www 5437: background: lightyellow;
5438: font-family: $sans;
1.523 albertel 5439: color: black;
1.795 www 5440: padding: 6px;
1.523 albertel 5441: }
1.795 www 5442:
1.523 albertel 5443: .LC_answer_previous {
1.795 www 5444: background: lightblue;
5445: font-family: $sans;
5446: color: darkblue;
5447: padding: 6px;
1.523 albertel 5448: }
1.795 www 5449:
1.779 bisitz 5450: .LC_answer_no_message {
1.777 tempelho 5451: background: #FFFFFF;
1.795 www 5452: font-family: $sans;
1.777 tempelho 5453: color: black;
1.795 www 5454: padding: 6px;
1.779 bisitz 5455: }
1.795 www 5456:
1.779 bisitz 5457: .LC_answer_unknown {
5458: background: orange;
1.795 www 5459: font-family: $sans;
1.779 bisitz 5460: color: black;
1.795 www 5461: padding: 6px;
1.777 tempelho 5462: }
1.795 www 5463:
1.529 albertel 5464: span.LC_prior_numerical,
5465: span.LC_prior_string,
5466: span.LC_prior_custom,
5467: span.LC_prior_reaction,
5468: span.LC_prior_math {
1.523 albertel 5469: font-family: monospace;
5470: white-space: pre;
5471: }
5472:
1.525 albertel 5473: span.LC_prior_string {
5474: font-family: monospace;
5475: white-space: pre;
5476: }
5477:
1.523 albertel 5478: table.LC_prior_option {
5479: width: 100%;
5480: border-collapse: collapse;
5481: }
1.795 www 5482:
5483: table.LC_prior_rank,
5484: table.LC_prior_match {
1.528 albertel 5485: border-collapse: collapse;
5486: }
1.795 www 5487:
1.528 albertel 5488: table.LC_prior_option tr td,
5489: table.LC_prior_rank tr td,
5490: table.LC_prior_match tr td {
1.524 albertel 5491: border: 1px solid #000000;
1.515 albertel 5492: }
5493:
1.770 droeschl 5494: td.LC_nobreak,
1.519 raeburn 5495: span.LC_nobreak {
1.544 albertel 5496: white-space: nowrap;
1.519 raeburn 5497: }
5498:
1.576 raeburn 5499: span.LC_cusr_emph {
5500: font-style: italic;
5501: }
5502:
1.633 raeburn 5503: span.LC_cusr_subheading {
5504: font-weight: normal;
5505: font-size: 85%;
5506: }
5507:
1.545 albertel 5508: table.LC_docs_documents {
5509: background: #BBBBBB;
1.803 bisitz 5510: border-width: 0;
1.545 albertel 5511: border-collapse: collapse;
5512: }
1.795 www 5513:
1.777 tempelho 5514: table.LC_docs_documents td.LC_docs_document {
1.779 bisitz 5515: border: 2px solid black;
5516: padding: 4px;
1.777 tempelho 5517: }
1.795 www 5518:
1.545 albertel 5519: .LC_docs_entry_move {
1.803 bisitz 5520: border: none;
1.545 albertel 5521: border-collapse: collapse;
1.544 albertel 5522: }
5523:
1.545 albertel 5524: .LC_docs_entry_move td {
5525: border: 2px solid #BBBBBB;
5526: background: #DDDDDD;
5527: }
5528:
5529: .LC_docs_editor td.LC_docs_entry_commands {
5530: background: #DDDDDD;
5531: font-size: x-small;
5532: }
1.795 www 5533:
1.544 albertel 5534: .LC_docs_copy {
1.545 albertel 5535: color: #000099;
1.544 albertel 5536: }
1.795 www 5537:
1.544 albertel 5538: .LC_docs_cut {
1.545 albertel 5539: color: #550044;
1.544 albertel 5540: }
1.795 www 5541:
1.544 albertel 5542: .LC_docs_rename {
1.545 albertel 5543: color: #009900;
1.544 albertel 5544: }
1.795 www 5545:
1.544 albertel 5546: .LC_docs_remove {
1.545 albertel 5547: color: #990000;
5548: }
5549:
1.547 albertel 5550: .LC_docs_reinit_warn,
5551: .LC_docs_ext_edit {
5552: font-size: x-small;
5553: }
5554:
1.545 albertel 5555: .LC_docs_editor td.LC_docs_entry_title,
5556: .LC_docs_editor td.LC_docs_entry_icon {
5557: background: #FFFFBB;
5558: }
1.795 www 5559:
1.545 albertel 5560: .LC_docs_editor td.LC_docs_entry_parameter {
5561: background: #BBBBFF;
5562: font-size: x-small;
5563: white-space: nowrap;
5564: }
5565:
5566: table.LC_docs_adddocs td,
5567: table.LC_docs_adddocs th {
5568: border: 1px solid #BBBBBB;
5569: padding: 4px;
5570: background: #DDDDDD;
1.543 albertel 5571: }
5572:
1.584 albertel 5573: table.LC_sty_begin {
5574: background: #BBFFBB;
5575: }
1.795 www 5576:
1.584 albertel 5577: table.LC_sty_end {
5578: background: #FFBBBB;
5579: }
5580:
1.589 raeburn 5581: table.LC_double_column {
1.803 bisitz 5582: border-width: 0;
1.589 raeburn 5583: border-collapse: collapse;
5584: width: 100%;
5585: padding: 2px;
5586: }
5587:
5588: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5589: top: 2px;
1.589 raeburn 5590: left: 2px;
5591: width: 47%;
5592: vertical-align: top;
5593: }
5594:
5595: table.LC_double_column tr td.LC_right_col {
5596: top: 2px;
1.779 bisitz 5597: right: 2px;
1.589 raeburn 5598: width: 47%;
5599: vertical-align: top;
5600: }
5601:
1.594 raeburn 5602: span.LC_role_level {
5603: font-weight: bold;
5604: }
5605:
1.591 raeburn 5606: div.LC_left_float {
5607: float: left;
5608: padding-right: 5%;
1.597 albertel 5609: padding-bottom: 4px;
1.591 raeburn 5610: }
5611:
5612: div.LC_clear_float_header {
1.597 albertel 5613: padding-bottom: 2px;
1.591 raeburn 5614: }
5615:
5616: div.LC_clear_float_footer {
1.597 albertel 5617: padding-top: 10px;
1.591 raeburn 5618: clear: both;
5619: }
5620:
1.597 albertel 5621: div.LC_grade_show_user {
5622: margin-top: 20px;
5623: border: 1px solid black;
5624: }
1.795 www 5625:
1.597 albertel 5626: div.LC_grade_user_name {
5627: background: #DDDDEE;
5628: border-bottom: 1px solid black;
1.705 tempelho 5629: font-weight: bold;
5630: font-size: large;
1.597 albertel 5631: }
1.795 www 5632:
1.597 albertel 5633: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5634: background: #DDEEDD;
5635: }
5636:
5637: div.LC_grade_show_problem,
5638: div.LC_grade_submissions,
5639: div.LC_grade_message_center,
5640: div.LC_grade_info_links,
5641: div.LC_grade_assign {
5642: margin: 5px;
5643: width: 99%;
5644: background: #FFFFFF;
5645: }
1.795 www 5646:
1.597 albertel 5647: div.LC_grade_show_problem_header,
5648: div.LC_grade_submissions_header,
5649: div.LC_grade_message_center_header,
5650: div.LC_grade_assign_header {
1.705 tempelho 5651: font-weight: bold;
5652: font-size: large;
1.597 albertel 5653: }
1.795 www 5654:
1.597 albertel 5655: div.LC_grade_show_problem_problem,
5656: div.LC_grade_submissions_body,
5657: div.LC_grade_message_center_body,
5658: div.LC_grade_assign_body {
5659: border: 1px solid black;
5660: width: 99%;
5661: background: #FFFFFF;
5662: }
1.795 www 5663:
1.598 albertel 5664: span.LC_grade_check_note {
1.705 tempelho 5665: font-weight: normal;
5666: font-size: medium;
1.598 albertel 5667: display: inline;
5668: position: absolute;
5669: right: 1em;
5670: }
1.597 albertel 5671:
1.613 albertel 5672: table.LC_scantron_action {
5673: width: 100%;
5674: }
1.795 www 5675:
1.613 albertel 5676: table.LC_scantron_action tr th {
1.698 harmsja 5677: font-weight:bold;
5678: font-style:normal;
1.613 albertel 5679: }
1.795 www 5680:
1.779 bisitz 5681: .LC_edit_problem_header,
1.614 albertel 5682: div.LC_edit_problem_footer {
1.705 tempelho 5683: font-weight: normal;
5684: font-size: medium;
1.602 albertel 5685: margin: 2px;
1.600 albertel 5686: }
1.795 www 5687:
1.600 albertel 5688: div.LC_edit_problem_header,
1.602 albertel 5689: div.LC_edit_problem_header div,
1.614 albertel 5690: div.LC_edit_problem_footer,
5691: div.LC_edit_problem_footer div,
1.602 albertel 5692: div.LC_edit_problem_editxml_header,
5693: div.LC_edit_problem_editxml_header div {
1.600 albertel 5694: margin-top: 5px;
5695: }
1.795 www 5696:
1.602 albertel 5697: div.LC_edit_problem_header_edit_row {
5698: background: $tabbg;
5699: padding: 3px;
5700: margin-bottom: 5px;
5701: }
1.795 www 5702:
1.600 albertel 5703: div.LC_edit_problem_header_title {
1.705 tempelho 5704: font-weight: bold;
5705: font-size: larger;
1.602 albertel 5706: background: $tabbg;
5707: padding: 3px;
5708: }
1.795 www 5709:
1.602 albertel 5710: table.LC_edit_problem_header_title {
1.705 tempelho 5711: font-size: larger;
5712: font-weight: bold;
1.602 albertel 5713: width: 100%;
5714: border-color: $pgbg;
5715: border-style: solid;
5716: border-width: $border;
1.600 albertel 5717: background: $tabbg;
1.602 albertel 5718: border-collapse: collapse;
1.803 bisitz 5719: padding: 0;
1.602 albertel 5720: }
5721:
5722: div.LC_edit_problem_discards {
5723: float: left;
5724: padding-bottom: 5px;
5725: }
1.795 www 5726:
1.602 albertel 5727: div.LC_edit_problem_saves {
5728: float: right;
5729: padding-bottom: 5px;
1.600 albertel 5730: }
1.795 www 5731:
1.600 albertel 5732: hr.LC_edit_problem_divide {
1.602 albertel 5733: clear: both;
1.600 albertel 5734: color: $tabbg;
5735: background-color: $tabbg;
5736: height: 3px;
1.803 bisitz 5737: border: none;
1.600 albertel 5738: }
1.795 www 5739:
1.679 riegler 5740: img.stift{
1.803 bisitz 5741: border-width: 0;
5742: vertical-align: middle;
1.677 riegler 5743: }
1.680 riegler 5744:
1.681 riegler 5745: table#LC_mainmenu{
5746: margin-top:10px;
5747: width:80%;
5748: }
5749:
1.680 riegler 5750: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
5751: vertical-align: top;
5752: width: 45%;
5753: }
1.795 www 5754:
1.779 bisitz 5755: .LC_mainmenu_fieldset_category {
5756: color: $font;
5757: background: $pgbg;
5758: font-family: $sans;
5759: font-size: small;
5760: font-weight: bold;
1.777 tempelho 5761: }
1.795 www 5762:
1.716 raeburn 5763: div.LC_createcourse {
5764: margin: 10px 10px 10px 10px;
5765: }
5766:
1.693 droeschl 5767: /* ---- Remove when done ----
5768: # The following styles is part of the redesign of LON-CAPA and are
5769: # subject to change during this project.
5770: # Don't rely on their current functionality as they might be
5771: # changed or removed.
5772: # --------------------------*/
5773:
1.698 harmsja 5774: a:hover,
1.721 harmsja 5775: ol.LC_smallMenu a:hover,
5776: ol#LC_MenuBreadcrumbs a:hover,
5777: ol#LC_PathBreadcrumbs a:hover,
5778: ul#LC_TabMainMenuContent a:hover,
5779: .LC_FormSectionClearButton input:hover
1.795 www 5780: ul.LC_TabContent li:hover a {
1.698 harmsja 5781: color:#BF2317;
5782: text-decoration:none;
1.693 droeschl 5783: }
5784:
1.779 bisitz 5785: h1 {
1.813 bisitz 5786: padding: 0;
1.693 droeschl 5787: line-height:130%;
5788: }
1.698 harmsja 5789:
1.795 www 5790: h2,h3,h4,h5,h6 {
1.803 bisitz 5791: margin: 5px 0 5px 0;
5792: padding: 0;
1.721 harmsja 5793: line-height:130%;
1.693 droeschl 5794: }
1.795 www 5795:
5796: .LC_hcell {
1.698 harmsja 5797: padding:3px 15px 3px 15px;
1.803 bisitz 5798: margin: 0;
1.703 harmsja 5799: background-color:$tabbg;
1.801 tempelho 5800: color:$fontmenu;
1.779 bisitz 5801: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5802: }
1.795 www 5803:
1.721 harmsja 5804: .LC_noBorder {
1.803 bisitz 5805: border: 0;
1.698 harmsja 5806: }
1.693 droeschl 5807:
5808:
1.698 harmsja 5809: /* Main Header with discription of Person, Course, etc. */
1.693 droeschl 5810:
1.761 tempelho 5811: .LC_Right {
5812: float: right;
1.803 bisitz 5813: margin: 0;
5814: padding: 0;
1.761 tempelho 5815: }
5816:
1.721 harmsja 5817: .LC_FormSectionClearButton input {
1.779 bisitz 5818: background-color:transparent;
1.803 bisitz 5819: border: none;
1.698 harmsja 5820: cursor:pointer;
5821: text-decoration:underline;
1.693 droeschl 5822: }
1.763 bisitz 5823:
5824: .LC_help_open_topic {
5825: color: #FFFFFF;
5826: background-color: #EEEEFF;
5827: margin: 1px;
5828: padding: 4px;
5829: border: 1px solid #000033;
5830: white-space: nowrap;
1.783 amueller 5831: /* vertical-align: middle; */
1.759 neumanie 5832: }
1.693 droeschl 5833:
1.698 harmsja 5834: dl,ul,div,fieldset {
1.803 bisitz 5835: margin: 10px 10px 10px 0;
1.806 bisitz 5836: /* overflow: hidden; */
1.693 droeschl 5837: }
1.795 www 5838:
1.813 bisitz 5839: #LC_nav_bar {
1.807 droeschl 5840: float: left;
5841: margin: 0;
5842: }
5843:
1.813 bisitz 5844: #LC_nav_bar em{
1.807 droeschl 5845: font-weight: bold;
5846: font-style: normal;
5847: }
5848:
5849: ol.LC_smallMenu {
5850: float: right;
5851: }
5852:
1.721 harmsja 5853: ol.LC_smallMenu, ol#LC_PathBreadcrumbs {
1.803 bisitz 5854: margin: 0;
1.693 droeschl 5855: }
5856:
1.721 harmsja 5857: ol.LC_smallMenu li {
1.693 droeschl 5858: display: inline;
1.803 bisitz 5859: padding: 5px 5px 0 10px;
1.693 droeschl 5860: vertical-align: top;
5861: }
5862:
1.721 harmsja 5863: ol.LC_smallMenu li img {
1.693 droeschl 5864: vertical-align: bottom;
5865: }
5866:
1.721 harmsja 5867: ol.LC_smallMenu a {
1.693 droeschl 5868: font-size: 90%;
5869: color: RGB(80, 80, 80);
5870: text-decoration: none;
5871: }
1.795 www 5872:
1.808 droeschl 5873: ul#LC_TabMainMenuContent {
1.807 droeschl 5874: clear: both;
1.808 droeschl 5875: color: $fontmenu;
5876: background: $tabbg;
5877: list-style: none;
5878: padding: 0;
5879: margin: 0;
5880: float:left;
5881: width: 100%;
5882: }
5883:
5884: ul#LC_TabMainMenuContent li {
5885: float: left;
5886: font-weight: bold;
5887: line-height: 1.8em;
5888: padding: 0 0.8em;
5889: border-right: 1px solid black;
5890: display: inline;
5891: vertical-align: middle;
1.807 droeschl 5892: }
5893:
1.795 www 5894: ul.LC_TabContent ,
1.741 harmsja 5895: ul.LC_TabContentBigger {
1.721 harmsja 5896: display:block;
5897: list-style:none;
1.803 bisitz 5898: margin: 0;
5899: padding: 0;
1.693 droeschl 5900: }
5901:
1.795 www 5902: ul.LC_TabContent li,
5903: ul.LC_TabContentBigger li {
1.693 droeschl 5904: display: inline;
1.741 harmsja 5905: border-right: solid 1px $lg_border_color;
5906: float:left;
5907: line-height:140%;
5908: white-space:nowrap;
5909: }
1.795 www 5910:
1.808 droeschl 5911: ul#LC_TabMainMenuContent li a {
5912: color: $fontmenu;
1.693 droeschl 5913: text-decoration: none;
5914: }
1.795 www 5915:
1.721 harmsja 5916: ul.LC_TabContent {
1.741 harmsja 5917: min-height:1.6em;
1.721 harmsja 5918: }
1.795 www 5919:
5920: ul.LC_TabContent li {
1.741 harmsja 5921: vertical-align:middle;
1.803 bisitz 5922: padding: 0 10px 0 10px;
1.745 ehlerst 5923: background-color:$tabbg;
5924: border-bottom:solid 1px $lg_border_color;
1.721 harmsja 5925: }
1.795 www 5926:
5927: ul.LC_TabContent li a, ul.LC_TabContent li {
1.721 harmsja 5928: color:rgb(47,47,47);
5929: text-decoration:none;
5930: font-size:95%;
5931: font-weight:bold;
1.761 tempelho 5932: padding-right: 16px;
1.721 harmsja 5933: }
1.795 www 5934:
5935: ul.LC_TabContent li:hover, ul.LC_TabContent li.active {
1.761 tempelho 5936: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.745 ehlerst 5937: border-bottom:solid 1px #FFFFFF;
1.761 tempelho 5938: padding-right: 16px;
1.744 ehlerst 5939: }
1.795 www 5940:
5941: ul.LC_TabContentBigger li {
1.741 harmsja 5942: vertical-align:bottom;
5943: border-top:solid 1px $lg_border_color;
5944: border-left:solid 1px $lg_border_color;
5945: padding:5px 10px 5px 10px;
5946: margin-left:2px;
5947: background:url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
5948: }
1.795 www 5949:
5950: ul.LC_TabContentBigger li:hover,
5951: ul.LC_TabContentBigger li.active {
1.744 ehlerst 5952: background:url(/adm/lonIcons/lightGreyBG.png) repeat-x right bottom;
5953: }
1.795 www 5954:
5955: ul.LC_TabContentBigger li,
5956: ul.LC_TabContentBigger li a {
1.741 harmsja 5957: font-size:110%;
5958: font-weight:bold;
5959: }
1.693 droeschl 5960:
1.795 www 5961: ol#LC_MenuBreadcrumbs,
5962: ol#LC_PathBreadcrumbs,
5963: ul.LC_CourseBreadcrumbs {
1.693 droeschl 5964: border-top: solid 1px RGB(255, 255, 255);
5965: height: 20px;
5966: line-height: 20px;
5967: vertical-align: bottom;
1.803 bisitz 5968: margin: 0 0 30px 0;
1.693 droeschl 5969: padding-left: 10px;
5970: list-style-position: inside;
1.723 riegler 5971: background: url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
1.693 droeschl 5972: }
5973:
1.795 www 5974: ol#LC_MenuBreadcrumbs li,
5975: ol#LC_PathBreadcrumbs li,
5976: ul.LC_CourseBreadcrumbs li {
1.741 harmsja 5977: /*
1.723 riegler 5978: background: url(/adm/lonIcons/arrow_white.png) no-repeat left center;
1.779 bisitz 5979: */
1.693 droeschl 5980: display: inline;
1.803 bisitz 5981: padding: 0 0 0 10px;
1.783 amueller 5982: /* vertical-align: bottom; */
1.693 droeschl 5983: overflow:hidden;
5984: }
5985:
1.783 amueller 5986: ol#LC_MenuBreadcrumbs li a, ul.LC_CourseBreadcrumbs li a {
1.693 droeschl 5987: text-decoration: none;
5988: font-size:90%;
5989: }
1.795 www 5990:
5991: ol#LC_PathBreadcrumbs li a {
1.698 harmsja 5992: text-decoration:none;
5993: font-size:100%;
5994: font-weight:bold;
1.693 droeschl 5995: }
1.795 www 5996:
5997: .LC_BoxPadding {
1.786 neumanie 5998: padding: 10px;
5999: }
1.795 www 6000:
6001: .LC_ContentBoxSpecial {
1.701 harmsja 6002: border: solid 1px $lg_border_color;
1.746 neumanie 6003: }
1.795 www 6004:
6005: .LC_ContentBoxSpecialContactInfo {
1.746 neumanie 6006: border: solid 1px $lg_border_color;
6007: max-width:25%;
6008: min-width:25%;
1.698 harmsja 6009: }
1.795 www 6010:
6011: .LC_AboutMe_Image {
1.747 neumanie 6012: float:left;
6013: margin-right:10px;
6014: }
1.795 www 6015:
6016: .LC_Clear_AboutMe_Image {
1.747 neumanie 6017: clear:left;
6018: }
1.795 www 6019:
1.721 harmsja 6020: dl.LC_ListStyleClean dt {
1.693 droeschl 6021: padding-right: 5px;
6022: display: table-header-group;
6023: }
6024:
1.721 harmsja 6025: dl.LC_ListStyleClean dd {
1.693 droeschl 6026: display: table-row;
6027: }
6028:
1.721 harmsja 6029: .LC_ListStyleClean,
6030: .LC_ListStyleSimple,
6031: .LC_ListStyleNormal,
1.777 tempelho 6032: .LC_ListStyle_Border,
1.795 www 6033: .LC_ListStyleSpecial {
1.693 droeschl 6034: /*display:block; */
6035: list-style-position: inside;
6036: list-style-type: none;
6037: overflow: hidden;
1.803 bisitz 6038: padding: 0;
1.693 droeschl 6039: }
6040:
1.721 harmsja 6041: .LC_ListStyleSimple li,
6042: .LC_ListStyleSimple dd,
6043: .LC_ListStyleNormal li,
6044: .LC_ListStyleNormal dd,
6045: .LC_ListStyleSpecial li,
1.795 www 6046: .LC_ListStyleSpecial dd {
1.803 bisitz 6047: margin: 0;
1.693 droeschl 6048: padding: 5px 5px 5px 10px;
6049: clear: both;
6050: }
6051:
1.721 harmsja 6052: .LC_ListStyleClean li,
6053: .LC_ListStyleClean dd {
1.803 bisitz 6054: padding-top: 0;
6055: padding-bottom: 0;
1.693 droeschl 6056: }
6057:
1.721 harmsja 6058: .LC_ListStyleSimple dd,
1.795 www 6059: .LC_ListStyleSimple li {
1.698 harmsja 6060: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6061: }
6062:
1.721 harmsja 6063: .LC_ListStyleSpecial li,
6064: .LC_ListStyleSpecial dd {
1.693 droeschl 6065: list-style-type: none;
6066: background-color: RGB(220, 220, 220);
6067: margin-bottom: 4px;
6068: }
6069:
1.721 harmsja 6070: table.LC_SimpleTable {
1.698 harmsja 6071: margin:5px;
6072: border:solid 1px $lg_border_color;
1.795 www 6073: }
1.693 droeschl 6074:
1.721 harmsja 6075: table.LC_SimpleTable tr {
1.803 bisitz 6076: padding: 0;
1.698 harmsja 6077: border:solid 1px $lg_border_color;
1.693 droeschl 6078: }
1.795 www 6079:
6080: table.LC_SimpleTable thead {
1.698 harmsja 6081: background:rgb(220,220,220);
1.693 droeschl 6082: }
6083:
1.721 harmsja 6084: div.LC_columnSection {
1.693 droeschl 6085: display: block;
6086: clear: both;
6087: overflow: hidden;
1.803 bisitz 6088: margin: 0;
1.693 droeschl 6089: }
6090:
1.721 harmsja 6091: div.LC_columnSection>* {
1.693 droeschl 6092: float: left;
1.803 bisitz 6093: margin: 10px 20px 10px 0;
1.747 neumanie 6094: overflow:hidden;
1.693 droeschl 6095: }
1.721 harmsja 6096:
1.795 www 6097: .ContentBoxSpecialTemplate {
1.747 neumanie 6098: border: solid 1px $lg_border_color;
1.719 ehlerst 6099: }
1.795 www 6100:
1.719 ehlerst 6101: .ContentBoxTemplate {
6102: padding:10px;
6103: }
6104:
1.721 harmsja 6105: div.LC_columnSection > .ContentBoxTemplate,
1.795 www 6106: div.LC_columnSection > .ContentBoxSpecialTemplate {
1.719 ehlerst 6107: width: 600px;
6108: }
1.753 droeschl 6109:
1.795 www 6110: .clear {
1.720 ehlerst 6111: clear: both;
1.803 bisitz 6112: line-height: 0;
6113: font-size: 0;
6114: height: 0;
1.720 ehlerst 6115: }
1.693 droeschl 6116:
1.694 tempelho 6117: .LC_loginpage_container {
6118: text-align:left;
6119: margin : 0 auto;
1.785 tempelho 6120: width:90%;
1.694 tempelho 6121: padding: 10px;
6122: height: auto;
1.712 muellerd 6123: background-color:#FFFFFF;
1.694 tempelho 6124: border:1px solid #CCCCCC;
6125: }
6126:
6127:
6128: .LC_loginpage_loginContainer {
6129: float:left;
1.712 muellerd 6130: width: 182px;
1.785 tempelho 6131: padding: 2px;
1.712 muellerd 6132: border:1px solid #CCCCCC;
6133: background-color:$loginbg;
1.694 tempelho 6134: }
6135:
1.795 www 6136: .LC_loginpage_loginContainer h2 {
1.803 bisitz 6137: margin-top: 0;
1.712 muellerd 6138: display:block;
6139: background:$bgcol;
6140: color:$textcol;
6141: padding-left:5px;
6142: }
1.785 tempelho 6143:
1.694 tempelho 6144: .LC_loginpage_loginInfo {
6145: float:left;
1.785 tempelho 6146: width:182px;
1.694 tempelho 6147: border:1px solid #CCCCCC;
1.785 tempelho 6148: padding:2px;
1.712 muellerd 6149: }
6150:
1.694 tempelho 6151: .LC_loginpage_space {
1.754 droeschl 6152: clear: both;
6153: margin-bottom: 20px;
1.694 tempelho 6154: border-bottom: 1px solid #CCCCCC;
6155: }
6156:
1.785 tempelho 6157: .LC_loginpage_floatLeft {
6158: float: left;
6159: width: 200px;
6160: margin: 0;
6161: }
6162:
1.795 www 6163: table em {
1.754 droeschl 6164: font-weight: bold;
6165: font-style: normal;
1.748 schulted 6166: }
1.795 www 6167:
1.779 bisitz 6168: table.LC_tableBrowseRes,
1.795 www 6169: table.LC_tableOfContent {
1.769 schulted 6170: border:none;
6171: border-spacing: 1;
1.754 droeschl 6172: padding: 3px;
6173: background-color: #FFFFFF;
6174: font-size: 90%;
1.753 droeschl 6175: }
1.789 droeschl 6176:
6177: table.LC_tableOfContent{
6178: border-collapse: collapse;
6179: }
6180:
1.771 droeschl 6181: table.LC_tableBrowseRes a,
1.768 schulted 6182: table.LC_tableOfContent a {
1.771 droeschl 6183: background-color: transparent;
1.753 droeschl 6184: text-decoration: none;
6185: }
6186:
1.771 droeschl 6187: table.LC_tableBrowseRes tr.LC_trOdd,
1.768 schulted 6188: table.LC_tableOfContent tr.LC_trOdd{
1.754 droeschl 6189: background-color: #EEEEEE;
1.753 droeschl 6190: }
6191:
1.795 www 6192: table.LC_tableOfContent img {
1.753 droeschl 6193: border: none;
6194: height: 1.3em;
6195: vertical-align: text-bottom;
6196: margin-right: 0.3em;
6197: }
1.757 schulted 6198:
1.795 www 6199: a#LC_content_toolbar_firsthomework {
1.774 ehlerst 6200: background-image:url(/res/adm/pages/open-first-problem.gif);
6201: }
6202:
1.795 www 6203: a#LC_content_toolbar_launchnav {
1.774 ehlerst 6204: background-image:url(/res/adm/pages/start-navigation.gif);
6205: }
6206:
1.795 www 6207: a#LC_content_toolbar_closenav {
1.774 ehlerst 6208: background-image:url(/res/adm/pages/close-navigation.gif);
6209: }
6210:
1.795 www 6211: a#LC_content_toolbar_everything {
1.774 ehlerst 6212: background-image:url(/res/adm/pages/show-all.gif);
6213: }
6214:
1.795 www 6215: a#LC_content_toolbar_uncompleted {
1.774 ehlerst 6216: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
6217: }
6218:
1.795 www 6219: #LC_content_toolbar_clearbubbles {
1.774 ehlerst 6220: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
6221: }
6222:
1.795 www 6223: a#LC_content_toolbar_changefolder {
1.757 schulted 6224: background : url(/res/adm/pages/close-all-folders.gif) top center ;
6225: }
6226:
1.795 www 6227: a#LC_content_toolbar_changefolder_toggled {
1.757 schulted 6228: background-image:url(/res/adm/pages/open-all-folders.gif);
6229: }
6230:
1.795 www 6231: ul#LC_toolbar li a:hover {
1.757 schulted 6232: background-position: bottom center;
6233: }
6234:
1.795 www 6235: ul#LC_toolbar {
1.803 bisitz 6236: padding: 0;
1.757 schulted 6237: margin: 2px;
6238: list-style:none;
6239: position:relative;
6240: background-color:white;
6241: }
6242:
1.795 www 6243: ul#LC_toolbar li {
1.757 schulted 6244: border:1px solid white;
1.803 bisitz 6245: padding: 0;
1.757 schulted 6246: margin: 0;
1.795 www 6247: float: left;
1.767 droeschl 6248: display:inline;
1.757 schulted 6249: vertical-align:middle;
1.795 www 6250: }
1.757 schulted 6251:
1.783 amueller 6252:
1.795 www 6253: a.LC_toolbarItem {
1.767 droeschl 6254: display:block;
1.803 bisitz 6255: padding: 0;
6256: margin: 0;
1.757 schulted 6257: height: 32px;
6258: width: 32px;
1.779 bisitz 6259: color:white;
1.803 bisitz 6260: border: none;
1.757 schulted 6261: background-repeat:no-repeat;
6262: background-color:transparent;
6263: }
6264:
1.782 bisitz 6265: ul.LC_functionslist li {
6266: float: left;
6267: white-space: nowrap;
6268: height: 35px; /* at least as high as heighest list item */
1.803 bisitz 6269: margin: 0 15px 15px 10px;
1.782 bisitz 6270: }
6271:
1.757 schulted 6272:
1.343 albertel 6273: END
6274: }
6275:
1.306 albertel 6276: =pod
6277:
6278: =item * &headtag()
6279:
6280: Returns a uniform footer for LON-CAPA web pages.
6281:
1.307 albertel 6282: Inputs: $title - optional title for the head
6283: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6284: $args - optional arguments
1.319 albertel 6285: force_register - if is true call registerurl so the remote is
6286: informed
1.415 albertel 6287: redirect -> array ref of
6288: 1- seconds before redirect occurs
6289: 2- url to redirect to
6290: 3- whether the side effect should occur
1.315 albertel 6291: (side effect of setting
6292: $env{'internal.head.redirect'} to the url
6293: redirected too)
1.352 albertel 6294: domain -> force to color decorate a page for a specific
6295: domain
6296: function -> force usage of a specific rolish color scheme
6297: bgcolor -> override the default page bgcolor
1.460 albertel 6298: no_auto_mt_title
6299: -> prevent &mt()ing the title arg
1.464 albertel 6300:
1.306 albertel 6301: =cut
6302:
6303: sub headtag {
1.313 albertel 6304: my ($title,$head_extra,$args) = @_;
1.306 albertel 6305:
1.363 albertel 6306: my $function = $args->{'function'} || &get_users_function();
6307: my $domain = $args->{'domain'} || &determinedomain();
6308: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6309: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6310: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6311: #time(),
1.418 albertel 6312: $env{'environment.color.timestamp'},
1.363 albertel 6313: $function,$domain,$bgcolor);
6314:
1.369 www 6315: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6316:
1.308 albertel 6317: my $result =
6318: '<head>'.
1.461 albertel 6319: &font_settings();
1.319 albertel 6320:
1.461 albertel 6321: if (!$args->{'frameset'}) {
6322: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6323: }
1.319 albertel 6324: if ($args->{'force_register'}) {
6325: $result .= &Apache::lonmenu::registerurl(1);
6326: }
1.436 albertel 6327: if (!$args->{'no_nav_bar'}
6328: && !$args->{'only_body'}
6329: && !$args->{'frameset'}) {
6330: $result .= &help_menu_js();
6331: }
1.319 albertel 6332:
1.314 albertel 6333: if (ref($args->{'redirect'})) {
1.414 albertel 6334: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6335: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6336: if (!$inhibit_continue) {
6337: $env{'internal.head.redirect'} = $url;
6338: }
1.313 albertel 6339: $result.=<<ADDMETA
6340: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6341: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6342: ADDMETA
6343: }
1.306 albertel 6344: if (!defined($title)) {
6345: $title = 'The LearningOnline Network with CAPA';
6346: }
1.460 albertel 6347: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6348: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6349: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6350: .$head_extra;
1.306 albertel 6351: return $result;
6352: }
6353:
6354: =pod
6355:
1.340 albertel 6356: =item * &font_settings()
6357:
6358: Returns neccessary <meta> to set the proper encoding
6359:
6360: Inputs: none
6361:
6362: =cut
6363:
6364: sub font_settings {
6365: my $headerstring='';
1.647 www 6366: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6367: $headerstring.=
6368: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6369: }
6370: return $headerstring;
6371: }
6372:
1.341 albertel 6373: =pod
6374:
6375: =item * &xml_begin()
6376:
6377: Returns the needed doctype and <html>
6378:
6379: Inputs: none
6380:
6381: =cut
6382:
6383: sub xml_begin {
6384: my $output='';
6385:
1.592 albertel 6386: if ($env{'internal.start_page'}==1) {
6387: &Apache::lonhtmlcommon::init_htmlareafields();
6388: }
1.342 albertel 6389:
1.341 albertel 6390: if ($env{'browser.mathml'}) {
6391: $output='<?xml version="1.0"?>'
6392: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6393: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6394:
6395: # .'<!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">] >'
6396: .'<!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">'
6397: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6398: .'xmlns="http://www.w3.org/1999/xhtml">';
6399: } else {
6400: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
6401: }
6402: return $output;
6403: }
1.340 albertel 6404:
6405: =pod
6406:
1.306 albertel 6407: =item * &endheadtag()
6408:
6409: Returns a uniform </head> for LON-CAPA web pages.
6410:
6411: Inputs: none
6412:
6413: =cut
6414:
6415: sub endheadtag {
6416: return '</head>';
6417: }
6418:
6419: =pod
6420:
6421: =item * &head()
6422:
6423: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6424:
1.648 raeburn 6425: Inputs:
6426:
6427: =over 4
6428:
6429: $title - optional title for the page
6430:
6431: $head_extra - optional extra HTML to put inside the <head>
6432:
6433: =back
1.405 albertel 6434:
1.306 albertel 6435: =cut
6436:
6437: sub head {
1.325 albertel 6438: my ($title,$head_extra,$args) = @_;
6439: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6440: }
6441:
6442: =pod
6443:
6444: =item * &start_page()
6445:
6446: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6447:
1.648 raeburn 6448: Inputs:
6449:
6450: =over 4
6451:
6452: $title - optional title for the page
6453:
6454: $head_extra - optional extra HTML to incude inside the <head>
6455:
6456: $args - additional optional args supported are:
6457:
6458: =over 8
6459:
6460: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6461: arg on
1.814 bisitz 6462: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6463: add_entries -> additional attributes to add to the <body>
6464: domain -> force to color decorate a page for a
1.317 albertel 6465: specific domain
1.648 raeburn 6466: function -> force usage of a specific rolish color
1.317 albertel 6467: scheme
1.648 raeburn 6468: redirect -> see &headtag()
6469: bgcolor -> override the default page bg color
6470: js_ready -> return a string ready for being used in
1.317 albertel 6471: a javascript writeln
1.648 raeburn 6472: html_encode -> return a string ready for being used in
1.320 albertel 6473: a html attribute
1.648 raeburn 6474: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6475: $forcereg arg
1.648 raeburn 6476: body_title -> alternate text to use instead of $title
1.326 albertel 6477: in the title box that appears, this text
6478: is not auto translated like the $title is
1.648 raeburn 6479: frameset -> if true will start with a <frameset>
1.330 albertel 6480: rather than <body>
1.648 raeburn 6481: skip_phases -> hash ref of
1.338 albertel 6482: head -> skip the <html><head> generation
6483: body -> skip all <body> generation
1.648 raeburn 6484: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6485: 'Switch To Inline Menu' link
1.648 raeburn 6486: no_auto_mt_title -> prevent &mt()ing the title arg
6487: inherit_jsmath -> when creating popup window in a page,
6488: should it have jsmath forced on by the
6489: current page
1.361 albertel 6490:
1.648 raeburn 6491: =back
1.460 albertel 6492:
1.648 raeburn 6493: =back
1.562 albertel 6494:
1.306 albertel 6495: =cut
6496:
6497: sub start_page {
1.309 albertel 6498: my ($title,$head_extra,$args) = @_;
1.318 albertel 6499: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6500: my %head_args;
1.352 albertel 6501: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6502: 'bgcolor','frameset','no_nav_bar','only_body',
6503: 'no_auto_mt_title') {
1.319 albertel 6504: if (defined($args->{$arg})) {
1.324 raeburn 6505: $head_args{$arg} = $args->{$arg};
1.319 albertel 6506: }
1.313 albertel 6507: }
1.319 albertel 6508:
1.315 albertel 6509: $env{'internal.start_page'}++;
1.338 albertel 6510: my $result;
6511: if (! exists($args->{'skip_phases'}{'head'}) ) {
6512: $result.=
1.341 albertel 6513: &xml_begin().
1.338 albertel 6514: &headtag($title,$head_extra,\%head_args).&endheadtag();
6515: }
6516:
6517: if (! exists($args->{'skip_phases'}{'body'}) ) {
6518: if ($args->{'frameset'}) {
6519: my $attr_string = &make_attr_string($args->{'force_register'},
6520: $args->{'add_entries'});
6521: $result .= "\n<frameset $attr_string>\n";
6522: } else {
6523: $result .=
6524: &bodytag($title,
6525: $args->{'function'}, $args->{'add_entries'},
6526: $args->{'only_body'}, $args->{'domain'},
6527: $args->{'force_register'}, $args->{'body_title'},
6528: $args->{'no_nav_bar'}, $args->{'bgcolor'},
1.816 ! bisitz 6529: $args->{'no_inline_link'},
1.460 albertel 6530: $args);
1.338 albertel 6531: }
1.330 albertel 6532: }
1.338 albertel 6533:
1.315 albertel 6534: if ($args->{'js_ready'}) {
1.713 kaisler 6535: $result = &js_ready($result);
1.315 albertel 6536: }
1.320 albertel 6537: if ($args->{'html_encode'}) {
1.713 kaisler 6538: $result = &html_encode($result);
6539: }
6540:
1.813 bisitz 6541: # Preparation for new and consistent functionlist at top of screen
6542: # if ($args->{'functionlist'}) {
6543: # $result .= &build_functionlist();
6544: #}
6545:
6546: # Don't add anything more if only_body wanted
6547: return $result if $args->{'only_body'};
6548:
6549: #Breadcrumbs
1.758 kaisler 6550: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6551: &Apache::lonhtmlcommon::clear_breadcrumbs();
6552: #if any br links exists, add them to the breadcrumbs
6553: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6554: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6555: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6556: }
6557: }
6558:
6559: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6560: if(exists($args->{'bread_crumbs_component'})){
6561: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6562: }else{
6563: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6564: }
1.320 albertel 6565: }
1.315 albertel 6566: return $result;
1.306 albertel 6567: }
6568:
1.330 albertel 6569:
1.306 albertel 6570: =pod
6571:
6572: =item * &head()
6573:
6574: Returns a complete </body></html> section for LON-CAPA web pages.
6575:
1.315 albertel 6576: Inputs: $args - additional optional args supported are:
6577: js_ready -> return a string ready for being used in
6578: a javascript writeln
1.320 albertel 6579: html_encode -> return a string ready for being used in
6580: a html attribute
1.330 albertel 6581: frameset -> if true will start with a <frameset>
6582: rather than <body>
1.493 albertel 6583: dicsussion -> if true will get discussion from
6584: lonxml::xmlend
6585: (you can pass the target and parser arguments
6586: through optional 'target' and 'parser' args
6587: to this routine)
1.306 albertel 6588:
6589: =cut
6590:
6591: sub end_page {
1.315 albertel 6592: my ($args) = @_;
6593: $env{'internal.end_page'}++;
1.330 albertel 6594: my $result;
1.335 albertel 6595: if ($args->{'discussion'}) {
6596: my ($target,$parser);
6597: if (ref($args->{'discussion'})) {
6598: ($target,$parser) =($args->{'discussion'}{'target'},
6599: $args->{'discussion'}{'parser'});
6600: }
6601: $result .= &Apache::lonxml::xmlend($target,$parser);
6602: }
6603:
1.330 albertel 6604: if ($args->{'frameset'}) {
6605: $result .= '</frameset>';
6606: } else {
1.635 raeburn 6607: $result .= &endbodytag($args);
1.330 albertel 6608: }
6609: $result .= "\n</html>";
6610:
1.315 albertel 6611: if ($args->{'js_ready'}) {
1.317 albertel 6612: $result = &js_ready($result);
1.315 albertel 6613: }
1.335 albertel 6614:
1.320 albertel 6615: if ($args->{'html_encode'}) {
6616: $result = &html_encode($result);
6617: }
1.335 albertel 6618:
1.315 albertel 6619: return $result;
6620: }
6621:
1.320 albertel 6622: sub html_encode {
6623: my ($result) = @_;
6624:
1.322 albertel 6625: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6626:
6627: return $result;
6628: }
1.317 albertel 6629: sub js_ready {
6630: my ($result) = @_;
6631:
1.323 albertel 6632: $result =~ s/[\n\r]/ /xmsg;
6633: $result =~ s/\\/\\\\/xmsg;
6634: $result =~ s/'/\\'/xmsg;
1.372 albertel 6635: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6636:
6637: return $result;
6638: }
6639:
1.315 albertel 6640: sub validate_page {
6641: if ( exists($env{'internal.start_page'})
1.316 albertel 6642: && $env{'internal.start_page'} > 1) {
6643: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6644: $env{'internal.start_page'}.' '.
1.316 albertel 6645: $ENV{'request.filename'});
1.315 albertel 6646: }
6647: if ( exists($env{'internal.end_page'})
1.316 albertel 6648: && $env{'internal.end_page'} > 1) {
6649: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6650: $env{'internal.end_page'}.' '.
1.316 albertel 6651: $env{'request.filename'});
1.315 albertel 6652: }
6653: if ( exists($env{'internal.start_page'})
6654: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6655: &Apache::lonnet::logthis('start_page called without end_page '.
6656: $env{'request.filename'});
1.315 albertel 6657: }
6658: if ( ! exists($env{'internal.start_page'})
6659: && exists($env{'internal.end_page'})) {
1.316 albertel 6660: &Apache::lonnet::logthis('end_page called without start_page'.
6661: $env{'request.filename'});
1.315 albertel 6662: }
1.306 albertel 6663: }
1.315 albertel 6664:
1.318 albertel 6665: sub simple_error_page {
6666: my ($r,$title,$msg) = @_;
6667: my $page =
6668: &Apache::loncommon::start_page($title).
6669: &mt($msg).
6670: &Apache::loncommon::end_page();
6671: if (ref($r)) {
6672: $r->print($page);
1.327 albertel 6673: return;
1.318 albertel 6674: }
6675: return $page;
6676: }
1.347 albertel 6677:
6678: {
1.610 albertel 6679: my @row_count;
1.347 albertel 6680: sub start_data_table {
1.422 albertel 6681: my ($add_class) = @_;
6682: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6683: unshift(@row_count,0);
1.422 albertel 6684: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6685: }
6686:
6687: sub end_data_table {
1.610 albertel 6688: shift(@row_count);
1.389 albertel 6689: return '</table>'."\n";;
1.347 albertel 6690: }
6691:
6692: sub start_data_table_row {
1.422 albertel 6693: my ($add_class) = @_;
1.610 albertel 6694: $row_count[0]++;
6695: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428 albertel 6696: $css_class = (join(' ',$css_class,$add_class));
1.422 albertel 6697: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6698: }
1.471 banghart 6699:
6700: sub continue_data_table_row {
6701: my ($add_class) = @_;
1.610 albertel 6702: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471 banghart 6703: $css_class = (join(' ',$css_class,$add_class));
6704: return '<tr class="'.$css_class.'">'."\n";;
6705: }
1.347 albertel 6706:
6707: sub end_data_table_row {
1.389 albertel 6708: return '</tr>'."\n";;
1.347 albertel 6709: }
1.367 www 6710:
1.421 albertel 6711: sub start_data_table_empty_row {
1.707 bisitz 6712: # $row_count[0]++;
1.421 albertel 6713: return '<tr class="LC_empty_row" >'."\n";;
6714: }
6715:
6716: sub end_data_table_empty_row {
6717: return '</tr>'."\n";;
6718: }
6719:
1.367 www 6720: sub start_data_table_header_row {
1.389 albertel 6721: return '<tr class="LC_header_row">'."\n";;
1.367 www 6722: }
6723:
6724: sub end_data_table_header_row {
1.389 albertel 6725: return '</tr>'."\n";;
1.367 www 6726: }
1.347 albertel 6727: }
6728:
1.548 albertel 6729: =pod
6730:
6731: =item * &inhibit_menu_check($arg)
6732:
6733: Checks for a inhibitmenu state and generates output to preserve it
6734:
6735: Inputs: $arg - can be any of
6736: - undef - in which case the return value is a string
6737: to add into arguments list of a uri
6738: - 'input' - in which case the return value is a HTML
6739: <form> <input> field of type hidden to
6740: preserve the value
6741: - a url - in which case the return value is the url with
6742: the neccesary cgi args added to preserve the
6743: inhibitmenu state
6744: - a ref to a url - no return value, but the string is
6745: updated to include the neccessary cgi
6746: args to preserve the inhibitmenu state
6747:
6748: =cut
6749:
6750: sub inhibit_menu_check {
6751: my ($arg) = @_;
6752: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6753: if ($arg eq 'input') {
6754: if ($env{'form.inhibitmenu'}) {
6755: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6756: } else {
6757: return
6758: }
6759: }
6760: if ($env{'form.inhibitmenu'}) {
6761: if (ref($arg)) {
6762: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6763: } elsif ($arg eq '') {
6764: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6765: } else {
6766: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6767: }
6768: }
6769: if (!ref($arg)) {
6770: return $arg;
6771: }
6772: }
6773:
1.251 albertel 6774: ###############################################
1.182 matthew 6775:
6776: =pod
6777:
1.549 albertel 6778: =back
6779:
6780: =head1 User Information Routines
6781:
6782: =over 4
6783:
1.405 albertel 6784: =item * &get_users_function()
1.182 matthew 6785:
6786: Used by &bodytag to determine the current users primary role.
6787: Returns either 'student','coordinator','admin', or 'author'.
6788:
6789: =cut
6790:
6791: ###############################################
6792: sub get_users_function {
1.815 tempelho 6793: my $function = 'norole';
1.258 albertel 6794: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182 matthew 6795: $function='coordinator';
6796: }
1.258 albertel 6797: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 6798: $function='admin';
6799: }
1.258 albertel 6800: if (($env{'request.role'}=~/^(au|ca)/) ||
1.182 matthew 6801: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
6802: $function='author';
6803: }
6804: return $function;
1.54 www 6805: }
1.99 www 6806:
6807: ###############################################
6808:
1.233 raeburn 6809: =pod
6810:
1.542 raeburn 6811: =item * &check_user_status()
1.274 raeburn 6812:
6813: Determines current status of supplied role for a
6814: specific user. Roles can be active, previous or future.
6815:
6816: Inputs:
6817: user's domain, user's username, course's domain,
1.375 raeburn 6818: course's number, optional section ID.
1.274 raeburn 6819:
6820: Outputs:
6821: role status: active, previous or future.
6822:
6823: =cut
6824:
6825: sub check_user_status {
1.412 raeburn 6826: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 6827: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
6828: my @uroles = keys %userinfo;
6829: my $srchstr;
6830: my $active_chk = 'none';
1.412 raeburn 6831: my $now = time;
1.274 raeburn 6832: if (@uroles > 0) {
1.412 raeburn 6833: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 6834: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
6835: } else {
1.412 raeburn 6836: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
6837: }
6838: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 6839: my $role_end = 0;
6840: my $role_start = 0;
6841: $active_chk = 'active';
1.412 raeburn 6842: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
6843: $role_end = $1;
6844: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
6845: $role_start = $1;
1.274 raeburn 6846: }
6847: }
6848: if ($role_start > 0) {
1.412 raeburn 6849: if ($now < $role_start) {
1.274 raeburn 6850: $active_chk = 'future';
6851: }
6852: }
6853: if ($role_end > 0) {
1.412 raeburn 6854: if ($now > $role_end) {
1.274 raeburn 6855: $active_chk = 'previous';
6856: }
6857: }
6858: }
6859: }
6860: return $active_chk;
6861: }
6862:
6863: ###############################################
6864:
6865: =pod
6866:
1.405 albertel 6867: =item * &get_sections()
1.233 raeburn 6868:
6869: Determines all the sections for a course including
6870: sections with students and sections containing other roles.
1.419 raeburn 6871: Incoming parameters:
6872:
6873: 1. domain
6874: 2. course number
6875: 3. reference to array containing roles for which sections should
6876: be gathered (optional).
6877: 4. reference to array containing status types for which sections
6878: should be gathered (optional).
6879:
6880: If the third argument is undefined, sections are gathered for any role.
6881: If the fourth argument is undefined, sections are gathered for any status.
6882: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 6883:
1.374 raeburn 6884: Returns section hash (keys are section IDs, values are
6885: number of users in each section), subject to the
1.419 raeburn 6886: optional roles filter, optional status filter
1.233 raeburn 6887:
6888: =cut
6889:
6890: ###############################################
6891: sub get_sections {
1.419 raeburn 6892: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 6893: if (!defined($cdom) || !defined($cnum)) {
6894: my $cid = $env{'request.course.id'};
6895:
6896: return if (!defined($cid));
6897:
6898: $cdom = $env{'course.'.$cid.'.domain'};
6899: $cnum = $env{'course.'.$cid.'.num'};
6900: }
6901:
6902: my %sectioncount;
1.419 raeburn 6903: my $now = time;
1.240 albertel 6904:
1.366 albertel 6905: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 6906: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 6907: my $sec_index = &Apache::loncoursedata::CL_SECTION();
6908: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 6909: my $start_index = &Apache::loncoursedata::CL_START();
6910: my $end_index = &Apache::loncoursedata::CL_END();
6911: my $status;
1.366 albertel 6912: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 6913: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
6914: $data->[$status_index],
6915: $data->[$start_index],
6916: $data->[$end_index]);
6917: if ($stu_status eq 'Active') {
6918: $status = 'active';
6919: } elsif ($end < $now) {
6920: $status = 'previous';
6921: } elsif ($start > $now) {
6922: $status = 'future';
6923: }
6924: if ($section ne '-1' && $section !~ /^\s*$/) {
6925: if ((!defined($possible_status)) || (($status ne '') &&
6926: (grep/^\Q$status\E$/,@{$possible_status}))) {
6927: $sectioncount{$section}++;
6928: }
1.240 albertel 6929: }
6930: }
6931: }
6932: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6933: foreach my $user (sort(keys(%courseroles))) {
6934: if ($user !~ /^(\w{2})/) { next; }
6935: my ($role) = ($user =~ /^(\w{2})/);
6936: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 6937: my ($section,$status);
1.240 albertel 6938: if ($role eq 'cr' &&
6939: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
6940: $section=$1;
6941: }
6942: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
6943: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 6944: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
6945: if ($end == -1 && $start == -1) {
6946: next; #deleted role
6947: }
6948: if (!defined($possible_status)) {
6949: $sectioncount{$section}++;
6950: } else {
6951: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
6952: $status = 'active';
6953: } elsif ($end < $now) {
6954: $status = 'future';
6955: } elsif ($start > $now) {
6956: $status = 'previous';
6957: }
6958: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
6959: $sectioncount{$section}++;
6960: }
6961: }
1.233 raeburn 6962: }
1.366 albertel 6963: return %sectioncount;
1.233 raeburn 6964: }
6965:
1.274 raeburn 6966: ###############################################
1.294 raeburn 6967:
6968: =pod
1.405 albertel 6969:
6970: =item * &get_course_users()
6971:
1.275 raeburn 6972: Retrieves usernames:domains for users in the specified course
6973: with specific role(s), and access status.
6974:
6975: Incoming parameters:
1.277 albertel 6976: 1. course domain
6977: 2. course number
6978: 3. access status: users must have - either active,
1.275 raeburn 6979: previous, future, or all.
1.277 albertel 6980: 4. reference to array of permissible roles
1.288 raeburn 6981: 5. reference to array of section restrictions (optional)
6982: 6. reference to results object (hash of hashes).
6983: 7. reference to optional userdata hash
1.609 raeburn 6984: 8. reference to optional statushash
1.630 raeburn 6985: 9. flag if privileged users (except those set to unhide in
6986: course settings) should be excluded
1.609 raeburn 6987: Keys of top level results hash are roles.
1.275 raeburn 6988: Keys of inner hashes are username:domain, with
6989: values set to access type.
1.288 raeburn 6990: Optional userdata hash returns an array with arguments in the
6991: same order as loncoursedata::get_classlist() for student data.
6992:
1.609 raeburn 6993: Optional statushash returns
6994:
1.288 raeburn 6995: Entries for end, start, section and status are blank because
6996: of the possibility of multiple values for non-student roles.
6997:
1.275 raeburn 6998: =cut
1.405 albertel 6999:
1.275 raeburn 7000: ###############################################
1.405 albertel 7001:
1.275 raeburn 7002: sub get_course_users {
1.630 raeburn 7003: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7004: my %idx = ();
1.419 raeburn 7005: my %seclists;
1.288 raeburn 7006:
7007: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7008: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7009: $idx{end} = &Apache::loncoursedata::CL_END();
7010: $idx{start} = &Apache::loncoursedata::CL_START();
7011: $idx{id} = &Apache::loncoursedata::CL_ID();
7012: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7013: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7014: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7015:
1.290 albertel 7016: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7017: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7018: my $now = time;
1.277 albertel 7019: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7020: my $match = 0;
1.412 raeburn 7021: my $secmatch = 0;
1.419 raeburn 7022: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7023: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7024: if ($section eq '') {
7025: $section = 'none';
7026: }
1.291 albertel 7027: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7028: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7029: $secmatch = 1;
7030: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7031: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7032: $secmatch = 1;
7033: }
7034: } else {
1.419 raeburn 7035: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7036: $secmatch = 1;
7037: }
1.290 albertel 7038: }
1.412 raeburn 7039: if (!$secmatch) {
7040: next;
7041: }
1.419 raeburn 7042: }
1.275 raeburn 7043: if (defined($$types{'active'})) {
1.288 raeburn 7044: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7045: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7046: $match = 1;
1.275 raeburn 7047: }
7048: }
7049: if (defined($$types{'previous'})) {
1.609 raeburn 7050: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7051: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7052: $match = 1;
1.275 raeburn 7053: }
7054: }
7055: if (defined($$types{'future'})) {
1.609 raeburn 7056: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7057: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7058: $match = 1;
1.275 raeburn 7059: }
7060: }
1.609 raeburn 7061: if ($match) {
7062: push(@{$seclists{$student}},$section);
7063: if (ref($userdata) eq 'HASH') {
7064: $$userdata{$student} = $$classlist{$student};
7065: }
7066: if (ref($statushash) eq 'HASH') {
7067: $statushash->{$student}{'st'}{$section} = $status;
7068: }
1.288 raeburn 7069: }
1.275 raeburn 7070: }
7071: }
1.412 raeburn 7072: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7073: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7074: my $now = time;
1.609 raeburn 7075: my %displaystatus = ( previous => 'Expired',
7076: active => 'Active',
7077: future => 'Future',
7078: );
1.630 raeburn 7079: my %nothide;
7080: if ($hidepriv) {
7081: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7082: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7083: if ($user !~ /:/) {
7084: $nothide{join(':',split(/[\@]/,$user))}=1;
7085: } else {
7086: $nothide{$user} = 1;
7087: }
7088: }
7089: }
1.439 raeburn 7090: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7091: my $match = 0;
1.412 raeburn 7092: my $secmatch = 0;
1.439 raeburn 7093: my $status;
1.412 raeburn 7094: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7095: $user =~ s/:$//;
1.439 raeburn 7096: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7097: if ($end == -1 || $start == -1) {
7098: next;
7099: }
7100: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7101: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7102: my ($uname,$udom) = split(/:/,$user);
7103: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7104: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7105: $secmatch = 1;
7106: } elsif ($usec eq '') {
1.420 albertel 7107: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7108: $secmatch = 1;
7109: }
7110: } else {
7111: if (grep(/^\Q$usec\E$/,@{$sections})) {
7112: $secmatch = 1;
7113: }
7114: }
7115: if (!$secmatch) {
7116: next;
7117: }
1.288 raeburn 7118: }
1.419 raeburn 7119: if ($usec eq '') {
7120: $usec = 'none';
7121: }
1.275 raeburn 7122: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7123: if ($hidepriv) {
7124: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7125: (!$nothide{$uname.':'.$udom})) {
7126: next;
7127: }
7128: }
1.503 raeburn 7129: if ($end > 0 && $end < $now) {
1.439 raeburn 7130: $status = 'previous';
7131: } elsif ($start > $now) {
7132: $status = 'future';
7133: } else {
7134: $status = 'active';
7135: }
1.277 albertel 7136: foreach my $type (keys(%{$types})) {
1.275 raeburn 7137: if ($status eq $type) {
1.420 albertel 7138: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7139: push(@{$$users{$role}{$user}},$type);
7140: }
1.288 raeburn 7141: $match = 1;
7142: }
7143: }
1.419 raeburn 7144: if (($match) && (ref($userdata) eq 'HASH')) {
7145: if (!exists($$userdata{$uname.':'.$udom})) {
7146: &get_user_info($udom,$uname,\%idx,$userdata);
7147: }
1.420 albertel 7148: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7149: push(@{$seclists{$uname.':'.$udom}},$usec);
7150: }
1.609 raeburn 7151: if (ref($statushash) eq 'HASH') {
7152: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7153: }
1.275 raeburn 7154: }
7155: }
7156: }
7157: }
1.290 albertel 7158: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7159: if ((defined($cdom)) && (defined($cnum))) {
7160: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7161: if ( defined($csettings{'internal.courseowner'}) ) {
7162: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7163: next if ($owner eq '');
7164: my ($ownername,$ownerdom);
7165: if ($owner =~ /^([^:]+):([^:]+)$/) {
7166: $ownername = $1;
7167: $ownerdom = $2;
7168: } else {
7169: $ownername = $owner;
7170: $ownerdom = $cdom;
7171: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7172: }
7173: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7174: if (defined($userdata) &&
1.609 raeburn 7175: !exists($$userdata{$owner})) {
7176: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7177: if (!grep(/^none$/,@{$seclists{$owner}})) {
7178: push(@{$seclists{$owner}},'none');
7179: }
7180: if (ref($statushash) eq 'HASH') {
7181: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7182: }
1.290 albertel 7183: }
1.279 raeburn 7184: }
7185: }
7186: }
1.419 raeburn 7187: foreach my $user (keys(%seclists)) {
7188: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7189: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7190: }
1.275 raeburn 7191: }
7192: return;
7193: }
7194:
1.288 raeburn 7195: sub get_user_info {
7196: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7197: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7198: &plainname($uname,$udom,'lastname');
1.291 albertel 7199: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7200: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7201: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7202: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7203: return;
7204: }
1.275 raeburn 7205:
1.472 raeburn 7206: ###############################################
7207:
7208: =pod
7209:
7210: =item * &get_user_quota()
7211:
7212: Retrieves quota assigned for storage of portfolio files for a user
7213:
7214: Incoming parameters:
7215: 1. user's username
7216: 2. user's domain
7217:
7218: Returns:
1.536 raeburn 7219: 1. Disk quota (in Mb) assigned to student.
7220: 2. (Optional) Type of setting: custom or default
7221: (individually assigned or default for user's
7222: institutional status).
7223: 3. (Optional) - User's institutional status (e.g., faculty, staff
7224: or student - types as defined in localenroll::inst_usertypes
7225: for user's domain, which determines default quota for user.
7226: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7227:
7228: If a value has been stored in the user's environment,
1.536 raeburn 7229: it will return that, otherwise it returns the maximal default
7230: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7231:
7232: =cut
7233:
7234: ###############################################
7235:
7236:
7237: sub get_user_quota {
7238: my ($uname,$udom) = @_;
1.536 raeburn 7239: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7240: if (!defined($udom)) {
7241: $udom = $env{'user.domain'};
7242: }
7243: if (!defined($uname)) {
7244: $uname = $env{'user.name'};
7245: }
7246: if (($udom eq '' || $uname eq '') ||
7247: ($udom eq 'public') && ($uname eq 'public')) {
7248: $quota = 0;
1.536 raeburn 7249: $quotatype = 'default';
7250: $defquota = 0;
1.472 raeburn 7251: } else {
1.536 raeburn 7252: my $inststatus;
1.472 raeburn 7253: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7254: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7255: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7256: } else {
1.536 raeburn 7257: my %userenv =
7258: &Apache::lonnet::get('environment',['portfolioquota',
7259: 'inststatus'],$udom,$uname);
1.472 raeburn 7260: my ($tmp) = keys(%userenv);
7261: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7262: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7263: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7264: } else {
7265: undef(%userenv);
7266: }
7267: }
1.536 raeburn 7268: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7269: if ($quota eq '') {
1.536 raeburn 7270: $quota = $defquota;
7271: $quotatype = 'default';
7272: } else {
7273: $quotatype = 'custom';
1.472 raeburn 7274: }
7275: }
1.536 raeburn 7276: if (wantarray) {
7277: return ($quota,$quotatype,$settingstatus,$defquota);
7278: } else {
7279: return $quota;
7280: }
1.472 raeburn 7281: }
7282:
7283: ###############################################
7284:
7285: =pod
7286:
7287: =item * &default_quota()
7288:
1.536 raeburn 7289: Retrieves default quota assigned for storage of user portfolio files,
7290: given an (optional) user's institutional status.
1.472 raeburn 7291:
7292: Incoming parameters:
7293: 1. domain
1.536 raeburn 7294: 2. (Optional) institutional status(es). This is a : separated list of
7295: status types (e.g., faculty, staff, student etc.)
7296: which apply to the user for whom the default is being retrieved.
7297: If the institutional status string in undefined, the domain
7298: default quota will be returned.
1.472 raeburn 7299:
7300: Returns:
7301: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7302: 2. (Optional) institutional type which determined the value of the
7303: default quota.
1.472 raeburn 7304:
7305: If a value has been stored in the domain's configuration db,
7306: it will return that, otherwise it returns 20 (for backwards
7307: compatibility with domains which have not set up a configuration
7308: db file; the original statically defined portfolio quota was 20 Mb).
7309:
1.536 raeburn 7310: If the user's status includes multiple types (e.g., staff and student),
7311: the largest default quota which applies to the user determines the
7312: default quota returned.
7313:
1.780 raeburn 7314: =back
7315:
1.472 raeburn 7316: =cut
7317:
7318: ###############################################
7319:
7320:
7321: sub default_quota {
1.536 raeburn 7322: my ($udom,$inststatus) = @_;
7323: my ($defquota,$settingstatus);
7324: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7325: ['quotas'],$udom);
7326: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7327: if ($inststatus ne '') {
1.765 raeburn 7328: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7329: foreach my $item (@statuses) {
1.711 raeburn 7330: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7331: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7332: if ($defquota eq '') {
7333: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7334: $settingstatus = $item;
7335: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7336: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7337: $settingstatus = $item;
7338: }
7339: }
7340: } else {
7341: if ($quotahash{'quotas'}{$item} ne '') {
7342: if ($defquota eq '') {
7343: $defquota = $quotahash{'quotas'}{$item};
7344: $settingstatus = $item;
7345: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7346: $defquota = $quotahash{'quotas'}{$item};
7347: $settingstatus = $item;
7348: }
1.536 raeburn 7349: }
7350: }
7351: }
7352: }
7353: if ($defquota eq '') {
1.711 raeburn 7354: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7355: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7356: } else {
7357: $defquota = $quotahash{'quotas'}{'default'};
7358: }
1.536 raeburn 7359: $settingstatus = 'default';
7360: }
7361: } else {
7362: $settingstatus = 'default';
7363: $defquota = 20;
7364: }
7365: if (wantarray) {
7366: return ($defquota,$settingstatus);
1.472 raeburn 7367: } else {
1.536 raeburn 7368: return $defquota;
1.472 raeburn 7369: }
7370: }
7371:
1.384 raeburn 7372: sub get_secgrprole_info {
7373: my ($cdom,$cnum,$needroles,$type) = @_;
7374: my %sections_count = &get_sections($cdom,$cnum);
7375: my @sections = (sort {$a <=> $b} keys(%sections_count));
7376: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7377: my @groups = sort(keys(%curr_groups));
7378: my $allroles = [];
7379: my $rolehash;
7380: my $accesshash = {
7381: active => 'Currently has access',
7382: future => 'Will have future access',
7383: previous => 'Previously had access',
7384: };
7385: if ($needroles) {
7386: $rolehash = {'all' => 'all'};
1.385 albertel 7387: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7388: if (&Apache::lonnet::error(%user_roles)) {
7389: undef(%user_roles);
7390: }
7391: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7392: my ($role)=split(/\:/,$item,2);
7393: if ($role eq 'cr') { next; }
7394: if ($role =~ /^cr/) {
7395: $$rolehash{$role} = (split('/',$role))[3];
7396: } else {
7397: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7398: }
7399: }
7400: foreach my $key (sort(keys(%{$rolehash}))) {
7401: push(@{$allroles},$key);
7402: }
7403: push (@{$allroles},'st');
7404: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7405: }
7406: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7407: }
7408:
1.555 raeburn 7409: sub user_picker {
1.627 raeburn 7410: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7411: my $currdom = $dom;
7412: my %curr_selected = (
7413: srchin => 'dom',
1.580 raeburn 7414: srchby => 'lastname',
1.555 raeburn 7415: );
7416: my $srchterm;
1.625 raeburn 7417: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7418: if ($srch->{'srchby'} ne '') {
7419: $curr_selected{'srchby'} = $srch->{'srchby'};
7420: }
7421: if ($srch->{'srchin'} ne '') {
7422: $curr_selected{'srchin'} = $srch->{'srchin'};
7423: }
7424: if ($srch->{'srchtype'} ne '') {
7425: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7426: }
7427: if ($srch->{'srchdomain'} ne '') {
7428: $currdom = $srch->{'srchdomain'};
7429: }
7430: $srchterm = $srch->{'srchterm'};
7431: }
7432: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7433: 'usr' => 'Search criteria',
1.563 raeburn 7434: 'doma' => 'Domain/institution to search',
1.558 albertel 7435: 'uname' => 'username',
7436: 'lastname' => 'last name',
1.555 raeburn 7437: 'lastfirst' => 'last name, first name',
1.558 albertel 7438: 'crs' => 'in this course',
1.576 raeburn 7439: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7440: 'alc' => 'all LON-CAPA',
1.573 raeburn 7441: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7442: 'exact' => 'is',
7443: 'contains' => 'contains',
1.569 raeburn 7444: 'begins' => 'begins with',
1.571 raeburn 7445: 'youm' => "You must include some text to search for.",
7446: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7447: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7448: 'yomc' => "You must choose a domain when using an institutional directory search.",
7449: 'ymcd' => "You must choose a domain when using a domain search.",
7450: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7451: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7452: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7453: );
1.563 raeburn 7454: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7455: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7456:
7457: my @srchins = ('crs','dom','alc','instd');
7458:
7459: foreach my $option (@srchins) {
7460: # FIXME 'alc' option unavailable until
7461: # loncreateuser::print_user_query_page()
7462: # has been completed.
7463: next if ($option eq 'alc');
7464: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7465: if ($curr_selected{'srchin'} eq $option) {
7466: $srchinsel .= '
7467: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7468: } else {
7469: $srchinsel .= '
7470: <option value="'.$option.'">'.$lt{$option}.'</option>';
7471: }
1.555 raeburn 7472: }
1.563 raeburn 7473: $srchinsel .= "\n </select>\n";
1.555 raeburn 7474:
7475: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7476: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7477: if ($curr_selected{'srchby'} eq $option) {
7478: $srchbysel .= '
7479: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7480: } else {
7481: $srchbysel .= '
7482: <option value="'.$option.'">'.$lt{$option}.'</option>';
7483: }
7484: }
7485: $srchbysel .= "\n </select>\n";
7486:
7487: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7488: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7489: if ($curr_selected{'srchtype'} eq $option) {
7490: $srchtypesel .= '
7491: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7492: } else {
7493: $srchtypesel .= '
7494: <option value="'.$option.'">'.$lt{$option}.'</option>';
7495: }
7496: }
7497: $srchtypesel .= "\n </select>\n";
7498:
1.558 albertel 7499: my ($newuserscript,$new_user_create);
1.556 raeburn 7500:
7501: if ($forcenewuser) {
1.576 raeburn 7502: if (ref($srch) eq 'HASH') {
7503: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7504: if ($cancreate) {
7505: $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>';
7506: } else {
1.799 bisitz 7507: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7508: my %usertypetext = (
7509: official => 'institutional',
7510: unofficial => 'non-institutional',
7511: );
1.799 bisitz 7512: $new_user_create = '<p class="LC_warning">'
7513: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7514: .' '
7515: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7516: ,'<a href="'.$helplink.'">','</a>')
7517: .'</p><br />';
1.627 raeburn 7518: }
1.576 raeburn 7519: }
7520: }
7521:
1.556 raeburn 7522: $newuserscript = <<"ENDSCRIPT";
7523:
1.570 raeburn 7524: function setSearch(createnew,callingForm) {
1.556 raeburn 7525: if (createnew == 1) {
1.570 raeburn 7526: for (var i=0; i<callingForm.srchby.length; i++) {
7527: if (callingForm.srchby.options[i].value == 'uname') {
7528: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7529: }
7530: }
1.570 raeburn 7531: for (var i=0; i<callingForm.srchin.length; i++) {
7532: if ( callingForm.srchin.options[i].value == 'dom') {
7533: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7534: }
7535: }
1.570 raeburn 7536: for (var i=0; i<callingForm.srchtype.length; i++) {
7537: if (callingForm.srchtype.options[i].value == 'exact') {
7538: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7539: }
7540: }
1.570 raeburn 7541: for (var i=0; i<callingForm.srchdomain.length; i++) {
7542: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7543: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7544: }
7545: }
7546: }
7547: }
7548: ENDSCRIPT
1.558 albertel 7549:
1.556 raeburn 7550: }
7551:
1.555 raeburn 7552: my $output = <<"END_BLOCK";
1.556 raeburn 7553: <script type="text/javascript">
1.570 raeburn 7554: function validateEntry(callingForm) {
1.558 albertel 7555:
1.556 raeburn 7556: var checkok = 1;
1.558 albertel 7557: var srchin;
1.570 raeburn 7558: for (var i=0; i<callingForm.srchin.length; i++) {
7559: if ( callingForm.srchin[i].checked ) {
7560: srchin = callingForm.srchin[i].value;
1.558 albertel 7561: }
7562: }
7563:
1.570 raeburn 7564: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7565: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7566: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7567: var srchterm = callingForm.srchterm.value;
7568: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7569: var msg = "";
7570:
7571: if (srchterm == "") {
7572: checkok = 0;
1.571 raeburn 7573: msg += "$lt{'youm'}\\n";
1.556 raeburn 7574: }
7575:
1.569 raeburn 7576: if (srchtype== 'begins') {
7577: if (srchterm.length < 2) {
7578: checkok = 0;
1.571 raeburn 7579: msg += "$lt{'thte'}\\n";
1.569 raeburn 7580: }
7581: }
7582:
1.556 raeburn 7583: if (srchtype== 'contains') {
7584: if (srchterm.length < 3) {
7585: checkok = 0;
1.571 raeburn 7586: msg += "$lt{'thet'}\\n";
1.556 raeburn 7587: }
7588: }
7589: if (srchin == 'instd') {
7590: if (srchdomain == '') {
7591: checkok = 0;
1.571 raeburn 7592: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7593: }
7594: }
7595: if (srchin == 'dom') {
7596: if (srchdomain == '') {
7597: checkok = 0;
1.571 raeburn 7598: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7599: }
7600: }
7601: if (srchby == 'lastfirst') {
7602: if (srchterm.indexOf(",") == -1) {
7603: checkok = 0;
1.571 raeburn 7604: msg += "$lt{'whus'}\\n";
1.556 raeburn 7605: }
7606: if (srchterm.indexOf(",") == srchterm.length -1) {
7607: checkok = 0;
1.571 raeburn 7608: msg += "$lt{'whse'}\\n";
1.556 raeburn 7609: }
7610: }
7611: if (checkok == 0) {
1.571 raeburn 7612: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7613: return;
7614: }
7615: if (checkok == 1) {
1.570 raeburn 7616: callingForm.submit();
1.556 raeburn 7617: }
7618: }
7619:
7620: $newuserscript
7621:
7622: </script>
1.558 albertel 7623:
7624: $new_user_create
7625:
1.555 raeburn 7626: <table>
1.558 albertel 7627: <tr>
1.573 raeburn 7628: <td>$lt{'doma'}:</td>
7629: <td>$domform</td>
7630: </td>
7631: </tr>
7632: <tr>
7633: <td>$lt{'usr'}:</td>
1.563 raeburn 7634: <td>$srchbysel
7635: $srchtypesel
7636: <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564 albertel 7637: $srchinsel
1.563 raeburn 7638: </td>
7639: </tr>
1.555 raeburn 7640: </table>
7641: <br />
7642: END_BLOCK
1.558 albertel 7643:
1.555 raeburn 7644: return $output;
7645: }
7646:
1.612 raeburn 7647: sub user_rule_check {
1.615 raeburn 7648: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7649: my $response;
7650: if (ref($usershash) eq 'HASH') {
7651: foreach my $user (keys(%{$usershash})) {
7652: my ($uname,$udom) = split(/:/,$user);
7653: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7654: my ($id,$newuser);
1.612 raeburn 7655: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7656: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7657: $id = $usershash->{$user}->{'id'};
7658: }
7659: my $inst_response;
7660: if (ref($checks) eq 'HASH') {
7661: if (defined($checks->{'username'})) {
1.615 raeburn 7662: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7663: &Apache::lonnet::get_instuser($udom,$uname);
7664: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7665: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7666: &Apache::lonnet::get_instuser($udom,undef,$id);
7667: }
1.615 raeburn 7668: } else {
7669: ($inst_response,%{$inst_results->{$user}}) =
7670: &Apache::lonnet::get_instuser($udom,$uname);
7671: return;
1.612 raeburn 7672: }
1.615 raeburn 7673: if (!$got_rules->{$udom}) {
1.612 raeburn 7674: my %domconfig = &Apache::lonnet::get_dom('configuration',
7675: ['usercreation'],$udom);
7676: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7677: foreach my $item ('username','id') {
1.612 raeburn 7678: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7679: $$curr_rules{$udom}{$item} =
7680: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7681: }
7682: }
7683: }
1.615 raeburn 7684: $got_rules->{$udom} = 1;
1.585 raeburn 7685: }
1.612 raeburn 7686: foreach my $item (keys(%{$checks})) {
7687: if (ref($$curr_rules{$udom}) eq 'HASH') {
7688: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7689: if (@{$$curr_rules{$udom}{$item}} > 0) {
7690: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7691: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7692: if ($rule_check{$rule}) {
7693: $$rulematch{$user}{$item} = $rule;
7694: if ($inst_response eq 'ok') {
1.615 raeburn 7695: if (ref($inst_results) eq 'HASH') {
7696: if (ref($inst_results->{$user}) eq 'HASH') {
7697: if (keys(%{$inst_results->{$user}}) == 0) {
7698: $$alerts{$item}{$udom}{$uname} = 1;
7699: }
1.612 raeburn 7700: }
7701: }
1.615 raeburn 7702: }
7703: last;
1.585 raeburn 7704: }
7705: }
7706: }
7707: }
7708: }
7709: }
7710: }
7711: }
1.612 raeburn 7712: return;
7713: }
7714:
7715: sub user_rule_formats {
7716: my ($domain,$domdesc,$curr_rules,$check) = @_;
7717: my %text = (
7718: 'username' => 'Usernames',
7719: 'id' => 'IDs',
7720: );
7721: my $output;
7722: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7723: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7724: if (@{$ruleorder} > 0) {
7725: $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>';
7726: foreach my $rule (@{$ruleorder}) {
7727: if (ref($curr_rules) eq 'ARRAY') {
7728: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7729: if (ref($rules->{$rule}) eq 'HASH') {
7730: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7731: $rules->{$rule}{'desc'}.'</li>';
7732: }
7733: }
7734: }
7735: }
7736: $output .= '</ul>';
7737: }
7738: }
7739: return $output;
7740: }
7741:
7742: sub instrule_disallow_msg {
1.615 raeburn 7743: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7744: my $response;
7745: my %text = (
7746: item => 'username',
7747: items => 'usernames',
7748: match => 'matches',
7749: do => 'does',
7750: action => 'a username',
7751: one => 'one',
7752: );
7753: if ($count > 1) {
7754: $text{'item'} = 'usernames';
7755: $text{'match'} ='match';
7756: $text{'do'} = 'do';
7757: $text{'action'} = 'usernames',
7758: $text{'one'} = 'ones';
7759: }
7760: if ($checkitem eq 'id') {
7761: $text{'items'} = 'IDs';
7762: $text{'item'} = 'ID';
7763: $text{'action'} = 'an ID';
1.615 raeburn 7764: if ($count > 1) {
7765: $text{'item'} = 'IDs';
7766: $text{'action'} = 'IDs';
7767: }
1.612 raeburn 7768: }
1.674 bisitz 7769: $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 7770: if ($mode eq 'upload') {
7771: if ($checkitem eq 'username') {
7772: $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'}.");
7773: } elsif ($checkitem eq 'id') {
1.674 bisitz 7774: $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 7775: }
1.669 raeburn 7776: } elsif ($mode eq 'selfcreate') {
7777: if ($checkitem eq 'id') {
7778: $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.");
7779: }
1.615 raeburn 7780: } else {
7781: if ($checkitem eq 'username') {
7782: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
7783: } elsif ($checkitem eq 'id') {
7784: $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.");
7785: }
1.612 raeburn 7786: }
7787: return $response;
1.585 raeburn 7788: }
7789:
1.624 raeburn 7790: sub personal_data_fieldtitles {
7791: my %fieldtitles = &Apache::lonlocal::texthash (
7792: id => 'Student/Employee ID',
7793: permanentemail => 'E-mail address',
7794: lastname => 'Last Name',
7795: firstname => 'First Name',
7796: middlename => 'Middle Name',
7797: generation => 'Generation',
7798: gen => 'Generation',
1.765 raeburn 7799: inststatus => 'Affiliation',
1.624 raeburn 7800: );
7801: return %fieldtitles;
7802: }
7803:
1.642 raeburn 7804: sub sorted_inst_types {
7805: my ($dom) = @_;
7806: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
7807: my $othertitle = &mt('All users');
7808: if ($env{'request.course.id'}) {
1.668 raeburn 7809: $othertitle = &mt('Any users');
1.642 raeburn 7810: }
7811: my @types;
7812: if (ref($order) eq 'ARRAY') {
7813: @types = @{$order};
7814: }
7815: if (@types == 0) {
7816: if (ref($usertypes) eq 'HASH') {
7817: @types = sort(keys(%{$usertypes}));
7818: }
7819: }
7820: if (keys(%{$usertypes}) > 0) {
7821: $othertitle = &mt('Other users');
7822: }
7823: return ($othertitle,$usertypes,\@types);
7824: }
7825:
1.645 raeburn 7826: sub get_institutional_codes {
7827: my ($settings,$allcourses,$LC_code) = @_;
7828: # Get complete list of course sections to update
7829: my @currsections = ();
7830: my @currxlists = ();
7831: my $coursecode = $$settings{'internal.coursecode'};
7832:
7833: if ($$settings{'internal.sectionnums'} ne '') {
7834: @currsections = split(/,/,$$settings{'internal.sectionnums'});
7835: }
7836:
7837: if ($$settings{'internal.crosslistings'} ne '') {
7838: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
7839: }
7840:
7841: if (@currxlists > 0) {
7842: foreach (@currxlists) {
7843: if (m/^([^:]+):(\w*)$/) {
7844: unless (grep/^$1$/,@{$allcourses}) {
7845: push @{$allcourses},$1;
7846: $$LC_code{$1} = $2;
7847: }
7848: }
7849: }
7850: }
7851:
7852: if (@currsections > 0) {
7853: foreach (@currsections) {
7854: if (m/^(\w+):(\w*)$/) {
7855: my $sec = $coursecode.$1;
7856: my $lc_sec = $2;
7857: unless (grep/^$sec$/,@{$allcourses}) {
7858: push @{$allcourses},$sec;
7859: $$LC_code{$sec} = $lc_sec;
7860: }
7861: }
7862: }
7863: }
7864: return;
7865: }
7866:
1.112 bowersj2 7867: =pod
7868:
1.780 raeburn 7869: =head1 Slot Helpers
7870:
7871: =over 4
7872:
7873: =item * sorted_slots()
7874:
7875: Sorts an array of slot names in order of slot start time (earliest first).
7876:
7877: Inputs:
7878:
7879: =over 4
7880:
7881: slotsarr - Reference to array of unsorted slot names.
7882:
7883: slots - Reference to hash of hash, where outer hash keys are slot names.
7884:
1.549 albertel 7885: =back
7886:
1.780 raeburn 7887: Returns:
7888:
7889: =over 4
7890:
7891: sorted - An array of slot names sorted by the start time of the slot.
7892:
7893: =back
7894:
7895: =back
7896:
7897: =cut
7898:
7899:
7900: sub sorted_slots {
7901: my ($slotsarr,$slots) = @_;
7902: my @sorted;
7903: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
7904: @sorted =
7905: sort {
7906: if (ref($slots->{$a}) && ref($slots->{$b})) {
7907: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
7908: }
7909: if (ref($slots->{$a})) { return -1;}
7910: if (ref($slots->{$b})) { return 1;}
7911: return 0;
7912: } @{$slotsarr};
7913: }
7914: return @sorted;
7915: }
7916:
7917:
7918: =pod
7919:
1.549 albertel 7920: =head1 HTTP Helpers
7921:
7922: =over 4
7923:
1.648 raeburn 7924: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 7925:
1.258 albertel 7926: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 7927: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 7928: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 7929:
7930: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
7931: $possible_names is an ref to an array of form element names. As an example:
7932: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 7933: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 7934:
7935: =cut
1.1 albertel 7936:
1.6 albertel 7937: sub get_unprocessed_cgi {
1.25 albertel 7938: my ($query,$possible_names)= @_;
1.26 matthew 7939: # $Apache::lonxml::debug=1;
1.356 albertel 7940: foreach my $pair (split(/&/,$query)) {
7941: my ($name, $value) = split(/=/,$pair);
1.369 www 7942: $name = &unescape($name);
1.25 albertel 7943: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
7944: $value =~ tr/+/ /;
7945: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 7946: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 7947: }
1.16 harris41 7948: }
1.6 albertel 7949: }
7950:
1.112 bowersj2 7951: =pod
7952:
1.648 raeburn 7953: =item * &cacheheader()
1.112 bowersj2 7954:
7955: returns cache-controlling header code
7956:
7957: =cut
7958:
1.7 albertel 7959: sub cacheheader {
1.258 albertel 7960: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 7961: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
7962: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 7963: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
7964: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 7965: return $output;
1.7 albertel 7966: }
7967:
1.112 bowersj2 7968: =pod
7969:
1.648 raeburn 7970: =item * &no_cache($r)
1.112 bowersj2 7971:
7972: specifies header code to not have cache
7973:
7974: =cut
7975:
1.9 albertel 7976: sub no_cache {
1.216 albertel 7977: my ($r) = @_;
7978: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 7979: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 7980: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
7981: $r->no_cache(1);
7982: $r->header_out("Expires" => $date);
7983: $r->header_out("Pragma" => "no-cache");
1.123 www 7984: }
7985:
7986: sub content_type {
1.181 albertel 7987: my ($r,$type,$charset) = @_;
1.299 foxr 7988: if ($r) {
7989: # Note that printout.pl calls this with undef for $r.
7990: &no_cache($r);
7991: }
1.258 albertel 7992: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 7993: unless ($charset) {
7994: $charset=&Apache::lonlocal::current_encoding;
7995: }
7996: if ($charset) { $type.='; charset='.$charset; }
7997: if ($r) {
7998: $r->content_type($type);
7999: } else {
8000: print("Content-type: $type\n\n");
8001: }
1.9 albertel 8002: }
1.25 albertel 8003:
1.112 bowersj2 8004: =pod
8005:
1.648 raeburn 8006: =item * &add_to_env($name,$value)
1.112 bowersj2 8007:
1.258 albertel 8008: adds $name to the %env hash with value
1.112 bowersj2 8009: $value, if $name already exists, the entry is converted to an array
8010: reference and $value is added to the array.
8011:
8012: =cut
8013:
1.25 albertel 8014: sub add_to_env {
8015: my ($name,$value)=@_;
1.258 albertel 8016: if (defined($env{$name})) {
8017: if (ref($env{$name})) {
1.25 albertel 8018: #already have multiple values
1.258 albertel 8019: push(@{ $env{$name} },$value);
1.25 albertel 8020: } else {
8021: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8022: my $first=$env{$name};
8023: undef($env{$name});
8024: push(@{ $env{$name} },$first,$value);
1.25 albertel 8025: }
8026: } else {
1.258 albertel 8027: $env{$name}=$value;
1.25 albertel 8028: }
1.31 albertel 8029: }
1.149 albertel 8030:
8031: =pod
8032:
1.648 raeburn 8033: =item * &get_env_multiple($name)
1.149 albertel 8034:
1.258 albertel 8035: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8036: values may be defined and end up as an array ref.
8037:
8038: returns an array of values
8039:
8040: =cut
8041:
8042: sub get_env_multiple {
8043: my ($name) = @_;
8044: my @values;
1.258 albertel 8045: if (defined($env{$name})) {
1.149 albertel 8046: # exists is it an array
1.258 albertel 8047: if (ref($env{$name})) {
8048: @values=@{ $env{$name} };
1.149 albertel 8049: } else {
1.258 albertel 8050: $values[0]=$env{$name};
1.149 albertel 8051: }
8052: }
8053: return(@values);
8054: }
8055:
1.660 raeburn 8056: sub ask_for_embedded_content {
8057: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
8058: my $upload_output = '
8059: <form name="upload_embedded" action="'.$actionurl.'"
8060: method="post" enctype="multipart/form-data">';
8061: $upload_output .= $state;
1.661 raeburn 8062: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 8063:
8064: my $num = 0;
8065: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
8066: $upload_output .= &start_data_table_row().
8067: '<td>'.$embed_file.'</td><td>';
8068: if ($args->{'ignore_remote_references'}
8069: && $embed_file =~ m{^\w+://}) {
8070: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
8071: } elsif ($args->{'error_on_invalid_names'}
8072: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8073:
8074: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
8075:
8076: } else {
8077: $upload_output .='
1.661 raeburn 8078: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 8079: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
8080: my $attrib = join(':',@{$$allfiles{$embed_file}});
8081: $upload_output .=
8082: "\n\t\t".
8083: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8084: $attrib.'" />';
8085: if (exists($$codebase{$embed_file})) {
8086: $upload_output .=
8087: "\n\t\t".
8088: '<input name="codebase_'.$num.'" type="hidden" value="'.
8089: &escape($$codebase{$embed_file}).'" />';
8090: }
8091: }
8092: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
8093: $num++;
8094: }
8095: $upload_output .= &Apache::loncommon::end_data_table().'<br />
8096: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
8097: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
8098: '.&mt('(only files for which a location has been provided will be uploaded)').'
8099: </form>';
8100: return $upload_output;
8101: }
8102:
1.661 raeburn 8103: sub upload_embedded {
8104: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
8105: $current_disk_usage) = @_;
8106: my $output;
8107: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8108: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8109: my $orig_uploaded_filename =
8110: $env{'form.embedded_item_'.$i.'.filename'};
8111:
8112: $env{'form.embedded_orig_'.$i} =
8113: &unescape($env{'form.embedded_orig_'.$i});
8114: my ($path,$fname) =
8115: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8116: # no path, whole string is fname
8117: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8118:
8119: $path = $env{'form.currentpath'}.$path;
8120: $fname = &Apache::lonnet::clean_filename($fname);
8121: # See if there is anything left
8122: next if ($fname eq '');
8123:
8124: # Check if file already exists as a file or directory.
8125: my ($state,$msg);
8126: if ($context eq 'portfolio') {
8127: my $port_path = $dirpath;
8128: if ($group ne '') {
8129: $port_path = "groups/$group/$port_path";
8130: }
8131: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
8132: $dir_root,$port_path,$disk_quota,
8133: $current_disk_usage,$uname,$udom);
8134: if ($state eq 'will_exceed_quota'
8135: || $state eq 'file_locked'
8136: || $state eq 'file_exists' ) {
8137: $output .= $msg;
8138: next;
8139: }
8140: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8141: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8142: if ($state eq 'exists') {
8143: $output .= $msg;
8144: next;
8145: }
8146: }
8147: # Check if extension is valid
8148: if (($fname =~ /\.(\w+)$/) &&
8149: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
8150: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
8151: next;
8152: } elsif (($fname =~ /\.(\w+)$/) &&
8153: (!defined(&Apache::loncommon::fileembstyle($1)))) {
8154: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
8155: next;
8156: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
8157: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
8158: next;
8159: }
8160:
8161: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8162: if ($context eq 'portfolio') {
8163: my $result=
8164: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
8165: $dirpath.$path);
8166: if ($result !~ m|^/uploaded/|) {
8167: $output .= '<span class="LC_error">'
8168: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8169: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8170: .'</span><br />';
8171: next;
8172: } else {
8173: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
8174: $path.$fname.'</span>').'</p>';
8175: }
8176: } else {
8177: # Save the file
8178: my $target = $env{'form.embedded_item_'.$i};
8179: my $fullpath = $dir_root.$dirpath.'/'.$path;
8180: my $dest = $fullpath.$fname;
8181: my $url = $url_root.$dirpath.'/'.$path.$fname;
8182: my @parts=split(/\//,$fullpath);
8183: my $count;
8184: my $filepath = $dir_root;
8185: for ($count=4;$count<=$#parts;$count++) {
8186: $filepath .= "/$parts[$count]";
8187: if ((-e $filepath)!=1) {
8188: mkdir($filepath,0770);
8189: }
8190: }
8191: my $fh;
8192: if (!open($fh,'>'.$dest)) {
8193: &Apache::lonnet::logthis('Failed to create '.$dest);
8194: $output .= '<span class="LC_error">'.
8195: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8196: '</span><br />';
8197: } else {
8198: if (!print $fh $env{'form.embedded_item_'.$i}) {
8199: &Apache::lonnet::logthis('Failed to write to '.$dest);
8200: $output .= '<span class="LC_error">'.
8201: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8202: '</span><br />';
8203: } else {
8204: if ($context eq 'testbank') {
8205: $output .= &mt('Embedded file uploaded successfully:').
8206: ' <a href="'.$url.'">'.
8207: $orig_uploaded_filename.'</a><br />';
8208: } else {
1.705 tempelho 8209: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 8210: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 8211: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 8212: }
8213: }
8214: close($fh);
8215: }
8216: }
8217: }
8218: return $output;
8219: }
8220:
8221: sub check_for_existing {
8222: my ($path,$fname,$element) = @_;
8223: my ($state,$msg);
8224: if (-d $path.'/'.$fname) {
8225: $state = 'exists';
8226: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8227: } elsif (-e $path.'/'.$fname) {
8228: $state = 'exists';
8229: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8230: }
8231: if ($state eq 'exists') {
8232: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8233: }
8234: return ($state,$msg);
8235: }
8236:
8237: sub check_for_upload {
8238: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8239: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
8240: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
8241: my $getpropath = 1;
8242: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8243: $getpropath);
8244: my $found_file = 0;
8245: my $locked_file = 0;
8246: foreach my $line (@dir_list) {
8247: my ($file_name)=split(/\&/,$line,2);
8248: if ($file_name eq $fname){
8249: $file_name = $path.$file_name;
8250: if ($group ne '') {
8251: $file_name = $group.$file_name;
8252: }
8253: $found_file = 1;
8254: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8255: $locked_file = 1;
8256: }
8257: }
8258: }
8259: if (($current_disk_usage + $filesize) > $disk_quota){
8260: my $msg = '<span class="LC_error">'.
8261: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8262: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8263: return ('will_exceed_quota',$msg);
8264: } elsif ($found_file) {
8265: if ($locked_file) {
8266: my $msg = '<span class="LC_error">';
8267: $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>');
8268: $msg .= '</span><br />';
8269: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8270: return ('file_locked',$msg);
8271: } else {
8272: my $msg = '<span class="LC_error">';
8273: $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'});
8274: $msg .= '</span>';
8275: $msg .= '<br />';
8276: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8277: return ('file_exists',$msg);
8278: }
8279: }
8280: }
8281:
1.31 albertel 8282:
1.41 ng 8283: =pod
1.45 matthew 8284:
1.464 albertel 8285: =back
1.41 ng 8286:
1.112 bowersj2 8287: =head1 CSV Upload/Handling functions
1.38 albertel 8288:
1.41 ng 8289: =over 4
8290:
1.648 raeburn 8291: =item * &upfile_store($r)
1.41 ng 8292:
8293: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 8294: needs $env{'form.upfile'}
1.41 ng 8295: returns $datatoken to be put into hidden field
8296:
8297: =cut
1.31 albertel 8298:
8299: sub upfile_store {
8300: my $r=shift;
1.258 albertel 8301: $env{'form.upfile'}=~s/\r/\n/gs;
8302: $env{'form.upfile'}=~s/\f/\n/gs;
8303: $env{'form.upfile'}=~s/\n+/\n/gs;
8304: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 8305:
1.258 albertel 8306: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8307: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 8308: {
1.158 raeburn 8309: my $datafile = $r->dir_config('lonDaemons').
8310: '/tmp/'.$datatoken.'.tmp';
8311: if ( open(my $fh,">$datafile") ) {
1.258 albertel 8312: print $fh $env{'form.upfile'};
1.158 raeburn 8313: close($fh);
8314: }
1.31 albertel 8315: }
8316: return $datatoken;
8317: }
8318:
1.56 matthew 8319: =pod
8320:
1.648 raeburn 8321: =item * &load_tmp_file($r)
1.41 ng 8322:
8323: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 8324: needs $env{'form.datatoken'},
8325: sets $env{'form.upfile'} to the contents of the file
1.41 ng 8326:
8327: =cut
1.31 albertel 8328:
8329: sub load_tmp_file {
8330: my $r=shift;
8331: my @studentdata=();
8332: {
1.158 raeburn 8333: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 8334: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 8335: if ( open(my $fh,"<$studentfile") ) {
8336: @studentdata=<$fh>;
8337: close($fh);
8338: }
1.31 albertel 8339: }
1.258 albertel 8340: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 8341: }
8342:
1.56 matthew 8343: =pod
8344:
1.648 raeburn 8345: =item * &upfile_record_sep()
1.41 ng 8346:
8347: Separate uploaded file into records
8348: returns array of records,
1.258 albertel 8349: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8350:
8351: =cut
1.31 albertel 8352:
8353: sub upfile_record_sep {
1.258 albertel 8354: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8355: } else {
1.248 albertel 8356: my @records;
1.258 albertel 8357: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8358: if ($line=~/^\s*$/) { next; }
8359: push(@records,$line);
8360: }
8361: return @records;
1.31 albertel 8362: }
8363: }
8364:
1.56 matthew 8365: =pod
8366:
1.648 raeburn 8367: =item * &record_sep($record)
1.41 ng 8368:
1.258 albertel 8369: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8370:
8371: =cut
8372:
1.263 www 8373: sub takeleft {
8374: my $index=shift;
8375: return substr('0000'.$index,-4,4);
8376: }
8377:
1.31 albertel 8378: sub record_sep {
8379: my $record=shift;
8380: my %components=();
1.258 albertel 8381: if ($env{'form.upfiletype'} eq 'xml') {
8382: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8383: my $i=0;
1.356 albertel 8384: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8385: $field=~s/^(\"|\')//;
8386: $field=~s/(\"|\')$//;
1.263 www 8387: $components{&takeleft($i)}=$field;
1.31 albertel 8388: $i++;
8389: }
1.258 albertel 8390: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8391: my $i=0;
1.356 albertel 8392: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8393: $field=~s/^(\"|\')//;
8394: $field=~s/(\"|\')$//;
1.263 www 8395: $components{&takeleft($i)}=$field;
1.31 albertel 8396: $i++;
8397: }
8398: } else {
1.561 www 8399: my $separator=',';
1.480 banghart 8400: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8401: $separator=';';
1.480 banghart 8402: }
1.31 albertel 8403: my $i=0;
1.561 www 8404: # the character we are looking for to indicate the end of a quote or a record
8405: my $looking_for=$separator;
8406: # do not add the characters to the fields
8407: my $ignore=0;
8408: # we just encountered a separator (or the beginning of the record)
8409: my $just_found_separator=1;
8410: # store the field we are working on here
8411: my $field='';
8412: # work our way through all characters in record
8413: foreach my $character ($record=~/(.)/g) {
8414: if ($character eq $looking_for) {
8415: if ($character ne $separator) {
8416: # Found the end of a quote, again looking for separator
8417: $looking_for=$separator;
8418: $ignore=1;
8419: } else {
8420: # Found a separator, store away what we got
8421: $components{&takeleft($i)}=$field;
8422: $i++;
8423: $just_found_separator=1;
8424: $ignore=0;
8425: $field='';
8426: }
8427: next;
8428: }
8429: # single or double quotation marks after a separator indicate beginning of a quote
8430: # we are now looking for the end of the quote and need to ignore separators
8431: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8432: $looking_for=$character;
8433: next;
8434: }
8435: # ignore would be true after we reached the end of a quote
8436: if ($ignore) { next; }
8437: if (($just_found_separator) && ($character=~/\s/)) { next; }
8438: $field.=$character;
8439: $just_found_separator=0;
1.31 albertel 8440: }
1.561 www 8441: # catch the very last entry, since we never encountered the separator
8442: $components{&takeleft($i)}=$field;
1.31 albertel 8443: }
8444: return %components;
8445: }
8446:
1.144 matthew 8447: ######################################################
8448: ######################################################
8449:
1.56 matthew 8450: =pod
8451:
1.648 raeburn 8452: =item * &upfile_select_html()
1.41 ng 8453:
1.144 matthew 8454: Return HTML code to select a file from the users machine and specify
8455: the file type.
1.41 ng 8456:
8457: =cut
8458:
1.144 matthew 8459: ######################################################
8460: ######################################################
1.31 albertel 8461: sub upfile_select_html {
1.144 matthew 8462: my %Types = (
8463: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8464: semisv => &mt('Semicolon separated values'),
1.144 matthew 8465: space => &mt('Space separated'),
8466: tab => &mt('Tabulator separated'),
8467: # xml => &mt('HTML/XML'),
8468: );
8469: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8470: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8471: foreach my $type (sort(keys(%Types))) {
8472: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8473: }
8474: $Str .= "</select>\n";
8475: return $Str;
1.31 albertel 8476: }
8477:
1.301 albertel 8478: sub get_samples {
8479: my ($records,$toget) = @_;
8480: my @samples=({});
8481: my $got=0;
8482: foreach my $rec (@$records) {
8483: my %temp = &record_sep($rec);
8484: if (! grep(/\S/, values(%temp))) { next; }
8485: if (%temp) {
8486: $samples[$got]=\%temp;
8487: $got++;
8488: if ($got == $toget) { last; }
8489: }
8490: }
8491: return \@samples;
8492: }
8493:
1.144 matthew 8494: ######################################################
8495: ######################################################
8496:
1.56 matthew 8497: =pod
8498:
1.648 raeburn 8499: =item * &csv_print_samples($r,$records)
1.41 ng 8500:
8501: Prints a table of sample values from each column uploaded $r is an
8502: Apache Request ref, $records is an arrayref from
8503: &Apache::loncommon::upfile_record_sep
8504:
8505: =cut
8506:
1.144 matthew 8507: ######################################################
8508: ######################################################
1.31 albertel 8509: sub csv_print_samples {
8510: my ($r,$records) = @_;
1.662 bisitz 8511: my $samples = &get_samples($records,5);
1.301 albertel 8512:
1.594 raeburn 8513: $r->print(&mt('Samples').'<br />'.&start_data_table().
8514: &start_data_table_header_row());
1.356 albertel 8515: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8516: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8517: $r->print(&end_data_table_header_row());
1.301 albertel 8518: foreach my $hash (@$samples) {
1.594 raeburn 8519: $r->print(&start_data_table_row());
1.356 albertel 8520: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8521: $r->print('<td>');
1.356 albertel 8522: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8523: $r->print('</td>');
8524: }
1.594 raeburn 8525: $r->print(&end_data_table_row());
1.31 albertel 8526: }
1.594 raeburn 8527: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8528: }
8529:
1.144 matthew 8530: ######################################################
8531: ######################################################
8532:
1.56 matthew 8533: =pod
8534:
1.648 raeburn 8535: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8536:
8537: Prints a table to create associations between values and table columns.
1.144 matthew 8538:
1.41 ng 8539: $r is an Apache Request ref,
8540: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8541: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8542:
8543: =cut
8544:
1.144 matthew 8545: ######################################################
8546: ######################################################
1.31 albertel 8547: sub csv_print_select_table {
8548: my ($r,$records,$d) = @_;
1.301 albertel 8549: my $i=0;
8550: my $samples = &get_samples($records,1);
1.144 matthew 8551: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8552: &start_data_table().&start_data_table_header_row().
1.144 matthew 8553: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8554: '<th>'.&mt('Column').'</th>'.
8555: &end_data_table_header_row()."\n");
1.356 albertel 8556: foreach my $array_ref (@$d) {
8557: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8558: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8559:
8560: $r->print('<td><select name=f'.$i.
1.32 matthew 8561: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8562: $r->print('<option value="none"></option>');
1.356 albertel 8563: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8564: $r->print('<option value="'.$sample.'"'.
8565: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8566: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8567: }
1.594 raeburn 8568: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8569: $i++;
8570: }
1.594 raeburn 8571: $r->print(&end_data_table());
1.31 albertel 8572: $i--;
8573: return $i;
8574: }
1.56 matthew 8575:
1.144 matthew 8576: ######################################################
8577: ######################################################
8578:
1.56 matthew 8579: =pod
1.31 albertel 8580:
1.648 raeburn 8581: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8582:
8583: Prints a table of sample values from the upload and can make associate samples to internal names.
8584:
8585: $r is an Apache Request ref,
8586: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8587: $d is an array of 2 element arrays (internal name, displayed name)
8588:
8589: =cut
8590:
1.144 matthew 8591: ######################################################
8592: ######################################################
1.31 albertel 8593: sub csv_samples_select_table {
8594: my ($r,$records,$d) = @_;
8595: my $i=0;
1.144 matthew 8596: #
1.662 bisitz 8597: my $max_samples = 5;
8598: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8599: $r->print(&start_data_table().
8600: &start_data_table_header_row().'<th>'.
8601: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8602: &end_data_table_header_row());
1.301 albertel 8603:
8604: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8605: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8606: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8607: foreach my $option (@$d) {
8608: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8609: $r->print('<option value="'.$value.'"'.
1.253 albertel 8610: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8611: $display.'</option>');
1.31 albertel 8612: }
8613: $r->print('</select></td><td>');
1.662 bisitz 8614: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8615: if (defined($samples->[$line]{$key})) {
8616: $r->print($samples->[$line]{$key}."<br />\n");
8617: }
8618: }
1.594 raeburn 8619: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8620: $i++;
8621: }
1.594 raeburn 8622: $r->print(&end_data_table());
1.31 albertel 8623: $i--;
8624: return($i);
1.115 matthew 8625: }
8626:
1.144 matthew 8627: ######################################################
8628: ######################################################
8629:
1.115 matthew 8630: =pod
8631:
1.648 raeburn 8632: =item * &clean_excel_name($name)
1.115 matthew 8633:
8634: Returns a replacement for $name which does not contain any illegal characters.
8635:
8636: =cut
8637:
1.144 matthew 8638: ######################################################
8639: ######################################################
1.115 matthew 8640: sub clean_excel_name {
8641: my ($name) = @_;
8642: $name =~ s/[:\*\?\/\\]//g;
8643: if (length($name) > 31) {
8644: $name = substr($name,0,31);
8645: }
8646: return $name;
1.25 albertel 8647: }
1.84 albertel 8648:
1.85 albertel 8649: =pod
8650:
1.648 raeburn 8651: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8652:
8653: Returns either 1 or undef
8654:
8655: 1 if the part is to be hidden, undef if it is to be shown
8656:
8657: Arguments are:
8658:
8659: $id the id of the part to be checked
8660: $symb, optional the symb of the resource to check
8661: $udom, optional the domain of the user to check for
8662: $uname, optional the username of the user to check for
8663:
8664: =cut
1.84 albertel 8665:
8666: sub check_if_partid_hidden {
8667: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8668: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8669: $symb,$udom,$uname);
1.141 albertel 8670: my $truth=1;
8671: #if the string starts with !, then the list is the list to show not hide
8672: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8673: my @hiddenlist=split(/,/,$hiddenparts);
8674: foreach my $checkid (@hiddenlist) {
1.141 albertel 8675: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8676: }
1.141 albertel 8677: return !$truth;
1.84 albertel 8678: }
1.127 matthew 8679:
1.138 matthew 8680:
8681: ############################################################
8682: ############################################################
8683:
8684: =pod
8685:
1.157 matthew 8686: =back
8687:
1.138 matthew 8688: =head1 cgi-bin script and graphing routines
8689:
1.157 matthew 8690: =over 4
8691:
1.648 raeburn 8692: =item * &get_cgi_id()
1.138 matthew 8693:
8694: Inputs: none
8695:
8696: Returns an id which can be used to pass environment variables
8697: to various cgi-bin scripts. These environment variables will
8698: be removed from the users environment after a given time by
8699: the routine &Apache::lonnet::transfer_profile_to_env.
8700:
8701: =cut
8702:
8703: ############################################################
8704: ############################################################
1.152 albertel 8705: my $uniq=0;
1.136 matthew 8706: sub get_cgi_id {
1.154 albertel 8707: $uniq=($uniq+1)%100000;
1.280 albertel 8708: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8709: }
8710:
1.127 matthew 8711: ############################################################
8712: ############################################################
8713:
8714: =pod
8715:
1.648 raeburn 8716: =item * &DrawBarGraph()
1.127 matthew 8717:
1.138 matthew 8718: Facilitates the plotting of data in a (stacked) bar graph.
8719: Puts plot definition data into the users environment in order for
8720: graph.png to plot it. Returns an <img> tag for the plot.
8721: The bars on the plot are labeled '1','2',...,'n'.
8722:
8723: Inputs:
8724:
8725: =over 4
8726:
8727: =item $Title: string, the title of the plot
8728:
8729: =item $xlabel: string, text describing the X-axis of the plot
8730:
8731: =item $ylabel: string, text describing the Y-axis of the plot
8732:
8733: =item $Max: scalar, the maximum Y value to use in the plot
8734: If $Max is < any data point, the graph will not be rendered.
8735:
1.140 matthew 8736: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8737: they are plotted. If undefined, default values will be used.
8738:
1.178 matthew 8739: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8740:
1.138 matthew 8741: =item @Values: An array of array references. Each array reference holds data
8742: to be plotted in a stacked bar chart.
8743:
1.239 matthew 8744: =item If the final element of @Values is a hash reference the key/value
8745: pairs will be added to the graph definition.
8746:
1.138 matthew 8747: =back
8748:
8749: Returns:
8750:
8751: An <img> tag which references graph.png and the appropriate identifying
8752: information for the plot.
8753:
1.127 matthew 8754: =cut
8755:
8756: ############################################################
8757: ############################################################
1.134 matthew 8758: sub DrawBarGraph {
1.178 matthew 8759: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 8760: #
8761: if (! defined($colors)) {
8762: $colors = ['#33ff00',
8763: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
8764: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
8765: ];
8766: }
1.228 matthew 8767: my $extra_settings = {};
8768: if (ref($Values[-1]) eq 'HASH') {
8769: $extra_settings = pop(@Values);
8770: }
1.127 matthew 8771: #
1.136 matthew 8772: my $identifier = &get_cgi_id();
8773: my $id = 'cgi.'.$identifier;
1.129 matthew 8774: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 8775: return '';
8776: }
1.225 matthew 8777: #
8778: my @Labels;
8779: if (defined($labels)) {
8780: @Labels = @$labels;
8781: } else {
8782: for (my $i=0;$i<@{$Values[0]};$i++) {
8783: push (@Labels,$i+1);
8784: }
8785: }
8786: #
1.129 matthew 8787: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 8788: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 8789: my %ValuesHash;
8790: my $NumSets=1;
8791: foreach my $array (@Values) {
8792: next if (! ref($array));
1.136 matthew 8793: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 8794: join(',',@$array);
1.129 matthew 8795: }
1.127 matthew 8796: #
1.136 matthew 8797: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 8798: if ($NumBars < 3) {
8799: $width = 120+$NumBars*32;
1.220 matthew 8800: $xskip = 1;
1.225 matthew 8801: $bar_width = 30;
8802: } elsif ($NumBars < 5) {
8803: $width = 120+$NumBars*20;
8804: $xskip = 1;
8805: $bar_width = 20;
1.220 matthew 8806: } elsif ($NumBars < 10) {
1.136 matthew 8807: $width = 120+$NumBars*15;
8808: $xskip = 1;
8809: $bar_width = 15;
8810: } elsif ($NumBars <= 25) {
8811: $width = 120+$NumBars*11;
8812: $xskip = 5;
8813: $bar_width = 8;
8814: } elsif ($NumBars <= 50) {
8815: $width = 120+$NumBars*8;
8816: $xskip = 5;
8817: $bar_width = 4;
8818: } else {
8819: $width = 120+$NumBars*8;
8820: $xskip = 5;
8821: $bar_width = 4;
8822: }
8823: #
1.137 matthew 8824: $Max = 1 if ($Max < 1);
8825: if ( int($Max) < $Max ) {
8826: $Max++;
8827: $Max = int($Max);
8828: }
1.127 matthew 8829: $Title = '' if (! defined($Title));
8830: $xlabel = '' if (! defined($xlabel));
8831: $ylabel = '' if (! defined($ylabel));
1.369 www 8832: $ValuesHash{$id.'.title'} = &escape($Title);
8833: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
8834: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 8835: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 8836: $ValuesHash{$id.'.NumBars'} = $NumBars;
8837: $ValuesHash{$id.'.NumSets'} = $NumSets;
8838: $ValuesHash{$id.'.PlotType'} = 'bar';
8839: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8840: $ValuesHash{$id.'.height'} = $height;
8841: $ValuesHash{$id.'.width'} = $width;
8842: $ValuesHash{$id.'.xskip'} = $xskip;
8843: $ValuesHash{$id.'.bar_width'} = $bar_width;
8844: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 8845: #
1.228 matthew 8846: # Deal with other parameters
8847: while (my ($key,$value) = each(%$extra_settings)) {
8848: $ValuesHash{$id.'.'.$key} = $value;
8849: }
8850: #
1.646 raeburn 8851: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 8852: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8853: }
8854:
8855: ############################################################
8856: ############################################################
8857:
8858: =pod
8859:
1.648 raeburn 8860: =item * &DrawXYGraph()
1.137 matthew 8861:
1.138 matthew 8862: Facilitates the plotting of data in an XY graph.
8863: Puts plot definition data into the users environment in order for
8864: graph.png to plot it. Returns an <img> tag for the plot.
8865:
8866: Inputs:
8867:
8868: =over 4
8869:
8870: =item $Title: string, the title of the plot
8871:
8872: =item $xlabel: string, text describing the X-axis of the plot
8873:
8874: =item $ylabel: string, text describing the Y-axis of the plot
8875:
8876: =item $Max: scalar, the maximum Y value to use in the plot
8877: If $Max is < any data point, the graph will not be rendered.
8878:
8879: =item $colors: Array ref containing the hex color codes for the data to be
8880: plotted in. If undefined, default values will be used.
8881:
8882: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8883:
8884: =item $Ydata: Array ref containing Array refs.
1.185 www 8885: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 8886:
8887: =item %Values: hash indicating or overriding any default values which are
8888: passed to graph.png.
8889: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8890:
8891: =back
8892:
8893: Returns:
8894:
8895: An <img> tag which references graph.png and the appropriate identifying
8896: information for the plot.
8897:
1.137 matthew 8898: =cut
8899:
8900: ############################################################
8901: ############################################################
8902: sub DrawXYGraph {
8903: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
8904: #
8905: # Create the identifier for the graph
8906: my $identifier = &get_cgi_id();
8907: my $id = 'cgi.'.$identifier;
8908: #
8909: $Title = '' if (! defined($Title));
8910: $xlabel = '' if (! defined($xlabel));
8911: $ylabel = '' if (! defined($ylabel));
8912: my %ValuesHash =
8913: (
1.369 www 8914: $id.'.title' => &escape($Title),
8915: $id.'.xlabel' => &escape($xlabel),
8916: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 8917: $id.'.y_max_value'=> $Max,
8918: $id.'.labels' => join(',',@$Xlabels),
8919: $id.'.PlotType' => 'XY',
8920: );
8921: #
8922: if (defined($colors) && ref($colors) eq 'ARRAY') {
8923: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8924: }
8925: #
8926: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
8927: return '';
8928: }
8929: my $NumSets=1;
1.138 matthew 8930: foreach my $array (@{$Ydata}){
1.137 matthew 8931: next if (! ref($array));
8932: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
8933: }
1.138 matthew 8934: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 8935: #
8936: # Deal with other parameters
8937: while (my ($key,$value) = each(%Values)) {
8938: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 8939: }
8940: #
1.646 raeburn 8941: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 8942: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8943: }
8944:
8945: ############################################################
8946: ############################################################
8947:
8948: =pod
8949:
1.648 raeburn 8950: =item * &DrawXYYGraph()
1.138 matthew 8951:
8952: Facilitates the plotting of data in an XY graph with two Y axes.
8953: Puts plot definition data into the users environment in order for
8954: graph.png to plot it. Returns an <img> tag for the plot.
8955:
8956: Inputs:
8957:
8958: =over 4
8959:
8960: =item $Title: string, the title of the plot
8961:
8962: =item $xlabel: string, text describing the X-axis of the plot
8963:
8964: =item $ylabel: string, text describing the Y-axis of the plot
8965:
8966: =item $colors: Array ref containing the hex color codes for the data to be
8967: plotted in. If undefined, default values will be used.
8968:
8969: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8970:
8971: =item $Ydata1: The first data set
8972:
8973: =item $Min1: The minimum value of the left Y-axis
8974:
8975: =item $Max1: The maximum value of the left Y-axis
8976:
8977: =item $Ydata2: The second data set
8978:
8979: =item $Min2: The minimum value of the right Y-axis
8980:
8981: =item $Max2: The maximum value of the left Y-axis
8982:
8983: =item %Values: hash indicating or overriding any default values which are
8984: passed to graph.png.
8985: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8986:
8987: =back
8988:
8989: Returns:
8990:
8991: An <img> tag which references graph.png and the appropriate identifying
8992: information for the plot.
1.136 matthew 8993:
8994: =cut
8995:
8996: ############################################################
8997: ############################################################
1.137 matthew 8998: sub DrawXYYGraph {
8999: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9000: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9001: #
9002: # Create the identifier for the graph
9003: my $identifier = &get_cgi_id();
9004: my $id = 'cgi.'.$identifier;
9005: #
9006: $Title = '' if (! defined($Title));
9007: $xlabel = '' if (! defined($xlabel));
9008: $ylabel = '' if (! defined($ylabel));
9009: my %ValuesHash =
9010: (
1.369 www 9011: $id.'.title' => &escape($Title),
9012: $id.'.xlabel' => &escape($xlabel),
9013: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9014: $id.'.labels' => join(',',@$Xlabels),
9015: $id.'.PlotType' => 'XY',
9016: $id.'.NumSets' => 2,
1.137 matthew 9017: $id.'.two_axes' => 1,
9018: $id.'.y1_max_value' => $Max1,
9019: $id.'.y1_min_value' => $Min1,
9020: $id.'.y2_max_value' => $Max2,
9021: $id.'.y2_min_value' => $Min2,
1.136 matthew 9022: );
9023: #
1.137 matthew 9024: if (defined($colors) && ref($colors) eq 'ARRAY') {
9025: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9026: }
9027: #
9028: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9029: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9030: return '';
9031: }
9032: my $NumSets=1;
1.137 matthew 9033: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9034: next if (! ref($array));
9035: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9036: }
9037: #
9038: # Deal with other parameters
9039: while (my ($key,$value) = each(%Values)) {
9040: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9041: }
9042: #
1.646 raeburn 9043: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9044: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9045: }
9046:
9047: ############################################################
9048: ############################################################
9049:
9050: =pod
9051:
1.157 matthew 9052: =back
9053:
1.139 matthew 9054: =head1 Statistics helper routines?
9055:
9056: Bad place for them but what the hell.
9057:
1.157 matthew 9058: =over 4
9059:
1.648 raeburn 9060: =item * &chartlink()
1.139 matthew 9061:
9062: Returns a link to the chart for a specific student.
9063:
9064: Inputs:
9065:
9066: =over 4
9067:
9068: =item $linktext: The text of the link
9069:
9070: =item $sname: The students username
9071:
9072: =item $sdomain: The students domain
9073:
9074: =back
9075:
1.157 matthew 9076: =back
9077:
1.139 matthew 9078: =cut
9079:
9080: ############################################################
9081: ############################################################
9082: sub chartlink {
9083: my ($linktext, $sname, $sdomain) = @_;
9084: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9085: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9086: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9087: '">'.$linktext.'</a>';
1.153 matthew 9088: }
9089:
9090: #######################################################
9091: #######################################################
9092:
9093: =pod
9094:
9095: =head1 Course Environment Routines
1.157 matthew 9096:
9097: =over 4
1.153 matthew 9098:
1.648 raeburn 9099: =item * &restore_course_settings()
1.153 matthew 9100:
1.648 raeburn 9101: =item * &store_course_settings()
1.153 matthew 9102:
9103: Restores/Store indicated form parameters from the course environment.
9104: Will not overwrite existing values of the form parameters.
9105:
9106: Inputs:
9107: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9108:
9109: a hash ref describing the data to be stored. For example:
9110:
9111: %Save_Parameters = ('Status' => 'scalar',
9112: 'chartoutputmode' => 'scalar',
9113: 'chartoutputdata' => 'scalar',
9114: 'Section' => 'array',
1.373 raeburn 9115: 'Group' => 'array',
1.153 matthew 9116: 'StudentData' => 'array',
9117: 'Maps' => 'array');
9118:
9119: Returns: both routines return nothing
9120:
1.631 raeburn 9121: =back
9122:
1.153 matthew 9123: =cut
9124:
9125: #######################################################
9126: #######################################################
9127: sub store_course_settings {
1.496 albertel 9128: return &store_settings($env{'request.course.id'},@_);
9129: }
9130:
9131: sub store_settings {
1.153 matthew 9132: # save to the environment
9133: # appenv the same items, just to be safe
1.300 albertel 9134: my $udom = $env{'user.domain'};
9135: my $uname = $env{'user.name'};
1.496 albertel 9136: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9137: my %SaveHash;
9138: my %AppHash;
9139: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9140: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9141: my $envname = 'environment.'.$basename;
1.258 albertel 9142: if (exists($env{'form.'.$setting})) {
1.153 matthew 9143: # Save this value away
9144: if ($type eq 'scalar' &&
1.258 albertel 9145: (! exists($env{$envname}) ||
9146: $env{$envname} ne $env{'form.'.$setting})) {
9147: $SaveHash{$basename} = $env{'form.'.$setting};
9148: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 9149: } elsif ($type eq 'array') {
9150: my $stored_form;
1.258 albertel 9151: if (ref($env{'form.'.$setting})) {
1.153 matthew 9152: $stored_form = join(',',
9153: map {
1.369 www 9154: &escape($_);
1.258 albertel 9155: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 9156: } else {
9157: $stored_form =
1.369 www 9158: &escape($env{'form.'.$setting});
1.153 matthew 9159: }
9160: # Determine if the array contents are the same.
1.258 albertel 9161: if ($stored_form ne $env{$envname}) {
1.153 matthew 9162: $SaveHash{$basename} = $stored_form;
9163: $AppHash{$envname} = $stored_form;
9164: }
9165: }
9166: }
9167: }
9168: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 9169: $udom,$uname);
1.153 matthew 9170: if ($put_result !~ /^(ok|delayed)/) {
9171: &Apache::lonnet::logthis('unable to save form parameters, '.
9172: 'got error:'.$put_result);
9173: }
9174: # Make sure these settings stick around in this session, too
1.646 raeburn 9175: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 9176: return;
9177: }
9178:
9179: sub restore_course_settings {
1.499 albertel 9180: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 9181: }
9182:
9183: sub restore_settings {
9184: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9185: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 9186: next if (exists($env{'form.'.$setting}));
1.496 albertel 9187: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 9188: '.'.$setting;
1.258 albertel 9189: if (exists($env{$envname})) {
1.153 matthew 9190: if ($type eq 'scalar') {
1.258 albertel 9191: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 9192: } elsif ($type eq 'array') {
1.258 albertel 9193: $env{'form.'.$setting} = [
1.153 matthew 9194: map {
1.369 www 9195: &unescape($_);
1.258 albertel 9196: } split(',',$env{$envname})
1.153 matthew 9197: ];
9198: }
9199: }
9200: }
1.127 matthew 9201: }
9202:
1.618 raeburn 9203: #######################################################
9204: #######################################################
9205:
9206: =pod
9207:
9208: =head1 Domain E-mail Routines
9209:
9210: =over 4
9211:
1.648 raeburn 9212: =item * &build_recipient_list()
1.618 raeburn 9213:
1.766 raeburn 9214: Build recipient lists for four types of e-mail:
9215: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
9216: (d) Help requests, generated by
9217: lonerrorhandler.pm, CHECKRPMS, loncron, and lonsupportreq.pm respectively.
1.618 raeburn 9218:
9219: Inputs:
1.619 raeburn 9220: defmail (scalar - email address of default recipient),
1.618 raeburn 9221: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 9222: defdom (domain for which to retrieve configuration settings),
9223: origmail (scalar - email address of recipient from loncapa.conf,
9224: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 9225:
1.655 raeburn 9226: Returns: comma separated list of addresses to which to send e-mail.
9227:
9228: =back
1.618 raeburn 9229:
9230: =cut
9231:
9232: ############################################################
9233: ############################################################
9234: sub build_recipient_list {
1.619 raeburn 9235: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 9236: my @recipients;
9237: my $otheremails;
9238: my %domconfig =
9239: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
9240: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 9241: if (exists($domconfig{'contacts'}{$mailing})) {
9242: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
9243: my @contacts = ('adminemail','supportemail');
9244: foreach my $item (@contacts) {
9245: if ($domconfig{'contacts'}{$mailing}{$item}) {
9246: my $addr = $domconfig{'contacts'}{$item};
9247: if (!grep(/^\Q$addr\E$/,@recipients)) {
9248: push(@recipients,$addr);
9249: }
1.619 raeburn 9250: }
1.766 raeburn 9251: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 9252: }
9253: }
1.766 raeburn 9254: } elsif ($origmail ne '') {
9255: push(@recipients,$origmail);
1.618 raeburn 9256: }
1.619 raeburn 9257: } elsif ($origmail ne '') {
9258: push(@recipients,$origmail);
1.618 raeburn 9259: }
1.688 raeburn 9260: if (defined($defmail)) {
9261: if ($defmail ne '') {
9262: push(@recipients,$defmail);
9263: }
1.618 raeburn 9264: }
9265: if ($otheremails) {
1.619 raeburn 9266: my @others;
9267: if ($otheremails =~ /,/) {
9268: @others = split(/,/,$otheremails);
1.618 raeburn 9269: } else {
1.619 raeburn 9270: push(@others,$otheremails);
9271: }
9272: foreach my $addr (@others) {
9273: if (!grep(/^\Q$addr\E$/,@recipients)) {
9274: push(@recipients,$addr);
9275: }
1.618 raeburn 9276: }
9277: }
1.619 raeburn 9278: my $recipientlist = join(',',@recipients);
1.618 raeburn 9279: return $recipientlist;
9280: }
9281:
1.127 matthew 9282: ############################################################
9283: ############################################################
1.154 albertel 9284:
1.655 raeburn 9285: =pod
9286:
9287: =head1 Course Catalog Routines
9288:
9289: =over 4
9290:
9291: =item * &gather_categories()
9292:
9293: Converts category definitions - keys of categories hash stored in
9294: coursecategories in configuration.db on the primary library server in a
9295: domain - to an array. Also generates javascript and idx hash used to
9296: generate Domain Coordinator interface for editing Course Categories.
9297:
9298: Inputs:
1.663 raeburn 9299:
1.655 raeburn 9300: categories (reference to hash of category definitions).
1.663 raeburn 9301:
1.655 raeburn 9302: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9303: categories and subcategories).
1.663 raeburn 9304:
1.655 raeburn 9305: idx (reference to hash of counters used in Domain Coordinator interface for
9306: editing Course Categories).
1.663 raeburn 9307:
1.655 raeburn 9308: jsarray (reference to array of categories used to create Javascript arrays for
9309: Domain Coordinator interface for editing Course Categories).
9310:
9311: Returns: nothing
9312:
9313: Side effects: populates cats, idx and jsarray.
9314:
9315: =cut
9316:
9317: sub gather_categories {
9318: my ($categories,$cats,$idx,$jsarray) = @_;
9319: my %counters;
9320: my $num = 0;
9321: foreach my $item (keys(%{$categories})) {
9322: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9323: if ($container eq '' && $depth == 0) {
9324: $cats->[$depth][$categories->{$item}] = $cat;
9325: } else {
9326: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9327: }
9328: my ($escitem,$tail) = split(/:/,$item,2);
9329: if ($counters{$tail} eq '') {
9330: $counters{$tail} = $num;
9331: $num ++;
9332: }
9333: if (ref($idx) eq 'HASH') {
9334: $idx->{$item} = $counters{$tail};
9335: }
9336: if (ref($jsarray) eq 'ARRAY') {
9337: push(@{$jsarray->[$counters{$tail}]},$item);
9338: }
9339: }
9340: return;
9341: }
9342:
9343: =pod
9344:
9345: =item * &extract_categories()
9346:
9347: Used to generate breadcrumb trails for course categories.
9348:
9349: Inputs:
1.663 raeburn 9350:
1.655 raeburn 9351: categories (reference to hash of category definitions).
1.663 raeburn 9352:
1.655 raeburn 9353: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9354: categories and subcategories).
1.663 raeburn 9355:
1.655 raeburn 9356: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9357:
1.655 raeburn 9358: allitems (reference to hash - key is category key
9359: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9360:
1.655 raeburn 9361: idx (reference to hash of counters used in Domain Coordinator interface for
9362: editing Course Categories).
1.663 raeburn 9363:
1.655 raeburn 9364: jsarray (reference to array of categories used to create Javascript arrays for
9365: Domain Coordinator interface for editing Course Categories).
9366:
1.665 raeburn 9367: subcats (reference to hash of arrays containing all subcategories within each
9368: category, -recursive)
9369:
1.655 raeburn 9370: Returns: nothing
9371:
9372: Side effects: populates trails and allitems hash references.
9373:
9374: =cut
9375:
9376: sub extract_categories {
1.665 raeburn 9377: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9378: if (ref($categories) eq 'HASH') {
9379: &gather_categories($categories,$cats,$idx,$jsarray);
9380: if (ref($cats->[0]) eq 'ARRAY') {
9381: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9382: my $name = $cats->[0][$i];
9383: my $item = &escape($name).'::0';
9384: my $trailstr;
9385: if ($name eq 'instcode') {
9386: $trailstr = &mt('Official courses (with institutional codes)');
9387: } else {
9388: $trailstr = $name;
9389: }
9390: if ($allitems->{$item} eq '') {
9391: push(@{$trails},$trailstr);
9392: $allitems->{$item} = scalar(@{$trails})-1;
9393: }
9394: my @parents = ($name);
9395: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9396: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9397: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9398: if (ref($subcats) eq 'HASH') {
9399: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9400: }
9401: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9402: }
9403: } else {
9404: if (ref($subcats) eq 'HASH') {
9405: $subcats->{$item} = [];
1.655 raeburn 9406: }
9407: }
9408: }
9409: }
9410: }
9411: return;
9412: }
9413:
9414: =pod
9415:
9416: =item *&recurse_categories()
9417:
9418: Recursively used to generate breadcrumb trails for course categories.
9419:
9420: Inputs:
1.663 raeburn 9421:
1.655 raeburn 9422: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9423: categories and subcategories).
1.663 raeburn 9424:
1.655 raeburn 9425: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9426:
9427: category (current course category, for which breadcrumb trail is being generated).
9428:
9429: trails (reference to array of breadcrumb trails for each category).
9430:
1.655 raeburn 9431: allitems (reference to hash - key is category key
9432: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9433:
1.655 raeburn 9434: parents (array containing containers directories for current category,
9435: back to top level).
9436:
9437: Returns: nothing
9438:
9439: Side effects: populates trails and allitems hash references
9440:
9441: =cut
9442:
9443: sub recurse_categories {
1.665 raeburn 9444: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9445: my $shallower = $depth - 1;
9446: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9447: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9448: my $name = $cats->[$depth]{$category}[$k];
9449: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9450: my $trailstr = join(' -> ',(@{$parents},$category));
9451: if ($allitems->{$item} eq '') {
9452: push(@{$trails},$trailstr);
9453: $allitems->{$item} = scalar(@{$trails})-1;
9454: }
9455: my $deeper = $depth+1;
9456: push(@{$parents},$category);
1.665 raeburn 9457: if (ref($subcats) eq 'HASH') {
9458: my $subcat = &escape($name).':'.$category.':'.$depth;
9459: for (my $j=@{$parents}; $j>=0; $j--) {
9460: my $higher;
9461: if ($j > 0) {
9462: $higher = &escape($parents->[$j]).':'.
9463: &escape($parents->[$j-1]).':'.$j;
9464: } else {
9465: $higher = &escape($parents->[$j]).'::'.$j;
9466: }
9467: push(@{$subcats->{$higher}},$subcat);
9468: }
9469: }
9470: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9471: $subcats);
1.655 raeburn 9472: pop(@{$parents});
9473: }
9474: } else {
9475: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9476: my $trailstr = join(' -> ',(@{$parents},$category));
9477: if ($allitems->{$item} eq '') {
9478: push(@{$trails},$trailstr);
9479: $allitems->{$item} = scalar(@{$trails})-1;
9480: }
9481: }
9482: return;
9483: }
9484:
1.663 raeburn 9485: =pod
9486:
9487: =item *&assign_categories_table()
9488:
9489: Create a datatable for display of hierarchical categories in a domain,
9490: with checkboxes to allow a course to be categorized.
9491:
9492: Inputs:
9493:
9494: cathash - reference to hash of categories defined for the domain (from
9495: configuration.db)
9496:
9497: currcat - scalar with an & separated list of categories assigned to a course.
9498:
9499: Returns: $output (markup to be displayed)
9500:
9501: =cut
9502:
9503: sub assign_categories_table {
9504: my ($cathash,$currcat) = @_;
9505: my $output;
9506: if (ref($cathash) eq 'HASH') {
9507: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9508: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9509: $maxdepth = scalar(@cats);
9510: if (@cats > 0) {
9511: my $itemcount = 0;
9512: if (ref($cats[0]) eq 'ARRAY') {
9513: $output = &Apache::loncommon::start_data_table();
9514: my @currcategories;
9515: if ($currcat ne '') {
9516: @currcategories = split('&',$currcat);
9517: }
9518: for (my $i=0; $i<@{$cats[0]}; $i++) {
9519: my $parent = $cats[0][$i];
9520: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9521: next if ($parent eq 'instcode');
9522: my $item = &escape($parent).'::0';
9523: my $checked = '';
9524: if (@currcategories > 0) {
9525: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9526: $checked = ' checked="checked"';
1.663 raeburn 9527: }
9528: }
1.675 raeburn 9529: $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9530: '<input type="checkbox" name="usecategory" value="'.
9531: $item.'"'.$checked.' />'.$parent.'</span>'.
9532: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9533: my $depth = 1;
9534: push(@path,$parent);
9535: $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
9536: pop(@path);
9537: $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
9538: $itemcount ++;
9539: }
9540: $output .= &Apache::loncommon::end_data_table();
9541: }
9542: }
9543: }
9544: return $output;
9545: }
9546:
9547: =pod
9548:
9549: =item *&assign_category_rows()
9550:
9551: Create a datatable row for display of nested categories in a domain,
9552: with checkboxes to allow a course to be categorized,called recursively.
9553:
9554: Inputs:
9555:
9556: itemcount - track row number for alternating colors
9557:
9558: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9559: categories and subcategories.
9560:
9561: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9562:
9563: parent - parent of current category item
9564:
9565: path - Array containing all categories back up through the hierarchy from the
9566: current category to the top level.
9567:
9568: currcategories - reference to array of current categories assigned to the course
9569:
9570: Returns: $output (markup to be displayed).
9571:
9572: =cut
9573:
9574: sub assign_category_rows {
9575: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9576: my ($text,$name,$item,$chgstr);
9577: if (ref($cats) eq 'ARRAY') {
9578: my $maxdepth = scalar(@{$cats});
9579: if (ref($cats->[$depth]) eq 'HASH') {
9580: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9581: my $numchildren = @{$cats->[$depth]{$parent}};
9582: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9583: $text .= '<td><table class="LC_datatable">';
9584: for (my $j=0; $j<$numchildren; $j++) {
9585: $name = $cats->[$depth]{$parent}[$j];
9586: $item = &escape($name).':'.&escape($parent).':'.$depth;
9587: my $deeper = $depth+1;
9588: my $checked = '';
9589: if (ref($currcategories) eq 'ARRAY') {
9590: if (@{$currcategories} > 0) {
9591: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9592: $checked = ' checked="checked"';
1.663 raeburn 9593: }
9594: }
9595: }
1.664 raeburn 9596: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9597: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9598: $item.'"'.$checked.' />'.$name.'</label></span>'.
9599: '<input type="hidden" name="catname" value="'.$name.'" />'.
9600: '</td><td>';
1.663 raeburn 9601: if (ref($path) eq 'ARRAY') {
9602: push(@{$path},$name);
9603: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9604: pop(@{$path});
9605: }
9606: $text .= '</td></tr>';
9607: }
9608: $text .= '</table></td>';
9609: }
9610: }
9611: }
9612: return $text;
9613: }
9614:
1.655 raeburn 9615: ############################################################
9616: ############################################################
9617:
9618:
1.443 albertel 9619: sub commit_customrole {
1.664 raeburn 9620: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9621: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9622: ($start?', '.&mt('starting').' '.localtime($start):'').
9623: ($end?', ending '.localtime($end):'').': <b>'.
9624: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9625: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9626: '</b><br />';
9627: return $output;
9628: }
9629:
9630: sub commit_standardrole {
1.541 raeburn 9631: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9632: my ($output,$logmsg,$linefeed);
9633: if ($context eq 'auto') {
9634: $linefeed = "\n";
9635: } else {
9636: $linefeed = "<br />\n";
9637: }
1.443 albertel 9638: if ($three eq 'st') {
1.541 raeburn 9639: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9640: $one,$two,$sec,$context);
9641: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9642: ($result eq 'unknown_course') || ($result eq 'refused')) {
9643: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9644: } else {
1.541 raeburn 9645: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9646: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9647: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9648: if ($context eq 'auto') {
9649: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9650: } else {
9651: $output .= '<b>'.$result.'</b>'.$linefeed.
9652: &mt('Add to classlist').': <b>ok</b>';
9653: }
9654: $output .= $linefeed;
1.443 albertel 9655: }
9656: } else {
9657: $output = &mt('Assigning').' '.$three.' in '.$url.
9658: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9659: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9660: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9661: if ($context eq 'auto') {
9662: $output .= $result.$linefeed;
9663: } else {
9664: $output .= '<b>'.$result.'</b>'.$linefeed;
9665: }
1.443 albertel 9666: }
9667: return $output;
9668: }
9669:
9670: sub commit_studentrole {
1.541 raeburn 9671: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9672: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9673: if ($context eq 'auto') {
9674: $linefeed = "\n";
9675: } else {
9676: $linefeed = '<br />'."\n";
9677: }
1.443 albertel 9678: if (defined($one) && defined($two)) {
9679: my $cid=$one.'_'.$two;
9680: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9681: my $secchange = 0;
9682: my $expire_role_result;
9683: my $modify_section_result;
1.628 raeburn 9684: if ($oldsec ne '-1') {
9685: if ($oldsec ne $sec) {
1.443 albertel 9686: $secchange = 1;
1.628 raeburn 9687: my $now = time;
1.443 albertel 9688: my $uurl='/'.$cid;
9689: $uurl=~s/\_/\//g;
9690: if ($oldsec) {
9691: $uurl.='/'.$oldsec;
9692: }
1.626 raeburn 9693: $oldsecurl = $uurl;
1.628 raeburn 9694: $expire_role_result =
1.652 raeburn 9695: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9696: if ($env{'request.course.sec'} ne '') {
9697: if ($expire_role_result eq 'refused') {
9698: my @roles = ('st');
9699: my @statuses = ('previous');
9700: my @roledoms = ($one);
9701: my $withsec = 1;
9702: my %roleshash =
9703: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9704: \@statuses,\@roles,\@roledoms,$withsec);
9705: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9706: my ($oldstart,$oldend) =
9707: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9708: if ($oldend > 0 && $oldend <= $now) {
9709: $expire_role_result = 'ok';
9710: }
9711: }
9712: }
9713: }
1.443 albertel 9714: $result = $expire_role_result;
9715: }
9716: }
9717: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9718: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9719: if ($modify_section_result =~ /^ok/) {
9720: if ($secchange == 1) {
1.628 raeburn 9721: if ($sec eq '') {
9722: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9723: } else {
9724: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9725: }
1.443 albertel 9726: } elsif ($oldsec eq '-1') {
1.628 raeburn 9727: if ($sec eq '') {
9728: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9729: } else {
9730: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9731: }
1.443 albertel 9732: } else {
1.628 raeburn 9733: if ($sec eq '') {
9734: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
9735: } else {
9736: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9737: }
1.443 albertel 9738: }
9739: } else {
1.628 raeburn 9740: if ($secchange) {
9741: $$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;
9742: } else {
9743: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
9744: }
1.443 albertel 9745: }
9746: $result = $modify_section_result;
9747: } elsif ($secchange == 1) {
1.628 raeburn 9748: if ($oldsec eq '') {
9749: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
9750: } else {
9751: $$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;
9752: }
1.626 raeburn 9753: if ($expire_role_result eq 'refused') {
9754: my $newsecurl = '/'.$cid;
9755: $newsecurl =~ s/\_/\//g;
9756: if ($sec ne '') {
9757: $newsecurl.='/'.$sec;
9758: }
9759: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
9760: if ($sec eq '') {
9761: $$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;
9762: } else {
9763: $$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;
9764: }
9765: }
9766: }
1.443 albertel 9767: }
9768: } else {
1.626 raeburn 9769: $$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 9770: $result = "error: incomplete course id\n";
9771: }
9772: return $result;
9773: }
9774:
9775: ############################################################
9776: ############################################################
9777:
1.566 albertel 9778: sub check_clone {
1.578 raeburn 9779: my ($args,$linefeed) = @_;
1.566 albertel 9780: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
9781: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
9782: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
9783: my $clonemsg;
9784: my $can_clone = 0;
9785:
9786: if ($clonehome eq 'no_host') {
1.578 raeburn 9787: $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 9788: } else {
9789: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568 albertel 9790: if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566 albertel 9791: $can_clone = 1;
9792: } else {
9793: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
9794: $args->{'clonedomain'},$args->{'clonecourse'});
9795: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 9796: if (grep(/^\*$/,@cloners)) {
9797: $can_clone = 1;
9798: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
9799: $can_clone = 1;
9800: } else {
9801: my %roleshash =
9802: &Apache::lonnet::get_my_roles($args->{'ccuname'},
9803: $args->{'ccdomain'},
9804: 'userroles',['active'],['cc'],
9805: [$args->{'clonedomain'}]);
9806: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
9807: $can_clone = 1;
9808: } else {
9809: $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'});
9810: }
1.566 albertel 9811: }
1.578 raeburn 9812: }
1.566 albertel 9813: }
9814: return ($can_clone, $clonemsg, $cloneid, $clonehome);
9815: }
9816:
1.444 albertel 9817: sub construct_course {
1.541 raeburn 9818: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444 albertel 9819: my $outcome;
1.541 raeburn 9820: my $linefeed = '<br />'."\n";
9821: if ($context eq 'auto') {
9822: $linefeed = "\n";
9823: }
1.566 albertel 9824:
9825: #
9826: # Are we cloning?
9827: #
9828: my ($can_clone, $clonemsg, $cloneid, $clonehome);
9829: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 9830: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 9831: if ($context ne 'auto') {
1.578 raeburn 9832: if ($clonemsg ne '') {
9833: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
9834: }
1.566 albertel 9835: }
9836: $outcome .= $clonemsg.$linefeed;
9837:
9838: if (!$can_clone) {
9839: return (0,$outcome);
9840: }
9841: }
9842:
1.444 albertel 9843: #
9844: # Open course
9845: #
9846: my $crstype = lc($args->{'crstype'});
9847: my %cenv=();
9848: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
9849: $args->{'cdescr'},
9850: $args->{'curl'},
9851: $args->{'course_home'},
9852: $args->{'nonstandard'},
9853: $args->{'crscode'},
9854: $args->{'ccuname'}.':'.
9855: $args->{'ccdomain'},
9856: $args->{'crstype'});
9857:
9858: # Note: The testing routines depend on this being output; see
9859: # Utils::Course. This needs to at least be output as a comment
9860: # if anyone ever decides to not show this, and Utils::Course::new
9861: # will need to be suitably modified.
1.541 raeburn 9862: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 9863: #
9864: # Check if created correctly
9865: #
1.479 albertel 9866: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 9867: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 9868: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 9869:
1.444 albertel 9870: #
1.566 albertel 9871: # Do the cloning
9872: #
9873: if ($can_clone && $cloneid) {
9874: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
9875: if ($context ne 'auto') {
9876: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
9877: }
9878: $outcome .= $clonemsg.$linefeed;
9879: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 9880: # Copy all files
1.637 www 9881: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 9882: # Restore URL
1.566 albertel 9883: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 9884: # Restore title
1.566 albertel 9885: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 9886: # Mark as cloned
1.566 albertel 9887: $cenv{'clonedfrom'}=$cloneid;
1.638 www 9888: # Need to clone grading mode
9889: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
9890: $cenv{'grading'}=$newenv{'grading'};
9891: # Do not clone these environment entries
9892: &Apache::lonnet::del('environment',
9893: ['default_enrollment_start_date',
9894: 'default_enrollment_end_date',
9895: 'question.email',
9896: 'policy.email',
9897: 'comment.email',
9898: 'pch.users.denied',
1.725 raeburn 9899: 'plc.users.denied',
9900: 'hidefromcat',
9901: 'categories'],
1.638 www 9902: $$crsudom,$$crsunum);
1.444 albertel 9903: }
1.566 albertel 9904:
1.444 albertel 9905: #
9906: # Set environment (will override cloned, if existing)
9907: #
9908: my @sections = ();
9909: my @xlists = ();
9910: if ($args->{'crstype'}) {
9911: $cenv{'type'}=$args->{'crstype'};
9912: }
9913: if ($args->{'crsid'}) {
9914: $cenv{'courseid'}=$args->{'crsid'};
9915: }
9916: if ($args->{'crscode'}) {
9917: $cenv{'internal.coursecode'}=$args->{'crscode'};
9918: }
9919: if ($args->{'crsquota'} ne '') {
9920: $cenv{'internal.coursequota'}=$args->{'crsquota'};
9921: } else {
9922: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
9923: }
9924: if ($args->{'ccuname'}) {
9925: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
9926: ':'.$args->{'ccdomain'};
9927: } else {
9928: $cenv{'internal.courseowner'} = $args->{'curruser'};
9929: }
9930: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
9931: if ($args->{'crssections'}) {
9932: $cenv{'internal.sectionnums'} = '';
9933: if ($args->{'crssections'} =~ m/,/) {
9934: @sections = split/,/,$args->{'crssections'};
9935: } else {
9936: $sections[0] = $args->{'crssections'};
9937: }
9938: if (@sections > 0) {
9939: foreach my $item (@sections) {
9940: my ($sec,$gp) = split/:/,$item;
9941: my $class = $args->{'crscode'}.$sec;
9942: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
9943: $cenv{'internal.sectionnums'} .= $item.',';
9944: unless ($addcheck eq 'ok') {
9945: push @badclasses, $class;
9946: }
9947: }
9948: $cenv{'internal.sectionnums'} =~ s/,$//;
9949: }
9950: }
9951: # do not hide course coordinator from staff listing,
9952: # even if privileged
9953: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9954: # add crosslistings
9955: if ($args->{'crsxlist'}) {
9956: $cenv{'internal.crosslistings'}='';
9957: if ($args->{'crsxlist'} =~ m/,/) {
9958: @xlists = split/,/,$args->{'crsxlist'};
9959: } else {
9960: $xlists[0] = $args->{'crsxlist'};
9961: }
9962: if (@xlists > 0) {
9963: foreach my $item (@xlists) {
9964: my ($xl,$gp) = split/:/,$item;
9965: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
9966: $cenv{'internal.crosslistings'} .= $item.',';
9967: unless ($addcheck eq 'ok') {
9968: push @badclasses, $xl;
9969: }
9970: }
9971: $cenv{'internal.crosslistings'} =~ s/,$//;
9972: }
9973: }
9974: if ($args->{'autoadds'}) {
9975: $cenv{'internal.autoadds'}=$args->{'autoadds'};
9976: }
9977: if ($args->{'autodrops'}) {
9978: $cenv{'internal.autodrops'}=$args->{'autodrops'};
9979: }
9980: # check for notification of enrollment changes
9981: my @notified = ();
9982: if ($args->{'notify_owner'}) {
9983: if ($args->{'ccuname'} ne '') {
9984: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
9985: }
9986: }
9987: if ($args->{'notify_dc'}) {
9988: if ($uname ne '') {
1.630 raeburn 9989: push(@notified,$uname.':'.$udom);
1.444 albertel 9990: }
9991: }
9992: if (@notified > 0) {
9993: my $notifylist;
9994: if (@notified > 1) {
9995: $notifylist = join(',',@notified);
9996: } else {
9997: $notifylist = $notified[0];
9998: }
9999: $cenv{'internal.notifylist'} = $notifylist;
10000: }
10001: if (@badclasses > 0) {
10002: my %lt=&Apache::lonlocal::texthash(
10003: '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',
10004: 'dnhr' => 'does not have rights to access enrollment in these classes',
10005: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10006: );
1.541 raeburn 10007: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10008: ' ('.$lt{'adby'}.')';
10009: if ($context eq 'auto') {
10010: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10011: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10012: foreach my $item (@badclasses) {
10013: if ($context eq 'auto') {
10014: $outcome .= " - $item\n";
10015: } else {
10016: $outcome .= "<li>$item</li>\n";
10017: }
10018: }
10019: if ($context eq 'auto') {
10020: $outcome .= $linefeed;
10021: } else {
1.566 albertel 10022: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10023: }
10024: }
1.444 albertel 10025: }
10026: if ($args->{'no_end_date'}) {
10027: $args->{'endaccess'} = 0;
10028: }
10029: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10030: $cenv{'internal.autoend'}=$args->{'enrollend'};
10031: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10032: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10033: if ($args->{'showphotos'}) {
10034: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10035: }
10036: $cenv{'internal.authtype'} = $args->{'authtype'};
10037: $cenv{'internal.autharg'} = $args->{'autharg'};
10038: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10039: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10040: 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');
10041: if ($context eq 'auto') {
10042: $outcome .= $krb_msg;
10043: } else {
1.566 albertel 10044: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10045: }
10046: $outcome .= $linefeed;
1.444 albertel 10047: }
10048: }
10049: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10050: if ($args->{'setpolicy'}) {
10051: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10052: }
10053: if ($args->{'setcontent'}) {
10054: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10055: }
10056: }
10057: if ($args->{'reshome'}) {
10058: $cenv{'reshome'}=$args->{'reshome'}.'/';
10059: $cenv{'reshome'}=~s/\/+$/\//;
10060: }
10061: #
10062: # course has keyed access
10063: #
10064: if ($args->{'setkeys'}) {
10065: $cenv{'keyaccess'}='yes';
10066: }
10067: # if specified, key authority is not course, but user
10068: # only active if keyaccess is yes
10069: if ($args->{'keyauth'}) {
1.487 albertel 10070: my ($user,$domain) = split(':',$args->{'keyauth'});
10071: $user = &LONCAPA::clean_username($user);
10072: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10073: if ($user ne '' && $domain ne '') {
1.487 albertel 10074: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10075: }
10076: }
10077:
10078: if ($args->{'disresdis'}) {
10079: $cenv{'pch.roles.denied'}='st';
10080: }
10081: if ($args->{'disablechat'}) {
10082: $cenv{'plc.roles.denied'}='st';
10083: }
10084:
10085: # Record we've not yet viewed the Course Initialization Helper for this
10086: # course
10087: $cenv{'course.helper.not.run'} = 1;
10088: #
10089: # Use new Randomseed
10090: #
10091: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10092: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10093: #
10094: # The encryption code and receipt prefix for this course
10095: #
10096: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10097: $cenv{'internal.encpref'}=100+int(9*rand(99));
10098: #
10099: # By default, use standard grading
10100: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10101:
1.541 raeburn 10102: $outcome .= $linefeed.&mt('Setting environment').': '.
10103: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10104: #
10105: # Open all assignments
10106: #
10107: if ($args->{'openall'}) {
10108: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10109: my %storecontent = ($storeunder => time,
10110: $storeunder.'.type' => 'date_start');
10111:
10112: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 10113: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10114: }
10115: #
10116: # Set first page
10117: #
10118: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10119: || ($cloneid)) {
1.445 albertel 10120: use LONCAPA::map;
1.444 albertel 10121: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 10122:
10123: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10124: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10125:
1.444 albertel 10126: $outcome .= ($fatal?$errtext:'read ok').' - ';
10127: my $title; my $url;
10128: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 10129: $title=&mt('Syllabus');
1.444 albertel 10130: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10131: } else {
1.690 bisitz 10132: $title=&mt('Navigate Contents');
1.444 albertel 10133: $url='/adm/navmaps';
10134: }
1.445 albertel 10135:
10136: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10137: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10138:
10139: if ($errtext) { $fatal=2; }
1.541 raeburn 10140: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 10141: }
1.566 albertel 10142:
10143: return (1,$outcome);
1.444 albertel 10144: }
10145:
10146: ############################################################
10147: ############################################################
10148:
1.378 raeburn 10149: sub course_type {
10150: my ($cid) = @_;
10151: if (!defined($cid)) {
10152: $cid = $env{'request.course.id'};
10153: }
1.404 albertel 10154: if (defined($env{'course.'.$cid.'.type'})) {
10155: return $env{'course.'.$cid.'.type'};
1.378 raeburn 10156: } else {
10157: return 'Course';
1.377 raeburn 10158: }
10159: }
1.156 albertel 10160:
1.406 raeburn 10161: sub group_term {
10162: my $crstype = &course_type();
10163: my %names = (
10164: 'Course' => 'group',
10165: 'Group' => 'team',
10166: );
10167: return $names{$crstype};
10168: }
10169:
1.156 albertel 10170: sub icon {
10171: my ($file)=@_;
1.505 albertel 10172: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 10173: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 10174: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 10175: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10176: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10177: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10178: $curfext.".gif") {
10179: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10180: $curfext.".gif";
10181: }
10182: }
1.249 albertel 10183: return &lonhttpdurl($iconname);
1.154 albertel 10184: }
1.84 albertel 10185:
1.575 albertel 10186: sub lonhttpdurl {
1.692 www 10187: #
10188: # Had been used for "small fry" static images on separate port 8080.
10189: # Modify here if lightweight http functionality desired again.
10190: # Currently eliminated due to increasing firewall issues.
10191: #
1.575 albertel 10192: my ($url)=@_;
1.692 www 10193: return $url;
1.215 albertel 10194: }
10195:
1.213 albertel 10196: sub connection_aborted {
10197: my ($r)=@_;
10198: $r->print(" ");$r->rflush();
10199: my $c = $r->connection;
10200: return $c->aborted();
10201: }
10202:
1.221 foxr 10203: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 10204: # strings as 'strings'.
10205: sub escape_single {
1.221 foxr 10206: my ($input) = @_;
1.223 albertel 10207: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 10208: $input =~ s/\'/\\\'/g; # Esacpe the 's....
10209: return $input;
10210: }
1.223 albertel 10211:
1.222 foxr 10212: # Same as escape_single, but escape's "'s This
10213: # can be used for "strings"
10214: sub escape_double {
10215: my ($input) = @_;
10216: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
10217: $input =~ s/\"/\\\"/g; # Esacpe the "s....
10218: return $input;
10219: }
1.223 albertel 10220:
1.222 foxr 10221: # Escapes the last element of a full URL.
10222: sub escape_url {
10223: my ($url) = @_;
1.238 raeburn 10224: my @urlslices = split(/\//, $url,-1);
1.369 www 10225: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 10226: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 10227: }
1.462 albertel 10228:
10229: # -------------------------------------------------------- Initliaze user login
10230: sub init_user_environment {
1.463 albertel 10231: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 10232: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
10233:
10234: my $public=($username eq 'public' && $domain eq 'public');
10235:
10236: # See if old ID present, if so, remove
10237:
10238: my ($filename,$cookie,$userroles);
10239: my $now=time;
10240:
10241: if ($public) {
10242: my $max_public=100;
10243: my $oldest;
10244: my $oldest_time=0;
10245: for(my $next=1;$next<=$max_public;$next++) {
10246: if (-e $lonids."/publicuser_$next.id") {
10247: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
10248: if ($mtime<$oldest_time || !$oldest_time) {
10249: $oldest_time=$mtime;
10250: $oldest=$next;
10251: }
10252: } else {
10253: $cookie="publicuser_$next";
10254: last;
10255: }
10256: }
10257: if (!$cookie) { $cookie="publicuser_$oldest"; }
10258: } else {
1.463 albertel 10259: # if this isn't a robot, kill any existing non-robot sessions
10260: if (!$args->{'robot'}) {
10261: opendir(DIR,$lonids);
10262: while ($filename=readdir(DIR)) {
10263: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10264: unlink($lonids.'/'.$filename);
10265: }
1.462 albertel 10266: }
1.463 albertel 10267: closedir(DIR);
1.462 albertel 10268: }
10269: # Give them a new cookie
1.463 albertel 10270: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10271: : $now.$$.int(rand(10000)));
1.463 albertel 10272: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10273:
10274: # Initialize roles
10275:
10276: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10277: }
10278: # ------------------------------------ Check browser type and MathML capability
10279:
10280: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10281: $clientunicode,$clientos) = &decode_user_agent($r);
10282:
10283: # -------------------------------------- Any accessibility options to remember?
10284: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
10285: foreach my $option ('imagesuppress','appletsuppress',
10286: 'embedsuppress','fontenhance','blackwhite') {
10287: if ($form->{$option} eq 'true') {
10288: &Apache::lonnet::put('environment',{$option => 'on'},
10289: $domain,$username);
10290: } else {
10291: &Apache::lonnet::del('environment',[$option],
10292: $domain,$username);
10293: }
10294: }
10295: }
10296: # ------------------------------------------------------------- Get environment
10297:
10298: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10299: my ($tmp) = keys(%userenv);
10300: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10301: # default remote control to off
10302: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
10303: } else {
10304: undef(%userenv);
10305: }
10306: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10307: $form->{'interface'}=$userenv{'interface'};
10308: }
10309: $env{'environment.remote'}=$userenv{'remote'};
10310: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10311:
10312: # --------------- Do not trust query string to be put directly into environment
10313: foreach my $option ('imagesuppress','appletsuppress',
10314: 'embedsuppress','fontenhance','blackwhite',
10315: 'interface','localpath','localres') {
10316: $form->{$option}=~s/[\n\r\=]//gs;
10317: }
10318: # --------------------------------------------------------- Write first profile
10319:
10320: {
10321: my %initial_env =
10322: ("user.name" => $username,
10323: "user.domain" => $domain,
10324: "user.home" => $authhost,
10325: "browser.type" => $clientbrowser,
10326: "browser.version" => $clientversion,
10327: "browser.mathml" => $clientmathml,
10328: "browser.unicode" => $clientunicode,
10329: "browser.os" => $clientos,
10330: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10331: "request.course.fn" => '',
10332: "request.course.uri" => '',
10333: "request.course.sec" => '',
10334: "request.role" => 'cm',
10335: "request.role.adv" => $env{'user.adv'},
10336: "request.host" => $ENV{'REMOTE_ADDR'},);
10337:
10338: if ($form->{'localpath'}) {
10339: $initial_env{"browser.localpath"} = $form->{'localpath'};
10340: $initial_env{"browser.localres"} = $form->{'localres'};
10341: }
10342:
10343: if ($public) {
10344: $initial_env{"environment.remote"} = "off";
10345: }
10346: if ($form->{'interface'}) {
10347: $form->{'interface'}=~s/\W//gs;
10348: $initial_env{"browser.interface"} = $form->{'interface'};
10349: $env{'browser.interface'}=$form->{'interface'};
10350: foreach my $option ('imagesuppress','appletsuppress',
10351: 'embedsuppress','fontenhance','blackwhite') {
10352: if (($form->{$option} eq 'true') ||
10353: ($userenv{$option} eq 'on')) {
10354: $initial_env{"browser.$option"} = "on";
10355: }
10356: }
10357: }
10358:
1.724 raeburn 10359: foreach my $tool ('aboutme','blog','portfolio') {
10360: $userenv{'availabletools.'.$tool} =
10361: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10362: }
10363:
1.765 raeburn 10364: foreach my $crstype ('official','unofficial') {
10365: $userenv{'canrequest.'.$crstype} =
10366: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10367: 'reload','requestcourses');
10368: }
10369:
1.462 albertel 10370: $env{'user.environment'} = "$lonids/$cookie.id";
10371:
10372: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10373: &GDBM_WRCREAT(),0640)) {
10374: &_add_to_env(\%disk_env,\%initial_env);
10375: &_add_to_env(\%disk_env,\%userenv,'environment.');
10376: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10377: if (ref($args->{'extra_env'})) {
10378: &_add_to_env(\%disk_env,$args->{'extra_env'});
10379: }
1.462 albertel 10380: untie(%disk_env);
10381: } else {
1.705 tempelho 10382: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10383: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10384: return 'error: '.$!;
10385: }
10386: }
10387: $env{'request.role'}='cm';
10388: $env{'request.role.adv'}=$env{'user.adv'};
10389: $env{'browser.type'}=$clientbrowser;
10390:
10391: return $cookie;
10392:
10393: }
10394:
10395: sub _add_to_env {
10396: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10397: if (ref($env_data) eq 'HASH') {
10398: while (my ($key,$value) = each(%$env_data)) {
10399: $idf->{$prefix.$key} = $value;
10400: $env{$prefix.$key} = $value;
10401: }
1.462 albertel 10402: }
10403: }
10404:
1.685 tempelho 10405: # --- Get the symbolic name of a problem and the url
10406: sub get_symb {
10407: my ($request,$silent) = @_;
1.726 raeburn 10408: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10409: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10410: if ($symb eq '') {
10411: if (!$silent) {
10412: $request->print("Unable to handle ambiguous references:$url:.");
10413: return ();
10414: }
10415: }
10416: &Apache::lonenc::check_decrypt(\$symb);
10417: return ($symb);
10418: }
10419:
10420: # --------------------------------------------------------------Get annotation
10421:
10422: sub get_annotation {
10423: my ($symb,$enc) = @_;
10424:
10425: my $key = $symb;
10426: if (!$enc) {
10427: $key =
10428: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10429: }
10430: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10431: return $annotation{$key};
10432: }
10433:
10434: sub clean_symb {
1.731 raeburn 10435: my ($symb,$delete_enc) = @_;
1.685 tempelho 10436:
10437: &Apache::lonenc::check_decrypt(\$symb);
10438: my $enc = $env{'request.enc'};
1.731 raeburn 10439: if ($delete_enc) {
1.730 raeburn 10440: delete($env{'request.enc'});
10441: }
1.685 tempelho 10442:
10443: return ($symb,$enc);
10444: }
1.462 albertel 10445:
1.41 ng 10446: =pod
10447:
10448: =back
10449:
1.112 bowersj2 10450: =cut
1.41 ng 10451:
1.112 bowersj2 10452: 1;
10453: __END__;
1.41 ng 10454:
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