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