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