Annotation of loncom/interface/lonhtmlcommon.pm, revision 1.110
1.2 www 1: # The LearningOnline Network with CAPA
2: # a pile of common html routines
3: #
1.110 ! www 4: # $Id: lonhtmlcommon.pm,v 1.109 2005/06/18 17:23:25 www Exp $
1.2 www 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.10 matthew 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: ######################################################################
1.2 www 55:
1.1 stredwic 56: package Apache::lonhtmlcommon;
57:
1.104 albertel 58: use strict;
1.10 matthew 59: use Time::Local;
1.47 sakharuk 60: use Time::HiRes;
1.30 www 61: use Apache::lonlocal;
1.104 albertel 62: use Apache::lonnet;
1.1 stredwic 63:
1.40 www 64: ##############################################
65: ##############################################
66:
67: =pod
68:
69: =item authorbombs
70:
71: =cut
72:
73: ##############################################
74: ##############################################
75:
76: sub authorbombs {
77: my $url=shift;
78: $url=&Apache::lonnet::declutter($url);
79: my ($udom,$uname)=($url=~/^(\w+)\/(\w+)\//);
80: my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom);
81: foreach (keys %bombs) {
82: if ($_=~/^$udom\/$uname\//) {
83: return '<a href="/adm/bombs/'.$url.
1.103 albertel 84: '"><img src="'.&Apache::loncommon::lonhttpdurl('/adm/lonMisc/bomb.gif').'" border="0" /></a>'.
1.40 www 85: &Apache::loncommon::help_open_topic('About_Bombs');
86: }
87: }
88: return '';
89: }
1.26 matthew 90:
91: ##############################################
92: ##############################################
93:
1.41 www 94: sub recent_filename {
95: my $area=shift;
96: return 'nohist_recent_'.&Apache::lonnet::escape($area);
97: }
98:
99: sub store_recent {
100: my ($area,$name,$value)=@_;
101: my $file=&recent_filename($area);
102: my %recent=&Apache::lonnet::dump($file);
103: if (scalar(keys(%recent))>10) {
104: # remove oldest value
105: my $oldest=time;
106: my $delkey='';
107: foreach (keys %recent) {
108: my $thistime=(split(/\&/,$recent{$_}))[0];
109: if ($thistime<$oldest) {
110: $oldest=$thistime;
111: $delkey=$_;
112: }
113: }
114: &Apache::lonnet::del($file,[$delkey]);
115: }
116: # store new value
117: &Apache::lonnet::put($file,{ $name =>
118: time.'&'.&Apache::lonnet::escape($value) });
119: }
120:
1.89 banghart 121: sub remove_recent {
122: my ($area,$names)=@_;
123: my $file=&recent_filename($area);
124: return &Apache::lonnet::del($file,$names);
125: }
126:
1.41 www 127: sub select_recent {
128: my ($area,$fieldname,$event)=@_;
129: my %recent=&Apache::lonnet::dump(&recent_filename($area));
130: my $return="\n<select name='$fieldname'".
1.96 albertel 131: ($event?" onchange='$event'":'').
1.41 www 132: ">\n<option value=''>--- ".&mt('Recent')." ---</option>";
133: foreach (sort keys %recent) {
134: unless ($_=~/^error\:/) {
1.94 foxr 135: my $escaped = &Apache::loncommon::escape_url($_);
136: $return.="\n<option value='$escaped'>".
1.41 www 137: &Apache::lonnet::unescape((split(/\&/,$recent{$_}))[1]).
138: '</option>';
139: }
140: }
141: $return.="\n</select>\n";
142: return $return;
143: }
144:
1.97 albertel 145: sub get_recent {
146: my ($area, $n) = @_;
147: my %recent=&Apache::lonnet::dump(&recent_filename($area));
148:
149: # Create hash with key as time and recent as value
150: my %time_hash = ();
151: foreach (keys %recent) {
152: my $thistime=(split(/\&/,$recent{$_}))[0];
153: $time_hash{$thistime} = $_;
154: }
155:
156: # Sort by decreasing time and return key value pairs
157: my %return_hash = ();
158: my $idx = 1;
159: foreach (reverse sort keys %time_hash) {
160: $return_hash{$time_hash{$_}} =
161: &Apache::lonnet::unescape((split(/\&/,$recent{$_}))[1]);
162: if ($n && ($idx++ >= $n)) {last;}
163: }
164:
165: return %return_hash;
166: }
167:
168:
1.41 www 169:
1.26 matthew 170: =pod
171:
172: =item textbox
173:
174: =cut
175:
176: ##############################################
177: ##############################################
178: sub textbox {
179: my ($name,$value,$size,$special) = @_;
180: $size = 40 if (! defined($size));
181: my $Str = '<input type="text" name="'.$name.'" size="'.$size.'" '.
182: 'value="'.$value.'" '.$special.' />';
183: return $Str;
184: }
185:
186: ##############################################
187: ##############################################
188:
189: =pod
190:
191: =item checkbox
192:
193: =cut
194:
195: ##############################################
196: ##############################################
197: sub checkbox {
1.68 matthew 198: my ($name,$checked,$value) = @_;
199: my $Str = '<input type="checkbox" name="'.$name.'" ';
200: if (defined($value)) {
201: $Str .= 'value="'.$value.'"';
202: }
203: if ($checked) {
204: $Str .= ' checked="1"';
205: }
206: $Str .= ' />';
1.26 matthew 207: return $Str;
208: }
209:
1.10 matthew 210: ##############################################
211: ##############################################
212:
213: =pod
214:
215: =item &date_setter
216:
1.22 matthew 217: &date_setter returns html and javascript for a compact date-setting form.
218: To retrieve values from it, use &get_date_from_form().
219:
1.10 matthew 220: Inputs
221:
222: =over 4
223:
224: =item $dname
225:
226: The name to prepend to the form elements.
227: The form elements defined will be dname_year, dname_month, dname_day,
228: dname_hour, dname_min, and dname_sec.
229:
230: =item $currentvalue
231:
232: The current setting for this time parameter. A unix format time
233: (time in seconds since the beginning of Jan 1st, 1970, GMT.
234: An undefined value is taken to indicate the value is the current time.
235: Also, to be explicit, a value of 'now' also indicates the current time.
236:
1.26 matthew 237: =item $special
238:
239: Additional html/javascript to be associated with each element in
240: the date_setter. See lonparmset for example usage.
241:
1.59 matthew 242: =item $includeempty
243:
244: =item $state
245:
246: Specifies the initial state of the form elements. Either 'disabled' or empty.
247: Defaults to empty, which indiciates the form elements are not disabled.
248:
1.22 matthew 249: =back
250:
251: Bugs
252:
253: The method used to restrict user input will fail in the year 2400.
254:
1.10 matthew 255: =cut
256:
257: ##############################################
258: ##############################################
259: sub date_setter {
1.67 matthew 260: my ($formname,$dname,$currentvalue,$special,$includeempty,$state,
1.108 www 261: $no_hh_mm_ss,$defhour,$defmin,$defsec) = @_;
1.107 www 262: my $wasdefined=1;
1.59 matthew 263: if (! defined($state) || $state ne 'disabled') {
264: $state = '';
265: }
1.67 matthew 266: if (! defined($no_hh_mm_ss)) {
267: $no_hh_mm_ss = 0;
268: }
1.110 ! www 269: if ($currentvalue eq 'now') {
! 270: $currentvalue=time;
! 271: }
! 272: if ((!defined($currentvalue)) || ($currentvalue eq '')) {
! 273: $wasdefined=0;
! 274: if ($includeempty) {
! 275: $currentvalue = 0;
! 276: } else {
1.39 www 277: $currentvalue = time;
278: }
1.10 matthew 279: }
280: # other potentially useful values: wkday,yrday,is_daylight_savings
1.65 albertel 281: my ($sec,$min,$hour,$mday,$month,$year)=('','',undef,'','','');
1.39 www 282: if ($currentvalue) {
283: ($sec,$min,$hour,$mday,$month,$year,undef,undef,undef) =
284: localtime($currentvalue);
285: $year += 1900;
286: }
1.107 www 287: unless ($wasdefined) {
1.110 ! www 288: if (($defhour) || ($defmin) || ($defsec)) {
! 289: ($sec,$min,$hour,$mday,$month,$year,undef,undef,undef) =
! 290: localtime(time);
! 291: $year += 1900;
! 292: $sec=($defsec?$defsec:0);
! 293: $min=($defmin?$defmin:0);
! 294: $hour=($defhour?$defhour:0);
! 295: } elsif (!$includeempty) {
! 296: $sec=0;
! 297: $min=0;
! 298: $hour=0;
! 299: }
1.107 www 300: }
1.10 matthew 301: my $result = "\n<!-- $dname date setting form -->\n";
302: $result .= <<ENDJS;
303: <script language="Javascript">
304: function $dname\_checkday() {
305: var day = document.$formname.$dname\_day.value;
306: var month = document.$formname.$dname\_month.value;
307: var year = document.$formname.$dname\_year.value;
308: var valid = true;
309: if (day < 1) {
310: document.$formname.$dname\_day.value = 1;
311: }
312: if (day > 31) {
313: document.$formname.$dname\_day.value = 31;
314: }
315: if ((month == 1) || (month == 3) || (month == 5) ||
316: (month == 7) || (month == 8) || (month == 10) ||
317: (month == 12)) {
318: if (day > 31) {
319: document.$formname.$dname\_day.value = 31;
320: day = 31;
321: }
322: } else if (month == 2 ) {
323: if ((year % 4 == 0) && (year % 100 != 0)) {
324: if (day > 29) {
325: document.$formname.$dname\_day.value = 29;
326: }
327: } else if (day > 29) {
328: document.$formname.$dname\_day.value = 28;
329: }
330: } else if (day > 30) {
331: document.$formname.$dname\_day.value = 30;
332: }
333: }
1.95 matthew 334:
1.59 matthew 335: function $dname\_disable() {
336: document.$formname.$dname\_month.disabled=true;
337: document.$formname.$dname\_day.disabled=true;
338: document.$formname.$dname\_year.disabled=true;
339: document.$formname.$dname\_hour.disabled=true;
340: document.$formname.$dname\_minute.disabled=true;
341: document.$formname.$dname\_second.disabled=true;
342: }
343:
344: function $dname\_enable() {
345: document.$formname.$dname\_month.disabled=false;
346: document.$formname.$dname\_day.disabled=false;
347: document.$formname.$dname\_year.disabled=false;
348: document.$formname.$dname\_hour.disabled=false;
349: document.$formname.$dname\_minute.disabled=false;
350: document.$formname.$dname\_second.disabled=false;
351: }
352:
1.29 www 353: function $dname\_opencalendar() {
1.59 matthew 354: if (! document.$formname.$dname\_month.disabled) {
355: var calwin=window.open(
1.29 www 356: "/adm/announcements?pickdate=yes&formname=$formname&element=$dname&month="+
357: document.$formname.$dname\_month.value+"&year="+
358: document.$formname.$dname\_year.value,
359: "LONCAPAcal",
360: "height=350,width=350,scrollbars=yes,resizable=yes,menubar=no");
1.59 matthew 361: }
1.29 www 362:
363: }
1.10 matthew 364: </script>
365: ENDJS
1.95 matthew 366: $result .= ' <nobr>';
1.96 albertel 367: my $monthselector = qq{<select name="$dname\_month" $special $state onchange="javascript:$dname\_checkday()" >};
1.67 matthew 368: # Month
1.10 matthew 369: my @Months = qw/January February March April May June
370: July August September October November December/;
371: # Pad @Months with a bogus value to make indexing easier
372: unshift(@Months,'If you can read this an error occurred');
1.95 matthew 373: if ($includeempty) { $monthselector.="<option value=''></option>"; }
1.10 matthew 374: for(my $m = 1;$m <=$#Months;$m++) {
1.95 matthew 375: $monthselector .= qq{ <option value="$m" };
376: $monthselector .= "selected " if ($m-1 eq $month);
377: $monthselector .= '> '.&mt($Months[$m]).' </option>';
1.10 matthew 378: }
1.95 matthew 379: $monthselector.= ' </select>';
1.67 matthew 380: # Day
1.96 albertel 381: my $dayselector = qq{<input type="text" name="$dname\_day" $state value="$mday" size="3" $special onchange="javascript:$dname\_checkday()" />};
1.67 matthew 382: # Year
1.96 albertel 383: my $yearselector = qq{<input type="year" name="$dname\_year" $state value="$year" size="5" $special onchange="javascript:$dname\_checkday()" />};
1.95 matthew 384: #
385: my $hourselector = qq{<select name="$dname\_hour" $special $state >};
386: if ($includeempty) {
387: $hourselector.=qq{<option value=''></option>};
388: }
389: for (my $h = 0;$h<24;$h++) {
390: $hourselector .= qq{<option value="$h" };
391: $hourselector .= "selected " if (defined($hour) && $hour == $h);
392: $hourselector .= ">";
393: my $timest='';
394: if ($h == 0) {
395: $timest .= "12 am";
396: } elsif($h == 12) {
397: $timest .= "12 noon";
398: } elsif($h < 12) {
399: $timest .= "$h am";
400: } else {
401: $timest .= $h-12 ." pm";
402: }
403: $timest=&mt($timest);
404: $hourselector .= $timest." </option>\n";
405: }
406: $hourselector .= " </select>\n";
407: my $minuteselector = qq{<input type="text" name="$dname\_minute" $special $state value="$min" size="3" />};
408: my $secondselector= qq{<input type="text" name="$dname\_second" $special $state value="$sec" size="3" />};
409: my $cal_link = qq{<a href="javascript:$dname\_opencalendar()">};
410: #
411: if ($no_hh_mm_ss) {
412: $result .= &mt('[_1] [_2] [_3] [_4]Select Date[_5]',
413: $monthselector,$dayselector,$yearselector,
414: $cal_link,'</a>');
415: } else {
416: $result .= &mt('[_1] [_2] [_3] [_4] [_5]m [_6]s [_7]Select Date[_8]',
417: $monthselector,$dayselector,$yearselector,
418: $hourselector,$minuteselector,$secondselector,
419: $cal_link,'</a>');
1.67 matthew 420: }
1.95 matthew 421: $result .= "</nobr>\n<!-- end $dname date setting form -->\n";
1.10 matthew 422: return $result;
423: }
424:
425: ##############################################
426: ##############################################
427:
1.22 matthew 428: =pod
429:
1.10 matthew 430: =item &get_date_from_form
1.22 matthew 431:
432: get_date_from_form retrieves the date specified in an &date_setter form.
1.10 matthew 433:
434: Inputs:
435:
436: =over 4
437:
438: =item $dname
439:
440: The name passed to &datesetter, which prefixes the form elements.
441:
442: =item $defaulttime
443:
444: The unix time to use as the default in case of poor inputs.
445:
446: =back
447:
448: Returns: Unix time represented in the form.
449:
450: =cut
451:
452: ##############################################
453: ##############################################
454: sub get_date_from_form {
455: my ($dname) = @_;
456: my ($sec,$min,$hour,$day,$month,$year);
457: #
1.104 albertel 458: if (defined($env{'form.'.$dname.'_second'})) {
459: my $tmpsec = $env{'form.'.$dname.'_second'};
1.10 matthew 460: if (($tmpsec =~ /^\d+$/) && ($tmpsec >= 0) && ($tmpsec < 60)) {
461: $sec = $tmpsec;
462: }
1.64 albertel 463: if (!defined($tmpsec) || $tmpsec eq '') { $sec = 0; }
1.67 matthew 464: } else {
465: $sec = 0;
1.10 matthew 466: }
1.104 albertel 467: if (defined($env{'form.'.$dname.'_minute'})) {
468: my $tmpmin = $env{'form.'.$dname.'_minute'};
1.10 matthew 469: if (($tmpmin =~ /^\d+$/) && ($tmpmin >= 0) && ($tmpmin < 60)) {
470: $min = $tmpmin;
471: }
1.64 albertel 472: if (!defined($tmpmin) || $tmpmin eq '') { $min = 0; }
1.67 matthew 473: } else {
474: $min = 0;
1.10 matthew 475: }
1.104 albertel 476: if (defined($env{'form.'.$dname.'_hour'})) {
477: my $tmphour = $env{'form.'.$dname.'_hour'};
1.33 matthew 478: if (($tmphour =~ /^\d+$/) && ($tmphour >= 0) && ($tmphour < 24)) {
1.10 matthew 479: $hour = $tmphour;
480: }
1.67 matthew 481: } else {
482: $hour = 0;
1.10 matthew 483: }
1.104 albertel 484: if (defined($env{'form.'.$dname.'_day'})) {
485: my $tmpday = $env{'form.'.$dname.'_day'};
1.10 matthew 486: if (($tmpday =~ /^\d+$/) && ($tmpday > 0) && ($tmpday < 32)) {
487: $day = $tmpday;
488: }
489: }
1.104 albertel 490: if (defined($env{'form.'.$dname.'_month'})) {
491: my $tmpmonth = $env{'form.'.$dname.'_month'};
1.10 matthew 492: if (($tmpmonth =~ /^\d+$/) && ($tmpmonth > 0) && ($tmpmonth < 13)) {
493: $month = $tmpmonth - 1;
494: }
495: }
1.104 albertel 496: if (defined($env{'form.'.$dname.'_year'})) {
497: my $tmpyear = $env{'form.'.$dname.'_year'};
1.10 matthew 498: if (($tmpyear =~ /^\d+$/) && ($tmpyear > 1900)) {
499: $year = $tmpyear - 1900;
500: }
501: }
1.24 www 502: if (($year<70) || ($year>137)) { return undef; }
1.33 matthew 503: if (defined($sec) && defined($min) && defined($hour) &&
504: defined($day) && defined($month) && defined($year) &&
505: eval(&timelocal($sec,$min,$hour,$day,$month,$year))) {
1.10 matthew 506: return &timelocal($sec,$min,$hour,$day,$month,$year);
507: } else {
508: return undef;
509: }
1.20 matthew 510: }
511:
512: ##############################################
513: ##############################################
514:
515: =pod
516:
517: =item &pjump_javascript_definition()
518:
519: Returns javascript defining the 'pjump' function, which opens up a
520: parameter setting wizard.
521:
522: =cut
523:
524: ##############################################
525: ##############################################
526: sub pjump_javascript_definition {
527: my $Str = <<END;
1.109 www 528: function pjump(type,dis,value,marker,ret,call,hour,min,sec) {
1.20 matthew 529: parmwin=window.open("/adm/rat/parameter.html?type="+escape(type)
530: +"&value="+escape(value)+"&marker="+escape(marker)
531: +"&return="+escape(ret)
1.109 www 532: +"&call="+escape(call)+"&name="+escape(dis)
533: +"&defhour="+escape(hour)+"&defmin="+escape(min)
534: +"&defsec="+escape(sec),"LONCAPAparms",
1.20 matthew 535: "height=350,width=350,scrollbars=no,menubar=no");
536: }
537: END
538: return $Str;
1.10 matthew 539: }
540:
541: ##############################################
542: ##############################################
1.17 matthew 543:
544: =pod
545:
546: =item &javascript_nothing()
547:
548: Return an appropriate null for the users browser. This is used
549: as the first arguement for window.open calls when you want a blank
550: window that you can then write to.
551:
552: =cut
553:
554: ##############################################
555: ##############################################
556: sub javascript_nothing {
557: # mozilla and other browsers work with "''", but IE on mac does not.
558: my $nothing = "''";
559: my $user_browser;
560: my $user_os;
1.104 albertel 561: $user_browser = $env{'browser.type'} if (exists($env{'browser.type'}));
562: $user_os = $env{'browser.os'} if (exists($env{'browser.os'}));
1.17 matthew 563: if (! defined($user_browser) || ! defined($user_os)) {
564: (undef,$user_browser,undef,undef,undef,$user_os) =
565: &Apache::loncommon::decode_user_agent();
566: }
567: if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
568: $nothing = "'javascript:void(0);'";
569: }
570: return $nothing;
571: }
572:
1.90 www 573: ##############################################
574: ##############################################
575: sub javascript_docopen {
576: # safari does not understand document.open() and loads "text/html"
577: my $nothing = "''";
578: my $user_browser;
579: my $user_os;
1.104 albertel 580: $user_browser = $env{'browser.type'} if (exists($env{'browser.type'}));
581: $user_os = $env{'browser.os'} if (exists($env{'browser.os'}));
1.90 www 582: if (! defined($user_browser) || ! defined($user_os)) {
583: (undef,$user_browser,undef,undef,undef,$user_os) =
584: &Apache::loncommon::decode_user_agent();
585: }
586: if ($user_browser eq 'safari' && $user_os =~ 'mac') {
587: $nothing = "document.clear()";
588: } else {
589: $nothing = "document.open('text/html','replace')";
590: }
591: return $nothing;
592: }
593:
1.21 matthew 594:
1.17 matthew 595: ##############################################
596: ##############################################
597:
1.21 matthew 598: =pod
1.17 matthew 599:
1.21 matthew 600: =item &StatusOptions()
1.10 matthew 601:
1.21 matthew 602: Returns html for a selection box which allows the user to choose the
603: enrollment status of students. The selection box name is 'Status'.
1.6 stredwic 604:
1.21 matthew 605: Inputs:
1.6 stredwic 606:
1.21 matthew 607: $status: the currently selected status. If undefined the value of
1.104 albertel 608: $env{'form.Status'} is taken. If that is undefined, a value of 'Active'
1.21 matthew 609: is used.
1.6 stredwic 610:
1.21 matthew 611: $formname: The name of the form. If defined the onchange attribute of
612: the selection box is set to document.$formname.submit().
1.6 stredwic 613:
1.21 matthew 614: $size: the size (number of lines) of the selection box.
1.6 stredwic 615:
1.27 matthew 616: $onchange: javascript to use when the value is changed. Enclosed in
617: double quotes, ""s, not single quotes.
618:
1.21 matthew 619: Returns: a perl string as described.
1.1 stredwic 620:
1.21 matthew 621: =cut
1.9 stredwic 622:
1.21 matthew 623: ##############################################
624: ##############################################
625: sub StatusOptions {
1.27 matthew 626: my ($status, $formName,$size,$onchange)=@_;
1.21 matthew 627: $size = 1 if (!defined($size));
628: if (! defined($status)) {
629: $status = 'Active';
1.104 albertel 630: $status = $env{'form.Status'} if (exists($env{'form.Status'}));
1.9 stredwic 631: }
1.1 stredwic 632:
633: my $OpSel1 = '';
634: my $OpSel2 = '';
635: my $OpSel3 = '';
636:
637: if($status eq 'Any') { $OpSel3 = ' selected'; }
638: elsif($status eq 'Expired' ) { $OpSel2 = ' selected'; }
639: else { $OpSel1 = ' selected'; }
640:
641: my $Str = '';
642: $Str .= '<select name="Status"';
1.27 matthew 643: if(defined($formName) && $formName ne '' && ! defined($onchange)) {
1.1 stredwic 644: $Str .= ' onchange="document.'.$formName.'.submit()"';
1.27 matthew 645: }
646: if (defined($onchange)) {
647: $Str .= ' onchange="'.$onchange.'"';
1.1 stredwic 648: }
1.21 matthew 649: $Str .= ' size="'.$size.'" ';
1.1 stredwic 650: $Str .= '>'."\n";
1.21 matthew 651: $Str .= '<option value="Active" '.$OpSel1.'>'.
1.37 www 652: &mt('Currently Enrolled').'</option>'."\n";
1.21 matthew 653: $Str .= '<option value="Expired" '.$OpSel2.'>'.
1.37 www 654: &mt('Previously Enrolled').'</option>'."\n";
1.21 matthew 655: $Str .= '<option value="Any" '.$OpSel3.'>'.
1.37 www 656: &mt('Any Enrollment Status').'</option>'."\n";
1.1 stredwic 657: $Str .= '</select>'."\n";
1.7 stredwic 658: }
1.12 matthew 659:
660: ########################################################
661: ########################################################
1.7 stredwic 662:
1.23 matthew 663: =pod
664:
665: =item Progess Window Handling Routines
666:
667: These routines handle the creation, update, increment, and closure of
668: progress windows. The progress window reports to the user the number
669: of items completed and an estimate of the time required to complete the rest.
670:
671: =over 4
672:
673:
674: =item &Create_PrgWin
675:
676: Writes javascript to the client to open a progress window and returns a
677: data structure used for bookkeeping.
678:
679: Inputs
680:
681: =over 4
682:
683: =item $r Apache request
684:
685: =item $title The title of the progress window
686:
687: =item $heading A description (usually 1 line) of the process being initiated.
688:
689: =item $number_to_do The total number of items being processed.
1.50 albertel 690:
691: =item $type Either 'popup' or 'inline' (popup is assumed if nothing is
692: specified)
693:
1.51 albertel 694: =item $width Specify the width in charaters of the input field.
695:
1.50 albertel 696: =item $formname Only useful in the inline case, if a form already exists, this needs to be used and specfiy the name of the form, otherwise the Progress line will be created in a new form of it's own
697:
698: =item $inputname Only useful in the inline case, if a form and an input of type text exists, use this to specify the name of the input field
1.23 matthew 699:
700: =back
701:
702: Returns a hash containing the progress state data structure.
703:
704:
705: =item &Update_PrgWin
706:
707: Updates the text in the progress indicator. Does not increment the count.
708: See &Increment_PrgWin.
709:
710: Inputs:
711:
712: =over 4
713:
714: =item $r Apache request
715:
716: =item $prog_state Pointer to the data structure returned by &Create_PrgWin
717:
718: =item $displaystring The string to write to the status indicator
719:
720: =back
721:
722: Returns: none
723:
724:
725: =item Increment_PrgWin
726:
727: Increment the count of items completed for the progress window by 1.
728:
729: Inputs:
730:
731: =over 4
732:
733: =item $r Apache request
734:
735: =item $prog_state Pointer to the data structure returned by Create_PrgWin
736:
737: =item $extraInfo A description of the items being iterated over. Typically
738: 'student'.
739:
740: =back
741:
742: Returns: none
743:
744:
745: =item Close_PrgWin
746:
747: Closes the progress window.
748:
749: Inputs:
750:
751: =over 4
752:
753: =item $r Apache request
754:
755: =item $prog_state Pointer to the data structure returned by Create_PrgWin
756:
757: =back
758:
759: Returns: none
760:
761: =back
762:
763: =cut
764:
765: ########################################################
766: ########################################################
767:
1.51 albertel 768: my $uniq=0;
769: sub get_uniq_name {
770: $uniq++;
771: return 'uniquename'.$uniq;
772: }
773:
1.7 stredwic 774: # Create progress
775: sub Create_PrgWin {
1.51 albertel 776: my ($r, $title, $heading, $number_to_do,$type,$width,$formname,
777: $inputname)=@_;
1.49 albertel 778: if (!defined($type)) { $type='popup'; }
1.51 albertel 779: if (!defined($width)) { $width=55; }
1.49 albertel 780: my %prog_state;
781: $prog_state{'type'}=$type;
782: if ($type eq 'popup') {
783: $prog_state{'window'}='popwin';
1.103 albertel 784: my $html=&Apache::lonxml::xmlbegin();
1.49 albertel 785: #the whole function called through timeout is due to issues
786: #in mozilla Read BUG #2665 if you want to know the whole story
787: &r_print($r,'<script>'.
788: "var popwin;
789: function openpopwin () {
790: popwin=open(\'\',\'popwin\',\'width=400,height=100\');".
1.103 albertel 791: "popwin.document.writeln(\'".$html."<head><title>$title</title></head>".
1.48 albertel 792: "<body bgcolor=\"#88DDFF\">".
793: "<h4>$heading</h4>".
794: "<form name=popremain>".
1.51 albertel 795: '<input type="text" size="'.$width.'" name="remaining" value="'.
1.48 albertel 796: &mt('Starting').'"></form>'.
797: "</body></html>\');".
1.49 albertel 798: "popwin.document.close();}".
799: "\nwindow.setTimeout(openpopwin,0)</script>");
800: $prog_state{'formname'}='popremain';
801: $prog_state{'inputname'}="remaining";
802: } elsif ($type eq 'inline') {
803: $prog_state{'window'}='window';
804: if (!$formname) {
1.51 albertel 805: $prog_state{'formname'}=&get_uniq_name();
806: &r_print($r,'<form name="'.$prog_state{'formname'}.'">');
1.49 albertel 807: } else {
808: $prog_state{'formname'}=$formname;
809: }
810: if (!$inputname) {
1.51 albertel 811: $prog_state{'inputname'}=&get_uniq_name();
1.56 albertel 812: &r_print($r,$heading.' <input type="text" name="'.$prog_state{'inputname'}.
1.51 albertel 813: '" size="'.$width.'" />');
1.49 albertel 814: } else {
815: $prog_state{'inputname'}=$inputname;
816:
817: }
818: if (!$formname) { &r_print($r,'</form>'); }
819: &Update_PrgWin($r,\%prog_state,&mt('Starting'));
820: }
1.7 stredwic 821:
1.16 albertel 822: $prog_state{'done'}=0;
1.23 matthew 823: $prog_state{'firststart'}=&Time::HiRes::time();
824: $prog_state{'laststart'}=&Time::HiRes::time();
1.16 albertel 825: $prog_state{'max'}=$number_to_do;
1.49 albertel 826:
1.14 albertel 827: return %prog_state;
1.7 stredwic 828: }
829:
830: # update progress
831: sub Update_PrgWin {
1.14 albertel 832: my ($r,$prog_state,$displayString)=@_;
1.49 albertel 833: &r_print($r,'<script>'.$$prog_state{'window'}.'.document.'.
834: $$prog_state{'formname'}.'.'.
835: $$prog_state{'inputname'}.'.value="'.
1.48 albertel 836: $displayString.'";</script>');
1.23 matthew 837: $$prog_state{'laststart'}=&Time::HiRes::time();
1.14 albertel 838: }
839:
840: # increment progress state
841: sub Increment_PrgWin {
842: my ($r,$prog_state,$extraInfo)=@_;
1.16 albertel 843: $$prog_state{'done'}++;
1.23 matthew 844: my $time_est= (&Time::HiRes::time() - $$prog_state{'firststart'})/
845: $$prog_state{'done'} *
1.16 albertel 846: ($$prog_state{'max'}-$$prog_state{'done'});
847: $time_est = int($time_est);
1.80 matthew 848: #
849: my $min = int($time_est/60);
850: my $sec = $time_est % 60;
851: #
852: my $str;
1.91 albertel 853: if ($min == 0 && $sec > 1) {
1.80 matthew 854: $str = '[_2] seconds';
1.91 albertel 855: } elsif ($min == 1 && $sec > 1) {
856: $str = '1 minute [_2] seconds';
1.80 matthew 857: } elsif ($min == 1 && $sec < 2) {
858: $str = '1 minute';
859: } elsif ($min < 10 && $sec > 1) {
860: $str = '[_1] minutes, [_2] seconds';
1.81 matthew 861: } elsif ($min >= 10 || $sec < 2) {
1.80 matthew 862: $str = '[_1] minutes';
1.16 albertel 863: }
1.80 matthew 864: $time_est = &mt($str,$min,$sec);
865: #
1.23 matthew 866: my $lasttime = &Time::HiRes::time()-$$prog_state{'laststart'};
867: if ($lasttime > 9) {
868: $lasttime = int($lasttime);
869: } elsif ($lasttime < 0.01) {
870: $lasttime = 0;
871: } else {
872: $lasttime = sprintf("%3.2f",$lasttime);
873: }
1.19 matthew 874: if ($lasttime == 1) {
1.32 www 875: $lasttime = '('.$lasttime.' '.&mt('second for').' '.$extraInfo.')';
1.19 matthew 876: } else {
1.32 www 877: $lasttime = '('.$lasttime.' '.&mt('seconds for').' '.$extraInfo.')';
1.28 matthew 878: }
879: #
1.104 albertel 880: my $user_browser = $env{'browser.type'} if (exists($env{'browser.type'}));
881: my $user_os = $env{'browser.os'} if (exists($env{'browser.os'}));
1.28 matthew 882: if (! defined($user_browser) || ! defined($user_os)) {
883: (undef,$user_browser,undef,undef,undef,$user_os) =
884: &Apache::loncommon::decode_user_agent();
885: }
886: if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
887: $lasttime = '';
1.19 matthew 888: }
1.49 albertel 889: &r_print($r,'<script>'.$$prog_state{'window'}.'.document.'.
890: $$prog_state{'formname'}.'.'.
891: $$prog_state{'inputname'}.'.value="'.
1.48 albertel 892: $$prog_state{'done'}.'/'.$$prog_state{'max'}.
893: ': '.$time_est.' '.&mt('remaining').' '.$lasttime.'";'.'</script>');
1.23 matthew 894: $$prog_state{'laststart'}=&Time::HiRes::time();
1.7 stredwic 895: }
896:
897: # close Progress Line
898: sub Close_PrgWin {
1.14 albertel 899: my ($r,$prog_state)=@_;
1.49 albertel 900: if ($$prog_state{'type'} eq 'popup') {
901: &r_print($r,'<script>popwin.close()</script>'."\n");
902: } elsif ($$prog_state{'type'} eq 'inline') {
903: &Update_PrgWin($r,$prog_state,&mt('Done'));
904: }
1.48 albertel 905: undef(%$prog_state);
906: }
907:
908: sub r_print {
909: my ($r,$to_print)=@_;
910: if ($r) {
911: $r->print($to_print);
912: $r->rflush();
1.47 sakharuk 913: } else {
1.48 albertel 914: print($to_print);
1.47 sakharuk 915: }
1.1 stredwic 916: }
1.34 www 917:
918: # ------------------------------------------------------- Puts directory header
919:
920: sub crumbs {
1.78 www 921: my ($uri,$target,$prefix,$form,$size,$noformat)=@_;
1.62 matthew 922: if (! defined($size)) {
923: $size = '+2';
924: }
1.100 raeburn 925: if ($target) {
926: $target = ' target="'.
927: &Apache::loncommon::escape_single($target).'"';
928: }
1.78 www 929: my $output='';
930: unless ($noformat) { $output.='<br /><tt><b>'; }
931: $output.='<font size="'.$size.'">'.$prefix.'/';
1.104 albertel 932: if ($env{'user.adv'}) {
1.43 www 933: my $path=$prefix.'/';
1.99 matthew 934: foreach my $dir (split('/',$uri)) {
935: if (! $dir) { next; }
936: $path .= $dir;
1.43 www 937: unless ($path eq $uri) { $path.='/'; }
1.99 matthew 938: my $linkpath = &Apache::loncommon::escape_single($path);
1.98 matthew 939: if ($form) {
1.99 matthew 940: $linkpath=
941: qq{javascript:$form.action='$linkpath';$form.submit();};
1.98 matthew 942: }
1.99 matthew 943: $output.=qq{<a href="$linkpath" $target>$dir</a>/};
1.35 www 944: }
945: } else {
946: $output.=$uri;
1.34 www 947: }
1.36 www 948: unless ($uri=~/\/$/) { $output=~s/\/$//; }
1.78 www 949: return $output.'</font>'.($noformat?'':'</b></tt><br />');
1.34 www 950: }
951:
1.85 www 952: # --------------------- A function that generates a window for the spellchecker
953:
954: sub spellheader {
1.103 albertel 955: my $html=&Apache::lonxml::xmlbegin();
1.105 www 956: my $nothing=&javascript_nothing();
1.85 www 957: return (<<ENDCHECK);
958: <script type="text/javascript">
1.92 albertel 959: //<!-- BEGIN LON-CAPA Internal
1.85 www 960: var checkwin;
961:
962: function spellcheckerwindow() {
1.105 www 963: checkwin=window.open($nothing,'spellcheckwin','height=320,width=280,resizable=yes,scrollbars=yes,location=no,menubar=no,toolbar=no');
1.103 albertel 964: checkwin.document.writeln('$html<head></head><body bgcolor="#DDDDDD"><form name="spellcheckform" action="/adm/spellcheck" method="post"><input type="hidden" name="text" value="" /></form></body></html>');
1.85 www 965: checkwin.document.close();
966: }
1.92 albertel 967: // END LON-CAPA Internal -->
1.85 www 968: </script>
969: ENDCHECK
970: }
971:
972: # ---------------------------------- Generate link to spell checker for a field
973:
974: sub spelllink {
975: my ($form,$field)=@_;
976: my $linktext=&mt('Check Spelling');
977: return (<<ENDLINK);
1.105 www 978: <a href="javascript:if (typeof(document.$form.onsubmit)!='undefined') { if (document.$form.onsubmit!=null) { document.$form.onsubmit();}};spellcheckerwindow();checkwin.document.forms.spellcheckform.text.value=this.document.forms.$form.$field.value;checkwin.document.forms.spellcheckform.submit();">$linktext</a>
1.85 www 979: ENDLINK
980: }
981:
1.52 www 982: # ------------------------------------------------- Output headers for HTMLArea
983:
984: sub htmlareaheaders {
1.71 www 985: if (&htmlareablocked()) { return ''; }
1.76 www 986: unless (&htmlareabrowser()) { return ''; }
1.52 www 987: my $lang='en';
1.71 www 988: if (&mt('htmlarea_lang') ne 'htmlarea_lang') {
989: $lang=&mt('htmlarea_lang');
990: }
1.52 www 991: return (<<ENDHEADERS);
1.61 www 992: <script type="text/javascript">
1.73 www 993: _editor_url='/htmlarea/';
994: _editor_lang='$lang';
1.61 www 995: </script>
1.52 www 996: <script type="text/javascript" src="/htmlarea/htmlarea.js"></script>
997: ENDHEADERS
998: }
999:
1.74 www 1000: # ------------------------------------------------- Activate additional buttons
1001:
1002: sub htmlareaaddbuttons {
1003: if (&htmlareablocked()) { return ''; }
1.76 www 1004: unless (&htmlareabrowser()) { return ''; }
1.74 www 1005: return (<<ENDADDBUTTON);
1006: var config=new HTMLArea.Config();
1007: config.registerButton('ed_math','LaTeX Inline',
1008: '/htmlarea/images/ed_math.gif',false,
1009: function(editor,id) {
1.88 albertel 1010: editor.surroundHTML(' <m>\$','\$</m> ');
1.74 www 1011: }
1012: );
1013: config.registerButton('ed_math_eqn','LaTeX Equation',
1014: '/htmlarea/images/ed_math_eqn.gif',false,
1015: function(editor,id) {
1.75 www 1016: editor.surroundHTML(
1.88 albertel 1017: ' \\n<center><m>\\\\[','\\\\]</m></center>\\n ');
1.74 www 1018: }
1019: );
1020: config.toolbar.push(['ed_math','ed_math_eqn']);
1021: ENDADDBUTTON
1022: }
1.76 www 1023:
1024: # ----------------------------------------------------------------- Preferences
1025:
1026: sub disablelink {
1.77 www 1027: my @fields=@_;
1028: if (defined($#fields)) {
1029: unless ($#fields>=0) { return ''; }
1030: }
1.93 albertel 1031: return '<a href="'.&HTML::Entities::encode('/adm/preferences?action=set_wysiwyg&wysiwyg=off&returnurl=','<>&"').&Apache::lonnet::escape($ENV{'REQUEST_URI'}).'">'.&mt('Disable WYSIWYG Editor').'</a>';
1.76 www 1032: }
1033:
1034: sub enablelink {
1.77 www 1035: my @fields=@_;
1036: if (defined($#fields)) {
1037: unless ($#fields>=0) { return ''; }
1038: }
1.93 albertel 1039: return '<a href="'.&HTML::Entities::encode('/adm/preferences?action=set_wysiwyg&wysiwyg=on&returnurl=','<>&"').&Apache::lonnet::escape($ENV{'REQUEST_URI'}).'">'.&mt('Enable WYSIWYG Editor').'</a>';
1.76 www 1040: }
1041:
1.72 www 1042: # ----------------------------------------- Script to activate only some fields
1043:
1044: sub htmlareaselectactive {
1.73 www 1045: my @fields=@_;
1.76 www 1046: unless (&htmlareabrowser()) { return ''; }
1.77 www 1047: if (&htmlareablocked()) { return '<br />'.&enablelink(@fields); }
1.74 www 1048: my $output='<script type="text/javascript" defer="1">'.
1049: &htmlareaaddbuttons();
1.73 www 1050: foreach(@fields) {
1.74 www 1051: $output.="\nHTMLArea.replace('$_',config);";
1.72 www 1052: }
1.76 www 1053: $output.="\nwindow.status='Activated Editfields';\n</script><br />".
1.77 www 1054: &disablelink(@fields);
1.72 www 1055: return $output;
1056: }
1057:
1.61 www 1058: # --------------------------------------------------------------------- Blocked
1059:
1060: sub htmlareablocked {
1.104 albertel 1061: unless ($env{'environment.wysiwygeditor'} eq 'on') { return 1; }
1.71 www 1062: return 0;
1.52 www 1063: }
1064:
1065: # ---------------------------------------- Browser capable of running HTMLArea?
1066:
1067: sub htmlareabrowser {
1068: return 1;
1069: }
1.53 matthew 1070:
1071: ############################################################
1072: ############################################################
1073:
1074: =pod
1075:
1076: =item breadcrumbs
1077:
1078: Compiles the previously registered breadcrumbs into an series of links.
1079: FAQ and BUG links will be placed on the left side of the table if they
1080: are defined for the last registered breadcrumb.
1081: Additionally supports a 'component', which will be displayed on the
1082: right side of the table (without a link).
1083: A link to help for the component will be included if one is specified.
1084:
1085: All inputs can be undef without problems.
1086:
1087: Inputs: $color (the background color of the table returned),
1088: $component (the large text on the right side of the table),
1089: $component_help
1.63 albertel 1090: $function (role to get colors from)
1091: $domain (domian of role)
1092: $menulink (boolean, controls whether to include a link to /adm/menu)
1.53 matthew 1093:
1094: Returns a string containing breadcrumbs for the current page.
1095:
1096: =item clear_breadcrumbs
1097:
1098: Clears the previously stored breadcrumbs.
1099:
1100: =item add_breadcrumb
1101:
1102: Pushes a breadcrumb on the stack of crumbs.
1103:
1104: input: $breadcrumb, a hash reference. The keys 'href','title', and 'text'
1105: are required. If present the keys 'faq' and 'bug' will be used to provide
1106: links to the FAQ and bug sites.
1107:
1108: returns: nothing
1109:
1110: =cut
1111:
1112: ############################################################
1113: ############################################################
1114: {
1115: my @Crumbs;
1.57 matthew 1116:
1.53 matthew 1117: sub breadcrumbs {
1.87 albertel 1118: my ($color,$component,$component_help,$function,$domain,$menulink,
1119: $helplink) = @_;
1.55 matthew 1120: if (! defined($color)) {
1121: if (! defined($function)) {
1122: $function = &Apache::loncommon::get_users_function();
1123: }
1124: $color = &Apache::loncommon::designparm($function.'.tabbg',
1125: $domain);
1126: }
1.53 matthew 1127: #
1128: my $Str = "\n".
1129: '<table width="100%" border="0" cellpadding="0" cellspacing="0">'.
1130: '<tr><td bgcolor="'.$color.'">'.
1131: '<font size="-1">';
1.57 matthew 1132: #
1133: # Make the faq and bug data cascade
1134: my $faq = '';
1135: my $bug = '';
1.106 www 1136: my $help='';
1.60 www 1137: # The last breadcrumb does not have a link, so handle it separately.
1.53 matthew 1138: my $last = pop(@Crumbs);
1.57 matthew 1139: #
1.70 matthew 1140: # The first one should be the course or a menu link
1.63 albertel 1141: if (!defined($menulink)) { $menulink=1; }
1.70 matthew 1142: if ($menulink) {
1143: my $description = 'Menu';
1.104 albertel 1144: if (exists($env{'request.course.id'}) &&
1145: $env{'request.course.id'} ne '') {
1.70 matthew 1146: $description =
1.104 albertel 1147: $env{'course.'.$env{'request.course.id'}.'.description'};
1.70 matthew 1148: }
1.57 matthew 1149: unshift(@Crumbs,{
1.70 matthew 1150: href =>'/adm/menu',
1151: title =>'Go to main menu',
1152: target =>'_top',
1153: text =>$description,
1154: });
1.53 matthew 1155: }
1156: my $links .=
1157: join('->',
1158: map {
1.57 matthew 1159: $faq = $_->{'faq'} if (exists($_->{'faq'}));
1160: $bug = $_->{'bug'} if (exists($_->{'bug'}));
1.106 www 1161: $help = $_->{'help'} if (exists($_->{'help'}));
1.69 matthew 1162: my $result = '<a href="'.$_->{'href'}.'" ';
1163: if (defined($_->{'target'}) && $_->{'target'} ne '') {
1164: $result .= 'target="'.$_->{'target'}.'" ';
1165: }
1166: $result .='title="'.&mt($_->{'title'}).'">'.
1167: &mt($_->{'text'}).'</a>';
1168: $result;
1.53 matthew 1169: } @Crumbs
1170: );
1171: $links .= '->' if ($links ne '');
1.82 albertel 1172: $links .= '<b>'.&mt($last->{'text'}).'</b>';
1.54 matthew 1173: #
1174: my $icons = '';
1.57 matthew 1175: $faq = $last->{'faq'} if (exists($last->{'faq'}));
1176: $bug = $last->{'bug'} if (exists($last->{'bug'}));
1.106 www 1177: $help = $last->{'help'} if (exists($last->{'help'}));
1178: $component_help=($component_help?$component_help:$help);
1.79 raeburn 1179: # if ($faq ne '') {
1180: # $icons .= &Apache::loncommon::help_open_faq($faq);
1181: # }
1182: # if ($bug ne '') {
1183: # $icons .= &Apache::loncommon::help_open_bug($bug);
1184: # }
1.87 albertel 1185: if ($helplink ne 'nohelp') {
1186: $icons .= &Apache::loncommon::help_open_menu($color,$component,$component_help,$function,$faq,$bug);
1187: }
1.54 matthew 1188: if ($icons ne '') {
1189: $Str .= $icons.' ';
1.53 matthew 1190: }
1.54 matthew 1191: #
1.53 matthew 1192: $Str .= $links.'</font></td>';
1.54 matthew 1193: #
1.53 matthew 1194: if (defined($component)) {
1195: $Str .= '<td align="right" bgcolor="'.$color.'">'.
1.83 raeburn 1196: '<font size="+1">'.&mt($component).'</font></td>';
1.53 matthew 1197: }
1198: $Str .= '</tr></table>'."\n";
1199: #
1200: # Return the @Crumbs stack to what we started with
1201: push(@Crumbs,$last);
1202: shift(@Crumbs);
1203: #
1204: return $Str;
1205: }
1206:
1207: sub clear_breadcrumbs {
1208: undef(@Crumbs);
1209: }
1210:
1211: sub add_breadcrumb {
1212: push (@Crumbs,@_);
1213: }
1214:
1.57 matthew 1215: } # End of scope for @Crumbs
1.53 matthew 1216:
1217: ############################################################
1218: ############################################################
1219:
1.1 stredwic 1220:
1221: 1;
1.23 matthew 1222:
1.1 stredwic 1223: __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