1: # The LearningOnline Network with CAPA
2: # a pile of common routines
3: #
4: # $Id: loncommon.pm,v 1.331 2006/04/11 20:00:44 albertel Exp $
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: #
28:
29: # Makes a table out of the previous attempts
30: # Inputs result_from_symbread, user, domain, course_id
31: # Reads in non-network-related .tab files
32:
33: # POD header:
34:
35: =pod
36:
37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
45:
46: =head1 OVERVIEW
47:
48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
55: package Apache::loncommon;
56:
57: use strict;
58: use Apache::lonnet;
59: use GDBM_File;
60: use POSIX qw(strftime mktime);
61: use Apache::lonmenu();
62: use Apache::lonlocal;
63: use HTML::Entities;
64:
65: my $readit;
66:
67: ##
68: ## Global Variables
69: ##
70:
71: # ----------------------------------------------- Filetypes/Languages/Copyright
72: my %language;
73: my %supported_language;
74: my %cprtag;
75: my %scprtag;
76: my %fe; my %fd;
77: my %category_extensions;
78:
79: # ---------------------------------------------- Designs
80:
81: my %designhash;
82:
83: # ---------------------------------------------- Thesaurus variables
84: #
85: # %Keywords:
86: # A hash used by &keyword to determine if a word is considered a keyword.
87: # $thesaurus_db_file
88: # Scalar containing the full path to the thesaurus database.
89:
90: my %Keywords;
91: my $thesaurus_db_file;
92:
93: #
94: # Initialize values from language.tab, copyright.tab, filetypes.tab,
95: # thesaurus.tab, and filecategories.tab.
96: #
97: BEGIN {
98: # Variable initialization
99: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
100: #
101: unless ($readit) {
102: # ------------------------------------------------------------------- languages
103: {
104: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
105: '/language.tab';
106: if ( open(my $fh,"<$langtabfile") ) {
107: while (<$fh>) {
108: next if /^\#/;
109: chomp;
110: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$_));
111: $language{$key}=$val.' - '.$enc;
112: if ($sup) {
113: $supported_language{$key}=$sup;
114: }
115: }
116: close($fh);
117: }
118: }
119: # ------------------------------------------------------------------ copyrights
120: {
121: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
122: '/copyright.tab';
123: if ( open (my $fh,"<$copyrightfile") ) {
124: while (<$fh>) {
125: next if /^\#/;
126: chomp;
127: my ($key,$val)=(split(/\s+/,$_,2));
128: $cprtag{$key}=$val;
129: }
130: close($fh);
131: }
132: }
133: # ------------------------------------------------------------------ source copyrights
134: {
135: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
136: '/source_copyright.tab';
137: if ( open (my $fh,"<$sourcecopyrightfile") ) {
138: while (<$fh>) {
139: next if /^\#/;
140: chomp;
141: my ($key,$val)=(split(/\s+/,$_,2));
142: $scprtag{$key}=$val;
143: }
144: close($fh);
145: }
146: }
147:
148: # -------------------------------------------------------------- domain designs
149:
150: my $filename;
151: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
152: opendir(DIR,$designdir);
153: while ($filename=readdir(DIR)) {
154: if ($filename!~/\.tab$/) { next; }
155: my ($domain)=($filename=~/^(\w+)\./);
156: {
157: my $designfile = $designdir.'/'.$filename;
158: if ( open (my $fh,"<$designfile") ) {
159: while (<$fh>) {
160: next if /^\#/;
161: chomp;
162: my ($key,$val)=(split(/\=/,$_));
163: if ($val) { $designhash{$domain.'.'.$key}=$val; }
164: }
165: close($fh);
166: }
167: }
168:
169: }
170: closedir(DIR);
171:
172:
173: # ------------------------------------------------------------- file categories
174: {
175: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
176: '/filecategories.tab';
177: if ( open (my $fh,"<$categoryfile") ) {
178: while (<$fh>) {
179: next if /^\#/;
180: chomp;
181: my ($extension,$category)=(split(/\s+/,$_,2));
182: push @{$category_extensions{lc($category)}},$extension;
183: }
184: close($fh);
185: }
186:
187: }
188: # ------------------------------------------------------------------ file types
189: {
190: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
191: '/filetypes.tab';
192: if ( open (my $fh,"<$typesfile") ) {
193: while (<$fh>) {
194: next if (/^\#/);
195: chomp;
196: my ($ending,$emb,$descr)=split(/\s+/,$_,3);
197: if ($descr ne '') {
198: $fe{$ending}=lc($emb);
199: $fd{$ending}=$descr;
200: }
201: }
202: close($fh);
203: }
204: }
205: &Apache::lonnet::logthis(
206: "<font color=yellow>INFO: Read file types</font>");
207: $readit=1;
208: } # end of unless($readit)
209:
210: }
211:
212: ###############################################################
213: ## HTML and Javascript Helper Functions ##
214: ###############################################################
215:
216: =pod
217:
218: =head1 HTML and Javascript Functions
219:
220: =over 4
221:
222: =item * browser_and_searcher_javascript ()
223:
224: X<browsing, javascript>X<searching, javascript>Returns a string
225: containing javascript with two functions, C<openbrowser> and
226: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
227: tags.
228:
229: =item * openbrowser(formname,elementname,only,omit) [javascript]
230:
231: inputs: formname, elementname, only, omit
232:
233: formname and elementname indicate the name of the html form and name of
234: the element that the results of the browsing selection are to be placed in.
235:
236: Specifying 'only' will restrict the browser to displaying only files
237: with the given extension. Can be a comma separated list.
238:
239: Specifying 'omit' will restrict the browser to NOT displaying files
240: with the given extension. Can be a comma separated list.
241:
242: =item * opensearcher(formname, elementname) [javascript]
243:
244: Inputs: formname, elementname
245:
246: formname and elementname specify the name of the html form and the name
247: of the element the selection from the search results will be placed in.
248:
249: =cut
250:
251: sub browser_and_searcher_javascript {
252: my ($mode)=@_;
253: if (!defined($mode)) { $mode='edit'; }
254: my $resurl=&lastresurl();
255: return <<END;
256: // <!-- BEGIN LON-CAPA Internal
257: var editbrowser = null;
258: function openbrowser(formname,elementname,only,omit,titleelement) {
259: var url = '$resurl/?';
260: if (editbrowser == null) {
261: url += 'launch=1&';
262: }
263: url += 'catalogmode=interactive&';
264: url += 'mode=$mode&';
265: url += 'form=' + formname + '&';
266: if (only != null) {
267: url += 'only=' + only + '&';
268: } else {
269: url += 'only=&';
270: }
271: if (omit != null) {
272: url += 'omit=' + omit + '&';
273: } else {
274: url += 'omit=&';
275: }
276: if (titleelement != null) {
277: url += 'titleelement=' + titleelement + '&';
278: } else {
279: url += 'titleelement=&';
280: }
281: url += 'element=' + elementname + '';
282: var title = 'Browser';
283: var options = 'scrollbars=1,resizable=1,menubar=1,location=1';
284: options += ',width=700,height=600';
285: editbrowser = open(url,title,options,'1');
286: editbrowser.focus();
287: }
288: var editsearcher;
289: function opensearcher(formname,elementname,titleelement) {
290: var url = '/adm/searchcat?';
291: if (editsearcher == null) {
292: url += 'launch=1&';
293: }
294: url += 'catalogmode=interactive&';
295: url += 'mode=$mode&';
296: url += 'form=' + formname + '&';
297: if (titleelement != null) {
298: url += 'titleelement=' + titleelement + '&';
299: } else {
300: url += 'titleelement=&';
301: }
302: url += 'element=' + elementname + '';
303: var title = 'Search';
304: var options = 'scrollbars=1,resizable=1,menubar=0';
305: options += ',width=700,height=600';
306: editsearcher = open(url,title,options,'1');
307: editsearcher.focus();
308: }
309: // END LON-CAPA Internal -->
310: END
311: }
312:
313: sub lastresurl {
314: if ($env{'environment.lastresurl'}) {
315: return $env{'environment.lastresurl'}
316: } else {
317: return '/res';
318: }
319: }
320:
321: sub storeresurl {
322: my $resurl=&Apache::lonnet::clutter(shift);
323: unless ($resurl=~/^\/res/) { return 0; }
324: $resurl=~s/\/$//;
325: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
326: &Apache::lonnet::appenv('environment.lastresurl' => $resurl);
327: return 1;
328: }
329:
330: sub studentbrowser_javascript {
331: unless (
332: (($env{'request.course.id'}) &&
333: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
334: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
335: '/'.$env{'request.course.sec'})
336: ))
337: || ($env{'request.role'}=~/^(au|dc|su)/)
338: ) { return ''; }
339: return (<<'ENDSTDBRW');
340: <script type="text/javascript" language="Javascript" >
341: var stdeditbrowser;
342: function openstdbrowser(formname,uname,udom,roleflag) {
343: var url = '/adm/pickstudent?';
344: var filter;
345: eval('filter=document.'+formname+'.'+uname+'.value;');
346: if (filter != null) {
347: if (filter != '') {
348: url += 'filter='+filter+'&';
349: }
350: }
351: url += 'form=' + formname + '&unameelement='+uname+
352: '&udomelement='+udom;
353: if (roleflag) { url+="&roles=1"; }
354: var title = 'Student_Browser';
355: var options = 'scrollbars=1,resizable=1,menubar=0';
356: options += ',width=700,height=600';
357: stdeditbrowser = open(url,title,options,'1');
358: stdeditbrowser.focus();
359: }
360: </script>
361: ENDSTDBRW
362: }
363:
364: sub selectstudent_link {
365: my ($form,$unameele,$udomele)=@_;
366: if ($env{'request.course.id'}) {
367: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
368: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
369: '/'.$env{'request.course.sec'})) {
370: return '';
371: }
372: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
373: '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
374: }
375: if ($env{'request.role'}=~/^(au|dc|su)/) {
376: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
377: '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
378: }
379: return '';
380: }
381:
382: sub coursebrowser_javascript {
383: my ($domainfilter)=@_;
384: return (<<ENDSTDBRW);
385: <script type="text/javascript" language="Javascript" >
386: var stdeditbrowser;
387: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag) {
388: var url = '/adm/pickcourse?';
389: var filter;
390: if (filter != null) {
391: if (filter != '') {
392: url += 'filter='+filter+'&';
393: }
394: }
395: var domainfilter='$domainfilter';
396: if (domainfilter != null) {
397: if (domainfilter != '') {
398: url += 'domainfilter='+domainfilter+'&';
399: }
400: }
401: url += 'form=' + formname + '&cnumelement='+uname+
402: '&cdomelement='+udom+
403: '&cnameelement='+desc;
404: if (extra_element !=null && extra_element != '' && formname == 'rolechoice') {
405: url += '&roleelement='+extra_element;
406: if (domainfilter == null || domainfilter == '') {
407: url += '&domainfilter='+extra_element;
408: }
409: }
410: if (multflag !=null && multflag != '') {
411: url += '&multiple='+multflag;
412: }
413: var title = 'Course_Browser';
414: var options = 'scrollbars=1,resizable=1,menubar=0';
415: options += ',width=700,height=600';
416: stdeditbrowser = open(url,title,options,'1');
417: stdeditbrowser.focus();
418: }
419: </script>
420: ENDSTDBRW
421: }
422:
423: sub selectcourse_link {
424: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag)=@_;
425: return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
426: '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'");'."'>".&mt('Select Course')."</a>";
427: }
428:
429: sub check_uncheck_jscript {
430: my $jscript = <<"ENDSCRT";
431: function checkAll(field) {
432: if (field.length > 0) {
433: for (i = 0; i < field.length; i++) {
434: field[i].checked = true ;
435: }
436: } else {
437: field.checked = true
438: }
439: }
440:
441: function uncheckAll(field) {
442: if (field.length > 0) {
443: for (i = 0; i < field.length; i++) {
444: field[i].checked = false ;
445: } } else {
446: field.checked = false ;
447: }
448: }
449: ENDSCRT
450: return $jscript;
451: }
452:
453:
454: =pod
455:
456: =item * linked_select_forms(...)
457:
458: linked_select_forms returns a string containing a <script></script> block
459: and html for two <select> menus. The select menus will be linked in that
460: changing the value of the first menu will result in new values being placed
461: in the second menu. The values in the select menu will appear in alphabetical
462: order.
463:
464: linked_select_forms takes the following ordered inputs:
465:
466: =over 4
467:
468: =item * $formname, the name of the <form> tag
469:
470: =item * $middletext, the text which appears between the <select> tags
471:
472: =item * $firstdefault, the default value for the first menu
473:
474: =item * $firstselectname, the name of the first <select> tag
475:
476: =item * $secondselectname, the name of the second <select> tag
477:
478: =item * $hashref, a reference to a hash containing the data for the menus.
479:
480: =back
481:
482: Below is an example of such a hash. Only the 'text', 'default', and
483: 'select2' keys must appear as stated. keys(%menu) are the possible
484: values for the first select menu. The text that coincides with the
485: first menu value is given in $menu{$choice1}->{'text'}. The values
486: and text for the second menu are given in the hash pointed to by
487: $menu{$choice1}->{'select2'}.
488:
489: my %menu = ( A1 => { text =>"Choice A1" ,
490: default => "B3",
491: select2 => {
492: B1 => "Choice B1",
493: B2 => "Choice B2",
494: B3 => "Choice B3",
495: B4 => "Choice B4"
496: }
497: },
498: A2 => { text =>"Choice A2" ,
499: default => "C2",
500: select2 => {
501: C1 => "Choice C1",
502: C2 => "Choice C2",
503: C3 => "Choice C3"
504: }
505: },
506: A3 => { text =>"Choice A3" ,
507: default => "D6",
508: select2 => {
509: D1 => "Choice D1",
510: D2 => "Choice D2",
511: D3 => "Choice D3",
512: D4 => "Choice D4",
513: D5 => "Choice D5",
514: D6 => "Choice D6",
515: D7 => "Choice D7"
516: }
517: }
518: );
519:
520: =cut
521:
522: sub linked_select_forms {
523: my ($formname,
524: $middletext,
525: $firstdefault,
526: $firstselectname,
527: $secondselectname,
528: $hashref
529: ) = @_;
530: my $second = "document.$formname.$secondselectname";
531: my $first = "document.$formname.$firstselectname";
532: # output the javascript to do the changing
533: my $result = '';
534: $result.="<script type=\"text/javascript\">\n";
535: $result.="var select2data = new Object();\n";
536: $" = '","';
537: my $debug = '';
538: foreach my $s1 (sort(keys(%$hashref))) {
539: $result.="select2data.d_$s1 = new Object();\n";
540: $result.="select2data.d_$s1.def = new String('".
541: $hashref->{$s1}->{'default'}."');\n";
542: $result.="select2data.d_$s1.values = new Array(";
543: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
544: $result.="\"@s2values\");\n";
545: $result.="select2data.d_$s1.texts = new Array(";
546: my @s2texts;
547: foreach my $value (@s2values) {
548: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
549: }
550: $result.="\"@s2texts\");\n";
551: }
552: $"=' ';
553: $result.= <<"END";
554:
555: function select1_changed() {
556: // Determine new choice
557: var newvalue = "d_" + $first.value;
558: // update select2
559: var values = select2data[newvalue].values;
560: var texts = select2data[newvalue].texts;
561: var select2def = select2data[newvalue].def;
562: var i;
563: // out with the old
564: for (i = 0; i < $second.options.length; i++) {
565: $second.options[i] = null;
566: }
567: // in with the nuclear
568: for (i=0;i<values.length; i++) {
569: $second.options[i] = new Option(values[i]);
570: $second.options[i].value = values[i];
571: $second.options[i].text = texts[i];
572: if (values[i] == select2def) {
573: $second.options[i].selected = true;
574: }
575: }
576: }
577: </script>
578: END
579: # output the initial values for the selection lists
580: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
581: foreach my $value (sort(keys(%$hashref))) {
582: $result.=" <option value=\"$value\" ";
583: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
584: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
585: }
586: $result .= "</select>\n";
587: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
588: $result .= $middletext;
589: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
590: my $seconddefault = $hashref->{$firstdefault}->{'default'};
591: foreach my $value (sort(keys(%select2))) {
592: $result.=" <option value=\"$value\" ";
593: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
594: $result.=">".&mt($select2{$value})."</option>\n";
595: }
596: $result .= "</select>\n";
597: # return $debug;
598: return $result;
599: } # end of sub linked_select_forms {
600:
601: =pod
602:
603: =item * help_open_topic($topic, $text, $stayOnPage, $width, $height)
604:
605: Returns a string corresponding to an HTML link to the given help
606: $topic, where $topic corresponds to the name of a .tex file in
607: /home/httpd/html/adm/help/tex, with underscores replaced by
608: spaces.
609:
610: $text will optionally be linked to the same topic, allowing you to
611: link text in addition to the graphic. If you do not want to link
612: text, but wish to specify one of the later parameters, pass an
613: empty string.
614:
615: $stayOnPage is a value that will be interpreted as a boolean. If true,
616: the link will not open a new window. If false, the link will open
617: a new window using Javascript. (Default is false.)
618:
619: $width and $height are optional numerical parameters that will
620: override the width and height of the popped up window, which may
621: be useful for certain help topics with big pictures included.
622:
623: =cut
624:
625: sub help_open_topic {
626: my ($topic, $text, $stayOnPage, $width, $height) = @_;
627: $text = "" if (not defined $text);
628: $stayOnPage = 0 if (not defined $stayOnPage);
629: if ($env{'browser.interface'} eq 'textual' ||
630: $env{'environment.remote'} eq 'off' ) {
631: $stayOnPage=1;
632: }
633: $width = 350 if (not defined $width);
634: $height = 400 if (not defined $height);
635: my $filename = $topic;
636: $filename =~ s/ /_/g;
637:
638: my $template = "";
639: my $link;
640:
641: $topic=~s/\W/\_/g;
642:
643: if (!$stayOnPage)
644: {
645: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
646: }
647: else
648: {
649: $link = "/adm/help/${filename}.hlp";
650: }
651:
652: # Add the text
653: if ($text ne "")
654: {
655: $template .=
656: "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
657: "<td bgcolor='#5555FF'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
658: }
659:
660: # Add the graphic
661: my $title = &mt('Online Help');
662: my $helpicon=&lonhttpdurl("/adm/help/gif/smallHelp.gif");
663: $template .= <<"ENDTEMPLATE";
664: <a href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
665: ENDTEMPLATE
666: if ($text ne '') { $template.='</td></tr></table>' };
667: return $template;
668:
669: }
670:
671: # This is a quicky function for Latex cheatsheet editing, since it
672: # appears in at least four places
673: sub helpLatexCheatsheet {
674: my $other = shift;
675: my $addOther = '';
676: if ($other) {
677: $addOther = Apache::loncommon::help_open_topic($other, shift,
678: undef, undef, 600) .
679: '</td><td>';
680: }
681: return '<table><tr><td>'.
682: $addOther .
683: &Apache::loncommon::help_open_topic("Greek_Symbols",'Greek Symbols',
684: undef,undef,600)
685: .'</td><td>'.
686: &Apache::loncommon::help_open_topic("Other_Symbols",'Other Symbols',
687: undef,undef,600)
688: .'</td></tr></table>';
689: }
690:
691: sub help_open_menu {
692: my ($color,$topic,$component_help,$function,$faq,$bug,$stayOnPage,$width,$height,$text) = @_;
693: $text = "" if (not defined $text);
694: $stayOnPage = 0 if (not defined $stayOnPage);
695: if ($env{'browser.interface'} eq 'textual' ||
696: $env{'environment.remote'} eq 'off' ) {
697: $stayOnPage=1;
698: }
699: $width = 620 if (not defined $width);
700: $height = 600 if (not defined $height);
701: my $link='';
702: my $title = &mt('Get help');
703: my $origurl = $ENV{'REQUEST_URI'};
704: $origurl=~s|^/~|/priv/|;
705: my $timestamp = time;
706: foreach (\$color,\$function,\$topic,\$component_help,\$faq,\$bug,\$origurl) {
707: $$_ = &Apache::lonnet::escape($$_);
708: }
709: if (!$stayOnPage) {
710: $link = "javascript:helpMenu('open')";
711: } else {
712: $link = "javascript:helpMenu('display')";
713: }
714: my $banner_link = "/adm/helpmenu?page=banner&color=$color&function=$function&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
715: my $details_link = "/adm/helpmenu?page=body&color=$color&function=$function&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp";
716: my $template;
717: if ($text ne "") {
718: $template .=
719: "<table bgcolor='#CC3300' cellspacing='1' cellpadding='1' border='0'><tr>".
720: "<td bgcolor='#CC6600'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
721: }
722: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
723: my $helpicon=&lonhttpdurl("/adm/lonIcons/helpgateway.gif");
724: my $start_page =
725: &Apache::loncommon::start_page('Help Menu', undef,
726: {'frameset' => 1,
727: 'js_ready' => 1,
728: 'add_entries' => {
729: 'border' => '0',
730: 'rows' => "105,*",},});
731: my $end_page =
732: &Apache::loncommon::end_page({'frameset' => 1,
733: 'js_ready' => 1,});
734:
735: $template .= <<"ENDTEMPLATE";
736: <script type="text/javascript">
737: // <!-- BEGIN LON-CAPA Internal
738: // <![CDATA[
739: function helpMenu(target) {
740: var caller = this;
741: if (target == 'open') {
742: var newWindow = null;
743: try {
744: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
745: }
746: catch(error) {
747: writeHelp(caller);
748: return;
749: }
750: if (newWindow) {
751: caller = newWindow;
752: }
753: }
754: writeHelp(caller);
755: return;
756: }
757: function writeHelp(caller) {
758: caller.document.writeln('$start_page<frame name="bannerframe" src="$banner_link" /><frame name="bodyframe" src="$details_link" /> $end_page')
759: caller.document.close()
760: caller.focus()
761: }
762: // ]]>
763: // END LON-CAPA Internal -->
764: </script>
765: <a href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help Menu)" /></a>
766: ENDTEMPLATE
767: if ($component_help) {
768: if (!$text) {
769: $template=&help_open_topic($component_help,undef,$stayOnPage,
770: $width,$height).' '.$template;
771: } else {
772: my $help_text;
773: $help_text=&Apache::lonnet::unescape($topic);
774: $template='<table><tr><td>'.
775: &help_open_topic($component_help,$help_text,$stayOnPage,
776: $width,$height).'</td><td>'.$template.
777: '</td></tr></table>';
778: }
779: }
780: if ($text ne '') { $template.='</td></tr></table>' };
781: return $template;
782: }
783:
784: sub help_open_bug {
785: my ($topic, $text, $stayOnPage, $width, $height) = @_;
786: unless ($env{'user.adv'}) { return ''; }
787: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
788: $text = "" if (not defined $text);
789: $stayOnPage = 0 if (not defined $stayOnPage);
790: if ($env{'browser.interface'} eq 'textual' ||
791: $env{'environment.remote'} eq 'off' ) {
792: $stayOnPage=1;
793: }
794: $width = 600 if (not defined $width);
795: $height = 600 if (not defined $height);
796:
797: $topic=~s/\W+/\+/g;
798: my $link='';
799: my $template='';
800: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
801: &Apache::lonnet::escape($ENV{'REQUEST_URI'}).'&component='.$topic;
802: if (!$stayOnPage)
803: {
804: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
805: }
806: else
807: {
808: $link = $url;
809: }
810: # Add the text
811: if ($text ne "")
812: {
813: $template .=
814: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
815: "<td bgcolor='#FF5555'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
816: }
817:
818: # Add the graphic
819: my $title = &mt('Report a Bug');
820: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
821: $template .= <<"ENDTEMPLATE";
822: <a href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
823: ENDTEMPLATE
824: if ($text ne '') { $template.='</td></tr></table>' };
825: return $template;
826:
827: }
828:
829: sub help_open_faq {
830: my ($topic, $text, $stayOnPage, $width, $height) = @_;
831: unless ($env{'user.adv'}) { return ''; }
832: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
833: $text = "" if (not defined $text);
834: $stayOnPage = 0 if (not defined $stayOnPage);
835: if ($env{'browser.interface'} eq 'textual' ||
836: $env{'environment.remote'} eq 'off' ) {
837: $stayOnPage=1;
838: }
839: $width = 350 if (not defined $width);
840: $height = 400 if (not defined $height);
841:
842: $topic=~s/\W+/\+/g;
843: my $link='';
844: my $template='';
845: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
846: if (!$stayOnPage)
847: {
848: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
849: }
850: else
851: {
852: $link = $url;
853: }
854:
855: # Add the text
856: if ($text ne "")
857: {
858: $template .=
859: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
860: "<td bgcolor='#448844'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
861: }
862:
863: # Add the graphic
864: my $title = &mt('View the FAQ');
865: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
866: $template .= <<"ENDTEMPLATE";
867: <a href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
868: ENDTEMPLATE
869: if ($text ne '') { $template.='</td></tr></table>' };
870: return $template;
871:
872: }
873:
874: ###############################################################
875: ###############################################################
876:
877: =pod
878:
879: =item * change_content_javascript():
880:
881: This and the next function allow you to create small sections of an
882: otherwise static HTML page that you can update on the fly with
883: Javascript, even in Netscape 4.
884:
885: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
886: must be written to the HTML page once. It will prove the Javascript
887: function "change(name, content)". Calling the change function with the
888: name of the section
889: you want to update, matching the name passed to C<changable_area>, and
890: the new content you want to put in there, will put the content into
891: that area.
892:
893: B<Note>: Netscape 4 only reserves enough space for the changable area
894: to contain room for the original contents. You need to "make space"
895: for whatever changes you wish to make, and be B<sure> to check your
896: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
897: it's adequate for updating a one-line status display, but little more.
898: This script will set the space to 100% width, so you only need to
899: worry about height in Netscape 4.
900:
901: Modern browsers are much less limiting, and if you can commit to the
902: user not using Netscape 4, this feature may be used freely with
903: pretty much any HTML.
904:
905: =cut
906:
907: sub change_content_javascript {
908: # If we're on Netscape 4, we need to use Layer-based code
909: if ($env{'browser.type'} eq 'netscape' &&
910: $env{'browser.version'} =~ /^4\./) {
911: return (<<NETSCAPE4);
912: function change(name, content) {
913: doc = document.layers[name+"___escape"].layers[0].document;
914: doc.open();
915: doc.write(content);
916: doc.close();
917: }
918: NETSCAPE4
919: } else {
920: # Otherwise, we need to use semi-standards-compliant code
921: # (technically, "innerHTML" isn't standard but the equivalent
922: # is really scary, and every useful browser supports it
923: return (<<DOMBASED);
924: function change(name, content) {
925: element = document.getElementById(name);
926: element.innerHTML = content;
927: }
928: DOMBASED
929: }
930: }
931:
932: =pod
933:
934: =item * changable_area($name, $origContent):
935:
936: This provides a "changable area" that can be modified on the fly via
937: the Javascript code provided in C<change_content_javascript>. $name is
938: the name you will use to reference the area later; do not repeat the
939: same name on a given HTML page more then once. $origContent is what
940: the area will originally contain, which can be left blank.
941:
942: =cut
943:
944: sub changable_area {
945: my ($name, $origContent) = @_;
946:
947: if ($env{'browser.type'} eq 'netscape' &&
948: $env{'browser.version'} =~ /^4\./) {
949: # If this is netscape 4, we need to use the Layer tag
950: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
951: } else {
952: return "<span id='$name'>$origContent</span>";
953: }
954: }
955:
956: =pod
957:
958: =back
959:
960: =head1 Excel and CSV file utility routines
961:
962: =over 4
963:
964: =cut
965:
966: ###############################################################
967: ###############################################################
968:
969: =pod
970:
971: =item * csv_translate($text)
972:
973: Translate $text to allow it to be output as a 'comma separated values'
974: format.
975:
976: =cut
977:
978: ###############################################################
979: ###############################################################
980: sub csv_translate {
981: my $text = shift;
982: $text =~ s/\"/\"\"/g;
983: $text =~ s/\n/ /g;
984: return $text;
985: }
986:
987: ###############################################################
988: ###############################################################
989:
990: =pod
991:
992: =item * define_excel_formats
993:
994: Define some commonly used Excel cell formats.
995:
996: Currently supported formats:
997:
998: =over 4
999:
1000: =item header
1001:
1002: =item bold
1003:
1004: =item h1
1005:
1006: =item h2
1007:
1008: =item h3
1009:
1010: =item h4
1011:
1012: =item i
1013:
1014: =item date
1015:
1016: =back
1017:
1018: Inputs: $workbook
1019:
1020: Returns: $format, a hash reference.
1021:
1022: =cut
1023:
1024: ###############################################################
1025: ###############################################################
1026: sub define_excel_formats {
1027: my ($workbook) = @_;
1028: my $format;
1029: $format->{'header'} = $workbook->add_format(bold => 1,
1030: bottom => 1,
1031: align => 'center');
1032: $format->{'bold'} = $workbook->add_format(bold=>1);
1033: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1034: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1035: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1036: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1037: $format->{'i'} = $workbook->add_format(italic=>1);
1038: $format->{'date'} = $workbook->add_format(num_format=>
1039: 'mm/dd/yyyy hh:mm:ss');
1040: return $format;
1041: }
1042:
1043: ###############################################################
1044: ###############################################################
1045:
1046: =pod
1047:
1048: =item * create_workbook
1049:
1050: Create an Excel worksheet. If it fails, output message on the
1051: request object and return undefs.
1052:
1053: Inputs: Apache request object
1054:
1055: Returns (undef) on failure,
1056: Excel worksheet object, scalar with filename, and formats
1057: from &Apache::loncommon::define_excel_formats on success
1058:
1059: =cut
1060:
1061: ###############################################################
1062: ###############################################################
1063: sub create_workbook {
1064: my ($r) = @_;
1065: #
1066: # Create the excel spreadsheet
1067: my $filename = '/prtspool/'.
1068: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1069: time.'_'.rand(1000000000).'.xls';
1070: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1071: if (! defined($workbook)) {
1072: $r->log_error("Error creating excel spreadsheet $filename: $!");
1073: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1074: "This error has been logged. ".
1075: "Please alert your LON-CAPA administrator").
1076: '</p>');
1077: return (undef);
1078: }
1079: #
1080: $workbook->set_tempdir('/home/httpd/perl/tmp');
1081: #
1082: my $format = &Apache::loncommon::define_excel_formats($workbook);
1083: return ($workbook,$filename,$format);
1084: }
1085:
1086: ###############################################################
1087: ###############################################################
1088:
1089: =pod
1090:
1091: =item * create_text_file
1092:
1093: Create a file to write to and eventually make available to the usre.
1094: If file creation fails, outputs an error message on the request object and
1095: return undefs.
1096:
1097: Inputs: Apache request object, and file suffix
1098:
1099: Returns (undef) on failure,
1100: Filehandle and filename on success.
1101:
1102: =cut
1103:
1104: ###############################################################
1105: ###############################################################
1106: sub create_text_file {
1107: my ($r,$suffix) = @_;
1108: if (! defined($suffix)) { $suffix = 'txt'; };
1109: my $fh;
1110: my $filename = '/prtspool/'.
1111: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1112: time.'_'.rand(1000000000).'.'.$suffix;
1113: $fh = Apache::File->new('>/home/httpd'.$filename);
1114: if (! defined($fh)) {
1115: $r->log_error("Couldn't open $filename for output $!");
1116: $r->print("Problems occured in creating the output file. ".
1117: "This error has been logged. ".
1118: "Please alert your LON-CAPA administrator.");
1119: }
1120: return ($fh,$filename)
1121: }
1122:
1123:
1124: =pod
1125:
1126: =back
1127:
1128: =cut
1129:
1130: ###############################################################
1131: ## Home server <option> list generating code ##
1132: ###############################################################
1133:
1134: =pod
1135:
1136: =head1 Home Server option list generating code
1137:
1138: =over 4
1139:
1140: =item * get_domains()
1141:
1142: Returns an array containing each of the domains listed in the hosts.tab
1143: file.
1144:
1145: =cut
1146:
1147: #-------------------------------------------
1148: sub get_domains {
1149: # The code below was stolen from "The Perl Cookbook", p 102, 1st ed.
1150: my @domains;
1151: my %seen;
1152: foreach (sort values(%Apache::lonnet::hostdom)) {
1153: push (@domains,$_) unless $seen{$_}++;
1154: }
1155: return @domains;
1156: }
1157:
1158: # ------------------------------------------
1159:
1160: sub domain_select {
1161: my ($name,$value,$multiple)=@_;
1162: my %domains=map {
1163: $_ => $_.' '.$Apache::lonnet::domaindescription{$_}
1164: } &get_domains;
1165: if ($multiple) {
1166: $domains{''}=&mt('Any domain');
1167: return &multiple_select_form($name,$value,4,\%domains);
1168: } else {
1169: return &select_form($name,$value,%domains);
1170: }
1171: }
1172:
1173: #-------------------------------------------
1174:
1175: =pod
1176:
1177: =item * multiple_select_form($name,$value,$size,$hash,$order)
1178:
1179: Returns a string containing a <select> element int multiple mode
1180:
1181:
1182: Args:
1183: $name - name of the <select> element
1184: $value - sclara or array ref of values that should already be selected
1185: $size - number of rows long the select element is
1186: $hash - the elements should be 'option' => 'shown text'
1187: (shown text should already have been &mt())
1188: $order - (optional) array ref of the order to show the elments in
1189:
1190: =cut
1191:
1192: #-------------------------------------------
1193: sub multiple_select_form {
1194: my ($name,$value,$size,$hash,$order)=@_;
1195: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1196: my $output='';
1197: if (! defined($size)) {
1198: $size = 4;
1199: if (scalar(keys(%$hash))<4) {
1200: $size = scalar(keys(%$hash));
1201: }
1202: }
1203: $output.="\n<select name='$name' size='$size' multiple='1'>";
1204: my @order = ref($order) ? @$order
1205: : sort(keys(%$hash));
1206: foreach my $key (@order) {
1207: $output.='<option value="'.$key.'" ';
1208: $output.='selected="selected" ' if ($selected{$key});
1209: $output.='>'.$hash->{$key}."</option>\n";
1210: }
1211: $output.="</select>\n";
1212: return $output;
1213: }
1214:
1215: #-------------------------------------------
1216:
1217: =pod
1218:
1219: =item * select_form($defdom,$name,%hash)
1220:
1221: Returns a string containing a <select name='$name' size='1'> form to
1222: allow a user to select options from a hash option_name => displayed text.
1223: See lonrights.pm for an example invocation and use.
1224:
1225: =cut
1226:
1227: #-------------------------------------------
1228: sub select_form {
1229: my ($def,$name,%hash) = @_;
1230: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1231: my @keys;
1232: if (exists($hash{'select_form_order'})) {
1233: @keys=@{$hash{'select_form_order'}};
1234: } else {
1235: @keys=sort(keys(%hash));
1236: }
1237: foreach (@keys) {
1238: $selectform.="<option value=\"$_\" ".
1239: ($_ eq $def ? 'selected="selected" ' : '').
1240: ">".&mt($hash{$_})."</option>\n";
1241: }
1242: $selectform.="</select>";
1243: return $selectform;
1244: }
1245:
1246: sub gradeleveldescription {
1247: my $gradelevel=shift;
1248: my %gradelevels=(0 => 'Not specified',
1249: 1 => 'Grade 1',
1250: 2 => 'Grade 2',
1251: 3 => 'Grade 3',
1252: 4 => 'Grade 4',
1253: 5 => 'Grade 5',
1254: 6 => 'Grade 6',
1255: 7 => 'Grade 7',
1256: 8 => 'Grade 8',
1257: 9 => 'Grade 9',
1258: 10 => 'Grade 10',
1259: 11 => 'Grade 11',
1260: 12 => 'Grade 12',
1261: 13 => 'Grade 13',
1262: 14 => '100 Level',
1263: 15 => '200 Level',
1264: 16 => '300 Level',
1265: 17 => '400 Level',
1266: 18 => 'Graduate Level');
1267: return &mt($gradelevels{$gradelevel});
1268: }
1269:
1270: sub select_level_form {
1271: my ($deflevel,$name)=@_;
1272: unless ($deflevel) { $deflevel=0; }
1273: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1274: for (my $i=0; $i<=18; $i++) {
1275: $selectform.="<option value=\"$i\" ".
1276: ($i==$deflevel ? 'selected="selected" ' : '').
1277: ">".&gradeleveldescription($i)."</option>\n";
1278: }
1279: $selectform.="</select>";
1280: return $selectform;
1281: }
1282:
1283: #-------------------------------------------
1284:
1285: =pod
1286:
1287: =item * select_dom_form($defdom,$name,$includeempty)
1288:
1289: Returns a string containing a <select name='$name' size='1'> form to
1290: allow a user to select the domain to preform an operation in.
1291: See loncreateuser.pm for an example invocation and use.
1292:
1293: If the $includeempty flag is set, it also includes an empty choice ("no domain
1294: selected");
1295:
1296: =cut
1297:
1298: #-------------------------------------------
1299: sub select_dom_form {
1300: my ($defdom,$name,$includeempty) = @_;
1301: my @domains = get_domains();
1302: if ($includeempty) { @domains=('',@domains); }
1303: my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
1304: foreach (@domains) {
1305: $selectdomain.="<option value=\"$_\" ".
1306: ($_ eq $defdom ? 'selected="selected" ' : '').
1307: ">$_</option>\n";
1308: }
1309: $selectdomain.="</select>";
1310: return $selectdomain;
1311: }
1312:
1313: #-------------------------------------------
1314:
1315: =pod
1316:
1317: =item * get_library_servers($domain)
1318:
1319: Returns a hash which contains keys like '103l3' and values like
1320: 'kirk.lite.msu.edu'. All of the keys will be for machines in the
1321: given $domain.
1322:
1323: =cut
1324:
1325: #-------------------------------------------
1326: sub get_library_servers {
1327: my $domain = shift;
1328: my %library_servers;
1329: foreach (keys(%Apache::lonnet::libserv)) {
1330: if ($Apache::lonnet::hostdom{$_} eq $domain) {
1331: $library_servers{$_} = $Apache::lonnet::hostname{$_};
1332: }
1333: }
1334: return %library_servers;
1335: }
1336:
1337: #-------------------------------------------
1338:
1339: =pod
1340:
1341: =item * home_server_option_list($domain)
1342:
1343: returns a string which contains an <option> list to be used in a
1344: <select> form input. See loncreateuser.pm for an example.
1345:
1346: =cut
1347:
1348: #-------------------------------------------
1349: sub home_server_option_list {
1350: my $domain = shift;
1351: my %servers = &get_library_servers($domain);
1352: my $result = '';
1353: foreach (sort keys(%servers)) {
1354: $result.=
1355: '<option value="'.$_.'">'.$_.' '.$servers{$_}."</option>\n";
1356: }
1357: return $result;
1358: }
1359:
1360: =pod
1361:
1362: =back
1363:
1364: =cut
1365:
1366: ###############################################################
1367: ## Decoding User Agent ##
1368: ###############################################################
1369:
1370: =pod
1371:
1372: =head1 Decoding the User Agent
1373:
1374: =over 4
1375:
1376: =item * &decode_user_agent()
1377:
1378: Inputs: $r
1379:
1380: Outputs:
1381:
1382: =over 4
1383:
1384: =item * $httpbrowser
1385:
1386: =item * $clientbrowser
1387:
1388: =item * $clientversion
1389:
1390: =item * $clientmathml
1391:
1392: =item * $clientunicode
1393:
1394: =item * $clientos
1395:
1396: =back
1397:
1398: =back
1399:
1400: =cut
1401:
1402: ###############################################################
1403: ###############################################################
1404: sub decode_user_agent {
1405: my ($r)=@_;
1406: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
1407: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
1408: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1409: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1410: my $clientbrowser='unknown';
1411: my $clientversion='0';
1412: my $clientmathml='';
1413: my $clientunicode='0';
1414: for (my $i=0;$i<=$#browsertype;$i++) {
1415: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
1416: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
1417: $clientbrowser=$bname;
1418: $httpbrowser=~/$vreg/i;
1419: $clientversion=$1;
1420: $clientmathml=($clientversion>=$minv);
1421: $clientunicode=($clientversion>=$univ);
1422: }
1423: }
1424: my $clientos='unknown';
1425: if (($httpbrowser=~/linux/i) ||
1426: ($httpbrowser=~/unix/i) ||
1427: ($httpbrowser=~/ux/i) ||
1428: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
1429: if (($httpbrowser=~/vax/i) ||
1430: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
1431: if ($httpbrowser=~/next/i) { $clientos='next'; }
1432: if (($httpbrowser=~/mac/i) ||
1433: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1434: if ($httpbrowser=~/win/i) { $clientos='win'; }
1435: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1436: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1437: $clientunicode,$clientos,);
1438: }
1439:
1440: ###############################################################
1441: ## Authentication changing form generation subroutines ##
1442: ###############################################################
1443: ##
1444: ## All of the authform_xxxxxxx subroutines take their inputs in a
1445: ## hash, and have reasonable default values.
1446: ##
1447: ## formname = the name given in the <form> tag.
1448: #-------------------------------------------
1449:
1450: =pod
1451:
1452: =head1 Authentication Routines
1453:
1454: =over 4
1455:
1456: =item * authform_xxxxxx
1457:
1458: The authform_xxxxxx subroutines provide javascript and html forms which
1459: handle some of the conveniences required for authentication forms.
1460: This is not an optimal method, but it works.
1461:
1462: See loncreateuser.pm for invocation and use examples.
1463:
1464: =over 4
1465:
1466: =item * authform_header
1467:
1468: =item * authform_authorwarning
1469:
1470: =item * authform_nochange
1471:
1472: =item * authform_kerberos
1473:
1474: =item * authform_internal
1475:
1476: =item * authform_filesystem
1477:
1478: =back
1479:
1480: =back
1481:
1482: =cut
1483:
1484: #-------------------------------------------
1485: sub authform_header{
1486: my %in = (
1487: formname => 'cu',
1488: kerb_def_dom => '',
1489: @_,
1490: );
1491: $in{'formname'} = 'document.' . $in{'formname'};
1492: my $result='';
1493:
1494: #---------------------------------------------- Code for upper case translation
1495: my $Javascript_toUpperCase;
1496: unless ($in{kerb_def_dom}) {
1497: $Javascript_toUpperCase =<<"END";
1498: switch (choice) {
1499: case 'krb': currentform.elements[choicearg].value =
1500: currentform.elements[choicearg].value.toUpperCase();
1501: break;
1502: default:
1503: }
1504: END
1505: } else {
1506: $Javascript_toUpperCase = "";
1507: }
1508:
1509: my $radioval = "'nochange'";
1510: if (exists($in{'curr_authtype'}) &&
1511: defined($in{'curr_authtype'}) &&
1512: $in{'curr_authtype'} ne '') {
1513: $radioval = "'$in{'curr_authtype'}arg'";
1514: }
1515: my $argfield = 'null';
1516: if ( grep/^mode$/,(keys %in) ) {
1517: if ($in{'mode'} eq 'modifycourse') {
1518: if ( grep/^curr_authtype$/,(keys %in) ) {
1519: $radioval = "'$in{'curr_authtype'}'";
1520: }
1521: if ( grep/^curr_autharg$/,(keys %in) ) {
1522: unless ($in{'curr_autharg'} eq '') {
1523: $argfield = "'$in{'curr_autharg'}'";
1524: }
1525: }
1526: }
1527: }
1528:
1529: $result.=<<"END";
1530: var current = new Object();
1531: current.radiovalue = $radioval;
1532: current.argfield = $argfield;
1533:
1534: function changed_radio(choice,currentform) {
1535: var choicearg = choice + 'arg';
1536: // If a radio button in changed, we need to change the argfield
1537: if (current.radiovalue != choice) {
1538: current.radiovalue = choice;
1539: if (current.argfield != null) {
1540: currentform.elements[current.argfield].value = '';
1541: }
1542: if (choice == 'nochange') {
1543: current.argfield = null;
1544: } else {
1545: current.argfield = choicearg;
1546: switch(choice) {
1547: case 'krb':
1548: currentform.elements[current.argfield].value =
1549: "$in{'kerb_def_dom'}";
1550: break;
1551: default:
1552: break;
1553: }
1554: }
1555: }
1556: return;
1557: }
1558:
1559: function changed_text(choice,currentform) {
1560: var choicearg = choice + 'arg';
1561: if (currentform.elements[choicearg].value !='') {
1562: $Javascript_toUpperCase
1563: // clear old field
1564: if ((current.argfield != choicearg) && (current.argfield != null)) {
1565: currentform.elements[current.argfield].value = '';
1566: }
1567: current.argfield = choicearg;
1568: }
1569: set_auth_radio_buttons(choice,currentform);
1570: return;
1571: }
1572:
1573: function set_auth_radio_buttons(newvalue,currentform) {
1574: var i=0;
1575: while (i < currentform.login.length) {
1576: if (currentform.login[i].value == newvalue) { break; }
1577: i++;
1578: }
1579: if (i == currentform.login.length) {
1580: return;
1581: }
1582: current.radiovalue = newvalue;
1583: currentform.login[i].checked = true;
1584: return;
1585: }
1586: END
1587: return $result;
1588: }
1589:
1590: sub authform_authorwarning{
1591: my $result='';
1592: $result='<i>'.
1593: &mt('As a general rule, only authors or co-authors should be '.
1594: 'filesystem authenticated '.
1595: '(which allows access to the server filesystem).')."</i>\n";
1596: return $result;
1597: }
1598:
1599: sub authform_nochange{
1600: my %in = (
1601: formname => 'document.cu',
1602: kerb_def_dom => 'MSU.EDU',
1603: @_,
1604: );
1605: my $result = '<label>'.&mt('[_1] Do not change login data',
1606: '<input type="radio" name="login" value="nochange" '.
1607: 'checked="checked" onclick="'.
1608: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
1609: '</label>';
1610: return $result;
1611: }
1612:
1613: sub authform_kerberos{
1614: my %in = (
1615: formname => 'document.cu',
1616: kerb_def_dom => 'MSU.EDU',
1617: kerb_def_auth => 'krb4',
1618: @_,
1619: );
1620: my ($check4,$check5,$krbarg);
1621: if ($in{'kerb_def_auth'} eq 'krb5') {
1622: $check5 = " checked=\"on\"";
1623: } else {
1624: $check4 = " checked=\"on\"";
1625: }
1626: $krbarg = $in{'kerb_def_dom'};
1627:
1628: my $krbcheck = "";
1629: if ( grep/^curr_authtype$/,(keys %in) ) {
1630: if ($in{'curr_authtype'} =~ m/^krb/) {
1631: $krbcheck = " checked=\"on\"";
1632: if ( grep/^curr_autharg$/,(keys %in) ) {
1633: $krbarg = $in{'curr_autharg'};
1634: }
1635: }
1636: }
1637:
1638: my $jscall = "javascript:changed_radio('krb',$in{'formname'});";
1639: my $result .= &mt
1640: ('[_1] Kerberos authenticated with domain [_2] '.
1641: '[_3] Version 4 [_4] Version 5 [_5]',
1642: '<label><input type="radio" name="login" value="krb" '.
1643: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.$krbcheck.' />',
1644: '</label><input type="text" size="10" name="krbarg" '.
1645: 'value="'.$krbarg.'" '.
1646: 'onchange="'.$jscall.'" />',
1647: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
1648: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
1649: '</label>');
1650: return $result;
1651: }
1652:
1653: sub authform_internal{
1654: my %args = (
1655: formname => 'document.cu',
1656: kerb_def_dom => 'MSU.EDU',
1657: @_,
1658: );
1659:
1660: my $intcheck = "";
1661: my $intarg = 'value=""';
1662: if ( grep/^curr_authtype$/,(keys %args) ) {
1663: if ($args{'curr_authtype'} eq 'int') {
1664: $intcheck = " checked=\"on\"";
1665: if ( grep/^curr_autharg$/,(keys %args) ) {
1666: $intarg = "value=\"$args{'curr_autharg'}\"";
1667: }
1668: }
1669: }
1670:
1671: my $jscall = "javascript:changed_radio('int',$args{'formname'});";
1672: my $result.=&mt
1673: ('[_1] Internally authenticated (with initial password [_2])',
1674: '<label><input type="radio" name="login" value="int" '.$intcheck.
1675: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1676: '</label><input type="text" size="10" name="intarg" '.$intarg.
1677: ' onchange="'.$jscall.'" />');
1678: return $result;
1679: }
1680:
1681: sub authform_local{
1682: my %in = (
1683: formname => 'document.cu',
1684: kerb_def_dom => 'MSU.EDU',
1685: @_,
1686: );
1687:
1688: my $loccheck = "";
1689: my $locarg = 'value=""';
1690: if ( grep/^curr_authtype$/,(keys %in) ) {
1691: if ($in{'curr_authtype'} eq 'loc') {
1692: $loccheck = " checked=\"on\"";
1693: if ( grep/^curr_autharg$/,(keys %in) ) {
1694: $locarg = "value=\"$in{'curr_autharg'}\"";
1695: }
1696: }
1697: }
1698:
1699: my $jscall = "javascript:changed_radio('loc',$in{'formname'});";
1700: my $result.=&mt('[_1] Local Authentication with argument [_2]',
1701: '<label><input type="radio" name="login" value="loc" '.$loccheck.
1702: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1703: '</label><input type="text" size="10" name="locarg" '.$locarg.
1704: ' onchange="'.$jscall.'" />');
1705: return $result;
1706: }
1707:
1708: sub authform_filesystem{
1709: my %in = (
1710: formname => 'document.cu',
1711: kerb_def_dom => 'MSU.EDU',
1712: @_,
1713: );
1714: my $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
1715: my $result.= &mt
1716: ('[_1] Filesystem Authenticated (with initial password [_2])',
1717: '<label><input type="radio" name="login" value="fsys" '.
1718: 'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1719: '</label><input type="text" size="10" name="fsysarg" value="" '.
1720: 'onchange="'.$jscall.'" />');
1721: return $result;
1722: }
1723:
1724: ###############################################################
1725: ## Get Authentication Defaults for Domain ##
1726: ###############################################################
1727:
1728: =pod
1729:
1730: =head1 Domains and Authentication
1731:
1732: Returns default authentication type and an associated argument as
1733: listed in file 'domain.tab'.
1734:
1735: =over 4
1736:
1737: =item * get_auth_defaults
1738:
1739: get_auth_defaults($target_domain) returns the default authentication
1740: type and an associated argument (initial password or a kerberos domain).
1741: These values are stored in lonTabs/domain.tab
1742:
1743: ($def_auth, $def_arg) = &get_auth_defaults($target_domain);
1744:
1745: If target_domain is not found in domain.tab, returns nothing ('').
1746:
1747: =cut
1748:
1749: #-------------------------------------------
1750: sub get_auth_defaults {
1751: my $domain=shift;
1752: return ($Apache::lonnet::domain_auth_def{$domain},$Apache::lonnet::domain_auth_arg_def{$domain});
1753: }
1754: ###############################################################
1755: ## End Get Authentication Defaults for Domain ##
1756: ###############################################################
1757:
1758: ###############################################################
1759: ## Get Kerberos Defaults for Domain ##
1760: ###############################################################
1761: ##
1762: ## Returns default kerberos version and an associated argument
1763: ## as listed in file domain.tab. If not listed, provides
1764: ## appropriate default domain and kerberos version.
1765: ##
1766: #-------------------------------------------
1767:
1768: =pod
1769:
1770: =item * get_kerberos_defaults
1771:
1772: get_kerberos_defaults($target_domain) returns the default kerberos
1773: version and domain. If not found in domain.tabs, it defaults to
1774: version 4 and the domain of the server.
1775:
1776: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
1777:
1778: =cut
1779:
1780: #-------------------------------------------
1781: sub get_kerberos_defaults {
1782: my $domain=shift;
1783: my ($krbdef,$krbdefdom) =
1784: &Apache::loncommon::get_auth_defaults($domain);
1785: unless ($krbdef =~/^krb/ && $krbdefdom) {
1786: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
1787: my $krbdefdom=$1;
1788: $krbdefdom=~tr/a-z/A-Z/;
1789: $krbdef = "krb4";
1790: }
1791: return ($krbdef,$krbdefdom);
1792: }
1793:
1794: =pod
1795:
1796: =back
1797:
1798: =cut
1799:
1800: ###############################################################
1801: ## Thesaurus Functions ##
1802: ###############################################################
1803:
1804: =pod
1805:
1806: =head1 Thesaurus Functions
1807:
1808: =over 4
1809:
1810: =item * initialize_keywords
1811:
1812: Initializes the package variable %Keywords if it is empty. Uses the
1813: package variable $thesaurus_db_file.
1814:
1815: =cut
1816:
1817: ###################################################
1818:
1819: sub initialize_keywords {
1820: return 1 if (scalar keys(%Keywords));
1821: # If we are here, %Keywords is empty, so fill it up
1822: # Make sure the file we need exists...
1823: if (! -e $thesaurus_db_file) {
1824: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
1825: " failed because it does not exist");
1826: return 0;
1827: }
1828: # Set up the hash as a database
1829: my %thesaurus_db;
1830: if (! tie(%thesaurus_db,'GDBM_File',
1831: $thesaurus_db_file,&GDBM_READER(),0640)){
1832: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
1833: $thesaurus_db_file);
1834: return 0;
1835: }
1836: # Get the average number of appearances of a word.
1837: my $avecount = $thesaurus_db{'average.count'};
1838: # Put keywords (those that appear > average) into %Keywords
1839: while (my ($word,$data)=each (%thesaurus_db)) {
1840: my ($count,undef) = split /:/,$data;
1841: $Keywords{$word}++ if ($count > $avecount);
1842: }
1843: untie %thesaurus_db;
1844: # Remove special values from %Keywords.
1845: foreach ('total.count','average.count') {
1846: delete($Keywords{$_}) if (exists($Keywords{$_}));
1847: }
1848: return 1;
1849: }
1850:
1851: ###################################################
1852:
1853: =pod
1854:
1855: =item * keyword($word)
1856:
1857: Returns true if $word is a keyword. A keyword is a word that appears more
1858: than the average number of times in the thesaurus database. Calls
1859: &initialize_keywords
1860:
1861: =cut
1862:
1863: ###################################################
1864:
1865: sub keyword {
1866: return if (!&initialize_keywords());
1867: my $word=lc(shift());
1868: $word=~s/\W//g;
1869: return exists($Keywords{$word});
1870: }
1871:
1872: ###############################################################
1873:
1874: =pod
1875:
1876: =item * get_related_words
1877:
1878: Look up a word in the thesaurus. Takes a scalar argument and returns
1879: an array of words. If the keyword is not in the thesaurus, an empty array
1880: will be returned. The order of the words returned is determined by the
1881: database which holds them.
1882:
1883: Uses global $thesaurus_db_file.
1884:
1885: =cut
1886:
1887: ###############################################################
1888: sub get_related_words {
1889: my $keyword = shift;
1890: my %thesaurus_db;
1891: if (! -e $thesaurus_db_file) {
1892: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
1893: "failed because the file does not exist");
1894: return ();
1895: }
1896: if (! tie(%thesaurus_db,'GDBM_File',
1897: $thesaurus_db_file,&GDBM_READER(),0640)){
1898: return ();
1899: }
1900: my @Words=();
1901: if (exists($thesaurus_db{$keyword})) {
1902: $_ = $thesaurus_db{$keyword};
1903: (undef,@Words) = split/:/; # The first element is the number of times
1904: # the word appears. We do not need it now.
1905: for (my $i=0;$i<=$#Words;$i++) {
1906: ($Words[$i],undef)= split/\,/,$Words[$i];
1907: }
1908: }
1909: untie %thesaurus_db;
1910: return @Words;
1911: }
1912:
1913: =pod
1914:
1915: =back
1916:
1917: =cut
1918:
1919: # -------------------------------------------------------------- Plaintext name
1920: =pod
1921:
1922: =head1 User Name Functions
1923:
1924: =over 4
1925:
1926: =item * plainname($uname,$udom,$first)
1927:
1928: Takes a users logon name and returns it as a string in
1929: "first middle last generation" form
1930: if $first is set to 'lastname' then it returns it as
1931: 'lastname generation, firstname middlename' if their is a lastname
1932:
1933: =cut
1934:
1935:
1936: ###############################################################
1937: sub plainname {
1938: my ($uname,$udom,$first)=@_;
1939: my %names=&getnames($uname,$udom);
1940: my $name=&Apache::lonnet::format_name($names{'firstname'},
1941: $names{'middlename'},
1942: $names{'lastname'},
1943: $names{'generation'},$first);
1944: $name=~s/^\s+//;
1945: $name=~s/\s+$//;
1946: $name=~s/\s+/ /g;
1947: if ($name !~ /\S/) { $name=$uname.'@'.$udom; }
1948: return $name;
1949: }
1950:
1951: # -------------------------------------------------------------------- Nickname
1952: =pod
1953:
1954: =item * nickname($uname,$udom)
1955:
1956: Gets a users name and returns it as a string as
1957:
1958: ""nickname""
1959:
1960: if the user has a nickname or
1961:
1962: "first middle last generation"
1963:
1964: if the user does not
1965:
1966: =cut
1967:
1968: sub nickname {
1969: my ($uname,$udom)=@_;
1970: my %names=&getnames($uname,$udom);
1971: my $name=$names{'nickname'};
1972: if ($name) {
1973: $name='"'.$name.'"';
1974: } else {
1975: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
1976: $names{'lastname'}.' '.$names{'generation'};
1977: $name=~s/\s+$//;
1978: $name=~s/\s+/ /g;
1979: }
1980: return $name;
1981: }
1982:
1983: sub getnames {
1984: my ($uname,$udom)=@_;
1985: my $id=$uname.':'.$udom;
1986: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
1987: if ($cached) {
1988: return %{$names};
1989: } else {
1990: my %loadnames=&Apache::lonnet::get('environment',
1991: ['firstname','middlename','lastname','generation','nickname'],
1992: $udom,$uname);
1993: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
1994: return %loadnames;
1995: }
1996: }
1997:
1998: # ------------------------------------------------------------------ Screenname
1999:
2000: =pod
2001:
2002: =item * screenname($uname,$udom)
2003:
2004: Gets a users screenname and returns it as a string
2005:
2006: =cut
2007:
2008: sub screenname {
2009: my ($uname,$udom)=@_;
2010: if ($uname eq $env{'user.name'} &&
2011: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
2012: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
2013: return $names{'screenname'};
2014: }
2015:
2016:
2017: # ------------------------------------------------------------- Message Wrapper
2018:
2019: sub messagewrapper {
2020: my ($link,$username,$domain)=@_;
2021: return
2022: '<a href="/adm/email?compose=individual&'.
2023: 'recname='.$username.'&recdom='.$domain.'" '.
2024: 'title="'.&mt('Send message').'">'.$link.'</a>';
2025: }
2026: # --------------------------------------------------------------- Notes Wrapper
2027:
2028: sub noteswrapper {
2029: my ($link,$un,$do)=@_;
2030: return
2031: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
2032: }
2033: # ------------------------------------------------------------- Aboutme Wrapper
2034:
2035: sub aboutmewrapper {
2036: my ($link,$username,$domain,$target)=@_;
2037: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
2038: ($target?' target="$target"':'').' title="'.&mt('View this users personal page').'">'.$link.'</a>';
2039: }
2040:
2041: # ------------------------------------------------------------ Syllabus Wrapper
2042:
2043:
2044: sub syllabuswrapper {
2045: my ($linktext,$coursedir,$domain,$fontcolor)=@_;
2046: if ($fontcolor) {
2047: $linktext='<font color="'.$fontcolor.'">'.$linktext.'</font>';
2048: }
2049: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
2050: }
2051:
2052: sub track_student_link {
2053: my ($linktext,$sname,$sdom,$target,$start) = @_;
2054: my $link ="/adm/trackstudent?";
2055: my $title = 'View recent activity';
2056: if (defined($sname) && $sname !~ /^\s*$/ &&
2057: defined($sdom) && $sdom !~ /^\s*$/) {
2058: $link .= "selected_student=$sname:$sdom";
2059: $title .= ' of this student';
2060: }
2061: if (defined($target) && $target !~ /^\s*$/) {
2062: $target = qq{target="$target"};
2063: } else {
2064: $target = '';
2065: }
2066: if ($start) { $link.='&start='.$start; }
2067: return qq{<a href="$link" title="$title" $target>$linktext</a>};
2068: }
2069:
2070: =pod
2071:
2072: =back
2073:
2074: =head1 Access .tab File Data
2075:
2076: =over 4
2077:
2078: =item * languageids()
2079:
2080: returns list of all language ids
2081:
2082: =cut
2083:
2084: sub languageids {
2085: return sort(keys(%language));
2086: }
2087:
2088: =pod
2089:
2090: =item * languagedescription()
2091:
2092: returns description of a specified language id
2093:
2094: =cut
2095:
2096: sub languagedescription {
2097: my $code=shift;
2098: return ($supported_language{$code}?'* ':'').
2099: $language{$code}.
2100: ($supported_language{$code}?' ('.&mt('interface available').')':'');
2101: }
2102:
2103: sub plainlanguagedescription {
2104: my $code=shift;
2105: return $language{$code};
2106: }
2107:
2108: sub supportedlanguagecode {
2109: my $code=shift;
2110: return $supported_language{$code};
2111: }
2112:
2113: =pod
2114:
2115: =item * copyrightids()
2116:
2117: returns list of all copyrights
2118:
2119: =cut
2120:
2121: sub copyrightids {
2122: return sort(keys(%cprtag));
2123: }
2124:
2125: =pod
2126:
2127: =item * copyrightdescription()
2128:
2129: returns description of a specified copyright id
2130:
2131: =cut
2132:
2133: sub copyrightdescription {
2134: return &mt($cprtag{shift(@_)});
2135: }
2136:
2137: =pod
2138:
2139: =item * source_copyrightids()
2140:
2141: returns list of all source copyrights
2142:
2143: =cut
2144:
2145: sub source_copyrightids {
2146: return sort(keys(%scprtag));
2147: }
2148:
2149: =pod
2150:
2151: =item * source_copyrightdescription()
2152:
2153: returns description of a specified source copyright id
2154:
2155: =cut
2156:
2157: sub source_copyrightdescription {
2158: return &mt($scprtag{shift(@_)});
2159: }
2160:
2161: =pod
2162:
2163: =item * filecategories()
2164:
2165: returns list of all file categories
2166:
2167: =cut
2168:
2169: sub filecategories {
2170: return sort(keys(%category_extensions));
2171: }
2172:
2173: =pod
2174:
2175: =item * filecategorytypes()
2176:
2177: returns list of file types belonging to a given file
2178: category
2179:
2180: =cut
2181:
2182: sub filecategorytypes {
2183: return @{$category_extensions{lc($_[0])}};
2184: }
2185:
2186: =pod
2187:
2188: =item * fileembstyle()
2189:
2190: returns embedding style for a specified file type
2191:
2192: =cut
2193:
2194: sub fileembstyle {
2195: return $fe{lc(shift(@_))};
2196: }
2197:
2198:
2199: sub filecategoryselect {
2200: my ($name,$value)=@_;
2201: return &select_form($value,$name,
2202: '' => &mt('Any category'),
2203: map { $_,$_ } sort(keys(%category_extensions)));
2204: }
2205:
2206: =pod
2207:
2208: =item * filedescription()
2209:
2210: returns description for a specified file type
2211:
2212: =cut
2213:
2214: sub filedescription {
2215: my $file_description = $fd{lc(shift())};
2216: $file_description =~ s:([\[\]]):~$1:g;
2217: return &mt($file_description);
2218: }
2219:
2220: =pod
2221:
2222: =item * filedescriptionex()
2223:
2224: returns description for a specified file type with
2225: extra formatting
2226:
2227: =cut
2228:
2229: sub filedescriptionex {
2230: my $ex=shift;
2231: my $file_description = $fd{lc($ex)};
2232: $file_description =~ s:([\[\]]):~$1:g;
2233: return '.'.$ex.' '.&mt($file_description);
2234: }
2235:
2236: # End of .tab access
2237: =pod
2238:
2239: =back
2240:
2241: =cut
2242:
2243: # ------------------------------------------------------------------ File Types
2244: sub fileextensions {
2245: return sort(keys(%fe));
2246: }
2247:
2248: # ----------------------------------------------------------- Display Languages
2249: # returns a hash with all desired display languages
2250: #
2251:
2252: sub display_languages {
2253: my %languages=();
2254: foreach (&preferred_languages()) {
2255: $languages{$_}=1;
2256: }
2257: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
2258: if ($env{'form.displaylanguage'}) {
2259: foreach (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
2260: $languages{$_}=1;
2261: }
2262: }
2263: return %languages;
2264: }
2265:
2266: sub preferred_languages {
2267: my @languages=();
2268: if ($env{'course.'.$env{'request.course.id'}.'.languages'}) {
2269: @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,
2270: $env{'course.'.$env{'request.course.id'}.'.languages'}));
2271: }
2272: if ($env{'environment.languages'}) {
2273: @languages=split(/\s*(\,|\;|\:)\s*/,$env{'environment.languages'});
2274: }
2275: my $browser=(split(/\;/,$ENV{'HTTP_ACCEPT_LANGUAGE'}))[0];
2276: if ($browser) {
2277: @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,$browser));
2278: }
2279: if ($Apache::lonnet::domain_lang_def{$env{'user.domain'}}) {
2280: @languages=(@languages,
2281: $Apache::lonnet::domain_lang_def{$env{'user.domain'}});
2282: }
2283: if ($Apache::lonnet::domain_lang_def{$env{'request.role.domain'}}) {
2284: @languages=(@languages,
2285: $Apache::lonnet::domain_lang_def{$env{'request.role.domain'}});
2286: }
2287: if ($Apache::lonnet::domain_lang_def{
2288: $Apache::lonnet::perlvar{'lonDefDomain'}}) {
2289: @languages=(@languages,
2290: $Apache::lonnet::domain_lang_def{
2291: $Apache::lonnet::perlvar{'lonDefDomain'}});
2292: }
2293: # turn "en-ca" into "en-ca,en"
2294: my @genlanguages;
2295: foreach (@languages) {
2296: unless ($_=~/\w/) { next; }
2297: push (@genlanguages,$_);
2298: if ($_=~/(\-|\_)/) {
2299: push (@genlanguages,(split(/(\-|\_)/,$_))[0]);
2300: }
2301: }
2302: return @genlanguages;
2303: }
2304:
2305: ###############################################################
2306: ## Student Answer Attempts ##
2307: ###############################################################
2308:
2309: =pod
2310:
2311: =head1 Alternate Problem Views
2312:
2313: =over 4
2314:
2315: =item * get_previous_attempt($symb, $username, $domain, $course,
2316: $getattempt, $regexp, $gradesub)
2317:
2318: Return string with previous attempt on problem. Arguments:
2319:
2320: =over 4
2321:
2322: =item * $symb: Problem, including path
2323:
2324: =item * $username: username of the desired student
2325:
2326: =item * $domain: domain of the desired student
2327:
2328: =item * $course: Course ID
2329:
2330: =item * $getattempt: Leave blank for all attempts, otherwise put
2331: something
2332:
2333: =item * $regexp: if string matches this regexp, the string will be
2334: sent to $gradesub
2335:
2336: =item * $gradesub: routine that processes the string if it matches $regexp
2337:
2338: =back
2339:
2340: The output string is a table containing all desired attempts, if any.
2341:
2342: =cut
2343:
2344: sub get_previous_attempt {
2345: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
2346: my $prevattempts='';
2347: no strict 'refs';
2348: if ($symb) {
2349: my (%returnhash)=
2350: &Apache::lonnet::restore($symb,$course,$domain,$username);
2351: if ($returnhash{'version'}) {
2352: my %lasthash=();
2353: my $version;
2354: for ($version=1;$version<=$returnhash{'version'};$version++) {
2355: foreach (sort(split(/\:/,$returnhash{$version.':keys'}))) {
2356: $lasthash{$_}=$returnhash{$version.':'.$_};
2357: }
2358: }
2359: $prevattempts='<table border="0" width="100%"><tr><td bgcolor="#777777">';
2360: $prevattempts.='<table border="0" width="100%"><tr bgcolor="#e6ffff"><td>History</td>';
2361: foreach (sort(keys %lasthash)) {
2362: my ($ign,@parts) = split(/\./,$_);
2363: if ($#parts > 0) {
2364: my $data=$parts[-1];
2365: pop(@parts);
2366: $prevattempts.='<td>Part '.join('.',@parts).'<br />'.$data.' </td>';
2367: } else {
2368: if ($#parts == 0) {
2369: $prevattempts.='<th>'.$parts[0].'</th>';
2370: } else {
2371: $prevattempts.='<th>'.$ign.'</th>';
2372: }
2373: }
2374: }
2375: if ($getattempt eq '') {
2376: for ($version=1;$version<=$returnhash{'version'};$version++) {
2377: $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Transaction '.$version.'</td>';
2378: foreach (sort(keys %lasthash)) {
2379: my $value;
2380: if ($_ =~ /timestamp/) {
2381: $value=scalar(localtime($returnhash{$version.':'.$_}));
2382: } else {
2383: $value=$returnhash{$version.':'.$_};
2384: }
2385: $prevattempts.='<td>'.&Apache::lonnet::unescape($value).' </td>';
2386: }
2387: }
2388: }
2389: $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Current</td>';
2390: foreach (sort(keys %lasthash)) {
2391: my $value;
2392: if ($_ =~ /timestamp/) {
2393: $value=scalar(localtime($lasthash{$_}));
2394: } else {
2395: $value=$lasthash{$_};
2396: }
2397: $value=&Apache::lonnet::unescape($value);
2398: if ($_ =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
2399: $prevattempts.='<td>'.$value.' </td>';
2400: }
2401: $prevattempts.='</tr></table></td></tr></table>';
2402: } else {
2403: $prevattempts='Nothing submitted - no attempts.';
2404: }
2405: } else {
2406: $prevattempts='No data.';
2407: }
2408: }
2409:
2410: sub relative_to_absolute {
2411: my ($url,$output)=@_;
2412: my $parser=HTML::TokeParser->new(\$output);
2413: my $token;
2414: my $thisdir=$url;
2415: my @rlinks=();
2416: while ($token=$parser->get_token) {
2417: if ($token->[0] eq 'S') {
2418: if ($token->[1] eq 'a') {
2419: if ($token->[2]->{'href'}) {
2420: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
2421: }
2422: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
2423: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
2424: } elsif ($token->[1] eq 'base') {
2425: $thisdir=$token->[2]->{'href'};
2426: }
2427: }
2428: }
2429: $thisdir=~s-/[^/]*$--;
2430: foreach (@rlinks) {
2431: unless (($_=~/^http:\/\//i) ||
2432: ($_=~/^\//) ||
2433: ($_=~/^javascript:/i) ||
2434: ($_=~/^mailto:/i) ||
2435: ($_=~/^\#/)) {
2436: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$_);
2437: $output=~s/(\"|\'|\=\s*)$_(\"|\'|\s|\>)/$1$newlocation$2/;
2438: }
2439: }
2440: # -------------------------------------------------- Deal with Applet codebases
2441: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
2442: return $output;
2443: }
2444:
2445: =pod
2446:
2447: =item * get_student_view
2448:
2449: show a snapshot of what student was looking at
2450:
2451: =cut
2452:
2453: sub get_student_view {
2454: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
2455: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
2456: my (%form);
2457: my @elements=('symb','courseid','domain','username');
2458: foreach my $element (@elements) {
2459: $form{'grade_'.$element}=eval '$'.$element #'
2460: }
2461: if (defined($moreenv)) {
2462: %form=(%form,%{$moreenv});
2463: }
2464: if (defined($target)) { $form{'grade_target'} = $target; }
2465: $feedurl=&Apache::lonnet::clutter($feedurl);
2466: my $userview=&Apache::lonnet::ssi_body($feedurl,%form);
2467: $userview=~s/\<body[^\>]*\>//gi;
2468: $userview=~s/\<\/body\>//gi;
2469: $userview=~s/\<html\>//gi;
2470: $userview=~s/\<\/html\>//gi;
2471: $userview=~s/\<head\>//gi;
2472: $userview=~s/\<\/head\>//gi;
2473: $userview=~s/action\s*\=/would_be_action\=/gi;
2474: $userview=&relative_to_absolute($feedurl,$userview);
2475: return $userview;
2476: }
2477:
2478: =pod
2479:
2480: =item * get_student_answers()
2481:
2482: show a snapshot of how student was answering problem
2483:
2484: =cut
2485:
2486: sub get_student_answers {
2487: my ($symb,$username,$domain,$courseid,%form) = @_;
2488: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
2489: my (%moreenv);
2490: my @elements=('symb','courseid','domain','username');
2491: foreach my $element (@elements) {
2492: $moreenv{'grade_'.$element}=eval '$'.$element #'
2493: }
2494: $moreenv{'grade_target'}='answer';
2495: %moreenv=(%form,%moreenv);
2496: my $userview=&Apache::lonnet::ssi('/res/'.$feedurl,%moreenv);
2497: return $userview;
2498: }
2499:
2500: =pod
2501:
2502: =item * &submlink()
2503:
2504: Inputs: $text $uname $udom $symb $target
2505:
2506: Returns: A link to grades.pm such as to see the SUBM view of a student
2507:
2508: =cut
2509:
2510: ###############################################
2511: sub submlink {
2512: my ($text,$uname,$udom,$symb,$target)=@_;
2513: if (!($uname && $udom)) {
2514: (my $cursymb, my $courseid,$udom,$uname)=
2515: &Apache::lonxml::whichuser($symb);
2516: if (!$symb) { $symb=$cursymb; }
2517: }
2518: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
2519: $symb=&Apache::lonnet::escape($symb);
2520: if ($target) { $target="target=\"$target\""; }
2521: return '<a href="/adm/grades?&command=submission&'.
2522: 'symb='.$symb.'&student='.$uname.
2523: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
2524: }
2525: ##############################################
2526:
2527: =pod
2528:
2529: =item * &pgrdlink()
2530:
2531: Inputs: $text $uname $udom $symb $target
2532:
2533: Returns: A link to grades.pm such as to see the PGRD view of a student
2534:
2535: =cut
2536:
2537: ###############################################
2538: sub pgrdlink {
2539: my $link=&submlink(@_);
2540: $link=~s/(&command=submission)/$1&showgrading=yes/;
2541: return $link;
2542: }
2543: ##############################################
2544:
2545: =pod
2546:
2547: =item * &pprmlink()
2548:
2549: Inputs: $text $uname $udom $symb $target
2550:
2551: Returns: A link to parmset.pm such as to see the PPRM view of a
2552: student and a specific resource
2553:
2554: =cut
2555:
2556: ###############################################
2557: sub pprmlink {
2558: my ($text,$uname,$udom,$symb,$target)=@_;
2559: if (!($uname && $udom)) {
2560: (my $cursymb, my $courseid,$udom,$uname)=
2561: &Apache::lonxml::whichuser($symb);
2562: if (!$symb) { $symb=$cursymb; }
2563: }
2564: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
2565: $symb=&Apache::lonnet::escape($symb);
2566: if ($target) { $target="target=\"$target\""; }
2567: return '<a href="/adm/parmset?&command=set&'.
2568: 'symb='.$symb.'&uname='.$uname.
2569: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
2570: }
2571: ##############################################
2572:
2573: =pod
2574:
2575: =back
2576:
2577: =cut
2578:
2579: ###############################################
2580:
2581:
2582: sub timehash {
2583: my @ltime=localtime(shift);
2584: return ( 'seconds' => $ltime[0],
2585: 'minutes' => $ltime[1],
2586: 'hours' => $ltime[2],
2587: 'day' => $ltime[3],
2588: 'month' => $ltime[4]+1,
2589: 'year' => $ltime[5]+1900,
2590: 'weekday' => $ltime[6],
2591: 'dayyear' => $ltime[7]+1,
2592: 'dlsav' => $ltime[8] );
2593: }
2594:
2595: sub maketime {
2596: my %th=@_;
2597: return POSIX::mktime(
2598: ($th{'seconds'},$th{'minutes'},$th{'hours'},
2599: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
2600: }
2601:
2602: #########################################
2603:
2604: sub findallcourses {
2605: my %courses=();
2606: my $now=time;
2607: foreach (keys %env) {
2608: if ($_=~/^user\.role\.\w+\.\/(\w+)\/(\w+)/) {
2609: my ($starttime,$endtime)=$env{$_};
2610: my $active=1;
2611: if ($starttime) {
2612: if ($now<$starttime) { $active=0; }
2613: }
2614: if ($endtime) {
2615: if ($now>$endtime) { $active=0; }
2616: }
2617: if ($active) { $courses{$1.'_'.$2}=1; }
2618: }
2619: }
2620: return keys %courses;
2621: }
2622:
2623: ###############################################
2624: ###############################################
2625:
2626: =pod
2627:
2628: =head1 Domain Template Functions
2629:
2630: =over 4
2631:
2632: =item * &determinedomain()
2633:
2634: Inputs: $domain (usually will be undef)
2635:
2636: Returns: Determines which domain should be used for designs
2637:
2638: =cut
2639:
2640: ###############################################
2641: sub determinedomain {
2642: my $domain=shift;
2643: if (! $domain) {
2644: # Determine domain if we have not been given one
2645: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
2646: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
2647: if ($env{'request.role.domain'}) {
2648: $domain=$env{'request.role.domain'};
2649: }
2650: }
2651: return $domain;
2652: }
2653: ###############################################
2654: =pod
2655:
2656: =item * &domainlogo()
2657:
2658: Inputs: $domain (usually will be undef)
2659:
2660: Returns: A link to a domain logo, if the domain logo exists.
2661: If the domain logo does not exist, a description of the domain.
2662:
2663: =cut
2664:
2665: ###############################################
2666: sub domainlogo {
2667: my $domain = &determinedomain(shift);
2668: # See if there is a logo
2669: if (-e '/home/httpd/html/adm/lonDomLogos/'.$domain.'.gif') {
2670: my $logo=&lonhttpdurl("/adm/lonDomLogos/$domain.gif");
2671: return '<img src="'.$logo.'" alt="'.$domain.'" />';
2672: } elsif(exists($Apache::lonnet::domaindescription{$domain})) {
2673: return $Apache::lonnet::domaindescription{$domain};
2674: } else {
2675: return '';
2676: }
2677: }
2678: ##############################################
2679:
2680: =pod
2681:
2682: =item * &designparm()
2683:
2684: Inputs: $which parameter; $domain (usually will be undef)
2685:
2686: Returns: value of designparamter $which
2687:
2688: =cut
2689:
2690: ##############################################
2691: sub designparm {
2692: my ($which,$domain)=@_;
2693: if ($env{'browser.blackwhite'} eq 'on') {
2694: if ($which=~/\.(font|alink|vlink|link)$/) {
2695: return '#000000';
2696: }
2697: if ($which=~/\.(pgbg|sidebg)$/) {
2698: return '#FFFFFF';
2699: }
2700: if ($which=~/\.tabbg$/) {
2701: return '#CCCCCC';
2702: }
2703: }
2704: if ($env{'environment.color.'.$which}) {
2705: return $env{'environment.color.'.$which};
2706: }
2707: $domain=&determinedomain($domain);
2708: if ($designhash{$domain.'.'.$which}) {
2709: return $designhash{$domain.'.'.$which};
2710: } else {
2711: return $designhash{'default.'.$which};
2712: }
2713: }
2714:
2715: ###############################################
2716: ###############################################
2717:
2718: =pod
2719:
2720: =back
2721:
2722: =head1 HTTP Helpers
2723:
2724: =over 4
2725:
2726: =item * &bodytag()
2727:
2728: Returns a uniform header for LON-CAPA web pages.
2729:
2730: Inputs:
2731:
2732: =over 4
2733:
2734: =item * $title, A title to be displayed on the page.
2735:
2736: =item * $function, the current role (can be undef).
2737:
2738: =item * $addentries, extra parameters for the <body> tag.
2739:
2740: =item * $bodyonly, if defined, only return the <body> tag.
2741:
2742: =item * $domain, if defined, force a given domain.
2743:
2744: =item * $forcereg, if page should register as content page (relevant for
2745: text interface only)
2746:
2747: =item * $customtitle, alternate text to use instead of $title
2748: in the title box that appears, this text
2749: is not auto translated like the $title is
2750:
2751: =item * $notopbar, if true, keep the 'what is this' info but remove the
2752: navigational links
2753:
2754: =item * $bgcolor, used to override the bg coor on a webpage to a specific value
2755:
2756: =back
2757:
2758: Returns: A uniform header for LON-CAPA web pages.
2759: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
2760: If $bodyonly is undef or zero, an html string containing a <body> tag and
2761: other decorations will be returned.
2762:
2763: =cut
2764:
2765: sub bodytag {
2766: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
2767: $notopbar,$bgcolor)=@_;
2768: $title=&mt($title);
2769: $function = &get_users_function() if (!$function);
2770: my $img=&designparm($function.'.img',$domain);
2771: my $pgbg= $bgcolor || &designparm($function.'.pgbg',$domain);
2772: my $tabbg=&designparm($function.'.tabbg',$domain);
2773: my $font=&designparm($function.'.font',$domain);
2774: my $link=&designparm($function.'.link',$domain);
2775: my $alink=&designparm($function.'.alink',$domain);
2776: my $vlink=&designparm($function.'.vlink',$domain);
2777: my $sidebg=&designparm($function.'.sidebg',$domain);
2778: # Accessibility font enhance
2779: my $addstyle='';
2780: if ($env{'browser.fontenhance'} eq 'on') {
2781: $addstyle=' font-size: x-large;';
2782: }
2783: # role and realm
2784: my ($role,$realm)
2785: =&Apache::lonnet::plaintext((split(/\./,$env{'request.role'}))[0]);
2786: # realm
2787: if ($env{'request.course.id'}) {
2788: $realm=
2789: $env{'course.'.$env{'request.course.id'}.'.description'};
2790: }
2791: unless ($realm) { $realm=' '; }
2792: # Set messages
2793: my $messages=&domainlogo($domain);
2794: # Port for miniserver
2795: my $lonhttpdPort=$Apache::lonnet::perlvar{'lonhttpdPort'};
2796: if (!defined($lonhttpdPort)) { $lonhttpdPort='8080'; }
2797:
2798: my $extra_body_attr = &make_attr_string($forcereg,$addentries);
2799:
2800: # construct main body tag
2801: my $bodytag = <<END;
2802: <style type="text/css">
2803: h1, h2, h3, th { font-family: Arial, Helvetica, sans-serif }
2804: a:focus { color: red; background: yellow }
2805: table.thinborder { border-collapse: collapse; }
2806: table.thinborder tr th, table.thinborder tr td { border-style: solid; border-width: 1px}
2807: form, .inline { display: inline; }
2808: .center { text-align: center; }
2809: .filename {font-family: monospace;}
2810: </style>
2811: <body bgcolor="$pgbg" text="$font" alink="$alink" vlink="$vlink" link="$link"
2812: style="margin-top: 0px;$addstyle" $extra_body_attr>
2813: END
2814:
2815: $bodytag .= &Apache::lontexconvert::init_math_support();
2816:
2817: my $upperleft='<img src="http://'.$ENV{'HTTP_HOST'}.':'.
2818: $lonhttpdPort.$img.'" alt="'.$function.'" />';
2819: if ($bodyonly) {
2820: return $bodytag;
2821: } elsif ($env{'browser.interface'} eq 'textual') {
2822: # Accessibility
2823:
2824: return $bodytag.&Apache::lonmenu::menubuttons($forcereg,'web',
2825: $forcereg).
2826: '<h1>LON-CAPA: '.$title.'</h1>';
2827: } elsif ($env{'environment.remote'} eq 'off') {
2828: # No Remote
2829: my $roleinfo=(<<ENDROLE);
2830: <td bgcolor="$tabbg" align="right">
2831: <font size="2" face="Arial, Helvetica, sans-serif">
2832: $env{'environment.firstname'}
2833: $env{'environment.middlename'}
2834: $env{'environment.lastname'}
2835: $env{'environment.generation'}
2836: </font>
2837: <br />
2838: <font size="2" face="Arial, Helvetica, sans-serif">$role</font>
2839: <br />
2840: <font size="2" face="Arial, Helvetica, sans-serif">$realm</font>
2841: </td>
2842: ENDROLE
2843: my $titleinfo = '<font face="Arial, Helvetica, sans-serif" size="+3" color="'.
2844: $font.'"><b>'.$title.'</b></font>';
2845: if ($customtitle) {
2846: $titleinfo = $customtitle;
2847: }
2848:
2849: if ($env{'request.state'} eq 'construct') {
2850: my ($uname,$thisdisfn)=
2851: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
2852: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
2853: $formaction=~s/\/+/\//g;
2854: unless ($customtitle) { #this is for resources; directories have customtitle, and crumbs and select recent are created in lonpubdir.pm
2855: my $parentpath = '';
2856: my $lastitem = '';
2857: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
2858: $parentpath = $1;
2859: $lastitem = $2;
2860: } else {
2861: $lastitem = $thisdisfn;
2862: }
2863: $titleinfo = &Apache::loncommon::help_open_menu('','','','',3,'Authoring').
2864: '<font face="Arial, Helvetica, sans-serif"><b>Construction Space</b>:</font> '.
2865: '<form name="dirs" method="post" action="'.$formaction
2866: .'" target="_top"><tt><b>'
2867: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"
2868: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
2869: .'</form>'
2870: .&Apache::lonmenu::constspaceform();
2871:
2872: }
2873: $forcereg=1;
2874: }
2875: my $titletable = '<table bgcolor="'.$pgbg.'" width="100%" border="0" '.
2876: 'cellspacing="3" cellpadding="3">'.
2877: '<tr><td bgcolor="'.$tabbg.'">'.
2878: $titleinfo.'</td>'.$roleinfo.'</tr></table>';
2879: if ($env{'request.state'} eq 'construct') {
2880: if ($notopbar) {
2881: $bodytag .= $titletable;
2882: } else {
2883: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,'web',$forcereg,$titletable);
2884: }
2885: } else {
2886: if ($notopbar) {
2887: $bodytag .= $titletable;
2888: } else {
2889: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,'web',$forcereg).
2890: $titletable;
2891: }
2892: }
2893: return $bodytag;
2894: }
2895:
2896: #
2897: # Top frame rendering, Remote is up
2898: #
2899: my $titleinfo = ' <font size="5" face="Arial, Helvetica, sans-serif"><b>'.$title.'</b></font>';
2900: if ($customtitle) {
2901: $titleinfo = $customtitle;
2902: }
2903: #
2904: # Extra info if you are the DC
2905: my $dc_info = '';
2906: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
2907: $env{'course.'.$env{'request.course.id'}.
2908: '.domain'}.'/'})) {
2909: my $cid = $env{'request.course.id'};
2910: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
2911: $dc_info = '('.$dc_info.')';
2912: }
2913: # Explicit link to get inline menu
2914: my $menu='<br /><font size="2" face="Arial, Helvetica, sans-serif"> <a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a></font>';
2915: #
2916: return(<<ENDBODY);
2917: $bodytag
2918: <table width="100%" cellspacing="0" border="0" cellpadding="0">
2919: <tr><td bgcolor="$sidebg">
2920: $upperleft</td>
2921: <td bgcolor="$sidebg" align="right">$messages </td>
2922: </tr>
2923: <tr>
2924: <td rowspan="3" bgcolor="$tabbg">
2925: $titleinfo $dc_info $menu
2926: </td><td bgcolor="$tabbg" align="right">
2927: <font size="2" face="Arial, Helvetica, sans-serif">
2928: $env{'environment.firstname'}
2929: $env{'environment.middlename'}
2930: $env{'environment.lastname'}
2931: $env{'environment.generation'}
2932: </font>
2933: </td>
2934: </tr>
2935: <tr><td bgcolor="$tabbg" align="right">
2936: <font size="2" face="Arial, Helvetica, sans-serif">$role</font>
2937: </td></tr>
2938: <tr>
2939: <td bgcolor="$tabbg" align="right"><font size="2" face="Arial, Helvetica, sans-serif">$realm</font> </td></tr>
2940: </table><br />
2941: ENDBODY
2942: }
2943:
2944: sub make_attr_string {
2945: my ($register,$attr_ref) = @_;
2946:
2947: if ($attr_ref && !ref($attr_ref)) {
2948: die("addentries Must be a hash ref ".
2949: join(':',caller(1))." ".
2950: join(':',caller(0))." ");
2951: }
2952:
2953: if ($register) {
2954: $attr_ref->{'onload'} = &Apache::lonmenu::loadevents().
2955: $attr_ref->{'onload'};
2956: $attr_ref->{'onunload'} = &Apache::lonmenu::unloadevents().
2957: $attr_ref->{'onunload'};
2958: }
2959: my $attr_string;
2960: foreach my $attr (keys(%$attr_ref)) {
2961: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
2962: }
2963: return $attr_string;
2964: }
2965:
2966:
2967: ###############################################
2968: ###############################################
2969:
2970: =pod
2971:
2972: =back
2973:
2974: =head1 HTML Helpers
2975:
2976: =over 4
2977:
2978: =item * &endbodytag()
2979:
2980: Returns a uniform footer for LON-CAPA web pages.
2981:
2982: Inputs: none
2983:
2984: =back
2985:
2986: =cut
2987:
2988: sub endbodytag {
2989: my $endbodytag='</body>';
2990: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
2991: if ( exists( $env{'internal.head.redirect'} ) ) {
2992: $endbodytag=
2993: "<br /><a href=\"$env{'internal.head.redirect'}\">".
2994: &mt('Continue').'</a>'.
2995: $endbodytag;
2996: }
2997: return $endbodytag;
2998: }
2999:
3000: =pod
3001:
3002: =over 4
3003:
3004: =item * &headtag()
3005:
3006: Returns a uniform footer for LON-CAPA web pages.
3007:
3008: Inputs: $title - optional title for the head
3009: $head_extra - optional extra HTML to put inside the <head>
3010: $args - optional arguments
3011: force_register - if is true call registerurl so the remote is
3012: informed
3013:
3014: redirect - array ref of seconds before redirect occurs
3015: url to redirect to
3016: (side effect of setting
3017: $env{'internal.head.redirect'} to the url
3018: redirected too)
3019: =back
3020:
3021: =cut
3022:
3023: sub headtag {
3024: my ($title,$head_extra,$args) = @_;
3025:
3026: my $result =
3027: '<head>'.
3028: &Apache::lonxml::fontsettings().
3029: &Apache::lonhtmlcommon::htmlareaheaders();
3030:
3031: if ($args->{'force_register'}) {
3032: $result .= &Apache::lonmenu::registerurl(1);
3033: }
3034:
3035: if (ref($args->{'redirect'})) {
3036: my ($time,$url) = @{$args->{'redirect'}};
3037: $url = &Apache::lonenc::check_encrypt($url);
3038: $env{'internal.head.redirect'} = $url;
3039: $result.=<<ADDMETA
3040: <meta http-equiv="pragma" content="no-cache" />
3041: <meta HTTP-EQUIV="Refresh" CONTENT="$time; url=$url" />
3042: ADDMETA
3043: }
3044: if (!defined($title)) {
3045: $title = 'The LearningOnline Network with CAPA';
3046: }
3047:
3048: $result .= '<title> LON-CAPA '.&mt($title).'</title>'.$head_extra;
3049: return $result;
3050: }
3051:
3052: =pod
3053:
3054: =over 4
3055:
3056: =item * &endheadtag()
3057:
3058: Returns a uniform </head> for LON-CAPA web pages.
3059:
3060: Inputs: none
3061:
3062: =back
3063:
3064: =cut
3065:
3066: sub endheadtag {
3067: return '</head>';
3068: }
3069:
3070: =pod
3071:
3072: =over 4
3073:
3074: =item * &head()
3075:
3076: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
3077:
3078: Inputs: $title - optional title for the page
3079: $head_extra - optional extra HTML to put inside the <head>
3080: =back
3081:
3082: =cut
3083:
3084: sub head {
3085: my ($title,$head_extra,$args) = @_;
3086: return &headtag($title,$head_extra,$args).&endheadtag();
3087: }
3088:
3089: =pod
3090:
3091: =over 4
3092:
3093: =item * &start_page()
3094:
3095: Returns a complete <html> .. <body> section for LON-CAPA web pages.
3096:
3097: Inputs: $title - optional title for the page
3098: $head_extra - optional extra HTML to incude inside the <head>
3099: $args - additional optional args supported are:
3100: only_body -> is true will set &bodytag() onlybodytag
3101: arg on
3102: no_nav_bar -> is true will set &bodytag() notopbar arg on
3103: add_entries -> additional attributes to add to the <body>
3104: domain -> force to color decorate a page for a
3105: specific domain
3106: function -> force usage of a specific rolish color
3107: scheme
3108: redirect -> see &headtag()
3109: bgcolor -> override the default page bg color
3110: js_ready -> return a string ready for being used in
3111: a javascript writeln
3112: html_encode -> return a string ready for being used in
3113: a html attribute
3114: force_register -> if is true will turn on the &bodytag()
3115: $forcereg arg
3116: body_title -> alternate text to use instead of $title
3117: in the title box that appears, this text
3118: is not auto translated like the $title is
3119: frameset -> if true will start with a <frameset>
3120: rather than <body>
3121: =back
3122:
3123: =cut
3124:
3125: sub start_page {
3126: my ($title,$head_extra,$args) = @_;
3127: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
3128: my %head_args;
3129: foreach my $arg ('redirect','force_register') {
3130: if (defined($args->{$arg})) {
3131: $head_args{$arg} = $args->{$arg};
3132: }
3133: }
3134:
3135: $env{'internal.start_page'}++;
3136: my $result =
3137: &Apache::lonxml::xmlbegin().
3138: &headtag($title,$head_extra,\%head_args).&endheadtag();
3139: if ($args->{'frameset'}) {
3140: my $attr_string = &make_attr_string($args->{'force_register'},
3141: $args->{'add_entries'});
3142: $result .= "\n<frameset $attr_string>\n";
3143: } else {
3144: $result .=
3145: &bodytag($title,
3146: $args->{'function'}, $args->{'add_entries'},
3147: $args->{'only_body'}, $args->{'domain'},
3148: $args->{'force_register'}, $args->{'body_title'},
3149: $args->{'no_nav_bar'}, $args->{'bgcolor'});
3150: }
3151: if ($args->{'js_ready'}) {
3152: $result = &js_ready($result);
3153: }
3154: if ($args->{'html_encode'}) {
3155: $result = &html_encode($result);
3156: }
3157: return $result;
3158: }
3159:
3160:
3161: =pod
3162:
3163: =over 4
3164:
3165: =item * &head()
3166:
3167: Returns a complete </body></html> section for LON-CAPA web pages.
3168:
3169: Inputs: $args - additional optional args supported are:
3170: js_ready -> return a string ready for being used in
3171: a javascript writeln
3172: html_encode -> return a string ready for being used in
3173: a html attribute
3174: frameset -> if true will start with a <frameset>
3175: rather than <body>
3176: =back
3177:
3178: =cut
3179:
3180: sub end_page {
3181: my ($args) = @_;
3182: #&Apache::lonnet::logthis("end_page ".join(':',caller(0)));
3183: $env{'internal.end_page'}++;
3184: my $result;
3185: if ($args->{'frameset'}) {
3186: $result .= '</frameset>';
3187: } else {
3188: $result .= &endbodytag();
3189: }
3190: $result .= "\n</html>";
3191:
3192: if ($args->{'js_ready'}) {
3193: $result = &js_ready($result);
3194: }
3195: if ($args->{'html_encode'}) {
3196: $result = &html_encode($result);
3197: }
3198: return $result;
3199: }
3200:
3201: sub html_encode {
3202: my ($result) = @_;
3203:
3204: $result = &HTML::Entities::encode($result,'<>&"');
3205:
3206: return $result;
3207: }
3208: sub js_ready {
3209: my ($result) = @_;
3210:
3211: $result =~ s/[\n\r]/ /xmsg;
3212: $result =~ s/\\/\\\\/xmsg;
3213: $result =~ s/'/\\'/xmsg;
3214: $result =~ s{</script>}{</scrip'+'t>}xmsg;
3215:
3216: return $result;
3217: }
3218:
3219: sub validate_page {
3220: if ( exists($env{'internal.start_page'})
3221: && $env{'internal.start_page'} > 1) {
3222: &Apache::lonnet::logthis('start_page called multiple times '.
3223: $env{'internal.start_page'}.' '.
3224: $ENV{'request.filename'});
3225: }
3226: if ( exists($env{'internal.end_page'})
3227: && $env{'internal.end_page'} > 1) {
3228: &Apache::lonnet::logthis('end_page called multiple times '.
3229: $env{'internal.end_page'}.' '.
3230: $env{'request.filename'});
3231: }
3232: if ( exists($env{'internal.start_page'})
3233: && ! exists($env{'internal.end_page'})) {
3234: &Apache::lonnet::logthis('start_page called without end_page '.
3235: $env{'request.filename'});
3236: }
3237: if ( ! exists($env{'internal.start_page'})
3238: && exists($env{'internal.end_page'})) {
3239: &Apache::lonnet::logthis('end_page called without start_page'.
3240: $env{'request.filename'});
3241: }
3242: }
3243:
3244: sub simple_error_page {
3245: my ($r,$title,$msg) = @_;
3246: my $page =
3247: &Apache::loncommon::start_page($title).
3248: &mt($msg).
3249: &Apache::loncommon::end_page();
3250: if (ref($r)) {
3251: $r->print($page);
3252: return;
3253: }
3254: return $page;
3255: }
3256: ###############################################
3257:
3258: =pod
3259:
3260: =over 4
3261:
3262: =item get_users_function
3263:
3264: Used by &bodytag to determine the current users primary role.
3265: Returns either 'student','coordinator','admin', or 'author'.
3266:
3267: =cut
3268:
3269: ###############################################
3270: sub get_users_function {
3271: my $function = 'student';
3272: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
3273: $function='coordinator';
3274: }
3275: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
3276: $function='admin';
3277: }
3278: if (($env{'request.role'}=~/^(au|ca)/) ||
3279: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
3280: $function='author';
3281: }
3282: return $function;
3283: }
3284:
3285: ###############################################
3286:
3287: =pod
3288:
3289: =item check_user_status
3290:
3291: Determines current status of supplied role for a
3292: specific user. Roles can be active, previous or future.
3293:
3294: Inputs:
3295: user's domain, user's username, course's domain,
3296: course's number, optional section/group.
3297:
3298: Outputs:
3299: role status: active, previous or future.
3300:
3301: =cut
3302:
3303: sub check_user_status {
3304: my ($udom,$uname,$cdom,$crs,$role,$secgrp) = @_;
3305: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
3306: my @uroles = keys %userinfo;
3307: my $srchstr;
3308: my $active_chk = 'none';
3309: if (@uroles > 0) {
3310: if (($role eq 'cc') || ($secgrp eq '') || (!defined($secgrp))) {
3311: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
3312: } else {
3313: $srchstr = '/'.$cdom.'/'.$crs.'/'.$secgrp.'_'.$role; }
3314: if (grep/^$srchstr$/,@uroles) {
3315: my $role_end = 0;
3316: my $role_start = 0;
3317: $active_chk = 'active';
3318: if ($userinfo{$srchstr} =~ m/^($role)_(\d+)/) {
3319: $role_end = $2;
3320: if ($userinfo{$srchstr} =~ m/^($role)_($role_end)_(\d+)$/) {
3321: $role_start = $3;
3322: }
3323: }
3324: if ($role_start > 0) {
3325: if (time < $role_start) {
3326: $active_chk = 'future';
3327: }
3328: }
3329: if ($role_end > 0) {
3330: if (time > $role_end) {
3331: $active_chk = 'previous';
3332: }
3333: }
3334: }
3335: }
3336: return $active_chk;
3337: }
3338:
3339: ###############################################
3340:
3341: =pod
3342:
3343: =item get_sections
3344:
3345: Determines all the sections for a course including
3346: sections with students and sections containing other roles.
3347: Incoming parameters: domain, course number, reference to
3348: section hash (keys to be section/group IDs), reference to
3349: array containing roles for which sections should be gathered
3350: (optional). If the fourth argument is undefined, sections
3351: are gathered for any role.
3352:
3353: Returns number of sections.
3354:
3355: =cut
3356:
3357: ###############################################
3358: sub get_sections {
3359: my ($cdom,$cnum,$sectioncount,$possible_roles) = @_;
3360: if (!($cdom && $cnum)) { return 0; }
3361: my $numsections = 0;
3362:
3363: if (!defined($possible_roles) || (grep/^st$/,@$possible_roles)) {
3364: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
3365: my $sec_index = &Apache::loncoursedata::CL_SECTION();
3366: my $status_index = &Apache::loncoursedata::CL_STATUS();
3367: while (my ($student,$data) = each %$classlist) {
3368: my ($section,$status) = ($data->[$sec_index],
3369: $data->[$status_index]);
3370: unless ($section eq '-1' || $section =~ /^\s*$/) {
3371: if (!defined($$sectioncount{$section})) { $numsections++; }
3372: $$sectioncount{$section}++;
3373: }
3374: }
3375: }
3376: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
3377: foreach my $user (sort(keys(%courseroles))) {
3378: if ($user !~ /^(\w{2})/) { next; }
3379: my ($role) = ($user =~ /^(\w{2})/);
3380: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
3381: my $section;
3382: if ($role eq 'cr' &&
3383: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
3384: $section=$1;
3385: }
3386: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
3387: if (!defined($section) || $section eq '-1') { next; }
3388: if (!defined($$sectioncount{$section})) { $numsections++; }
3389: $$sectioncount{$section}++;
3390: }
3391: return $numsections;
3392: }
3393:
3394: ###############################################
3395:
3396: =pod
3397:
3398: =item coursegroups
3399:
3400: Retrieve information about groups in a course,
3401:
3402: Input:
3403: 1. Reference to hash to populate with group information.
3404: 2. Optional course domain
3405: 3. Optional course number
3406: 4. Optional group name
3407:
3408: Course domain and number will be taken from user's
3409: environment if not supplied. Optional group name will'
3410: be passed to lonnet::get_coursegroups() as a regexp to
3411: use in the call to the dump function.
3412:
3413: Output
3414: Returns number of groups in the course (subject to the
3415: optional group name filter).
3416:
3417: Side effects:
3418: Populates the referenced curr_groups hash, with key,
3419: value pairs. Keys are group names, corresponding values
3420: are scalars containing group information in XML. This
3421: can be sent to &get_group_settings() to be parsed.
3422:
3423: =cut
3424:
3425: ###############################################
3426:
3427: sub coursegroups {
3428: my ($curr_groups,$cdom,$cnum,$group) = @_;
3429: my $numgroups;
3430: if (!defined($cdom) || !defined($cnum)) {
3431: my $cid = $env{'request.course.id'};
3432: $cdom = $env{'course.'.$cid.'.domain'};
3433: $cnum = $env{'course.'.$cid.'.num'};
3434: }
3435: %{$curr_groups} = &Apache::lonnet::get_coursegroups($cdom,$cnum,$group);
3436: my ($tmp) = keys(%{$curr_groups});
3437: if ($tmp=~/^error:/) {
3438: unless ($tmp eq 'error: 2 tie(GDBM) Failed while attempting dump') {
3439: &logthis('Error retrieving groups: '.$tmp.' in '.$cnum.':'.
3440: $cdom);
3441: }
3442: $numgroups = 0;
3443: } else {
3444: $numgroups = keys(%{$curr_groups});
3445: }
3446: return $numgroups;
3447: }
3448:
3449: ###############################################
3450:
3451: =pod
3452:
3453: =item get_group_settings
3454:
3455: Uses TokeParser to extract group information from the
3456: XML used to describe course groups.
3457:
3458: Input:
3459: Scalar containing XML - as retrieved from &coursegroups().
3460:
3461: Output:
3462: Hash containing group information as key=values for (a), and
3463: hash of hashes for (b)
3464:
3465: Keys (in two categories):
3466: (a) groupname, creator, creation, modified, startdate,enddate.
3467: Corresponding values are name of the group, creator of the group
3468: (username:domain), UNIX time for date group was created, and
3469: settings were last modified, and default start and end access
3470: times for group members.
3471:
3472: (b) functions returned in hash of hashes.
3473: Outer hash key is functions.
3474: Inner hash keys are chat,discussion,email,files,homepage,roster.
3475: Corresponding values are either on or off, depending on
3476: whether this type of functionality is available for the group.
3477:
3478: =cut
3479:
3480: ###############################################
3481:
3482: sub get_group_settings {
3483: my ($groupinfo)=@_;
3484: my $parser=HTML::TokeParser->new(\$groupinfo);
3485: my $token;
3486: my $tool = '';
3487: my $role = '';
3488: my %content=();
3489: while ($token=$parser->get_token) {
3490: if ($token->[0] eq 'S') {
3491: my $entry=$token->[1];
3492: if ($entry eq 'functions' || $entry eq 'autosec') {
3493: %{$content{$entry}} = ();
3494: $tool = $entry;
3495: } elsif ($entry eq 'role') {
3496: if ($tool eq 'autosec') {
3497: $role = $token->[2]{id};
3498: }
3499: } else {
3500: my $value=$parser->get_text('/'.$entry);
3501: if ($entry eq 'name') {
3502: if ($tool eq 'functions') {
3503: my $function = $token->[2]{id};
3504: $content{$tool}{$function} = $value;
3505: }
3506: } elsif ($entry eq 'groupname') {
3507: $content{$entry}=&Apache::lonnet::unescape($value);
3508: } elsif (($entry eq 'roles') || ($entry eq 'types') ||
3509: ($entry eq 'sectionpick') || ($entry eq 'defpriv')) {
3510: push(@{$content{$entry}},$value);
3511: } elsif ($entry eq 'section') {
3512: if ($tool eq 'autosec' && $role ne '') {
3513: push(@{$content{$tool}{$role}},$value);
3514: }
3515: } else {
3516: $content{$entry}=$value;
3517: }
3518: }
3519: } elsif ($token->[0] eq 'E') {
3520: if ($token->[1] eq 'functions' || $token->[1] eq 'autosec') {
3521: $tool = '';
3522: } elsif ($token->[1] eq 'role') {
3523: $role = '';
3524: }
3525:
3526: }
3527: }
3528: return %content;
3529: }
3530:
3531: sub check_group_access {
3532: my ($group) = @_;
3533: my $access = 1;
3534: my $now = time;
3535: my ($start,$end) = split(/\./,$env{'user.role.gr/'.$env{'request.course,id'}.'/'.$group});
3536: if (($end!=0) && ($end<$now)) { $access = 0; }
3537: if (($start!=0) && ($start>$now)) { $access=0; }
3538: return $access;
3539: }
3540:
3541: ###############################################
3542:
3543: =pod
3544:
3545: =item get_course_users
3546:
3547: Retrieves usernames:domains for users in the specified course
3548: with specific role(s), and access status.
3549:
3550: Incoming parameters:
3551: 1. course domain
3552: 2. course number
3553: 3. access status: users must have - either active,
3554: previous, future, or all.
3555: 4. reference to array of permissible roles
3556: 5. reference to array of section restrictions (optional)
3557: 6. reference to results object (hash of hashes).
3558: 7. reference to optional userdata hash
3559: Keys of top level hash are roles.
3560: Keys of inner hashes are username:domain, with
3561: values set to access type.
3562: Optional userdata hash returns an array with arguments in the
3563: same order as loncoursedata::get_classlist() for student data.
3564:
3565: Entries for end, start, section and status are blank because
3566: of the possibility of multiple values for non-student roles.
3567:
3568: =cut
3569:
3570: ###############################################
3571:
3572: sub get_course_users {
3573: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata) = @_;
3574: my %idx = ();
3575:
3576: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
3577: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
3578: $idx{end} = &Apache::loncoursedata::CL_END();
3579: $idx{start} = &Apache::loncoursedata::CL_START();
3580: $idx{id} = &Apache::loncoursedata::CL_ID();
3581: $idx{section} = &Apache::loncoursedata::CL_SECTION();
3582: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
3583: $idx{status} = &Apache::loncoursedata::CL_STATUS();
3584:
3585: if (grep(/^st$/,@{$roles})) {
3586: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
3587: my $now = time;
3588: foreach my $student (keys(%{$classlist})) {
3589: my $match = 0;
3590: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
3591: unless(grep(/^\Q$$classlist{$student}[$idx{section}]\E$/,
3592: @{$sections})) {
3593: next;
3594: }
3595: }
3596: if (defined($$types{'active'})) {
3597: if ($$classlist{$student}[$idx{status}] eq 'Active') {
3598: push(@{$$users{st}{$student}},'active');
3599: $match = 1;
3600: }
3601: }
3602: if (defined($$types{'previous'})) {
3603: if ($$classlist{$student}[$idx{end}] <= $now) {
3604: push(@{$$users{st}{$student}},'previous');
3605: $match = 1;
3606: }
3607: }
3608: if (defined($$types{'future'})) {
3609: if (($$classlist{$student}[$idx{start}] > $now) && ($$classlist{$student}[$idx{end}] > $now) || ($$classlist{$student}[$idx{end}] == 0) || ($$classlist{$student}[$idx{end}] eq '')) {
3610: push(@{$$users{st}{$student}},'future');
3611: $match = 1;
3612: }
3613: }
3614: if ($match && defined($userdata)) {
3615: $$userdata{$student} = $$classlist{$student};
3616: }
3617: }
3618: }
3619: if ((@{$roles} > 0) && (@{$roles} ne "st")) {
3620: my @coursepersonnel = &Apache::lonnet::getkeys('nohist_userroles',$cdom,$cnum);
3621: foreach my $person (@coursepersonnel) {
3622: my $match = 0;
3623: my ($role,$user) = ($person =~ /^([^:]*):([^:]+:[^:]+)/);
3624: $user =~ s/:$//;
3625: if (($role) && (grep(/^\Q$role\E$/,@{$roles}))) {
3626: my ($uname,$udom,$usec) = split(/:/,$user);
3627: if ($usec ne '' && (ref($sections) eq 'ARRAY') &&
3628: @{$sections} > 0) {
3629: unless(grep(/^\Q$usec\E$/,@{$sections})) {
3630: next;
3631: }
3632: }
3633: if ($uname ne '' && $udom ne '') {
3634: my $status = &check_user_status($udom,$uname,$cdom,$cnum,$role);
3635: foreach my $type (keys(%{$types})) {
3636: if ($status eq $type) {
3637: @{$$users{$role}{$user}} = $type;
3638: $match = 1;
3639: }
3640: }
3641: if ($match && defined($userdata) &&
3642: !exists($$userdata{$uname.':'.$udom})) {
3643: &get_user_info($udom,$uname,\%idx,$userdata);
3644: }
3645: }
3646: }
3647: }
3648: if (grep(/^ow$/,@{$roles})) {
3649: if ((defined($cdom)) && (defined($cnum))) {
3650: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
3651: if ( defined($csettings{'internal.courseowner'}) ) {
3652: my $owner = $csettings{'internal.courseowner'};
3653: @{$$users{'ow'}{$owner.':'.$cdom}} = 'any';
3654: if (defined($userdata) &&
3655: !exists($$userdata{$owner.':'.$cdom})) {
3656: &get_user_info($cdom,$owner,\%idx,$userdata);
3657: }
3658: }
3659: }
3660: }
3661: }
3662: return;
3663: }
3664:
3665: sub get_user_info {
3666: my ($udom,$uname,$idx,$userdata) = @_;
3667: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
3668: &plainname($uname,$udom,'lastname');
3669: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
3670: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
3671: return;
3672: }
3673:
3674: ###############################################
3675:
3676: sub get_posted_cgi {
3677: my $r=shift;
3678:
3679: my $buffer;
3680: if ($r->header_in('Content-length')) {
3681: $r->read($buffer,$r->header_in('Content-length'),0);
3682: }
3683: unless ($buffer=~/^(\-+\w+)\s+Content\-Disposition\:\s*form\-data/si) {
3684: my @pairs=split(/&/,$buffer);
3685: my $pair;
3686: foreach $pair (@pairs) {
3687: my ($name,$value) = split(/=/,$pair);
3688: $value =~ tr/+/ /;
3689: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
3690: $name =~ tr/+/ /;
3691: $name =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
3692: &add_to_env("form.$name",$value);
3693: }
3694: } else {
3695: my $contentsep=$1;
3696: my @lines = split (/\n/,$buffer);
3697: my $name='';
3698: my $value='';
3699: my $fname='';
3700: my $fmime='';
3701: my $i;
3702: for ($i=0;$i<=$#lines;$i++) {
3703: if ($lines[$i]=~/^$contentsep/) {
3704: if ($name) {
3705: chomp($value);
3706: if ($fname) {
3707: $env{"form.$name.filename"}=$fname;
3708: $env{"form.$name.mimetype"}=$fmime;
3709: } else {
3710: $value=~s/\s+$//s;
3711: }
3712: &add_to_env("form.$name",$value);
3713: }
3714: if ($i<$#lines) {
3715: $i++;
3716: $lines[$i]=~
3717: /Content\-Disposition\:\s*form\-data\;\s*name\=\"([^\"]+)\"/i;
3718: $name=$1;
3719: $value='';
3720: if ($lines[$i]=~/filename\=\"([^\"]+)\"/i) {
3721: $fname=$1;
3722: if
3723: ($lines[$i+1]=~/Content\-Type\:\s*([\w\-\/]+)/i) {
3724: $fmime=$1;
3725: $i++;
3726: } else {
3727: $fmime='';
3728: }
3729: } else {
3730: $fname='';
3731: $fmime='';
3732: }
3733: $i++;
3734: }
3735: } else {
3736: $value.=$lines[$i]."\n";
3737: }
3738: }
3739: }
3740: #
3741: # Digested POSTed values
3742: #
3743: # Remember the way this was originally done (GET or POST)
3744: #
3745: $env{'request.method'}=$ENV{'REQUEST_METHOD'};
3746: #
3747: # There may also be stuff in the query string
3748: # Tell subsequent handlers that this was GET, not POST, so they can access query string.
3749: # Also, unset POSTed content length to cover all tracks.
3750: #
3751:
3752: # This does not work, because M_GET is not defined (if it's defined, it is just 0).
3753: # Commenting out for now ... not sure if harm is done.
3754: # $r->method_number(M_GET);
3755:
3756: $r->method('GET');
3757: $r->headers_in->unset('Content-length');
3758: }
3759:
3760: =pod
3761:
3762: =item * get_unprocessed_cgi($query,$possible_names)
3763:
3764: Modify the %env hash to contain unprocessed CGI form parameters held in
3765: $query. The parameters listed in $possible_names (an array reference),
3766: will be set in $env{'form.name'} if they do not already exist.
3767:
3768: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
3769: $possible_names is an ref to an array of form element names. As an example:
3770: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
3771: will result in $env{'form.uname'} and $env{'form.udom'} being set.
3772:
3773: =cut
3774:
3775: sub get_unprocessed_cgi {
3776: my ($query,$possible_names)= @_;
3777: # $Apache::lonxml::debug=1;
3778: foreach (split(/&/,$query)) {
3779: my ($name, $value) = split(/=/,$_);
3780: $name = &Apache::lonnet::unescape($name);
3781: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
3782: $value =~ tr/+/ /;
3783: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
3784: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
3785: }
3786: }
3787: }
3788:
3789: =pod
3790:
3791: =item * cacheheader()
3792:
3793: returns cache-controlling header code
3794:
3795: =cut
3796:
3797: sub cacheheader {
3798: unless ($env{'request.method'} eq 'GET') { return ''; }
3799: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
3800: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
3801: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
3802: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
3803: return $output;
3804: }
3805:
3806: =pod
3807:
3808: =item * no_cache($r)
3809:
3810: specifies header code to not have cache
3811:
3812: =cut
3813:
3814: sub no_cache {
3815: my ($r) = @_;
3816: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
3817: $env{'request.method'} ne 'GET') { return ''; }
3818: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
3819: $r->no_cache(1);
3820: $r->header_out("Expires" => $date);
3821: $r->header_out("Pragma" => "no-cache");
3822: }
3823:
3824: sub content_type {
3825: my ($r,$type,$charset) = @_;
3826: if ($r) {
3827: # Note that printout.pl calls this with undef for $r.
3828: &no_cache($r);
3829: }
3830: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
3831: unless ($charset) {
3832: $charset=&Apache::lonlocal::current_encoding;
3833: }
3834: if ($charset) { $type.='; charset='.$charset; }
3835: if ($r) {
3836: $r->content_type($type);
3837: } else {
3838: print("Content-type: $type\n\n");
3839: }
3840: }
3841:
3842: =pod
3843:
3844: =item * add_to_env($name,$value)
3845:
3846: adds $name to the %env hash with value
3847: $value, if $name already exists, the entry is converted to an array
3848: reference and $value is added to the array.
3849:
3850: =cut
3851:
3852: sub add_to_env {
3853: my ($name,$value)=@_;
3854: if (defined($env{$name})) {
3855: if (ref($env{$name})) {
3856: #already have multiple values
3857: push(@{ $env{$name} },$value);
3858: } else {
3859: #first time seeing multiple values, convert hash entry to an arrayref
3860: my $first=$env{$name};
3861: undef($env{$name});
3862: push(@{ $env{$name} },$first,$value);
3863: }
3864: } else {
3865: $env{$name}=$value;
3866: }
3867: }
3868:
3869: =pod
3870:
3871: =item * get_env_multiple($name)
3872:
3873: gets $name from the %env hash, it seemlessly handles the cases where multiple
3874: values may be defined and end up as an array ref.
3875:
3876: returns an array of values
3877:
3878: =cut
3879:
3880: sub get_env_multiple {
3881: my ($name) = @_;
3882: my @values;
3883: if (defined($env{$name})) {
3884: # exists is it an array
3885: if (ref($env{$name})) {
3886: @values=@{ $env{$name} };
3887: } else {
3888: $values[0]=$env{$name};
3889: }
3890: }
3891: return(@values);
3892: }
3893:
3894:
3895: =pod
3896:
3897: =back
3898:
3899: =head1 CSV Upload/Handling functions
3900:
3901: =over 4
3902:
3903: =item * upfile_store($r)
3904:
3905: Store uploaded file, $r should be the HTTP Request object,
3906: needs $env{'form.upfile'}
3907: returns $datatoken to be put into hidden field
3908:
3909: =cut
3910:
3911: sub upfile_store {
3912: my $r=shift;
3913: $env{'form.upfile'}=~s/\r/\n/gs;
3914: $env{'form.upfile'}=~s/\f/\n/gs;
3915: $env{'form.upfile'}=~s/\n+/\n/gs;
3916: $env{'form.upfile'}=~s/\n+$//gs;
3917:
3918: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
3919: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
3920: {
3921: my $datafile = $r->dir_config('lonDaemons').
3922: '/tmp/'.$datatoken.'.tmp';
3923: if ( open(my $fh,">$datafile") ) {
3924: print $fh $env{'form.upfile'};
3925: close($fh);
3926: }
3927: }
3928: return $datatoken;
3929: }
3930:
3931: =pod
3932:
3933: =item * load_tmp_file($r)
3934:
3935: Load uploaded file from tmp, $r should be the HTTP Request object,
3936: needs $env{'form.datatoken'},
3937: sets $env{'form.upfile'} to the contents of the file
3938:
3939: =cut
3940:
3941: sub load_tmp_file {
3942: my $r=shift;
3943: my @studentdata=();
3944: {
3945: my $studentfile = $r->dir_config('lonDaemons').
3946: '/tmp/'.$env{'form.datatoken'}.'.tmp';
3947: if ( open(my $fh,"<$studentfile") ) {
3948: @studentdata=<$fh>;
3949: close($fh);
3950: }
3951: }
3952: $env{'form.upfile'}=join('',@studentdata);
3953: }
3954:
3955: =pod
3956:
3957: =item * upfile_record_sep()
3958:
3959: Separate uploaded file into records
3960: returns array of records,
3961: needs $env{'form.upfile'} and $env{'form.upfiletype'}
3962:
3963: =cut
3964:
3965: sub upfile_record_sep {
3966: if ($env{'form.upfiletype'} eq 'xml') {
3967: } else {
3968: my @records;
3969: foreach my $line (split(/\n/,$env{'form.upfile'})) {
3970: if ($line=~/^\s*$/) { next; }
3971: push(@records,$line);
3972: }
3973: return @records;
3974: }
3975: }
3976:
3977: =pod
3978:
3979: =item * record_sep($record)
3980:
3981: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
3982:
3983: =cut
3984:
3985: sub takeleft {
3986: my $index=shift;
3987: return substr('0000'.$index,-4,4);
3988: }
3989:
3990: sub record_sep {
3991: my $record=shift;
3992: my %components=();
3993: if ($env{'form.upfiletype'} eq 'xml') {
3994: } elsif ($env{'form.upfiletype'} eq 'space') {
3995: my $i=0;
3996: foreach (split(/\s+/,$record)) {
3997: my $field=$_;
3998: $field=~s/^(\"|\')//;
3999: $field=~s/(\"|\')$//;
4000: $components{&takeleft($i)}=$field;
4001: $i++;
4002: }
4003: } elsif ($env{'form.upfiletype'} eq 'tab') {
4004: my $i=0;
4005: foreach (split(/\t/,$record)) {
4006: my $field=$_;
4007: $field=~s/^(\"|\')//;
4008: $field=~s/(\"|\')$//;
4009: $components{&takeleft($i)}=$field;
4010: $i++;
4011: }
4012: } else {
4013: my @allfields=split(/\,/,$record);
4014: my $i=0;
4015: my $j;
4016: for ($j=0;$j<=$#allfields;$j++) {
4017: my $field=$allfields[$j];
4018: if ($field=~/^\s*(\"|\')/) {
4019: my $delimiter=$1;
4020: while (($field!~/$delimiter$/) && ($j<$#allfields)) {
4021: $j++;
4022: $field.=','.$allfields[$j];
4023: }
4024: $field=~s/^\s*$delimiter//;
4025: $field=~s/$delimiter\s*$//;
4026: }
4027: $components{&takeleft($i)}=$field;
4028: $i++;
4029: }
4030: }
4031: return %components;
4032: }
4033:
4034: ######################################################
4035: ######################################################
4036:
4037: =pod
4038:
4039: =item * upfile_select_html()
4040:
4041: Return HTML code to select a file from the users machine and specify
4042: the file type.
4043:
4044: =cut
4045:
4046: ######################################################
4047: ######################################################
4048: sub upfile_select_html {
4049: my %Types = (
4050: csv => &mt('CSV (comma separated values, spreadsheet)'),
4051: space => &mt('Space separated'),
4052: tab => &mt('Tabulator separated'),
4053: # xml => &mt('HTML/XML'),
4054: );
4055: my $Str = '<input type="file" name="upfile" size="50" />'.
4056: '<br />Type: <select name="upfiletype">';
4057: foreach my $type (sort(keys(%Types))) {
4058: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
4059: }
4060: $Str .= "</select>\n";
4061: return $Str;
4062: }
4063:
4064: sub get_samples {
4065: my ($records,$toget) = @_;
4066: my @samples=({});
4067: my $got=0;
4068: foreach my $rec (@$records) {
4069: my %temp = &record_sep($rec);
4070: if (! grep(/\S/, values(%temp))) { next; }
4071: if (%temp) {
4072: $samples[$got]=\%temp;
4073: $got++;
4074: if ($got == $toget) { last; }
4075: }
4076: }
4077: return \@samples;
4078: }
4079:
4080: ######################################################
4081: ######################################################
4082:
4083: =pod
4084:
4085: =item * csv_print_samples($r,$records)
4086:
4087: Prints a table of sample values from each column uploaded $r is an
4088: Apache Request ref, $records is an arrayref from
4089: &Apache::loncommon::upfile_record_sep
4090:
4091: =cut
4092:
4093: ######################################################
4094: ######################################################
4095: sub csv_print_samples {
4096: my ($r,$records) = @_;
4097: my $samples = &get_samples($records,3);
4098:
4099: $r->print(&mt('Samples').'<br /><table border="2"><tr>');
4100: foreach (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
4101: $r->print('<th>'.&mt('Column [_1]',($_+1)).'</th>'); }
4102: $r->print('</tr>');
4103: foreach my $hash (@$samples) {
4104: $r->print('<tr>');
4105: foreach (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
4106: $r->print('<td>');
4107: if (defined($$hash{$_})) { $r->print($$hash{$_}); }
4108: $r->print('</td>');
4109: }
4110: $r->print('</tr>');
4111: }
4112: $r->print('</tr></table><br />'."\n");
4113: }
4114:
4115: ######################################################
4116: ######################################################
4117:
4118: =pod
4119:
4120: =item * csv_print_select_table($r,$records,$d)
4121:
4122: Prints a table to create associations between values and table columns.
4123:
4124: $r is an Apache Request ref,
4125: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
4126: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
4127:
4128: =cut
4129:
4130: ######################################################
4131: ######################################################
4132: sub csv_print_select_table {
4133: my ($r,$records,$d) = @_;
4134: my $i=0;
4135: my $samples = &get_samples($records,1);
4136: $r->print(&mt('Associate columns with student attributes.')."\n".
4137: '<table border="2"><tr>'.
4138: '<th>'.&mt('Attribute').'</th>'.
4139: '<th>'.&mt('Column').'</th></tr>'."\n");
4140: foreach (@$d) {
4141: my ($value,$display,$defaultcol)=@{ $_ };
4142: $r->print('<tr><td>'.$display.'</td>');
4143:
4144: $r->print('<td><select name=f'.$i.
4145: ' onchange="javascript:flip(this.form,'.$i.');">');
4146: $r->print('<option value="none"></option>');
4147: foreach (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
4148: $r->print('<option value="'.$_.'"'.
4149: ($_ eq $defaultcol ? ' selected="selected" ' : '').
4150: '>Column '.($_+1).'</option>');
4151: }
4152: $r->print('</select></td></tr>'."\n");
4153: $i++;
4154: }
4155: $i--;
4156: return $i;
4157: }
4158:
4159: ######################################################
4160: ######################################################
4161:
4162: =pod
4163:
4164: =item * csv_samples_select_table($r,$records,$d)
4165:
4166: Prints a table of sample values from the upload and can make associate samples to internal names.
4167:
4168: $r is an Apache Request ref,
4169: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
4170: $d is an array of 2 element arrays (internal name, displayed name)
4171:
4172: =cut
4173:
4174: ######################################################
4175: ######################################################
4176: sub csv_samples_select_table {
4177: my ($r,$records,$d) = @_;
4178: my $i=0;
4179: #
4180: my $samples = &get_samples($records,3);
4181: $r->print('<table border=2><tr><th>'.
4182: &mt('Field').'</th><th>'.&mt('Samples').'</th></tr>');
4183:
4184: foreach my $key (sort(keys(%{ $samples->[0] }))) {
4185: $r->print('<tr><td><select name="f'.$i.'"'.
4186: ' onchange="javascript:flip(this.form,'.$i.');">');
4187: foreach my $option (@$d) {
4188: my ($value,$display,$defaultcol)=@{ $option };
4189: $r->print('<option value="'.$value.'"'.
4190: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
4191: $display.'</option>');
4192: }
4193: $r->print('</select></td><td>');
4194: foreach my $line (0..2) {
4195: if (defined($samples->[$line]{$key})) {
4196: $r->print($samples->[$line]{$key}."<br />\n");
4197: }
4198: }
4199: $r->print('</td></tr>');
4200: $i++;
4201: }
4202: $i--;
4203: return($i);
4204: }
4205:
4206: ######################################################
4207: ######################################################
4208:
4209: =pod
4210:
4211: =item clean_excel_name($name)
4212:
4213: Returns a replacement for $name which does not contain any illegal characters.
4214:
4215: =cut
4216:
4217: ######################################################
4218: ######################################################
4219: sub clean_excel_name {
4220: my ($name) = @_;
4221: $name =~ s/[:\*\?\/\\]//g;
4222: if (length($name) > 31) {
4223: $name = substr($name,0,31);
4224: }
4225: return $name;
4226: }
4227:
4228: =pod
4229:
4230: =item * check_if_partid_hidden($id,$symb,$udom,$uname)
4231:
4232: Returns either 1 or undef
4233:
4234: 1 if the part is to be hidden, undef if it is to be shown
4235:
4236: Arguments are:
4237:
4238: $id the id of the part to be checked
4239: $symb, optional the symb of the resource to check
4240: $udom, optional the domain of the user to check for
4241: $uname, optional the username of the user to check for
4242:
4243: =cut
4244:
4245: sub check_if_partid_hidden {
4246: my ($id,$symb,$udom,$uname) = @_;
4247: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
4248: $symb,$udom,$uname);
4249: my $truth=1;
4250: #if the string starts with !, then the list is the list to show not hide
4251: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
4252: my @hiddenlist=split(/,/,$hiddenparts);
4253: foreach my $checkid (@hiddenlist) {
4254: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
4255: }
4256: return !$truth;
4257: }
4258:
4259:
4260: ############################################################
4261: ############################################################
4262:
4263: =pod
4264:
4265: =back
4266:
4267: =head1 cgi-bin script and graphing routines
4268:
4269: =over 4
4270:
4271: =item get_cgi_id
4272:
4273: Inputs: none
4274:
4275: Returns an id which can be used to pass environment variables
4276: to various cgi-bin scripts. These environment variables will
4277: be removed from the users environment after a given time by
4278: the routine &Apache::lonnet::transfer_profile_to_env.
4279:
4280: =cut
4281:
4282: ############################################################
4283: ############################################################
4284: my $uniq=0;
4285: sub get_cgi_id {
4286: $uniq=($uniq+1)%100000;
4287: return (time.'_'.$$.'_'.$uniq);
4288: }
4289:
4290: ############################################################
4291: ############################################################
4292:
4293: =pod
4294:
4295: =item DrawBarGraph
4296:
4297: Facilitates the plotting of data in a (stacked) bar graph.
4298: Puts plot definition data into the users environment in order for
4299: graph.png to plot it. Returns an <img> tag for the plot.
4300: The bars on the plot are labeled '1','2',...,'n'.
4301:
4302: Inputs:
4303:
4304: =over 4
4305:
4306: =item $Title: string, the title of the plot
4307:
4308: =item $xlabel: string, text describing the X-axis of the plot
4309:
4310: =item $ylabel: string, text describing the Y-axis of the plot
4311:
4312: =item $Max: scalar, the maximum Y value to use in the plot
4313: If $Max is < any data point, the graph will not be rendered.
4314:
4315: =item $colors: array ref holding the colors to be used for the data sets when
4316: they are plotted. If undefined, default values will be used.
4317:
4318: =item $labels: array ref holding the labels to use on the x-axis for the bars.
4319:
4320: =item @Values: An array of array references. Each array reference holds data
4321: to be plotted in a stacked bar chart.
4322:
4323: =item If the final element of @Values is a hash reference the key/value
4324: pairs will be added to the graph definition.
4325:
4326: =back
4327:
4328: Returns:
4329:
4330: An <img> tag which references graph.png and the appropriate identifying
4331: information for the plot.
4332:
4333: =cut
4334:
4335: ############################################################
4336: ############################################################
4337: sub DrawBarGraph {
4338: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
4339: #
4340: if (! defined($colors)) {
4341: $colors = ['#33ff00',
4342: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
4343: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
4344: ];
4345: }
4346: my $extra_settings = {};
4347: if (ref($Values[-1]) eq 'HASH') {
4348: $extra_settings = pop(@Values);
4349: }
4350: #
4351: my $identifier = &get_cgi_id();
4352: my $id = 'cgi.'.$identifier;
4353: if (! @Values || ref($Values[0]) ne 'ARRAY') {
4354: return '';
4355: }
4356: #
4357: my @Labels;
4358: if (defined($labels)) {
4359: @Labels = @$labels;
4360: } else {
4361: for (my $i=0;$i<@{$Values[0]};$i++) {
4362: push (@Labels,$i+1);
4363: }
4364: }
4365: #
4366: my $NumBars = scalar(@{$Values[0]});
4367: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
4368: my %ValuesHash;
4369: my $NumSets=1;
4370: foreach my $array (@Values) {
4371: next if (! ref($array));
4372: $ValuesHash{$id.'.data.'.$NumSets++} =
4373: join(',',@$array);
4374: }
4375: #
4376: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
4377: if ($NumBars < 3) {
4378: $width = 120+$NumBars*32;
4379: $xskip = 1;
4380: $bar_width = 30;
4381: } elsif ($NumBars < 5) {
4382: $width = 120+$NumBars*20;
4383: $xskip = 1;
4384: $bar_width = 20;
4385: } elsif ($NumBars < 10) {
4386: $width = 120+$NumBars*15;
4387: $xskip = 1;
4388: $bar_width = 15;
4389: } elsif ($NumBars <= 25) {
4390: $width = 120+$NumBars*11;
4391: $xskip = 5;
4392: $bar_width = 8;
4393: } elsif ($NumBars <= 50) {
4394: $width = 120+$NumBars*8;
4395: $xskip = 5;
4396: $bar_width = 4;
4397: } else {
4398: $width = 120+$NumBars*8;
4399: $xskip = 5;
4400: $bar_width = 4;
4401: }
4402: #
4403: $Max = 1 if ($Max < 1);
4404: if ( int($Max) < $Max ) {
4405: $Max++;
4406: $Max = int($Max);
4407: }
4408: $Title = '' if (! defined($Title));
4409: $xlabel = '' if (! defined($xlabel));
4410: $ylabel = '' if (! defined($ylabel));
4411: $ValuesHash{$id.'.title'} = &Apache::lonnet::escape($Title);
4412: $ValuesHash{$id.'.xlabel'} = &Apache::lonnet::escape($xlabel);
4413: $ValuesHash{$id.'.ylabel'} = &Apache::lonnet::escape($ylabel);
4414: $ValuesHash{$id.'.y_max_value'} = $Max;
4415: $ValuesHash{$id.'.NumBars'} = $NumBars;
4416: $ValuesHash{$id.'.NumSets'} = $NumSets;
4417: $ValuesHash{$id.'.PlotType'} = 'bar';
4418: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
4419: $ValuesHash{$id.'.height'} = $height;
4420: $ValuesHash{$id.'.width'} = $width;
4421: $ValuesHash{$id.'.xskip'} = $xskip;
4422: $ValuesHash{$id.'.bar_width'} = $bar_width;
4423: $ValuesHash{$id.'.labels'} = join(',',@Labels);
4424: #
4425: # Deal with other parameters
4426: while (my ($key,$value) = each(%$extra_settings)) {
4427: $ValuesHash{$id.'.'.$key} = $value;
4428: }
4429: #
4430: &Apache::lonnet::appenv(%ValuesHash);
4431: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
4432: }
4433:
4434: ############################################################
4435: ############################################################
4436:
4437: =pod
4438:
4439: =item DrawXYGraph
4440:
4441: Facilitates the plotting of data in an XY graph.
4442: Puts plot definition data into the users environment in order for
4443: graph.png to plot it. Returns an <img> tag for the plot.
4444:
4445: Inputs:
4446:
4447: =over 4
4448:
4449: =item $Title: string, the title of the plot
4450:
4451: =item $xlabel: string, text describing the X-axis of the plot
4452:
4453: =item $ylabel: string, text describing the Y-axis of the plot
4454:
4455: =item $Max: scalar, the maximum Y value to use in the plot
4456: If $Max is < any data point, the graph will not be rendered.
4457:
4458: =item $colors: Array ref containing the hex color codes for the data to be
4459: plotted in. If undefined, default values will be used.
4460:
4461: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
4462:
4463: =item $Ydata: Array ref containing Array refs.
4464: Each of the contained arrays will be plotted as a separate curve.
4465:
4466: =item %Values: hash indicating or overriding any default values which are
4467: passed to graph.png.
4468: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
4469:
4470: =back
4471:
4472: Returns:
4473:
4474: An <img> tag which references graph.png and the appropriate identifying
4475: information for the plot.
4476:
4477: =cut
4478:
4479: ############################################################
4480: ############################################################
4481: sub DrawXYGraph {
4482: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
4483: #
4484: # Create the identifier for the graph
4485: my $identifier = &get_cgi_id();
4486: my $id = 'cgi.'.$identifier;
4487: #
4488: $Title = '' if (! defined($Title));
4489: $xlabel = '' if (! defined($xlabel));
4490: $ylabel = '' if (! defined($ylabel));
4491: my %ValuesHash =
4492: (
4493: $id.'.title' => &Apache::lonnet::escape($Title),
4494: $id.'.xlabel' => &Apache::lonnet::escape($xlabel),
4495: $id.'.ylabel' => &Apache::lonnet::escape($ylabel),
4496: $id.'.y_max_value'=> $Max,
4497: $id.'.labels' => join(',',@$Xlabels),
4498: $id.'.PlotType' => 'XY',
4499: );
4500: #
4501: if (defined($colors) && ref($colors) eq 'ARRAY') {
4502: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
4503: }
4504: #
4505: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
4506: return '';
4507: }
4508: my $NumSets=1;
4509: foreach my $array (@{$Ydata}){
4510: next if (! ref($array));
4511: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
4512: }
4513: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
4514: #
4515: # Deal with other parameters
4516: while (my ($key,$value) = each(%Values)) {
4517: $ValuesHash{$id.'.'.$key} = $value;
4518: }
4519: #
4520: &Apache::lonnet::appenv(%ValuesHash);
4521: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
4522: }
4523:
4524: ############################################################
4525: ############################################################
4526:
4527: =pod
4528:
4529: =item DrawXYYGraph
4530:
4531: Facilitates the plotting of data in an XY graph with two Y axes.
4532: Puts plot definition data into the users environment in order for
4533: graph.png to plot it. Returns an <img> tag for the plot.
4534:
4535: Inputs:
4536:
4537: =over 4
4538:
4539: =item $Title: string, the title of the plot
4540:
4541: =item $xlabel: string, text describing the X-axis of the plot
4542:
4543: =item $ylabel: string, text describing the Y-axis of the plot
4544:
4545: =item $colors: Array ref containing the hex color codes for the data to be
4546: plotted in. If undefined, default values will be used.
4547:
4548: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
4549:
4550: =item $Ydata1: The first data set
4551:
4552: =item $Min1: The minimum value of the left Y-axis
4553:
4554: =item $Max1: The maximum value of the left Y-axis
4555:
4556: =item $Ydata2: The second data set
4557:
4558: =item $Min2: The minimum value of the right Y-axis
4559:
4560: =item $Max2: The maximum value of the left Y-axis
4561:
4562: =item %Values: hash indicating or overriding any default values which are
4563: passed to graph.png.
4564: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
4565:
4566: =back
4567:
4568: Returns:
4569:
4570: An <img> tag which references graph.png and the appropriate identifying
4571: information for the plot.
4572:
4573: =cut
4574:
4575: ############################################################
4576: ############################################################
4577: sub DrawXYYGraph {
4578: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
4579: $Ydata2,$Min2,$Max2,%Values)=@_;
4580: #
4581: # Create the identifier for the graph
4582: my $identifier = &get_cgi_id();
4583: my $id = 'cgi.'.$identifier;
4584: #
4585: $Title = '' if (! defined($Title));
4586: $xlabel = '' if (! defined($xlabel));
4587: $ylabel = '' if (! defined($ylabel));
4588: my %ValuesHash =
4589: (
4590: $id.'.title' => &Apache::lonnet::escape($Title),
4591: $id.'.xlabel' => &Apache::lonnet::escape($xlabel),
4592: $id.'.ylabel' => &Apache::lonnet::escape($ylabel),
4593: $id.'.labels' => join(',',@$Xlabels),
4594: $id.'.PlotType' => 'XY',
4595: $id.'.NumSets' => 2,
4596: $id.'.two_axes' => 1,
4597: $id.'.y1_max_value' => $Max1,
4598: $id.'.y1_min_value' => $Min1,
4599: $id.'.y2_max_value' => $Max2,
4600: $id.'.y2_min_value' => $Min2,
4601: );
4602: #
4603: if (defined($colors) && ref($colors) eq 'ARRAY') {
4604: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
4605: }
4606: #
4607: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
4608: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
4609: return '';
4610: }
4611: my $NumSets=1;
4612: foreach my $array ($Ydata1,$Ydata2){
4613: next if (! ref($array));
4614: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
4615: }
4616: #
4617: # Deal with other parameters
4618: while (my ($key,$value) = each(%Values)) {
4619: $ValuesHash{$id.'.'.$key} = $value;
4620: }
4621: #
4622: &Apache::lonnet::appenv(%ValuesHash);
4623: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
4624: }
4625:
4626: ############################################################
4627: ############################################################
4628:
4629: =pod
4630:
4631: =back
4632:
4633: =head1 Statistics helper routines?
4634:
4635: Bad place for them but what the hell.
4636:
4637: =over 4
4638:
4639: =item &chartlink
4640:
4641: Returns a link to the chart for a specific student.
4642:
4643: Inputs:
4644:
4645: =over 4
4646:
4647: =item $linktext: The text of the link
4648:
4649: =item $sname: The students username
4650:
4651: =item $sdomain: The students domain
4652:
4653: =back
4654:
4655: =back
4656:
4657: =cut
4658:
4659: ############################################################
4660: ############################################################
4661: sub chartlink {
4662: my ($linktext, $sname, $sdomain) = @_;
4663: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
4664: '&SelectedStudent='.&Apache::lonnet::escape($sname.':'.$sdomain).
4665: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
4666: '">'.$linktext.'</a>';
4667: }
4668:
4669: #######################################################
4670: #######################################################
4671:
4672: =pod
4673:
4674: =head1 Course Environment Routines
4675:
4676: =over 4
4677:
4678: =item &restore_course_settings
4679:
4680: =item &store_course_settings
4681:
4682: Restores/Store indicated form parameters from the course environment.
4683: Will not overwrite existing values of the form parameters.
4684:
4685: Inputs:
4686: a scalar describing the data (e.g. 'chart', 'problem_analysis')
4687:
4688: a hash ref describing the data to be stored. For example:
4689:
4690: %Save_Parameters = ('Status' => 'scalar',
4691: 'chartoutputmode' => 'scalar',
4692: 'chartoutputdata' => 'scalar',
4693: 'Section' => 'array',
4694: 'StudentData' => 'array',
4695: 'Maps' => 'array');
4696:
4697: Returns: both routines return nothing
4698:
4699: =cut
4700:
4701: #######################################################
4702: #######################################################
4703: sub store_course_settings {
4704: # save to the environment
4705: # appenv the same items, just to be safe
4706: my $courseid = $env{'request.course.id'};
4707: my $udom = $env{'user.domain'};
4708: my $uname = $env{'user.name'};
4709: my ($prefix,$Settings) = @_;
4710: my %SaveHash;
4711: my %AppHash;
4712: while (my ($setting,$type) = each(%$Settings)) {
4713: my $basename = join('.','internal',$courseid,$prefix,$setting);
4714: my $envname = 'environment.'.$basename;
4715: if (exists($env{'form.'.$setting})) {
4716: # Save this value away
4717: if ($type eq 'scalar' &&
4718: (! exists($env{$envname}) ||
4719: $env{$envname} ne $env{'form.'.$setting})) {
4720: $SaveHash{$basename} = $env{'form.'.$setting};
4721: $AppHash{$envname} = $env{'form.'.$setting};
4722: } elsif ($type eq 'array') {
4723: my $stored_form;
4724: if (ref($env{'form.'.$setting})) {
4725: $stored_form = join(',',
4726: map {
4727: &Apache::lonnet::escape($_);
4728: } sort(@{$env{'form.'.$setting}}));
4729: } else {
4730: $stored_form =
4731: &Apache::lonnet::escape($env{'form.'.$setting});
4732: }
4733: # Determine if the array contents are the same.
4734: if ($stored_form ne $env{$envname}) {
4735: $SaveHash{$basename} = $stored_form;
4736: $AppHash{$envname} = $stored_form;
4737: }
4738: }
4739: }
4740: }
4741: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
4742: $udom,$uname);
4743: if ($put_result !~ /^(ok|delayed)/) {
4744: &Apache::lonnet::logthis('unable to save form parameters, '.
4745: 'got error:'.$put_result);
4746: }
4747: # Make sure these settings stick around in this session, too
4748: &Apache::lonnet::appenv(%AppHash);
4749: return;
4750: }
4751:
4752: sub restore_course_settings {
4753: my $courseid = $env{'request.course.id'};
4754: my ($prefix,$Settings) = @_;
4755: while (my ($setting,$type) = each(%$Settings)) {
4756: next if (exists($env{'form.'.$setting}));
4757: my $envname = 'environment.internal.'.$courseid.'.'.$prefix.
4758: '.'.$setting;
4759: if (exists($env{$envname})) {
4760: if ($type eq 'scalar') {
4761: $env{'form.'.$setting} = $env{$envname};
4762: } elsif ($type eq 'array') {
4763: $env{'form.'.$setting} = [
4764: map {
4765: &Apache::lonnet::unescape($_);
4766: } split(',',$env{$envname})
4767: ];
4768: }
4769: }
4770: }
4771: }
4772:
4773: ############################################################
4774: ############################################################
4775:
4776: sub propath {
4777: my ($udom,$uname)=@_;
4778: $udom=~s/\W//g;
4779: $uname=~s/\W//g;
4780: my $subdir=$uname.'__';
4781: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
4782: my $proname="$Apache::lonnet::perlvar{'lonUsersDir'}/$udom/$subdir/$uname";
4783: return $proname;
4784: }
4785:
4786: sub icon {
4787: my ($file)=@_;
4788: my $curfext = (split(/\./,$file))[-1];
4789: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
4790: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
4791: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
4792: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
4793: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
4794: $curfext.".gif") {
4795: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
4796: $curfext.".gif";
4797: }
4798: }
4799: return &lonhttpdurl($iconname);
4800: }
4801:
4802: sub lonhttpdurl {
4803: my ($url)=@_;
4804: my $lonhttpd_port=$Apache::lonnet::perlvar{'lonhttpdPort'};
4805: if (!defined($lonhttpd_port)) { $lonhttpd_port='8080'; }
4806: return 'http://'.$ENV{'SERVER_NAME'}.':'.$lonhttpd_port.$url;
4807: }
4808:
4809: sub connection_aborted {
4810: my ($r)=@_;
4811: $r->print(" ");$r->rflush();
4812: my $c = $r->connection;
4813: return $c->aborted();
4814: }
4815:
4816: # Escapes strings that may have embedded 's that will be put into
4817: # strings as 'strings'.
4818: sub escape_single {
4819: my ($input) = @_;
4820: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
4821: $input =~ s/\'/\\\'/g; # Esacpe the 's....
4822: return $input;
4823: }
4824:
4825: # Same as escape_single, but escape's "'s This
4826: # can be used for "strings"
4827: sub escape_double {
4828: my ($input) = @_;
4829: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
4830: $input =~ s/\"/\\\"/g; # Esacpe the "s....
4831: return $input;
4832: }
4833:
4834: # Escapes the last element of a full URL.
4835: sub escape_url {
4836: my ($url) = @_;
4837: my @urlslices = split(/\//, $url,-1);
4838: my $lastitem = &Apache::lonnet::escape(pop(@urlslices));
4839: return join('/',@urlslices).'/'.$lastitem;
4840: }
4841: =pod
4842:
4843: =back
4844:
4845: =cut
4846:
4847: 1;
4848: __END__;
4849:
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