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