File:
[LON-CAPA] /
loncom /
interface /
lonhtmlcommon.pm
Revision
1.301:
download - view:
text,
annotated -
select for diffs
Wed Feb 22 10:18:26 2012 UTC (12 years, 3 months ago) by
foxr
Branches:
MAIN
CVS tags:
HEAD
bz874 Include jpicker and bind it to all colorchooser class inputs.
Note that if you add other colorchooser class elements you need to
post fixup the values to ensure they start with x or any other required
leading characer as jpicker will just put the hex rgb values
1: # The LearningOnline Network with CAPA
2: # a pile of common html routines
3: #
4: # $Id: lonhtmlcommon.pm,v 1.301 2012/02/22 10:18:26 foxr 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: <script type="text/javascript" src="/adm/jpicker/js/jpicker-1.1.6.min.js" >
1174: </script>
1175: <link rel="stylesheet" type="text/css" href="/adm/jpicker/css/jPicker-1.1.6.min.css" />
1176: ENDJQUERY
1177: return $s;
1178: }
1179:
1180: # ----------------------------------------------------------------- Preferences
1181:
1182: # ------------------------------------------------- lang to use in html editor
1183: sub htmlarea_lang {
1184: my $lang='en';
1185: if (&mt('htmlarea_lang') ne 'htmlarea_lang') {
1186: $lang=&mt('htmlarea_lang');
1187: }
1188: return $lang;
1189: }
1190:
1191: # ----------------------------------------- Script to activate only some fields
1192:
1193: sub htmlareaselectactive {
1194: my ($args) = @_;
1195: unless (&htmlareabrowser()) { return ''; }
1196: my $output='<script type="text/javascript" defer="defer">'."\n"
1197: .'// <![CDATA['."\n";
1198: my $lang = &htmlarea_lang();
1199: my $fullpage = 'false';
1200: my ($dragmath_prefix,$dragmath_helpicon,$dragmath_whitespace);
1201: if (ref($args) eq 'HASH') {
1202: if (exists($args->{'lang'})) {
1203: if ($args->{'lang'} ne '') {
1204: $lang = $args->{'lang'};
1205: }
1206: }
1207: if (exists($args->{'fullpage'})) {
1208: if ($args->{'fullpage'} eq 'true') {
1209: $fullpage = $args->{'fullpage'};
1210: }
1211: }
1212: if (exists($args->{'dragmath'})) {
1213: if ($args->{'dragmath'} ne '') {
1214: $dragmath_prefix = $args->{'dragmath'};
1215: $dragmath_helpicon=&Apache::loncommon::lonhttpdurl("/adm/help/help.png");
1216: $dragmath_whitespace=&Apache::loncommon::lonhttpdurl("/adm/lonIcons/transparent1x1.gif");
1217: }
1218: }
1219: }
1220: $output.='
1221:
1222: function containsBlockHtml(id) {
1223: 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);
1224: return (re >= 0);
1225: }
1226:
1227: function startRichEditor(id) {
1228: CKEDITOR.replace(id,
1229: {
1230: customConfig: "/ckeditor/loncapaconfig.js",
1231: language : "'.$lang.'",
1232: fullPage : '.$fullpage.',
1233: }
1234: );
1235: }
1236:
1237: function destroyRichEditor(id) {
1238: CKEDITOR.instances[id].destroy();
1239: }
1240:
1241: function editorHandler(event) {
1242: var rawid = $(this).attr("id");
1243: var id = new RegExp("LC_rt_(.*)").exec(rawid)[1];
1244: event.preventDefault();
1245: var rt_enabled = $(this).hasClass("LC_enable_rt");
1246: if (rt_enabled) {
1247: startRichEditor(id);
1248: $("#LC_rt_"+id).html("<b>« Plain text</b>");
1249: $("#LC_rt_"+id).attr("title", "Disable rich text formatting and edit in plain text");
1250: $("#LC_rt_"+id).addClass("LC_disable_rt");
1251: $("#LC_rt_"+id).removeClass("LC_enable_rt");
1252: } else {
1253: destroyRichEditor(id);
1254: $("#LC_rt_"+id).html("<b>Rich formatting »</b>");
1255: $("#LC_rt_"+id).attr("title", "Enable rich text formatting (bold, italic, etc.)");
1256: $("#LC_rt_"+id).addClass("LC_enable_rt");
1257: $("#LC_rt_"+id).removeClass("LC_disable_rt");
1258: }';
1259: if ($dragmath_prefix ne '') {
1260: $output .= "\n var visible = '';
1261: if (rt_enabled) {
1262: visible = 'none';
1263: }
1264: editmath_visibility(id,visible);\n";
1265: }
1266: $output .= '
1267: }
1268: $(document).ready(function(){
1269: $(".LC_richAlwaysOn").each(function() {
1270: startRichEditor($(this).attr("id"));
1271: });
1272: $(".LC_richDetectHtml").each(function() {
1273: var id = $(this).attr("id");
1274: var rt_enabled = containsBlockHtml(id);
1275: if(rt_enabled) {
1276: $(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>");
1277: startRichEditor(id);
1278: $("#LC_rt_"+id).click(editorHandler);
1279: }
1280: else {
1281: $(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>");
1282: $("#LC_rt_"+id).click(editorHandler);
1283: }';
1284: if ($dragmath_prefix ne '') {
1285: $output .= "\n var visible = '';
1286: if (rt_enabled) {
1287: visible = 'none';
1288: }
1289: editmath_visibility(id,visible);\n";
1290: }
1291: $output .= '
1292: });
1293: $(".LC_richDefaultOn").each(function() {
1294: var id = $(this).attr("id");
1295: $(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>");
1296: startRichEditor(id);
1297: $("#LC_rt_"+id).click(editorHandler);
1298: });
1299: $(".LC_richDefaultOff").each(function() {
1300: var id = $(this).attr("id");
1301: $(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>");
1302: $("#LC_rt_"+id).click(editorHandler);
1303: });
1304: $.fn.jPicker.defaults.images.clientPath="/adm/jpicker/images/";
1305: $(".colorchooser").jPicker();
1306:
1307: c });
1308: ';
1309: if ($dragmath_prefix ne '') {
1310: $output .= '
1311:
1312: function editmath_visibility(id,value) {
1313:
1314: if ((id == "") || (id == null)) {
1315: return;
1316: }
1317: var mathid = "'.$dragmath_prefix.'_"+id;
1318: mathele = document.getElementById(mathid);
1319: if (mathele == null) {
1320: return;
1321: }
1322: mathele.style.display = value;
1323: var mathhelpicon = "'.$dragmath_prefix.'helpicon'.'_"+id;
1324: mathhelpiconele = document.getElementById(mathhelpicon);
1325: if (mathhelpiconele == null) {
1326: return;
1327: }
1328: if (value == "none") {
1329: mathhelpiconele.src = "'.$dragmath_whitespace.'";
1330: } else {
1331: mathhelpiconele.src = "'.$dragmath_helpicon.'";
1332: }
1333: }
1334: ';
1335:
1336: }
1337: $output.="\nwindow.status='Activated Editfields';\n"
1338: .'// ]]>'."\n"
1339: .'</script>';
1340: return $output;
1341: }
1342:
1343: # --------------------------------------------------------------------- Blocked
1344:
1345: sub htmlareablocked {
1346: unless ($env{'environment.wysiwygeditor'} eq 'on') { return 1; }
1347: return 0;
1348: }
1349:
1350: # ---------------------------------------- Browser capable of running HTMLArea?
1351:
1352: sub htmlareabrowser {
1353: return 1;
1354: }
1355:
1356: #
1357: # Should the "return to content" link be shown?
1358: #
1359:
1360: sub show_return_link {
1361:
1362: unless ($env{'request.course.id'}) { return 0; }
1363: if ($env{'request.noversionuri'}=~m{^/priv/} ||
1364: $env{'request.uri'}=~m{^/~}) { return 1; }
1365:
1366: if (($env{'request.noversionuri'} =~ m{^/adm/(viewclasslist|navmaps)($|\?)})
1367: || ($env{'request.noversionuri'} =~ m{^/adm/.*/aboutme($|\?)})) {
1368:
1369: return if ($env{'form.register'});
1370: }
1371: return (($env{'request.noversionuri'}=~m{^/(res|public)/} &&
1372: $env{'request.symb'} eq '')
1373: ||
1374: ($env{'request.noversionuri'}=~ m{^/cgi-bin/printout.pl})
1375: ||
1376: (($env{'request.noversionuri'}=~/^\/adm\//) &&
1377: ($env{'request.noversionuri'}!~/^\/adm\/wrapper\//) &&
1378: ($env{'request.noversionuri'}!~
1379: m{^/adm/.*/(smppg|bulletinboard)($|\?)})
1380: ));
1381: }
1382:
1383:
1384: ############################################################
1385: ############################################################
1386:
1387: =pod
1388:
1389: =item breadcrumbs
1390:
1391: Compiles the previously registered breadcrumbs into an series of links.
1392: Additionally supports a 'component', which will be displayed on the
1393: right side of the breadcrumbs enclosing div (without a link).
1394: A link to help for the component will be included if one is specified.
1395:
1396: All inputs can be undef without problems.
1397:
1398: Inputs: $component (the text on the right side of the breadcrumbs trail),
1399: $component_help
1400: $menulink (boolean, controls whether to include a link to /adm/menu)
1401: $helplink (if 'nohelp' don't include the orange help link)
1402: $css_class (optional name for the class to apply to the table for CSS)
1403: $no_mt (optional flag, 1 if &mt() is _not_ to be applied to $component
1404: when including the text on the right.
1405: Returns a string containing breadcrumbs for the current page.
1406:
1407: =item clear_breadcrumbs
1408:
1409: Clears the previously stored breadcrumbs.
1410:
1411: =item add_breadcrumb
1412:
1413: Pushes a breadcrumb on the stack of crumbs.
1414:
1415: input: $breadcrumb, a hash reference. The keys 'href','title', and 'text'
1416: are required. If present the keys 'faq' and 'bug' will be used to provide
1417: links to the FAQ and bug sites. If the key 'no_mt' is present the 'title'
1418: and 'text' values won't be sent through &mt()
1419:
1420: returns: nothing
1421:
1422: =cut
1423:
1424: ############################################################
1425: ############################################################
1426: {
1427: my @Crumbs;
1428: my %tools = ();
1429:
1430: sub breadcrumbs {
1431: my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt, $CourseBreadcrumbs) = @_;
1432: #
1433: $css_class ||= 'LC_breadcrumbs';
1434:
1435: # Make the faq and bug data cascade
1436: my $faq = '';
1437: my $bug = '';
1438: my $help = '';
1439: # Crumb Symbol
1440: my $crumbsymbol = '»';
1441: # The last breadcrumb does not have a link, so handle it separately.
1442: my $last = pop(@Crumbs);
1443: #
1444: # The first one should be the course or a menu link
1445: if (!defined($menulink)) { $menulink=1; }
1446: if ($menulink) {
1447: my $description = 'Menu';
1448: my $no_mt_descr = 0;
1449: if ((exists($env{'request.course.id'})) &&
1450: ($env{'request.course.id'} ne '') &&
1451: ($env{'course.'.$env{'request.course.id'}.'.description'} ne '')) {
1452: $description =
1453: $env{'course.'.$env{'request.course.id'}.'.description'};
1454: $no_mt_descr = 1;
1455: }
1456: $menulink = { href =>'/adm/menu',
1457: title =>'Go to main menu',
1458: target =>'_top',
1459: text =>$description,
1460: no_mt =>$no_mt_descr, };
1461: if($last) {
1462: #$last set, so we have some crumbs
1463: unshift(@Crumbs,$menulink);
1464: } else {
1465: #only menulink crumb present
1466: $last = $menulink;
1467: }
1468: }
1469: my $links;
1470: if ((&show_return_link) && (!$CourseBreadcrumbs)) {
1471: my $alttext = &mt('Go Back');
1472: $links=&htmltag( 'a',"<img src='/res/adm/pages/reload.png' border='0' style='vertical-align:middle;' alt='$alttext' />",
1473: { href => '/adm/flip?postdata=return:',
1474: title => &mt("Back to most recent content resource") });
1475: $links=&htmltag('li',$links);
1476: }
1477: $links.= join "",
1478: map {
1479: $faq = $_->{'faq'} if (exists($_->{'faq'}));
1480: $bug = $_->{'bug'} if (exists($_->{'bug'}));
1481: $help = $_->{'help'} if (exists($_->{'help'}));
1482:
1483: my $result = $_->{no_mt} ? $_->{text} : &mt($_->{text});
1484:
1485: if ($_->{href}){
1486: $result = &htmltag( 'a', $result,
1487: { href => $_->{href},
1488: title => $_->{no_mt} ? $_->{title} : &mt($_->{title}),
1489: target => $_->{target}, });
1490: }
1491:
1492: $result = &htmltag( 'li', "$result $crumbsymbol");
1493: } @Crumbs;
1494:
1495: #should the last Element be translated?
1496:
1497: my $lasttext = $last->{'no_mt'} ? $last->{'text'}
1498: : mt( $last->{'text'} );
1499:
1500: # last breadcrumb is the first order heading of a page
1501: # for course breadcrumbs it's just bold
1502: $links .= &htmltag( 'li', htmltag($CourseBreadcrumbs ? 'b' : 'h1',
1503: $lasttext), {title => $lasttext});
1504:
1505: my $icons = '';
1506: $faq = $last->{'faq'} if (exists($last->{'faq'}));
1507: $bug = $last->{'bug'} if (exists($last->{'bug'}));
1508: $help = $last->{'help'} if (exists($last->{'help'}));
1509: $component_help=($component_help?$component_help:$help);
1510: # if ($faq ne '') {
1511: # $icons .= &Apache::loncommon::help_open_faq($faq);
1512: # }
1513: # if ($bug ne '') {
1514: # $icons .= &Apache::loncommon::help_open_bug($bug);
1515: # }
1516: if ($faq ne '' || $component_help ne '' || $bug ne '') {
1517: $icons .= &Apache::loncommon::help_open_menu($component,
1518: $component_help,
1519: $faq,$bug);
1520: }
1521: #
1522:
1523:
1524: unless ($CourseBreadcrumbs) {
1525: $links = &htmltag('ol', $links, { id => "LC_MenuBreadcrumbs" });
1526: } else {
1527: $links = &htmltag('ul', $links, { class => "LC_CourseBreadcrumbs" });
1528: }
1529:
1530: if ($component) {
1531: $links = &htmltag('span',
1532: ( $no_mt ? $component : mt($component) ).
1533: ( $icons ? $icons : '' ),
1534: { class => 'LC_breadcrumbs_component' } )
1535: .$links;
1536: }
1537:
1538: &render_tools(\$links);
1539: $links = &htmltag('div', $links,
1540: { id => "LC_breadcrumbs" }) unless ($CourseBreadcrumbs) ;
1541: &render_advtools(\$links);
1542:
1543: # Return the @Crumbs stack to what we started with
1544: push(@Crumbs,$last);
1545: shift(@Crumbs);
1546: # Return the breadcrumb's line
1547: return "$links";
1548: }
1549:
1550: sub clear_breadcrumbs {
1551: undef(@Crumbs);
1552: undef(%tools);
1553: }
1554:
1555: sub add_breadcrumb {
1556: push(@Crumbs,@_);
1557: }
1558:
1559: =item add_breadcrumb_tool($category, $html)
1560:
1561: Adds $html to $category of the breadcrumb toolbar container.
1562:
1563: $html is usually a link to a page that invokes a function on the currently
1564: displayed data (e.g. print when viewing a problem)
1565:
1566: Currently there are 3 possible values for $category:
1567:
1568: =over
1569:
1570: =item navigation
1571: left of breadcrumbs line
1572:
1573: =item tools
1574: right of breadcrumbs line
1575:
1576: =item advtools
1577: advanced tools shown in a separate box below breadcrumbs line
1578:
1579: =back
1580:
1581: returns: nothing
1582:
1583: =cut
1584:
1585: sub add_breadcrumb_tool {
1586: my ($category, @html) = @_;
1587: return unless @html;
1588: if (!keys(%tools)) {
1589: %tools = ( navigation => [], tools => [], advtools => []);
1590: }
1591:
1592: #this cleans data received from lonmenu::innerregister
1593: @html = grep {defined $_ && $_ ne ''} @html;
1594: for (@html) {
1595: s/align="(right|left)"//;
1596: # s/<span.*?\/span>// if $category ne 'advtools';
1597: }
1598:
1599: push @{$tools{$category}}, @html;
1600: }
1601:
1602: =item clear_breadcrumb_tools()
1603:
1604: Clears the breadcrumb toolbar container.
1605:
1606: returns: nothing
1607:
1608: =cut
1609:
1610: sub clear_breadcrumb_tools {
1611: undef(%tools);
1612: }
1613:
1614: =item render_tools(\$breadcrumbs)
1615:
1616: Creates html for breadcrumb tools (categories navigation and tools) and inserts
1617: \$breadcrumbs at the correct position.
1618:
1619: input: \$breadcrumbs - a reference to the string containing prepared
1620: breadcrumbs.
1621:
1622: returns: nothing
1623: =cut
1624:
1625: #TODO might split this in separate functions for each category
1626: sub render_tools {
1627: my ($breadcrumbs) = @_;
1628: return unless (keys(%tools));
1629:
1630: my $navigation = list_from_array($tools{navigation},
1631: { listattr => { class=>"LC_breadcrumb_tools_navigation" } });
1632: my $tools = list_from_array($tools{tools},
1633: { listattr => { class=>"LC_breadcrumb_tools_tools" } });
1634: $$breadcrumbs = list_from_array([$navigation, $tools, $$breadcrumbs],
1635: { listattr => { class=>'LC_breadcrumb_tools_outerlist' } });
1636: }
1637:
1638: =item render_advtools(\$breadcrumbs)
1639:
1640: Creates html for advanced tools (category advtools) and inserts \$breadcrumbs
1641: at the correct position.
1642:
1643: input: \$breadcrumbs - a reference to the string containing prepared
1644: breadcrumbs (after render_tools call).
1645:
1646: returns: nothing
1647: =cut
1648:
1649: sub render_advtools {
1650: my ($breadcrumbs) = @_;
1651: return unless (defined $tools{'advtools'})
1652: and (scalar(@{$tools{'advtools'}}) > 0);
1653:
1654: $$breadcrumbs .= Apache::loncommon::head_subbox(
1655: funclist_from_array($tools{'advtools'}) );
1656: }
1657:
1658: } # End of scope for @Crumbs
1659:
1660: ############################################################
1661: ############################################################
1662:
1663: # Nested table routines.
1664: #
1665: # Routines to display form items in a multi-row table with 2 columns.
1666: # Uses nested tables to divide form elements into segments.
1667: # For examples of use see loncom/interface/lonnotify.pm
1668: #
1669: # Can be used in following order: ...
1670: # &start_pick_box()
1671: # row1
1672: # row2
1673: # row3 ... etc.
1674: # &submit_row()
1675: # &end_pick_box()
1676: #
1677: # where row1, row 2 etc. are chosen from &role_select_row,&course_select_row,
1678: # &status_select_row and &email_default_row
1679: #
1680: # Can also be used in following order:
1681: #
1682: # &start_pick_box()
1683: # &row_title()
1684: # &row_closure()
1685: # &row_title()
1686: # &row_closure() ... etc.
1687: # &submit_row()
1688: # &end_pick_box()
1689: #
1690: # In general a &submit_row() call should proceed the call to &end_pick_box(),
1691: # as this routine adds a button for form submission.
1692: # &submit_row() does not require a &row_closure after it.
1693: #
1694: # &start_pick_box() creates a bounding table with 1-pixel wide black border.
1695: # rows should be placed between calls to &start_pick_box() and &end_pick_box.
1696: #
1697: # &row_title() adds a title in the left column for each segment.
1698: # &row_closure() closes a row with a 1-pixel wide black line.
1699: #
1700: # &role_select_row() provides a select box from which to choose 1 or more roles
1701: # &course_select_row provides ways of picking groups of courses
1702: # radio buttons: all, by category or by picking from a course picker pop-up
1703: # note: by category option is only displayed if a domain has implemented
1704: # selection by year, semester, department, number etc.
1705: #
1706: # &status_select_row() provides a select box from which to choose 1 or more
1707: # access types (current access, prior access, and future access)
1708: #
1709: # &email_default_row() provides text boxes for default e-mail suffixes for
1710: # different authentication types in a domain.
1711: #
1712: # &row_title() and &row_closure() are called internally by the &*_select_row
1713: # routines, but can also be called directly to start and end rows which have
1714: # needs that are not accommodated by the *_select_row() routines.
1715:
1716: { # Start: row_count block for pick_box
1717: my @row_count;
1718:
1719: sub start_pick_box {
1720: my ($css_class) = @_;
1721: if (defined($css_class)) {
1722: $css_class = 'class="'.$css_class.'"';
1723: } else {
1724: $css_class= 'class="LC_pick_box"';
1725: }
1726: unshift(@row_count,0);
1727: my $output = <<"END";
1728: <table $css_class>
1729: END
1730: return $output;
1731: }
1732:
1733: sub end_pick_box {
1734: shift(@row_count);
1735: my $output = <<"END";
1736: </table>
1737: END
1738: return $output;
1739: }
1740:
1741: sub row_headline {
1742: my $output = <<"END";
1743: <tr><td colspan="2">
1744: END
1745: return $output;
1746: }
1747:
1748: sub row_title {
1749: my ($title,$css_title_class,$css_value_class, $css_value_furtherAttributes) = @_;
1750: $row_count[0]++;
1751: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1752: $css_title_class ||= 'LC_pick_box_title';
1753: $css_title_class = 'class="'.$css_title_class.'"';
1754:
1755: $css_value_class ||= 'LC_pick_box_value';
1756:
1757: if ($title ne '') {
1758: $title .= ':';
1759: }
1760: my $output = <<"ENDONE";
1761: <tr class="LC_pick_box_row" $css_value_furtherAttributes>
1762: <td $css_title_class>
1763: $title
1764: </td>
1765: <td class="$css_value_class $css_class">
1766: ENDONE
1767: return $output;
1768: }
1769:
1770: sub row_closure {
1771: my ($no_separator) =@_;
1772: my $output = <<"ENDTWO";
1773: </td>
1774: </tr>
1775: ENDTWO
1776: if (!$no_separator) {
1777: $output .= <<"ENDTWO";
1778: <tr>
1779: <td colspan="2" class="LC_pick_box_separator">
1780: </td>
1781: </tr>
1782: ENDTWO
1783: }
1784: return $output;
1785: }
1786:
1787: } # End: row_count block for pick_box
1788:
1789: sub role_select_row {
1790: my ($roles,$title,$css_class,$show_separate_custom,$cdom,$cnum) = @_;
1791: my $crstype = 'Course';
1792: if ($cdom ne '' && $cnum ne '') {
1793: $crstype = &Apache::loncommon::course_type($cdom.'_'.$cnum);
1794: }
1795: my $output;
1796: if (defined($title)) {
1797: $output = &row_title($title,$css_class);
1798: }
1799: $output .= qq|
1800: <select name="roles" multiple="multiple">\n|;
1801: foreach my $role (@$roles) {
1802: my $plrole;
1803: if ($role eq 'ow') {
1804: $plrole = &mt('Course Owner');
1805: } elsif ($role eq 'cr') {
1806: if ($show_separate_custom) {
1807: if ($cdom ne '' && $cnum ne '') {
1808: my %course_customroles = &course_custom_roles($cdom,$cnum);
1809: foreach my $crrole (sort(keys(%course_customroles))) {
1810: my ($plcrrole) = ($crrole =~ m|^cr/[^/]+/[^/]+/(.+)$|);
1811: $output .= ' <option value="'.$crrole.'">'.$plcrrole.
1812: '</option>';
1813: }
1814: }
1815: } else {
1816: $plrole = &mt('Custom Role');
1817: }
1818: } else {
1819: $plrole=&Apache::lonnet::plaintext($role,$crstype);
1820: }
1821: if (($role ne 'cr') || (!$show_separate_custom)) {
1822: $output .= ' <option value="'.$role.'">'.$plrole.'</option>';
1823: }
1824: }
1825: $output .= qq| </select>\n|;
1826: if (defined($title)) {
1827: $output .= &row_closure();
1828: }
1829: return $output;
1830: }
1831:
1832: sub course_select_row {
1833: my ($title,$formname,$totcodes,$codetitles,$idlist,$idlist_titles,
1834: $css_class,$crstype,$standardnames) = @_;
1835: my $output = &row_title($title,$css_class);
1836: $output .= &course_selection($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype,$standardnames);
1837: $output .= &row_closure();
1838: return $output;
1839: }
1840:
1841: sub course_selection {
1842: my ($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype,$standardnames) = @_;
1843: my $output = qq|
1844: <script type="text/javascript">
1845: // <![CDATA[
1846: function coursePick (formname) {
1847: for (var i=0; i<formname.coursepick.length; i++) {
1848: if (formname.coursepick[i].value == 'category') {
1849: courseSet('');
1850: }
1851: if (!formname.coursepick[i].checked) {
1852: if (formname.coursepick[i].value == 'specific') {
1853: formname.coursetotal.value = 0;
1854: formname.courselist = '';
1855: }
1856: }
1857: }
1858: }
1859: function setPick (formname) {
1860: for (var i=0; i<formname.coursepick.length; i++) {
1861: if (formname.coursepick[i].value == 'category') {
1862: formname.coursepick[i].checked = true;
1863: }
1864: formname.coursetotal.value = 0;
1865: formname.courselist = '';
1866: }
1867: }
1868: // ]]>
1869: </script>
1870: |;
1871:
1872: my ($allcrs,$pickspec);
1873: if ($crstype eq 'Community') {
1874: $allcrs = &mt('All communities');
1875: $pickspec = &mt('Pick specific communities:');
1876: } else {
1877: $allcrs = &mt('All courses');
1878: $pickspec = &mt('Pick specific course(s):');
1879: }
1880:
1881: my $courseform='<b>'.&Apache::loncommon::selectcourse_link
1882: ($formname,'pickcourse','pickdomain','coursedesc','',1,$crstype).'</b>';
1883: $output .= '<input type="radio" name="coursepick" value="all" onclick="coursePick(this.form)" />'.$allcrs.'<br />';
1884: if ($totcodes > 0) {
1885: my $numtitles = @$codetitles;
1886: if ($numtitles > 0) {
1887: $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 />';
1888: $output .= '<table><tr><td>'.$$codetitles[0].'<br />'."\n".
1889: '<select name="'.$standardnames->[0].
1890: '" onChange="setPick(this.form);courseSet('."'$$codetitles[0]'".')">'."\n".
1891: ' <option value="-1" />Select'."\n";
1892: my @items = ();
1893: my @longitems = ();
1894: if ($$idlist{$$codetitles[0]} =~ /","/) {
1895: @items = split(/","/,$$idlist{$$codetitles[0]});
1896: } else {
1897: $items[0] = $$idlist{$$codetitles[0]};
1898: }
1899: if (defined($$idlist_titles{$$codetitles[0]})) {
1900: if ($$idlist_titles{$$codetitles[0]} =~ /","/) {
1901: @longitems = split(/","/,$$idlist_titles{$$codetitles[0]});
1902: } else {
1903: $longitems[0] = $$idlist_titles{$$codetitles[0]};
1904: }
1905: for (my $i=0; $i<@longitems; $i++) {
1906: if ($longitems[$i] eq '') {
1907: $longitems[$i] = $items[$i];
1908: }
1909: }
1910: } else {
1911: @longitems = @items;
1912: }
1913: for (my $i=0; $i<@items; $i++) {
1914: $output .= ' <option value="'.$items[$i].'">'.$longitems[$i].'</option>';
1915: }
1916: $output .= '</select></td>';
1917: for (my $i=1; $i<$numtitles; $i++) {
1918: $output .= '<td>'.$$codetitles[$i].'<br />'."\n".
1919: '<select name="'.$standardnames->[$i].
1920: '" onChange="courseSet('."'$$codetitles[$i]'".')">'."\n".
1921: '<option value="-1"><-Pick '.$$codetitles[$i-1].'</option>'."\n".
1922: '</select>'."\n".
1923: '</td>';
1924: }
1925: $output .= '</tr></table><br />';
1926: }
1927: }
1928: $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";
1929: return $output;
1930: }
1931:
1932: sub status_select_row {
1933: my ($types,$title,$css_class) = @_;
1934: my $output;
1935: if (defined($title)) {
1936: $output = &row_title($title,$css_class,'LC_pick_box_select');
1937: }
1938: $output .= qq|
1939: <select name="types" multiple="multiple">\n|;
1940: foreach my $status_type (sort(keys(%{$types}))) {
1941: $output .= ' <option value="'.$status_type.'">'.$$types{$status_type}.'</option>';
1942: }
1943: $output .= qq| </select>\n|;
1944: if (defined($title)) {
1945: $output .= &row_closure();
1946: }
1947: return $output;
1948: }
1949:
1950: sub email_default_row {
1951: my ($authtypes,$title,$descrip,$css_class) = @_;
1952: my $output = &row_title($title,$css_class);
1953: $output .= $descrip.
1954: &Apache::loncommon::start_data_table().
1955: &Apache::loncommon::start_data_table_header_row().
1956: '<th>'.&mt('Authentication Method').'</th>'.
1957: '<th align="right">'.&mt('Username -> e-mail conversion').'</th>'."\n".
1958: &Apache::loncommon::end_data_table_header_row();
1959: my $rownum = 0;
1960: foreach my $auth (sort(keys(%{$authtypes}))) {
1961: my ($userentry,$size);
1962: if ($auth =~ /^krb/) {
1963: $userentry = '';
1964: $size = 25;
1965: } else {
1966: $userentry = 'username@';
1967: $size = 15;
1968: }
1969: $output .= &Apache::loncommon::start_data_table_row().
1970: '<td> '.$$authtypes{$auth}.'</td>'.
1971: '<td align="right">'.$userentry.
1972: '<input type="text" name="'.$auth.'" size="'.$size.'" /></td>'.
1973: &Apache::loncommon::end_data_table_row();
1974: }
1975: $output .= &Apache::loncommon::end_data_table();
1976: $output .= &row_closure();
1977: return $output;
1978: }
1979:
1980:
1981: sub submit_row {
1982: my ($title,$cmd,$submit_text,$css_class) = @_;
1983: my $output = &row_title($title,$css_class,'LC_pick_box_submit');
1984: $output .= qq|
1985: <br />
1986: <input type="hidden" name="command" value="$cmd" />
1987: <input type="submit" value="$submit_text"/>
1988: <br /><br />
1989: \n|;
1990: return $output;
1991: }
1992:
1993: sub course_custom_roles {
1994: my ($cdom,$cnum) = @_;
1995: my %returnhash=();
1996: my %coursepersonnel=&Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
1997: foreach my $person (sort(keys(%coursepersonnel))) {
1998: my ($role) = ($person =~ /^([^:]+):/);
1999: my ($end,$start) = split(/:/,$coursepersonnel{$person});
2000: if ($end == -1 && $start == -1) {
2001: next;
2002: }
2003: if ($role =~ m|^cr/[^/]+/[^/]+/[^/]|) {
2004: $returnhash{$role} ++;
2005: }
2006: }
2007: return %returnhash;
2008: }
2009:
2010:
2011: sub resource_info_box {
2012: my ($symb,$onlyfolderflag,$stuvcurrent,$stuvdisp)=@_;
2013: my $return='';
2014: if ($stuvcurrent ne '') {
2015: $return = '<div class="LC_left_float">';
2016: }
2017: if ($symb) {
2018: $return.=&Apache::loncommon::start_data_table();
2019: my ($map,$id,$resource)=&Apache::lonnet::decode_symb($symb);
2020: my $folder=&Apache::lonnet::gettitle($map);
2021: $return.=&Apache::loncommon::start_data_table_row().
2022: '<th align="left">'.&mt('Folder:').'</th><td>'.$folder.'</td>'.
2023: &Apache::loncommon::end_data_table_row();
2024: unless ($onlyfolderflag) {
2025: $return.=&Apache::loncommon::start_data_table_row().
2026: '<th align="left">'.&mt('Resource:').'</th><td>'.&Apache::lonnet::gettitle($symb).'</td>'.
2027: &Apache::loncommon::end_data_table_row();
2028: }
2029: if ($stuvcurrent ne '') {
2030: $return .= &Apache::loncommon::start_data_table_row().
2031: '<th align="left">'.&mt("Student's current version:").'</th><td>'.$stuvcurrent.'</td>'.
2032: &Apache::loncommon::end_data_table_row();
2033: }
2034: if ($stuvdisp ne '') {
2035: $return .= &Apache::loncommon::start_data_table_row().
2036: '<th align="left">'.&mt("Student's version displayed:").'</th><td>'.$stuvdisp.'</td>'.
2037: &Apache::loncommon::end_data_table_row();
2038: }
2039: $return.=&Apache::loncommon::end_data_table();
2040: } else {
2041: $return='<p><span class="LC_error">'.&mt('No context provided.').'</span></p>';
2042: }
2043: if ($stuvcurrent ne '') {
2044: $return .= '</div>';
2045: }
2046: return $return;
2047: }
2048:
2049: ##############################################
2050: ##############################################
2051:
2052: # topic_bar
2053: #
2054: # Generates a div containing an (optional) number with a white background followed by a
2055: # title with a background color defined in the corresponding CSS: LC_topic_bar
2056: # Inputs:
2057: # 1. number to display.
2058: # If input for number is empty only the title will be displayed.
2059: # 2. title text to display.
2060: # Outputs - a scalar containing html mark-up for the div.
2061:
2062: sub topic_bar {
2063: my ($num,$title) = @_;
2064: my $number = '';
2065: if ($num ne '') {
2066: $number = '<span>'.$num.'</span>';
2067: }
2068: return '<div class="LC_topic_bar">'.$number.$title.'</div>';
2069: }
2070:
2071: ##############################################
2072: ##############################################
2073: # echo_form_input
2074: #
2075: # Generates html markup to add form elements from the referrer page
2076: # as hidden form elements (values encoded) in the new page.
2077: #
2078: # Intended to support two types of use
2079: # (a) to allow backing up to earlier pages in a multi-page
2080: # form submission process using a breadcrumb trail.
2081: #
2082: # (b) to allow the current page to be reloaded with form elements
2083: # set on previous page to remain unchanged. An example would
2084: # be where the a page containing a dynamically-built table of data is
2085: # is to be redisplayed, with only the sort order of the data changed.
2086: #
2087: # Inputs:
2088: # 1. Reference to array of form elements in the submitted form on
2089: # the referrer page which are to be excluded from the echoed elements.
2090: #
2091: # 2. Reference to array of regular expressions, which if matched in the
2092: # name of the form element n the referrer page will be omitted from echo.
2093: #
2094: # Outputs: A scalar containing the html markup for the echoed form
2095: # elements (all as hidden elements, with values encoded).
2096:
2097:
2098: sub echo_form_input {
2099: my ($excluded,$regexps) = @_;
2100: my $output = '';
2101: foreach my $key (keys(%env)) {
2102: if ($key =~ /^form\.(.+)$/) {
2103: my $name = $1;
2104: my $match = 0;
2105: if (ref($excluded) eq 'ARRAY') {
2106: next if (grep(/^\Q$name\E$/,@{$excluded}));
2107: }
2108: if (ref($regexps) eq 'ARRAY') {
2109: if (@{$regexps} > 0) {
2110: foreach my $regexp (@{$regexps}) {
2111: if ($name =~ /$regexp/) {
2112: $match = 1;
2113: last;
2114: }
2115: }
2116: }
2117: }
2118: next if ($match);
2119: if (ref($env{$key}) eq 'ARRAY') {
2120: foreach my $value (@{$env{$key}}) {
2121: $value = &HTML::Entities::encode($value,'<>&"');
2122: $output .= '<input type="hidden" name="'.$name.
2123: '" value="'.$value.'" />'."\n";
2124: }
2125: } else {
2126: my $value = &HTML::Entities::encode($env{$key},'<>&"');
2127: $output .= '<input type="hidden" name="'.$name.
2128: '" value="'.$value.'" />'."\n";
2129: }
2130: }
2131: }
2132: return $output;
2133: }
2134:
2135: ##############################################
2136: ##############################################
2137: # set_form_elements
2138: #
2139: # Generates javascript to set form elements to values based on
2140: # corresponding values for the same form elements when the page was
2141: # previously submitted.
2142: #
2143: # Last submission values are read from hidden form elements in referring
2144: # page which have the same name, i.e., generated by &echo_form_input().
2145: #
2146: # Intended to be called by onload event.
2147: #
2148: # Inputs:
2149: # (a) Reference to hash of echoed form elements to be set.
2150: #
2151: # In the hash, keys are the form element names, and the values are the
2152: # element type (selectbox, radio, checkbox or text -for textbox, textarea or
2153: # hidden).
2154: #
2155: # (b) Optional reference to hash of stored elements to be set.
2156: #
2157: # If the page being displayed is a page which permits modification of
2158: # previously stored data, e.g., the first page in a multi-page submission,
2159: # then if stored is supplied, form elements will be set to the last stored
2160: # values. If user supplied values are also available for the same elements
2161: # these will replace the stored values.
2162: #
2163: # Output:
2164: #
2165: # javascript function - set_form_elements() which sets form elements,
2166: # expects an argument: formname - the name of the form according to
2167: # the DOM, e.g., document.compose
2168:
2169: sub set_form_elements {
2170: my ($elements,$stored) = @_;
2171: my %values;
2172: my $output .= 'function setFormElements(courseForm) {
2173: ';
2174: if (defined($stored)) {
2175: foreach my $name (keys(%{$stored})) {
2176: if (exists($$elements{$name})) {
2177: if (ref($$stored{$name}) eq 'ARRAY') {
2178: $values{$name} = $$stored{$name};
2179: } else {
2180: @{$values{$name}} = ($$stored{$name});
2181: }
2182: }
2183: }
2184: }
2185:
2186: foreach my $key (keys(%env)) {
2187: if ($key =~ /^form\.(.+)$/) {
2188: my $name = $1;
2189: if (exists($$elements{$name})) {
2190: @{$values{$name}} = &Apache::loncommon::get_env_multiple($key);
2191: }
2192: }
2193: }
2194:
2195: foreach my $name (keys(%values)) {
2196: for (my $i=0; $i<@{$values{$name}}; $i++) {
2197: $values{$name}[$i] = &HTML::Entities::decode($values{$name}[$i],'<>&"');
2198: $values{$name}[$i] =~ s/([\r\n\f]+)/\\n/g;
2199: $values{$name}[$i] =~ s/"/\\"/g;
2200: }
2201: if (($$elements{$name} eq 'text') || ($$elements{$name} eq 'hidden')) {
2202: my $numvalues = @{$values{$name}};
2203: if ($numvalues > 1) {
2204: my $valuestring = join('","',@{$values{$name}});
2205: $output .= qq|
2206: var textvalues = new Array ("$valuestring");
2207: var total = courseForm.elements['$name'].length;
2208: if (total > $numvalues) {
2209: total = $numvalues;
2210: }
2211: for (var i=0; i<total; i++) {
2212: courseForm.elements['$name']\[i].value = textvalues[i];
2213: }
2214: |;
2215: } else {
2216: $output .= qq|
2217: courseForm.elements['$name'].value = "$values{$name}[0]";
2218: |;
2219: }
2220: } else {
2221: $output .= qq|
2222: var elementLength = courseForm.elements['$name'].length;
2223: if (elementLength==undefined) {
2224: |;
2225: foreach my $value (@{$values{$name}}) {
2226: if ($$elements{$name} eq 'selectbox') {
2227: $output .= qq|
2228: if (courseForm.elements['$name'].options[0].value == "$value") {
2229: courseForm.elements['$name'].options[0].selected = true;
2230: }|;
2231: } elsif (($$elements{$name} eq 'radio') ||
2232: ($$elements{$name} eq 'checkbox')) {
2233: $output .= qq|
2234: if (courseForm.elements['$name'].value == "$value") {
2235: courseForm.elements['$name'].checked = true;
2236: } else {
2237: courseForm.elements['$name'].checked = false;
2238: }|;
2239: }
2240: }
2241: $output .= qq|
2242: }
2243: else {
2244: for (var i=0; i<courseForm.elements['$name'].length; i++) {
2245: |;
2246: if ($$elements{$name} eq 'selectbox') {
2247: $output .= qq|
2248: courseForm.elements['$name'].options[i].selected = false;|;
2249: } elsif (($$elements{$name} eq 'radio') ||
2250: ($$elements{$name} eq 'checkbox')) {
2251: $output .= qq|
2252: courseForm.elements['$name']\[i].checked = false;|;
2253: }
2254: $output .= qq|
2255: }
2256: for (var j=0; j<courseForm.elements['$name'].length; j++) {
2257: |;
2258: foreach my $value (@{$values{$name}}) {
2259: if ($$elements{$name} eq 'selectbox') {
2260: $output .= qq|
2261: if (courseForm.elements['$name'].options[j].value == "$value") {
2262: courseForm.elements['$name'].options[j].selected = true;
2263: }|;
2264: } elsif (($$elements{$name} eq 'radio') ||
2265: ($$elements{$name} eq 'checkbox')) {
2266: $output .= qq|
2267: if (courseForm.elements['$name']\[j].value == "$value") {
2268: courseForm.elements['$name']\[j].checked = true;
2269: }|;
2270: }
2271: }
2272: $output .= qq|
2273: }
2274: }
2275: |;
2276: }
2277: }
2278: $output .= "
2279: return;
2280: }\n";
2281: return $output;
2282: }
2283:
2284: ##############################################
2285: ##############################################
2286:
2287: sub file_submissionchk_js {
2288: my ($turninpaths,$multiples) = @_;
2289: my $overwritewarn = &mt('File(s) you uploaded for your submission will overwrite existing file(s) submitted for this item').'\\n'.
2290: &mt('Continue submission and overwrite the file(s)?');
2291: my $delfilewarn = &mt('You have indicated you wish to remove some files previously included in your submission.').'\\n'.
2292: &mt('Continue submission with these files removed?');
2293: my ($turninpathtext,$multtext,$arrayindexofjs);
2294: if (ref($turninpaths) eq 'HASH') {
2295: foreach my $key (sort(keys(%{$turninpaths}))) {
2296: $turninpathtext .= " if (prefix == '$key') {\n".
2297: " return '$turninpaths->{$key}';\n".
2298: " }\n";
2299: }
2300: }
2301: $turninpathtext .= " return '';\n";
2302: if (ref($multiples) eq 'HASH') {
2303: foreach my $key (sort(keys(%{$multiples}))) {
2304: $multtext .= " if (prefix == '$key') {\n".
2305: " return '$multiples->{$key}';\n".
2306: " }\n";
2307: }
2308: }
2309: $multtext .= " return '';\n";
2310:
2311: $arrayindexofjs = &Apache::loncommon::javascript_array_indexof();
2312: return <<"ENDSCRIPT";
2313: <script type="text/javascript">
2314: // <![CDATA[
2315:
2316: function file_submission_check(formname,path,multiresp) {
2317: var elemnum = formname.elements.length;
2318: if (elemnum == 0) {
2319: return true;
2320: }
2321: var alloverwrites = [];
2322: var alldelconfirm = [];
2323: var result = [];
2324: var submitter;
2325: var subprefix;
2326: var allsub = getIndexByName(formname,'all_submit');
2327: if (allsub == -1) {
2328: var idx = getIndexByName(formname,'submitted');
2329: if (idx != -1) {
2330: var subval = String(formname.elements[idx].value);
2331: submitter = subval.replace(/^part_/,'');
2332: result = overwritten_check(formname,path,multiresp,submitter);
2333: alloverwrites.push.apply(alloverwrites,result['overwrite']);
2334: alldelconfirm.push.apply(alldelconfirm,result['delete']);
2335: }
2336: } else {
2337: if (formname.elements[allsub].type == 'submit') {
2338: var partsub = /^\\d+\\.\\d+_submit_.+\$/;
2339: var allprefixes = [];
2340: var allparts = [];
2341: for (var i=0; i<formname.elements.length; i++) {
2342: if (formname.elements[i].type == 'submit') {
2343: var elemname = formname.elements[i].name;
2344: var subname = String(elemname);
2345: var savesub = String(elemname);
2346: if (partsub.test(subname)) {
2347: var prefix = subname.replace(/_submit_.+\$/,'');
2348: if (allprefixes.indexOf(prefix) == -1) {
2349: allprefixes.push(prefix);
2350: allparts[prefix] = [];
2351: }
2352: var part = savesub.replace(/^\\d+\\.\\d+_submit_/,'');
2353: allparts[prefix].push(part);
2354: }
2355: }
2356: }
2357: for (var k=0; k<allprefixes.length; k++) {
2358: var idx = getIndexByName(formname,allprefixes[k]+'_submitted');
2359: if (idx > -1) {
2360: if (formname.elements[idx].value != 'yes') {
2361: submitterval = formname.elements[idx].value;
2362: submitter = submitterval.replace(/^part_/,'');
2363: subprefix = allprefixes[k];
2364: result = overwritten_check(formname,path,multiresp,submitter,subprefix);
2365: alloverwrites.push.apply(alloverwrites,result['overwrite']);
2366: alldelconfirm.push.apply(alldelconfirm,result['delete']);
2367: break;
2368: }
2369: }
2370: }
2371: if (submitter == '' || submitter == undefined) {
2372: for (var m=0; m<allprefixes.length; m++) {
2373: for (var n=0; n<allparts[allprefixes[m]].length; n++) {
2374: var result = overwritten_check(formname,path,multiresp,allparts[allprefixes[m]][n],allprefixes[m]);
2375: alloverwrites.push.apply(alloverwrites,result['overwrite']);
2376: alldelconfirm.push.apply(alldelconfirm,result['delete']);
2377: }
2378: }
2379: }
2380: }
2381: }
2382: if (alloverwrites.length > 0) {
2383: if (!confirm("$overwritewarn")) {
2384: for (var n=0; n<alloverwrites.length; n++) {
2385: formname.elements[alloverwrites[n]].value = "";
2386: }
2387: return false;
2388: }
2389: }
2390: if (alldelconfirm.length > 0) {
2391: if (!confirm("$delfilewarn")) {
2392: for (var p=0; p<alldelconfirm.length; p++) {
2393: formname.elements[alldelconfirm[p]].checked = false;
2394: }
2395: return false;
2396: }
2397: }
2398: return true;
2399: }
2400:
2401: function getIndexByName(formname,item) {
2402: for (var i=0;i<formname.elements.length;i++) {
2403: if (formname.elements[i].name == item) {
2404: return i;
2405: }
2406: }
2407: return -1;
2408: }
2409:
2410: function overwritten_check(formname,path,multiresp,part,prefix) {
2411: var result = [];
2412: result['overwrite'] = [];
2413: result['delete'] = [];
2414: var elemnum = formname.elements.length;
2415: if (elemnum == 0) {
2416: return result;
2417: }
2418: var uploadstr;
2419: var deletestr;
2420: if ((prefix != undefined) && (prefix != '')) {
2421: var prepend = prefix+'_';
2422: uploadstr = new RegExp("^"+prepend+"HWFILE"+part+".+\$");
2423: deletestr = new RegExp("^"+prepend+"HWFILE"+part+".+_\\\\d+_delete\$");
2424: multiresp = check_for_multiples(prepend);
2425: path = check_for_turninpath(prepend);
2426: } else {
2427: uploadstr = new RegExp("^HWFILE"+part+".+\$");
2428: deletestr = new RegExp("^HWFILE"+part+".+_\\\\d+_delete\$");
2429: }
2430: var alluploads = [];
2431: var allchecked = [];
2432: var allskipdel = [];
2433: var fnametrim = /[^\\/\\\\]+\$/;
2434: for (var i=0; i<formname.elements.length; i++) {
2435: var id = formname.elements[i].id;
2436: if (id != '') {
2437: if (uploadstr.test(id)) {
2438: if (formname.elements[i].type == 'file') {
2439: alluploads.push(id);
2440: } else {
2441: if (deletestr.test(id)) {
2442: if (formname.elements[i].type == 'checkbox') {
2443: if (formname.elements[i].checked) {
2444: allchecked.push(id);
2445: }
2446: }
2447: }
2448: }
2449: }
2450: }
2451: }
2452: for (var j=0; j<alluploads.length; j++) {
2453: var delstr = new RegExp("^"+alluploads[j]+"_\\\\d+_delete\$");
2454: var delboxes = [];
2455: for (var k=0; k<formname.elements.length; k++) {
2456: var id = formname.elements[k].id;
2457: if ((id != '') && (id != undefined)) {
2458: if (delstr.test(id)) {
2459: if (formname.elements[k].type == 'checkbox') {
2460: delboxes.push(id);
2461: }
2462: }
2463: }
2464: }
2465: if (delboxes.length > 0) {
2466: if ((formname.elements[alluploads[j]].value != undefined) &&
2467: (formname.elements[alluploads[j]].value != '')) {
2468: var filepath = formname.elements[alluploads[j]].value;
2469: var newfilename = fnametrim.exec(filepath);
2470: if (newfilename != null) {
2471: var filename = String(newfilename);
2472: var nospaces = filename.replace(/\\s+/g,'_');
2473: var nospecials = nospaces.replace(/[^\\/\\w\\.\\-]/g,'');
2474: var cleanfilename = nospecials.replace(/\\.(\\d+\\.)/g,"_\$1");
2475: if (cleanfilename != '') {
2476: var fullpath = path+"/"+cleanfilename;
2477: if (multiresp == 1) {
2478: var partid = String(alluploads[i]);
2479: var subdir = partid.replace(/^\\d*.?\\d*_?HWFILE/,'');
2480: if (subdir != "" && subdir != undefined) {
2481: fullpath = path+"/"+subdir+"/"+cleanfilename;
2482: }
2483: }
2484: for (var m=0; m<delboxes.length; m++) {
2485: if (fullpath == formname.elements[delboxes[m]].value) {
2486: if (formname.elements[delboxes[m]].checked) {
2487: allskipdel.push(delboxes[m]);
2488: } else {
2489: result['overwrite'].push(alluploads[j]);
2490: }
2491: break;
2492: }
2493: }
2494: }
2495: }
2496: }
2497: }
2498: }
2499: if (allchecked.length > 0) {
2500: if (allskipdel.length > 0) {
2501: for (var n=0; n<allchecked.length; n++) {
2502: if (allskipdel.indexOf(allchecked[n]) == -1) {
2503: result['delete'].push(allchecked[n]);
2504: }
2505: }
2506: } else {
2507: result['delete'].push.apply(result['delete'],allchecked);
2508: }
2509: }
2510: return result;
2511: }
2512:
2513: function check_for_multiples(prefix) {
2514: $multtext
2515: }
2516:
2517: function check_for_turninpath(prefix) {
2518: $turninpathtext
2519: }
2520:
2521: // ]]>
2522: </script>
2523:
2524: $arrayindexofjs
2525:
2526: ENDSCRIPT
2527: }
2528:
2529: ##############################################
2530: ##############################################
2531:
2532: # javascript_valid_email
2533: #
2534: # Generates javascript to validate an e-mail address.
2535: # Returns a javascript function which accetps a form field as argumnent, and
2536: # returns false if field.value does not satisfy two regular expression matches
2537: # for a valid e-mail address. Backwards compatible with old browsers without
2538: # support for javascript RegExp (just checks for @ in field.value in this case).
2539:
2540: sub javascript_valid_email {
2541: my $scripttag .= <<'END';
2542: function validmail(field) {
2543: var str = field.value;
2544: if (window.RegExp) {
2545: var reg1str = "(@.*@)|(\\.\\.)|(@\\.)|(\\.@)|(^\\.)";
2546: var reg2str = "^.+\\@(\\[?)[a-zA-Z0-9\\-\\.]+\\.([a-zA-Z]{2,3}|[0-9]{1,3})(\\]?)$"; //"
2547: var reg1 = new RegExp(reg1str);
2548: var reg2 = new RegExp(reg2str);
2549: if (!reg1.test(str) && reg2.test(str)) {
2550: return true;
2551: }
2552: return false;
2553: }
2554: else
2555: {
2556: if(str.indexOf("@") >= 0) {
2557: return true;
2558: }
2559: return false;
2560: }
2561: }
2562: END
2563: return $scripttag;
2564: }
2565:
2566:
2567: # USAGE: htmltag(element, content, {attribute => value,...});
2568: #
2569: # EXAMPLES:
2570: # - htmltag('a', 'this is an anchor', {href => 'www.example.com',
2571: # title => 'this is a title'})
2572: #
2573: # - You might want to set up needed tags like:
2574: #
2575: # my $h3 = sub { return htmltag( "h3", @_ ) };
2576: #
2577: # ... and use them: $h3->("This is a headline")
2578: #
2579: # - To set up a couple of tags, see sub inittags
2580: #
2581: # NOTES:
2582: # - Empty elements, such as <br/> are correctly terminated,
2583: # i.e. htmltag('br') returns <br/>
2584: # - Empty attributes (title="") are filtered out.
2585: # - The function will not check for deprecated attributes.
2586: #
2587: # OUTPUT: content enclosed in xhtml conform tags
2588: sub htmltag{
2589: return
2590: qq|<$_[0]|
2591: . join( '', map { qq| $_="${$_[2]}{$_}"| if ${$_[2]}{$_} } keys %{ $_[2] } )
2592: . ($_[1] ? qq|>$_[1]</$_[0]>| : qq|/>|). "\n";
2593: };
2594:
2595:
2596: # USAGE: inittags(@tags);
2597: #
2598: # EXAMPLES:
2599: # - my ($h1, $h2, $h3) = inittags( qw( h1 h2 h3 ) )
2600: # $h1->("This is a headline") #Returns: <h1>This is a headline</h1>
2601: #
2602: # NOTES: See sub htmltag for further information.
2603: #
2604: # OUTPUT: List of subroutines.
2605: sub inittags {
2606: my @tags = @_;
2607: return map { my $tag = $_;
2608: sub { return htmltag( $tag, @_ ) }
2609: } @tags;
2610: }
2611:
2612:
2613: # USAGE: scripttag(scriptcode, [start|end|both]);
2614: #
2615: # EXAMPLES:
2616: # - scripttag("alert('Hello World!')", 'both')
2617: # returns:
2618: # <script type="text/javascript">
2619: # // BEGIN LON-CAPA Internal
2620: # alert(Hello World!')
2621: # // END LON-CAPA Internal
2622: # </script>
2623: #
2624: # NOTES:
2625: # - works currently only for javascripts
2626: #
2627: # OUTPUT:
2628: # Scriptcode properly enclosed in <script> and CDATA tags (and LC
2629: # Internal markers if 2nd argument is given)
2630: sub scripttag {
2631: my ( $content, $marker ) = @_;
2632: return unless defined $content;
2633:
2634: my $begin = "\n// BEGIN LON-CAPA Internal\n";
2635: my $end = "\n// END LON-CAPA Internal\n";
2636:
2637: if ($marker) {
2638: $content = $begin . $content if $marker eq 'start' or $marker eq 'both';
2639: $content .= $end if $marker eq 'end' or $marker eq 'both';
2640: }
2641:
2642: $content = "\n// <![CDATA[\n$content\n// ]]>\n";
2643:
2644: return htmltag('script', $content, {type => 'text/javascript'});
2645: };
2646:
2647:
2648: =item list_from_array( \@array, { listattr =>{}, itemattr =>{} } )
2649:
2650: Constructs a XHTML list from \@array.
2651:
2652: input:
2653:
2654: =over
2655:
2656: =item \@array
2657:
2658: A reference to the array containing text that will be wrapped in <li></li> tags.
2659:
2660: =item { listattr => {}, itemattr =>{} }
2661:
2662: Attributes for <ul> and <li> passed in as hash references.
2663: See htmltag() for more details.
2664:
2665: =back
2666:
2667: returns: XHTML list as String.
2668:
2669: =cut
2670:
2671: # \@items, {listattr => { class => 'abc', id => 'xyx' }, itemattr => {class => 'abc', id => 'xyx'}}
2672: sub list_from_array {
2673: my ($items, $args) = @_;
2674: return unless (ref($items) eq 'ARRAY');
2675: return unless scalar @$items;
2676: my ($ul, $li) = inittags( qw(ul li) );
2677: my $listitems = join '', map { $li->($_, $args->{itemattr}) } @$items;
2678: return $ul->( $listitems, $args->{listattr} );
2679: }
2680:
2681:
2682: ##############################################
2683: ##############################################
2684:
2685: # generate_menu
2686: #
2687: # Generates html markup for a menu.
2688: #
2689: # Inputs:
2690: # An array of following structure:
2691: # ({ categorytitle => 'Categorytitle',
2692: # items => [
2693: # {
2694: # linktext => 'Text to be displayed',
2695: # url => 'URL the link is pointing to, i.e. /adm/site?action=dosomething',
2696: # permission => 'Contains permissions as returned from lonnet::allowed(),
2697: # must evaluate to true in order to activate the link',
2698: # icon => 'icon filename',
2699: # alttext => 'alt text for the icon',
2700: # help => 'Name of the corresponding helpfile',
2701: # linktitle => 'Description of the link (used for title tag)'
2702: # },
2703: # ...
2704: # ]
2705: # },
2706: # ...
2707: # )
2708: #
2709: # Outputs: A scalar containing the html markup for the menu.
2710:
2711: sub generate_menu {
2712: my @menu = @_;
2713: # subs for specific html elements
2714: my ($h3, $div, $ul, $li, $a, $img) = inittags( qw(h3 div ul li a img) );
2715:
2716: my @categories; # each element represents the entire markup for a category
2717:
2718: foreach my $category (@menu) {
2719: my @links; # contains the links for the current $category
2720: foreach my $link (@{$$category{items}}) {
2721: next unless $$link{permission};
2722:
2723: # create the markup for the current $link and push it into @links.
2724: # each entry consists of an image and a text optionally followed
2725: # by a help link.
2726: my $src;
2727: if ($$link{icon} ne '') {
2728: $src = '/res/adm/pages/'.$$link{icon};
2729: }
2730: push(@links,$li->(
2731: $a->(
2732: $img->("", {
2733: class => "LC_noBorder LC_middle",
2734: src => $src,
2735: alt => mt(defined($$link{alttext}) ?
2736: $$link{alttext} : $$link{linktext})
2737: }), {
2738: href => $$link{url},
2739: title => mt($$link{linktitle})
2740: }).
2741: $a->(mt($$link{linktext}), {
2742: href => $$link{url},
2743: title => mt($$link{linktitle}),
2744: class => "LC_menubuttons_link"
2745: }).
2746: (defined($$link{help}) ?
2747: Apache::loncommon::help_open_topic($$link{help}) : ''),
2748: {class => "LC_menubuttons_inline_text"}));
2749: }
2750:
2751: # wrap categorytitle in <h3>, concatenate with
2752: # joined and in <ul> tags wrapped @links
2753: # and wrap everything in an enclosing <div> and push it into
2754: # @categories
2755: # such that each element looks like:
2756: # <div><h3>title</h3><ul><li>...</li>...</ul></div>
2757: # the category won't be added if there aren't any links
2758: push(@categories,
2759: $div->($h3->(mt($$category{categorytitle}), {class=>"LC_hcell"}).
2760: $ul->(join('' ,@links), {class =>"LC_ListStyleNormal" }),
2761: {class=>"LC_Box LC_400Box"})) if scalar(@links);
2762: }
2763:
2764: # wrap the joined @categories in another <div> (column layout)
2765: return $div->(join('', @categories), {class => "LC_columnSection"});
2766: }
2767:
2768: ##############################################
2769: ##############################################
2770:
2771: =pod
2772:
2773: =item &start_funclist
2774:
2775: Start list of available functions
2776:
2777: Typically used to offer a simple list of available functions
2778: at top or bottom of page.
2779: All available functions/actions for the current page
2780: should be included in this list.
2781:
2782: If the optional headline text is not provided, a default text will be used.
2783:
2784:
2785: Related routines:
2786: =over 4
2787: add_item_funclist
2788: end_funclist
2789: =back
2790:
2791:
2792: Inputs: (optional) headline text
2793:
2794: Returns: HTML code with function list start
2795:
2796: =cut
2797:
2798: ##############################################
2799: ##############################################
2800:
2801: sub start_funclist {
2802: my($legendtext)=@_;
2803: $legendtext=&mt('Functions') if !$legendtext;
2804: return '<ul class="LC_funclist"><li style="font-weight:bold; margin-left:0.8em;">'.$legendtext.'</li>'."\n";
2805: }
2806:
2807:
2808: ##############################################
2809: ##############################################
2810:
2811: =pod
2812:
2813: =item &add_item_funclist
2814:
2815: Adds an item to the list of available functions
2816:
2817: Related routines:
2818: =over 4
2819: start_funclist
2820: end_funclist
2821: =back
2822:
2823: Inputs: content item with text and link to function
2824:
2825: Returns: HTML code with list item for funclist
2826:
2827: =cut
2828:
2829: ##############################################
2830: ##############################################
2831:
2832: sub add_item_funclist {
2833: my($content) = @_;
2834: return '<li>'.$content.'</li>'."\n";
2835: }
2836:
2837: =pod
2838:
2839: =item &end_funclist
2840:
2841: End list of available functions
2842:
2843: Related routines:
2844: =over 4
2845: start_funclist
2846: add_item_funclist
2847: =back
2848:
2849: Inputs: ./.
2850:
2851: Returns: HTML code with function list end
2852: =cut
2853:
2854: sub end_funclist {
2855: return "</ul>\n";
2856: }
2857:
2858: =pod
2859:
2860: =item funclist_from_array( \@array, {legend => 'text for legend'} )
2861:
2862: Constructs a XHTML list from \@array with the first item being visually
2863: highlighted and set to the value of legend or 'Functions' if legend is
2864: empty.
2865:
2866: =over
2867:
2868: =item \@array
2869:
2870: A reference to the array containing text that will be wrapped in <li></li> tags.
2871:
2872: =item { legend => 'text' }
2873:
2874: A string that's used as visually highlighted first item. 'Functions' is used if
2875: it's value evaluates to false.
2876:
2877: =back
2878:
2879: returns: XHTML list as string.
2880:
2881: =back
2882:
2883: =cut
2884:
2885: sub funclist_from_array {
2886: my ($items, $args) = @_;
2887: return unless(ref($items) eq 'ARRAY');
2888: $args->{legend} ||= mt('Functions');
2889: return list_from_array( [$args->{legend}, @$items],
2890: { listattr => {class => 'LC_funclist'} });
2891: }
2892:
2893: 1;
2894:
2895: __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