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