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