Annotation of loncom/interface/lonhtmlcommon.pm, revision 1.330
1.2 www 1: # The LearningOnline Network with CAPA
2: # a pile of common html routines
3: #
1.330 ! raeburn 4: # $Id: lonhtmlcommon.pm,v 1.329 2012/11/03 23:32:37 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.330 ! raeburn 64: use LONCAPA qw(:DEFAULT :match);
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.326 foxr 1104:
1.34 www 1105: # ------------------------------------------------------- Puts directory header
1106:
1107: sub crumbs {
1.252 bisitz 1108: my ($uri,$target,$prefix,$form,$skiplast)=@_;
1.303 www 1109: # You cannot crumbnify uploaded or adm resources
1110: if ($uri=~/^\/*(uploaded|adm)\//) { return &mt('(Internal Course/Group Content)'); }
1.100 raeburn 1111: if ($target) {
1112: $target = ' target="'.
1113: &Apache::loncommon::escape_single($target).'"';
1114: }
1.252 bisitz 1115: my $output='<span class="LC_filename">';
1116: $output.=$prefix.'/';
1.249 raeburn 1117: if (($env{'user.adv'}) || ($env{'user.author'})) {
1.252 bisitz 1118: my $path=$prefix.'/';
1119: foreach my $dir (split('/',$uri)) {
1.99 matthew 1120: if (! $dir) { next; }
1121: $path .= $dir;
1.252 bisitz 1122: if ($path eq $uri) {
1123: if ($skiplast) {
1124: $output.=$dir;
1.132 www 1125: last;
1.252 bisitz 1126: }
1127: } else {
1128: $path.='/';
1129: }
1.157 albertel 1130: my $href_path = &HTML::Entities::encode($path,'<>&"');
1.252 bisitz 1131: &Apache::loncommon::inhibit_menu_check(\$href_path);
1132: if ($form) {
1133: my $href = 'javascript:'.$form.".action='".$href_path."';".$form.'.submit();';
1134: $output.=qq{<a href="$href"$target>$dir</a>/};
1135: } else {
1136: $output.=qq{<a href="$href_path"$target>$dir</a>/};
1137: }
1138: }
1.35 www 1139: } else {
1.252 bisitz 1140: foreach my $dir (split('/',$uri)) {
1.149 albertel 1141: if (! $dir) { next; }
1.252 bisitz 1142: $output.=$dir.'/';
1143: }
1.34 www 1144: }
1.149 albertel 1145: if ($uri !~ m|/$|) { $output=~s|/$||; }
1.252 bisitz 1146: $output.='</span>';
1147:
1.304 foxr 1148:
1.252 bisitz 1149: return $output;
1.34 www 1150: }
1151:
1.85 www 1152: # --------------------- A function that generates a window for the spellchecker
1153:
1154: sub spellheader {
1.123 albertel 1155: my $start_page=
1156: &Apache::loncommon::start_page('Speller Suggestions',undef,
1.140 albertel 1157: {'only_body' => 1,
1158: 'js_ready' => 1,
1159: 'bgcolor' => '#DDDDDD',
1160: 'add_entries' => {
1161: 'onload' =>
1162: 'document.forms.spellcheckform.submit()',
1163: }
1164: });
1.123 albertel 1165: my $end_page=
1166: &Apache::loncommon::end_page({'js_ready' => 1});
1167:
1.105 www 1168: my $nothing=&javascript_nothing();
1.85 www 1169: return (<<ENDCHECK);
1170: <script type="text/javascript">
1.218 bisitz 1171: // <![CDATA[
1.92 albertel 1172: //<!-- BEGIN LON-CAPA Internal
1.85 www 1173: var checkwin;
1174:
1.140 albertel 1175: function spellcheckerwindow(string) {
1176: var esc_string = string.replace(/\"/g,'"');
1.105 www 1177: checkwin=window.open($nothing,'spellcheckwin','height=320,width=280,resizable=yes,scrollbars=yes,location=no,menubar=no,toolbar=no');
1.154 albertel 1178: 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 1179: checkwin.document.close();
1180: }
1.92 albertel 1181: // END LON-CAPA Internal -->
1.218 bisitz 1182: // ]]>
1.85 www 1183: </script>
1184: ENDCHECK
1185: }
1186:
1187: # ---------------------------------- Generate link to spell checker for a field
1188:
1189: sub spelllink {
1190: my ($form,$field)=@_;
1191: my $linktext=&mt('Check Spelling');
1192: return (<<ENDLINK);
1.140 albertel 1193: <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 1194: ENDLINK
1195: }
1196:
1.281 raeburn 1197: # ------------------------------------------------- Output headers for CKEditor
1.124 albertel 1198:
1.52 www 1199: sub htmlareaheaders {
1.255 faziophi 1200: my $s="";
1.260 faziophi 1201: if (&htmlareabrowser()) {
1.255 faziophi 1202: $s.=(<<ENDEDITOR);
1203: <script type="text/javascript" src="/ckeditor/ckeditor.js"></script>
1204: ENDEDITOR
1205: }
1206: $s.=(<<ENDJQUERY);
1.294 raeburn 1207: <script type="text/javascript" src="/adm/jQuery/js/jquery-1.6.2.min.js"></script>
1208: <script type="text/javascript" src="/adm/jQuery/js/jquery-ui-1.8.16.custom.min.js"></script>
1209: <link rel="stylesheet" type="text/css" href="/adm/jQuery/css/smoothness/jquery-ui-1.8.16.custom.css" />
1.301 foxr 1210: <script type="text/javascript" src="/adm/jpicker/js/jpicker-1.1.6.min.js" >
1211: </script>
1212: <link rel="stylesheet" type="text/css" href="/adm/jpicker/css/jPicker-1.1.6.min.css" />
1.310 raeburn 1213: <script type="text/javascript" src="/adm/countdown/js/jquery.countdown.js"></script>
1214: <link rel="stylesheet" type="text/css" href="/adm/countdown/css/jquery.countdown.css" />
1.320 foxr 1215:
1.323 foxr 1216: <script type="text/javascript" src="/adm/spellchecker/js/jquery.spellchecker.min.js"></script>
1.320 foxr 1217: <link rel="stylesheet" type="text/css" href="/adm/spellchecker/css/spellchecker.css" />
1218:
1.255 faziophi 1219: ENDJQUERY
1220: return $s;
1.52 www 1221: }
1222:
1.76 www 1223: # ----------------------------------------------------------------- Preferences
1224:
1.167 albertel 1225: # ------------------------------------------------- lang to use in html editor
1226: sub htmlarea_lang {
1227: my $lang='en';
1228: if (&mt('htmlarea_lang') ne 'htmlarea_lang') {
1229: $lang=&mt('htmlarea_lang');
1230: }
1231: return $lang;
1232: }
1233:
1.326 foxr 1234: # return javacsript to activate elements of .colorchooser with jpicker:
1235: # Caller is responsible for enclosing this in <script> tags:
1236: #
1237: sub color_picker {
1238: return '
1239: $(document).ready(function(){
1240: $.fn.jPicker.defaults.images.clientPath="/adm/jpicker/images/";
1241: $(".colorchooser").jPicker({window: { position: {x: "screenCenter", y: "bottom"}}});
1242: });';
1243: }
1244:
1.72 www 1245: # ----------------------------------------- Script to activate only some fields
1246:
1247: sub htmlareaselectactive {
1.281 raeburn 1248: my ($args) = @_;
1.76 www 1249: unless (&htmlareabrowser()) { return ''; }
1.262 raeburn 1250: my $output='<script type="text/javascript" defer="defer">'."\n"
1.230 bisitz 1251: .'// <![CDATA['."\n";
1.167 albertel 1252: my $lang = &htmlarea_lang();
1.281 raeburn 1253: my $fullpage = 'false';
1.282 raeburn 1254: my ($dragmath_prefix,$dragmath_helpicon,$dragmath_whitespace);
1.281 raeburn 1255: if (ref($args) eq 'HASH') {
1256: if (exists($args->{'lang'})) {
1257: if ($args->{'lang'} ne '') {
1258: $lang = $args->{'lang'};
1259: }
1260: }
1261: if (exists($args->{'fullpage'})) {
1262: if ($args->{'fullpage'} eq 'true') {
1263: $fullpage = $args->{'fullpage'};
1264: }
1265: }
1266: if (exists($args->{'dragmath'})) {
1267: if ($args->{'dragmath'} ne '') {
1268: $dragmath_prefix = $args->{'dragmath'};
1.282 raeburn 1269: $dragmath_helpicon=&Apache::loncommon::lonhttpdurl("/adm/help/help.png");
1270: $dragmath_whitespace=&Apache::loncommon::lonhttpdurl("/adm/lonIcons/transparent1x1.gif");
1.281 raeburn 1271: }
1272: }
1273: }
1.255 faziophi 1274: $output.='
1275:
1276: function containsBlockHtml(id) {
1.281 raeburn 1277: 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 1278: return (re >= 0);
1279: }
1280:
1281: function startRichEditor(id) {
1282: CKEDITOR.replace(id,
1283: {
1.281 raeburn 1284: customConfig: "/ckeditor/loncapaconfig.js",
1285: language : "'.$lang.'",
1286: fullPage : '.$fullpage.',
1.255 faziophi 1287: }
1288: );
1289: }
1290:
1291: function destroyRichEditor(id) {
1292: CKEDITOR.instances[id].destroy();
1.72 www 1293: }
1.255 faziophi 1294:
1295: function editorHandler(event) {
1296: var rawid = $(this).attr("id");
1.281 raeburn 1297: var id = new RegExp("LC_rt_(.*)").exec(rawid)[1];
1.255 faziophi 1298: event.preventDefault();
1.281 raeburn 1299: var rt_enabled = $(this).hasClass("LC_enable_rt");
1300: if (rt_enabled) {
1.255 faziophi 1301: startRichEditor(id);
1302: $("#LC_rt_"+id).html("<b>« Plain text</b>");
1303: $("#LC_rt_"+id).attr("title", "Disable rich text formatting and edit in plain text");
1304: $("#LC_rt_"+id).addClass("LC_disable_rt");
1305: $("#LC_rt_"+id).removeClass("LC_enable_rt");
1306: } else {
1307: destroyRichEditor(id);
1308: $("#LC_rt_"+id).html("<b>Rich formatting »</b>");
1309: $("#LC_rt_"+id).attr("title", "Enable rich text formatting (bold, italic, etc.)");
1310: $("#LC_rt_"+id).addClass("LC_enable_rt");
1311: $("#LC_rt_"+id).removeClass("LC_disable_rt");
1.281 raeburn 1312: }';
1313: if ($dragmath_prefix ne '') {
1314: $output .= "\n var visible = '';
1315: if (rt_enabled) {
1316: visible = 'none';
1317: }
1318: editmath_visibility(id,visible);\n";
1319: }
1320: $output .= '
1321: }
1.255 faziophi 1322: $(document).ready(function(){
1323: $(".LC_richAlwaysOn").each(function() {
1324: startRichEditor($(this).attr("id"));
1325: });
1326: $(".LC_richDetectHtml").each(function() {
1327: var id = $(this).attr("id");
1.281 raeburn 1328: var rt_enabled = containsBlockHtml(id);
1329: if(rt_enabled) {
1.255 faziophi 1330: $(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>");
1331: startRichEditor(id);
1.281 raeburn 1332: $("#LC_rt_"+id).click(editorHandler);
1.255 faziophi 1333: }
1334: else {
1335: $(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>");
1336: $("#LC_rt_"+id).click(editorHandler);
1.281 raeburn 1337: }';
1338: if ($dragmath_prefix ne '') {
1339: $output .= "\n var visible = '';
1340: if (rt_enabled) {
1341: visible = 'none';
1342: }
1343: editmath_visibility(id,visible);\n";
1344: }
1345: $output .= '
1.255 faziophi 1346: });
1347: $(".LC_richDefaultOn").each(function() {
1348: var id = $(this).attr("id");
1349: $(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>");
1350: startRichEditor(id);
1351: $("#LC_rt_"+id).click(editorHandler);
1352: });
1353: $(".LC_richDefaultOff").each(function() {
1354: var id = $(this).attr("id");
1355: $(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 1356: $("#LC_rt_"+id).click(editorHandler);
1.255 faziophi 1357: });
1.301 foxr 1358:
1.304 foxr 1359:
1.302 foxr 1360: });
1.281 raeburn 1361: ';
1.326 foxr 1362: $output .= &color_picker;
1363:
1.306 foxr 1364: # Code to put a due date countdown in 'duedatecountdown' span.
1365: # This is currently located in the breadcrumb headers.
1366: # note that the dueDateLayout is internatinoalized below.
1367: # Here document is used to support the substitution into the javascript below.
1.307 foxr 1368: # ..which unforunately necessitates escaping the $'s in the javascript.
1369: # There are several times of importance
1370: #
1371: # serverDueDate - The absolute time at which the problem expires.
1372: # serverTime - The server's time when the problem finished computing.
1373: # clientTime - The client's time...as close to serverTime as possible.
1374: # The clientTime will be slightly later due to
1375: # 1. The latency between problem computation and
1376: # the first network action.
1377: # 2. The time required between the page load-start and the actual
1378: # initial javascript execution that got clientTime.
1379: # These are used as follows:
1380: # The difference between clientTime and serverTime are used to
1381: # correct for differences in clock settings between the browser's system and the
1382: # server's.
1383: #
1384: # The difference between clientTime and the time at which the ready() method
1385: # starts executing is used to estimate latencies for page load and submission.
1386: # Since this is an estimate, it is doubled. The latency estimate + one minute
1387: # is used to determine when the countdown timer turns red to warn the user
1388: # to think about submitting.
1.306 foxr 1389:
1.314 raeburn 1390: my $dueDateLayout = &mt('Due in: {dn} {dl} {hnn}{sep}{mnn}{sep}{snn} [_1]',"<span id='submitearly'></span>");
1391: my $early = '- <b>'.&mt('Submit Early').'</b>';
1392: my $pastdue = '- <b>'.&mt('Past Due').'</b>';
1.306 foxr 1393: $output .= <<JAVASCRIPT;
1.307 foxr 1394:
1395: var documentReadyTime;
1396:
1.306 foxr 1397: \$(document).ready(function() {
1398: if (typeof(dueDate) != "undefined") {
1.307 foxr 1399: documentReadyTime = (new Date()).getTime();
1.306 foxr 1400: \$("#duedatecountdown").countdown({until: dueDate, compact: true,
1401: layout: "$dueDateLayout",
1402: onTick: function (periods) {
1.307 foxr 1403: var latencyEstimate = (documentReadyTime - clientTime) * 2;
1.314 raeburn 1404: if(\$.countdown.periodsToSeconds(periods) < (300 + latencyEstimate)) {
1405: \$("#submitearly").html("$early");
1406: if (\$.countdown.periodsToSeconds(periods) < 1) {
1407: \$("#submitearly").html("$pastdue");
1408: }
1409: }
1.307 foxr 1410: if(\$.countdown.periodsToSeconds(periods) < (60 + latencyEstimate)) {
1.306 foxr 1411: \$(this).css("color", "red"); //Highlight last minute.
1412: }
1413: }
1414: });
1415: }
1416: });
1.322 foxr 1417:
1418: /* This code describes the spellcheck options that will be used for
1419: items with class 'spellchecked'. It is necessary for those objects'
1420: to explicitly request checking (e.g. onblur is a nice event for that).
1421: */
1422: \$(document).ready(function() {
1423: \$(".spellchecked").spellchecker({
1424: url: "/ajax/spellcheck",
1425: lang: "en",
1426: engine: "pspell",
1427: suggestionBoxPosition: "below",
1428: innerDocument: true
1429: });
1430: \$("textarea.spellchecked").spellchecker({
1431: url: "/ajax/spellcheck",
1432: lang: "en",
1433: engine: "pspell",
1434: suggestionBoxPosition: "below",
1435: innerDocument: true
1436: });
1437:
1438: });
1439:
1.325 foxr 1440: /* the muli colored editor can generate spellcheck with language 'none'
1441: to disable spellcheck as well
1442: */
1.324 foxr 1443: function doSpellcheck(element, lang) {
1.325 foxr 1444: if (lang != 'none') {
1445: \$(element).spellchecker('option', {lang: lang});
1446: \$(element).spellchecker('check');
1447: }
1.324 foxr 1448: }
1449:
1.322 foxr 1450:
1.306 foxr 1451: JAVASCRIPT
1.281 raeburn 1452: if ($dragmath_prefix ne '') {
1453: $output .= '
1454:
1455: function editmath_visibility(id,value) {
1456:
1457: if ((id == "") || (id == null)) {
1458: return;
1459: }
1460: var mathid = "'.$dragmath_prefix.'_"+id;
1461: mathele = document.getElementById(mathid);
1462: if (mathele == null) {
1463: return;
1464: }
1465: mathele.style.display = value;
1.282 raeburn 1466: var mathhelpicon = "'.$dragmath_prefix.'helpicon'.'_"+id;
1467: mathhelpiconele = document.getElementById(mathhelpicon);
1468: if (mathhelpiconele == null) {
1469: return;
1470: }
1471: if (value == "none") {
1472: mathhelpiconele.src = "'.$dragmath_whitespace.'";
1473: } else {
1474: mathhelpiconele.src = "'.$dragmath_helpicon.'";
1475: }
1.281 raeburn 1476: }
1477: ';
1478:
1479: }
1.218 bisitz 1480: $output.="\nwindow.status='Activated Editfields';\n"
1.230 bisitz 1481: .'// ]]>'."\n"
1.281 raeburn 1482: .'</script>';
1.72 www 1483: return $output;
1484: }
1485:
1.61 www 1486: # --------------------------------------------------------------------- Blocked
1487:
1488: sub htmlareablocked {
1.104 albertel 1489: unless ($env{'environment.wysiwygeditor'} eq 'on') { return 1; }
1.71 www 1490: return 0;
1.52 www 1491: }
1492:
1493: # ---------------------------------------- Browser capable of running HTMLArea?
1494:
1495: sub htmlareabrowser {
1496: return 1;
1497: }
1.53 matthew 1498:
1.287 www 1499: #
1500: # Should the "return to content" link be shown?
1501: #
1502:
1503: sub show_return_link {
1.289 www 1504:
1505: unless ($env{'request.course.id'}) { return 0; }
1506: if ($env{'request.noversionuri'}=~m{^/priv/} ||
1.318 raeburn 1507: $env{'request.uri'}=~m{^/priv/}) { return 1; }
1.289 www 1508:
1.287 www 1509: if (($env{'request.noversionuri'} =~ m{^/adm/(viewclasslist|navmaps)($|\?)})
1510: || ($env{'request.noversionuri'} =~ m{^/adm/.*/aboutme($|\?)})) {
1511:
1512: return if ($env{'form.register'});
1513: }
1514: return (($env{'request.noversionuri'}=~m{^/(res|public)/} &&
1515: $env{'request.symb'} eq '')
1516: ||
1517: ($env{'request.noversionuri'}=~ m{^/cgi-bin/printout.pl})
1518: ||
1519: (($env{'request.noversionuri'}=~/^\/adm\//) &&
1520: ($env{'request.noversionuri'}!~/^\/adm\/wrapper\//) &&
1521: ($env{'request.noversionuri'}!~
1522: m{^/adm/.*/(smppg|bulletinboard)($|\?)})
1523: ));
1524: }
1525:
1526:
1.304 foxr 1527: ##
1528: # Set the dueDate variable...note this is done in the timezone
1529: # of the browser.
1530: #
1531: # @param epoch relative time at which the problem is due.
1532: #
1533: # @return the javascript fragment to set the date:
1534: #
1535: sub set_due_date {
1536: my $dueStamp = shift;
1537: my $duems = $dueStamp * 1000; # Javascript Date object needs ms not seconds.
1538:
1539: my $now = time()*1000;
1540:
1541: # This slightly obscure bit of javascript sets the dueDate variable
1542: # to the time in the browser at which the problem was due.
1543: # The code should correct for gross differences between the server
1544: # and client's time setting
1545:
1.315 raeburn 1546: return <<"END";
1547:
1548: <script type="text/javascript">
1.304 foxr 1549: //<![CDATA[
1550: var serverDueDate = $duems;
1551: var serverTime = $now;
1552: var clientTime = (new Date()).getTime();
1553: var dueDate = new Date(serverDueDate + (clientTime - serverTime));
1554:
1555: //]]>
1556: </script>
1557:
1.315 raeburn 1558: END
1.307 foxr 1559: }
1560: ##
1561: # Sets the time at which the problem finished computing.
1562: # This just updates the serverTime and clientTime variables above.
1563: # Calling this in e.g. end_problem provides a better estimate of the
1564: # difference beetween the server and client time setting as
1565: # the difference contains less of the latency/problem compute time.
1566: #
1567: sub set_compute_end_time {
1568:
1569: my $now = time()*1000; # Javascript times are in ms.
1.316 raeburn 1570: return <<"END";
1571:
1572: <script type="text/javascript">
1.307 foxr 1573: //<![CDATA[
1574: serverTime = $now;
1575: clientTime = (new Date()).getTime();
1576: //]]>
1577: </script>
1578:
1.316 raeburn 1579: END
1.304 foxr 1580: }
1581:
1.53 matthew 1582: ############################################################
1583: ############################################################
1584:
1585: =pod
1586:
1.309 raeburn 1587: =item &breadcrumbs()
1.53 matthew 1588:
1589: Compiles the previously registered breadcrumbs into an series of links.
1590: Additionally supports a 'component', which will be displayed on the
1.223 droeschl 1591: right side of the breadcrumbs enclosing div (without a link).
1.53 matthew 1592: A link to help for the component will be included if one is specified.
1593:
1594: All inputs can be undef without problems.
1595:
1.223 droeschl 1596: Inputs: $component (the text on the right side of the breadcrumbs trail),
1.53 matthew 1597: $component_help
1.63 albertel 1598: $menulink (boolean, controls whether to include a link to /adm/menu)
1.138 albertel 1599: $helplink (if 'nohelp' don't include the orange help link)
1600: $css_class (optional name for the class to apply to the table for CSS)
1.197 raeburn 1601: $no_mt (optional flag, 1 if &mt() is _not_ to be applied to $component
1602: when including the text on the right.
1.53 matthew 1603: Returns a string containing breadcrumbs for the current page.
1604:
1.309 raeburn 1605: =item &clear_breadcrumbs()
1.53 matthew 1606:
1607: Clears the previously stored breadcrumbs.
1608:
1.309 raeburn 1609: =item &add_breadcrumb()
1.53 matthew 1610:
1611: Pushes a breadcrumb on the stack of crumbs.
1612:
1613: input: $breadcrumb, a hash reference. The keys 'href','title', and 'text'
1614: are required. If present the keys 'faq' and 'bug' will be used to provide
1.156 albertel 1615: links to the FAQ and bug sites. If the key 'no_mt' is present the 'title'
1616: and 'text' values won't be sent through &mt()
1.53 matthew 1617:
1618: returns: nothing
1619:
1620: =cut
1621:
1622: ############################################################
1623: ############################################################
1624: {
1625: my @Crumbs;
1.242 droeschl 1626: my %tools = ();
1.57 matthew 1627:
1.53 matthew 1628: sub breadcrumbs {
1.314 raeburn 1629: my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt,
1630: $CourseBreadcrumbs) = @_;
1.53 matthew 1631: #
1.215 droeschl 1632: $css_class ||= 'LC_breadcrumbs';
1.205 amueller 1633:
1.57 matthew 1634: # Make the faq and bug data cascade
1.223 droeschl 1635: my $faq = '';
1636: my $bug = '';
1637: my $help = '';
1.215 droeschl 1638: # Crumb Symbol
1.223 droeschl 1639: my $crumbsymbol = '»';
1.60 www 1640: # The last breadcrumb does not have a link, so handle it separately.
1.53 matthew 1641: my $last = pop(@Crumbs);
1.57 matthew 1642: #
1.70 matthew 1643: # The first one should be the course or a menu link
1.215 droeschl 1644: if (!defined($menulink)) { $menulink=1; }
1.70 matthew 1645: if ($menulink) {
1646: my $description = 'Menu';
1.172 raeburn 1647: my $no_mt_descr = 0;
1.269 raeburn 1648: if ((exists($env{'request.course.id'})) &&
1649: ($env{'request.course.id'} ne '') &&
1650: ($env{'course.'.$env{'request.course.id'}.'.description'} ne '')) {
1.70 matthew 1651: $description =
1.104 albertel 1652: $env{'course.'.$env{'request.course.id'}.'.description'};
1.172 raeburn 1653: $no_mt_descr = 1;
1.330 ! raeburn 1654: if ($env{'request.noversionuri'} =~
! 1655: m{^/public/($match_domain)/($match_courseid)/syllabus$}) {
! 1656: unless (($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1) &&
! 1657: ($env{'course.'.$env{'request.course.id'}.'.num'} eq $2)) {
! 1658: $description = 'Menu';
! 1659: $no_mt_descr = 0;
! 1660: }
! 1661: }
1.70 matthew 1662: }
1.215 droeschl 1663: $menulink = { href =>'/adm/menu',
1664: title =>'Go to main menu',
1665: target =>'_top',
1666: text =>$description,
1667: no_mt =>$no_mt_descr, };
1668: if($last) {
1669: #$last set, so we have some crumbs
1670: unshift(@Crumbs,$menulink);
1671: } else {
1672: #only menulink crumb present
1673: $last = $menulink;
1674: }
1.53 matthew 1675: }
1.287 www 1676: my $links;
1.330 ! raeburn 1677: if ((&show_return_link) && (!$CourseBreadcrumbs) && (ref($last) eq 'HASH')) {
1.299 raeburn 1678: my $alttext = &mt('Go Back');
1.317 raeburn 1679: $links=&htmltag( 'a','<img src="/res/adm/pages/tolastloc.png" alt="'.$alttext.'" class="LC_icon" />',
1.287 www 1680: { href => '/adm/flip?postdata=return:',
1.317 raeburn 1681: title => &mt('Back to most recent content resource'),
1682: class => 'LC_menubuttons_link',
1683: });
1.299 raeburn 1684: $links=&htmltag('li',$links);
1.287 www 1685: }
1686: $links.= join "",
1.261 droeschl 1687: map {
1688: $faq = $_->{'faq'} if (exists($_->{'faq'}));
1689: $bug = $_->{'bug'} if (exists($_->{'bug'}));
1690: $help = $_->{'help'} if (exists($_->{'help'}));
1691:
1.287 www 1692: my $result = $_->{no_mt} ? $_->{text} : &mt($_->{text});
1.261 droeschl 1693:
1694: if ($_->{href}){
1.287 www 1695: $result = &htmltag( 'a', $result,
1.261 droeschl 1696: { href => $_->{href},
1.287 www 1697: title => $_->{no_mt} ? $_->{title} : &mt($_->{title}),
1.261 droeschl 1698: target => $_->{target}, });
1699: }
1700:
1.287 www 1701: $result = &htmltag( 'li', "$result $crumbsymbol");
1.261 droeschl 1702: } @Crumbs;
1.223 droeschl 1703:
1704: #should the last Element be translated?
1.261 droeschl 1705:
1706: my $lasttext = $last->{'no_mt'} ? $last->{'text'}
1707: : mt( $last->{'text'} );
1708:
1.274 droeschl 1709: # last breadcrumb is the first order heading of a page
1710: # for course breadcrumbs it's just bold
1.304 foxr 1711:
1.330 ! raeburn 1712: if ($lasttext ne '') {
! 1713: $links .= &htmltag( 'li', htmltag($CourseBreadcrumbs ? 'b' : 'h1',
! 1714: $lasttext), {title => $lasttext});
! 1715: }
1.223 droeschl 1716:
1.54 matthew 1717: my $icons = '';
1.223 droeschl 1718: $faq = $last->{'faq'} if (exists($last->{'faq'}));
1719: $bug = $last->{'bug'} if (exists($last->{'bug'}));
1.106 www 1720: $help = $last->{'help'} if (exists($last->{'help'}));
1721: $component_help=($component_help?$component_help:$help);
1.145 albertel 1722: # if ($faq ne '') {
1723: # $icons .= &Apache::loncommon::help_open_faq($faq);
1724: # }
1.79 raeburn 1725: # if ($bug ne '') {
1726: # $icons .= &Apache::loncommon::help_open_bug($bug);
1727: # }
1.223 droeschl 1728: if ($faq ne '' || $component_help ne '' || $bug ne '') {
1729: $icons .= &Apache::loncommon::help_open_menu($component,
1730: $component_help,
1731: $faq,$bug);
1732: }
1.54 matthew 1733: #
1.304 foxr 1734:
1.205 amueller 1735:
1.330 ! raeburn 1736: if ($links ne '') {
! 1737: unless ($CourseBreadcrumbs) {
! 1738: $links = &htmltag('ol', $links, { id => "LC_MenuBreadcrumbs" });
! 1739: } else {
! 1740: $links = &htmltag('ul', $links, { class => "LC_CourseBreadcrumbs" });
! 1741: }
1.53 matthew 1742: }
1.223 droeschl 1743:
1.304 foxr 1744:
1.223 droeschl 1745: if ($component) {
1.287 www 1746: $links = &htmltag('span',
1.223 droeschl 1747: ( $no_mt ? $component : mt($component) ).
1748: ( $icons ? $icons : '' ),
1749: { class => 'LC_breadcrumbs_component' } )
1.304 foxr 1750: .$links
1751: ;
1.223 droeschl 1752: }
1753:
1.287 www 1754: &render_tools(\$links);
1755: $links = &htmltag('div', $links,
1.225 bisitz 1756: { id => "LC_breadcrumbs" }) unless ($CourseBreadcrumbs) ;
1.287 www 1757: &render_advtools(\$links);
1.223 droeschl 1758:
1.53 matthew 1759: # Return the @Crumbs stack to what we started with
1760: push(@Crumbs,$last);
1761: shift(@Crumbs);
1.304 foxr 1762:
1763:
1.223 droeschl 1764: # Return the breadcrumb's line
1.304 foxr 1765:
1766:
1767:
1.223 droeschl 1768: return "$links";
1.53 matthew 1769: }
1770:
1771: sub clear_breadcrumbs {
1772: undef(@Crumbs);
1.242 droeschl 1773: undef(%tools);
1.53 matthew 1774: }
1775:
1776: sub add_breadcrumb {
1.232 raeburn 1777: push(@Crumbs,@_);
1.53 matthew 1778: }
1.242 droeschl 1779:
1.309 raeburn 1780: =item &add_breadcrumb_tool($category, $html)
1.261 droeschl 1781:
1782: Adds $html to $category of the breadcrumb toolbar container.
1783:
1784: $html is usually a link to a page that invokes a function on the currently
1785: displayed data (e.g. print when viewing a problem)
1786:
1787: Currently there are 3 possible values for $category:
1788:
1789: =over
1790:
1791: =item navigation
1792: left of breadcrumbs line
1793:
1794: =item tools
1.314 raeburn 1795: remaining items in right of breadcrumbs line
1.261 droeschl 1796:
1797: =item advtools
1798: advanced tools shown in a separate box below breadcrumbs line
1799:
1800: =back
1801:
1802: returns: nothing
1803:
1804: =cut
1.242 droeschl 1805:
1806: sub add_breadcrumb_tool {
1.261 droeschl 1807: my ($category, @html) = @_;
1808: return unless @html;
1.285 raeburn 1809: if (!keys(%tools)) {
1.261 droeschl 1810: %tools = ( navigation => [], tools => [], advtools => []);
1.242 droeschl 1811: }
1.261 droeschl 1812:
1813: #this cleans data received from lonmenu::innerregister
1814: @html = grep {defined $_ && $_ ne ''} @html;
1815: for (@html) {
1816: s/align="(right|left)"//;
1.288 www 1817: # s/<span.*?\/span>// if $category ne 'advtools';
1.261 droeschl 1818: }
1819:
1820: push @{$tools{$category}}, @html;
1.242 droeschl 1821: }
1822:
1.309 raeburn 1823: =item &clear_breadcrumb_tools()
1.261 droeschl 1824:
1825: Clears the breadcrumb toolbar container.
1826:
1827: returns: nothing
1828:
1829: =cut
1830:
1.245 droeschl 1831: sub clear_breadcrumb_tools {
1832: undef(%tools);
1833: }
1834:
1.309 raeburn 1835: =item &render_tools(\$breadcrumbs)
1.261 droeschl 1836:
1837: Creates html for breadcrumb tools (categories navigation and tools) and inserts
1838: \$breadcrumbs at the correct position.
1839:
1840: input: \$breadcrumbs - a reference to the string containing prepared
1841: breadcrumbs.
1842:
1843: returns: nothing
1.309 raeburn 1844:
1.261 droeschl 1845: =cut
1846:
1847: #TODO might split this in separate functions for each category
1848: sub render_tools {
1849: my ($breadcrumbs) = @_;
1.285 raeburn 1850: return unless (keys(%tools));
1.261 droeschl 1851:
1852: my $navigation = list_from_array($tools{navigation},
1853: { listattr => { class=>"LC_breadcrumb_tools_navigation" } });
1854: my $tools = list_from_array($tools{tools},
1855: { listattr => { class=>"LC_breadcrumb_tools_tools" } });
1856: $$breadcrumbs = list_from_array([$navigation, $tools, $$breadcrumbs],
1857: { listattr => { class=>'LC_breadcrumb_tools_outerlist' } });
1858: }
1859:
1.309 raeburn 1860: =pod
1861:
1862: =item &render_advtools(\$breadcrumbs)
1.261 droeschl 1863:
1864: Creates html for advanced tools (category advtools) and inserts \$breadcrumbs
1865: at the correct position.
1866:
1867: input: \$breadcrumbs - a reference to the string containing prepared
1868: breadcrumbs (after render_tools call).
1869:
1870: returns: nothing
1.309 raeburn 1871:
1.261 droeschl 1872: =cut
1873:
1874: sub render_advtools {
1875: my ($breadcrumbs) = @_;
1876: return unless (defined $tools{'advtools'})
1877: and (scalar(@{$tools{'advtools'}}) > 0);
1878:
1879: $$breadcrumbs .= Apache::loncommon::head_subbox(
1880: funclist_from_array($tools{'advtools'}) );
1.242 droeschl 1881: }
1.53 matthew 1882:
1.57 matthew 1883: } # End of scope for @Crumbs
1.53 matthew 1884:
1885: ############################################################
1886: ############################################################
1887:
1.112 raeburn 1888: # Nested table routines.
1889: #
1890: # Routines to display form items in a multi-row table with 2 columns.
1891: # Uses nested tables to divide form elements into segments.
1892: # For examples of use see loncom/interface/lonnotify.pm
1893: #
1894: # Can be used in following order: ...
1895: # &start_pick_box()
1896: # row1
1897: # row2
1898: # row3 ... etc.
1.173 raeburn 1899: # &submit_row()
1.161 raeburn 1900: # &end_pick_box()
1.112 raeburn 1901: #
1902: # where row1, row 2 etc. are chosen from &role_select_row,&course_select_row,
1903: # &status_select_row and &email_default_row
1904: #
1905: # Can also be used in following order:
1906: #
1907: # &start_pick_box()
1908: # &row_title()
1909: # &row_closure()
1910: # &row_title()
1911: # &row_closure() ... etc.
1912: # &submit_row()
1913: # &end_pick_box()
1914: #
1915: # In general a &submit_row() call should proceed the call to &end_pick_box(),
1916: # as this routine adds a button for form submission.
1.113 raeburn 1917: # &submit_row() does not require a &row_closure after it.
1.112 raeburn 1918: #
1919: # &start_pick_box() creates a bounding table with 1-pixel wide black border.
1920: # rows should be placed between calls to &start_pick_box() and &end_pick_box.
1921: #
1922: # &row_title() adds a title in the left column for each segment.
1923: # &row_closure() closes a row with a 1-pixel wide black line.
1924: #
1925: # &role_select_row() provides a select box from which to choose 1 or more roles
1926: # &course_select_row provides ways of picking groups of courses
1927: # radio buttons: all, by category or by picking from a course picker pop-up
1928: # note: by category option is only displayed if a domain has implemented
1929: # selection by year, semester, department, number etc.
1930: #
1931: # &status_select_row() provides a select box from which to choose 1 or more
1932: # access types (current access, prior access, and future access)
1933: #
1934: # &email_default_row() provides text boxes for default e-mail suffixes for
1935: # different authentication types in a domain.
1936: #
1937: # &row_title() and &row_closure() are called internally by the &*_select_row
1938: # routines, but can also be called directly to start and end rows which have
1939: # needs that are not accommodated by the *_select_row() routines.
1940:
1.193 bisitz 1941: { # Start: row_count block for pick_box
1942: my @row_count;
1943:
1.112 raeburn 1944: sub start_pick_box {
1.313 raeburn 1945: my ($css_class,$id) = @_;
1.142 albertel 1946: if (defined($css_class)) {
1947: $css_class = 'class="'.$css_class.'"';
1948: } else {
1949: $css_class= 'class="LC_pick_box"';
1950: }
1.313 raeburn 1951: my $table_id;
1952: if (defined($id)) {
1953: $table_id = ' id="'.$id.'"';
1954: }
1.193 bisitz 1955: unshift(@row_count,0);
1.112 raeburn 1956: my $output = <<"END";
1.313 raeburn 1957: <table $css_class $table_id>
1.112 raeburn 1958: END
1959: return $output;
1960: }
1961:
1962: sub end_pick_box {
1.193 bisitz 1963: shift(@row_count);
1.112 raeburn 1964: my $output = <<"END";
1965: </table>
1966: END
1967: return $output;
1968: }
1969:
1.181 bisitz 1970: sub row_headline {
1971: my $output = <<"END";
1972: <tr><td colspan="2">
1973: END
1974: return $output;
1975: }
1976:
1.112 raeburn 1977: sub row_title {
1.243 amueller 1978: my ($title,$css_title_class,$css_value_class, $css_value_furtherAttributes) = @_;
1.193 bisitz 1979: $row_count[0]++;
1980: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.142 albertel 1981: $css_title_class ||= 'LC_pick_box_title';
1982: $css_title_class = 'class="'.$css_title_class.'"';
1983:
1984: $css_value_class ||= 'LC_pick_box_value';
1985:
1.173 raeburn 1986: if ($title ne '') {
1987: $title .= ':';
1988: }
1.112 raeburn 1989: my $output = <<"ENDONE";
1.243 amueller 1990: <tr class="LC_pick_box_row" $css_value_furtherAttributes>
1.142 albertel 1991: <td $css_title_class>
1.173 raeburn 1992: $title
1.112 raeburn 1993: </td>
1.193 bisitz 1994: <td class="$css_value_class $css_class">
1.112 raeburn 1995: ENDONE
1996: return $output;
1997: }
1998:
1999: sub row_closure {
1.143 albertel 2000: my ($no_separator) =@_;
1.113 raeburn 2001: my $output = <<"ENDTWO";
1.112 raeburn 2002: </td>
2003: </tr>
1.143 albertel 2004: ENDTWO
2005: if (!$no_separator) {
2006: $output .= <<"ENDTWO";
1.112 raeburn 2007: <tr>
1.143 albertel 2008: <td colspan="2" class="LC_pick_box_separator">
1.112 raeburn 2009: </td>
2010: </tr>
2011: ENDTWO
1.143 albertel 2012: }
1.112 raeburn 2013: return $output;
2014: }
2015:
1.193 bisitz 2016: } # End: row_count block for pick_box
2017:
1.112 raeburn 2018: sub role_select_row {
1.147 raeburn 2019: my ($roles,$title,$css_class,$show_separate_custom,$cdom,$cnum) = @_;
1.236 raeburn 2020: my $crstype = 'Course';
2021: if ($cdom ne '' && $cnum ne '') {
2022: $crstype = &Apache::loncommon::course_type($cdom.'_'.$cnum);
2023: }
1.116 raeburn 2024: my $output;
2025: if (defined($title)) {
1.142 albertel 2026: $output = &row_title($title,$css_class);
1.116 raeburn 2027: }
1.142 albertel 2028: $output .= qq|
1.198 bisitz 2029: <select name="roles" multiple="multiple">\n|;
1.113 raeburn 2030: foreach my $role (@$roles) {
1.114 raeburn 2031: my $plrole;
2032: if ($role eq 'ow') {
2033: $plrole = &mt('Course Owner');
1.147 raeburn 2034: } elsif ($role eq 'cr') {
2035: if ($show_separate_custom) {
2036: if ($cdom ne '' && $cnum ne '') {
2037: my %course_customroles = &course_custom_roles($cdom,$cnum);
2038: foreach my $crrole (sort(keys(%course_customroles))) {
2039: my ($plcrrole) = ($crrole =~ m|^cr/[^/]+/[^/]+/(.+)$|);
2040: $output .= ' <option value="'.$crrole.'">'.$plcrrole.
2041: '</option>';
2042: }
2043: }
2044: } else {
2045: $plrole = &mt('Custom Role');
2046: }
1.114 raeburn 2047: } else {
1.236 raeburn 2048: $plrole=&Apache::lonnet::plaintext($role,$crstype);
1.114 raeburn 2049: }
1.147 raeburn 2050: if (($role ne 'cr') || (!$show_separate_custom)) {
2051: $output .= ' <option value="'.$role.'">'.$plrole.'</option>';
2052: }
1.112 raeburn 2053: }
1.142 albertel 2054: $output .= qq| </select>\n|;
1.116 raeburn 2055: if (defined($title)) {
2056: $output .= &row_closure();
2057: }
1.112 raeburn 2058: return $output;
2059: }
2060:
2061: sub course_select_row {
1.142 albertel 2062: my ($title,$formname,$totcodes,$codetitles,$idlist,$idlist_titles,
1.280 raeburn 2063: $css_class,$crstype,$standardnames) = @_;
1.142 albertel 2064: my $output = &row_title($title,$css_class);
1.280 raeburn 2065: $output .= &course_selection($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype,$standardnames);
1.169 raeburn 2066: $output .= &row_closure();
2067: return $output;
2068: }
2069:
2070: sub course_selection {
1.280 raeburn 2071: my ($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype,$standardnames) = @_;
1.169 raeburn 2072: my $output = qq|
1.142 albertel 2073: <script type="text/javascript">
1.218 bisitz 2074: // <![CDATA[
1.112 raeburn 2075: function coursePick (formname) {
2076: for (var i=0; i<formname.coursepick.length; i++) {
1.114 raeburn 2077: if (formname.coursepick[i].value == 'category') {
2078: courseSet('');
2079: }
1.112 raeburn 2080: if (!formname.coursepick[i].checked) {
2081: if (formname.coursepick[i].value == 'specific') {
2082: formname.coursetotal.value = 0;
2083: formname.courselist = '';
2084: }
2085: }
2086: }
2087: }
1.114 raeburn 2088: function setPick (formname) {
2089: for (var i=0; i<formname.coursepick.length; i++) {
2090: if (formname.coursepick[i].value == 'category') {
2091: formname.coursepick[i].checked = true;
2092: }
2093: formname.coursetotal.value = 0;
2094: formname.courselist = '';
2095: }
2096: }
1.218 bisitz 2097: // ]]>
1.112 raeburn 2098: </script>
2099: |;
1.237 raeburn 2100:
2101: my ($allcrs,$pickspec);
2102: if ($crstype eq 'Community') {
2103: $allcrs = &mt('All communities');
2104: $pickspec = &mt('Pick specific communities:');
2105: } else {
2106: $allcrs = &mt('All courses');
2107: $pickspec = &mt('Pick specific course(s):');
2108: }
2109:
1.112 raeburn 2110: my $courseform='<b>'.&Apache::loncommon::selectcourse_link
1.237 raeburn 2111: ($formname,'pickcourse','pickdomain','coursedesc','',1,$crstype).'</b>';
2112: $output .= '<input type="radio" name="coursepick" value="all" onclick="coursePick(this.form)" />'.$allcrs.'<br />';
1.112 raeburn 2113: if ($totcodes > 0) {
2114: my $numtitles = @$codetitles;
2115: if ($numtitles > 0) {
1.129 raeburn 2116: $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 2117: $output .= '<table><tr><td>'.$$codetitles[0].'<br />'."\n".
1.280 raeburn 2118: '<select name="'.$standardnames->[0].
1.114 raeburn 2119: '" onChange="setPick(this.form);courseSet('."'$$codetitles[0]'".')">'."\n".
1.112 raeburn 2120: ' <option value="-1" />Select'."\n";
2121: my @items = ();
2122: my @longitems = ();
2123: if ($$idlist{$$codetitles[0]} =~ /","/) {
1.113 raeburn 2124: @items = split(/","/,$$idlist{$$codetitles[0]});
1.112 raeburn 2125: } else {
2126: $items[0] = $$idlist{$$codetitles[0]};
2127: }
2128: if (defined($$idlist_titles{$$codetitles[0]})) {
2129: if ($$idlist_titles{$$codetitles[0]} =~ /","/) {
1.113 raeburn 2130: @longitems = split(/","/,$$idlist_titles{$$codetitles[0]});
1.112 raeburn 2131: } else {
2132: $longitems[0] = $$idlist_titles{$$codetitles[0]};
2133: }
2134: for (my $i=0; $i<@longitems; $i++) {
2135: if ($longitems[$i] eq '') {
2136: $longitems[$i] = $items[$i];
2137: }
2138: }
2139: } else {
2140: @longitems = @items;
2141: }
2142: for (my $i=0; $i<@items; $i++) {
2143: $output .= ' <option value="'.$items[$i].'">'.$longitems[$i].'</option>';
2144: }
2145: $output .= '</select></td>';
2146: for (my $i=1; $i<$numtitles; $i++) {
2147: $output .= '<td>'.$$codetitles[$i].'<br />'."\n".
1.280 raeburn 2148: '<select name="'.$standardnames->[$i].
1.112 raeburn 2149: '" onChange="courseSet('."'$$codetitles[$i]'".')">'."\n".
2150: '<option value="-1"><-Pick '.$$codetitles[$i-1].'</option>'."\n".
2151: '</select>'."\n".
2152: '</td>';
2153: }
2154: $output .= '</tr></table><br />';
2155: }
2156: }
1.238 raeburn 2157: $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 2158: return $output;
2159: }
2160:
2161: sub status_select_row {
1.142 albertel 2162: my ($types,$title,$css_class) = @_;
1.117 raeburn 2163: my $output;
2164: if (defined($title)) {
1.142 albertel 2165: $output = &row_title($title,$css_class,'LC_pick_box_select');
1.117 raeburn 2166: }
1.142 albertel 2167: $output .= qq|
1.198 bisitz 2168: <select name="types" multiple="multiple">\n|;
1.113 raeburn 2169: foreach my $status_type (sort(keys(%{$types}))) {
1.112 raeburn 2170: $output .= ' <option value="'.$status_type.'">'.$$types{$status_type}.'</option>';
2171: }
1.142 albertel 2172: $output .= qq| </select>\n|;
1.117 raeburn 2173: if (defined($title)) {
2174: $output .= &row_closure();
2175: }
1.112 raeburn 2176: return $output;
2177: }
2178:
2179: sub email_default_row {
1.142 albertel 2180: my ($authtypes,$title,$descrip,$css_class) = @_;
2181: my $output = &row_title($title,$css_class);
2182: $output .= $descrip.
2183: &Apache::loncommon::start_data_table().
2184: &Apache::loncommon::start_data_table_header_row().
2185: '<th>'.&mt('Authentication Method').'</th>'.
2186: '<th align="right">'.&mt('Username -> e-mail conversion').'</th>'."\n".
2187: &Apache::loncommon::end_data_table_header_row();
1.112 raeburn 2188: my $rownum = 0;
1.113 raeburn 2189: foreach my $auth (sort(keys(%{$authtypes}))) {
1.112 raeburn 2190: my ($userentry,$size);
2191: if ($auth =~ /^krb/) {
2192: $userentry = '';
2193: $size = 25;
2194: } else {
2195: $userentry = 'username@';
2196: $size = 15;
2197: }
1.142 albertel 2198: $output .= &Apache::loncommon::start_data_table_row().
2199: '<td> '.$$authtypes{$auth}.'</td>'.
2200: '<td align="right">'.$userentry.
2201: '<input type="text" name="'.$auth.'" size="'.$size.'" /></td>'.
2202: &Apache::loncommon::end_data_table_row();
1.112 raeburn 2203: }
1.142 albertel 2204: $output .= &Apache::loncommon::end_data_table();
1.112 raeburn 2205: $output .= &row_closure();
2206: return $output;
2207: }
2208:
2209:
2210: sub submit_row {
1.142 albertel 2211: my ($title,$cmd,$submit_text,$css_class) = @_;
2212: my $output = &row_title($title,$css_class,'LC_pick_box_submit');
1.112 raeburn 2213: $output .= qq|
2214: <br />
2215: <input type="hidden" name="command" value="$cmd" />
2216: <input type="submit" value="$submit_text"/>
2217: <br /><br />
1.142 albertel 2218: \n|;
1.112 raeburn 2219: return $output;
2220: }
1.1 stredwic 2221:
1.147 raeburn 2222: sub course_custom_roles {
2223: my ($cdom,$cnum) = @_;
2224: my %returnhash=();
2225: my %coursepersonnel=&Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
2226: foreach my $person (sort(keys(%coursepersonnel))) {
2227: my ($role) = ($person =~ /^([^:]+):/);
2228: my ($end,$start) = split(/:/,$coursepersonnel{$person});
2229: if ($end == -1 && $start == -1) {
2230: next;
2231: }
2232: if ($role =~ m|^cr/[^/]+/[^/]+/[^/]|) {
2233: $returnhash{$role} ++;
2234: }
2235: }
2236: return %returnhash;
2237: }
2238:
2239:
1.270 www 2240: sub resource_info_box {
1.300 raeburn 2241: my ($symb,$onlyfolderflag,$stuvcurrent,$stuvdisp)=@_;
1.270 www 2242: my $return='';
1.300 raeburn 2243: if ($stuvcurrent ne '') {
2244: $return = '<div class="LC_left_float">';
2245: }
1.270 www 2246: if ($symb) {
1.300 raeburn 2247: $return.=&Apache::loncommon::start_data_table();
1.271 www 2248: my ($map,$id,$resource)=&Apache::lonnet::decode_symb($symb);
2249: my $folder=&Apache::lonnet::gettitle($map);
2250: $return.=&Apache::loncommon::start_data_table_row().
1.300 raeburn 2251: '<th align="left">'.&mt('Folder:').'</th><td>'.$folder.'</td>'.
1.271 www 2252: &Apache::loncommon::end_data_table_row();
1.270 www 2253: unless ($onlyfolderflag) {
2254: $return.=&Apache::loncommon::start_data_table_row().
1.300 raeburn 2255: '<th align="left">'.&mt('Resource:').'</th><td>'.&Apache::lonnet::gettitle($symb).'</td>'.
2256: &Apache::loncommon::end_data_table_row();
2257: }
2258: if ($stuvcurrent ne '') {
2259: $return .= &Apache::loncommon::start_data_table_row().
2260: '<th align="left">'.&mt("Student's current version:").'</th><td>'.$stuvcurrent.'</td>'.
2261: &Apache::loncommon::end_data_table_row();
2262: }
2263: if ($stuvdisp ne '') {
2264: $return .= &Apache::loncommon::start_data_table_row().
2265: '<th align="left">'.&mt("Student's version displayed:").'</th><td>'.$stuvdisp.'</td>'.
1.270 www 2266: &Apache::loncommon::end_data_table_row();
2267: }
1.271 www 2268: $return.=&Apache::loncommon::end_data_table();
1.270 www 2269: } else {
2270: $return='<p><span class="LC_error">'.&mt('No context provided.').'</span></p>';
2271: }
1.300 raeburn 2272: if ($stuvcurrent ne '') {
2273: $return .= '</div>';
2274: }
1.270 www 2275: return $return;
2276: }
2277:
1.119 raeburn 2278: ##############################################
2279: ##############################################
1.179 raeburn 2280:
2281: # topic_bar
2282: #
1.248 wenzelju 2283: # Generates a div containing an (optional) number with a white background followed by a
1.240 raeburn 2284: # title with a background color defined in the corresponding CSS: LC_topic_bar
2285: # Inputs:
1.248 wenzelju 2286: # 1. number to display.
2287: # If input for number is empty only the title will be displayed.
1.240 raeburn 2288: # 2. title text to display.
1.313 raeburn 2289: # 3. optional id for the <div>
1.240 raeburn 2290: # Outputs - a scalar containing html mark-up for the div.
2291:
1.179 raeburn 2292: sub topic_bar {
1.313 raeburn 2293: my ($num,$title,$id) = @_;
1.248 wenzelju 2294: my $number = '';
2295: if ($num ne '') {
2296: $number = '<span>'.$num.'</span>';
1.239 amueller 2297: }
1.313 raeburn 2298: if ($id ne '') {
2299: $id = 'id="'.$id.'"';
2300: }
2301: return '<div class="LC_topic_bar" '.$id.'>'.$number.$title.'</div>';
1.179 raeburn 2302: }
2303:
2304: ##############################################
2305: ##############################################
1.119 raeburn 2306: # echo_form_input
2307: #
2308: # Generates html markup to add form elements from the referrer page
2309: # as hidden form elements (values encoded) in the new page.
2310: #
2311: # Intended to support two types of use
2312: # (a) to allow backing up to earlier pages in a multi-page
2313: # form submission process using a breadcrumb trail.
2314: #
2315: # (b) to allow the current page to be reloaded with form elements
2316: # set on previous page to remain unchanged. An example would
2317: # be where the a page containing a dynamically-built table of data is
2318: # is to be redisplayed, with only the sort order of the data changed.
2319: #
2320: # Inputs:
2321: # 1. Reference to array of form elements in the submitted form on
2322: # the referrer page which are to be excluded from the echoed elements.
2323: #
2324: # 2. Reference to array of regular expressions, which if matched in the
2325: # name of the form element n the referrer page will be omitted from echo.
2326: #
2327: # Outputs: A scalar containing the html markup for the echoed form
2328: # elements (all as hidden elements, with values encoded).
2329:
2330:
2331: sub echo_form_input {
2332: my ($excluded,$regexps) = @_;
2333: my $output = '';
2334: foreach my $key (keys(%env)) {
2335: if ($key =~ /^form\.(.+)$/) {
2336: my $name = $1;
2337: my $match = 0;
1.285 raeburn 2338: if (ref($excluded) eq 'ARRAY') {
2339: next if (grep(/^\Q$name\E$/,@{$excluded}));
2340: }
2341: if (ref($regexps) eq 'ARRAY') {
2342: if (@{$regexps} > 0) {
2343: foreach my $regexp (@{$regexps}) {
2344: if ($name =~ /$regexp/) {
2345: $match = 1;
2346: last;
1.119 raeburn 2347: }
2348: }
2349: }
1.285 raeburn 2350: }
2351: next if ($match);
2352: if (ref($env{$key}) eq 'ARRAY') {
2353: foreach my $value (@{$env{$key}}) {
2354: $value = &HTML::Entities::encode($value,'<>&"');
2355: $output .= '<input type="hidden" name="'.$name.
2356: '" value="'.$value.'" />'."\n";
1.119 raeburn 2357: }
1.285 raeburn 2358: } else {
2359: my $value = &HTML::Entities::encode($env{$key},'<>&"');
2360: $output .= '<input type="hidden" name="'.$name.
2361: '" value="'.$value.'" />'."\n";
1.119 raeburn 2362: }
2363: }
2364: }
2365: return $output;
2366: }
2367:
2368: ##############################################
2369: ##############################################
2370: # set_form_elements
2371: #
2372: # Generates javascript to set form elements to values based on
2373: # corresponding values for the same form elements when the page was
2374: # previously submitted.
2375: #
2376: # Last submission values are read from hidden form elements in referring
2377: # page which have the same name, i.e., generated by &echo_form_input().
2378: #
2379: # Intended to be called by onload event.
2380: #
1.121 raeburn 2381: # Inputs:
2382: # (a) Reference to hash of echoed form elements to be set.
1.119 raeburn 2383: #
2384: # In the hash, keys are the form element names, and the values are the
2385: # element type (selectbox, radio, checkbox or text -for textbox, textarea or
2386: # hidden).
1.121 raeburn 2387: #
2388: # (b) Optional reference to hash of stored elements to be set.
2389: #
2390: # If the page being displayed is a page which permits modification of
2391: # previously stored data, e.g., the first page in a multi-page submission,
2392: # then if stored is supplied, form elements will be set to the last stored
2393: # values. If user supplied values are also available for the same elements
2394: # these will replace the stored values.
2395: #
1.119 raeburn 2396: # Output:
2397: #
2398: # javascript function - set_form_elements() which sets form elements,
2399: # expects an argument: formname - the name of the form according to
2400: # the DOM, e.g., document.compose
2401:
2402: sub set_form_elements {
1.121 raeburn 2403: my ($elements,$stored) = @_;
2404: my %values;
1.119 raeburn 2405: my $output .= 'function setFormElements(courseForm) {
1.121 raeburn 2406: ';
2407: if (defined($stored)) {
2408: foreach my $name (keys(%{$stored})) {
2409: if (exists($$elements{$name})) {
2410: if (ref($$stored{$name}) eq 'ARRAY') {
2411: $values{$name} = $$stored{$name};
2412: } else {
2413: @{$values{$name}} = ($$stored{$name});
2414: }
2415: }
2416: }
2417: }
2418:
1.119 raeburn 2419: foreach my $key (keys(%env)) {
2420: if ($key =~ /^form\.(.+)$/) {
2421: my $name = $1;
2422: if (exists($$elements{$name})) {
1.121 raeburn 2423: @{$values{$name}} = &Apache::loncommon::get_env_multiple($key);
2424: }
2425: }
2426: }
2427:
2428: foreach my $name (keys(%values)) {
2429: for (my $i=0; $i<@{$values{$name}}; $i++) {
2430: $values{$name}[$i] = &HTML::Entities::decode($values{$name}[$i],'<>&"');
2431: $values{$name}[$i] =~ s/([\r\n\f]+)/\\n/g;
2432: $values{$name}[$i] =~ s/"/\\"/g;
2433: }
1.234 raeburn 2434: if (($$elements{$name} eq 'text') || ($$elements{$name} eq 'hidden')) {
1.121 raeburn 2435: my $numvalues = @{$values{$name}};
2436: if ($numvalues > 1) {
2437: my $valuestring = join('","',@{$values{$name}});
2438: $output .= qq|
1.119 raeburn 2439: var textvalues = new Array ("$valuestring");
1.147 raeburn 2440: var total = courseForm.elements['$name'].length;
1.119 raeburn 2441: if (total > $numvalues) {
2442: total = $numvalues;
2443: }
2444: for (var i=0; i<total; i++) {
1.147 raeburn 2445: courseForm.elements['$name']\[i].value = textvalues[i];
1.119 raeburn 2446: }
2447: |;
1.121 raeburn 2448: } else {
2449: $output .= qq|
1.147 raeburn 2450: courseForm.elements['$name'].value = "$values{$name}[0]";
1.119 raeburn 2451: |;
1.121 raeburn 2452: }
2453: } else {
2454: $output .= qq|
1.147 raeburn 2455: var elementLength = courseForm.elements['$name'].length;
1.119 raeburn 2456: if (elementLength==undefined) {
2457: |;
1.121 raeburn 2458: foreach my $value (@{$values{$name}}) {
2459: if ($$elements{$name} eq 'selectbox') {
2460: $output .= qq|
1.147 raeburn 2461: if (courseForm.elements['$name'].options[0].value == "$value") {
2462: courseForm.elements['$name'].options[0].selected = true;
1.119 raeburn 2463: }|;
1.121 raeburn 2464: } elsif (($$elements{$name} eq 'radio') ||
2465: ($$elements{$name} eq 'checkbox')) {
2466: $output .= qq|
1.147 raeburn 2467: if (courseForm.elements['$name'].value == "$value") {
1.148 albertel 2468: courseForm.elements['$name'].checked = true;
1.234 raeburn 2469: } else {
2470: courseForm.elements['$name'].checked = false;
1.119 raeburn 2471: }|;
1.121 raeburn 2472: }
2473: }
2474: $output .= qq|
1.119 raeburn 2475: }
2476: else {
1.147 raeburn 2477: for (var i=0; i<courseForm.elements['$name'].length; i++) {
1.119 raeburn 2478: |;
1.121 raeburn 2479: if ($$elements{$name} eq 'selectbox') {
2480: $output .= qq|
1.147 raeburn 2481: courseForm.elements['$name'].options[i].selected = false;|;
1.121 raeburn 2482: } elsif (($$elements{$name} eq 'radio') ||
2483: ($$elements{$name} eq 'checkbox')) {
2484: $output .= qq|
1.147 raeburn 2485: courseForm.elements['$name']\[i].checked = false;|;
1.121 raeburn 2486: }
2487: $output .= qq|
1.119 raeburn 2488: }
1.147 raeburn 2489: for (var j=0; j<courseForm.elements['$name'].length; j++) {
1.119 raeburn 2490: |;
1.121 raeburn 2491: foreach my $value (@{$values{$name}}) {
2492: if ($$elements{$name} eq 'selectbox') {
2493: $output .= qq|
1.147 raeburn 2494: if (courseForm.elements['$name'].options[j].value == "$value") {
2495: courseForm.elements['$name'].options[j].selected = true;
1.119 raeburn 2496: }|;
1.121 raeburn 2497: } elsif (($$elements{$name} eq 'radio') ||
2498: ($$elements{$name} eq 'checkbox')) {
2499: $output .= qq|
1.147 raeburn 2500: if (courseForm.elements['$name']\[j].value == "$value") {
2501: courseForm.elements['$name']\[j].checked = true;
1.119 raeburn 2502: }|;
1.121 raeburn 2503: }
2504: }
2505: $output .= qq|
1.119 raeburn 2506: }
2507: }
2508: |;
2509: }
2510: }
2511: $output .= "
1.235 raeburn 2512: return;
1.119 raeburn 2513: }\n";
2514: return $output;
2515: }
2516:
1.158 raeburn 2517: ##############################################
2518: ##############################################
2519:
1.291 raeburn 2520: sub file_submissionchk_js {
2521: my ($turninpaths,$multiples) = @_;
2522: my $overwritewarn = &mt('File(s) you uploaded for your submission will overwrite existing file(s) submitted for this item').'\\n'.
2523: &mt('Continue submission and overwrite the file(s)?');
2524: my $delfilewarn = &mt('You have indicated you wish to remove some files previously included in your submission.').'\\n'.
2525: &mt('Continue submission with these files removed?');
1.292 raeburn 2526: my ($turninpathtext,$multtext,$arrayindexofjs);
1.291 raeburn 2527: if (ref($turninpaths) eq 'HASH') {
2528: foreach my $key (sort(keys(%{$turninpaths}))) {
2529: $turninpathtext .= " if (prefix == '$key') {\n".
2530: " return '$turninpaths->{$key}';\n".
2531: " }\n";
2532: }
2533: }
2534: $turninpathtext .= " return '';\n";
2535: if (ref($multiples) eq 'HASH') {
2536: foreach my $key (sort(keys(%{$multiples}))) {
2537: $multtext .= " if (prefix == '$key') {\n".
2538: " return '$multiples->{$key}';\n".
2539: " }\n";
2540: }
2541: }
2542: $multtext .= " return '';\n";
1.292 raeburn 2543:
1.293 raeburn 2544: $arrayindexofjs = &Apache::loncommon::javascript_array_indexof();
1.291 raeburn 2545: return <<"ENDSCRIPT";
2546: <script type="text/javascript">
2547: // <![CDATA[
2548:
2549: function file_submission_check(formname,path,multiresp) {
2550: var elemnum = formname.elements.length;
2551: if (elemnum == 0) {
2552: return true;
2553: }
2554: var alloverwrites = [];
2555: var alldelconfirm = [];
2556: var result = [];
2557: var submitter;
2558: var subprefix;
2559: var allsub = getIndexByName(formname,'all_submit');
2560: if (allsub == -1) {
2561: var idx = getIndexByName(formname,'submitted');
2562: if (idx != -1) {
2563: var subval = String(formname.elements[idx].value);
2564: submitter = subval.replace(/^part_/,'');
2565: result = overwritten_check(formname,path,multiresp,submitter);
2566: alloverwrites.push.apply(alloverwrites,result['overwrite']);
2567: alldelconfirm.push.apply(alldelconfirm,result['delete']);
2568: }
2569: } else {
2570: if (formname.elements[allsub].type == 'submit') {
2571: var partsub = /^\\d+\\.\\d+_submit_.+\$/;
2572: var allprefixes = [];
2573: var allparts = [];
2574: for (var i=0; i<formname.elements.length; i++) {
2575: if (formname.elements[i].type == 'submit') {
2576: var elemname = formname.elements[i].name;
2577: var subname = String(elemname);
2578: var savesub = String(elemname);
2579: if (partsub.test(subname)) {
2580: var prefix = subname.replace(/_submit_.+\$/,'');
2581: if (allprefixes.indexOf(prefix) == -1) {
2582: allprefixes.push(prefix);
2583: allparts[prefix] = [];
2584: }
2585: var part = savesub.replace(/^\\d+\\.\\d+_submit_/,'');
2586: allparts[prefix].push(part);
2587: }
2588: }
2589: }
2590: for (var k=0; k<allprefixes.length; k++) {
2591: var idx = getIndexByName(formname,allprefixes[k]+'_submitted');
2592: if (idx > -1) {
2593: if (formname.elements[idx].value != 'yes') {
2594: submitterval = formname.elements[idx].value;
2595: submitter = submitterval.replace(/^part_/,'');
2596: subprefix = allprefixes[k];
2597: result = overwritten_check(formname,path,multiresp,submitter,subprefix);
2598: alloverwrites.push.apply(alloverwrites,result['overwrite']);
2599: alldelconfirm.push.apply(alldelconfirm,result['delete']);
2600: break;
2601: }
2602: }
2603: }
2604: if (submitter == '' || submitter == undefined) {
2605: for (var m=0; m<allprefixes.length; m++) {
2606: for (var n=0; n<allparts[allprefixes[m]].length; n++) {
2607: var result = overwritten_check(formname,path,multiresp,allparts[allprefixes[m]][n],allprefixes[m]);
2608: alloverwrites.push.apply(alloverwrites,result['overwrite']);
2609: alldelconfirm.push.apply(alldelconfirm,result['delete']);
2610: }
2611: }
2612: }
2613: }
2614: }
2615: if (alloverwrites.length > 0) {
2616: if (!confirm("$overwritewarn")) {
2617: for (var n=0; n<alloverwrites.length; n++) {
2618: formname.elements[alloverwrites[n]].value = "";
2619: }
2620: return false;
2621: }
2622: }
2623: if (alldelconfirm.length > 0) {
2624: if (!confirm("$delfilewarn")) {
2625: for (var p=0; p<alldelconfirm.length; p++) {
2626: formname.elements[alldelconfirm[p]].checked = false;
2627: }
2628: return false;
2629: }
2630: }
2631: return true;
2632: }
2633:
2634: function getIndexByName(formname,item) {
2635: for (var i=0;i<formname.elements.length;i++) {
2636: if (formname.elements[i].name == item) {
2637: return i;
2638: }
2639: }
2640: return -1;
2641: }
2642:
2643: function overwritten_check(formname,path,multiresp,part,prefix) {
2644: var result = [];
2645: result['overwrite'] = [];
2646: result['delete'] = [];
2647: var elemnum = formname.elements.length;
2648: if (elemnum == 0) {
2649: return result;
2650: }
2651: var uploadstr;
2652: var deletestr;
2653: if ((prefix != undefined) && (prefix != '')) {
2654: var prepend = prefix+'_';
2655: uploadstr = new RegExp("^"+prepend+"HWFILE"+part+".+\$");
2656: deletestr = new RegExp("^"+prepend+"HWFILE"+part+".+_\\\\d+_delete\$");
2657: multiresp = check_for_multiples(prepend);
2658: path = check_for_turninpath(prepend);
2659: } else {
2660: uploadstr = new RegExp("^HWFILE"+part+".+\$");
2661: deletestr = new RegExp("^HWFILE"+part+".+_\\\\d+_delete\$");
2662: }
2663: var alluploads = [];
2664: var allchecked = [];
2665: var allskipdel = [];
2666: var fnametrim = /[^\\/\\\\]+\$/;
2667: for (var i=0; i<formname.elements.length; i++) {
2668: var id = formname.elements[i].id;
2669: if (id != '') {
2670: if (uploadstr.test(id)) {
2671: if (formname.elements[i].type == 'file') {
2672: alluploads.push(id);
2673: } else {
2674: if (deletestr.test(id)) {
2675: if (formname.elements[i].type == 'checkbox') {
2676: if (formname.elements[i].checked) {
2677: allchecked.push(id);
2678: }
2679: }
2680: }
2681: }
2682: }
2683: }
2684: }
2685: for (var j=0; j<alluploads.length; j++) {
2686: var delstr = new RegExp("^"+alluploads[j]+"_\\\\d+_delete\$");
2687: var delboxes = [];
2688: for (var k=0; k<formname.elements.length; k++) {
2689: var id = formname.elements[k].id;
2690: if ((id != '') && (id != undefined)) {
2691: if (delstr.test(id)) {
2692: if (formname.elements[k].type == 'checkbox') {
2693: delboxes.push(id);
2694: }
2695: }
2696: }
2697: }
2698: if (delboxes.length > 0) {
2699: if ((formname.elements[alluploads[j]].value != undefined) &&
2700: (formname.elements[alluploads[j]].value != '')) {
2701: var filepath = formname.elements[alluploads[j]].value;
2702: var newfilename = fnametrim.exec(filepath);
2703: if (newfilename != null) {
2704: var filename = String(newfilename);
2705: var nospaces = filename.replace(/\\s+/g,'_');
2706: var nospecials = nospaces.replace(/[^\\/\\w\\.\\-]/g,'');
2707: var cleanfilename = nospecials.replace(/\\.(\\d+\\.)/g,"_\$1");
2708: if (cleanfilename != '') {
2709: var fullpath = path+"/"+cleanfilename;
2710: if (multiresp == 1) {
2711: var partid = String(alluploads[i]);
2712: var subdir = partid.replace(/^\\d*.?\\d*_?HWFILE/,'');
2713: if (subdir != "" && subdir != undefined) {
2714: fullpath = path+"/"+subdir+"/"+cleanfilename;
2715: }
2716: }
2717: for (var m=0; m<delboxes.length; m++) {
2718: if (fullpath == formname.elements[delboxes[m]].value) {
2719: if (formname.elements[delboxes[m]].checked) {
2720: allskipdel.push(delboxes[m]);
2721: } else {
2722: result['overwrite'].push(alluploads[j]);
2723: }
2724: break;
2725: }
2726: }
2727: }
2728: }
2729: }
2730: }
2731: }
2732: if (allchecked.length > 0) {
2733: if (allskipdel.length > 0) {
2734: for (var n=0; n<allchecked.length; n++) {
2735: if (allskipdel.indexOf(allchecked[n]) == -1) {
2736: result['delete'].push(allchecked[n]);
2737: }
2738: }
2739: } else {
2740: result['delete'].push.apply(result['delete'],allchecked);
2741: }
2742: }
2743: return result;
2744: }
2745:
2746: function check_for_multiples(prefix) {
2747: $multtext
2748: }
2749:
2750: function check_for_turninpath(prefix) {
2751: $turninpathtext
2752: }
2753:
2754: // ]]>
2755: </script>
2756:
1.292 raeburn 2757: $arrayindexofjs
2758:
1.291 raeburn 2759: ENDSCRIPT
2760: }
2761:
2762: ##############################################
2763: ##############################################
2764:
1.313 raeburn 2765: sub resize_scrollbox_js {
2766: my ($context,$tabidstr) = @_;
2767: my (%names,$paddingwfrac,$offsetwfrac,$offsetv,$minw,$minv);
2768: if ($context eq 'docs') {
2769: %names = (
2770: boxw => 'contenteditor',
2771: item => 'contentlist',
2772: header => 'uploadfileresult',
2773: scroll => 'contentscroll',
2774: boxh => 'contenteditor',
2775: );
2776: $paddingwfrac = 0.09;
2777: $offsetwfrac = 0.015;
2778: $offsetv = 20;
2779: $minw = 250;
2780: $minv = 200;
2781: } elsif ($context eq 'params') {
2782: %names = (
2783: boxw => 'parameditor',
2784: item => 'mapmenuinner',
2785: header => 'parmstep1',
2786: scroll => 'mapmenuscroll',
2787: boxh => 'parmlevel',
2788: );
2789: $paddingwfrac = 0.2;
2790: $offsetwfrac = 0.015;
2791: $offsetv = 80;
2792: $minw = 100;
2793: $minv = 100;
2794: }
2795: my $viewport_js = &Apache::loncommon::viewport_geometry_js();
2796: my $output = '
2797:
2798: window.onresize=callResize;
2799:
2800: ';
2801: if ($context eq 'docs') {
2802: $output .= '
2803: var activeTab;
2804: ';
2805: }
2806: $output .= <<"FIRST";
2807:
2808: $viewport_js
2809:
2810: function resize_scrollbox(scrollboxname,chkw,chkh) {
2811: var scrollboxid = 'div_'+scrollboxname;
2812: var scrolltableid = 'table_'+scrollboxname;
2813: var scrollbox;
2814: var scrolltable;
2815:
2816: if (document.getElementById("$names{'boxw'}") == null) {
2817: return;
2818: }
2819:
2820: if (document.getElementById(scrollboxid) == null) {
2821: return;
2822: } else {
2823: scrollbox = document.getElementById(scrollboxid);
2824: }
2825:
2826:
2827: if (document.getElementById(scrolltableid) == null) {
2828: return;
2829: } else {
2830: scrolltable = document.getElementById(scrolltableid);
2831: }
2832:
2833: init_geometry();
2834: var vph = Geometry.getViewportHeight();
2835: var vpw = Geometry.getViewportWidth();
2836:
2837: FIRST
2838: if ($context eq 'docs') {
2839: $output .= "
2840: var alltabs = ['$tabidstr'];
2841: ";
2842: } elsif ($context eq 'params') {
2843: $output .= "
2844: if (document.getElementById('$names{'boxh'}') == null) {
2845: return;
2846: }
2847: ";
2848: }
2849: $output .= <<"SECOND";
2850: var listwchange;
2851: if (chkw == 1) {
2852: var boxw = document.getElementById("$names{'boxw'}").offsetWidth;
2853: var itemw;
2854: var itemid = document.getElementById("$names{'item'}");
2855: if (itemid != null) {
2856: itemw = itemid.offsetWidth;
2857: }
2858: var itemwstart = itemw;
2859:
2860: var scrollboxw = scrollbox.offsetWidth;
2861: var scrollboxscrollw = scrollbox.scrollWidth;
2862:
2863: var offsetw = parseInt(vpw * $offsetwfrac);
2864: var paddingw = parseInt(vpw * $paddingwfrac);
2865:
2866: var minscrollboxw = $minw;
2867: var maxcolw = 0;
2868: SECOND
2869: if ($context eq 'docs') {
2870: $output .= <<"DOCSONE";
2871: var actabw = 0;
2872: for (var i=0; i<alltabs.length; i++) {
2873: if (activeTab == alltabs[i]) {
2874: actabw = document.getElementById(alltabs[i]).offsetWidth;
2875: if (actabw > maxcolw) {
2876: maxcolw = actabw;
2877: }
2878: } else {
2879: if (document.getElementById(alltabs[i]) != null) {
2880: var thistab = document.getElementById(alltabs[i]);
2881: thistab.style.visibility = 'hidden';
2882: thistab.style.display = 'block';
2883: var tabw = document.getElementById(alltabs[i]).offsetWidth;
2884: thistab.style.display = 'none';
2885: thistab.style.visibility = '';
2886: if (tabw > maxcolw) {
2887: maxcolw = tabw;
2888: }
2889: }
2890: }
2891: }
2892: DOCSONE
2893: } elsif ($context eq 'params') {
2894: $output .= <<"PARAMSONE";
2895: var parmlevelrows = new Array();
2896: var mapmenucells = new Array();
2897: parmlevelrows = document.getElementById("$names{'boxh'}").rows;
2898: var numrows = parmlevelrows.length;
2899: if (numrows > 1) {
2900: mapmenucells = parmlevelrows[2].getElementsByTagName('td');
2901: }
2902: maxcolw = mapmenucells[0].offsetWidth;
2903: PARAMSONE
2904: }
2905: $output .= <<"THIRD";
2906: if (maxcolw > 0) {
2907: var newscrollboxw;
2908: if (maxcolw+paddingw+scrollboxscrollw<boxw) {
2909: newscrollboxw = boxw-paddingw-maxcolw;
2910: if (newscrollboxw < minscrollboxw) {
2911: newscrollboxw = minscrollboxw;
2912: }
2913: scrollbox.style.width = newscrollboxw+"px";
2914: if (newscrollboxw != scrollboxw) {
2915: var newitemw = newscrollboxw-offsetw;
2916: itemid.style.width = newitemw+"px";
2917: }
2918: } else {
2919: newscrollboxw = boxw-paddingw-maxcolw;
2920: if (newscrollboxw < minscrollboxw) {
2921: newscrollboxw = minscrollboxw;
2922: }
2923: scrollbox.style.width = newscrollboxw+"px";
2924: if (newscrollboxw != scrollboxw) {
2925: var newitemw = newscrollboxw-offsetw;
2926: itemid.style.width = newitemw+"px";
2927: }
2928: }
2929:
2930: if (newscrollboxw != scrollboxw) {
2931: var newscrolltablew = newscrollboxw+offsetw;
2932: scrolltable.style.width = newscrolltablew+"px";
2933: }
2934: }
2935:
2936: if (itemid.offsetWidth != itemwstart) {
2937: listwchange = 1;
2938: }
2939: }
2940: if ((chkh == 1) || (listwchange)) {
2941: var primaryheight = document.getElementById('LC_nav_bar').offsetHeight;
2942: var secondaryheight = document.getElementById('LC_secondary_menu').offsetHeight;
2943: var crumbsheight = document.getElementById('LC_breadcrumbs').offsetHeight;
2944: var dccidheight = 0;
2945: if (document.getElementById('dccid') != null) {
2946: dccidheight = document.getElementById('dccid').offsetHeight;
2947: }
2948: var headerheight = 0;
2949: if (document.getElementById("$names{'header'}") != null) {
2950: headerheight = document.getElementById("$names{'header'}").offsetHeight;
2951: }
2952: var tabbedheight = document.getElementById("tabbededitor").offsetHeight;
2953: var boxheight = document.getElementById("$names{'boxh'}").offsetHeight;
2954: var freevspace = vph-(primaryheight+secondaryheight+crumbsheight+dccidheight+headerheight+tabbedheight+boxheight);
2955:
2956: var scrollboxheight = scrollbox.offsetHeight;
2957: var scrollboxscrollheight = scrollbox.scrollHeight;
2958:
2959: var minvscrollbox = $minv;
2960: var offsetv = $offsetv;
2961: var newscrollboxheight;
2962: if (freevspace < 0) {
2963: newscrollboxheight = scrollboxheight+freevspace-offsetv;
2964: if (newscrollboxheight < minvscrollbox) {
2965: newscrollboxheight = minvscrollbox;
2966: }
2967: scrollbox.style.height = newscrollboxheight + "px";
2968: } else {
2969: if (scrollboxscrollheight > scrollboxheight) {
2970: if (freevspace > offsetv) {
2971: newscrollboxheight = scrollboxheight+freevspace-offsetv;
2972: if (newscrollboxheight < minvscrollbox) {
2973: newscrollboxheight = minvscrollbox;
2974: }
2975: scrollbox.style.height = newscrollboxheight+"px";
2976: }
2977: }
2978: }
2979: scrollboxheight = scrollbox.offsetHeight;
2980: var itemh = document.getElementById("$names{'item'}").offsetHeight;
2981:
2982: if (scrollboxscrollheight <= scrollboxheight) {
2983: if ((itemh+offsetv)<scrollboxheight) {
2984: newscrollheight = itemh+offsetv;
2985: scrollbox.style.height = newscrollheight+"px";
2986: }
2987: }
2988: }
2989: return;
2990: }
2991:
2992: function callResize() {
2993: var timer;
2994: clearTimeout(timer);
2995: timer=setTimeout('resize_scrollbox("$names{'scroll'}","1","1")',500);
2996: }
2997:
1.329 raeburn 2998: THIRD
1.313 raeburn 2999: return $output;
3000: }
3001:
1.328 raeburn 3002: ##############################################
3003: ##############################################
3004:
3005: sub javascript_jumpto_resource {
3006: my $confirm_switch = &mt("Editing requires switching to the resource's home server.").'\n'.
3007: &mt('Switch server?');
3008: return (<<ENDUTILITY)
3009:
3010: function go(url) {
3011: if (url!='' && url!= null) {
3012: currentURL = null;
3013: currentSymb= null;
3014: window.location.href=url;
3015: }
3016: }
3017:
3018: function need_switchserver(url) {
3019: if (url!='' && url!= null) {
3020: if (confirm("$confirm_switch")) {
3021: go(url);
3022: }
3023: }
3024: return;
3025: }
3026:
3027: ENDUTILITY
3028:
3029: }
3030:
3031: sub jump_to_editres {
1.330 ! raeburn 3032: my ($cfile,$home,$switchserver,$forceedit,$forcereg,$symb) = @_;
1.328 raeburn 3033: my $jscall;
3034: if ($switchserver) {
3035: if ($symb && $home) {
3036: $cfile = '/adm/switchserver?otherserver='.$home.'&role='.
1.330 ! raeburn 3037: &HTML::Entities::encode($env{'request.role'},'"<>&').
! 3038: '&symb='.&HTML::Entities::encode($symb,'"<>&');
! 3039: if ($forceedit) {
1.328 raeburn 3040: $cfile .= '&forceedit=1';
3041: }
1.330 ! raeburn 3042: if ($forcereg) {
! 3043: $cfile .= '&register=1';
! 3044: }
1.328 raeburn 3045: $jscall = "need_switchserver('$cfile');";
3046: }
3047: } else {
1.330 ! raeburn 3048: unless ($cfile =~ m{^/priv/}) {
! 3049: if ($symb) {
! 3050: $cfile .= (($cfile=~/\?/)?'&':'?')."symb=$symb";
! 3051: }
! 3052: if ($forceedit) {
! 3053: $cfile .= (($cfile=~/\?/)?'&':'?').'forceedit=1';
! 3054: }
! 3055: if ($forcereg) {
! 3056: $cfile .= (($cfile=~/\?/)?'&':'?').'register=1';
! 3057: }
1.328 raeburn 3058: }
3059: $jscall = "go('$cfile')";
3060: }
3061: return $jscall;
3062: }
1.313 raeburn 3063:
3064: ##############################################
3065: ##############################################
3066:
1.158 raeburn 3067: # javascript_valid_email
3068: #
3069: # Generates javascript to validate an e-mail address.
3070: # Returns a javascript function which accetps a form field as argumnent, and
3071: # returns false if field.value does not satisfy two regular expression matches
3072: # for a valid e-mail address. Backwards compatible with old browsers without
3073: # support for javascript RegExp (just checks for @ in field.value in this case).
3074:
3075: sub javascript_valid_email {
3076: my $scripttag .= <<'END';
3077: function validmail(field) {
3078: var str = field.value;
3079: if (window.RegExp) {
3080: var reg1str = "(@.*@)|(\\.\\.)|(@\\.)|(\\.@)|(^\\.)";
3081: var reg2str = "^.+\\@(\\[?)[a-zA-Z0-9\\-\\.]+\\.([a-zA-Z]{2,3}|[0-9]{1,3})(\\]?)$"; //"
3082: var reg1 = new RegExp(reg1str);
3083: var reg2 = new RegExp(reg2str);
3084: if (!reg1.test(str) && reg2.test(str)) {
3085: return true;
3086: }
3087: return false;
3088: }
3089: else
3090: {
3091: if(str.indexOf("@") >= 0) {
3092: return true;
3093: }
3094: return false;
3095: }
3096: }
3097: END
3098: return $scripttag;
3099: }
3100:
1.219 droeschl 3101:
3102: # USAGE: htmltag(element, content, {attribute => value,...});
3103: #
3104: # EXAMPLES:
3105: # - htmltag('a', 'this is an anchor', {href => 'www.example.com',
3106: # title => 'this is a title'})
3107: #
3108: # - You might want to set up needed tags like:
3109: #
3110: # my $h3 = sub { return htmltag( "h3", @_ ) };
3111: #
3112: # ... and use them: $h3->("This is a headline")
3113: #
3114: # - To set up a couple of tags, see sub inittags
3115: #
3116: # NOTES:
3117: # - Empty elements, such as <br/> are correctly terminated,
3118: # i.e. htmltag('br') returns <br/>
3119: # - Empty attributes (title="") are filtered out.
3120: # - The function will not check for deprecated attributes.
3121: #
3122: # OUTPUT: content enclosed in xhtml conform tags
3123: sub htmltag{
3124: return
3125: qq|<$_[0]|
3126: . join( '', map { qq| $_="${$_[2]}{$_}"| if ${$_[2]}{$_} } keys %{ $_[2] } )
3127: . ($_[1] ? qq|>$_[1]</$_[0]>| : qq|/>|). "\n";
3128: };
3129:
3130:
3131: # USAGE: inittags(@tags);
3132: #
3133: # EXAMPLES:
1.261 droeschl 3134: # - my ($h1, $h2, $h3) = inittags( qw( h1 h2 h3 ) )
1.219 droeschl 3135: # $h1->("This is a headline") #Returns: <h1>This is a headline</h1>
3136: #
3137: # NOTES: See sub htmltag for further information.
3138: #
3139: # OUTPUT: List of subroutines.
3140: sub inittags {
3141: my @tags = @_;
3142: return map { my $tag = $_;
3143: sub { return htmltag( $tag, @_ ) }
3144: } @tags;
3145: }
3146:
3147:
1.231 droeschl 3148: # USAGE: scripttag(scriptcode, [start|end|both]);
1.229 droeschl 3149: #
3150: # EXAMPLES:
1.231 droeschl 3151: # - scripttag("alert('Hello World!')", 'both')
3152: # returns:
3153: # <script type="text/javascript">
3154: # // BEGIN LON-CAPA Internal
3155: # alert(Hello World!')
3156: # // END LON-CAPA Internal
3157: # </script>
1.229 droeschl 3158: #
3159: # NOTES:
3160: # - works currently only for javascripts
3161: #
1.231 droeschl 3162: # OUTPUT:
3163: # Scriptcode properly enclosed in <script> and CDATA tags (and LC
3164: # Internal markers if 2nd argument is given)
1.229 droeschl 3165: sub scripttag {
1.231 droeschl 3166: my ( $content, $marker ) = @_;
3167: return unless defined $content;
3168:
3169: my $begin = "\n// BEGIN LON-CAPA Internal\n";
3170: my $end = "\n// END LON-CAPA Internal\n";
3171:
3172: if ($marker) {
3173: $content = $begin . $content if $marker eq 'start' or $marker eq 'both';
3174: $content .= $end if $marker eq 'end' or $marker eq 'both';
3175: }
3176:
1.229 droeschl 3177: $content = "\n// <![CDATA[\n$content\n// ]]>\n";
1.231 droeschl 3178:
3179: return htmltag('script', $content, {type => 'text/javascript'});
1.229 droeschl 3180: };
3181:
1.309 raeburn 3182: =pod
1.229 droeschl 3183:
1.309 raeburn 3184: =item &list_from_array( \@array, { listattr =>{}, itemattr =>{} } )
1.261 droeschl 3185:
3186: Constructs a XHTML list from \@array.
3187:
3188: input:
3189:
3190: =over
3191:
3192: =item \@array
3193:
3194: A reference to the array containing text that will be wrapped in <li></li> tags.
3195:
3196: =item { listattr => {}, itemattr =>{} }
3197:
3198: Attributes for <ul> and <li> passed in as hash references.
3199: See htmltag() for more details.
3200:
3201: =back
3202:
3203: returns: XHTML list as String.
3204:
3205: =cut
3206:
3207: # \@items, {listattr => { class => 'abc', id => 'xyx' }, itemattr => {class => 'abc', id => 'xyx'}}
3208: sub list_from_array {
3209: my ($items, $args) = @_;
1.285 raeburn 3210: return unless (ref($items) eq 'ARRAY');
1.273 droeschl 3211: return unless scalar @$items;
1.261 droeschl 3212: my ($ul, $li) = inittags( qw(ul li) );
3213: my $listitems = join '', map { $li->($_, $args->{itemattr}) } @$items;
3214: return $ul->( $listitems, $args->{listattr} );
3215: }
3216:
3217:
1.183 droeschl 3218: ##############################################
3219: ##############################################
3220:
3221: # generate_menu
3222: #
3223: # Generates html markup for a menu.
3224: #
3225: # Inputs:
3226: # An array of following structure:
3227: # ({ categorytitle => 'Categorytitle',
3228: # items => [
1.201 droeschl 3229: # {
3230: # linktext => 'Text to be displayed',
3231: # url => 'URL the link is pointing to, i.e. /adm/site?action=dosomething',
1.183 droeschl 3232: # permission => 'Contains permissions as returned from lonnet::allowed(),
1.201 droeschl 3233: # must evaluate to true in order to activate the link',
1.184 droeschl 3234: # icon => 'icon filename',
1.186 droeschl 3235: # alttext => 'alt text for the icon',
1.183 droeschl 3236: # help => 'Name of the corresponding helpfile',
3237: # linktitle => 'Description of the link (used for title tag)'
3238: # },
3239: # ...
3240: # ]
3241: # },
3242: # ...
3243: # )
3244: #
3245: # Outputs: A scalar containing the html markup for the menu.
3246:
3247: sub generate_menu {
3248: my @menu = @_;
1.201 droeschl 3249: # subs for specific html elements
1.219 droeschl 3250: my ($h3, $div, $ul, $li, $a, $img) = inittags( qw(h3 div ul li a img) );
1.201 droeschl 3251:
3252: my @categories; # each element represents the entire markup for a category
3253:
3254: foreach my $category (@menu) {
3255: my @links; # contains the links for the current $category
3256: foreach my $link (@{$$category{items}}) {
3257: next unless $$link{permission};
3258:
3259: # create the markup for the current $link and push it into @links.
3260: # each entry consists of an image and a text optionally followed
3261: # by a help link.
1.283 raeburn 3262: my $src;
3263: if ($$link{icon} ne '') {
3264: $src = '/res/adm/pages/'.$$link{icon};
3265: }
1.232 raeburn 3266: push(@links,$li->(
1.201 droeschl 3267: $a->(
3268: $img->("", {
3269: class => "LC_noBorder LC_middle",
1.283 raeburn 3270: src => $src,
1.202 droeschl 3271: alt => mt(defined($$link{alttext}) ?
3272: $$link{alttext} : $$link{linktext})
1.201 droeschl 3273: }), {
3274: href => $$link{url},
1.308 raeburn 3275: title => mt($$link{linktitle}),
3276: class => 'LC_menubuttons_link'
1.201 droeschl 3277: }).
1.202 droeschl 3278: $a->(mt($$link{linktext}), {
1.201 droeschl 3279: href => $$link{url},
1.202 droeschl 3280: title => mt($$link{linktitle}),
1.201 droeschl 3281: class => "LC_menubuttons_link"
3282: }).
3283: (defined($$link{help}) ?
3284: Apache::loncommon::help_open_topic($$link{help}) : ''),
1.232 raeburn 3285: {class => "LC_menubuttons_inline_text"}));
1.201 droeschl 3286: }
3287:
3288: # wrap categorytitle in <h3>, concatenate with
3289: # joined and in <ul> tags wrapped @links
3290: # and wrap everything in an enclosing <div> and push it into
3291: # @categories
3292: # such that each element looks like:
3293: # <div><h3>title</h3><ul><li>...</li>...</ul></div>
3294: # the category won't be added if there aren't any links
1.232 raeburn 3295: push(@categories,
1.202 droeschl 3296: $div->($h3->(mt($$category{categorytitle}), {class=>"LC_hcell"}).
1.201 droeschl 3297: $ul->(join('' ,@links), {class =>"LC_ListStyleNormal" }),
1.232 raeburn 3298: {class=>"LC_Box LC_400Box"})) if scalar(@links);
1.183 droeschl 3299: }
1.201 droeschl 3300:
3301: # wrap the joined @categories in another <div> (column layout)
3302: return $div->(join('', @categories), {class => "LC_columnSection"});
1.183 droeschl 3303: }
1.176 foxr 3304:
1.224 bisitz 3305: ##############################################
3306: ##############################################
3307:
3308: =pod
3309:
1.309 raeburn 3310: =item &start_funclist()
1.224 bisitz 3311:
3312: Start list of available functions
3313:
3314: Typically used to offer a simple list of available functions
3315: at top or bottom of page.
3316: All available functions/actions for the current page
3317: should be included in this list.
3318:
3319: If the optional headline text is not provided, a default text will be used.
3320:
3321:
3322: Related routines:
3323: =over 4
3324: add_item_funclist
3325: end_funclist
3326: =back
3327:
3328:
3329: Inputs: (optional) headline text
3330:
3331: Returns: HTML code with function list start
3332:
3333: =cut
3334:
3335: ##############################################
3336: ##############################################
3337:
3338: sub start_funclist {
3339: my($legendtext)=@_;
3340: $legendtext=&mt('Functions') if !$legendtext;
1.244 droeschl 3341: return '<ul class="LC_funclist"><li style="font-weight:bold; margin-left:0.8em;">'.$legendtext.'</li>'."\n";
1.224 bisitz 3342: }
3343:
3344:
3345: ##############################################
3346: ##############################################
3347:
3348: =pod
3349:
1.309 raeburn 3350: =item &add_item_funclist()
1.224 bisitz 3351:
3352: Adds an item to the list of available functions
3353:
3354: Related routines:
3355: =over 4
3356: start_funclist
3357: end_funclist
3358: =back
3359:
3360: Inputs: content item with text and link to function
3361:
3362: Returns: HTML code with list item for funclist
3363:
3364: =cut
3365:
3366: ##############################################
3367: ##############################################
3368:
3369: sub add_item_funclist {
3370: my($content) = @_;
3371: return '<li>'.$content.'</li>'."\n";
3372: }
3373:
3374: =pod
3375:
1.309 raeburn 3376: =item &end_funclist()
1.224 bisitz 3377:
3378: End list of available functions
3379:
3380: Related routines:
3381: =over 4
3382: start_funclist
3383: add_item_funclist
3384: =back
3385:
3386: Inputs: ./.
3387:
3388: Returns: HTML code with function list end
3389: =cut
3390:
3391: sub end_funclist {
1.246 bisitz 3392: return "</ul>\n";
1.224 bisitz 3393: }
3394:
1.261 droeschl 3395: =pod
3396:
1.309 raeburn 3397: =item &funclist_from_array( \@array, {legend => 'text for legend'} )
1.261 droeschl 3398:
3399: Constructs a XHTML list from \@array with the first item being visually
3400: highlighted and set to the value of legend or 'Functions' if legend is
3401: empty.
3402:
3403: =over
3404:
3405: =item \@array
3406:
3407: A reference to the array containing text that will be wrapped in <li></li> tags.
3408:
3409: =item { legend => 'text' }
3410:
3411: A string that's used as visually highlighted first item. 'Functions' is used if
3412: it's value evaluates to false.
3413:
3414: =back
3415:
3416: returns: XHTML list as string.
3417:
3418: =back
3419:
3420: =cut
3421:
3422: sub funclist_from_array {
3423: my ($items, $args) = @_;
1.285 raeburn 3424: return unless(ref($items) eq 'ARRAY');
1.261 droeschl 3425: $args->{legend} ||= mt('Functions');
3426: return list_from_array( [$args->{legend}, @$items],
3427: { listattr => {class => 'LC_funclist'} });
3428: }
3429:
1.1 stredwic 3430: 1;
1.23 matthew 3431:
1.1 stredwic 3432: __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