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