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