Annotation of loncom/interface/loncommon.pm, revision 1.466
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.466 ! albertel 4: # $Id: loncommon.pm,v 1.465 2006/10/13 22:03:26 albertel 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.117 www 62: use Apache::lonlocal;
1.139 matthew 63: use HTML::Entities;
1.334 albertel 64: use Apache::lonhtmlcommon();
65: use Apache::loncoursedata();
1.344 albertel 66: use Apache::lontexconvert();
1.444 albertel 67: use Apache::lonclonecourse();
1.369 www 68: use LONCAPA;
1.117 www 69:
1.22 www 70: my $readit;
71:
1.157 matthew 72: ##
73: ## Global Variables
74: ##
1.46 matthew 75:
1.20 www 76: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 77: my %language;
1.124 www 78: my %supported_language;
1.12 harris41 79: my %cprtag;
1.192 taceyjo1 80: my %scprtag;
1.351 www 81: my %fe; my %fd; my %fm;
1.41 ng 82: my %category_extensions;
1.12 harris41 83:
1.63 www 84: # ---------------------------------------------- Designs
85:
86: my %designhash;
87:
1.46 matthew 88: # ---------------------------------------------- Thesaurus variables
1.144 matthew 89: #
90: # %Keywords:
91: # A hash used by &keyword to determine if a word is considered a keyword.
92: # $thesaurus_db_file
93: # Scalar containing the full path to the thesaurus database.
1.46 matthew 94:
95: my %Keywords;
96: my $thesaurus_db_file;
97:
1.144 matthew 98: #
99: # Initialize values from language.tab, copyright.tab, filetypes.tab,
100: # thesaurus.tab, and filecategories.tab.
101: #
1.18 www 102: BEGIN {
1.46 matthew 103: # Variable initialization
104: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
105: #
1.22 www 106: unless ($readit) {
1.12 harris41 107: # ------------------------------------------------------------------- languages
108: {
1.158 raeburn 109: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
110: '/language.tab';
111: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 112: while (my $line = <$fh>) {
113: next if ($line=~/^\#/);
114: chomp($line);
115: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158 raeburn 116: $language{$key}=$val.' - '.$enc;
117: if ($sup) {
118: $supported_language{$key}=$sup;
119: }
120: }
121: close($fh);
122: }
1.12 harris41 123: }
124: # ------------------------------------------------------------------ copyrights
125: {
1.158 raeburn 126: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
127: '/copyright.tab';
128: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 129: while (my $line = <$fh>) {
130: next if ($line=~/^\#/);
131: chomp($line);
132: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 133: $cprtag{$key}=$val;
134: }
135: close($fh);
136: }
1.12 harris41 137: }
1.351 www 138: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 139: {
140: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
141: '/source_copyright.tab';
142: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 143: while (my $line = <$fh>) {
144: next if ($line =~ /^\#/);
145: chomp($line);
146: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 147: $scprtag{$key}=$val;
148: }
149: close($fh);
150: }
151: }
1.63 www 152:
153: # -------------------------------------------------------------- domain designs
154:
155: my $filename;
156: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
157: opendir(DIR,$designdir);
158: while ($filename=readdir(DIR)) {
1.271 albertel 159: if ($filename!~/\.tab$/) { next; }
1.63 www 160: my ($domain)=($filename=~/^(\w+)\./);
1.271 albertel 161: {
162: my $designfile = $designdir.'/'.$filename;
163: if ( open (my $fh,"<$designfile") ) {
1.356 albertel 164: while (my $line = <$fh>) {
165: next if ($line =~ /^\#/);
166: chomp($line);
167: my ($key,$val)=(split(/\=/,$line));
1.271 albertel 168: if ($val) { $designhash{$domain.'.'.$key}=$val; }
169: }
170: close($fh);
171: }
172: }
1.63 www 173:
174: }
175: closedir(DIR);
176:
177:
1.15 harris41 178: # ------------------------------------------------------------- file categories
179: {
1.158 raeburn 180: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
181: '/filecategories.tab';
182: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 183: while (my $line = <$fh>) {
184: next if ($line =~ /^\#/);
185: chomp($line);
186: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 187: push @{$category_extensions{lc($category)}},$extension;
188: }
189: close($fh);
190: }
191:
1.15 harris41 192: }
1.12 harris41 193: # ------------------------------------------------------------------ file types
194: {
1.158 raeburn 195: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
196: '/filetypes.tab';
197: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 198: while (my $line = <$fh>) {
199: next if ($line =~ /^\#/);
200: chomp($line);
201: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 202: if ($descr ne '') {
203: $fe{$ending}=lc($emb);
204: $fd{$ending}=$descr;
1.351 www 205: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 206: }
207: }
208: close($fh);
209: }
1.12 harris41 210: }
1.22 www 211: &Apache::lonnet::logthis(
1.46 matthew 212: "<font color=yellow>INFO: Read file types</font>");
1.22 www 213: $readit=1;
1.46 matthew 214: } # end of unless($readit)
1.32 matthew 215:
216: }
1.112 bowersj2 217:
1.42 matthew 218: ###############################################################
219: ## HTML and Javascript Helper Functions ##
220: ###############################################################
221:
222: =pod
223:
1.112 bowersj2 224: =head1 HTML and Javascript Functions
1.42 matthew 225:
1.112 bowersj2 226: =over 4
227:
228: =item * browser_and_searcher_javascript ()
229:
230: X<browsing, javascript>X<searching, javascript>Returns a string
231: containing javascript with two functions, C<openbrowser> and
232: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
233: tags.
1.42 matthew 234:
1.112 bowersj2 235: =item * openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 236:
237: inputs: formname, elementname, only, omit
238:
239: formname and elementname indicate the name of the html form and name of
240: the element that the results of the browsing selection are to be placed in.
241:
242: Specifying 'only' will restrict the browser to displaying only files
1.185 www 243: with the given extension. Can be a comma separated list.
1.42 matthew 244:
245: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 246: with the given extension. Can be a comma separated list.
1.42 matthew 247:
1.112 bowersj2 248: =item * opensearcher(formname, elementname) [javascript]
1.42 matthew 249:
250: Inputs: formname, elementname
251:
252: formname and elementname specify the name of the html form and the name
253: of the element the selection from the search results will be placed in.
254:
255: =cut
256:
257: sub browser_and_searcher_javascript {
1.199 albertel 258: my ($mode)=@_;
259: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 260: my $resurl=&escape_single(&lastresurl());
1.42 matthew 261: return <<END;
1.219 albertel 262: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 263: var editbrowser = null;
1.135 albertel 264: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 265: var url = '$resurl/?';
1.42 matthew 266: if (editbrowser == null) {
267: url += 'launch=1&';
268: }
269: url += 'catalogmode=interactive&';
1.199 albertel 270: url += 'mode=$mode&';
1.42 matthew 271: url += 'form=' + formname + '&';
272: if (only != null) {
273: url += 'only=' + only + '&';
1.217 albertel 274: } else {
275: url += 'only=&';
276: }
1.42 matthew 277: if (omit != null) {
278: url += 'omit=' + omit + '&';
1.217 albertel 279: } else {
280: url += 'omit=&';
281: }
1.135 albertel 282: if (titleelement != null) {
283: url += 'titleelement=' + titleelement + '&';
1.217 albertel 284: } else {
285: url += 'titleelement=&';
286: }
1.42 matthew 287: url += 'element=' + elementname + '';
288: var title = 'Browser';
1.435 albertel 289: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 290: options += ',width=700,height=600';
291: editbrowser = open(url,title,options,'1');
292: editbrowser.focus();
293: }
294: var editsearcher;
1.135 albertel 295: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 296: var url = '/adm/searchcat?';
297: if (editsearcher == null) {
298: url += 'launch=1&';
299: }
300: url += 'catalogmode=interactive&';
1.199 albertel 301: url += 'mode=$mode&';
1.42 matthew 302: url += 'form=' + formname + '&';
1.135 albertel 303: if (titleelement != null) {
304: url += 'titleelement=' + titleelement + '&';
1.217 albertel 305: } else {
306: url += 'titleelement=&';
307: }
1.42 matthew 308: url += 'element=' + elementname + '';
309: var title = 'Search';
1.435 albertel 310: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 311: options += ',width=700,height=600';
312: editsearcher = open(url,title,options,'1');
313: editsearcher.focus();
314: }
1.219 albertel 315: // END LON-CAPA Internal -->
1.42 matthew 316: END
1.170 www 317: }
318:
319: sub lastresurl {
1.258 albertel 320: if ($env{'environment.lastresurl'}) {
321: return $env{'environment.lastresurl'}
1.170 www 322: } else {
323: return '/res';
324: }
325: }
326:
327: sub storeresurl {
328: my $resurl=&Apache::lonnet::clutter(shift);
329: unless ($resurl=~/^\/res/) { return 0; }
330: $resurl=~s/\/$//;
331: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
332: &Apache::lonnet::appenv('environment.lastresurl' => $resurl);
333: return 1;
1.42 matthew 334: }
335:
1.74 www 336: sub studentbrowser_javascript {
1.111 www 337: unless (
1.258 albertel 338: (($env{'request.course.id'}) &&
1.302 albertel 339: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
340: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
341: '/'.$env{'request.course.sec'})
342: ))
1.258 albertel 343: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 344: ) { return ''; }
1.74 www 345: return (<<'ENDSTDBRW');
346: <script type="text/javascript" language="Javascript" >
347: var stdeditbrowser;
1.111 www 348: function openstdbrowser(formname,uname,udom,roleflag) {
1.74 www 349: var url = '/adm/pickstudent?';
350: var filter;
351: eval('filter=document.'+formname+'.'+uname+'.value;');
352: if (filter != null) {
353: if (filter != '') {
354: url += 'filter='+filter+'&';
355: }
356: }
357: url += 'form=' + formname + '&unameelement='+uname+
358: '&udomelement='+udom;
1.111 www 359: if (roleflag) { url+="&roles=1"; }
1.102 www 360: var title = 'Student_Browser';
1.74 www 361: var options = 'scrollbars=1,resizable=1,menubar=0';
362: options += ',width=700,height=600';
363: stdeditbrowser = open(url,title,options,'1');
364: stdeditbrowser.focus();
365: }
366: </script>
367: ENDSTDBRW
368: }
1.42 matthew 369:
1.74 www 370: sub selectstudent_link {
1.111 www 371: my ($form,$unameele,$udomele)=@_;
1.258 albertel 372: if ($env{'request.course.id'}) {
1.302 albertel 373: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
374: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
375: '/'.$env{'request.course.sec'})) {
1.111 www 376: return '';
377: }
378: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.119 www 379: '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
1.74 www 380: }
1.258 albertel 381: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.111 www 382: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.119 www 383: '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
1.111 www 384: }
385: return '';
1.91 www 386: }
387:
388: sub coursebrowser_javascript {
1.234 raeburn 389: my ($domainfilter)=@_;
1.377 raeburn 390: 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.128 albertel 391: return (<<ENDSTDBRW);
1.91 www 392: <script type="text/javascript" language="Javascript" >
393: var stdeditbrowser;
1.377 raeburn 394: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
1.91 www 395: var url = '/adm/pickcourse?';
396: var filter;
397: if (filter != null) {
398: if (filter != '') {
399: url += 'filter='+filter+'&';
400: }
401: }
1.128 albertel 402: var domainfilter='$domainfilter';
403: if (domainfilter != null) {
404: if (domainfilter != '') {
405: url += 'domainfilter='+domainfilter+'&';
406: }
407: }
1.91 www 408: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 409: '&cdomelement='+udom+
410: '&cnameelement='+desc;
1.234 raeburn 411: if (extra_element !=null && extra_element != '' && formname == 'rolechoice') {
412: url += '&roleelement='+extra_element;
413: if (domainfilter == null || domainfilter == '') {
414: url += '&domainfilter='+extra_element;
415: }
1.230 raeburn 416: }
1.293 raeburn 417: if (multflag !=null && multflag != '') {
418: url += '&multiple='+multflag;
419: }
1.377 raeburn 420: if (crstype == 'Course/Group') {
421: if (formname == 'cu') {
422: crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value;
423: if (crstype == "") {
424: alert("$crs_or_grp_alert");
425: return;
426: }
427: }
428: }
429: if (crstype !=null && crstype != '') {
430: url += '&type='+crstype;
431: }
1.102 www 432: var title = 'Course_Browser';
1.91 www 433: var options = 'scrollbars=1,resizable=1,menubar=0';
434: options += ',width=700,height=600';
435: stdeditbrowser = open(url,title,options,'1');
436: stdeditbrowser.focus();
437: }
438: </script>
439: ENDSTDBRW
440: }
441:
442: sub selectcourse_link {
1.377 raeburn 443: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.91 www 444: return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
1.377 raeburn 445: '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'","'.$selecttype.'");'."'>".&mt('Select [_1]',$selecttype)."</a>";
1.74 www 446: }
1.42 matthew 447:
1.273 raeburn 448: sub check_uncheck_jscript {
449: my $jscript = <<"ENDSCRT";
450: function checkAll(field) {
451: if (field.length > 0) {
452: for (i = 0; i < field.length; i++) {
453: field[i].checked = true ;
454: }
455: } else {
456: field.checked = true
457: }
458: }
459:
460: function uncheckAll(field) {
461: if (field.length > 0) {
462: for (i = 0; i < field.length; i++) {
463: field[i].checked = false ;
464: } } else {
465: field.checked = false ;
466: }
467: }
468: ENDSCRT
469: return $jscript;
470: }
471:
472:
1.42 matthew 473: =pod
1.36 matthew 474:
1.112 bowersj2 475: =item * linked_select_forms(...)
1.36 matthew 476:
477: linked_select_forms returns a string containing a <script></script> block
478: and html for two <select> menus. The select menus will be linked in that
479: changing the value of the first menu will result in new values being placed
480: in the second menu. The values in the select menu will appear in alphabetical
481: order.
482:
483: linked_select_forms takes the following ordered inputs:
484:
485: =over 4
486:
1.112 bowersj2 487: =item * $formname, the name of the <form> tag
1.36 matthew 488:
1.112 bowersj2 489: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 490:
1.112 bowersj2 491: =item * $firstdefault, the default value for the first menu
1.36 matthew 492:
1.112 bowersj2 493: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 494:
1.112 bowersj2 495: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 496:
1.112 bowersj2 497: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 498:
1.41 ng 499: =back
500:
1.36 matthew 501: Below is an example of such a hash. Only the 'text', 'default', and
502: 'select2' keys must appear as stated. keys(%menu) are the possible
503: values for the first select menu. The text that coincides with the
1.41 ng 504: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 505: and text for the second menu are given in the hash pointed to by
506: $menu{$choice1}->{'select2'}.
507:
1.112 bowersj2 508: my %menu = ( A1 => { text =>"Choice A1" ,
509: default => "B3",
510: select2 => {
511: B1 => "Choice B1",
512: B2 => "Choice B2",
513: B3 => "Choice B3",
514: B4 => "Choice B4"
515: }
516: },
517: A2 => { text =>"Choice A2" ,
518: default => "C2",
519: select2 => {
520: C1 => "Choice C1",
521: C2 => "Choice C2",
522: C3 => "Choice C3"
523: }
524: },
525: A3 => { text =>"Choice A3" ,
526: default => "D6",
527: select2 => {
528: D1 => "Choice D1",
529: D2 => "Choice D2",
530: D3 => "Choice D3",
531: D4 => "Choice D4",
532: D5 => "Choice D5",
533: D6 => "Choice D6",
534: D7 => "Choice D7"
535: }
536: }
537: );
1.36 matthew 538:
539: =cut
540:
541: sub linked_select_forms {
542: my ($formname,
543: $middletext,
544: $firstdefault,
545: $firstselectname,
546: $secondselectname,
547: $hashref
548: ) = @_;
549: my $second = "document.$formname.$secondselectname";
550: my $first = "document.$formname.$firstselectname";
551: # output the javascript to do the changing
552: my $result = '';
1.219 albertel 553: $result.="<script type=\"text/javascript\">\n";
1.36 matthew 554: $result.="var select2data = new Object();\n";
555: $" = '","';
556: my $debug = '';
557: foreach my $s1 (sort(keys(%$hashref))) {
558: $result.="select2data.d_$s1 = new Object();\n";
559: $result.="select2data.d_$s1.def = new String('".
560: $hashref->{$s1}->{'default'}."');\n";
561: $result.="select2data.d_$s1.values = new Array(";
562: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
563: $result.="\"@s2values\");\n";
564: $result.="select2data.d_$s1.texts = new Array(";
565: my @s2texts;
566: foreach my $value (@s2values) {
567: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
568: }
569: $result.="\"@s2texts\");\n";
570: }
571: $"=' ';
572: $result.= <<"END";
573:
574: function select1_changed() {
575: // Determine new choice
576: var newvalue = "d_" + $first.value;
577: // update select2
578: var values = select2data[newvalue].values;
579: var texts = select2data[newvalue].texts;
580: var select2def = select2data[newvalue].def;
581: var i;
582: // out with the old
583: for (i = 0; i < $second.options.length; i++) {
584: $second.options[i] = null;
585: }
586: // in with the nuclear
587: for (i=0;i<values.length; i++) {
588: $second.options[i] = new Option(values[i]);
1.143 matthew 589: $second.options[i].value = values[i];
1.36 matthew 590: $second.options[i].text = texts[i];
591: if (values[i] == select2def) {
592: $second.options[i].selected = true;
593: }
594: }
595: }
596: </script>
597: END
598: # output the initial values for the selection lists
599: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
600: foreach my $value (sort(keys(%$hashref))) {
601: $result.=" <option value=\"$value\" ";
1.253 albertel 602: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 603: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 604: }
605: $result .= "</select>\n";
606: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
607: $result .= $middletext;
608: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
609: my $seconddefault = $hashref->{$firstdefault}->{'default'};
610: foreach my $value (sort(keys(%select2))) {
611: $result.=" <option value=\"$value\" ";
1.253 albertel 612: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 613: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 614: }
615: $result .= "</select>\n";
616: # return $debug;
617: return $result;
618: } # end of sub linked_select_forms {
619:
1.45 matthew 620: =pod
1.44 bowersj2 621:
1.112 bowersj2 622: =item * help_open_topic($topic, $text, $stayOnPage, $width, $height)
1.44 bowersj2 623:
1.112 bowersj2 624: Returns a string corresponding to an HTML link to the given help
625: $topic, where $topic corresponds to the name of a .tex file in
626: /home/httpd/html/adm/help/tex, with underscores replaced by
627: spaces.
628:
629: $text will optionally be linked to the same topic, allowing you to
630: link text in addition to the graphic. If you do not want to link
631: text, but wish to specify one of the later parameters, pass an
632: empty string.
633:
634: $stayOnPage is a value that will be interpreted as a boolean. If true,
635: the link will not open a new window. If false, the link will open
636: a new window using Javascript. (Default is false.)
637:
638: $width and $height are optional numerical parameters that will
639: override the width and height of the popped up window, which may
640: be useful for certain help topics with big pictures included.
1.44 bowersj2 641:
642: =cut
643:
644: sub help_open_topic {
1.48 bowersj2 645: my ($topic, $text, $stayOnPage, $width, $height) = @_;
646: $text = "" if (not defined $text);
1.44 bowersj2 647: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 648: if ($env{'browser.interface'} eq 'textual' ||
649: $env{'environment.remote'} eq 'off' ) {
1.79 www 650: $stayOnPage=1;
651: }
1.44 bowersj2 652: $width = 350 if (not defined $width);
653: $height = 400 if (not defined $height);
654: my $filename = $topic;
655: $filename =~ s/ /_/g;
656:
1.48 bowersj2 657: my $template = "";
658: my $link;
1.159 www 659:
660: $topic=~s/\W/\_/g;
1.44 bowersj2 661:
662: if (!$stayOnPage)
663: {
1.72 bowersj2 664: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.44 bowersj2 665: }
666: else
667: {
1.48 bowersj2 668: $link = "/adm/help/${filename}.hlp";
669: }
670:
671: # Add the text
672: if ($text ne "")
673: {
1.77 www 674: $template .=
675: "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
1.436 albertel 676: "<td bgcolor='#5555FF'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.48 bowersj2 677: }
678:
679: # Add the graphic
1.179 matthew 680: my $title = &mt('Online Help');
1.215 albertel 681: my $helpicon=&lonhttpdurl("/adm/help/gif/smallHelp.gif");
1.48 bowersj2 682: $template .= <<"ENDTEMPLATE";
1.436 albertel 683: <a target="_top" href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
1.44 bowersj2 684: ENDTEMPLATE
1.78 www 685: if ($text ne '') { $template.='</td></tr></table>' };
1.44 bowersj2 686: return $template;
687:
1.106 bowersj2 688: }
689:
690: # This is a quicky function for Latex cheatsheet editing, since it
691: # appears in at least four places
692: sub helpLatexCheatsheet {
693: my $other = shift;
694: my $addOther = '';
695: if ($other) {
696: $addOther = Apache::loncommon::help_open_topic($other, shift,
697: undef, undef, 600) .
698: '</td><td>';
699: }
700: return '<table><tr><td>'.
701: $addOther .
702: &Apache::loncommon::help_open_topic("Greek_Symbols",'Greek Symbols',
703: undef,undef,600)
704: .'</td><td>'.
705: &Apache::loncommon::help_open_topic("Other_Symbols",'Other Symbols',
706: undef,undef,600)
707: .'</td></tr></table>';
1.172 www 708: }
709:
1.430 albertel 710: sub general_help {
711: my $helptopic='Student_Intro';
712: if ($env{'request.role'}=~/^(ca|au)/) {
713: $helptopic='Authoring_Intro';
714: } elsif ($env{'request.role'}=~/^cc/) {
715: $helptopic='Course_Coordination_Intro';
716: }
717: return $helptopic;
718: }
719:
720: sub update_help_link {
721: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
722: my $origurl = $ENV{'REQUEST_URI'};
723: $origurl=~s|^/~|/priv/|;
724: my $timestamp = time;
725: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
726: $$datum = &escape($$datum);
727: }
728:
729: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
730: my $output .= <<"ENDOUTPUT";
731: <script type="text/javascript">
732: banner_link = '$banner_link';
733: </script>
734: ENDOUTPUT
735: return $output;
736: }
737:
738: # now just updates the help link and generates a blue icon
1.193 raeburn 739: sub help_open_menu {
1.430 albertel 740: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
741: = @_;
742:
743: $stayOnPage = 0 if (not defined $stayOnPage);
744: if ($env{'browser.interface'} eq 'textual' ||
745: $env{'environment.remote'} eq 'off' ) {
746: $stayOnPage=1;
747: }
748: my $output;
749: if ($component_help) {
750: if (!$text) {
751: $output=&help_open_topic($component_help,undef,$stayOnPage,
752: $width,$height);
753: } else {
754: my $help_text;
755: $help_text=&unescape($topic);
756: $output='<table><tr><td>'.
757: &help_open_topic($component_help,$help_text,$stayOnPage,
758: $width,$height).'</td></tr></table>';
759: }
760: }
761: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
762: return $output.$banner_link;
763: }
764:
765: sub top_nav_help {
766: my ($text) = @_;
767:
1.436 albertel 768: $text = &mt($text);
769:
770: my $stayOnPage =
771: ($env{'browser.interface'} eq 'textual' ||
772: $env{'environment.remote'} eq 'off' );
773: my $link= ($stayOnPage) ? "javascript:helpMenu('display')"
774: : "javascript:helpMenu('open')";
775: my $banner_link = &update_help_link(undef,undef,undef,undef,$stayOnPage);
776:
1.201 raeburn 777: my $title = &mt('Get help');
1.436 albertel 778:
779: return <<"END";
780: $banner_link
781: <a href="$link" title="$title">$text</a>
782: END
783: }
784:
785: sub help_menu_js {
786: my ($text) = @_;
787:
788: my $stayOnPage =
789: ($env{'browser.interface'} eq 'textual' ||
790: $env{'environment.remote'} eq 'off' );
791:
792: my $width = 620;
793: my $height = 600;
1.430 albertel 794: my $helptopic=&general_help();
795: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 796: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 797: my $start_page =
798: &Apache::loncommon::start_page('Help Menu', undef,
799: {'frameset' => 1,
800: 'js_ready' => 1,
801: 'add_entries' => {
802: 'border' => '0',
803: 'rows' => "105,*",},});
804: my $end_page =
805: &Apache::loncommon::end_page({'frameset' => 1,
806: 'js_ready' => 1,});
807:
1.436 albertel 808: my $template .= <<"ENDTEMPLATE";
809: <script type="text/javascript">
1.253 albertel 810: // <!-- BEGIN LON-CAPA Internal
811: // <![CDATA[
1.430 albertel 812: var banner_link = '';
1.243 raeburn 813: function helpMenu(target) {
814: var caller = this;
815: if (target == 'open') {
816: var newWindow = null;
817: try {
1.262 albertel 818: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 819: }
820: catch(error) {
821: writeHelp(caller);
822: return;
823: }
824: if (newWindow) {
825: caller = newWindow;
826: }
1.193 raeburn 827: }
1.243 raeburn 828: writeHelp(caller);
829: return;
830: }
831: function writeHelp(caller) {
1.430 albertel 832: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 833: caller.document.close()
834: caller.focus()
1.193 raeburn 835: }
1.253 albertel 836: // ]]>
1.219 albertel 837: // END LON-CAPA Internal -->
1.436 albertel 838: </script>
1.193 raeburn 839: ENDTEMPLATE
840: return $template;
841: }
842:
1.172 www 843: sub help_open_bug {
844: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 845: unless ($env{'user.adv'}) { return ''; }
1.172 www 846: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
847: $text = "" if (not defined $text);
848: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 849: if ($env{'browser.interface'} eq 'textual' ||
850: $env{'environment.remote'} eq 'off' ) {
1.172 www 851: $stayOnPage=1;
852: }
1.184 albertel 853: $width = 600 if (not defined $width);
854: $height = 600 if (not defined $height);
1.172 www 855:
856: $topic=~s/\W+/\+/g;
857: my $link='';
858: my $template='';
1.379 albertel 859: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
860: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 861: if (!$stayOnPage)
862: {
863: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
864: }
865: else
866: {
867: $link = $url;
868: }
869: # Add the text
870: if ($text ne "")
871: {
872: $template .=
873: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.436 albertel 874: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.172 www 875: }
876:
877: # Add the graphic
1.179 matthew 878: my $title = &mt('Report a Bug');
1.215 albertel 879: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 880: $template .= <<"ENDTEMPLATE";
1.436 albertel 881: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 882: ENDTEMPLATE
883: if ($text ne '') { $template.='</td></tr></table>' };
884: return $template;
885:
886: }
887:
888: sub help_open_faq {
889: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 890: unless ($env{'user.adv'}) { return ''; }
1.172 www 891: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
892: $text = "" if (not defined $text);
893: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 894: if ($env{'browser.interface'} eq 'textual' ||
895: $env{'environment.remote'} eq 'off' ) {
1.172 www 896: $stayOnPage=1;
897: }
898: $width = 350 if (not defined $width);
899: $height = 400 if (not defined $height);
900:
901: $topic=~s/\W+/\+/g;
902: my $link='';
903: my $template='';
904: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
905: if (!$stayOnPage)
906: {
907: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
908: }
909: else
910: {
911: $link = $url;
912: }
913:
914: # Add the text
915: if ($text ne "")
916: {
917: $template .=
1.173 www 918: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.436 albertel 919: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.172 www 920: }
921:
922: # Add the graphic
1.179 matthew 923: my $title = &mt('View the FAQ');
1.215 albertel 924: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 925: $template .= <<"ENDTEMPLATE";
1.436 albertel 926: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 927: ENDTEMPLATE
928: if ($text ne '') { $template.='</td></tr></table>' };
929: return $template;
930:
1.44 bowersj2 931: }
1.37 matthew 932:
1.180 matthew 933: ###############################################################
934: ###############################################################
935:
1.45 matthew 936: =pod
937:
1.256 matthew 938: =item * change_content_javascript():
939:
940: This and the next function allow you to create small sections of an
941: otherwise static HTML page that you can update on the fly with
942: Javascript, even in Netscape 4.
943:
944: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
945: must be written to the HTML page once. It will prove the Javascript
946: function "change(name, content)". Calling the change function with the
947: name of the section
948: you want to update, matching the name passed to C<changable_area>, and
949: the new content you want to put in there, will put the content into
950: that area.
951:
952: B<Note>: Netscape 4 only reserves enough space for the changable area
953: to contain room for the original contents. You need to "make space"
954: for whatever changes you wish to make, and be B<sure> to check your
955: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
956: it's adequate for updating a one-line status display, but little more.
957: This script will set the space to 100% width, so you only need to
958: worry about height in Netscape 4.
959:
960: Modern browsers are much less limiting, and if you can commit to the
961: user not using Netscape 4, this feature may be used freely with
962: pretty much any HTML.
963:
964: =cut
965:
966: sub change_content_javascript {
967: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 968: if ($env{'browser.type'} eq 'netscape' &&
969: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 970: return (<<NETSCAPE4);
971: function change(name, content) {
972: doc = document.layers[name+"___escape"].layers[0].document;
973: doc.open();
974: doc.write(content);
975: doc.close();
976: }
977: NETSCAPE4
978: } else {
979: # Otherwise, we need to use semi-standards-compliant code
980: # (technically, "innerHTML" isn't standard but the equivalent
981: # is really scary, and every useful browser supports it
982: return (<<DOMBASED);
983: function change(name, content) {
984: element = document.getElementById(name);
985: element.innerHTML = content;
986: }
987: DOMBASED
988: }
989: }
990:
991: =pod
992:
993: =item * changable_area($name, $origContent):
994:
995: This provides a "changable area" that can be modified on the fly via
996: the Javascript code provided in C<change_content_javascript>. $name is
997: the name you will use to reference the area later; do not repeat the
998: same name on a given HTML page more then once. $origContent is what
999: the area will originally contain, which can be left blank.
1000:
1001: =cut
1002:
1003: sub changable_area {
1004: my ($name, $origContent) = @_;
1005:
1.258 albertel 1006: if ($env{'browser.type'} eq 'netscape' &&
1007: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1008: # If this is netscape 4, we need to use the Layer tag
1009: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1010: } else {
1011: return "<span id='$name'>$origContent</span>";
1012: }
1013: }
1014:
1015: =pod
1016:
1017: =back
1018:
1019: =head1 Excel and CSV file utility routines
1020:
1021: =over 4
1022:
1023: =cut
1024:
1025: ###############################################################
1026: ###############################################################
1027:
1028: =pod
1029:
1.112 bowersj2 1030: =item * csv_translate($text)
1.37 matthew 1031:
1.185 www 1032: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1033: format.
1034:
1035: =cut
1036:
1.180 matthew 1037: ###############################################################
1038: ###############################################################
1.37 matthew 1039: sub csv_translate {
1040: my $text = shift;
1041: $text =~ s/\"/\"\"/g;
1.209 albertel 1042: $text =~ s/\n/ /g;
1.37 matthew 1043: return $text;
1044: }
1.180 matthew 1045:
1046: ###############################################################
1047: ###############################################################
1048:
1049: =pod
1050:
1051: =item * define_excel_formats
1052:
1053: Define some commonly used Excel cell formats.
1054:
1055: Currently supported formats:
1056:
1057: =over 4
1058:
1059: =item header
1060:
1061: =item bold
1062:
1063: =item h1
1064:
1065: =item h2
1066:
1067: =item h3
1068:
1.256 matthew 1069: =item h4
1070:
1071: =item i
1072:
1.180 matthew 1073: =item date
1074:
1075: =back
1076:
1077: Inputs: $workbook
1078:
1079: Returns: $format, a hash reference.
1080:
1081: =cut
1082:
1083: ###############################################################
1084: ###############################################################
1085: sub define_excel_formats {
1086: my ($workbook) = @_;
1087: my $format;
1088: $format->{'header'} = $workbook->add_format(bold => 1,
1089: bottom => 1,
1090: align => 'center');
1091: $format->{'bold'} = $workbook->add_format(bold=>1);
1092: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1093: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1094: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1095: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1096: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1097: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1098: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1099: return $format;
1100: }
1101:
1102: ###############################################################
1103: ###############################################################
1.113 bowersj2 1104:
1105: =pod
1106:
1.256 matthew 1107: =item * create_workbook
1.255 matthew 1108:
1109: Create an Excel worksheet. If it fails, output message on the
1110: request object and return undefs.
1111:
1112: Inputs: Apache request object
1113:
1114: Returns (undef) on failure,
1115: Excel worksheet object, scalar with filename, and formats
1116: from &Apache::loncommon::define_excel_formats on success
1117:
1118: =cut
1119:
1120: ###############################################################
1121: ###############################################################
1122: sub create_workbook {
1123: my ($r) = @_;
1124: #
1125: # Create the excel spreadsheet
1126: my $filename = '/prtspool/'.
1.258 albertel 1127: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1128: time.'_'.rand(1000000000).'.xls';
1129: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1130: if (! defined($workbook)) {
1131: $r->log_error("Error creating excel spreadsheet $filename: $!");
1132: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1133: "This error has been logged. ".
1134: "Please alert your LON-CAPA administrator").
1135: '</p>');
1136: return (undef);
1137: }
1138: #
1139: $workbook->set_tempdir('/home/httpd/perl/tmp');
1140: #
1141: my $format = &Apache::loncommon::define_excel_formats($workbook);
1142: return ($workbook,$filename,$format);
1143: }
1144:
1145: ###############################################################
1146: ###############################################################
1147:
1148: =pod
1149:
1.256 matthew 1150: =item * create_text_file
1.113 bowersj2 1151:
1.256 matthew 1152: Create a file to write to and eventually make available to the usre.
1153: If file creation fails, outputs an error message on the request object and
1154: return undefs.
1.113 bowersj2 1155:
1.256 matthew 1156: Inputs: Apache request object, and file suffix
1.113 bowersj2 1157:
1.256 matthew 1158: Returns (undef) on failure,
1159: Filehandle and filename on success.
1.113 bowersj2 1160:
1161: =cut
1162:
1.256 matthew 1163: ###############################################################
1164: ###############################################################
1165: sub create_text_file {
1166: my ($r,$suffix) = @_;
1167: if (! defined($suffix)) { $suffix = 'txt'; };
1168: my $fh;
1169: my $filename = '/prtspool/'.
1.258 albertel 1170: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1171: time.'_'.rand(1000000000).'.'.$suffix;
1172: $fh = Apache::File->new('>/home/httpd'.$filename);
1173: if (! defined($fh)) {
1174: $r->log_error("Couldn't open $filename for output $!");
1175: $r->print("Problems occured in creating the output file. ".
1176: "This error has been logged. ".
1177: "Please alert your LON-CAPA administrator.");
1.113 bowersj2 1178: }
1.256 matthew 1179: return ($fh,$filename)
1.113 bowersj2 1180: }
1181:
1182:
1.256 matthew 1183: =pod
1.113 bowersj2 1184:
1185: =back
1186:
1187: =cut
1.37 matthew 1188:
1189: ###############################################################
1.33 matthew 1190: ## Home server <option> list generating code ##
1191: ###############################################################
1.35 matthew 1192:
1.45 matthew 1193: =pod
1194:
1.112 bowersj2 1195: =head1 Home Server option list generating code
1196:
1197: =over 4
1198:
1199: =item * get_domains()
1.35 matthew 1200:
1201: Returns an array containing each of the domains listed in the hosts.tab
1202: file.
1203:
1204: =cut
1205:
1206: #-------------------------------------------
1.34 matthew 1207: sub get_domains {
1208: # The code below was stolen from "The Perl Cookbook", p 102, 1st ed.
1209: my @domains;
1210: my %seen;
1.356 albertel 1211: foreach my $dom (sort(values(%Apache::lonnet::hostdom))) {
1212: push(@domains,$dom) unless $seen{$dom}++;
1.34 matthew 1213: }
1214: return @domains;
1215: }
1.88 www 1216:
1.169 www 1217: # ------------------------------------------
1218:
1219: sub domain_select {
1220: my ($name,$value,$multiple)=@_;
1221: my %domains=map {
1222: $_ => $_.' '.$Apache::lonnet::domaindescription{$_}
1223: } &get_domains;
1224: if ($multiple) {
1225: $domains{''}=&mt('Any domain');
1.287 albertel 1226: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1227: } else {
1228: return &select_form($name,$value,%domains);
1229: }
1230: }
1231:
1.282 albertel 1232: #-------------------------------------------
1233:
1234: =pod
1235:
1.287 albertel 1236: =item * multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1237:
1238: Returns a string containing a <select> element int multiple mode
1239:
1240:
1241: Args:
1242: $name - name of the <select> element
1243: $value - sclara or array ref of values that should already be selected
1244: $size - number of rows long the select element is
1.283 albertel 1245: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1246: (shown text should already have been &mt())
1.284 albertel 1247: $order - (optional) array ref of the order to show the elments in
1.283 albertel 1248:
1.282 albertel 1249: =cut
1250:
1251: #-------------------------------------------
1.169 www 1252: sub multiple_select_form {
1.284 albertel 1253: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1254: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1255: my $output='';
1.191 matthew 1256: if (! defined($size)) {
1257: $size = 4;
1.283 albertel 1258: if (scalar(keys(%$hash))<4) {
1259: $size = scalar(keys(%$hash));
1.191 matthew 1260: }
1261: }
1.169 www 1262: $output.="\n<select name='$name' size='$size' multiple='1'>";
1.286 banghart 1263: my @order = ref($order) ? @$order
1.284 albertel 1264: : sort(keys(%$hash));
1265: foreach my $key (@order) {
1.356 albertel 1266: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1267: $output.='selected="selected" ' if ($selected{$key});
1268: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1269: }
1270: $output.="</select>\n";
1271: return $output;
1272: }
1273:
1.88 www 1274: #-------------------------------------------
1275:
1276: =pod
1277:
1.112 bowersj2 1278: =item * select_form($defdom,$name,%hash)
1.88 www 1279:
1280: Returns a string containing a <select name='$name' size='1'> form to
1281: allow a user to select options from a hash option_name => displayed text.
1282: See lonrights.pm for an example invocation and use.
1283:
1284: =cut
1285:
1286: #-------------------------------------------
1287: sub select_form {
1288: my ($def,$name,%hash) = @_;
1289: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1290: my @keys;
1291: if (exists($hash{'select_form_order'})) {
1292: @keys=@{$hash{'select_form_order'}};
1293: } else {
1294: @keys=sort(keys(%hash));
1295: }
1.356 albertel 1296: foreach my $key (@keys) {
1297: $selectform.=
1298: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1299: ($key eq $def ? 'selected="selected" ' : '').
1300: ">".&mt($hash{$key})."</option>\n";
1.88 www 1301: }
1302: $selectform.="</select>";
1303: return $selectform;
1304: }
1305:
1.167 www 1306: sub gradeleveldescription {
1307: my $gradelevel=shift;
1308: my %gradelevels=(0 => 'Not specified',
1309: 1 => 'Grade 1',
1310: 2 => 'Grade 2',
1311: 3 => 'Grade 3',
1312: 4 => 'Grade 4',
1313: 5 => 'Grade 5',
1314: 6 => 'Grade 6',
1315: 7 => 'Grade 7',
1316: 8 => 'Grade 8',
1317: 9 => 'Grade 9',
1318: 10 => 'Grade 10',
1319: 11 => 'Grade 11',
1320: 12 => 'Grade 12',
1321: 13 => 'Grade 13',
1322: 14 => '100 Level',
1323: 15 => '200 Level',
1324: 16 => '300 Level',
1325: 17 => '400 Level',
1326: 18 => 'Graduate Level');
1327: return &mt($gradelevels{$gradelevel});
1328: }
1329:
1.163 www 1330: sub select_level_form {
1331: my ($deflevel,$name)=@_;
1332: unless ($deflevel) { $deflevel=0; }
1.167 www 1333: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1334: for (my $i=0; $i<=18; $i++) {
1335: $selectform.="<option value=\"$i\" ".
1.253 albertel 1336: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1337: ">".&gradeleveldescription($i)."</option>\n";
1338: }
1339: $selectform.="</select>";
1340: return $selectform;
1.163 www 1341: }
1.167 www 1342:
1.35 matthew 1343: #-------------------------------------------
1344:
1.45 matthew 1345: =pod
1346:
1.112 bowersj2 1347: =item * select_dom_form($defdom,$name,$includeempty)
1.35 matthew 1348:
1349: Returns a string containing a <select name='$name' size='1'> form to
1350: allow a user to select the domain to preform an operation in.
1351: See loncreateuser.pm for an example invocation and use.
1352:
1.90 www 1353: If the $includeempty flag is set, it also includes an empty choice ("no domain
1354: selected");
1355:
1.35 matthew 1356: =cut
1357:
1358: #-------------------------------------------
1.34 matthew 1359: sub select_dom_form {
1.90 www 1360: my ($defdom,$name,$includeempty) = @_;
1.34 matthew 1361: my @domains = get_domains();
1.90 www 1362: if ($includeempty) { @domains=('',@domains); }
1.34 matthew 1363: my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
1.356 albertel 1364: foreach my $dom (@domains) {
1365: $selectdomain.="<option value=\"$dom\" ".
1366: ($dom eq $defdom ? 'selected="selected" ' : '').
1367: ">$dom</option>\n";
1.34 matthew 1368: }
1369: $selectdomain.="</select>";
1370: return $selectdomain;
1371: }
1372:
1.35 matthew 1373: #-------------------------------------------
1374:
1.45 matthew 1375: =pod
1376:
1.112 bowersj2 1377: =item * get_library_servers($domain)
1.35 matthew 1378:
1379: Returns a hash which contains keys like '103l3' and values like
1380: 'kirk.lite.msu.edu'. All of the keys will be for machines in the
1381: given $domain.
1382:
1383: =cut
1384:
1385: #-------------------------------------------
1.52 matthew 1386: sub get_library_servers {
1.33 matthew 1387: my $domain = shift;
1.52 matthew 1388: my %library_servers;
1.356 albertel 1389: foreach my $hostid (keys(%Apache::lonnet::libserv)) {
1390: if ($Apache::lonnet::hostdom{$hostid} eq $domain) {
1391: $library_servers{$hostid} = $Apache::lonnet::hostname{$hostid};
1.33 matthew 1392: }
1393: }
1.52 matthew 1394: return %library_servers;
1.33 matthew 1395: }
1396:
1.35 matthew 1397: #-------------------------------------------
1398:
1.45 matthew 1399: =pod
1400:
1.112 bowersj2 1401: =item * home_server_option_list($domain)
1.35 matthew 1402:
1403: returns a string which contains an <option> list to be used in a
1404: <select> form input. See loncreateuser.pm for an example.
1405:
1406: =cut
1407:
1408: #-------------------------------------------
1.33 matthew 1409: sub home_server_option_list {
1410: my $domain = shift;
1.52 matthew 1411: my %servers = &get_library_servers($domain);
1.33 matthew 1412: my $result = '';
1.356 albertel 1413: foreach my $hostid (sort(keys(%servers))) {
1.33 matthew 1414: $result.=
1.356 albertel 1415: '<option value="'.$hostid.'">'.
1416: $hostid.' '.$servers{$hostid}."</option>\n";
1.33 matthew 1417: }
1418: return $result;
1419: }
1.112 bowersj2 1420:
1421: =pod
1422:
1423: =back
1424:
1425: =cut
1.87 matthew 1426:
1427: ###############################################################
1.112 bowersj2 1428: ## Decoding User Agent ##
1.87 matthew 1429: ###############################################################
1430:
1431: =pod
1432:
1.112 bowersj2 1433: =head1 Decoding the User Agent
1434:
1435: =over 4
1436:
1437: =item * &decode_user_agent()
1.87 matthew 1438:
1439: Inputs: $r
1440:
1441: Outputs:
1442:
1443: =over 4
1444:
1.112 bowersj2 1445: =item * $httpbrowser
1.87 matthew 1446:
1.112 bowersj2 1447: =item * $clientbrowser
1.87 matthew 1448:
1.112 bowersj2 1449: =item * $clientversion
1.87 matthew 1450:
1.112 bowersj2 1451: =item * $clientmathml
1.87 matthew 1452:
1.112 bowersj2 1453: =item * $clientunicode
1.87 matthew 1454:
1.112 bowersj2 1455: =item * $clientos
1.87 matthew 1456:
1457: =back
1458:
1.157 matthew 1459: =back
1460:
1.87 matthew 1461: =cut
1462:
1463: ###############################################################
1464: ###############################################################
1465: sub decode_user_agent {
1.247 albertel 1466: my ($r)=@_;
1.87 matthew 1467: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
1468: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
1469: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 1470: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 1471: my $clientbrowser='unknown';
1472: my $clientversion='0';
1473: my $clientmathml='';
1474: my $clientunicode='0';
1475: for (my $i=0;$i<=$#browsertype;$i++) {
1476: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
1477: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
1478: $clientbrowser=$bname;
1479: $httpbrowser=~/$vreg/i;
1480: $clientversion=$1;
1481: $clientmathml=($clientversion>=$minv);
1482: $clientunicode=($clientversion>=$univ);
1483: }
1484: }
1485: my $clientos='unknown';
1486: if (($httpbrowser=~/linux/i) ||
1487: ($httpbrowser=~/unix/i) ||
1488: ($httpbrowser=~/ux/i) ||
1489: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
1490: if (($httpbrowser=~/vax/i) ||
1491: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
1492: if ($httpbrowser=~/next/i) { $clientos='next'; }
1493: if (($httpbrowser=~/mac/i) ||
1494: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1495: if ($httpbrowser=~/win/i) { $clientos='win'; }
1496: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1497: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1498: $clientunicode,$clientos,);
1499: }
1500:
1.32 matthew 1501: ###############################################################
1502: ## Authentication changing form generation subroutines ##
1503: ###############################################################
1504: ##
1505: ## All of the authform_xxxxxxx subroutines take their inputs in a
1506: ## hash, and have reasonable default values.
1507: ##
1508: ## formname = the name given in the <form> tag.
1.35 matthew 1509: #-------------------------------------------
1510:
1.45 matthew 1511: =pod
1512:
1.112 bowersj2 1513: =head1 Authentication Routines
1514:
1515: =over 4
1516:
1517: =item * authform_xxxxxx
1.35 matthew 1518:
1519: The authform_xxxxxx subroutines provide javascript and html forms which
1520: handle some of the conveniences required for authentication forms.
1521: This is not an optimal method, but it works.
1522:
1523: See loncreateuser.pm for invocation and use examples.
1524:
1525: =over 4
1526:
1.112 bowersj2 1527: =item * authform_header
1.35 matthew 1528:
1.112 bowersj2 1529: =item * authform_authorwarning
1.35 matthew 1530:
1.112 bowersj2 1531: =item * authform_nochange
1.35 matthew 1532:
1.112 bowersj2 1533: =item * authform_kerberos
1.35 matthew 1534:
1.112 bowersj2 1535: =item * authform_internal
1.35 matthew 1536:
1.112 bowersj2 1537: =item * authform_filesystem
1.35 matthew 1538:
1539: =back
1540:
1.157 matthew 1541: =back
1542:
1.35 matthew 1543: =cut
1544:
1545: #-------------------------------------------
1.32 matthew 1546: sub authform_header{
1547: my %in = (
1548: formname => 'cu',
1.80 albertel 1549: kerb_def_dom => '',
1.32 matthew 1550: @_,
1551: );
1552: $in{'formname'} = 'document.' . $in{'formname'};
1553: my $result='';
1.80 albertel 1554:
1555: #---------------------------------------------- Code for upper case translation
1556: my $Javascript_toUpperCase;
1557: unless ($in{kerb_def_dom}) {
1558: $Javascript_toUpperCase =<<"END";
1559: switch (choice) {
1560: case 'krb': currentform.elements[choicearg].value =
1561: currentform.elements[choicearg].value.toUpperCase();
1562: break;
1563: default:
1564: }
1565: END
1566: } else {
1567: $Javascript_toUpperCase = "";
1568: }
1569:
1.165 raeburn 1570: my $radioval = "'nochange'";
1.174 matthew 1571: if (exists($in{'curr_authtype'}) &&
1572: defined($in{'curr_authtype'}) &&
1573: $in{'curr_authtype'} ne '') {
1574: $radioval = "'$in{'curr_authtype'}arg'";
1575: }
1.165 raeburn 1576: my $argfield = 'null';
1577: if ( grep/^mode$/,(keys %in) ) {
1578: if ($in{'mode'} eq 'modifycourse') {
1579: if ( grep/^curr_authtype$/,(keys %in) ) {
1580: $radioval = "'$in{'curr_authtype'}'";
1581: }
1582: if ( grep/^curr_autharg$/,(keys %in) ) {
1583: unless ($in{'curr_autharg'} eq '') {
1584: $argfield = "'$in{'curr_autharg'}'";
1585: }
1586: }
1587: }
1588: }
1589:
1.32 matthew 1590: $result.=<<"END";
1591: var current = new Object();
1.165 raeburn 1592: current.radiovalue = $radioval;
1593: current.argfield = $argfield;
1.32 matthew 1594:
1595: function changed_radio(choice,currentform) {
1596: var choicearg = choice + 'arg';
1597: // If a radio button in changed, we need to change the argfield
1598: if (current.radiovalue != choice) {
1599: current.radiovalue = choice;
1600: if (current.argfield != null) {
1601: currentform.elements[current.argfield].value = '';
1602: }
1603: if (choice == 'nochange') {
1604: current.argfield = null;
1605: } else {
1606: current.argfield = choicearg;
1607: switch(choice) {
1608: case 'krb':
1609: currentform.elements[current.argfield].value =
1610: "$in{'kerb_def_dom'}";
1611: break;
1612: default:
1613: break;
1614: }
1615: }
1616: }
1617: return;
1618: }
1.22 www 1619:
1.32 matthew 1620: function changed_text(choice,currentform) {
1621: var choicearg = choice + 'arg';
1622: if (currentform.elements[choicearg].value !='') {
1.80 albertel 1623: $Javascript_toUpperCase
1.32 matthew 1624: // clear old field
1625: if ((current.argfield != choicearg) && (current.argfield != null)) {
1626: currentform.elements[current.argfield].value = '';
1627: }
1628: current.argfield = choicearg;
1629: }
1630: set_auth_radio_buttons(choice,currentform);
1631: return;
1.20 www 1632: }
1.32 matthew 1633:
1634: function set_auth_radio_buttons(newvalue,currentform) {
1635: var i=0;
1636: while (i < currentform.login.length) {
1637: if (currentform.login[i].value == newvalue) { break; }
1638: i++;
1639: }
1640: if (i == currentform.login.length) {
1641: return;
1642: }
1643: current.radiovalue = newvalue;
1644: currentform.login[i].checked = true;
1645: return;
1646: }
1647: END
1648: return $result;
1649: }
1650:
1651: sub authform_authorwarning{
1652: my $result='';
1.144 matthew 1653: $result='<i>'.
1654: &mt('As a general rule, only authors or co-authors should be '.
1655: 'filesystem authenticated '.
1656: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 1657: return $result;
1658: }
1659:
1660: sub authform_nochange{
1661: my %in = (
1662: formname => 'document.cu',
1663: kerb_def_dom => 'MSU.EDU',
1664: @_,
1665: );
1.281 albertel 1666: my $result = '<label>'.&mt('[_1] Do not change login data',
1.144 matthew 1667: '<input type="radio" name="login" value="nochange" '.
1668: 'checked="checked" onclick="'.
1.281 albertel 1669: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
1670: '</label>';
1.32 matthew 1671: return $result;
1672: }
1673:
1674: sub authform_kerberos{
1675: my %in = (
1676: formname => 'document.cu',
1677: kerb_def_dom => 'MSU.EDU',
1.80 albertel 1678: kerb_def_auth => 'krb4',
1.32 matthew 1679: @_,
1680: );
1.165 raeburn 1681: my ($check4,$check5,$krbarg);
1.80 albertel 1682: if ($in{'kerb_def_auth'} eq 'krb5') {
1683: $check5 = " checked=\"on\"";
1684: } else {
1685: $check4 = " checked=\"on\"";
1686: }
1.165 raeburn 1687: $krbarg = $in{'kerb_def_dom'};
1688:
1689: my $krbcheck = "";
1690: if ( grep/^curr_authtype$/,(keys %in) ) {
1691: if ($in{'curr_authtype'} =~ m/^krb/) {
1692: $krbcheck = " checked=\"on\"";
1693: if ( grep/^curr_autharg$/,(keys %in) ) {
1694: $krbarg = $in{'curr_autharg'};
1695: }
1696: }
1697: }
1698:
1.144 matthew 1699: my $jscall = "javascript:changed_radio('krb',$in{'formname'});";
1700: my $result .= &mt
1701: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 1702: '[_3] Version 4 [_4] Version 5 [_5]',
1703: '<label><input type="radio" name="login" value="krb" '.
1.165 raeburn 1704: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.$krbcheck.' />',
1.281 albertel 1705: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 1706: 'value="'.$krbarg.'" '.
1.144 matthew 1707: 'onchange="'.$jscall.'" />',
1.281 albertel 1708: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
1709: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
1710: '</label>');
1.32 matthew 1711: return $result;
1712: }
1713:
1714: sub authform_internal{
1715: my %args = (
1716: formname => 'document.cu',
1717: kerb_def_dom => 'MSU.EDU',
1718: @_,
1719: );
1.165 raeburn 1720:
1721: my $intcheck = "";
1722: my $intarg = 'value=""';
1723: if ( grep/^curr_authtype$/,(keys %args) ) {
1724: if ($args{'curr_authtype'} eq 'int') {
1725: $intcheck = " checked=\"on\"";
1726: if ( grep/^curr_autharg$/,(keys %args) ) {
1727: $intarg = "value=\"$args{'curr_autharg'}\"";
1728: }
1729: }
1730: }
1731:
1.144 matthew 1732: my $jscall = "javascript:changed_radio('int',$args{'formname'});";
1733: my $result.=&mt
1734: ('[_1] Internally authenticated (with initial password [_2])',
1.281 albertel 1735: '<label><input type="radio" name="login" value="int" '.$intcheck.
1.165 raeburn 1736: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.281 albertel 1737: '</label><input type="text" size="10" name="intarg" '.$intarg.
1.165 raeburn 1738: ' onchange="'.$jscall.'" />');
1.32 matthew 1739: return $result;
1740: }
1741:
1742: sub authform_local{
1743: my %in = (
1744: formname => 'document.cu',
1745: kerb_def_dom => 'MSU.EDU',
1746: @_,
1747: );
1.165 raeburn 1748:
1749: my $loccheck = "";
1750: my $locarg = 'value=""';
1751: if ( grep/^curr_authtype$/,(keys %in) ) {
1752: if ($in{'curr_authtype'} eq 'loc') {
1753: $loccheck = " checked=\"on\"";
1754: if ( grep/^curr_autharg$/,(keys %in) ) {
1755: $locarg = "value=\"$in{'curr_autharg'}\"";
1756: }
1757: }
1758: }
1759:
1.144 matthew 1760: my $jscall = "javascript:changed_radio('loc',$in{'formname'});";
1.160 matthew 1761: my $result.=&mt('[_1] Local Authentication with argument [_2]',
1.281 albertel 1762: '<label><input type="radio" name="login" value="loc" '.$loccheck.
1.165 raeburn 1763: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.281 albertel 1764: '</label><input type="text" size="10" name="locarg" '.$locarg.
1.165 raeburn 1765: ' onchange="'.$jscall.'" />');
1.32 matthew 1766: return $result;
1767: }
1768:
1769: sub authform_filesystem{
1770: my %in = (
1771: formname => 'document.cu',
1772: kerb_def_dom => 'MSU.EDU',
1773: @_,
1774: );
1.144 matthew 1775: my $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
1776: my $result.= &mt
1777: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 1778: '<label><input type="radio" name="login" value="fsys" '.
1.144 matthew 1779: 'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.281 albertel 1780: '</label><input type="text" size="10" name="fsysarg" value="" '.
1.144 matthew 1781: 'onchange="'.$jscall.'" />');
1.32 matthew 1782: return $result;
1783: }
1784:
1.80 albertel 1785: ###############################################################
1786: ## Get Authentication Defaults for Domain ##
1787: ###############################################################
1788:
1789: =pod
1790:
1.112 bowersj2 1791: =head1 Domains and Authentication
1792:
1793: Returns default authentication type and an associated argument as
1794: listed in file 'domain.tab'.
1795:
1796: =over 4
1797:
1798: =item * get_auth_defaults
1.80 albertel 1799:
1800: get_auth_defaults($target_domain) returns the default authentication
1801: type and an associated argument (initial password or a kerberos domain).
1802: These values are stored in lonTabs/domain.tab
1803:
1804: ($def_auth, $def_arg) = &get_auth_defaults($target_domain);
1805:
1806: If target_domain is not found in domain.tab, returns nothing ('').
1807:
1808: =cut
1809:
1810: #-------------------------------------------
1811: sub get_auth_defaults {
1812: my $domain=shift;
1813: return ($Apache::lonnet::domain_auth_def{$domain},$Apache::lonnet::domain_auth_arg_def{$domain});
1814: }
1815: ###############################################################
1816: ## End Get Authentication Defaults for Domain ##
1817: ###############################################################
1818:
1819: ###############################################################
1820: ## Get Kerberos Defaults for Domain ##
1821: ###############################################################
1822: ##
1823: ## Returns default kerberos version and an associated argument
1824: ## as listed in file domain.tab. If not listed, provides
1825: ## appropriate default domain and kerberos version.
1826: ##
1827: #-------------------------------------------
1828:
1829: =pod
1830:
1.112 bowersj2 1831: =item * get_kerberos_defaults
1.80 albertel 1832:
1833: get_kerberos_defaults($target_domain) returns the default kerberos
1834: version and domain. If not found in domain.tabs, it defaults to
1835: version 4 and the domain of the server.
1836:
1837: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
1838:
1839: =cut
1840:
1841: #-------------------------------------------
1842: sub get_kerberos_defaults {
1843: my $domain=shift;
1844: my ($krbdef,$krbdefdom) =
1845: &Apache::loncommon::get_auth_defaults($domain);
1846: unless ($krbdef =~/^krb/ && $krbdefdom) {
1847: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
1848: my $krbdefdom=$1;
1849: $krbdefdom=~tr/a-z/A-Z/;
1850: $krbdef = "krb4";
1851: }
1852: return ($krbdef,$krbdefdom);
1853: }
1.112 bowersj2 1854:
1855: =pod
1856:
1857: =back
1858:
1859: =cut
1.32 matthew 1860:
1.46 matthew 1861: ###############################################################
1862: ## Thesaurus Functions ##
1863: ###############################################################
1.20 www 1864:
1.46 matthew 1865: =pod
1.20 www 1866:
1.112 bowersj2 1867: =head1 Thesaurus Functions
1868:
1869: =over 4
1870:
1871: =item * initialize_keywords
1.46 matthew 1872:
1873: Initializes the package variable %Keywords if it is empty. Uses the
1874: package variable $thesaurus_db_file.
1875:
1876: =cut
1877:
1878: ###################################################
1879:
1880: sub initialize_keywords {
1881: return 1 if (scalar keys(%Keywords));
1882: # If we are here, %Keywords is empty, so fill it up
1883: # Make sure the file we need exists...
1884: if (! -e $thesaurus_db_file) {
1885: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
1886: " failed because it does not exist");
1887: return 0;
1888: }
1889: # Set up the hash as a database
1890: my %thesaurus_db;
1891: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 1892: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 1893: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
1894: $thesaurus_db_file);
1895: return 0;
1896: }
1897: # Get the average number of appearances of a word.
1898: my $avecount = $thesaurus_db{'average.count'};
1899: # Put keywords (those that appear > average) into %Keywords
1900: while (my ($word,$data)=each (%thesaurus_db)) {
1901: my ($count,undef) = split /:/,$data;
1902: $Keywords{$word}++ if ($count > $avecount);
1903: }
1904: untie %thesaurus_db;
1905: # Remove special values from %Keywords.
1.356 albertel 1906: foreach my $value ('total.count','average.count') {
1907: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.46 matthew 1908: }
1909: return 1;
1910: }
1911:
1912: ###################################################
1913:
1914: =pod
1915:
1.112 bowersj2 1916: =item * keyword($word)
1.46 matthew 1917:
1918: Returns true if $word is a keyword. A keyword is a word that appears more
1919: than the average number of times in the thesaurus database. Calls
1920: &initialize_keywords
1921:
1922: =cut
1923:
1924: ###################################################
1.20 www 1925:
1926: sub keyword {
1.46 matthew 1927: return if (!&initialize_keywords());
1928: my $word=lc(shift());
1929: $word=~s/\W//g;
1930: return exists($Keywords{$word});
1.20 www 1931: }
1.46 matthew 1932:
1933: ###############################################################
1934:
1935: =pod
1.20 www 1936:
1.112 bowersj2 1937: =item * get_related_words
1.46 matthew 1938:
1.160 matthew 1939: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 1940: an array of words. If the keyword is not in the thesaurus, an empty array
1941: will be returned. The order of the words returned is determined by the
1942: database which holds them.
1943:
1944: Uses global $thesaurus_db_file.
1945:
1946: =cut
1947:
1948: ###############################################################
1949: sub get_related_words {
1950: my $keyword = shift;
1951: my %thesaurus_db;
1952: if (! -e $thesaurus_db_file) {
1953: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
1954: "failed because the file does not exist");
1955: return ();
1956: }
1957: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 1958: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 1959: return ();
1960: }
1961: my @Words=();
1.429 www 1962: my $count=0;
1.46 matthew 1963: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 1964: # The first element is the number of times
1965: # the word appears. We do not need it now.
1.429 www 1966: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
1967: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
1968: my $threshold=$mostfrequentcount/10;
1969: foreach my $possibleword (@RelatedWords) {
1970: my ($word,$wordcount)=split(/\,/,$possibleword);
1971: if ($wordcount>$threshold) {
1972: push(@Words,$word);
1973: $count++;
1974: if ($count>10) { last; }
1975: }
1.20 www 1976: }
1977: }
1.46 matthew 1978: untie %thesaurus_db;
1979: return @Words;
1.14 harris41 1980: }
1.46 matthew 1981:
1.112 bowersj2 1982: =pod
1983:
1984: =back
1985:
1986: =cut
1.61 www 1987:
1988: # -------------------------------------------------------------- Plaintext name
1.81 albertel 1989: =pod
1990:
1.112 bowersj2 1991: =head1 User Name Functions
1992:
1993: =over 4
1994:
1.226 albertel 1995: =item * plainname($uname,$udom,$first)
1.81 albertel 1996:
1.112 bowersj2 1997: Takes a users logon name and returns it as a string in
1.226 albertel 1998: "first middle last generation" form
1999: if $first is set to 'lastname' then it returns it as
2000: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2001:
2002: =cut
1.61 www 2003:
1.295 www 2004:
1.81 albertel 2005: ###############################################################
1.61 www 2006: sub plainname {
1.226 albertel 2007: my ($uname,$udom,$first)=@_;
1.295 www 2008: my %names=&getnames($uname,$udom);
1.226 albertel 2009: my $name=&Apache::lonnet::format_name($names{'firstname'},
2010: $names{'middlename'},
2011: $names{'lastname'},
2012: $names{'generation'},$first);
2013: $name=~s/^\s+//;
1.62 www 2014: $name=~s/\s+$//;
2015: $name=~s/\s+/ /g;
1.353 albertel 2016: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2017: return $name;
1.61 www 2018: }
1.66 www 2019:
2020: # -------------------------------------------------------------------- Nickname
1.81 albertel 2021: =pod
2022:
1.112 bowersj2 2023: =item * nickname($uname,$udom)
1.81 albertel 2024:
2025: Gets a users name and returns it as a string as
2026:
2027: ""nickname""
1.66 www 2028:
1.81 albertel 2029: if the user has a nickname or
2030:
2031: "first middle last generation"
2032:
2033: if the user does not
2034:
2035: =cut
1.66 www 2036:
2037: sub nickname {
2038: my ($uname,$udom)=@_;
1.295 www 2039: my %names=&getnames($uname,$udom);
1.68 albertel 2040: my $name=$names{'nickname'};
1.66 www 2041: if ($name) {
2042: $name='"'.$name.'"';
2043: } else {
2044: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2045: $names{'lastname'}.' '.$names{'generation'};
2046: $name=~s/\s+$//;
2047: $name=~s/\s+/ /g;
2048: }
2049: return $name;
2050: }
2051:
1.295 www 2052: sub getnames {
2053: my ($uname,$udom)=@_;
1.433 albertel 2054: if ($udom eq 'public' && $uname eq 'public') {
2055: return ('lastname' => &mt('Public'));
2056: }
1.295 www 2057: my $id=$uname.':'.$udom;
2058: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2059: if ($cached) {
2060: return %{$names};
2061: } else {
2062: my %loadnames=&Apache::lonnet::get('environment',
2063: ['firstname','middlename','lastname','generation','nickname'],
2064: $udom,$uname);
2065: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2066: return %loadnames;
2067: }
2068: }
1.61 www 2069:
1.466 ! albertel 2070: sub getemails {
! 2071: my ($uname,$udom)=@_;
! 2072: if ($udom eq 'public' && $uname eq 'public') {
! 2073: return;
! 2074: }
! 2075: my $id=$uname.':'.$udom;
! 2076: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
! 2077: if ($cached) {
! 2078: return %{$names};
! 2079: } else {
! 2080: my %loadnames=&Apache::lonnet::get('environment',
! 2081: ['notification','critnotification',
! 2082: 'permanentemail'],
! 2083: $udom,$uname);
! 2084: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
! 2085: return %loadnames;
! 2086: }
! 2087: }
! 2088:
1.61 www 2089: # ------------------------------------------------------------------ Screenname
1.81 albertel 2090:
2091: =pod
2092:
1.112 bowersj2 2093: =item * screenname($uname,$udom)
1.81 albertel 2094:
2095: Gets a users screenname and returns it as a string
2096:
2097: =cut
1.61 www 2098:
2099: sub screenname {
2100: my ($uname,$udom)=@_;
1.258 albertel 2101: if ($uname eq $env{'user.name'} &&
2102: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2103: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2104: return $names{'screenname'};
1.62 www 2105: }
2106:
1.212 albertel 2107:
1.62 www 2108: # ------------------------------------------------------------- Message Wrapper
2109:
2110: sub messagewrapper {
1.369 www 2111: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 2112: return
1.441 albertel 2113: '<a href="/adm/email?compose=individual&'.
2114: 'recname='.$username.'&recdom='.$domain.
2115: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 2116: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 2117: }
2118: # --------------------------------------------------------------- Notes Wrapper
2119:
2120: sub noteswrapper {
2121: my ($link,$un,$do)=@_;
2122: return
2123: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 2124: }
2125: # ------------------------------------------------------------- Aboutme Wrapper
2126:
2127: sub aboutmewrapper {
1.166 www 2128: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 2129: if (!defined($username) && !defined($domain)) {
2130: return;
2131: }
1.205 www 2132: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.454 banghart 2133: ($target?' target="$target"':'').' title="'.&mt("View this user's personal page").'">'.$link.'</a>';
1.62 www 2134: }
2135:
2136: # ------------------------------------------------------------ Syllabus Wrapper
2137:
2138:
2139: sub syllabuswrapper {
1.109 matthew 2140: my ($linktext,$coursedir,$domain,$fontcolor)=@_;
2141: if ($fontcolor) {
2142: $linktext='<font color="'.$fontcolor.'">'.$linktext.'</font>';
2143: }
1.208 matthew 2144: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 2145: }
1.14 harris41 2146:
1.208 matthew 2147: sub track_student_link {
1.268 albertel 2148: my ($linktext,$sname,$sdom,$target,$start) = @_;
2149: my $link ="/adm/trackstudent?";
1.208 matthew 2150: my $title = 'View recent activity';
2151: if (defined($sname) && $sname !~ /^\s*$/ &&
2152: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 2153: $link .= "selected_student=$sname:$sdom";
1.208 matthew 2154: $title .= ' of this student';
1.268 albertel 2155: }
1.208 matthew 2156: if (defined($target) && $target !~ /^\s*$/) {
2157: $target = qq{target="$target"};
2158: } else {
2159: $target = '';
2160: }
1.268 albertel 2161: if ($start) { $link.='&start='.$start; }
1.448 albertel 2162:
2163: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
2164: &help_open_topic('View_recent_activity');
1.208 matthew 2165: }
2166:
1.112 bowersj2 2167: =pod
2168:
2169: =back
2170:
2171: =head1 Access .tab File Data
2172:
2173: =over 4
2174:
2175: =item * languageids()
2176:
2177: returns list of all language ids
2178:
2179: =cut
2180:
1.14 harris41 2181: sub languageids {
1.16 harris41 2182: return sort(keys(%language));
1.14 harris41 2183: }
2184:
1.112 bowersj2 2185: =pod
2186:
2187: =item * languagedescription()
2188:
2189: returns description of a specified language id
2190:
2191: =cut
2192:
1.14 harris41 2193: sub languagedescription {
1.125 www 2194: my $code=shift;
2195: return ($supported_language{$code}?'* ':'').
2196: $language{$code}.
1.126 www 2197: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 2198: }
2199:
2200: sub plainlanguagedescription {
2201: my $code=shift;
2202: return $language{$code};
2203: }
2204:
2205: sub supportedlanguagecode {
2206: my $code=shift;
2207: return $supported_language{$code};
1.97 www 2208: }
2209:
1.112 bowersj2 2210: =pod
2211:
2212: =item * copyrightids()
2213:
2214: returns list of all copyrights
2215:
2216: =cut
2217:
2218: sub copyrightids {
2219: return sort(keys(%cprtag));
2220: }
2221:
2222: =pod
2223:
2224: =item * copyrightdescription()
2225:
2226: returns description of a specified copyright id
2227:
2228: =cut
2229:
2230: sub copyrightdescription {
1.166 www 2231: return &mt($cprtag{shift(@_)});
1.112 bowersj2 2232: }
1.197 matthew 2233:
2234: =pod
2235:
1.192 taceyjo1 2236: =item * source_copyrightids()
2237:
2238: returns list of all source copyrights
2239:
2240: =cut
2241:
2242: sub source_copyrightids {
2243: return sort(keys(%scprtag));
2244: }
2245:
2246: =pod
2247:
2248: =item * source_copyrightdescription()
2249:
2250: returns description of a specified source copyright id
2251:
2252: =cut
2253:
2254: sub source_copyrightdescription {
2255: return &mt($scprtag{shift(@_)});
2256: }
1.112 bowersj2 2257:
2258: =pod
2259:
2260: =item * filecategories()
2261:
2262: returns list of all file categories
2263:
2264: =cut
2265:
2266: sub filecategories {
2267: return sort(keys(%category_extensions));
2268: }
2269:
2270: =pod
2271:
2272: =item * filecategorytypes()
2273:
2274: returns list of file types belonging to a given file
2275: category
2276:
2277: =cut
2278:
2279: sub filecategorytypes {
1.356 albertel 2280: my ($cat) = @_;
2281: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 2282: }
2283:
2284: =pod
2285:
2286: =item * fileembstyle()
2287:
2288: returns embedding style for a specified file type
2289:
2290: =cut
2291:
2292: sub fileembstyle {
2293: return $fe{lc(shift(@_))};
1.169 www 2294: }
2295:
1.351 www 2296: sub filemimetype {
2297: return $fm{lc(shift(@_))};
2298: }
2299:
1.169 www 2300:
2301: sub filecategoryselect {
2302: my ($name,$value)=@_;
1.189 matthew 2303: return &select_form($value,$name,
1.169 www 2304: '' => &mt('Any category'),
2305: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 2306: }
2307:
2308: =pod
2309:
2310: =item * filedescription()
2311:
2312: returns description for a specified file type
2313:
2314: =cut
2315:
2316: sub filedescription {
1.188 matthew 2317: my $file_description = $fd{lc(shift())};
2318: $file_description =~ s:([\[\]]):~$1:g;
2319: return &mt($file_description);
1.112 bowersj2 2320: }
2321:
2322: =pod
2323:
2324: =item * filedescriptionex()
2325:
2326: returns description for a specified file type with
2327: extra formatting
2328:
2329: =cut
2330:
2331: sub filedescriptionex {
2332: my $ex=shift;
1.188 matthew 2333: my $file_description = $fd{lc($ex)};
2334: $file_description =~ s:([\[\]]):~$1:g;
2335: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 2336: }
2337:
2338: # End of .tab access
2339: =pod
2340:
2341: =back
2342:
2343: =cut
2344:
2345: # ------------------------------------------------------------------ File Types
2346: sub fileextensions {
2347: return sort(keys(%fe));
2348: }
2349:
1.97 www 2350: # ----------------------------------------------------------- Display Languages
2351: # returns a hash with all desired display languages
2352: #
2353:
2354: sub display_languages {
2355: my %languages=();
1.356 albertel 2356: foreach my $lang (&preferred_languages()) {
2357: $languages{$lang}=1;
1.97 www 2358: }
2359: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 2360: if ($env{'form.displaylanguage'}) {
1.356 albertel 2361: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
2362: $languages{$lang}=1;
1.97 www 2363: }
2364: }
2365: return %languages;
1.14 harris41 2366: }
2367:
1.117 www 2368: sub preferred_languages {
2369: my @languages=();
1.258 albertel 2370: if ($env{'course.'.$env{'request.course.id'}.'.languages'}) {
1.117 www 2371: @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,
1.258 albertel 2372: $env{'course.'.$env{'request.course.id'}.'.languages'}));
1.177 www 2373: }
1.258 albertel 2374: if ($env{'environment.languages'}) {
1.459 albertel 2375: @languages=(@languages,
2376: split(/\s*(\,|\;|\:)\s*/,$env{'environment.languages'}));
1.118 www 2377: }
1.162 www 2378: my $browser=(split(/\;/,$ENV{'HTTP_ACCEPT_LANGUAGE'}))[0];
2379: if ($browser) {
2380: @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,$browser));
2381: }
1.258 albertel 2382: if ($Apache::lonnet::domain_lang_def{$env{'user.domain'}}) {
1.118 www 2383: @languages=(@languages,
1.258 albertel 2384: $Apache::lonnet::domain_lang_def{$env{'user.domain'}});
1.118 www 2385: }
1.258 albertel 2386: if ($Apache::lonnet::domain_lang_def{$env{'request.role.domain'}}) {
1.118 www 2387: @languages=(@languages,
1.258 albertel 2388: $Apache::lonnet::domain_lang_def{$env{'request.role.domain'}});
1.118 www 2389: }
2390: if ($Apache::lonnet::domain_lang_def{
2391: $Apache::lonnet::perlvar{'lonDefDomain'}}) {
2392: @languages=(@languages,
2393: $Apache::lonnet::domain_lang_def{
2394: $Apache::lonnet::perlvar{'lonDefDomain'}});
2395: }
2396: # turn "en-ca" into "en-ca,en"
2397: my @genlanguages;
1.356 albertel 2398: foreach my $lang (@languages) {
2399: unless ($lang=~/\w/) { next; }
2400: push (@genlanguages,$lang);
2401: if ($lang=~/(\-|\_)/) {
2402: push(@genlanguages,(split(/(\-|\_)/,$lang))[0]);
1.118 www 2403: }
2404: }
2405: return @genlanguages;
1.117 www 2406: }
2407:
1.112 bowersj2 2408: ###############################################################
2409: ## Student Answer Attempts ##
2410: ###############################################################
2411:
2412: =pod
2413:
2414: =head1 Alternate Problem Views
2415:
2416: =over 4
2417:
2418: =item * get_previous_attempt($symb, $username, $domain, $course,
2419: $getattempt, $regexp, $gradesub)
2420:
2421: Return string with previous attempt on problem. Arguments:
2422:
2423: =over 4
2424:
2425: =item * $symb: Problem, including path
2426:
2427: =item * $username: username of the desired student
2428:
2429: =item * $domain: domain of the desired student
1.14 harris41 2430:
1.112 bowersj2 2431: =item * $course: Course ID
1.14 harris41 2432:
1.112 bowersj2 2433: =item * $getattempt: Leave blank for all attempts, otherwise put
2434: something
1.14 harris41 2435:
1.112 bowersj2 2436: =item * $regexp: if string matches this regexp, the string will be
2437: sent to $gradesub
1.14 harris41 2438:
1.112 bowersj2 2439: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 2440:
1.112 bowersj2 2441: =back
1.14 harris41 2442:
1.112 bowersj2 2443: The output string is a table containing all desired attempts, if any.
1.16 harris41 2444:
1.112 bowersj2 2445: =cut
1.1 albertel 2446:
2447: sub get_previous_attempt {
1.43 ng 2448: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 2449: my $prevattempts='';
1.43 ng 2450: no strict 'refs';
1.1 albertel 2451: if ($symb) {
1.3 albertel 2452: my (%returnhash)=
2453: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 2454: if ($returnhash{'version'}) {
2455: my %lasthash=();
2456: my $version;
2457: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 2458: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
2459: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 2460: }
1.1 albertel 2461: }
1.43 ng 2462: $prevattempts='<table border="0" width="100%"><tr><td bgcolor="#777777">';
1.40 ng 2463: $prevattempts.='<table border="0" width="100%"><tr bgcolor="#e6ffff"><td>History</td>';
1.356 albertel 2464: foreach my $key (sort(keys(%lasthash))) {
2465: my ($ign,@parts) = split(/\./,$key);
1.41 ng 2466: if ($#parts > 0) {
1.31 albertel 2467: my $data=$parts[-1];
2468: pop(@parts);
1.40 ng 2469: $prevattempts.='<td>Part '.join('.',@parts).'<br />'.$data.' </td>';
1.31 albertel 2470: } else {
1.41 ng 2471: if ($#parts == 0) {
2472: $prevattempts.='<th>'.$parts[0].'</th>';
2473: } else {
2474: $prevattempts.='<th>'.$ign.'</th>';
2475: }
1.31 albertel 2476: }
1.16 harris41 2477: }
1.40 ng 2478: if ($getattempt eq '') {
2479: for ($version=1;$version<=$returnhash{'version'};$version++) {
2480: $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Transaction '.$version.'</td>';
1.356 albertel 2481: foreach my $key (sort(keys(%lasthash))) {
1.40 ng 2482: my $value;
1.356 albertel 2483: if ($key =~ /timestamp/) {
2484: $value=scalar(localtime($returnhash{$version.':'.$key}));
1.40 ng 2485: } else {
1.356 albertel 2486: $value=$returnhash{$version.':'.$key};
1.40 ng 2487: }
1.369 www 2488: $prevattempts.='<td>'.&unescape($value).' </td>';
1.40 ng 2489: }
2490: }
1.1 albertel 2491: }
1.40 ng 2492: $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Current</td>';
1.356 albertel 2493: foreach my $key (sort(keys(%lasthash))) {
1.5 albertel 2494: my $value;
1.356 albertel 2495: if ($key =~ /timestamp/) {
2496: $value=scalar(localtime($lasthash{$key}));
1.5 albertel 2497: } else {
1.356 albertel 2498: $value=$lasthash{$key};
1.5 albertel 2499: }
1.369 www 2500: $value=&unescape($value);
1.356 albertel 2501: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 2502: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 2503: }
1.40 ng 2504: $prevattempts.='</tr></table></td></tr></table>';
1.1 albertel 2505: } else {
2506: $prevattempts='Nothing submitted - no attempts.';
2507: }
2508: } else {
2509: $prevattempts='No data.';
2510: }
1.10 albertel 2511: }
2512:
1.107 albertel 2513: sub relative_to_absolute {
2514: my ($url,$output)=@_;
2515: my $parser=HTML::TokeParser->new(\$output);
2516: my $token;
2517: my $thisdir=$url;
2518: my @rlinks=();
2519: while ($token=$parser->get_token) {
2520: if ($token->[0] eq 'S') {
2521: if ($token->[1] eq 'a') {
2522: if ($token->[2]->{'href'}) {
2523: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
2524: }
2525: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
2526: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
2527: } elsif ($token->[1] eq 'base') {
2528: $thisdir=$token->[2]->{'href'};
2529: }
2530: }
2531: }
2532: $thisdir=~s-/[^/]*$--;
1.356 albertel 2533: foreach my $link (@rlinks) {
2534: unless (($link=~/^http:\/\//i) ||
2535: ($link=~/^\//) ||
2536: ($link=~/^javascript:/i) ||
2537: ($link=~/^mailto:/i) ||
2538: ($link=~/^\#/)) {
2539: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
2540: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 2541: }
2542: }
2543: # -------------------------------------------------- Deal with Applet codebases
2544: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
2545: return $output;
2546: }
2547:
1.112 bowersj2 2548: =pod
2549:
2550: =item * get_student_view
2551:
2552: show a snapshot of what student was looking at
2553:
2554: =cut
2555:
1.10 albertel 2556: sub get_student_view {
1.186 albertel 2557: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 2558: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 2559: my (%form);
1.10 albertel 2560: my @elements=('symb','courseid','domain','username');
2561: foreach my $element (@elements) {
1.186 albertel 2562: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 2563: }
1.186 albertel 2564: if (defined($moreenv)) {
2565: %form=(%form,%{$moreenv});
2566: }
1.236 albertel 2567: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 2568: $feedurl=&Apache::lonnet::clutter($feedurl);
1.186 albertel 2569: my $userview=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 2570: $userview=~s/\<body[^\>]*\>//gi;
2571: $userview=~s/\<\/body\>//gi;
2572: $userview=~s/\<html\>//gi;
2573: $userview=~s/\<\/html\>//gi;
2574: $userview=~s/\<head\>//gi;
2575: $userview=~s/\<\/head\>//gi;
2576: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 2577: $userview=&relative_to_absolute($feedurl,$userview);
1.11 albertel 2578: return $userview;
2579: }
2580:
1.112 bowersj2 2581: =pod
2582:
2583: =item * get_student_answers()
2584:
2585: show a snapshot of how student was answering problem
2586:
2587: =cut
2588:
1.11 albertel 2589: sub get_student_answers {
1.100 sakharuk 2590: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 2591: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 2592: my (%moreenv);
1.11 albertel 2593: my @elements=('symb','courseid','domain','username');
2594: foreach my $element (@elements) {
1.186 albertel 2595: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 2596: }
1.186 albertel 2597: $moreenv{'grade_target'}='answer';
2598: %moreenv=(%form,%moreenv);
2599: my $userview=&Apache::lonnet::ssi('/res/'.$feedurl,%moreenv);
1.10 albertel 2600: return $userview;
1.1 albertel 2601: }
1.116 albertel 2602:
2603: =pod
2604:
2605: =item * &submlink()
2606:
1.242 albertel 2607: Inputs: $text $uname $udom $symb $target
1.116 albertel 2608:
2609: Returns: A link to grades.pm such as to see the SUBM view of a student
2610:
2611: =cut
2612:
2613: ###############################################
2614: sub submlink {
1.242 albertel 2615: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 2616: if (!($uname && $udom)) {
2617: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 2618: &Apache::lonnet::whichuser($symb);
1.116 albertel 2619: if (!$symb) { $symb=$cursymb; }
2620: }
1.254 matthew 2621: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 2622: $symb=&escape($symb);
1.242 albertel 2623: if ($target) { $target="target=\"$target\""; }
2624: return '<a href="/adm/grades?&command=submission&'.
2625: 'symb='.$symb.'&student='.$uname.
2626: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
2627: }
2628: ##############################################
2629:
2630: =pod
2631:
2632: =item * &pgrdlink()
2633:
2634: Inputs: $text $uname $udom $symb $target
2635:
2636: Returns: A link to grades.pm such as to see the PGRD view of a student
2637:
2638: =cut
2639:
2640: ###############################################
2641: sub pgrdlink {
2642: my $link=&submlink(@_);
2643: $link=~s/(&command=submission)/$1&showgrading=yes/;
2644: return $link;
2645: }
2646: ##############################################
2647:
2648: =pod
2649:
2650: =item * &pprmlink()
2651:
2652: Inputs: $text $uname $udom $symb $target
2653:
2654: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 2655: student and a specific resource
1.242 albertel 2656:
2657: =cut
2658:
2659: ###############################################
2660: sub pprmlink {
2661: my ($text,$uname,$udom,$symb,$target)=@_;
2662: if (!($uname && $udom)) {
2663: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 2664: &Apache::lonnet::whichuser($symb);
1.242 albertel 2665: if (!$symb) { $symb=$cursymb; }
2666: }
1.254 matthew 2667: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 2668: $symb=&escape($symb);
1.242 albertel 2669: if ($target) { $target="target=\"$target\""; }
2670: return '<a href="/adm/parmset?&command=set&'.
2671: 'symb='.$symb.'&uname='.$uname.
2672: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 2673: }
2674: ##############################################
1.37 matthew 2675:
1.112 bowersj2 2676: =pod
2677:
2678: =back
2679:
2680: =cut
2681:
1.37 matthew 2682: ###############################################
1.51 www 2683:
2684:
2685: sub timehash {
2686: my @ltime=localtime(shift);
2687: return ( 'seconds' => $ltime[0],
2688: 'minutes' => $ltime[1],
2689: 'hours' => $ltime[2],
2690: 'day' => $ltime[3],
2691: 'month' => $ltime[4]+1,
2692: 'year' => $ltime[5]+1900,
2693: 'weekday' => $ltime[6],
2694: 'dayyear' => $ltime[7]+1,
2695: 'dlsav' => $ltime[8] );
2696: }
2697:
1.370 www 2698: sub utc_string {
2699: my ($date)=@_;
1.371 www 2700: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 2701: }
2702:
1.51 www 2703: sub maketime {
2704: my %th=@_;
2705: return POSIX::mktime(
2706: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 2707: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 2708: }
2709:
2710: #########################################
1.51 www 2711:
2712: sub findallcourses {
1.355 albertel 2713: my ($roles) = @_;
2714: my %roles;
2715: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 2716: my %courses;
1.51 www 2717: my $now=time;
1.348 albertel 2718: foreach my $key (keys(%env)) {
2719: if ( $key=~m{^user\.role\.(\w+)\./(\w+)/(\w+)} ) {
2720: my ($role,$domain,$id) = ($1,$2,$3);
2721: next if ($role eq 'ca' || $role eq 'aa');
1.355 albertel 2722: next if (%roles && !exists($roles{$role}));
1.354 albertel 2723: my ($starttime,$endtime)=split(/\./,$env{$key});
1.51 www 2724: my $active=1;
2725: if ($starttime) {
2726: if ($now<$starttime) { $active=0; }
2727: }
2728: if ($endtime) {
2729: if ($now>$endtime) { $active=0; }
2730: }
1.348 albertel 2731: if ($active) { $courses{$domain.'_'.$id}=1; }
1.51 www 2732: }
2733: }
1.348 albertel 2734: return keys(%courses);
1.51 www 2735: }
1.37 matthew 2736:
1.54 www 2737: ###############################################
1.60 matthew 2738: ###############################################
2739:
2740: =pod
2741:
1.112 bowersj2 2742: =head1 Domain Template Functions
2743:
2744: =over 4
2745:
2746: =item * &determinedomain()
1.60 matthew 2747:
2748: Inputs: $domain (usually will be undef)
2749:
1.63 www 2750: Returns: Determines which domain should be used for designs
1.60 matthew 2751:
2752: =cut
1.54 www 2753:
1.60 matthew 2754: ###############################################
1.63 www 2755: sub determinedomain {
2756: my $domain=shift;
2757: if (! $domain) {
1.60 matthew 2758: # Determine domain if we have not been given one
2759: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258 albertel 2760: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
2761: if ($env{'request.role.domain'}) {
2762: $domain=$env{'request.role.domain'};
1.60 matthew 2763: }
2764: }
1.63 www 2765: return $domain;
2766: }
2767: ###############################################
2768: =pod
2769:
1.112 bowersj2 2770: =item * &domainlogo()
1.63 www 2771:
2772: Inputs: $domain (usually will be undef)
2773:
2774: Returns: A link to a domain logo, if the domain logo exists.
2775: If the domain logo does not exist, a description of the domain.
2776:
2777: =cut
1.112 bowersj2 2778:
1.63 www 2779: ###############################################
2780: sub domainlogo {
2781: my $domain = &determinedomain(shift);
2782: # See if there is a logo
1.59 www 2783: if (-e '/home/httpd/html/adm/lonDomLogos/'.$domain.'.gif') {
1.215 albertel 2784: my $logo=&lonhttpdurl("/adm/lonDomLogos/$domain.gif");
2785: return '<img src="'.$logo.'" alt="'.$domain.'" />';
1.60 matthew 2786: } elsif(exists($Apache::lonnet::domaindescription{$domain})) {
2787: return $Apache::lonnet::domaindescription{$domain};
1.59 www 2788: } else {
1.60 matthew 2789: return '';
1.59 www 2790: }
2791: }
1.63 www 2792: ##############################################
2793:
2794: =pod
2795:
1.112 bowersj2 2796: =item * &designparm()
1.63 www 2797:
2798: Inputs: $which parameter; $domain (usually will be undef)
2799:
2800: Returns: value of designparamter $which
2801:
2802: =cut
1.112 bowersj2 2803:
1.397 albertel 2804:
1.400 albertel 2805: ##############################################
1.397 albertel 2806: sub designparm {
2807: my ($which,$domain)=@_;
1.258 albertel 2808: if ($env{'browser.blackwhite'} eq 'on') {
1.110 www 2809: if ($which=~/\.(font|alink|vlink|link)$/) {
2810: return '#000000';
2811: }
2812: if ($which=~/\.(pgbg|sidebg)$/) {
2813: return '#FFFFFF';
2814: }
2815: if ($which=~/\.tabbg$/) {
2816: return '#CCCCCC';
2817: }
2818: }
1.397 albertel 2819: if (exists($env{'environment.color.'.$which})) {
1.258 albertel 2820: return $env{'environment.color.'.$which};
1.96 www 2821: }
1.63 www 2822: $domain=&determinedomain($domain);
1.397 albertel 2823: if (exists($designhash{$domain.'.'.$which})) {
1.63 www 2824: return $designhash{$domain.'.'.$which};
2825: } else {
2826: return $designhash{'default.'.$which};
2827: }
2828: }
1.59 www 2829:
1.60 matthew 2830: ###############################################
2831: ###############################################
2832:
2833: =pod
2834:
1.112 bowersj2 2835: =back
2836:
2837: =head1 HTTP Helpers
2838:
2839: =over 4
2840:
2841: =item * &bodytag()
1.60 matthew 2842:
2843: Returns a uniform header for LON-CAPA web pages.
2844:
2845: Inputs:
2846:
1.112 bowersj2 2847: =over 4
2848:
2849: =item * $title, A title to be displayed on the page.
2850:
2851: =item * $function, the current role (can be undef).
2852:
2853: =item * $addentries, extra parameters for the <body> tag.
2854:
2855: =item * $bodyonly, if defined, only return the <body> tag.
2856:
2857: =item * $domain, if defined, force a given domain.
2858:
2859: =item * $forcereg, if page should register as content page (relevant for
1.86 www 2860: text interface only)
1.60 matthew 2861:
1.326 albertel 2862: =item * $customtitle, alternate text to use instead of $title
2863: in the title box that appears, this text
2864: is not auto translated like the $title is
1.309 albertel 2865:
2866: =item * $notopbar, if true, keep the 'what is this' info but remove the
2867: navigational links
1.317 albertel 2868:
1.338 albertel 2869: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
2870:
2871: =item * $notitle, if true keep the nav controls, but remove the title bar
2872:
1.361 albertel 2873: =item * $no_inline_link, if true and in remote mode, don't show the
2874: 'Switch To Inline Menu' link
2875:
1.460 albertel 2876: =item * $args, optional argument valid values are
2877: no_auto_mt_title -> prevents &mt()ing the title arg
2878:
1.112 bowersj2 2879: =back
2880:
1.60 matthew 2881: Returns: A uniform header for LON-CAPA web pages.
2882: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
2883: If $bodyonly is undef or zero, an html string containing a <body> tag and
2884: other decorations will be returned.
2885:
2886: =cut
2887:
1.54 www 2888: sub bodytag {
1.309 albertel 2889: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.460 albertel 2890: $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
1.339 albertel 2891:
1.460 albertel 2892: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 2893:
1.183 matthew 2894: $function = &get_users_function() if (!$function);
1.339 albertel 2895: my $img = &designparm($function.'.img',$domain);
2896: my $font = &designparm($function.'.font',$domain);
2897: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
2898:
2899: my %design = ( 'style' => 'margin-top: 0px',
2900: 'bgcolor' => $pgbg,
2901: 'text' => $font,
2902: 'alink' => &designparm($function.'.alink',$domain),
2903: 'vlink' => &designparm($function.'.vlink',$domain),
2904: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 2905: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 2906:
1.63 www 2907: # role and realm
1.378 raeburn 2908: my ($role,$realm) = split(/\./,$env{'request.role'},2);
2909: if ($role eq 'ca') {
2910: my ($rdom,$rname) = ($realm =~ m-^/(\w+)/(\w+)$-);
2911: $realm = &plainname($rname,$rdom).':'.$rdom;
2912: }
1.55 www 2913: # realm
1.258 albertel 2914: if ($env{'request.course.id'}) {
1.378 raeburn 2915: if ($env{'request.role'} !~ /^cr/) {
2916: $role = &Apache::lonnet::plaintext($role,&course_type());
2917: }
1.359 albertel 2918: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 2919: } else {
2920: $role = &Apache::lonnet::plaintext($role);
1.54 www 2921: }
1.433 albertel 2922:
1.359 albertel 2923: if (!$realm) { $realm=' '; }
1.55 www 2924: # Set messages
1.60 matthew 2925: my $messages=&domainlogo($domain);
1.101 www 2926: # Port for miniserver
1.83 albertel 2927: my $lonhttpdPort=$Apache::lonnet::perlvar{'lonhttpdPort'};
2928: if (!defined($lonhttpdPort)) { $lonhttpdPort='8080'; }
1.330 albertel 2929:
1.438 albertel 2930: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 2931:
1.101 www 2932: # construct main body tag
1.359 albertel 2933: my $bodytag = "<body $extra_body_attr>".
2934: &Apache::lontexconvert::init_math_support();
1.252 albertel 2935:
1.332 albertel 2936: if ($bodyonly
2937: || ($env{'request.state'} eq 'construct'
2938: && $env{'environment.remote'} ne 'off' )) {
1.60 matthew 2939: return $bodytag;
1.258 albertel 2940: } elsif ($env{'browser.interface'} eq 'textual') {
1.95 www 2941: # Accessibility
1.224 raeburn 2942:
1.337 albertel 2943: $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
1.338 albertel 2944: if (!$notitle) {
1.337 albertel 2945: $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
2946: }
2947: return $bodytag;
1.359 albertel 2948: }
2949:
1.410 albertel 2950: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 2951: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
2952: undef($role);
1.434 albertel 2953: } else {
2954: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 2955: }
1.359 albertel 2956:
2957: my $roleinfo=(<<ENDROLE);
2958: <td class="LC_title_bar_who">
2959: <div class="LC_title_bar_name">
1.410 albertel 2960: $name
1.361 albertel 2961:
1.359 albertel 2962: </div>
2963: <div class="LC_title_bar_role">
1.361 albertel 2964: $role
1.359 albertel 2965: </div>
2966: <div class="LC_title_bar_realm">
1.361 albertel 2967: $realm
1.359 albertel 2968: </div>
1.206 albertel 2969: </td>
2970: ENDROLE
1.235 raeburn 2971:
1.359 albertel 2972: my $titleinfo = '<span class="LC_title_bar_title">'.$title.'</span>';
2973: if ($customtitle) {
2974: $titleinfo = $customtitle;
2975: }
2976: #
2977: # Extra info if you are the DC
2978: my $dc_info = '';
2979: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
2980: $env{'course.'.$env{'request.course.id'}.
2981: '.domain'}.'/'})) {
2982: my $cid = $env{'request.course.id'};
2983: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 2984: $dc_info =~ s/\s+$//;
1.359 albertel 2985: $dc_info = '('.$dc_info.')';
2986: }
2987:
2988: if ($env{'environment.remote'} eq 'off') {
2989: # No Remote
1.258 albertel 2990: if ($env{'request.state'} eq 'construct') {
1.359 albertel 2991: $forcereg=1;
2992: }
2993:
2994: if (!$customtitle && $env{'request.state'} eq 'construct') {
2995: # this is for resources; directories have customtitle, and crumbs
2996: # and select recent are created in lonpubdir.pm
1.229 albertel 2997: my ($uname,$thisdisfn)=
1.258 albertel 2998: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229 albertel 2999: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
3000: $formaction=~s/\/+/\//g;
3001:
1.359 albertel 3002: my $parentpath = '';
3003: my $lastitem = '';
3004: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
3005: $parentpath = $1;
3006: $lastitem = $2;
3007: } else {
3008: $lastitem = $thisdisfn;
3009: }
3010: $titleinfo =
1.401 albertel 3011: &Apache::loncommon::help_open_menu('','',3,'Authoring').
1.359 albertel 3012: '<b>Construction Space</b>: '.
3013: '<form name="dirs" method="post" action="'.$formaction
3014: .'" target="_top"><tt><b>'
3015: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"
3016: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
3017: .'</form>'
3018: .&Apache::lonmenu::constspaceform();
1.235 raeburn 3019: }
1.359 albertel 3020:
1.337 albertel 3021: my $titletable;
1.338 albertel 3022: if (!$notitle) {
1.337 albertel 3023: $titletable =
1.359 albertel 3024: '<table id="LC_title_bar">'.
3025: "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
3026: '</tr></table>';
1.337 albertel 3027: }
1.359 albertel 3028: if ($notopbar) {
3029: $bodytag .= $titletable;
3030: } else {
3031: if ($env{'request.state'} eq 'construct') {
1.337 albertel 3032: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
3033: $titletable);
1.272 raeburn 3034: } else {
1.336 albertel 3035: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359 albertel 3036: $titletable;
1.272 raeburn 3037: }
1.235 raeburn 3038: }
3039: return $bodytag;
1.94 www 3040: }
1.95 www 3041:
1.93 www 3042: #
1.95 www 3043: # Top frame rendering, Remote is up
1.93 www 3044: #
1.359 albertel 3045:
3046: my $upperleft='<img src="http://'.$ENV{'HTTP_HOST'}.':'.
3047: $lonhttpdPort.$img.'" alt="'.$function.'" />';
3048:
1.305 www 3049: # Explicit link to get inline menu
1.361 albertel 3050: my $menu= ($no_inline_link?''
3051: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245 matthew 3052: #
1.338 albertel 3053: if ($notitle) {
1.337 albertel 3054: return $bodytag;
3055: }
1.94 www 3056: return(<<ENDBODY);
1.60 matthew 3057: $bodytag
1.359 albertel 3058: <table id="LC_title_bar" class="LC_with_remote">
1.368 albertel 3059: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
1.359 albertel 3060: <td class="LC_title_bar_domain_logo">$messages </td>
1.54 www 3061: </tr>
1.359 albertel 3062: <tr><td>$titleinfo $dc_info $menu</td>
3063: $roleinfo
1.368 albertel 3064: </tr>
1.356 albertel 3065: </table>
1.54 www 3066: ENDBODY
1.182 matthew 3067: }
3068:
1.330 albertel 3069: sub make_attr_string {
3070: my ($register,$attr_ref) = @_;
3071:
3072: if ($attr_ref && !ref($attr_ref)) {
3073: die("addentries Must be a hash ref ".
3074: join(':',caller(1))." ".
3075: join(':',caller(0))." ");
3076: }
3077:
3078: if ($register) {
1.339 albertel 3079: my ($on_load,$on_unload);
3080: foreach my $key (keys(%{$attr_ref})) {
3081: if (lc($key) eq 'onload') {
3082: $on_load.=$attr_ref->{$key}.';';
3083: delete($attr_ref->{$key});
3084:
3085: } elsif (lc($key) eq 'onunload') {
3086: $on_unload.=$attr_ref->{$key}.';';
3087: delete($attr_ref->{$key});
3088: }
3089: }
3090: $attr_ref->{'onload'} =
3091: &Apache::lonmenu::loadevents(). $on_load;
3092: $attr_ref->{'onunload'}=
3093: &Apache::lonmenu::unloadevents().$on_unload;
3094: }
3095:
3096: # Accessibility font enhance
3097: if ($env{'browser.fontenhance'} eq 'on') {
3098: my $style;
3099: foreach my $key (keys(%{$attr_ref})) {
3100: if (lc($key) eq 'style') {
3101: $style.=$attr_ref->{$key}.';';
3102: delete($attr_ref->{$key});
3103: }
3104: }
3105: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 3106: }
1.339 albertel 3107:
3108: if ($env{'browser.blackwhite'} eq 'on') {
3109: delete($attr_ref->{'font'});
3110: delete($attr_ref->{'link'});
3111: delete($attr_ref->{'alink'});
3112: delete($attr_ref->{'vlink'});
3113: delete($attr_ref->{'bgcolor'});
3114: delete($attr_ref->{'background'});
3115: }
3116:
1.330 albertel 3117: my $attr_string;
3118: foreach my $attr (keys(%$attr_ref)) {
3119: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
3120: }
3121: return $attr_string;
3122: }
3123:
3124:
1.182 matthew 3125: ###############################################
1.251 albertel 3126: ###############################################
3127:
3128: =pod
3129:
3130: =back
3131:
1.306 albertel 3132: =head1 HTML Helpers
1.251 albertel 3133:
3134: =over 4
3135:
3136: =item * &endbodytag()
3137:
3138: Returns a uniform footer for LON-CAPA web pages.
3139:
1.306 albertel 3140: Inputs: none
1.251 albertel 3141:
3142: =back
3143:
3144: =cut
3145:
3146: sub endbodytag {
3147: my $endbodytag='</body>';
1.269 albertel 3148: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 3149: if ( exists( $env{'internal.head.redirect'} ) ) {
3150: $endbodytag=
3151: "<br /><a href=\"$env{'internal.head.redirect'}\">".
3152: &mt('Continue').'</a>'.
3153: $endbodytag;
3154: }
1.251 albertel 3155: return $endbodytag;
3156: }
3157:
1.352 albertel 3158: =pod
3159:
3160: =over 4
3161:
3162: =item * &standard_css()
3163:
3164: Returns a style sheet
3165:
3166: Inputs: (all optional)
3167: domain -> force to color decorate a page for a specific
3168: domain
3169: function -> force usage of a specific rolish color scheme
3170: bgcolor -> override the default page bgcolor
3171:
3172: =back
3173:
3174: =cut
3175:
1.343 albertel 3176: sub standard_css {
1.345 albertel 3177: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 3178: $function = &get_users_function() if (!$function);
3179: my $img = &designparm($function.'.img', $domain);
3180: my $tabbg = &designparm($function.'.tabbg', $domain);
3181: my $font = &designparm($function.'.font', $domain);
1.345 albertel 3182: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 3183: my $pgbg_or_bgcolor =
3184: $bgcolor ||
1.352 albertel 3185: &designparm($function.'.pgbg', $domain);
1.382 albertel 3186: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 3187: my $alink = &designparm($function.'.alink', $domain);
3188: my $vlink = &designparm($function.'.vlink', $domain);
3189: my $link = &designparm($function.'.link', $domain);
3190:
3191: my $sans = 'Arial,Helvetica,sans-serif';
1.395 albertel 3192: my $mono = 'monospace';
1.352 albertel 3193: my $data_table_head = $tabbg;
3194: my $data_table_light = '#EEEEEE';
3195: my $data_table_dark = '#DDD';
1.424 albertel 3196: my $data_table_darker = '#CCC';
1.349 albertel 3197: my $data_table_highlight = '#FFFF00';
1.352 albertel 3198: my $mail_new = '#FFBB77';
3199: my $mail_new_hover = '#DD9955';
3200: my $mail_read = '#BBBB77';
3201: my $mail_read_hover = '#999944';
3202: my $mail_replied = '#AAAA88';
3203: my $mail_replied_hover = '#888855';
3204: my $mail_other = '#99BBBB';
3205: my $mail_other_hover = '#669999';
1.391 albertel 3206: my $table_header = '#DDDDDD';
1.392 albertel 3207:
3208: my $border = ($env{'browser.type'} eq 'explorer') ? '0px 2px 0px 2px'
3209: : '0px 3px 0px 4px';
1.448 albertel 3210:
1.343 albertel 3211: return <<END;
1.345 albertel 3212: h1, h2, h3, th { font-family: $sans }
1.343 albertel 3213: a:focus { color: red; background: yellow }
3214: table.thinborder { border-collapse: collapse; }
1.426 albertel 3215: table.thinborder tr th { border-style: solid; border-width: 1px; background: $tabbg;}
3216: table.thinborder tr td { border-style: solid; border-width: 1px}
3217:
1.343 albertel 3218: form, .inline { display: inline; }
3219: .center { text-align: center; }
1.395 albertel 3220: .LC_filename {font-family: $mono;}
1.350 albertel 3221: .LC_error {
3222: color: red;
3223: font-size: larger;
3224: }
1.457 albertel 3225: .LC_warning,
3226: .LC_diff_removed {
1.394 albertel 3227: color: red;
3228: }
1.457 albertel 3229: .LC_success,
3230: .LC_diff_added {
1.350 albertel 3231: color: green;
3232: }
1.440 albertel 3233: .LC_icon {
3234: border: 0px;
3235: }
1.346 albertel 3236:
1.458 albertel 3237: table.LC_pastsubmission {
3238: border: 1px solid black;
3239: margin: 2px;
3240: }
3241:
1.392 albertel 3242: table#LC_top_nav, table#LC_menubuttons {
1.345 albertel 3243: width: 100%;
3244: background: $pgbg;
1.392 albertel 3245: border: 2px;
1.402 albertel 3246: border-collapse: separate;
1.403 albertel 3247: padding: 0px;
1.345 albertel 3248: }
1.392 albertel 3249:
1.409 albertel 3250: table#LC_title_bar, table.LC_breadcrumbs, table#LC_nav_location,
1.393 albertel 3251: table#LC_title_bar.LC_with_remote {
1.359 albertel 3252: width: 100%;
1.392 albertel 3253: border-color: $pgbg;
3254: border-style: solid;
3255: border-width: $border;
3256:
1.379 albertel 3257: background: $pgbg;
3258: font-family: $sans;
1.392 albertel 3259: border-collapse: collapse;
1.403 albertel 3260: padding: 0px;
1.359 albertel 3261: }
1.392 albertel 3262:
1.409 albertel 3263: table.LC_docs_path {
3264: width: 100%;
3265: border: 0;
3266: background: $pgbg;
3267: font-family: $sans;
3268: border-collapse: collapse;
3269: padding: 0px;
3270: }
3271:
1.359 albertel 3272: table#LC_title_bar td {
3273: background: $tabbg;
3274: }
3275: table#LC_title_bar td.LC_title_bar_who {
3276: background: $tabbg;
3277: color: $font;
1.427 albertel 3278: font: small $sans;
1.359 albertel 3279: text-align: right;
3280: }
3281: span.LC_title_bar_title {
1.416 albertel 3282: font: bold x-large $sans;
1.359 albertel 3283: }
3284: table#LC_title_bar td.LC_title_bar_domain_logo {
3285: background: $sidebg;
3286: text-align: right;
1.368 albertel 3287: padding: 0px;
3288: }
3289: table#LC_title_bar td.LC_title_bar_role_logo {
3290: background: $sidebg;
3291: padding: 0px;
1.359 albertel 3292: }
3293:
1.346 albertel 3294: table#LC_menubuttons_mainmenu {
3295: background: $pgbg;
3296: border: 0px;
3297: border-spacing: 1px;
1.372 albertel 3298: padding: 0px 1px;
1.346 albertel 3299: margin: 0px;
3300: border-collapse: separate;
3301: }
3302: table#LC_menubuttons img, table#LC_menubuttons_mainmenu img {
3303: border: 0px;
3304: }
1.345 albertel 3305: table#LC_top_nav td {
3306: background: $tabbg;
1.392 albertel 3307: border: 0px;
1.407 albertel 3308: font-size: small;
1.345 albertel 3309: }
3310: table#LC_top_nav td a, div#LC_top_nav a {
3311: color: $font;
3312: font-family: $sans;
3313: }
1.364 albertel 3314: table#LC_top_nav td.LC_top_nav_logo {
3315: background: $tabbg;
1.432 albertel 3316: text-align: left;
1.408 albertel 3317: white-space: nowrap;
1.432 albertel 3318: width: 31px;
1.408 albertel 3319: }
3320: table#LC_top_nav td.LC_top_nav_logo img {
1.432 albertel 3321: border: 0px;
1.408 albertel 3322: vertical-align: bottom;
1.364 albertel 3323: }
1.432 albertel 3324: table#LC_top_nav td.LC_top_nav_exit,
3325: table#LC_top_nav td.LC_top_nav_help {
3326: width: 2.0em;
3327: }
1.442 albertel 3328: table#LC_top_nav td.LC_top_nav_login {
3329: width: 4.0em;
3330: text-align: center;
3331: }
1.409 albertel 3332: table.LC_breadcrumbs td, table.LC_docs_path td {
1.357 albertel 3333: background: $tabbg;
3334: color: $font;
3335: font-family: $sans;
1.358 albertel 3336: font-size: smaller;
1.357 albertel 3337: }
1.411 albertel 3338: table.LC_breadcrumbs td.LC_breadcrumbs_component,
1.409 albertel 3339: table.LC_docs_path td.LC_docs_path_component {
1.357 albertel 3340: background: $tabbg;
3341: color: $font;
3342: font-family: $sans;
3343: font-size: larger;
3344: text-align: right;
3345: }
1.383 albertel 3346: td.LC_table_cell_checkbox {
3347: text-align: center;
3348: }
3349:
1.346 albertel 3350: .LC_menubuttons_inline_text {
3351: color: $font;
3352: font-family: $sans;
3353: font-size: smaller;
3354: }
3355:
3356: td.LC_menubuttons_text {
3357: color: $font;
3358: font-family: $sans;
3359: }
3360: td.LC_menubuttons_img {
3361: background: $tabbg;
3362: }
3363: .LC_current_location {
3364: font-family: $sans;
3365: background: $tabbg;
3366: }
3367: .LC_new_mail {
3368: font-family: $sans;
3369: font-weight: bold;
3370: }
1.347 albertel 3371:
1.440 albertel 3372: table.LC_aboutme_port {
3373: border: 0px;
3374: border-collapse: collapse;
3375: border-spacing: 0px;
3376: }
1.349 albertel 3377: table.LC_data_table, table.LC_mail_list {
1.347 albertel 3378: border: 1px solid #000000;
1.402 albertel 3379: border-collapse: separate;
1.426 albertel 3380: border-spacing: 1px;
1.347 albertel 3381: }
1.422 albertel 3382: .LC_data_table_dense {
3383: font-size: small;
3384: }
1.349 albertel 3385: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th {
3386: font-weight: bold;
3387: background-color: $data_table_head;
1.421 albertel 3388: font-size: smaller;
1.347 albertel 3389: }
1.440 albertel 3390: table.LC_data_table tr td,
3391: table.LC_aboutme_port tr td {
1.349 albertel 3392: background-color: $data_table_light;
1.425 albertel 3393: padding: 2px;
1.347 albertel 3394: }
1.440 albertel 3395: table.LC_data_table tr.LC_even_row td,
3396: table.LC_aboutme_port tr.LC_even_row td {
1.349 albertel 3397: background-color: $data_table_dark;
1.347 albertel 3398: }
1.425 albertel 3399: table.LC_data_table tr.LC_data_table_highlight td {
3400: background-color: $data_table_darker;
3401: }
1.451 albertel 3402: table.LC_data_table tr.LC_empty_row td,
1.452 albertel 3403: table.LC_whatsnew tr.LC_empty_row td {
1.347 albertel 3404: background-color: #FFFFFF;
1.421 albertel 3405: font-weight: bold;
3406: font-style: italic;
3407: text-align: center;
3408: padding: 8px;
1.347 albertel 3409: }
1.465 albertel 3410: table.LC_whatsnew tr.LC_empty_row td {
3411: padding: 4ex
3412: }
3413:
1.347 albertel 3414:
1.451 albertel 3415: table.LC_whatsnew {
3416: }
3417:
3418: table.LC_whatsnew tr th,
3419: table.LC_whatsnew tr.LC_info_row td {
3420: background-color: #CCC;
3421: font-weight: bold;
3422: font-size: small;
3423: text-align: right;
3424: }
3425: table.LC_whatsnew tr td {
3426: background-color: #FFF;
3427: font-size: small;
3428: text-align: right;
3429: }
3430: table.LC_whatsnew tr td.LC_first_item {
3431: text-align: left;
3432: }
3433:
3434: table.LC_whatsnew tr.LC_odd_row td {
3435: background-color: #EEE;
3436: }
3437:
1.349 albertel 3438: table.LC_calendar {
3439: border: 1px solid #000000;
3440: border-collapse: collapse;
3441: }
3442: table.LC_calendar_pickdate {
3443: font-size: xx-small;
3444: }
3445: table.LC_calendar tr td {
3446: border: 1px solid #000000;
3447: vertical-align: top;
3448: }
3449: table.LC_calendar tr td.LC_calendar_day_empty {
3450: background-color: $data_table_dark;
3451: }
3452: table.LC_calendar tr td.LC_calendar_day_current {
3453: background-color: $data_table_highlight;
3454: }
3455:
3456: table.LC_mail_list tr.LC_mail_new {
3457: background-color: $mail_new;
3458: }
3459: table.LC_mail_list tr.LC_mail_new:hover {
3460: background-color: $mail_new_hover;
3461: }
3462: table.LC_mail_list tr.LC_mail_read {
3463: background-color: $mail_read;
3464: }
3465: table.LC_mail_list tr.LC_mail_read:hover {
3466: background-color: $mail_read_hover;
3467: }
3468: table.LC_mail_list tr.LC_mail_replied {
3469: background-color: $mail_replied;
3470: }
3471: table.LC_mail_list tr.LC_mail_replied:hover {
3472: background-color: $mail_replied_hover;
3473: }
3474: table.LC_mail_list tr.LC_mail_other {
3475: background-color: $mail_other;
3476: }
3477: table.LC_mail_list tr.LC_mail_other:hover {
3478: background-color: $mail_other_hover;
3479: }
1.385 albertel 3480:
1.386 albertel 3481: table#LC_portfolio_actions {
3482: width: auto;
3483: background: $pgbg;
3484: border: 0px;
3485: border-spacing: 2px 2px;
3486: padding: 0px;
3487: margin: 0px;
3488: border-collapse: separate;
3489: }
3490: table#LC_portfolio_actions td.LC_label {
3491: background: $tabbg;
3492: text-align: right;
3493: }
3494: table#LC_portfolio_actions td.LC_value {
3495: background: $tabbg;
3496: }
1.385 albertel 3497:
1.391 albertel 3498: table#LC_cstr_controls {
3499: width: 100%;
3500: border-collapse: collapse;
3501: }
3502: table#LC_cstr_controls tr td {
3503: border: 4px solid $pgbg;
3504: padding: 4px;
3505: text-align: center;
3506: background: $tabbg;
3507: }
3508: table#LC_cstr_controls tr th {
3509: border: 4px solid $pgbg;
3510: background: $table_header;
3511: text-align: center;
3512: font-family: $sans;
3513: font-size: smaller;
3514: }
3515:
1.389 albertel 3516: table#LC_browser {
3517:
3518: }
3519: table#LC_browser tr th {
1.391 albertel 3520: background: $table_header;
1.389 albertel 3521: }
1.390 albertel 3522: table#LC_browser tr td {
3523: padding: 2px;
3524: }
1.389 albertel 3525: table#LC_browser tr.LC_browser_file,
3526: table#LC_browser tr.LC_browser_file_published {
3527: background: #CCFF88;
3528: }
3529: table#LC_browser tr.LC_browser_file_locked,
3530: table#LC_browser tr.LC_browser_file_unpublished {
3531: background: #FFAA99;
1.387 albertel 3532: }
1.389 albertel 3533: table#LC_browser tr.LC_browser_file_obsolete {
3534: background: #AAAAAA;
1.387 albertel 3535: }
1.455 albertel 3536: table#LC_browser tr.LC_browser_file_modified,
3537: table#LC_browser tr.LC_browser_file_metamodified {
1.389 albertel 3538: background: #FFFF77;
1.387 albertel 3539: }
1.389 albertel 3540: table#LC_browser tr.LC_browser_folder {
3541: background: #CCCCFF;
1.387 albertel 3542: }
1.388 albertel 3543: span.LC_current_location {
3544: font-size: x-large;
3545: background: $pgbg;
3546: }
1.387 albertel 3547:
1.395 albertel 3548: span.LC_parm_menu_item {
3549: font-size: larger;
3550: font-family: $sans;
3551: }
3552: span.LC_parm_scope_all {
3553: color: red;
3554: }
3555: span.LC_parm_scope_folder {
3556: color: green;
3557: }
3558: span.LC_parm_scope_resource {
3559: color: orange;
3560: }
3561: span.LC_parm_part {
3562: color: blue;
3563: }
3564: span.LC_parm_folder, span.LC_parm_symb {
3565: font-size: x-small;
3566: font-family: $mono;
3567: color: #AAAAAA;
3568: }
3569:
1.396 albertel 3570: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
3571: td.LC_parm_overview_parm_selectors, td.LC_parm_overview_parm_restrictions {
3572: border: 1px solid black;
3573: border-collapse: collapse;
3574: }
3575: table.LC_parm_overview_restrictions td {
3576: border-width: 1px 4px 1px 4px;
3577: border-style: solid;
3578: border-color: $pgbg;
3579: text-align: center;
3580: }
3581: table.LC_parm_overview_restrictions th {
3582: background: $tabbg;
3583: border-width: 1px 4px 1px 4px;
3584: border-style: solid;
3585: border-color: $pgbg;
3586: }
1.398 albertel 3587: table#LC_helpmenu {
3588: border: 0px;
3589: height: 55px;
3590: border-spacing: 0px;
3591: }
3592:
3593: table#LC_helpmenu fieldset legend {
3594: font-size: larger;
3595: font-weight: bold;
3596: }
1.397 albertel 3597: table#LC_helpmenu_links {
3598: width: 100%;
3599: border: 1px solid black;
3600: background: $pgbg;
3601: padding: 0px;
3602: border-spacing: 1px;
3603: }
3604: table#LC_helpmenu_links tr td {
3605: padding: 1px;
3606: background: $tabbg;
1.399 albertel 3607: text-align: center;
3608: font-weight: bold;
1.397 albertel 3609: }
1.396 albertel 3610:
1.397 albertel 3611: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
3612: table#LC_helpmenu_links a:active {
3613: text-decoration: none;
3614: color: $font;
3615: }
3616: table#LC_helpmenu_links a:hover {
3617: text-decoration: underline;
3618: color: $vlink;
3619: }
1.396 albertel 3620:
1.417 albertel 3621: .LC_chrt_popup_exists {
3622: border: 1px solid #339933;
3623: margin: -1px;
3624: }
3625: .LC_chrt_popup_up {
3626: border: 1px solid yellow;
3627: margin: -1px;
3628: }
3629: .LC_chrt_popup {
3630: border: 1px solid #8888FF;
3631: background: #CCCCFF;
3632: }
3633:
1.421 albertel 3634: table.LC_pick_box {
3635: width: 100%;
3636: border-collapse: separate;
3637: background: white;
3638: border: 1px solid black;
3639: border-spacing: 1px;
3640: }
3641: table.LC_pick_box td.LC_pick_box_title {
3642: background: $tabbg;
3643: font-weight: bold;
3644: text-align: right;
3645: width: 184px;
3646: padding: 8px;
3647: }
1.424 albertel 3648: table.LC_pick_box td.LC_pick_box_separator {
1.421 albertel 3649: padding: 0px;
3650: height: 1px;
3651: background: black;
3652: }
3653: table.LC_pick_box td.LC_pick_box_submit {
3654: text-align: right;
3655: }
3656:
1.424 albertel 3657: table.LC_group_priv_box {
3658: background: white;
3659: border: 1px solid black;
3660: border-spacing: 1px;
3661: }
3662: table.LC_group_priv_box td.LC_pick_box_title {
3663: background: $tabbg;
3664: font-weight: bold;
3665: text-align: right;
3666: width: 184px;
3667: }
3668: table.LC_group_priv_box td.LC_groups_fixed {
3669: background: $data_table_light;
3670: text-align: center;
3671: }
3672: table.LC_group_priv_box td.LC_groups_optional {
3673: background: $data_table_dark;
3674: text-align: center;
3675: }
3676: table.LC_group_priv_box td.LC_groups_functionality {
3677: background: $data_table_darker;
3678: text-align: center;
3679: font-weight: bold;
3680: }
3681: table.LC_group_priv td {
3682: text-align: left;
3683: padding: 0px;
3684: }
3685:
1.421 albertel 3686: table.LC_notify_front_page {
3687: background: white;
3688: border: 1px solid black;
3689: padding: 8px;
3690: }
3691: table.LC_notify_front_page td {
3692: padding: 8px;
3693: }
1.424 albertel 3694: .LC_navbuttons {
3695: margin: 2ex 0ex 2ex 0ex;
3696: }
1.423 albertel 3697: .LC_topic_bar {
3698: font-family: $sans;
3699: font-weight: bold;
3700: width: 100%;
3701: background: $tabbg;
3702: vertical-align: middle;
3703: margin: 2ex 0ex 2ex 0ex;
3704: }
3705: .LC_topic_bar span {
3706: vertical-align: middle;
3707: }
3708: .LC_topic_bar img {
3709: vertical-align: bottom;
3710: }
3711: table.LC_course_group_status {
3712: margin: 20px;
3713: }
3714: table.LC_status_selector td {
3715: vertical-align: top;
3716: text-align: center;
1.424 albertel 3717: padding: 4px;
3718: }
3719: table.LC_descriptive_input td.LC_description {
3720: vertical-align: top;
3721: text-align: right;
3722: font-weight: bold;
1.423 albertel 3723: }
1.421 albertel 3724:
1.343 albertel 3725: END
3726: }
3727:
1.306 albertel 3728: =pod
3729:
3730: =over 4
3731:
3732: =item * &headtag()
3733:
3734: Returns a uniform footer for LON-CAPA web pages.
3735:
1.307 albertel 3736: Inputs: $title - optional title for the head
3737: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 3738: $args - optional arguments
1.319 albertel 3739: force_register - if is true call registerurl so the remote is
3740: informed
1.415 albertel 3741: redirect -> array ref of
3742: 1- seconds before redirect occurs
3743: 2- url to redirect to
3744: 3- whether the side effect should occur
1.315 albertel 3745: (side effect of setting
3746: $env{'internal.head.redirect'} to the url
3747: redirected too)
1.352 albertel 3748: domain -> force to color decorate a page for a specific
3749: domain
3750: function -> force usage of a specific rolish color scheme
3751: bgcolor -> override the default page bgcolor
1.460 albertel 3752: no_auto_mt_title
3753: -> prevent &mt()ing the title arg
1.464 albertel 3754:
1.306 albertel 3755: =back
3756:
3757: =cut
3758:
3759: sub headtag {
1.313 albertel 3760: my ($title,$head_extra,$args) = @_;
1.306 albertel 3761:
1.363 albertel 3762: my $function = $args->{'function'} || &get_users_function();
3763: my $domain = $args->{'domain'} || &determinedomain();
3764: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 3765: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 3766: $Apache::lonnet::perlvar{'lonVersion'},
1.418 albertel 3767: #time(),
3768: $env{'environment.color.timestamp'},
1.363 albertel 3769: $function,$domain,$bgcolor);
3770:
1.369 www 3771: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 3772:
1.308 albertel 3773: my $result =
3774: '<head>'.
1.461 albertel 3775: &font_settings();
1.319 albertel 3776:
1.461 albertel 3777: if (!$args->{'frameset'}) {
3778: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
3779: }
1.319 albertel 3780: if ($args->{'force_register'}) {
3781: $result .= &Apache::lonmenu::registerurl(1);
3782: }
1.436 albertel 3783: if (!$args->{'no_nav_bar'}
3784: && !$args->{'only_body'}
3785: && !$args->{'frameset'}) {
3786: $result .= &help_menu_js();
3787: }
1.319 albertel 3788:
1.314 albertel 3789: if (ref($args->{'redirect'})) {
1.414 albertel 3790: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 3791: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 3792: if (!$inhibit_continue) {
3793: $env{'internal.head.redirect'} = $url;
3794: }
1.313 albertel 3795: $result.=<<ADDMETA
3796: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 3797: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 3798: ADDMETA
3799: }
1.306 albertel 3800: if (!defined($title)) {
3801: $title = 'The LearningOnline Network with CAPA';
3802: }
1.460 albertel 3803: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
3804: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 3805: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
3806: .$head_extra;
1.306 albertel 3807: return $result;
3808: }
3809:
3810: =pod
3811:
3812: =over 4
3813:
1.340 albertel 3814: =item * &font_settings()
3815:
3816: Returns neccessary <meta> to set the proper encoding
3817:
3818: Inputs: none
3819:
3820: =back
3821:
3822: =cut
3823:
3824: sub font_settings {
3825: my $headerstring='';
3826: if (($env{'browser.os'} eq 'mac') && (!$env{'browser.mathml'})) {
3827: $headerstring.=
3828: '<meta Content-Type="text/html; charset=x-mac-roman" />';
3829: } elsif (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
3830: $headerstring.=
3831: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
3832: }
3833: return $headerstring;
3834: }
3835:
1.341 albertel 3836: =pod
3837:
3838: =over 4
3839:
3840: =item * &xml_begin()
3841:
3842: Returns the needed doctype and <html>
3843:
3844: Inputs: none
3845:
3846: =back
3847:
3848: =cut
3849:
3850: sub xml_begin {
3851: my $output='';
3852:
1.342 albertel 3853: &Apache::lonhtmlcommon::init_htmlareafields();
3854:
1.341 albertel 3855: if ($env{'browser.mathml'}) {
3856: $output='<?xml version="1.0"?>'
3857: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
3858: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
3859:
3860: # .'<!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">] >'
3861: .'<!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">'
3862: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
3863: .'xmlns="http://www.w3.org/1999/xhtml">';
3864: } else {
3865: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
3866: }
3867: return $output;
3868: }
1.340 albertel 3869:
3870: =pod
3871:
3872: =over 4
3873:
1.306 albertel 3874: =item * &endheadtag()
3875:
3876: Returns a uniform </head> for LON-CAPA web pages.
3877:
3878: Inputs: none
3879:
3880: =back
3881:
3882: =cut
3883:
3884: sub endheadtag {
3885: return '</head>';
3886: }
3887:
3888: =pod
3889:
3890: =over 4
3891:
3892: =item * &head()
3893:
3894: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
3895:
3896: Inputs: $title - optional title for the page
1.307 albertel 3897: $head_extra - optional extra HTML to put inside the <head>
1.405 albertel 3898:
1.306 albertel 3899: =back
3900:
3901: =cut
3902:
3903: sub head {
1.325 albertel 3904: my ($title,$head_extra,$args) = @_;
3905: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 3906: }
3907:
3908: =pod
3909:
3910: =over 4
3911:
3912: =item * &start_page()
3913:
3914: Returns a complete <html> .. <body> section for LON-CAPA web pages.
3915:
3916: Inputs: $title - optional title for the page
3917: $head_extra - optional extra HTML to incude inside the <head>
1.315 albertel 3918: $args - additional optional args supported are:
1.317 albertel 3919: only_body -> is true will set &bodytag() onlybodytag
3920: arg on
3921: no_nav_bar -> is true will set &bodytag() notopbar arg on
3922: add_entries -> additional attributes to add to the <body>
3923: domain -> force to color decorate a page for a
3924: specific domain
3925: function -> force usage of a specific rolish color
3926: scheme
3927: redirect -> see &headtag()
3928: bgcolor -> override the default page bg color
3929: js_ready -> return a string ready for being used in
3930: a javascript writeln
1.320 albertel 3931: html_encode -> return a string ready for being used in
3932: a html attribute
1.317 albertel 3933: force_register -> if is true will turn on the &bodytag()
3934: $forcereg arg
1.326 albertel 3935: body_title -> alternate text to use instead of $title
3936: in the title box that appears, this text
3937: is not auto translated like the $title is
1.330 albertel 3938: frameset -> if true will start with a <frameset>
3939: rather than <body>
1.338 albertel 3940: no_title -> if true the title bar won't be shown
3941: skip_phases -> hash ref of
3942: head -> skip the <html><head> generation
3943: body -> skip all <body> generation
1.337 albertel 3944:
1.361 albertel 3945: no_inline_link -> if true and in remote mode, don't show the
3946: 'Switch To Inline Menu' link
3947:
1.460 albertel 3948: no_auto_mt_title -> prevent &mt()ing the title arg
3949:
1.306 albertel 3950: =back
3951:
3952: =cut
3953:
3954: sub start_page {
1.309 albertel 3955: my ($title,$head_extra,$args) = @_;
1.318 albertel 3956: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 3957: my %head_args;
1.352 albertel 3958: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 3959: 'bgcolor','frameset','no_nav_bar','only_body',
3960: 'no_auto_mt_title') {
1.319 albertel 3961: if (defined($args->{$arg})) {
1.324 raeburn 3962: $head_args{$arg} = $args->{$arg};
1.319 albertel 3963: }
1.313 albertel 3964: }
1.319 albertel 3965:
1.315 albertel 3966: $env{'internal.start_page'}++;
1.338 albertel 3967: my $result;
3968: if (! exists($args->{'skip_phases'}{'head'}) ) {
3969: $result.=
1.341 albertel 3970: &xml_begin().
1.338 albertel 3971: &headtag($title,$head_extra,\%head_args).&endheadtag();
3972: }
3973:
3974: if (! exists($args->{'skip_phases'}{'body'}) ) {
3975: if ($args->{'frameset'}) {
3976: my $attr_string = &make_attr_string($args->{'force_register'},
3977: $args->{'add_entries'});
3978: $result .= "\n<frameset $attr_string>\n";
3979: } else {
3980: $result .=
3981: &bodytag($title,
3982: $args->{'function'}, $args->{'add_entries'},
3983: $args->{'only_body'}, $args->{'domain'},
3984: $args->{'force_register'}, $args->{'body_title'},
3985: $args->{'no_nav_bar'}, $args->{'bgcolor'},
1.460 albertel 3986: $args->{'no_title'}, $args->{'no_inline_link'},
3987: $args);
1.338 albertel 3988: }
1.330 albertel 3989: }
1.338 albertel 3990:
1.315 albertel 3991: if ($args->{'js_ready'}) {
1.317 albertel 3992: $result = &js_ready($result);
1.315 albertel 3993: }
1.320 albertel 3994: if ($args->{'html_encode'}) {
3995: $result = &html_encode($result);
3996: }
1.315 albertel 3997: return $result;
1.306 albertel 3998: }
3999:
1.330 albertel 4000:
1.306 albertel 4001: =pod
4002:
4003: =over 4
4004:
4005: =item * &head()
4006:
4007: Returns a complete </body></html> section for LON-CAPA web pages.
4008:
1.315 albertel 4009: Inputs: $args - additional optional args supported are:
4010: js_ready -> return a string ready for being used in
4011: a javascript writeln
1.320 albertel 4012: html_encode -> return a string ready for being used in
4013: a html attribute
1.330 albertel 4014: frameset -> if true will start with a <frameset>
4015: rather than <body>
1.306 albertel 4016:
4017: =cut
4018:
4019: sub end_page {
1.315 albertel 4020: my ($args) = @_;
4021: $env{'internal.end_page'}++;
1.330 albertel 4022: my $result;
1.335 albertel 4023: if ($args->{'discussion'}) {
4024: my ($target,$parser);
4025: if (ref($args->{'discussion'})) {
4026: ($target,$parser) =($args->{'discussion'}{'target'},
4027: $args->{'discussion'}{'parser'});
4028: }
4029: $result .= &Apache::lonxml::xmlend($target,$parser);
4030: }
4031:
1.330 albertel 4032: if ($args->{'frameset'}) {
4033: $result .= '</frameset>';
4034: } else {
4035: $result .= &endbodytag();
4036: }
4037: $result .= "\n</html>";
4038:
1.315 albertel 4039: if ($args->{'js_ready'}) {
1.317 albertel 4040: $result = &js_ready($result);
1.315 albertel 4041: }
1.335 albertel 4042:
1.320 albertel 4043: if ($args->{'html_encode'}) {
4044: $result = &html_encode($result);
4045: }
1.335 albertel 4046:
1.315 albertel 4047: return $result;
4048: }
4049:
1.320 albertel 4050: sub html_encode {
4051: my ($result) = @_;
4052:
1.322 albertel 4053: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 4054:
4055: return $result;
4056: }
1.317 albertel 4057: sub js_ready {
4058: my ($result) = @_;
4059:
1.323 albertel 4060: $result =~ s/[\n\r]/ /xmsg;
4061: $result =~ s/\\/\\\\/xmsg;
4062: $result =~ s/'/\\'/xmsg;
1.372 albertel 4063: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 4064:
4065: return $result;
4066: }
4067:
1.315 albertel 4068: sub validate_page {
4069: if ( exists($env{'internal.start_page'})
1.316 albertel 4070: && $env{'internal.start_page'} > 1) {
4071: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 4072: $env{'internal.start_page'}.' '.
1.316 albertel 4073: $ENV{'request.filename'});
1.315 albertel 4074: }
4075: if ( exists($env{'internal.end_page'})
1.316 albertel 4076: && $env{'internal.end_page'} > 1) {
4077: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 4078: $env{'internal.end_page'}.' '.
1.316 albertel 4079: $env{'request.filename'});
1.315 albertel 4080: }
4081: if ( exists($env{'internal.start_page'})
4082: && ! exists($env{'internal.end_page'})) {
1.316 albertel 4083: &Apache::lonnet::logthis('start_page called without end_page '.
4084: $env{'request.filename'});
1.315 albertel 4085: }
4086: if ( ! exists($env{'internal.start_page'})
4087: && exists($env{'internal.end_page'})) {
1.316 albertel 4088: &Apache::lonnet::logthis('end_page called without start_page'.
4089: $env{'request.filename'});
1.315 albertel 4090: }
1.306 albertel 4091: }
1.315 albertel 4092:
1.318 albertel 4093: sub simple_error_page {
4094: my ($r,$title,$msg) = @_;
4095: my $page =
4096: &Apache::loncommon::start_page($title).
4097: &mt($msg).
4098: &Apache::loncommon::end_page();
4099: if (ref($r)) {
4100: $r->print($page);
1.327 albertel 4101: return;
1.318 albertel 4102: }
4103: return $page;
4104: }
1.347 albertel 4105:
4106: {
4107: my $row_count;
4108: sub start_data_table {
1.422 albertel 4109: my ($add_class) = @_;
4110: my $css_class = (join(' ','LC_data_table',$add_class));
1.347 albertel 4111: undef($row_count);
1.422 albertel 4112: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 4113: }
4114:
4115: sub end_data_table {
4116: undef($row_count);
1.389 albertel 4117: return '</table>'."\n";;
1.347 albertel 4118: }
4119:
4120: sub start_data_table_row {
1.422 albertel 4121: my ($add_class) = @_;
1.347 albertel 4122: $row_count++;
1.422 albertel 4123: my $css_class = ($row_count % 2)?'':'LC_even_row';
1.428 albertel 4124: $css_class = (join(' ',$css_class,$add_class));
1.422 albertel 4125: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 4126: }
4127:
4128: sub end_data_table_row {
1.389 albertel 4129: return '</tr>'."\n";;
1.347 albertel 4130: }
1.367 www 4131:
1.421 albertel 4132: sub start_data_table_empty_row {
4133: $row_count++;
4134: return '<tr class="LC_empty_row" >'."\n";;
4135: }
4136:
4137: sub end_data_table_empty_row {
4138: return '</tr>'."\n";;
4139: }
4140:
1.367 www 4141: sub start_data_table_header_row {
1.389 albertel 4142: return '<tr class="LC_header_row">'."\n";;
1.367 www 4143: }
4144:
4145: sub end_data_table_header_row {
1.389 albertel 4146: return '</tr>'."\n";;
1.367 www 4147: }
1.347 albertel 4148: }
4149:
1.251 albertel 4150: ###############################################
1.182 matthew 4151:
4152: =pod
4153:
1.405 albertel 4154: =item * &get_users_function()
1.182 matthew 4155:
4156: Used by &bodytag to determine the current users primary role.
4157: Returns either 'student','coordinator','admin', or 'author'.
4158:
4159: =cut
4160:
4161: ###############################################
4162: sub get_users_function {
4163: my $function = 'student';
1.258 albertel 4164: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182 matthew 4165: $function='coordinator';
4166: }
1.258 albertel 4167: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 4168: $function='admin';
4169: }
1.258 albertel 4170: if (($env{'request.role'}=~/^(au|ca)/) ||
1.182 matthew 4171: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
4172: $function='author';
4173: }
4174: return $function;
1.54 www 4175: }
1.99 www 4176:
4177: ###############################################
4178:
1.233 raeburn 4179: =pod
4180:
1.405 albertel 4181: =item * &check_user_status
1.274 raeburn 4182:
4183: Determines current status of supplied role for a
4184: specific user. Roles can be active, previous or future.
4185:
4186: Inputs:
4187: user's domain, user's username, course's domain,
1.375 raeburn 4188: course's number, optional section ID.
1.274 raeburn 4189:
4190: Outputs:
4191: role status: active, previous or future.
4192:
4193: =cut
4194:
4195: sub check_user_status {
1.412 raeburn 4196: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 4197: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
4198: my @uroles = keys %userinfo;
4199: my $srchstr;
4200: my $active_chk = 'none';
1.412 raeburn 4201: my $now = time;
1.274 raeburn 4202: if (@uroles > 0) {
1.412 raeburn 4203: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 4204: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
4205: } else {
1.412 raeburn 4206: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
4207: }
4208: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 4209: my $role_end = 0;
4210: my $role_start = 0;
4211: $active_chk = 'active';
1.412 raeburn 4212: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
4213: $role_end = $1;
4214: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
4215: $role_start = $1;
1.274 raeburn 4216: }
4217: }
4218: if ($role_start > 0) {
1.412 raeburn 4219: if ($now < $role_start) {
1.274 raeburn 4220: $active_chk = 'future';
4221: }
4222: }
4223: if ($role_end > 0) {
1.412 raeburn 4224: if ($now > $role_end) {
1.274 raeburn 4225: $active_chk = 'previous';
4226: }
4227: }
4228: }
4229: }
4230: return $active_chk;
4231: }
4232:
4233: ###############################################
4234:
4235: =pod
4236:
1.405 albertel 4237: =item * &get_sections()
1.233 raeburn 4238:
4239: Determines all the sections for a course including
4240: sections with students and sections containing other roles.
1.419 raeburn 4241: Incoming parameters:
4242:
4243: 1. domain
4244: 2. course number
4245: 3. reference to array containing roles for which sections should
4246: be gathered (optional).
4247: 4. reference to array containing status types for which sections
4248: should be gathered (optional).
4249:
4250: If the third argument is undefined, sections are gathered for any role.
4251: If the fourth argument is undefined, sections are gathered for any status.
4252: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 4253:
1.374 raeburn 4254: Returns section hash (keys are section IDs, values are
4255: number of users in each section), subject to the
1.419 raeburn 4256: optional roles filter, optional status filter
1.233 raeburn 4257:
4258: =cut
4259:
4260: ###############################################
4261: sub get_sections {
1.419 raeburn 4262: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 4263: if (!defined($cdom) || !defined($cnum)) {
4264: my $cid = $env{'request.course.id'};
4265:
4266: return if (!defined($cid));
4267:
4268: $cdom = $env{'course.'.$cid.'.domain'};
4269: $cnum = $env{'course.'.$cid.'.num'};
4270: }
4271:
4272: my %sectioncount;
1.419 raeburn 4273: my $now = time;
1.240 albertel 4274:
1.366 albertel 4275: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 4276: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 4277: my $sec_index = &Apache::loncoursedata::CL_SECTION();
4278: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 4279: my $start_index = &Apache::loncoursedata::CL_START();
4280: my $end_index = &Apache::loncoursedata::CL_END();
4281: my $status;
1.366 albertel 4282: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 4283: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
4284: $data->[$status_index],
4285: $data->[$start_index],
4286: $data->[$end_index]);
4287: if ($stu_status eq 'Active') {
4288: $status = 'active';
4289: } elsif ($end < $now) {
4290: $status = 'previous';
4291: } elsif ($start > $now) {
4292: $status = 'future';
4293: }
4294: if ($section ne '-1' && $section !~ /^\s*$/) {
4295: if ((!defined($possible_status)) || (($status ne '') &&
4296: (grep/^\Q$status\E$/,@{$possible_status}))) {
4297: $sectioncount{$section}++;
4298: }
1.240 albertel 4299: }
4300: }
4301: }
4302: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
4303: foreach my $user (sort(keys(%courseroles))) {
4304: if ($user !~ /^(\w{2})/) { next; }
4305: my ($role) = ($user =~ /^(\w{2})/);
4306: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 4307: my ($section,$status);
1.240 albertel 4308: if ($role eq 'cr' &&
4309: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
4310: $section=$1;
4311: }
4312: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
4313: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 4314: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
4315: if ($end == -1 && $start == -1) {
4316: next; #deleted role
4317: }
4318: if (!defined($possible_status)) {
4319: $sectioncount{$section}++;
4320: } else {
4321: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
4322: $status = 'active';
4323: } elsif ($end < $now) {
4324: $status = 'future';
4325: } elsif ($start > $now) {
4326: $status = 'previous';
4327: }
4328: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
4329: $sectioncount{$section}++;
4330: }
4331: }
1.233 raeburn 4332: }
1.366 albertel 4333: return %sectioncount;
1.233 raeburn 4334: }
4335:
1.274 raeburn 4336: ###############################################
1.294 raeburn 4337:
4338: =pod
1.405 albertel 4339:
4340: =item * &get_course_users()
4341:
1.275 raeburn 4342: Retrieves usernames:domains for users in the specified course
4343: with specific role(s), and access status.
4344:
4345: Incoming parameters:
1.277 albertel 4346: 1. course domain
4347: 2. course number
4348: 3. access status: users must have - either active,
1.275 raeburn 4349: previous, future, or all.
1.277 albertel 4350: 4. reference to array of permissible roles
1.288 raeburn 4351: 5. reference to array of section restrictions (optional)
4352: 6. reference to results object (hash of hashes).
4353: 7. reference to optional userdata hash
1.275 raeburn 4354: Keys of top level hash are roles.
4355: Keys of inner hashes are username:domain, with
4356: values set to access type.
1.288 raeburn 4357: Optional userdata hash returns an array with arguments in the
4358: same order as loncoursedata::get_classlist() for student data.
4359:
4360: Entries for end, start, section and status are blank because
4361: of the possibility of multiple values for non-student roles.
4362:
1.275 raeburn 4363: =cut
1.405 albertel 4364:
1.275 raeburn 4365: ###############################################
1.405 albertel 4366:
1.275 raeburn 4367: sub get_course_users {
1.288 raeburn 4368: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata) = @_;
4369: my %idx = ();
1.419 raeburn 4370: my %seclists;
1.288 raeburn 4371:
4372: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
4373: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
4374: $idx{end} = &Apache::loncoursedata::CL_END();
4375: $idx{start} = &Apache::loncoursedata::CL_START();
4376: $idx{id} = &Apache::loncoursedata::CL_ID();
4377: $idx{section} = &Apache::loncoursedata::CL_SECTION();
4378: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
4379: $idx{status} = &Apache::loncoursedata::CL_STATUS();
4380:
1.290 albertel 4381: if (grep(/^st$/,@{$roles})) {
1.276 albertel 4382: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 4383: my $now = time;
1.277 albertel 4384: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 4385: my $match = 0;
1.412 raeburn 4386: my $secmatch = 0;
1.419 raeburn 4387: my $section = $$classlist{$student}[$idx{section}];
4388: if ($section eq '') {
4389: $section = 'none';
4390: }
1.291 albertel 4391: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 4392: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 4393: $secmatch = 1;
4394: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 4395: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 4396: $secmatch = 1;
4397: }
4398: } else {
1.419 raeburn 4399: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 4400: $secmatch = 1;
4401: }
1.290 albertel 4402: }
1.412 raeburn 4403: if (!$secmatch) {
4404: next;
4405: }
1.419 raeburn 4406: }
1.420 albertel 4407: push(@{$seclists{$student}},$section);
1.275 raeburn 4408: if (defined($$types{'active'})) {
1.288 raeburn 4409: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 4410: push(@{$$users{st}{$student}},'active');
1.288 raeburn 4411: $match = 1;
1.275 raeburn 4412: }
4413: }
4414: if (defined($$types{'previous'})) {
1.288 raeburn 4415: if ($$classlist{$student}[$idx{end}] <= $now) {
1.275 raeburn 4416: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 4417: $match = 1;
1.275 raeburn 4418: }
4419: }
4420: if (defined($$types{'future'})) {
1.288 raeburn 4421: if (($$classlist{$student}[$idx{start}] > $now) && ($$classlist{$student}[$idx{end}] > $now) || ($$classlist{$student}[$idx{end}] == 0) || ($$classlist{$student}[$idx{end}] eq '')) {
1.275 raeburn 4422: push(@{$$users{st}{$student}},'future');
1.288 raeburn 4423: $match = 1;
1.275 raeburn 4424: }
4425: }
1.412 raeburn 4426: if ($match && ref($userdata) eq 'HASH') {
1.288 raeburn 4427: $$userdata{$student} = $$classlist{$student};
4428: }
1.275 raeburn 4429: }
4430: }
1.412 raeburn 4431: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 4432: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
4433: my $now = time;
4434: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 4435: my $match = 0;
1.412 raeburn 4436: my $secmatch = 0;
1.439 raeburn 4437: my $status;
1.412 raeburn 4438: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 4439: $user =~ s/:$//;
1.439 raeburn 4440: my ($end,$start) = split(/:/,$coursepersonnel{$person});
4441: if ($end == -1 || $start == -1) {
4442: next;
4443: }
4444: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
4445: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 4446: my ($uname,$udom) = split(/:/,$user);
4447: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 4448: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 4449: $secmatch = 1;
4450: } elsif ($usec eq '') {
1.420 albertel 4451: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 4452: $secmatch = 1;
4453: }
4454: } else {
4455: if (grep(/^\Q$usec\E$/,@{$sections})) {
4456: $secmatch = 1;
4457: }
4458: }
4459: if (!$secmatch) {
4460: next;
4461: }
1.288 raeburn 4462: }
1.419 raeburn 4463: if ($usec eq '') {
4464: $usec = 'none';
4465: }
1.275 raeburn 4466: if ($uname ne '' && $udom ne '') {
1.439 raeburn 4467: if ($end < $now) {
4468: $status = 'previous';
4469: } elsif ($start > $now) {
4470: $status = 'future';
4471: } else {
4472: $status = 'active';
4473: }
1.277 albertel 4474: foreach my $type (keys(%{$types})) {
1.275 raeburn 4475: if ($status eq $type) {
1.420 albertel 4476: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 4477: push(@{$$users{$role}{$user}},$type);
4478: }
1.288 raeburn 4479: $match = 1;
4480: }
4481: }
1.419 raeburn 4482: if (($match) && (ref($userdata) eq 'HASH')) {
4483: if (!exists($$userdata{$uname.':'.$udom})) {
4484: &get_user_info($udom,$uname,\%idx,$userdata);
4485: }
1.420 albertel 4486: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 4487: push(@{$seclists{$uname.':'.$udom}},$usec);
4488: }
1.275 raeburn 4489: }
4490: }
4491: }
4492: }
1.290 albertel 4493: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 4494: if ((defined($cdom)) && (defined($cnum))) {
4495: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
4496: if ( defined($csettings{'internal.courseowner'}) ) {
4497: my $owner = $csettings{'internal.courseowner'};
1.439 raeburn 4498: if ($owner !~ /^[^:]+:[^:]+$/) {
4499: $owner = $owner.':'.$cdom;
4500: }
4501: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 4502: if (defined($userdata) &&
4503: !exists($$userdata{$owner.':'.$cdom})) {
4504: &get_user_info($cdom,$owner,\%idx,$userdata);
1.420 albertel 4505: if (!grep(/^none$/,@{$seclists{$owner.':'.$cdom}})) {
1.419 raeburn 4506: push(@{$seclists{$owner.':'.$cdom}},'none');
4507: }
1.290 albertel 4508: }
1.279 raeburn 4509: }
4510: }
4511: }
1.419 raeburn 4512: foreach my $user (keys(%seclists)) {
4513: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
4514: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
4515: }
1.275 raeburn 4516: }
4517: return;
4518: }
4519:
1.288 raeburn 4520: sub get_user_info {
4521: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 4522: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
4523: &plainname($uname,$udom,'lastname');
1.291 albertel 4524: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 4525: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.288 raeburn 4526: return;
4527: }
1.275 raeburn 4528:
1.384 raeburn 4529: sub get_secgrprole_info {
4530: my ($cdom,$cnum,$needroles,$type) = @_;
4531: my %sections_count = &get_sections($cdom,$cnum);
4532: my @sections = (sort {$a <=> $b} keys(%sections_count));
4533: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
4534: my @groups = sort(keys(%curr_groups));
4535: my $allroles = [];
4536: my $rolehash;
4537: my $accesshash = {
4538: active => 'Currently has access',
4539: future => 'Will have future access',
4540: previous => 'Previously had access',
4541: };
4542: if ($needroles) {
4543: $rolehash = {'all' => 'all'};
1.385 albertel 4544: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
4545: if (&Apache::lonnet::error(%user_roles)) {
4546: undef(%user_roles);
4547: }
4548: foreach my $item (keys(%user_roles)) {
1.384 raeburn 4549: my ($role)=split(/\:/,$item,2);
4550: if ($role eq 'cr') { next; }
4551: if ($role =~ /^cr/) {
4552: $$rolehash{$role} = (split('/',$role))[3];
4553: } else {
4554: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
4555: }
4556: }
4557: foreach my $key (sort(keys(%{$rolehash}))) {
4558: push(@{$allroles},$key);
4559: }
4560: push (@{$allroles},'st');
4561: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
4562: }
4563: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
4564: }
4565:
1.112 bowersj2 4566: =pod
4567:
4568: =item * get_unprocessed_cgi($query,$possible_names)
4569:
1.258 albertel 4570: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 4571: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 4572: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 4573:
4574: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
4575: $possible_names is an ref to an array of form element names. As an example:
4576: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 4577: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 4578:
4579: =cut
1.1 albertel 4580:
1.6 albertel 4581: sub get_unprocessed_cgi {
1.25 albertel 4582: my ($query,$possible_names)= @_;
1.26 matthew 4583: # $Apache::lonxml::debug=1;
1.356 albertel 4584: foreach my $pair (split(/&/,$query)) {
4585: my ($name, $value) = split(/=/,$pair);
1.369 www 4586: $name = &unescape($name);
1.25 albertel 4587: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
4588: $value =~ tr/+/ /;
4589: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 4590: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 4591: }
1.16 harris41 4592: }
1.6 albertel 4593: }
4594:
1.112 bowersj2 4595: =pod
4596:
4597: =item * cacheheader()
4598:
4599: returns cache-controlling header code
4600:
4601: =cut
4602:
1.7 albertel 4603: sub cacheheader {
1.258 albertel 4604: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 4605: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
4606: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 4607: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
4608: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 4609: return $output;
1.7 albertel 4610: }
4611:
1.112 bowersj2 4612: =pod
4613:
4614: =item * no_cache($r)
4615:
4616: specifies header code to not have cache
4617:
4618: =cut
4619:
1.9 albertel 4620: sub no_cache {
1.216 albertel 4621: my ($r) = @_;
4622: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 4623: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 4624: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
4625: $r->no_cache(1);
4626: $r->header_out("Expires" => $date);
4627: $r->header_out("Pragma" => "no-cache");
1.123 www 4628: }
4629:
4630: sub content_type {
1.181 albertel 4631: my ($r,$type,$charset) = @_;
1.299 foxr 4632: if ($r) {
4633: # Note that printout.pl calls this with undef for $r.
4634: &no_cache($r);
4635: }
1.258 albertel 4636: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 4637: unless ($charset) {
4638: $charset=&Apache::lonlocal::current_encoding;
4639: }
4640: if ($charset) { $type.='; charset='.$charset; }
4641: if ($r) {
4642: $r->content_type($type);
4643: } else {
4644: print("Content-type: $type\n\n");
4645: }
1.9 albertel 4646: }
1.25 albertel 4647:
1.112 bowersj2 4648: =pod
4649:
4650: =item * add_to_env($name,$value)
4651:
1.258 albertel 4652: adds $name to the %env hash with value
1.112 bowersj2 4653: $value, if $name already exists, the entry is converted to an array
4654: reference and $value is added to the array.
4655:
4656: =cut
4657:
1.25 albertel 4658: sub add_to_env {
4659: my ($name,$value)=@_;
1.258 albertel 4660: if (defined($env{$name})) {
4661: if (ref($env{$name})) {
1.25 albertel 4662: #already have multiple values
1.258 albertel 4663: push(@{ $env{$name} },$value);
1.25 albertel 4664: } else {
4665: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 4666: my $first=$env{$name};
4667: undef($env{$name});
4668: push(@{ $env{$name} },$first,$value);
1.25 albertel 4669: }
4670: } else {
1.258 albertel 4671: $env{$name}=$value;
1.25 albertel 4672: }
1.31 albertel 4673: }
1.149 albertel 4674:
4675: =pod
4676:
4677: =item * get_env_multiple($name)
4678:
1.258 albertel 4679: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 4680: values may be defined and end up as an array ref.
4681:
4682: returns an array of values
4683:
4684: =cut
4685:
4686: sub get_env_multiple {
4687: my ($name) = @_;
4688: my @values;
1.258 albertel 4689: if (defined($env{$name})) {
1.149 albertel 4690: # exists is it an array
1.258 albertel 4691: if (ref($env{$name})) {
4692: @values=@{ $env{$name} };
1.149 albertel 4693: } else {
1.258 albertel 4694: $values[0]=$env{$name};
1.149 albertel 4695: }
4696: }
4697: return(@values);
4698: }
4699:
1.31 albertel 4700:
1.41 ng 4701: =pod
1.45 matthew 4702:
1.464 albertel 4703: =back
1.41 ng 4704:
1.112 bowersj2 4705: =head1 CSV Upload/Handling functions
1.38 albertel 4706:
1.41 ng 4707: =over 4
4708:
1.112 bowersj2 4709: =item * upfile_store($r)
1.41 ng 4710:
4711: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 4712: needs $env{'form.upfile'}
1.41 ng 4713: returns $datatoken to be put into hidden field
4714:
4715: =cut
1.31 albertel 4716:
4717: sub upfile_store {
4718: my $r=shift;
1.258 albertel 4719: $env{'form.upfile'}=~s/\r/\n/gs;
4720: $env{'form.upfile'}=~s/\f/\n/gs;
4721: $env{'form.upfile'}=~s/\n+/\n/gs;
4722: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 4723:
1.258 albertel 4724: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
4725: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 4726: {
1.158 raeburn 4727: my $datafile = $r->dir_config('lonDaemons').
4728: '/tmp/'.$datatoken.'.tmp';
4729: if ( open(my $fh,">$datafile") ) {
1.258 albertel 4730: print $fh $env{'form.upfile'};
1.158 raeburn 4731: close($fh);
4732: }
1.31 albertel 4733: }
4734: return $datatoken;
4735: }
4736:
1.56 matthew 4737: =pod
4738:
1.112 bowersj2 4739: =item * load_tmp_file($r)
1.41 ng 4740:
4741: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 4742: needs $env{'form.datatoken'},
4743: sets $env{'form.upfile'} to the contents of the file
1.41 ng 4744:
4745: =cut
1.31 albertel 4746:
4747: sub load_tmp_file {
4748: my $r=shift;
4749: my @studentdata=();
4750: {
1.158 raeburn 4751: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 4752: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 4753: if ( open(my $fh,"<$studentfile") ) {
4754: @studentdata=<$fh>;
4755: close($fh);
4756: }
1.31 albertel 4757: }
1.258 albertel 4758: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 4759: }
4760:
1.56 matthew 4761: =pod
4762:
1.112 bowersj2 4763: =item * upfile_record_sep()
1.41 ng 4764:
4765: Separate uploaded file into records
4766: returns array of records,
1.258 albertel 4767: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 4768:
4769: =cut
1.31 albertel 4770:
4771: sub upfile_record_sep {
1.258 albertel 4772: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 4773: } else {
1.248 albertel 4774: my @records;
1.258 albertel 4775: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 4776: if ($line=~/^\s*$/) { next; }
4777: push(@records,$line);
4778: }
4779: return @records;
1.31 albertel 4780: }
4781: }
4782:
1.56 matthew 4783: =pod
4784:
1.112 bowersj2 4785: =item * record_sep($record)
1.41 ng 4786:
1.258 albertel 4787: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 4788:
4789: =cut
4790:
1.263 www 4791: sub takeleft {
4792: my $index=shift;
4793: return substr('0000'.$index,-4,4);
4794: }
4795:
1.31 albertel 4796: sub record_sep {
4797: my $record=shift;
4798: my %components=();
1.258 albertel 4799: if ($env{'form.upfiletype'} eq 'xml') {
4800: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 4801: my $i=0;
1.356 albertel 4802: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 4803: $field=~s/^(\"|\')//;
4804: $field=~s/(\"|\')$//;
1.263 www 4805: $components{&takeleft($i)}=$field;
1.31 albertel 4806: $i++;
4807: }
1.258 albertel 4808: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 4809: my $i=0;
1.356 albertel 4810: foreach my $field (split(/\t/,$record)) {
1.31 albertel 4811: $field=~s/^(\"|\')//;
4812: $field=~s/(\"|\')$//;
1.263 www 4813: $components{&takeleft($i)}=$field;
1.31 albertel 4814: $i++;
4815: }
4816: } else {
4817: my @allfields=split(/\,/,$record);
4818: my $i=0;
4819: my $j;
4820: for ($j=0;$j<=$#allfields;$j++) {
4821: my $field=$allfields[$j];
4822: if ($field=~/^\s*(\"|\')/) {
4823: my $delimiter=$1;
4824: while (($field!~/$delimiter$/) && ($j<$#allfields)) {
4825: $j++;
4826: $field.=','.$allfields[$j];
4827: }
4828: $field=~s/^\s*$delimiter//;
4829: $field=~s/$delimiter\s*$//;
4830: }
1.263 www 4831: $components{&takeleft($i)}=$field;
1.31 albertel 4832: $i++;
4833: }
4834: }
4835: return %components;
4836: }
4837:
1.144 matthew 4838: ######################################################
4839: ######################################################
4840:
1.56 matthew 4841: =pod
4842:
1.112 bowersj2 4843: =item * upfile_select_html()
1.41 ng 4844:
1.144 matthew 4845: Return HTML code to select a file from the users machine and specify
4846: the file type.
1.41 ng 4847:
4848: =cut
4849:
1.144 matthew 4850: ######################################################
4851: ######################################################
1.31 albertel 4852: sub upfile_select_html {
1.144 matthew 4853: my %Types = (
4854: csv => &mt('CSV (comma separated values, spreadsheet)'),
4855: space => &mt('Space separated'),
4856: tab => &mt('Tabulator separated'),
4857: # xml => &mt('HTML/XML'),
4858: );
4859: my $Str = '<input type="file" name="upfile" size="50" />'.
4860: '<br />Type: <select name="upfiletype">';
4861: foreach my $type (sort(keys(%Types))) {
4862: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
4863: }
4864: $Str .= "</select>\n";
4865: return $Str;
1.31 albertel 4866: }
4867:
1.301 albertel 4868: sub get_samples {
4869: my ($records,$toget) = @_;
4870: my @samples=({});
4871: my $got=0;
4872: foreach my $rec (@$records) {
4873: my %temp = &record_sep($rec);
4874: if (! grep(/\S/, values(%temp))) { next; }
4875: if (%temp) {
4876: $samples[$got]=\%temp;
4877: $got++;
4878: if ($got == $toget) { last; }
4879: }
4880: }
4881: return \@samples;
4882: }
4883:
1.144 matthew 4884: ######################################################
4885: ######################################################
4886:
1.56 matthew 4887: =pod
4888:
1.112 bowersj2 4889: =item * csv_print_samples($r,$records)
1.41 ng 4890:
4891: Prints a table of sample values from each column uploaded $r is an
4892: Apache Request ref, $records is an arrayref from
4893: &Apache::loncommon::upfile_record_sep
4894:
4895: =cut
4896:
1.144 matthew 4897: ######################################################
4898: ######################################################
1.31 albertel 4899: sub csv_print_samples {
4900: my ($r,$records) = @_;
1.301 albertel 4901: my $samples = &get_samples($records,3);
4902:
1.144 matthew 4903: $r->print(&mt('Samples').'<br /><table border="2"><tr>');
1.356 albertel 4904: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
4905: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.31 albertel 4906: $r->print('</tr>');
1.301 albertel 4907: foreach my $hash (@$samples) {
1.31 albertel 4908: $r->print('<tr>');
1.356 albertel 4909: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 4910: $r->print('<td>');
1.356 albertel 4911: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 4912: $r->print('</td>');
4913: }
4914: $r->print('</tr>');
4915: }
4916: $r->print('</tr></table><br />'."\n");
4917: }
4918:
1.144 matthew 4919: ######################################################
4920: ######################################################
4921:
1.56 matthew 4922: =pod
4923:
1.112 bowersj2 4924: =item * csv_print_select_table($r,$records,$d)
1.41 ng 4925:
4926: Prints a table to create associations between values and table columns.
1.144 matthew 4927:
1.41 ng 4928: $r is an Apache Request ref,
4929: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 4930: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 4931:
4932: =cut
4933:
1.144 matthew 4934: ######################################################
4935: ######################################################
1.31 albertel 4936: sub csv_print_select_table {
4937: my ($r,$records,$d) = @_;
1.301 albertel 4938: my $i=0;
4939: my $samples = &get_samples($records,1);
1.144 matthew 4940: $r->print(&mt('Associate columns with student attributes.')."\n".
4941: '<table border="2"><tr>'.
4942: '<th>'.&mt('Attribute').'</th>'.
4943: '<th>'.&mt('Column').'</th></tr>'."\n");
1.356 albertel 4944: foreach my $array_ref (@$d) {
4945: my ($value,$display,$defaultcol)=@{ $array_ref };
1.31 albertel 4946: $r->print('<tr><td>'.$display.'</td>');
4947:
4948: $r->print('<td><select name=f'.$i.
1.32 matthew 4949: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 4950: $r->print('<option value="none"></option>');
1.356 albertel 4951: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
4952: $r->print('<option value="'.$sample.'"'.
4953: ($sample eq $defaultcol ? ' selected="selected" ' : '').
4954: '>Column '.($sample+1).'</option>');
1.31 albertel 4955: }
4956: $r->print('</select></td></tr>'."\n");
4957: $i++;
4958: }
4959: $i--;
4960: return $i;
4961: }
1.56 matthew 4962:
1.144 matthew 4963: ######################################################
4964: ######################################################
4965:
1.56 matthew 4966: =pod
1.31 albertel 4967:
1.112 bowersj2 4968: =item * csv_samples_select_table($r,$records,$d)
1.41 ng 4969:
4970: Prints a table of sample values from the upload and can make associate samples to internal names.
4971:
4972: $r is an Apache Request ref,
4973: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
4974: $d is an array of 2 element arrays (internal name, displayed name)
4975:
4976: =cut
4977:
1.144 matthew 4978: ######################################################
4979: ######################################################
1.31 albertel 4980: sub csv_samples_select_table {
4981: my ($r,$records,$d) = @_;
4982: my $i=0;
1.144 matthew 4983: #
1.301 albertel 4984: my $samples = &get_samples($records,3);
1.144 matthew 4985: $r->print('<table border=2><tr><th>'.
4986: &mt('Field').'</th><th>'.&mt('Samples').'</th></tr>');
1.301 albertel 4987:
4988: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.144 matthew 4989: $r->print('<tr><td><select name="f'.$i.'"'.
1.32 matthew 4990: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 4991: foreach my $option (@$d) {
4992: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 4993: $r->print('<option value="'.$value.'"'.
1.253 albertel 4994: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 4995: $display.'</option>');
1.31 albertel 4996: }
4997: $r->print('</select></td><td>');
1.301 albertel 4998: foreach my $line (0..2) {
4999: if (defined($samples->[$line]{$key})) {
5000: $r->print($samples->[$line]{$key}."<br />\n");
5001: }
5002: }
1.31 albertel 5003: $r->print('</td></tr>');
5004: $i++;
5005: }
5006: $i--;
5007: return($i);
1.115 matthew 5008: }
5009:
1.144 matthew 5010: ######################################################
5011: ######################################################
5012:
1.115 matthew 5013: =pod
5014:
5015: =item clean_excel_name($name)
5016:
5017: Returns a replacement for $name which does not contain any illegal characters.
5018:
5019: =cut
5020:
1.144 matthew 5021: ######################################################
5022: ######################################################
1.115 matthew 5023: sub clean_excel_name {
5024: my ($name) = @_;
5025: $name =~ s/[:\*\?\/\\]//g;
5026: if (length($name) > 31) {
5027: $name = substr($name,0,31);
5028: }
5029: return $name;
1.25 albertel 5030: }
1.84 albertel 5031:
1.85 albertel 5032: =pod
5033:
1.112 bowersj2 5034: =item * check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 5035:
5036: Returns either 1 or undef
5037:
5038: 1 if the part is to be hidden, undef if it is to be shown
5039:
5040: Arguments are:
5041:
5042: $id the id of the part to be checked
5043: $symb, optional the symb of the resource to check
5044: $udom, optional the domain of the user to check for
5045: $uname, optional the username of the user to check for
5046:
5047: =cut
1.84 albertel 5048:
5049: sub check_if_partid_hidden {
5050: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 5051: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 5052: $symb,$udom,$uname);
1.141 albertel 5053: my $truth=1;
5054: #if the string starts with !, then the list is the list to show not hide
5055: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 5056: my @hiddenlist=split(/,/,$hiddenparts);
5057: foreach my $checkid (@hiddenlist) {
1.141 albertel 5058: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 5059: }
1.141 albertel 5060: return !$truth;
1.84 albertel 5061: }
1.127 matthew 5062:
1.138 matthew 5063:
5064: ############################################################
5065: ############################################################
5066:
5067: =pod
5068:
1.157 matthew 5069: =back
5070:
1.138 matthew 5071: =head1 cgi-bin script and graphing routines
5072:
1.157 matthew 5073: =over 4
5074:
1.138 matthew 5075: =item get_cgi_id
5076:
5077: Inputs: none
5078:
5079: Returns an id which can be used to pass environment variables
5080: to various cgi-bin scripts. These environment variables will
5081: be removed from the users environment after a given time by
5082: the routine &Apache::lonnet::transfer_profile_to_env.
5083:
5084: =cut
5085:
5086: ############################################################
5087: ############################################################
1.152 albertel 5088: my $uniq=0;
1.136 matthew 5089: sub get_cgi_id {
1.154 albertel 5090: $uniq=($uniq+1)%100000;
1.280 albertel 5091: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 5092: }
5093:
1.127 matthew 5094: ############################################################
5095: ############################################################
5096:
5097: =pod
5098:
1.134 matthew 5099: =item DrawBarGraph
1.127 matthew 5100:
1.138 matthew 5101: Facilitates the plotting of data in a (stacked) bar graph.
5102: Puts plot definition data into the users environment in order for
5103: graph.png to plot it. Returns an <img> tag for the plot.
5104: The bars on the plot are labeled '1','2',...,'n'.
5105:
5106: Inputs:
5107:
5108: =over 4
5109:
5110: =item $Title: string, the title of the plot
5111:
5112: =item $xlabel: string, text describing the X-axis of the plot
5113:
5114: =item $ylabel: string, text describing the Y-axis of the plot
5115:
5116: =item $Max: scalar, the maximum Y value to use in the plot
5117: If $Max is < any data point, the graph will not be rendered.
5118:
1.140 matthew 5119: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 5120: they are plotted. If undefined, default values will be used.
5121:
1.178 matthew 5122: =item $labels: array ref holding the labels to use on the x-axis for the bars.
5123:
1.138 matthew 5124: =item @Values: An array of array references. Each array reference holds data
5125: to be plotted in a stacked bar chart.
5126:
1.239 matthew 5127: =item If the final element of @Values is a hash reference the key/value
5128: pairs will be added to the graph definition.
5129:
1.138 matthew 5130: =back
5131:
5132: Returns:
5133:
5134: An <img> tag which references graph.png and the appropriate identifying
5135: information for the plot.
5136:
1.127 matthew 5137: =cut
5138:
5139: ############################################################
5140: ############################################################
1.134 matthew 5141: sub DrawBarGraph {
1.178 matthew 5142: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 5143: #
5144: if (! defined($colors)) {
5145: $colors = ['#33ff00',
5146: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
5147: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
5148: ];
5149: }
1.228 matthew 5150: my $extra_settings = {};
5151: if (ref($Values[-1]) eq 'HASH') {
5152: $extra_settings = pop(@Values);
5153: }
1.127 matthew 5154: #
1.136 matthew 5155: my $identifier = &get_cgi_id();
5156: my $id = 'cgi.'.$identifier;
1.129 matthew 5157: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 5158: return '';
5159: }
1.225 matthew 5160: #
5161: my @Labels;
5162: if (defined($labels)) {
5163: @Labels = @$labels;
5164: } else {
5165: for (my $i=0;$i<@{$Values[0]};$i++) {
5166: push (@Labels,$i+1);
5167: }
5168: }
5169: #
1.129 matthew 5170: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 5171: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 5172: my %ValuesHash;
5173: my $NumSets=1;
5174: foreach my $array (@Values) {
5175: next if (! ref($array));
1.136 matthew 5176: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 5177: join(',',@$array);
1.129 matthew 5178: }
1.127 matthew 5179: #
1.136 matthew 5180: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 5181: if ($NumBars < 3) {
5182: $width = 120+$NumBars*32;
1.220 matthew 5183: $xskip = 1;
1.225 matthew 5184: $bar_width = 30;
5185: } elsif ($NumBars < 5) {
5186: $width = 120+$NumBars*20;
5187: $xskip = 1;
5188: $bar_width = 20;
1.220 matthew 5189: } elsif ($NumBars < 10) {
1.136 matthew 5190: $width = 120+$NumBars*15;
5191: $xskip = 1;
5192: $bar_width = 15;
5193: } elsif ($NumBars <= 25) {
5194: $width = 120+$NumBars*11;
5195: $xskip = 5;
5196: $bar_width = 8;
5197: } elsif ($NumBars <= 50) {
5198: $width = 120+$NumBars*8;
5199: $xskip = 5;
5200: $bar_width = 4;
5201: } else {
5202: $width = 120+$NumBars*8;
5203: $xskip = 5;
5204: $bar_width = 4;
5205: }
5206: #
1.137 matthew 5207: $Max = 1 if ($Max < 1);
5208: if ( int($Max) < $Max ) {
5209: $Max++;
5210: $Max = int($Max);
5211: }
1.127 matthew 5212: $Title = '' if (! defined($Title));
5213: $xlabel = '' if (! defined($xlabel));
5214: $ylabel = '' if (! defined($ylabel));
1.369 www 5215: $ValuesHash{$id.'.title'} = &escape($Title);
5216: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
5217: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 5218: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 5219: $ValuesHash{$id.'.NumBars'} = $NumBars;
5220: $ValuesHash{$id.'.NumSets'} = $NumSets;
5221: $ValuesHash{$id.'.PlotType'} = 'bar';
5222: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
5223: $ValuesHash{$id.'.height'} = $height;
5224: $ValuesHash{$id.'.width'} = $width;
5225: $ValuesHash{$id.'.xskip'} = $xskip;
5226: $ValuesHash{$id.'.bar_width'} = $bar_width;
5227: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 5228: #
1.228 matthew 5229: # Deal with other parameters
5230: while (my ($key,$value) = each(%$extra_settings)) {
5231: $ValuesHash{$id.'.'.$key} = $value;
5232: }
5233: #
1.137 matthew 5234: &Apache::lonnet::appenv(%ValuesHash);
5235: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
5236: }
5237:
5238: ############################################################
5239: ############################################################
5240:
5241: =pod
5242:
5243: =item DrawXYGraph
5244:
1.138 matthew 5245: Facilitates the plotting of data in an XY graph.
5246: Puts plot definition data into the users environment in order for
5247: graph.png to plot it. Returns an <img> tag for the plot.
5248:
5249: Inputs:
5250:
5251: =over 4
5252:
5253: =item $Title: string, the title of the plot
5254:
5255: =item $xlabel: string, text describing the X-axis of the plot
5256:
5257: =item $ylabel: string, text describing the Y-axis of the plot
5258:
5259: =item $Max: scalar, the maximum Y value to use in the plot
5260: If $Max is < any data point, the graph will not be rendered.
5261:
5262: =item $colors: Array ref containing the hex color codes for the data to be
5263: plotted in. If undefined, default values will be used.
5264:
5265: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
5266:
5267: =item $Ydata: Array ref containing Array refs.
1.185 www 5268: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 5269:
5270: =item %Values: hash indicating or overriding any default values which are
5271: passed to graph.png.
5272: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
5273:
5274: =back
5275:
5276: Returns:
5277:
5278: An <img> tag which references graph.png and the appropriate identifying
5279: information for the plot.
5280:
1.137 matthew 5281: =cut
5282:
5283: ############################################################
5284: ############################################################
5285: sub DrawXYGraph {
5286: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
5287: #
5288: # Create the identifier for the graph
5289: my $identifier = &get_cgi_id();
5290: my $id = 'cgi.'.$identifier;
5291: #
5292: $Title = '' if (! defined($Title));
5293: $xlabel = '' if (! defined($xlabel));
5294: $ylabel = '' if (! defined($ylabel));
5295: my %ValuesHash =
5296: (
1.369 www 5297: $id.'.title' => &escape($Title),
5298: $id.'.xlabel' => &escape($xlabel),
5299: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 5300: $id.'.y_max_value'=> $Max,
5301: $id.'.labels' => join(',',@$Xlabels),
5302: $id.'.PlotType' => 'XY',
5303: );
5304: #
5305: if (defined($colors) && ref($colors) eq 'ARRAY') {
5306: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
5307: }
5308: #
5309: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
5310: return '';
5311: }
5312: my $NumSets=1;
1.138 matthew 5313: foreach my $array (@{$Ydata}){
1.137 matthew 5314: next if (! ref($array));
5315: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
5316: }
1.138 matthew 5317: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 5318: #
5319: # Deal with other parameters
5320: while (my ($key,$value) = each(%Values)) {
5321: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 5322: }
5323: #
1.136 matthew 5324: &Apache::lonnet::appenv(%ValuesHash);
5325: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
5326: }
5327:
5328: ############################################################
5329: ############################################################
5330:
5331: =pod
5332:
1.138 matthew 5333: =item DrawXYYGraph
5334:
5335: Facilitates the plotting of data in an XY graph with two Y axes.
5336: Puts plot definition data into the users environment in order for
5337: graph.png to plot it. Returns an <img> tag for the plot.
5338:
5339: Inputs:
5340:
5341: =over 4
5342:
5343: =item $Title: string, the title of the plot
5344:
5345: =item $xlabel: string, text describing the X-axis of the plot
5346:
5347: =item $ylabel: string, text describing the Y-axis of the plot
5348:
5349: =item $colors: Array ref containing the hex color codes for the data to be
5350: plotted in. If undefined, default values will be used.
5351:
5352: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
5353:
5354: =item $Ydata1: The first data set
5355:
5356: =item $Min1: The minimum value of the left Y-axis
5357:
5358: =item $Max1: The maximum value of the left Y-axis
5359:
5360: =item $Ydata2: The second data set
5361:
5362: =item $Min2: The minimum value of the right Y-axis
5363:
5364: =item $Max2: The maximum value of the left Y-axis
5365:
5366: =item %Values: hash indicating or overriding any default values which are
5367: passed to graph.png.
5368: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
5369:
5370: =back
5371:
5372: Returns:
5373:
5374: An <img> tag which references graph.png and the appropriate identifying
5375: information for the plot.
1.136 matthew 5376:
5377: =cut
5378:
5379: ############################################################
5380: ############################################################
1.137 matthew 5381: sub DrawXYYGraph {
5382: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
5383: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 5384: #
5385: # Create the identifier for the graph
5386: my $identifier = &get_cgi_id();
5387: my $id = 'cgi.'.$identifier;
5388: #
5389: $Title = '' if (! defined($Title));
5390: $xlabel = '' if (! defined($xlabel));
5391: $ylabel = '' if (! defined($ylabel));
5392: my %ValuesHash =
5393: (
1.369 www 5394: $id.'.title' => &escape($Title),
5395: $id.'.xlabel' => &escape($xlabel),
5396: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 5397: $id.'.labels' => join(',',@$Xlabels),
5398: $id.'.PlotType' => 'XY',
5399: $id.'.NumSets' => 2,
1.137 matthew 5400: $id.'.two_axes' => 1,
5401: $id.'.y1_max_value' => $Max1,
5402: $id.'.y1_min_value' => $Min1,
5403: $id.'.y2_max_value' => $Max2,
5404: $id.'.y2_min_value' => $Min2,
1.136 matthew 5405: );
5406: #
1.137 matthew 5407: if (defined($colors) && ref($colors) eq 'ARRAY') {
5408: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
5409: }
5410: #
5411: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
5412: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 5413: return '';
5414: }
5415: my $NumSets=1;
1.137 matthew 5416: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 5417: next if (! ref($array));
5418: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 5419: }
5420: #
5421: # Deal with other parameters
5422: while (my ($key,$value) = each(%Values)) {
5423: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 5424: }
5425: #
5426: &Apache::lonnet::appenv(%ValuesHash);
1.130 albertel 5427: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 5428: }
5429:
5430: ############################################################
5431: ############################################################
5432:
5433: =pod
5434:
1.157 matthew 5435: =back
5436:
1.139 matthew 5437: =head1 Statistics helper routines?
5438:
5439: Bad place for them but what the hell.
5440:
1.157 matthew 5441: =over 4
5442:
1.139 matthew 5443: =item &chartlink
5444:
5445: Returns a link to the chart for a specific student.
5446:
5447: Inputs:
5448:
5449: =over 4
5450:
5451: =item $linktext: The text of the link
5452:
5453: =item $sname: The students username
5454:
5455: =item $sdomain: The students domain
5456:
5457: =back
5458:
1.157 matthew 5459: =back
5460:
1.139 matthew 5461: =cut
5462:
5463: ############################################################
5464: ############################################################
5465: sub chartlink {
5466: my ($linktext, $sname, $sdomain) = @_;
5467: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 5468: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 5469: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 5470: '">'.$linktext.'</a>';
1.153 matthew 5471: }
5472:
5473: #######################################################
5474: #######################################################
5475:
5476: =pod
5477:
5478: =head1 Course Environment Routines
1.157 matthew 5479:
5480: =over 4
1.153 matthew 5481:
5482: =item &restore_course_settings
5483:
5484: =item &store_course_settings
5485:
5486: Restores/Store indicated form parameters from the course environment.
5487: Will not overwrite existing values of the form parameters.
5488:
5489: Inputs:
5490: a scalar describing the data (e.g. 'chart', 'problem_analysis')
5491:
5492: a hash ref describing the data to be stored. For example:
5493:
5494: %Save_Parameters = ('Status' => 'scalar',
5495: 'chartoutputmode' => 'scalar',
5496: 'chartoutputdata' => 'scalar',
5497: 'Section' => 'array',
1.373 raeburn 5498: 'Group' => 'array',
1.153 matthew 5499: 'StudentData' => 'array',
5500: 'Maps' => 'array');
5501:
5502: Returns: both routines return nothing
5503:
5504: =cut
5505:
5506: #######################################################
5507: #######################################################
5508: sub store_course_settings {
5509: # save to the environment
5510: # appenv the same items, just to be safe
1.258 albertel 5511: my $courseid = $env{'request.course.id'};
1.300 albertel 5512: my $udom = $env{'user.domain'};
5513: my $uname = $env{'user.name'};
1.153 matthew 5514: my ($prefix,$Settings) = @_;
5515: my %SaveHash;
5516: my %AppHash;
5517: while (my ($setting,$type) = each(%$Settings)) {
1.300 albertel 5518: my $basename = join('.','internal',$courseid,$prefix,$setting);
5519: my $envname = 'environment.'.$basename;
1.258 albertel 5520: if (exists($env{'form.'.$setting})) {
1.153 matthew 5521: # Save this value away
5522: if ($type eq 'scalar' &&
1.258 albertel 5523: (! exists($env{$envname}) ||
5524: $env{$envname} ne $env{'form.'.$setting})) {
5525: $SaveHash{$basename} = $env{'form.'.$setting};
5526: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 5527: } elsif ($type eq 'array') {
5528: my $stored_form;
1.258 albertel 5529: if (ref($env{'form.'.$setting})) {
1.153 matthew 5530: $stored_form = join(',',
5531: map {
1.369 www 5532: &escape($_);
1.258 albertel 5533: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 5534: } else {
5535: $stored_form =
1.369 www 5536: &escape($env{'form.'.$setting});
1.153 matthew 5537: }
5538: # Determine if the array contents are the same.
1.258 albertel 5539: if ($stored_form ne $env{$envname}) {
1.153 matthew 5540: $SaveHash{$basename} = $stored_form;
5541: $AppHash{$envname} = $stored_form;
5542: }
5543: }
5544: }
5545: }
5546: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 5547: $udom,$uname);
1.153 matthew 5548: if ($put_result !~ /^(ok|delayed)/) {
5549: &Apache::lonnet::logthis('unable to save form parameters, '.
5550: 'got error:'.$put_result);
5551: }
5552: # Make sure these settings stick around in this session, too
5553: &Apache::lonnet::appenv(%AppHash);
5554: return;
5555: }
5556:
5557: sub restore_course_settings {
1.258 albertel 5558: my $courseid = $env{'request.course.id'};
1.153 matthew 5559: my ($prefix,$Settings) = @_;
5560: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 5561: next if (exists($env{'form.'.$setting}));
1.300 albertel 5562: my $envname = 'environment.internal.'.$courseid.'.'.$prefix.
1.153 matthew 5563: '.'.$setting;
1.258 albertel 5564: if (exists($env{$envname})) {
1.153 matthew 5565: if ($type eq 'scalar') {
1.258 albertel 5566: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 5567: } elsif ($type eq 'array') {
1.258 albertel 5568: $env{'form.'.$setting} = [
1.153 matthew 5569: map {
1.369 www 5570: &unescape($_);
1.258 albertel 5571: } split(',',$env{$envname})
1.153 matthew 5572: ];
5573: }
5574: }
5575: }
1.127 matthew 5576: }
5577:
5578: ############################################################
5579: ############################################################
1.154 albertel 5580:
1.443 albertel 5581: sub commit_customrole {
5582: my ($udom,$uname,$url,$three,$four,$five,$start,$end) = @_;
5583: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.'@'.$three.' in '.$url.
5584: ($start?', '.&mt('starting').' '.localtime($start):'').
5585: ($end?', ending '.localtime($end):'').': <b>'.
5586: &Apache::lonnet::assigncustomrole(
5587: $udom,$uname,$url,$three,$four,$five,$end,$start).
5588: '</b><br />';
5589: return $output;
5590: }
5591:
5592: sub commit_standardrole {
5593: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec) = @_;
5594: my $output;
5595: my $logmsg;
5596: if ($three eq 'st') {
5597: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec);
5598: if (($result =~ /^error/) || ($result eq 'not_in_class') || ($result eq 'unknown_course')) {
5599: $output = "Error: $result\n";
5600: } else {
5601: $output = &mt('Assigning').' '.$three.' in '.$url.
5602: ($start?', '.&mt('starting').' '.localtime($start):'').
5603: ($end?', '.&mt('ending').' '.localtime($end):'').
5604: ': <b>'.$result.'</b><br />'.
5605: &mt('Add to classlist').': <b>ok</b><br />';
5606: }
5607: } else {
5608: $output = &mt('Assigning').' '.$three.' in '.$url.
5609: ($start?', '.&mt('starting').' '.localtime($start):'').
5610: ($end?', '.&mt('ending').' '.localtime($end):'').': <b>'.
5611: &Apache::lonnet::assignrole(
5612: $udom,$uname,$url,$three,$end,$start).
5613: '</b><br />';
5614: }
5615: return $output;
5616: }
5617:
5618: sub commit_studentrole {
5619: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec) = @_;
5620: my $linefeed = '<br />'."\n";
5621: my $result;
5622: if (defined($one) && defined($two)) {
5623: my $cid=$one.'_'.$two;
5624: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
5625: my $secchange = 0;
5626: my $expire_role_result;
5627: my $modify_section_result;
5628: unless ($oldsec eq '-1') {
5629: unless ($sec eq $oldsec) {
5630: $secchange = 1;
5631: my $uurl='/'.$cid;
5632: $uurl=~s/\_/\//g;
5633: if ($oldsec) {
5634: $uurl.='/'.$oldsec;
5635: }
5636: $expire_role_result = &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',time);
5637: $result = $expire_role_result;
5638: }
5639: }
5640: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
5641: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid);
5642: if ($modify_section_result =~ /^ok/) {
5643: if ($secchange == 1) {
5644: $$logmsg .= "Section for $uname switched from old section: $oldsec to new section: $sec".$linefeed;
5645: } elsif ($oldsec eq '-1') {
5646: $$logmsg .= "New student role for $uname in section $sec in course $cid".$linefeed;
5647: } else {
5648: $$logmsg .= "Student $uname assigned to unchanged section $sec in course $cid".$linefeed;
5649: }
5650: } else {
5651: $$logmsg .= "Error when attempting section change for $uname from old section $oldsec to new section: $sec in course $cid -error: $modify_section_result".$linefeed;
5652: }
5653: $result = $modify_section_result;
5654: } elsif ($secchange == 1) {
5655: $$logmsg .= "Error when attempting to expire role for $uname in old section $oldsec in course $cid -error: $expire_role_result".$linefeed;
5656: }
5657: } else {
5658: $$logmsg .= "Incomplete course id defined. Addition of user $uname from domain $udom to course $one\_$two, section $sec not completed.$linefeed";
5659: $result = "error: incomplete course id\n";
5660: }
5661: return $result;
5662: }
5663:
5664: ############################################################
5665: ############################################################
5666:
1.444 albertel 5667: sub construct_course {
5668: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname) = @_;
5669: my $outcome;
5670:
5671: #
5672: # Open course
5673: #
5674: my $crstype = lc($args->{'crstype'});
5675: my %cenv=();
5676: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
5677: $args->{'cdescr'},
5678: $args->{'curl'},
5679: $args->{'course_home'},
5680: $args->{'nonstandard'},
5681: $args->{'crscode'},
5682: $args->{'ccuname'}.':'.
5683: $args->{'ccdomain'},
5684: $args->{'crstype'});
5685:
5686: # Note: The testing routines depend on this being output; see
5687: # Utils::Course. This needs to at least be output as a comment
5688: # if anyone ever decides to not show this, and Utils::Course::new
5689: # will need to be suitably modified.
5690: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]<br />',$crstype,$$courseid);
5691: #
5692: # Check if created correctly
5693: #
5694: ($$crsudom,$$crsunum)=($$courseid=~/^\/(\w+)\/(\w+)$/);
5695: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
5696: $outcome .= &mt('Created on').': '.$crsuhome.'<br>';
5697: #
5698: # Are we cloning?
5699: #
5700: my $cloneid='';
5701: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
5702: $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
5703: my ($clonecrsudom,$clonecrsunum)=($cloneid=~/^\/(\w+)\/(\w+)$/);
5704: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
5705: if ($clonehome eq 'no_host') {
5706: $outcome .=
5707: '<br /><font color="red">'.&mt('Attempting to clone non-existing [_1]',$crstype).' '.$cloneid.'</font>';
5708: } else {
5709: $outcome .=
5710: '<br /><font color="green">'.&mt('Cloning [_1] from [_2]',$crstype,$clonehome).'</font>';
5711: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
5712: # Copy all files
5713: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid);
5714: # Restore URL
5715: $cenv{'url'}=$oldcenv{'url'};
5716: # Restore title
5717: $cenv{'description'}=$oldcenv{'description'};
5718: # restore grading mode
5719: if (defined($oldcenv{'grading'})) {
5720: $cenv{'grading'}=$oldcenv{'grading'};
5721: }
5722: # Mark as cloned
5723: $cenv{'clonedfrom'}=$cloneid;
5724: delete($cenv{'default_enrollment_start_date'});
5725: delete($cenv{'default_enrollment_end_date'});
5726: }
5727: }
5728: #
5729: # Set environment (will override cloned, if existing)
5730: #
5731: my @sections = ();
5732: my @xlists = ();
5733: if ($args->{'crstype'}) {
5734: $cenv{'type'}=$args->{'crstype'};
5735: }
5736: if ($args->{'crsid'}) {
5737: $cenv{'courseid'}=$args->{'crsid'};
5738: }
5739: if ($args->{'crscode'}) {
5740: $cenv{'internal.coursecode'}=$args->{'crscode'};
5741: }
5742: if ($args->{'crsquota'} ne '') {
5743: $cenv{'internal.coursequota'}=$args->{'crsquota'};
5744: } else {
5745: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
5746: }
5747: if ($args->{'ccuname'}) {
5748: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
5749: ':'.$args->{'ccdomain'};
5750: } else {
5751: $cenv{'internal.courseowner'} = $args->{'curruser'};
5752: }
5753:
5754: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
5755: if ($args->{'crssections'}) {
5756: $cenv{'internal.sectionnums'} = '';
5757: if ($args->{'crssections'} =~ m/,/) {
5758: @sections = split/,/,$args->{'crssections'};
5759: } else {
5760: $sections[0] = $args->{'crssections'};
5761: }
5762: if (@sections > 0) {
5763: foreach my $item (@sections) {
5764: my ($sec,$gp) = split/:/,$item;
5765: my $class = $args->{'crscode'}.$sec;
5766: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
5767: $cenv{'internal.sectionnums'} .= $item.',';
5768: unless ($addcheck eq 'ok') {
5769: push @badclasses, $class;
5770: }
5771: }
5772: $cenv{'internal.sectionnums'} =~ s/,$//;
5773: }
5774: }
5775: # do not hide course coordinator from staff listing,
5776: # even if privileged
5777: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
5778: # add crosslistings
5779: if ($args->{'crsxlist'}) {
5780: $cenv{'internal.crosslistings'}='';
5781: if ($args->{'crsxlist'} =~ m/,/) {
5782: @xlists = split/,/,$args->{'crsxlist'};
5783: } else {
5784: $xlists[0] = $args->{'crsxlist'};
5785: }
5786: if (@xlists > 0) {
5787: foreach my $item (@xlists) {
5788: my ($xl,$gp) = split/:/,$item;
5789: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
5790: $cenv{'internal.crosslistings'} .= $item.',';
5791: unless ($addcheck eq 'ok') {
5792: push @badclasses, $xl;
5793: }
5794: }
5795: $cenv{'internal.crosslistings'} =~ s/,$//;
5796: }
5797: }
5798: if ($args->{'autoadds'}) {
5799: $cenv{'internal.autoadds'}=$args->{'autoadds'};
5800: }
5801: if ($args->{'autodrops'}) {
5802: $cenv{'internal.autodrops'}=$args->{'autodrops'};
5803: }
5804: # check for notification of enrollment changes
5805: my @notified = ();
5806: if ($args->{'notify_owner'}) {
5807: if ($args->{'ccuname'} ne '') {
5808: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
5809: }
5810: }
5811: if ($args->{'notify_dc'}) {
5812: if ($uname ne '') {
5813: push(@notified,$uname.'@'.$udom);
5814: }
5815: }
5816: if (@notified > 0) {
5817: my $notifylist;
5818: if (@notified > 1) {
5819: $notifylist = join(',',@notified);
5820: } else {
5821: $notifylist = $notified[0];
5822: }
5823: $cenv{'internal.notifylist'} = $notifylist;
5824: }
5825: if (@badclasses > 0) {
5826: my %lt=&Apache::lonlocal::texthash(
5827: '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',
5828: 'dnhr' => 'does not have rights to access enrollment in these classes',
5829: 'adby' => 'as determined by the policies of your institution on access to official classlists'
5830: );
5831: $outcome .= '<font color="red">'.$lt{'tclb'}.' ('.$cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.' ('.$lt{'adby'}.').<br /><ul>'."\n";
5832: foreach (@badclasses) {
5833: $outcome .= "<li>$_</li>\n";
5834: }
5835: $outcome .= "</ul><br /><br /></font>\n";
5836: }
5837: if ($args->{'no_end_date'}) {
5838: $args->{'endaccess'} = 0;
5839: }
5840: $cenv{'internal.autostart'}=$args->{'enrollstart'};
5841: $cenv{'internal.autoend'}=$args->{'enrollend'};
5842: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
5843: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
5844: if ($args->{'showphotos'}) {
5845: $cenv{'internal.showphotos'}=$args->{'showphotos'};
5846: }
5847: $cenv{'internal.authtype'} = $args->{'authtype'};
5848: $cenv{'internal.autharg'} = $args->{'autharg'};
5849: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
5850: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
5851: $outcome .= '<font color="red" size="+1">'.
5852: &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').'</font></p>';
5853: }
5854: }
5855: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
5856: if ($args->{'setpolicy'}) {
5857: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
5858: }
5859: if ($args->{'setcontent'}) {
5860: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
5861: }
5862: }
5863: if ($args->{'reshome'}) {
5864: $cenv{'reshome'}=$args->{'reshome'}.'/';
5865: $cenv{'reshome'}=~s/\/+$/\//;
5866: }
5867: #
5868: # course has keyed access
5869: #
5870: if ($args->{'setkeys'}) {
5871: $cenv{'keyaccess'}='yes';
5872: }
5873: # if specified, key authority is not course, but user
5874: # only active if keyaccess is yes
5875: if ($args->{'keyauth'}) {
5876: $args->{'keyauth'}=~s/[^\w\@]//g;
5877: if ($args->{'keyauth'}) {
5878: $cenv{'keyauth'}=$args->{'keyauth'};
5879: }
5880: }
5881:
5882: if ($args->{'disresdis'}) {
5883: $cenv{'pch.roles.denied'}='st';
5884: }
5885: if ($args->{'disablechat'}) {
5886: $cenv{'plc.roles.denied'}='st';
5887: }
5888:
5889: # Record we've not yet viewed the Course Initialization Helper for this
5890: # course
5891: $cenv{'course.helper.not.run'} = 1;
5892: #
5893: # Use new Randomseed
5894: #
5895: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
5896: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
5897: #
5898: # The encryption code and receipt prefix for this course
5899: #
5900: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
5901: $cenv{'internal.encpref'}=100+int(9*rand(99));
5902: #
5903: # By default, use standard grading
5904: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
5905:
5906: $outcome .= ('<br />'.&mt('Setting environment').': '.
5907: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).'<br>');
5908: #
5909: # Open all assignments
5910: #
5911: if ($args->{'openall'}) {
5912: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
5913: my %storecontent = ($storeunder => time,
5914: $storeunder.'.type' => 'date_start');
5915:
5916: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
5917: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).'<br>';
5918: }
5919: #
5920: # Set first page
5921: #
5922: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
5923: || ($cloneid)) {
1.445 albertel 5924: use LONCAPA::map;
1.444 albertel 5925: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 5926:
5927: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
5928: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
5929:
1.444 albertel 5930: $outcome .= ($fatal?$errtext:'read ok').' - ';
5931: my $title; my $url;
5932: if ($args->{'firstres'} eq 'syl') {
5933: $title='Syllabus';
5934: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
5935: } else {
5936: $title='Navigate Contents';
5937: $url='/adm/navmaps';
5938: }
1.445 albertel 5939:
5940: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
5941: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
5942:
5943: if ($errtext) { $fatal=2; }
5944: $outcome .= ($fatal?$errtext:'write ok').'<br />';
1.444 albertel 5945: }
5946: return $outcome;
5947: }
5948:
5949: ############################################################
5950: ############################################################
5951:
1.378 raeburn 5952: sub course_type {
5953: my ($cid) = @_;
5954: if (!defined($cid)) {
5955: $cid = $env{'request.course.id'};
5956: }
1.404 albertel 5957: if (defined($env{'course.'.$cid.'.type'})) {
5958: return $env{'course.'.$cid.'.type'};
1.378 raeburn 5959: } else {
5960: return 'Course';
1.377 raeburn 5961: }
5962: }
1.156 albertel 5963:
1.406 raeburn 5964: sub group_term {
5965: my $crstype = &course_type();
5966: my %names = (
5967: 'Course' => 'group',
5968: 'Group' => 'team',
5969: );
5970: return $names{$crstype};
5971: }
5972:
1.156 albertel 5973: sub icon {
5974: my ($file)=@_;
1.168 albertel 5975: my $curfext = (split(/\./,$file))[-1];
5976: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 5977: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 5978: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
5979: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
5980: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
5981: $curfext.".gif") {
5982: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
5983: $curfext.".gif";
5984: }
5985: }
1.249 albertel 5986: return &lonhttpdurl($iconname);
1.154 albertel 5987: }
1.84 albertel 5988:
1.215 albertel 5989: sub lonhttpdurl {
5990: my ($url)=@_;
5991: my $lonhttpd_port=$Apache::lonnet::perlvar{'lonhttpdPort'};
5992: if (!defined($lonhttpd_port)) { $lonhttpd_port='8080'; }
5993: return 'http://'.$ENV{'SERVER_NAME'}.':'.$lonhttpd_port.$url;
5994: }
5995:
1.213 albertel 5996: sub connection_aborted {
5997: my ($r)=@_;
5998: $r->print(" ");$r->rflush();
5999: my $c = $r->connection;
6000: return $c->aborted();
6001: }
6002:
1.221 foxr 6003: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 6004: # strings as 'strings'.
6005: sub escape_single {
1.221 foxr 6006: my ($input) = @_;
1.223 albertel 6007: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 6008: $input =~ s/\'/\\\'/g; # Esacpe the 's....
6009: return $input;
6010: }
1.223 albertel 6011:
1.222 foxr 6012: # Same as escape_single, but escape's "'s This
6013: # can be used for "strings"
6014: sub escape_double {
6015: my ($input) = @_;
6016: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
6017: $input =~ s/\"/\\\"/g; # Esacpe the "s....
6018: return $input;
6019: }
1.223 albertel 6020:
1.222 foxr 6021: # Escapes the last element of a full URL.
6022: sub escape_url {
6023: my ($url) = @_;
1.238 raeburn 6024: my @urlslices = split(/\//, $url,-1);
1.369 www 6025: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 6026: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 6027: }
1.462 albertel 6028:
6029: # -------------------------------------------------------- Initliaze user login
6030: sub init_user_environment {
1.463 albertel 6031: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 6032: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
6033:
6034: my $public=($username eq 'public' && $domain eq 'public');
6035:
6036: # See if old ID present, if so, remove
6037:
6038: my ($filename,$cookie,$userroles);
6039: my $now=time;
6040:
6041: if ($public) {
6042: my $max_public=100;
6043: my $oldest;
6044: my $oldest_time=0;
6045: for(my $next=1;$next<=$max_public;$next++) {
6046: if (-e $lonids."/publicuser_$next.id") {
6047: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
6048: if ($mtime<$oldest_time || !$oldest_time) {
6049: $oldest_time=$mtime;
6050: $oldest=$next;
6051: }
6052: } else {
6053: $cookie="publicuser_$next";
6054: last;
6055: }
6056: }
6057: if (!$cookie) { $cookie="publicuser_$oldest"; }
6058: } else {
1.463 albertel 6059: # if this isn't a robot, kill any existing non-robot sessions
6060: if (!$args->{'robot'}) {
6061: opendir(DIR,$lonids);
6062: while ($filename=readdir(DIR)) {
6063: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
6064: unlink($lonids.'/'.$filename);
6065: }
1.462 albertel 6066: }
1.463 albertel 6067: closedir(DIR);
1.462 albertel 6068: }
6069: # Give them a new cookie
1.463 albertel 6070: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
6071: : $now);
6072: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 6073:
6074: # Initialize roles
6075:
6076: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
6077: }
6078: # ------------------------------------ Check browser type and MathML capability
6079:
6080: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
6081: $clientunicode,$clientos) = &decode_user_agent($r);
6082:
6083: # -------------------------------------- Any accessibility options to remember?
6084: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
6085: foreach my $option ('imagesuppress','appletsuppress',
6086: 'embedsuppress','fontenhance','blackwhite') {
6087: if ($form->{$option} eq 'true') {
6088: &Apache::lonnet::put('environment',{$option => 'on'},
6089: $domain,$username);
6090: } else {
6091: &Apache::lonnet::del('environment',[$option],
6092: $domain,$username);
6093: }
6094: }
6095: }
6096: # ------------------------------------------------------------- Get environment
6097:
6098: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
6099: my ($tmp) = keys(%userenv);
6100: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
6101: # default remote control to off
6102: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
6103: } else {
6104: undef(%userenv);
6105: }
6106: if (($userenv{'interface'}) && (!$form->{'interface'})) {
6107: $form->{'interface'}=$userenv{'interface'};
6108: }
6109: $env{'environment.remote'}=$userenv{'remote'};
6110: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
6111:
6112: # --------------- Do not trust query string to be put directly into environment
6113: foreach my $option ('imagesuppress','appletsuppress',
6114: 'embedsuppress','fontenhance','blackwhite',
6115: 'interface','localpath','localres') {
6116: $form->{$option}=~s/[\n\r\=]//gs;
6117: }
6118: # --------------------------------------------------------- Write first profile
6119:
6120: {
6121: my %initial_env =
6122: ("user.name" => $username,
6123: "user.domain" => $domain,
6124: "user.home" => $authhost,
6125: "browser.type" => $clientbrowser,
6126: "browser.version" => $clientversion,
6127: "browser.mathml" => $clientmathml,
6128: "browser.unicode" => $clientunicode,
6129: "browser.os" => $clientos,
6130: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
6131: "request.course.fn" => '',
6132: "request.course.uri" => '',
6133: "request.course.sec" => '',
6134: "request.role" => 'cm',
6135: "request.role.adv" => $env{'user.adv'},
6136: "request.host" => $ENV{'REMOTE_ADDR'},);
6137:
6138: if ($form->{'localpath'}) {
6139: $initial_env{"browser.localpath"} = $form->{'localpath'};
6140: $initial_env{"browser.localres"} = $form->{'localres'};
6141: }
6142:
6143: if ($public) {
6144: $initial_env{"environment.remote"} = "off";
6145: }
6146: if ($form->{'interface'}) {
6147: $form->{'interface'}=~s/\W//gs;
6148: $initial_env{"browser.interface"} = $form->{'interface'};
6149: $env{'browser.interface'}=$form->{'interface'};
6150: foreach my $option ('imagesuppress','appletsuppress',
6151: 'embedsuppress','fontenhance','blackwhite') {
6152: if (($form->{$option} eq 'true') ||
6153: ($userenv{$option} eq 'on')) {
6154: $initial_env{"browser.$option"} = "on";
6155: }
6156: }
6157: }
6158:
6159: $env{'user.environment'} = "$lonids/$cookie.id";
6160:
6161: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
6162: &GDBM_WRCREAT(),0640)) {
6163: &_add_to_env(\%disk_env,\%initial_env);
6164: &_add_to_env(\%disk_env,\%userenv,'environment.');
6165: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 6166: if (ref($args->{'extra_env'})) {
6167: &_add_to_env(\%disk_env,$args->{'extra_env'});
6168: }
1.462 albertel 6169: untie(%disk_env);
6170: } else {
6171: &Apache::lonnet::logthis("<font color=\"blue\">WARNING: ".
6172: 'Could not create environment storage in lonauth: '.$!.'</font>');
6173: return 'error: '.$!;
6174: }
6175: }
6176: $env{'request.role'}='cm';
6177: $env{'request.role.adv'}=$env{'user.adv'};
6178: $env{'browser.type'}=$clientbrowser;
6179:
6180: return $cookie;
6181:
6182: }
6183:
6184: sub _add_to_env {
6185: my ($idf,$env_data,$prefix) = @_;
6186: while (my ($key,$value) = each(%$env_data)) {
6187: $idf->{$prefix.$key} = $value;
6188: $env{$prefix.$key} = $value;
6189: }
6190: }
6191:
6192:
1.41 ng 6193: =pod
6194:
6195: =back
6196:
1.112 bowersj2 6197: =cut
1.41 ng 6198:
1.112 bowersj2 6199: 1;
6200: __END__;
1.41 ng 6201:
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