Annotation of loncom/interface/loncommon.pm, revision 1.804
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.804 ! bisitz 4: # $Id: loncommon.pm,v 1.803 2009/05/05 16:51:22 bisitz 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:
4218: =item * $notopbar, 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:
4223: =item * $notitle, if true keep the nav controls, but remove the title bar
4224:
1.361 albertel 4225: =item * $no_inline_link, if true and in remote mode, don't show the
4226: 'Switch To Inline Menu' link
4227:
1.460 albertel 4228: =item * $args, optional argument valid values are
4229: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4230: inherit_jsmath -> when creating popup window in a page,
4231: should it have jsmath forced on by the
4232: current page
1.460 albertel 4233:
1.112 bowersj2 4234: =back
4235:
1.60 matthew 4236: Returns: A uniform header for LON-CAPA web pages.
4237: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4238: If $bodyonly is undef or zero, an html string containing a <body> tag and
4239: other decorations will be returned.
4240:
4241: =cut
4242:
1.54 www 4243: sub bodytag {
1.309 albertel 4244: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.460 albertel 4245: $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
1.339 albertel 4246:
1.460 albertel 4247: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4248:
1.183 matthew 4249: $function = &get_users_function() if (!$function);
1.339 albertel 4250: my $img = &designparm($function.'.img',$domain);
4251: my $font = &designparm($function.'.font',$domain);
4252: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4253:
1.803 bisitz 4254: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4255: 'bgcolor' => $pgbg,
1.339 albertel 4256: 'text' => $font,
4257: 'alink' => &designparm($function.'.alink',$domain),
4258: 'vlink' => &designparm($function.'.vlink',$domain),
4259: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4260: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4261:
1.63 www 4262: # role and realm
1.378 raeburn 4263: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4264: if ($role eq 'ca') {
1.479 albertel 4265: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4266: $realm = &plainname($rname,$rdom);
1.378 raeburn 4267: }
1.55 www 4268: # realm
1.258 albertel 4269: if ($env{'request.course.id'}) {
1.378 raeburn 4270: if ($env{'request.role'} !~ /^cr/) {
4271: $role = &Apache::lonnet::plaintext($role,&course_type());
4272: }
1.359 albertel 4273: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4274: } else {
4275: $role = &Apache::lonnet::plaintext($role);
1.54 www 4276: }
1.433 albertel 4277:
1.359 albertel 4278: if (!$realm) { $realm=' '; }
1.55 www 4279: # Set messages
1.60 matthew 4280: my $messages=&domainlogo($domain);
1.330 albertel 4281:
1.438 albertel 4282: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4283:
1.101 www 4284: # construct main body tag
1.359 albertel 4285: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4286: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4287:
1.530 albertel 4288: if ($bodyonly) {
1.60 matthew 4289: return $bodytag;
1.798 tempelho 4290: }
1.359 albertel 4291:
1.410 albertel 4292: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4293: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4294: undef($role);
1.434 albertel 4295: } else {
4296: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4297: }
1.359 albertel 4298:
4299: my $roleinfo=(<<ENDROLE);
4300: <td class="LC_title_bar_who">
4301: <div class="LC_title_bar_name">
1.410 albertel 4302: $name
1.361 albertel 4303:
1.359 albertel 4304: </div>
4305: <div class="LC_title_bar_role">
1.361 albertel 4306: $role
1.359 albertel 4307: </div>
4308: <div class="LC_title_bar_realm">
1.361 albertel 4309: $realm
1.359 albertel 4310: </div>
1.206 albertel 4311: </td>
4312: ENDROLE
1.235 raeburn 4313:
1.762 bisitz 4314: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4315: if ($customtitle) {
4316: $titleinfo = $customtitle;
4317: }
4318: #
4319: # Extra info if you are the DC
4320: my $dc_info = '';
4321: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4322: $env{'course.'.$env{'request.course.id'}.
4323: '.domain'}.'/'})) {
4324: my $cid = $env{'request.course.id'};
4325: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4326: $dc_info =~ s/\s+$//;
1.359 albertel 4327: $dc_info = '('.$dc_info.')';
4328: }
4329:
1.644 www 4330: if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359 albertel 4331: # No Remote
1.258 albertel 4332: if ($env{'request.state'} eq 'construct') {
1.359 albertel 4333: $forcereg=1;
4334: }
4335:
4336: if (!$customtitle && $env{'request.state'} eq 'construct') {
4337: # this is for resources; directories have customtitle, and crumbs
4338: # and select recent are created in lonpubdir.pm
1.229 albertel 4339: my ($uname,$thisdisfn)=
1.258 albertel 4340: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229 albertel 4341: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4342: $formaction=~s/\/+/\//g;
4343:
1.359 albertel 4344: my $parentpath = '';
4345: my $lastitem = '';
4346: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4347: $parentpath = $1;
4348: $lastitem = $2;
4349: } else {
4350: $lastitem = $thisdisfn;
4351: }
4352: $titleinfo =
1.640 bisitz 4353: &Apache::loncommon::help_open_menu('','',3,'Authoring')
4354: .'<b>'.&mt('Construction Space').'</b>: '
4355: .'<form name="dirs" method="post" action="'.$formaction
1.359 albertel 4356: .'" target="_top"><tt><b>'
1.705 tempelho 4357: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<span class=\"LC_fontsize_big\">$lastitem</span></b></tt><br />"
1.359 albertel 4358: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4359: .'</form>'
4360: .&Apache::lonmenu::constspaceform();
1.235 raeburn 4361: }
1.359 albertel 4362:
1.337 albertel 4363: my $titletable;
1.338 albertel 4364: if (!$notitle) {
1.337 albertel 4365: $titletable =
1.359 albertel 4366: '<table id="LC_title_bar">'.
4367: "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
4368: '</tr></table>';
1.337 albertel 4369: }
1.359 albertel 4370: if ($notopbar) {
4371: $bodytag .= $titletable;
4372: } else {
4373: if ($env{'request.state'} eq 'construct') {
1.337 albertel 4374: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
4375: $titletable);
1.272 raeburn 4376: } else {
1.336 albertel 4377: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359 albertel 4378: $titletable;
1.272 raeburn 4379: }
1.235 raeburn 4380: }
4381: return $bodytag;
1.94 www 4382: }
1.95 www 4383:
1.93 www 4384: #
1.95 www 4385: # Top frame rendering, Remote is up
1.93 www 4386: #
1.359 albertel 4387:
1.517 raeburn 4388: my $imgsrc = $img;
4389: if ($img =~ /^\/adm/) {
1.575 albertel 4390: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4391: }
4392: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4393:
1.305 www 4394: # Explicit link to get inline menu
1.361 albertel 4395: my $menu= ($no_inline_link?''
4396: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245 matthew 4397: #
1.338 albertel 4398: if ($notitle) {
1.337 albertel 4399: return $bodytag;
4400: }
1.94 www 4401: return(<<ENDBODY);
1.60 matthew 4402: $bodytag
1.359 albertel 4403: <table id="LC_title_bar" class="LC_with_remote">
1.791 tempelho 4404: <tr><td>$upperleft</td>
4405: <td>$messages </td>
1.54 www 4406: </tr>
1.359 albertel 4407: <tr><td>$titleinfo $dc_info $menu</td>
4408: $roleinfo
1.368 albertel 4409: </tr>
1.356 albertel 4410: </table>
1.54 www 4411: ENDBODY
1.182 matthew 4412: }
4413:
1.330 albertel 4414: sub make_attr_string {
4415: my ($register,$attr_ref) = @_;
4416:
4417: if ($attr_ref && !ref($attr_ref)) {
4418: die("addentries Must be a hash ref ".
4419: join(':',caller(1))." ".
4420: join(':',caller(0))." ");
4421: }
4422:
4423: if ($register) {
1.339 albertel 4424: my ($on_load,$on_unload);
4425: foreach my $key (keys(%{$attr_ref})) {
4426: if (lc($key) eq 'onload') {
4427: $on_load.=$attr_ref->{$key}.';';
4428: delete($attr_ref->{$key});
4429:
4430: } elsif (lc($key) eq 'onunload') {
4431: $on_unload.=$attr_ref->{$key}.';';
4432: delete($attr_ref->{$key});
4433: }
4434: }
4435: $attr_ref->{'onload'} =
4436: &Apache::lonmenu::loadevents(). $on_load;
4437: $attr_ref->{'onunload'}=
4438: &Apache::lonmenu::unloadevents().$on_unload;
4439: }
4440:
4441: # Accessibility font enhance
4442: if ($env{'browser.fontenhance'} eq 'on') {
4443: my $style;
4444: foreach my $key (keys(%{$attr_ref})) {
4445: if (lc($key) eq 'style') {
4446: $style.=$attr_ref->{$key}.';';
4447: delete($attr_ref->{$key});
4448: }
4449: }
4450: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4451: }
1.339 albertel 4452:
4453: if ($env{'browser.blackwhite'} eq 'on') {
4454: delete($attr_ref->{'font'});
4455: delete($attr_ref->{'link'});
4456: delete($attr_ref->{'alink'});
4457: delete($attr_ref->{'vlink'});
4458: delete($attr_ref->{'bgcolor'});
4459: delete($attr_ref->{'background'});
4460: }
4461:
1.330 albertel 4462: my $attr_string;
4463: foreach my $attr (keys(%$attr_ref)) {
4464: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4465: }
4466: return $attr_string;
4467: }
4468:
4469:
1.182 matthew 4470: ###############################################
1.251 albertel 4471: ###############################################
4472:
4473: =pod
4474:
4475: =item * &endbodytag()
4476:
4477: Returns a uniform footer for LON-CAPA web pages.
4478:
1.635 raeburn 4479: Inputs: 1 - optional reference to an args hash
4480: If in the hash, key for noredirectlink has a value which evaluates to true,
4481: a 'Continue' link is not displayed if the page contains an
4482: internal redirect in the <head></head> section,
4483: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4484:
4485: =cut
4486:
4487: sub endbodytag {
1.635 raeburn 4488: my ($args) = @_;
1.251 albertel 4489: my $endbodytag='</body>';
1.269 albertel 4490: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4491: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4492: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4493: $endbodytag=
4494: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4495: &mt('Continue').'</a>'.
4496: $endbodytag;
4497: }
1.315 albertel 4498: }
1.251 albertel 4499: return $endbodytag;
4500: }
4501:
1.352 albertel 4502: =pod
4503:
4504: =item * &standard_css()
4505:
4506: Returns a style sheet
4507:
4508: Inputs: (all optional)
4509: domain -> force to color decorate a page for a specific
4510: domain
4511: function -> force usage of a specific rolish color scheme
4512: bgcolor -> override the default page bgcolor
4513:
4514: =cut
4515:
1.343 albertel 4516: sub standard_css {
1.345 albertel 4517: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4518: $function = &get_users_function() if (!$function);
4519: my $img = &designparm($function.'.img', $domain);
4520: my $tabbg = &designparm($function.'.tabbg', $domain);
4521: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4522: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4523: #second colour for later usage
1.345 albertel 4524: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4525: my $pgbg_or_bgcolor =
4526: $bgcolor ||
1.352 albertel 4527: &designparm($function.'.pgbg', $domain);
1.382 albertel 4528: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4529: my $alink = &designparm($function.'.alink', $domain);
4530: my $vlink = &designparm($function.'.vlink', $domain);
4531: my $link = &designparm($function.'.link', $domain);
4532:
1.704 muellerd 4533: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4534: my $bgcol = &designparm('login.bgcol',$domain);
4535: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4536:
1.602 albertel 4537: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4538: my $mono = 'monospace';
1.352 albertel 4539: my $data_table_head = $tabbg;
4540: my $data_table_light = '#EEEEEE';
1.470 banghart 4541: my $data_table_dark = '#DDDDDD';
4542: my $data_table_darker = '#CCCCCC';
1.349 albertel 4543: my $data_table_highlight = '#FFFF00';
1.352 albertel 4544: my $mail_new = '#FFBB77';
4545: my $mail_new_hover = '#DD9955';
4546: my $mail_read = '#BBBB77';
4547: my $mail_read_hover = '#999944';
4548: my $mail_replied = '#AAAA88';
4549: my $mail_replied_hover = '#888855';
4550: my $mail_other = '#99BBBB';
4551: my $mail_other_hover = '#669999';
1.391 albertel 4552: my $table_header = '#DDDDDD';
1.489 raeburn 4553: my $feedback_link_bg = '#BBBBBB';
1.701 harmsja 4554: my $lg_border_color = '#C8C8C8';
1.392 albertel 4555:
1.608 albertel 4556: my $border = ($env{'browser.type'} eq 'explorer' ||
1.803 bisitz 4557: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4558: : '0 3px 0 4px';
1.448 albertel 4559:
1.523 albertel 4560:
1.343 albertel 4561: return <<END;
1.795 www 4562: body {
4563: font-family: $sans;
4564: line-height:130%;
4565: font-size:0.83em;
4566: color:$font;
4567: }
4568:
4569: a:link, a:visited {
4570: font-size:100%;
4571: }
4572:
4573: a:focus {
4574: color: red;
4575: background: yellow
4576: }
1.698 harmsja 4577:
1.510 albertel 4578: table.thinborder,
4579: table.thinborder tr th {
4580: border-style: solid;
4581: border-width: 1px;
1.698 harmsja 4582: border-color: $lg_border_color;
1.510 albertel 4583: background: $tabbg;
4584: }
1.795 www 4585:
1.523 albertel 4586: table.thinborder tr td {
1.510 albertel 4587: border-style: solid;
1.698 harmsja 4588: border-width: 1px;
4589: border-color: $lg_border_color;
1.510 albertel 4590: }
1.426 albertel 4591:
1.795 www 4592: form, .inline {
4593: display: inline;
4594: }
1.721 harmsja 4595:
1.795 www 4596: .LC_right {
4597: text-align:right;
4598: }
4599:
4600: .LC_middle {
4601: vertical-align:middle;
4602: }
1.721 harmsja 4603:
4604: /* just for tests */
1.754 droeschl 4605: .LC_400Box {width:400px; }
1.721 harmsja 4606: /* end */
4607:
1.778 bisitz 4608: .LC_filename {
4609: font-family: $mono;
4610: white-space:pre;
4611: }
4612:
4613: .LC_fileicon {
4614: border: none;
4615: height: 1.3em;
4616: vertical-align: text-bottom;
4617: margin-right: 0.3em;
4618: text-decoration:none;
4619: }
4620:
1.350 albertel 4621: .LC_error {
4622: color: red;
4623: font-size: larger;
4624: }
1.795 www 4625:
1.457 albertel 4626: .LC_warning,
4627: .LC_diff_removed {
1.733 bisitz 4628: color: red;
1.394 albertel 4629: }
1.532 albertel 4630:
4631: .LC_info,
1.457 albertel 4632: .LC_success,
4633: .LC_diff_added {
1.350 albertel 4634: color: green;
4635: }
1.795 www 4636:
1.802 bisitz 4637: div.LC_confirm_box {
4638: background-color: #FAFAFA;
4639: border: 1px solid $lg_border_color;
4640: margin-right: 0;
4641: padding: 5px;
4642: }
4643:
4644: div.LC_confirm_box .LC_error img,
4645: div.LC_confirm_box .LC_success img {
4646: vertical-align: middle;
4647: }
4648:
1.543 albertel 4649: .LC_unknown {
4650: color: yellow;
4651: }
4652:
1.440 albertel 4653: .LC_icon {
1.771 droeschl 4654: border: none;
1.790 droeschl 4655: vertical-align: middle;
1.771 droeschl 4656: }
4657:
1.539 albertel 4658: .LC_indexer_icon {
1.803 bisitz 4659: border: none;
1.539 albertel 4660: height: 22px;
4661: }
1.795 www 4662:
1.543 albertel 4663: .LC_docs_spacer {
4664: width: 25px;
4665: height: 1px;
1.771 droeschl 4666: border: none;
1.543 albertel 4667: }
1.346 albertel 4668:
1.532 albertel 4669: .LC_internal_info {
1.735 bisitz 4670: color: #999999;
1.532 albertel 4671: }
4672:
1.794 www 4673: .LC_discussion {
4674: background: $tabbg;
4675: border: 1px solid black;
4676: margin: 2px;
4677: }
4678:
4679: .LC_disc_action_links_bar {
4680: background: $tabbg;
4681: font-family: $sans;
1.803 bisitz 4682: border: none;
1.795 www 4683: margin: 4px;
1.794 www 4684: }
4685:
4686: .LC_disc_action_left {
4687: text-align: left;
4688: }
4689:
4690: .LC_disc_action_right {
4691: text-align: right;
4692: }
4693:
4694: .LC_disc_new_item {
4695: background: white;
4696: border: 2px solid red;
4697: margin: 2px;
4698: }
4699:
4700: .LC_disc_old_item {
4701: background: white;
4702: border: 1px solid black;
4703: margin: 2px;
4704: }
4705:
1.458 albertel 4706: table.LC_pastsubmission {
4707: border: 1px solid black;
4708: margin: 2px;
4709: }
4710:
1.795 www 4711: table#LC_top_nav,
4712: table#LC_menubuttons,
4713: table#LC_nav_location {
1.345 albertel 4714: width: 100%;
4715: background: $pgbg;
1.392 albertel 4716: border: 2px;
1.402 albertel 4717: border-collapse: separate;
1.803 bisitz 4718: padding: 0;
1.345 albertel 4719: }
1.392 albertel 4720:
1.801 tempelho 4721: table#LC_title_bar a {
4722: color: $fontmenu;
4723: }
4724:
1.795 www 4725: table#LC_title_bar,
4726: table.LC_breadcrumbs,
1.393 albertel 4727: table#LC_title_bar.LC_with_remote {
1.359 albertel 4728: width: 100%;
1.392 albertel 4729: border-color: $pgbg;
4730: border-style: solid;
4731: border-width: $border;
1.379 albertel 4732: background: $pgbg;
1.801 tempelho 4733: color: $fontmenu;
1.379 albertel 4734: font-family: $sans;
1.392 albertel 4735: border-collapse: collapse;
1.803 bisitz 4736: padding: 0;
1.359 albertel 4737: }
1.795 www 4738:
1.409 albertel 4739: table.LC_docs_path {
4740: width: 100%;
4741: border: 0;
4742: background: $pgbg;
4743: font-family: $sans;
4744: border-collapse: collapse;
1.803 bisitz 4745: padding: 0;
1.409 albertel 4746: }
4747:
1.359 albertel 4748: table#LC_title_bar td {
4749: background: $tabbg;
4750: }
1.795 www 4751:
1.773 ehlerst 4752: table#LC_title_bar .LC_title_bar_who {
1.359 albertel 4753: background: $tabbg;
1.801 tempelho 4754: color: $fontmenu;
1.427 albertel 4755: font: small $sans;
1.359 albertel 4756: text-align: right;
1.803 bisitz 4757: margin: 0;
1.773 ehlerst 4758: }
1.795 www 4759:
1.773 ehlerst 4760: table#LC_title_bar .LC_title_bar_name {
1.803 bisitz 4761: margin: 0;
1.773 ehlerst 4762: }
1.795 www 4763:
1.773 ehlerst 4764: table#LC_title_bar .LC_title_bar_role {
1.803 bisitz 4765: margin: 0;
1.773 ehlerst 4766: }
1.795 www 4767:
1.775 bisitz 4768: table#LC_title_bar .LC_title_bar_realm {
1.803 bisitz 4769: margin: 0;
1.359 albertel 4770: }
1.795 www 4771:
1.469 banghart 4772: span.LC_metadata {
1.795 www 4773: font-family: $sans;
1.469 banghart 4774: }
1.359 albertel 4775:
1.706 harmsja 4776: table#LC_menubuttons img{
1.803 bisitz 4777: border: none;
1.346 albertel 4778: }
1.795 www 4779:
1.345 albertel 4780: table#LC_top_nav td {
4781: background: $tabbg;
1.803 bisitz 4782: border: none;
1.407 albertel 4783: font-size: small;
1.706 harmsja 4784: vertical-align:top;
4785: padding:2px 5px 2px 5px;
1.345 albertel 4786: }
1.795 www 4787:
4788: table#LC_top_nav td a,
4789: div#LC_top_nav a {
1.345 albertel 4790: color: $font;
4791: font-family: $sans;
4792: }
1.795 www 4793:
1.364 albertel 4794: table#LC_top_nav td.LC_top_nav_logo {
4795: background: $tabbg;
1.432 albertel 4796: text-align: left;
1.408 albertel 4797: white-space: nowrap;
1.432 albertel 4798: width: 31px;
1.408 albertel 4799: }
1.795 www 4800:
1.408 albertel 4801: table#LC_top_nav td.LC_top_nav_logo img {
1.803 bisitz 4802: border: none;
1.408 albertel 4803: vertical-align: bottom;
1.364 albertel 4804: }
1.795 www 4805:
1.777 tempelho 4806: table#LC_top_nav td.LC_top_nav_exit,
1.779 bisitz 4807: table#LC_top_nav td.LC_top_nav_help {
1.777 tempelho 4808: width: 2.0em;
4809: }
1.795 www 4810:
1.442 albertel 4811: table#LC_top_nav td.LC_top_nav_login {
4812: width: 4.0em;
4813: text-align: center;
4814: }
1.795 www 4815:
4816: table.LC_breadcrumbs td,
4817: table.LC_docs_path td {
1.357 albertel 4818: background: $tabbg;
1.801 tempelho 4819: color: $fontmenu;
1.357 albertel 4820: font-family: $sans;
1.358 albertel 4821: font-size: smaller;
1.357 albertel 4822: }
1.795 www 4823:
1.777 tempelho 4824: table.LC_breadcrumbs td.LC_breadcrumbs_component,
4825: table.LC_docs_path td.LC_docs_path_component {
1.779 bisitz 4826: background: $tabbg;
1.801 tempelho 4827: color: $fontmenu;
1.777 tempelho 4828: font-family: $sans;
1.779 bisitz 4829: font-size: larger;
4830: text-align: right;
1.777 tempelho 4831: }
1.795 www 4832:
1.383 albertel 4833: td.LC_table_cell_checkbox {
4834: text-align: center;
4835: }
1.795 www 4836:
1.779 bisitz 4837: table#LC_mainmenu td.LC_mainmenu_column {
4838: vertical-align: top;
1.777 tempelho 4839: }
1.522 albertel 4840:
1.795 www 4841: .LC_fontsize_small {
1.705 tempelho 4842: font-size: 70%;
4843: }
4844:
1.795 www 4845: .LC_fontsize_medium {
1.705 tempelho 4846: font-size: 85%;
4847: }
4848:
1.795 www 4849: .LC_fontsize_large {
1.705 tempelho 4850: font-size: 120%;
4851: }
4852:
1.346 albertel 4853: .LC_menubuttons_inline_text {
4854: color: $font;
4855: font-family: $sans;
1.698 harmsja 4856: font-size: 90%;
1.701 harmsja 4857: padding-left:3px;
1.346 albertel 4858: }
4859:
1.526 www 4860: .LC_menubuttons_link {
4861: text-decoration: none;
4862: }
1.795 www 4863:
1.522 albertel 4864: .LC_menubuttons_category {
1.521 www 4865: color: $font;
1.526 www 4866: background: $pgbg;
1.521 www 4867: font-family: $sans;
4868: font-size: larger;
4869: font-weight: bold;
4870: }
4871:
1.346 albertel 4872: td.LC_menubuttons_text {
1.779 bisitz 4873: color: $font;
1.346 albertel 4874: }
1.706 harmsja 4875:
1.346 albertel 4876: .LC_current_location {
4877: font-family: $sans;
4878: background: $tabbg;
4879: }
1.795 www 4880:
1.346 albertel 4881: .LC_new_mail {
4882: font-family: $sans;
1.634 www 4883: background: $tabbg;
1.346 albertel 4884: font-weight: bold;
4885: }
1.347 albertel 4886:
1.527 www 4887: .LC_dropadd_labeltext {
4888: font-family: $sans;
4889: text-align: right;
4890: }
4891:
4892: .LC_preferences_labeltext {
4893: font-family: $sans;
4894: text-align: right;
4895: }
4896:
1.666 raeburn 4897: .LC_roleslog_note {
1.701 harmsja 4898: font-size: small;
1.666 raeburn 4899: }
4900:
1.715 raeburn 4901: .LC_mail_functions {
4902: font-weight: bold;
4903: }
4904:
1.440 albertel 4905: table.LC_aboutme_port {
1.803 bisitz 4906: border: none;
1.440 albertel 4907: border-collapse: collapse;
1.803 bisitz 4908: border-spacing: 0;
1.440 albertel 4909: }
1.795 www 4910:
4911: table.LC_data_table,
4912: table.LC_mail_list {
1.347 albertel 4913: border: 1px solid #000000;
1.402 albertel 4914: border-collapse: separate;
1.426 albertel 4915: border-spacing: 1px;
1.610 albertel 4916: background: $pgbg;
1.347 albertel 4917: }
1.795 www 4918:
1.422 albertel 4919: .LC_data_table_dense {
4920: font-size: small;
4921: }
1.795 www 4922:
1.507 raeburn 4923: table.LC_nested_outer {
4924: border: 1px solid #000000;
1.589 raeburn 4925: border-collapse: collapse;
1.803 bisitz 4926: border-spacing: 0;
1.507 raeburn 4927: width: 100%;
4928: }
1.795 www 4929:
1.507 raeburn 4930: table.LC_nested {
1.803 bisitz 4931: border: none;
1.589 raeburn 4932: border-collapse: collapse;
1.803 bisitz 4933: border-spacing: 0;
1.507 raeburn 4934: width: 100%;
4935: }
1.795 www 4936:
4937: table.LC_data_table tr th,
4938: table.LC_calendar tr th,
4939: table.LC_mail_list tr th,
1.523 albertel 4940: table.LC_prior_tries tr th {
1.349 albertel 4941: font-weight: bold;
4942: background-color: $data_table_head;
1.801 tempelho 4943: color:$fontmenu;
1.701 harmsja 4944: font-size:90%;
1.347 albertel 4945: }
1.795 www 4946:
1.711 raeburn 4947: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 4948: background-color: #CCCCCC;
1.711 raeburn 4949: font-weight: bold;
4950: text-align: left;
4951: }
1.795 www 4952:
1.779 bisitz 4953: table.LC_data_table tr.LC_odd_row > td,
1.709 bisitz 4954: table.LC_pick_box tr > td.LC_odd_row,
1.440 albertel 4955: table.LC_aboutme_port tr td {
1.349 albertel 4956: background-color: $data_table_light;
1.425 albertel 4957: padding: 2px;
1.347 albertel 4958: }
1.795 www 4959:
1.610 albertel 4960: table.LC_data_table tr.LC_even_row > td,
1.709 bisitz 4961: table.LC_pick_box tr > td.LC_even_row,
1.440 albertel 4962: table.LC_aboutme_port tr.LC_even_row td {
1.349 albertel 4963: background-color: $data_table_dark;
1.709 bisitz 4964: padding: 2px;
1.347 albertel 4965: }
1.795 www 4966:
1.425 albertel 4967: table.LC_data_table tr.LC_data_table_highlight td {
4968: background-color: $data_table_darker;
4969: }
1.795 www 4970:
1.639 raeburn 4971: table.LC_data_table tr td.LC_leftcol_header {
4972: background-color: $data_table_head;
4973: font-weight: bold;
4974: }
1.795 www 4975:
1.451 albertel 4976: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 4977: table.LC_nested tr.LC_empty_row td {
1.347 albertel 4978: background-color: #FFFFFF;
1.421 albertel 4979: font-weight: bold;
4980: font-style: italic;
4981: text-align: center;
4982: padding: 8px;
1.347 albertel 4983: }
1.795 www 4984:
1.507 raeburn 4985: table.LC_nested tr.LC_empty_row td {
1.465 albertel 4986: padding: 4ex
4987: }
1.795 www 4988:
1.507 raeburn 4989: table.LC_nested_outer tr th {
4990: font-weight: bold;
1.801 tempelho 4991: color:$fontmenu;
1.507 raeburn 4992: background-color: $data_table_head;
1.701 harmsja 4993: font-size: small;
1.507 raeburn 4994: border-bottom: 1px solid #000000;
4995: }
1.795 www 4996:
1.507 raeburn 4997: table.LC_nested_outer tr td.LC_subheader {
4998: background-color: $data_table_head;
4999: font-weight: bold;
5000: font-size: small;
5001: border-bottom: 1px solid #000000;
5002: text-align: right;
1.451 albertel 5003: }
1.795 www 5004:
1.507 raeburn 5005: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5006: background-color: #CCCCCC;
1.451 albertel 5007: font-weight: bold;
5008: font-size: small;
1.507 raeburn 5009: text-align: center;
5010: }
1.795 www 5011:
1.589 raeburn 5012: table.LC_nested tr.LC_info_row td.LC_left_item,
5013: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5014: text-align: left;
1.451 albertel 5015: }
1.795 www 5016:
1.507 raeburn 5017: table.LC_nested td {
1.735 bisitz 5018: background-color: #FFFFFF;
1.451 albertel 5019: font-size: small;
1.507 raeburn 5020: }
1.795 www 5021:
1.507 raeburn 5022: table.LC_nested_outer tr th.LC_right_item,
5023: table.LC_nested tr.LC_info_row td.LC_right_item,
5024: table.LC_nested tr.LC_odd_row td.LC_right_item,
5025: table.LC_nested tr td.LC_right_item {
1.451 albertel 5026: text-align: right;
5027: }
5028:
1.507 raeburn 5029: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5030: background-color: #EEEEEE;
1.451 albertel 5031: }
5032:
1.473 raeburn 5033: table.LC_createuser {
5034: }
5035:
5036: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5037: font-size: small;
1.473 raeburn 5038: }
5039:
5040: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5041: background-color: #CCCCCC;
1.473 raeburn 5042: font-weight: bold;
5043: text-align: center;
5044: }
5045:
1.349 albertel 5046: table.LC_calendar {
5047: border: 1px solid #000000;
5048: border-collapse: collapse;
5049: }
1.795 www 5050:
1.349 albertel 5051: table.LC_calendar_pickdate {
5052: font-size: xx-small;
5053: }
1.795 www 5054:
1.349 albertel 5055: table.LC_calendar tr td {
5056: border: 1px solid #000000;
5057: vertical-align: top;
5058: }
1.795 www 5059:
1.349 albertel 5060: table.LC_calendar tr td.LC_calendar_day_empty {
5061: background-color: $data_table_dark;
5062: }
1.795 www 5063:
1.779 bisitz 5064: table.LC_calendar tr td.LC_calendar_day_current {
5065: background-color: $data_table_highlight;
1.777 tempelho 5066: }
1.795 www 5067:
1.349 albertel 5068: table.LC_mail_list tr.LC_mail_new {
5069: background-color: $mail_new;
5070: }
1.795 www 5071:
1.349 albertel 5072: table.LC_mail_list tr.LC_mail_new:hover {
5073: background-color: $mail_new_hover;
5074: }
1.795 www 5075:
5076: table.LC_mail_list tr.LC_mail_even {
1.777 tempelho 5077: }
1.795 www 5078:
5079: table.LC_mail_list tr.LC_mail_odd {
1.777 tempelho 5080: }
1.795 www 5081:
1.349 albertel 5082: table.LC_mail_list tr.LC_mail_read {
5083: background-color: $mail_read;
5084: }
1.795 www 5085:
1.349 albertel 5086: table.LC_mail_list tr.LC_mail_read:hover {
5087: background-color: $mail_read_hover;
5088: }
1.795 www 5089:
1.349 albertel 5090: table.LC_mail_list tr.LC_mail_replied {
5091: background-color: $mail_replied;
5092: }
1.795 www 5093:
1.349 albertel 5094: table.LC_mail_list tr.LC_mail_replied:hover {
5095: background-color: $mail_replied_hover;
5096: }
1.795 www 5097:
1.349 albertel 5098: table.LC_mail_list tr.LC_mail_other {
5099: background-color: $mail_other;
5100: }
1.795 www 5101:
1.349 albertel 5102: table.LC_mail_list tr.LC_mail_other:hover {
5103: background-color: $mail_other_hover;
5104: }
1.494 raeburn 5105:
1.777 tempelho 5106: table.LC_data_table tr > td.LC_browser_file,
5107: table.LC_data_table tr > td.LC_browser_file_published {
1.389 albertel 5108: background: #CCFF88;
5109: }
1.795 www 5110:
1.777 tempelho 5111: table.LC_data_table tr > td.LC_browser_file_locked,
5112: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5113: background: #FFAA99;
1.387 albertel 5114: }
1.795 www 5115:
1.777 tempelho 5116: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.779 bisitz 5117: background: #AAAAAA;
5118: }
1.795 www 5119:
1.777 tempelho 5120: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5121: table.LC_data_table tr > td.LC_browser_file_metamodified {
5122: background: #FFFF77;
1.777 tempelho 5123: }
1.795 www 5124:
1.696 bisitz 5125: table.LC_data_table tr.LC_browser_folder > td {
1.389 albertel 5126: background: #CCCCFF;
1.387 albertel 5127: }
1.696 bisitz 5128:
1.707 bisitz 5129: table.LC_data_table tr > td.LC_roles_is {
5130: /* background: #77FF77; */
5131: }
1.795 www 5132:
1.707 bisitz 5133: table.LC_data_table tr > td.LC_roles_future {
5134: background: #FFFF77;
5135: }
1.795 www 5136:
1.707 bisitz 5137: table.LC_data_table tr > td.LC_roles_will {
5138: background: #FFAA77;
5139: }
1.795 www 5140:
1.707 bisitz 5141: table.LC_data_table tr > td.LC_roles_expired {
5142: background: #FF7777;
5143: }
1.795 www 5144:
1.707 bisitz 5145: table.LC_data_table tr > td.LC_roles_will_not {
5146: background: #AAFF77;
5147: }
1.795 www 5148:
1.707 bisitz 5149: table.LC_data_table tr > td.LC_roles_selected {
5150: background: #11CC55;
5151: }
5152:
1.388 albertel 5153: span.LC_current_location {
1.701 harmsja 5154: font-size:larger;
1.388 albertel 5155: background: $pgbg;
5156: }
1.387 albertel 5157:
1.395 albertel 5158: span.LC_parm_menu_item {
5159: font-size: larger;
5160: font-family: $sans;
5161: }
1.795 www 5162:
1.395 albertel 5163: span.LC_parm_scope_all {
5164: color: red;
5165: }
1.795 www 5166:
1.395 albertel 5167: span.LC_parm_scope_folder {
5168: color: green;
5169: }
1.795 www 5170:
1.395 albertel 5171: span.LC_parm_scope_resource {
5172: color: orange;
5173: }
1.795 www 5174:
1.395 albertel 5175: span.LC_parm_part {
5176: color: blue;
5177: }
1.795 www 5178:
1.395 albertel 5179: span.LC_parm_folder, span.LC_parm_symb {
5180: font-size: x-small;
5181: font-family: $mono;
5182: color: #AAAAAA;
5183: }
5184:
1.795 www 5185: td.LC_parm_overview_level_menu,
5186: td.LC_parm_overview_map_menu,
5187: td.LC_parm_overview_parm_selectors,
5188: td.LC_parm_overview_restrictions {
1.396 albertel 5189: border: 1px solid black;
5190: border-collapse: collapse;
5191: }
1.795 www 5192:
1.396 albertel 5193: table.LC_parm_overview_restrictions td {
5194: border-width: 1px 4px 1px 4px;
5195: border-style: solid;
5196: border-color: $pgbg;
5197: text-align: center;
5198: }
1.795 www 5199:
1.396 albertel 5200: table.LC_parm_overview_restrictions th {
5201: background: $tabbg;
5202: border-width: 1px 4px 1px 4px;
5203: border-style: solid;
5204: border-color: $pgbg;
5205: }
1.795 www 5206:
1.398 albertel 5207: table#LC_helpmenu {
1.803 bisitz 5208: border: none;
1.398 albertel 5209: height: 55px;
1.803 bisitz 5210: border-spacing: 0;
1.398 albertel 5211: }
5212:
5213: table#LC_helpmenu fieldset legend {
5214: font-size: larger;
5215: font-weight: bold;
5216: }
1.795 www 5217:
1.397 albertel 5218: table#LC_helpmenu_links {
5219: width: 100%;
5220: border: 1px solid black;
5221: background: $pgbg;
1.803 bisitz 5222: padding: 0;
1.397 albertel 5223: border-spacing: 1px;
5224: }
1.795 www 5225:
1.397 albertel 5226: table#LC_helpmenu_links tr td {
5227: padding: 1px;
5228: background: $tabbg;
1.399 albertel 5229: text-align: center;
5230: font-weight: bold;
1.397 albertel 5231: }
1.396 albertel 5232:
1.795 www 5233: table#LC_helpmenu_links a:link,
5234: table#LC_helpmenu_links a:visited,
1.397 albertel 5235: table#LC_helpmenu_links a:active {
5236: text-decoration: none;
5237: color: $font;
5238: }
1.795 www 5239:
1.397 albertel 5240: table#LC_helpmenu_links a:hover {
5241: text-decoration: underline;
5242: color: $vlink;
5243: }
1.396 albertel 5244:
1.417 albertel 5245: .LC_chrt_popup_exists {
5246: border: 1px solid #339933;
5247: margin: -1px;
5248: }
1.795 www 5249:
1.417 albertel 5250: .LC_chrt_popup_up {
5251: border: 1px solid yellow;
5252: margin: -1px;
5253: }
1.795 www 5254:
1.417 albertel 5255: .LC_chrt_popup {
5256: border: 1px solid #8888FF;
5257: background: #CCCCFF;
5258: }
1.795 www 5259:
1.421 albertel 5260: table.LC_pick_box {
5261: border-collapse: separate;
5262: background: white;
5263: border: 1px solid black;
5264: border-spacing: 1px;
5265: }
1.795 www 5266:
1.421 albertel 5267: table.LC_pick_box td.LC_pick_box_title {
5268: background: $tabbg;
5269: font-weight: bold;
5270: text-align: right;
1.740 bisitz 5271: vertical-align: top;
1.421 albertel 5272: width: 184px;
5273: padding: 8px;
5274: }
1.795 www 5275:
1.645 raeburn 5276: table.LC_pick_box td.LC_selfenroll_pick_box_title {
5277: background: $tabbg;
5278: font-weight: bold;
5279: text-align: right;
5280: width: 350px;
5281: padding: 8px;
5282: }
5283:
1.579 raeburn 5284: table.LC_pick_box td.LC_pick_box_value {
5285: text-align: left;
5286: padding: 8px;
5287: }
1.795 www 5288:
1.579 raeburn 5289: table.LC_pick_box td.LC_pick_box_select {
5290: text-align: left;
5291: padding: 8px;
5292: }
1.795 www 5293:
1.424 albertel 5294: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5295: padding: 0;
1.421 albertel 5296: height: 1px;
5297: background: black;
5298: }
1.795 www 5299:
1.421 albertel 5300: table.LC_pick_box td.LC_pick_box_submit {
5301: text-align: right;
5302: }
1.795 www 5303:
1.579 raeburn 5304: table.LC_pick_box td.LC_evenrow_value {
5305: text-align: left;
5306: padding: 8px;
5307: background-color: $data_table_light;
5308: }
1.795 www 5309:
1.579 raeburn 5310: table.LC_pick_box td.LC_oddrow_value {
5311: text-align: left;
5312: padding: 8px;
5313: background-color: $data_table_light;
5314: }
1.795 www 5315:
1.579 raeburn 5316: table.LC_helpform_receipt {
5317: width: 620px;
5318: border-collapse: separate;
5319: background: white;
5320: border: 1px solid black;
5321: border-spacing: 1px;
5322: }
1.795 www 5323:
1.579 raeburn 5324: table.LC_helpform_receipt td.LC_pick_box_title {
5325: background: $tabbg;
5326: font-weight: bold;
5327: text-align: right;
5328: width: 184px;
5329: padding: 8px;
5330: }
1.795 www 5331:
1.579 raeburn 5332: table.LC_helpform_receipt td.LC_evenrow_value {
5333: text-align: left;
5334: padding: 8px;
5335: background-color: $data_table_light;
5336: }
1.795 www 5337:
1.579 raeburn 5338: table.LC_helpform_receipt td.LC_oddrow_value {
5339: text-align: left;
5340: padding: 8px;
5341: background-color: $data_table_light;
5342: }
1.795 www 5343:
1.579 raeburn 5344: table.LC_helpform_receipt td.LC_pick_box_separator {
1.803 bisitz 5345: padding: 0;
1.579 raeburn 5346: height: 1px;
5347: background: black;
5348: }
1.795 www 5349:
1.579 raeburn 5350: span.LC_helpform_receipt_cat {
5351: font-weight: bold;
5352: }
1.795 www 5353:
1.424 albertel 5354: table.LC_group_priv_box {
5355: background: white;
5356: border: 1px solid black;
5357: border-spacing: 1px;
5358: }
1.795 www 5359:
1.424 albertel 5360: table.LC_group_priv_box td.LC_pick_box_title {
5361: background: $tabbg;
5362: font-weight: bold;
5363: text-align: right;
5364: width: 184px;
5365: }
1.795 www 5366:
1.424 albertel 5367: table.LC_group_priv_box td.LC_groups_fixed {
5368: background: $data_table_light;
5369: text-align: center;
5370: }
1.795 www 5371:
1.424 albertel 5372: table.LC_group_priv_box td.LC_groups_optional {
5373: background: $data_table_dark;
5374: text-align: center;
5375: }
1.795 www 5376:
1.424 albertel 5377: table.LC_group_priv_box td.LC_groups_functionality {
5378: background: $data_table_darker;
5379: text-align: center;
5380: font-weight: bold;
5381: }
1.795 www 5382:
1.424 albertel 5383: table.LC_group_priv td {
5384: text-align: left;
1.803 bisitz 5385: padding: 0;
1.424 albertel 5386: }
5387:
1.421 albertel 5388: table.LC_notify_front_page {
5389: background: white;
5390: border: 1px solid black;
5391: padding: 8px;
5392: }
1.795 www 5393:
1.421 albertel 5394: table.LC_notify_front_page td {
5395: padding: 8px;
5396: }
1.795 www 5397:
1.424 albertel 5398: .LC_navbuttons {
5399: margin: 2ex 0ex 2ex 0ex;
5400: }
1.795 www 5401:
1.423 albertel 5402: .LC_topic_bar {
5403: font-family: $sans;
5404: font-weight: bold;
5405: width: 100%;
5406: background: $tabbg;
5407: vertical-align: middle;
5408: margin: 2ex 0ex 2ex 0ex;
5409: }
1.795 www 5410:
1.423 albertel 5411: .LC_topic_bar span {
5412: vertical-align: middle;
5413: }
1.795 www 5414:
1.423 albertel 5415: .LC_topic_bar img {
5416: vertical-align: bottom;
5417: }
1.795 www 5418:
1.423 albertel 5419: table.LC_course_group_status {
5420: margin: 20px;
5421: }
1.795 www 5422:
1.423 albertel 5423: table.LC_status_selector td {
5424: vertical-align: top;
5425: text-align: center;
1.424 albertel 5426: padding: 4px;
5427: }
1.795 www 5428:
1.424 albertel 5429: table.LC_descriptive_input td.LC_description {
5430: vertical-align: top;
5431: text-align: right;
5432: font-weight: bold;
1.423 albertel 5433: }
1.795 www 5434:
1.599 albertel 5435: div.LC_feedback_link {
1.616 albertel 5436: clear: both;
1.599 albertel 5437: background: white;
1.779 bisitz 5438: width: 100%;
1.489 raeburn 5439: }
1.795 www 5440:
1.489 raeburn 5441: span.LC_feedback_link {
1.599 albertel 5442: background: $feedback_link_bg;
5443: font-size: larger;
5444: }
1.795 www 5445:
1.599 albertel 5446: span.LC_message_link {
5447: background: $feedback_link_bg;
5448: font-size: larger;
5449: position: absolute;
5450: right: 1em;
1.489 raeburn 5451: }
1.421 albertel 5452:
1.515 albertel 5453: table.LC_prior_tries {
1.524 albertel 5454: border: 1px solid #000000;
5455: border-collapse: separate;
5456: border-spacing: 1px;
1.515 albertel 5457: }
1.523 albertel 5458:
1.515 albertel 5459: table.LC_prior_tries td {
1.524 albertel 5460: padding: 2px;
1.515 albertel 5461: }
1.523 albertel 5462:
5463: .LC_answer_correct {
1.795 www 5464: background: lightgreen;
5465: font-family: $sans;
5466: color: darkgreen;
5467: padding: 6px;
1.523 albertel 5468: }
1.795 www 5469:
1.523 albertel 5470: .LC_answer_charged_try {
1.797 www 5471: background: #FFAAAA;
1.795 www 5472: font-family: $sans;
5473: color: darkred;
5474: padding: 6px;
1.523 albertel 5475: }
1.795 www 5476:
1.779 bisitz 5477: .LC_answer_not_charged_try,
1.523 albertel 5478: .LC_answer_no_grade,
5479: .LC_answer_late {
1.795 www 5480: background: lightyellow;
5481: font-family: $sans;
1.523 albertel 5482: color: black;
1.795 www 5483: padding: 6px;
1.523 albertel 5484: }
1.795 www 5485:
1.523 albertel 5486: .LC_answer_previous {
1.795 www 5487: background: lightblue;
5488: font-family: $sans;
5489: color: darkblue;
5490: padding: 6px;
1.523 albertel 5491: }
1.795 www 5492:
1.779 bisitz 5493: .LC_answer_no_message {
1.777 tempelho 5494: background: #FFFFFF;
1.795 www 5495: font-family: $sans;
1.777 tempelho 5496: color: black;
1.795 www 5497: padding: 6px;
1.779 bisitz 5498: }
1.795 www 5499:
1.779 bisitz 5500: .LC_answer_unknown {
5501: background: orange;
1.795 www 5502: font-family: $sans;
1.779 bisitz 5503: color: black;
1.795 www 5504: padding: 6px;
1.777 tempelho 5505: }
1.795 www 5506:
1.529 albertel 5507: span.LC_prior_numerical,
5508: span.LC_prior_string,
5509: span.LC_prior_custom,
5510: span.LC_prior_reaction,
5511: span.LC_prior_math {
1.523 albertel 5512: font-family: monospace;
5513: white-space: pre;
5514: }
5515:
1.525 albertel 5516: span.LC_prior_string {
5517: font-family: monospace;
5518: white-space: pre;
5519: }
5520:
1.523 albertel 5521: table.LC_prior_option {
5522: width: 100%;
5523: border-collapse: collapse;
5524: }
1.795 www 5525:
5526: table.LC_prior_rank,
5527: table.LC_prior_match {
1.528 albertel 5528: border-collapse: collapse;
5529: }
1.795 www 5530:
1.528 albertel 5531: table.LC_prior_option tr td,
5532: table.LC_prior_rank tr td,
5533: table.LC_prior_match tr td {
1.524 albertel 5534: border: 1px solid #000000;
1.515 albertel 5535: }
5536:
1.770 droeschl 5537: td.LC_nobreak,
1.519 raeburn 5538: span.LC_nobreak {
1.544 albertel 5539: white-space: nowrap;
1.519 raeburn 5540: }
5541:
1.576 raeburn 5542: span.LC_cusr_emph {
5543: font-style: italic;
5544: }
5545:
1.633 raeburn 5546: span.LC_cusr_subheading {
5547: font-weight: normal;
5548: font-size: 85%;
5549: }
5550:
1.545 albertel 5551: table.LC_docs_documents {
5552: background: #BBBBBB;
1.803 bisitz 5553: border-width: 0;
1.545 albertel 5554: border-collapse: collapse;
5555: }
1.795 www 5556:
1.777 tempelho 5557: table.LC_docs_documents td.LC_docs_document {
1.779 bisitz 5558: border: 2px solid black;
5559: padding: 4px;
1.777 tempelho 5560: }
1.795 www 5561:
1.545 albertel 5562: .LC_docs_entry_move {
1.803 bisitz 5563: border: none;
1.545 albertel 5564: border-collapse: collapse;
1.544 albertel 5565: }
5566:
1.545 albertel 5567: .LC_docs_entry_move td {
5568: border: 2px solid #BBBBBB;
5569: background: #DDDDDD;
5570: }
5571:
5572: .LC_docs_editor td.LC_docs_entry_commands {
5573: background: #DDDDDD;
5574: font-size: x-small;
5575: }
1.795 www 5576:
1.544 albertel 5577: .LC_docs_copy {
1.545 albertel 5578: color: #000099;
1.544 albertel 5579: }
1.795 www 5580:
1.544 albertel 5581: .LC_docs_cut {
1.545 albertel 5582: color: #550044;
1.544 albertel 5583: }
1.795 www 5584:
1.544 albertel 5585: .LC_docs_rename {
1.545 albertel 5586: color: #009900;
1.544 albertel 5587: }
1.795 www 5588:
1.544 albertel 5589: .LC_docs_remove {
1.545 albertel 5590: color: #990000;
5591: }
5592:
1.547 albertel 5593: .LC_docs_reinit_warn,
5594: .LC_docs_ext_edit {
5595: font-size: x-small;
5596: }
5597:
1.545 albertel 5598: .LC_docs_editor td.LC_docs_entry_title,
5599: .LC_docs_editor td.LC_docs_entry_icon {
5600: background: #FFFFBB;
5601: }
1.795 www 5602:
1.545 albertel 5603: .LC_docs_editor td.LC_docs_entry_parameter {
5604: background: #BBBBFF;
5605: font-size: x-small;
5606: white-space: nowrap;
5607: }
5608:
5609: table.LC_docs_adddocs td,
5610: table.LC_docs_adddocs th {
5611: border: 1px solid #BBBBBB;
5612: padding: 4px;
5613: background: #DDDDDD;
1.543 albertel 5614: }
5615:
1.584 albertel 5616: table.LC_sty_begin {
5617: background: #BBFFBB;
5618: }
1.795 www 5619:
1.584 albertel 5620: table.LC_sty_end {
5621: background: #FFBBBB;
5622: }
5623:
1.589 raeburn 5624: table.LC_double_column {
1.803 bisitz 5625: border-width: 0;
1.589 raeburn 5626: border-collapse: collapse;
5627: width: 100%;
5628: padding: 2px;
5629: }
5630:
5631: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5632: top: 2px;
1.589 raeburn 5633: left: 2px;
5634: width: 47%;
5635: vertical-align: top;
5636: }
5637:
5638: table.LC_double_column tr td.LC_right_col {
5639: top: 2px;
1.779 bisitz 5640: right: 2px;
1.589 raeburn 5641: width: 47%;
5642: vertical-align: top;
5643: }
5644:
1.594 raeburn 5645: span.LC_role_level {
5646: font-weight: bold;
5647: }
5648:
1.591 raeburn 5649: div.LC_left_float {
5650: float: left;
5651: padding-right: 5%;
1.597 albertel 5652: padding-bottom: 4px;
1.591 raeburn 5653: }
5654:
5655: div.LC_clear_float_header {
1.597 albertel 5656: padding-bottom: 2px;
1.591 raeburn 5657: }
5658:
5659: div.LC_clear_float_footer {
1.597 albertel 5660: padding-top: 10px;
1.591 raeburn 5661: clear: both;
5662: }
5663:
1.597 albertel 5664: div.LC_grade_show_user {
5665: margin-top: 20px;
5666: border: 1px solid black;
5667: }
1.795 www 5668:
1.597 albertel 5669: div.LC_grade_user_name {
5670: background: #DDDDEE;
5671: border-bottom: 1px solid black;
1.705 tempelho 5672: font-weight: bold;
5673: font-size: large;
1.597 albertel 5674: }
1.795 www 5675:
1.597 albertel 5676: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5677: background: #DDEEDD;
5678: }
5679:
5680: div.LC_grade_show_problem,
5681: div.LC_grade_submissions,
5682: div.LC_grade_message_center,
5683: div.LC_grade_info_links,
5684: div.LC_grade_assign {
5685: margin: 5px;
5686: width: 99%;
5687: background: #FFFFFF;
5688: }
1.795 www 5689:
1.597 albertel 5690: div.LC_grade_show_problem_header,
5691: div.LC_grade_submissions_header,
5692: div.LC_grade_message_center_header,
5693: div.LC_grade_assign_header {
1.705 tempelho 5694: font-weight: bold;
5695: font-size: large;
1.597 albertel 5696: }
1.795 www 5697:
1.597 albertel 5698: div.LC_grade_show_problem_problem,
5699: div.LC_grade_submissions_body,
5700: div.LC_grade_message_center_body,
5701: div.LC_grade_assign_body {
5702: border: 1px solid black;
5703: width: 99%;
5704: background: #FFFFFF;
5705: }
1.795 www 5706:
1.598 albertel 5707: span.LC_grade_check_note {
1.705 tempelho 5708: font-weight: normal;
5709: font-size: medium;
1.598 albertel 5710: display: inline;
5711: position: absolute;
5712: right: 1em;
5713: }
1.597 albertel 5714:
1.613 albertel 5715: table.LC_scantron_action {
5716: width: 100%;
5717: }
1.795 www 5718:
1.613 albertel 5719: table.LC_scantron_action tr th {
1.698 harmsja 5720: font-weight:bold;
5721: font-style:normal;
1.613 albertel 5722: }
1.795 www 5723:
1.779 bisitz 5724: .LC_edit_problem_header,
1.614 albertel 5725: div.LC_edit_problem_footer {
1.705 tempelho 5726: font-weight: normal;
5727: font-size: medium;
1.602 albertel 5728: margin: 2px;
1.600 albertel 5729: }
1.795 www 5730:
1.600 albertel 5731: div.LC_edit_problem_header,
1.602 albertel 5732: div.LC_edit_problem_header div,
1.614 albertel 5733: div.LC_edit_problem_footer,
5734: div.LC_edit_problem_footer div,
1.602 albertel 5735: div.LC_edit_problem_editxml_header,
5736: div.LC_edit_problem_editxml_header div {
1.600 albertel 5737: margin-top: 5px;
5738: }
1.795 www 5739:
1.602 albertel 5740: div.LC_edit_problem_header_edit_row {
5741: background: $tabbg;
5742: padding: 3px;
5743: margin-bottom: 5px;
5744: }
1.795 www 5745:
1.600 albertel 5746: div.LC_edit_problem_header_title {
1.705 tempelho 5747: font-weight: bold;
5748: font-size: larger;
1.602 albertel 5749: background: $tabbg;
5750: padding: 3px;
5751: }
1.795 www 5752:
1.602 albertel 5753: table.LC_edit_problem_header_title {
1.705 tempelho 5754: font-size: larger;
5755: font-weight: bold;
1.602 albertel 5756: width: 100%;
5757: border-color: $pgbg;
5758: border-style: solid;
5759: border-width: $border;
1.600 albertel 5760: background: $tabbg;
1.602 albertel 5761: border-collapse: collapse;
1.803 bisitz 5762: padding: 0;
1.602 albertel 5763: }
5764:
5765: div.LC_edit_problem_discards {
5766: float: left;
5767: padding-bottom: 5px;
5768: }
1.795 www 5769:
1.602 albertel 5770: div.LC_edit_problem_saves {
5771: float: right;
5772: padding-bottom: 5px;
1.600 albertel 5773: }
1.795 www 5774:
1.600 albertel 5775: hr.LC_edit_problem_divide {
1.602 albertel 5776: clear: both;
1.600 albertel 5777: color: $tabbg;
5778: background-color: $tabbg;
5779: height: 3px;
1.803 bisitz 5780: border: none;
1.600 albertel 5781: }
1.795 www 5782:
1.679 riegler 5783: img.stift{
1.803 bisitz 5784: border-width: 0;
5785: vertical-align: middle;
1.677 riegler 5786: }
1.680 riegler 5787:
1.681 riegler 5788: table#LC_mainmenu{
5789: margin-top:10px;
5790: width:80%;
5791: }
5792:
1.680 riegler 5793: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
5794: vertical-align: top;
5795: width: 45%;
5796: }
1.795 www 5797:
1.779 bisitz 5798: .LC_mainmenu_fieldset_category {
5799: color: $font;
5800: background: $pgbg;
5801: font-family: $sans;
5802: font-size: small;
5803: font-weight: bold;
1.777 tempelho 5804: }
1.795 www 5805:
1.716 raeburn 5806: div.LC_createcourse {
5807: margin: 10px 10px 10px 10px;
5808: }
5809:
1.693 droeschl 5810: /* ---- Remove when done ----
5811: # The following styles is part of the redesign of LON-CAPA and are
5812: # subject to change during this project.
5813: # Don't rely on their current functionality as they might be
5814: # changed or removed.
5815: # --------------------------*/
5816:
1.698 harmsja 5817: a:hover,
1.721 harmsja 5818: ol.LC_smallMenu a:hover,
5819: ol#LC_MenuBreadcrumbs a:hover,
5820: ol#LC_PathBreadcrumbs a:hover,
5821: ul#LC_TabMainMenuContent a:hover,
5822: .LC_FormSectionClearButton input:hover
1.795 www 5823: ul.LC_TabContent li:hover a {
1.698 harmsja 5824: color:#BF2317;
5825: text-decoration:none;
1.693 droeschl 5826: }
5827:
1.779 bisitz 5828: h1 {
1.721 harmsja 5829: padding:5px 10px 5px 20px;
1.693 droeschl 5830: line-height:130%;
5831: }
1.698 harmsja 5832:
1.795 www 5833: h2,h3,h4,h5,h6 {
1.803 bisitz 5834: margin: 5px 0 5px 0;
5835: padding: 0;
1.721 harmsja 5836: line-height:130%;
1.693 droeschl 5837: }
1.795 www 5838:
5839: .LC_hcell {
1.698 harmsja 5840: padding:3px 15px 3px 15px;
1.803 bisitz 5841: margin: 0;
1.703 harmsja 5842: background-color:$tabbg;
1.801 tempelho 5843: color:$fontmenu;
1.779 bisitz 5844: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5845: }
1.795 www 5846:
1.721 harmsja 5847: .LC_noBorder {
1.803 bisitz 5848: border: 0;
1.698 harmsja 5849: }
1.693 droeschl 5850:
5851:
1.698 harmsja 5852: /* Main Header with discription of Person, Course, etc. */
1.693 droeschl 5853:
1.761 tempelho 5854: .LC_Right {
5855: float: right;
1.803 bisitz 5856: margin: 0;
5857: padding: 0;
1.761 tempelho 5858: }
5859:
1.721 harmsja 5860: .LC_FormSectionClearButton input {
1.779 bisitz 5861: background-color:transparent;
1.803 bisitz 5862: border: none;
1.698 harmsja 5863: cursor:pointer;
5864: text-decoration:underline;
1.693 droeschl 5865: }
1.763 bisitz 5866:
5867: .LC_help_open_topic {
5868: color: #FFFFFF;
5869: background-color: #EEEEFF;
5870: margin: 1px;
5871: padding: 4px;
5872: border: 1px solid #000033;
5873: white-space: nowrap;
1.783 amueller 5874: /* vertical-align: middle; */
1.759 neumanie 5875: }
1.693 droeschl 5876:
1.698 harmsja 5877: dl,ul,div,fieldset {
1.803 bisitz 5878: margin: 10px 10px 10px 0;
1.693 droeschl 5879: overflow:hidden;
5880: }
1.795 www 5881:
1.721 harmsja 5882: ol.LC_smallMenu, ol#LC_PathBreadcrumbs {
1.803 bisitz 5883: margin: 0;
1.693 droeschl 5884: }
5885:
1.721 harmsja 5886: ol.LC_smallMenu li {
1.693 droeschl 5887: display: inline;
1.803 bisitz 5888: padding: 5px 5px 0 10px;
1.693 droeschl 5889: vertical-align: top;
5890: }
5891:
1.721 harmsja 5892: ol.LC_smallMenu li img {
1.693 droeschl 5893: vertical-align: bottom;
5894: }
5895:
1.721 harmsja 5896: ol.LC_smallMenu a {
1.693 droeschl 5897: font-size: 90%;
5898: color: RGB(80, 80, 80);
5899: text-decoration: none;
5900: }
1.795 www 5901:
5902: ol#LC_TabMainMenuContent,
5903: ul.LC_TabContent ,
1.741 harmsja 5904: ul.LC_TabContentBigger {
1.721 harmsja 5905: display:block;
5906: list-style:none;
1.803 bisitz 5907: margin: 0;
5908: padding: 0;
1.693 droeschl 5909: }
5910:
1.795 www 5911: ol#LC_TabMainMenuContent li,
5912: ul.LC_TabContent li,
5913: ul.LC_TabContentBigger li {
1.693 droeschl 5914: display: inline;
1.741 harmsja 5915: border-right: solid 1px $lg_border_color;
5916: float:left;
5917: line-height:140%;
5918: white-space:nowrap;
5919: }
1.795 www 5920:
5921: ol#LC_TabMainMenuContent li {
1.693 droeschl 5922: vertical-align: bottom;
5923: border-bottom: solid 1px RGB(175, 175, 175);
1.721 harmsja 5924: padding: 5px 10px 5px 10px;
1.741 harmsja 5925: margin-right:5px;
5926: margin-bottom:3px;
1.693 droeschl 5927: font-weight: bold;
1.723 riegler 5928: background: url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
1.693 droeschl 5929: }
5930:
1.795 www 5931: ol#LC_TabMainMenuContent li a {
1.693 droeschl 5932: color: RGB(47, 47, 47);
5933: text-decoration: none;
5934: }
1.795 www 5935:
1.721 harmsja 5936: ul.LC_TabContent {
1.741 harmsja 5937: min-height:1.6em;
1.721 harmsja 5938: }
1.795 www 5939:
5940: ul.LC_TabContent li {
1.741 harmsja 5941: vertical-align:middle;
1.803 bisitz 5942: padding: 0 10px 0 10px;
1.745 ehlerst 5943: background-color:$tabbg;
5944: border-bottom:solid 1px $lg_border_color;
1.721 harmsja 5945: }
1.795 www 5946:
5947: ul.LC_TabContent li a, ul.LC_TabContent li {
1.721 harmsja 5948: color:rgb(47,47,47);
5949: text-decoration:none;
5950: font-size:95%;
5951: font-weight:bold;
1.761 tempelho 5952: padding-right: 16px;
1.721 harmsja 5953: }
1.795 www 5954:
5955: ul.LC_TabContent li:hover, ul.LC_TabContent li.active {
1.761 tempelho 5956: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.745 ehlerst 5957: border-bottom:solid 1px #FFFFFF;
1.761 tempelho 5958: padding-right: 16px;
1.744 ehlerst 5959: }
1.795 www 5960:
5961: ul.LC_TabContentBigger li {
1.741 harmsja 5962: vertical-align:bottom;
5963: border-top:solid 1px $lg_border_color;
5964: border-left:solid 1px $lg_border_color;
5965: padding:5px 10px 5px 10px;
5966: margin-left:2px;
5967: background:url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
5968: }
1.795 www 5969:
5970: ul.LC_TabContentBigger li:hover,
5971: ul.LC_TabContentBigger li.active {
1.744 ehlerst 5972: background:url(/adm/lonIcons/lightGreyBG.png) repeat-x right bottom;
5973: }
1.795 www 5974:
5975: ul.LC_TabContentBigger li,
5976: ul.LC_TabContentBigger li a {
1.741 harmsja 5977: font-size:110%;
5978: font-weight:bold;
5979: }
1.693 droeschl 5980:
1.795 www 5981: ol#LC_MenuBreadcrumbs,
5982: ol#LC_PathBreadcrumbs,
5983: ul.LC_CourseBreadcrumbs {
1.693 droeschl 5984: border-top: solid 1px RGB(255, 255, 255);
5985: height: 20px;
5986: line-height: 20px;
5987: vertical-align: bottom;
1.803 bisitz 5988: margin: 0 0 30px 0;
1.693 droeschl 5989: padding-left: 10px;
5990: list-style-position: inside;
1.723 riegler 5991: background: url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
1.693 droeschl 5992: }
5993:
1.795 www 5994: ol#LC_MenuBreadcrumbs li,
5995: ol#LC_PathBreadcrumbs li,
5996: ul.LC_CourseBreadcrumbs li {
1.741 harmsja 5997: /*
1.723 riegler 5998: background: url(/adm/lonIcons/arrow_white.png) no-repeat left center;
1.779 bisitz 5999: */
1.693 droeschl 6000: display: inline;
1.803 bisitz 6001: padding: 0 0 0 10px;
1.783 amueller 6002: /* vertical-align: bottom; */
1.693 droeschl 6003: overflow:hidden;
6004: }
6005:
1.783 amueller 6006: ol#LC_MenuBreadcrumbs li a, ul.LC_CourseBreadcrumbs li a {
1.693 droeschl 6007: text-decoration: none;
6008: font-size:90%;
6009: }
1.795 www 6010:
6011: ol#LC_PathBreadcrumbs li a {
1.698 harmsja 6012: text-decoration:none;
6013: font-size:100%;
6014: font-weight:bold;
1.693 droeschl 6015: }
1.795 www 6016:
6017: .LC_BoxPadding {
1.786 neumanie 6018: padding: 10px;
6019: }
1.795 www 6020:
6021: .LC_ContentBoxSpecial {
1.701 harmsja 6022: border: solid 1px $lg_border_color;
1.746 neumanie 6023: }
1.795 www 6024:
6025: .LC_ContentBoxSpecialContactInfo {
1.746 neumanie 6026: border: solid 1px $lg_border_color;
6027: max-width:25%;
6028: min-width:25%;
1.698 harmsja 6029: }
1.795 www 6030:
6031: .LC_AboutMe_Image {
1.747 neumanie 6032: float:left;
6033: margin-right:10px;
6034: }
1.795 www 6035:
6036: .LC_Clear_AboutMe_Image {
1.747 neumanie 6037: clear:left;
6038: }
1.795 www 6039:
1.721 harmsja 6040: dl.LC_ListStyleClean dt {
1.693 droeschl 6041: padding-right: 5px;
6042: display: table-header-group;
6043: }
6044:
1.721 harmsja 6045: dl.LC_ListStyleClean dd {
1.693 droeschl 6046: display: table-row;
6047: }
6048:
1.721 harmsja 6049: .LC_ListStyleClean,
6050: .LC_ListStyleSimple,
6051: .LC_ListStyleNormal,
1.777 tempelho 6052: .LC_ListStyle_Border,
1.795 www 6053: .LC_ListStyleSpecial {
1.693 droeschl 6054: /*display:block; */
6055: list-style-position: inside;
6056: list-style-type: none;
6057: overflow: hidden;
1.803 bisitz 6058: padding: 0;
1.693 droeschl 6059: }
6060:
1.721 harmsja 6061: .LC_ListStyleSimple li,
6062: .LC_ListStyleSimple dd,
6063: .LC_ListStyleNormal li,
6064: .LC_ListStyleNormal dd,
6065: .LC_ListStyleSpecial li,
1.795 www 6066: .LC_ListStyleSpecial dd {
1.803 bisitz 6067: margin: 0;
1.693 droeschl 6068: padding: 5px 5px 5px 10px;
6069: clear: both;
6070: }
6071:
1.721 harmsja 6072: .LC_ListStyleClean li,
6073: .LC_ListStyleClean dd {
1.803 bisitz 6074: padding-top: 0;
6075: padding-bottom: 0;
1.693 droeschl 6076: }
6077:
1.721 harmsja 6078: .LC_ListStyleSimple dd,
1.795 www 6079: .LC_ListStyleSimple li {
1.698 harmsja 6080: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6081: }
6082:
1.721 harmsja 6083: .LC_ListStyleSpecial li,
6084: .LC_ListStyleSpecial dd {
1.693 droeschl 6085: list-style-type: none;
6086: background-color: RGB(220, 220, 220);
6087: margin-bottom: 4px;
6088: }
6089:
1.721 harmsja 6090: table.LC_SimpleTable {
1.698 harmsja 6091: margin:5px;
6092: border:solid 1px $lg_border_color;
1.795 www 6093: }
1.693 droeschl 6094:
1.721 harmsja 6095: table.LC_SimpleTable tr {
1.803 bisitz 6096: padding: 0;
1.698 harmsja 6097: border:solid 1px $lg_border_color;
1.693 droeschl 6098: }
1.795 www 6099:
6100: table.LC_SimpleTable thead {
1.698 harmsja 6101: background:rgb(220,220,220);
1.693 droeschl 6102: }
6103:
1.721 harmsja 6104: div.LC_columnSection {
1.693 droeschl 6105: display: block;
6106: clear: both;
6107: overflow: hidden;
1.803 bisitz 6108: margin: 0;
1.693 droeschl 6109: }
6110:
1.721 harmsja 6111: div.LC_columnSection>* {
1.693 droeschl 6112: float: left;
1.803 bisitz 6113: margin: 10px 20px 10px 0;
1.747 neumanie 6114: overflow:hidden;
1.693 droeschl 6115: }
1.721 harmsja 6116:
1.795 www 6117: .ContentBoxSpecialTemplate {
1.747 neumanie 6118: border: solid 1px $lg_border_color;
1.719 ehlerst 6119: }
1.795 www 6120:
1.719 ehlerst 6121: .ContentBoxTemplate {
6122: padding:10px;
6123: }
6124:
1.721 harmsja 6125: div.LC_columnSection > .ContentBoxTemplate,
1.795 www 6126: div.LC_columnSection > .ContentBoxSpecialTemplate {
1.719 ehlerst 6127: width: 600px;
6128: }
1.753 droeschl 6129:
1.795 www 6130: .clear {
1.720 ehlerst 6131: clear: both;
1.803 bisitz 6132: line-height: 0;
6133: font-size: 0;
6134: height: 0;
1.720 ehlerst 6135: }
1.693 droeschl 6136:
1.694 tempelho 6137: .LC_loginpage_container {
6138: text-align:left;
6139: margin : 0 auto;
1.785 tempelho 6140: width:90%;
1.694 tempelho 6141: padding: 10px;
6142: height: auto;
1.712 muellerd 6143: background-color:#FFFFFF;
1.694 tempelho 6144: border:1px solid #CCCCCC;
6145: }
6146:
6147:
6148: .LC_loginpage_loginContainer {
6149: float:left;
1.712 muellerd 6150: width: 182px;
1.785 tempelho 6151: padding: 2px;
1.712 muellerd 6152: border:1px solid #CCCCCC;
6153: background-color:$loginbg;
1.694 tempelho 6154: }
6155:
1.795 www 6156: .LC_loginpage_loginContainer h2 {
1.803 bisitz 6157: margin-top: 0;
1.712 muellerd 6158: display:block;
6159: background:$bgcol;
6160: color:$textcol;
6161: padding-left:5px;
6162: }
1.785 tempelho 6163:
1.694 tempelho 6164: .LC_loginpage_loginInfo {
6165: float:left;
1.785 tempelho 6166: width:182px;
1.694 tempelho 6167: border:1px solid #CCCCCC;
1.785 tempelho 6168: padding:2px;
1.712 muellerd 6169: }
6170:
1.694 tempelho 6171: .LC_loginpage_space {
1.754 droeschl 6172: clear: both;
6173: margin-bottom: 20px;
1.694 tempelho 6174: border-bottom: 1px solid #CCCCCC;
6175: }
6176:
1.785 tempelho 6177: .LC_loginpage_floatLeft {
6178: float: left;
6179: width: 200px;
6180: margin: 0;
6181: }
6182:
1.795 www 6183: table em {
1.754 droeschl 6184: font-weight: bold;
6185: font-style: normal;
1.748 schulted 6186: }
1.795 www 6187:
1.779 bisitz 6188: table.LC_tableBrowseRes,
1.795 www 6189: table.LC_tableOfContent {
1.769 schulted 6190: border:none;
6191: border-spacing: 1;
1.754 droeschl 6192: padding: 3px;
6193: background-color: #FFFFFF;
6194: font-size: 90%;
1.753 droeschl 6195: }
1.789 droeschl 6196:
6197: table.LC_tableOfContent{
6198: border-collapse: collapse;
6199: }
6200:
1.771 droeschl 6201: table.LC_tableBrowseRes a,
1.768 schulted 6202: table.LC_tableOfContent a {
1.771 droeschl 6203: background-color: transparent;
1.753 droeschl 6204: text-decoration: none;
6205: }
6206:
1.771 droeschl 6207: table.LC_tableBrowseRes tr.LC_trOdd,
1.768 schulted 6208: table.LC_tableOfContent tr.LC_trOdd{
1.754 droeschl 6209: background-color: #EEEEEE;
1.753 droeschl 6210: }
6211:
1.795 www 6212: table.LC_tableOfContent img {
1.753 droeschl 6213: border: none;
6214: height: 1.3em;
6215: vertical-align: text-bottom;
6216: margin-right: 0.3em;
6217: }
1.757 schulted 6218:
1.795 www 6219: a#LC_content_toolbar_firsthomework {
1.774 ehlerst 6220: background-image:url(/res/adm/pages/open-first-problem.gif);
6221: }
6222:
1.795 www 6223: a#LC_content_toolbar_launchnav {
1.774 ehlerst 6224: background-image:url(/res/adm/pages/start-navigation.gif);
6225: }
6226:
1.795 www 6227: a#LC_content_toolbar_closenav {
1.774 ehlerst 6228: background-image:url(/res/adm/pages/close-navigation.gif);
6229: }
6230:
1.795 www 6231: a#LC_content_toolbar_everything {
1.774 ehlerst 6232: background-image:url(/res/adm/pages/show-all.gif);
6233: }
6234:
1.795 www 6235: a#LC_content_toolbar_uncompleted {
1.774 ehlerst 6236: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
6237: }
6238:
1.795 www 6239: #LC_content_toolbar_clearbubbles {
1.774 ehlerst 6240: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
6241: }
6242:
1.795 www 6243: a#LC_content_toolbar_changefolder {
1.757 schulted 6244: background : url(/res/adm/pages/close-all-folders.gif) top center ;
6245: }
6246:
1.795 www 6247: a#LC_content_toolbar_changefolder_toggled {
1.757 schulted 6248: background-image:url(/res/adm/pages/open-all-folders.gif);
6249: }
6250:
1.795 www 6251: ul#LC_toolbar li a:hover {
1.757 schulted 6252: background-position: bottom center;
6253: }
6254:
1.795 www 6255: ul#LC_toolbar {
1.803 bisitz 6256: padding: 0;
1.757 schulted 6257: margin: 2px;
6258: list-style:none;
6259: position:relative;
6260: background-color:white;
6261: }
6262:
1.795 www 6263: ul#LC_toolbar li {
1.757 schulted 6264: border:1px solid white;
1.803 bisitz 6265: padding: 0;
1.757 schulted 6266: margin: 0;
1.795 www 6267: float: left;
1.767 droeschl 6268: display:inline;
1.757 schulted 6269: vertical-align:middle;
1.795 www 6270: }
1.757 schulted 6271:
1.783 amueller 6272:
1.795 www 6273: a.LC_toolbarItem {
1.767 droeschl 6274: display:block;
1.803 bisitz 6275: padding: 0;
6276: margin: 0;
1.757 schulted 6277: height: 32px;
6278: width: 32px;
1.779 bisitz 6279: color:white;
1.803 bisitz 6280: border: none;
1.757 schulted 6281: background-repeat:no-repeat;
6282: background-color:transparent;
6283: }
6284:
1.782 bisitz 6285: ul.LC_functionslist li {
6286: float: left;
6287: white-space: nowrap;
6288: height: 35px; /* at least as high as heighest list item */
1.803 bisitz 6289: margin: 0 15px 15px 10px;
1.782 bisitz 6290: }
6291:
1.757 schulted 6292:
1.343 albertel 6293: END
6294: }
6295:
1.306 albertel 6296: =pod
6297:
6298: =item * &headtag()
6299:
6300: Returns a uniform footer for LON-CAPA web pages.
6301:
1.307 albertel 6302: Inputs: $title - optional title for the head
6303: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6304: $args - optional arguments
1.319 albertel 6305: force_register - if is true call registerurl so the remote is
6306: informed
1.415 albertel 6307: redirect -> array ref of
6308: 1- seconds before redirect occurs
6309: 2- url to redirect to
6310: 3- whether the side effect should occur
1.315 albertel 6311: (side effect of setting
6312: $env{'internal.head.redirect'} to the url
6313: redirected too)
1.352 albertel 6314: domain -> force to color decorate a page for a specific
6315: domain
6316: function -> force usage of a specific rolish color scheme
6317: bgcolor -> override the default page bgcolor
1.460 albertel 6318: no_auto_mt_title
6319: -> prevent &mt()ing the title arg
1.464 albertel 6320:
1.306 albertel 6321: =cut
6322:
6323: sub headtag {
1.313 albertel 6324: my ($title,$head_extra,$args) = @_;
1.306 albertel 6325:
1.363 albertel 6326: my $function = $args->{'function'} || &get_users_function();
6327: my $domain = $args->{'domain'} || &determinedomain();
6328: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6329: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6330: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6331: #time(),
1.418 albertel 6332: $env{'environment.color.timestamp'},
1.363 albertel 6333: $function,$domain,$bgcolor);
6334:
1.369 www 6335: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6336:
1.308 albertel 6337: my $result =
6338: '<head>'.
1.461 albertel 6339: &font_settings();
1.319 albertel 6340:
1.461 albertel 6341: if (!$args->{'frameset'}) {
6342: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6343: }
1.319 albertel 6344: if ($args->{'force_register'}) {
6345: $result .= &Apache::lonmenu::registerurl(1);
6346: }
1.436 albertel 6347: if (!$args->{'no_nav_bar'}
6348: && !$args->{'only_body'}
6349: && !$args->{'frameset'}) {
6350: $result .= &help_menu_js();
6351: }
1.319 albertel 6352:
1.314 albertel 6353: if (ref($args->{'redirect'})) {
1.414 albertel 6354: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6355: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6356: if (!$inhibit_continue) {
6357: $env{'internal.head.redirect'} = $url;
6358: }
1.313 albertel 6359: $result.=<<ADDMETA
6360: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6361: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6362: ADDMETA
6363: }
1.306 albertel 6364: if (!defined($title)) {
6365: $title = 'The LearningOnline Network with CAPA';
6366: }
1.460 albertel 6367: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6368: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6369: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6370: .$head_extra;
1.306 albertel 6371: return $result;
6372: }
6373:
6374: =pod
6375:
1.340 albertel 6376: =item * &font_settings()
6377:
6378: Returns neccessary <meta> to set the proper encoding
6379:
6380: Inputs: none
6381:
6382: =cut
6383:
6384: sub font_settings {
6385: my $headerstring='';
1.647 www 6386: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6387: $headerstring.=
6388: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6389: }
6390: return $headerstring;
6391: }
6392:
1.341 albertel 6393: =pod
6394:
6395: =item * &xml_begin()
6396:
6397: Returns the needed doctype and <html>
6398:
6399: Inputs: none
6400:
6401: =cut
6402:
6403: sub xml_begin {
6404: my $output='';
6405:
1.592 albertel 6406: if ($env{'internal.start_page'}==1) {
6407: &Apache::lonhtmlcommon::init_htmlareafields();
6408: }
1.342 albertel 6409:
1.341 albertel 6410: if ($env{'browser.mathml'}) {
6411: $output='<?xml version="1.0"?>'
6412: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6413: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6414:
6415: # .'<!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">] >'
6416: .'<!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">'
6417: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6418: .'xmlns="http://www.w3.org/1999/xhtml">';
6419: } else {
6420: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
6421: }
6422: return $output;
6423: }
1.340 albertel 6424:
6425: =pod
6426:
1.306 albertel 6427: =item * &endheadtag()
6428:
6429: Returns a uniform </head> for LON-CAPA web pages.
6430:
6431: Inputs: none
6432:
6433: =cut
6434:
6435: sub endheadtag {
6436: return '</head>';
6437: }
6438:
6439: =pod
6440:
6441: =item * &head()
6442:
6443: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6444:
1.648 raeburn 6445: Inputs:
6446:
6447: =over 4
6448:
6449: $title - optional title for the page
6450:
6451: $head_extra - optional extra HTML to put inside the <head>
6452:
6453: =back
1.405 albertel 6454:
1.306 albertel 6455: =cut
6456:
6457: sub head {
1.325 albertel 6458: my ($title,$head_extra,$args) = @_;
6459: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6460: }
6461:
6462: =pod
6463:
6464: =item * &start_page()
6465:
6466: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6467:
1.648 raeburn 6468: Inputs:
6469:
6470: =over 4
6471:
6472: $title - optional title for the page
6473:
6474: $head_extra - optional extra HTML to incude inside the <head>
6475:
6476: $args - additional optional args supported are:
6477:
6478: =over 8
6479:
6480: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6481: arg on
1.648 raeburn 6482: no_nav_bar -> is true will set &bodytag() notopbar arg on
6483: add_entries -> additional attributes to add to the <body>
6484: domain -> force to color decorate a page for a
1.317 albertel 6485: specific domain
1.648 raeburn 6486: function -> force usage of a specific rolish color
1.317 albertel 6487: scheme
1.648 raeburn 6488: redirect -> see &headtag()
6489: bgcolor -> override the default page bg color
6490: js_ready -> return a string ready for being used in
1.317 albertel 6491: a javascript writeln
1.648 raeburn 6492: html_encode -> return a string ready for being used in
1.320 albertel 6493: a html attribute
1.648 raeburn 6494: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6495: $forcereg arg
1.648 raeburn 6496: body_title -> alternate text to use instead of $title
1.326 albertel 6497: in the title box that appears, this text
6498: is not auto translated like the $title is
1.648 raeburn 6499: frameset -> if true will start with a <frameset>
1.330 albertel 6500: rather than <body>
1.648 raeburn 6501: no_title -> if true the title bar won't be shown
6502: skip_phases -> hash ref of
1.338 albertel 6503: head -> skip the <html><head> generation
6504: body -> skip all <body> generation
1.648 raeburn 6505: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6506: 'Switch To Inline Menu' link
1.648 raeburn 6507: no_auto_mt_title -> prevent &mt()ing the title arg
6508: inherit_jsmath -> when creating popup window in a page,
6509: should it have jsmath forced on by the
6510: current page
1.361 albertel 6511:
1.648 raeburn 6512: =back
1.460 albertel 6513:
1.648 raeburn 6514: =back
1.562 albertel 6515:
1.306 albertel 6516: =cut
6517:
6518: sub start_page {
1.309 albertel 6519: my ($title,$head_extra,$args) = @_;
1.318 albertel 6520: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6521: my %head_args;
1.352 albertel 6522: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6523: 'bgcolor','frameset','no_nav_bar','only_body',
6524: 'no_auto_mt_title') {
1.319 albertel 6525: if (defined($args->{$arg})) {
1.324 raeburn 6526: $head_args{$arg} = $args->{$arg};
1.319 albertel 6527: }
1.313 albertel 6528: }
1.319 albertel 6529:
1.315 albertel 6530: $env{'internal.start_page'}++;
1.338 albertel 6531: my $result;
6532: if (! exists($args->{'skip_phases'}{'head'}) ) {
6533: $result.=
1.341 albertel 6534: &xml_begin().
1.338 albertel 6535: &headtag($title,$head_extra,\%head_args).&endheadtag();
6536: }
6537:
6538: if (! exists($args->{'skip_phases'}{'body'}) ) {
6539: if ($args->{'frameset'}) {
6540: my $attr_string = &make_attr_string($args->{'force_register'},
6541: $args->{'add_entries'});
6542: $result .= "\n<frameset $attr_string>\n";
6543: } else {
6544: $result .=
6545: &bodytag($title,
6546: $args->{'function'}, $args->{'add_entries'},
6547: $args->{'only_body'}, $args->{'domain'},
6548: $args->{'force_register'}, $args->{'body_title'},
6549: $args->{'no_nav_bar'}, $args->{'bgcolor'},
1.460 albertel 6550: $args->{'no_title'}, $args->{'no_inline_link'},
6551: $args);
1.338 albertel 6552: }
1.330 albertel 6553: }
1.338 albertel 6554:
1.315 albertel 6555: if ($args->{'js_ready'}) {
1.713 kaisler 6556: $result = &js_ready($result);
1.315 albertel 6557: }
1.320 albertel 6558: if ($args->{'html_encode'}) {
1.713 kaisler 6559: $result = &html_encode($result);
6560: }
6561:
1.758 kaisler 6562: #Breadcrumbs
6563: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6564: &Apache::lonhtmlcommon::clear_breadcrumbs();
6565: #if any br links exists, add them to the breadcrumbs
6566: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6567: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6568: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6569: }
6570: }
6571:
6572: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6573: if(exists($args->{'bread_crumbs_component'})){
6574: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6575: }else{
6576: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6577: }
1.320 albertel 6578: }
1.315 albertel 6579: return $result;
1.306 albertel 6580: }
6581:
1.330 albertel 6582:
1.306 albertel 6583: =pod
6584:
6585: =item * &head()
6586:
6587: Returns a complete </body></html> section for LON-CAPA web pages.
6588:
1.315 albertel 6589: Inputs: $args - additional optional args supported are:
6590: js_ready -> return a string ready for being used in
6591: a javascript writeln
1.320 albertel 6592: html_encode -> return a string ready for being used in
6593: a html attribute
1.330 albertel 6594: frameset -> if true will start with a <frameset>
6595: rather than <body>
1.493 albertel 6596: dicsussion -> if true will get discussion from
6597: lonxml::xmlend
6598: (you can pass the target and parser arguments
6599: through optional 'target' and 'parser' args
6600: to this routine)
1.306 albertel 6601:
6602: =cut
6603:
6604: sub end_page {
1.315 albertel 6605: my ($args) = @_;
6606: $env{'internal.end_page'}++;
1.330 albertel 6607: my $result;
1.335 albertel 6608: if ($args->{'discussion'}) {
6609: my ($target,$parser);
6610: if (ref($args->{'discussion'})) {
6611: ($target,$parser) =($args->{'discussion'}{'target'},
6612: $args->{'discussion'}{'parser'});
6613: }
6614: $result .= &Apache::lonxml::xmlend($target,$parser);
6615: }
6616:
1.330 albertel 6617: if ($args->{'frameset'}) {
6618: $result .= '</frameset>';
6619: } else {
1.635 raeburn 6620: $result .= &endbodytag($args);
1.330 albertel 6621: }
6622: $result .= "\n</html>";
6623:
1.315 albertel 6624: if ($args->{'js_ready'}) {
1.317 albertel 6625: $result = &js_ready($result);
1.315 albertel 6626: }
1.335 albertel 6627:
1.320 albertel 6628: if ($args->{'html_encode'}) {
6629: $result = &html_encode($result);
6630: }
1.335 albertel 6631:
1.315 albertel 6632: return $result;
6633: }
6634:
1.320 albertel 6635: sub html_encode {
6636: my ($result) = @_;
6637:
1.322 albertel 6638: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6639:
6640: return $result;
6641: }
1.317 albertel 6642: sub js_ready {
6643: my ($result) = @_;
6644:
1.323 albertel 6645: $result =~ s/[\n\r]/ /xmsg;
6646: $result =~ s/\\/\\\\/xmsg;
6647: $result =~ s/'/\\'/xmsg;
1.372 albertel 6648: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6649:
6650: return $result;
6651: }
6652:
1.315 albertel 6653: sub validate_page {
6654: if ( exists($env{'internal.start_page'})
1.316 albertel 6655: && $env{'internal.start_page'} > 1) {
6656: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6657: $env{'internal.start_page'}.' '.
1.316 albertel 6658: $ENV{'request.filename'});
1.315 albertel 6659: }
6660: if ( exists($env{'internal.end_page'})
1.316 albertel 6661: && $env{'internal.end_page'} > 1) {
6662: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6663: $env{'internal.end_page'}.' '.
1.316 albertel 6664: $env{'request.filename'});
1.315 albertel 6665: }
6666: if ( exists($env{'internal.start_page'})
6667: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6668: &Apache::lonnet::logthis('start_page called without end_page '.
6669: $env{'request.filename'});
1.315 albertel 6670: }
6671: if ( ! exists($env{'internal.start_page'})
6672: && exists($env{'internal.end_page'})) {
1.316 albertel 6673: &Apache::lonnet::logthis('end_page called without start_page'.
6674: $env{'request.filename'});
1.315 albertel 6675: }
1.306 albertel 6676: }
1.315 albertel 6677:
1.318 albertel 6678: sub simple_error_page {
6679: my ($r,$title,$msg) = @_;
6680: my $page =
6681: &Apache::loncommon::start_page($title).
6682: &mt($msg).
6683: &Apache::loncommon::end_page();
6684: if (ref($r)) {
6685: $r->print($page);
1.327 albertel 6686: return;
1.318 albertel 6687: }
6688: return $page;
6689: }
1.347 albertel 6690:
6691: {
1.610 albertel 6692: my @row_count;
1.347 albertel 6693: sub start_data_table {
1.422 albertel 6694: my ($add_class) = @_;
6695: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6696: unshift(@row_count,0);
1.422 albertel 6697: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6698: }
6699:
6700: sub end_data_table {
1.610 albertel 6701: shift(@row_count);
1.389 albertel 6702: return '</table>'."\n";;
1.347 albertel 6703: }
6704:
6705: sub start_data_table_row {
1.422 albertel 6706: my ($add_class) = @_;
1.610 albertel 6707: $row_count[0]++;
6708: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428 albertel 6709: $css_class = (join(' ',$css_class,$add_class));
1.422 albertel 6710: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6711: }
1.471 banghart 6712:
6713: sub continue_data_table_row {
6714: my ($add_class) = @_;
1.610 albertel 6715: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471 banghart 6716: $css_class = (join(' ',$css_class,$add_class));
6717: return '<tr class="'.$css_class.'">'."\n";;
6718: }
1.347 albertel 6719:
6720: sub end_data_table_row {
1.389 albertel 6721: return '</tr>'."\n";;
1.347 albertel 6722: }
1.367 www 6723:
1.421 albertel 6724: sub start_data_table_empty_row {
1.707 bisitz 6725: # $row_count[0]++;
1.421 albertel 6726: return '<tr class="LC_empty_row" >'."\n";;
6727: }
6728:
6729: sub end_data_table_empty_row {
6730: return '</tr>'."\n";;
6731: }
6732:
1.367 www 6733: sub start_data_table_header_row {
1.389 albertel 6734: return '<tr class="LC_header_row">'."\n";;
1.367 www 6735: }
6736:
6737: sub end_data_table_header_row {
1.389 albertel 6738: return '</tr>'."\n";;
1.367 www 6739: }
1.347 albertel 6740: }
6741:
1.548 albertel 6742: =pod
6743:
6744: =item * &inhibit_menu_check($arg)
6745:
6746: Checks for a inhibitmenu state and generates output to preserve it
6747:
6748: Inputs: $arg - can be any of
6749: - undef - in which case the return value is a string
6750: to add into arguments list of a uri
6751: - 'input' - in which case the return value is a HTML
6752: <form> <input> field of type hidden to
6753: preserve the value
6754: - a url - in which case the return value is the url with
6755: the neccesary cgi args added to preserve the
6756: inhibitmenu state
6757: - a ref to a url - no return value, but the string is
6758: updated to include the neccessary cgi
6759: args to preserve the inhibitmenu state
6760:
6761: =cut
6762:
6763: sub inhibit_menu_check {
6764: my ($arg) = @_;
6765: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6766: if ($arg eq 'input') {
6767: if ($env{'form.inhibitmenu'}) {
6768: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6769: } else {
6770: return
6771: }
6772: }
6773: if ($env{'form.inhibitmenu'}) {
6774: if (ref($arg)) {
6775: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6776: } elsif ($arg eq '') {
6777: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6778: } else {
6779: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6780: }
6781: }
6782: if (!ref($arg)) {
6783: return $arg;
6784: }
6785: }
6786:
1.251 albertel 6787: ###############################################
1.182 matthew 6788:
6789: =pod
6790:
1.549 albertel 6791: =back
6792:
6793: =head1 User Information Routines
6794:
6795: =over 4
6796:
1.405 albertel 6797: =item * &get_users_function()
1.182 matthew 6798:
6799: Used by &bodytag to determine the current users primary role.
6800: Returns either 'student','coordinator','admin', or 'author'.
6801:
6802: =cut
6803:
6804: ###############################################
6805: sub get_users_function {
6806: my $function = 'student';
1.258 albertel 6807: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182 matthew 6808: $function='coordinator';
6809: }
1.258 albertel 6810: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 6811: $function='admin';
6812: }
1.258 albertel 6813: if (($env{'request.role'}=~/^(au|ca)/) ||
1.182 matthew 6814: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
6815: $function='author';
6816: }
6817: return $function;
1.54 www 6818: }
1.99 www 6819:
6820: ###############################################
6821:
1.233 raeburn 6822: =pod
6823:
1.542 raeburn 6824: =item * &check_user_status()
1.274 raeburn 6825:
6826: Determines current status of supplied role for a
6827: specific user. Roles can be active, previous or future.
6828:
6829: Inputs:
6830: user's domain, user's username, course's domain,
1.375 raeburn 6831: course's number, optional section ID.
1.274 raeburn 6832:
6833: Outputs:
6834: role status: active, previous or future.
6835:
6836: =cut
6837:
6838: sub check_user_status {
1.412 raeburn 6839: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 6840: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
6841: my @uroles = keys %userinfo;
6842: my $srchstr;
6843: my $active_chk = 'none';
1.412 raeburn 6844: my $now = time;
1.274 raeburn 6845: if (@uroles > 0) {
1.412 raeburn 6846: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 6847: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
6848: } else {
1.412 raeburn 6849: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
6850: }
6851: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 6852: my $role_end = 0;
6853: my $role_start = 0;
6854: $active_chk = 'active';
1.412 raeburn 6855: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
6856: $role_end = $1;
6857: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
6858: $role_start = $1;
1.274 raeburn 6859: }
6860: }
6861: if ($role_start > 0) {
1.412 raeburn 6862: if ($now < $role_start) {
1.274 raeburn 6863: $active_chk = 'future';
6864: }
6865: }
6866: if ($role_end > 0) {
1.412 raeburn 6867: if ($now > $role_end) {
1.274 raeburn 6868: $active_chk = 'previous';
6869: }
6870: }
6871: }
6872: }
6873: return $active_chk;
6874: }
6875:
6876: ###############################################
6877:
6878: =pod
6879:
1.405 albertel 6880: =item * &get_sections()
1.233 raeburn 6881:
6882: Determines all the sections for a course including
6883: sections with students and sections containing other roles.
1.419 raeburn 6884: Incoming parameters:
6885:
6886: 1. domain
6887: 2. course number
6888: 3. reference to array containing roles for which sections should
6889: be gathered (optional).
6890: 4. reference to array containing status types for which sections
6891: should be gathered (optional).
6892:
6893: If the third argument is undefined, sections are gathered for any role.
6894: If the fourth argument is undefined, sections are gathered for any status.
6895: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 6896:
1.374 raeburn 6897: Returns section hash (keys are section IDs, values are
6898: number of users in each section), subject to the
1.419 raeburn 6899: optional roles filter, optional status filter
1.233 raeburn 6900:
6901: =cut
6902:
6903: ###############################################
6904: sub get_sections {
1.419 raeburn 6905: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 6906: if (!defined($cdom) || !defined($cnum)) {
6907: my $cid = $env{'request.course.id'};
6908:
6909: return if (!defined($cid));
6910:
6911: $cdom = $env{'course.'.$cid.'.domain'};
6912: $cnum = $env{'course.'.$cid.'.num'};
6913: }
6914:
6915: my %sectioncount;
1.419 raeburn 6916: my $now = time;
1.240 albertel 6917:
1.366 albertel 6918: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 6919: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 6920: my $sec_index = &Apache::loncoursedata::CL_SECTION();
6921: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 6922: my $start_index = &Apache::loncoursedata::CL_START();
6923: my $end_index = &Apache::loncoursedata::CL_END();
6924: my $status;
1.366 albertel 6925: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 6926: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
6927: $data->[$status_index],
6928: $data->[$start_index],
6929: $data->[$end_index]);
6930: if ($stu_status eq 'Active') {
6931: $status = 'active';
6932: } elsif ($end < $now) {
6933: $status = 'previous';
6934: } elsif ($start > $now) {
6935: $status = 'future';
6936: }
6937: if ($section ne '-1' && $section !~ /^\s*$/) {
6938: if ((!defined($possible_status)) || (($status ne '') &&
6939: (grep/^\Q$status\E$/,@{$possible_status}))) {
6940: $sectioncount{$section}++;
6941: }
1.240 albertel 6942: }
6943: }
6944: }
6945: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6946: foreach my $user (sort(keys(%courseroles))) {
6947: if ($user !~ /^(\w{2})/) { next; }
6948: my ($role) = ($user =~ /^(\w{2})/);
6949: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 6950: my ($section,$status);
1.240 albertel 6951: if ($role eq 'cr' &&
6952: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
6953: $section=$1;
6954: }
6955: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
6956: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 6957: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
6958: if ($end == -1 && $start == -1) {
6959: next; #deleted role
6960: }
6961: if (!defined($possible_status)) {
6962: $sectioncount{$section}++;
6963: } else {
6964: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
6965: $status = 'active';
6966: } elsif ($end < $now) {
6967: $status = 'future';
6968: } elsif ($start > $now) {
6969: $status = 'previous';
6970: }
6971: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
6972: $sectioncount{$section}++;
6973: }
6974: }
1.233 raeburn 6975: }
1.366 albertel 6976: return %sectioncount;
1.233 raeburn 6977: }
6978:
1.274 raeburn 6979: ###############################################
1.294 raeburn 6980:
6981: =pod
1.405 albertel 6982:
6983: =item * &get_course_users()
6984:
1.275 raeburn 6985: Retrieves usernames:domains for users in the specified course
6986: with specific role(s), and access status.
6987:
6988: Incoming parameters:
1.277 albertel 6989: 1. course domain
6990: 2. course number
6991: 3. access status: users must have - either active,
1.275 raeburn 6992: previous, future, or all.
1.277 albertel 6993: 4. reference to array of permissible roles
1.288 raeburn 6994: 5. reference to array of section restrictions (optional)
6995: 6. reference to results object (hash of hashes).
6996: 7. reference to optional userdata hash
1.609 raeburn 6997: 8. reference to optional statushash
1.630 raeburn 6998: 9. flag if privileged users (except those set to unhide in
6999: course settings) should be excluded
1.609 raeburn 7000: Keys of top level results hash are roles.
1.275 raeburn 7001: Keys of inner hashes are username:domain, with
7002: values set to access type.
1.288 raeburn 7003: Optional userdata hash returns an array with arguments in the
7004: same order as loncoursedata::get_classlist() for student data.
7005:
1.609 raeburn 7006: Optional statushash returns
7007:
1.288 raeburn 7008: Entries for end, start, section and status are blank because
7009: of the possibility of multiple values for non-student roles.
7010:
1.275 raeburn 7011: =cut
1.405 albertel 7012:
1.275 raeburn 7013: ###############################################
1.405 albertel 7014:
1.275 raeburn 7015: sub get_course_users {
1.630 raeburn 7016: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7017: my %idx = ();
1.419 raeburn 7018: my %seclists;
1.288 raeburn 7019:
7020: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7021: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7022: $idx{end} = &Apache::loncoursedata::CL_END();
7023: $idx{start} = &Apache::loncoursedata::CL_START();
7024: $idx{id} = &Apache::loncoursedata::CL_ID();
7025: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7026: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7027: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7028:
1.290 albertel 7029: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7030: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7031: my $now = time;
1.277 albertel 7032: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7033: my $match = 0;
1.412 raeburn 7034: my $secmatch = 0;
1.419 raeburn 7035: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7036: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7037: if ($section eq '') {
7038: $section = 'none';
7039: }
1.291 albertel 7040: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7041: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7042: $secmatch = 1;
7043: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7044: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7045: $secmatch = 1;
7046: }
7047: } else {
1.419 raeburn 7048: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7049: $secmatch = 1;
7050: }
1.290 albertel 7051: }
1.412 raeburn 7052: if (!$secmatch) {
7053: next;
7054: }
1.419 raeburn 7055: }
1.275 raeburn 7056: if (defined($$types{'active'})) {
1.288 raeburn 7057: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7058: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7059: $match = 1;
1.275 raeburn 7060: }
7061: }
7062: if (defined($$types{'previous'})) {
1.609 raeburn 7063: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7064: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7065: $match = 1;
1.275 raeburn 7066: }
7067: }
7068: if (defined($$types{'future'})) {
1.609 raeburn 7069: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7070: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7071: $match = 1;
1.275 raeburn 7072: }
7073: }
1.609 raeburn 7074: if ($match) {
7075: push(@{$seclists{$student}},$section);
7076: if (ref($userdata) eq 'HASH') {
7077: $$userdata{$student} = $$classlist{$student};
7078: }
7079: if (ref($statushash) eq 'HASH') {
7080: $statushash->{$student}{'st'}{$section} = $status;
7081: }
1.288 raeburn 7082: }
1.275 raeburn 7083: }
7084: }
1.412 raeburn 7085: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7086: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7087: my $now = time;
1.609 raeburn 7088: my %displaystatus = ( previous => 'Expired',
7089: active => 'Active',
7090: future => 'Future',
7091: );
1.630 raeburn 7092: my %nothide;
7093: if ($hidepriv) {
7094: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7095: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7096: if ($user !~ /:/) {
7097: $nothide{join(':',split(/[\@]/,$user))}=1;
7098: } else {
7099: $nothide{$user} = 1;
7100: }
7101: }
7102: }
1.439 raeburn 7103: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7104: my $match = 0;
1.412 raeburn 7105: my $secmatch = 0;
1.439 raeburn 7106: my $status;
1.412 raeburn 7107: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7108: $user =~ s/:$//;
1.439 raeburn 7109: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7110: if ($end == -1 || $start == -1) {
7111: next;
7112: }
7113: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7114: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7115: my ($uname,$udom) = split(/:/,$user);
7116: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7117: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7118: $secmatch = 1;
7119: } elsif ($usec eq '') {
1.420 albertel 7120: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7121: $secmatch = 1;
7122: }
7123: } else {
7124: if (grep(/^\Q$usec\E$/,@{$sections})) {
7125: $secmatch = 1;
7126: }
7127: }
7128: if (!$secmatch) {
7129: next;
7130: }
1.288 raeburn 7131: }
1.419 raeburn 7132: if ($usec eq '') {
7133: $usec = 'none';
7134: }
1.275 raeburn 7135: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7136: if ($hidepriv) {
7137: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7138: (!$nothide{$uname.':'.$udom})) {
7139: next;
7140: }
7141: }
1.503 raeburn 7142: if ($end > 0 && $end < $now) {
1.439 raeburn 7143: $status = 'previous';
7144: } elsif ($start > $now) {
7145: $status = 'future';
7146: } else {
7147: $status = 'active';
7148: }
1.277 albertel 7149: foreach my $type (keys(%{$types})) {
1.275 raeburn 7150: if ($status eq $type) {
1.420 albertel 7151: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7152: push(@{$$users{$role}{$user}},$type);
7153: }
1.288 raeburn 7154: $match = 1;
7155: }
7156: }
1.419 raeburn 7157: if (($match) && (ref($userdata) eq 'HASH')) {
7158: if (!exists($$userdata{$uname.':'.$udom})) {
7159: &get_user_info($udom,$uname,\%idx,$userdata);
7160: }
1.420 albertel 7161: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7162: push(@{$seclists{$uname.':'.$udom}},$usec);
7163: }
1.609 raeburn 7164: if (ref($statushash) eq 'HASH') {
7165: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7166: }
1.275 raeburn 7167: }
7168: }
7169: }
7170: }
1.290 albertel 7171: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7172: if ((defined($cdom)) && (defined($cnum))) {
7173: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7174: if ( defined($csettings{'internal.courseowner'}) ) {
7175: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7176: next if ($owner eq '');
7177: my ($ownername,$ownerdom);
7178: if ($owner =~ /^([^:]+):([^:]+)$/) {
7179: $ownername = $1;
7180: $ownerdom = $2;
7181: } else {
7182: $ownername = $owner;
7183: $ownerdom = $cdom;
7184: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7185: }
7186: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7187: if (defined($userdata) &&
1.609 raeburn 7188: !exists($$userdata{$owner})) {
7189: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7190: if (!grep(/^none$/,@{$seclists{$owner}})) {
7191: push(@{$seclists{$owner}},'none');
7192: }
7193: if (ref($statushash) eq 'HASH') {
7194: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7195: }
1.290 albertel 7196: }
1.279 raeburn 7197: }
7198: }
7199: }
1.419 raeburn 7200: foreach my $user (keys(%seclists)) {
7201: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7202: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7203: }
1.275 raeburn 7204: }
7205: return;
7206: }
7207:
1.288 raeburn 7208: sub get_user_info {
7209: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7210: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7211: &plainname($uname,$udom,'lastname');
1.291 albertel 7212: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7213: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7214: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7215: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7216: return;
7217: }
1.275 raeburn 7218:
1.472 raeburn 7219: ###############################################
7220:
7221: =pod
7222:
7223: =item * &get_user_quota()
7224:
7225: Retrieves quota assigned for storage of portfolio files for a user
7226:
7227: Incoming parameters:
7228: 1. user's username
7229: 2. user's domain
7230:
7231: Returns:
1.536 raeburn 7232: 1. Disk quota (in Mb) assigned to student.
7233: 2. (Optional) Type of setting: custom or default
7234: (individually assigned or default for user's
7235: institutional status).
7236: 3. (Optional) - User's institutional status (e.g., faculty, staff
7237: or student - types as defined in localenroll::inst_usertypes
7238: for user's domain, which determines default quota for user.
7239: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7240:
7241: If a value has been stored in the user's environment,
1.536 raeburn 7242: it will return that, otherwise it returns the maximal default
7243: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7244:
7245: =cut
7246:
7247: ###############################################
7248:
7249:
7250: sub get_user_quota {
7251: my ($uname,$udom) = @_;
1.536 raeburn 7252: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7253: if (!defined($udom)) {
7254: $udom = $env{'user.domain'};
7255: }
7256: if (!defined($uname)) {
7257: $uname = $env{'user.name'};
7258: }
7259: if (($udom eq '' || $uname eq '') ||
7260: ($udom eq 'public') && ($uname eq 'public')) {
7261: $quota = 0;
1.536 raeburn 7262: $quotatype = 'default';
7263: $defquota = 0;
1.472 raeburn 7264: } else {
1.536 raeburn 7265: my $inststatus;
1.472 raeburn 7266: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7267: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7268: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7269: } else {
1.536 raeburn 7270: my %userenv =
7271: &Apache::lonnet::get('environment',['portfolioquota',
7272: 'inststatus'],$udom,$uname);
1.472 raeburn 7273: my ($tmp) = keys(%userenv);
7274: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7275: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7276: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7277: } else {
7278: undef(%userenv);
7279: }
7280: }
1.536 raeburn 7281: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7282: if ($quota eq '') {
1.536 raeburn 7283: $quota = $defquota;
7284: $quotatype = 'default';
7285: } else {
7286: $quotatype = 'custom';
1.472 raeburn 7287: }
7288: }
1.536 raeburn 7289: if (wantarray) {
7290: return ($quota,$quotatype,$settingstatus,$defquota);
7291: } else {
7292: return $quota;
7293: }
1.472 raeburn 7294: }
7295:
7296: ###############################################
7297:
7298: =pod
7299:
7300: =item * &default_quota()
7301:
1.536 raeburn 7302: Retrieves default quota assigned for storage of user portfolio files,
7303: given an (optional) user's institutional status.
1.472 raeburn 7304:
7305: Incoming parameters:
7306: 1. domain
1.536 raeburn 7307: 2. (Optional) institutional status(es). This is a : separated list of
7308: status types (e.g., faculty, staff, student etc.)
7309: which apply to the user for whom the default is being retrieved.
7310: If the institutional status string in undefined, the domain
7311: default quota will be returned.
1.472 raeburn 7312:
7313: Returns:
7314: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7315: 2. (Optional) institutional type which determined the value of the
7316: default quota.
1.472 raeburn 7317:
7318: If a value has been stored in the domain's configuration db,
7319: it will return that, otherwise it returns 20 (for backwards
7320: compatibility with domains which have not set up a configuration
7321: db file; the original statically defined portfolio quota was 20 Mb).
7322:
1.536 raeburn 7323: If the user's status includes multiple types (e.g., staff and student),
7324: the largest default quota which applies to the user determines the
7325: default quota returned.
7326:
1.780 raeburn 7327: =back
7328:
1.472 raeburn 7329: =cut
7330:
7331: ###############################################
7332:
7333:
7334: sub default_quota {
1.536 raeburn 7335: my ($udom,$inststatus) = @_;
7336: my ($defquota,$settingstatus);
7337: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7338: ['quotas'],$udom);
7339: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7340: if ($inststatus ne '') {
1.765 raeburn 7341: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7342: foreach my $item (@statuses) {
1.711 raeburn 7343: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7344: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7345: if ($defquota eq '') {
7346: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7347: $settingstatus = $item;
7348: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7349: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7350: $settingstatus = $item;
7351: }
7352: }
7353: } else {
7354: if ($quotahash{'quotas'}{$item} ne '') {
7355: if ($defquota eq '') {
7356: $defquota = $quotahash{'quotas'}{$item};
7357: $settingstatus = $item;
7358: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7359: $defquota = $quotahash{'quotas'}{$item};
7360: $settingstatus = $item;
7361: }
1.536 raeburn 7362: }
7363: }
7364: }
7365: }
7366: if ($defquota eq '') {
1.711 raeburn 7367: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7368: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7369: } else {
7370: $defquota = $quotahash{'quotas'}{'default'};
7371: }
1.536 raeburn 7372: $settingstatus = 'default';
7373: }
7374: } else {
7375: $settingstatus = 'default';
7376: $defquota = 20;
7377: }
7378: if (wantarray) {
7379: return ($defquota,$settingstatus);
1.472 raeburn 7380: } else {
1.536 raeburn 7381: return $defquota;
1.472 raeburn 7382: }
7383: }
7384:
1.384 raeburn 7385: sub get_secgrprole_info {
7386: my ($cdom,$cnum,$needroles,$type) = @_;
7387: my %sections_count = &get_sections($cdom,$cnum);
7388: my @sections = (sort {$a <=> $b} keys(%sections_count));
7389: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7390: my @groups = sort(keys(%curr_groups));
7391: my $allroles = [];
7392: my $rolehash;
7393: my $accesshash = {
7394: active => 'Currently has access',
7395: future => 'Will have future access',
7396: previous => 'Previously had access',
7397: };
7398: if ($needroles) {
7399: $rolehash = {'all' => 'all'};
1.385 albertel 7400: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7401: if (&Apache::lonnet::error(%user_roles)) {
7402: undef(%user_roles);
7403: }
7404: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7405: my ($role)=split(/\:/,$item,2);
7406: if ($role eq 'cr') { next; }
7407: if ($role =~ /^cr/) {
7408: $$rolehash{$role} = (split('/',$role))[3];
7409: } else {
7410: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7411: }
7412: }
7413: foreach my $key (sort(keys(%{$rolehash}))) {
7414: push(@{$allroles},$key);
7415: }
7416: push (@{$allroles},'st');
7417: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7418: }
7419: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7420: }
7421:
1.555 raeburn 7422: sub user_picker {
1.627 raeburn 7423: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7424: my $currdom = $dom;
7425: my %curr_selected = (
7426: srchin => 'dom',
1.580 raeburn 7427: srchby => 'lastname',
1.555 raeburn 7428: );
7429: my $srchterm;
1.625 raeburn 7430: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7431: if ($srch->{'srchby'} ne '') {
7432: $curr_selected{'srchby'} = $srch->{'srchby'};
7433: }
7434: if ($srch->{'srchin'} ne '') {
7435: $curr_selected{'srchin'} = $srch->{'srchin'};
7436: }
7437: if ($srch->{'srchtype'} ne '') {
7438: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7439: }
7440: if ($srch->{'srchdomain'} ne '') {
7441: $currdom = $srch->{'srchdomain'};
7442: }
7443: $srchterm = $srch->{'srchterm'};
7444: }
7445: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7446: 'usr' => 'Search criteria',
1.563 raeburn 7447: 'doma' => 'Domain/institution to search',
1.558 albertel 7448: 'uname' => 'username',
7449: 'lastname' => 'last name',
1.555 raeburn 7450: 'lastfirst' => 'last name, first name',
1.558 albertel 7451: 'crs' => 'in this course',
1.576 raeburn 7452: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7453: 'alc' => 'all LON-CAPA',
1.573 raeburn 7454: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7455: 'exact' => 'is',
7456: 'contains' => 'contains',
1.569 raeburn 7457: 'begins' => 'begins with',
1.571 raeburn 7458: 'youm' => "You must include some text to search for.",
7459: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7460: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7461: 'yomc' => "You must choose a domain when using an institutional directory search.",
7462: 'ymcd' => "You must choose a domain when using a domain search.",
7463: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7464: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7465: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7466: );
1.563 raeburn 7467: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7468: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7469:
7470: my @srchins = ('crs','dom','alc','instd');
7471:
7472: foreach my $option (@srchins) {
7473: # FIXME 'alc' option unavailable until
7474: # loncreateuser::print_user_query_page()
7475: # has been completed.
7476: next if ($option eq 'alc');
7477: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7478: if ($curr_selected{'srchin'} eq $option) {
7479: $srchinsel .= '
7480: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7481: } else {
7482: $srchinsel .= '
7483: <option value="'.$option.'">'.$lt{$option}.'</option>';
7484: }
1.555 raeburn 7485: }
1.563 raeburn 7486: $srchinsel .= "\n </select>\n";
1.555 raeburn 7487:
7488: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7489: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7490: if ($curr_selected{'srchby'} eq $option) {
7491: $srchbysel .= '
7492: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7493: } else {
7494: $srchbysel .= '
7495: <option value="'.$option.'">'.$lt{$option}.'</option>';
7496: }
7497: }
7498: $srchbysel .= "\n </select>\n";
7499:
7500: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7501: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7502: if ($curr_selected{'srchtype'} eq $option) {
7503: $srchtypesel .= '
7504: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7505: } else {
7506: $srchtypesel .= '
7507: <option value="'.$option.'">'.$lt{$option}.'</option>';
7508: }
7509: }
7510: $srchtypesel .= "\n </select>\n";
7511:
1.558 albertel 7512: my ($newuserscript,$new_user_create);
1.556 raeburn 7513:
7514: if ($forcenewuser) {
1.576 raeburn 7515: if (ref($srch) eq 'HASH') {
7516: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7517: if ($cancreate) {
7518: $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>';
7519: } else {
1.799 bisitz 7520: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7521: my %usertypetext = (
7522: official => 'institutional',
7523: unofficial => 'non-institutional',
7524: );
1.799 bisitz 7525: $new_user_create = '<p class="LC_warning">'
7526: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7527: .' '
7528: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7529: ,'<a href="'.$helplink.'">','</a>')
7530: .'</p><br />';
1.627 raeburn 7531: }
1.576 raeburn 7532: }
7533: }
7534:
1.556 raeburn 7535: $newuserscript = <<"ENDSCRIPT";
7536:
1.570 raeburn 7537: function setSearch(createnew,callingForm) {
1.556 raeburn 7538: if (createnew == 1) {
1.570 raeburn 7539: for (var i=0; i<callingForm.srchby.length; i++) {
7540: if (callingForm.srchby.options[i].value == 'uname') {
7541: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7542: }
7543: }
1.570 raeburn 7544: for (var i=0; i<callingForm.srchin.length; i++) {
7545: if ( callingForm.srchin.options[i].value == 'dom') {
7546: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7547: }
7548: }
1.570 raeburn 7549: for (var i=0; i<callingForm.srchtype.length; i++) {
7550: if (callingForm.srchtype.options[i].value == 'exact') {
7551: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7552: }
7553: }
1.570 raeburn 7554: for (var i=0; i<callingForm.srchdomain.length; i++) {
7555: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7556: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7557: }
7558: }
7559: }
7560: }
7561: ENDSCRIPT
1.558 albertel 7562:
1.556 raeburn 7563: }
7564:
1.555 raeburn 7565: my $output = <<"END_BLOCK";
1.556 raeburn 7566: <script type="text/javascript">
1.570 raeburn 7567: function validateEntry(callingForm) {
1.558 albertel 7568:
1.556 raeburn 7569: var checkok = 1;
1.558 albertel 7570: var srchin;
1.570 raeburn 7571: for (var i=0; i<callingForm.srchin.length; i++) {
7572: if ( callingForm.srchin[i].checked ) {
7573: srchin = callingForm.srchin[i].value;
1.558 albertel 7574: }
7575: }
7576:
1.570 raeburn 7577: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7578: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7579: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7580: var srchterm = callingForm.srchterm.value;
7581: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7582: var msg = "";
7583:
7584: if (srchterm == "") {
7585: checkok = 0;
1.571 raeburn 7586: msg += "$lt{'youm'}\\n";
1.556 raeburn 7587: }
7588:
1.569 raeburn 7589: if (srchtype== 'begins') {
7590: if (srchterm.length < 2) {
7591: checkok = 0;
1.571 raeburn 7592: msg += "$lt{'thte'}\\n";
1.569 raeburn 7593: }
7594: }
7595:
1.556 raeburn 7596: if (srchtype== 'contains') {
7597: if (srchterm.length < 3) {
7598: checkok = 0;
1.571 raeburn 7599: msg += "$lt{'thet'}\\n";
1.556 raeburn 7600: }
7601: }
7602: if (srchin == 'instd') {
7603: if (srchdomain == '') {
7604: checkok = 0;
1.571 raeburn 7605: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7606: }
7607: }
7608: if (srchin == 'dom') {
7609: if (srchdomain == '') {
7610: checkok = 0;
1.571 raeburn 7611: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7612: }
7613: }
7614: if (srchby == 'lastfirst') {
7615: if (srchterm.indexOf(",") == -1) {
7616: checkok = 0;
1.571 raeburn 7617: msg += "$lt{'whus'}\\n";
1.556 raeburn 7618: }
7619: if (srchterm.indexOf(",") == srchterm.length -1) {
7620: checkok = 0;
1.571 raeburn 7621: msg += "$lt{'whse'}\\n";
1.556 raeburn 7622: }
7623: }
7624: if (checkok == 0) {
1.571 raeburn 7625: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7626: return;
7627: }
7628: if (checkok == 1) {
1.570 raeburn 7629: callingForm.submit();
1.556 raeburn 7630: }
7631: }
7632:
7633: $newuserscript
7634:
7635: </script>
1.558 albertel 7636:
7637: $new_user_create
7638:
1.555 raeburn 7639: <table>
1.558 albertel 7640: <tr>
1.573 raeburn 7641: <td>$lt{'doma'}:</td>
7642: <td>$domform</td>
7643: </td>
7644: </tr>
7645: <tr>
7646: <td>$lt{'usr'}:</td>
1.563 raeburn 7647: <td>$srchbysel
7648: $srchtypesel
7649: <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564 albertel 7650: $srchinsel
1.563 raeburn 7651: </td>
7652: </tr>
1.555 raeburn 7653: </table>
7654: <br />
7655: END_BLOCK
1.558 albertel 7656:
1.555 raeburn 7657: return $output;
7658: }
7659:
1.612 raeburn 7660: sub user_rule_check {
1.615 raeburn 7661: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7662: my $response;
7663: if (ref($usershash) eq 'HASH') {
7664: foreach my $user (keys(%{$usershash})) {
7665: my ($uname,$udom) = split(/:/,$user);
7666: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7667: my ($id,$newuser);
1.612 raeburn 7668: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7669: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7670: $id = $usershash->{$user}->{'id'};
7671: }
7672: my $inst_response;
7673: if (ref($checks) eq 'HASH') {
7674: if (defined($checks->{'username'})) {
1.615 raeburn 7675: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7676: &Apache::lonnet::get_instuser($udom,$uname);
7677: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7678: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7679: &Apache::lonnet::get_instuser($udom,undef,$id);
7680: }
1.615 raeburn 7681: } else {
7682: ($inst_response,%{$inst_results->{$user}}) =
7683: &Apache::lonnet::get_instuser($udom,$uname);
7684: return;
1.612 raeburn 7685: }
1.615 raeburn 7686: if (!$got_rules->{$udom}) {
1.612 raeburn 7687: my %domconfig = &Apache::lonnet::get_dom('configuration',
7688: ['usercreation'],$udom);
7689: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7690: foreach my $item ('username','id') {
1.612 raeburn 7691: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7692: $$curr_rules{$udom}{$item} =
7693: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7694: }
7695: }
7696: }
1.615 raeburn 7697: $got_rules->{$udom} = 1;
1.585 raeburn 7698: }
1.612 raeburn 7699: foreach my $item (keys(%{$checks})) {
7700: if (ref($$curr_rules{$udom}) eq 'HASH') {
7701: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7702: if (@{$$curr_rules{$udom}{$item}} > 0) {
7703: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7704: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7705: if ($rule_check{$rule}) {
7706: $$rulematch{$user}{$item} = $rule;
7707: if ($inst_response eq 'ok') {
1.615 raeburn 7708: if (ref($inst_results) eq 'HASH') {
7709: if (ref($inst_results->{$user}) eq 'HASH') {
7710: if (keys(%{$inst_results->{$user}}) == 0) {
7711: $$alerts{$item}{$udom}{$uname} = 1;
7712: }
1.612 raeburn 7713: }
7714: }
1.615 raeburn 7715: }
7716: last;
1.585 raeburn 7717: }
7718: }
7719: }
7720: }
7721: }
7722: }
7723: }
7724: }
1.612 raeburn 7725: return;
7726: }
7727:
7728: sub user_rule_formats {
7729: my ($domain,$domdesc,$curr_rules,$check) = @_;
7730: my %text = (
7731: 'username' => 'Usernames',
7732: 'id' => 'IDs',
7733: );
7734: my $output;
7735: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7736: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7737: if (@{$ruleorder} > 0) {
7738: $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>';
7739: foreach my $rule (@{$ruleorder}) {
7740: if (ref($curr_rules) eq 'ARRAY') {
7741: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7742: if (ref($rules->{$rule}) eq 'HASH') {
7743: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7744: $rules->{$rule}{'desc'}.'</li>';
7745: }
7746: }
7747: }
7748: }
7749: $output .= '</ul>';
7750: }
7751: }
7752: return $output;
7753: }
7754:
7755: sub instrule_disallow_msg {
1.615 raeburn 7756: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7757: my $response;
7758: my %text = (
7759: item => 'username',
7760: items => 'usernames',
7761: match => 'matches',
7762: do => 'does',
7763: action => 'a username',
7764: one => 'one',
7765: );
7766: if ($count > 1) {
7767: $text{'item'} = 'usernames';
7768: $text{'match'} ='match';
7769: $text{'do'} = 'do';
7770: $text{'action'} = 'usernames',
7771: $text{'one'} = 'ones';
7772: }
7773: if ($checkitem eq 'id') {
7774: $text{'items'} = 'IDs';
7775: $text{'item'} = 'ID';
7776: $text{'action'} = 'an ID';
1.615 raeburn 7777: if ($count > 1) {
7778: $text{'item'} = 'IDs';
7779: $text{'action'} = 'IDs';
7780: }
1.612 raeburn 7781: }
1.674 bisitz 7782: $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 7783: if ($mode eq 'upload') {
7784: if ($checkitem eq 'username') {
7785: $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'}.");
7786: } elsif ($checkitem eq 'id') {
1.674 bisitz 7787: $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 7788: }
1.669 raeburn 7789: } elsif ($mode eq 'selfcreate') {
7790: if ($checkitem eq 'id') {
7791: $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.");
7792: }
1.615 raeburn 7793: } else {
7794: if ($checkitem eq 'username') {
7795: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
7796: } elsif ($checkitem eq 'id') {
7797: $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.");
7798: }
1.612 raeburn 7799: }
7800: return $response;
1.585 raeburn 7801: }
7802:
1.624 raeburn 7803: sub personal_data_fieldtitles {
7804: my %fieldtitles = &Apache::lonlocal::texthash (
7805: id => 'Student/Employee ID',
7806: permanentemail => 'E-mail address',
7807: lastname => 'Last Name',
7808: firstname => 'First Name',
7809: middlename => 'Middle Name',
7810: generation => 'Generation',
7811: gen => 'Generation',
1.765 raeburn 7812: inststatus => 'Affiliation',
1.624 raeburn 7813: );
7814: return %fieldtitles;
7815: }
7816:
1.642 raeburn 7817: sub sorted_inst_types {
7818: my ($dom) = @_;
7819: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
7820: my $othertitle = &mt('All users');
7821: if ($env{'request.course.id'}) {
1.668 raeburn 7822: $othertitle = &mt('Any users');
1.642 raeburn 7823: }
7824: my @types;
7825: if (ref($order) eq 'ARRAY') {
7826: @types = @{$order};
7827: }
7828: if (@types == 0) {
7829: if (ref($usertypes) eq 'HASH') {
7830: @types = sort(keys(%{$usertypes}));
7831: }
7832: }
7833: if (keys(%{$usertypes}) > 0) {
7834: $othertitle = &mt('Other users');
7835: }
7836: return ($othertitle,$usertypes,\@types);
7837: }
7838:
1.645 raeburn 7839: sub get_institutional_codes {
7840: my ($settings,$allcourses,$LC_code) = @_;
7841: # Get complete list of course sections to update
7842: my @currsections = ();
7843: my @currxlists = ();
7844: my $coursecode = $$settings{'internal.coursecode'};
7845:
7846: if ($$settings{'internal.sectionnums'} ne '') {
7847: @currsections = split(/,/,$$settings{'internal.sectionnums'});
7848: }
7849:
7850: if ($$settings{'internal.crosslistings'} ne '') {
7851: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
7852: }
7853:
7854: if (@currxlists > 0) {
7855: foreach (@currxlists) {
7856: if (m/^([^:]+):(\w*)$/) {
7857: unless (grep/^$1$/,@{$allcourses}) {
7858: push @{$allcourses},$1;
7859: $$LC_code{$1} = $2;
7860: }
7861: }
7862: }
7863: }
7864:
7865: if (@currsections > 0) {
7866: foreach (@currsections) {
7867: if (m/^(\w+):(\w*)$/) {
7868: my $sec = $coursecode.$1;
7869: my $lc_sec = $2;
7870: unless (grep/^$sec$/,@{$allcourses}) {
7871: push @{$allcourses},$sec;
7872: $$LC_code{$sec} = $lc_sec;
7873: }
7874: }
7875: }
7876: }
7877: return;
7878: }
7879:
1.112 bowersj2 7880: =pod
7881:
1.780 raeburn 7882: =head1 Slot Helpers
7883:
7884: =over 4
7885:
7886: =item * sorted_slots()
7887:
7888: Sorts an array of slot names in order of slot start time (earliest first).
7889:
7890: Inputs:
7891:
7892: =over 4
7893:
7894: slotsarr - Reference to array of unsorted slot names.
7895:
7896: slots - Reference to hash of hash, where outer hash keys are slot names.
7897:
1.549 albertel 7898: =back
7899:
1.780 raeburn 7900: Returns:
7901:
7902: =over 4
7903:
7904: sorted - An array of slot names sorted by the start time of the slot.
7905:
7906: =back
7907:
7908: =back
7909:
7910: =cut
7911:
7912:
7913: sub sorted_slots {
7914: my ($slotsarr,$slots) = @_;
7915: my @sorted;
7916: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
7917: @sorted =
7918: sort {
7919: if (ref($slots->{$a}) && ref($slots->{$b})) {
7920: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
7921: }
7922: if (ref($slots->{$a})) { return -1;}
7923: if (ref($slots->{$b})) { return 1;}
7924: return 0;
7925: } @{$slotsarr};
7926: }
7927: return @sorted;
7928: }
7929:
7930:
7931: =pod
7932:
1.549 albertel 7933: =head1 HTTP Helpers
7934:
7935: =over 4
7936:
1.648 raeburn 7937: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 7938:
1.258 albertel 7939: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 7940: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 7941: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 7942:
7943: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
7944: $possible_names is an ref to an array of form element names. As an example:
7945: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 7946: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 7947:
7948: =cut
1.1 albertel 7949:
1.6 albertel 7950: sub get_unprocessed_cgi {
1.25 albertel 7951: my ($query,$possible_names)= @_;
1.26 matthew 7952: # $Apache::lonxml::debug=1;
1.356 albertel 7953: foreach my $pair (split(/&/,$query)) {
7954: my ($name, $value) = split(/=/,$pair);
1.369 www 7955: $name = &unescape($name);
1.25 albertel 7956: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
7957: $value =~ tr/+/ /;
7958: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 7959: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 7960: }
1.16 harris41 7961: }
1.6 albertel 7962: }
7963:
1.112 bowersj2 7964: =pod
7965:
1.648 raeburn 7966: =item * &cacheheader()
1.112 bowersj2 7967:
7968: returns cache-controlling header code
7969:
7970: =cut
7971:
1.7 albertel 7972: sub cacheheader {
1.258 albertel 7973: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 7974: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
7975: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 7976: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
7977: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 7978: return $output;
1.7 albertel 7979: }
7980:
1.112 bowersj2 7981: =pod
7982:
1.648 raeburn 7983: =item * &no_cache($r)
1.112 bowersj2 7984:
7985: specifies header code to not have cache
7986:
7987: =cut
7988:
1.9 albertel 7989: sub no_cache {
1.216 albertel 7990: my ($r) = @_;
7991: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 7992: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 7993: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
7994: $r->no_cache(1);
7995: $r->header_out("Expires" => $date);
7996: $r->header_out("Pragma" => "no-cache");
1.123 www 7997: }
7998:
7999: sub content_type {
1.181 albertel 8000: my ($r,$type,$charset) = @_;
1.299 foxr 8001: if ($r) {
8002: # Note that printout.pl calls this with undef for $r.
8003: &no_cache($r);
8004: }
1.258 albertel 8005: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8006: unless ($charset) {
8007: $charset=&Apache::lonlocal::current_encoding;
8008: }
8009: if ($charset) { $type.='; charset='.$charset; }
8010: if ($r) {
8011: $r->content_type($type);
8012: } else {
8013: print("Content-type: $type\n\n");
8014: }
1.9 albertel 8015: }
1.25 albertel 8016:
1.112 bowersj2 8017: =pod
8018:
1.648 raeburn 8019: =item * &add_to_env($name,$value)
1.112 bowersj2 8020:
1.258 albertel 8021: adds $name to the %env hash with value
1.112 bowersj2 8022: $value, if $name already exists, the entry is converted to an array
8023: reference and $value is added to the array.
8024:
8025: =cut
8026:
1.25 albertel 8027: sub add_to_env {
8028: my ($name,$value)=@_;
1.258 albertel 8029: if (defined($env{$name})) {
8030: if (ref($env{$name})) {
1.25 albertel 8031: #already have multiple values
1.258 albertel 8032: push(@{ $env{$name} },$value);
1.25 albertel 8033: } else {
8034: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8035: my $first=$env{$name};
8036: undef($env{$name});
8037: push(@{ $env{$name} },$first,$value);
1.25 albertel 8038: }
8039: } else {
1.258 albertel 8040: $env{$name}=$value;
1.25 albertel 8041: }
1.31 albertel 8042: }
1.149 albertel 8043:
8044: =pod
8045:
1.648 raeburn 8046: =item * &get_env_multiple($name)
1.149 albertel 8047:
1.258 albertel 8048: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8049: values may be defined and end up as an array ref.
8050:
8051: returns an array of values
8052:
8053: =cut
8054:
8055: sub get_env_multiple {
8056: my ($name) = @_;
8057: my @values;
1.258 albertel 8058: if (defined($env{$name})) {
1.149 albertel 8059: # exists is it an array
1.258 albertel 8060: if (ref($env{$name})) {
8061: @values=@{ $env{$name} };
1.149 albertel 8062: } else {
1.258 albertel 8063: $values[0]=$env{$name};
1.149 albertel 8064: }
8065: }
8066: return(@values);
8067: }
8068:
1.660 raeburn 8069: sub ask_for_embedded_content {
8070: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
8071: my $upload_output = '
8072: <form name="upload_embedded" action="'.$actionurl.'"
8073: method="post" enctype="multipart/form-data">';
8074: $upload_output .= $state;
1.661 raeburn 8075: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 8076:
8077: my $num = 0;
8078: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
8079: $upload_output .= &start_data_table_row().
8080: '<td>'.$embed_file.'</td><td>';
8081: if ($args->{'ignore_remote_references'}
8082: && $embed_file =~ m{^\w+://}) {
8083: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
8084: } elsif ($args->{'error_on_invalid_names'}
8085: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8086:
8087: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
8088:
8089: } else {
8090: $upload_output .='
1.661 raeburn 8091: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 8092: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
8093: my $attrib = join(':',@{$$allfiles{$embed_file}});
8094: $upload_output .=
8095: "\n\t\t".
8096: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8097: $attrib.'" />';
8098: if (exists($$codebase{$embed_file})) {
8099: $upload_output .=
8100: "\n\t\t".
8101: '<input name="codebase_'.$num.'" type="hidden" value="'.
8102: &escape($$codebase{$embed_file}).'" />';
8103: }
8104: }
8105: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
8106: $num++;
8107: }
8108: $upload_output .= &Apache::loncommon::end_data_table().'<br />
8109: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
8110: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
8111: '.&mt('(only files for which a location has been provided will be uploaded)').'
8112: </form>';
8113: return $upload_output;
8114: }
8115:
1.661 raeburn 8116: sub upload_embedded {
8117: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
8118: $current_disk_usage) = @_;
8119: my $output;
8120: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8121: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8122: my $orig_uploaded_filename =
8123: $env{'form.embedded_item_'.$i.'.filename'};
8124:
8125: $env{'form.embedded_orig_'.$i} =
8126: &unescape($env{'form.embedded_orig_'.$i});
8127: my ($path,$fname) =
8128: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8129: # no path, whole string is fname
8130: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8131:
8132: $path = $env{'form.currentpath'}.$path;
8133: $fname = &Apache::lonnet::clean_filename($fname);
8134: # See if there is anything left
8135: next if ($fname eq '');
8136:
8137: # Check if file already exists as a file or directory.
8138: my ($state,$msg);
8139: if ($context eq 'portfolio') {
8140: my $port_path = $dirpath;
8141: if ($group ne '') {
8142: $port_path = "groups/$group/$port_path";
8143: }
8144: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
8145: $dir_root,$port_path,$disk_quota,
8146: $current_disk_usage,$uname,$udom);
8147: if ($state eq 'will_exceed_quota'
8148: || $state eq 'file_locked'
8149: || $state eq 'file_exists' ) {
8150: $output .= $msg;
8151: next;
8152: }
8153: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8154: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8155: if ($state eq 'exists') {
8156: $output .= $msg;
8157: next;
8158: }
8159: }
8160: # Check if extension is valid
8161: if (($fname =~ /\.(\w+)$/) &&
8162: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
8163: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
8164: next;
8165: } elsif (($fname =~ /\.(\w+)$/) &&
8166: (!defined(&Apache::loncommon::fileembstyle($1)))) {
8167: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
8168: next;
8169: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
8170: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
8171: next;
8172: }
8173:
8174: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8175: if ($context eq 'portfolio') {
8176: my $result=
8177: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
8178: $dirpath.$path);
8179: if ($result !~ m|^/uploaded/|) {
8180: $output .= '<span class="LC_error">'
8181: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8182: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8183: .'</span><br />';
8184: next;
8185: } else {
8186: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
8187: $path.$fname.'</span>').'</p>';
8188: }
8189: } else {
8190: # Save the file
8191: my $target = $env{'form.embedded_item_'.$i};
8192: my $fullpath = $dir_root.$dirpath.'/'.$path;
8193: my $dest = $fullpath.$fname;
8194: my $url = $url_root.$dirpath.'/'.$path.$fname;
8195: my @parts=split(/\//,$fullpath);
8196: my $count;
8197: my $filepath = $dir_root;
8198: for ($count=4;$count<=$#parts;$count++) {
8199: $filepath .= "/$parts[$count]";
8200: if ((-e $filepath)!=1) {
8201: mkdir($filepath,0770);
8202: }
8203: }
8204: my $fh;
8205: if (!open($fh,'>'.$dest)) {
8206: &Apache::lonnet::logthis('Failed to create '.$dest);
8207: $output .= '<span class="LC_error">'.
8208: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8209: '</span><br />';
8210: } else {
8211: if (!print $fh $env{'form.embedded_item_'.$i}) {
8212: &Apache::lonnet::logthis('Failed to write to '.$dest);
8213: $output .= '<span class="LC_error">'.
8214: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8215: '</span><br />';
8216: } else {
8217: if ($context eq 'testbank') {
8218: $output .= &mt('Embedded file uploaded successfully:').
8219: ' <a href="'.$url.'">'.
8220: $orig_uploaded_filename.'</a><br />';
8221: } else {
1.705 tempelho 8222: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 8223: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 8224: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 8225: }
8226: }
8227: close($fh);
8228: }
8229: }
8230: }
8231: return $output;
8232: }
8233:
8234: sub check_for_existing {
8235: my ($path,$fname,$element) = @_;
8236: my ($state,$msg);
8237: if (-d $path.'/'.$fname) {
8238: $state = 'exists';
8239: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8240: } elsif (-e $path.'/'.$fname) {
8241: $state = 'exists';
8242: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8243: }
8244: if ($state eq 'exists') {
8245: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8246: }
8247: return ($state,$msg);
8248: }
8249:
8250: sub check_for_upload {
8251: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8252: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
8253: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
8254: my $getpropath = 1;
8255: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8256: $getpropath);
8257: my $found_file = 0;
8258: my $locked_file = 0;
8259: foreach my $line (@dir_list) {
8260: my ($file_name)=split(/\&/,$line,2);
8261: if ($file_name eq $fname){
8262: $file_name = $path.$file_name;
8263: if ($group ne '') {
8264: $file_name = $group.$file_name;
8265: }
8266: $found_file = 1;
8267: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8268: $locked_file = 1;
8269: }
8270: }
8271: }
8272: if (($current_disk_usage + $filesize) > $disk_quota){
8273: my $msg = '<span class="LC_error">'.
8274: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8275: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8276: return ('will_exceed_quota',$msg);
8277: } elsif ($found_file) {
8278: if ($locked_file) {
8279: my $msg = '<span class="LC_error">';
8280: $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>');
8281: $msg .= '</span><br />';
8282: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8283: return ('file_locked',$msg);
8284: } else {
8285: my $msg = '<span class="LC_error">';
8286: $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'});
8287: $msg .= '</span>';
8288: $msg .= '<br />';
8289: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8290: return ('file_exists',$msg);
8291: }
8292: }
8293: }
8294:
1.31 albertel 8295:
1.41 ng 8296: =pod
1.45 matthew 8297:
1.464 albertel 8298: =back
1.41 ng 8299:
1.112 bowersj2 8300: =head1 CSV Upload/Handling functions
1.38 albertel 8301:
1.41 ng 8302: =over 4
8303:
1.648 raeburn 8304: =item * &upfile_store($r)
1.41 ng 8305:
8306: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 8307: needs $env{'form.upfile'}
1.41 ng 8308: returns $datatoken to be put into hidden field
8309:
8310: =cut
1.31 albertel 8311:
8312: sub upfile_store {
8313: my $r=shift;
1.258 albertel 8314: $env{'form.upfile'}=~s/\r/\n/gs;
8315: $env{'form.upfile'}=~s/\f/\n/gs;
8316: $env{'form.upfile'}=~s/\n+/\n/gs;
8317: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 8318:
1.258 albertel 8319: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8320: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 8321: {
1.158 raeburn 8322: my $datafile = $r->dir_config('lonDaemons').
8323: '/tmp/'.$datatoken.'.tmp';
8324: if ( open(my $fh,">$datafile") ) {
1.258 albertel 8325: print $fh $env{'form.upfile'};
1.158 raeburn 8326: close($fh);
8327: }
1.31 albertel 8328: }
8329: return $datatoken;
8330: }
8331:
1.56 matthew 8332: =pod
8333:
1.648 raeburn 8334: =item * &load_tmp_file($r)
1.41 ng 8335:
8336: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 8337: needs $env{'form.datatoken'},
8338: sets $env{'form.upfile'} to the contents of the file
1.41 ng 8339:
8340: =cut
1.31 albertel 8341:
8342: sub load_tmp_file {
8343: my $r=shift;
8344: my @studentdata=();
8345: {
1.158 raeburn 8346: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 8347: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 8348: if ( open(my $fh,"<$studentfile") ) {
8349: @studentdata=<$fh>;
8350: close($fh);
8351: }
1.31 albertel 8352: }
1.258 albertel 8353: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 8354: }
8355:
1.56 matthew 8356: =pod
8357:
1.648 raeburn 8358: =item * &upfile_record_sep()
1.41 ng 8359:
8360: Separate uploaded file into records
8361: returns array of records,
1.258 albertel 8362: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8363:
8364: =cut
1.31 albertel 8365:
8366: sub upfile_record_sep {
1.258 albertel 8367: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8368: } else {
1.248 albertel 8369: my @records;
1.258 albertel 8370: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8371: if ($line=~/^\s*$/) { next; }
8372: push(@records,$line);
8373: }
8374: return @records;
1.31 albertel 8375: }
8376: }
8377:
1.56 matthew 8378: =pod
8379:
1.648 raeburn 8380: =item * &record_sep($record)
1.41 ng 8381:
1.258 albertel 8382: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8383:
8384: =cut
8385:
1.263 www 8386: sub takeleft {
8387: my $index=shift;
8388: return substr('0000'.$index,-4,4);
8389: }
8390:
1.31 albertel 8391: sub record_sep {
8392: my $record=shift;
8393: my %components=();
1.258 albertel 8394: if ($env{'form.upfiletype'} eq 'xml') {
8395: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8396: my $i=0;
1.356 albertel 8397: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8398: $field=~s/^(\"|\')//;
8399: $field=~s/(\"|\')$//;
1.263 www 8400: $components{&takeleft($i)}=$field;
1.31 albertel 8401: $i++;
8402: }
1.258 albertel 8403: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8404: my $i=0;
1.356 albertel 8405: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8406: $field=~s/^(\"|\')//;
8407: $field=~s/(\"|\')$//;
1.263 www 8408: $components{&takeleft($i)}=$field;
1.31 albertel 8409: $i++;
8410: }
8411: } else {
1.561 www 8412: my $separator=',';
1.480 banghart 8413: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8414: $separator=';';
1.480 banghart 8415: }
1.31 albertel 8416: my $i=0;
1.561 www 8417: # the character we are looking for to indicate the end of a quote or a record
8418: my $looking_for=$separator;
8419: # do not add the characters to the fields
8420: my $ignore=0;
8421: # we just encountered a separator (or the beginning of the record)
8422: my $just_found_separator=1;
8423: # store the field we are working on here
8424: my $field='';
8425: # work our way through all characters in record
8426: foreach my $character ($record=~/(.)/g) {
8427: if ($character eq $looking_for) {
8428: if ($character ne $separator) {
8429: # Found the end of a quote, again looking for separator
8430: $looking_for=$separator;
8431: $ignore=1;
8432: } else {
8433: # Found a separator, store away what we got
8434: $components{&takeleft($i)}=$field;
8435: $i++;
8436: $just_found_separator=1;
8437: $ignore=0;
8438: $field='';
8439: }
8440: next;
8441: }
8442: # single or double quotation marks after a separator indicate beginning of a quote
8443: # we are now looking for the end of the quote and need to ignore separators
8444: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8445: $looking_for=$character;
8446: next;
8447: }
8448: # ignore would be true after we reached the end of a quote
8449: if ($ignore) { next; }
8450: if (($just_found_separator) && ($character=~/\s/)) { next; }
8451: $field.=$character;
8452: $just_found_separator=0;
1.31 albertel 8453: }
1.561 www 8454: # catch the very last entry, since we never encountered the separator
8455: $components{&takeleft($i)}=$field;
1.31 albertel 8456: }
8457: return %components;
8458: }
8459:
1.144 matthew 8460: ######################################################
8461: ######################################################
8462:
1.56 matthew 8463: =pod
8464:
1.648 raeburn 8465: =item * &upfile_select_html()
1.41 ng 8466:
1.144 matthew 8467: Return HTML code to select a file from the users machine and specify
8468: the file type.
1.41 ng 8469:
8470: =cut
8471:
1.144 matthew 8472: ######################################################
8473: ######################################################
1.31 albertel 8474: sub upfile_select_html {
1.144 matthew 8475: my %Types = (
8476: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8477: semisv => &mt('Semicolon separated values'),
1.144 matthew 8478: space => &mt('Space separated'),
8479: tab => &mt('Tabulator separated'),
8480: # xml => &mt('HTML/XML'),
8481: );
8482: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8483: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8484: foreach my $type (sort(keys(%Types))) {
8485: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8486: }
8487: $Str .= "</select>\n";
8488: return $Str;
1.31 albertel 8489: }
8490:
1.301 albertel 8491: sub get_samples {
8492: my ($records,$toget) = @_;
8493: my @samples=({});
8494: my $got=0;
8495: foreach my $rec (@$records) {
8496: my %temp = &record_sep($rec);
8497: if (! grep(/\S/, values(%temp))) { next; }
8498: if (%temp) {
8499: $samples[$got]=\%temp;
8500: $got++;
8501: if ($got == $toget) { last; }
8502: }
8503: }
8504: return \@samples;
8505: }
8506:
1.144 matthew 8507: ######################################################
8508: ######################################################
8509:
1.56 matthew 8510: =pod
8511:
1.648 raeburn 8512: =item * &csv_print_samples($r,$records)
1.41 ng 8513:
8514: Prints a table of sample values from each column uploaded $r is an
8515: Apache Request ref, $records is an arrayref from
8516: &Apache::loncommon::upfile_record_sep
8517:
8518: =cut
8519:
1.144 matthew 8520: ######################################################
8521: ######################################################
1.31 albertel 8522: sub csv_print_samples {
8523: my ($r,$records) = @_;
1.662 bisitz 8524: my $samples = &get_samples($records,5);
1.301 albertel 8525:
1.594 raeburn 8526: $r->print(&mt('Samples').'<br />'.&start_data_table().
8527: &start_data_table_header_row());
1.356 albertel 8528: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8529: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8530: $r->print(&end_data_table_header_row());
1.301 albertel 8531: foreach my $hash (@$samples) {
1.594 raeburn 8532: $r->print(&start_data_table_row());
1.356 albertel 8533: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8534: $r->print('<td>');
1.356 albertel 8535: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8536: $r->print('</td>');
8537: }
1.594 raeburn 8538: $r->print(&end_data_table_row());
1.31 albertel 8539: }
1.594 raeburn 8540: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8541: }
8542:
1.144 matthew 8543: ######################################################
8544: ######################################################
8545:
1.56 matthew 8546: =pod
8547:
1.648 raeburn 8548: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8549:
8550: Prints a table to create associations between values and table columns.
1.144 matthew 8551:
1.41 ng 8552: $r is an Apache Request ref,
8553: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8554: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8555:
8556: =cut
8557:
1.144 matthew 8558: ######################################################
8559: ######################################################
1.31 albertel 8560: sub csv_print_select_table {
8561: my ($r,$records,$d) = @_;
1.301 albertel 8562: my $i=0;
8563: my $samples = &get_samples($records,1);
1.144 matthew 8564: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8565: &start_data_table().&start_data_table_header_row().
1.144 matthew 8566: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8567: '<th>'.&mt('Column').'</th>'.
8568: &end_data_table_header_row()."\n");
1.356 albertel 8569: foreach my $array_ref (@$d) {
8570: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8571: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8572:
8573: $r->print('<td><select name=f'.$i.
1.32 matthew 8574: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8575: $r->print('<option value="none"></option>');
1.356 albertel 8576: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8577: $r->print('<option value="'.$sample.'"'.
8578: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8579: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8580: }
1.594 raeburn 8581: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8582: $i++;
8583: }
1.594 raeburn 8584: $r->print(&end_data_table());
1.31 albertel 8585: $i--;
8586: return $i;
8587: }
1.56 matthew 8588:
1.144 matthew 8589: ######################################################
8590: ######################################################
8591:
1.56 matthew 8592: =pod
1.31 albertel 8593:
1.648 raeburn 8594: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8595:
8596: Prints a table of sample values from the upload and can make associate samples to internal names.
8597:
8598: $r is an Apache Request ref,
8599: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8600: $d is an array of 2 element arrays (internal name, displayed name)
8601:
8602: =cut
8603:
1.144 matthew 8604: ######################################################
8605: ######################################################
1.31 albertel 8606: sub csv_samples_select_table {
8607: my ($r,$records,$d) = @_;
8608: my $i=0;
1.144 matthew 8609: #
1.662 bisitz 8610: my $max_samples = 5;
8611: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8612: $r->print(&start_data_table().
8613: &start_data_table_header_row().'<th>'.
8614: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8615: &end_data_table_header_row());
1.301 albertel 8616:
8617: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8618: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8619: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8620: foreach my $option (@$d) {
8621: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8622: $r->print('<option value="'.$value.'"'.
1.253 albertel 8623: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8624: $display.'</option>');
1.31 albertel 8625: }
8626: $r->print('</select></td><td>');
1.662 bisitz 8627: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8628: if (defined($samples->[$line]{$key})) {
8629: $r->print($samples->[$line]{$key}."<br />\n");
8630: }
8631: }
1.594 raeburn 8632: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8633: $i++;
8634: }
1.594 raeburn 8635: $r->print(&end_data_table());
1.31 albertel 8636: $i--;
8637: return($i);
1.115 matthew 8638: }
8639:
1.144 matthew 8640: ######################################################
8641: ######################################################
8642:
1.115 matthew 8643: =pod
8644:
1.648 raeburn 8645: =item * &clean_excel_name($name)
1.115 matthew 8646:
8647: Returns a replacement for $name which does not contain any illegal characters.
8648:
8649: =cut
8650:
1.144 matthew 8651: ######################################################
8652: ######################################################
1.115 matthew 8653: sub clean_excel_name {
8654: my ($name) = @_;
8655: $name =~ s/[:\*\?\/\\]//g;
8656: if (length($name) > 31) {
8657: $name = substr($name,0,31);
8658: }
8659: return $name;
1.25 albertel 8660: }
1.84 albertel 8661:
1.85 albertel 8662: =pod
8663:
1.648 raeburn 8664: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8665:
8666: Returns either 1 or undef
8667:
8668: 1 if the part is to be hidden, undef if it is to be shown
8669:
8670: Arguments are:
8671:
8672: $id the id of the part to be checked
8673: $symb, optional the symb of the resource to check
8674: $udom, optional the domain of the user to check for
8675: $uname, optional the username of the user to check for
8676:
8677: =cut
1.84 albertel 8678:
8679: sub check_if_partid_hidden {
8680: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8681: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8682: $symb,$udom,$uname);
1.141 albertel 8683: my $truth=1;
8684: #if the string starts with !, then the list is the list to show not hide
8685: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8686: my @hiddenlist=split(/,/,$hiddenparts);
8687: foreach my $checkid (@hiddenlist) {
1.141 albertel 8688: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8689: }
1.141 albertel 8690: return !$truth;
1.84 albertel 8691: }
1.127 matthew 8692:
1.138 matthew 8693:
8694: ############################################################
8695: ############################################################
8696:
8697: =pod
8698:
1.157 matthew 8699: =back
8700:
1.138 matthew 8701: =head1 cgi-bin script and graphing routines
8702:
1.157 matthew 8703: =over 4
8704:
1.648 raeburn 8705: =item * &get_cgi_id()
1.138 matthew 8706:
8707: Inputs: none
8708:
8709: Returns an id which can be used to pass environment variables
8710: to various cgi-bin scripts. These environment variables will
8711: be removed from the users environment after a given time by
8712: the routine &Apache::lonnet::transfer_profile_to_env.
8713:
8714: =cut
8715:
8716: ############################################################
8717: ############################################################
1.152 albertel 8718: my $uniq=0;
1.136 matthew 8719: sub get_cgi_id {
1.154 albertel 8720: $uniq=($uniq+1)%100000;
1.280 albertel 8721: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8722: }
8723:
1.127 matthew 8724: ############################################################
8725: ############################################################
8726:
8727: =pod
8728:
1.648 raeburn 8729: =item * &DrawBarGraph()
1.127 matthew 8730:
1.138 matthew 8731: Facilitates the plotting of data in a (stacked) bar graph.
8732: Puts plot definition data into the users environment in order for
8733: graph.png to plot it. Returns an <img> tag for the plot.
8734: The bars on the plot are labeled '1','2',...,'n'.
8735:
8736: Inputs:
8737:
8738: =over 4
8739:
8740: =item $Title: string, the title of the plot
8741:
8742: =item $xlabel: string, text describing the X-axis of the plot
8743:
8744: =item $ylabel: string, text describing the Y-axis of the plot
8745:
8746: =item $Max: scalar, the maximum Y value to use in the plot
8747: If $Max is < any data point, the graph will not be rendered.
8748:
1.140 matthew 8749: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8750: they are plotted. If undefined, default values will be used.
8751:
1.178 matthew 8752: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8753:
1.138 matthew 8754: =item @Values: An array of array references. Each array reference holds data
8755: to be plotted in a stacked bar chart.
8756:
1.239 matthew 8757: =item If the final element of @Values is a hash reference the key/value
8758: pairs will be added to the graph definition.
8759:
1.138 matthew 8760: =back
8761:
8762: Returns:
8763:
8764: An <img> tag which references graph.png and the appropriate identifying
8765: information for the plot.
8766:
1.127 matthew 8767: =cut
8768:
8769: ############################################################
8770: ############################################################
1.134 matthew 8771: sub DrawBarGraph {
1.178 matthew 8772: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 8773: #
8774: if (! defined($colors)) {
8775: $colors = ['#33ff00',
8776: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
8777: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
8778: ];
8779: }
1.228 matthew 8780: my $extra_settings = {};
8781: if (ref($Values[-1]) eq 'HASH') {
8782: $extra_settings = pop(@Values);
8783: }
1.127 matthew 8784: #
1.136 matthew 8785: my $identifier = &get_cgi_id();
8786: my $id = 'cgi.'.$identifier;
1.129 matthew 8787: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 8788: return '';
8789: }
1.225 matthew 8790: #
8791: my @Labels;
8792: if (defined($labels)) {
8793: @Labels = @$labels;
8794: } else {
8795: for (my $i=0;$i<@{$Values[0]};$i++) {
8796: push (@Labels,$i+1);
8797: }
8798: }
8799: #
1.129 matthew 8800: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 8801: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 8802: my %ValuesHash;
8803: my $NumSets=1;
8804: foreach my $array (@Values) {
8805: next if (! ref($array));
1.136 matthew 8806: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 8807: join(',',@$array);
1.129 matthew 8808: }
1.127 matthew 8809: #
1.136 matthew 8810: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 8811: if ($NumBars < 3) {
8812: $width = 120+$NumBars*32;
1.220 matthew 8813: $xskip = 1;
1.225 matthew 8814: $bar_width = 30;
8815: } elsif ($NumBars < 5) {
8816: $width = 120+$NumBars*20;
8817: $xskip = 1;
8818: $bar_width = 20;
1.220 matthew 8819: } elsif ($NumBars < 10) {
1.136 matthew 8820: $width = 120+$NumBars*15;
8821: $xskip = 1;
8822: $bar_width = 15;
8823: } elsif ($NumBars <= 25) {
8824: $width = 120+$NumBars*11;
8825: $xskip = 5;
8826: $bar_width = 8;
8827: } elsif ($NumBars <= 50) {
8828: $width = 120+$NumBars*8;
8829: $xskip = 5;
8830: $bar_width = 4;
8831: } else {
8832: $width = 120+$NumBars*8;
8833: $xskip = 5;
8834: $bar_width = 4;
8835: }
8836: #
1.137 matthew 8837: $Max = 1 if ($Max < 1);
8838: if ( int($Max) < $Max ) {
8839: $Max++;
8840: $Max = int($Max);
8841: }
1.127 matthew 8842: $Title = '' if (! defined($Title));
8843: $xlabel = '' if (! defined($xlabel));
8844: $ylabel = '' if (! defined($ylabel));
1.369 www 8845: $ValuesHash{$id.'.title'} = &escape($Title);
8846: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
8847: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 8848: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 8849: $ValuesHash{$id.'.NumBars'} = $NumBars;
8850: $ValuesHash{$id.'.NumSets'} = $NumSets;
8851: $ValuesHash{$id.'.PlotType'} = 'bar';
8852: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8853: $ValuesHash{$id.'.height'} = $height;
8854: $ValuesHash{$id.'.width'} = $width;
8855: $ValuesHash{$id.'.xskip'} = $xskip;
8856: $ValuesHash{$id.'.bar_width'} = $bar_width;
8857: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 8858: #
1.228 matthew 8859: # Deal with other parameters
8860: while (my ($key,$value) = each(%$extra_settings)) {
8861: $ValuesHash{$id.'.'.$key} = $value;
8862: }
8863: #
1.646 raeburn 8864: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 8865: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8866: }
8867:
8868: ############################################################
8869: ############################################################
8870:
8871: =pod
8872:
1.648 raeburn 8873: =item * &DrawXYGraph()
1.137 matthew 8874:
1.138 matthew 8875: Facilitates the plotting of data in an XY graph.
8876: Puts plot definition data into the users environment in order for
8877: graph.png to plot it. Returns an <img> tag for the plot.
8878:
8879: Inputs:
8880:
8881: =over 4
8882:
8883: =item $Title: string, the title of the plot
8884:
8885: =item $xlabel: string, text describing the X-axis of the plot
8886:
8887: =item $ylabel: string, text describing the Y-axis of the plot
8888:
8889: =item $Max: scalar, the maximum Y value to use in the plot
8890: If $Max is < any data point, the graph will not be rendered.
8891:
8892: =item $colors: Array ref containing the hex color codes for the data to be
8893: plotted in. If undefined, default values will be used.
8894:
8895: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8896:
8897: =item $Ydata: Array ref containing Array refs.
1.185 www 8898: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 8899:
8900: =item %Values: hash indicating or overriding any default values which are
8901: passed to graph.png.
8902: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8903:
8904: =back
8905:
8906: Returns:
8907:
8908: An <img> tag which references graph.png and the appropriate identifying
8909: information for the plot.
8910:
1.137 matthew 8911: =cut
8912:
8913: ############################################################
8914: ############################################################
8915: sub DrawXYGraph {
8916: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
8917: #
8918: # Create the identifier for the graph
8919: my $identifier = &get_cgi_id();
8920: my $id = 'cgi.'.$identifier;
8921: #
8922: $Title = '' if (! defined($Title));
8923: $xlabel = '' if (! defined($xlabel));
8924: $ylabel = '' if (! defined($ylabel));
8925: my %ValuesHash =
8926: (
1.369 www 8927: $id.'.title' => &escape($Title),
8928: $id.'.xlabel' => &escape($xlabel),
8929: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 8930: $id.'.y_max_value'=> $Max,
8931: $id.'.labels' => join(',',@$Xlabels),
8932: $id.'.PlotType' => 'XY',
8933: );
8934: #
8935: if (defined($colors) && ref($colors) eq 'ARRAY') {
8936: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8937: }
8938: #
8939: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
8940: return '';
8941: }
8942: my $NumSets=1;
1.138 matthew 8943: foreach my $array (@{$Ydata}){
1.137 matthew 8944: next if (! ref($array));
8945: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
8946: }
1.138 matthew 8947: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 8948: #
8949: # Deal with other parameters
8950: while (my ($key,$value) = each(%Values)) {
8951: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 8952: }
8953: #
1.646 raeburn 8954: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 8955: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8956: }
8957:
8958: ############################################################
8959: ############################################################
8960:
8961: =pod
8962:
1.648 raeburn 8963: =item * &DrawXYYGraph()
1.138 matthew 8964:
8965: Facilitates the plotting of data in an XY graph with two Y axes.
8966: Puts plot definition data into the users environment in order for
8967: graph.png to plot it. Returns an <img> tag for the plot.
8968:
8969: Inputs:
8970:
8971: =over 4
8972:
8973: =item $Title: string, the title of the plot
8974:
8975: =item $xlabel: string, text describing the X-axis of the plot
8976:
8977: =item $ylabel: string, text describing the Y-axis of the plot
8978:
8979: =item $colors: Array ref containing the hex color codes for the data to be
8980: plotted in. If undefined, default values will be used.
8981:
8982: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8983:
8984: =item $Ydata1: The first data set
8985:
8986: =item $Min1: The minimum value of the left Y-axis
8987:
8988: =item $Max1: The maximum value of the left Y-axis
8989:
8990: =item $Ydata2: The second data set
8991:
8992: =item $Min2: The minimum value of the right Y-axis
8993:
8994: =item $Max2: The maximum value of the left Y-axis
8995:
8996: =item %Values: hash indicating or overriding any default values which are
8997: passed to graph.png.
8998: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8999:
9000: =back
9001:
9002: Returns:
9003:
9004: An <img> tag which references graph.png and the appropriate identifying
9005: information for the plot.
1.136 matthew 9006:
9007: =cut
9008:
9009: ############################################################
9010: ############################################################
1.137 matthew 9011: sub DrawXYYGraph {
9012: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9013: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9014: #
9015: # Create the identifier for the graph
9016: my $identifier = &get_cgi_id();
9017: my $id = 'cgi.'.$identifier;
9018: #
9019: $Title = '' if (! defined($Title));
9020: $xlabel = '' if (! defined($xlabel));
9021: $ylabel = '' if (! defined($ylabel));
9022: my %ValuesHash =
9023: (
1.369 www 9024: $id.'.title' => &escape($Title),
9025: $id.'.xlabel' => &escape($xlabel),
9026: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9027: $id.'.labels' => join(',',@$Xlabels),
9028: $id.'.PlotType' => 'XY',
9029: $id.'.NumSets' => 2,
1.137 matthew 9030: $id.'.two_axes' => 1,
9031: $id.'.y1_max_value' => $Max1,
9032: $id.'.y1_min_value' => $Min1,
9033: $id.'.y2_max_value' => $Max2,
9034: $id.'.y2_min_value' => $Min2,
1.136 matthew 9035: );
9036: #
1.137 matthew 9037: if (defined($colors) && ref($colors) eq 'ARRAY') {
9038: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9039: }
9040: #
9041: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9042: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9043: return '';
9044: }
9045: my $NumSets=1;
1.137 matthew 9046: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9047: next if (! ref($array));
9048: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9049: }
9050: #
9051: # Deal with other parameters
9052: while (my ($key,$value) = each(%Values)) {
9053: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9054: }
9055: #
1.646 raeburn 9056: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9057: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9058: }
9059:
9060: ############################################################
9061: ############################################################
9062:
9063: =pod
9064:
1.157 matthew 9065: =back
9066:
1.139 matthew 9067: =head1 Statistics helper routines?
9068:
9069: Bad place for them but what the hell.
9070:
1.157 matthew 9071: =over 4
9072:
1.648 raeburn 9073: =item * &chartlink()
1.139 matthew 9074:
9075: Returns a link to the chart for a specific student.
9076:
9077: Inputs:
9078:
9079: =over 4
9080:
9081: =item $linktext: The text of the link
9082:
9083: =item $sname: The students username
9084:
9085: =item $sdomain: The students domain
9086:
9087: =back
9088:
1.157 matthew 9089: =back
9090:
1.139 matthew 9091: =cut
9092:
9093: ############################################################
9094: ############################################################
9095: sub chartlink {
9096: my ($linktext, $sname, $sdomain) = @_;
9097: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9098: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9099: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9100: '">'.$linktext.'</a>';
1.153 matthew 9101: }
9102:
9103: #######################################################
9104: #######################################################
9105:
9106: =pod
9107:
9108: =head1 Course Environment Routines
1.157 matthew 9109:
9110: =over 4
1.153 matthew 9111:
1.648 raeburn 9112: =item * &restore_course_settings()
1.153 matthew 9113:
1.648 raeburn 9114: =item * &store_course_settings()
1.153 matthew 9115:
9116: Restores/Store indicated form parameters from the course environment.
9117: Will not overwrite existing values of the form parameters.
9118:
9119: Inputs:
9120: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9121:
9122: a hash ref describing the data to be stored. For example:
9123:
9124: %Save_Parameters = ('Status' => 'scalar',
9125: 'chartoutputmode' => 'scalar',
9126: 'chartoutputdata' => 'scalar',
9127: 'Section' => 'array',
1.373 raeburn 9128: 'Group' => 'array',
1.153 matthew 9129: 'StudentData' => 'array',
9130: 'Maps' => 'array');
9131:
9132: Returns: both routines return nothing
9133:
1.631 raeburn 9134: =back
9135:
1.153 matthew 9136: =cut
9137:
9138: #######################################################
9139: #######################################################
9140: sub store_course_settings {
1.496 albertel 9141: return &store_settings($env{'request.course.id'},@_);
9142: }
9143:
9144: sub store_settings {
1.153 matthew 9145: # save to the environment
9146: # appenv the same items, just to be safe
1.300 albertel 9147: my $udom = $env{'user.domain'};
9148: my $uname = $env{'user.name'};
1.496 albertel 9149: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9150: my %SaveHash;
9151: my %AppHash;
9152: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9153: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9154: my $envname = 'environment.'.$basename;
1.258 albertel 9155: if (exists($env{'form.'.$setting})) {
1.153 matthew 9156: # Save this value away
9157: if ($type eq 'scalar' &&
1.258 albertel 9158: (! exists($env{$envname}) ||
9159: $env{$envname} ne $env{'form.'.$setting})) {
9160: $SaveHash{$basename} = $env{'form.'.$setting};
9161: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 9162: } elsif ($type eq 'array') {
9163: my $stored_form;
1.258 albertel 9164: if (ref($env{'form.'.$setting})) {
1.153 matthew 9165: $stored_form = join(',',
9166: map {
1.369 www 9167: &escape($_);
1.258 albertel 9168: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 9169: } else {
9170: $stored_form =
1.369 www 9171: &escape($env{'form.'.$setting});
1.153 matthew 9172: }
9173: # Determine if the array contents are the same.
1.258 albertel 9174: if ($stored_form ne $env{$envname}) {
1.153 matthew 9175: $SaveHash{$basename} = $stored_form;
9176: $AppHash{$envname} = $stored_form;
9177: }
9178: }
9179: }
9180: }
9181: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 9182: $udom,$uname);
1.153 matthew 9183: if ($put_result !~ /^(ok|delayed)/) {
9184: &Apache::lonnet::logthis('unable to save form parameters, '.
9185: 'got error:'.$put_result);
9186: }
9187: # Make sure these settings stick around in this session, too
1.646 raeburn 9188: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 9189: return;
9190: }
9191:
9192: sub restore_course_settings {
1.499 albertel 9193: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 9194: }
9195:
9196: sub restore_settings {
9197: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9198: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 9199: next if (exists($env{'form.'.$setting}));
1.496 albertel 9200: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 9201: '.'.$setting;
1.258 albertel 9202: if (exists($env{$envname})) {
1.153 matthew 9203: if ($type eq 'scalar') {
1.258 albertel 9204: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 9205: } elsif ($type eq 'array') {
1.258 albertel 9206: $env{'form.'.$setting} = [
1.153 matthew 9207: map {
1.369 www 9208: &unescape($_);
1.258 albertel 9209: } split(',',$env{$envname})
1.153 matthew 9210: ];
9211: }
9212: }
9213: }
1.127 matthew 9214: }
9215:
1.618 raeburn 9216: #######################################################
9217: #######################################################
9218:
9219: =pod
9220:
9221: =head1 Domain E-mail Routines
9222:
9223: =over 4
9224:
1.648 raeburn 9225: =item * &build_recipient_list()
1.618 raeburn 9226:
1.766 raeburn 9227: Build recipient lists for four types of e-mail:
9228: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
9229: (d) Help requests, generated by
9230: lonerrorhandler.pm, CHECKRPMS, loncron, and lonsupportreq.pm respectively.
1.618 raeburn 9231:
9232: Inputs:
1.619 raeburn 9233: defmail (scalar - email address of default recipient),
1.618 raeburn 9234: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 9235: defdom (domain for which to retrieve configuration settings),
9236: origmail (scalar - email address of recipient from loncapa.conf,
9237: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 9238:
1.655 raeburn 9239: Returns: comma separated list of addresses to which to send e-mail.
9240:
9241: =back
1.618 raeburn 9242:
9243: =cut
9244:
9245: ############################################################
9246: ############################################################
9247: sub build_recipient_list {
1.619 raeburn 9248: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 9249: my @recipients;
9250: my $otheremails;
9251: my %domconfig =
9252: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
9253: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 9254: if (exists($domconfig{'contacts'}{$mailing})) {
9255: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
9256: my @contacts = ('adminemail','supportemail');
9257: foreach my $item (@contacts) {
9258: if ($domconfig{'contacts'}{$mailing}{$item}) {
9259: my $addr = $domconfig{'contacts'}{$item};
9260: if (!grep(/^\Q$addr\E$/,@recipients)) {
9261: push(@recipients,$addr);
9262: }
1.619 raeburn 9263: }
1.766 raeburn 9264: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 9265: }
9266: }
1.766 raeburn 9267: } elsif ($origmail ne '') {
9268: push(@recipients,$origmail);
1.618 raeburn 9269: }
1.619 raeburn 9270: } elsif ($origmail ne '') {
9271: push(@recipients,$origmail);
1.618 raeburn 9272: }
1.688 raeburn 9273: if (defined($defmail)) {
9274: if ($defmail ne '') {
9275: push(@recipients,$defmail);
9276: }
1.618 raeburn 9277: }
9278: if ($otheremails) {
1.619 raeburn 9279: my @others;
9280: if ($otheremails =~ /,/) {
9281: @others = split(/,/,$otheremails);
1.618 raeburn 9282: } else {
1.619 raeburn 9283: push(@others,$otheremails);
9284: }
9285: foreach my $addr (@others) {
9286: if (!grep(/^\Q$addr\E$/,@recipients)) {
9287: push(@recipients,$addr);
9288: }
1.618 raeburn 9289: }
9290: }
1.619 raeburn 9291: my $recipientlist = join(',',@recipients);
1.618 raeburn 9292: return $recipientlist;
9293: }
9294:
1.127 matthew 9295: ############################################################
9296: ############################################################
1.154 albertel 9297:
1.655 raeburn 9298: =pod
9299:
9300: =head1 Course Catalog Routines
9301:
9302: =over 4
9303:
9304: =item * &gather_categories()
9305:
9306: Converts category definitions - keys of categories hash stored in
9307: coursecategories in configuration.db on the primary library server in a
9308: domain - to an array. Also generates javascript and idx hash used to
9309: generate Domain Coordinator interface for editing Course Categories.
9310:
9311: Inputs:
1.663 raeburn 9312:
1.655 raeburn 9313: categories (reference to hash of category definitions).
1.663 raeburn 9314:
1.655 raeburn 9315: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9316: categories and subcategories).
1.663 raeburn 9317:
1.655 raeburn 9318: idx (reference to hash of counters used in Domain Coordinator interface for
9319: editing Course Categories).
1.663 raeburn 9320:
1.655 raeburn 9321: jsarray (reference to array of categories used to create Javascript arrays for
9322: Domain Coordinator interface for editing Course Categories).
9323:
9324: Returns: nothing
9325:
9326: Side effects: populates cats, idx and jsarray.
9327:
9328: =cut
9329:
9330: sub gather_categories {
9331: my ($categories,$cats,$idx,$jsarray) = @_;
9332: my %counters;
9333: my $num = 0;
9334: foreach my $item (keys(%{$categories})) {
9335: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9336: if ($container eq '' && $depth == 0) {
9337: $cats->[$depth][$categories->{$item}] = $cat;
9338: } else {
9339: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9340: }
9341: my ($escitem,$tail) = split(/:/,$item,2);
9342: if ($counters{$tail} eq '') {
9343: $counters{$tail} = $num;
9344: $num ++;
9345: }
9346: if (ref($idx) eq 'HASH') {
9347: $idx->{$item} = $counters{$tail};
9348: }
9349: if (ref($jsarray) eq 'ARRAY') {
9350: push(@{$jsarray->[$counters{$tail}]},$item);
9351: }
9352: }
9353: return;
9354: }
9355:
9356: =pod
9357:
9358: =item * &extract_categories()
9359:
9360: Used to generate breadcrumb trails for course categories.
9361:
9362: Inputs:
1.663 raeburn 9363:
1.655 raeburn 9364: categories (reference to hash of category definitions).
1.663 raeburn 9365:
1.655 raeburn 9366: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9367: categories and subcategories).
1.663 raeburn 9368:
1.655 raeburn 9369: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9370:
1.655 raeburn 9371: allitems (reference to hash - key is category key
9372: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9373:
1.655 raeburn 9374: idx (reference to hash of counters used in Domain Coordinator interface for
9375: editing Course Categories).
1.663 raeburn 9376:
1.655 raeburn 9377: jsarray (reference to array of categories used to create Javascript arrays for
9378: Domain Coordinator interface for editing Course Categories).
9379:
1.665 raeburn 9380: subcats (reference to hash of arrays containing all subcategories within each
9381: category, -recursive)
9382:
1.655 raeburn 9383: Returns: nothing
9384:
9385: Side effects: populates trails and allitems hash references.
9386:
9387: =cut
9388:
9389: sub extract_categories {
1.665 raeburn 9390: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9391: if (ref($categories) eq 'HASH') {
9392: &gather_categories($categories,$cats,$idx,$jsarray);
9393: if (ref($cats->[0]) eq 'ARRAY') {
9394: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9395: my $name = $cats->[0][$i];
9396: my $item = &escape($name).'::0';
9397: my $trailstr;
9398: if ($name eq 'instcode') {
9399: $trailstr = &mt('Official courses (with institutional codes)');
9400: } else {
9401: $trailstr = $name;
9402: }
9403: if ($allitems->{$item} eq '') {
9404: push(@{$trails},$trailstr);
9405: $allitems->{$item} = scalar(@{$trails})-1;
9406: }
9407: my @parents = ($name);
9408: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9409: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9410: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9411: if (ref($subcats) eq 'HASH') {
9412: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9413: }
9414: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9415: }
9416: } else {
9417: if (ref($subcats) eq 'HASH') {
9418: $subcats->{$item} = [];
1.655 raeburn 9419: }
9420: }
9421: }
9422: }
9423: }
9424: return;
9425: }
9426:
9427: =pod
9428:
9429: =item *&recurse_categories()
9430:
9431: Recursively used to generate breadcrumb trails for course categories.
9432:
9433: Inputs:
1.663 raeburn 9434:
1.655 raeburn 9435: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9436: categories and subcategories).
1.663 raeburn 9437:
1.655 raeburn 9438: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9439:
9440: category (current course category, for which breadcrumb trail is being generated).
9441:
9442: trails (reference to array of breadcrumb trails for each category).
9443:
1.655 raeburn 9444: allitems (reference to hash - key is category key
9445: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9446:
1.655 raeburn 9447: parents (array containing containers directories for current category,
9448: back to top level).
9449:
9450: Returns: nothing
9451:
9452: Side effects: populates trails and allitems hash references
9453:
9454: =cut
9455:
9456: sub recurse_categories {
1.665 raeburn 9457: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9458: my $shallower = $depth - 1;
9459: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9460: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9461: my $name = $cats->[$depth]{$category}[$k];
9462: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9463: my $trailstr = join(' -> ',(@{$parents},$category));
9464: if ($allitems->{$item} eq '') {
9465: push(@{$trails},$trailstr);
9466: $allitems->{$item} = scalar(@{$trails})-1;
9467: }
9468: my $deeper = $depth+1;
9469: push(@{$parents},$category);
1.665 raeburn 9470: if (ref($subcats) eq 'HASH') {
9471: my $subcat = &escape($name).':'.$category.':'.$depth;
9472: for (my $j=@{$parents}; $j>=0; $j--) {
9473: my $higher;
9474: if ($j > 0) {
9475: $higher = &escape($parents->[$j]).':'.
9476: &escape($parents->[$j-1]).':'.$j;
9477: } else {
9478: $higher = &escape($parents->[$j]).'::'.$j;
9479: }
9480: push(@{$subcats->{$higher}},$subcat);
9481: }
9482: }
9483: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9484: $subcats);
1.655 raeburn 9485: pop(@{$parents});
9486: }
9487: } else {
9488: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9489: my $trailstr = join(' -> ',(@{$parents},$category));
9490: if ($allitems->{$item} eq '') {
9491: push(@{$trails},$trailstr);
9492: $allitems->{$item} = scalar(@{$trails})-1;
9493: }
9494: }
9495: return;
9496: }
9497:
1.663 raeburn 9498: =pod
9499:
9500: =item *&assign_categories_table()
9501:
9502: Create a datatable for display of hierarchical categories in a domain,
9503: with checkboxes to allow a course to be categorized.
9504:
9505: Inputs:
9506:
9507: cathash - reference to hash of categories defined for the domain (from
9508: configuration.db)
9509:
9510: currcat - scalar with an & separated list of categories assigned to a course.
9511:
9512: Returns: $output (markup to be displayed)
9513:
9514: =cut
9515:
9516: sub assign_categories_table {
9517: my ($cathash,$currcat) = @_;
9518: my $output;
9519: if (ref($cathash) eq 'HASH') {
9520: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9521: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9522: $maxdepth = scalar(@cats);
9523: if (@cats > 0) {
9524: my $itemcount = 0;
9525: if (ref($cats[0]) eq 'ARRAY') {
9526: $output = &Apache::loncommon::start_data_table();
9527: my @currcategories;
9528: if ($currcat ne '') {
9529: @currcategories = split('&',$currcat);
9530: }
9531: for (my $i=0; $i<@{$cats[0]}; $i++) {
9532: my $parent = $cats[0][$i];
9533: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9534: next if ($parent eq 'instcode');
9535: my $item = &escape($parent).'::0';
9536: my $checked = '';
9537: if (@currcategories > 0) {
9538: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9539: $checked = ' checked="checked"';
1.663 raeburn 9540: }
9541: }
1.675 raeburn 9542: $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9543: '<input type="checkbox" name="usecategory" value="'.
9544: $item.'"'.$checked.' />'.$parent.'</span>'.
9545: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9546: my $depth = 1;
9547: push(@path,$parent);
9548: $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
9549: pop(@path);
9550: $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
9551: $itemcount ++;
9552: }
9553: $output .= &Apache::loncommon::end_data_table();
9554: }
9555: }
9556: }
9557: return $output;
9558: }
9559:
9560: =pod
9561:
9562: =item *&assign_category_rows()
9563:
9564: Create a datatable row for display of nested categories in a domain,
9565: with checkboxes to allow a course to be categorized,called recursively.
9566:
9567: Inputs:
9568:
9569: itemcount - track row number for alternating colors
9570:
9571: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9572: categories and subcategories.
9573:
9574: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9575:
9576: parent - parent of current category item
9577:
9578: path - Array containing all categories back up through the hierarchy from the
9579: current category to the top level.
9580:
9581: currcategories - reference to array of current categories assigned to the course
9582:
9583: Returns: $output (markup to be displayed).
9584:
9585: =cut
9586:
9587: sub assign_category_rows {
9588: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9589: my ($text,$name,$item,$chgstr);
9590: if (ref($cats) eq 'ARRAY') {
9591: my $maxdepth = scalar(@{$cats});
9592: if (ref($cats->[$depth]) eq 'HASH') {
9593: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9594: my $numchildren = @{$cats->[$depth]{$parent}};
9595: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9596: $text .= '<td><table class="LC_datatable">';
9597: for (my $j=0; $j<$numchildren; $j++) {
9598: $name = $cats->[$depth]{$parent}[$j];
9599: $item = &escape($name).':'.&escape($parent).':'.$depth;
9600: my $deeper = $depth+1;
9601: my $checked = '';
9602: if (ref($currcategories) eq 'ARRAY') {
9603: if (@{$currcategories} > 0) {
9604: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9605: $checked = ' checked="checked"';
1.663 raeburn 9606: }
9607: }
9608: }
1.664 raeburn 9609: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9610: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9611: $item.'"'.$checked.' />'.$name.'</label></span>'.
9612: '<input type="hidden" name="catname" value="'.$name.'" />'.
9613: '</td><td>';
1.663 raeburn 9614: if (ref($path) eq 'ARRAY') {
9615: push(@{$path},$name);
9616: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9617: pop(@{$path});
9618: }
9619: $text .= '</td></tr>';
9620: }
9621: $text .= '</table></td>';
9622: }
9623: }
9624: }
9625: return $text;
9626: }
9627:
1.655 raeburn 9628: ############################################################
9629: ############################################################
9630:
9631:
1.443 albertel 9632: sub commit_customrole {
1.664 raeburn 9633: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9634: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9635: ($start?', '.&mt('starting').' '.localtime($start):'').
9636: ($end?', ending '.localtime($end):'').': <b>'.
9637: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9638: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9639: '</b><br />';
9640: return $output;
9641: }
9642:
9643: sub commit_standardrole {
1.541 raeburn 9644: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9645: my ($output,$logmsg,$linefeed);
9646: if ($context eq 'auto') {
9647: $linefeed = "\n";
9648: } else {
9649: $linefeed = "<br />\n";
9650: }
1.443 albertel 9651: if ($three eq 'st') {
1.541 raeburn 9652: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9653: $one,$two,$sec,$context);
9654: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9655: ($result eq 'unknown_course') || ($result eq 'refused')) {
9656: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9657: } else {
1.541 raeburn 9658: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9659: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9660: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9661: if ($context eq 'auto') {
9662: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9663: } else {
9664: $output .= '<b>'.$result.'</b>'.$linefeed.
9665: &mt('Add to classlist').': <b>ok</b>';
9666: }
9667: $output .= $linefeed;
1.443 albertel 9668: }
9669: } else {
9670: $output = &mt('Assigning').' '.$three.' in '.$url.
9671: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9672: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9673: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9674: if ($context eq 'auto') {
9675: $output .= $result.$linefeed;
9676: } else {
9677: $output .= '<b>'.$result.'</b>'.$linefeed;
9678: }
1.443 albertel 9679: }
9680: return $output;
9681: }
9682:
9683: sub commit_studentrole {
1.541 raeburn 9684: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9685: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9686: if ($context eq 'auto') {
9687: $linefeed = "\n";
9688: } else {
9689: $linefeed = '<br />'."\n";
9690: }
1.443 albertel 9691: if (defined($one) && defined($two)) {
9692: my $cid=$one.'_'.$two;
9693: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9694: my $secchange = 0;
9695: my $expire_role_result;
9696: my $modify_section_result;
1.628 raeburn 9697: if ($oldsec ne '-1') {
9698: if ($oldsec ne $sec) {
1.443 albertel 9699: $secchange = 1;
1.628 raeburn 9700: my $now = time;
1.443 albertel 9701: my $uurl='/'.$cid;
9702: $uurl=~s/\_/\//g;
9703: if ($oldsec) {
9704: $uurl.='/'.$oldsec;
9705: }
1.626 raeburn 9706: $oldsecurl = $uurl;
1.628 raeburn 9707: $expire_role_result =
1.652 raeburn 9708: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9709: if ($env{'request.course.sec'} ne '') {
9710: if ($expire_role_result eq 'refused') {
9711: my @roles = ('st');
9712: my @statuses = ('previous');
9713: my @roledoms = ($one);
9714: my $withsec = 1;
9715: my %roleshash =
9716: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9717: \@statuses,\@roles,\@roledoms,$withsec);
9718: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9719: my ($oldstart,$oldend) =
9720: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9721: if ($oldend > 0 && $oldend <= $now) {
9722: $expire_role_result = 'ok';
9723: }
9724: }
9725: }
9726: }
1.443 albertel 9727: $result = $expire_role_result;
9728: }
9729: }
9730: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9731: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9732: if ($modify_section_result =~ /^ok/) {
9733: if ($secchange == 1) {
1.628 raeburn 9734: if ($sec eq '') {
9735: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9736: } else {
9737: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9738: }
1.443 albertel 9739: } elsif ($oldsec eq '-1') {
1.628 raeburn 9740: if ($sec eq '') {
9741: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9742: } else {
9743: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9744: }
1.443 albertel 9745: } else {
1.628 raeburn 9746: if ($sec eq '') {
9747: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
9748: } else {
9749: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9750: }
1.443 albertel 9751: }
9752: } else {
1.628 raeburn 9753: if ($secchange) {
9754: $$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;
9755: } else {
9756: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
9757: }
1.443 albertel 9758: }
9759: $result = $modify_section_result;
9760: } elsif ($secchange == 1) {
1.628 raeburn 9761: if ($oldsec eq '') {
9762: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
9763: } else {
9764: $$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;
9765: }
1.626 raeburn 9766: if ($expire_role_result eq 'refused') {
9767: my $newsecurl = '/'.$cid;
9768: $newsecurl =~ s/\_/\//g;
9769: if ($sec ne '') {
9770: $newsecurl.='/'.$sec;
9771: }
9772: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
9773: if ($sec eq '') {
9774: $$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;
9775: } else {
9776: $$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;
9777: }
9778: }
9779: }
1.443 albertel 9780: }
9781: } else {
1.626 raeburn 9782: $$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 9783: $result = "error: incomplete course id\n";
9784: }
9785: return $result;
9786: }
9787:
9788: ############################################################
9789: ############################################################
9790:
1.566 albertel 9791: sub check_clone {
1.578 raeburn 9792: my ($args,$linefeed) = @_;
1.566 albertel 9793: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
9794: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
9795: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
9796: my $clonemsg;
9797: my $can_clone = 0;
9798:
9799: if ($clonehome eq 'no_host') {
1.578 raeburn 9800: $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 9801: } else {
9802: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568 albertel 9803: if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566 albertel 9804: $can_clone = 1;
9805: } else {
9806: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
9807: $args->{'clonedomain'},$args->{'clonecourse'});
9808: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 9809: if (grep(/^\*$/,@cloners)) {
9810: $can_clone = 1;
9811: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
9812: $can_clone = 1;
9813: } else {
9814: my %roleshash =
9815: &Apache::lonnet::get_my_roles($args->{'ccuname'},
9816: $args->{'ccdomain'},
9817: 'userroles',['active'],['cc'],
9818: [$args->{'clonedomain'}]);
9819: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
9820: $can_clone = 1;
9821: } else {
9822: $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'});
9823: }
1.566 albertel 9824: }
1.578 raeburn 9825: }
1.566 albertel 9826: }
9827: return ($can_clone, $clonemsg, $cloneid, $clonehome);
9828: }
9829:
1.444 albertel 9830: sub construct_course {
1.541 raeburn 9831: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444 albertel 9832: my $outcome;
1.541 raeburn 9833: my $linefeed = '<br />'."\n";
9834: if ($context eq 'auto') {
9835: $linefeed = "\n";
9836: }
1.566 albertel 9837:
9838: #
9839: # Are we cloning?
9840: #
9841: my ($can_clone, $clonemsg, $cloneid, $clonehome);
9842: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 9843: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 9844: if ($context ne 'auto') {
1.578 raeburn 9845: if ($clonemsg ne '') {
9846: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
9847: }
1.566 albertel 9848: }
9849: $outcome .= $clonemsg.$linefeed;
9850:
9851: if (!$can_clone) {
9852: return (0,$outcome);
9853: }
9854: }
9855:
1.444 albertel 9856: #
9857: # Open course
9858: #
9859: my $crstype = lc($args->{'crstype'});
9860: my %cenv=();
9861: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
9862: $args->{'cdescr'},
9863: $args->{'curl'},
9864: $args->{'course_home'},
9865: $args->{'nonstandard'},
9866: $args->{'crscode'},
9867: $args->{'ccuname'}.':'.
9868: $args->{'ccdomain'},
9869: $args->{'crstype'});
9870:
9871: # Note: The testing routines depend on this being output; see
9872: # Utils::Course. This needs to at least be output as a comment
9873: # if anyone ever decides to not show this, and Utils::Course::new
9874: # will need to be suitably modified.
1.541 raeburn 9875: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 9876: #
9877: # Check if created correctly
9878: #
1.479 albertel 9879: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 9880: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 9881: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 9882:
1.444 albertel 9883: #
1.566 albertel 9884: # Do the cloning
9885: #
9886: if ($can_clone && $cloneid) {
9887: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
9888: if ($context ne 'auto') {
9889: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
9890: }
9891: $outcome .= $clonemsg.$linefeed;
9892: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 9893: # Copy all files
1.637 www 9894: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 9895: # Restore URL
1.566 albertel 9896: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 9897: # Restore title
1.566 albertel 9898: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 9899: # Mark as cloned
1.566 albertel 9900: $cenv{'clonedfrom'}=$cloneid;
1.638 www 9901: # Need to clone grading mode
9902: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
9903: $cenv{'grading'}=$newenv{'grading'};
9904: # Do not clone these environment entries
9905: &Apache::lonnet::del('environment',
9906: ['default_enrollment_start_date',
9907: 'default_enrollment_end_date',
9908: 'question.email',
9909: 'policy.email',
9910: 'comment.email',
9911: 'pch.users.denied',
1.725 raeburn 9912: 'plc.users.denied',
9913: 'hidefromcat',
9914: 'categories'],
1.638 www 9915: $$crsudom,$$crsunum);
1.444 albertel 9916: }
1.566 albertel 9917:
1.444 albertel 9918: #
9919: # Set environment (will override cloned, if existing)
9920: #
9921: my @sections = ();
9922: my @xlists = ();
9923: if ($args->{'crstype'}) {
9924: $cenv{'type'}=$args->{'crstype'};
9925: }
9926: if ($args->{'crsid'}) {
9927: $cenv{'courseid'}=$args->{'crsid'};
9928: }
9929: if ($args->{'crscode'}) {
9930: $cenv{'internal.coursecode'}=$args->{'crscode'};
9931: }
9932: if ($args->{'crsquota'} ne '') {
9933: $cenv{'internal.coursequota'}=$args->{'crsquota'};
9934: } else {
9935: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
9936: }
9937: if ($args->{'ccuname'}) {
9938: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
9939: ':'.$args->{'ccdomain'};
9940: } else {
9941: $cenv{'internal.courseowner'} = $args->{'curruser'};
9942: }
9943: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
9944: if ($args->{'crssections'}) {
9945: $cenv{'internal.sectionnums'} = '';
9946: if ($args->{'crssections'} =~ m/,/) {
9947: @sections = split/,/,$args->{'crssections'};
9948: } else {
9949: $sections[0] = $args->{'crssections'};
9950: }
9951: if (@sections > 0) {
9952: foreach my $item (@sections) {
9953: my ($sec,$gp) = split/:/,$item;
9954: my $class = $args->{'crscode'}.$sec;
9955: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
9956: $cenv{'internal.sectionnums'} .= $item.',';
9957: unless ($addcheck eq 'ok') {
9958: push @badclasses, $class;
9959: }
9960: }
9961: $cenv{'internal.sectionnums'} =~ s/,$//;
9962: }
9963: }
9964: # do not hide course coordinator from staff listing,
9965: # even if privileged
9966: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9967: # add crosslistings
9968: if ($args->{'crsxlist'}) {
9969: $cenv{'internal.crosslistings'}='';
9970: if ($args->{'crsxlist'} =~ m/,/) {
9971: @xlists = split/,/,$args->{'crsxlist'};
9972: } else {
9973: $xlists[0] = $args->{'crsxlist'};
9974: }
9975: if (@xlists > 0) {
9976: foreach my $item (@xlists) {
9977: my ($xl,$gp) = split/:/,$item;
9978: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
9979: $cenv{'internal.crosslistings'} .= $item.',';
9980: unless ($addcheck eq 'ok') {
9981: push @badclasses, $xl;
9982: }
9983: }
9984: $cenv{'internal.crosslistings'} =~ s/,$//;
9985: }
9986: }
9987: if ($args->{'autoadds'}) {
9988: $cenv{'internal.autoadds'}=$args->{'autoadds'};
9989: }
9990: if ($args->{'autodrops'}) {
9991: $cenv{'internal.autodrops'}=$args->{'autodrops'};
9992: }
9993: # check for notification of enrollment changes
9994: my @notified = ();
9995: if ($args->{'notify_owner'}) {
9996: if ($args->{'ccuname'} ne '') {
9997: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
9998: }
9999: }
10000: if ($args->{'notify_dc'}) {
10001: if ($uname ne '') {
1.630 raeburn 10002: push(@notified,$uname.':'.$udom);
1.444 albertel 10003: }
10004: }
10005: if (@notified > 0) {
10006: my $notifylist;
10007: if (@notified > 1) {
10008: $notifylist = join(',',@notified);
10009: } else {
10010: $notifylist = $notified[0];
10011: }
10012: $cenv{'internal.notifylist'} = $notifylist;
10013: }
10014: if (@badclasses > 0) {
10015: my %lt=&Apache::lonlocal::texthash(
10016: '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',
10017: 'dnhr' => 'does not have rights to access enrollment in these classes',
10018: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10019: );
1.541 raeburn 10020: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10021: ' ('.$lt{'adby'}.')';
10022: if ($context eq 'auto') {
10023: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10024: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10025: foreach my $item (@badclasses) {
10026: if ($context eq 'auto') {
10027: $outcome .= " - $item\n";
10028: } else {
10029: $outcome .= "<li>$item</li>\n";
10030: }
10031: }
10032: if ($context eq 'auto') {
10033: $outcome .= $linefeed;
10034: } else {
1.566 albertel 10035: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10036: }
10037: }
1.444 albertel 10038: }
10039: if ($args->{'no_end_date'}) {
10040: $args->{'endaccess'} = 0;
10041: }
10042: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10043: $cenv{'internal.autoend'}=$args->{'enrollend'};
10044: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10045: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10046: if ($args->{'showphotos'}) {
10047: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10048: }
10049: $cenv{'internal.authtype'} = $args->{'authtype'};
10050: $cenv{'internal.autharg'} = $args->{'autharg'};
10051: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10052: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10053: 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');
10054: if ($context eq 'auto') {
10055: $outcome .= $krb_msg;
10056: } else {
1.566 albertel 10057: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10058: }
10059: $outcome .= $linefeed;
1.444 albertel 10060: }
10061: }
10062: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10063: if ($args->{'setpolicy'}) {
10064: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10065: }
10066: if ($args->{'setcontent'}) {
10067: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10068: }
10069: }
10070: if ($args->{'reshome'}) {
10071: $cenv{'reshome'}=$args->{'reshome'}.'/';
10072: $cenv{'reshome'}=~s/\/+$/\//;
10073: }
10074: #
10075: # course has keyed access
10076: #
10077: if ($args->{'setkeys'}) {
10078: $cenv{'keyaccess'}='yes';
10079: }
10080: # if specified, key authority is not course, but user
10081: # only active if keyaccess is yes
10082: if ($args->{'keyauth'}) {
1.487 albertel 10083: my ($user,$domain) = split(':',$args->{'keyauth'});
10084: $user = &LONCAPA::clean_username($user);
10085: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10086: if ($user ne '' && $domain ne '') {
1.487 albertel 10087: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10088: }
10089: }
10090:
10091: if ($args->{'disresdis'}) {
10092: $cenv{'pch.roles.denied'}='st';
10093: }
10094: if ($args->{'disablechat'}) {
10095: $cenv{'plc.roles.denied'}='st';
10096: }
10097:
10098: # Record we've not yet viewed the Course Initialization Helper for this
10099: # course
10100: $cenv{'course.helper.not.run'} = 1;
10101: #
10102: # Use new Randomseed
10103: #
10104: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10105: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10106: #
10107: # The encryption code and receipt prefix for this course
10108: #
10109: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10110: $cenv{'internal.encpref'}=100+int(9*rand(99));
10111: #
10112: # By default, use standard grading
10113: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10114:
1.541 raeburn 10115: $outcome .= $linefeed.&mt('Setting environment').': '.
10116: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10117: #
10118: # Open all assignments
10119: #
10120: if ($args->{'openall'}) {
10121: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10122: my %storecontent = ($storeunder => time,
10123: $storeunder.'.type' => 'date_start');
10124:
10125: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 10126: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10127: }
10128: #
10129: # Set first page
10130: #
10131: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10132: || ($cloneid)) {
1.445 albertel 10133: use LONCAPA::map;
1.444 albertel 10134: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 10135:
10136: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10137: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10138:
1.444 albertel 10139: $outcome .= ($fatal?$errtext:'read ok').' - ';
10140: my $title; my $url;
10141: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 10142: $title=&mt('Syllabus');
1.444 albertel 10143: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10144: } else {
1.690 bisitz 10145: $title=&mt('Navigate Contents');
1.444 albertel 10146: $url='/adm/navmaps';
10147: }
1.445 albertel 10148:
10149: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10150: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10151:
10152: if ($errtext) { $fatal=2; }
1.541 raeburn 10153: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 10154: }
1.566 albertel 10155:
10156: return (1,$outcome);
1.444 albertel 10157: }
10158:
10159: ############################################################
10160: ############################################################
10161:
1.378 raeburn 10162: sub course_type {
10163: my ($cid) = @_;
10164: if (!defined($cid)) {
10165: $cid = $env{'request.course.id'};
10166: }
1.404 albertel 10167: if (defined($env{'course.'.$cid.'.type'})) {
10168: return $env{'course.'.$cid.'.type'};
1.378 raeburn 10169: } else {
10170: return 'Course';
1.377 raeburn 10171: }
10172: }
1.156 albertel 10173:
1.406 raeburn 10174: sub group_term {
10175: my $crstype = &course_type();
10176: my %names = (
10177: 'Course' => 'group',
10178: 'Group' => 'team',
10179: );
10180: return $names{$crstype};
10181: }
10182:
1.156 albertel 10183: sub icon {
10184: my ($file)=@_;
1.505 albertel 10185: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 10186: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 10187: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 10188: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10189: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10190: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10191: $curfext.".gif") {
10192: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10193: $curfext.".gif";
10194: }
10195: }
1.249 albertel 10196: return &lonhttpdurl($iconname);
1.154 albertel 10197: }
1.84 albertel 10198:
1.575 albertel 10199: sub lonhttpdurl {
1.692 www 10200: #
10201: # Had been used for "small fry" static images on separate port 8080.
10202: # Modify here if lightweight http functionality desired again.
10203: # Currently eliminated due to increasing firewall issues.
10204: #
1.575 albertel 10205: my ($url)=@_;
1.692 www 10206: return $url;
1.215 albertel 10207: }
10208:
1.213 albertel 10209: sub connection_aborted {
10210: my ($r)=@_;
10211: $r->print(" ");$r->rflush();
10212: my $c = $r->connection;
10213: return $c->aborted();
10214: }
10215:
1.221 foxr 10216: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 10217: # strings as 'strings'.
10218: sub escape_single {
1.221 foxr 10219: my ($input) = @_;
1.223 albertel 10220: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 10221: $input =~ s/\'/\\\'/g; # Esacpe the 's....
10222: return $input;
10223: }
1.223 albertel 10224:
1.222 foxr 10225: # Same as escape_single, but escape's "'s This
10226: # can be used for "strings"
10227: sub escape_double {
10228: my ($input) = @_;
10229: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
10230: $input =~ s/\"/\\\"/g; # Esacpe the "s....
10231: return $input;
10232: }
1.223 albertel 10233:
1.222 foxr 10234: # Escapes the last element of a full URL.
10235: sub escape_url {
10236: my ($url) = @_;
1.238 raeburn 10237: my @urlslices = split(/\//, $url,-1);
1.369 www 10238: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 10239: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 10240: }
1.462 albertel 10241:
10242: # -------------------------------------------------------- Initliaze user login
10243: sub init_user_environment {
1.463 albertel 10244: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 10245: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
10246:
10247: my $public=($username eq 'public' && $domain eq 'public');
10248:
10249: # See if old ID present, if so, remove
10250:
10251: my ($filename,$cookie,$userroles);
10252: my $now=time;
10253:
10254: if ($public) {
10255: my $max_public=100;
10256: my $oldest;
10257: my $oldest_time=0;
10258: for(my $next=1;$next<=$max_public;$next++) {
10259: if (-e $lonids."/publicuser_$next.id") {
10260: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
10261: if ($mtime<$oldest_time || !$oldest_time) {
10262: $oldest_time=$mtime;
10263: $oldest=$next;
10264: }
10265: } else {
10266: $cookie="publicuser_$next";
10267: last;
10268: }
10269: }
10270: if (!$cookie) { $cookie="publicuser_$oldest"; }
10271: } else {
1.463 albertel 10272: # if this isn't a robot, kill any existing non-robot sessions
10273: if (!$args->{'robot'}) {
10274: opendir(DIR,$lonids);
10275: while ($filename=readdir(DIR)) {
10276: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10277: unlink($lonids.'/'.$filename);
10278: }
1.462 albertel 10279: }
1.463 albertel 10280: closedir(DIR);
1.462 albertel 10281: }
10282: # Give them a new cookie
1.463 albertel 10283: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10284: : $now.$$.int(rand(10000)));
1.463 albertel 10285: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10286:
10287: # Initialize roles
10288:
10289: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10290: }
10291: # ------------------------------------ Check browser type and MathML capability
10292:
10293: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10294: $clientunicode,$clientos) = &decode_user_agent($r);
10295:
10296: # -------------------------------------- Any accessibility options to remember?
10297: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
10298: foreach my $option ('imagesuppress','appletsuppress',
10299: 'embedsuppress','fontenhance','blackwhite') {
10300: if ($form->{$option} eq 'true') {
10301: &Apache::lonnet::put('environment',{$option => 'on'},
10302: $domain,$username);
10303: } else {
10304: &Apache::lonnet::del('environment',[$option],
10305: $domain,$username);
10306: }
10307: }
10308: }
10309: # ------------------------------------------------------------- Get environment
10310:
10311: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10312: my ($tmp) = keys(%userenv);
10313: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10314: # default remote control to off
10315: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
10316: } else {
10317: undef(%userenv);
10318: }
10319: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10320: $form->{'interface'}=$userenv{'interface'};
10321: }
10322: $env{'environment.remote'}=$userenv{'remote'};
10323: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10324:
10325: # --------------- Do not trust query string to be put directly into environment
10326: foreach my $option ('imagesuppress','appletsuppress',
10327: 'embedsuppress','fontenhance','blackwhite',
10328: 'interface','localpath','localres') {
10329: $form->{$option}=~s/[\n\r\=]//gs;
10330: }
10331: # --------------------------------------------------------- Write first profile
10332:
10333: {
10334: my %initial_env =
10335: ("user.name" => $username,
10336: "user.domain" => $domain,
10337: "user.home" => $authhost,
10338: "browser.type" => $clientbrowser,
10339: "browser.version" => $clientversion,
10340: "browser.mathml" => $clientmathml,
10341: "browser.unicode" => $clientunicode,
10342: "browser.os" => $clientos,
10343: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10344: "request.course.fn" => '',
10345: "request.course.uri" => '',
10346: "request.course.sec" => '',
10347: "request.role" => 'cm',
10348: "request.role.adv" => $env{'user.adv'},
10349: "request.host" => $ENV{'REMOTE_ADDR'},);
10350:
10351: if ($form->{'localpath'}) {
10352: $initial_env{"browser.localpath"} = $form->{'localpath'};
10353: $initial_env{"browser.localres"} = $form->{'localres'};
10354: }
10355:
10356: if ($public) {
10357: $initial_env{"environment.remote"} = "off";
10358: }
10359: if ($form->{'interface'}) {
10360: $form->{'interface'}=~s/\W//gs;
10361: $initial_env{"browser.interface"} = $form->{'interface'};
10362: $env{'browser.interface'}=$form->{'interface'};
10363: foreach my $option ('imagesuppress','appletsuppress',
10364: 'embedsuppress','fontenhance','blackwhite') {
10365: if (($form->{$option} eq 'true') ||
10366: ($userenv{$option} eq 'on')) {
10367: $initial_env{"browser.$option"} = "on";
10368: }
10369: }
10370: }
10371:
1.724 raeburn 10372: foreach my $tool ('aboutme','blog','portfolio') {
10373: $userenv{'availabletools.'.$tool} =
10374: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10375: }
10376:
1.765 raeburn 10377: foreach my $crstype ('official','unofficial') {
10378: $userenv{'canrequest.'.$crstype} =
10379: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10380: 'reload','requestcourses');
10381: }
10382:
1.462 albertel 10383: $env{'user.environment'} = "$lonids/$cookie.id";
10384:
10385: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10386: &GDBM_WRCREAT(),0640)) {
10387: &_add_to_env(\%disk_env,\%initial_env);
10388: &_add_to_env(\%disk_env,\%userenv,'environment.');
10389: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10390: if (ref($args->{'extra_env'})) {
10391: &_add_to_env(\%disk_env,$args->{'extra_env'});
10392: }
1.462 albertel 10393: untie(%disk_env);
10394: } else {
1.705 tempelho 10395: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10396: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10397: return 'error: '.$!;
10398: }
10399: }
10400: $env{'request.role'}='cm';
10401: $env{'request.role.adv'}=$env{'user.adv'};
10402: $env{'browser.type'}=$clientbrowser;
10403:
10404: return $cookie;
10405:
10406: }
10407:
10408: sub _add_to_env {
10409: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10410: if (ref($env_data) eq 'HASH') {
10411: while (my ($key,$value) = each(%$env_data)) {
10412: $idf->{$prefix.$key} = $value;
10413: $env{$prefix.$key} = $value;
10414: }
1.462 albertel 10415: }
10416: }
10417:
1.685 tempelho 10418: # --- Get the symbolic name of a problem and the url
10419: sub get_symb {
10420: my ($request,$silent) = @_;
1.726 raeburn 10421: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10422: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10423: if ($symb eq '') {
10424: if (!$silent) {
10425: $request->print("Unable to handle ambiguous references:$url:.");
10426: return ();
10427: }
10428: }
10429: &Apache::lonenc::check_decrypt(\$symb);
10430: return ($symb);
10431: }
10432:
10433: # --------------------------------------------------------------Get annotation
10434:
10435: sub get_annotation {
10436: my ($symb,$enc) = @_;
10437:
10438: my $key = $symb;
10439: if (!$enc) {
10440: $key =
10441: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10442: }
10443: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10444: return $annotation{$key};
10445: }
10446:
10447: sub clean_symb {
1.731 raeburn 10448: my ($symb,$delete_enc) = @_;
1.685 tempelho 10449:
10450: &Apache::lonenc::check_decrypt(\$symb);
10451: my $enc = $env{'request.enc'};
1.731 raeburn 10452: if ($delete_enc) {
1.730 raeburn 10453: delete($env{'request.enc'});
10454: }
1.685 tempelho 10455:
10456: return ($symb,$enc);
10457: }
1.462 albertel 10458:
1.41 ng 10459: =pod
10460:
10461: =back
10462:
1.112 bowersj2 10463: =cut
1.41 ng 10464:
1.112 bowersj2 10465: 1;
10466: __END__;
1.41 ng 10467:
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