Annotation of loncom/interface/loncommon.pm, revision 1.708
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.708 ! bisitz 4: # $Id: loncommon.pm,v 1.707 2008/12/04 16:56:50 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');
409: <script type="text/javascript" language="Javascript" >
410: var stdeditbrowser;
1.558 albertel 411: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter) {
1.74 www 412: var url = '/adm/pickstudent?';
413: var filter;
1.558 albertel 414: if (!ignorefilter) {
415: eval('filter=document.'+formname+'.'+uname+'.value;');
416: }
1.74 www 417: if (filter != null) {
418: if (filter != '') {
419: url += 'filter='+filter+'&';
420: }
421: }
422: url += 'form=' + formname + '&unameelement='+uname+
423: '&udomelement='+udom;
1.111 www 424: if (roleflag) { url+="&roles=1"; }
1.102 www 425: var title = 'Student_Browser';
1.74 www 426: var options = 'scrollbars=1,resizable=1,menubar=0';
427: options += ',width=700,height=600';
428: stdeditbrowser = open(url,title,options,'1');
429: stdeditbrowser.focus();
430: }
431: </script>
432: ENDSTDBRW
433: }
1.42 matthew 434:
1.74 www 435: sub selectstudent_link {
1.111 www 436: my ($form,$unameele,$udomele)=@_;
1.258 albertel 437: if ($env{'request.course.id'}) {
1.302 albertel 438: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
439: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
440: '/'.$env{'request.course.sec'})) {
1.111 www 441: return '';
442: }
443: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.607 albertel 444: '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
1.74 www 445: }
1.258 albertel 446: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.111 www 447: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.119 www 448: '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
1.111 www 449: }
450: return '';
1.91 www 451: }
452:
1.653 raeburn 453: sub authorbrowser_javascript {
454: return <<"ENDAUTHORBRW";
455: <script type="text/javascript">
456: var stdeditbrowser;
457:
458: function openauthorbrowser(formname,udom) {
459: var url = '/adm/pickauthor?';
460: url += 'form='+formname+'&roledom='+udom;
461: var title = 'Author_Browser';
462: var options = 'scrollbars=1,resizable=1,menubar=0';
463: options += ',width=700,height=600';
464: stdeditbrowser = open(url,title,options,'1');
465: stdeditbrowser.focus();
466: }
467:
468: </script>
469: ENDAUTHORBRW
470: }
471:
1.91 www 472: sub coursebrowser_javascript {
1.468 raeburn 473: my ($domainfilter,$sec_element,$formname)=@_;
1.377 raeburn 474: my $crs_or_grp_alert = &mt('Please select the type of LON-CAPA entity - Course or Group - for which you wish to add/modify a user role');
1.468 raeburn 475: my $output = '
1.538 albertel 476: <script type="text/javascript">
1.468 raeburn 477: var stdeditbrowser;'."\n";
478: $output .= <<"ENDSTDBRW";
1.377 raeburn 479: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
1.91 www 480: var url = '/adm/pickcourse?';
1.468 raeburn 481: var domainfilter = '';
482: var formid = getFormIdByName(formname);
483: if (formid > -1) {
484: var domid = getIndexByName(formid,udom);
485: if (domid > -1) {
486: if (document.forms[formid].elements[domid].type == 'select-one') {
487: domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
488: }
489: if (document.forms[formid].elements[domid].type == 'hidden') {
490: domainfilter=document.forms[formid].elements[domid].value;
491: }
492: }
1.91 www 493: }
1.128 albertel 494: if (domainfilter != null) {
495: if (domainfilter != '') {
496: url += 'domainfilter='+domainfilter+'&';
497: }
498: }
1.91 www 499: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 500: '&cdomelement='+udom+
501: '&cnameelement='+desc;
1.468 raeburn 502: if (extra_element !=null && extra_element != '') {
1.594 raeburn 503: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 504: url += '&roleelement='+extra_element;
505: if (domainfilter == null || domainfilter == '') {
506: url += '&domainfilter='+extra_element;
507: }
1.234 raeburn 508: }
1.468 raeburn 509: else {
510: if (formname == 'portform') {
511: url += '&setroles='+extra_element;
512: }
513: }
1.230 raeburn 514: }
1.293 raeburn 515: if (multflag !=null && multflag != '') {
516: url += '&multiple='+multflag;
517: }
1.377 raeburn 518: if (crstype == 'Course/Group') {
519: if (formname == 'cu') {
520: crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value;
521: if (crstype == "") {
522: alert("$crs_or_grp_alert");
523: return;
524: }
525: }
526: }
527: if (crstype !=null && crstype != '') {
528: url += '&type='+crstype;
529: }
1.102 www 530: var title = 'Course_Browser';
1.91 www 531: var options = 'scrollbars=1,resizable=1,menubar=0';
532: options += ',width=700,height=600';
533: stdeditbrowser = open(url,title,options,'1');
534: stdeditbrowser.focus();
535: }
1.468 raeburn 536:
537: function getFormIdByName(formname) {
538: for (var i=0;i<document.forms.length;i++) {
539: if (document.forms[i].name == formname) {
540: return i;
541: }
542: }
543: return -1;
544: }
545:
546: function getIndexByName(formid,item) {
547: for (var i=0;i<document.forms[formid].elements.length;i++) {
548: if (document.forms[formid].elements[i].name == item) {
549: return i;
550: }
551: }
552: return -1;
553: }
1.91 www 554: ENDSTDBRW
1.468 raeburn 555: if ($sec_element ne '') {
556: $output .= &setsec_javascript($sec_element,$formname);
557: }
558: $output .= '
559: </script>';
560: return $output;
561: }
562:
563: sub setsec_javascript {
564: my ($sec_element,$formname) = @_;
565: my $setsections = qq|
566: function setSect(sectionlist) {
1.629 raeburn 567: var sectionsArray = new Array();
568: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
569: sectionsArray = sectionlist.split(",");
570: }
1.468 raeburn 571: var numSections = sectionsArray.length;
572: document.$formname.$sec_element.length = 0;
573: if (numSections == 0) {
574: document.$formname.$sec_element.multiple=false;
575: document.$formname.$sec_element.size=1;
576: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
577: } else {
578: if (numSections == 1) {
579: document.$formname.$sec_element.multiple=false;
580: document.$formname.$sec_element.size=1;
581: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
582: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
583: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
584: } else {
585: for (var i=0; i<numSections; i++) {
586: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
587: }
588: document.$formname.$sec_element.multiple=true
589: if (numSections < 3) {
590: document.$formname.$sec_element.size=numSections;
591: } else {
592: document.$formname.$sec_element.size=3;
593: }
594: document.$formname.$sec_element.options[0].selected = false
595: }
596: }
1.91 www 597: }
1.468 raeburn 598: |;
599: return $setsections;
600: }
601:
1.91 www 602:
603: sub selectcourse_link {
1.377 raeburn 604: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.492 albertel 605: return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
606: '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'","'.$selecttype.'");'."'>".&mt('Select Course')."</a>";
1.74 www 607: }
1.42 matthew 608:
1.653 raeburn 609: sub selectauthor_link {
610: my ($form,$udom)=@_;
611: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
612: &mt('Select Author').'</a>';
613: }
614:
1.273 raeburn 615: sub check_uncheck_jscript {
616: my $jscript = <<"ENDSCRT";
617: function checkAll(field) {
618: if (field.length > 0) {
619: for (i = 0; i < field.length; i++) {
620: field[i].checked = true ;
621: }
622: } else {
623: field.checked = true
624: }
625: }
626:
627: function uncheckAll(field) {
628: if (field.length > 0) {
629: for (i = 0; i < field.length; i++) {
630: field[i].checked = false ;
1.543 albertel 631: }
632: } else {
1.273 raeburn 633: field.checked = false ;
634: }
635: }
636: ENDSCRT
637: return $jscript;
638: }
639:
1.656 www 640: sub select_timezone {
1.659 raeburn 641: my ($name,$selected,$onchange,$includeempty)=@_;
642: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
643: if ($includeempty) {
644: $output .= '<option value=""';
645: if (($selected eq '') || ($selected eq 'local')) {
646: $output .= ' selected="selected" ';
647: }
648: $output .= '> </option>';
649: }
1.657 raeburn 650: my @timezones = DateTime::TimeZone->all_names;
651: foreach my $tzone (@timezones) {
652: $output.= '<option value="'.$tzone.'"';
653: if ($tzone eq $selected) {
654: $output.=' selected="selected"';
655: }
656: $output.=">$tzone</option>\n";
1.656 www 657: }
658: $output.="</select>";
659: return $output;
660: }
1.273 raeburn 661:
1.687 raeburn 662: sub select_datelocale {
663: my ($name,$selected,$onchange,$includeempty)=@_;
664: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
665: if ($includeempty) {
666: $output .= '<option value=""';
667: if ($selected eq '') {
668: $output .= ' selected="selected" ';
669: }
670: $output .= '> </option>';
671: }
672: my (@possibles,%locale_names);
673: my @locales = DateTime::Locale::Catalog::Locales;
674: foreach my $locale (@locales) {
675: if (ref($locale) eq 'HASH') {
676: my $id = $locale->{'id'};
677: if ($id ne '') {
678: my $en_terr = $locale->{'en_territory'};
679: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 680: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 681: if (grep(/^en$/,@languages) || !@languages) {
682: if ($en_terr ne '') {
683: $locale_names{$id} = '('.$en_terr.')';
684: } elsif ($native_terr ne '') {
685: $locale_names{$id} = $native_terr;
686: }
687: } else {
688: if ($native_terr ne '') {
689: $locale_names{$id} = $native_terr.' ';
690: } elsif ($en_terr ne '') {
691: $locale_names{$id} = '('.$en_terr.')';
692: }
693: }
694: push (@possibles,$id);
695: }
696: }
697: }
698: foreach my $item (sort(@possibles)) {
699: $output.= '<option value="'.$item.'"';
700: if ($item eq $selected) {
701: $output.=' selected="selected"';
702: }
703: $output.=">$item";
704: if ($locale_names{$item} ne '') {
705: $output.=" $locale_names{$item}</option>\n";
706: }
707: $output.="</option>\n";
708: }
709: $output.="</select>";
710: return $output;
711: }
712:
1.42 matthew 713: =pod
1.36 matthew 714:
1.648 raeburn 715: =item * &linked_select_forms(...)
1.36 matthew 716:
717: linked_select_forms returns a string containing a <script></script> block
718: and html for two <select> menus. The select menus will be linked in that
719: changing the value of the first menu will result in new values being placed
720: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 721: order unless a defined order is provided.
1.36 matthew 722:
723: linked_select_forms takes the following ordered inputs:
724:
725: =over 4
726:
1.112 bowersj2 727: =item * $formname, the name of the <form> tag
1.36 matthew 728:
1.112 bowersj2 729: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 730:
1.112 bowersj2 731: =item * $firstdefault, the default value for the first menu
1.36 matthew 732:
1.112 bowersj2 733: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 734:
1.112 bowersj2 735: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 736:
1.112 bowersj2 737: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 738:
1.609 raeburn 739: =item * $menuorder, the order of values in the first menu
740:
1.41 ng 741: =back
742:
1.36 matthew 743: Below is an example of such a hash. Only the 'text', 'default', and
744: 'select2' keys must appear as stated. keys(%menu) are the possible
745: values for the first select menu. The text that coincides with the
1.41 ng 746: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 747: and text for the second menu are given in the hash pointed to by
748: $menu{$choice1}->{'select2'}.
749:
1.112 bowersj2 750: my %menu = ( A1 => { text =>"Choice A1" ,
751: default => "B3",
752: select2 => {
753: B1 => "Choice B1",
754: B2 => "Choice B2",
755: B3 => "Choice B3",
756: B4 => "Choice B4"
1.609 raeburn 757: },
758: order => ['B4','B3','B1','B2'],
1.112 bowersj2 759: },
760: A2 => { text =>"Choice A2" ,
761: default => "C2",
762: select2 => {
763: C1 => "Choice C1",
764: C2 => "Choice C2",
765: C3 => "Choice C3"
1.609 raeburn 766: },
767: order => ['C2','C1','C3'],
1.112 bowersj2 768: },
769: A3 => { text =>"Choice A3" ,
770: default => "D6",
771: select2 => {
772: D1 => "Choice D1",
773: D2 => "Choice D2",
774: D3 => "Choice D3",
775: D4 => "Choice D4",
776: D5 => "Choice D5",
777: D6 => "Choice D6",
778: D7 => "Choice D7"
1.609 raeburn 779: },
780: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 781: }
782: );
1.36 matthew 783:
784: =cut
785:
786: sub linked_select_forms {
787: my ($formname,
788: $middletext,
789: $firstdefault,
790: $firstselectname,
791: $secondselectname,
1.609 raeburn 792: $hashref,
793: $menuorder,
1.36 matthew 794: ) = @_;
795: my $second = "document.$formname.$secondselectname";
796: my $first = "document.$formname.$firstselectname";
797: # output the javascript to do the changing
798: my $result = '';
1.219 albertel 799: $result.="<script type=\"text/javascript\">\n";
1.36 matthew 800: $result.="var select2data = new Object();\n";
801: $" = '","';
802: my $debug = '';
803: foreach my $s1 (sort(keys(%$hashref))) {
804: $result.="select2data.d_$s1 = new Object();\n";
805: $result.="select2data.d_$s1.def = new String('".
806: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 807: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 808: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 809: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
810: @s2values = @{$hashref->{$s1}->{'order'}};
811: }
1.36 matthew 812: $result.="\"@s2values\");\n";
813: $result.="select2data.d_$s1.texts = new Array(";
814: my @s2texts;
815: foreach my $value (@s2values) {
816: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
817: }
818: $result.="\"@s2texts\");\n";
819: }
820: $"=' ';
821: $result.= <<"END";
822:
823: function select1_changed() {
824: // Determine new choice
825: var newvalue = "d_" + $first.value;
826: // update select2
827: var values = select2data[newvalue].values;
828: var texts = select2data[newvalue].texts;
829: var select2def = select2data[newvalue].def;
830: var i;
831: // out with the old
832: for (i = 0; i < $second.options.length; i++) {
833: $second.options[i] = null;
834: }
835: // in with the nuclear
836: for (i=0;i<values.length; i++) {
837: $second.options[i] = new Option(values[i]);
1.143 matthew 838: $second.options[i].value = values[i];
1.36 matthew 839: $second.options[i].text = texts[i];
840: if (values[i] == select2def) {
841: $second.options[i].selected = true;
842: }
843: }
844: }
845: </script>
846: END
847: # output the initial values for the selection lists
848: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 849: my @order = sort(keys(%{$hashref}));
850: if (ref($menuorder) eq 'ARRAY') {
851: @order = @{$menuorder};
852: }
853: foreach my $value (@order) {
1.36 matthew 854: $result.=" <option value=\"$value\" ";
1.253 albertel 855: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 856: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 857: }
858: $result .= "</select>\n";
859: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
860: $result .= $middletext;
861: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
862: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 863:
864: my @secondorder = sort(keys(%select2));
865: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
866: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
867: }
868: foreach my $value (@secondorder) {
1.36 matthew 869: $result.=" <option value=\"$value\" ";
1.253 albertel 870: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 871: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 872: }
873: $result .= "</select>\n";
874: # return $debug;
875: return $result;
876: } # end of sub linked_select_forms {
877:
1.45 matthew 878: =pod
1.44 bowersj2 879:
1.648 raeburn 880: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44 bowersj2 881:
1.112 bowersj2 882: Returns a string corresponding to an HTML link to the given help
883: $topic, where $topic corresponds to the name of a .tex file in
884: /home/httpd/html/adm/help/tex, with underscores replaced by
885: spaces.
886:
887: $text will optionally be linked to the same topic, allowing you to
888: link text in addition to the graphic. If you do not want to link
889: text, but wish to specify one of the later parameters, pass an
890: empty string.
891:
892: $stayOnPage is a value that will be interpreted as a boolean. If true,
893: the link will not open a new window. If false, the link will open
894: a new window using Javascript. (Default is false.)
895:
896: $width and $height are optional numerical parameters that will
897: override the width and height of the popped up window, which may
898: be useful for certain help topics with big pictures included.
1.44 bowersj2 899:
900: =cut
901:
902: sub help_open_topic {
1.48 bowersj2 903: my ($topic, $text, $stayOnPage, $width, $height) = @_;
904: $text = "" if (not defined $text);
1.44 bowersj2 905: $stayOnPage = 0 if (not defined $stayOnPage);
1.552 banghart 906: if ($env{'browser.interface'} eq 'textual') {
1.79 www 907: $stayOnPage=1;
908: }
1.44 bowersj2 909: $width = 350 if (not defined $width);
910: $height = 400 if (not defined $height);
911: my $filename = $topic;
912: $filename =~ s/ /_/g;
913:
1.48 bowersj2 914: my $template = "";
915: my $link;
1.572 banghart 916:
1.159 www 917: $topic=~s/\W/\_/g;
1.44 bowersj2 918:
1.572 banghart 919: if (!$stayOnPage) {
1.72 bowersj2 920: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 921: } else {
1.48 bowersj2 922: $link = "/adm/help/${filename}.hlp";
923: }
924:
925: # Add the text
1.572 banghart 926: if ($text ne "") {
1.77 www 927: $template .=
1.572 banghart 928: "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 929: "<td bgcolor='#5555FF'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.48 bowersj2 930: }
931:
932: # Add the graphic
1.179 matthew 933: my $title = &mt('Online Help');
1.667 raeburn 934: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.48 bowersj2 935: $template .= <<"ENDTEMPLATE";
1.436 albertel 936: <a target="_top" href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
1.44 bowersj2 937: ENDTEMPLATE
1.705 tempelho 938: if ($text ne '') { $template.='</td></tr></table>' };
1.44 bowersj2 939: return $template;
940:
1.106 bowersj2 941: }
942:
943: # This is a quicky function for Latex cheatsheet editing, since it
944: # appears in at least four places
945: sub helpLatexCheatsheet {
946: my $other = shift;
947: my $addOther = '';
948: if ($other) {
949: $addOther = Apache::loncommon::help_open_topic($other, shift,
950: undef, undef, 600) .
951: '</td><td>';
952: }
953: return '<table><tr><td>'.
954: $addOther .
1.636 raeburn 955: &Apache::loncommon::help_open_topic("Greek_Symbols",&mt('Greek Symbols'),
1.106 bowersj2 956: undef,undef,600)
957: .'</td><td>'.
1.636 raeburn 958: &Apache::loncommon::help_open_topic("Other_Symbols",&mt('Other Symbols'),
1.106 bowersj2 959: undef,undef,600)
1.673 felicia 960: .'</td><td>'.
961: &Apache::loncommon::help_open_topic("Authoring_Output_Tags",&mt('Output Tags'),
962: undef,undef,600)
1.106 bowersj2 963: .'</td></tr></table>';
1.172 www 964: }
965:
1.430 albertel 966: sub general_help {
967: my $helptopic='Student_Intro';
968: if ($env{'request.role'}=~/^(ca|au)/) {
969: $helptopic='Authoring_Intro';
970: } elsif ($env{'request.role'}=~/^cc/) {
971: $helptopic='Course_Coordination_Intro';
1.672 raeburn 972: } elsif ($env{'request.role'}=~/^dc/) {
973: $helptopic='Domain_Coordination_Intro';
1.430 albertel 974: }
975: return $helptopic;
976: }
977:
978: sub update_help_link {
979: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
980: my $origurl = $ENV{'REQUEST_URI'};
981: $origurl=~s|^/~|/priv/|;
982: my $timestamp = time;
983: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
984: $$datum = &escape($$datum);
985: }
986:
987: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
988: my $output .= <<"ENDOUTPUT";
989: <script type="text/javascript">
990: banner_link = '$banner_link';
991: </script>
992: ENDOUTPUT
993: return $output;
994: }
995:
996: # now just updates the help link and generates a blue icon
1.193 raeburn 997: sub help_open_menu {
1.430 albertel 998: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 999: = @_;
1.430 albertel 1000: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 1001: # only use pop-up help (stayOnPage == 0)
1.552 banghart 1002: # if environment.remote is on (using remote control UI)
1.572 banghart 1003: if ($env{'browser.interface'} eq 'textual' ||
1004: $env{'environment.remote'} eq 'off' ) {
1.552 banghart 1005: $stayOnPage=1;
1.430 albertel 1006: }
1007: my $output;
1008: if ($component_help) {
1009: if (!$text) {
1010: $output=&help_open_topic($component_help,undef,$stayOnPage,
1011: $width,$height);
1012: } else {
1013: my $help_text;
1014: $help_text=&unescape($topic);
1015: $output='<table><tr><td>'.
1016: &help_open_topic($component_help,$help_text,$stayOnPage,
1017: $width,$height).'</td></tr></table>';
1018: }
1019: }
1020: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1021: return $output.$banner_link;
1022: }
1023:
1024: sub top_nav_help {
1025: my ($text) = @_;
1.436 albertel 1026: $text = &mt($text);
1.572 banghart 1027: my $stay_on_page =
1.436 albertel 1028: ($env{'browser.interface'} eq 'textual' ||
1029: $env{'environment.remote'} eq 'off' );
1.572 banghart 1030: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1031: : "javascript:helpMenu('open')";
1.572 banghart 1032: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1033:
1.201 raeburn 1034: my $title = &mt('Get help');
1.436 albertel 1035:
1036: return <<"END";
1037: $banner_link
1038: <a href="$link" title="$title">$text</a>
1039: END
1040: }
1041:
1042: sub help_menu_js {
1043: my ($text) = @_;
1044:
1045: my $stayOnPage =
1046: ($env{'browser.interface'} eq 'textual' ||
1047: $env{'environment.remote'} eq 'off' );
1048:
1049: my $width = 620;
1050: my $height = 600;
1.430 albertel 1051: my $helptopic=&general_help();
1052: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1053: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1054: my $start_page =
1055: &Apache::loncommon::start_page('Help Menu', undef,
1056: {'frameset' => 1,
1057: 'js_ready' => 1,
1058: 'add_entries' => {
1059: 'border' => '0',
1.579 raeburn 1060: 'rows' => "110,*",},});
1.331 albertel 1061: my $end_page =
1062: &Apache::loncommon::end_page({'frameset' => 1,
1063: 'js_ready' => 1,});
1064:
1.436 albertel 1065: my $template .= <<"ENDTEMPLATE";
1066: <script type="text/javascript">
1.253 albertel 1067: // <!-- BEGIN LON-CAPA Internal
1068: // <![CDATA[
1.430 albertel 1069: var banner_link = '';
1.243 raeburn 1070: function helpMenu(target) {
1071: var caller = this;
1072: if (target == 'open') {
1073: var newWindow = null;
1074: try {
1.262 albertel 1075: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1076: }
1077: catch(error) {
1078: writeHelp(caller);
1079: return;
1080: }
1081: if (newWindow) {
1082: caller = newWindow;
1083: }
1.193 raeburn 1084: }
1.243 raeburn 1085: writeHelp(caller);
1086: return;
1087: }
1088: function writeHelp(caller) {
1.430 albertel 1089: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1090: caller.document.close()
1091: caller.focus()
1.193 raeburn 1092: }
1.253 albertel 1093: // ]]>
1.219 albertel 1094: // END LON-CAPA Internal -->
1.436 albertel 1095: </script>
1.193 raeburn 1096: ENDTEMPLATE
1097: return $template;
1098: }
1099:
1.172 www 1100: sub help_open_bug {
1101: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1102: unless ($env{'user.adv'}) { return ''; }
1.172 www 1103: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1104: $text = "" if (not defined $text);
1105: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1106: if ($env{'browser.interface'} eq 'textual' ||
1107: $env{'environment.remote'} eq 'off' ) {
1.172 www 1108: $stayOnPage=1;
1109: }
1.184 albertel 1110: $width = 600 if (not defined $width);
1111: $height = 600 if (not defined $height);
1.172 www 1112:
1113: $topic=~s/\W+/\+/g;
1114: my $link='';
1115: my $template='';
1.379 albertel 1116: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1117: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1118: if (!$stayOnPage)
1119: {
1120: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1121: }
1122: else
1123: {
1124: $link = $url;
1125: }
1126: # Add the text
1127: if ($text ne "")
1128: {
1129: $template .=
1130: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1131: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1132: }
1133:
1134: # Add the graphic
1.179 matthew 1135: my $title = &mt('Report a Bug');
1.215 albertel 1136: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1137: $template .= <<"ENDTEMPLATE";
1.436 albertel 1138: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1139: ENDTEMPLATE
1140: if ($text ne '') { $template.='</td></tr></table>' };
1141: return $template;
1142:
1143: }
1144:
1145: sub help_open_faq {
1146: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1147: unless ($env{'user.adv'}) { return ''; }
1.172 www 1148: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1149: $text = "" if (not defined $text);
1150: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1151: if ($env{'browser.interface'} eq 'textual' ||
1152: $env{'environment.remote'} eq 'off' ) {
1.172 www 1153: $stayOnPage=1;
1154: }
1155: $width = 350 if (not defined $width);
1156: $height = 400 if (not defined $height);
1157:
1158: $topic=~s/\W+/\+/g;
1159: my $link='';
1160: my $template='';
1161: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1162: if (!$stayOnPage)
1163: {
1164: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1165: }
1166: else
1167: {
1168: $link = $url;
1169: }
1170:
1171: # Add the text
1172: if ($text ne "")
1173: {
1174: $template .=
1.173 www 1175: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1176: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1177: }
1178:
1179: # Add the graphic
1.179 matthew 1180: my $title = &mt('View the FAQ');
1.215 albertel 1181: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1182: $template .= <<"ENDTEMPLATE";
1.436 albertel 1183: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1184: ENDTEMPLATE
1185: if ($text ne '') { $template.='</td></tr></table>' };
1186: return $template;
1187:
1.44 bowersj2 1188: }
1.37 matthew 1189:
1.180 matthew 1190: ###############################################################
1191: ###############################################################
1192:
1.45 matthew 1193: =pod
1194:
1.648 raeburn 1195: =item * &change_content_javascript():
1.256 matthew 1196:
1197: This and the next function allow you to create small sections of an
1198: otherwise static HTML page that you can update on the fly with
1199: Javascript, even in Netscape 4.
1200:
1201: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1202: must be written to the HTML page once. It will prove the Javascript
1203: function "change(name, content)". Calling the change function with the
1204: name of the section
1205: you want to update, matching the name passed to C<changable_area>, and
1206: the new content you want to put in there, will put the content into
1207: that area.
1208:
1209: B<Note>: Netscape 4 only reserves enough space for the changable area
1210: to contain room for the original contents. You need to "make space"
1211: for whatever changes you wish to make, and be B<sure> to check your
1212: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1213: it's adequate for updating a one-line status display, but little more.
1214: This script will set the space to 100% width, so you only need to
1215: worry about height in Netscape 4.
1216:
1217: Modern browsers are much less limiting, and if you can commit to the
1218: user not using Netscape 4, this feature may be used freely with
1219: pretty much any HTML.
1220:
1221: =cut
1222:
1223: sub change_content_javascript {
1224: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1225: if ($env{'browser.type'} eq 'netscape' &&
1226: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1227: return (<<NETSCAPE4);
1228: function change(name, content) {
1229: doc = document.layers[name+"___escape"].layers[0].document;
1230: doc.open();
1231: doc.write(content);
1232: doc.close();
1233: }
1234: NETSCAPE4
1235: } else {
1236: # Otherwise, we need to use semi-standards-compliant code
1237: # (technically, "innerHTML" isn't standard but the equivalent
1238: # is really scary, and every useful browser supports it
1239: return (<<DOMBASED);
1240: function change(name, content) {
1241: element = document.getElementById(name);
1242: element.innerHTML = content;
1243: }
1244: DOMBASED
1245: }
1246: }
1247:
1248: =pod
1249:
1.648 raeburn 1250: =item * &changable_area($name,$origContent):
1.256 matthew 1251:
1252: This provides a "changable area" that can be modified on the fly via
1253: the Javascript code provided in C<change_content_javascript>. $name is
1254: the name you will use to reference the area later; do not repeat the
1255: same name on a given HTML page more then once. $origContent is what
1256: the area will originally contain, which can be left blank.
1257:
1258: =cut
1259:
1260: sub changable_area {
1261: my ($name, $origContent) = @_;
1262:
1.258 albertel 1263: if ($env{'browser.type'} eq 'netscape' &&
1264: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1265: # If this is netscape 4, we need to use the Layer tag
1266: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1267: } else {
1268: return "<span id='$name'>$origContent</span>";
1269: }
1270: }
1271:
1272: =pod
1273:
1.648 raeburn 1274: =item * &viewport_geometry_js
1.590 raeburn 1275:
1276: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1277:
1278: =cut
1279:
1280:
1281: sub viewport_geometry_js {
1282: return <<"GEOMETRY";
1283: var Geometry = {};
1284: function init_geometry() {
1285: if (Geometry.init) { return };
1286: Geometry.init=1;
1287: if (window.innerHeight) {
1288: Geometry.getViewportHeight = function() { return window.innerHeight; };
1289: Geometry.getViewportWidth = function() { return window.innerWidth; };
1290: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1291: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1292: }
1293: else if (document.documentElement && document.documentElement.clientHeight) {
1294: Geometry.getViewportHeight =
1295: function() { return document.documentElement.clientHeight; };
1296: Geometry.getViewportWidth =
1297: function() { return document.documentElement.clientWidth; };
1298:
1299: Geometry.getHorizontalScroll =
1300: function() { return document.documentElement.scrollLeft; };
1301: Geometry.getVerticalScroll =
1302: function() { return document.documentElement.scrollTop; };
1303: }
1304: else if (document.body.clientHeight) {
1305: Geometry.getViewportHeight =
1306: function() { return document.body.clientHeight; };
1307: Geometry.getViewportWidth =
1308: function() { return document.body.clientWidth; };
1309: Geometry.getHorizontalScroll =
1310: function() { return document.body.scrollLeft; };
1311: Geometry.getVerticalScroll =
1312: function() { return document.body.scrollTop; };
1313: }
1314: }
1315:
1316: GEOMETRY
1317: }
1318:
1319: =pod
1320:
1.648 raeburn 1321: =item * &viewport_size_js()
1.590 raeburn 1322:
1323: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window.
1324:
1325: =cut
1326:
1327: sub viewport_size_js {
1328: my $geometry = &viewport_geometry_js();
1329: return <<"DIMS";
1330:
1331: $geometry
1332:
1333: function getViewportDims(width,height) {
1334: init_geometry();
1335: width.value = Geometry.getViewportWidth();
1336: height.value = Geometry.getViewportHeight();
1337: return;
1338: }
1339:
1340: DIMS
1341: }
1342:
1343: =pod
1344:
1.648 raeburn 1345: =item * &resize_textarea_js()
1.565 albertel 1346:
1347: emits the needed javascript to resize a textarea to be as big as possible
1348:
1349: creates a function resize_textrea that takes two IDs first should be
1350: the id of the element to resize, second should be the id of a div that
1351: surrounds everything that comes after the textarea, this routine needs
1352: to be attached to the <body> for the onload and onresize events.
1353:
1.648 raeburn 1354: =back
1.565 albertel 1355:
1356: =cut
1357:
1358: sub resize_textarea_js {
1.590 raeburn 1359: my $geometry = &viewport_geometry_js();
1.565 albertel 1360: return <<"RESIZE";
1361: <script type="text/javascript">
1.590 raeburn 1362: $geometry
1.565 albertel 1363:
1.588 albertel 1364: function getX(element) {
1365: var x = 0;
1366: while (element) {
1367: x += element.offsetLeft;
1368: element = element.offsetParent;
1369: }
1370: return x;
1371: }
1372: function getY(element) {
1373: var y = 0;
1374: while (element) {
1375: y += element.offsetTop;
1376: element = element.offsetParent;
1377: }
1378: return y;
1379: }
1380:
1381:
1.565 albertel 1382: function resize_textarea(textarea_id,bottom_id) {
1383: init_geometry();
1384: var textarea = document.getElementById(textarea_id);
1385: //alert(textarea);
1386:
1.588 albertel 1387: var textarea_top = getY(textarea);
1.565 albertel 1388: var textarea_height = textarea.offsetHeight;
1389: var bottom = document.getElementById(bottom_id);
1.588 albertel 1390: var bottom_top = getY(bottom);
1.565 albertel 1391: var bottom_height = bottom.offsetHeight;
1392: var window_height = Geometry.getViewportHeight();
1.588 albertel 1393: var fudge = 23;
1.565 albertel 1394: var new_height = window_height-fudge-textarea_top-bottom_height;
1395: if (new_height < 300) {
1396: new_height = 300;
1397: }
1398: textarea.style.height=new_height+'px';
1399: }
1400: </script>
1401: RESIZE
1402:
1403: }
1404:
1405: =pod
1406:
1.256 matthew 1407: =head1 Excel and CSV file utility routines
1408:
1409: =over 4
1410:
1411: =cut
1412:
1413: ###############################################################
1414: ###############################################################
1415:
1416: =pod
1417:
1.648 raeburn 1418: =item * &csv_translate($text)
1.37 matthew 1419:
1.185 www 1420: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1421: format.
1422:
1423: =cut
1424:
1.180 matthew 1425: ###############################################################
1426: ###############################################################
1.37 matthew 1427: sub csv_translate {
1428: my $text = shift;
1429: $text =~ s/\"/\"\"/g;
1.209 albertel 1430: $text =~ s/\n/ /g;
1.37 matthew 1431: return $text;
1432: }
1.180 matthew 1433:
1434: ###############################################################
1435: ###############################################################
1436:
1437: =pod
1438:
1.648 raeburn 1439: =item * &define_excel_formats()
1.180 matthew 1440:
1441: Define some commonly used Excel cell formats.
1442:
1443: Currently supported formats:
1444:
1445: =over 4
1446:
1447: =item header
1448:
1449: =item bold
1450:
1451: =item h1
1452:
1453: =item h2
1454:
1455: =item h3
1456:
1.256 matthew 1457: =item h4
1458:
1459: =item i
1460:
1.180 matthew 1461: =item date
1462:
1463: =back
1464:
1465: Inputs: $workbook
1466:
1467: Returns: $format, a hash reference.
1468:
1469: =cut
1470:
1471: ###############################################################
1472: ###############################################################
1473: sub define_excel_formats {
1474: my ($workbook) = @_;
1475: my $format;
1476: $format->{'header'} = $workbook->add_format(bold => 1,
1477: bottom => 1,
1478: align => 'center');
1479: $format->{'bold'} = $workbook->add_format(bold=>1);
1480: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1481: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1482: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1483: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1484: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1485: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1486: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1487: return $format;
1488: }
1489:
1490: ###############################################################
1491: ###############################################################
1.113 bowersj2 1492:
1493: =pod
1494:
1.648 raeburn 1495: =item * &create_workbook()
1.255 matthew 1496:
1497: Create an Excel worksheet. If it fails, output message on the
1498: request object and return undefs.
1499:
1500: Inputs: Apache request object
1501:
1502: Returns (undef) on failure,
1503: Excel worksheet object, scalar with filename, and formats
1504: from &Apache::loncommon::define_excel_formats on success
1505:
1506: =cut
1507:
1508: ###############################################################
1509: ###############################################################
1510: sub create_workbook {
1511: my ($r) = @_;
1512: #
1513: # Create the excel spreadsheet
1514: my $filename = '/prtspool/'.
1.258 albertel 1515: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1516: time.'_'.rand(1000000000).'.xls';
1517: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1518: if (! defined($workbook)) {
1519: $r->log_error("Error creating excel spreadsheet $filename: $!");
1520: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1521: "This error has been logged. ".
1522: "Please alert your LON-CAPA administrator").
1523: '</p>');
1524: return (undef);
1525: }
1526: #
1527: $workbook->set_tempdir('/home/httpd/perl/tmp');
1528: #
1529: my $format = &Apache::loncommon::define_excel_formats($workbook);
1530: return ($workbook,$filename,$format);
1531: }
1532:
1533: ###############################################################
1534: ###############################################################
1535:
1536: =pod
1537:
1.648 raeburn 1538: =item * &create_text_file()
1.113 bowersj2 1539:
1.542 raeburn 1540: Create a file to write to and eventually make available to the user.
1.256 matthew 1541: If file creation fails, outputs an error message on the request object and
1542: return undefs.
1.113 bowersj2 1543:
1.256 matthew 1544: Inputs: Apache request object, and file suffix
1.113 bowersj2 1545:
1.256 matthew 1546: Returns (undef) on failure,
1547: Filehandle and filename on success.
1.113 bowersj2 1548:
1549: =cut
1550:
1.256 matthew 1551: ###############################################################
1552: ###############################################################
1553: sub create_text_file {
1554: my ($r,$suffix) = @_;
1555: if (! defined($suffix)) { $suffix = 'txt'; };
1556: my $fh;
1557: my $filename = '/prtspool/'.
1.258 albertel 1558: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1559: time.'_'.rand(1000000000).'.'.$suffix;
1560: $fh = Apache::File->new('>/home/httpd'.$filename);
1561: if (! defined($fh)) {
1562: $r->log_error("Couldn't open $filename for output $!");
1.683 bisitz 1563: $r->print(&mt('Problems occurred in creating the output file. '
1564: .'This error has been logged. '
1565: .'Please alert your LON-CAPA administrator.'));
1.113 bowersj2 1566: }
1.256 matthew 1567: return ($fh,$filename)
1.113 bowersj2 1568: }
1569:
1570:
1.256 matthew 1571: =pod
1.113 bowersj2 1572:
1573: =back
1574:
1575: =cut
1.37 matthew 1576:
1577: ###############################################################
1.33 matthew 1578: ## Home server <option> list generating code ##
1579: ###############################################################
1.35 matthew 1580:
1.169 www 1581: # ------------------------------------------
1582:
1583: sub domain_select {
1584: my ($name,$value,$multiple)=@_;
1585: my %domains=map {
1.514 albertel 1586: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1587: } &Apache::lonnet::all_domains();
1.169 www 1588: if ($multiple) {
1589: $domains{''}=&mt('Any domain');
1.550 albertel 1590: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1591: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1592: } else {
1.550 albertel 1593: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1594: return &select_form($name,$value,%domains);
1595: }
1596: }
1597:
1.282 albertel 1598: #-------------------------------------------
1599:
1600: =pod
1601:
1.519 raeburn 1602: =head1 Routines for form select boxes
1603:
1604: =over 4
1605:
1.648 raeburn 1606: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1607:
1608: Returns a string containing a <select> element int multiple mode
1609:
1610:
1611: Args:
1612: $name - name of the <select> element
1.506 raeburn 1613: $value - scalar or array ref of values that should already be selected
1.282 albertel 1614: $size - number of rows long the select element is
1.283 albertel 1615: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1616: (shown text should already have been &mt())
1.506 raeburn 1617: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1618:
1.282 albertel 1619: =cut
1620:
1621: #-------------------------------------------
1.169 www 1622: sub multiple_select_form {
1.284 albertel 1623: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1624: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1625: my $output='';
1.191 matthew 1626: if (! defined($size)) {
1627: $size = 4;
1.283 albertel 1628: if (scalar(keys(%$hash))<4) {
1629: $size = scalar(keys(%$hash));
1.191 matthew 1630: }
1631: }
1.169 www 1632: $output.="\n<select name='$name' size='$size' multiple='1'>";
1.501 banghart 1633: my @order;
1.506 raeburn 1634: if (ref($order) eq 'ARRAY') {
1635: @order = @{$order};
1636: } else {
1637: @order = sort(keys(%$hash));
1.501 banghart 1638: }
1639: if (exists($$hash{'select_form_order'})) {
1640: @order = @{$$hash{'select_form_order'}};
1641: }
1642:
1.284 albertel 1643: foreach my $key (@order) {
1.356 albertel 1644: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1645: $output.='selected="selected" ' if ($selected{$key});
1646: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1647: }
1648: $output.="</select>\n";
1649: return $output;
1650: }
1651:
1.88 www 1652: #-------------------------------------------
1653:
1654: =pod
1655:
1.648 raeburn 1656: =item * &select_form($defdom,$name,%hash)
1.88 www 1657:
1658: Returns a string containing a <select name='$name' size='1'> form to
1659: allow a user to select options from a hash option_name => displayed text.
1660: See lonrights.pm for an example invocation and use.
1661:
1662: =cut
1663:
1664: #-------------------------------------------
1665: sub select_form {
1666: my ($def,$name,%hash) = @_;
1667: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1668: my @keys;
1669: if (exists($hash{'select_form_order'})) {
1670: @keys=@{$hash{'select_form_order'}};
1671: } else {
1672: @keys=sort(keys(%hash));
1673: }
1.356 albertel 1674: foreach my $key (@keys) {
1675: $selectform.=
1676: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1677: ($key eq $def ? 'selected="selected" ' : '').
1678: ">".&mt($hash{$key})."</option>\n";
1.88 www 1679: }
1680: $selectform.="</select>";
1681: return $selectform;
1682: }
1683:
1.475 www 1684: # For display filters
1685:
1686: sub display_filter {
1687: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1688: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.475 www 1689: return '<nobr><label>'.&mt('Records [_1]',
1690: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1691: (&mt('all'),10,20,50,100,1000,10000))).
1.478 www 1692: '</label></nobr> <nobr>'.
1.475 www 1693: &mt('Filter [_1]',
1.477 www 1694: &select_form($env{'form.displayfilter'},
1695: 'displayfilter',
1696: ('currentfolder' => 'Current folder/page',
1697: 'containing' => 'Containing phrase',
1698: 'none' => 'None'))).
1.478 www 1699: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></nobr>';
1.475 www 1700: }
1701:
1.167 www 1702: sub gradeleveldescription {
1703: my $gradelevel=shift;
1704: my %gradelevels=(0 => 'Not specified',
1705: 1 => 'Grade 1',
1706: 2 => 'Grade 2',
1707: 3 => 'Grade 3',
1708: 4 => 'Grade 4',
1709: 5 => 'Grade 5',
1710: 6 => 'Grade 6',
1711: 7 => 'Grade 7',
1712: 8 => 'Grade 8',
1713: 9 => 'Grade 9',
1714: 10 => 'Grade 10',
1715: 11 => 'Grade 11',
1716: 12 => 'Grade 12',
1717: 13 => 'Grade 13',
1718: 14 => '100 Level',
1719: 15 => '200 Level',
1720: 16 => '300 Level',
1721: 17 => '400 Level',
1722: 18 => 'Graduate Level');
1723: return &mt($gradelevels{$gradelevel});
1724: }
1725:
1.163 www 1726: sub select_level_form {
1727: my ($deflevel,$name)=@_;
1728: unless ($deflevel) { $deflevel=0; }
1.167 www 1729: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1730: for (my $i=0; $i<=18; $i++) {
1731: $selectform.="<option value=\"$i\" ".
1.253 albertel 1732: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1733: ">".&gradeleveldescription($i)."</option>\n";
1734: }
1735: $selectform.="</select>";
1736: return $selectform;
1.163 www 1737: }
1.167 www 1738:
1.35 matthew 1739: #-------------------------------------------
1740:
1.45 matthew 1741: =pod
1742:
1.648 raeburn 1743: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc)
1.35 matthew 1744:
1745: Returns a string containing a <select name='$name' size='1'> form to
1746: allow a user to select the domain to preform an operation in.
1747: See loncreateuser.pm for an example invocation and use.
1748:
1.90 www 1749: If the $includeempty flag is set, it also includes an empty choice ("no domain
1750: selected");
1751:
1.563 raeburn 1752: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1753:
1.35 matthew 1754: =cut
1755:
1756: #-------------------------------------------
1.34 matthew 1757: sub select_dom_form {
1.563 raeburn 1758: my ($defdom,$name,$includeempty,$showdomdesc) = @_;
1.550 albertel 1759: my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90 www 1760: if ($includeempty) { @domains=('',@domains); }
1.34 matthew 1761: my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
1.356 albertel 1762: foreach my $dom (@domains) {
1763: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1764: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1765: if ($showdomdesc) {
1766: if ($dom ne '') {
1767: my $domdesc = &Apache::lonnet::domain($dom,'description');
1768: if ($domdesc ne '') {
1769: $selectdomain .= ' ('.$domdesc.')';
1770: }
1771: }
1772: }
1773: $selectdomain .= "</option>\n";
1.34 matthew 1774: }
1775: $selectdomain.="</select>";
1776: return $selectdomain;
1777: }
1778:
1.35 matthew 1779: #-------------------------------------------
1780:
1.45 matthew 1781: =pod
1782:
1.648 raeburn 1783: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1784:
1.586 raeburn 1785: input: 4 arguments (two required, two optional) -
1786: $domain - domain of new user
1787: $name - name of form element
1788: $default - Value of 'default' causes a default item to be first
1789: option, and selected by default.
1790: $hide - Value of 'hide' causes hiding of the name of the server,
1791: if 1 server found, or default, if 0 found.
1.594 raeburn 1792: output: returns 2 items:
1.586 raeburn 1793: (a) form element which contains either:
1794: (i) <select name="$name">
1795: <option value="$hostid1">$hostid $servers{$hostid}</option>
1796: <option value="$hostid2">$hostid $servers{$hostid}</option>
1797: </select>
1798: form item if there are multiple library servers in $domain, or
1799: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
1800: if there is only one library server in $domain.
1801:
1802: (b) number of library servers found.
1803:
1804: See loncreateuser.pm for example of use.
1.35 matthew 1805:
1806: =cut
1807:
1808: #-------------------------------------------
1.586 raeburn 1809: sub home_server_form_item {
1810: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 1811: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 1812: my $result;
1813: my $numlib = keys(%servers);
1814: if ($numlib > 1) {
1815: $result .= '<select name="'.$name.'" />'."\n";
1816: if ($default) {
1817: $result .= '<option value="default" selected>'.&mt('default').
1818: '</option>'."\n";
1819: }
1820: foreach my $hostid (sort(keys(%servers))) {
1821: $result.= '<option value="'.$hostid.'">'.
1822: $hostid.' '.$servers{$hostid}."</option>\n";
1823: }
1824: $result .= '</select>'."\n";
1825: } elsif ($numlib == 1) {
1826: my $hostid;
1827: foreach my $item (keys(%servers)) {
1828: $hostid = $item;
1829: }
1830: $result .= '<input type="hidden" name="'.$name.'" value="'.
1831: $hostid.'" />';
1832: if (!$hide) {
1833: $result .= $hostid.' '.$servers{$hostid};
1834: }
1835: $result .= "\n";
1836: } elsif ($default) {
1837: $result .= '<input type="hidden" name="'.$name.
1838: '" value="default" />';
1839: if (!$hide) {
1840: $result .= &mt('default');
1841: }
1842: $result .= "\n";
1.33 matthew 1843: }
1.586 raeburn 1844: return ($result,$numlib);
1.33 matthew 1845: }
1.112 bowersj2 1846:
1847: =pod
1848:
1.534 albertel 1849: =back
1850:
1.112 bowersj2 1851: =cut
1.87 matthew 1852:
1853: ###############################################################
1.112 bowersj2 1854: ## Decoding User Agent ##
1.87 matthew 1855: ###############################################################
1856:
1857: =pod
1858:
1.112 bowersj2 1859: =head1 Decoding the User Agent
1860:
1861: =over 4
1862:
1863: =item * &decode_user_agent()
1.87 matthew 1864:
1865: Inputs: $r
1866:
1867: Outputs:
1868:
1869: =over 4
1870:
1.112 bowersj2 1871: =item * $httpbrowser
1.87 matthew 1872:
1.112 bowersj2 1873: =item * $clientbrowser
1.87 matthew 1874:
1.112 bowersj2 1875: =item * $clientversion
1.87 matthew 1876:
1.112 bowersj2 1877: =item * $clientmathml
1.87 matthew 1878:
1.112 bowersj2 1879: =item * $clientunicode
1.87 matthew 1880:
1.112 bowersj2 1881: =item * $clientos
1.87 matthew 1882:
1883: =back
1884:
1.157 matthew 1885: =back
1886:
1.87 matthew 1887: =cut
1888:
1889: ###############################################################
1890: ###############################################################
1891: sub decode_user_agent {
1.247 albertel 1892: my ($r)=@_;
1.87 matthew 1893: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
1894: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
1895: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 1896: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 1897: my $clientbrowser='unknown';
1898: my $clientversion='0';
1899: my $clientmathml='';
1900: my $clientunicode='0';
1901: for (my $i=0;$i<=$#browsertype;$i++) {
1902: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
1903: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
1904: $clientbrowser=$bname;
1905: $httpbrowser=~/$vreg/i;
1906: $clientversion=$1;
1907: $clientmathml=($clientversion>=$minv);
1908: $clientunicode=($clientversion>=$univ);
1909: }
1910: }
1911: my $clientos='unknown';
1912: if (($httpbrowser=~/linux/i) ||
1913: ($httpbrowser=~/unix/i) ||
1914: ($httpbrowser=~/ux/i) ||
1915: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
1916: if (($httpbrowser=~/vax/i) ||
1917: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
1918: if ($httpbrowser=~/next/i) { $clientos='next'; }
1919: if (($httpbrowser=~/mac/i) ||
1920: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1921: if ($httpbrowser=~/win/i) { $clientos='win'; }
1922: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1923: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1924: $clientunicode,$clientos,);
1925: }
1926:
1.32 matthew 1927: ###############################################################
1928: ## Authentication changing form generation subroutines ##
1929: ###############################################################
1930: ##
1931: ## All of the authform_xxxxxxx subroutines take their inputs in a
1932: ## hash, and have reasonable default values.
1933: ##
1934: ## formname = the name given in the <form> tag.
1.35 matthew 1935: #-------------------------------------------
1936:
1.45 matthew 1937: =pod
1938:
1.112 bowersj2 1939: =head1 Authentication Routines
1940:
1941: =over 4
1942:
1.648 raeburn 1943: =item * &authform_xxxxxx()
1.35 matthew 1944:
1945: The authform_xxxxxx subroutines provide javascript and html forms which
1946: handle some of the conveniences required for authentication forms.
1947: This is not an optimal method, but it works.
1948:
1949: =over 4
1950:
1.112 bowersj2 1951: =item * authform_header
1.35 matthew 1952:
1.112 bowersj2 1953: =item * authform_authorwarning
1.35 matthew 1954:
1.112 bowersj2 1955: =item * authform_nochange
1.35 matthew 1956:
1.112 bowersj2 1957: =item * authform_kerberos
1.35 matthew 1958:
1.112 bowersj2 1959: =item * authform_internal
1.35 matthew 1960:
1.112 bowersj2 1961: =item * authform_filesystem
1.35 matthew 1962:
1963: =back
1964:
1.648 raeburn 1965: See loncreateuser.pm for invocation and use examples.
1.157 matthew 1966:
1.35 matthew 1967: =cut
1968:
1969: #-------------------------------------------
1.32 matthew 1970: sub authform_header{
1971: my %in = (
1972: formname => 'cu',
1.80 albertel 1973: kerb_def_dom => '',
1.32 matthew 1974: @_,
1975: );
1976: $in{'formname'} = 'document.' . $in{'formname'};
1977: my $result='';
1.80 albertel 1978:
1979: #---------------------------------------------- Code for upper case translation
1980: my $Javascript_toUpperCase;
1981: unless ($in{kerb_def_dom}) {
1982: $Javascript_toUpperCase =<<"END";
1983: switch (choice) {
1984: case 'krb': currentform.elements[choicearg].value =
1985: currentform.elements[choicearg].value.toUpperCase();
1986: break;
1987: default:
1988: }
1989: END
1990: } else {
1991: $Javascript_toUpperCase = "";
1992: }
1993:
1.165 raeburn 1994: my $radioval = "'nochange'";
1.591 raeburn 1995: if (defined($in{'curr_authtype'})) {
1996: if ($in{'curr_authtype'} ne '') {
1997: $radioval = "'".$in{'curr_authtype'}."arg'";
1998: }
1.174 matthew 1999: }
1.165 raeburn 2000: my $argfield = 'null';
1.591 raeburn 2001: if (defined($in{'mode'})) {
1.165 raeburn 2002: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2003: if (defined($in{'curr_autharg'})) {
2004: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2005: $argfield = "'$in{'curr_autharg'}'";
2006: }
2007: }
2008: }
2009: }
2010:
1.32 matthew 2011: $result.=<<"END";
2012: var current = new Object();
1.165 raeburn 2013: current.radiovalue = $radioval;
2014: current.argfield = $argfield;
1.32 matthew 2015:
2016: function changed_radio(choice,currentform) {
2017: var choicearg = choice + 'arg';
2018: // If a radio button in changed, we need to change the argfield
2019: if (current.radiovalue != choice) {
2020: current.radiovalue = choice;
2021: if (current.argfield != null) {
2022: currentform.elements[current.argfield].value = '';
2023: }
2024: if (choice == 'nochange') {
2025: current.argfield = null;
2026: } else {
2027: current.argfield = choicearg;
2028: switch(choice) {
2029: case 'krb':
2030: currentform.elements[current.argfield].value =
2031: "$in{'kerb_def_dom'}";
2032: break;
2033: default:
2034: break;
2035: }
2036: }
2037: }
2038: return;
2039: }
1.22 www 2040:
1.32 matthew 2041: function changed_text(choice,currentform) {
2042: var choicearg = choice + 'arg';
2043: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2044: $Javascript_toUpperCase
1.32 matthew 2045: // clear old field
2046: if ((current.argfield != choicearg) && (current.argfield != null)) {
2047: currentform.elements[current.argfield].value = '';
2048: }
2049: current.argfield = choicearg;
2050: }
2051: set_auth_radio_buttons(choice,currentform);
2052: return;
1.20 www 2053: }
1.32 matthew 2054:
2055: function set_auth_radio_buttons(newvalue,currentform) {
2056: var i=0;
2057: while (i < currentform.login.length) {
2058: if (currentform.login[i].value == newvalue) { break; }
2059: i++;
2060: }
2061: if (i == currentform.login.length) {
2062: return;
2063: }
2064: current.radiovalue = newvalue;
2065: currentform.login[i].checked = true;
2066: return;
2067: }
2068: END
2069: return $result;
2070: }
2071:
2072: sub authform_authorwarning{
2073: my $result='';
1.144 matthew 2074: $result='<i>'.
2075: &mt('As a general rule, only authors or co-authors should be '.
2076: 'filesystem authenticated '.
2077: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2078: return $result;
2079: }
2080:
2081: sub authform_nochange{
2082: my %in = (
2083: formname => 'document.cu',
2084: kerb_def_dom => 'MSU.EDU',
2085: @_,
2086: );
1.586 raeburn 2087: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2088: my $result;
2089: if (keys(%can_assign) == 0) {
2090: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2091: } else {
2092: $result = '<label>'.&mt('[_1] Do not change login data',
2093: '<input type="radio" name="login" value="nochange" '.
2094: 'checked="checked" onclick="'.
1.281 albertel 2095: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2096: '</label>';
1.586 raeburn 2097: }
1.32 matthew 2098: return $result;
2099: }
2100:
1.591 raeburn 2101: sub authform_kerberos {
1.32 matthew 2102: my %in = (
2103: formname => 'document.cu',
2104: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2105: kerb_def_auth => 'krb4',
1.32 matthew 2106: @_,
2107: );
1.586 raeburn 2108: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2109: $autharg,$jscall);
2110: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2111: if ($in{'kerb_def_auth'} eq 'krb5') {
1.586 raeburn 2112: $check5 = ' checked="on"';
1.80 albertel 2113: } else {
1.586 raeburn 2114: $check4 = ' checked="on"';
1.80 albertel 2115: }
1.165 raeburn 2116: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2117: if (defined($in{'curr_authtype'})) {
2118: if ($in{'curr_authtype'} eq 'krb') {
1.586 raeburn 2119: $krbcheck = ' checked="on"';
1.623 raeburn 2120: if (defined($in{'mode'})) {
2121: if ($in{'mode'} eq 'modifyuser') {
2122: $krbcheck = '';
2123: }
2124: }
1.591 raeburn 2125: if (defined($in{'curr_kerb_ver'})) {
2126: if ($in{'curr_krb_ver'} eq '5') {
2127: $check5 = ' checked="on"';
2128: $check4 = '';
2129: } else {
2130: $check4 = ' checked="on"';
2131: $check5 = '';
2132: }
1.586 raeburn 2133: }
1.591 raeburn 2134: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2135: $krbarg = $in{'curr_autharg'};
2136: }
1.586 raeburn 2137: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2138: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2139: $result =
2140: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2141: $in{'curr_autharg'},$krbver);
2142: } else {
2143: $result =
2144: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2145: }
2146: return $result;
2147: }
2148: }
2149: } else {
2150: if ($authnum == 1) {
2151: $authtype = '<input type="hidden" name="login" value="krb">';
1.165 raeburn 2152: }
2153: }
1.586 raeburn 2154: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2155: return;
1.587 raeburn 2156: } elsif ($authtype eq '') {
1.591 raeburn 2157: if (defined($in{'mode'})) {
1.587 raeburn 2158: if ($in{'mode'} eq 'modifycourse') {
2159: if ($authnum == 1) {
2160: $authtype = '<input type="hidden" name="login" value="krb">';
2161: }
2162: }
2163: }
1.586 raeburn 2164: }
2165: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2166: if ($authtype eq '') {
2167: $authtype = '<input type="radio" name="login" value="krb" '.
2168: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2169: $krbcheck.' />';
2170: }
2171: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2172: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2173: $in{'curr_authtype'} eq 'krb5') ||
2174: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2175: $in{'curr_authtype'} eq 'krb4')) {
2176: $result .= &mt
1.144 matthew 2177: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2178: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2179: '<label>'.$authtype,
1.281 albertel 2180: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2181: 'value="'.$krbarg.'" '.
1.144 matthew 2182: 'onchange="'.$jscall.'" />',
1.281 albertel 2183: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2184: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2185: '</label>');
1.586 raeburn 2186: } elsif ($can_assign{'krb4'}) {
2187: $result .= &mt
2188: ('[_1] Kerberos authenticated with domain [_2] '.
2189: '[_3] Version 4 [_4]',
2190: '<label>'.$authtype,
2191: '</label><input type="text" size="10" name="krbarg" '.
2192: 'value="'.$krbarg.'" '.
2193: 'onchange="'.$jscall.'" />',
2194: '<label><input type="hidden" name="krbver" value="4" />',
2195: '</label>');
2196: } elsif ($can_assign{'krb5'}) {
2197: $result .= &mt
2198: ('[_1] Kerberos authenticated with domain [_2] '.
2199: '[_3] Version 5 [_4]',
2200: '<label>'.$authtype,
2201: '</label><input type="text" size="10" name="krbarg" '.
2202: 'value="'.$krbarg.'" '.
2203: 'onchange="'.$jscall.'" />',
2204: '<label><input type="hidden" name="krbver" value="5" />',
2205: '</label>');
2206: }
1.32 matthew 2207: return $result;
2208: }
2209:
2210: sub authform_internal{
1.586 raeburn 2211: my %in = (
1.32 matthew 2212: formname => 'document.cu',
2213: kerb_def_dom => 'MSU.EDU',
2214: @_,
2215: );
1.586 raeburn 2216: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2217: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2218: if (defined($in{'curr_authtype'})) {
2219: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2220: if ($can_assign{'int'}) {
2221: $intcheck = 'checked="on" ';
1.623 raeburn 2222: if (defined($in{'mode'})) {
2223: if ($in{'mode'} eq 'modifyuser') {
2224: $intcheck = '';
2225: }
2226: }
1.591 raeburn 2227: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2228: $intarg = $in{'curr_autharg'};
2229: }
2230: } else {
2231: $result = &mt('Currently internally authenticated.');
2232: return $result;
1.165 raeburn 2233: }
2234: }
1.586 raeburn 2235: } else {
2236: if ($authnum == 1) {
2237: $authtype = '<input type="hidden" name="login" value="int">';
2238: }
2239: }
2240: if (!$can_assign{'int'}) {
2241: return;
1.587 raeburn 2242: } elsif ($authtype eq '') {
1.591 raeburn 2243: if (defined($in{'mode'})) {
1.587 raeburn 2244: if ($in{'mode'} eq 'modifycourse') {
2245: if ($authnum == 1) {
2246: $authtype = '<input type="hidden" name="login" value="int">';
2247: }
2248: }
2249: }
1.165 raeburn 2250: }
1.586 raeburn 2251: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2252: if ($authtype eq '') {
2253: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2254: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2255: }
1.605 bisitz 2256: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2257: $intarg.'" onchange="'.$jscall.'" />';
2258: $result = &mt
1.144 matthew 2259: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2260: '<label>'.$authtype,'</label>'.$autharg);
1.620 www 2261: $result.="<label><input type=\"checkbox\" name=\"visible\" onClick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32 matthew 2262: return $result;
2263: }
2264:
2265: sub authform_local{
2266: my %in = (
2267: formname => 'document.cu',
2268: kerb_def_dom => 'MSU.EDU',
2269: @_,
2270: );
1.586 raeburn 2271: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2272: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2273: if (defined($in{'curr_authtype'})) {
2274: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2275: if ($can_assign{'loc'}) {
2276: $loccheck = 'checked="on" ';
1.623 raeburn 2277: if (defined($in{'mode'})) {
2278: if ($in{'mode'} eq 'modifyuser') {
2279: $loccheck = '';
2280: }
2281: }
1.591 raeburn 2282: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2283: $locarg = $in{'curr_autharg'};
2284: }
2285: } else {
2286: $result = &mt('Currently using local (institutional) authentication.');
2287: return $result;
1.165 raeburn 2288: }
2289: }
1.586 raeburn 2290: } else {
2291: if ($authnum == 1) {
2292: $authtype = '<input type="hidden" name="login" value="loc">';
2293: }
2294: }
2295: if (!$can_assign{'loc'}) {
2296: return;
1.587 raeburn 2297: } elsif ($authtype eq '') {
1.591 raeburn 2298: if (defined($in{'mode'})) {
1.587 raeburn 2299: if ($in{'mode'} eq 'modifycourse') {
2300: if ($authnum == 1) {
2301: $authtype = '<input type="hidden" name="login" value="loc">';
2302: }
2303: }
2304: }
1.165 raeburn 2305: }
1.586 raeburn 2306: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2307: if ($authtype eq '') {
2308: $authtype = '<input type="radio" name="login" value="loc" '.
2309: $loccheck.' onchange="'.$jscall.'" onclick="'.
2310: $jscall.'" />';
2311: }
2312: $autharg = '<input type="text" size="10" name="locarg" value="'.
2313: $locarg.'" onchange="'.$jscall.'" />';
2314: $result = &mt('[_1] Local Authentication with argument [_2]',
2315: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2316: return $result;
2317: }
2318:
2319: sub authform_filesystem{
2320: my %in = (
2321: formname => 'document.cu',
2322: kerb_def_dom => 'MSU.EDU',
2323: @_,
2324: );
1.586 raeburn 2325: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2326: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2327: if (defined($in{'curr_authtype'})) {
2328: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2329: if ($can_assign{'fsys'}) {
2330: $fsyscheck = 'checked="on" ';
1.623 raeburn 2331: if (defined($in{'mode'})) {
2332: if ($in{'mode'} eq 'modifyuser') {
2333: $fsyscheck = '';
2334: }
2335: }
1.586 raeburn 2336: } else {
2337: $result = &mt('Currently Filesystem Authenticated.');
2338: return $result;
2339: }
2340: }
2341: } else {
2342: if ($authnum == 1) {
2343: $authtype = '<input type="hidden" name="login" value="fsys">';
2344: }
2345: }
2346: if (!$can_assign{'fsys'}) {
2347: return;
1.587 raeburn 2348: } elsif ($authtype eq '') {
1.591 raeburn 2349: if (defined($in{'mode'})) {
1.587 raeburn 2350: if ($in{'mode'} eq 'modifycourse') {
2351: if ($authnum == 1) {
2352: $authtype = '<input type="hidden" name="login" value="fsys">';
2353: }
2354: }
2355: }
1.586 raeburn 2356: }
2357: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2358: if ($authtype eq '') {
2359: $authtype = '<input type="radio" name="login" value="fsys" '.
2360: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2361: $jscall.'" />';
2362: }
2363: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2364: ' onchange="'.$jscall.'" />';
2365: $result = &mt
1.144 matthew 2366: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2367: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2368: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2369: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2370: 'onchange="'.$jscall.'" />');
1.32 matthew 2371: return $result;
2372: }
2373:
1.586 raeburn 2374: sub get_assignable_auth {
2375: my ($dom) = @_;
2376: if ($dom eq '') {
2377: $dom = $env{'request.role.domain'};
2378: }
2379: my %can_assign = (
2380: krb4 => 1,
2381: krb5 => 1,
2382: int => 1,
2383: loc => 1,
2384: );
2385: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2386: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2387: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2388: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2389: my $context;
2390: if ($env{'request.role'} =~ /^au/) {
2391: $context = 'author';
2392: } elsif ($env{'request.role'} =~ /^dc/) {
2393: $context = 'domain';
2394: } elsif ($env{'request.course.id'}) {
2395: $context = 'course';
2396: }
2397: if ($context) {
2398: if (ref($authhash->{$context}) eq 'HASH') {
2399: %can_assign = %{$authhash->{$context}};
2400: }
2401: }
2402: }
2403: }
2404: my $authnum = 0;
2405: foreach my $key (keys(%can_assign)) {
2406: if ($can_assign{$key}) {
2407: $authnum ++;
2408: }
2409: }
2410: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2411: $authnum --;
2412: }
2413: return ($authnum,%can_assign);
2414: }
2415:
1.80 albertel 2416: ###############################################################
2417: ## Get Kerberos Defaults for Domain ##
2418: ###############################################################
2419: ##
2420: ## Returns default kerberos version and an associated argument
2421: ## as listed in file domain.tab. If not listed, provides
2422: ## appropriate default domain and kerberos version.
2423: ##
2424: #-------------------------------------------
2425:
2426: =pod
2427:
1.648 raeburn 2428: =item * &get_kerberos_defaults()
1.80 albertel 2429:
2430: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2431: version and domain. If not found, it defaults to version 4 and the
2432: domain of the server.
1.80 albertel 2433:
1.648 raeburn 2434: =over 4
2435:
1.80 albertel 2436: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2437:
1.648 raeburn 2438: =back
2439:
2440: =back
2441:
1.80 albertel 2442: =cut
2443:
2444: #-------------------------------------------
2445: sub get_kerberos_defaults {
2446: my $domain=shift;
1.641 raeburn 2447: my ($krbdef,$krbdefdom);
2448: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2449: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2450: $krbdef = $domdefaults{'auth_def'};
2451: $krbdefdom = $domdefaults{'auth_arg_def'};
2452: } else {
1.80 albertel 2453: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2454: my $krbdefdom=$1;
2455: $krbdefdom=~tr/a-z/A-Z/;
2456: $krbdef = "krb4";
2457: }
2458: return ($krbdef,$krbdefdom);
2459: }
1.112 bowersj2 2460:
1.32 matthew 2461:
1.46 matthew 2462: ###############################################################
2463: ## Thesaurus Functions ##
2464: ###############################################################
1.20 www 2465:
1.46 matthew 2466: =pod
1.20 www 2467:
1.112 bowersj2 2468: =head1 Thesaurus Functions
2469:
2470: =over 4
2471:
1.648 raeburn 2472: =item * &initialize_keywords()
1.46 matthew 2473:
2474: Initializes the package variable %Keywords if it is empty. Uses the
2475: package variable $thesaurus_db_file.
2476:
2477: =cut
2478:
2479: ###################################################
2480:
2481: sub initialize_keywords {
2482: return 1 if (scalar keys(%Keywords));
2483: # If we are here, %Keywords is empty, so fill it up
2484: # Make sure the file we need exists...
2485: if (! -e $thesaurus_db_file) {
2486: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2487: " failed because it does not exist");
2488: return 0;
2489: }
2490: # Set up the hash as a database
2491: my %thesaurus_db;
2492: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2493: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2494: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2495: $thesaurus_db_file);
2496: return 0;
2497: }
2498: # Get the average number of appearances of a word.
2499: my $avecount = $thesaurus_db{'average.count'};
2500: # Put keywords (those that appear > average) into %Keywords
2501: while (my ($word,$data)=each (%thesaurus_db)) {
2502: my ($count,undef) = split /:/,$data;
2503: $Keywords{$word}++ if ($count > $avecount);
2504: }
2505: untie %thesaurus_db;
2506: # Remove special values from %Keywords.
1.356 albertel 2507: foreach my $value ('total.count','average.count') {
2508: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2509: }
1.46 matthew 2510: return 1;
2511: }
2512:
2513: ###################################################
2514:
2515: =pod
2516:
1.648 raeburn 2517: =item * &keyword($word)
1.46 matthew 2518:
2519: Returns true if $word is a keyword. A keyword is a word that appears more
2520: than the average number of times in the thesaurus database. Calls
2521: &initialize_keywords
2522:
2523: =cut
2524:
2525: ###################################################
1.20 www 2526:
2527: sub keyword {
1.46 matthew 2528: return if (!&initialize_keywords());
2529: my $word=lc(shift());
2530: $word=~s/\W//g;
2531: return exists($Keywords{$word});
1.20 www 2532: }
1.46 matthew 2533:
2534: ###############################################################
2535:
2536: =pod
1.20 www 2537:
1.648 raeburn 2538: =item * &get_related_words()
1.46 matthew 2539:
1.160 matthew 2540: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2541: an array of words. If the keyword is not in the thesaurus, an empty array
2542: will be returned. The order of the words returned is determined by the
2543: database which holds them.
2544:
2545: Uses global $thesaurus_db_file.
2546:
2547: =cut
2548:
2549: ###############################################################
2550: sub get_related_words {
2551: my $keyword = shift;
2552: my %thesaurus_db;
2553: if (! -e $thesaurus_db_file) {
2554: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2555: "failed because the file does not exist");
2556: return ();
2557: }
2558: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2559: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2560: return ();
2561: }
2562: my @Words=();
1.429 www 2563: my $count=0;
1.46 matthew 2564: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2565: # The first element is the number of times
2566: # the word appears. We do not need it now.
1.429 www 2567: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2568: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2569: my $threshold=$mostfrequentcount/10;
2570: foreach my $possibleword (@RelatedWords) {
2571: my ($word,$wordcount)=split(/\,/,$possibleword);
2572: if ($wordcount>$threshold) {
2573: push(@Words,$word);
2574: $count++;
2575: if ($count>10) { last; }
2576: }
1.20 www 2577: }
2578: }
1.46 matthew 2579: untie %thesaurus_db;
2580: return @Words;
1.14 harris41 2581: }
1.46 matthew 2582:
1.112 bowersj2 2583: =pod
2584:
2585: =back
2586:
2587: =cut
1.61 www 2588:
2589: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2590: =pod
2591:
1.112 bowersj2 2592: =head1 User Name Functions
2593:
2594: =over 4
2595:
1.648 raeburn 2596: =item * &plainname($uname,$udom,$first)
1.81 albertel 2597:
1.112 bowersj2 2598: Takes a users logon name and returns it as a string in
1.226 albertel 2599: "first middle last generation" form
2600: if $first is set to 'lastname' then it returns it as
2601: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2602:
2603: =cut
1.61 www 2604:
1.295 www 2605:
1.81 albertel 2606: ###############################################################
1.61 www 2607: sub plainname {
1.226 albertel 2608: my ($uname,$udom,$first)=@_;
1.537 albertel 2609: return if (!defined($uname) || !defined($udom));
1.295 www 2610: my %names=&getnames($uname,$udom);
1.226 albertel 2611: my $name=&Apache::lonnet::format_name($names{'firstname'},
2612: $names{'middlename'},
2613: $names{'lastname'},
2614: $names{'generation'},$first);
2615: $name=~s/^\s+//;
1.62 www 2616: $name=~s/\s+$//;
2617: $name=~s/\s+/ /g;
1.353 albertel 2618: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2619: return $name;
1.61 www 2620: }
1.66 www 2621:
2622: # -------------------------------------------------------------------- Nickname
1.81 albertel 2623: =pod
2624:
1.648 raeburn 2625: =item * &nickname($uname,$udom)
1.81 albertel 2626:
2627: Gets a users name and returns it as a string as
2628:
2629: ""nickname""
1.66 www 2630:
1.81 albertel 2631: if the user has a nickname or
2632:
2633: "first middle last generation"
2634:
2635: if the user does not
2636:
2637: =cut
1.66 www 2638:
2639: sub nickname {
2640: my ($uname,$udom)=@_;
1.537 albertel 2641: return if (!defined($uname) || !defined($udom));
1.295 www 2642: my %names=&getnames($uname,$udom);
1.68 albertel 2643: my $name=$names{'nickname'};
1.66 www 2644: if ($name) {
2645: $name='"'.$name.'"';
2646: } else {
2647: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2648: $names{'lastname'}.' '.$names{'generation'};
2649: $name=~s/\s+$//;
2650: $name=~s/\s+/ /g;
2651: }
2652: return $name;
2653: }
2654:
1.295 www 2655: sub getnames {
2656: my ($uname,$udom)=@_;
1.537 albertel 2657: return if (!defined($uname) || !defined($udom));
1.433 albertel 2658: if ($udom eq 'public' && $uname eq 'public') {
2659: return ('lastname' => &mt('Public'));
2660: }
1.295 www 2661: my $id=$uname.':'.$udom;
2662: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2663: if ($cached) {
2664: return %{$names};
2665: } else {
2666: my %loadnames=&Apache::lonnet::get('environment',
2667: ['firstname','middlename','lastname','generation','nickname'],
2668: $udom,$uname);
2669: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2670: return %loadnames;
2671: }
2672: }
1.61 www 2673:
1.542 raeburn 2674: # -------------------------------------------------------------------- getemails
1.648 raeburn 2675:
1.542 raeburn 2676: =pod
2677:
1.648 raeburn 2678: =item * &getemails($uname,$udom)
1.542 raeburn 2679:
2680: Gets a user's email information and returns it as a hash with keys:
2681: notification, critnotification, permanentemail
2682:
2683: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2684: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2685:
1.648 raeburn 2686:
1.542 raeburn 2687: =cut
2688:
1.648 raeburn 2689:
1.466 albertel 2690: sub getemails {
2691: my ($uname,$udom)=@_;
2692: if ($udom eq 'public' && $uname eq 'public') {
2693: return;
2694: }
1.467 www 2695: if (!$udom) { $udom=$env{'user.domain'}; }
2696: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2697: my $id=$uname.':'.$udom;
2698: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2699: if ($cached) {
2700: return %{$names};
2701: } else {
2702: my %loadnames=&Apache::lonnet::get('environment',
2703: ['notification','critnotification',
2704: 'permanentemail'],
2705: $udom,$uname);
2706: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2707: return %loadnames;
2708: }
2709: }
2710:
1.551 albertel 2711: sub flush_email_cache {
2712: my ($uname,$udom)=@_;
2713: if (!$udom) { $udom =$env{'user.domain'}; }
2714: if (!$uname) { $uname=$env{'user.name'}; }
2715: return if ($udom eq 'public' && $uname eq 'public');
2716: my $id=$uname.':'.$udom;
2717: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2718: }
2719:
1.61 www 2720: # ------------------------------------------------------------------ Screenname
1.81 albertel 2721:
2722: =pod
2723:
1.648 raeburn 2724: =item * &screenname($uname,$udom)
1.81 albertel 2725:
2726: Gets a users screenname and returns it as a string
2727:
2728: =cut
1.61 www 2729:
2730: sub screenname {
2731: my ($uname,$udom)=@_;
1.258 albertel 2732: if ($uname eq $env{'user.name'} &&
2733: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2734: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2735: return $names{'screenname'};
1.62 www 2736: }
2737:
1.212 albertel 2738:
1.62 www 2739: # ------------------------------------------------------------- Message Wrapper
2740:
2741: sub messagewrapper {
1.369 www 2742: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 2743: return
1.441 albertel 2744: '<a href="/adm/email?compose=individual&'.
2745: 'recname='.$username.'&recdom='.$domain.
2746: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 2747: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 2748: }
2749: # --------------------------------------------------------------- Notes Wrapper
2750:
2751: sub noteswrapper {
2752: my ($link,$un,$do)=@_;
2753: return
2754: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 2755: }
2756: # ------------------------------------------------------------- Aboutme Wrapper
2757:
2758: sub aboutmewrapper {
1.166 www 2759: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 2760: if (!defined($username) && !defined($domain)) {
2761: return;
2762: }
1.205 www 2763: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.454 banghart 2764: ($target?' target="$target"':'').' title="'.&mt("View this user's personal page").'">'.$link.'</a>';
1.62 www 2765: }
2766:
2767: # ------------------------------------------------------------ Syllabus Wrapper
2768:
2769:
2770: sub syllabuswrapper {
1.707 bisitz 2771: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 2772: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 2773: }
1.14 harris41 2774:
1.208 matthew 2775: sub track_student_link {
1.268 albertel 2776: my ($linktext,$sname,$sdom,$target,$start) = @_;
2777: my $link ="/adm/trackstudent?";
1.208 matthew 2778: my $title = 'View recent activity';
2779: if (defined($sname) && $sname !~ /^\s*$/ &&
2780: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 2781: $link .= "selected_student=$sname:$sdom";
1.208 matthew 2782: $title .= ' of this student';
1.268 albertel 2783: }
1.208 matthew 2784: if (defined($target) && $target !~ /^\s*$/) {
2785: $target = qq{target="$target"};
2786: } else {
2787: $target = '';
2788: }
1.268 albertel 2789: if ($start) { $link.='&start='.$start; }
1.554 albertel 2790: $title = &mt($title);
2791: $linktext = &mt($linktext);
1.448 albertel 2792: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
2793: &help_open_topic('View_recent_activity');
1.208 matthew 2794: }
2795:
1.508 www 2796: # ===================================================== Display a student photo
2797:
2798:
1.509 albertel 2799: sub student_image_tag {
1.508 www 2800: my ($domain,$user)=@_;
2801: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
2802: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
2803: return '<img src="'.$imgsrc.'" align="right" />';
2804: } else {
2805: return '';
2806: }
2807: }
2808:
1.112 bowersj2 2809: =pod
2810:
2811: =back
2812:
2813: =head1 Access .tab File Data
2814:
2815: =over 4
2816:
1.648 raeburn 2817: =item * &languageids()
1.112 bowersj2 2818:
2819: returns list of all language ids
2820:
2821: =cut
2822:
1.14 harris41 2823: sub languageids {
1.16 harris41 2824: return sort(keys(%language));
1.14 harris41 2825: }
2826:
1.112 bowersj2 2827: =pod
2828:
1.648 raeburn 2829: =item * &languagedescription()
1.112 bowersj2 2830:
2831: returns description of a specified language id
2832:
2833: =cut
2834:
1.14 harris41 2835: sub languagedescription {
1.125 www 2836: my $code=shift;
2837: return ($supported_language{$code}?'* ':'').
2838: $language{$code}.
1.126 www 2839: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 2840: }
2841:
2842: sub plainlanguagedescription {
2843: my $code=shift;
2844: return $language{$code};
2845: }
2846:
2847: sub supportedlanguagecode {
2848: my $code=shift;
2849: return $supported_language{$code};
1.97 www 2850: }
2851:
1.112 bowersj2 2852: =pod
2853:
1.648 raeburn 2854: =item * ©rightids()
1.112 bowersj2 2855:
2856: returns list of all copyrights
2857:
2858: =cut
2859:
2860: sub copyrightids {
2861: return sort(keys(%cprtag));
2862: }
2863:
2864: =pod
2865:
1.648 raeburn 2866: =item * ©rightdescription()
1.112 bowersj2 2867:
2868: returns description of a specified copyright id
2869:
2870: =cut
2871:
2872: sub copyrightdescription {
1.166 www 2873: return &mt($cprtag{shift(@_)});
1.112 bowersj2 2874: }
1.197 matthew 2875:
2876: =pod
2877:
1.648 raeburn 2878: =item * &source_copyrightids()
1.192 taceyjo1 2879:
2880: returns list of all source copyrights
2881:
2882: =cut
2883:
2884: sub source_copyrightids {
2885: return sort(keys(%scprtag));
2886: }
2887:
2888: =pod
2889:
1.648 raeburn 2890: =item * &source_copyrightdescription()
1.192 taceyjo1 2891:
2892: returns description of a specified source copyright id
2893:
2894: =cut
2895:
2896: sub source_copyrightdescription {
2897: return &mt($scprtag{shift(@_)});
2898: }
1.112 bowersj2 2899:
2900: =pod
2901:
1.648 raeburn 2902: =item * &filecategories()
1.112 bowersj2 2903:
2904: returns list of all file categories
2905:
2906: =cut
2907:
2908: sub filecategories {
2909: return sort(keys(%category_extensions));
2910: }
2911:
2912: =pod
2913:
1.648 raeburn 2914: =item * &filecategorytypes()
1.112 bowersj2 2915:
2916: returns list of file types belonging to a given file
2917: category
2918:
2919: =cut
2920:
2921: sub filecategorytypes {
1.356 albertel 2922: my ($cat) = @_;
2923: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 2924: }
2925:
2926: =pod
2927:
1.648 raeburn 2928: =item * &fileembstyle()
1.112 bowersj2 2929:
2930: returns embedding style for a specified file type
2931:
2932: =cut
2933:
2934: sub fileembstyle {
2935: return $fe{lc(shift(@_))};
1.169 www 2936: }
2937:
1.351 www 2938: sub filemimetype {
2939: return $fm{lc(shift(@_))};
2940: }
2941:
1.169 www 2942:
2943: sub filecategoryselect {
2944: my ($name,$value)=@_;
1.189 matthew 2945: return &select_form($value,$name,
1.169 www 2946: '' => &mt('Any category'),
2947: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 2948: }
2949:
2950: =pod
2951:
1.648 raeburn 2952: =item * &filedescription()
1.112 bowersj2 2953:
2954: returns description for a specified file type
2955:
2956: =cut
2957:
2958: sub filedescription {
1.188 matthew 2959: my $file_description = $fd{lc(shift())};
2960: $file_description =~ s:([\[\]]):~$1:g;
2961: return &mt($file_description);
1.112 bowersj2 2962: }
2963:
2964: =pod
2965:
1.648 raeburn 2966: =item * &filedescriptionex()
1.112 bowersj2 2967:
2968: returns description for a specified file type with
2969: extra formatting
2970:
2971: =cut
2972:
2973: sub filedescriptionex {
2974: my $ex=shift;
1.188 matthew 2975: my $file_description = $fd{lc($ex)};
2976: $file_description =~ s:([\[\]]):~$1:g;
2977: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 2978: }
2979:
2980: # End of .tab access
2981: =pod
2982:
2983: =back
2984:
2985: =cut
2986:
2987: # ------------------------------------------------------------------ File Types
2988: sub fileextensions {
2989: return sort(keys(%fe));
2990: }
2991:
1.97 www 2992: # ----------------------------------------------------------- Display Languages
2993: # returns a hash with all desired display languages
2994: #
2995:
2996: sub display_languages {
2997: my %languages=();
1.695 raeburn 2998: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 2999: $languages{$lang}=1;
1.97 www 3000: }
3001: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3002: if ($env{'form.displaylanguage'}) {
1.356 albertel 3003: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3004: $languages{$lang}=1;
1.97 www 3005: }
3006: }
3007: return %languages;
1.14 harris41 3008: }
3009:
1.582 albertel 3010: sub languages {
3011: my ($possible_langs) = @_;
1.695 raeburn 3012: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3013: if (!ref($possible_langs)) {
3014: if( wantarray ) {
3015: return @preferred_langs;
3016: } else {
3017: return $preferred_langs[0];
3018: }
3019: }
3020: my %possibilities = map { $_ => 1 } (@$possible_langs);
3021: my @preferred_possibilities;
3022: foreach my $preferred_lang (@preferred_langs) {
3023: if (exists($possibilities{$preferred_lang})) {
3024: push(@preferred_possibilities, $preferred_lang);
3025: }
3026: }
3027: if( wantarray ) {
3028: return @preferred_possibilities;
3029: }
3030: return $preferred_possibilities[0];
3031: }
3032:
1.112 bowersj2 3033: ###############################################################
3034: ## Student Answer Attempts ##
3035: ###############################################################
3036:
3037: =pod
3038:
3039: =head1 Alternate Problem Views
3040:
3041: =over 4
3042:
1.648 raeburn 3043: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3044: $getattempt, $regexp, $gradesub)
3045:
3046: Return string with previous attempt on problem. Arguments:
3047:
3048: =over 4
3049:
3050: =item * $symb: Problem, including path
3051:
3052: =item * $username: username of the desired student
3053:
3054: =item * $domain: domain of the desired student
1.14 harris41 3055:
1.112 bowersj2 3056: =item * $course: Course ID
1.14 harris41 3057:
1.112 bowersj2 3058: =item * $getattempt: Leave blank for all attempts, otherwise put
3059: something
1.14 harris41 3060:
1.112 bowersj2 3061: =item * $regexp: if string matches this regexp, the string will be
3062: sent to $gradesub
1.14 harris41 3063:
1.112 bowersj2 3064: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3065:
1.112 bowersj2 3066: =back
1.14 harris41 3067:
1.112 bowersj2 3068: The output string is a table containing all desired attempts, if any.
1.16 harris41 3069:
1.112 bowersj2 3070: =cut
1.1 albertel 3071:
3072: sub get_previous_attempt {
1.43 ng 3073: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3074: my $prevattempts='';
1.43 ng 3075: no strict 'refs';
1.1 albertel 3076: if ($symb) {
1.3 albertel 3077: my (%returnhash)=
3078: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3079: if ($returnhash{'version'}) {
3080: my %lasthash=();
3081: my $version;
3082: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3083: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3084: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3085: }
1.1 albertel 3086: }
1.596 albertel 3087: $prevattempts=&start_data_table().&start_data_table_header_row();
3088: $prevattempts.='<th>'.&mt('History').'</th>';
1.356 albertel 3089: foreach my $key (sort(keys(%lasthash))) {
3090: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3091: if ($#parts > 0) {
1.31 albertel 3092: my $data=$parts[-1];
3093: pop(@parts);
1.596 albertel 3094: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.31 albertel 3095: } else {
1.41 ng 3096: if ($#parts == 0) {
3097: $prevattempts.='<th>'.$parts[0].'</th>';
3098: } else {
3099: $prevattempts.='<th>'.$ign.'</th>';
3100: }
1.31 albertel 3101: }
1.16 harris41 3102: }
1.596 albertel 3103: $prevattempts.=&end_data_table_header_row();
1.40 ng 3104: if ($getattempt eq '') {
3105: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596 albertel 3106: $prevattempts.=&start_data_table_row().
3107: '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356 albertel 3108: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3109: my $value = &format_previous_attempt_value($key,
3110: $returnhash{$version.':'.$key});
3111: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 3112: }
1.596 albertel 3113: $prevattempts.=&end_data_table_row();
1.40 ng 3114: }
1.1 albertel 3115: }
1.596 albertel 3116: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3117: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3118: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 3119: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 3120: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 3121: }
1.596 albertel 3122: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3123: } else {
1.596 albertel 3124: $prevattempts=
3125: &start_data_table().&start_data_table_row().
3126: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3127: &end_data_table_row().&end_data_table();
1.1 albertel 3128: }
3129: } else {
1.596 albertel 3130: $prevattempts=
3131: &start_data_table().&start_data_table_row().
3132: '<td>'.&mt('No data.').'</td>'.
3133: &end_data_table_row().&end_data_table();
1.1 albertel 3134: }
1.10 albertel 3135: }
3136:
1.581 albertel 3137: sub format_previous_attempt_value {
3138: my ($key,$value) = @_;
3139: if ($key =~ /timestamp/) {
3140: $value = &Apache::lonlocal::locallocaltime($value);
3141: } elsif (ref($value) eq 'ARRAY') {
3142: $value = '('.join(', ', @{ $value }).')';
3143: } else {
3144: $value = &unescape($value);
3145: }
3146: return $value;
3147: }
3148:
3149:
1.107 albertel 3150: sub relative_to_absolute {
3151: my ($url,$output)=@_;
3152: my $parser=HTML::TokeParser->new(\$output);
3153: my $token;
3154: my $thisdir=$url;
3155: my @rlinks=();
3156: while ($token=$parser->get_token) {
3157: if ($token->[0] eq 'S') {
3158: if ($token->[1] eq 'a') {
3159: if ($token->[2]->{'href'}) {
3160: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3161: }
3162: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3163: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3164: } elsif ($token->[1] eq 'base') {
3165: $thisdir=$token->[2]->{'href'};
3166: }
3167: }
3168: }
3169: $thisdir=~s-/[^/]*$--;
1.356 albertel 3170: foreach my $link (@rlinks) {
3171: unless (($link=~/^http:\/\//i) ||
3172: ($link=~/^\//) ||
3173: ($link=~/^javascript:/i) ||
3174: ($link=~/^mailto:/i) ||
3175: ($link=~/^\#/)) {
3176: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3177: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3178: }
3179: }
3180: # -------------------------------------------------- Deal with Applet codebases
3181: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3182: return $output;
3183: }
3184:
1.112 bowersj2 3185: =pod
3186:
1.648 raeburn 3187: =item * &get_student_view()
1.112 bowersj2 3188:
3189: show a snapshot of what student was looking at
3190:
3191: =cut
3192:
1.10 albertel 3193: sub get_student_view {
1.186 albertel 3194: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3195: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3196: my (%form);
1.10 albertel 3197: my @elements=('symb','courseid','domain','username');
3198: foreach my $element (@elements) {
1.186 albertel 3199: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3200: }
1.186 albertel 3201: if (defined($moreenv)) {
3202: %form=(%form,%{$moreenv});
3203: }
1.236 albertel 3204: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3205: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3206: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3207: $userview=~s/\<body[^\>]*\>//gi;
3208: $userview=~s/\<\/body\>//gi;
3209: $userview=~s/\<html\>//gi;
3210: $userview=~s/\<\/html\>//gi;
3211: $userview=~s/\<head\>//gi;
3212: $userview=~s/\<\/head\>//gi;
3213: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3214: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3215: if (wantarray) {
3216: return ($userview,$response);
3217: } else {
3218: return $userview;
3219: }
3220: }
3221:
3222: sub get_student_view_with_retries {
3223: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3224:
3225: my $ok = 0; # True if we got a good response.
3226: my $content;
3227: my $response;
3228:
3229: # Try to get the student_view done. within the retries count:
3230:
3231: do {
3232: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3233: $ok = $response->is_success;
3234: if (!$ok) {
3235: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3236: }
3237: $retries--;
3238: } while (!$ok && ($retries > 0));
3239:
3240: if (!$ok) {
3241: $content = ''; # On error return an empty content.
3242: }
1.651 www 3243: if (wantarray) {
3244: return ($content, $response);
3245: } else {
3246: return $content;
3247: }
1.11 albertel 3248: }
3249:
1.112 bowersj2 3250: =pod
3251:
1.648 raeburn 3252: =item * &get_student_answers()
1.112 bowersj2 3253:
3254: show a snapshot of how student was answering problem
3255:
3256: =cut
3257:
1.11 albertel 3258: sub get_student_answers {
1.100 sakharuk 3259: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3260: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3261: my (%moreenv);
1.11 albertel 3262: my @elements=('symb','courseid','domain','username');
3263: foreach my $element (@elements) {
1.186 albertel 3264: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3265: }
1.186 albertel 3266: $moreenv{'grade_target'}='answer';
3267: %moreenv=(%form,%moreenv);
1.497 raeburn 3268: $feedurl = &Apache::lonnet::clutter($feedurl);
3269: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3270: return $userview;
1.1 albertel 3271: }
1.116 albertel 3272:
3273: =pod
3274:
3275: =item * &submlink()
3276:
1.242 albertel 3277: Inputs: $text $uname $udom $symb $target
1.116 albertel 3278:
3279: Returns: A link to grades.pm such as to see the SUBM view of a student
3280:
3281: =cut
3282:
3283: ###############################################
3284: sub submlink {
1.242 albertel 3285: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3286: if (!($uname && $udom)) {
3287: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3288: &Apache::lonnet::whichuser($symb);
1.116 albertel 3289: if (!$symb) { $symb=$cursymb; }
3290: }
1.254 matthew 3291: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3292: $symb=&escape($symb);
1.242 albertel 3293: if ($target) { $target="target=\"$target\""; }
3294: return '<a href="/adm/grades?&command=submission&'.
3295: 'symb='.$symb.'&student='.$uname.
3296: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3297: }
3298: ##############################################
3299:
3300: =pod
3301:
3302: =item * &pgrdlink()
3303:
3304: Inputs: $text $uname $udom $symb $target
3305:
3306: Returns: A link to grades.pm such as to see the PGRD view of a student
3307:
3308: =cut
3309:
3310: ###############################################
3311: sub pgrdlink {
3312: my $link=&submlink(@_);
3313: $link=~s/(&command=submission)/$1&showgrading=yes/;
3314: return $link;
3315: }
3316: ##############################################
3317:
3318: =pod
3319:
3320: =item * &pprmlink()
3321:
3322: Inputs: $text $uname $udom $symb $target
3323:
3324: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3325: student and a specific resource
1.242 albertel 3326:
3327: =cut
3328:
3329: ###############################################
3330: sub pprmlink {
3331: my ($text,$uname,$udom,$symb,$target)=@_;
3332: if (!($uname && $udom)) {
3333: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3334: &Apache::lonnet::whichuser($symb);
1.242 albertel 3335: if (!$symb) { $symb=$cursymb; }
3336: }
1.254 matthew 3337: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3338: $symb=&escape($symb);
1.242 albertel 3339: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3340: return '<a href="/adm/parmset?command=set&'.
3341: 'symb='.$symb.'&uname='.$uname.
3342: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3343: }
3344: ##############################################
1.37 matthew 3345:
1.112 bowersj2 3346: =pod
3347:
3348: =back
3349:
3350: =cut
3351:
1.37 matthew 3352: ###############################################
1.51 www 3353:
3354:
3355: sub timehash {
1.687 raeburn 3356: my ($thistime) = @_;
3357: my $timezone = &Apache::lonlocal::gettimezone();
3358: my $dt = DateTime->from_epoch(epoch => $thistime)
3359: ->set_time_zone($timezone);
3360: my $wday = $dt->day_of_week();
3361: if ($wday == 7) { $wday = 0; }
3362: return ( 'second' => $dt->second(),
3363: 'minute' => $dt->minute(),
3364: 'hour' => $dt->hour(),
3365: 'day' => $dt->day_of_month(),
3366: 'month' => $dt->month(),
3367: 'year' => $dt->year(),
3368: 'weekday' => $wday,
3369: 'dayyear' => $dt->day_of_year(),
3370: 'dlsav' => $dt->is_dst() );
1.51 www 3371: }
3372:
1.370 www 3373: sub utc_string {
3374: my ($date)=@_;
1.371 www 3375: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3376: }
3377:
1.51 www 3378: sub maketime {
3379: my %th=@_;
1.687 raeburn 3380: my ($epoch_time,$timezone,$dt);
3381: $timezone = &Apache::lonlocal::gettimezone();
3382: eval {
3383: $dt = DateTime->new( year => $th{'year'},
3384: month => $th{'month'},
3385: day => $th{'day'},
3386: hour => $th{'hour'},
3387: minute => $th{'minute'},
3388: second => $th{'second'},
3389: time_zone => $timezone,
3390: );
3391: };
3392: if (!$@) {
3393: $epoch_time = $dt->epoch;
3394: if ($epoch_time) {
3395: return $epoch_time;
3396: }
3397: }
1.51 www 3398: return POSIX::mktime(
3399: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3400: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3401: }
3402:
3403: #########################################
1.51 www 3404:
3405: sub findallcourses {
1.482 raeburn 3406: my ($roles,$uname,$udom) = @_;
1.355 albertel 3407: my %roles;
3408: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3409: my %courses;
1.51 www 3410: my $now=time;
1.482 raeburn 3411: if (!defined($uname)) {
3412: $uname = $env{'user.name'};
3413: }
3414: if (!defined($udom)) {
3415: $udom = $env{'user.domain'};
3416: }
3417: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3418: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3419: if (!%roles) {
3420: %roles = (
3421: cc => 1,
3422: in => 1,
3423: ep => 1,
3424: ta => 1,
3425: cr => 1,
3426: st => 1,
3427: );
3428: }
3429: foreach my $entry (keys(%roleshash)) {
3430: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3431: if ($trole =~ /^cr/) {
3432: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3433: } else {
3434: next if (!exists($roles{$trole}));
3435: }
3436: if ($tend) {
3437: next if ($tend < $now);
3438: }
3439: if ($tstart) {
3440: next if ($tstart > $now);
3441: }
3442: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3443: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3444: if ($secpart eq '') {
3445: ($cnum,$role) = split(/_/,$cnumpart);
3446: $sec = 'none';
3447: $realsec = '';
3448: } else {
3449: $cnum = $cnumpart;
3450: ($sec,$role) = split(/_/,$secpart);
3451: $realsec = $sec;
1.490 raeburn 3452: }
1.482 raeburn 3453: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3454: }
3455: } else {
3456: foreach my $key (keys(%env)) {
1.483 albertel 3457: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3458: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3459: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3460: next if ($role eq 'ca' || $role eq 'aa');
3461: next if (%roles && !exists($roles{$role}));
3462: my ($starttime,$endtime)=split(/\./,$env{$key});
3463: my $active=1;
3464: if ($starttime) {
3465: if ($now<$starttime) { $active=0; }
3466: }
3467: if ($endtime) {
3468: if ($now>$endtime) { $active=0; }
3469: }
3470: if ($active) {
3471: if ($sec eq '') {
3472: $sec = 'none';
3473: }
3474: $courses{$cdom.'_'.$cnum}{$sec} =
3475: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3476: }
3477: }
1.51 www 3478: }
3479: }
1.474 raeburn 3480: return %courses;
1.51 www 3481: }
1.37 matthew 3482:
1.54 www 3483: ###############################################
1.474 raeburn 3484:
3485: sub blockcheck {
1.482 raeburn 3486: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3487:
3488: if (!defined($udom)) {
3489: $udom = $env{'user.domain'};
3490: }
3491: if (!defined($uname)) {
3492: $uname = $env{'user.name'};
3493: }
3494:
3495: # If uname and udom are for a course, check for blocks in the course.
3496:
3497: if (&Apache::lonnet::is_course($udom,$uname)) {
3498: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3499: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3500: return ($startblock,$endblock);
3501: }
1.474 raeburn 3502:
1.502 raeburn 3503: my $startblock = 0;
3504: my $endblock = 0;
1.482 raeburn 3505: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3506:
1.490 raeburn 3507: # If uname is for a user, and activity is course-specific, i.e.,
3508: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3509:
1.490 raeburn 3510: if (($activity eq 'boards' || $activity eq 'chat' ||
3511: $activity eq 'groups') && ($env{'request.course.id'})) {
3512: foreach my $key (keys(%live_courses)) {
3513: if ($key ne $env{'request.course.id'}) {
3514: delete($live_courses{$key});
3515: }
3516: }
3517: }
3518:
3519: my $otheruser = 0;
3520: my %own_courses;
3521: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3522: # Resource belongs to user other than current user.
3523: $otheruser = 1;
3524: # Gather courses for current user
3525: %own_courses =
3526: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3527: }
3528:
3529: # Gather active course roles - course coordinator, instructor,
3530: # exam proctor, ta, student, or custom role.
1.474 raeburn 3531:
3532: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3533: my ($cdom,$cnum);
3534: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3535: $cdom = $env{'course.'.$course.'.domain'};
3536: $cnum = $env{'course.'.$course.'.num'};
3537: } else {
1.490 raeburn 3538: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3539: }
3540: my $no_ownblock = 0;
3541: my $no_userblock = 0;
1.533 raeburn 3542: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3543: # Check if current user has 'evb' priv for this
3544: if (defined($own_courses{$course})) {
3545: foreach my $sec (keys(%{$own_courses{$course}})) {
3546: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3547: if ($sec ne 'none') {
3548: $checkrole .= '/'.$sec;
3549: }
3550: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3551: $no_ownblock = 1;
3552: last;
3553: }
3554: }
3555: }
3556: # if they have 'evb' priv and are currently not playing student
3557: next if (($no_ownblock) &&
3558: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3559: }
1.474 raeburn 3560: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3561: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3562: if ($sec ne 'none') {
1.482 raeburn 3563: $checkrole .= '/'.$sec;
1.474 raeburn 3564: }
1.490 raeburn 3565: if ($otheruser) {
3566: # Resource belongs to user other than current user.
3567: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3568: my ($trole,$tdom,$tnum,$tsec);
3569: my $entry = $live_courses{$course}{$sec};
3570: if ($entry =~ /^cr/) {
3571: ($trole,$tdom,$tnum,$tsec) =
3572: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3573: } else {
3574: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3575: }
3576: my ($spec,$area,$trest,%allroles,%userroles);
3577: $area = '/'.$tdom.'/'.$tnum;
3578: $trest = $tnum;
3579: if ($tsec ne '') {
3580: $area .= '/'.$tsec;
3581: $trest .= '/'.$tsec;
3582: }
3583: $spec = $trole.'.'.$area;
3584: if ($trole =~ /^cr/) {
3585: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3586: $tdom,$spec,$trest,$area);
3587: } else {
3588: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3589: $tdom,$spec,$trest,$area);
3590: }
3591: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3592: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3593: if ($1) {
3594: $no_userblock = 1;
3595: last;
3596: }
3597: }
1.490 raeburn 3598: } else {
3599: # Resource belongs to current user
3600: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3601: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3602: $no_ownblock = 1;
3603: last;
3604: }
1.474 raeburn 3605: }
3606: }
3607: # if they have the evb priv and are currently not playing student
1.482 raeburn 3608: next if (($no_ownblock) &&
1.491 albertel 3609: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3610: next if ($no_userblock);
1.474 raeburn 3611:
1.490 raeburn 3612: # Retrieve blocking times and identity of blocker for course
3613: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3614:
3615: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3616: if (($start != 0) &&
3617: (($startblock == 0) || ($startblock > $start))) {
3618: $startblock = $start;
3619: }
3620: if (($end != 0) &&
3621: (($endblock == 0) || ($endblock < $end))) {
3622: $endblock = $end;
3623: }
1.490 raeburn 3624: }
3625: return ($startblock,$endblock);
3626: }
3627:
3628: sub get_blocks {
3629: my ($setters,$activity,$cdom,$cnum) = @_;
3630: my $startblock = 0;
3631: my $endblock = 0;
3632: my $course = $cdom.'_'.$cnum;
3633: $setters->{$course} = {};
3634: $setters->{$course}{'staff'} = [];
3635: $setters->{$course}{'times'} = [];
3636: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3637: foreach my $record (keys(%records)) {
3638: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3639: if ($start <= time && $end >= time) {
3640: my ($staff_name,$staff_dom,$title,$blocks) =
3641: &parse_block_record($records{$record});
3642: if ($blocks->{$activity} eq 'on') {
3643: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3644: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3645: if ( ($startblock == 0) || ($startblock > $start) ) {
3646: $startblock = $start;
1.490 raeburn 3647: }
1.491 albertel 3648: if ( ($endblock == 0) || ($endblock < $end) ) {
3649: $endblock = $end;
1.474 raeburn 3650: }
3651: }
3652: }
3653: }
3654: return ($startblock,$endblock);
3655: }
3656:
3657: sub parse_block_record {
3658: my ($record) = @_;
3659: my ($setuname,$setudom,$title,$blocks);
3660: if (ref($record) eq 'HASH') {
3661: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3662: $title = &unescape($record->{'event'});
3663: $blocks = $record->{'blocks'};
3664: } else {
3665: my @data = split(/:/,$record,3);
3666: if (scalar(@data) eq 2) {
3667: $title = $data[1];
3668: ($setuname,$setudom) = split(/@/,$data[0]);
3669: } else {
3670: ($setuname,$setudom,$title) = @data;
3671: }
3672: $blocks = { 'com' => 'on' };
3673: }
3674: return ($setuname,$setudom,$title,$blocks);
3675: }
3676:
3677: sub build_block_table {
3678: my ($startblock,$endblock,$setters) = @_;
3679: my %lt = &Apache::lonlocal::texthash(
3680: 'cacb' => 'Currently active communication blocks',
3681: 'cour' => 'Course',
3682: 'dura' => 'Duration',
3683: 'blse' => 'Block set by'
3684: );
3685: my $output;
1.476 raeburn 3686: $output = '<br />'.$lt{'cacb'}.':<br />';
1.474 raeburn 3687: $output .= &start_data_table();
3688: $output .= '
3689: <tr>
3690: <th>'.$lt{'cour'}.'</th>
3691: <th>'.$lt{'dura'}.'</th>
3692: <th>'.$lt{'blse'}.'</th>
3693: </tr>
3694: ';
3695: foreach my $course (keys(%{$setters})) {
3696: my %courseinfo=&Apache::lonnet::coursedescription($course);
3697: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
3698: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490 raeburn 3699: my $fullname = &plainname($uname,$udom);
3700: if (defined($env{'user.name'}) && defined($env{'user.domain'})
3701: && $env{'user.name'} ne 'public'
3702: && $env{'user.domain'} ne 'public') {
3703: $fullname = &aboutmewrapper($fullname,$uname,$udom);
3704: }
1.474 raeburn 3705: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
3706: $openblock = &Apache::lonlocal::locallocaltime($openblock);
3707: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
3708: $output .= &Apache::loncommon::start_data_table_row().
3709: '<td>'.$courseinfo{'description'}.'</td>'.
3710: '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490 raeburn 3711: '<td>'.$fullname.'</td>'.
1.474 raeburn 3712: &Apache::loncommon::end_data_table_row();
3713: }
3714: }
3715: $output .= &end_data_table();
3716: }
3717:
1.490 raeburn 3718: sub blocking_status {
3719: my ($activity,$uname,$udom) = @_;
3720: my %setters;
3721: my ($blocked,$output,$ownitem,$is_course);
3722: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
3723: if ($startblock && $endblock) {
3724: $blocked = 1;
3725: if (wantarray) {
3726: my $category;
3727: if ($activity eq 'boards') {
3728: $category = 'Discussion posts in this course';
3729: } elsif ($activity eq 'blogs') {
3730: $category = 'Blogs';
3731: } elsif ($activity eq 'port') {
3732: if (defined($uname) && defined($udom)) {
3733: if ($uname eq $env{'user.name'} &&
3734: $udom eq $env{'user.domain'}) {
3735: $ownitem = 1;
3736: }
3737: }
3738: $is_course = &Apache::lonnet::is_course($udom,$uname);
3739: if ($ownitem) {
3740: $category = 'Your portfolio files';
3741: } elsif ($is_course) {
3742: my $coursedesc;
3743: foreach my $course (keys(%setters)) {
3744: my %courseinfo =
3745: &Apache::lonnet::coursedescription($course);
3746: $coursedesc = $courseinfo{'description'};
3747: }
3748: $category = "Group files in the course '$coursedesc'";
3749: } else {
3750: $category = 'Portfolio files belonging to ';
3751: if ($env{'user.name'} eq 'public' &&
3752: $env{'user.domain'} eq 'public') {
3753: $category .= &plainname($uname,$udom);
3754: } else {
3755: $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);
3756: }
3757: }
3758: } elsif ($activity eq 'groups') {
3759: $category = 'Groups in this course';
3760: }
3761: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
3762: my $showend = &Apache::lonlocal::locallocaltime($endblock);
3763: $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
3764: if (!($activity eq 'port' && !($ownitem) && !($is_course))) {
3765: $output .= &build_block_table($startblock,$endblock,\%setters);
3766: }
3767: }
3768: }
3769: if (wantarray) {
3770: return ($blocked,$output);
3771: } else {
3772: return $blocked;
3773: }
3774: }
3775:
1.60 matthew 3776: ###############################################
3777:
1.682 raeburn 3778: sub check_ip_acc {
3779: my ($acc)=@_;
3780: &Apache::lonxml::debug("acc is $acc");
3781: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
3782: return 1;
3783: }
3784: my $allowed=0;
3785: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
3786:
3787: my $name;
3788: foreach my $pattern (split(',',$acc)) {
3789: $pattern =~ s/^\s*//;
3790: $pattern =~ s/\s*$//;
3791: if ($pattern =~ /\*$/) {
3792: #35.8.*
3793: $pattern=~s/\*//;
3794: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3795: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
3796: #35.8.3.[34-56]
3797: my $low=$2;
3798: my $high=$3;
3799: $pattern=$1;
3800: if ($ip =~ /^\Q$pattern\E/) {
3801: my $last=(split(/\./,$ip))[3];
3802: if ($last <=$high && $last >=$low) { $allowed=1; }
3803: }
3804: } elsif ($pattern =~ /^\*/) {
3805: #*.msu.edu
3806: $pattern=~s/\*//;
3807: if (!defined($name)) {
3808: use Socket;
3809: my $netaddr=inet_aton($ip);
3810: ($name)=gethostbyaddr($netaddr,AF_INET);
3811: }
3812: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3813: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
3814: #127.0.0.1
3815: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3816: } else {
3817: #some.name.com
3818: if (!defined($name)) {
3819: use Socket;
3820: my $netaddr=inet_aton($ip);
3821: ($name)=gethostbyaddr($netaddr,AF_INET);
3822: }
3823: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3824: }
3825: if ($allowed) { last; }
3826: }
3827: return $allowed;
3828: }
3829:
3830: ###############################################
3831:
1.60 matthew 3832: =pod
3833:
1.112 bowersj2 3834: =head1 Domain Template Functions
3835:
3836: =over 4
3837:
3838: =item * &determinedomain()
1.60 matthew 3839:
3840: Inputs: $domain (usually will be undef)
3841:
1.63 www 3842: Returns: Determines which domain should be used for designs
1.60 matthew 3843:
3844: =cut
1.54 www 3845:
1.60 matthew 3846: ###############################################
1.63 www 3847: sub determinedomain {
3848: my $domain=shift;
1.531 albertel 3849: if (! $domain) {
1.60 matthew 3850: # Determine domain if we have not been given one
3851: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258 albertel 3852: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
3853: if ($env{'request.role.domain'}) {
3854: $domain=$env{'request.role.domain'};
1.60 matthew 3855: }
3856: }
1.63 www 3857: return $domain;
3858: }
3859: ###############################################
1.517 raeburn 3860:
1.518 albertel 3861: sub devalidate_domconfig_cache {
3862: my ($udom)=@_;
3863: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
3864: }
3865:
3866: # ---------------------- Get domain configuration for a domain
3867: sub get_domainconf {
3868: my ($udom) = @_;
3869: my $cachetime=1800;
3870: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
3871: if (defined($cached)) { return %{$result}; }
3872:
3873: my %domconfig = &Apache::lonnet::get_dom('configuration',
3874: ['login','rolecolors'],$udom);
1.632 raeburn 3875: my (%designhash,%legacy);
1.518 albertel 3876: if (keys(%domconfig) > 0) {
3877: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 3878: if (keys(%{$domconfig{'login'}})) {
3879: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 3880: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
3881: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
3882: $designhash{$udom.'.login.'.$key.'_'.$img} =
3883: $domconfig{'login'}{$key}{$img};
3884: }
3885: } else {
3886: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
3887: }
1.632 raeburn 3888: }
3889: } else {
3890: $legacy{'login'} = 1;
1.518 albertel 3891: }
1.632 raeburn 3892: } else {
3893: $legacy{'login'} = 1;
1.518 albertel 3894: }
3895: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 3896: if (keys(%{$domconfig{'rolecolors'}})) {
3897: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
3898: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
3899: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
3900: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
3901: }
1.518 albertel 3902: }
3903: }
1.632 raeburn 3904: } else {
3905: $legacy{'rolecolors'} = 1;
1.518 albertel 3906: }
1.632 raeburn 3907: } else {
3908: $legacy{'rolecolors'} = 1;
1.518 albertel 3909: }
1.632 raeburn 3910: if (keys(%legacy) > 0) {
3911: my %legacyhash = &get_legacy_domconf($udom);
3912: foreach my $item (keys(%legacyhash)) {
3913: if ($item =~ /^\Q$udom\E\.login/) {
3914: if ($legacy{'login'}) {
3915: $designhash{$item} = $legacyhash{$item};
3916: }
3917: } else {
3918: if ($legacy{'rolecolors'}) {
3919: $designhash{$item} = $legacyhash{$item};
3920: }
1.518 albertel 3921: }
3922: }
3923: }
1.632 raeburn 3924: } else {
3925: %designhash = &get_legacy_domconf($udom);
1.518 albertel 3926: }
3927: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
3928: $cachetime);
3929: return %designhash;
3930: }
3931:
1.632 raeburn 3932: sub get_legacy_domconf {
3933: my ($udom) = @_;
3934: my %legacyhash;
3935: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
3936: my $designfile = $designdir.'/'.$udom.'.tab';
3937: if (-e $designfile) {
3938: if ( open (my $fh,"<$designfile") ) {
3939: while (my $line = <$fh>) {
3940: next if ($line =~ /^\#/);
3941: chomp($line);
3942: my ($key,$val)=(split(/\=/,$line));
3943: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
3944: }
3945: close($fh);
3946: }
3947: }
3948: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
3949: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
3950: }
3951: return %legacyhash;
3952: }
3953:
1.63 www 3954: =pod
3955:
1.112 bowersj2 3956: =item * &domainlogo()
1.63 www 3957:
3958: Inputs: $domain (usually will be undef)
3959:
3960: Returns: A link to a domain logo, if the domain logo exists.
3961: If the domain logo does not exist, a description of the domain.
3962:
3963: =cut
1.112 bowersj2 3964:
1.63 www 3965: ###############################################
3966: sub domainlogo {
1.517 raeburn 3967: my $domain = &determinedomain(shift);
1.518 albertel 3968: my %designhash = &get_domainconf($domain);
1.517 raeburn 3969: # See if there is a logo
3970: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 3971: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 3972: if ($imgsrc =~ m{^/(adm|res)/}) {
3973: if ($imgsrc =~ m{^/res/}) {
3974: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
3975: &Apache::lonnet::repcopy($local_name);
3976: }
3977: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 3978: }
3979: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 3980: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
3981: return &Apache::lonnet::domain($domain,'description');
1.59 www 3982: } else {
1.60 matthew 3983: return '';
1.59 www 3984: }
3985: }
1.63 www 3986: ##############################################
3987:
3988: =pod
3989:
1.112 bowersj2 3990: =item * &designparm()
1.63 www 3991:
3992: Inputs: $which parameter; $domain (usually will be undef)
3993:
3994: Returns: value of designparamter $which
3995:
3996: =cut
1.112 bowersj2 3997:
1.397 albertel 3998:
1.400 albertel 3999: ##############################################
1.397 albertel 4000: sub designparm {
4001: my ($which,$domain)=@_;
1.258 albertel 4002: if ($env{'browser.blackwhite'} eq 'on') {
1.635 raeburn 4003: if ($which=~/\.(font|alink|vlink|link|textcol)$/) {
1.110 www 4004: return '#000000';
4005: }
1.635 raeburn 4006: if ($which=~/\.(pgbg|sidebg|bgcol)$/) {
1.110 www 4007: return '#FFFFFF';
4008: }
4009: if ($which=~/\.tabbg$/) {
4010: return '#CCCCCC';
4011: }
4012: }
1.397 albertel 4013: if (exists($env{'environment.color.'.$which})) {
1.258 albertel 4014: return $env{'environment.color.'.$which};
1.96 www 4015: }
1.63 www 4016: $domain=&determinedomain($domain);
1.518 albertel 4017: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4018: my $output;
1.517 raeburn 4019: if ($domdesign{$domain.'.'.$which} ne '') {
1.520 raeburn 4020: $output = $domdesign{$domain.'.'.$which};
1.63 www 4021: } else {
1.520 raeburn 4022: $output = $defaultdesign{$which};
4023: }
4024: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4025: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4026: if ($output =~ m{^/(adm|res)/}) {
4027: if ($output =~ m{^/res/}) {
4028: my $local_name = &Apache::lonnet::filelocation('',$output);
4029: &Apache::lonnet::repcopy($local_name);
4030: }
1.520 raeburn 4031: $output = &lonhttpdurl($output);
4032: }
1.63 www 4033: }
1.520 raeburn 4034: return $output;
1.63 www 4035: }
1.59 www 4036:
1.60 matthew 4037: ###############################################
4038: ###############################################
4039:
4040: =pod
4041:
1.112 bowersj2 4042: =back
4043:
1.549 albertel 4044: =head1 HTML Helpers
1.112 bowersj2 4045:
4046: =over 4
4047:
4048: =item * &bodytag()
1.60 matthew 4049:
4050: Returns a uniform header for LON-CAPA web pages.
4051:
4052: Inputs:
4053:
1.112 bowersj2 4054: =over 4
4055:
4056: =item * $title, A title to be displayed on the page.
4057:
4058: =item * $function, the current role (can be undef).
4059:
4060: =item * $addentries, extra parameters for the <body> tag.
4061:
4062: =item * $bodyonly, if defined, only return the <body> tag.
4063:
4064: =item * $domain, if defined, force a given domain.
4065:
4066: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4067: text interface only)
1.60 matthew 4068:
1.326 albertel 4069: =item * $customtitle, alternate text to use instead of $title
4070: in the title box that appears, this text
4071: is not auto translated like the $title is
1.309 albertel 4072:
4073: =item * $notopbar, if true, keep the 'what is this' info but remove the
4074: navigational links
1.317 albertel 4075:
1.338 albertel 4076: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4077:
4078: =item * $notitle, if true keep the nav controls, but remove the title bar
4079:
1.361 albertel 4080: =item * $no_inline_link, if true and in remote mode, don't show the
4081: 'Switch To Inline Menu' link
4082:
1.460 albertel 4083: =item * $args, optional argument valid values are
4084: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4085: inherit_jsmath -> when creating popup window in a page,
4086: should it have jsmath forced on by the
4087: current page
1.460 albertel 4088:
1.112 bowersj2 4089: =back
4090:
1.60 matthew 4091: Returns: A uniform header for LON-CAPA web pages.
4092: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4093: If $bodyonly is undef or zero, an html string containing a <body> tag and
4094: other decorations will be returned.
4095:
4096: =cut
4097:
1.54 www 4098: sub bodytag {
1.309 albertel 4099: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.460 albertel 4100: $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
1.339 albertel 4101:
1.460 albertel 4102: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4103:
1.183 matthew 4104: $function = &get_users_function() if (!$function);
1.339 albertel 4105: my $img = &designparm($function.'.img',$domain);
4106: my $font = &designparm($function.'.font',$domain);
4107: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4108:
4109: my %design = ( 'style' => 'margin-top: 0px',
1.535 albertel 4110: 'bgcolor' => $pgbg,
1.339 albertel 4111: 'text' => $font,
4112: 'alink' => &designparm($function.'.alink',$domain),
4113: 'vlink' => &designparm($function.'.vlink',$domain),
4114: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4115: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4116:
1.63 www 4117: # role and realm
1.378 raeburn 4118: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4119: if ($role eq 'ca') {
1.479 albertel 4120: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4121: $realm = &plainname($rname,$rdom);
1.378 raeburn 4122: }
1.55 www 4123: # realm
1.258 albertel 4124: if ($env{'request.course.id'}) {
1.378 raeburn 4125: if ($env{'request.role'} !~ /^cr/) {
4126: $role = &Apache::lonnet::plaintext($role,&course_type());
4127: }
1.359 albertel 4128: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4129: } else {
4130: $role = &Apache::lonnet::plaintext($role);
1.54 www 4131: }
1.433 albertel 4132:
1.359 albertel 4133: if (!$realm) { $realm=' '; }
1.55 www 4134: # Set messages
1.60 matthew 4135: my $messages=&domainlogo($domain);
1.330 albertel 4136:
1.438 albertel 4137: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4138:
1.101 www 4139: # construct main body tag
1.359 albertel 4140: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4141: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4142:
1.530 albertel 4143: if ($bodyonly) {
1.60 matthew 4144: return $bodytag;
1.258 albertel 4145: } elsif ($env{'browser.interface'} eq 'textual') {
1.95 www 4146: # Accessibility
1.224 raeburn 4147:
1.337 albertel 4148: $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
1.338 albertel 4149: if (!$notitle) {
1.337 albertel 4150: $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
4151: }
4152: return $bodytag;
1.359 albertel 4153: }
4154:
1.410 albertel 4155: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4156: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4157: undef($role);
1.434 albertel 4158: } else {
4159: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4160: }
1.359 albertel 4161:
4162: my $roleinfo=(<<ENDROLE);
4163: <td class="LC_title_bar_who">
4164: <div class="LC_title_bar_name">
1.410 albertel 4165: $name
1.361 albertel 4166:
1.359 albertel 4167: </div>
4168: <div class="LC_title_bar_role">
1.361 albertel 4169: $role
1.359 albertel 4170: </div>
4171: <div class="LC_title_bar_realm">
1.361 albertel 4172: $realm
1.359 albertel 4173: </div>
1.206 albertel 4174: </td>
4175: ENDROLE
1.235 raeburn 4176:
1.359 albertel 4177: my $titleinfo = '<span class="LC_title_bar_title">'.$title.'</span>';
4178: if ($customtitle) {
4179: $titleinfo = $customtitle;
4180: }
4181: #
4182: # Extra info if you are the DC
4183: my $dc_info = '';
4184: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4185: $env{'course.'.$env{'request.course.id'}.
4186: '.domain'}.'/'})) {
4187: my $cid = $env{'request.course.id'};
4188: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4189: $dc_info =~ s/\s+$//;
1.359 albertel 4190: $dc_info = '('.$dc_info.')';
4191: }
4192:
1.644 www 4193: if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359 albertel 4194: # No Remote
1.258 albertel 4195: if ($env{'request.state'} eq 'construct') {
1.359 albertel 4196: $forcereg=1;
4197: }
4198:
4199: if (!$customtitle && $env{'request.state'} eq 'construct') {
4200: # this is for resources; directories have customtitle, and crumbs
4201: # and select recent are created in lonpubdir.pm
1.229 albertel 4202: my ($uname,$thisdisfn)=
1.258 albertel 4203: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229 albertel 4204: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4205: $formaction=~s/\/+/\//g;
4206:
1.359 albertel 4207: my $parentpath = '';
4208: my $lastitem = '';
4209: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4210: $parentpath = $1;
4211: $lastitem = $2;
4212: } else {
4213: $lastitem = $thisdisfn;
4214: }
4215: $titleinfo =
1.640 bisitz 4216: &Apache::loncommon::help_open_menu('','',3,'Authoring')
4217: .'<b>'.&mt('Construction Space').'</b>: '
4218: .'<form name="dirs" method="post" action="'.$formaction
1.359 albertel 4219: .'" target="_top"><tt><b>'
1.705 tempelho 4220: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<span class=\"LC_fontsize_big\">$lastitem</span></b></tt><br />"
1.359 albertel 4221: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4222: .'</form>'
4223: .&Apache::lonmenu::constspaceform();
1.235 raeburn 4224: }
1.359 albertel 4225:
1.337 albertel 4226: my $titletable;
1.338 albertel 4227: if (!$notitle) {
1.337 albertel 4228: $titletable =
1.359 albertel 4229: '<table id="LC_title_bar">'.
4230: "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
4231: '</tr></table>';
1.337 albertel 4232: }
1.359 albertel 4233: if ($notopbar) {
4234: $bodytag .= $titletable;
4235: } else {
4236: if ($env{'request.state'} eq 'construct') {
1.337 albertel 4237: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
4238: $titletable);
1.272 raeburn 4239: } else {
1.336 albertel 4240: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359 albertel 4241: $titletable;
1.272 raeburn 4242: }
1.235 raeburn 4243: }
4244: return $bodytag;
1.94 www 4245: }
1.95 www 4246:
1.93 www 4247: #
1.95 www 4248: # Top frame rendering, Remote is up
1.93 www 4249: #
1.359 albertel 4250:
1.517 raeburn 4251: my $imgsrc = $img;
4252: if ($img =~ /^\/adm/) {
1.575 albertel 4253: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4254: }
4255: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4256:
1.305 www 4257: # Explicit link to get inline menu
1.361 albertel 4258: my $menu= ($no_inline_link?''
4259: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245 matthew 4260: #
1.338 albertel 4261: if ($notitle) {
1.337 albertel 4262: return $bodytag;
4263: }
1.94 www 4264: return(<<ENDBODY);
1.60 matthew 4265: $bodytag
1.359 albertel 4266: <table id="LC_title_bar" class="LC_with_remote">
1.368 albertel 4267: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
1.359 albertel 4268: <td class="LC_title_bar_domain_logo">$messages </td>
1.54 www 4269: </tr>
1.359 albertel 4270: <tr><td>$titleinfo $dc_info $menu</td>
4271: $roleinfo
1.368 albertel 4272: </tr>
1.356 albertel 4273: </table>
1.54 www 4274: ENDBODY
1.182 matthew 4275: }
4276:
1.330 albertel 4277: sub make_attr_string {
4278: my ($register,$attr_ref) = @_;
4279:
4280: if ($attr_ref && !ref($attr_ref)) {
4281: die("addentries Must be a hash ref ".
4282: join(':',caller(1))." ".
4283: join(':',caller(0))." ");
4284: }
4285:
4286: if ($register) {
1.339 albertel 4287: my ($on_load,$on_unload);
4288: foreach my $key (keys(%{$attr_ref})) {
4289: if (lc($key) eq 'onload') {
4290: $on_load.=$attr_ref->{$key}.';';
4291: delete($attr_ref->{$key});
4292:
4293: } elsif (lc($key) eq 'onunload') {
4294: $on_unload.=$attr_ref->{$key}.';';
4295: delete($attr_ref->{$key});
4296: }
4297: }
4298: $attr_ref->{'onload'} =
4299: &Apache::lonmenu::loadevents(). $on_load;
4300: $attr_ref->{'onunload'}=
4301: &Apache::lonmenu::unloadevents().$on_unload;
4302: }
4303:
4304: # Accessibility font enhance
4305: if ($env{'browser.fontenhance'} eq 'on') {
4306: my $style;
4307: foreach my $key (keys(%{$attr_ref})) {
4308: if (lc($key) eq 'style') {
4309: $style.=$attr_ref->{$key}.';';
4310: delete($attr_ref->{$key});
4311: }
4312: }
4313: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4314: }
1.339 albertel 4315:
4316: if ($env{'browser.blackwhite'} eq 'on') {
4317: delete($attr_ref->{'font'});
4318: delete($attr_ref->{'link'});
4319: delete($attr_ref->{'alink'});
4320: delete($attr_ref->{'vlink'});
4321: delete($attr_ref->{'bgcolor'});
4322: delete($attr_ref->{'background'});
4323: }
4324:
1.330 albertel 4325: my $attr_string;
4326: foreach my $attr (keys(%$attr_ref)) {
4327: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4328: }
4329: return $attr_string;
4330: }
4331:
4332:
1.182 matthew 4333: ###############################################
1.251 albertel 4334: ###############################################
4335:
4336: =pod
4337:
4338: =item * &endbodytag()
4339:
4340: Returns a uniform footer for LON-CAPA web pages.
4341:
1.635 raeburn 4342: Inputs: 1 - optional reference to an args hash
4343: If in the hash, key for noredirectlink has a value which evaluates to true,
4344: a 'Continue' link is not displayed if the page contains an
4345: internal redirect in the <head></head> section,
4346: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4347:
4348: =cut
4349:
4350: sub endbodytag {
1.635 raeburn 4351: my ($args) = @_;
1.251 albertel 4352: my $endbodytag='</body>';
1.269 albertel 4353: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4354: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4355: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4356: $endbodytag=
4357: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4358: &mt('Continue').'</a>'.
4359: $endbodytag;
4360: }
1.315 albertel 4361: }
1.251 albertel 4362: return $endbodytag;
4363: }
4364:
1.352 albertel 4365: =pod
4366:
4367: =item * &standard_css()
4368:
4369: Returns a style sheet
4370:
4371: Inputs: (all optional)
4372: domain -> force to color decorate a page for a specific
4373: domain
4374: function -> force usage of a specific rolish color scheme
4375: bgcolor -> override the default page bgcolor
4376:
4377: =cut
4378:
1.343 albertel 4379: sub standard_css {
1.345 albertel 4380: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4381: $function = &get_users_function() if (!$function);
4382: my $img = &designparm($function.'.img', $domain);
4383: my $tabbg = &designparm($function.'.tabbg', $domain);
4384: my $font = &designparm($function.'.font', $domain);
1.345 albertel 4385: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4386: my $pgbg_or_bgcolor =
4387: $bgcolor ||
1.352 albertel 4388: &designparm($function.'.pgbg', $domain);
1.382 albertel 4389: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4390: my $alink = &designparm($function.'.alink', $domain);
4391: my $vlink = &designparm($function.'.vlink', $domain);
4392: my $link = &designparm($function.'.link', $domain);
4393:
1.704 muellerd 4394: my $loginbg = &designparm('login.sidebg',$domain);
4395:
1.602 albertel 4396: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4397: my $mono = 'monospace';
1.352 albertel 4398: my $data_table_head = $tabbg;
4399: my $data_table_light = '#EEEEEE';
1.470 banghart 4400: my $data_table_dark = '#DDDDDD';
4401: my $data_table_darker = '#CCCCCC';
1.349 albertel 4402: my $data_table_highlight = '#FFFF00';
1.352 albertel 4403: my $mail_new = '#FFBB77';
4404: my $mail_new_hover = '#DD9955';
4405: my $mail_read = '#BBBB77';
4406: my $mail_read_hover = '#999944';
4407: my $mail_replied = '#AAAA88';
4408: my $mail_replied_hover = '#888855';
4409: my $mail_other = '#99BBBB';
4410: my $mail_other_hover = '#669999';
1.391 albertel 4411: my $table_header = '#DDDDDD';
1.489 raeburn 4412: my $feedback_link_bg = '#BBBBBB';
1.701 harmsja 4413: my $lg_border_color = '#C8C8C8';
1.392 albertel 4414:
1.608 albertel 4415: my $border = ($env{'browser.type'} eq 'explorer' ||
4416: $env{'browser.type'} eq 'safari' ) ? '0px 2px 0px 2px'
4417: : '0px 3px 0px 4px';
1.448 albertel 4418:
1.523 albertel 4419:
1.343 albertel 4420: return <<END;
1.698 harmsja 4421: body{
4422: font-family: $sans;
4423: line-height:130%;
1.701 harmsja 4424: font-size:0.83em;
1.698 harmsja 4425: color:$font;
4426: }
1.701 harmsja 4427: a:link, a:visited { font-size:100%; }
1.698 harmsja 4428:
1.343 albertel 4429: a:focus { color: red; background: yellow }
1.510 albertel 4430: table.thinborder,
4431: table.thinborder tr th {
4432: border-style: solid;
4433: border-width: 1px;
1.698 harmsja 4434: border-color: $lg_border_color;
1.510 albertel 4435: background: $tabbg;
4436: }
1.523 albertel 4437: table.thinborder tr td {
1.510 albertel 4438: border-style: solid;
1.698 harmsja 4439: border-width: 1px;
4440: border-color: $lg_border_color;
1.510 albertel 4441: }
1.426 albertel 4442:
1.343 albertel 4443: form, .inline { display: inline; }
4444: .center { text-align: center; }
1.701 harmsja 4445: .left { text-align:left; }
4446: .right {text-align:right;}
4447: .middle {vertical-align:middle;}
4448: .top {vertical-align:top;}
4449: .bottom {vertical-align:bottom;}
1.593 albertel 4450: .LC_filename {font-family: $mono; white-space:pre;}
1.350 albertel 4451: .LC_error {
4452: color: red;
4453: font-size: larger;
4454: }
1.457 albertel 4455: .LC_warning,
4456: .LC_diff_removed {
1.394 albertel 4457: color: red;
4458: }
1.532 albertel 4459:
4460: .LC_info,
1.457 albertel 4461: .LC_success,
4462: .LC_diff_added {
1.350 albertel 4463: color: green;
4464: }
1.543 albertel 4465: .LC_unknown {
4466: color: yellow;
4467: }
4468:
1.440 albertel 4469: .LC_icon {
4470: border: 0px;
4471: }
1.539 albertel 4472: .LC_indexer_icon {
4473: border: 0px;
4474: height: 22px;
4475: }
1.543 albertel 4476: .LC_docs_spacer {
4477: width: 25px;
4478: height: 1px;
4479: border: 0px;
4480: }
1.346 albertel 4481:
1.532 albertel 4482: .LC_internal_info {
4483: color: #999;
4484: }
4485:
1.458 albertel 4486: table.LC_pastsubmission {
4487: border: 1px solid black;
4488: margin: 2px;
4489: }
4490:
1.606 albertel 4491: table#LC_top_nav, table#LC_menubuttons,table#LC_nav_location {
1.345 albertel 4492: width: 100%;
4493: background: $pgbg;
1.392 albertel 4494: border: 2px;
1.402 albertel 4495: border-collapse: separate;
1.403 albertel 4496: padding: 0px;
1.345 albertel 4497: }
1.392 albertel 4498:
1.606 albertel 4499: table#LC_title_bar, table.LC_breadcrumbs,
1.393 albertel 4500: table#LC_title_bar.LC_with_remote {
1.359 albertel 4501: width: 100%;
1.392 albertel 4502: border-color: $pgbg;
4503: border-style: solid;
4504: border-width: $border;
4505:
1.379 albertel 4506: background: $pgbg;
4507: font-family: $sans;
1.392 albertel 4508: border-collapse: collapse;
1.403 albertel 4509: padding: 0px;
1.359 albertel 4510: }
1.409 albertel 4511: table.LC_docs_path {
4512: width: 100%;
4513: border: 0;
4514: background: $pgbg;
4515: font-family: $sans;
4516: border-collapse: collapse;
4517: padding: 0px;
4518: }
4519:
1.359 albertel 4520: table#LC_title_bar td {
4521: background: $tabbg;
4522: }
4523: table#LC_title_bar td.LC_title_bar_who {
4524: background: $tabbg;
4525: color: $font;
1.427 albertel 4526: font: small $sans;
1.359 albertel 4527: text-align: right;
4528: }
1.469 banghart 4529: span.LC_metadata {
4530: font-family: $sans;
4531: }
1.359 albertel 4532: span.LC_title_bar_title {
1.416 albertel 4533: font: bold x-large $sans;
1.359 albertel 4534: }
4535: table#LC_title_bar td.LC_title_bar_domain_logo {
4536: background: $sidebg;
4537: text-align: right;
1.368 albertel 4538: padding: 0px;
4539: }
4540: table#LC_title_bar td.LC_title_bar_role_logo {
4541: background: $sidebg;
4542: padding: 0px;
1.359 albertel 4543: }
4544:
1.706 harmsja 4545: table#LC_menubuttons img{
1.346 albertel 4546: border: 0px;
4547: }
1.345 albertel 4548: table#LC_top_nav td {
4549: background: $tabbg;
1.392 albertel 4550: border: 0px;
1.407 albertel 4551: font-size: small;
1.706 harmsja 4552: vertical-align:top;
4553: padding:2px 5px 2px 5px;
1.345 albertel 4554: }
4555: table#LC_top_nav td a, div#LC_top_nav a {
4556: color: $font;
4557: font-family: $sans;
4558: }
1.364 albertel 4559: table#LC_top_nav td.LC_top_nav_logo {
4560: background: $tabbg;
1.432 albertel 4561: text-align: left;
1.408 albertel 4562: white-space: nowrap;
1.432 albertel 4563: width: 31px;
1.408 albertel 4564: }
4565: table#LC_top_nav td.LC_top_nav_logo img {
1.432 albertel 4566: border: 0px;
1.408 albertel 4567: vertical-align: bottom;
1.364 albertel 4568: }
1.432 albertel 4569: table#LC_top_nav td.LC_top_nav_exit,
4570: table#LC_top_nav td.LC_top_nav_help {
4571: width: 2.0em;
4572: }
1.442 albertel 4573: table#LC_top_nav td.LC_top_nav_login {
4574: width: 4.0em;
4575: text-align: center;
4576: }
1.409 albertel 4577: table.LC_breadcrumbs td, table.LC_docs_path td {
1.357 albertel 4578: background: $tabbg;
4579: color: $font;
4580: font-family: $sans;
1.358 albertel 4581: font-size: smaller;
1.357 albertel 4582: }
1.411 albertel 4583: table.LC_breadcrumbs td.LC_breadcrumbs_component,
1.409 albertel 4584: table.LC_docs_path td.LC_docs_path_component {
1.357 albertel 4585: background: $tabbg;
4586: color: $font;
4587: font-family: $sans;
4588: font-size: larger;
4589: text-align: right;
4590: }
1.383 albertel 4591: td.LC_table_cell_checkbox {
4592: text-align: center;
4593: }
1.522 albertel 4594: table#LC_mainmenu td.LC_mainmenu_column {
4595: vertical-align: top;
4596: }
4597:
1.705 tempelho 4598: .LC_fontsize_small
4599: {
4600: font-size: 70%;
4601: }
4602:
4603: .LC_fontsize_medium
4604: {
4605: font-size: 85%;
4606: }
4607:
4608: .LC_fontsize_large
4609: {
4610: font-size: 120%;
4611: }
4612:
4613: .LC_fontcolor_red
4614: {
4615: color: #FF0000;
4616: }
4617:
1.346 albertel 4618: .LC_menubuttons_inline_text {
4619: color: $font;
4620: font-family: $sans;
1.698 harmsja 4621: font-size: 90%;
1.701 harmsja 4622: padding-left:3px;
1.346 albertel 4623: }
4624:
1.526 www 4625: .LC_menubuttons_link {
4626: text-decoration: none;
4627: }
1.698 harmsja 4628: /*2008--9-5: new menu style sheet.Changed category*/
1.522 albertel 4629: .LC_menubuttons_category {
1.521 www 4630: color: $font;
1.526 www 4631: background: $pgbg;
1.521 www 4632: font-family: $sans;
4633: font-size: larger;
4634: font-weight: bold;
4635: }
4636:
1.346 albertel 4637: td.LC_menubuttons_text {
1.701 harmsja 4638: color: $font;
1.346 albertel 4639: }
1.706 harmsja 4640:
4641:
1.526 www 4642:
1.346 albertel 4643: .LC_current_location {
4644: font-family: $sans;
4645: background: $tabbg;
4646: }
4647: .LC_new_mail {
4648: font-family: $sans;
1.634 www 4649: background: $tabbg;
1.346 albertel 4650: font-weight: bold;
4651: }
1.347 albertel 4652:
1.526 www 4653:
1.527 www 4654: .LC_dropadd_labeltext {
4655: font-family: $sans;
4656: text-align: right;
4657: }
4658:
4659: .LC_preferences_labeltext {
4660: font-family: $sans;
4661: text-align: right;
4662: }
4663:
1.666 raeburn 4664: .LC_roleslog_note {
1.701 harmsja 4665: font-size: small;
1.666 raeburn 4666: }
4667:
1.440 albertel 4668: table.LC_aboutme_port {
4669: border: 0px;
4670: border-collapse: collapse;
4671: border-spacing: 0px;
4672: }
1.349 albertel 4673: table.LC_data_table, table.LC_mail_list {
1.347 albertel 4674: border: 1px solid #000000;
1.402 albertel 4675: border-collapse: separate;
1.426 albertel 4676: border-spacing: 1px;
1.610 albertel 4677: background: $pgbg;
1.347 albertel 4678: }
1.422 albertel 4679: .LC_data_table_dense {
4680: font-size: small;
4681: }
1.507 raeburn 4682: table.LC_nested_outer {
4683: border: 1px solid #000000;
1.589 raeburn 4684: border-collapse: collapse;
1.507 raeburn 4685: border-spacing: 0px;
4686: width: 100%;
4687: }
4688: table.LC_nested {
4689: border: 0px;
1.589 raeburn 4690: border-collapse: collapse;
1.507 raeburn 4691: border-spacing: 0px;
4692: width: 100%;
4693: }
1.523 albertel 4694: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
4695: table.LC_prior_tries tr th {
1.349 albertel 4696: font-weight: bold;
4697: background-color: $data_table_head;
1.701 harmsja 4698: font-size:90%;
1.347 albertel 4699: }
1.610 albertel 4700: table.LC_data_table tr.LC_odd_row > td,
1.440 albertel 4701: table.LC_aboutme_port tr td {
1.349 albertel 4702: background-color: $data_table_light;
1.425 albertel 4703: padding: 2px;
1.347 albertel 4704: }
1.610 albertel 4705: table.LC_data_table tr.LC_even_row > td,
1.440 albertel 4706: table.LC_aboutme_port tr.LC_even_row td {
1.349 albertel 4707: background-color: $data_table_dark;
1.347 albertel 4708: }
1.425 albertel 4709: table.LC_data_table tr.LC_data_table_highlight td {
4710: background-color: $data_table_darker;
4711: }
1.639 raeburn 4712: table.LC_data_table tr td.LC_leftcol_header {
4713: background-color: $data_table_head;
4714: font-weight: bold;
4715: }
1.451 albertel 4716: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 4717: table.LC_nested tr.LC_empty_row td {
1.347 albertel 4718: background-color: #FFFFFF;
1.421 albertel 4719: font-weight: bold;
4720: font-style: italic;
4721: text-align: center;
4722: padding: 8px;
1.347 albertel 4723: }
1.507 raeburn 4724: table.LC_nested tr.LC_empty_row td {
1.465 albertel 4725: padding: 4ex
4726: }
1.507 raeburn 4727: table.LC_nested_outer tr th {
4728: font-weight: bold;
4729: background-color: $data_table_head;
1.701 harmsja 4730: font-size: small;
1.507 raeburn 4731: border-bottom: 1px solid #000000;
4732: }
4733: table.LC_nested_outer tr td.LC_subheader {
4734: background-color: $data_table_head;
4735: font-weight: bold;
4736: font-size: small;
4737: border-bottom: 1px solid #000000;
4738: text-align: right;
1.451 albertel 4739: }
1.507 raeburn 4740: table.LC_nested tr.LC_info_row td {
1.451 albertel 4741: background-color: #CCC;
4742: font-weight: bold;
4743: font-size: small;
1.507 raeburn 4744: text-align: center;
4745: }
1.589 raeburn 4746: table.LC_nested tr.LC_info_row td.LC_left_item,
4747: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 4748: text-align: left;
1.451 albertel 4749: }
1.507 raeburn 4750: table.LC_nested td {
1.451 albertel 4751: background-color: #FFF;
4752: font-size: small;
1.507 raeburn 4753: }
4754: table.LC_nested_outer tr th.LC_right_item,
4755: table.LC_nested tr.LC_info_row td.LC_right_item,
4756: table.LC_nested tr.LC_odd_row td.LC_right_item,
4757: table.LC_nested tr td.LC_right_item {
1.451 albertel 4758: text-align: right;
4759: }
4760:
1.507 raeburn 4761: table.LC_nested tr.LC_odd_row td {
1.451 albertel 4762: background-color: #EEE;
4763: }
4764:
1.473 raeburn 4765: table.LC_createuser {
4766: }
4767:
4768: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 4769: font-size: small;
1.473 raeburn 4770: }
4771:
4772: table.LC_createuser tr.LC_info_row td {
4773: background-color: #CCC;
4774: font-weight: bold;
4775: text-align: center;
4776: }
4777:
1.349 albertel 4778: table.LC_calendar {
4779: border: 1px solid #000000;
4780: border-collapse: collapse;
4781: }
4782: table.LC_calendar_pickdate {
4783: font-size: xx-small;
4784: }
4785: table.LC_calendar tr td {
4786: border: 1px solid #000000;
4787: vertical-align: top;
4788: }
4789: table.LC_calendar tr td.LC_calendar_day_empty {
4790: background-color: $data_table_dark;
4791: }
4792: table.LC_calendar tr td.LC_calendar_day_current {
4793: background-color: $data_table_highlight;
4794: }
4795:
4796: table.LC_mail_list tr.LC_mail_new {
4797: background-color: $mail_new;
4798: }
4799: table.LC_mail_list tr.LC_mail_new:hover {
4800: background-color: $mail_new_hover;
4801: }
4802: table.LC_mail_list tr.LC_mail_read {
4803: background-color: $mail_read;
4804: }
4805: table.LC_mail_list tr.LC_mail_read:hover {
4806: background-color: $mail_read_hover;
4807: }
4808: table.LC_mail_list tr.LC_mail_replied {
4809: background-color: $mail_replied;
4810: }
4811: table.LC_mail_list tr.LC_mail_replied:hover {
4812: background-color: $mail_replied_hover;
4813: }
4814: table.LC_mail_list tr.LC_mail_other {
4815: background-color: $mail_other;
4816: }
4817: table.LC_mail_list tr.LC_mail_other:hover {
4818: background-color: $mail_other_hover;
4819: }
1.494 raeburn 4820: table.LC_mail_list tr.LC_mail_even {
4821: }
4822: table.LC_mail_list tr.LC_mail_odd {
4823: }
4824:
1.696 bisitz 4825: table.LC_data_table tr > td.LC_browser_file,
4826: table.LC_data_table tr > td.LC_browser_file_published {
1.389 albertel 4827: background: #CCFF88;
4828: }
1.696 bisitz 4829: table.LC_data_table tr > td.LC_browser_file_locked,
4830: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 4831: background: #FFAA99;
1.387 albertel 4832: }
1.696 bisitz 4833: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.389 albertel 4834: background: #AAAAAA;
1.387 albertel 4835: }
1.696 bisitz 4836: table.LC_data_table tr > td.LC_browser_file_modified,
4837: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.389 albertel 4838: background: #FFFF77;
1.387 albertel 4839: }
1.696 bisitz 4840: table.LC_data_table tr.LC_browser_folder > td {
1.389 albertel 4841: background: #CCCCFF;
1.387 albertel 4842: }
1.696 bisitz 4843:
1.707 bisitz 4844: table.LC_data_table tr > td.LC_roles_is {
4845: /* background: #77FF77; */
4846: }
4847: table.LC_data_table tr > td.LC_roles_future {
4848: background: #FFFF77;
4849: }
4850: table.LC_data_table tr > td.LC_roles_will {
4851: background: #FFAA77;
4852: }
4853: table.LC_data_table tr > td.LC_roles_expired {
4854: background: #FF7777;
4855: }
4856: table.LC_data_table tr > td.LC_roles_will_not {
4857: background: #AAFF77;
4858: }
4859: table.LC_data_table tr > td.LC_roles_selected {
4860: background: #11CC55;
4861: }
4862:
1.388 albertel 4863: span.LC_current_location {
1.701 harmsja 4864: font-size:larger;
1.388 albertel 4865: background: $pgbg;
4866: }
1.387 albertel 4867:
1.395 albertel 4868: span.LC_parm_menu_item {
4869: font-size: larger;
4870: font-family: $sans;
4871: }
4872: span.LC_parm_scope_all {
4873: color: red;
4874: }
4875: span.LC_parm_scope_folder {
4876: color: green;
4877: }
4878: span.LC_parm_scope_resource {
4879: color: orange;
4880: }
4881: span.LC_parm_part {
4882: color: blue;
4883: }
4884: span.LC_parm_folder, span.LC_parm_symb {
4885: font-size: x-small;
4886: font-family: $mono;
4887: color: #AAAAAA;
4888: }
4889:
1.396 albertel 4890: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
4891: td.LC_parm_overview_parm_selectors, td.LC_parm_overview_parm_restrictions {
4892: border: 1px solid black;
4893: border-collapse: collapse;
4894: }
4895: table.LC_parm_overview_restrictions td {
4896: border-width: 1px 4px 1px 4px;
4897: border-style: solid;
4898: border-color: $pgbg;
4899: text-align: center;
4900: }
4901: table.LC_parm_overview_restrictions th {
4902: background: $tabbg;
4903: border-width: 1px 4px 1px 4px;
4904: border-style: solid;
4905: border-color: $pgbg;
4906: }
1.398 albertel 4907: table#LC_helpmenu {
4908: border: 0px;
4909: height: 55px;
4910: border-spacing: 0px;
4911: }
4912:
4913: table#LC_helpmenu fieldset legend {
4914: font-size: larger;
4915: font-weight: bold;
4916: }
1.397 albertel 4917: table#LC_helpmenu_links {
4918: width: 100%;
4919: border: 1px solid black;
4920: background: $pgbg;
4921: padding: 0px;
4922: border-spacing: 1px;
4923: }
4924: table#LC_helpmenu_links tr td {
4925: padding: 1px;
4926: background: $tabbg;
1.399 albertel 4927: text-align: center;
4928: font-weight: bold;
1.397 albertel 4929: }
1.396 albertel 4930:
1.397 albertel 4931: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
4932: table#LC_helpmenu_links a:active {
4933: text-decoration: none;
4934: color: $font;
4935: }
4936: table#LC_helpmenu_links a:hover {
4937: text-decoration: underline;
4938: color: $vlink;
4939: }
1.396 albertel 4940:
1.417 albertel 4941: .LC_chrt_popup_exists {
4942: border: 1px solid #339933;
4943: margin: -1px;
4944: }
4945: .LC_chrt_popup_up {
4946: border: 1px solid yellow;
4947: margin: -1px;
4948: }
4949: .LC_chrt_popup {
4950: border: 1px solid #8888FF;
4951: background: #CCCCFF;
4952: }
1.421 albertel 4953: table.LC_pick_box {
4954: border-collapse: separate;
4955: background: white;
4956: border: 1px solid black;
4957: border-spacing: 1px;
4958: }
4959: table.LC_pick_box td.LC_pick_box_title {
4960: background: $tabbg;
4961: font-weight: bold;
4962: text-align: right;
4963: width: 184px;
4964: padding: 8px;
4965: }
1.645 raeburn 4966: table.LC_pick_box td.LC_selfenroll_pick_box_title {
4967: background: $tabbg;
4968: font-weight: bold;
4969: text-align: right;
4970: width: 350px;
4971: padding: 8px;
4972: }
4973:
1.579 raeburn 4974: table.LC_pick_box td.LC_pick_box_value {
4975: text-align: left;
4976: padding: 8px;
4977: }
4978: table.LC_pick_box td.LC_pick_box_select {
4979: text-align: left;
4980: padding: 8px;
4981: }
1.424 albertel 4982: table.LC_pick_box td.LC_pick_box_separator {
1.421 albertel 4983: padding: 0px;
4984: height: 1px;
4985: background: black;
4986: }
4987: table.LC_pick_box td.LC_pick_box_submit {
4988: text-align: right;
4989: }
1.579 raeburn 4990: table.LC_pick_box td.LC_evenrow_value {
4991: text-align: left;
4992: padding: 8px;
4993: background-color: $data_table_light;
4994: }
4995: table.LC_pick_box td.LC_oddrow_value {
4996: text-align: left;
4997: padding: 8px;
4998: background-color: $data_table_light;
4999: }
5000: table.LC_helpform_receipt {
5001: width: 620px;
5002: border-collapse: separate;
5003: background: white;
5004: border: 1px solid black;
5005: border-spacing: 1px;
5006: }
5007: table.LC_helpform_receipt td.LC_pick_box_title {
5008: background: $tabbg;
5009: font-weight: bold;
5010: text-align: right;
5011: width: 184px;
5012: padding: 8px;
5013: }
5014: table.LC_helpform_receipt td.LC_evenrow_value {
5015: text-align: left;
5016: padding: 8px;
5017: background-color: $data_table_light;
5018: }
5019: table.LC_helpform_receipt td.LC_oddrow_value {
5020: text-align: left;
5021: padding: 8px;
5022: background-color: $data_table_light;
5023: }
5024: table.LC_helpform_receipt td.LC_pick_box_separator {
5025: padding: 0px;
5026: height: 1px;
5027: background: black;
5028: }
5029: span.LC_helpform_receipt_cat {
5030: font-weight: bold;
5031: }
1.424 albertel 5032: table.LC_group_priv_box {
5033: background: white;
5034: border: 1px solid black;
5035: border-spacing: 1px;
5036: }
5037: table.LC_group_priv_box td.LC_pick_box_title {
5038: background: $tabbg;
5039: font-weight: bold;
5040: text-align: right;
5041: width: 184px;
5042: }
5043: table.LC_group_priv_box td.LC_groups_fixed {
5044: background: $data_table_light;
5045: text-align: center;
5046: }
5047: table.LC_group_priv_box td.LC_groups_optional {
5048: background: $data_table_dark;
5049: text-align: center;
5050: }
5051: table.LC_group_priv_box td.LC_groups_functionality {
5052: background: $data_table_darker;
5053: text-align: center;
5054: font-weight: bold;
5055: }
5056: table.LC_group_priv td {
5057: text-align: left;
5058: padding: 0px;
5059: }
5060:
1.421 albertel 5061: table.LC_notify_front_page {
5062: background: white;
5063: border: 1px solid black;
5064: padding: 8px;
5065: }
5066: table.LC_notify_front_page td {
5067: padding: 8px;
5068: }
1.424 albertel 5069: .LC_navbuttons {
5070: margin: 2ex 0ex 2ex 0ex;
5071: }
1.423 albertel 5072: .LC_topic_bar {
5073: font-family: $sans;
5074: font-weight: bold;
5075: width: 100%;
5076: background: $tabbg;
5077: vertical-align: middle;
5078: margin: 2ex 0ex 2ex 0ex;
5079: }
5080: .LC_topic_bar span {
5081: vertical-align: middle;
5082: }
5083: .LC_topic_bar img {
5084: vertical-align: bottom;
5085: }
5086: table.LC_course_group_status {
5087: margin: 20px;
5088: }
5089: table.LC_status_selector td {
5090: vertical-align: top;
5091: text-align: center;
1.424 albertel 5092: padding: 4px;
5093: }
5094: table.LC_descriptive_input td.LC_description {
5095: vertical-align: top;
5096: text-align: right;
5097: font-weight: bold;
1.423 albertel 5098: }
1.599 albertel 5099: div.LC_feedback_link {
1.616 albertel 5100: clear: both;
1.599 albertel 5101: background: white;
5102: width: 100%;
1.489 raeburn 5103: }
5104: span.LC_feedback_link {
1.599 albertel 5105: background: $feedback_link_bg;
5106: font-size: larger;
5107: }
5108: span.LC_message_link {
5109: background: $feedback_link_bg;
5110: font-size: larger;
5111: position: absolute;
5112: right: 1em;
1.489 raeburn 5113: }
1.421 albertel 5114:
1.515 albertel 5115: table.LC_prior_tries {
1.524 albertel 5116: border: 1px solid #000000;
5117: border-collapse: separate;
5118: border-spacing: 1px;
1.515 albertel 5119: }
1.523 albertel 5120:
1.515 albertel 5121: table.LC_prior_tries td {
1.524 albertel 5122: padding: 2px;
1.515 albertel 5123: }
1.523 albertel 5124:
5125: .LC_answer_correct {
5126: background: #AAFFAA;
5127: color: black;
5128: }
5129: .LC_answer_charged_try {
5130: background: #FFAAAA ! important;
5131: color: black;
5132: }
5133: .LC_answer_not_charged_try,
5134: .LC_answer_no_grade,
5135: .LC_answer_late {
5136: background: #FFFFAA;
5137: color: black;
5138: }
5139: .LC_answer_previous {
5140: background: #AAAAFF;
5141: color: black;
5142: }
5143: .LC_answer_no_message {
5144: background: #FFFFFF;
5145: color: black;
5146: }
5147: .LC_answer_unknown {
5148: background: orange;
5149: color: black;
5150: }
5151:
5152:
1.529 albertel 5153: span.LC_prior_numerical,
5154: span.LC_prior_string,
5155: span.LC_prior_custom,
5156: span.LC_prior_reaction,
5157: span.LC_prior_math {
1.523 albertel 5158: font-family: monospace;
5159: white-space: pre;
5160: }
5161:
1.525 albertel 5162: span.LC_prior_string {
5163: font-family: monospace;
5164: white-space: pre;
5165: }
5166:
1.523 albertel 5167: table.LC_prior_option {
5168: width: 100%;
5169: border-collapse: collapse;
5170: }
1.528 albertel 5171: table.LC_prior_rank, table.LC_prior_match {
5172: border-collapse: collapse;
5173: }
5174: table.LC_prior_option tr td,
5175: table.LC_prior_rank tr td,
5176: table.LC_prior_match tr td {
1.524 albertel 5177: border: 1px solid #000000;
1.515 albertel 5178: }
5179:
1.519 raeburn 5180: span.LC_nobreak {
1.544 albertel 5181: white-space: nowrap;
1.519 raeburn 5182: }
5183:
1.576 raeburn 5184: span.LC_cusr_emph {
5185: font-style: italic;
5186: }
5187:
1.633 raeburn 5188: span.LC_cusr_subheading {
5189: font-weight: normal;
5190: font-size: 85%;
5191: }
5192:
1.545 albertel 5193: table.LC_docs_documents {
5194: background: #BBBBBB;
1.547 albertel 5195: border-width: 0px;
1.545 albertel 5196: border-collapse: collapse;
5197: }
5198:
5199: table.LC_docs_documents td.LC_docs_document {
5200: border: 2px solid black;
5201: padding: 4px;
5202: }
5203:
5204: .LC_docs_course_commands div {
5205: float: left;
5206: border: 4px solid #AAAAAA;
5207: padding: 4px;
5208: background: #DDDDCC;
5209: }
5210:
5211: .LC_docs_entry_move {
5212: border: 0px;
5213: border-collapse: collapse;
1.544 albertel 5214: }
5215:
1.545 albertel 5216: .LC_docs_entry_move td {
5217: border: 2px solid #BBBBBB;
5218: background: #DDDDDD;
5219: }
5220:
5221: .LC_docs_editor td.LC_docs_entry_commands {
5222: background: #DDDDDD;
5223: font-size: x-small;
5224: }
1.544 albertel 5225: .LC_docs_copy {
1.545 albertel 5226: color: #000099;
1.544 albertel 5227: }
5228: .LC_docs_cut {
1.545 albertel 5229: color: #550044;
1.544 albertel 5230: }
5231: .LC_docs_rename {
1.545 albertel 5232: color: #009900;
1.544 albertel 5233: }
5234: .LC_docs_remove {
1.545 albertel 5235: color: #990000;
5236: }
5237:
1.547 albertel 5238: .LC_docs_reinit_warn,
5239: .LC_docs_ext_edit {
5240: font-size: x-small;
5241: }
5242:
1.545 albertel 5243: .LC_docs_editor td.LC_docs_entry_title,
5244: .LC_docs_editor td.LC_docs_entry_icon {
5245: background: #FFFFBB;
5246: }
5247: .LC_docs_editor td.LC_docs_entry_parameter {
5248: background: #BBBBFF;
5249: font-size: x-small;
5250: white-space: nowrap;
5251: }
5252:
5253: table.LC_docs_adddocs td,
5254: table.LC_docs_adddocs th {
5255: border: 1px solid #BBBBBB;
5256: padding: 4px;
5257: background: #DDDDDD;
1.543 albertel 5258: }
5259:
1.584 albertel 5260: table.LC_sty_begin {
5261: background: #BBFFBB;
5262: }
5263: table.LC_sty_end {
5264: background: #FFBBBB;
5265: }
5266:
1.589 raeburn 5267: table.LC_double_column {
5268: border-width: 0px;
5269: border-collapse: collapse;
5270: width: 100%;
5271: padding: 2px;
5272: }
5273:
5274: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5275: top: 2px;
1.589 raeburn 5276: left: 2px;
5277: width: 47%;
5278: vertical-align: top;
5279: }
5280:
5281: table.LC_double_column tr td.LC_right_col {
5282: top: 2px;
5283: right: 2px;
5284: width: 47%;
5285: vertical-align: top;
5286: }
5287:
1.594 raeburn 5288: span.LC_role_level {
5289: font-weight: bold;
5290: }
5291:
1.591 raeburn 5292: div.LC_left_float {
5293: float: left;
5294: padding-right: 5%;
1.597 albertel 5295: padding-bottom: 4px;
1.591 raeburn 5296: }
5297:
5298: div.LC_clear_float_header {
1.597 albertel 5299: padding-bottom: 2px;
1.591 raeburn 5300: }
5301:
5302: div.LC_clear_float_footer {
1.597 albertel 5303: padding-top: 10px;
1.591 raeburn 5304: clear: both;
5305: }
5306:
1.597 albertel 5307:
1.601 albertel 5308: div.LC_grade_select_mode {
1.604 albertel 5309: font-family: $sans;
1.601 albertel 5310: }
5311: div.LC_grade_select_mode div div {
5312: margin: 5px;
5313: }
5314: div.LC_grade_select_mode_selector {
5315: margin: 5px;
5316: float: left;
5317: }
5318: div.LC_grade_select_mode_selector_header {
1.705 tempelho 5319: font-weight: bold;
5320: font-size: medium;
1.601 albertel 5321: }
5322: div.LC_grade_select_mode_type {
5323: clear: left;
5324: }
5325:
1.597 albertel 5326: div.LC_grade_show_user {
5327: margin-top: 20px;
5328: border: 1px solid black;
5329: }
5330: div.LC_grade_user_name {
5331: background: #DDDDEE;
5332: border-bottom: 1px solid black;
1.705 tempelho 5333: font-weight: bold;
5334: font-size: large;
1.597 albertel 5335: }
5336: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5337: background: #DDEEDD;
5338: }
5339:
5340: div.LC_grade_show_problem,
5341: div.LC_grade_submissions,
5342: div.LC_grade_message_center,
5343: div.LC_grade_info_links,
5344: div.LC_grade_assign {
5345: margin: 5px;
5346: width: 99%;
5347: background: #FFFFFF;
5348: }
5349: div.LC_grade_show_problem_header,
5350: div.LC_grade_submissions_header,
5351: div.LC_grade_message_center_header,
5352: div.LC_grade_assign_header {
1.705 tempelho 5353: font-weight: bold;
5354: font-size: large;
1.597 albertel 5355: }
5356: div.LC_grade_show_problem_problem,
5357: div.LC_grade_submissions_body,
5358: div.LC_grade_message_center_body,
5359: div.LC_grade_assign_body {
5360: border: 1px solid black;
5361: width: 99%;
5362: background: #FFFFFF;
5363: }
1.598 albertel 5364: span.LC_grade_check_note {
1.705 tempelho 5365: font-weight: normal;
5366: font-size: medium;
1.598 albertel 5367: display: inline;
5368: position: absolute;
5369: right: 1em;
5370: }
1.597 albertel 5371:
1.613 albertel 5372: table.LC_scantron_action {
5373: width: 100%;
5374: }
5375: table.LC_scantron_action tr th {
1.698 harmsja 5376: font-weight:bold;
5377: font-style:normal;
1.613 albertel 5378: }
1.698 harmsja 5379: .LC_edit_problem_header,
1.614 albertel 5380: div.LC_edit_problem_footer {
1.705 tempelho 5381: font-weight: normal;
5382: font-size: medium;
1.602 albertel 5383: margin: 2px;
1.600 albertel 5384: }
5385: div.LC_edit_problem_header,
1.602 albertel 5386: div.LC_edit_problem_header div,
1.614 albertel 5387: div.LC_edit_problem_footer,
5388: div.LC_edit_problem_footer div,
1.602 albertel 5389: div.LC_edit_problem_editxml_header,
5390: div.LC_edit_problem_editxml_header div {
1.600 albertel 5391: margin-top: 5px;
5392: }
1.602 albertel 5393: div.LC_edit_problem_header_edit_row {
5394: background: $tabbg;
5395: padding: 3px;
5396: margin-bottom: 5px;
5397: }
1.600 albertel 5398: div.LC_edit_problem_header_title {
1.705 tempelho 5399: font-weight: bold;
5400: font-size: larger;
1.602 albertel 5401: background: $tabbg;
5402: padding: 3px;
5403: }
5404: table.LC_edit_problem_header_title {
1.705 tempelho 5405: font-size: larger;
5406: font-weight: bold;
1.602 albertel 5407: width: 100%;
5408: border-color: $pgbg;
5409: border-style: solid;
5410: border-width: $border;
5411:
1.600 albertel 5412: background: $tabbg;
1.602 albertel 5413: border-collapse: collapse;
5414: padding: 0px
5415: }
5416:
5417: div.LC_edit_problem_discards {
5418: float: left;
5419: padding-bottom: 5px;
5420: }
5421: div.LC_edit_problem_saves {
5422: float: right;
5423: padding-bottom: 5px;
1.600 albertel 5424: }
5425: hr.LC_edit_problem_divide {
1.602 albertel 5426: clear: both;
1.600 albertel 5427: color: $tabbg;
5428: background-color: $tabbg;
5429: height: 3px;
5430: border: 0px;
5431: }
1.679 riegler 5432: img.stift{
1.678 riegler 5433: border-width:0;
1.679 riegler 5434: vertical-align:middle;
1.677 riegler 5435: }
1.680 riegler 5436:
1.681 riegler 5437: table#LC_mainmenu{
5438: margin-top:10px;
5439: width:80%;
5440:
5441: }
5442:
1.680 riegler 5443: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
5444: vertical-align: top;
5445: width: 45%;
5446: }
5447: .LC_mainmenu_fieldset_category {
5448: color: $font;
5449: background: $pgbg;
5450: font-family: $sans;
5451: font-size: small;
5452: font-weight: bold;
5453: }
5454:
1.693 droeschl 5455: /* ---- Remove when done ----
5456: # The following styles is part of the redesign of LON-CAPA and are
5457: # subject to change during this project.
5458: # Don't rely on their current functionality as they might be
5459: # changed or removed.
5460: # --------------------------*/
5461:
1.698 harmsja 5462: a:hover,
5463: ol.smallMenu a:hover,
5464: ol#MenuBreadcrumbs a:hover,
5465: ul#TabMainMenuContent a:hover,
5466: .FormSectionClearButton input:hover{
5467: color:#BF2317;
5468: text-decoration:none;
1.693 droeschl 5469: }
5470:
5471: h1 {
1.701 harmsja 5472: padding:5px 10px 5px 0px;
1.693 droeschl 5473: line-height:130%;
5474: }
1.698 harmsja 5475:
1.693 droeschl 5476: h2,h3,h4,h5,h6
5477: {
5478: margin:5px 0px 5px 0px;
5479: line-height:130%;
5480: }
1.698 harmsja 5481: .hcell{
5482: padding:3px 15px 3px 15px;
5483: margin:0px;
1.703 harmsja 5484: background-color:$tabbg;
5485: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5486: }
1.698 harmsja 5487: .noBorder {
5488: border:0px;
5489: }
5490: /*
5491: .bgLightGrey { background:URL(images/TabMenuBG.png) repeat-x left top; }
5492: .bgLightGreyYellow {background-color:#EFECE0;}
5493: */
1.693 droeschl 5494:
5495:
1.698 harmsja 5496: /* Main Header with discription of Person, Course, etc. */
1.693 droeschl 5497: .HeadRight {
5498: text-align: right;
5499: float: right;
5500: margin: 0px;
5501: padding: 0px;
1.698 harmsja 5502: right:0;
1.693 droeschl 5503: position:absolute;
1.698 harmsja 5504: overflow:hidden;
1.693 droeschl 5505: }
5506:
1.698 harmsja 5507: p {
5508: padding: 10px;
5509:
5510: }
5511: .FormSectionClearButton input {
5512: background-color:transparent;
5513: border:0px;
5514: cursor:pointer;
5515: text-decoration:underline;
1.693 droeschl 5516: }
5517:
5518:
1.698 harmsja 5519: dl,ul,div,fieldset {
5520: margin: 10px 10px 10px 0px;
1.693 droeschl 5521: overflow:hidden;
5522: }
1.698 harmsja 5523: ol.smallMenu {
5524: margin: 0px;
1.693 droeschl 5525: }
5526:
1.698 harmsja 5527: ol.smallMenu li {
1.693 droeschl 5528: display: inline;
5529: padding: 5px 5px 0px 10px;
5530: vertical-align: top;
5531: }
5532:
1.698 harmsja 5533: ol.smallMenu li img {
1.693 droeschl 5534: vertical-align: bottom;
5535: }
5536:
1.698 harmsja 5537: ol.smallMenu a {
1.693 droeschl 5538: font-size: 90%;
5539: color: RGB(80, 80, 80);
5540: text-decoration: none;
5541: }
5542:
1.698 harmsja 5543: ol#TabMainMenuContent {
1.693 droeschl 5544:
5545: margin: 0px 0px 10px 0px;
5546: padding: 0px;
5547: }
5548:
1.698 harmsja 5549: ol#TabMainMenuContent li {
1.693 droeschl 5550: display: inline;
5551: vertical-align: bottom;
5552: border-bottom: solid 1px RGB(175, 175, 175);
5553: border-right: solid 1px RGB(175, 175, 175);
5554: padding: 5px 15px 5px 15px;
5555: margin-right:4px;
5556: line-height: 140%;
5557: font-weight: bold;
5558: overflow:hidden;
1.698 harmsja 5559: /* background: RGB(211, 206, 205) URL(images/TabMenuBG.png) repeat-x left top;*/
1.693 droeschl 5560: }
5561:
1.698 harmsja 5562: ol#TabMainMenuContent li a{
1.693 droeschl 5563: color: RGB(47, 47, 47);
5564: text-decoration: none;
5565: }
5566:
1.698 harmsja 5567: ol#TabMainMenuContent div.columnSection {
1.693 droeschl 5568: margin-bottom: 0px;
5569: }
5570:
1.698 harmsja 5571: ol#MenuBreadcrumbs, ol#PathBreadcrumbs {
1.693 droeschl 5572: border-top: solid 1px RGB(255, 255, 255);
5573: height: 20px;
5574: line-height: 20px;
5575: vertical-align: bottom;
5576: margin: 0px 0px 30px 0px;
5577: padding-left: 10px;
5578: list-style-position: inside;
1.698 harmsja 5579: /* background: RGB(211, 206, 205) URL(images/TabMenuBG.png) repeat-x left
5580: top;*/
1.693 droeschl 5581: }
5582:
1.698 harmsja 5583: ol#MenuBreadcrumbs li, ol#PathBreadcrumbs li {
5584: /* background: url(images/pfeil_white.png) no-repeat left center;*/
1.693 droeschl 5585: display: inline;
5586: padding: 0px 0px 0px 10px;
5587: vertical-align: bottom;
5588: overflow:hidden;
5589: }
5590:
1.698 harmsja 5591: ol#MenuBreadcrumbs li a {
1.693 droeschl 5592: text-decoration: none;
5593: font-size:90%;
5594: }
1.698 harmsja 5595: ol#PathBreadcrumbs li a{
5596: text-decoration:none;
5597: font-size:100%;
5598: font-weight:bold;
1.693 droeschl 5599: }
5600:
1.698 harmsja 5601: .ContentBoxSpecial
1.693 droeschl 5602: {
1.701 harmsja 5603: border: solid 1px $lg_border_color;
1.698 harmsja 5604: }
5605: .ContentBox {
5606: padding:10px;
1.693 droeschl 5607: }
1.698 harmsja 5608: .PopUp
1.693 droeschl 5609: {
1.698 harmsja 5610: padding:10px;
5611: border-left:solid 1px $lg_border_color;
5612: border-top:solid 1px $lg_border_color;
5613: border-bottom:outset 1px $lg_border_color;
5614: border-right:outset 1px $lg_border_color;
5615: display:none;
5616: position:absolute;
5617: right:0;
5618: background-color:white;
5619: z-index:5;
1.693 droeschl 5620: }
5621:
1.698 harmsja 5622: dl.ListStyleClean dt {
1.693 droeschl 5623: padding-right: 5px;
5624: display: table-header-group;
5625: }
5626:
1.698 harmsja 5627: dl.ListStyleClean dd {
1.693 droeschl 5628: display: table-row;
5629: }
5630:
5631: .ListStyleClean,
5632: .ListStyleSimple,
5633: .ListStyleNormal,
5634: .ListStyleNormal_Border,
5635: .ListStyleSpecial
5636: {
5637: /*display:block; */
5638: list-style-position: inside;
5639: list-style-type: none;
5640: overflow: hidden;
5641: padding: 0px;
5642: }
5643:
5644: .ListStyleSimple li,
1.698 harmsja 5645: .ListStyleSimple dd,
1.693 droeschl 5646: .ListStyleNormal li,
1.698 harmsja 5647: .ListStyleNormal dd,
1.693 droeschl 5648: .ListStyleSpecial li,
1.698 harmsja 5649: .ListStyleSpecial dd
1.693 droeschl 5650: {
5651: margin: 0px;
5652: padding: 5px 5px 5px 10px;
5653: clear: both;
5654: }
5655:
1.698 harmsja 5656: .ListStyleClean li,
5657: .ListStyleClean dd {
1.693 droeschl 5658: padding-top: 0px;
5659: padding-bottom: 0px;
5660: }
5661:
1.698 harmsja 5662: .ListStyleSimple dd,
5663: .ListStyleSimple li{
5664: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 5665: }
5666:
1.698 harmsja 5667: .ListStyleSpecial li,
5668: .ListStyleSpecial dd {
1.693 droeschl 5669: list-style-type: none;
5670: background-color: RGB(220, 220, 220);
5671: margin-bottom: 4px;
5672: }
5673:
1.698 harmsja 5674: table.SimpleTable {
5675: margin:5px;
5676: border:solid 1px $lg_border_color;
1.693 droeschl 5677: }
5678:
1.698 harmsja 5679: table.SimpleTable tr {
5680: padding:0px;
5681: border:solid 1px $lg_border_color;
1.693 droeschl 5682: }
5683: table.SimpleTable thead{
1.698 harmsja 5684: background:rgb(220,220,220);
1.693 droeschl 5685: }
5686:
1.698 harmsja 5687: div.columnSection {
1.693 droeschl 5688: display: block;
5689: clear: both;
5690: overflow: hidden;
5691: margin:0px;
5692: }
5693:
1.698 harmsja 5694: div.columnSection>* {
1.693 droeschl 5695: float: left;
5696: margin: 10px 20px 10px 0px;
5697: overflow:hidden;
5698: }
1.698 harmsja 5699: div.columnSection > .ContentBox,
5700: div.columnSection > .ContentBoxSpecial
1.693 droeschl 5701: {
1.698 harmsja 5702: width: 400px;
1.693 droeschl 5703:
5704: }
5705:
1.694 tempelho 5706: .LC_loginpage_container {
5707: text-align:left;
5708: margin : 0 auto;
5709: width:65%;
5710: padding: 10px;
5711: height: auto;
1.704 muellerd 5712: # background-color:#FFFFFF;
5713: background-color:$loginbg;
1.694 tempelho 5714: border:1px solid #CCCCCC;
5715: }
5716:
5717:
5718: .LC_loginpage_loginContainer {
5719: float:left;
5720: width:60%;
5721: }
5722:
5723: .LC_loginpage_loginInfo {
5724: margin-top:20px;
5725: margin-left:20px;
5726: float:left;
5727: width:30%;
5728: border:1px solid #CCCCCC;
5729: padding:10px;
5730: }
5731:
5732: .LC_loginpage_space {
5733: clear:both;
5734: margin-bottom:20px;
5735: border-bottom: 1px solid #CCCCCC;
5736: }
5737:
5738: .LC_loginpage_fieldset{
5739: border: 1px solid #CCCCCC;
5740: margin: 0 auto;
5741: }
5742:
5743: .LC_loginpage_legend{
5744: padding: 2px;
5745: margin: 0px;
5746: font-size:14px;
5747: font-weight:bold;
5748: }
5749:
5750:
1.693 droeschl 5751:
1.343 albertel 5752: END
5753: }
5754:
1.306 albertel 5755: =pod
5756:
5757: =item * &headtag()
5758:
5759: Returns a uniform footer for LON-CAPA web pages.
5760:
1.307 albertel 5761: Inputs: $title - optional title for the head
5762: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 5763: $args - optional arguments
1.319 albertel 5764: force_register - if is true call registerurl so the remote is
5765: informed
1.415 albertel 5766: redirect -> array ref of
5767: 1- seconds before redirect occurs
5768: 2- url to redirect to
5769: 3- whether the side effect should occur
1.315 albertel 5770: (side effect of setting
5771: $env{'internal.head.redirect'} to the url
5772: redirected too)
1.352 albertel 5773: domain -> force to color decorate a page for a specific
5774: domain
5775: function -> force usage of a specific rolish color scheme
5776: bgcolor -> override the default page bgcolor
1.460 albertel 5777: no_auto_mt_title
5778: -> prevent &mt()ing the title arg
1.464 albertel 5779:
1.306 albertel 5780: =cut
5781:
5782: sub headtag {
1.313 albertel 5783: my ($title,$head_extra,$args) = @_;
1.306 albertel 5784:
1.363 albertel 5785: my $function = $args->{'function'} || &get_users_function();
5786: my $domain = $args->{'domain'} || &determinedomain();
5787: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 5788: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 5789: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 5790: #time(),
1.418 albertel 5791: $env{'environment.color.timestamp'},
1.363 albertel 5792: $function,$domain,$bgcolor);
5793:
1.369 www 5794: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 5795:
1.308 albertel 5796: my $result =
5797: '<head>'.
1.461 albertel 5798: &font_settings();
1.319 albertel 5799:
1.461 albertel 5800: if (!$args->{'frameset'}) {
5801: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
5802: }
1.319 albertel 5803: if ($args->{'force_register'}) {
5804: $result .= &Apache::lonmenu::registerurl(1);
5805: }
1.436 albertel 5806: if (!$args->{'no_nav_bar'}
5807: && !$args->{'only_body'}
5808: && !$args->{'frameset'}) {
5809: $result .= &help_menu_js();
5810: }
1.319 albertel 5811:
1.314 albertel 5812: if (ref($args->{'redirect'})) {
1.414 albertel 5813: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 5814: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 5815: if (!$inhibit_continue) {
5816: $env{'internal.head.redirect'} = $url;
5817: }
1.313 albertel 5818: $result.=<<ADDMETA
5819: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 5820: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 5821: ADDMETA
5822: }
1.306 albertel 5823: if (!defined($title)) {
5824: $title = 'The LearningOnline Network with CAPA';
5825: }
1.460 albertel 5826: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
5827: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 5828: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
5829: .$head_extra;
1.306 albertel 5830: return $result;
5831: }
5832:
5833: =pod
5834:
1.340 albertel 5835: =item * &font_settings()
5836:
5837: Returns neccessary <meta> to set the proper encoding
5838:
5839: Inputs: none
5840:
5841: =cut
5842:
5843: sub font_settings {
5844: my $headerstring='';
1.647 www 5845: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 5846: $headerstring.=
5847: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
5848: }
5849: return $headerstring;
5850: }
5851:
1.341 albertel 5852: =pod
5853:
5854: =item * &xml_begin()
5855:
5856: Returns the needed doctype and <html>
5857:
5858: Inputs: none
5859:
5860: =cut
5861:
5862: sub xml_begin {
5863: my $output='';
5864:
1.592 albertel 5865: if ($env{'internal.start_page'}==1) {
5866: &Apache::lonhtmlcommon::init_htmlareafields();
5867: }
1.342 albertel 5868:
1.341 albertel 5869: if ($env{'browser.mathml'}) {
5870: $output='<?xml version="1.0"?>'
5871: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
5872: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
5873:
5874: # .'<!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">] >'
5875: .'<!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">'
5876: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
5877: .'xmlns="http://www.w3.org/1999/xhtml">';
5878: } else {
5879: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
5880: }
5881: return $output;
5882: }
1.340 albertel 5883:
5884: =pod
5885:
1.306 albertel 5886: =item * &endheadtag()
5887:
5888: Returns a uniform </head> for LON-CAPA web pages.
5889:
5890: Inputs: none
5891:
5892: =cut
5893:
5894: sub endheadtag {
5895: return '</head>';
5896: }
5897:
5898: =pod
5899:
5900: =item * &head()
5901:
5902: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
5903:
1.648 raeburn 5904: Inputs:
5905:
5906: =over 4
5907:
5908: $title - optional title for the page
5909:
5910: $head_extra - optional extra HTML to put inside the <head>
5911:
5912: =back
1.405 albertel 5913:
1.306 albertel 5914: =cut
5915:
5916: sub head {
1.325 albertel 5917: my ($title,$head_extra,$args) = @_;
5918: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 5919: }
5920:
5921: =pod
5922:
5923: =item * &start_page()
5924:
5925: Returns a complete <html> .. <body> section for LON-CAPA web pages.
5926:
1.648 raeburn 5927: Inputs:
5928:
5929: =over 4
5930:
5931: $title - optional title for the page
5932:
5933: $head_extra - optional extra HTML to incude inside the <head>
5934:
5935: $args - additional optional args supported are:
5936:
5937: =over 8
5938:
5939: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 5940: arg on
1.648 raeburn 5941: no_nav_bar -> is true will set &bodytag() notopbar arg on
5942: add_entries -> additional attributes to add to the <body>
5943: domain -> force to color decorate a page for a
1.317 albertel 5944: specific domain
1.648 raeburn 5945: function -> force usage of a specific rolish color
1.317 albertel 5946: scheme
1.648 raeburn 5947: redirect -> see &headtag()
5948: bgcolor -> override the default page bg color
5949: js_ready -> return a string ready for being used in
1.317 albertel 5950: a javascript writeln
1.648 raeburn 5951: html_encode -> return a string ready for being used in
1.320 albertel 5952: a html attribute
1.648 raeburn 5953: force_register -> if is true will turn on the &bodytag()
1.317 albertel 5954: $forcereg arg
1.648 raeburn 5955: body_title -> alternate text to use instead of $title
1.326 albertel 5956: in the title box that appears, this text
5957: is not auto translated like the $title is
1.648 raeburn 5958: frameset -> if true will start with a <frameset>
1.330 albertel 5959: rather than <body>
1.648 raeburn 5960: no_title -> if true the title bar won't be shown
5961: skip_phases -> hash ref of
1.338 albertel 5962: head -> skip the <html><head> generation
5963: body -> skip all <body> generation
1.648 raeburn 5964: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 5965: 'Switch To Inline Menu' link
1.648 raeburn 5966: no_auto_mt_title -> prevent &mt()ing the title arg
5967: inherit_jsmath -> when creating popup window in a page,
5968: should it have jsmath forced on by the
5969: current page
1.361 albertel 5970:
1.648 raeburn 5971: =back
1.460 albertel 5972:
1.648 raeburn 5973: =back
1.562 albertel 5974:
1.306 albertel 5975: =cut
5976:
5977: sub start_page {
1.309 albertel 5978: my ($title,$head_extra,$args) = @_;
1.318 albertel 5979: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 5980: my %head_args;
1.352 albertel 5981: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 5982: 'bgcolor','frameset','no_nav_bar','only_body',
5983: 'no_auto_mt_title') {
1.319 albertel 5984: if (defined($args->{$arg})) {
1.324 raeburn 5985: $head_args{$arg} = $args->{$arg};
1.319 albertel 5986: }
1.313 albertel 5987: }
1.319 albertel 5988:
1.315 albertel 5989: $env{'internal.start_page'}++;
1.338 albertel 5990: my $result;
5991: if (! exists($args->{'skip_phases'}{'head'}) ) {
5992: $result.=
1.341 albertel 5993: &xml_begin().
1.338 albertel 5994: &headtag($title,$head_extra,\%head_args).&endheadtag();
5995: }
5996:
5997: if (! exists($args->{'skip_phases'}{'body'}) ) {
5998: if ($args->{'frameset'}) {
5999: my $attr_string = &make_attr_string($args->{'force_register'},
6000: $args->{'add_entries'});
6001: $result .= "\n<frameset $attr_string>\n";
6002: } else {
6003: $result .=
6004: &bodytag($title,
6005: $args->{'function'}, $args->{'add_entries'},
6006: $args->{'only_body'}, $args->{'domain'},
6007: $args->{'force_register'}, $args->{'body_title'},
6008: $args->{'no_nav_bar'}, $args->{'bgcolor'},
1.460 albertel 6009: $args->{'no_title'}, $args->{'no_inline_link'},
6010: $args);
1.338 albertel 6011: }
1.330 albertel 6012: }
1.338 albertel 6013:
1.315 albertel 6014: if ($args->{'js_ready'}) {
1.317 albertel 6015: $result = &js_ready($result);
1.315 albertel 6016: }
1.320 albertel 6017: if ($args->{'html_encode'}) {
6018: $result = &html_encode($result);
6019: }
1.315 albertel 6020: return $result;
1.306 albertel 6021: }
6022:
1.330 albertel 6023:
1.306 albertel 6024: =pod
6025:
6026: =item * &head()
6027:
6028: Returns a complete </body></html> section for LON-CAPA web pages.
6029:
1.315 albertel 6030: Inputs: $args - additional optional args supported are:
6031: js_ready -> return a string ready for being used in
6032: a javascript writeln
1.320 albertel 6033: html_encode -> return a string ready for being used in
6034: a html attribute
1.330 albertel 6035: frameset -> if true will start with a <frameset>
6036: rather than <body>
1.493 albertel 6037: dicsussion -> if true will get discussion from
6038: lonxml::xmlend
6039: (you can pass the target and parser arguments
6040: through optional 'target' and 'parser' args
6041: to this routine)
1.306 albertel 6042:
6043: =cut
6044:
6045: sub end_page {
1.315 albertel 6046: my ($args) = @_;
6047: $env{'internal.end_page'}++;
1.330 albertel 6048: my $result;
1.335 albertel 6049: if ($args->{'discussion'}) {
6050: my ($target,$parser);
6051: if (ref($args->{'discussion'})) {
6052: ($target,$parser) =($args->{'discussion'}{'target'},
6053: $args->{'discussion'}{'parser'});
6054: }
6055: $result .= &Apache::lonxml::xmlend($target,$parser);
6056: }
6057:
1.330 albertel 6058: if ($args->{'frameset'}) {
6059: $result .= '</frameset>';
6060: } else {
1.635 raeburn 6061: $result .= &endbodytag($args);
1.330 albertel 6062: }
6063: $result .= "\n</html>";
6064:
1.315 albertel 6065: if ($args->{'js_ready'}) {
1.317 albertel 6066: $result = &js_ready($result);
1.315 albertel 6067: }
1.335 albertel 6068:
1.320 albertel 6069: if ($args->{'html_encode'}) {
6070: $result = &html_encode($result);
6071: }
1.335 albertel 6072:
1.315 albertel 6073: return $result;
6074: }
6075:
1.320 albertel 6076: sub html_encode {
6077: my ($result) = @_;
6078:
1.322 albertel 6079: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6080:
6081: return $result;
6082: }
1.317 albertel 6083: sub js_ready {
6084: my ($result) = @_;
6085:
1.323 albertel 6086: $result =~ s/[\n\r]/ /xmsg;
6087: $result =~ s/\\/\\\\/xmsg;
6088: $result =~ s/'/\\'/xmsg;
1.372 albertel 6089: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6090:
6091: return $result;
6092: }
6093:
1.315 albertel 6094: sub validate_page {
6095: if ( exists($env{'internal.start_page'})
1.316 albertel 6096: && $env{'internal.start_page'} > 1) {
6097: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6098: $env{'internal.start_page'}.' '.
1.316 albertel 6099: $ENV{'request.filename'});
1.315 albertel 6100: }
6101: if ( exists($env{'internal.end_page'})
1.316 albertel 6102: && $env{'internal.end_page'} > 1) {
6103: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6104: $env{'internal.end_page'}.' '.
1.316 albertel 6105: $env{'request.filename'});
1.315 albertel 6106: }
6107: if ( exists($env{'internal.start_page'})
6108: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6109: &Apache::lonnet::logthis('start_page called without end_page '.
6110: $env{'request.filename'});
1.315 albertel 6111: }
6112: if ( ! exists($env{'internal.start_page'})
6113: && exists($env{'internal.end_page'})) {
1.316 albertel 6114: &Apache::lonnet::logthis('end_page called without start_page'.
6115: $env{'request.filename'});
1.315 albertel 6116: }
1.306 albertel 6117: }
1.315 albertel 6118:
1.318 albertel 6119: sub simple_error_page {
6120: my ($r,$title,$msg) = @_;
6121: my $page =
6122: &Apache::loncommon::start_page($title).
6123: &mt($msg).
6124: &Apache::loncommon::end_page();
6125: if (ref($r)) {
6126: $r->print($page);
1.327 albertel 6127: return;
1.318 albertel 6128: }
6129: return $page;
6130: }
1.347 albertel 6131:
6132: {
1.610 albertel 6133: my @row_count;
1.347 albertel 6134: sub start_data_table {
1.422 albertel 6135: my ($add_class) = @_;
6136: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6137: unshift(@row_count,0);
1.422 albertel 6138: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6139: }
6140:
6141: sub end_data_table {
1.610 albertel 6142: shift(@row_count);
1.389 albertel 6143: return '</table>'."\n";;
1.347 albertel 6144: }
6145:
6146: sub start_data_table_row {
1.422 albertel 6147: my ($add_class) = @_;
1.610 albertel 6148: $row_count[0]++;
6149: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428 albertel 6150: $css_class = (join(' ',$css_class,$add_class));
1.422 albertel 6151: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6152: }
1.471 banghart 6153:
6154: sub continue_data_table_row {
6155: my ($add_class) = @_;
1.610 albertel 6156: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471 banghart 6157: $css_class = (join(' ',$css_class,$add_class));
6158: return '<tr class="'.$css_class.'">'."\n";;
6159: }
1.347 albertel 6160:
6161: sub end_data_table_row {
1.389 albertel 6162: return '</tr>'."\n";;
1.347 albertel 6163: }
1.367 www 6164:
1.421 albertel 6165: sub start_data_table_empty_row {
1.707 bisitz 6166: # $row_count[0]++;
1.421 albertel 6167: return '<tr class="LC_empty_row" >'."\n";;
6168: }
6169:
6170: sub end_data_table_empty_row {
6171: return '</tr>'."\n";;
6172: }
6173:
1.367 www 6174: sub start_data_table_header_row {
1.389 albertel 6175: return '<tr class="LC_header_row">'."\n";;
1.367 www 6176: }
6177:
6178: sub end_data_table_header_row {
1.389 albertel 6179: return '</tr>'."\n";;
1.367 www 6180: }
1.347 albertel 6181: }
6182:
1.548 albertel 6183: =pod
6184:
6185: =item * &inhibit_menu_check($arg)
6186:
6187: Checks for a inhibitmenu state and generates output to preserve it
6188:
6189: Inputs: $arg - can be any of
6190: - undef - in which case the return value is a string
6191: to add into arguments list of a uri
6192: - 'input' - in which case the return value is a HTML
6193: <form> <input> field of type hidden to
6194: preserve the value
6195: - a url - in which case the return value is the url with
6196: the neccesary cgi args added to preserve the
6197: inhibitmenu state
6198: - a ref to a url - no return value, but the string is
6199: updated to include the neccessary cgi
6200: args to preserve the inhibitmenu state
6201:
6202: =cut
6203:
6204: sub inhibit_menu_check {
6205: my ($arg) = @_;
6206: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6207: if ($arg eq 'input') {
6208: if ($env{'form.inhibitmenu'}) {
6209: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6210: } else {
6211: return
6212: }
6213: }
6214: if ($env{'form.inhibitmenu'}) {
6215: if (ref($arg)) {
6216: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6217: } elsif ($arg eq '') {
6218: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6219: } else {
6220: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6221: }
6222: }
6223: if (!ref($arg)) {
6224: return $arg;
6225: }
6226: }
6227:
1.251 albertel 6228: ###############################################
1.182 matthew 6229:
6230: =pod
6231:
1.549 albertel 6232: =back
6233:
6234: =head1 User Information Routines
6235:
6236: =over 4
6237:
1.405 albertel 6238: =item * &get_users_function()
1.182 matthew 6239:
6240: Used by &bodytag to determine the current users primary role.
6241: Returns either 'student','coordinator','admin', or 'author'.
6242:
6243: =cut
6244:
6245: ###############################################
6246: sub get_users_function {
6247: my $function = 'student';
1.258 albertel 6248: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182 matthew 6249: $function='coordinator';
6250: }
1.258 albertel 6251: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 6252: $function='admin';
6253: }
1.258 albertel 6254: if (($env{'request.role'}=~/^(au|ca)/) ||
1.182 matthew 6255: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
6256: $function='author';
6257: }
6258: return $function;
1.54 www 6259: }
1.99 www 6260:
6261: ###############################################
6262:
1.233 raeburn 6263: =pod
6264:
1.542 raeburn 6265: =item * &check_user_status()
1.274 raeburn 6266:
6267: Determines current status of supplied role for a
6268: specific user. Roles can be active, previous or future.
6269:
6270: Inputs:
6271: user's domain, user's username, course's domain,
1.375 raeburn 6272: course's number, optional section ID.
1.274 raeburn 6273:
6274: Outputs:
6275: role status: active, previous or future.
6276:
6277: =cut
6278:
6279: sub check_user_status {
1.412 raeburn 6280: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 6281: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
6282: my @uroles = keys %userinfo;
6283: my $srchstr;
6284: my $active_chk = 'none';
1.412 raeburn 6285: my $now = time;
1.274 raeburn 6286: if (@uroles > 0) {
1.412 raeburn 6287: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 6288: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
6289: } else {
1.412 raeburn 6290: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
6291: }
6292: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 6293: my $role_end = 0;
6294: my $role_start = 0;
6295: $active_chk = 'active';
1.412 raeburn 6296: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
6297: $role_end = $1;
6298: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
6299: $role_start = $1;
1.274 raeburn 6300: }
6301: }
6302: if ($role_start > 0) {
1.412 raeburn 6303: if ($now < $role_start) {
1.274 raeburn 6304: $active_chk = 'future';
6305: }
6306: }
6307: if ($role_end > 0) {
1.412 raeburn 6308: if ($now > $role_end) {
1.274 raeburn 6309: $active_chk = 'previous';
6310: }
6311: }
6312: }
6313: }
6314: return $active_chk;
6315: }
6316:
6317: ###############################################
6318:
6319: =pod
6320:
1.405 albertel 6321: =item * &get_sections()
1.233 raeburn 6322:
6323: Determines all the sections for a course including
6324: sections with students and sections containing other roles.
1.419 raeburn 6325: Incoming parameters:
6326:
6327: 1. domain
6328: 2. course number
6329: 3. reference to array containing roles for which sections should
6330: be gathered (optional).
6331: 4. reference to array containing status types for which sections
6332: should be gathered (optional).
6333:
6334: If the third argument is undefined, sections are gathered for any role.
6335: If the fourth argument is undefined, sections are gathered for any status.
6336: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 6337:
1.374 raeburn 6338: Returns section hash (keys are section IDs, values are
6339: number of users in each section), subject to the
1.419 raeburn 6340: optional roles filter, optional status filter
1.233 raeburn 6341:
6342: =cut
6343:
6344: ###############################################
6345: sub get_sections {
1.419 raeburn 6346: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 6347: if (!defined($cdom) || !defined($cnum)) {
6348: my $cid = $env{'request.course.id'};
6349:
6350: return if (!defined($cid));
6351:
6352: $cdom = $env{'course.'.$cid.'.domain'};
6353: $cnum = $env{'course.'.$cid.'.num'};
6354: }
6355:
6356: my %sectioncount;
1.419 raeburn 6357: my $now = time;
1.240 albertel 6358:
1.366 albertel 6359: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 6360: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 6361: my $sec_index = &Apache::loncoursedata::CL_SECTION();
6362: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 6363: my $start_index = &Apache::loncoursedata::CL_START();
6364: my $end_index = &Apache::loncoursedata::CL_END();
6365: my $status;
1.366 albertel 6366: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 6367: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
6368: $data->[$status_index],
6369: $data->[$start_index],
6370: $data->[$end_index]);
6371: if ($stu_status eq 'Active') {
6372: $status = 'active';
6373: } elsif ($end < $now) {
6374: $status = 'previous';
6375: } elsif ($start > $now) {
6376: $status = 'future';
6377: }
6378: if ($section ne '-1' && $section !~ /^\s*$/) {
6379: if ((!defined($possible_status)) || (($status ne '') &&
6380: (grep/^\Q$status\E$/,@{$possible_status}))) {
6381: $sectioncount{$section}++;
6382: }
1.240 albertel 6383: }
6384: }
6385: }
6386: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6387: foreach my $user (sort(keys(%courseroles))) {
6388: if ($user !~ /^(\w{2})/) { next; }
6389: my ($role) = ($user =~ /^(\w{2})/);
6390: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 6391: my ($section,$status);
1.240 albertel 6392: if ($role eq 'cr' &&
6393: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
6394: $section=$1;
6395: }
6396: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
6397: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 6398: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
6399: if ($end == -1 && $start == -1) {
6400: next; #deleted role
6401: }
6402: if (!defined($possible_status)) {
6403: $sectioncount{$section}++;
6404: } else {
6405: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
6406: $status = 'active';
6407: } elsif ($end < $now) {
6408: $status = 'future';
6409: } elsif ($start > $now) {
6410: $status = 'previous';
6411: }
6412: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
6413: $sectioncount{$section}++;
6414: }
6415: }
1.233 raeburn 6416: }
1.366 albertel 6417: return %sectioncount;
1.233 raeburn 6418: }
6419:
1.274 raeburn 6420: ###############################################
1.294 raeburn 6421:
6422: =pod
1.405 albertel 6423:
6424: =item * &get_course_users()
6425:
1.275 raeburn 6426: Retrieves usernames:domains for users in the specified course
6427: with specific role(s), and access status.
6428:
6429: Incoming parameters:
1.277 albertel 6430: 1. course domain
6431: 2. course number
6432: 3. access status: users must have - either active,
1.275 raeburn 6433: previous, future, or all.
1.277 albertel 6434: 4. reference to array of permissible roles
1.288 raeburn 6435: 5. reference to array of section restrictions (optional)
6436: 6. reference to results object (hash of hashes).
6437: 7. reference to optional userdata hash
1.609 raeburn 6438: 8. reference to optional statushash
1.630 raeburn 6439: 9. flag if privileged users (except those set to unhide in
6440: course settings) should be excluded
1.609 raeburn 6441: Keys of top level results hash are roles.
1.275 raeburn 6442: Keys of inner hashes are username:domain, with
6443: values set to access type.
1.288 raeburn 6444: Optional userdata hash returns an array with arguments in the
6445: same order as loncoursedata::get_classlist() for student data.
6446:
1.609 raeburn 6447: Optional statushash returns
6448:
1.288 raeburn 6449: Entries for end, start, section and status are blank because
6450: of the possibility of multiple values for non-student roles.
6451:
1.275 raeburn 6452: =cut
1.405 albertel 6453:
1.275 raeburn 6454: ###############################################
1.405 albertel 6455:
1.275 raeburn 6456: sub get_course_users {
1.630 raeburn 6457: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 6458: my %idx = ();
1.419 raeburn 6459: my %seclists;
1.288 raeburn 6460:
6461: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
6462: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
6463: $idx{end} = &Apache::loncoursedata::CL_END();
6464: $idx{start} = &Apache::loncoursedata::CL_START();
6465: $idx{id} = &Apache::loncoursedata::CL_ID();
6466: $idx{section} = &Apache::loncoursedata::CL_SECTION();
6467: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
6468: $idx{status} = &Apache::loncoursedata::CL_STATUS();
6469:
1.290 albertel 6470: if (grep(/^st$/,@{$roles})) {
1.276 albertel 6471: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 6472: my $now = time;
1.277 albertel 6473: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 6474: my $match = 0;
1.412 raeburn 6475: my $secmatch = 0;
1.419 raeburn 6476: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 6477: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 6478: if ($section eq '') {
6479: $section = 'none';
6480: }
1.291 albertel 6481: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6482: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6483: $secmatch = 1;
6484: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 6485: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6486: $secmatch = 1;
6487: }
6488: } else {
1.419 raeburn 6489: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 6490: $secmatch = 1;
6491: }
1.290 albertel 6492: }
1.412 raeburn 6493: if (!$secmatch) {
6494: next;
6495: }
1.419 raeburn 6496: }
1.275 raeburn 6497: if (defined($$types{'active'})) {
1.288 raeburn 6498: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 6499: push(@{$$users{st}{$student}},'active');
1.288 raeburn 6500: $match = 1;
1.275 raeburn 6501: }
6502: }
6503: if (defined($$types{'previous'})) {
1.609 raeburn 6504: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 6505: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 6506: $match = 1;
1.275 raeburn 6507: }
6508: }
6509: if (defined($$types{'future'})) {
1.609 raeburn 6510: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 6511: push(@{$$users{st}{$student}},'future');
1.288 raeburn 6512: $match = 1;
1.275 raeburn 6513: }
6514: }
1.609 raeburn 6515: if ($match) {
6516: push(@{$seclists{$student}},$section);
6517: if (ref($userdata) eq 'HASH') {
6518: $$userdata{$student} = $$classlist{$student};
6519: }
6520: if (ref($statushash) eq 'HASH') {
6521: $statushash->{$student}{'st'}{$section} = $status;
6522: }
1.288 raeburn 6523: }
1.275 raeburn 6524: }
6525: }
1.412 raeburn 6526: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 6527: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6528: my $now = time;
1.609 raeburn 6529: my %displaystatus = ( previous => 'Expired',
6530: active => 'Active',
6531: future => 'Future',
6532: );
1.630 raeburn 6533: my %nothide;
6534: if ($hidepriv) {
6535: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
6536: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
6537: if ($user !~ /:/) {
6538: $nothide{join(':',split(/[\@]/,$user))}=1;
6539: } else {
6540: $nothide{$user} = 1;
6541: }
6542: }
6543: }
1.439 raeburn 6544: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 6545: my $match = 0;
1.412 raeburn 6546: my $secmatch = 0;
1.439 raeburn 6547: my $status;
1.412 raeburn 6548: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 6549: $user =~ s/:$//;
1.439 raeburn 6550: my ($end,$start) = split(/:/,$coursepersonnel{$person});
6551: if ($end == -1 || $start == -1) {
6552: next;
6553: }
6554: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
6555: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 6556: my ($uname,$udom) = split(/:/,$user);
6557: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6558: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6559: $secmatch = 1;
6560: } elsif ($usec eq '') {
1.420 albertel 6561: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6562: $secmatch = 1;
6563: }
6564: } else {
6565: if (grep(/^\Q$usec\E$/,@{$sections})) {
6566: $secmatch = 1;
6567: }
6568: }
6569: if (!$secmatch) {
6570: next;
6571: }
1.288 raeburn 6572: }
1.419 raeburn 6573: if ($usec eq '') {
6574: $usec = 'none';
6575: }
1.275 raeburn 6576: if ($uname ne '' && $udom ne '') {
1.630 raeburn 6577: if ($hidepriv) {
6578: if ((&Apache::lonnet::privileged($uname,$udom)) &&
6579: (!$nothide{$uname.':'.$udom})) {
6580: next;
6581: }
6582: }
1.503 raeburn 6583: if ($end > 0 && $end < $now) {
1.439 raeburn 6584: $status = 'previous';
6585: } elsif ($start > $now) {
6586: $status = 'future';
6587: } else {
6588: $status = 'active';
6589: }
1.277 albertel 6590: foreach my $type (keys(%{$types})) {
1.275 raeburn 6591: if ($status eq $type) {
1.420 albertel 6592: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 6593: push(@{$$users{$role}{$user}},$type);
6594: }
1.288 raeburn 6595: $match = 1;
6596: }
6597: }
1.419 raeburn 6598: if (($match) && (ref($userdata) eq 'HASH')) {
6599: if (!exists($$userdata{$uname.':'.$udom})) {
6600: &get_user_info($udom,$uname,\%idx,$userdata);
6601: }
1.420 albertel 6602: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 6603: push(@{$seclists{$uname.':'.$udom}},$usec);
6604: }
1.609 raeburn 6605: if (ref($statushash) eq 'HASH') {
6606: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
6607: }
1.275 raeburn 6608: }
6609: }
6610: }
6611: }
1.290 albertel 6612: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 6613: if ((defined($cdom)) && (defined($cnum))) {
6614: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
6615: if ( defined($csettings{'internal.courseowner'}) ) {
6616: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 6617: next if ($owner eq '');
6618: my ($ownername,$ownerdom);
6619: if ($owner =~ /^([^:]+):([^:]+)$/) {
6620: $ownername = $1;
6621: $ownerdom = $2;
6622: } else {
6623: $ownername = $owner;
6624: $ownerdom = $cdom;
6625: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 6626: }
6627: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 6628: if (defined($userdata) &&
1.609 raeburn 6629: !exists($$userdata{$owner})) {
6630: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
6631: if (!grep(/^none$/,@{$seclists{$owner}})) {
6632: push(@{$seclists{$owner}},'none');
6633: }
6634: if (ref($statushash) eq 'HASH') {
6635: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 6636: }
1.290 albertel 6637: }
1.279 raeburn 6638: }
6639: }
6640: }
1.419 raeburn 6641: foreach my $user (keys(%seclists)) {
6642: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
6643: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
6644: }
1.275 raeburn 6645: }
6646: return;
6647: }
6648:
1.288 raeburn 6649: sub get_user_info {
6650: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 6651: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
6652: &plainname($uname,$udom,'lastname');
1.291 albertel 6653: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 6654: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 6655: my %idhash = &Apache::lonnet::idrget($udom,($uname));
6656: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 6657: return;
6658: }
1.275 raeburn 6659:
1.472 raeburn 6660: ###############################################
6661:
6662: =pod
6663:
6664: =item * &get_user_quota()
6665:
6666: Retrieves quota assigned for storage of portfolio files for a user
6667:
6668: Incoming parameters:
6669: 1. user's username
6670: 2. user's domain
6671:
6672: Returns:
1.536 raeburn 6673: 1. Disk quota (in Mb) assigned to student.
6674: 2. (Optional) Type of setting: custom or default
6675: (individually assigned or default for user's
6676: institutional status).
6677: 3. (Optional) - User's institutional status (e.g., faculty, staff
6678: or student - types as defined in localenroll::inst_usertypes
6679: for user's domain, which determines default quota for user.
6680: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 6681:
6682: If a value has been stored in the user's environment,
1.536 raeburn 6683: it will return that, otherwise it returns the maximal default
6684: defined for the user's instituional status(es) in the domain.
1.472 raeburn 6685:
6686: =cut
6687:
6688: ###############################################
6689:
6690:
6691: sub get_user_quota {
6692: my ($uname,$udom) = @_;
1.536 raeburn 6693: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 6694: if (!defined($udom)) {
6695: $udom = $env{'user.domain'};
6696: }
6697: if (!defined($uname)) {
6698: $uname = $env{'user.name'};
6699: }
6700: if (($udom eq '' || $uname eq '') ||
6701: ($udom eq 'public') && ($uname eq 'public')) {
6702: $quota = 0;
1.536 raeburn 6703: $quotatype = 'default';
6704: $defquota = 0;
1.472 raeburn 6705: } else {
1.536 raeburn 6706: my $inststatus;
1.472 raeburn 6707: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
6708: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 6709: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 6710: } else {
1.536 raeburn 6711: my %userenv =
6712: &Apache::lonnet::get('environment',['portfolioquota',
6713: 'inststatus'],$udom,$uname);
1.472 raeburn 6714: my ($tmp) = keys(%userenv);
6715: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
6716: $quota = $userenv{'portfolioquota'};
1.536 raeburn 6717: $inststatus = $userenv{'inststatus'};
1.472 raeburn 6718: } else {
6719: undef(%userenv);
6720: }
6721: }
1.536 raeburn 6722: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 6723: if ($quota eq '') {
1.536 raeburn 6724: $quota = $defquota;
6725: $quotatype = 'default';
6726: } else {
6727: $quotatype = 'custom';
1.472 raeburn 6728: }
6729: }
1.536 raeburn 6730: if (wantarray) {
6731: return ($quota,$quotatype,$settingstatus,$defquota);
6732: } else {
6733: return $quota;
6734: }
1.472 raeburn 6735: }
6736:
6737: ###############################################
6738:
6739: =pod
6740:
6741: =item * &default_quota()
6742:
1.536 raeburn 6743: Retrieves default quota assigned for storage of user portfolio files,
6744: given an (optional) user's institutional status.
1.472 raeburn 6745:
6746: Incoming parameters:
6747: 1. domain
1.536 raeburn 6748: 2. (Optional) institutional status(es). This is a : separated list of
6749: status types (e.g., faculty, staff, student etc.)
6750: which apply to the user for whom the default is being retrieved.
6751: If the institutional status string in undefined, the domain
6752: default quota will be returned.
1.472 raeburn 6753:
6754: Returns:
6755: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 6756: 2. (Optional) institutional type which determined the value of the
6757: default quota.
1.472 raeburn 6758:
6759: If a value has been stored in the domain's configuration db,
6760: it will return that, otherwise it returns 20 (for backwards
6761: compatibility with domains which have not set up a configuration
6762: db file; the original statically defined portfolio quota was 20 Mb).
6763:
1.536 raeburn 6764: If the user's status includes multiple types (e.g., staff and student),
6765: the largest default quota which applies to the user determines the
6766: default quota returned.
6767:
1.472 raeburn 6768: =cut
6769:
6770: ###############################################
6771:
6772:
6773: sub default_quota {
1.536 raeburn 6774: my ($udom,$inststatus) = @_;
6775: my ($defquota,$settingstatus);
6776: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 6777: ['quotas'],$udom);
6778: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 6779: if ($inststatus ne '') {
6780: my @statuses = split(/:/,$inststatus);
6781: foreach my $item (@statuses) {
1.622 raeburn 6782: if ($quotahash{'quotas'}{$item} ne '') {
1.536 raeburn 6783: if ($defquota eq '') {
1.622 raeburn 6784: $defquota = $quotahash{'quotas'}{$item};
1.536 raeburn 6785: $settingstatus = $item;
1.622 raeburn 6786: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
6787: $defquota = $quotahash{'quotas'}{$item};
1.536 raeburn 6788: $settingstatus = $item;
6789: }
6790: }
6791: }
6792: }
6793: if ($defquota eq '') {
1.622 raeburn 6794: $defquota = $quotahash{'quotas'}{'default'};
1.536 raeburn 6795: $settingstatus = 'default';
6796: }
6797: } else {
6798: $settingstatus = 'default';
6799: $defquota = 20;
6800: }
6801: if (wantarray) {
6802: return ($defquota,$settingstatus);
1.472 raeburn 6803: } else {
1.536 raeburn 6804: return $defquota;
1.472 raeburn 6805: }
6806: }
6807:
1.384 raeburn 6808: sub get_secgrprole_info {
6809: my ($cdom,$cnum,$needroles,$type) = @_;
6810: my %sections_count = &get_sections($cdom,$cnum);
6811: my @sections = (sort {$a <=> $b} keys(%sections_count));
6812: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
6813: my @groups = sort(keys(%curr_groups));
6814: my $allroles = [];
6815: my $rolehash;
6816: my $accesshash = {
6817: active => 'Currently has access',
6818: future => 'Will have future access',
6819: previous => 'Previously had access',
6820: };
6821: if ($needroles) {
6822: $rolehash = {'all' => 'all'};
1.385 albertel 6823: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6824: if (&Apache::lonnet::error(%user_roles)) {
6825: undef(%user_roles);
6826: }
6827: foreach my $item (keys(%user_roles)) {
1.384 raeburn 6828: my ($role)=split(/\:/,$item,2);
6829: if ($role eq 'cr') { next; }
6830: if ($role =~ /^cr/) {
6831: $$rolehash{$role} = (split('/',$role))[3];
6832: } else {
6833: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
6834: }
6835: }
6836: foreach my $key (sort(keys(%{$rolehash}))) {
6837: push(@{$allroles},$key);
6838: }
6839: push (@{$allroles},'st');
6840: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
6841: }
6842: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
6843: }
6844:
1.555 raeburn 6845: sub user_picker {
1.627 raeburn 6846: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 6847: my $currdom = $dom;
6848: my %curr_selected = (
6849: srchin => 'dom',
1.580 raeburn 6850: srchby => 'lastname',
1.555 raeburn 6851: );
6852: my $srchterm;
1.625 raeburn 6853: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 6854: if ($srch->{'srchby'} ne '') {
6855: $curr_selected{'srchby'} = $srch->{'srchby'};
6856: }
6857: if ($srch->{'srchin'} ne '') {
6858: $curr_selected{'srchin'} = $srch->{'srchin'};
6859: }
6860: if ($srch->{'srchtype'} ne '') {
6861: $curr_selected{'srchtype'} = $srch->{'srchtype'};
6862: }
6863: if ($srch->{'srchdomain'} ne '') {
6864: $currdom = $srch->{'srchdomain'};
6865: }
6866: $srchterm = $srch->{'srchterm'};
6867: }
6868: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 6869: 'usr' => 'Search criteria',
1.563 raeburn 6870: 'doma' => 'Domain/institution to search',
1.558 albertel 6871: 'uname' => 'username',
6872: 'lastname' => 'last name',
1.555 raeburn 6873: 'lastfirst' => 'last name, first name',
1.558 albertel 6874: 'crs' => 'in this course',
1.576 raeburn 6875: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 6876: 'alc' => 'all LON-CAPA',
1.573 raeburn 6877: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 6878: 'exact' => 'is',
6879: 'contains' => 'contains',
1.569 raeburn 6880: 'begins' => 'begins with',
1.571 raeburn 6881: 'youm' => "You must include some text to search for.",
6882: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
6883: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
6884: 'yomc' => "You must choose a domain when using an institutional directory search.",
6885: 'ymcd' => "You must choose a domain when using a domain search.",
6886: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
6887: 'whse' => "When searching by last,first you must include at least one character in the first name.",
6888: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 6889: );
1.563 raeburn 6890: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
6891: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 6892:
6893: my @srchins = ('crs','dom','alc','instd');
6894:
6895: foreach my $option (@srchins) {
6896: # FIXME 'alc' option unavailable until
6897: # loncreateuser::print_user_query_page()
6898: # has been completed.
6899: next if ($option eq 'alc');
6900: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 6901: if ($curr_selected{'srchin'} eq $option) {
6902: $srchinsel .= '
6903: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6904: } else {
6905: $srchinsel .= '
6906: <option value="'.$option.'">'.$lt{$option}.'</option>';
6907: }
1.555 raeburn 6908: }
1.563 raeburn 6909: $srchinsel .= "\n </select>\n";
1.555 raeburn 6910:
6911: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 6912: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 6913: if ($curr_selected{'srchby'} eq $option) {
6914: $srchbysel .= '
6915: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6916: } else {
6917: $srchbysel .= '
6918: <option value="'.$option.'">'.$lt{$option}.'</option>';
6919: }
6920: }
6921: $srchbysel .= "\n </select>\n";
6922:
6923: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 6924: foreach my $option ('begins','contains','exact') {
1.555 raeburn 6925: if ($curr_selected{'srchtype'} eq $option) {
6926: $srchtypesel .= '
6927: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6928: } else {
6929: $srchtypesel .= '
6930: <option value="'.$option.'">'.$lt{$option}.'</option>';
6931: }
6932: }
6933: $srchtypesel .= "\n </select>\n";
6934:
1.558 albertel 6935: my ($newuserscript,$new_user_create);
1.556 raeburn 6936:
6937: if ($forcenewuser) {
1.576 raeburn 6938: if (ref($srch) eq 'HASH') {
6939: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 6940: if ($cancreate) {
6941: $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>';
6942: } else {
6943: my $helplink = ' href="javascript:helpMenu('."'display'".')"';
6944: my %usertypetext = (
6945: official => 'institutional',
6946: unofficial => 'non-institutional',
6947: );
6948: $new_user_create = '<br /><span class="LC_warning">'.&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.").' '.&mt('Contact the <a[_1]>helpdesk</a> for assistance.',$helplink).'</span><br /><br />';
6949: }
1.576 raeburn 6950: }
6951: }
6952:
1.556 raeburn 6953: $newuserscript = <<"ENDSCRIPT";
6954:
1.570 raeburn 6955: function setSearch(createnew,callingForm) {
1.556 raeburn 6956: if (createnew == 1) {
1.570 raeburn 6957: for (var i=0; i<callingForm.srchby.length; i++) {
6958: if (callingForm.srchby.options[i].value == 'uname') {
6959: callingForm.srchby.selectedIndex = i;
1.556 raeburn 6960: }
6961: }
1.570 raeburn 6962: for (var i=0; i<callingForm.srchin.length; i++) {
6963: if ( callingForm.srchin.options[i].value == 'dom') {
6964: callingForm.srchin.selectedIndex = i;
1.556 raeburn 6965: }
6966: }
1.570 raeburn 6967: for (var i=0; i<callingForm.srchtype.length; i++) {
6968: if (callingForm.srchtype.options[i].value == 'exact') {
6969: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 6970: }
6971: }
1.570 raeburn 6972: for (var i=0; i<callingForm.srchdomain.length; i++) {
6973: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
6974: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 6975: }
6976: }
6977: }
6978: }
6979: ENDSCRIPT
1.558 albertel 6980:
1.556 raeburn 6981: }
6982:
1.555 raeburn 6983: my $output = <<"END_BLOCK";
1.556 raeburn 6984: <script type="text/javascript">
1.570 raeburn 6985: function validateEntry(callingForm) {
1.558 albertel 6986:
1.556 raeburn 6987: var checkok = 1;
1.558 albertel 6988: var srchin;
1.570 raeburn 6989: for (var i=0; i<callingForm.srchin.length; i++) {
6990: if ( callingForm.srchin[i].checked ) {
6991: srchin = callingForm.srchin[i].value;
1.558 albertel 6992: }
6993: }
6994:
1.570 raeburn 6995: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
6996: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
6997: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
6998: var srchterm = callingForm.srchterm.value;
6999: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7000: var msg = "";
7001:
7002: if (srchterm == "") {
7003: checkok = 0;
1.571 raeburn 7004: msg += "$lt{'youm'}\\n";
1.556 raeburn 7005: }
7006:
1.569 raeburn 7007: if (srchtype== 'begins') {
7008: if (srchterm.length < 2) {
7009: checkok = 0;
1.571 raeburn 7010: msg += "$lt{'thte'}\\n";
1.569 raeburn 7011: }
7012: }
7013:
1.556 raeburn 7014: if (srchtype== 'contains') {
7015: if (srchterm.length < 3) {
7016: checkok = 0;
1.571 raeburn 7017: msg += "$lt{'thet'}\\n";
1.556 raeburn 7018: }
7019: }
7020: if (srchin == 'instd') {
7021: if (srchdomain == '') {
7022: checkok = 0;
1.571 raeburn 7023: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7024: }
7025: }
7026: if (srchin == 'dom') {
7027: if (srchdomain == '') {
7028: checkok = 0;
1.571 raeburn 7029: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7030: }
7031: }
7032: if (srchby == 'lastfirst') {
7033: if (srchterm.indexOf(",") == -1) {
7034: checkok = 0;
1.571 raeburn 7035: msg += "$lt{'whus'}\\n";
1.556 raeburn 7036: }
7037: if (srchterm.indexOf(",") == srchterm.length -1) {
7038: checkok = 0;
1.571 raeburn 7039: msg += "$lt{'whse'}\\n";
1.556 raeburn 7040: }
7041: }
7042: if (checkok == 0) {
1.571 raeburn 7043: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7044: return;
7045: }
7046: if (checkok == 1) {
1.570 raeburn 7047: callingForm.submit();
1.556 raeburn 7048: }
7049: }
7050:
7051: $newuserscript
7052:
7053: </script>
1.558 albertel 7054:
7055: $new_user_create
7056:
1.555 raeburn 7057: <table>
1.558 albertel 7058: <tr>
1.573 raeburn 7059: <td>$lt{'doma'}:</td>
7060: <td>$domform</td>
7061: </td>
7062: </tr>
7063: <tr>
7064: <td>$lt{'usr'}:</td>
1.563 raeburn 7065: <td>$srchbysel
7066: $srchtypesel
7067: <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564 albertel 7068: $srchinsel
1.563 raeburn 7069: </td>
7070: </tr>
1.555 raeburn 7071: </table>
7072: <br />
7073: END_BLOCK
1.558 albertel 7074:
1.555 raeburn 7075: return $output;
7076: }
7077:
1.612 raeburn 7078: sub user_rule_check {
1.615 raeburn 7079: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7080: my $response;
7081: if (ref($usershash) eq 'HASH') {
7082: foreach my $user (keys(%{$usershash})) {
7083: my ($uname,$udom) = split(/:/,$user);
7084: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7085: my ($id,$newuser);
1.612 raeburn 7086: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7087: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7088: $id = $usershash->{$user}->{'id'};
7089: }
7090: my $inst_response;
7091: if (ref($checks) eq 'HASH') {
7092: if (defined($checks->{'username'})) {
1.615 raeburn 7093: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7094: &Apache::lonnet::get_instuser($udom,$uname);
7095: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7096: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7097: &Apache::lonnet::get_instuser($udom,undef,$id);
7098: }
1.615 raeburn 7099: } else {
7100: ($inst_response,%{$inst_results->{$user}}) =
7101: &Apache::lonnet::get_instuser($udom,$uname);
7102: return;
1.612 raeburn 7103: }
1.615 raeburn 7104: if (!$got_rules->{$udom}) {
1.612 raeburn 7105: my %domconfig = &Apache::lonnet::get_dom('configuration',
7106: ['usercreation'],$udom);
7107: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7108: foreach my $item ('username','id') {
1.612 raeburn 7109: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7110: $$curr_rules{$udom}{$item} =
7111: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7112: }
7113: }
7114: }
1.615 raeburn 7115: $got_rules->{$udom} = 1;
1.585 raeburn 7116: }
1.612 raeburn 7117: foreach my $item (keys(%{$checks})) {
7118: if (ref($$curr_rules{$udom}) eq 'HASH') {
7119: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7120: if (@{$$curr_rules{$udom}{$item}} > 0) {
7121: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7122: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7123: if ($rule_check{$rule}) {
7124: $$rulematch{$user}{$item} = $rule;
7125: if ($inst_response eq 'ok') {
1.615 raeburn 7126: if (ref($inst_results) eq 'HASH') {
7127: if (ref($inst_results->{$user}) eq 'HASH') {
7128: if (keys(%{$inst_results->{$user}}) == 0) {
7129: $$alerts{$item}{$udom}{$uname} = 1;
7130: }
1.612 raeburn 7131: }
7132: }
1.615 raeburn 7133: }
7134: last;
1.585 raeburn 7135: }
7136: }
7137: }
7138: }
7139: }
7140: }
7141: }
7142: }
1.612 raeburn 7143: return;
7144: }
7145:
7146: sub user_rule_formats {
7147: my ($domain,$domdesc,$curr_rules,$check) = @_;
7148: my %text = (
7149: 'username' => 'Usernames',
7150: 'id' => 'IDs',
7151: );
7152: my $output;
7153: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7154: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7155: if (@{$ruleorder} > 0) {
7156: $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>';
7157: foreach my $rule (@{$ruleorder}) {
7158: if (ref($curr_rules) eq 'ARRAY') {
7159: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7160: if (ref($rules->{$rule}) eq 'HASH') {
7161: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7162: $rules->{$rule}{'desc'}.'</li>';
7163: }
7164: }
7165: }
7166: }
7167: $output .= '</ul>';
7168: }
7169: }
7170: return $output;
7171: }
7172:
7173: sub instrule_disallow_msg {
1.615 raeburn 7174: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7175: my $response;
7176: my %text = (
7177: item => 'username',
7178: items => 'usernames',
7179: match => 'matches',
7180: do => 'does',
7181: action => 'a username',
7182: one => 'one',
7183: );
7184: if ($count > 1) {
7185: $text{'item'} = 'usernames';
7186: $text{'match'} ='match';
7187: $text{'do'} = 'do';
7188: $text{'action'} = 'usernames',
7189: $text{'one'} = 'ones';
7190: }
7191: if ($checkitem eq 'id') {
7192: $text{'items'} = 'IDs';
7193: $text{'item'} = 'ID';
7194: $text{'action'} = 'an ID';
1.615 raeburn 7195: if ($count > 1) {
7196: $text{'item'} = 'IDs';
7197: $text{'action'} = 'IDs';
7198: }
1.612 raeburn 7199: }
1.674 bisitz 7200: $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 7201: if ($mode eq 'upload') {
7202: if ($checkitem eq 'username') {
7203: $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'}.");
7204: } elsif ($checkitem eq 'id') {
1.674 bisitz 7205: $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 7206: }
1.669 raeburn 7207: } elsif ($mode eq 'selfcreate') {
7208: if ($checkitem eq 'id') {
7209: $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.");
7210: }
1.615 raeburn 7211: } else {
7212: if ($checkitem eq 'username') {
7213: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
7214: } elsif ($checkitem eq 'id') {
7215: $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.");
7216: }
1.612 raeburn 7217: }
7218: return $response;
1.585 raeburn 7219: }
7220:
1.624 raeburn 7221: sub personal_data_fieldtitles {
7222: my %fieldtitles = &Apache::lonlocal::texthash (
7223: id => 'Student/Employee ID',
7224: permanentemail => 'E-mail address',
7225: lastname => 'Last Name',
7226: firstname => 'First Name',
7227: middlename => 'Middle Name',
7228: generation => 'Generation',
7229: gen => 'Generation',
7230: );
7231: return %fieldtitles;
7232: }
7233:
1.642 raeburn 7234: sub sorted_inst_types {
7235: my ($dom) = @_;
7236: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
7237: my $othertitle = &mt('All users');
7238: if ($env{'request.course.id'}) {
1.668 raeburn 7239: $othertitle = &mt('Any users');
1.642 raeburn 7240: }
7241: my @types;
7242: if (ref($order) eq 'ARRAY') {
7243: @types = @{$order};
7244: }
7245: if (@types == 0) {
7246: if (ref($usertypes) eq 'HASH') {
7247: @types = sort(keys(%{$usertypes}));
7248: }
7249: }
7250: if (keys(%{$usertypes}) > 0) {
7251: $othertitle = &mt('Other users');
7252: }
7253: return ($othertitle,$usertypes,\@types);
7254: }
7255:
1.645 raeburn 7256: sub get_institutional_codes {
7257: my ($settings,$allcourses,$LC_code) = @_;
7258: # Get complete list of course sections to update
7259: my @currsections = ();
7260: my @currxlists = ();
7261: my $coursecode = $$settings{'internal.coursecode'};
7262:
7263: if ($$settings{'internal.sectionnums'} ne '') {
7264: @currsections = split(/,/,$$settings{'internal.sectionnums'});
7265: }
7266:
7267: if ($$settings{'internal.crosslistings'} ne '') {
7268: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
7269: }
7270:
7271: if (@currxlists > 0) {
7272: foreach (@currxlists) {
7273: if (m/^([^:]+):(\w*)$/) {
7274: unless (grep/^$1$/,@{$allcourses}) {
7275: push @{$allcourses},$1;
7276: $$LC_code{$1} = $2;
7277: }
7278: }
7279: }
7280: }
7281:
7282: if (@currsections > 0) {
7283: foreach (@currsections) {
7284: if (m/^(\w+):(\w*)$/) {
7285: my $sec = $coursecode.$1;
7286: my $lc_sec = $2;
7287: unless (grep/^$sec$/,@{$allcourses}) {
7288: push @{$allcourses},$sec;
7289: $$LC_code{$sec} = $lc_sec;
7290: }
7291: }
7292: }
7293: }
7294: return;
7295: }
7296:
1.112 bowersj2 7297: =pod
7298:
1.549 albertel 7299: =back
7300:
7301: =head1 HTTP Helpers
7302:
7303: =over 4
7304:
1.648 raeburn 7305: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 7306:
1.258 albertel 7307: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 7308: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 7309: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 7310:
7311: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
7312: $possible_names is an ref to an array of form element names. As an example:
7313: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 7314: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 7315:
7316: =cut
1.1 albertel 7317:
1.6 albertel 7318: sub get_unprocessed_cgi {
1.25 albertel 7319: my ($query,$possible_names)= @_;
1.26 matthew 7320: # $Apache::lonxml::debug=1;
1.356 albertel 7321: foreach my $pair (split(/&/,$query)) {
7322: my ($name, $value) = split(/=/,$pair);
1.369 www 7323: $name = &unescape($name);
1.25 albertel 7324: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
7325: $value =~ tr/+/ /;
7326: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 7327: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 7328: }
1.16 harris41 7329: }
1.6 albertel 7330: }
7331:
1.112 bowersj2 7332: =pod
7333:
1.648 raeburn 7334: =item * &cacheheader()
1.112 bowersj2 7335:
7336: returns cache-controlling header code
7337:
7338: =cut
7339:
1.7 albertel 7340: sub cacheheader {
1.258 albertel 7341: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 7342: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
7343: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 7344: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
7345: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 7346: return $output;
1.7 albertel 7347: }
7348:
1.112 bowersj2 7349: =pod
7350:
1.648 raeburn 7351: =item * &no_cache($r)
1.112 bowersj2 7352:
7353: specifies header code to not have cache
7354:
7355: =cut
7356:
1.9 albertel 7357: sub no_cache {
1.216 albertel 7358: my ($r) = @_;
7359: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 7360: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 7361: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
7362: $r->no_cache(1);
7363: $r->header_out("Expires" => $date);
7364: $r->header_out("Pragma" => "no-cache");
1.123 www 7365: }
7366:
7367: sub content_type {
1.181 albertel 7368: my ($r,$type,$charset) = @_;
1.299 foxr 7369: if ($r) {
7370: # Note that printout.pl calls this with undef for $r.
7371: &no_cache($r);
7372: }
1.258 albertel 7373: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 7374: unless ($charset) {
7375: $charset=&Apache::lonlocal::current_encoding;
7376: }
7377: if ($charset) { $type.='; charset='.$charset; }
7378: if ($r) {
7379: $r->content_type($type);
7380: } else {
7381: print("Content-type: $type\n\n");
7382: }
1.9 albertel 7383: }
1.25 albertel 7384:
1.112 bowersj2 7385: =pod
7386:
1.648 raeburn 7387: =item * &add_to_env($name,$value)
1.112 bowersj2 7388:
1.258 albertel 7389: adds $name to the %env hash with value
1.112 bowersj2 7390: $value, if $name already exists, the entry is converted to an array
7391: reference and $value is added to the array.
7392:
7393: =cut
7394:
1.25 albertel 7395: sub add_to_env {
7396: my ($name,$value)=@_;
1.258 albertel 7397: if (defined($env{$name})) {
7398: if (ref($env{$name})) {
1.25 albertel 7399: #already have multiple values
1.258 albertel 7400: push(@{ $env{$name} },$value);
1.25 albertel 7401: } else {
7402: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 7403: my $first=$env{$name};
7404: undef($env{$name});
7405: push(@{ $env{$name} },$first,$value);
1.25 albertel 7406: }
7407: } else {
1.258 albertel 7408: $env{$name}=$value;
1.25 albertel 7409: }
1.31 albertel 7410: }
1.149 albertel 7411:
7412: =pod
7413:
1.648 raeburn 7414: =item * &get_env_multiple($name)
1.149 albertel 7415:
1.258 albertel 7416: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 7417: values may be defined and end up as an array ref.
7418:
7419: returns an array of values
7420:
7421: =cut
7422:
7423: sub get_env_multiple {
7424: my ($name) = @_;
7425: my @values;
1.258 albertel 7426: if (defined($env{$name})) {
1.149 albertel 7427: # exists is it an array
1.258 albertel 7428: if (ref($env{$name})) {
7429: @values=@{ $env{$name} };
1.149 albertel 7430: } else {
1.258 albertel 7431: $values[0]=$env{$name};
1.149 albertel 7432: }
7433: }
7434: return(@values);
7435: }
7436:
1.660 raeburn 7437: sub ask_for_embedded_content {
7438: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
7439: my $upload_output = '
7440: <form name="upload_embedded" action="'.$actionurl.'"
7441: method="post" enctype="multipart/form-data">';
7442: $upload_output .= $state;
1.661 raeburn 7443: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 7444:
7445: my $num = 0;
7446: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
7447: $upload_output .= &start_data_table_row().
7448: '<td>'.$embed_file.'</td><td>';
7449: if ($args->{'ignore_remote_references'}
7450: && $embed_file =~ m{^\w+://}) {
7451: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
7452: } elsif ($args->{'error_on_invalid_names'}
7453: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
7454:
7455: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
7456:
7457: } else {
7458: $upload_output .='
1.661 raeburn 7459: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 7460: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
7461: my $attrib = join(':',@{$$allfiles{$embed_file}});
7462: $upload_output .=
7463: "\n\t\t".
7464: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
7465: $attrib.'" />';
7466: if (exists($$codebase{$embed_file})) {
7467: $upload_output .=
7468: "\n\t\t".
7469: '<input name="codebase_'.$num.'" type="hidden" value="'.
7470: &escape($$codebase{$embed_file}).'" />';
7471: }
7472: }
7473: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
7474: $num++;
7475: }
7476: $upload_output .= &Apache::loncommon::end_data_table().'<br />
7477: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
7478: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
7479: '.&mt('(only files for which a location has been provided will be uploaded)').'
7480: </form>';
7481: return $upload_output;
7482: }
7483:
1.661 raeburn 7484: sub upload_embedded {
7485: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
7486: $current_disk_usage) = @_;
7487: my $output;
7488: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
7489: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
7490: my $orig_uploaded_filename =
7491: $env{'form.embedded_item_'.$i.'.filename'};
7492:
7493: $env{'form.embedded_orig_'.$i} =
7494: &unescape($env{'form.embedded_orig_'.$i});
7495: my ($path,$fname) =
7496: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
7497: # no path, whole string is fname
7498: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
7499:
7500: $path = $env{'form.currentpath'}.$path;
7501: $fname = &Apache::lonnet::clean_filename($fname);
7502: # See if there is anything left
7503: next if ($fname eq '');
7504:
7505: # Check if file already exists as a file or directory.
7506: my ($state,$msg);
7507: if ($context eq 'portfolio') {
7508: my $port_path = $dirpath;
7509: if ($group ne '') {
7510: $port_path = "groups/$group/$port_path";
7511: }
7512: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
7513: $dir_root,$port_path,$disk_quota,
7514: $current_disk_usage,$uname,$udom);
7515: if ($state eq 'will_exceed_quota'
7516: || $state eq 'file_locked'
7517: || $state eq 'file_exists' ) {
7518: $output .= $msg;
7519: next;
7520: }
7521: } elsif (($context eq 'author') || ($context eq 'testbank')) {
7522: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
7523: if ($state eq 'exists') {
7524: $output .= $msg;
7525: next;
7526: }
7527: }
7528: # Check if extension is valid
7529: if (($fname =~ /\.(\w+)$/) &&
7530: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
7531: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
7532: next;
7533: } elsif (($fname =~ /\.(\w+)$/) &&
7534: (!defined(&Apache::loncommon::fileembstyle($1)))) {
7535: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
7536: next;
7537: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
7538: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
7539: next;
7540: }
7541:
7542: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
7543: if ($context eq 'portfolio') {
7544: my $result=
7545: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
7546: $dirpath.$path);
7547: if ($result !~ m|^/uploaded/|) {
7548: $output .= '<span class="LC_error">'
7549: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
7550: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
7551: .'</span><br />';
7552: next;
7553: } else {
7554: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
7555: $path.$fname.'</span>').'</p>';
7556: }
7557: } else {
7558: # Save the file
7559: my $target = $env{'form.embedded_item_'.$i};
7560: my $fullpath = $dir_root.$dirpath.'/'.$path;
7561: my $dest = $fullpath.$fname;
7562: my $url = $url_root.$dirpath.'/'.$path.$fname;
7563: my @parts=split(/\//,$fullpath);
7564: my $count;
7565: my $filepath = $dir_root;
7566: for ($count=4;$count<=$#parts;$count++) {
7567: $filepath .= "/$parts[$count]";
7568: if ((-e $filepath)!=1) {
7569: mkdir($filepath,0770);
7570: }
7571: }
7572: my $fh;
7573: if (!open($fh,'>'.$dest)) {
7574: &Apache::lonnet::logthis('Failed to create '.$dest);
7575: $output .= '<span class="LC_error">'.
7576: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7577: '</span><br />';
7578: } else {
7579: if (!print $fh $env{'form.embedded_item_'.$i}) {
7580: &Apache::lonnet::logthis('Failed to write to '.$dest);
7581: $output .= '<span class="LC_error">'.
7582: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7583: '</span><br />';
7584: } else {
7585: if ($context eq 'testbank') {
7586: $output .= &mt('Embedded file uploaded successfully:').
7587: ' <a href="'.$url.'">'.
7588: $orig_uploaded_filename.'</a><br />';
7589: } else {
1.705 tempelho 7590: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 7591: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 7592: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 7593: }
7594: }
7595: close($fh);
7596: }
7597: }
7598: }
7599: return $output;
7600: }
7601:
7602: sub check_for_existing {
7603: my ($path,$fname,$element) = @_;
7604: my ($state,$msg);
7605: if (-d $path.'/'.$fname) {
7606: $state = 'exists';
7607: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7608: } elsif (-e $path.'/'.$fname) {
7609: $state = 'exists';
7610: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7611: }
7612: if ($state eq 'exists') {
7613: $msg = '<span class="LC_error">'.$msg.'</span><br />';
7614: }
7615: return ($state,$msg);
7616: }
7617:
7618: sub check_for_upload {
7619: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
7620: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
7621: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
7622: my $getpropath = 1;
7623: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
7624: $getpropath);
7625: my $found_file = 0;
7626: my $locked_file = 0;
7627: foreach my $line (@dir_list) {
7628: my ($file_name)=split(/\&/,$line,2);
7629: if ($file_name eq $fname){
7630: $file_name = $path.$file_name;
7631: if ($group ne '') {
7632: $file_name = $group.$file_name;
7633: }
7634: $found_file = 1;
7635: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
7636: $locked_file = 1;
7637: }
7638: }
7639: }
7640: if (($current_disk_usage + $filesize) > $disk_quota){
7641: my $msg = '<span class="LC_error">'.
7642: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
7643: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
7644: return ('will_exceed_quota',$msg);
7645: } elsif ($found_file) {
7646: if ($locked_file) {
7647: my $msg = '<span class="LC_error">';
7648: $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>');
7649: $msg .= '</span><br />';
7650: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
7651: return ('file_locked',$msg);
7652: } else {
7653: my $msg = '<span class="LC_error">';
7654: $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'});
7655: $msg .= '</span>';
7656: $msg .= '<br />';
7657: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
7658: return ('file_exists',$msg);
7659: }
7660: }
7661: }
7662:
1.31 albertel 7663:
1.41 ng 7664: =pod
1.45 matthew 7665:
1.464 albertel 7666: =back
1.41 ng 7667:
1.112 bowersj2 7668: =head1 CSV Upload/Handling functions
1.38 albertel 7669:
1.41 ng 7670: =over 4
7671:
1.648 raeburn 7672: =item * &upfile_store($r)
1.41 ng 7673:
7674: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 7675: needs $env{'form.upfile'}
1.41 ng 7676: returns $datatoken to be put into hidden field
7677:
7678: =cut
1.31 albertel 7679:
7680: sub upfile_store {
7681: my $r=shift;
1.258 albertel 7682: $env{'form.upfile'}=~s/\r/\n/gs;
7683: $env{'form.upfile'}=~s/\f/\n/gs;
7684: $env{'form.upfile'}=~s/\n+/\n/gs;
7685: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 7686:
1.258 albertel 7687: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
7688: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 7689: {
1.158 raeburn 7690: my $datafile = $r->dir_config('lonDaemons').
7691: '/tmp/'.$datatoken.'.tmp';
7692: if ( open(my $fh,">$datafile") ) {
1.258 albertel 7693: print $fh $env{'form.upfile'};
1.158 raeburn 7694: close($fh);
7695: }
1.31 albertel 7696: }
7697: return $datatoken;
7698: }
7699:
1.56 matthew 7700: =pod
7701:
1.648 raeburn 7702: =item * &load_tmp_file($r)
1.41 ng 7703:
7704: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 7705: needs $env{'form.datatoken'},
7706: sets $env{'form.upfile'} to the contents of the file
1.41 ng 7707:
7708: =cut
1.31 albertel 7709:
7710: sub load_tmp_file {
7711: my $r=shift;
7712: my @studentdata=();
7713: {
1.158 raeburn 7714: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 7715: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 7716: if ( open(my $fh,"<$studentfile") ) {
7717: @studentdata=<$fh>;
7718: close($fh);
7719: }
1.31 albertel 7720: }
1.258 albertel 7721: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 7722: }
7723:
1.56 matthew 7724: =pod
7725:
1.648 raeburn 7726: =item * &upfile_record_sep()
1.41 ng 7727:
7728: Separate uploaded file into records
7729: returns array of records,
1.258 albertel 7730: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 7731:
7732: =cut
1.31 albertel 7733:
7734: sub upfile_record_sep {
1.258 albertel 7735: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 7736: } else {
1.248 albertel 7737: my @records;
1.258 albertel 7738: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 7739: if ($line=~/^\s*$/) { next; }
7740: push(@records,$line);
7741: }
7742: return @records;
1.31 albertel 7743: }
7744: }
7745:
1.56 matthew 7746: =pod
7747:
1.648 raeburn 7748: =item * &record_sep($record)
1.41 ng 7749:
1.258 albertel 7750: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 7751:
7752: =cut
7753:
1.263 www 7754: sub takeleft {
7755: my $index=shift;
7756: return substr('0000'.$index,-4,4);
7757: }
7758:
1.31 albertel 7759: sub record_sep {
7760: my $record=shift;
7761: my %components=();
1.258 albertel 7762: if ($env{'form.upfiletype'} eq 'xml') {
7763: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 7764: my $i=0;
1.356 albertel 7765: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 7766: $field=~s/^(\"|\')//;
7767: $field=~s/(\"|\')$//;
1.263 www 7768: $components{&takeleft($i)}=$field;
1.31 albertel 7769: $i++;
7770: }
1.258 albertel 7771: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 7772: my $i=0;
1.356 albertel 7773: foreach my $field (split(/\t/,$record)) {
1.31 albertel 7774: $field=~s/^(\"|\')//;
7775: $field=~s/(\"|\')$//;
1.263 www 7776: $components{&takeleft($i)}=$field;
1.31 albertel 7777: $i++;
7778: }
7779: } else {
1.561 www 7780: my $separator=',';
1.480 banghart 7781: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 7782: $separator=';';
1.480 banghart 7783: }
1.31 albertel 7784: my $i=0;
1.561 www 7785: # the character we are looking for to indicate the end of a quote or a record
7786: my $looking_for=$separator;
7787: # do not add the characters to the fields
7788: my $ignore=0;
7789: # we just encountered a separator (or the beginning of the record)
7790: my $just_found_separator=1;
7791: # store the field we are working on here
7792: my $field='';
7793: # work our way through all characters in record
7794: foreach my $character ($record=~/(.)/g) {
7795: if ($character eq $looking_for) {
7796: if ($character ne $separator) {
7797: # Found the end of a quote, again looking for separator
7798: $looking_for=$separator;
7799: $ignore=1;
7800: } else {
7801: # Found a separator, store away what we got
7802: $components{&takeleft($i)}=$field;
7803: $i++;
7804: $just_found_separator=1;
7805: $ignore=0;
7806: $field='';
7807: }
7808: next;
7809: }
7810: # single or double quotation marks after a separator indicate beginning of a quote
7811: # we are now looking for the end of the quote and need to ignore separators
7812: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
7813: $looking_for=$character;
7814: next;
7815: }
7816: # ignore would be true after we reached the end of a quote
7817: if ($ignore) { next; }
7818: if (($just_found_separator) && ($character=~/\s/)) { next; }
7819: $field.=$character;
7820: $just_found_separator=0;
1.31 albertel 7821: }
1.561 www 7822: # catch the very last entry, since we never encountered the separator
7823: $components{&takeleft($i)}=$field;
1.31 albertel 7824: }
7825: return %components;
7826: }
7827:
1.144 matthew 7828: ######################################################
7829: ######################################################
7830:
1.56 matthew 7831: =pod
7832:
1.648 raeburn 7833: =item * &upfile_select_html()
1.41 ng 7834:
1.144 matthew 7835: Return HTML code to select a file from the users machine and specify
7836: the file type.
1.41 ng 7837:
7838: =cut
7839:
1.144 matthew 7840: ######################################################
7841: ######################################################
1.31 albertel 7842: sub upfile_select_html {
1.144 matthew 7843: my %Types = (
7844: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 7845: semisv => &mt('Semicolon separated values'),
1.144 matthew 7846: space => &mt('Space separated'),
7847: tab => &mt('Tabulator separated'),
7848: # xml => &mt('HTML/XML'),
7849: );
7850: my $Str = '<input type="file" name="upfile" size="50" />'.
7851: '<br />Type: <select name="upfiletype">';
7852: foreach my $type (sort(keys(%Types))) {
7853: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
7854: }
7855: $Str .= "</select>\n";
7856: return $Str;
1.31 albertel 7857: }
7858:
1.301 albertel 7859: sub get_samples {
7860: my ($records,$toget) = @_;
7861: my @samples=({});
7862: my $got=0;
7863: foreach my $rec (@$records) {
7864: my %temp = &record_sep($rec);
7865: if (! grep(/\S/, values(%temp))) { next; }
7866: if (%temp) {
7867: $samples[$got]=\%temp;
7868: $got++;
7869: if ($got == $toget) { last; }
7870: }
7871: }
7872: return \@samples;
7873: }
7874:
1.144 matthew 7875: ######################################################
7876: ######################################################
7877:
1.56 matthew 7878: =pod
7879:
1.648 raeburn 7880: =item * &csv_print_samples($r,$records)
1.41 ng 7881:
7882: Prints a table of sample values from each column uploaded $r is an
7883: Apache Request ref, $records is an arrayref from
7884: &Apache::loncommon::upfile_record_sep
7885:
7886: =cut
7887:
1.144 matthew 7888: ######################################################
7889: ######################################################
1.31 albertel 7890: sub csv_print_samples {
7891: my ($r,$records) = @_;
1.662 bisitz 7892: my $samples = &get_samples($records,5);
1.301 albertel 7893:
1.594 raeburn 7894: $r->print(&mt('Samples').'<br />'.&start_data_table().
7895: &start_data_table_header_row());
1.356 albertel 7896: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
7897: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 7898: $r->print(&end_data_table_header_row());
1.301 albertel 7899: foreach my $hash (@$samples) {
1.594 raeburn 7900: $r->print(&start_data_table_row());
1.356 albertel 7901: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 7902: $r->print('<td>');
1.356 albertel 7903: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 7904: $r->print('</td>');
7905: }
1.594 raeburn 7906: $r->print(&end_data_table_row());
1.31 albertel 7907: }
1.594 raeburn 7908: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 7909: }
7910:
1.144 matthew 7911: ######################################################
7912: ######################################################
7913:
1.56 matthew 7914: =pod
7915:
1.648 raeburn 7916: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 7917:
7918: Prints a table to create associations between values and table columns.
1.144 matthew 7919:
1.41 ng 7920: $r is an Apache Request ref,
7921: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 7922: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 7923:
7924: =cut
7925:
1.144 matthew 7926: ######################################################
7927: ######################################################
1.31 albertel 7928: sub csv_print_select_table {
7929: my ($r,$records,$d) = @_;
1.301 albertel 7930: my $i=0;
7931: my $samples = &get_samples($records,1);
1.144 matthew 7932: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 7933: &start_data_table().&start_data_table_header_row().
1.144 matthew 7934: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 7935: '<th>'.&mt('Column').'</th>'.
7936: &end_data_table_header_row()."\n");
1.356 albertel 7937: foreach my $array_ref (@$d) {
7938: my ($value,$display,$defaultcol)=@{ $array_ref };
1.705 tempelho 7939: $r->print(&start_data_table_row().'<tr><td>'.$display.'</td>');
1.31 albertel 7940:
7941: $r->print('<td><select name=f'.$i.
1.32 matthew 7942: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 7943: $r->print('<option value="none"></option>');
1.356 albertel 7944: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
7945: $r->print('<option value="'.$sample.'"'.
7946: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 7947: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 7948: }
1.594 raeburn 7949: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 7950: $i++;
7951: }
1.594 raeburn 7952: $r->print(&end_data_table());
1.31 albertel 7953: $i--;
7954: return $i;
7955: }
1.56 matthew 7956:
1.144 matthew 7957: ######################################################
7958: ######################################################
7959:
1.56 matthew 7960: =pod
1.31 albertel 7961:
1.648 raeburn 7962: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 7963:
7964: Prints a table of sample values from the upload and can make associate samples to internal names.
7965:
7966: $r is an Apache Request ref,
7967: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
7968: $d is an array of 2 element arrays (internal name, displayed name)
7969:
7970: =cut
7971:
1.144 matthew 7972: ######################################################
7973: ######################################################
1.31 albertel 7974: sub csv_samples_select_table {
7975: my ($r,$records,$d) = @_;
7976: my $i=0;
1.144 matthew 7977: #
1.662 bisitz 7978: my $max_samples = 5;
7979: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 7980: $r->print(&start_data_table().
7981: &start_data_table_header_row().'<th>'.
7982: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
7983: &end_data_table_header_row());
1.301 albertel 7984:
7985: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 7986: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 7987: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 7988: foreach my $option (@$d) {
7989: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 7990: $r->print('<option value="'.$value.'"'.
1.253 albertel 7991: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 7992: $display.'</option>');
1.31 albertel 7993: }
7994: $r->print('</select></td><td>');
1.662 bisitz 7995: foreach my $line (0..($max_samples-1)) {
1.301 albertel 7996: if (defined($samples->[$line]{$key})) {
7997: $r->print($samples->[$line]{$key}."<br />\n");
7998: }
7999: }
1.594 raeburn 8000: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8001: $i++;
8002: }
1.594 raeburn 8003: $r->print(&end_data_table());
1.31 albertel 8004: $i--;
8005: return($i);
1.115 matthew 8006: }
8007:
1.144 matthew 8008: ######################################################
8009: ######################################################
8010:
1.115 matthew 8011: =pod
8012:
1.648 raeburn 8013: =item * &clean_excel_name($name)
1.115 matthew 8014:
8015: Returns a replacement for $name which does not contain any illegal characters.
8016:
8017: =cut
8018:
1.144 matthew 8019: ######################################################
8020: ######################################################
1.115 matthew 8021: sub clean_excel_name {
8022: my ($name) = @_;
8023: $name =~ s/[:\*\?\/\\]//g;
8024: if (length($name) > 31) {
8025: $name = substr($name,0,31);
8026: }
8027: return $name;
1.25 albertel 8028: }
1.84 albertel 8029:
1.85 albertel 8030: =pod
8031:
1.648 raeburn 8032: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8033:
8034: Returns either 1 or undef
8035:
8036: 1 if the part is to be hidden, undef if it is to be shown
8037:
8038: Arguments are:
8039:
8040: $id the id of the part to be checked
8041: $symb, optional the symb of the resource to check
8042: $udom, optional the domain of the user to check for
8043: $uname, optional the username of the user to check for
8044:
8045: =cut
1.84 albertel 8046:
8047: sub check_if_partid_hidden {
8048: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8049: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8050: $symb,$udom,$uname);
1.141 albertel 8051: my $truth=1;
8052: #if the string starts with !, then the list is the list to show not hide
8053: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8054: my @hiddenlist=split(/,/,$hiddenparts);
8055: foreach my $checkid (@hiddenlist) {
1.141 albertel 8056: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8057: }
1.141 albertel 8058: return !$truth;
1.84 albertel 8059: }
1.127 matthew 8060:
1.138 matthew 8061:
8062: ############################################################
8063: ############################################################
8064:
8065: =pod
8066:
1.157 matthew 8067: =back
8068:
1.138 matthew 8069: =head1 cgi-bin script and graphing routines
8070:
1.157 matthew 8071: =over 4
8072:
1.648 raeburn 8073: =item * &get_cgi_id()
1.138 matthew 8074:
8075: Inputs: none
8076:
8077: Returns an id which can be used to pass environment variables
8078: to various cgi-bin scripts. These environment variables will
8079: be removed from the users environment after a given time by
8080: the routine &Apache::lonnet::transfer_profile_to_env.
8081:
8082: =cut
8083:
8084: ############################################################
8085: ############################################################
1.152 albertel 8086: my $uniq=0;
1.136 matthew 8087: sub get_cgi_id {
1.154 albertel 8088: $uniq=($uniq+1)%100000;
1.280 albertel 8089: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8090: }
8091:
1.127 matthew 8092: ############################################################
8093: ############################################################
8094:
8095: =pod
8096:
1.648 raeburn 8097: =item * &DrawBarGraph()
1.127 matthew 8098:
1.138 matthew 8099: Facilitates the plotting of data in a (stacked) bar graph.
8100: Puts plot definition data into the users environment in order for
8101: graph.png to plot it. Returns an <img> tag for the plot.
8102: The bars on the plot are labeled '1','2',...,'n'.
8103:
8104: Inputs:
8105:
8106: =over 4
8107:
8108: =item $Title: string, the title of the plot
8109:
8110: =item $xlabel: string, text describing the X-axis of the plot
8111:
8112: =item $ylabel: string, text describing the Y-axis of the plot
8113:
8114: =item $Max: scalar, the maximum Y value to use in the plot
8115: If $Max is < any data point, the graph will not be rendered.
8116:
1.140 matthew 8117: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8118: they are plotted. If undefined, default values will be used.
8119:
1.178 matthew 8120: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8121:
1.138 matthew 8122: =item @Values: An array of array references. Each array reference holds data
8123: to be plotted in a stacked bar chart.
8124:
1.239 matthew 8125: =item If the final element of @Values is a hash reference the key/value
8126: pairs will be added to the graph definition.
8127:
1.138 matthew 8128: =back
8129:
8130: Returns:
8131:
8132: An <img> tag which references graph.png and the appropriate identifying
8133: information for the plot.
8134:
1.127 matthew 8135: =cut
8136:
8137: ############################################################
8138: ############################################################
1.134 matthew 8139: sub DrawBarGraph {
1.178 matthew 8140: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 8141: #
8142: if (! defined($colors)) {
8143: $colors = ['#33ff00',
8144: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
8145: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
8146: ];
8147: }
1.228 matthew 8148: my $extra_settings = {};
8149: if (ref($Values[-1]) eq 'HASH') {
8150: $extra_settings = pop(@Values);
8151: }
1.127 matthew 8152: #
1.136 matthew 8153: my $identifier = &get_cgi_id();
8154: my $id = 'cgi.'.$identifier;
1.129 matthew 8155: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 8156: return '';
8157: }
1.225 matthew 8158: #
8159: my @Labels;
8160: if (defined($labels)) {
8161: @Labels = @$labels;
8162: } else {
8163: for (my $i=0;$i<@{$Values[0]};$i++) {
8164: push (@Labels,$i+1);
8165: }
8166: }
8167: #
1.129 matthew 8168: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 8169: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 8170: my %ValuesHash;
8171: my $NumSets=1;
8172: foreach my $array (@Values) {
8173: next if (! ref($array));
1.136 matthew 8174: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 8175: join(',',@$array);
1.129 matthew 8176: }
1.127 matthew 8177: #
1.136 matthew 8178: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 8179: if ($NumBars < 3) {
8180: $width = 120+$NumBars*32;
1.220 matthew 8181: $xskip = 1;
1.225 matthew 8182: $bar_width = 30;
8183: } elsif ($NumBars < 5) {
8184: $width = 120+$NumBars*20;
8185: $xskip = 1;
8186: $bar_width = 20;
1.220 matthew 8187: } elsif ($NumBars < 10) {
1.136 matthew 8188: $width = 120+$NumBars*15;
8189: $xskip = 1;
8190: $bar_width = 15;
8191: } elsif ($NumBars <= 25) {
8192: $width = 120+$NumBars*11;
8193: $xskip = 5;
8194: $bar_width = 8;
8195: } elsif ($NumBars <= 50) {
8196: $width = 120+$NumBars*8;
8197: $xskip = 5;
8198: $bar_width = 4;
8199: } else {
8200: $width = 120+$NumBars*8;
8201: $xskip = 5;
8202: $bar_width = 4;
8203: }
8204: #
1.137 matthew 8205: $Max = 1 if ($Max < 1);
8206: if ( int($Max) < $Max ) {
8207: $Max++;
8208: $Max = int($Max);
8209: }
1.127 matthew 8210: $Title = '' if (! defined($Title));
8211: $xlabel = '' if (! defined($xlabel));
8212: $ylabel = '' if (! defined($ylabel));
1.369 www 8213: $ValuesHash{$id.'.title'} = &escape($Title);
8214: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
8215: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 8216: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 8217: $ValuesHash{$id.'.NumBars'} = $NumBars;
8218: $ValuesHash{$id.'.NumSets'} = $NumSets;
8219: $ValuesHash{$id.'.PlotType'} = 'bar';
8220: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8221: $ValuesHash{$id.'.height'} = $height;
8222: $ValuesHash{$id.'.width'} = $width;
8223: $ValuesHash{$id.'.xskip'} = $xskip;
8224: $ValuesHash{$id.'.bar_width'} = $bar_width;
8225: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 8226: #
1.228 matthew 8227: # Deal with other parameters
8228: while (my ($key,$value) = each(%$extra_settings)) {
8229: $ValuesHash{$id.'.'.$key} = $value;
8230: }
8231: #
1.646 raeburn 8232: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 8233: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8234: }
8235:
8236: ############################################################
8237: ############################################################
8238:
8239: =pod
8240:
1.648 raeburn 8241: =item * &DrawXYGraph()
1.137 matthew 8242:
1.138 matthew 8243: Facilitates the plotting of data in an XY graph.
8244: Puts plot definition data into the users environment in order for
8245: graph.png to plot it. Returns an <img> tag for the plot.
8246:
8247: Inputs:
8248:
8249: =over 4
8250:
8251: =item $Title: string, the title of the plot
8252:
8253: =item $xlabel: string, text describing the X-axis of the plot
8254:
8255: =item $ylabel: string, text describing the Y-axis of the plot
8256:
8257: =item $Max: scalar, the maximum Y value to use in the plot
8258: If $Max is < any data point, the graph will not be rendered.
8259:
8260: =item $colors: Array ref containing the hex color codes for the data to be
8261: plotted in. If undefined, default values will be used.
8262:
8263: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8264:
8265: =item $Ydata: Array ref containing Array refs.
1.185 www 8266: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 8267:
8268: =item %Values: hash indicating or overriding any default values which are
8269: passed to graph.png.
8270: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8271:
8272: =back
8273:
8274: Returns:
8275:
8276: An <img> tag which references graph.png and the appropriate identifying
8277: information for the plot.
8278:
1.137 matthew 8279: =cut
8280:
8281: ############################################################
8282: ############################################################
8283: sub DrawXYGraph {
8284: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
8285: #
8286: # Create the identifier for the graph
8287: my $identifier = &get_cgi_id();
8288: my $id = 'cgi.'.$identifier;
8289: #
8290: $Title = '' if (! defined($Title));
8291: $xlabel = '' if (! defined($xlabel));
8292: $ylabel = '' if (! defined($ylabel));
8293: my %ValuesHash =
8294: (
1.369 www 8295: $id.'.title' => &escape($Title),
8296: $id.'.xlabel' => &escape($xlabel),
8297: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 8298: $id.'.y_max_value'=> $Max,
8299: $id.'.labels' => join(',',@$Xlabels),
8300: $id.'.PlotType' => 'XY',
8301: );
8302: #
8303: if (defined($colors) && ref($colors) eq 'ARRAY') {
8304: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8305: }
8306: #
8307: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
8308: return '';
8309: }
8310: my $NumSets=1;
1.138 matthew 8311: foreach my $array (@{$Ydata}){
1.137 matthew 8312: next if (! ref($array));
8313: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
8314: }
1.138 matthew 8315: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 8316: #
8317: # Deal with other parameters
8318: while (my ($key,$value) = each(%Values)) {
8319: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 8320: }
8321: #
1.646 raeburn 8322: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 8323: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8324: }
8325:
8326: ############################################################
8327: ############################################################
8328:
8329: =pod
8330:
1.648 raeburn 8331: =item * &DrawXYYGraph()
1.138 matthew 8332:
8333: Facilitates the plotting of data in an XY graph with two Y axes.
8334: Puts plot definition data into the users environment in order for
8335: graph.png to plot it. Returns an <img> tag for the plot.
8336:
8337: Inputs:
8338:
8339: =over 4
8340:
8341: =item $Title: string, the title of the plot
8342:
8343: =item $xlabel: string, text describing the X-axis of the plot
8344:
8345: =item $ylabel: string, text describing the Y-axis of the plot
8346:
8347: =item $colors: Array ref containing the hex color codes for the data to be
8348: plotted in. If undefined, default values will be used.
8349:
8350: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8351:
8352: =item $Ydata1: The first data set
8353:
8354: =item $Min1: The minimum value of the left Y-axis
8355:
8356: =item $Max1: The maximum value of the left Y-axis
8357:
8358: =item $Ydata2: The second data set
8359:
8360: =item $Min2: The minimum value of the right Y-axis
8361:
8362: =item $Max2: The maximum value of the left Y-axis
8363:
8364: =item %Values: hash indicating or overriding any default values which are
8365: passed to graph.png.
8366: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8367:
8368: =back
8369:
8370: Returns:
8371:
8372: An <img> tag which references graph.png and the appropriate identifying
8373: information for the plot.
1.136 matthew 8374:
8375: =cut
8376:
8377: ############################################################
8378: ############################################################
1.137 matthew 8379: sub DrawXYYGraph {
8380: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
8381: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 8382: #
8383: # Create the identifier for the graph
8384: my $identifier = &get_cgi_id();
8385: my $id = 'cgi.'.$identifier;
8386: #
8387: $Title = '' if (! defined($Title));
8388: $xlabel = '' if (! defined($xlabel));
8389: $ylabel = '' if (! defined($ylabel));
8390: my %ValuesHash =
8391: (
1.369 www 8392: $id.'.title' => &escape($Title),
8393: $id.'.xlabel' => &escape($xlabel),
8394: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 8395: $id.'.labels' => join(',',@$Xlabels),
8396: $id.'.PlotType' => 'XY',
8397: $id.'.NumSets' => 2,
1.137 matthew 8398: $id.'.two_axes' => 1,
8399: $id.'.y1_max_value' => $Max1,
8400: $id.'.y1_min_value' => $Min1,
8401: $id.'.y2_max_value' => $Max2,
8402: $id.'.y2_min_value' => $Min2,
1.136 matthew 8403: );
8404: #
1.137 matthew 8405: if (defined($colors) && ref($colors) eq 'ARRAY') {
8406: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8407: }
8408: #
8409: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
8410: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 8411: return '';
8412: }
8413: my $NumSets=1;
1.137 matthew 8414: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 8415: next if (! ref($array));
8416: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 8417: }
8418: #
8419: # Deal with other parameters
8420: while (my ($key,$value) = each(%Values)) {
8421: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 8422: }
8423: #
1.646 raeburn 8424: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 8425: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 8426: }
8427:
8428: ############################################################
8429: ############################################################
8430:
8431: =pod
8432:
1.157 matthew 8433: =back
8434:
1.139 matthew 8435: =head1 Statistics helper routines?
8436:
8437: Bad place for them but what the hell.
8438:
1.157 matthew 8439: =over 4
8440:
1.648 raeburn 8441: =item * &chartlink()
1.139 matthew 8442:
8443: Returns a link to the chart for a specific student.
8444:
8445: Inputs:
8446:
8447: =over 4
8448:
8449: =item $linktext: The text of the link
8450:
8451: =item $sname: The students username
8452:
8453: =item $sdomain: The students domain
8454:
8455: =back
8456:
1.157 matthew 8457: =back
8458:
1.139 matthew 8459: =cut
8460:
8461: ############################################################
8462: ############################################################
8463: sub chartlink {
8464: my ($linktext, $sname, $sdomain) = @_;
8465: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 8466: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 8467: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 8468: '">'.$linktext.'</a>';
1.153 matthew 8469: }
8470:
8471: #######################################################
8472: #######################################################
8473:
8474: =pod
8475:
8476: =head1 Course Environment Routines
1.157 matthew 8477:
8478: =over 4
1.153 matthew 8479:
1.648 raeburn 8480: =item * &restore_course_settings()
1.153 matthew 8481:
1.648 raeburn 8482: =item * &store_course_settings()
1.153 matthew 8483:
8484: Restores/Store indicated form parameters from the course environment.
8485: Will not overwrite existing values of the form parameters.
8486:
8487: Inputs:
8488: a scalar describing the data (e.g. 'chart', 'problem_analysis')
8489:
8490: a hash ref describing the data to be stored. For example:
8491:
8492: %Save_Parameters = ('Status' => 'scalar',
8493: 'chartoutputmode' => 'scalar',
8494: 'chartoutputdata' => 'scalar',
8495: 'Section' => 'array',
1.373 raeburn 8496: 'Group' => 'array',
1.153 matthew 8497: 'StudentData' => 'array',
8498: 'Maps' => 'array');
8499:
8500: Returns: both routines return nothing
8501:
1.631 raeburn 8502: =back
8503:
1.153 matthew 8504: =cut
8505:
8506: #######################################################
8507: #######################################################
8508: sub store_course_settings {
1.496 albertel 8509: return &store_settings($env{'request.course.id'},@_);
8510: }
8511:
8512: sub store_settings {
1.153 matthew 8513: # save to the environment
8514: # appenv the same items, just to be safe
1.300 albertel 8515: my $udom = $env{'user.domain'};
8516: my $uname = $env{'user.name'};
1.496 albertel 8517: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8518: my %SaveHash;
8519: my %AppHash;
8520: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 8521: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 8522: my $envname = 'environment.'.$basename;
1.258 albertel 8523: if (exists($env{'form.'.$setting})) {
1.153 matthew 8524: # Save this value away
8525: if ($type eq 'scalar' &&
1.258 albertel 8526: (! exists($env{$envname}) ||
8527: $env{$envname} ne $env{'form.'.$setting})) {
8528: $SaveHash{$basename} = $env{'form.'.$setting};
8529: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 8530: } elsif ($type eq 'array') {
8531: my $stored_form;
1.258 albertel 8532: if (ref($env{'form.'.$setting})) {
1.153 matthew 8533: $stored_form = join(',',
8534: map {
1.369 www 8535: &escape($_);
1.258 albertel 8536: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 8537: } else {
8538: $stored_form =
1.369 www 8539: &escape($env{'form.'.$setting});
1.153 matthew 8540: }
8541: # Determine if the array contents are the same.
1.258 albertel 8542: if ($stored_form ne $env{$envname}) {
1.153 matthew 8543: $SaveHash{$basename} = $stored_form;
8544: $AppHash{$envname} = $stored_form;
8545: }
8546: }
8547: }
8548: }
8549: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 8550: $udom,$uname);
1.153 matthew 8551: if ($put_result !~ /^(ok|delayed)/) {
8552: &Apache::lonnet::logthis('unable to save form parameters, '.
8553: 'got error:'.$put_result);
8554: }
8555: # Make sure these settings stick around in this session, too
1.646 raeburn 8556: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 8557: return;
8558: }
8559:
8560: sub restore_course_settings {
1.499 albertel 8561: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 8562: }
8563:
8564: sub restore_settings {
8565: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8566: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 8567: next if (exists($env{'form.'.$setting}));
1.496 albertel 8568: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 8569: '.'.$setting;
1.258 albertel 8570: if (exists($env{$envname})) {
1.153 matthew 8571: if ($type eq 'scalar') {
1.258 albertel 8572: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 8573: } elsif ($type eq 'array') {
1.258 albertel 8574: $env{'form.'.$setting} = [
1.153 matthew 8575: map {
1.369 www 8576: &unescape($_);
1.258 albertel 8577: } split(',',$env{$envname})
1.153 matthew 8578: ];
8579: }
8580: }
8581: }
1.127 matthew 8582: }
8583:
1.618 raeburn 8584: #######################################################
8585: #######################################################
8586:
8587: =pod
8588:
8589: =head1 Domain E-mail Routines
8590:
8591: =over 4
8592:
1.648 raeburn 8593: =item * &build_recipient_list()
1.618 raeburn 8594:
8595: Build recipient lists for three types of e-mail:
8596: (a) Error Reports, (b) Package Updates, (c) Help requests, generated by
1.619 raeburn 8597: lonerrorhandler.pm, CHECKRPMS and lonsupportreq.pm respectively.
1.618 raeburn 8598:
8599: Inputs:
1.619 raeburn 8600: defmail (scalar - email address of default recipient),
1.618 raeburn 8601: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 8602: defdom (domain for which to retrieve configuration settings),
8603: origmail (scalar - email address of recipient from loncapa.conf,
8604: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 8605:
1.655 raeburn 8606: Returns: comma separated list of addresses to which to send e-mail.
8607:
8608: =back
1.618 raeburn 8609:
8610: =cut
8611:
8612: ############################################################
8613: ############################################################
8614: sub build_recipient_list {
1.619 raeburn 8615: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 8616: my @recipients;
8617: my $otheremails;
8618: my %domconfig =
8619: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
8620: if (ref($domconfig{'contacts'}) eq 'HASH') {
8621: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
8622: my @contacts = ('adminemail','supportemail');
8623: foreach my $item (@contacts) {
8624: if ($domconfig{'contacts'}{$mailing}{$item}) {
1.619 raeburn 8625: my $addr = $domconfig{'contacts'}{$item};
8626: if (!grep(/^\Q$addr\E$/,@recipients)) {
8627: push(@recipients,$addr);
8628: }
1.618 raeburn 8629: }
8630: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
8631: }
8632: }
1.619 raeburn 8633: } elsif ($origmail ne '') {
8634: push(@recipients,$origmail);
1.618 raeburn 8635: }
1.688 raeburn 8636: if (defined($defmail)) {
8637: if ($defmail ne '') {
8638: push(@recipients,$defmail);
8639: }
1.618 raeburn 8640: }
8641: if ($otheremails) {
1.619 raeburn 8642: my @others;
8643: if ($otheremails =~ /,/) {
8644: @others = split(/,/,$otheremails);
1.618 raeburn 8645: } else {
1.619 raeburn 8646: push(@others,$otheremails);
8647: }
8648: foreach my $addr (@others) {
8649: if (!grep(/^\Q$addr\E$/,@recipients)) {
8650: push(@recipients,$addr);
8651: }
1.618 raeburn 8652: }
8653: }
1.619 raeburn 8654: my $recipientlist = join(',',@recipients);
1.618 raeburn 8655: return $recipientlist;
8656: }
8657:
1.127 matthew 8658: ############################################################
8659: ############################################################
1.154 albertel 8660:
1.655 raeburn 8661: =pod
8662:
8663: =head1 Course Catalog Routines
8664:
8665: =over 4
8666:
8667: =item * &gather_categories()
8668:
8669: Converts category definitions - keys of categories hash stored in
8670: coursecategories in configuration.db on the primary library server in a
8671: domain - to an array. Also generates javascript and idx hash used to
8672: generate Domain Coordinator interface for editing Course Categories.
8673:
8674: Inputs:
1.663 raeburn 8675:
1.655 raeburn 8676: categories (reference to hash of category definitions).
1.663 raeburn 8677:
1.655 raeburn 8678: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8679: categories and subcategories).
1.663 raeburn 8680:
1.655 raeburn 8681: idx (reference to hash of counters used in Domain Coordinator interface for
8682: editing Course Categories).
1.663 raeburn 8683:
1.655 raeburn 8684: jsarray (reference to array of categories used to create Javascript arrays for
8685: Domain Coordinator interface for editing Course Categories).
8686:
8687: Returns: nothing
8688:
8689: Side effects: populates cats, idx and jsarray.
8690:
8691: =cut
8692:
8693: sub gather_categories {
8694: my ($categories,$cats,$idx,$jsarray) = @_;
8695: my %counters;
8696: my $num = 0;
8697: foreach my $item (keys(%{$categories})) {
8698: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
8699: if ($container eq '' && $depth == 0) {
8700: $cats->[$depth][$categories->{$item}] = $cat;
8701: } else {
8702: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
8703: }
8704: my ($escitem,$tail) = split(/:/,$item,2);
8705: if ($counters{$tail} eq '') {
8706: $counters{$tail} = $num;
8707: $num ++;
8708: }
8709: if (ref($idx) eq 'HASH') {
8710: $idx->{$item} = $counters{$tail};
8711: }
8712: if (ref($jsarray) eq 'ARRAY') {
8713: push(@{$jsarray->[$counters{$tail}]},$item);
8714: }
8715: }
8716: return;
8717: }
8718:
8719: =pod
8720:
8721: =item * &extract_categories()
8722:
8723: Used to generate breadcrumb trails for course categories.
8724:
8725: Inputs:
1.663 raeburn 8726:
1.655 raeburn 8727: categories (reference to hash of category definitions).
1.663 raeburn 8728:
1.655 raeburn 8729: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8730: categories and subcategories).
1.663 raeburn 8731:
1.655 raeburn 8732: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 8733:
1.655 raeburn 8734: allitems (reference to hash - key is category key
8735: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 8736:
1.655 raeburn 8737: idx (reference to hash of counters used in Domain Coordinator interface for
8738: editing Course Categories).
1.663 raeburn 8739:
1.655 raeburn 8740: jsarray (reference to array of categories used to create Javascript arrays for
8741: Domain Coordinator interface for editing Course Categories).
8742:
1.665 raeburn 8743: subcats (reference to hash of arrays containing all subcategories within each
8744: category, -recursive)
8745:
1.655 raeburn 8746: Returns: nothing
8747:
8748: Side effects: populates trails and allitems hash references.
8749:
8750: =cut
8751:
8752: sub extract_categories {
1.665 raeburn 8753: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 8754: if (ref($categories) eq 'HASH') {
8755: &gather_categories($categories,$cats,$idx,$jsarray);
8756: if (ref($cats->[0]) eq 'ARRAY') {
8757: for (my $i=0; $i<@{$cats->[0]}; $i++) {
8758: my $name = $cats->[0][$i];
8759: my $item = &escape($name).'::0';
8760: my $trailstr;
8761: if ($name eq 'instcode') {
8762: $trailstr = &mt('Official courses (with institutional codes)');
8763: } else {
8764: $trailstr = $name;
8765: }
8766: if ($allitems->{$item} eq '') {
8767: push(@{$trails},$trailstr);
8768: $allitems->{$item} = scalar(@{$trails})-1;
8769: }
8770: my @parents = ($name);
8771: if (ref($cats->[1]{$name}) eq 'ARRAY') {
8772: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
8773: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 8774: if (ref($subcats) eq 'HASH') {
8775: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
8776: }
8777: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
8778: }
8779: } else {
8780: if (ref($subcats) eq 'HASH') {
8781: $subcats->{$item} = [];
1.655 raeburn 8782: }
8783: }
8784: }
8785: }
8786: }
8787: return;
8788: }
8789:
8790: =pod
8791:
8792: =item *&recurse_categories()
8793:
8794: Recursively used to generate breadcrumb trails for course categories.
8795:
8796: Inputs:
1.663 raeburn 8797:
1.655 raeburn 8798: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8799: categories and subcategories).
1.663 raeburn 8800:
1.655 raeburn 8801: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 8802:
8803: category (current course category, for which breadcrumb trail is being generated).
8804:
8805: trails (reference to array of breadcrumb trails for each category).
8806:
1.655 raeburn 8807: allitems (reference to hash - key is category key
8808: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 8809:
1.655 raeburn 8810: parents (array containing containers directories for current category,
8811: back to top level).
8812:
8813: Returns: nothing
8814:
8815: Side effects: populates trails and allitems hash references
8816:
8817: =cut
8818:
8819: sub recurse_categories {
1.665 raeburn 8820: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 8821: my $shallower = $depth - 1;
8822: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
8823: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
8824: my $name = $cats->[$depth]{$category}[$k];
8825: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
8826: my $trailstr = join(' -> ',(@{$parents},$category));
8827: if ($allitems->{$item} eq '') {
8828: push(@{$trails},$trailstr);
8829: $allitems->{$item} = scalar(@{$trails})-1;
8830: }
8831: my $deeper = $depth+1;
8832: push(@{$parents},$category);
1.665 raeburn 8833: if (ref($subcats) eq 'HASH') {
8834: my $subcat = &escape($name).':'.$category.':'.$depth;
8835: for (my $j=@{$parents}; $j>=0; $j--) {
8836: my $higher;
8837: if ($j > 0) {
8838: $higher = &escape($parents->[$j]).':'.
8839: &escape($parents->[$j-1]).':'.$j;
8840: } else {
8841: $higher = &escape($parents->[$j]).'::'.$j;
8842: }
8843: push(@{$subcats->{$higher}},$subcat);
8844: }
8845: }
8846: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
8847: $subcats);
1.655 raeburn 8848: pop(@{$parents});
8849: }
8850: } else {
8851: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
8852: my $trailstr = join(' -> ',(@{$parents},$category));
8853: if ($allitems->{$item} eq '') {
8854: push(@{$trails},$trailstr);
8855: $allitems->{$item} = scalar(@{$trails})-1;
8856: }
8857: }
8858: return;
8859: }
8860:
1.663 raeburn 8861: =pod
8862:
8863: =item *&assign_categories_table()
8864:
8865: Create a datatable for display of hierarchical categories in a domain,
8866: with checkboxes to allow a course to be categorized.
8867:
8868: Inputs:
8869:
8870: cathash - reference to hash of categories defined for the domain (from
8871: configuration.db)
8872:
8873: currcat - scalar with an & separated list of categories assigned to a course.
8874:
8875: Returns: $output (markup to be displayed)
8876:
8877: =cut
8878:
8879: sub assign_categories_table {
8880: my ($cathash,$currcat) = @_;
8881: my $output;
8882: if (ref($cathash) eq 'HASH') {
8883: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
8884: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
8885: $maxdepth = scalar(@cats);
8886: if (@cats > 0) {
8887: my $itemcount = 0;
8888: if (ref($cats[0]) eq 'ARRAY') {
8889: $output = &Apache::loncommon::start_data_table();
8890: my @currcategories;
8891: if ($currcat ne '') {
8892: @currcategories = split('&',$currcat);
8893: }
8894: for (my $i=0; $i<@{$cats[0]}; $i++) {
8895: my $parent = $cats[0][$i];
8896: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
8897: next if ($parent eq 'instcode');
8898: my $item = &escape($parent).'::0';
8899: my $checked = '';
8900: if (@currcategories > 0) {
8901: if (grep(/^\Q$item\E$/,@currcategories)) {
8902: $checked = ' checked="checked" ';
8903: }
8904: }
1.675 raeburn 8905: $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
8906: '<input type="checkbox" name="usecategory" value="'.
8907: $item.'"'.$checked.' />'.$parent.'</span>'.
8908: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 8909: my $depth = 1;
8910: push(@path,$parent);
8911: $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
8912: pop(@path);
8913: $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
8914: $itemcount ++;
8915: }
8916: $output .= &Apache::loncommon::end_data_table();
8917: }
8918: }
8919: }
8920: return $output;
8921: }
8922:
8923: =pod
8924:
8925: =item *&assign_category_rows()
8926:
8927: Create a datatable row for display of nested categories in a domain,
8928: with checkboxes to allow a course to be categorized,called recursively.
8929:
8930: Inputs:
8931:
8932: itemcount - track row number for alternating colors
8933:
8934: cats - reference to array of arrays/hashes which encapsulates hierarchy of
8935: categories and subcategories.
8936:
8937: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
8938:
8939: parent - parent of current category item
8940:
8941: path - Array containing all categories back up through the hierarchy from the
8942: current category to the top level.
8943:
8944: currcategories - reference to array of current categories assigned to the course
8945:
8946: Returns: $output (markup to be displayed).
8947:
8948: =cut
8949:
8950: sub assign_category_rows {
8951: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
8952: my ($text,$name,$item,$chgstr);
8953: if (ref($cats) eq 'ARRAY') {
8954: my $maxdepth = scalar(@{$cats});
8955: if (ref($cats->[$depth]) eq 'HASH') {
8956: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
8957: my $numchildren = @{$cats->[$depth]{$parent}};
8958: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
8959: $text .= '<td><table class="LC_datatable">';
8960: for (my $j=0; $j<$numchildren; $j++) {
8961: $name = $cats->[$depth]{$parent}[$j];
8962: $item = &escape($name).':'.&escape($parent).':'.$depth;
8963: my $deeper = $depth+1;
8964: my $checked = '';
8965: if (ref($currcategories) eq 'ARRAY') {
8966: if (@{$currcategories} > 0) {
8967: if (grep(/^\Q$item\E$/,@{$currcategories})) {
8968: $checked = ' checked="checked" ';
8969: }
8970: }
8971: }
1.664 raeburn 8972: $text .= '<tr><td><span class="LC_nobreak"><label>'.
8973: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 8974: $item.'"'.$checked.' />'.$name.'</label></span>'.
8975: '<input type="hidden" name="catname" value="'.$name.'" />'.
8976: '</td><td>';
1.663 raeburn 8977: if (ref($path) eq 'ARRAY') {
8978: push(@{$path},$name);
8979: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
8980: pop(@{$path});
8981: }
8982: $text .= '</td></tr>';
8983: }
8984: $text .= '</table></td>';
8985: }
8986: }
8987: }
8988: return $text;
8989: }
8990:
1.655 raeburn 8991: ############################################################
8992: ############################################################
8993:
8994:
1.443 albertel 8995: sub commit_customrole {
1.664 raeburn 8996: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 8997: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 8998: ($start?', '.&mt('starting').' '.localtime($start):'').
8999: ($end?', ending '.localtime($end):'').': <b>'.
9000: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9001: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9002: '</b><br />';
9003: return $output;
9004: }
9005:
9006: sub commit_standardrole {
1.541 raeburn 9007: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9008: my ($output,$logmsg,$linefeed);
9009: if ($context eq 'auto') {
9010: $linefeed = "\n";
9011: } else {
9012: $linefeed = "<br />\n";
9013: }
1.443 albertel 9014: if ($three eq 'st') {
1.541 raeburn 9015: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9016: $one,$two,$sec,$context);
9017: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9018: ($result eq 'unknown_course') || ($result eq 'refused')) {
9019: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9020: } else {
1.541 raeburn 9021: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9022: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9023: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9024: if ($context eq 'auto') {
9025: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9026: } else {
9027: $output .= '<b>'.$result.'</b>'.$linefeed.
9028: &mt('Add to classlist').': <b>ok</b>';
9029: }
9030: $output .= $linefeed;
1.443 albertel 9031: }
9032: } else {
9033: $output = &mt('Assigning').' '.$three.' in '.$url.
9034: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9035: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9036: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9037: if ($context eq 'auto') {
9038: $output .= $result.$linefeed;
9039: } else {
9040: $output .= '<b>'.$result.'</b>'.$linefeed;
9041: }
1.443 albertel 9042: }
9043: return $output;
9044: }
9045:
9046: sub commit_studentrole {
1.541 raeburn 9047: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9048: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9049: if ($context eq 'auto') {
9050: $linefeed = "\n";
9051: } else {
9052: $linefeed = '<br />'."\n";
9053: }
1.443 albertel 9054: if (defined($one) && defined($two)) {
9055: my $cid=$one.'_'.$two;
9056: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9057: my $secchange = 0;
9058: my $expire_role_result;
9059: my $modify_section_result;
1.628 raeburn 9060: if ($oldsec ne '-1') {
9061: if ($oldsec ne $sec) {
1.443 albertel 9062: $secchange = 1;
1.628 raeburn 9063: my $now = time;
1.443 albertel 9064: my $uurl='/'.$cid;
9065: $uurl=~s/\_/\//g;
9066: if ($oldsec) {
9067: $uurl.='/'.$oldsec;
9068: }
1.626 raeburn 9069: $oldsecurl = $uurl;
1.628 raeburn 9070: $expire_role_result =
1.652 raeburn 9071: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9072: if ($env{'request.course.sec'} ne '') {
9073: if ($expire_role_result eq 'refused') {
9074: my @roles = ('st');
9075: my @statuses = ('previous');
9076: my @roledoms = ($one);
9077: my $withsec = 1;
9078: my %roleshash =
9079: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9080: \@statuses,\@roles,\@roledoms,$withsec);
9081: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9082: my ($oldstart,$oldend) =
9083: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9084: if ($oldend > 0 && $oldend <= $now) {
9085: $expire_role_result = 'ok';
9086: }
9087: }
9088: }
9089: }
1.443 albertel 9090: $result = $expire_role_result;
9091: }
9092: }
9093: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9094: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9095: if ($modify_section_result =~ /^ok/) {
9096: if ($secchange == 1) {
1.628 raeburn 9097: if ($sec eq '') {
9098: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9099: } else {
9100: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9101: }
1.443 albertel 9102: } elsif ($oldsec eq '-1') {
1.628 raeburn 9103: if ($sec eq '') {
9104: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9105: } else {
9106: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9107: }
1.443 albertel 9108: } else {
1.628 raeburn 9109: if ($sec eq '') {
9110: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
9111: } else {
9112: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9113: }
1.443 albertel 9114: }
9115: } else {
1.628 raeburn 9116: if ($secchange) {
9117: $$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;
9118: } else {
9119: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
9120: }
1.443 albertel 9121: }
9122: $result = $modify_section_result;
9123: } elsif ($secchange == 1) {
1.628 raeburn 9124: if ($oldsec eq '') {
9125: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
9126: } else {
9127: $$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;
9128: }
1.626 raeburn 9129: if ($expire_role_result eq 'refused') {
9130: my $newsecurl = '/'.$cid;
9131: $newsecurl =~ s/\_/\//g;
9132: if ($sec ne '') {
9133: $newsecurl.='/'.$sec;
9134: }
9135: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
9136: if ($sec eq '') {
9137: $$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;
9138: } else {
9139: $$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;
9140: }
9141: }
9142: }
1.443 albertel 9143: }
9144: } else {
1.626 raeburn 9145: $$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 9146: $result = "error: incomplete course id\n";
9147: }
9148: return $result;
9149: }
9150:
9151: ############################################################
9152: ############################################################
9153:
1.566 albertel 9154: sub check_clone {
1.578 raeburn 9155: my ($args,$linefeed) = @_;
1.566 albertel 9156: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
9157: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
9158: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
9159: my $clonemsg;
9160: my $can_clone = 0;
9161:
9162: if ($clonehome eq 'no_host') {
1.578 raeburn 9163: $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 9164: } else {
9165: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568 albertel 9166: if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566 albertel 9167: $can_clone = 1;
9168: } else {
9169: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
9170: $args->{'clonedomain'},$args->{'clonecourse'});
9171: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 9172: if (grep(/^\*$/,@cloners)) {
9173: $can_clone = 1;
9174: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
9175: $can_clone = 1;
9176: } else {
9177: my %roleshash =
9178: &Apache::lonnet::get_my_roles($args->{'ccuname'},
9179: $args->{'ccdomain'},
9180: 'userroles',['active'],['cc'],
9181: [$args->{'clonedomain'}]);
9182: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
9183: $can_clone = 1;
9184: } else {
9185: $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'});
9186: }
1.566 albertel 9187: }
1.578 raeburn 9188: }
1.566 albertel 9189: }
9190: return ($can_clone, $clonemsg, $cloneid, $clonehome);
9191: }
9192:
1.444 albertel 9193: sub construct_course {
1.541 raeburn 9194: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444 albertel 9195: my $outcome;
1.541 raeburn 9196: my $linefeed = '<br />'."\n";
9197: if ($context eq 'auto') {
9198: $linefeed = "\n";
9199: }
1.566 albertel 9200:
9201: #
9202: # Are we cloning?
9203: #
9204: my ($can_clone, $clonemsg, $cloneid, $clonehome);
9205: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 9206: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 9207: if ($context ne 'auto') {
1.578 raeburn 9208: if ($clonemsg ne '') {
9209: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
9210: }
1.566 albertel 9211: }
9212: $outcome .= $clonemsg.$linefeed;
9213:
9214: if (!$can_clone) {
9215: return (0,$outcome);
9216: }
9217: }
9218:
1.444 albertel 9219: #
9220: # Open course
9221: #
9222: my $crstype = lc($args->{'crstype'});
9223: my %cenv=();
9224: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
9225: $args->{'cdescr'},
9226: $args->{'curl'},
9227: $args->{'course_home'},
9228: $args->{'nonstandard'},
9229: $args->{'crscode'},
9230: $args->{'ccuname'}.':'.
9231: $args->{'ccdomain'},
9232: $args->{'crstype'});
9233:
9234: # Note: The testing routines depend on this being output; see
9235: # Utils::Course. This needs to at least be output as a comment
9236: # if anyone ever decides to not show this, and Utils::Course::new
9237: # will need to be suitably modified.
1.541 raeburn 9238: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 9239: #
9240: # Check if created correctly
9241: #
1.479 albertel 9242: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 9243: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 9244: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 9245:
1.444 albertel 9246: #
1.566 albertel 9247: # Do the cloning
9248: #
9249: if ($can_clone && $cloneid) {
9250: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
9251: if ($context ne 'auto') {
9252: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
9253: }
9254: $outcome .= $clonemsg.$linefeed;
9255: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 9256: # Copy all files
1.637 www 9257: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 9258: # Restore URL
1.566 albertel 9259: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 9260: # Restore title
1.566 albertel 9261: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 9262: # Mark as cloned
1.566 albertel 9263: $cenv{'clonedfrom'}=$cloneid;
1.638 www 9264: # Need to clone grading mode
9265: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
9266: $cenv{'grading'}=$newenv{'grading'};
9267: # Do not clone these environment entries
9268: &Apache::lonnet::del('environment',
9269: ['default_enrollment_start_date',
9270: 'default_enrollment_end_date',
9271: 'question.email',
9272: 'policy.email',
9273: 'comment.email',
9274: 'pch.users.denied',
9275: 'plc.users.denied'],
9276: $$crsudom,$$crsunum);
1.444 albertel 9277: }
1.566 albertel 9278:
1.444 albertel 9279: #
9280: # Set environment (will override cloned, if existing)
9281: #
9282: my @sections = ();
9283: my @xlists = ();
9284: if ($args->{'crstype'}) {
9285: $cenv{'type'}=$args->{'crstype'};
9286: }
9287: if ($args->{'crsid'}) {
9288: $cenv{'courseid'}=$args->{'crsid'};
9289: }
9290: if ($args->{'crscode'}) {
9291: $cenv{'internal.coursecode'}=$args->{'crscode'};
9292: }
9293: if ($args->{'crsquota'} ne '') {
9294: $cenv{'internal.coursequota'}=$args->{'crsquota'};
9295: } else {
9296: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
9297: }
9298: if ($args->{'ccuname'}) {
9299: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
9300: ':'.$args->{'ccdomain'};
9301: } else {
9302: $cenv{'internal.courseowner'} = $args->{'curruser'};
9303: }
9304: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
9305: if ($args->{'crssections'}) {
9306: $cenv{'internal.sectionnums'} = '';
9307: if ($args->{'crssections'} =~ m/,/) {
9308: @sections = split/,/,$args->{'crssections'};
9309: } else {
9310: $sections[0] = $args->{'crssections'};
9311: }
9312: if (@sections > 0) {
9313: foreach my $item (@sections) {
9314: my ($sec,$gp) = split/:/,$item;
9315: my $class = $args->{'crscode'}.$sec;
9316: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
9317: $cenv{'internal.sectionnums'} .= $item.',';
9318: unless ($addcheck eq 'ok') {
9319: push @badclasses, $class;
9320: }
9321: }
9322: $cenv{'internal.sectionnums'} =~ s/,$//;
9323: }
9324: }
9325: # do not hide course coordinator from staff listing,
9326: # even if privileged
9327: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9328: # add crosslistings
9329: if ($args->{'crsxlist'}) {
9330: $cenv{'internal.crosslistings'}='';
9331: if ($args->{'crsxlist'} =~ m/,/) {
9332: @xlists = split/,/,$args->{'crsxlist'};
9333: } else {
9334: $xlists[0] = $args->{'crsxlist'};
9335: }
9336: if (@xlists > 0) {
9337: foreach my $item (@xlists) {
9338: my ($xl,$gp) = split/:/,$item;
9339: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
9340: $cenv{'internal.crosslistings'} .= $item.',';
9341: unless ($addcheck eq 'ok') {
9342: push @badclasses, $xl;
9343: }
9344: }
9345: $cenv{'internal.crosslistings'} =~ s/,$//;
9346: }
9347: }
9348: if ($args->{'autoadds'}) {
9349: $cenv{'internal.autoadds'}=$args->{'autoadds'};
9350: }
9351: if ($args->{'autodrops'}) {
9352: $cenv{'internal.autodrops'}=$args->{'autodrops'};
9353: }
9354: # check for notification of enrollment changes
9355: my @notified = ();
9356: if ($args->{'notify_owner'}) {
9357: if ($args->{'ccuname'} ne '') {
9358: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
9359: }
9360: }
9361: if ($args->{'notify_dc'}) {
9362: if ($uname ne '') {
1.630 raeburn 9363: push(@notified,$uname.':'.$udom);
1.444 albertel 9364: }
9365: }
9366: if (@notified > 0) {
9367: my $notifylist;
9368: if (@notified > 1) {
9369: $notifylist = join(',',@notified);
9370: } else {
9371: $notifylist = $notified[0];
9372: }
9373: $cenv{'internal.notifylist'} = $notifylist;
9374: }
9375: if (@badclasses > 0) {
9376: my %lt=&Apache::lonlocal::texthash(
9377: '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',
9378: 'dnhr' => 'does not have rights to access enrollment in these classes',
9379: 'adby' => 'as determined by the policies of your institution on access to official classlists'
9380: );
1.541 raeburn 9381: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
9382: ' ('.$lt{'adby'}.')';
9383: if ($context eq 'auto') {
9384: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 9385: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 9386: foreach my $item (@badclasses) {
9387: if ($context eq 'auto') {
9388: $outcome .= " - $item\n";
9389: } else {
9390: $outcome .= "<li>$item</li>\n";
9391: }
9392: }
9393: if ($context eq 'auto') {
9394: $outcome .= $linefeed;
9395: } else {
1.566 albertel 9396: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 9397: }
9398: }
1.444 albertel 9399: }
9400: if ($args->{'no_end_date'}) {
9401: $args->{'endaccess'} = 0;
9402: }
9403: $cenv{'internal.autostart'}=$args->{'enrollstart'};
9404: $cenv{'internal.autoend'}=$args->{'enrollend'};
9405: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
9406: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
9407: if ($args->{'showphotos'}) {
9408: $cenv{'internal.showphotos'}=$args->{'showphotos'};
9409: }
9410: $cenv{'internal.authtype'} = $args->{'authtype'};
9411: $cenv{'internal.autharg'} = $args->{'autharg'};
9412: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
9413: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 9414: 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');
9415: if ($context eq 'auto') {
9416: $outcome .= $krb_msg;
9417: } else {
1.566 albertel 9418: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 9419: }
9420: $outcome .= $linefeed;
1.444 albertel 9421: }
9422: }
9423: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
9424: if ($args->{'setpolicy'}) {
9425: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9426: }
9427: if ($args->{'setcontent'}) {
9428: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9429: }
9430: }
9431: if ($args->{'reshome'}) {
9432: $cenv{'reshome'}=$args->{'reshome'}.'/';
9433: $cenv{'reshome'}=~s/\/+$/\//;
9434: }
9435: #
9436: # course has keyed access
9437: #
9438: if ($args->{'setkeys'}) {
9439: $cenv{'keyaccess'}='yes';
9440: }
9441: # if specified, key authority is not course, but user
9442: # only active if keyaccess is yes
9443: if ($args->{'keyauth'}) {
1.487 albertel 9444: my ($user,$domain) = split(':',$args->{'keyauth'});
9445: $user = &LONCAPA::clean_username($user);
9446: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 9447: if ($user ne '' && $domain ne '') {
1.487 albertel 9448: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 9449: }
9450: }
9451:
9452: if ($args->{'disresdis'}) {
9453: $cenv{'pch.roles.denied'}='st';
9454: }
9455: if ($args->{'disablechat'}) {
9456: $cenv{'plc.roles.denied'}='st';
9457: }
9458:
9459: # Record we've not yet viewed the Course Initialization Helper for this
9460: # course
9461: $cenv{'course.helper.not.run'} = 1;
9462: #
9463: # Use new Randomseed
9464: #
9465: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
9466: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
9467: #
9468: # The encryption code and receipt prefix for this course
9469: #
9470: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
9471: $cenv{'internal.encpref'}=100+int(9*rand(99));
9472: #
9473: # By default, use standard grading
9474: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
9475:
1.541 raeburn 9476: $outcome .= $linefeed.&mt('Setting environment').': '.
9477: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9478: #
9479: # Open all assignments
9480: #
9481: if ($args->{'openall'}) {
9482: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
9483: my %storecontent = ($storeunder => time,
9484: $storeunder.'.type' => 'date_start');
9485:
9486: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 9487: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9488: }
9489: #
9490: # Set first page
9491: #
9492: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
9493: || ($cloneid)) {
1.445 albertel 9494: use LONCAPA::map;
1.444 albertel 9495: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 9496:
9497: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
9498: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
9499:
1.444 albertel 9500: $outcome .= ($fatal?$errtext:'read ok').' - ';
9501: my $title; my $url;
9502: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 9503: $title=&mt('Syllabus');
1.444 albertel 9504: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
9505: } else {
1.690 bisitz 9506: $title=&mt('Navigate Contents');
1.444 albertel 9507: $url='/adm/navmaps';
9508: }
1.445 albertel 9509:
9510: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
9511: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
9512:
9513: if ($errtext) { $fatal=2; }
1.541 raeburn 9514: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 9515: }
1.566 albertel 9516:
9517: return (1,$outcome);
1.444 albertel 9518: }
9519:
9520: ############################################################
9521: ############################################################
9522:
1.378 raeburn 9523: sub course_type {
9524: my ($cid) = @_;
9525: if (!defined($cid)) {
9526: $cid = $env{'request.course.id'};
9527: }
1.404 albertel 9528: if (defined($env{'course.'.$cid.'.type'})) {
9529: return $env{'course.'.$cid.'.type'};
1.378 raeburn 9530: } else {
9531: return 'Course';
1.377 raeburn 9532: }
9533: }
1.156 albertel 9534:
1.406 raeburn 9535: sub group_term {
9536: my $crstype = &course_type();
9537: my %names = (
9538: 'Course' => 'group',
9539: 'Group' => 'team',
9540: );
9541: return $names{$crstype};
9542: }
9543:
1.156 albertel 9544: sub icon {
9545: my ($file)=@_;
1.505 albertel 9546: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 9547: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 9548: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 9549: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
9550: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
9551: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9552: $curfext.".gif") {
9553: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9554: $curfext.".gif";
9555: }
9556: }
1.249 albertel 9557: return &lonhttpdurl($iconname);
1.154 albertel 9558: }
1.84 albertel 9559:
1.575 albertel 9560: sub lonhttpdurl {
1.692 www 9561: #
9562: # Had been used for "small fry" static images on separate port 8080.
9563: # Modify here if lightweight http functionality desired again.
9564: # Currently eliminated due to increasing firewall issues.
9565: #
1.575 albertel 9566: my ($url)=@_;
1.692 www 9567: return $url;
1.215 albertel 9568: }
9569:
1.213 albertel 9570: sub connection_aborted {
9571: my ($r)=@_;
9572: $r->print(" ");$r->rflush();
9573: my $c = $r->connection;
9574: return $c->aborted();
9575: }
9576:
1.221 foxr 9577: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 9578: # strings as 'strings'.
9579: sub escape_single {
1.221 foxr 9580: my ($input) = @_;
1.223 albertel 9581: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 9582: $input =~ s/\'/\\\'/g; # Esacpe the 's....
9583: return $input;
9584: }
1.223 albertel 9585:
1.222 foxr 9586: # Same as escape_single, but escape's "'s This
9587: # can be used for "strings"
9588: sub escape_double {
9589: my ($input) = @_;
9590: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
9591: $input =~ s/\"/\\\"/g; # Esacpe the "s....
9592: return $input;
9593: }
1.223 albertel 9594:
1.222 foxr 9595: # Escapes the last element of a full URL.
9596: sub escape_url {
9597: my ($url) = @_;
1.238 raeburn 9598: my @urlslices = split(/\//, $url,-1);
1.369 www 9599: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 9600: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 9601: }
1.462 albertel 9602:
9603: # -------------------------------------------------------- Initliaze user login
9604: sub init_user_environment {
1.463 albertel 9605: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 9606: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
9607:
9608: my $public=($username eq 'public' && $domain eq 'public');
9609:
9610: # See if old ID present, if so, remove
9611:
9612: my ($filename,$cookie,$userroles);
9613: my $now=time;
9614:
9615: if ($public) {
9616: my $max_public=100;
9617: my $oldest;
9618: my $oldest_time=0;
9619: for(my $next=1;$next<=$max_public;$next++) {
9620: if (-e $lonids."/publicuser_$next.id") {
9621: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
9622: if ($mtime<$oldest_time || !$oldest_time) {
9623: $oldest_time=$mtime;
9624: $oldest=$next;
9625: }
9626: } else {
9627: $cookie="publicuser_$next";
9628: last;
9629: }
9630: }
9631: if (!$cookie) { $cookie="publicuser_$oldest"; }
9632: } else {
1.463 albertel 9633: # if this isn't a robot, kill any existing non-robot sessions
9634: if (!$args->{'robot'}) {
9635: opendir(DIR,$lonids);
9636: while ($filename=readdir(DIR)) {
9637: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
9638: unlink($lonids.'/'.$filename);
9639: }
1.462 albertel 9640: }
1.463 albertel 9641: closedir(DIR);
1.462 albertel 9642: }
9643: # Give them a new cookie
1.463 albertel 9644: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 9645: : $now.$$.int(rand(10000)));
1.463 albertel 9646: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 9647:
9648: # Initialize roles
9649:
9650: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
9651: }
9652: # ------------------------------------ Check browser type and MathML capability
9653:
9654: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
9655: $clientunicode,$clientos) = &decode_user_agent($r);
9656:
9657: # -------------------------------------- Any accessibility options to remember?
9658: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
9659: foreach my $option ('imagesuppress','appletsuppress',
9660: 'embedsuppress','fontenhance','blackwhite') {
9661: if ($form->{$option} eq 'true') {
9662: &Apache::lonnet::put('environment',{$option => 'on'},
9663: $domain,$username);
9664: } else {
9665: &Apache::lonnet::del('environment',[$option],
9666: $domain,$username);
9667: }
9668: }
9669: }
9670: # ------------------------------------------------------------- Get environment
9671:
9672: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
9673: my ($tmp) = keys(%userenv);
9674: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9675: # default remote control to off
9676: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
9677: } else {
9678: undef(%userenv);
9679: }
9680: if (($userenv{'interface'}) && (!$form->{'interface'})) {
9681: $form->{'interface'}=$userenv{'interface'};
9682: }
9683: $env{'environment.remote'}=$userenv{'remote'};
9684: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
9685:
9686: # --------------- Do not trust query string to be put directly into environment
9687: foreach my $option ('imagesuppress','appletsuppress',
9688: 'embedsuppress','fontenhance','blackwhite',
9689: 'interface','localpath','localres') {
9690: $form->{$option}=~s/[\n\r\=]//gs;
9691: }
9692: # --------------------------------------------------------- Write first profile
9693:
9694: {
9695: my %initial_env =
9696: ("user.name" => $username,
9697: "user.domain" => $domain,
9698: "user.home" => $authhost,
9699: "browser.type" => $clientbrowser,
9700: "browser.version" => $clientversion,
9701: "browser.mathml" => $clientmathml,
9702: "browser.unicode" => $clientunicode,
9703: "browser.os" => $clientos,
9704: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
9705: "request.course.fn" => '',
9706: "request.course.uri" => '',
9707: "request.course.sec" => '',
9708: "request.role" => 'cm',
9709: "request.role.adv" => $env{'user.adv'},
9710: "request.host" => $ENV{'REMOTE_ADDR'},);
9711:
9712: if ($form->{'localpath'}) {
9713: $initial_env{"browser.localpath"} = $form->{'localpath'};
9714: $initial_env{"browser.localres"} = $form->{'localres'};
9715: }
9716:
9717: if ($public) {
9718: $initial_env{"environment.remote"} = "off";
9719: }
9720: if ($form->{'interface'}) {
9721: $form->{'interface'}=~s/\W//gs;
9722: $initial_env{"browser.interface"} = $form->{'interface'};
9723: $env{'browser.interface'}=$form->{'interface'};
9724: foreach my $option ('imagesuppress','appletsuppress',
9725: 'embedsuppress','fontenhance','blackwhite') {
9726: if (($form->{$option} eq 'true') ||
9727: ($userenv{$option} eq 'on')) {
9728: $initial_env{"browser.$option"} = "on";
9729: }
9730: }
9731: }
9732:
9733: $env{'user.environment'} = "$lonids/$cookie.id";
9734:
9735: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
9736: &GDBM_WRCREAT(),0640)) {
9737: &_add_to_env(\%disk_env,\%initial_env);
9738: &_add_to_env(\%disk_env,\%userenv,'environment.');
9739: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 9740: if (ref($args->{'extra_env'})) {
9741: &_add_to_env(\%disk_env,$args->{'extra_env'});
9742: }
1.462 albertel 9743: untie(%disk_env);
9744: } else {
1.705 tempelho 9745: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
9746: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 9747: return 'error: '.$!;
9748: }
9749: }
9750: $env{'request.role'}='cm';
9751: $env{'request.role.adv'}=$env{'user.adv'};
9752: $env{'browser.type'}=$clientbrowser;
9753:
9754: return $cookie;
9755:
9756: }
9757:
9758: sub _add_to_env {
9759: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 9760: if (ref($env_data) eq 'HASH') {
9761: while (my ($key,$value) = each(%$env_data)) {
9762: $idf->{$prefix.$key} = $value;
9763: $env{$prefix.$key} = $value;
9764: }
1.462 albertel 9765: }
9766: }
9767:
1.685 tempelho 9768: # --- Get the symbolic name of a problem and the url
9769: sub get_symb {
9770: my ($request,$silent) = @_;
9771: (my $url=$env{'form.url'}) =~ s-^http://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
9772: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
9773: if ($symb eq '') {
9774: if (!$silent) {
9775: $request->print("Unable to handle ambiguous references:$url:.");
9776: return ();
9777: }
9778: }
9779: &Apache::lonenc::check_decrypt(\$symb);
9780: return ($symb);
9781: }
9782:
9783: # --------------------------------------------------------------Get annotation
9784:
9785: sub get_annotation {
9786: my ($symb,$enc) = @_;
9787:
9788: my $key = $symb;
9789: if (!$enc) {
9790: $key =
9791: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
9792: }
9793: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
9794: return $annotation{$key};
9795: }
9796:
9797: sub clean_symb {
9798: my ($symb) = @_;
9799:
9800: &Apache::lonenc::check_decrypt(\$symb);
9801: my $enc = $env{'request.enc'};
9802: delete($env{'request.enc'});
9803:
9804: return ($symb,$enc);
9805: }
1.462 albertel 9806:
1.41 ng 9807: =pod
9808:
9809: =back
9810:
1.112 bowersj2 9811: =cut
1.41 ng 9812:
1.112 bowersj2 9813: 1;
9814: __END__;
1.41 ng 9815:
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