1: # The LearningOnline Network with CAPA
2: # a pile of common html routines
3: #
4: # $Id: lonhtmlcommon.pm,v 1.277 2010/06/10 09:09:59 bisitz 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: sub coursepreflink {
67: my ($text,$category)=@_;
68: if (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
69: return '<a href="'.&HTML::Entities::encode("/adm/courseprefs?phase=display&actions=$category",'<>&"').'">'.$text.'</a>';
70: } else {
71: return '';
72: }
73: }
74:
75: sub raw_href_to_link {
76: my ($message)=@_;
77: $message=~s/(https?\:\/\/[^\s\'\"\<]+)([\s\<]|$)/<a href="$1"><tt>$1<\/tt><\/a>$2/gi;
78: return $message;
79: }
80:
81: ##############################################
82: ##############################################
83:
84: =item confirm_success
85:
86: Successful completion of an operation message
87:
88: =cut
89:
90: sub confirm_success {
91: my ($message,$failure)=@_;
92: if ($failure) {
93: return '<span class="LC_error" style="font-size: inherit;">'."\n"
94: .'<img src="/adm/lonIcons/navmap.wrong.gif" alt="'.&mt('Error').'" /> '."\n"
95: .$message."\n"
96: .'</span>'."\n";
97: } else {
98: return '<span class="LC_success">'."\n"
99: .'<img src="/adm/lonIcons/navmap.correct.gif" alt="'.&mt('OK').'" /> '."\n"
100: .$message."\n"
101: .'</span>'."\n";
102: }
103: }
104:
105: ##############################################
106: ##############################################
107:
108: =pod
109:
110: =item dragmath_button
111:
112: Creates a button that launches a dragmath popup-window, in which an
113: expression can be edited and pasted as LaTeX into a specified textarea.
114:
115: textarea - Name of the textarea to edit.
116: helpicon - If true, show a help icon to the right of the button.
117:
118: =cut
119:
120: sub dragmath_button {
121: my ($textarea,$helpicon) = @_;
122: my $help_text;
123: if ($helpicon) {
124: $help_text = &Apache::loncommon::help_open_topic('Authoring_Math_Editor');
125: }
126: my $buttontext=&mt('Edit Math');
127: return <<ENDDRAGMATH;
128: <input type="button" value="$buttontext" onclick="javascript:mathedit('$textarea',document)" />$help_text
129: ENDDRAGMATH
130: }
131:
132: ##############################################
133:
134: =pod
135:
136: =item dragmath_js
137:
138: Javascript used to open pop-up window containing dragmath applet which
139: can be used to paste LaTeX into a textarea.
140: =cut
141:
142: sub dragmath_js {
143: my ($popup) = @_;
144: return <<ENDDRAGMATHJS;
145: <script type="text/javascript">
146: // <![CDATA[
147: function mathedit(textarea, doc) {
148: targetEntry = textarea;
149: targetDoc = doc;
150: newwin = window.open("/adm/dragmath/applet/$popup.html","","width=565,height=500,resizable");
151: }
152: // ]]>
153: </script>
154:
155: ENDDRAGMATHJS
156: }
157:
158:
159: ##############################################
160: ##############################################
161:
162: =pod
163:
164: =item authorbombs
165:
166: =cut
167:
168: ##############################################
169: ##############################################
170:
171: sub authorbombs {
172: my $url=shift;
173: $url=&Apache::lonnet::declutter($url);
174: my ($udom,$uname)=($url=~m{^($LONCAPA::domain_re)/($LONCAPA::username_re)/});
175: my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom);
176: foreach my $bomb (keys(%bombs)) {
177: if ($bomb =~ /^$udom\/$uname\//) {
178: return '<a href="/adm/bombs/'.$url.
179: '"><img src="'.&Apache::loncommon::lonhttpdurl('/adm/lonMisc/bomb.gif').'" alt="'.&mt('Bomb').'" border="0" /></a>'.
180: &Apache::loncommon::help_open_topic('About_Bombs');
181: }
182: }
183: return '';
184: }
185:
186: ##############################################
187: ##############################################
188:
189: sub recent_filename {
190: my $area=shift;
191: return 'nohist_recent_'.&escape($area);
192: }
193:
194: sub store_recent {
195: my ($area,$name,$value,$freeze)=@_;
196: my $file=&recent_filename($area);
197: my %recent=&Apache::lonnet::dump($file);
198: if (scalar(keys(%recent))>20) {
199: # remove oldest value
200: my $oldest=time();
201: my $delkey='';
202: foreach my $item (keys(%recent)) {
203: my $thistime=(split(/\&/,$recent{$item}))[0];
204: if (($thistime ne "always_include") && ($thistime<$oldest)) {
205: $oldest=$thistime;
206: $delkey=$item;
207: }
208: }
209: &Apache::lonnet::del($file,[$delkey]);
210: }
211: # store new value
212: my $timestamp;
213: if ($freeze) {
214: $timestamp = "always_include";
215: } else {
216: $timestamp = time();
217: }
218: &Apache::lonnet::put($file,{ $name =>
219: $timestamp.'&'.&escape($value) });
220: }
221:
222: sub remove_recent {
223: my ($area,$names)=@_;
224: my $file=&recent_filename($area);
225: return &Apache::lonnet::del($file,$names);
226: }
227:
228: sub select_recent {
229: my ($area,$fieldname,$event)=@_;
230: my %recent=&Apache::lonnet::dump(&recent_filename($area));
231: my $return="\n<select name='$fieldname'".
232: ($event?" onchange='$event'":'').
233: ">\n<option value=''>--- ".&mt('Recent')." ---</option>";
234: foreach my $value (sort(keys(%recent))) {
235: unless ($value =~/^error\:/) {
236: my $escaped = &Apache::loncommon::escape_url($value);
237: &Apache::loncommon::inhibit_menu_check(\$escaped);
238: if ($area eq 'residx') {
239: next if ((!&Apache::lonnet::allowed('bre',$value)) && (!&Apache::lonnet::allowed('bro',$value)));
240: }
241: $return.="\n<option value='$escaped'>".
242: &unescape((split(/\&/,$recent{$value}))[1]).
243: '</option>';
244: }
245: }
246: $return.="\n</select>\n";
247: return $return;
248: }
249:
250: sub get_recent {
251: my ($area, $n) = @_;
252: my %recent=&Apache::lonnet::dump(&recent_filename($area));
253:
254: # Create hash with key as time and recent as value
255: # Begin filling return_hash with any 'always_include' option
256: my %time_hash = ();
257: my %return_hash = ();
258: foreach my $item (keys(%recent)) {
259: my ($thistime,$thisvalue)=(split(/\&/,$recent{$item}));
260: if ($thistime eq 'always_include') {
261: $return_hash{$item} = &unescape($thisvalue);
262: $n--;
263: } else {
264: $time_hash{$thistime} = $item;
265: }
266: }
267:
268: # Sort by decreasing time and return key value pairs
269: my $idx = 1;
270: foreach my $item (reverse(sort(keys(%time_hash)))) {
271: $return_hash{$time_hash{$item}} =
272: &unescape((split(/\&/,$recent{$time_hash{$item}}))[1]);
273: if ($n && ($idx++ >= $n)) {last;}
274: }
275:
276: return %return_hash;
277: }
278:
279: sub get_recent_frozen {
280: my ($area) = @_;
281: my %recent=&Apache::lonnet::dump(&recent_filename($area));
282:
283: # Create hash with all 'frozen' items
284: my %return_hash = ();
285: foreach my $item (keys(%recent)) {
286: my ($thistime,$thisvalue)=(split(/\&/,$recent{$item}));
287: if ($thistime eq 'always_include') {
288: $return_hash{$item} = &unescape($thisvalue);
289: }
290: }
291: return %return_hash;
292: }
293:
294:
295:
296: =pod
297:
298: =item textbox
299:
300: =cut
301:
302: ##############################################
303: ##############################################
304: sub textbox {
305: my ($name,$value,$size,$special) = @_;
306: $size = 40 if (! defined($size));
307: $value = &HTML::Entities::encode($value,'<>&"');
308: my $Str = '<input type="text" name="'.$name.'" size="'.$size.'" '.
309: 'value="'.$value.'" '.$special.' />';
310: return $Str;
311: }
312:
313: ##############################################
314: ##############################################
315:
316: =pod
317:
318: =item checkbox
319:
320: =cut
321:
322: ##############################################
323: ##############################################
324: sub checkbox {
325: my ($name,$checked,$value) = @_;
326: my $Str = '<input type="checkbox" name="'.$name.'" ';
327: if (defined($value)) {
328: $Str .= 'value="'.$value.'"';
329: }
330: if ($checked) {
331: $Str .= ' checked="checked"';
332: }
333: $Str .= ' />';
334: return $Str;
335: }
336:
337:
338: =pod
339:
340: =item radiobutton
341:
342: =cut
343:
344: ##############################################
345: ##############################################
346: sub radio {
347: my ($name,$checked,$value) = @_;
348: my $Str = '<input type="radio" name="'.$name.'" ';
349: if (defined($value)) {
350: $Str .= 'value="'.$value.'"';
351: }
352: if ($checked eq $value) {
353: $Str .= ' checked="checked"';
354: }
355: $Str .= ' />';
356: return $Str;
357: }
358:
359: ##############################################
360: ##############################################
361:
362: =pod
363:
364: =item &date_setter
365:
366: &date_setter returns html and javascript for a compact date-setting form.
367: To retrieve values from it, use &get_date_from_form().
368:
369: Inputs
370:
371: =over 4
372:
373: =item $dname
374:
375: The name to prepend to the form elements.
376: The form elements defined will be dname_year, dname_month, dname_day,
377: dname_hour, dname_min, and dname_sec.
378:
379: =item $currentvalue
380:
381: The current setting for this time parameter. A unix format time
382: (time in seconds since the beginning of Jan 1st, 1970, GMT.
383: An undefined value is taken to indicate the value is the current time
384: unless it is requested to leave it empty. See $includeempty.
385: Also, to be explicit, a value of 'now' also indicates the current time.
386:
387: =item $special
388:
389: Additional html/javascript to be associated with each element in
390: the date_setter. See lonparmset for example usage.
391:
392: =item $includeempty
393:
394: If it is set (true) and no date/time value is provided,
395: the date/time fields are left empty.
396:
397: =item $state
398:
399: Specifies the initial state of the form elements. Either 'disabled' or empty.
400: Defaults to empty, which indiciates the form elements are not disabled.
401:
402: =back
403:
404: Bugs
405:
406: The method used to restrict user input will fail in the year 2400.
407:
408: =cut
409:
410: ##############################################
411: ##############################################
412: sub date_setter {
413: my ($formname,$dname,$currentvalue,$special,$includeempty,$state,
414: $no_hh_mm_ss,$defhour,$defmin,$defsec,$nolink) = @_;
415: my $now = time;
416:
417: my $tzname;
418: my ($sec,$min,$hour,$mday,$month,$year) = ('', '', undef,''.''.'');
419: #other potentially useful values: wkday,yrday,is_daylight_savings
420:
421: if (! defined($state) || $state ne 'disabled') {
422: $state = '';
423: }
424: if (! defined($no_hh_mm_ss)) {
425: $no_hh_mm_ss = 0;
426: }
427: if ($currentvalue eq 'now') {
428: $currentvalue = $now;
429: }
430:
431: # Default value: Set empty date field to current time
432: # unless empty inclusion is requested
433: if ((!$includeempty) && (!$currentvalue)) {
434: $currentvalue = $now;
435: }
436: # Do we have a date? Split it!
437: if ($currentvalue) {
438: ($tzname,$sec,$min,$hour,$mday,$month,$year) = &get_timedates($currentvalue);
439:
440: #No values provided for hour, min, sec? Use default 0
441: if (($defhour) || ($defmin) || ($defsec)) {
442: $sec = ($defsec ? $defsec : 0);
443: $min = ($defmin ? $defmin : 0);
444: $hour = ($defhour ? $defhour : 0);
445: }
446: }
447: my $result = "\n<!-- $dname date setting form -->\n";
448: $result .= <<ENDJS;
449: <script type="text/javascript">
450: // <![CDATA[
451: function $dname\_checkday() {
452: var day = document.$formname.$dname\_day.value;
453: var month = document.$formname.$dname\_month.value;
454: var year = document.$formname.$dname\_year.value;
455: var valid = true;
456: if (day < 1) {
457: document.$formname.$dname\_day.value = 1;
458: }
459: if (day > 31) {
460: document.$formname.$dname\_day.value = 31;
461: }
462: if ((month == 1) || (month == 3) || (month == 5) ||
463: (month == 7) || (month == 8) || (month == 10) ||
464: (month == 12)) {
465: if (day > 31) {
466: document.$formname.$dname\_day.value = 31;
467: day = 31;
468: }
469: } else if (month == 2 ) {
470: if ((year % 4 == 0) && (year % 100 != 0)) {
471: if (day > 29) {
472: document.$formname.$dname\_day.value = 29;
473: }
474: } else if (day > 29) {
475: document.$formname.$dname\_day.value = 28;
476: }
477: } else if (day > 30) {
478: document.$formname.$dname\_day.value = 30;
479: }
480: }
481:
482: function $dname\_disable() {
483: document.$formname.$dname\_month.disabled=true;
484: document.$formname.$dname\_day.disabled=true;
485: document.$formname.$dname\_year.disabled=true;
486: document.$formname.$dname\_hour.disabled=true;
487: document.$formname.$dname\_minute.disabled=true;
488: document.$formname.$dname\_second.disabled=true;
489: }
490:
491: function $dname\_enable() {
492: document.$formname.$dname\_month.disabled=false;
493: document.$formname.$dname\_day.disabled=false;
494: document.$formname.$dname\_year.disabled=false;
495: document.$formname.$dname\_hour.disabled=false;
496: document.$formname.$dname\_minute.disabled=false;
497: document.$formname.$dname\_second.disabled=false;
498: }
499:
500: function $dname\_opencalendar() {
501: if (! document.$formname.$dname\_month.disabled) {
502: var calwin=window.open(
503: "/adm/announcements?pickdate=yes&formname=$formname&element=$dname&month="+
504: document.$formname.$dname\_month.value+"&year="+
505: document.$formname.$dname\_year.value,
506: "LONCAPAcal",
507: "height=350,width=350,scrollbars=yes,resizable=yes,menubar=no");
508: }
509:
510: }
511: // ]]>
512: </script>
513: ENDJS
514: $result .= ' <span class="LC_nobreak">';
515: my $monthselector = qq{<select name="$dname\_month" $special $state onchange="javascript:$dname\_checkday()" >};
516: # Month
517: my @Months = qw/January February March April May June
518: July August September October November December/;
519: # Pad @Months with a bogus value to make indexing easier
520: unshift(@Months,'If you can read this an error occurred');
521: if ($includeempty) { $monthselector.="<option value=''></option>"; }
522: for(my $m = 1;$m <=$#Months;$m++) {
523: $monthselector .= qq{ <option value="$m"};
524: $monthselector .= ' selected="selected"' if ($m-1 eq $month);
525: $monthselector .= '> '.&mt($Months[$m]).' </option>'."\n";
526: }
527: $monthselector.= ' </select>';
528: # Day
529: my $dayselector = qq{<input type="text" name="$dname\_day" $state value="$mday" size="3" $special onchange="javascript:$dname\_checkday()" />};
530: # Year
531: my $yearselector = qq{<input type="text" name="$dname\_year" $state value="$year" size="5" $special onchange="javascript:$dname\_checkday()" />};
532: #
533: my $hourselector = qq{<select name="$dname\_hour" $special $state >};
534: if ($includeempty) {
535: $hourselector.=qq{<option value=''></option>};
536: }
537: for (my $h = 0;$h<24;$h++) {
538: $hourselector .= qq{<option value="$h"};
539: $hourselector .= ' selected="selected"' if (defined($hour) && $hour == $h);
540: $hourselector .= ">";
541: my $timest='';
542: if ($h == 0) {
543: $timest .= "12 am";
544: } elsif($h == 12) {
545: $timest .= "12 noon";
546: } elsif($h < 12) {
547: $timest .= "$h am";
548: } else {
549: $timest .= $h-12 ." pm";
550: }
551: $timest=&mt($timest);
552: $hourselector .= $timest." </option>\n";
553: }
554: $hourselector .= " </select>\n";
555: my $minuteselector = qq{<input type="text" name="$dname\_minute" $special $state value="$min" size="3" />};
556: my $secondselector= qq{<input type="text" name="$dname\_second" $special $state value="$sec" size="3" />};
557: my $cal_link;
558: if (!$nolink) {
559: $cal_link = qq{<a href="javascript:$dname\_opencalendar()">};
560: }
561: #
562: my $tzone = ' '.$tzname.' ';
563: if ($no_hh_mm_ss) {
564: $result .= &mt('[_1] [_2] [_3] ',
565: $monthselector,$dayselector,$yearselector).
566: $tzone;
567: if (!$nolink) {
568: $result .= &mt('[_1]Select Date[_2]',$cal_link,'</a>');
569: }
570: } else {
571: $result .= &mt('[_1] [_2] [_3] [_4] [_5]m [_6]s ',
572: $monthselector,$dayselector,$yearselector,
573: $hourselector,$minuteselector,$secondselector).
574: $tzone;
575: if (!$nolink) {
576: $result .= &mt('[_1]Select Date[_2]',$cal_link,'</a>');
577: }
578: }
579: $result .= "</span>\n<!-- end $dname date setting form -->\n";
580: return $result;
581: }
582:
583: sub get_timedates {
584: my ($epoch) = @_;
585: my $dt = DateTime->from_epoch(epoch => $epoch)
586: ->set_time_zone(&Apache::lonlocal::gettimezone());
587: my $tzname = $dt->time_zone_short_name();
588: my $sec = $dt->second;
589: my $min = $dt->minute;
590: my $hour = $dt->hour;
591: my $mday = $dt->day;
592: my $month = $dt->month;
593: if ($month) {
594: $month --;
595: }
596: my $year = $dt->year;
597: return ($tzname,$sec,$min,$hour,$mday,$month,$year);
598: }
599:
600: sub build_url {
601: my ($base, $fields)=@_;
602: my $url;
603: $url = $base.'?';
604: foreach my $key (keys(%$fields)) {
605: $url.=&escape($key).'='.&escape($$fields{$key}).'&';
606: }
607: $url =~ s/&$//;
608: return $url;
609: }
610:
611:
612: ##############################################
613: ##############################################
614:
615: =pod
616:
617: =item &get_date_from_form
618:
619: get_date_from_form retrieves the date specified in an &date_setter form.
620:
621: Inputs:
622:
623: =over 4
624:
625: =item $dname
626:
627: The name passed to &date_setter, which prefixes the form elements.
628:
629: =item $defaulttime
630:
631: The unix time to use as the default in case of poor inputs.
632:
633: =back
634:
635: Returns: Unix time represented in the form.
636:
637: =cut
638:
639: ##############################################
640: ##############################################
641: sub get_date_from_form {
642: my ($dname) = @_;
643: my ($sec,$min,$hour,$day,$month,$year);
644: #
645: if (defined($env{'form.'.$dname.'_second'})) {
646: my $tmpsec = $env{'form.'.$dname.'_second'};
647: if (($tmpsec =~ /^\d+$/) && ($tmpsec >= 0) && ($tmpsec < 60)) {
648: $sec = $tmpsec;
649: }
650: if (!defined($tmpsec) || $tmpsec eq '') { $sec = 0; }
651: } else {
652: $sec = 0;
653: }
654: if (defined($env{'form.'.$dname.'_minute'})) {
655: my $tmpmin = $env{'form.'.$dname.'_minute'};
656: if (($tmpmin =~ /^\d+$/) && ($tmpmin >= 0) && ($tmpmin < 60)) {
657: $min = $tmpmin;
658: }
659: if (!defined($tmpmin) || $tmpmin eq '') { $min = 0; }
660: } else {
661: $min = 0;
662: }
663: if (defined($env{'form.'.$dname.'_hour'})) {
664: my $tmphour = $env{'form.'.$dname.'_hour'};
665: if (($tmphour =~ /^\d+$/) && ($tmphour >= 0) && ($tmphour < 24)) {
666: $hour = $tmphour;
667: }
668: } else {
669: $hour = 0;
670: }
671: if (defined($env{'form.'.$dname.'_day'})) {
672: my $tmpday = $env{'form.'.$dname.'_day'};
673: if (($tmpday =~ /^\d+$/) && ($tmpday > 0) && ($tmpday < 32)) {
674: $day = $tmpday;
675: }
676: }
677: if (defined($env{'form.'.$dname.'_month'})) {
678: my $tmpmonth = $env{'form.'.$dname.'_month'};
679: if (($tmpmonth =~ /^\d+$/) && ($tmpmonth > 0) && ($tmpmonth < 13)) {
680: $month = $tmpmonth;
681: }
682: }
683: if (defined($env{'form.'.$dname.'_year'})) {
684: my $tmpyear = $env{'form.'.$dname.'_year'};
685: if (($tmpyear =~ /^\d+$/) && ($tmpyear >= 1970)) {
686: $year = $tmpyear;
687: }
688: }
689: if (($year<1970) || ($year>2037)) { return undef; }
690: if (defined($sec) && defined($min) && defined($hour) &&
691: defined($day) && defined($month) && defined($year)) {
692: my $timezone = &Apache::lonlocal::gettimezone();
693: my $dt = DateTime->new( year => $year,
694: month => $month,
695: day => $day,
696: hour => $hour,
697: minute => $min,
698: second => $sec,
699: time_zone => $timezone,
700: );
701: my $epoch_time = $dt->epoch;
702: if ($epoch_time ne '') {
703: return $epoch_time;
704: } else {
705: return undef;
706: }
707: } else {
708: return undef;
709: }
710: }
711:
712: ##############################################
713: ##############################################
714:
715: =pod
716:
717: =item &pjump_javascript_definition()
718:
719: Returns javascript defining the 'pjump' function, which opens up a
720: parameter setting wizard.
721:
722: =cut
723:
724: ##############################################
725: ##############################################
726: sub pjump_javascript_definition {
727: my $Str = <<END;
728: function pjump(type,dis,value,marker,ret,call,hour,min,sec) {
729: parmwin=window.open("/adm/rat/parameter.html?type="+escape(type)
730: +"&value="+escape(value)+"&marker="+escape(marker)
731: +"&return="+escape(ret)
732: +"&call="+escape(call)+"&name="+escape(dis)
733: +"&defhour="+escape(hour)+"&defmin="+escape(min)
734: +"&defsec="+escape(sec),"LONCAPAparms",
735: "height=350,width=350,scrollbars=no,menubar=no");
736: }
737: END
738: return $Str;
739: }
740:
741: ##############################################
742: ##############################################
743:
744: =pod
745:
746: =item &javascript_nothing()
747:
748: Return an appropriate null for the users browser. This is used
749: as the first arguement for window.open calls when you want a blank
750: window that you can then write to.
751:
752: =cut
753:
754: ##############################################
755: ##############################################
756: sub javascript_nothing {
757: # mozilla and other browsers work with "''", but IE on mac does not.
758: my $nothing = "''";
759: my $user_browser;
760: my $user_os;
761: $user_browser = $env{'browser.type'} if (exists($env{'browser.type'}));
762: $user_os = $env{'browser.os'} if (exists($env{'browser.os'}));
763: if (! defined($user_browser) || ! defined($user_os)) {
764: (undef,$user_browser,undef,undef,undef,$user_os) =
765: &Apache::loncommon::decode_user_agent();
766: }
767: if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
768: $nothing = "'javascript:void(0);'";
769: }
770: return $nothing;
771: }
772:
773: ##############################################
774: ##############################################
775: sub javascript_docopen {
776: my ($mimetype) = @_;
777: $mimetype ||= 'text/html';
778: # safari does not understand document.open() and loads "text/html"
779: my $nothing = "''";
780: my $user_browser;
781: my $user_os;
782: $user_browser = $env{'browser.type'} if (exists($env{'browser.type'}));
783: $user_os = $env{'browser.os'} if (exists($env{'browser.os'}));
784: if (! defined($user_browser) || ! defined($user_os)) {
785: (undef,$user_browser,undef,undef,undef,$user_os) =
786: &Apache::loncommon::decode_user_agent();
787: }
788: if ($user_browser eq 'safari' && $user_os =~ 'mac') {
789: $nothing = "document.clear()";
790: } else {
791: $nothing = "document.open('$mimetype','replace')";
792: }
793: return $nothing;
794: }
795:
796:
797: ##############################################
798: ##############################################
799:
800: =pod
801:
802: =item &StatusOptions()
803:
804: Returns html for a selection box which allows the user to choose the
805: enrollment status of students. The selection box name is 'Status'.
806:
807: Inputs:
808:
809: $status: the currently selected status. If undefined the value of
810: $env{'form.Status'} is taken. If that is undefined, a value of 'Active'
811: is used.
812:
813: $formname: The name of the form. If defined the onchange attribute of
814: the selection box is set to document.$formname.submit().
815:
816: $size: the size (number of lines) of the selection box.
817:
818: $onchange: javascript to use when the value is changed. Enclosed in
819: double quotes, ""s, not single quotes.
820:
821: Returns: a perl string as described.
822:
823: =cut
824:
825: ##############################################
826: ##############################################
827: sub StatusOptions {
828: my ($status, $formName,$size,$onchange,$mult)=@_;
829: $size = 1 if (!defined($size));
830: if (! defined($status)) {
831: $status = 'Active';
832: $status = $env{'form.Status'} if (exists($env{'form.Status'}));
833: }
834:
835: my $Str = '';
836: $Str .= '<select name="Status"';
837: if (defined($mult)){
838: $Str .= ' multiple="multiple" ';
839: }
840: if(defined($formName) && $formName ne '' && ! defined($onchange)) {
841: $Str .= ' onchange="document.'.$formName.'.submit()"';
842: }
843: if (defined($onchange)) {
844: $Str .= ' onchange="'.$onchange.'"';
845: }
846: $Str .= ' size="'.$size.'" ';
847: $Str .= '>'."\n";
848: foreach my $type (['Active', &mt('Currently Has Access')],
849: ['Future', &mt('Will Have Future Access')],
850: ['Expired', &mt('Previously Had Access')],
851: ['Any', &mt('Any Access Status')]) {
852: my ($name,$label) = @$type;
853: $Str .= '<option value="'.$name.'" ';
854: if ($status eq $name) {
855: $Str .= 'selected="selected" ';
856: }
857: $Str .= '>'.$label.'</option>'."\n";
858: }
859:
860: $Str .= '</select>'."\n";
861: }
862:
863: ########################################################
864: ########################################################
865:
866: =pod
867:
868: =item Progess Window Handling Routines
869:
870: These routines handle the creation, update, increment, and closure of
871: progress windows. The progress window reports to the user the number
872: of items completed and an estimate of the time required to complete the rest.
873:
874: =over 4
875:
876:
877: =item &Create_PrgWin
878:
879: Writes javascript to the client to open a progress window and returns a
880: data structure used for bookkeeping.
881:
882: Inputs
883:
884: =over 4
885:
886: =item $r Apache request
887:
888: =item $title The title of the progress window
889:
890: =item $heading A description (usually 1 line) of the process being initiated.
891:
892: =item $number_to_do The total number of items being processed.
893:
894: =item $type Either 'popup' or 'inline' (popup is assumed if nothing is
895: specified)
896:
897: =item $width Specify the width in charaters of the input field.
898:
899: =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
900:
901: =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
902:
903: =back
904:
905: Returns a hash containing the progress state data structure.
906:
907:
908: =item &Update_PrgWin
909:
910: Updates the text in the progress indicator. Does not increment the count.
911: See &Increment_PrgWin.
912:
913: Inputs:
914:
915: =over 4
916:
917: =item $r Apache request
918:
919: =item $prog_state Pointer to the data structure returned by &Create_PrgWin
920:
921: =item $displaystring The string to write to the status indicator
922:
923: =back
924:
925: Returns: none
926:
927:
928: =item Increment_PrgWin
929:
930: Increment the count of items completed for the progress window by $step or 1 if no step is provided.
931:
932: Inputs:
933:
934: =over 4
935:
936: =item $r Apache request
937:
938: =item $prog_state Pointer to the data structure returned by Create_PrgWin
939:
940: =item $extraInfo A description of the items being iterated over. Typically
941: 'student'.
942:
943: =item $step (optional) counter step. Will be set to default 1 if ommited.
944:
945: =back
946:
947: Returns: none
948:
949:
950: =item Close_PrgWin
951:
952: Closes the progress window.
953:
954: Inputs:
955:
956: =over 4
957:
958: =item $r Apache request
959:
960: =item $prog_state Pointer to the data structure returned by Create_PrgWin
961:
962: =back
963:
964: Returns: none
965:
966: =back
967:
968: =cut
969:
970: ########################################################
971: ########################################################
972:
973: my $uniq=0;
974: sub get_uniq_name {
975: $uniq++;
976: return 'uniquename'.$uniq;
977: }
978:
979: # Create progress
980: sub Create_PrgWin {
981: my ($r, $title, $heading, $number_to_do,$type,$width,$formname,
982: $inputname)=@_;
983: if (!defined($type)) { $type='popup'; }
984: if (!defined($width)) { $width=55; }
985: my %prog_state;
986: $prog_state{'type'}=$type;
987: if ($type eq 'popup') {
988: $prog_state{'window'}='popwin';
989: my $start_page =
990: &Apache::loncommon::start_page($title,undef,
991: {'only_body' => 1,
992: 'bgcolor' => '#88DDFF',
993: 'js_ready' => 1});
994: my $end_page = &Apache::loncommon::end_page({'js_ready' => 1});
995:
996: #the whole function called through timeout is due to issues
997: #in mozilla Read BUG #2665 if you want to know the whole story
998: &r_print($r,&Apache::lonhtmlcommon::scripttag(
999: "var popwin;
1000: function openpopwin () {
1001: popwin=open(\'\',\'popwin\',\'width=400,height=100\');".
1002: "popwin.document.writeln(\'".$start_page.
1003: "<h4>".&mt("$heading")."<\/h4>".
1004: "<form action=\"\" name=\"popremain\" method=\"post\">".
1005: '<input type="text" size="'.$width.'" name="remaining" value="'.
1006: &mt('Starting').'" /><\\/form>'.$end_page.
1007: "\');".
1008: "popwin.document.close();}".
1009: "\nwindow.setTimeout(openpopwin,0)"
1010: ));
1011: $prog_state{'formname'}='popremain';
1012: $prog_state{'inputname'}="remaining";
1013: } elsif ($type eq 'inline') {
1014: $prog_state{'window'}='window';
1015: if (!$formname) {
1016: $prog_state{'formname'}=&get_uniq_name();
1017: &r_print($r,'<form action="" name="'.$prog_state{'formname'}.'">');
1018: } else {
1019: $prog_state{'formname'}=$formname;
1020: }
1021: if (!$inputname) {
1022: $prog_state{'inputname'}=&get_uniq_name();
1023: &r_print($r,&mt("$heading [_1]",' <input type="text" name="'.$prog_state{'inputname'}.'" size="'.$width.'" />'));
1024: } else {
1025: $prog_state{'inputname'}=$inputname;
1026:
1027: }
1028: if (!$formname) { &r_print($r,'</form>'); }
1029: &Update_PrgWin($r,\%prog_state,&mt('Starting'));
1030: }
1031:
1032: $prog_state{'done'}=0;
1033: $prog_state{'firststart'}=&Time::HiRes::time();
1034: $prog_state{'laststart'}=&Time::HiRes::time();
1035: $prog_state{'max'}=$number_to_do;
1036:
1037: return %prog_state;
1038: }
1039:
1040: # update progress
1041: sub Update_PrgWin {
1042: my ($r,$prog_state,$displayString)=@_;
1043: &r_print($r,&Apache::lonhtmlcommon::scripttag(
1044: $$prog_state{'window'}.'.document.'.
1045: $$prog_state{'formname'}.'.'.
1046: $$prog_state{'inputname'}.'.value="'.
1047: $displayString.'";'
1048: ));
1049: $$prog_state{'laststart'}=&Time::HiRes::time();
1050: }
1051:
1052: # increment progress state
1053: sub Increment_PrgWin {
1054: my ($r,$prog_state,$extraInfo,$step)=@_;
1055: if ( ($step == 0) || ($step !~ /^\d+(\.\d+)*$/) ) {
1056: $step = 1; # default
1057: }
1058: $$prog_state{'done'} += $step;
1059:
1060: # Catch (max modulo step) <> 0
1061: my $current = $$prog_state{'done'};
1062: my $last = ($$prog_state{'max'} - $current);
1063: if ($last <= 0) {
1064: $last = 1;
1065: $current = $$prog_state{'max'};
1066: }
1067:
1068: my $time_est= (&Time::HiRes::time() - $$prog_state{'firststart'})/
1069: $current * $last;
1070: $time_est = int($time_est);
1071: #
1072: my $min = int($time_est/60);
1073: my $sec = $time_est % 60;
1074: #
1075: my $str;
1076: if ($min == 0 && $sec > 1) {
1077: $str = '[_1] seconds';
1078: } elsif ($min == 1 && $sec > 1) {
1079: $str = '1 minute [_2] seconds';
1080: } elsif ($min == 1 && $sec < 2) {
1081: $str = '1 minute';
1082: } elsif ($min < 10 && $sec > 1) {
1083: $str = '[_1] minutes, [_2] seconds';
1084: } elsif ($min >= 10 || $sec < 2) {
1085: $str = '[_1] minutes';
1086: }
1087: $time_est = &mt($str,$min,$sec);
1088: #
1089: my $lasttime = &Time::HiRes::time()-$$prog_state{'laststart'};
1090: if ($lasttime > 9) {
1091: $lasttime = int($lasttime);
1092: } elsif ($lasttime < 0.01) {
1093: $lasttime = 0;
1094: } else {
1095: $lasttime = sprintf("%3.2f",$lasttime);
1096: }
1097: if ($lasttime == 1) {
1098: $lasttime = '('.$lasttime.' '.&mt('second for').' '.$extraInfo.')';
1099: } else {
1100: $lasttime = '('.$lasttime.' '.&mt('seconds for').' '.$extraInfo.')';
1101: }
1102: #
1103: my $user_browser = $env{'browser.type'} if (exists($env{'browser.type'}));
1104: my $user_os = $env{'browser.os'} if (exists($env{'browser.os'}));
1105: if (! defined($user_browser) || ! defined($user_os)) {
1106: (undef,$user_browser,undef,undef,undef,$user_os) =
1107: &Apache::loncommon::decode_user_agent();
1108: }
1109: if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
1110: $lasttime = '';
1111: }
1112: &r_print($r,&Apache::lonhtmlcommon::scripttag(
1113: $$prog_state{'window'}.'.document.'.
1114: $$prog_state{'formname'}.'.'.
1115: $$prog_state{'inputname'}.'.value="'.
1116: $current.'/'.$$prog_state{'max'}.
1117: ': '.$time_est.' '.&mt('remaining').' '.$lasttime.'";'
1118: ));
1119: $$prog_state{'laststart'}=&Time::HiRes::time();
1120: }
1121:
1122: # close Progress Line
1123: sub Close_PrgWin {
1124: my ($r,$prog_state)=@_;
1125: if ($$prog_state{'type'} eq 'popup') {
1126: &r_print($r,&Apache::lonhtmlcommon::scripttag(
1127: 'popwin.close()'
1128: ));
1129: } elsif ($$prog_state{'type'} eq 'inline') {
1130: &Update_PrgWin($r,$prog_state,&mt('Done'));
1131: }
1132: undef(%$prog_state);
1133: }
1134:
1135: sub r_print {
1136: my ($r,$to_print)=@_;
1137: if ($r) {
1138: $r->print($to_print);
1139: $r->rflush();
1140: } else {
1141: print($to_print);
1142: }
1143: }
1144:
1145: # ------------------------------------------------------- Puts directory header
1146:
1147: sub crumbs {
1148: my ($uri,$target,$prefix,$form,$skiplast)=@_;
1149: if ($target) {
1150: $target = ' target="'.
1151: &Apache::loncommon::escape_single($target).'"';
1152: }
1153: my $output='<span class="LC_filename">';
1154: $output.=$prefix.'/';
1155: if (($env{'user.adv'}) || ($env{'user.author'})) {
1156: my $path=$prefix.'/';
1157: foreach my $dir (split('/',$uri)) {
1158: if (! $dir) { next; }
1159: $path .= $dir;
1160: if ($path eq $uri) {
1161: if ($skiplast) {
1162: $output.=$dir;
1163: last;
1164: }
1165: } else {
1166: $path.='/';
1167: }
1168: my $href_path = &HTML::Entities::encode($path,'<>&"');
1169: &Apache::loncommon::inhibit_menu_check(\$href_path);
1170: if ($form) {
1171: my $href = 'javascript:'.$form.".action='".$href_path."';".$form.'.submit();';
1172: $output.=qq{<a href="$href"$target>$dir</a>/};
1173: } else {
1174: $output.=qq{<a href="$href_path"$target>$dir</a>/};
1175: }
1176: }
1177: } else {
1178: foreach my $dir (split('/',$uri)) {
1179: if (! $dir) { next; }
1180: $output.=$dir.'/';
1181: }
1182: }
1183: if ($uri !~ m|/$|) { $output=~s|/$||; }
1184: $output.='</span>';
1185:
1186: return $output;
1187: }
1188:
1189: # --------------------- A function that generates a window for the spellchecker
1190:
1191: sub spellheader {
1192: my $start_page=
1193: &Apache::loncommon::start_page('Speller Suggestions',undef,
1194: {'only_body' => 1,
1195: 'js_ready' => 1,
1196: 'bgcolor' => '#DDDDDD',
1197: 'add_entries' => {
1198: 'onload' =>
1199: 'document.forms.spellcheckform.submit()',
1200: }
1201: });
1202: my $end_page=
1203: &Apache::loncommon::end_page({'js_ready' => 1});
1204:
1205: my $nothing=&javascript_nothing();
1206: return (<<ENDCHECK);
1207: <script type="text/javascript">
1208: // <![CDATA[
1209: //<!-- BEGIN LON-CAPA Internal
1210: var checkwin;
1211:
1212: function spellcheckerwindow(string) {
1213: var esc_string = string.replace(/\"/g,'"');
1214: checkwin=window.open($nothing,'spellcheckwin','height=320,width=280,resizable=yes,scrollbars=yes,location=no,menubar=no,toolbar=no');
1215: checkwin.document.writeln('$start_page<form name="spellcheckform" action="/adm/spellcheck" method="post"><input type="hidden" name="text" value="'+esc_string+'" /><\\/form>$end_page');
1216: checkwin.document.close();
1217: }
1218: // END LON-CAPA Internal -->
1219: // ]]>
1220: </script>
1221: ENDCHECK
1222: }
1223:
1224: # ---------------------------------- Generate link to spell checker for a field
1225:
1226: sub spelllink {
1227: my ($form,$field)=@_;
1228: my $linktext=&mt('Check Spelling');
1229: return (<<ENDLINK);
1230: <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>
1231: ENDLINK
1232: }
1233:
1234: # ------------------------------------------------- Output headers for HTMLArea
1235:
1236: {
1237: my @htmlareafields;
1238: sub init_htmlareafields {
1239: undef(@htmlareafields);
1240: }
1241:
1242: sub add_htmlareafields {
1243: my (@newfields) = @_;
1244: push(@htmlareafields,@newfields);
1245: }
1246:
1247: sub get_htmlareafields {
1248: return @htmlareafields;
1249: }
1250: }
1251:
1252: sub htmlareaheaders {
1253: my $s="";
1254: if (&htmlareabrowser()) {
1255: $s.=(<<ENDEDITOR);
1256: <script type="text/javascript" src="/ckeditor/ckeditor.js"></script>
1257: ENDEDITOR
1258: }
1259: $s.=(<<ENDJQUERY);
1260: <script type="text/javascript" src="/adm/jQuery/js/jquery-1.3.2.min.js"></script>
1261: <script type="text/javascript" src="/adm/jQuery/js/jquery-ui-1.7.2.custom.min.js"></script>
1262: <link rel="stylesheet" type="text/css" href="/adm/jQuery/css/smoothness/jquery-ui-1.7.2.custom.css" />
1263: ENDJQUERY
1264: return $s;
1265: }
1266:
1267: # ----------------------------------------------------------------- Preferences
1268:
1269: sub disablelink {
1270: my @fields=@_;
1271: if (defined($#fields)) {
1272: unless ($#fields>=0) { return ''; }
1273: }
1274: return '<a href="'.&HTML::Entities::encode('/adm/preferences?action=set_wysiwyg&wysiwyg=off&returnurl=','<>&"').&escape($ENV{'REQUEST_URI'}).'">'.&mt('Disable WYSIWYG Editor').'</a>';
1275: }
1276:
1277: sub enablelink {
1278: my @fields=@_;
1279: if (defined($#fields)) {
1280: unless ($#fields>=0) { return ''; }
1281: }
1282: return '<a href="'.&HTML::Entities::encode('/adm/preferences?action=set_wysiwyg&wysiwyg=on&returnurl=','<>&"').&escape($ENV{'REQUEST_URI'}).'">'.&mt('Enable WYSIWYG Editor').'</a>';
1283: }
1284:
1285: # ------------------------------------------------- lang to use in html editor
1286: sub htmlarea_lang {
1287: my $lang='en';
1288: if (&mt('htmlarea_lang') ne 'htmlarea_lang') {
1289: $lang=&mt('htmlarea_lang');
1290: }
1291: return $lang;
1292: }
1293:
1294: # ----------------------------------------- Script to activate only some fields
1295:
1296: sub htmlareaselectactive {
1297: my @fields=@_;
1298: unless (&htmlareabrowser()) { return ''; }
1299: my $output='<script type="text/javascript" defer="defer">'."\n"
1300: .'// <![CDATA['."\n";
1301: my $lang = &htmlarea_lang();
1302: $output.='
1303:
1304: function containsBlockHtml(id) {
1305: var re = $("#"+id).html().search(/(?:\<\;|\<)(br|h1|h2|h3|h4|h5|h6|p|ol|ul|table|pre|address|blockquote|center|div)[\s]*((?:\/[\s]*(?:\>\;|\>)|(?:\>\;|\>)[\s\S]*(?:\<\;|\<)\/[\s]*\1[\s]*\(?:\>\;|\>))/im);
1306: return (re >= 0);
1307: }
1308:
1309: function startRichEditor(id) {
1310: CKEDITOR.replace(id,
1311: {
1312: customConfig: "/ckeditor/loncapaconfig.js"
1313: }
1314: );
1315: }
1316:
1317: function destroyRichEditor(id) {
1318: CKEDITOR.instances[id].destroy();
1319: }
1320:
1321: function editorHandler(event) {
1322: var rawid = $(this).attr("id");
1323: var id = new RegExp("LC_rt_(.*)").exec(rawid)[1]
1324: event.preventDefault();
1325: if ($(this).hasClass("LC_enable_rt")) {
1326: startRichEditor(id);
1327: $("#LC_rt_"+id).html("<b>« Plain text</b>");
1328: $("#LC_rt_"+id).attr("title", "Disable rich text formatting and edit in plain text");
1329: $("#LC_rt_"+id).addClass("LC_disable_rt");
1330: $("#LC_rt_"+id).removeClass("LC_enable_rt");
1331: } else {
1332: destroyRichEditor(id);
1333: $("#LC_rt_"+id).html("<b>Rich formatting »</b>");
1334: $("#LC_rt_"+id).attr("title", "Enable rich text formatting (bold, italic, etc.)");
1335: $("#LC_rt_"+id).addClass("LC_enable_rt");
1336: $("#LC_rt_"+id).removeClass("LC_disable_rt");
1337: }
1338: }
1339:
1340: $(document).ready(function(){
1341: $(".LC_richAlwaysOn").each(function() {
1342: startRichEditor($(this).attr("id"));
1343: });
1344: $(".LC_richDetectHtml").each(function() {
1345: var id = $(this).attr("id");
1346: if(containsBlockHtml(id)) {
1347: $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Disable rich text formatting and edit in plain text\" class=\"LC_disable_rt\"><b>« Plain text</b></a></div>");
1348: startRichEditor(id);
1349: $("#LC_rt_"+id).click(editorHandler);
1350: }
1351: else {
1352: $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Enable rich text formatting (bold, italic, etc.)\" class=\"LC_enable_rt\"><b>Rich formatting »</b></a></div>");
1353: $("#LC_rt_"+id).click(editorHandler);
1354: }
1355: });
1356: $(".LC_richDefaultOn").each(function() {
1357: var id = $(this).attr("id");
1358: $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Disable rich text formatting and edit in plain text\" class=\"LC_disable_rt\"><b>« Plain text</b></a></div>");
1359: startRichEditor(id);
1360: $("#LC_rt_"+id).click(editorHandler);
1361: });
1362: $(".LC_richDefaultOff").each(function() {
1363: var id = $(this).attr("id");
1364: $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Enable rich text formatting (bold, italic, etc.)\" class=\"LC_enable_rt\"><b>Rich formatting »</b></a></div>");
1365: $("#LC_rt_"+id).click(editorHandler);
1366: });
1367:
1368: });
1369: ';
1370: $output.="\nwindow.status='Activated Editfields';\n"
1371: .'// ]]>'."\n"
1372: .'</script><br />';
1373: return $output;
1374: }
1375:
1376: # --------------------------------------------------------------------- Blocked
1377:
1378: sub htmlareablocked {
1379: unless ($env{'environment.wysiwygeditor'} eq 'on') { return 1; }
1380: return 0;
1381: }
1382:
1383: # ---------------------------------------- Browser capable of running HTMLArea?
1384:
1385: sub htmlareabrowser {
1386: return 1;
1387: }
1388:
1389: ############################################################
1390: ############################################################
1391:
1392: =pod
1393:
1394: =item breadcrumbs
1395:
1396: Compiles the previously registered breadcrumbs into an series of links.
1397: Additionally supports a 'component', which will be displayed on the
1398: right side of the breadcrumbs enclosing div (without a link).
1399: A link to help for the component will be included if one is specified.
1400:
1401: All inputs can be undef without problems.
1402:
1403: Inputs: $component (the text on the right side of the breadcrumbs trail),
1404: $component_help
1405: $menulink (boolean, controls whether to include a link to /adm/menu)
1406: $helplink (if 'nohelp' don't include the orange help link)
1407: $css_class (optional name for the class to apply to the table for CSS)
1408: $no_mt (optional flag, 1 if &mt() is _not_ to be applied to $component
1409: when including the text on the right.
1410: Returns a string containing breadcrumbs for the current page.
1411:
1412: =item clear_breadcrumbs
1413:
1414: Clears the previously stored breadcrumbs.
1415:
1416: =item add_breadcrumb
1417:
1418: Pushes a breadcrumb on the stack of crumbs.
1419:
1420: input: $breadcrumb, a hash reference. The keys 'href','title', and 'text'
1421: are required. If present the keys 'faq' and 'bug' will be used to provide
1422: links to the FAQ and bug sites. If the key 'no_mt' is present the 'title'
1423: and 'text' values won't be sent through &mt()
1424:
1425: returns: nothing
1426:
1427: =cut
1428:
1429: ############################################################
1430: ############################################################
1431: {
1432: my @Crumbs;
1433: my %tools = ();
1434:
1435: sub breadcrumbs {
1436: my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt, $CourseBreadcrumbs) = @_;
1437: #
1438: $css_class ||= 'LC_breadcrumbs';
1439:
1440: # Make the faq and bug data cascade
1441: my $faq = '';
1442: my $bug = '';
1443: my $help = '';
1444: # Crumb Symbol
1445: my $crumbsymbol = '»';
1446: # The last breadcrumb does not have a link, so handle it separately.
1447: my $last = pop(@Crumbs);
1448: #
1449: # The first one should be the course or a menu link
1450: if (!defined($menulink)) { $menulink=1; }
1451: if ($menulink) {
1452: my $description = 'Menu';
1453: my $no_mt_descr = 0;
1454: if ((exists($env{'request.course.id'})) &&
1455: ($env{'request.course.id'} ne '') &&
1456: ($env{'course.'.$env{'request.course.id'}.'.description'} ne '')) {
1457: $description =
1458: $env{'course.'.$env{'request.course.id'}.'.description'};
1459: $no_mt_descr = 1;
1460: }
1461: $menulink = { href =>'/adm/menu',
1462: title =>'Go to main menu',
1463: target =>'_top',
1464: text =>$description,
1465: no_mt =>$no_mt_descr, };
1466: if($last) {
1467: #$last set, so we have some crumbs
1468: unshift(@Crumbs,$menulink);
1469: } else {
1470: #only menulink crumb present
1471: $last = $menulink;
1472: }
1473: }
1474: my $links = join "",
1475: map {
1476: $faq = $_->{'faq'} if (exists($_->{'faq'}));
1477: $bug = $_->{'bug'} if (exists($_->{'bug'}));
1478: $help = $_->{'help'} if (exists($_->{'help'}));
1479:
1480: my $result = $_->{no_mt} ? $_->{text} : mt($_->{text});
1481:
1482: if ($_->{href}){
1483: $result = htmltag( 'a', $result,
1484: { href => $_->{href},
1485: title => $_->{no_mt} ? $_->{title} : mt($_->{title}),
1486: target => $_->{target}, });
1487: }
1488:
1489: $result = htmltag( 'li', "$result $crumbsymbol");
1490: } @Crumbs;
1491:
1492: #should the last Element be translated?
1493:
1494: my $lasttext = $last->{'no_mt'} ? $last->{'text'}
1495: : mt( $last->{'text'} );
1496:
1497: # last breadcrumb is the first order heading of a page
1498: # for course breadcrumbs it's just bold
1499: $links .= htmltag( 'li', htmltag($CourseBreadcrumbs ? 'b' : 'h1',
1500: $lasttext), {title => $lasttext});
1501:
1502: my $icons = '';
1503: $faq = $last->{'faq'} if (exists($last->{'faq'}));
1504: $bug = $last->{'bug'} if (exists($last->{'bug'}));
1505: $help = $last->{'help'} if (exists($last->{'help'}));
1506: $component_help=($component_help?$component_help:$help);
1507: # if ($faq ne '') {
1508: # $icons .= &Apache::loncommon::help_open_faq($faq);
1509: # }
1510: # if ($bug ne '') {
1511: # $icons .= &Apache::loncommon::help_open_bug($bug);
1512: # }
1513: if ($faq ne '' || $component_help ne '' || $bug ne '') {
1514: $icons .= &Apache::loncommon::help_open_menu($component,
1515: $component_help,
1516: $faq,$bug);
1517: }
1518: #
1519:
1520:
1521: unless ($CourseBreadcrumbs) {
1522: $links = htmltag('ol', $links, { id => "LC_MenuBreadcrumbs" });
1523: } else {
1524: $links = htmltag('ul', $links, { class => "LC_CourseBreadcrumbs" });
1525: }
1526:
1527: if ($component) {
1528: $links = htmltag('span',
1529: ( $no_mt ? $component : mt($component) ).
1530: ( $icons ? $icons : '' ),
1531: { class => 'LC_breadcrumbs_component' } )
1532: .$links;
1533: }
1534:
1535: render_tools(\$links);
1536: $links = htmltag('div', $links,
1537: { id => "LC_breadcrumbs" }) unless ($CourseBreadcrumbs) ;
1538: render_advtools(\$links);
1539:
1540: # Return the @Crumbs stack to what we started with
1541: push(@Crumbs,$last);
1542: shift(@Crumbs);
1543: # Return the breadcrumb's line
1544: return "$links";
1545: }
1546:
1547: sub clear_breadcrumbs {
1548: undef(@Crumbs);
1549: undef(%tools);
1550: }
1551:
1552: sub add_breadcrumb {
1553: push(@Crumbs,@_);
1554: }
1555:
1556: =item add_breadcrumb_tool($category, $html)
1557:
1558: Adds $html to $category of the breadcrumb toolbar container.
1559:
1560: $html is usually a link to a page that invokes a function on the currently
1561: displayed data (e.g. print when viewing a problem)
1562:
1563: Currently there are 3 possible values for $category:
1564:
1565: =over
1566:
1567: =item navigation
1568: left of breadcrumbs line
1569:
1570: =item tools
1571: right of breadcrumbs line
1572:
1573: =item advtools
1574: advanced tools shown in a separate box below breadcrumbs line
1575:
1576: =back
1577:
1578: returns: nothing
1579:
1580: =cut
1581:
1582: sub add_breadcrumb_tool {
1583: my ($category, @html) = @_;
1584: return unless @html;
1585: if (!defined(%tools)) {
1586: %tools = ( navigation => [], tools => [], advtools => []);
1587: }
1588:
1589: #this cleans data received from lonmenu::innerregister
1590: @html = grep {defined $_ && $_ ne ''} @html;
1591: for (@html) {
1592: s/align="(right|left)"//;
1593: s/<span.*?\/span>// if $category ne 'advtools';
1594: }
1595:
1596: push @{$tools{$category}}, @html;
1597: }
1598:
1599: =item clear_breadcrumb_tools()
1600:
1601: Clears the breadcrumb toolbar container.
1602:
1603: returns: nothing
1604:
1605: =cut
1606:
1607: sub clear_breadcrumb_tools {
1608: undef(%tools);
1609: }
1610:
1611: =item render_tools(\$breadcrumbs)
1612:
1613: Creates html for breadcrumb tools (categories navigation and tools) and inserts
1614: \$breadcrumbs at the correct position.
1615:
1616: input: \$breadcrumbs - a reference to the string containing prepared
1617: breadcrumbs.
1618:
1619: returns: nothing
1620: =cut
1621:
1622: #TODO might split this in separate functions for each category
1623: sub render_tools {
1624: my ($breadcrumbs) = @_;
1625: return unless defined %tools;
1626:
1627: my $navigation = list_from_array($tools{navigation},
1628: { listattr => { class=>"LC_breadcrumb_tools_navigation" } });
1629: my $tools = list_from_array($tools{tools},
1630: { listattr => { class=>"LC_breadcrumb_tools_tools" } });
1631: $$breadcrumbs = list_from_array([$navigation, $tools, $$breadcrumbs],
1632: { listattr => { class=>'LC_breadcrumb_tools_outerlist' } });
1633: }
1634:
1635: =item render_advtools(\$breadcrumbs)
1636:
1637: Creates html for advanced tools (category advtools) and inserts \$breadcrumbs
1638: at the correct position.
1639:
1640: input: \$breadcrumbs - a reference to the string containing prepared
1641: breadcrumbs (after render_tools call).
1642:
1643: returns: nothing
1644: =cut
1645:
1646: sub render_advtools {
1647: my ($breadcrumbs) = @_;
1648: return unless (defined $tools{'advtools'})
1649: and (scalar(@{$tools{'advtools'}}) > 0);
1650:
1651: $$breadcrumbs .= Apache::loncommon::head_subbox(
1652: funclist_from_array($tools{'advtools'}) );
1653: }
1654:
1655: } # End of scope for @Crumbs
1656:
1657: ############################################################
1658: ############################################################
1659:
1660: # Nested table routines.
1661: #
1662: # Routines to display form items in a multi-row table with 2 columns.
1663: # Uses nested tables to divide form elements into segments.
1664: # For examples of use see loncom/interface/lonnotify.pm
1665: #
1666: # Can be used in following order: ...
1667: # &start_pick_box()
1668: # row1
1669: # row2
1670: # row3 ... etc.
1671: # &submit_row()
1672: # &end_pick_box()
1673: #
1674: # where row1, row 2 etc. are chosen from &role_select_row,&course_select_row,
1675: # &status_select_row and &email_default_row
1676: #
1677: # Can also be used in following order:
1678: #
1679: # &start_pick_box()
1680: # &row_title()
1681: # &row_closure()
1682: # &row_title()
1683: # &row_closure() ... etc.
1684: # &submit_row()
1685: # &end_pick_box()
1686: #
1687: # In general a &submit_row() call should proceed the call to &end_pick_box(),
1688: # as this routine adds a button for form submission.
1689: # &submit_row() does not require a &row_closure after it.
1690: #
1691: # &start_pick_box() creates a bounding table with 1-pixel wide black border.
1692: # rows should be placed between calls to &start_pick_box() and &end_pick_box.
1693: #
1694: # &row_title() adds a title in the left column for each segment.
1695: # &row_closure() closes a row with a 1-pixel wide black line.
1696: #
1697: # &role_select_row() provides a select box from which to choose 1 or more roles
1698: # &course_select_row provides ways of picking groups of courses
1699: # radio buttons: all, by category or by picking from a course picker pop-up
1700: # note: by category option is only displayed if a domain has implemented
1701: # selection by year, semester, department, number etc.
1702: #
1703: # &status_select_row() provides a select box from which to choose 1 or more
1704: # access types (current access, prior access, and future access)
1705: #
1706: # &email_default_row() provides text boxes for default e-mail suffixes for
1707: # different authentication types in a domain.
1708: #
1709: # &row_title() and &row_closure() are called internally by the &*_select_row
1710: # routines, but can also be called directly to start and end rows which have
1711: # needs that are not accommodated by the *_select_row() routines.
1712:
1713: { # Start: row_count block for pick_box
1714: my @row_count;
1715:
1716: sub start_pick_box {
1717: my ($css_class) = @_;
1718: if (defined($css_class)) {
1719: $css_class = 'class="'.$css_class.'"';
1720: } else {
1721: $css_class= 'class="LC_pick_box"';
1722: }
1723: unshift(@row_count,0);
1724: my $output = <<"END";
1725: <table $css_class>
1726: END
1727: return $output;
1728: }
1729:
1730: sub end_pick_box {
1731: shift(@row_count);
1732: my $output = <<"END";
1733: </table>
1734: END
1735: return $output;
1736: }
1737:
1738: sub row_headline {
1739: my $output = <<"END";
1740: <tr><td colspan="2">
1741: END
1742: return $output;
1743: }
1744:
1745: sub row_title {
1746: my ($title,$css_title_class,$css_value_class, $css_value_furtherAttributes) = @_;
1747: $row_count[0]++;
1748: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1749: $css_title_class ||= 'LC_pick_box_title';
1750: $css_title_class = 'class="'.$css_title_class.'"';
1751:
1752: $css_value_class ||= 'LC_pick_box_value';
1753:
1754: if ($title ne '') {
1755: $title .= ':';
1756: }
1757: my $output = <<"ENDONE";
1758: <tr class="LC_pick_box_row" $css_value_furtherAttributes>
1759: <td $css_title_class>
1760: $title
1761: </td>
1762: <td class="$css_value_class $css_class">
1763: ENDONE
1764: return $output;
1765: }
1766:
1767: sub row_closure {
1768: my ($no_separator) =@_;
1769: my $output = <<"ENDTWO";
1770: </td>
1771: </tr>
1772: ENDTWO
1773: if (!$no_separator) {
1774: $output .= <<"ENDTWO";
1775: <tr>
1776: <td colspan="2" class="LC_pick_box_separator">
1777: </td>
1778: </tr>
1779: ENDTWO
1780: }
1781: return $output;
1782: }
1783:
1784: } # End: row_count block for pick_box
1785:
1786: sub role_select_row {
1787: my ($roles,$title,$css_class,$show_separate_custom,$cdom,$cnum) = @_;
1788: my $crstype = 'Course';
1789: if ($cdom ne '' && $cnum ne '') {
1790: $crstype = &Apache::loncommon::course_type($cdom.'_'.$cnum);
1791: }
1792: my $output;
1793: if (defined($title)) {
1794: $output = &row_title($title,$css_class);
1795: }
1796: $output .= qq|
1797: <select name="roles" multiple="multiple">\n|;
1798: foreach my $role (@$roles) {
1799: my $plrole;
1800: if ($role eq 'ow') {
1801: $plrole = &mt('Course Owner');
1802: } elsif ($role eq 'cr') {
1803: if ($show_separate_custom) {
1804: if ($cdom ne '' && $cnum ne '') {
1805: my %course_customroles = &course_custom_roles($cdom,$cnum);
1806: foreach my $crrole (sort(keys(%course_customroles))) {
1807: my ($plcrrole) = ($crrole =~ m|^cr/[^/]+/[^/]+/(.+)$|);
1808: $output .= ' <option value="'.$crrole.'">'.$plcrrole.
1809: '</option>';
1810: }
1811: }
1812: } else {
1813: $plrole = &mt('Custom Role');
1814: }
1815: } else {
1816: $plrole=&Apache::lonnet::plaintext($role,$crstype);
1817: }
1818: if (($role ne 'cr') || (!$show_separate_custom)) {
1819: $output .= ' <option value="'.$role.'">'.$plrole.'</option>';
1820: }
1821: }
1822: $output .= qq| </select>\n|;
1823: if (defined($title)) {
1824: $output .= &row_closure();
1825: }
1826: return $output;
1827: }
1828:
1829: sub course_select_row {
1830: my ($title,$formname,$totcodes,$codetitles,$idlist,$idlist_titles,
1831: $css_class,$crstype) = @_;
1832: my $output = &row_title($title,$css_class);
1833: $output .= &course_selection($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype);
1834: $output .= &row_closure();
1835: return $output;
1836: }
1837:
1838: sub course_selection {
1839: my ($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype) = @_;
1840: my $output = qq|
1841: <script type="text/javascript">
1842: // <![CDATA[
1843: function coursePick (formname) {
1844: for (var i=0; i<formname.coursepick.length; i++) {
1845: if (formname.coursepick[i].value == 'category') {
1846: courseSet('');
1847: }
1848: if (!formname.coursepick[i].checked) {
1849: if (formname.coursepick[i].value == 'specific') {
1850: formname.coursetotal.value = 0;
1851: formname.courselist = '';
1852: }
1853: }
1854: }
1855: }
1856: function setPick (formname) {
1857: for (var i=0; i<formname.coursepick.length; i++) {
1858: if (formname.coursepick[i].value == 'category') {
1859: formname.coursepick[i].checked = true;
1860: }
1861: formname.coursetotal.value = 0;
1862: formname.courselist = '';
1863: }
1864: }
1865: // ]]>
1866: </script>
1867: |;
1868:
1869: my ($allcrs,$pickspec);
1870: if ($crstype eq 'Community') {
1871: $allcrs = &mt('All communities');
1872: $pickspec = &mt('Pick specific communities:');
1873: } else {
1874: $allcrs = &mt('All courses');
1875: $pickspec = &mt('Pick specific course(s):');
1876: }
1877:
1878: my $courseform='<b>'.&Apache::loncommon::selectcourse_link
1879: ($formname,'pickcourse','pickdomain','coursedesc','',1,$crstype).'</b>';
1880: $output .= '<input type="radio" name="coursepick" value="all" onclick="coursePick(this.form)" />'.$allcrs.'<br />';
1881: if ($totcodes > 0) {
1882: my $numtitles = @$codetitles;
1883: if ($numtitles > 0) {
1884: $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 />';
1885: $output .= '<table><tr><td>'.$$codetitles[0].'<br />'."\n".
1886: '<select name="'.$$codetitles[0].
1887: '" onChange="setPick(this.form);courseSet('."'$$codetitles[0]'".')">'."\n".
1888: ' <option value="-1" />Select'."\n";
1889: my @items = ();
1890: my @longitems = ();
1891: if ($$idlist{$$codetitles[0]} =~ /","/) {
1892: @items = split(/","/,$$idlist{$$codetitles[0]});
1893: } else {
1894: $items[0] = $$idlist{$$codetitles[0]};
1895: }
1896: if (defined($$idlist_titles{$$codetitles[0]})) {
1897: if ($$idlist_titles{$$codetitles[0]} =~ /","/) {
1898: @longitems = split(/","/,$$idlist_titles{$$codetitles[0]});
1899: } else {
1900: $longitems[0] = $$idlist_titles{$$codetitles[0]};
1901: }
1902: for (my $i=0; $i<@longitems; $i++) {
1903: if ($longitems[$i] eq '') {
1904: $longitems[$i] = $items[$i];
1905: }
1906: }
1907: } else {
1908: @longitems = @items;
1909: }
1910: for (my $i=0; $i<@items; $i++) {
1911: $output .= ' <option value="'.$items[$i].'">'.$longitems[$i].'</option>';
1912: }
1913: $output .= '</select></td>';
1914: for (my $i=1; $i<$numtitles; $i++) {
1915: $output .= '<td>'.$$codetitles[$i].'<br />'."\n".
1916: '<select name="'.$$codetitles[$i].
1917: '" onChange="courseSet('."'$$codetitles[$i]'".')">'."\n".
1918: '<option value="-1"><-Pick '.$$codetitles[$i-1].'</option>'."\n".
1919: '</select>'."\n".
1920: '</td>';
1921: }
1922: $output .= '</tr></table><br />';
1923: }
1924: }
1925: $output .= '<input type="radio" name="coursepick" value="specific" onclick="coursePick(this.form);opencrsbrowser('."'".$formname."','dccourse','dcdomain','coursedesc','','1','$crstype'".')" />'.$pickspec.' '.$courseform.' <input type="text" value="0" size="4" name="coursetotal" /><input type="hidden" name="courselist" value="" />selected.<br />'."\n";
1926: return $output;
1927: }
1928:
1929: sub status_select_row {
1930: my ($types,$title,$css_class) = @_;
1931: my $output;
1932: if (defined($title)) {
1933: $output = &row_title($title,$css_class,'LC_pick_box_select');
1934: }
1935: $output .= qq|
1936: <select name="types" multiple="multiple">\n|;
1937: foreach my $status_type (sort(keys(%{$types}))) {
1938: $output .= ' <option value="'.$status_type.'">'.$$types{$status_type}.'</option>';
1939: }
1940: $output .= qq| </select>\n|;
1941: if (defined($title)) {
1942: $output .= &row_closure();
1943: }
1944: return $output;
1945: }
1946:
1947: sub email_default_row {
1948: my ($authtypes,$title,$descrip,$css_class) = @_;
1949: my $output = &row_title($title,$css_class);
1950: $output .= $descrip.
1951: &Apache::loncommon::start_data_table().
1952: &Apache::loncommon::start_data_table_header_row().
1953: '<th>'.&mt('Authentication Method').'</th>'.
1954: '<th align="right">'.&mt('Username -> e-mail conversion').'</th>'."\n".
1955: &Apache::loncommon::end_data_table_header_row();
1956: my $rownum = 0;
1957: foreach my $auth (sort(keys(%{$authtypes}))) {
1958: my ($userentry,$size);
1959: if ($auth =~ /^krb/) {
1960: $userentry = '';
1961: $size = 25;
1962: } else {
1963: $userentry = 'username@';
1964: $size = 15;
1965: }
1966: $output .= &Apache::loncommon::start_data_table_row().
1967: '<td> '.$$authtypes{$auth}.'</td>'.
1968: '<td align="right">'.$userentry.
1969: '<input type="text" name="'.$auth.'" size="'.$size.'" /></td>'.
1970: &Apache::loncommon::end_data_table_row();
1971: }
1972: $output .= &Apache::loncommon::end_data_table();
1973: $output .= &row_closure();
1974: return $output;
1975: }
1976:
1977:
1978: sub submit_row {
1979: my ($title,$cmd,$submit_text,$css_class) = @_;
1980: my $output = &row_title($title,$css_class,'LC_pick_box_submit');
1981: $output .= qq|
1982: <br />
1983: <input type="hidden" name="command" value="$cmd" />
1984: <input type="submit" value="$submit_text"/>
1985: <br /><br />
1986: \n|;
1987: return $output;
1988: }
1989:
1990: sub course_custom_roles {
1991: my ($cdom,$cnum) = @_;
1992: my %returnhash=();
1993: my %coursepersonnel=&Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
1994: foreach my $person (sort(keys(%coursepersonnel))) {
1995: my ($role) = ($person =~ /^([^:]+):/);
1996: my ($end,$start) = split(/:/,$coursepersonnel{$person});
1997: if ($end == -1 && $start == -1) {
1998: next;
1999: }
2000: if ($role =~ m|^cr/[^/]+/[^/]+/[^/]|) {
2001: $returnhash{$role} ++;
2002: }
2003: }
2004: return %returnhash;
2005: }
2006:
2007:
2008: sub resource_info_box {
2009: my ($symb,$onlyfolderflag)=@_;
2010: my $return='';
2011: if ($symb) {
2012: $return=&Apache::loncommon::start_data_table();
2013: my ($map,$id,$resource)=&Apache::lonnet::decode_symb($symb);
2014: my $folder=&Apache::lonnet::gettitle($map);
2015: $return.=&Apache::loncommon::start_data_table_row().
2016: '<th>'.&mt('Folder:').'</th><td>'.$folder.'</td>'.
2017: &Apache::loncommon::end_data_table_row();
2018: unless ($onlyfolderflag) {
2019: $return.=&Apache::loncommon::start_data_table_row().
2020: '<th>'.&mt('Resource:').'</th><td>'.&Apache::lonnet::gettitle($symb).'</td>'.
2021: &Apache::loncommon::end_data_table_row();
2022: }
2023: $return.=&Apache::loncommon::end_data_table();
2024: } else {
2025: $return='<p><span class="LC_error">'.&mt('No context provided.').'</span></p>';
2026: }
2027: return $return;
2028:
2029: }
2030:
2031: ##############################################
2032: ##############################################
2033:
2034: # topic_bar
2035: #
2036: # Generates a div containing an (optional) number with a white background followed by a
2037: # title with a background color defined in the corresponding CSS: LC_topic_bar
2038: # Inputs:
2039: # 1. number to display.
2040: # If input for number is empty only the title will be displayed.
2041: # 2. title text to display.
2042: # Outputs - a scalar containing html mark-up for the div.
2043:
2044: sub topic_bar {
2045: my ($num,$title) = @_;
2046: my $number = '';
2047: if ($num ne '') {
2048: $number = '<span>'.$num.'</span>';
2049: }
2050: return '<div class="LC_topic_bar">'.$number.$title.'</div>';
2051: }
2052:
2053: ##############################################
2054: ##############################################
2055: # echo_form_input
2056: #
2057: # Generates html markup to add form elements from the referrer page
2058: # as hidden form elements (values encoded) in the new page.
2059: #
2060: # Intended to support two types of use
2061: # (a) to allow backing up to earlier pages in a multi-page
2062: # form submission process using a breadcrumb trail.
2063: #
2064: # (b) to allow the current page to be reloaded with form elements
2065: # set on previous page to remain unchanged. An example would
2066: # be where the a page containing a dynamically-built table of data is
2067: # is to be redisplayed, with only the sort order of the data changed.
2068: #
2069: # Inputs:
2070: # 1. Reference to array of form elements in the submitted form on
2071: # the referrer page which are to be excluded from the echoed elements.
2072: #
2073: # 2. Reference to array of regular expressions, which if matched in the
2074: # name of the form element n the referrer page will be omitted from echo.
2075: #
2076: # Outputs: A scalar containing the html markup for the echoed form
2077: # elements (all as hidden elements, with values encoded).
2078:
2079:
2080: sub echo_form_input {
2081: my ($excluded,$regexps) = @_;
2082: my $output = '';
2083: foreach my $key (keys(%env)) {
2084: if ($key =~ /^form\.(.+)$/) {
2085: my $name = $1;
2086: my $match = 0;
2087: if ((!@{$excluded}) || (!grep/^$name$/,@{$excluded})) {
2088: if (defined($regexps)) {
2089: if (@{$regexps} > 0) {
2090: foreach my $regexp (@{$regexps}) {
2091: if ($name =~ /\Q$regexp\E/) {
2092: $match = 1;
2093: last;
2094: }
2095: }
2096: }
2097: }
2098: if (!$match) {
2099: if (ref($env{$key})) {
2100: foreach my $value (@{$env{$key}}) {
2101: $value = &HTML::Entities::encode($value,'<>&"');
2102: $output .= '<input type="hidden" name="'.$name.
2103: '" value="'.$value.'" />'."\n";
2104: }
2105: } else {
2106: my $value = &HTML::Entities::encode($env{$key},'<>&"');
2107: $output .= '<input type="hidden" name="'.$name.
2108: '" value="'.$value.'" />'."\n";
2109: }
2110: }
2111: }
2112: }
2113: }
2114: return $output;
2115: }
2116:
2117: ##############################################
2118: ##############################################
2119: # set_form_elements
2120: #
2121: # Generates javascript to set form elements to values based on
2122: # corresponding values for the same form elements when the page was
2123: # previously submitted.
2124: #
2125: # Last submission values are read from hidden form elements in referring
2126: # page which have the same name, i.e., generated by &echo_form_input().
2127: #
2128: # Intended to be called by onload event.
2129: #
2130: # Inputs:
2131: # (a) Reference to hash of echoed form elements to be set.
2132: #
2133: # In the hash, keys are the form element names, and the values are the
2134: # element type (selectbox, radio, checkbox or text -for textbox, textarea or
2135: # hidden).
2136: #
2137: # (b) Optional reference to hash of stored elements to be set.
2138: #
2139: # If the page being displayed is a page which permits modification of
2140: # previously stored data, e.g., the first page in a multi-page submission,
2141: # then if stored is supplied, form elements will be set to the last stored
2142: # values. If user supplied values are also available for the same elements
2143: # these will replace the stored values.
2144: #
2145: # Output:
2146: #
2147: # javascript function - set_form_elements() which sets form elements,
2148: # expects an argument: formname - the name of the form according to
2149: # the DOM, e.g., document.compose
2150:
2151: sub set_form_elements {
2152: my ($elements,$stored) = @_;
2153: my %values;
2154: my $output .= 'function setFormElements(courseForm) {
2155: ';
2156: if (defined($stored)) {
2157: foreach my $name (keys(%{$stored})) {
2158: if (exists($$elements{$name})) {
2159: if (ref($$stored{$name}) eq 'ARRAY') {
2160: $values{$name} = $$stored{$name};
2161: } else {
2162: @{$values{$name}} = ($$stored{$name});
2163: }
2164: }
2165: }
2166: }
2167:
2168: foreach my $key (keys(%env)) {
2169: if ($key =~ /^form\.(.+)$/) {
2170: my $name = $1;
2171: if (exists($$elements{$name})) {
2172: @{$values{$name}} = &Apache::loncommon::get_env_multiple($key);
2173: }
2174: }
2175: }
2176:
2177: foreach my $name (keys(%values)) {
2178: for (my $i=0; $i<@{$values{$name}}; $i++) {
2179: $values{$name}[$i] = &HTML::Entities::decode($values{$name}[$i],'<>&"');
2180: $values{$name}[$i] =~ s/([\r\n\f]+)/\\n/g;
2181: $values{$name}[$i] =~ s/"/\\"/g;
2182: }
2183: if (($$elements{$name} eq 'text') || ($$elements{$name} eq 'hidden')) {
2184: my $numvalues = @{$values{$name}};
2185: if ($numvalues > 1) {
2186: my $valuestring = join('","',@{$values{$name}});
2187: $output .= qq|
2188: var textvalues = new Array ("$valuestring");
2189: var total = courseForm.elements['$name'].length;
2190: if (total > $numvalues) {
2191: total = $numvalues;
2192: }
2193: for (var i=0; i<total; i++) {
2194: courseForm.elements['$name']\[i].value = textvalues[i];
2195: }
2196: |;
2197: } else {
2198: $output .= qq|
2199: courseForm.elements['$name'].value = "$values{$name}[0]";
2200: |;
2201: }
2202: } else {
2203: $output .= qq|
2204: var elementLength = courseForm.elements['$name'].length;
2205: if (elementLength==undefined) {
2206: |;
2207: foreach my $value (@{$values{$name}}) {
2208: if ($$elements{$name} eq 'selectbox') {
2209: $output .= qq|
2210: if (courseForm.elements['$name'].options[0].value == "$value") {
2211: courseForm.elements['$name'].options[0].selected = true;
2212: }|;
2213: } elsif (($$elements{$name} eq 'radio') ||
2214: ($$elements{$name} eq 'checkbox')) {
2215: $output .= qq|
2216: if (courseForm.elements['$name'].value == "$value") {
2217: courseForm.elements['$name'].checked = true;
2218: } else {
2219: courseForm.elements['$name'].checked = false;
2220: }|;
2221: }
2222: }
2223: $output .= qq|
2224: }
2225: else {
2226: for (var i=0; i<courseForm.elements['$name'].length; i++) {
2227: |;
2228: if ($$elements{$name} eq 'selectbox') {
2229: $output .= qq|
2230: courseForm.elements['$name'].options[i].selected = false;|;
2231: } elsif (($$elements{$name} eq 'radio') ||
2232: ($$elements{$name} eq 'checkbox')) {
2233: $output .= qq|
2234: courseForm.elements['$name']\[i].checked = false;|;
2235: }
2236: $output .= qq|
2237: }
2238: for (var j=0; j<courseForm.elements['$name'].length; j++) {
2239: |;
2240: foreach my $value (@{$values{$name}}) {
2241: if ($$elements{$name} eq 'selectbox') {
2242: $output .= qq|
2243: if (courseForm.elements['$name'].options[j].value == "$value") {
2244: courseForm.elements['$name'].options[j].selected = true;
2245: }|;
2246: } elsif (($$elements{$name} eq 'radio') ||
2247: ($$elements{$name} eq 'checkbox')) {
2248: $output .= qq|
2249: if (courseForm.elements['$name']\[j].value == "$value") {
2250: courseForm.elements['$name']\[j].checked = true;
2251: }|;
2252: }
2253: }
2254: $output .= qq|
2255: }
2256: }
2257: |;
2258: }
2259: }
2260: $output .= "
2261: return;
2262: }\n";
2263: return $output;
2264: }
2265:
2266: ##############################################
2267: ##############################################
2268:
2269: # javascript_valid_email
2270: #
2271: # Generates javascript to validate an e-mail address.
2272: # Returns a javascript function which accetps a form field as argumnent, and
2273: # returns false if field.value does not satisfy two regular expression matches
2274: # for a valid e-mail address. Backwards compatible with old browsers without
2275: # support for javascript RegExp (just checks for @ in field.value in this case).
2276:
2277: sub javascript_valid_email {
2278: my $scripttag .= <<'END';
2279: function validmail(field) {
2280: var str = field.value;
2281: if (window.RegExp) {
2282: var reg1str = "(@.*@)|(\\.\\.)|(@\\.)|(\\.@)|(^\\.)";
2283: var reg2str = "^.+\\@(\\[?)[a-zA-Z0-9\\-\\.]+\\.([a-zA-Z]{2,3}|[0-9]{1,3})(\\]?)$"; //"
2284: var reg1 = new RegExp(reg1str);
2285: var reg2 = new RegExp(reg2str);
2286: if (!reg1.test(str) && reg2.test(str)) {
2287: return true;
2288: }
2289: return false;
2290: }
2291: else
2292: {
2293: if(str.indexOf("@") >= 0) {
2294: return true;
2295: }
2296: return false;
2297: }
2298: }
2299: END
2300: return $scripttag;
2301: }
2302:
2303:
2304: # USAGE: htmltag(element, content, {attribute => value,...});
2305: #
2306: # EXAMPLES:
2307: # - htmltag('a', 'this is an anchor', {href => 'www.example.com',
2308: # title => 'this is a title'})
2309: #
2310: # - You might want to set up needed tags like:
2311: #
2312: # my $h3 = sub { return htmltag( "h3", @_ ) };
2313: #
2314: # ... and use them: $h3->("This is a headline")
2315: #
2316: # - To set up a couple of tags, see sub inittags
2317: #
2318: # NOTES:
2319: # - Empty elements, such as <br/> are correctly terminated,
2320: # i.e. htmltag('br') returns <br/>
2321: # - Empty attributes (title="") are filtered out.
2322: # - The function will not check for deprecated attributes.
2323: #
2324: # OUTPUT: content enclosed in xhtml conform tags
2325: sub htmltag{
2326: return
2327: qq|<$_[0]|
2328: . join( '', map { qq| $_="${$_[2]}{$_}"| if ${$_[2]}{$_} } keys %{ $_[2] } )
2329: . ($_[1] ? qq|>$_[1]</$_[0]>| : qq|/>|). "\n";
2330: };
2331:
2332:
2333: # USAGE: inittags(@tags);
2334: #
2335: # EXAMPLES:
2336: # - my ($h1, $h2, $h3) = inittags( qw( h1 h2 h3 ) )
2337: # $h1->("This is a headline") #Returns: <h1>This is a headline</h1>
2338: #
2339: # NOTES: See sub htmltag for further information.
2340: #
2341: # OUTPUT: List of subroutines.
2342: sub inittags {
2343: my @tags = @_;
2344: return map { my $tag = $_;
2345: sub { return htmltag( $tag, @_ ) }
2346: } @tags;
2347: }
2348:
2349:
2350: # USAGE: scripttag(scriptcode, [start|end|both]);
2351: #
2352: # EXAMPLES:
2353: # - scripttag("alert('Hello World!')", 'both')
2354: # returns:
2355: # <script type="text/javascript">
2356: # // BEGIN LON-CAPA Internal
2357: # alert(Hello World!')
2358: # // END LON-CAPA Internal
2359: # </script>
2360: #
2361: # NOTES:
2362: # - works currently only for javascripts
2363: #
2364: # OUTPUT:
2365: # Scriptcode properly enclosed in <script> and CDATA tags (and LC
2366: # Internal markers if 2nd argument is given)
2367: sub scripttag {
2368: my ( $content, $marker ) = @_;
2369: return unless defined $content;
2370:
2371: my $begin = "\n// BEGIN LON-CAPA Internal\n";
2372: my $end = "\n// END LON-CAPA Internal\n";
2373:
2374: if ($marker) {
2375: $content = $begin . $content if $marker eq 'start' or $marker eq 'both';
2376: $content .= $end if $marker eq 'end' or $marker eq 'both';
2377: }
2378:
2379: $content = "\n// <![CDATA[\n$content\n// ]]>\n";
2380:
2381: return htmltag('script', $content, {type => 'text/javascript'});
2382: };
2383:
2384:
2385: =item list_from_array( \@array, { listattr =>{}, itemattr =>{} } )
2386:
2387: Constructs a XHTML list from \@array.
2388:
2389: input:
2390:
2391: =over
2392:
2393: =item \@array
2394:
2395: A reference to the array containing text that will be wrapped in <li></li> tags.
2396:
2397: =item { listattr => {}, itemattr =>{} }
2398:
2399: Attributes for <ul> and <li> passed in as hash references.
2400: See htmltag() for more details.
2401:
2402: =back
2403:
2404: returns: XHTML list as String.
2405:
2406: =cut
2407:
2408: # \@items, {listattr => { class => 'abc', id => 'xyx' }, itemattr => {class => 'abc', id => 'xyx'}}
2409: sub list_from_array {
2410: my ($items, $args) = @_;
2411: return unless scalar @$items;
2412: my ($ul, $li) = inittags( qw(ul li) );
2413: my $listitems = join '', map { $li->($_, $args->{itemattr}) } @$items;
2414: return $ul->( $listitems, $args->{listattr} );
2415: }
2416:
2417:
2418: ##############################################
2419: ##############################################
2420:
2421: # generate_menu
2422: #
2423: # Generates html markup for a menu.
2424: #
2425: # Inputs:
2426: # An array of following structure:
2427: # ({ categorytitle => 'Categorytitle',
2428: # items => [
2429: # {
2430: # linktext => 'Text to be displayed',
2431: # url => 'URL the link is pointing to, i.e. /adm/site?action=dosomething',
2432: # permission => 'Contains permissions as returned from lonnet::allowed(),
2433: # must evaluate to true in order to activate the link',
2434: # icon => 'icon filename',
2435: # alttext => 'alt text for the icon',
2436: # help => 'Name of the corresponding helpfile',
2437: # linktitle => 'Description of the link (used for title tag)'
2438: # },
2439: # ...
2440: # ]
2441: # },
2442: # ...
2443: # )
2444: #
2445: # Outputs: A scalar containing the html markup for the menu.
2446:
2447: sub generate_menu {
2448: my @menu = @_;
2449: # subs for specific html elements
2450: my ($h3, $div, $ul, $li, $a, $img) = inittags( qw(h3 div ul li a img) );
2451:
2452: my @categories; # each element represents the entire markup for a category
2453:
2454: foreach my $category (@menu) {
2455: my @links; # contains the links for the current $category
2456: foreach my $link (@{$$category{items}}) {
2457: next unless $$link{permission};
2458:
2459: # create the markup for the current $link and push it into @links.
2460: # each entry consists of an image and a text optionally followed
2461: # by a help link.
2462: push(@links,$li->(
2463: $a->(
2464: $img->("", {
2465: class => "LC_noBorder LC_middle",
2466: src => "/res/adm/pages/$$link{icon}",
2467: alt => mt(defined($$link{alttext}) ?
2468: $$link{alttext} : $$link{linktext})
2469: }), {
2470: href => $$link{url},
2471: title => mt($$link{linktitle})
2472: }).
2473: $a->(mt($$link{linktext}), {
2474: href => $$link{url},
2475: title => mt($$link{linktitle}),
2476: class => "LC_menubuttons_link"
2477: }).
2478: (defined($$link{help}) ?
2479: Apache::loncommon::help_open_topic($$link{help}) : ''),
2480: {class => "LC_menubuttons_inline_text"}));
2481: }
2482:
2483: # wrap categorytitle in <h3>, concatenate with
2484: # joined and in <ul> tags wrapped @links
2485: # and wrap everything in an enclosing <div> and push it into
2486: # @categories
2487: # such that each element looks like:
2488: # <div><h3>title</h3><ul><li>...</li>...</ul></div>
2489: # the category won't be added if there aren't any links
2490: push(@categories,
2491: $div->($h3->(mt($$category{categorytitle}), {class=>"LC_hcell"}).
2492: $ul->(join('' ,@links), {class =>"LC_ListStyleNormal" }),
2493: {class=>"LC_Box LC_400Box"})) if scalar(@links);
2494: }
2495:
2496: # wrap the joined @categories in another <div> (column layout)
2497: return $div->(join('', @categories), {class => "LC_columnSection"});
2498: }
2499:
2500: ##############################################
2501: ##############################################
2502:
2503: =pod
2504:
2505: =item &start_funclist
2506:
2507: Start list of available functions
2508:
2509: Typically used to offer a simple list of available functions
2510: at top or bottom of page.
2511: All available functions/actions for the current page
2512: should be included in this list.
2513:
2514: If the optional headline text is not provided, a default text will be used.
2515:
2516:
2517: Related routines:
2518: =over 4
2519: add_item_funclist
2520: end_funclist
2521: =back
2522:
2523:
2524: Inputs: (optional) headline text
2525:
2526: Returns: HTML code with function list start
2527:
2528: =cut
2529:
2530: ##############################################
2531: ##############################################
2532:
2533: sub start_funclist {
2534: my($legendtext)=@_;
2535: $legendtext=&mt('Functions') if !$legendtext;
2536: return '<ul class="LC_funclist"><li style="font-weight:bold; margin-left:0.8em;">'.$legendtext.'</li>'."\n";
2537: }
2538:
2539:
2540: ##############################################
2541: ##############################################
2542:
2543: =pod
2544:
2545: =item &add_item_funclist
2546:
2547: Adds an item to the list of available functions
2548:
2549: Related routines:
2550: =over 4
2551: start_funclist
2552: end_funclist
2553: =back
2554:
2555: Inputs: content item with text and link to function
2556:
2557: Returns: HTML code with list item for funclist
2558:
2559: =cut
2560:
2561: ##############################################
2562: ##############################################
2563:
2564: sub add_item_funclist {
2565: my($content) = @_;
2566: return '<li>'.$content.'</li>'."\n";
2567: }
2568:
2569: =pod
2570:
2571: =item &end_funclist
2572:
2573: End list of available functions
2574:
2575: Related routines:
2576: =over 4
2577: start_funclist
2578: add_item_funclist
2579: =back
2580:
2581: Inputs: ./.
2582:
2583: Returns: HTML code with function list end
2584: =cut
2585:
2586: sub end_funclist {
2587: return "</ul>\n";
2588: }
2589:
2590: =pod
2591:
2592: =item funclist_from_array( \@array, {legend => 'text for legend'} )
2593:
2594: Constructs a XHTML list from \@array with the first item being visually
2595: highlighted and set to the value of legend or 'Functions' if legend is
2596: empty.
2597:
2598: =over
2599:
2600: =item \@array
2601:
2602: A reference to the array containing text that will be wrapped in <li></li> tags.
2603:
2604: =item { legend => 'text' }
2605:
2606: A string that's used as visually highlighted first item. 'Functions' is used if
2607: it's value evaluates to false.
2608:
2609: =back
2610:
2611: returns: XHTML list as string.
2612:
2613: =back
2614:
2615: =cut
2616:
2617: sub funclist_from_array {
2618: my ($items, $args) = @_;
2619: $args->{legend} ||= mt('Functions');
2620: return list_from_array( [$args->{legend}, @$items],
2621: { listattr => {class => 'LC_funclist'} });
2622: }
2623:
2624: 1;
2625:
2626: __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