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