Annotation of loncom/interface/lonhtmlcommon.pm, revision 1.133
1.2 www 1: # The LearningOnline Network with CAPA
2: # a pile of common html routines
3: #
1.132 www 4: # $Id: lonhtmlcommon.pm,v 1.131 2006/06/01 19:30:49 albertel 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.130 www 63: use lib '/home/httpd/lib/perl/';
64: use LONCAPA;
1.1 stredwic 65:
1.40 www 66: ##############################################
67: ##############################################
68:
69: =pod
70:
71: =item authorbombs
72:
73: =cut
74:
75: ##############################################
76: ##############################################
77:
78: sub authorbombs {
79: my $url=shift;
80: $url=&Apache::lonnet::declutter($url);
81: my ($udom,$uname)=($url=~/^(\w+)\/(\w+)\//);
82: my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom);
83: foreach (keys %bombs) {
84: if ($_=~/^$udom\/$uname\//) {
85: return '<a href="/adm/bombs/'.$url.
1.103 albertel 86: '"><img src="'.&Apache::loncommon::lonhttpdurl('/adm/lonMisc/bomb.gif').'" border="0" /></a>'.
1.40 www 87: &Apache::loncommon::help_open_topic('About_Bombs');
88: }
89: }
90: return '';
91: }
1.26 matthew 92:
93: ##############################################
94: ##############################################
95:
1.41 www 96: sub recent_filename {
97: my $area=shift;
1.130 www 98: return 'nohist_recent_'.&escape($area);
1.41 www 99: }
100:
101: sub store_recent {
102: my ($area,$name,$value)=@_;
103: my $file=&recent_filename($area);
104: my %recent=&Apache::lonnet::dump($file);
1.111 www 105: if (scalar(keys(%recent))>20) {
1.41 www 106: # remove oldest value
107: my $oldest=time;
108: my $delkey='';
109: foreach (keys %recent) {
110: my $thistime=(split(/\&/,$recent{$_}))[0];
111: if ($thistime<$oldest) {
112: $oldest=$thistime;
113: $delkey=$_;
114: }
115: }
116: &Apache::lonnet::del($file,[$delkey]);
117: }
118: # store new value
119: &Apache::lonnet::put($file,{ $name =>
1.130 www 120: time.'&'.&escape($value) });
1.41 www 121: }
122:
1.89 banghart 123: sub remove_recent {
124: my ($area,$names)=@_;
125: my $file=&recent_filename($area);
126: return &Apache::lonnet::del($file,$names);
127: }
128:
1.41 www 129: sub select_recent {
130: my ($area,$fieldname,$event)=@_;
131: my %recent=&Apache::lonnet::dump(&recent_filename($area));
132: my $return="\n<select name='$fieldname'".
1.96 albertel 133: ($event?" onchange='$event'":'').
1.41 www 134: ">\n<option value=''>--- ".&mt('Recent')." ---</option>";
135: foreach (sort keys %recent) {
136: unless ($_=~/^error\:/) {
1.94 foxr 137: my $escaped = &Apache::loncommon::escape_url($_);
138: $return.="\n<option value='$escaped'>".
1.130 www 139: &unescape((split(/\&/,$recent{$_}))[1]).
1.41 www 140: '</option>';
141: }
142: }
143: $return.="\n</select>\n";
144: return $return;
145: }
146:
1.97 albertel 147: sub get_recent {
148: my ($area, $n) = @_;
149: my %recent=&Apache::lonnet::dump(&recent_filename($area));
150:
151: # Create hash with key as time and recent as value
152: my %time_hash = ();
1.133 ! albertel 153: my $nfrozen = 0;
1.97 albertel 154: foreach (keys %recent) {
1.133 ! albertel 155: my ($thistime,$thisvalue)=(split(/\&/,$recent{$_}));
! 156: if (($thisvalue eq 'role_frozen') && ($area='roles')) {
! 157: $thistime=time+$nfrozen;
! 158: $nfrozen++;
! 159: }
1.97 albertel 160: $time_hash{$thistime} = $_;
161: }
162:
163: # Sort by decreasing time and return key value pairs
164: my %return_hash = ();
165: my $idx = 1;
166: foreach (reverse sort keys %time_hash) {
167: $return_hash{$time_hash{$_}} =
1.133 ! albertel 168: &unescape((split(/\&/,$recent{$time_hash{$_}}))[1]);
1.97 albertel 169: if ($n && ($idx++ >= $n)) {last;}
170: }
171:
172: return %return_hash;
173: }
174:
175:
1.41 www 176:
1.26 matthew 177: =pod
178:
179: =item textbox
180:
181: =cut
182:
183: ##############################################
184: ##############################################
185: sub textbox {
186: my ($name,$value,$size,$special) = @_;
187: $size = 40 if (! defined($size));
1.128 albertel 188: $value = &HTML::Entities::encode($value,'<>&"');
1.26 matthew 189: my $Str = '<input type="text" name="'.$name.'" size="'.$size.'" '.
190: 'value="'.$value.'" '.$special.' />';
191: return $Str;
192: }
193:
194: ##############################################
195: ##############################################
196:
197: =pod
198:
199: =item checkbox
200:
201: =cut
202:
203: ##############################################
204: ##############################################
205: sub checkbox {
1.68 matthew 206: my ($name,$checked,$value) = @_;
207: my $Str = '<input type="checkbox" name="'.$name.'" ';
208: if (defined($value)) {
209: $Str .= 'value="'.$value.'"';
210: }
211: if ($checked) {
212: $Str .= ' checked="1"';
213: }
214: $Str .= ' />';
1.26 matthew 215: return $Str;
216: }
217:
1.120 albertel 218:
219: =pod
220:
221: =item radiobutton
222:
223: =cut
224:
225: ##############################################
226: ##############################################
227: sub radio {
228: my ($name,$checked,$value) = @_;
229: my $Str = '<input type="radio" name="'.$name.'" ';
230: if (defined($value)) {
231: $Str .= 'value="'.$value.'"';
232: }
233: if ($checked eq $value) {
234: $Str .= ' checked="1"';
235: }
236: $Str .= ' />';
237: return $Str;
238: }
239:
1.10 matthew 240: ##############################################
241: ##############################################
242:
243: =pod
244:
245: =item &date_setter
246:
1.22 matthew 247: &date_setter returns html and javascript for a compact date-setting form.
248: To retrieve values from it, use &get_date_from_form().
249:
1.10 matthew 250: Inputs
251:
252: =over 4
253:
254: =item $dname
255:
256: The name to prepend to the form elements.
257: The form elements defined will be dname_year, dname_month, dname_day,
258: dname_hour, dname_min, and dname_sec.
259:
260: =item $currentvalue
261:
262: The current setting for this time parameter. A unix format time
263: (time in seconds since the beginning of Jan 1st, 1970, GMT.
264: An undefined value is taken to indicate the value is the current time.
265: Also, to be explicit, a value of 'now' also indicates the current time.
266:
1.26 matthew 267: =item $special
268:
269: Additional html/javascript to be associated with each element in
270: the date_setter. See lonparmset for example usage.
271:
1.59 matthew 272: =item $includeempty
273:
274: =item $state
275:
276: Specifies the initial state of the form elements. Either 'disabled' or empty.
277: Defaults to empty, which indiciates the form elements are not disabled.
278:
1.22 matthew 279: =back
280:
281: Bugs
282:
283: The method used to restrict user input will fail in the year 2400.
284:
1.10 matthew 285: =cut
286:
287: ##############################################
288: ##############################################
289: sub date_setter {
1.67 matthew 290: my ($formname,$dname,$currentvalue,$special,$includeempty,$state,
1.108 www 291: $no_hh_mm_ss,$defhour,$defmin,$defsec) = @_;
1.107 www 292: my $wasdefined=1;
1.59 matthew 293: if (! defined($state) || $state ne 'disabled') {
294: $state = '';
295: }
1.67 matthew 296: if (! defined($no_hh_mm_ss)) {
297: $no_hh_mm_ss = 0;
298: }
1.110 www 299: if ($currentvalue eq 'now') {
300: $currentvalue=time;
301: }
302: if ((!defined($currentvalue)) || ($currentvalue eq '')) {
303: $wasdefined=0;
304: if ($includeempty) {
305: $currentvalue = 0;
306: } else {
1.39 www 307: $currentvalue = time;
308: }
1.10 matthew 309: }
310: # other potentially useful values: wkday,yrday,is_daylight_savings
1.65 albertel 311: my ($sec,$min,$hour,$mday,$month,$year)=('','',undef,'','','');
1.39 www 312: if ($currentvalue) {
313: ($sec,$min,$hour,$mday,$month,$year,undef,undef,undef) =
314: localtime($currentvalue);
315: $year += 1900;
316: }
1.107 www 317: unless ($wasdefined) {
1.110 www 318: if (($defhour) || ($defmin) || ($defsec)) {
319: ($sec,$min,$hour,$mday,$month,$year,undef,undef,undef) =
320: localtime(time);
321: $year += 1900;
322: $sec=($defsec?$defsec:0);
323: $min=($defmin?$defmin:0);
324: $hour=($defhour?$defhour:0);
325: } elsif (!$includeempty) {
326: $sec=0;
327: $min=0;
328: $hour=0;
329: }
1.107 www 330: }
1.10 matthew 331: my $result = "\n<!-- $dname date setting form -->\n";
332: $result .= <<ENDJS;
333: <script language="Javascript">
334: function $dname\_checkday() {
335: var day = document.$formname.$dname\_day.value;
336: var month = document.$formname.$dname\_month.value;
337: var year = document.$formname.$dname\_year.value;
338: var valid = true;
339: if (day < 1) {
340: document.$formname.$dname\_day.value = 1;
341: }
342: if (day > 31) {
343: document.$formname.$dname\_day.value = 31;
344: }
345: if ((month == 1) || (month == 3) || (month == 5) ||
346: (month == 7) || (month == 8) || (month == 10) ||
347: (month == 12)) {
348: if (day > 31) {
349: document.$formname.$dname\_day.value = 31;
350: day = 31;
351: }
352: } else if (month == 2 ) {
353: if ((year % 4 == 0) && (year % 100 != 0)) {
354: if (day > 29) {
355: document.$formname.$dname\_day.value = 29;
356: }
357: } else if (day > 29) {
358: document.$formname.$dname\_day.value = 28;
359: }
360: } else if (day > 30) {
361: document.$formname.$dname\_day.value = 30;
362: }
363: }
1.95 matthew 364:
1.59 matthew 365: function $dname\_disable() {
366: document.$formname.$dname\_month.disabled=true;
367: document.$formname.$dname\_day.disabled=true;
368: document.$formname.$dname\_year.disabled=true;
369: document.$formname.$dname\_hour.disabled=true;
370: document.$formname.$dname\_minute.disabled=true;
371: document.$formname.$dname\_second.disabled=true;
372: }
373:
374: function $dname\_enable() {
375: document.$formname.$dname\_month.disabled=false;
376: document.$formname.$dname\_day.disabled=false;
377: document.$formname.$dname\_year.disabled=false;
378: document.$formname.$dname\_hour.disabled=false;
379: document.$formname.$dname\_minute.disabled=false;
380: document.$formname.$dname\_second.disabled=false;
381: }
382:
1.29 www 383: function $dname\_opencalendar() {
1.59 matthew 384: if (! document.$formname.$dname\_month.disabled) {
385: var calwin=window.open(
1.29 www 386: "/adm/announcements?pickdate=yes&formname=$formname&element=$dname&month="+
387: document.$formname.$dname\_month.value+"&year="+
388: document.$formname.$dname\_year.value,
389: "LONCAPAcal",
390: "height=350,width=350,scrollbars=yes,resizable=yes,menubar=no");
1.59 matthew 391: }
1.29 www 392:
393: }
1.10 matthew 394: </script>
395: ENDJS
1.95 matthew 396: $result .= ' <nobr>';
1.96 albertel 397: my $monthselector = qq{<select name="$dname\_month" $special $state onchange="javascript:$dname\_checkday()" >};
1.67 matthew 398: # Month
1.10 matthew 399: my @Months = qw/January February March April May June
400: July August September October November December/;
401: # Pad @Months with a bogus value to make indexing easier
402: unshift(@Months,'If you can read this an error occurred');
1.95 matthew 403: if ($includeempty) { $monthselector.="<option value=''></option>"; }
1.10 matthew 404: for(my $m = 1;$m <=$#Months;$m++) {
1.95 matthew 405: $monthselector .= qq{ <option value="$m" };
406: $monthselector .= "selected " if ($m-1 eq $month);
407: $monthselector .= '> '.&mt($Months[$m]).' </option>';
1.10 matthew 408: }
1.95 matthew 409: $monthselector.= ' </select>';
1.67 matthew 410: # Day
1.96 albertel 411: my $dayselector = qq{<input type="text" name="$dname\_day" $state value="$mday" size="3" $special onchange="javascript:$dname\_checkday()" />};
1.67 matthew 412: # Year
1.96 albertel 413: my $yearselector = qq{<input type="year" name="$dname\_year" $state value="$year" size="5" $special onchange="javascript:$dname\_checkday()" />};
1.95 matthew 414: #
415: my $hourselector = qq{<select name="$dname\_hour" $special $state >};
416: if ($includeempty) {
417: $hourselector.=qq{<option value=''></option>};
418: }
419: for (my $h = 0;$h<24;$h++) {
420: $hourselector .= qq{<option value="$h" };
421: $hourselector .= "selected " if (defined($hour) && $hour == $h);
422: $hourselector .= ">";
423: my $timest='';
424: if ($h == 0) {
425: $timest .= "12 am";
426: } elsif($h == 12) {
427: $timest .= "12 noon";
428: } elsif($h < 12) {
429: $timest .= "$h am";
430: } else {
431: $timest .= $h-12 ." pm";
432: }
433: $timest=&mt($timest);
434: $hourselector .= $timest." </option>\n";
435: }
436: $hourselector .= " </select>\n";
437: my $minuteselector = qq{<input type="text" name="$dname\_minute" $special $state value="$min" size="3" />};
438: my $secondselector= qq{<input type="text" name="$dname\_second" $special $state value="$sec" size="3" />};
439: my $cal_link = qq{<a href="javascript:$dname\_opencalendar()">};
440: #
441: if ($no_hh_mm_ss) {
442: $result .= &mt('[_1] [_2] [_3] [_4]Select Date[_5]',
443: $monthselector,$dayselector,$yearselector,
444: $cal_link,'</a>');
445: } else {
446: $result .= &mt('[_1] [_2] [_3] [_4] [_5]m [_6]s [_7]Select Date[_8]',
447: $monthselector,$dayselector,$yearselector,
448: $hourselector,$minuteselector,$secondselector,
449: $cal_link,'</a>');
1.67 matthew 450: }
1.95 matthew 451: $result .= "</nobr>\n<!-- end $dname date setting form -->\n";
1.10 matthew 452: return $result;
453: }
454:
455: ##############################################
456: ##############################################
457:
1.22 matthew 458: =pod
459:
1.10 matthew 460: =item &get_date_from_form
1.22 matthew 461:
462: get_date_from_form retrieves the date specified in an &date_setter form.
1.10 matthew 463:
464: Inputs:
465:
466: =over 4
467:
468: =item $dname
469:
470: The name passed to &datesetter, which prefixes the form elements.
471:
472: =item $defaulttime
473:
474: The unix time to use as the default in case of poor inputs.
475:
476: =back
477:
478: Returns: Unix time represented in the form.
479:
480: =cut
481:
482: ##############################################
483: ##############################################
484: sub get_date_from_form {
485: my ($dname) = @_;
486: my ($sec,$min,$hour,$day,$month,$year);
487: #
1.104 albertel 488: if (defined($env{'form.'.$dname.'_second'})) {
489: my $tmpsec = $env{'form.'.$dname.'_second'};
1.10 matthew 490: if (($tmpsec =~ /^\d+$/) && ($tmpsec >= 0) && ($tmpsec < 60)) {
491: $sec = $tmpsec;
492: }
1.64 albertel 493: if (!defined($tmpsec) || $tmpsec eq '') { $sec = 0; }
1.67 matthew 494: } else {
495: $sec = 0;
1.10 matthew 496: }
1.104 albertel 497: if (defined($env{'form.'.$dname.'_minute'})) {
498: my $tmpmin = $env{'form.'.$dname.'_minute'};
1.10 matthew 499: if (($tmpmin =~ /^\d+$/) && ($tmpmin >= 0) && ($tmpmin < 60)) {
500: $min = $tmpmin;
501: }
1.64 albertel 502: if (!defined($tmpmin) || $tmpmin eq '') { $min = 0; }
1.67 matthew 503: } else {
504: $min = 0;
1.10 matthew 505: }
1.104 albertel 506: if (defined($env{'form.'.$dname.'_hour'})) {
507: my $tmphour = $env{'form.'.$dname.'_hour'};
1.33 matthew 508: if (($tmphour =~ /^\d+$/) && ($tmphour >= 0) && ($tmphour < 24)) {
1.10 matthew 509: $hour = $tmphour;
510: }
1.67 matthew 511: } else {
512: $hour = 0;
1.10 matthew 513: }
1.104 albertel 514: if (defined($env{'form.'.$dname.'_day'})) {
515: my $tmpday = $env{'form.'.$dname.'_day'};
1.10 matthew 516: if (($tmpday =~ /^\d+$/) && ($tmpday > 0) && ($tmpday < 32)) {
517: $day = $tmpday;
518: }
519: }
1.104 albertel 520: if (defined($env{'form.'.$dname.'_month'})) {
521: my $tmpmonth = $env{'form.'.$dname.'_month'};
1.10 matthew 522: if (($tmpmonth =~ /^\d+$/) && ($tmpmonth > 0) && ($tmpmonth < 13)) {
523: $month = $tmpmonth - 1;
524: }
525: }
1.104 albertel 526: if (defined($env{'form.'.$dname.'_year'})) {
527: my $tmpyear = $env{'form.'.$dname.'_year'};
1.10 matthew 528: if (($tmpyear =~ /^\d+$/) && ($tmpyear > 1900)) {
529: $year = $tmpyear - 1900;
530: }
531: }
1.24 www 532: if (($year<70) || ($year>137)) { return undef; }
1.33 matthew 533: if (defined($sec) && defined($min) && defined($hour) &&
534: defined($day) && defined($month) && defined($year) &&
1.125 albertel 535: eval('&timelocal($sec,$min,$hour,$day,$month,$year)')) {
1.10 matthew 536: return &timelocal($sec,$min,$hour,$day,$month,$year);
537: } else {
538: return undef;
539: }
1.20 matthew 540: }
541:
542: ##############################################
543: ##############################################
544:
545: =pod
546:
547: =item &pjump_javascript_definition()
548:
549: Returns javascript defining the 'pjump' function, which opens up a
550: parameter setting wizard.
551:
552: =cut
553:
554: ##############################################
555: ##############################################
556: sub pjump_javascript_definition {
557: my $Str = <<END;
1.109 www 558: function pjump(type,dis,value,marker,ret,call,hour,min,sec) {
1.20 matthew 559: parmwin=window.open("/adm/rat/parameter.html?type="+escape(type)
560: +"&value="+escape(value)+"&marker="+escape(marker)
561: +"&return="+escape(ret)
1.109 www 562: +"&call="+escape(call)+"&name="+escape(dis)
563: +"&defhour="+escape(hour)+"&defmin="+escape(min)
564: +"&defsec="+escape(sec),"LONCAPAparms",
1.20 matthew 565: "height=350,width=350,scrollbars=no,menubar=no");
566: }
567: END
568: return $Str;
1.10 matthew 569: }
570:
571: ##############################################
572: ##############################################
1.17 matthew 573:
574: =pod
575:
576: =item &javascript_nothing()
577:
578: Return an appropriate null for the users browser. This is used
579: as the first arguement for window.open calls when you want a blank
580: window that you can then write to.
581:
582: =cut
583:
584: ##############################################
585: ##############################################
586: sub javascript_nothing {
587: # mozilla and other browsers work with "''", but IE on mac does not.
588: my $nothing = "''";
589: my $user_browser;
590: my $user_os;
1.104 albertel 591: $user_browser = $env{'browser.type'} if (exists($env{'browser.type'}));
592: $user_os = $env{'browser.os'} if (exists($env{'browser.os'}));
1.17 matthew 593: if (! defined($user_browser) || ! defined($user_os)) {
594: (undef,$user_browser,undef,undef,undef,$user_os) =
595: &Apache::loncommon::decode_user_agent();
596: }
597: if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
598: $nothing = "'javascript:void(0);'";
599: }
600: return $nothing;
601: }
602:
1.90 www 603: ##############################################
604: ##############################################
605: sub javascript_docopen {
606: # safari does not understand document.open() and loads "text/html"
607: my $nothing = "''";
608: my $user_browser;
609: my $user_os;
1.104 albertel 610: $user_browser = $env{'browser.type'} if (exists($env{'browser.type'}));
611: $user_os = $env{'browser.os'} if (exists($env{'browser.os'}));
1.90 www 612: if (! defined($user_browser) || ! defined($user_os)) {
613: (undef,$user_browser,undef,undef,undef,$user_os) =
614: &Apache::loncommon::decode_user_agent();
615: }
616: if ($user_browser eq 'safari' && $user_os =~ 'mac') {
617: $nothing = "document.clear()";
618: } else {
619: $nothing = "document.open('text/html','replace')";
620: }
621: return $nothing;
622: }
623:
1.21 matthew 624:
1.17 matthew 625: ##############################################
626: ##############################################
627:
1.21 matthew 628: =pod
1.17 matthew 629:
1.21 matthew 630: =item &StatusOptions()
1.10 matthew 631:
1.21 matthew 632: Returns html for a selection box which allows the user to choose the
633: enrollment status of students. The selection box name is 'Status'.
1.6 stredwic 634:
1.21 matthew 635: Inputs:
1.6 stredwic 636:
1.21 matthew 637: $status: the currently selected status. If undefined the value of
1.104 albertel 638: $env{'form.Status'} is taken. If that is undefined, a value of 'Active'
1.21 matthew 639: is used.
1.6 stredwic 640:
1.21 matthew 641: $formname: The name of the form. If defined the onchange attribute of
642: the selection box is set to document.$formname.submit().
1.6 stredwic 643:
1.21 matthew 644: $size: the size (number of lines) of the selection box.
1.6 stredwic 645:
1.27 matthew 646: $onchange: javascript to use when the value is changed. Enclosed in
647: double quotes, ""s, not single quotes.
648:
1.21 matthew 649: Returns: a perl string as described.
1.1 stredwic 650:
1.21 matthew 651: =cut
1.9 stredwic 652:
1.21 matthew 653: ##############################################
654: ##############################################
655: sub StatusOptions {
1.27 matthew 656: my ($status, $formName,$size,$onchange)=@_;
1.21 matthew 657: $size = 1 if (!defined($size));
658: if (! defined($status)) {
659: $status = 'Active';
1.104 albertel 660: $status = $env{'form.Status'} if (exists($env{'form.Status'}));
1.9 stredwic 661: }
1.1 stredwic 662:
663: my $OpSel1 = '';
664: my $OpSel2 = '';
665: my $OpSel3 = '';
666:
667: if($status eq 'Any') { $OpSel3 = ' selected'; }
668: elsif($status eq 'Expired' ) { $OpSel2 = ' selected'; }
669: else { $OpSel1 = ' selected'; }
670:
671: my $Str = '';
672: $Str .= '<select name="Status"';
1.27 matthew 673: if(defined($formName) && $formName ne '' && ! defined($onchange)) {
1.1 stredwic 674: $Str .= ' onchange="document.'.$formName.'.submit()"';
1.27 matthew 675: }
676: if (defined($onchange)) {
677: $Str .= ' onchange="'.$onchange.'"';
1.1 stredwic 678: }
1.21 matthew 679: $Str .= ' size="'.$size.'" ';
1.1 stredwic 680: $Str .= '>'."\n";
1.21 matthew 681: $Str .= '<option value="Active" '.$OpSel1.'>'.
1.37 www 682: &mt('Currently Enrolled').'</option>'."\n";
1.21 matthew 683: $Str .= '<option value="Expired" '.$OpSel2.'>'.
1.37 www 684: &mt('Previously Enrolled').'</option>'."\n";
1.21 matthew 685: $Str .= '<option value="Any" '.$OpSel3.'>'.
1.37 www 686: &mt('Any Enrollment Status').'</option>'."\n";
1.1 stredwic 687: $Str .= '</select>'."\n";
1.7 stredwic 688: }
1.12 matthew 689:
690: ########################################################
691: ########################################################
1.7 stredwic 692:
1.23 matthew 693: =pod
694:
695: =item Progess Window Handling Routines
696:
697: These routines handle the creation, update, increment, and closure of
698: progress windows. The progress window reports to the user the number
699: of items completed and an estimate of the time required to complete the rest.
700:
701: =over 4
702:
703:
704: =item &Create_PrgWin
705:
706: Writes javascript to the client to open a progress window and returns a
707: data structure used for bookkeeping.
708:
709: Inputs
710:
711: =over 4
712:
713: =item $r Apache request
714:
715: =item $title The title of the progress window
716:
717: =item $heading A description (usually 1 line) of the process being initiated.
718:
719: =item $number_to_do The total number of items being processed.
1.50 albertel 720:
721: =item $type Either 'popup' or 'inline' (popup is assumed if nothing is
722: specified)
723:
1.51 albertel 724: =item $width Specify the width in charaters of the input field.
725:
1.50 albertel 726: =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
727:
728: =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 729:
730: =back
731:
732: Returns a hash containing the progress state data structure.
733:
734:
735: =item &Update_PrgWin
736:
737: Updates the text in the progress indicator. Does not increment the count.
738: See &Increment_PrgWin.
739:
740: Inputs:
741:
742: =over 4
743:
744: =item $r Apache request
745:
746: =item $prog_state Pointer to the data structure returned by &Create_PrgWin
747:
748: =item $displaystring The string to write to the status indicator
749:
750: =back
751:
752: Returns: none
753:
754:
755: =item Increment_PrgWin
756:
757: Increment the count of items completed for the progress window by 1.
758:
759: Inputs:
760:
761: =over 4
762:
763: =item $r Apache request
764:
765: =item $prog_state Pointer to the data structure returned by Create_PrgWin
766:
767: =item $extraInfo A description of the items being iterated over. Typically
768: 'student'.
769:
770: =back
771:
772: Returns: none
773:
774:
775: =item Close_PrgWin
776:
777: Closes the progress window.
778:
779: Inputs:
780:
781: =over 4
782:
783: =item $r Apache request
784:
785: =item $prog_state Pointer to the data structure returned by Create_PrgWin
786:
787: =back
788:
789: Returns: none
790:
791: =back
792:
793: =cut
794:
795: ########################################################
796: ########################################################
797:
1.51 albertel 798: my $uniq=0;
799: sub get_uniq_name {
800: $uniq++;
801: return 'uniquename'.$uniq;
802: }
803:
1.7 stredwic 804: # Create progress
805: sub Create_PrgWin {
1.51 albertel 806: my ($r, $title, $heading, $number_to_do,$type,$width,$formname,
807: $inputname)=@_;
1.49 albertel 808: if (!defined($type)) { $type='popup'; }
1.51 albertel 809: if (!defined($width)) { $width=55; }
1.49 albertel 810: my %prog_state;
811: $prog_state{'type'}=$type;
812: if ($type eq 'popup') {
813: $prog_state{'window'}='popwin';
1.122 albertel 814: my $start_page =
815: &Apache::loncommon::start_page($title,undef,
816: {'only_body' => 1,
817: 'bgcolor' => '#88DDFF',
818: 'js_ready' => 1});
819: my $end_page = &Apache::loncommon::end_page({'js_ready' => 1});
820:
1.49 albertel 821: #the whole function called through timeout is due to issues
822: #in mozilla Read BUG #2665 if you want to know the whole story
1.122 albertel 823: &r_print($r,'<script type="text/javascript">'.
1.49 albertel 824: "var popwin;
825: function openpopwin () {
826: popwin=open(\'\',\'popwin\',\'width=400,height=100\');".
1.122 albertel 827: "popwin.document.writeln(\'".$start_page.
1.131 albertel 828: "<h4>$heading<\/h4>".
829: "<form name=\"popremain\" method=\"post\">".
1.51 albertel 830: '<input type="text" size="'.$width.'" name="remaining" value="'.
1.131 albertel 831: &mt('Starting').'" /><\\/form>'.$end_page.
1.122 albertel 832: "\');".
1.49 albertel 833: "popwin.document.close();}".
834: "\nwindow.setTimeout(openpopwin,0)</script>");
835: $prog_state{'formname'}='popremain';
836: $prog_state{'inputname'}="remaining";
837: } elsif ($type eq 'inline') {
838: $prog_state{'window'}='window';
839: if (!$formname) {
1.51 albertel 840: $prog_state{'formname'}=&get_uniq_name();
841: &r_print($r,'<form name="'.$prog_state{'formname'}.'">');
1.49 albertel 842: } else {
843: $prog_state{'formname'}=$formname;
844: }
845: if (!$inputname) {
1.51 albertel 846: $prog_state{'inputname'}=&get_uniq_name();
1.56 albertel 847: &r_print($r,$heading.' <input type="text" name="'.$prog_state{'inputname'}.
1.51 albertel 848: '" size="'.$width.'" />');
1.49 albertel 849: } else {
850: $prog_state{'inputname'}=$inputname;
851:
852: }
853: if (!$formname) { &r_print($r,'</form>'); }
854: &Update_PrgWin($r,\%prog_state,&mt('Starting'));
855: }
1.7 stredwic 856:
1.16 albertel 857: $prog_state{'done'}=0;
1.23 matthew 858: $prog_state{'firststart'}=&Time::HiRes::time();
859: $prog_state{'laststart'}=&Time::HiRes::time();
1.16 albertel 860: $prog_state{'max'}=$number_to_do;
1.49 albertel 861:
1.14 albertel 862: return %prog_state;
1.7 stredwic 863: }
864:
865: # update progress
866: sub Update_PrgWin {
1.14 albertel 867: my ($r,$prog_state,$displayString)=@_;
1.49 albertel 868: &r_print($r,'<script>'.$$prog_state{'window'}.'.document.'.
869: $$prog_state{'formname'}.'.'.
870: $$prog_state{'inputname'}.'.value="'.
1.48 albertel 871: $displayString.'";</script>');
1.23 matthew 872: $$prog_state{'laststart'}=&Time::HiRes::time();
1.14 albertel 873: }
874:
875: # increment progress state
876: sub Increment_PrgWin {
877: my ($r,$prog_state,$extraInfo)=@_;
1.16 albertel 878: $$prog_state{'done'}++;
1.23 matthew 879: my $time_est= (&Time::HiRes::time() - $$prog_state{'firststart'})/
880: $$prog_state{'done'} *
1.16 albertel 881: ($$prog_state{'max'}-$$prog_state{'done'});
882: $time_est = int($time_est);
1.80 matthew 883: #
884: my $min = int($time_est/60);
885: my $sec = $time_est % 60;
886: #
887: my $str;
1.91 albertel 888: if ($min == 0 && $sec > 1) {
1.80 matthew 889: $str = '[_2] seconds';
1.91 albertel 890: } elsif ($min == 1 && $sec > 1) {
891: $str = '1 minute [_2] seconds';
1.80 matthew 892: } elsif ($min == 1 && $sec < 2) {
893: $str = '1 minute';
894: } elsif ($min < 10 && $sec > 1) {
895: $str = '[_1] minutes, [_2] seconds';
1.81 matthew 896: } elsif ($min >= 10 || $sec < 2) {
1.80 matthew 897: $str = '[_1] minutes';
1.16 albertel 898: }
1.80 matthew 899: $time_est = &mt($str,$min,$sec);
900: #
1.23 matthew 901: my $lasttime = &Time::HiRes::time()-$$prog_state{'laststart'};
902: if ($lasttime > 9) {
903: $lasttime = int($lasttime);
904: } elsif ($lasttime < 0.01) {
905: $lasttime = 0;
906: } else {
907: $lasttime = sprintf("%3.2f",$lasttime);
908: }
1.19 matthew 909: if ($lasttime == 1) {
1.32 www 910: $lasttime = '('.$lasttime.' '.&mt('second for').' '.$extraInfo.')';
1.19 matthew 911: } else {
1.32 www 912: $lasttime = '('.$lasttime.' '.&mt('seconds for').' '.$extraInfo.')';
1.28 matthew 913: }
914: #
1.104 albertel 915: my $user_browser = $env{'browser.type'} if (exists($env{'browser.type'}));
916: my $user_os = $env{'browser.os'} if (exists($env{'browser.os'}));
1.28 matthew 917: if (! defined($user_browser) || ! defined($user_os)) {
918: (undef,$user_browser,undef,undef,undef,$user_os) =
919: &Apache::loncommon::decode_user_agent();
920: }
921: if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
922: $lasttime = '';
1.19 matthew 923: }
1.49 albertel 924: &r_print($r,'<script>'.$$prog_state{'window'}.'.document.'.
925: $$prog_state{'formname'}.'.'.
926: $$prog_state{'inputname'}.'.value="'.
1.48 albertel 927: $$prog_state{'done'}.'/'.$$prog_state{'max'}.
928: ': '.$time_est.' '.&mt('remaining').' '.$lasttime.'";'.'</script>');
1.23 matthew 929: $$prog_state{'laststart'}=&Time::HiRes::time();
1.7 stredwic 930: }
931:
932: # close Progress Line
933: sub Close_PrgWin {
1.14 albertel 934: my ($r,$prog_state)=@_;
1.49 albertel 935: if ($$prog_state{'type'} eq 'popup') {
936: &r_print($r,'<script>popwin.close()</script>'."\n");
937: } elsif ($$prog_state{'type'} eq 'inline') {
938: &Update_PrgWin($r,$prog_state,&mt('Done'));
939: }
1.48 albertel 940: undef(%$prog_state);
941: }
942:
943: sub r_print {
944: my ($r,$to_print)=@_;
945: if ($r) {
946: $r->print($to_print);
947: $r->rflush();
1.47 sakharuk 948: } else {
1.48 albertel 949: print($to_print);
1.47 sakharuk 950: }
1.1 stredwic 951: }
1.34 www 952:
953: # ------------------------------------------------------- Puts directory header
954:
955: sub crumbs {
1.132 www 956: my ($uri,$target,$prefix,$form,$size,$noformat,$skiplast)=@_;
1.62 matthew 957: if (! defined($size)) {
958: $size = '+2';
959: }
1.100 raeburn 960: if ($target) {
961: $target = ' target="'.
962: &Apache::loncommon::escape_single($target).'"';
963: }
1.78 www 964: my $output='';
965: unless ($noformat) { $output.='<br /><tt><b>'; }
966: $output.='<font size="'.$size.'">'.$prefix.'/';
1.104 albertel 967: if ($env{'user.adv'}) {
1.43 www 968: my $path=$prefix.'/';
1.99 matthew 969: foreach my $dir (split('/',$uri)) {
970: if (! $dir) { next; }
971: $path .= $dir;
1.132 www 972: if ($path eq $uri) {
973: if ($skiplast) {
974: $output.=$dir;
975: last;
976: }
977: } else {
978: $path.='/';
979: }
1.99 matthew 980: my $linkpath = &Apache::loncommon::escape_single($path);
1.98 matthew 981: if ($form) {
1.99 matthew 982: $linkpath=
983: qq{javascript:$form.action='$linkpath';$form.submit();};
1.98 matthew 984: }
1.99 matthew 985: $output.=qq{<a href="$linkpath" $target>$dir</a>/};
1.35 www 986: }
987: } else {
988: $output.=$uri;
1.34 www 989: }
1.36 www 990: unless ($uri=~/\/$/) { $output=~s/\/$//; }
1.78 www 991: return $output.'</font>'.($noformat?'':'</b></tt><br />');
1.34 www 992: }
993:
1.85 www 994: # --------------------- A function that generates a window for the spellchecker
995:
996: sub spellheader {
1.123 albertel 997: my $start_page=
998: &Apache::loncommon::start_page('Speller Suggestions',undef,
999: {'only_body' => 1,
1000: 'js_ready' => 1,
1001: 'bgcolor' => '#DDDDDD',});
1002: my $end_page=
1003: &Apache::loncommon::end_page({'js_ready' => 1});
1004:
1.105 www 1005: my $nothing=&javascript_nothing();
1.85 www 1006: return (<<ENDCHECK);
1007: <script type="text/javascript">
1.92 albertel 1008: //<!-- BEGIN LON-CAPA Internal
1.85 www 1009: var checkwin;
1010:
1011: function spellcheckerwindow() {
1.105 www 1012: checkwin=window.open($nothing,'spellcheckwin','height=320,width=280,resizable=yes,scrollbars=yes,location=no,menubar=no,toolbar=no');
1.131 albertel 1013: checkwin.document.writeln('$start_page<form name="spellcheckform" action="/adm/spellcheck" method="post"><input type="hidden" name="text" value="" /><\\/form>$end_page');
1.85 www 1014: checkwin.document.close();
1015: }
1.92 albertel 1016: // END LON-CAPA Internal -->
1.85 www 1017: </script>
1018: ENDCHECK
1019: }
1020:
1021: # ---------------------------------- Generate link to spell checker for a field
1022:
1023: sub spelllink {
1024: my ($form,$field)=@_;
1025: my $linktext=&mt('Check Spelling');
1026: return (<<ENDLINK);
1.105 www 1027: <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 1028: ENDLINK
1029: }
1030:
1.52 www 1031: # ------------------------------------------------- Output headers for HTMLArea
1032:
1.124 albertel 1033: {
1034: my @htmlareafields;
1035: sub init_htmlareafields {
1036: undef(@htmlareafields);
1037: }
1038:
1039: sub add_htmlareafields {
1040: my (@newfields) = @_;
1041: push(@htmlareafields,@newfields);
1042: }
1043:
1044: sub get_htmlareafields {
1045: return @htmlareafields;
1046: }
1047: }
1048:
1.52 www 1049: sub htmlareaheaders {
1.71 www 1050: if (&htmlareablocked()) { return ''; }
1.76 www 1051: unless (&htmlareabrowser()) { return ''; }
1.52 www 1052: my $lang='en';
1.71 www 1053: if (&mt('htmlarea_lang') ne 'htmlarea_lang') {
1054: $lang=&mt('htmlarea_lang');
1055: }
1.52 www 1056: return (<<ENDHEADERS);
1.61 www 1057: <script type="text/javascript">
1.73 www 1058: _editor_url='/htmlarea/';
1059: _editor_lang='$lang';
1.61 www 1060: </script>
1.52 www 1061: <script type="text/javascript" src="/htmlarea/htmlarea.js"></script>
1062: ENDHEADERS
1063: }
1064:
1.74 www 1065: # ------------------------------------------------- Activate additional buttons
1066:
1067: sub htmlareaaddbuttons {
1068: if (&htmlareablocked()) { return ''; }
1.76 www 1069: unless (&htmlareabrowser()) { return ''; }
1.74 www 1070: return (<<ENDADDBUTTON);
1071: var config=new HTMLArea.Config();
1072: config.registerButton('ed_math','LaTeX Inline',
1073: '/htmlarea/images/ed_math.gif',false,
1074: function(editor,id) {
1.88 albertel 1075: editor.surroundHTML(' <m>\$','\$</m> ');
1.74 www 1076: }
1077: );
1078: config.registerButton('ed_math_eqn','LaTeX Equation',
1079: '/htmlarea/images/ed_math_eqn.gif',false,
1080: function(editor,id) {
1.75 www 1081: editor.surroundHTML(
1.88 albertel 1082: ' \\n<center><m>\\\\[','\\\\]</m></center>\\n ');
1.74 www 1083: }
1084: );
1085: config.toolbar.push(['ed_math','ed_math_eqn']);
1086: ENDADDBUTTON
1087: }
1.76 www 1088:
1089: # ----------------------------------------------------------------- Preferences
1090:
1091: sub disablelink {
1.77 www 1092: my @fields=@_;
1093: if (defined($#fields)) {
1094: unless ($#fields>=0) { return ''; }
1095: }
1.130 www 1096: return '<a href="'.&HTML::Entities::encode('/adm/preferences?action=set_wysiwyg&wysiwyg=off&returnurl=','<>&"').&escape($ENV{'REQUEST_URI'}).'">'.&mt('Disable WYSIWYG Editor').'</a>';
1.76 www 1097: }
1098:
1099: sub enablelink {
1.77 www 1100: my @fields=@_;
1101: if (defined($#fields)) {
1102: unless ($#fields>=0) { return ''; }
1103: }
1.130 www 1104: return '<a href="'.&HTML::Entities::encode('/adm/preferences?action=set_wysiwyg&wysiwyg=on&returnurl=','<>&"').&escape($ENV{'REQUEST_URI'}).'">'.&mt('Enable WYSIWYG Editor').'</a>';
1.76 www 1105: }
1106:
1.72 www 1107: # ----------------------------------------- Script to activate only some fields
1108:
1109: sub htmlareaselectactive {
1.73 www 1110: my @fields=@_;
1.76 www 1111: unless (&htmlareabrowser()) { return ''; }
1.77 www 1112: if (&htmlareablocked()) { return '<br />'.&enablelink(@fields); }
1.74 www 1113: my $output='<script type="text/javascript" defer="1">'.
1114: &htmlareaaddbuttons();
1.73 www 1115: foreach(@fields) {
1.74 www 1116: $output.="\nHTMLArea.replace('$_',config);";
1.72 www 1117: }
1.76 www 1118: $output.="\nwindow.status='Activated Editfields';\n</script><br />".
1.77 www 1119: &disablelink(@fields);
1.72 www 1120: return $output;
1121: }
1122:
1.61 www 1123: # --------------------------------------------------------------------- Blocked
1124:
1125: sub htmlareablocked {
1.104 albertel 1126: unless ($env{'environment.wysiwygeditor'} eq 'on') { return 1; }
1.71 www 1127: return 0;
1.52 www 1128: }
1129:
1130: # ---------------------------------------- Browser capable of running HTMLArea?
1131:
1132: sub htmlareabrowser {
1133: return 1;
1134: }
1.53 matthew 1135:
1136: ############################################################
1137: ############################################################
1138:
1139: =pod
1140:
1141: =item breadcrumbs
1142:
1143: Compiles the previously registered breadcrumbs into an series of links.
1144: FAQ and BUG links will be placed on the left side of the table if they
1145: are defined for the last registered breadcrumb.
1146: Additionally supports a 'component', which will be displayed on the
1147: right side of the table (without a link).
1148: A link to help for the component will be included if one is specified.
1149:
1150: All inputs can be undef without problems.
1151:
1152: Inputs: $color (the background color of the table returned),
1153: $component (the large text on the right side of the table),
1154: $component_help
1.63 albertel 1155: $function (role to get colors from)
1156: $domain (domian of role)
1157: $menulink (boolean, controls whether to include a link to /adm/menu)
1.53 matthew 1158:
1159: Returns a string containing breadcrumbs for the current page.
1160:
1161: =item clear_breadcrumbs
1162:
1163: Clears the previously stored breadcrumbs.
1164:
1165: =item add_breadcrumb
1166:
1167: Pushes a breadcrumb on the stack of crumbs.
1168:
1169: input: $breadcrumb, a hash reference. The keys 'href','title', and 'text'
1170: are required. If present the keys 'faq' and 'bug' will be used to provide
1171: links to the FAQ and bug sites.
1172:
1173: returns: nothing
1174:
1175: =cut
1176:
1177: ############################################################
1178: ############################################################
1179: {
1180: my @Crumbs;
1.57 matthew 1181:
1.53 matthew 1182: sub breadcrumbs {
1.127 albertel 1183: my ($component,$component_help,$menulink,$helplink) = @_;
1.53 matthew 1184: #
1.126 albertel 1185: my $Str = "\n".'<table id="LC_breadcrumbs"><tr><td>';
1.57 matthew 1186: #
1187: # Make the faq and bug data cascade
1188: my $faq = '';
1189: my $bug = '';
1.106 www 1190: my $help='';
1.60 www 1191: # The last breadcrumb does not have a link, so handle it separately.
1.53 matthew 1192: my $last = pop(@Crumbs);
1.57 matthew 1193: #
1.70 matthew 1194: # The first one should be the course or a menu link
1.63 albertel 1195: if (!defined($menulink)) { $menulink=1; }
1.70 matthew 1196: if ($menulink) {
1197: my $description = 'Menu';
1.104 albertel 1198: if (exists($env{'request.course.id'}) &&
1199: $env{'request.course.id'} ne '') {
1.70 matthew 1200: $description =
1.104 albertel 1201: $env{'course.'.$env{'request.course.id'}.'.description'};
1.70 matthew 1202: }
1.57 matthew 1203: unshift(@Crumbs,{
1.70 matthew 1204: href =>'/adm/menu',
1205: title =>'Go to main menu',
1206: target =>'_top',
1207: text =>$description,
1208: });
1.53 matthew 1209: }
1210: my $links .=
1211: join('->',
1212: map {
1.57 matthew 1213: $faq = $_->{'faq'} if (exists($_->{'faq'}));
1214: $bug = $_->{'bug'} if (exists($_->{'bug'}));
1.106 www 1215: $help = $_->{'help'} if (exists($_->{'help'}));
1.69 matthew 1216: my $result = '<a href="'.$_->{'href'}.'" ';
1217: if (defined($_->{'target'}) && $_->{'target'} ne '') {
1218: $result .= 'target="'.$_->{'target'}.'" ';
1219: }
1220: $result .='title="'.&mt($_->{'title'}).'">'.
1221: &mt($_->{'text'}).'</a>';
1222: $result;
1.53 matthew 1223: } @Crumbs
1224: );
1225: $links .= '->' if ($links ne '');
1.82 albertel 1226: $links .= '<b>'.&mt($last->{'text'}).'</b>';
1.54 matthew 1227: #
1228: my $icons = '';
1.57 matthew 1229: $faq = $last->{'faq'} if (exists($last->{'faq'}));
1230: $bug = $last->{'bug'} if (exists($last->{'bug'}));
1.106 www 1231: $help = $last->{'help'} if (exists($last->{'help'}));
1232: $component_help=($component_help?$component_help:$help);
1.79 raeburn 1233: # if ($faq ne '') {
1234: # $icons .= &Apache::loncommon::help_open_faq($faq);
1235: # }
1236: # if ($bug ne '') {
1237: # $icons .= &Apache::loncommon::help_open_bug($bug);
1238: # }
1.87 albertel 1239: if ($helplink ne 'nohelp') {
1.126 albertel 1240: $icons .= &Apache::loncommon::help_open_menu(undef,$component,
1241: $component_help,
1242: undef,$faq,$bug);
1.87 albertel 1243: }
1.54 matthew 1244: if ($icons ne '') {
1245: $Str .= $icons.' ';
1.53 matthew 1246: }
1.54 matthew 1247: #
1.126 albertel 1248: $Str .= $links.'</td>';
1.54 matthew 1249: #
1.53 matthew 1250: if (defined($component)) {
1.126 albertel 1251: $Str .= '<td class="LC_breadcrumb_component">'.
1252: &mt($component).'</td>';
1.53 matthew 1253: }
1254: $Str .= '</tr></table>'."\n";
1255: #
1256: # Return the @Crumbs stack to what we started with
1257: push(@Crumbs,$last);
1258: shift(@Crumbs);
1259: #
1260: return $Str;
1261: }
1262:
1263: sub clear_breadcrumbs {
1264: undef(@Crumbs);
1265: }
1266:
1267: sub add_breadcrumb {
1268: push (@Crumbs,@_);
1269: }
1270:
1.57 matthew 1271: } # End of scope for @Crumbs
1.53 matthew 1272:
1273: ############################################################
1274: ############################################################
1275:
1.112 raeburn 1276: # Nested table routines.
1277: #
1278: # Routines to display form items in a multi-row table with 2 columns.
1279: # Uses nested tables to divide form elements into segments.
1280: # For examples of use see loncom/interface/lonnotify.pm
1281: #
1282: # Can be used in following order: ...
1283: # &start_pick_box()
1284: # row1
1285: # row2
1286: # row3 ... etc.
1287: # &submit_row(0
1288: # &end_pickbox()
1289: #
1290: # where row1, row 2 etc. are chosen from &role_select_row,&course_select_row,
1291: # &status_select_row and &email_default_row
1292: #
1293: # Can also be used in following order:
1294: #
1295: # &start_pick_box()
1296: # &row_title()
1297: # &row_closure()
1298: # &row_title()
1299: # &row_closure() ... etc.
1300: # &submit_row()
1301: # &end_pick_box()
1302: #
1303: # In general a &submit_row() call should proceed the call to &end_pick_box(),
1304: # as this routine adds a button for form submission.
1.113 raeburn 1305: # &submit_row() does not require a &row_closure after it.
1.112 raeburn 1306: #
1307: # &start_pick_box() creates a bounding table with 1-pixel wide black border.
1308: # rows should be placed between calls to &start_pick_box() and &end_pick_box.
1309: #
1310: # &row_title() adds a title in the left column for each segment.
1311: # &row_closure() closes a row with a 1-pixel wide black line.
1312: #
1313: # &role_select_row() provides a select box from which to choose 1 or more roles
1314: # &course_select_row provides ways of picking groups of courses
1315: # radio buttons: all, by category or by picking from a course picker pop-up
1316: # note: by category option is only displayed if a domain has implemented
1317: # selection by year, semester, department, number etc.
1318: #
1319: # &status_select_row() provides a select box from which to choose 1 or more
1320: # access types (current access, prior access, and future access)
1321: #
1322: # &email_default_row() provides text boxes for default e-mail suffixes for
1323: # different authentication types in a domain.
1324: #
1325: # &row_title() and &row_closure() are called internally by the &*_select_row
1326: # routines, but can also be called directly to start and end rows which have
1327: # needs that are not accommodated by the *_select_row() routines.
1328:
1329: sub start_pick_box {
1330: my ($table_width) = @_;
1331: my $output = <<"END";
1332: <table width="$table_width" border="0" cellpadding="0" cellspacing="1" bgcolor="#000000">
1333: <tr>
1334: <td>
1335: <table width="100%" border="0" cellpadding="0" cellspacing="0" bgcolor="#ffffff">
1336: <tr>
1337: <td>
1338: <table width="100%" border="0" cellpadding="0" cellspacing="1" bgcolor="#ffffff">
1339: END
1340: return $output;
1341: }
1342:
1343: sub end_pick_box {
1344: my $output = <<"END";
1345: </table>
1346: </td>
1347: </tr>
1348: </table>
1349: </td>
1350: </tr>
1351: </table>
1352: END
1353: return $output;
1354: }
1355:
1356: sub row_title {
1357: my ($col_width,$tablecolor,$title) = @_;
1358: my $output = <<"ENDONE";
1359: <tr>
1360: <td width="$col_width" bgcolor="$tablecolor">
1361: <table width="$col_width" border="0" cellpadding="8" cellspacing="0">
1362: <tr>
1363: <td align="right"><b>$title:</b>
1364: </td>
1365: </tr>
1366: </table>
1367: </td>
1368: <td width="100%" valign="top">
1369: <table width="100%" border="0" cellpadding="8" cellspacing="0">
1370: <tr>
1371: ENDONE
1372: return $output;
1373: }
1374:
1375: sub row_closure {
1.113 raeburn 1376: my $output = <<"ENDTWO";
1.112 raeburn 1377: </tr>
1378: </table>
1379: </td>
1380: </tr>
1381: <tr>
1382: <td width="100%" colspan="2" bgcolor="#000000">
1383: <img src="/adm/lonMisc/blackdot.gif" /><br />
1384: </td>
1385: </tr>
1386: ENDTWO
1387: return $output;
1388: }
1389:
1390: sub role_select_row {
1391: my ($roles,$col_width,$tablecolor,$title) = @_;
1.116 raeburn 1392: my $output;
1393: if (defined($title)) {
1394: $output = &row_title($col_width,$tablecolor,$title);
1395: }
1.119 raeburn 1396: $output .= qq| <td valign="top">
1.112 raeburn 1397: <select name="roles" multiple >\n|;
1.113 raeburn 1398: foreach my $role (@$roles) {
1.114 raeburn 1399: my $plrole;
1400: if ($role eq 'ow') {
1401: $plrole = &mt('Course Owner');
1402: } else {
1403: $plrole=&Apache::lonnet::plaintext($role);
1404: }
1.113 raeburn 1405: $output .= ' <option value="'.$role.'">'.$plrole.'</option>';
1.112 raeburn 1406: }
1407: $output .= qq| </select>
1408: </td>\n|;
1.116 raeburn 1409: if (defined($title)) {
1410: $output .= &row_closure();
1411: }
1.112 raeburn 1412: return $output;
1413: }
1414:
1415: sub course_select_row {
1416: my ($col_width,$tablecolor,$title,$formname,$totcodes,$codetitles,$idlist,$idlist_titles) = @_;
1417: my $output = &row_title($col_width,$tablecolor,$title);
1418: $output .= " <td>\n";
1419: $output .= qq|
1420: <script type="text/javascript" language="Javascript" >
1421: function coursePick (formname) {
1422: for (var i=0; i<formname.coursepick.length; i++) {
1.114 raeburn 1423: if (formname.coursepick[i].value == 'category') {
1424: courseSet('');
1425: }
1.112 raeburn 1426: if (!formname.coursepick[i].checked) {
1427: if (formname.coursepick[i].value == 'specific') {
1428: formname.coursetotal.value = 0;
1429: formname.courselist = '';
1430: }
1431: }
1432: }
1433: }
1.114 raeburn 1434: function setPick (formname) {
1435: for (var i=0; i<formname.coursepick.length; i++) {
1436: if (formname.coursepick[i].value == 'category') {
1437: formname.coursepick[i].checked = true;
1438: }
1439: formname.coursetotal.value = 0;
1440: formname.courselist = '';
1441: }
1442: }
1.112 raeburn 1443: </script>
1444: |;
1445: my $courseform='<b>'.&Apache::loncommon::selectcourse_link
1.118 raeburn 1446: ($formname,'pickcourse','pickdomain','coursedesc','',1).'</b>';
1.129 raeburn 1447: $output .= '<input type="radio" name="coursepick" value="all" onclick="coursePick(this.form)" />'.&mt('All courses').'<br />';
1.112 raeburn 1448: if ($totcodes > 0) {
1449: my $numtitles = @$codetitles;
1450: if ($numtitles > 0) {
1.129 raeburn 1451: $output .= '<input type="radio" name="coursepick" value="category" onclick="coursePick(this.form);alert('."'".&mt('Choose categories, from left to right')."'".')" />'.&mt('Pick courses by category:').' <br />';
1.112 raeburn 1452: $output .= '<table><tr><td>'.$$codetitles[0].'<br />'."\n".
1453: '<select name="'.$$codetitles[0].
1.114 raeburn 1454: '" onChange="setPick(this.form);courseSet('."'$$codetitles[0]'".')">'."\n".
1.112 raeburn 1455: ' <option value="-1" />Select'."\n";
1456: my @items = ();
1457: my @longitems = ();
1458: if ($$idlist{$$codetitles[0]} =~ /","/) {
1.113 raeburn 1459: @items = split(/","/,$$idlist{$$codetitles[0]});
1.112 raeburn 1460: } else {
1461: $items[0] = $$idlist{$$codetitles[0]};
1462: }
1463: if (defined($$idlist_titles{$$codetitles[0]})) {
1464: if ($$idlist_titles{$$codetitles[0]} =~ /","/) {
1.113 raeburn 1465: @longitems = split(/","/,$$idlist_titles{$$codetitles[0]});
1.112 raeburn 1466: } else {
1467: $longitems[0] = $$idlist_titles{$$codetitles[0]};
1468: }
1469: for (my $i=0; $i<@longitems; $i++) {
1470: if ($longitems[$i] eq '') {
1471: $longitems[$i] = $items[$i];
1472: }
1473: }
1474: } else {
1475: @longitems = @items;
1476: }
1477: for (my $i=0; $i<@items; $i++) {
1478: $output .= ' <option value="'.$items[$i].'">'.$longitems[$i].'</option>';
1479: }
1480: $output .= '</select></td>';
1481: for (my $i=1; $i<$numtitles; $i++) {
1482: $output .= '<td>'.$$codetitles[$i].'<br />'."\n".
1483: '<select name="'.$$codetitles[$i].
1484: '" onChange="courseSet('."'$$codetitles[$i]'".')">'."\n".
1485: '<option value="-1"><-Pick '.$$codetitles[$i-1].'</option>'."\n".
1486: '</select>'."\n".
1487: '</td>';
1488: }
1489: $output .= '</tr></table><br />';
1490: }
1491: }
1.118 raeburn 1492: $output .= '<input type="radio" name="coursepick" value="specific" onclick="coursePick(this.form);opencrsbrowser('."'".$formname."'".','."'".'dccourse'."'".','."'".'dcdomain'."'".','."'".'coursedesc'."','','1'".')" />'.&mt('Pick specific course(s):').' '.$courseform.' <input type="text" value="0" size="4" name="coursetotal" /><input type="hidden" name="courselist" value="" />selected.<br /></td>'."\n";
1.112 raeburn 1493: $output .= &row_closure();
1494: return $output;
1495: }
1496:
1497: sub status_select_row {
1498: my ($types,$col_width,$tablecolor,$title) = @_;
1.117 raeburn 1499: my $output;
1500: if (defined($title)) {
1501: $output = &row_title($col_width,$tablecolor,$title);
1502: }
1.119 raeburn 1503: $output .= qq| <td valign="top">
1.112 raeburn 1504: <select name="types" multiple>\n|;
1.113 raeburn 1505: foreach my $status_type (sort(keys(%{$types}))) {
1.112 raeburn 1506: $output .= ' <option value="'.$status_type.'">'.$$types{$status_type}.'</option>';
1507: }
1508: $output .= qq| </select>
1509: </td>\n|;
1.117 raeburn 1510: if (defined($title)) {
1511: $output .= &row_closure();
1512: }
1.112 raeburn 1513: return $output;
1514: }
1515:
1516: sub email_default_row {
1517: my ($authtypes,$col_width,$tablecolor,$title,$descrip) = @_;
1518: my $output = &row_title($col_width,$tablecolor,$title);
1519: my @rowcols = ('#eeeeee','#dddddd');
1.113 raeburn 1520: $output .= ' <td>'.$descrip;
1.115 albertel 1521: $output .= &start_pick_box('');
1.113 raeburn 1522: $output .= ' <tr bgcolor="'.$tablecolor.'">
1523: <td><b>'.&mt('Authentication Method').'</b></td><td align="right"><b>'.&mt('Username -> e-mail conversion').'</b></td>
1.112 raeburn 1524: </tr>'."\n";
1525: my $rownum = 0;
1.113 raeburn 1526: foreach my $auth (sort(keys(%{$authtypes}))) {
1.112 raeburn 1527: my ($userentry,$size);
1528: my $rowiter = $rownum%2;
1529: if ($auth =~ /^krb/) {
1530: $userentry = '';
1531: $size = 25;
1532: } else {
1533: $userentry = 'username@';
1534: $size = 15;
1535: }
1.113 raeburn 1536: $output .= '<tr bgcolor="'.$rowcols[$rowiter].'"><td> '.$$authtypes{$auth}.'</td><td align="right">'.$userentry.'<input type="text" name="'.$auth.'" size="'.$size.'" /></td></tr>';
1.112 raeburn 1537: $rownum ++;
1538: }
1.113 raeburn 1539: $output .= &end_pick_box();
1540: $output .= " <br /></td>\n";
1.112 raeburn 1541: $output .= &row_closure();
1542: return $output;
1543: }
1544:
1545:
1546: sub submit_row {
1547: my ($col_width,$tablecolor,$title,$cmd,$submit_text) = @_;
1.113 raeburn 1548: my $output = &row_title($col_width,$tablecolor,$title);
1.112 raeburn 1549: $output .= qq|
1550: <td width="100%" valign="top" align="right">
1551: <br />
1552: <input type="hidden" name="command" value="$cmd" />
1553: <input type="submit" value="$submit_text"/>
1554: <br /><br />
1555: </td>\n|;
1556: return $output;
1557: }
1.1 stredwic 1558:
1.119 raeburn 1559: ##############################################
1560: ##############################################
1561:
1562: # echo_form_input
1563: #
1564: # Generates html markup to add form elements from the referrer page
1565: # as hidden form elements (values encoded) in the new page.
1566: #
1567: # Intended to support two types of use
1568: # (a) to allow backing up to earlier pages in a multi-page
1569: # form submission process using a breadcrumb trail.
1570: #
1571: # (b) to allow the current page to be reloaded with form elements
1572: # set on previous page to remain unchanged. An example would
1573: # be where the a page containing a dynamically-built table of data is
1574: # is to be redisplayed, with only the sort order of the data changed.
1575: #
1576: # Inputs:
1577: # 1. Reference to array of form elements in the submitted form on
1578: # the referrer page which are to be excluded from the echoed elements.
1579: #
1580: # 2. Reference to array of regular expressions, which if matched in the
1581: # name of the form element n the referrer page will be omitted from echo.
1582: #
1583: # Outputs: A scalar containing the html markup for the echoed form
1584: # elements (all as hidden elements, with values encoded).
1585:
1586:
1587: sub echo_form_input {
1588: my ($excluded,$regexps) = @_;
1589: my $output = '';
1590: foreach my $key (keys(%env)) {
1591: if ($key =~ /^form\.(.+)$/) {
1592: my $name = $1;
1593: my $match = 0;
1594: if ((!@{$excluded}) || (!grep/^$name$/,@{$excluded})) {
1595: if (defined($regexps)) {
1596: if (@{$regexps} > 0) {
1597: foreach my $regexp (@{$regexps}) {
1598: if ($name =~ /\Q$regexp\E/) {
1599: $match = 1;
1600: last;
1601: }
1602: }
1603: }
1604: }
1605: if (!$match) {
1606: if (ref($env{$key})) {
1607: foreach my $value (@{$env{$key}}) {
1608: $value = &HTML::Entities::encode($value,'<>&"');
1609: $output .= '<input type="hidden" name="'.$name.
1610: '" value="'.$value.'" />'."\n";
1611: }
1612: } else {
1613: my $value = &HTML::Entities::encode($env{$key},'<>&"');
1614: $output .= '<input type="hidden" name="'.$name.
1615: '" value="'.$value.'" />'."\n";
1616: }
1617: }
1618: }
1619: }
1620: }
1621: return $output;
1622: }
1623:
1624: ##############################################
1625: ##############################################
1626:
1627: # set_form_elements
1628: #
1629: # Generates javascript to set form elements to values based on
1630: # corresponding values for the same form elements when the page was
1631: # previously submitted.
1632: #
1633: # Last submission values are read from hidden form elements in referring
1634: # page which have the same name, i.e., generated by &echo_form_input().
1635: #
1636: # Intended to be called by onload event.
1637: #
1.121 raeburn 1638: # Inputs:
1639: # (a) Reference to hash of echoed form elements to be set.
1.119 raeburn 1640: #
1641: # In the hash, keys are the form element names, and the values are the
1642: # element type (selectbox, radio, checkbox or text -for textbox, textarea or
1643: # hidden).
1.121 raeburn 1644: #
1645: # (b) Optional reference to hash of stored elements to be set.
1646: #
1647: # If the page being displayed is a page which permits modification of
1648: # previously stored data, e.g., the first page in a multi-page submission,
1649: # then if stored is supplied, form elements will be set to the last stored
1650: # values. If user supplied values are also available for the same elements
1651: # these will replace the stored values.
1652: #
1.119 raeburn 1653: # Output:
1654: #
1655: # javascript function - set_form_elements() which sets form elements,
1656: # expects an argument: formname - the name of the form according to
1657: # the DOM, e.g., document.compose
1658:
1659: sub set_form_elements {
1.121 raeburn 1660: my ($elements,$stored) = @_;
1661: my %values;
1.119 raeburn 1662: my $output .= 'function setFormElements(courseForm) {
1.121 raeburn 1663: ';
1664: if (defined($stored)) {
1665: foreach my $name (keys(%{$stored})) {
1666: if (exists($$elements{$name})) {
1667: if (ref($$stored{$name}) eq 'ARRAY') {
1668: $values{$name} = $$stored{$name};
1669: } else {
1670: @{$values{$name}} = ($$stored{$name});
1671: }
1672: }
1673: }
1674: }
1675:
1.119 raeburn 1676: foreach my $key (keys(%env)) {
1677: if ($key =~ /^form\.(.+)$/) {
1678: my $name = $1;
1679: if (exists($$elements{$name})) {
1.121 raeburn 1680: @{$values{$name}} = &Apache::loncommon::get_env_multiple($key);
1681: }
1682: }
1683: }
1684:
1685: foreach my $name (keys(%values)) {
1686: for (my $i=0; $i<@{$values{$name}}; $i++) {
1687: $values{$name}[$i] = &HTML::Entities::decode($values{$name}[$i],'<>&"');
1688: $values{$name}[$i] =~ s/([\r\n\f]+)/\\n/g;
1689: $values{$name}[$i] =~ s/"/\\"/g;
1690: }
1691: if ($$elements{$name} eq 'text') {
1692: my $numvalues = @{$values{$name}};
1693: if ($numvalues > 1) {
1694: my $valuestring = join('","',@{$values{$name}});
1695: $output .= qq|
1.119 raeburn 1696: var textvalues = new Array ("$valuestring");
1697: var total = courseForm.$name.length;
1698: if (total > $numvalues) {
1699: total = $numvalues;
1700: }
1701: for (var i=0; i<total; i++) {
1702: courseForm.$name\[i].value = textvalues[i];
1703: }
1704: |;
1.121 raeburn 1705: } else {
1706: $output .= qq|
1707: courseForm.$name.value = "$values{$name}[0]";
1.119 raeburn 1708: |;
1.121 raeburn 1709: }
1710: } else {
1711: $output .= qq|
1.119 raeburn 1712: var elementLength = courseForm.$name.length;
1713: if (elementLength==undefined) {
1714: |;
1.121 raeburn 1715: foreach my $value (@{$values{$name}}) {
1716: if ($$elements{$name} eq 'selectbox') {
1717: $output .= qq|
1.119 raeburn 1718: if (courseForm.$name.options[0].value == "$value") {
1719: courseForm.$name.options[0].selected = true;
1720: }|;
1.121 raeburn 1721: } elsif (($$elements{$name} eq 'radio') ||
1722: ($$elements{$name} eq 'checkbox')) {
1723: $output .= qq|
1.119 raeburn 1724: if (courseForm.$name.value == "$value") {
1725: courseForm.$name.checked = true;
1726: }|;
1.121 raeburn 1727: }
1728: }
1729: $output .= qq|
1.119 raeburn 1730: }
1731: else {
1732: for (var i=0; i<courseForm.$name.length; i++) {
1733: |;
1.121 raeburn 1734: if ($$elements{$name} eq 'selectbox') {
1735: $output .= qq|
1.119 raeburn 1736: courseForm.$name.options[i].selected = false;|;
1.121 raeburn 1737: } elsif (($$elements{$name} eq 'radio') ||
1738: ($$elements{$name} eq 'checkbox')) {
1739: $output .= qq|
1.119 raeburn 1740: courseForm.$name\[i].checked = false;|;
1.121 raeburn 1741: }
1742: $output .= qq|
1.119 raeburn 1743: }
1744: for (var j=0; j<courseForm.$name.length; j++) {
1745: |;
1.121 raeburn 1746: foreach my $value (@{$values{$name}}) {
1747: if ($$elements{$name} eq 'selectbox') {
1748: $output .= qq|
1.119 raeburn 1749: if (courseForm.$name.options[j].value == "$value") {
1750: courseForm.$name.options[j].selected = true;
1751: }|;
1.121 raeburn 1752: } elsif (($$elements{$name} eq 'radio') ||
1753: ($$elements{$name} eq 'checkbox')) {
1754: $output .= qq|
1.119 raeburn 1755: if (courseForm.$name\[j].value == "$value") {
1756: courseForm.$name\[j].checked = true;
1757: }|;
1.121 raeburn 1758: }
1759: }
1760: $output .= qq|
1.119 raeburn 1761: }
1762: }
1763: |;
1764: }
1765: }
1766: $output .= "
1767: }\n";
1768: return $output;
1769: }
1770:
1.1 stredwic 1771: 1;
1.23 matthew 1772:
1.1 stredwic 1773: __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