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