1: # The LearningOnline Network with CAPA
2: # a pile of common html routines
3: #
4: # $Id: lonhtmlcommon.pm,v 1.23 2003/06/11 14:20:29 matthew 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: ######################################################################
30:
31: =pod
32:
33: =head1 NAME
34:
35: Apache::lonhtmlcommon - routines to do common html things
36:
37: =head1 SYNOPSIS
38:
39: Referenced by other mod_perl Apache modules.
40:
41: =head1 INTRODUCTION
42:
43: lonhtmlcommon is a collection of subroutines used to present information
44: in a consistent html format, or provide other functionality related to
45: html.
46:
47: =head2 General Subroutines
48:
49: =over 4
50:
51: =cut
52:
53: ######################################################################
54: ######################################################################
55:
56: package Apache::lonhtmlcommon;
57:
58: use Time::Local;
59: use strict;
60:
61: ##############################################
62: ##############################################
63:
64: =pod
65:
66: =item &date_setter
67:
68: &date_setter returns html and javascript for a compact date-setting form.
69: To retrieve values from it, use &get_date_from_form().
70:
71: Inputs
72:
73: =over 4
74:
75: =item $dname
76:
77: The name to prepend to the form elements.
78: The form elements defined will be dname_year, dname_month, dname_day,
79: dname_hour, dname_min, and dname_sec.
80:
81: =item $currentvalue
82:
83: The current setting for this time parameter. A unix format time
84: (time in seconds since the beginning of Jan 1st, 1970, GMT.
85: An undefined value is taken to indicate the value is the current time.
86: Also, to be explicit, a value of 'now' also indicates the current time.
87:
88: =back
89:
90: Bugs
91:
92: The method used to restrict user input will fail in the year 2400.
93:
94: =cut
95:
96: ##############################################
97: ##############################################
98: sub date_setter {
99: my ($formname,$dname,$currentvalue) = @_;
100: if (! defined($currentvalue) || $currentvalue eq 'now') {
101: $currentvalue = time;
102: }
103: # other potentially useful values: wkday,yrday,is_daylight_savings
104: my ($sec,$min,$hour,$mday,$month,$year,undef,undef,undef) =
105: localtime($currentvalue);
106: $year += 1900;
107: my $result = "\n<!-- $dname date setting form -->\n";
108: $result .= <<ENDJS;
109: <script language="Javascript">
110: function $dname\_checkday() {
111: var day = document.$formname.$dname\_day.value;
112: var month = document.$formname.$dname\_month.value;
113: var year = document.$formname.$dname\_year.value;
114: var valid = true;
115: if (day < 1) {
116: document.$formname.$dname\_day.value = 1;
117: }
118: if (day > 31) {
119: document.$formname.$dname\_day.value = 31;
120: }
121: if ((month == 1) || (month == 3) || (month == 5) ||
122: (month == 7) || (month == 8) || (month == 10) ||
123: (month == 12)) {
124: if (day > 31) {
125: document.$formname.$dname\_day.value = 31;
126: day = 31;
127: }
128: } else if (month == 2 ) {
129: if ((year % 4 == 0) && (year % 100 != 0)) {
130: if (day > 29) {
131: document.$formname.$dname\_day.value = 29;
132: }
133: } else if (day > 29) {
134: document.$formname.$dname\_day.value = 28;
135: }
136: } else if (day > 30) {
137: document.$formname.$dname\_day.value = 30;
138: }
139: }
140: </script>
141: ENDJS
142: $result .= " <select name=\"$dname\_month\" ".
143: "onChange=\"javascript:$dname\_checkday()\" >\n";
144: my @Months = qw/January February March April May June
145: July August September October November December/;
146: # Pad @Months with a bogus value to make indexing easier
147: unshift(@Months,'If you can read this an error occurred');
148: for(my $m = 1;$m <=$#Months;$m++) {
149: $result .= " <option value=\"$m\" ";
150: $result .= "selected " if ($m-1 == $month);
151: $result .= "> $Months[$m] </option>\n";
152: }
153: $result .= " </select>\n";
154: $result .= " <input type=\"text\" name=\"$dname\_day\" ".
155: "value=\"$mday\" size=\"3\" ".
156: "onChange=\"javascript:$dname\_checkday()\" />\n";
157: $result .= " <input type=\"year\" name=\"$dname\_year\" ".
158: "value=\"$year\" size=\"5\" ".
159: "onChange=\"javascript:$dname\_checkday()\" />\n";
160: $result .= " ";
161: $result .= " <select name=\"$dname\_hour\" >\n";
162: for (my $h = 0;$h<24;$h++) {
163: $result .= " <option value=\"$h\" ";
164: $result .= "selected " if ($hour == $h);
165: $result .= "> ";
166: if ($h == 0) {
167: $result .= "12 am";
168: } elsif($h == 12) {
169: $result .= "12 noon";
170: } elsif($h < 12) {
171: $result .= "$h am";
172: } else {
173: $result .= $h-12 ." pm";
174: }
175: $result .= " </option>\n";
176: }
177: $result .= " </select>\n";
178: $result .= " <input type=\"text\" name=\"$dname\_minute\" ".
179: "value=\"$min\" size=\"3\" /> m\n";
180: $result .= " <input type=\"text\" name=\"$dname\_second\" ".
181: "value=\"$sec\" size=\"3\" /> s\n";
182: $result .= "<!-- end $dname date setting form -->\n";
183: return $result;
184: }
185:
186: ##############################################
187: ##############################################
188:
189: =pod
190:
191: =item &get_date_from_form
192:
193: get_date_from_form retrieves the date specified in an &date_setter form.
194:
195: Inputs:
196:
197: =over 4
198:
199: =item $dname
200:
201: The name passed to &datesetter, which prefixes the form elements.
202:
203: =item $defaulttime
204:
205: The unix time to use as the default in case of poor inputs.
206:
207: =back
208:
209: Returns: Unix time represented in the form.
210:
211: =cut
212:
213: ##############################################
214: ##############################################
215: sub get_date_from_form {
216: my ($dname) = @_;
217: my ($sec,$min,$hour,$day,$month,$year);
218: #
219: if (defined($ENV{'form.'.$dname.'_second'})) {
220: my $tmpsec = $ENV{'form.'.$dname.'_second'};
221: if (($tmpsec =~ /^\d+$/) && ($tmpsec >= 0) && ($tmpsec < 60)) {
222: $sec = $tmpsec;
223: }
224: }
225: if (defined($ENV{'form.'.$dname.'_minute'})) {
226: my $tmpmin = $ENV{'form.'.$dname.'_minute'};
227: if (($tmpmin =~ /^\d+$/) && ($tmpmin >= 0) && ($tmpmin < 60)) {
228: $min = $tmpmin;
229: }
230: }
231: if (defined($ENV{'form.'.$dname.'_hour'})) {
232: my $tmphour = $ENV{'form.'.$dname.'_hour'};
233: if (($tmphour =~ /^\d+$/) && ($tmphour > 0) && ($tmphour < 32)) {
234: $hour = $tmphour;
235: }
236: }
237: if (defined($ENV{'form.'.$dname.'_day'})) {
238: my $tmpday = $ENV{'form.'.$dname.'_day'};
239: if (($tmpday =~ /^\d+$/) && ($tmpday > 0) && ($tmpday < 32)) {
240: $day = $tmpday;
241: }
242: }
243: if (defined($ENV{'form.'.$dname.'_month'})) {
244: my $tmpmonth = $ENV{'form.'.$dname.'_month'};
245: if (($tmpmonth =~ /^\d+$/) && ($tmpmonth > 0) && ($tmpmonth < 13)) {
246: $month = $tmpmonth - 1;
247: }
248: }
249: if (defined($ENV{'form.'.$dname.'_year'})) {
250: my $tmpyear = $ENV{'form.'.$dname.'_year'};
251: if (($tmpyear =~ /^\d+$/) && ($tmpyear > 1900)) {
252: $year = $tmpyear - 1900;
253: }
254: }
255: if (eval(&timelocal($sec,$min,$hour,$day,$month,$year))) {
256: return &timelocal($sec,$min,$hour,$day,$month,$year);
257: } else {
258: return undef;
259: }
260: }
261:
262: ##############################################
263: ##############################################
264:
265: =pod
266:
267: =item &pjump_javascript_definition()
268:
269: Returns javascript defining the 'pjump' function, which opens up a
270: parameter setting wizard.
271:
272: =cut
273:
274: ##############################################
275: ##############################################
276: sub pjump_javascript_definition {
277: my $Str = <<END;
278: function pjump(type,dis,value,marker,ret,call) {
279: parmwin=window.open("/adm/rat/parameter.html?type="+escape(type)
280: +"&value="+escape(value)+"&marker="+escape(marker)
281: +"&return="+escape(ret)
282: +"&call="+escape(call)+"&name="+escape(dis),"LONCAPAparms",
283: "height=350,width=350,scrollbars=no,menubar=no");
284: }
285: END
286: return $Str;
287: }
288:
289: ##############################################
290: ##############################################
291:
292: =pod
293:
294: =item &javascript_nothing()
295:
296: Return an appropriate null for the users browser. This is used
297: as the first arguement for window.open calls when you want a blank
298: window that you can then write to.
299:
300: =cut
301:
302: ##############################################
303: ##############################################
304: sub javascript_nothing {
305: # mozilla and other browsers work with "''", but IE on mac does not.
306: my $nothing = "''";
307: my $user_browser;
308: my $user_os;
309: $user_browser = $ENV{'browser.type'} if (exists($ENV{'browser.type'}));
310: $user_os = $ENV{'browser.os'} if (exists($ENV{'browser.os'}));
311: if (! defined($user_browser) || ! defined($user_os)) {
312: (undef,$user_browser,undef,undef,undef,$user_os) =
313: &Apache::loncommon::decode_user_agent();
314: }
315: if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
316: $nothing = "'javascript:void(0);'";
317: }
318: return $nothing;
319: }
320:
321:
322: ##############################################
323: ##############################################
324:
325: =pod
326:
327: =item &StatusOptions()
328:
329: Returns html for a selection box which allows the user to choose the
330: enrollment status of students. The selection box name is 'Status'.
331:
332: Inputs:
333:
334: $status: the currently selected status. If undefined the value of
335: $ENV{'form.Status'} is taken. If that is undefined, a value of 'Active'
336: is used.
337:
338: $formname: The name of the form. If defined the onchange attribute of
339: the selection box is set to document.$formname.submit().
340:
341: $size: the size (number of lines) of the selection box.
342:
343: Returns: a perl string as described.
344:
345: =cut
346:
347: ##############################################
348: ##############################################
349: sub StatusOptions {
350: my ($status, $formName,$size)=@_;
351: $size = 1 if (!defined($size));
352: if (! defined($status)) {
353: $status = 'Active';
354: $status = $ENV{'form.Status'} if (exists($ENV{'form.Status'}));
355: }
356:
357: my $OpSel1 = '';
358: my $OpSel2 = '';
359: my $OpSel3 = '';
360:
361: if($status eq 'Any') { $OpSel3 = ' selected'; }
362: elsif($status eq 'Expired' ) { $OpSel2 = ' selected'; }
363: else { $OpSel1 = ' selected'; }
364:
365: my $Str = '';
366: $Str .= '<select name="Status"';
367: if(defined($formName) && $formName ne '') {
368: $Str .= ' onchange="document.'.$formName.'.submit()"';
369: }
370: $Str .= ' size="'.$size.'" ';
371: $Str .= '>'."\n";
372: $Str .= '<option value="Active" '.$OpSel1.'>'.
373: 'Currently Enrolled</option>'."\n";
374: $Str .= '<option value="Expired" '.$OpSel2.'>'.
375: 'Previously Enrolled</option>'."\n";
376: $Str .= '<option value="Any" '.$OpSel3.'>'.
377: 'Any Enrollment Status</option>'."\n";
378: $Str .= '</select>'."\n";
379: }
380:
381:
382: ########################################################
383: ########################################################
384:
385: =pod
386:
387: =item &MultipleSectionSelect()
388:
389: Inputs:
390:
391: =over 4
392:
393: =item $sections A references to an array containing the names of all the
394: sections used in a class.
395:
396: =item $selectedSections A reference to an array containing the names of the
397: currently selected sections.
398:
399: =back
400:
401: Returns: a string containing HTML for a multiple select box for
402: selecting sections of a course.
403:
404: The form element name is 'Section'. @$sections is sorted prior to output.
405:
406: =cut
407:
408: ########################################################
409: ########################################################
410: sub MultipleSectionSelect {
411: my ($sections,$selectedSections)=@_;
412:
413: my $Str = '';
414: $Str .= '<select name="Section" multiple="true" size="4">'."\n";
415:
416: foreach (sort @$sections) {
417: $Str .= '<option';
418: foreach my $selected (@$selectedSections) {
419: if($_ eq $selected) {
420: $Str .= ' selected=""';
421: }
422: }
423: $Str .= '>'.$_.'</option>'."\n";
424: }
425: $Str .= '</select>'."\n";
426:
427: return $Str;
428: }
429:
430: ########################################################
431: ########################################################
432:
433: =pod
434:
435: =item &Title()
436:
437: Inputs: $pageName a string containing the name of the page to be sent
438: to &Apache::loncommon::bodytag.
439:
440: Returns: string containing being <html> and complete <head> and <title>
441: as well as a <script> to focus the current window and change its width
442: and height to 500. Why? I do not know. If you find out, please update
443: this documentation.
444:
445: =cut
446:
447: ########################################################
448: ########################################################
449: sub Title {
450: my ($pageName)=@_;
451:
452: my $Str = '';
453:
454: $Str .= '<html><head><title>'.$pageName.'</title></head>'."\n";
455: $Str .= &Apache::loncommon::bodytag($pageName)."\n";
456: $Str .= '<script>window.focus(); window.width=500;window.height=500;';
457: $Str .= '</script>'."\n";
458:
459: return $Str;
460: }
461:
462: ########################################################
463: ########################################################
464:
465: =pod
466:
467: =item &CreateHeadings()
468:
469: This function generates the column headings for the chart.
470:
471: =over 4
472:
473: Inputs: $CacheData, $keyID, $headings, $spacePadding
474:
475: $CacheData: pointer to a hash tied to the cached data database
476:
477: $keyID: a pointer to an array containing the names of the data
478: held in a column and is used as part of a key into $CacheData
479:
480: $headings: The names of the headings for the student information
481:
482: $spacePadding: The spaces to go between columns
483:
484: Output: $Str
485:
486: $Str: A formatted string of the table column headings.
487:
488: =back
489:
490: =cut
491:
492: ########################################################
493: ########################################################
494: sub CreateHeadings {
495: my ($data,$keyID,$headings,$displayString,$format)=@_;
496: my $Str='';
497: my $formatting = '';
498:
499: for(my $index=0; $index<(scalar @$headings); $index++) {
500: my $currentHeading=$headings->[$index];
501: if($format eq 'preformatted') {
502: my @dataLength=split(//,$currentHeading);
503: my $length=scalar @dataLength;
504: $formatting = (' 'x
505: ($data->{$keyID->[$index].':columnWidth'}-$length));
506: }
507: my $linkdata=$keyID->[$index];
508:
509: my $tempString = $displayString;
510: $tempString =~ s/LINKDATA/$linkdata/;
511: $tempString =~ s/DISPLAYDATA/$currentHeading/;
512: $tempString =~ s/FORMATTING/$formatting/;
513:
514: $Str .= $tempString;
515: }
516:
517: return $Str;
518: }
519:
520: ########################################################
521: ########################################################
522:
523: =pod
524:
525: =item &FormatStudentInformation()
526:
527: This function produces a formatted string of the student\'s information:
528: username, domain, section, full name, and PID.
529:
530: =over 4
531:
532: Input: $cache, $name, $keyID, $spacePadding
533:
534: $cache: This is a pointer to a hash that is tied to the cached data
535:
536: $name: The name and domain of the current student in name:domain format
537:
538: $keyID: A pointer to an array holding the names used to
539:
540: remove data from the hash. They represent the name of the data to be removed.
541:
542: $spacePadding: Extra spaces that represent the space between columns
543:
544: Output: $Str
545:
546: $Str: Formatted string.
547:
548: =back
549:
550: =cut
551:
552: ########################################################
553: ########################################################
554: sub FormatStudentInformation {
555: my ($data,$name,$keyID,$displayString,$format)=@_;
556: my $Str='';
557: my $currentColumn;
558:
559: for(my $index=0; $index<(scalar @$keyID); $index++) {
560: $currentColumn=$data->{$name.':'.$keyID->[$index]};
561:
562: if($format eq 'preformatted') {
563: my @dataLength=split(//,$currentColumn);
564: my $length=scalar @dataLength;
565: $currentColumn.= (' 'x
566: ($data->{$keyID->[$index].':columnWidth'}-$length));
567: }
568:
569: my $tempString = $displayString;
570: $tempString =~ s/DISPLAYDATA/$currentColumn/;
571:
572: $Str .= $tempString;
573: }
574:
575: return $Str;
576: }
577:
578: ########################################################
579: ########################################################
580:
581: =pod
582:
583: =item Progess Window Handling Routines
584:
585: These routines handle the creation, update, increment, and closure of
586: progress windows. The progress window reports to the user the number
587: of items completed and an estimate of the time required to complete the rest.
588:
589: =over 4
590:
591:
592: =item &Create_PrgWin
593:
594: Writes javascript to the client to open a progress window and returns a
595: data structure used for bookkeeping.
596:
597: Inputs
598:
599: =over 4
600:
601: =item $r Apache request
602:
603: =item $title The title of the progress window
604:
605: =item $heading A description (usually 1 line) of the process being initiated.
606:
607: =item $number_to_do The total number of items being processed.
608:
609: =back
610:
611: Returns a hash containing the progress state data structure.
612:
613:
614: =item &Update_PrgWin
615:
616: Updates the text in the progress indicator. Does not increment the count.
617: See &Increment_PrgWin.
618:
619: Inputs:
620:
621: =over 4
622:
623: =item $r Apache request
624:
625: =item $prog_state Pointer to the data structure returned by &Create_PrgWin
626:
627: =item $displaystring The string to write to the status indicator
628:
629: =back
630:
631: Returns: none
632:
633:
634: =item Increment_PrgWin
635:
636: Increment the count of items completed for the progress window by 1.
637:
638: Inputs:
639:
640: =over 4
641:
642: =item $r Apache request
643:
644: =item $prog_state Pointer to the data structure returned by Create_PrgWin
645:
646: =item $extraInfo A description of the items being iterated over. Typically
647: 'student'.
648:
649: =back
650:
651: Returns: none
652:
653:
654: =item Close_PrgWin
655:
656: Closes the progress window.
657:
658: Inputs:
659:
660: =over 4
661:
662: =item $r Apache request
663:
664: =item $prog_state Pointer to the data structure returned by Create_PrgWin
665:
666: =back
667:
668: Returns: none
669:
670: =back
671:
672: =cut
673:
674: ########################################################
675: ########################################################
676:
677: # Create progress
678: sub Create_PrgWin {
679: my ($r, $title, $heading, $number_to_do)=@_;
680: $r->print('<script>'.
681: "popwin=open(\'\',\'popwin\',\'width=400,height=100\');".
682: "popwin.document.writeln(\'<html><head><title>$title</title></head>".
683: "<body bgcolor=\"#88DDFF\">".
684: "<h4>$heading</h4>".
685: "<form name=popremain>".
686: "<input type=text size=55 name=remaining value=Starting></form>".
687: "</body></html>\');".
688: "popwin.document.close();".
689: "</script>");
690:
691: my %prog_state;
692: $prog_state{'done'}=0;
693: $prog_state{'firststart'}=&Time::HiRes::time();
694: $prog_state{'laststart'}=&Time::HiRes::time();
695: $prog_state{'max'}=$number_to_do;
696:
697: $r->rflush();
698: return %prog_state;
699: }
700:
701: # update progress
702: sub Update_PrgWin {
703: my ($r,$prog_state,$displayString)=@_;
704: $r->print('<script>popwin.document.popremain.remaining.value="'.
705: $displayString.'";</script>');
706: $$prog_state{'laststart'}=&Time::HiRes::time();
707: $r->rflush();
708: }
709:
710: # increment progress state
711: sub Increment_PrgWin {
712: my ($r,$prog_state,$extraInfo)=@_;
713: $$prog_state{'done'}++;
714: my $time_est= (&Time::HiRes::time() - $$prog_state{'firststart'})/
715: $$prog_state{'done'} *
716: ($$prog_state{'max'}-$$prog_state{'done'});
717: $time_est = int($time_est);
718: if (int ($time_est/60) > 0) {
719: my $min = int($time_est/60);
720: my $sec = $time_est % 60;
721: $time_est = $min.' minutes';
722: if ($sec > 1) {
723: $time_est.= ', '.$sec.' seconds';
724: } elsif ($sec > 0) {
725: $time_est.= ', '.$sec.' second';
726: }
727: } else {
728: $time_est .= ' seconds';
729: }
730: my $lasttime = &Time::HiRes::time()-$$prog_state{'laststart'};
731: if ($lasttime > 9) {
732: $lasttime = int($lasttime);
733: } elsif ($lasttime < 0.01) {
734: $lasttime = 0;
735: } else {
736: $lasttime = sprintf("%3.2f",$lasttime);
737: }
738: if ($lasttime == 1) {
739: $lasttime = '('.$lasttime.' second for '.$extraInfo.')';
740: } else {
741: $lasttime = '('.$lasttime.' seconds for '.$extraInfo.')';
742: }
743: $r->print('<script>popwin.document.popremain.remaining.value="'.
744: $$prog_state{'done'}.'/'.$$prog_state{'max'}.
745: ': '.$time_est.' remaining '.$lasttime.'";'.'</script>');
746: $$prog_state{'laststart'}=&Time::HiRes::time();
747: $r->rflush();
748: }
749:
750: # close Progress Line
751: sub Close_PrgWin {
752: my ($r,$prog_state)=@_;
753: $r->print('<script>popwin.close()</script>'."\n");
754: undef(%$prog_state);
755: $r->rflush();
756: }
757:
758: 1;
759:
760: __END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonhtmlcommon.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface