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