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