1: # The LearningOnline Network with CAPA
2: # a pile of common html routines
3: #
4: # $Id: lonhtmlcommon.pm,v 1.358.2.20 2023/09/11 14:13:31 raeburn Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: ######################################################################
29: ######################################################################
30:
31: =pod
32:
33: =head1 NAME
34:
35: Apache::lonhtmlcommon - routines to do common html things
36:
37: =head1 SYNOPSIS
38:
39: Referenced by other mod_perl Apache modules.
40:
41: =head1 INTRODUCTION
42:
43: lonhtmlcommon is a collection of subroutines used to present information
44: in a consistent html format, or provide other functionality related to
45: html.
46:
47: =head2 General Subroutines
48:
49: =over 4
50:
51: =cut
52:
53: ######################################################################
54: ######################################################################
55:
56: package Apache::lonhtmlcommon;
57:
58: use strict;
59: use Time::Local;
60: use Time::HiRes;
61: use Apache::lonlocal;
62: use Apache::lonnet;
63: use HTML::Entities();
64: use LONCAPA qw(:DEFAULT :match);
65:
66: sub java_not_enabled {
67: if (($env{'browser.mobile'}) && ($env{'browser.mobile'} =~ /^ipad|ipod|iphone$/i)) {
68: return "\n".'<span class="LC_error">'.
69: &mt('The required Java applet could not be started, because Java is not supported by your mobile device.').
70: "</span>\n";
71: } else {
72: return "\n".'<span class="LC_error">'.
73: &mt('The required Java applet could not be started. Please make sure to have Java installed and active in your browser.').
74: "</span>\n";
75: }
76: }
77:
78: sub coursepreflink {
79: my ($text,$category)=@_;
80: if (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
81: return '<a target="_top" href="'.&HTML::Entities::encode("/adm/courseprefs?phase=display&actions=$category",'<>&"').'"><span class="LC_setting">'.$text.'</span></a>';
82: } else {
83: return '';
84: }
85: }
86:
87: sub raw_href_to_link {
88: my ($message)=@_;
89: $message=~s/(https?\:\/\/[^\s\'\"\<]+)([\s\<]|$)/<a href="$1"><tt>$1<\/tt><\/a>$2/gi;
90: return $message;
91: }
92:
93: sub entity_encode {
94: my ($text)=@_;
95: return &HTML::Entities::encode($text, '\'<>&"');
96: }
97:
98: sub direct_parm_link {
99: my ($linktext,$symb,$filter,$part,$target)=@_;
100: $symb=&entity_encode($symb);
101: $filter=&entity_encode($filter);
102: $part=&entity_encode($part);
103: if (($symb) && (&Apache::lonnet::allowed('opa')) && ($target ne 'tex')) {
104: return "<a target='_top' href='/adm/parmset?symb=$symb&filter=$filter&part=$part'><span class='LC_setting'>$linktext</span></a>";
105: } else {
106: return $linktext;
107: }
108: }
109: ##############################################
110: ##############################################
111:
112: =item &confirm_success()
113:
114: Successful completion of an operation message
115:
116: =cut
117:
118: sub confirm_success {
119: my ($message,$failure)=@_;
120: if ($failure) {
121: return '<span class="LC_error" style="font-size: inherit;">'."\n"
122: .'<img src="/adm/lonIcons/navmap.wrong.gif" alt="'.&mt('Error').'" /> '."\n"
123: .$message."\n"
124: .'</span>'."\n";
125: } else {
126: return '<span class="LC_success">'."\n"
127: .'<img src="/adm/lonIcons/navmap.correct.gif" alt="'.&mt('OK').'" /> '."\n"
128: .$message."\n"
129: .'</span>'."\n";
130: }
131: }
132:
133: ##############################################
134: ##############################################
135:
136: =pod
137:
138: =item &dragmath_button()
139:
140: Creates a button that launches a dragmath popup-window, in which an
141: expression can be edited and pasted as LaTeX into a specified textarea.
142:
143: textarea - Name of the textarea to edit.
144: helpicon - If true, show a help icon to the right of the button.
145:
146: =cut
147:
148: sub dragmath_button {
149: my ($textarea,$helpicon) = @_;
150: my $help_text;
151: if ($helpicon) {
152: $help_text = &Apache::loncommon::help_open_topic('Authoring_Math_Editor',undef,undef,undef,undef,'mathhelpicon_'.$textarea);
153: }
154: my $buttontext=&mt('Edit Math');
155: return <<ENDDRAGMATH;
156: <input type="button" value="$buttontext" onclick="javascript:mathedit('$textarea',document)" />$help_text
157: ENDDRAGMATH
158: }
159:
160: ##############################################
161:
162: =pod
163:
164: =item &dragmath_js()
165:
166: Javascript used to open pop-up window containing dragmath applet which
167: can be used to paste LaTeX into a textarea.
168:
169: =cut
170:
171: sub dragmath_js {
172: my ($popup) = @_;
173: return <<ENDDRAGMATHJS;
174: <script type="text/javascript">
175: // <![CDATA[
176: function mathedit(textarea, doc) {
177: targetEntry = textarea;
178: targetDoc = doc;
179: newwin = window.open("/adm/dragmath/$popup.html","","width=565,height=500,resizable");
180: }
181: // ]]>
182: </script>
183:
184: ENDDRAGMATHJS
185: }
186:
187: ##############################################
188: ##############################################
189:
190: =pod
191:
192: =item &dependencies_button()
193:
194: Creates a button that launches a popup-window, in which dependencies
195: for the web page in the main window can be added to, replaced or deleted.
196:
197: =cut
198:
199: sub dependencies_button {
200: my $buttontext=&mt('Manage Dependencies');
201: return <<"END";
202: <input type="button" value="$buttontext" onclick="javascript:dependencycheck();" />
203: END
204: }
205:
206: ##############################################
207:
208: =pod
209:
210: =item &dependencycheck_js()
211:
212: Javascript used to open pop-up window containing interface to manage
213: dependencies for a web page uploaded diretcly to a course.
214:
215: =cut
216:
217: sub dependencycheck_js {
218: my ($symb,$title,$url,$folderpath,$uri) = @_;
219: my $link;
220: if ($symb) {
221: $link = '/adm/dependencies?symb='.&HTML::Entities::encode($symb,'<>&"');
222: } elsif ($folderpath) {
223: $link = '/adm/dependencies?folderpath='.&HTML::Entities::encode($folderpath,'<>&"');
224: $url = $uri;
225: } elsif ($uri =~ m{^/public/$match_domain/$match_courseid/syllabus$}) {
226: $link = '/adm/dependencies';
227: }
228: $link .= (($link=~/\?/)?'&':'?').'title='.
229: &HTML::Entities::encode($title,'<>&"');
230: if ($url) {
231: $link .= '&url='.&HTML::Entities::encode($url,'<>&"');
232: }
233: return <<ENDJS;
234: <script type="text/javascript">
235: // <![CDATA[
236: function dependencycheck() {
237: depwin = window.open("$link","","width=750,height=500,resizable,scrollbars=yes");
238: }
239: // ]]>
240: </script>
241: ENDJS
242: }
243:
244: ##############################################
245: ##############################################
246:
247: =pod
248:
249: =item &authorbombs()
250:
251: =cut
252:
253: ##############################################
254: ##############################################
255:
256: sub authorbombs {
257: my $url=shift;
258: $url=&Apache::lonnet::declutter($url);
259: my ($udom,$uname)=($url=~m{^($LONCAPA::domain_re)/($LONCAPA::username_re)/});
260: my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom);
261: foreach my $bomb (keys(%bombs)) {
262: if ($bomb =~ /^$udom\/$uname\//) {
263: return '<a href="/adm/bombs/'.$url.
264: '"><img src="'.&Apache::loncommon::lonhttpdurl('/adm/lonMisc/bomb.gif').'" alt="'.&mt('Bomb').'" border="0" /></a>'.
265: &Apache::loncommon::help_open_topic('About_Bombs');
266: }
267: }
268: return '';
269: }
270:
271: ##############################################
272: ##############################################
273:
274: sub recent_filename {
275: my $area=shift;
276: return 'nohist_recent_'.&escape($area);
277: }
278:
279: sub store_recent {
280: my ($area,$name,$value,$freeze)=@_;
281: my $file=&recent_filename($area);
282: my %recent=&Apache::lonnet::dump($file);
283: if (scalar(keys(%recent))>20) {
284: # remove oldest value
285: my $oldest=time();
286: my $delkey='';
287: foreach my $item (keys(%recent)) {
288: my $thistime=(split(/\&/,$recent{$item}))[0];
289: if (($thistime ne "always_include") && ($thistime<$oldest)) {
290: $oldest=$thistime;
291: $delkey=$item;
292: }
293: }
294: &Apache::lonnet::del($file,[$delkey]);
295: }
296: # store new value
297: my $timestamp;
298: if ($freeze) {
299: $timestamp = "always_include";
300: } else {
301: $timestamp = time();
302: }
303: &Apache::lonnet::put($file,{ $name =>
304: $timestamp.'&'.&escape($value) });
305: }
306:
307: sub remove_recent {
308: my ($area,$names)=@_;
309: my $file=&recent_filename($area);
310: return &Apache::lonnet::del($file,$names);
311: }
312:
313: sub select_recent {
314: my ($area,$fieldname,$event)=@_;
315: my %recent=&Apache::lonnet::dump(&recent_filename($area));
316: my $return="\n<select name='$fieldname'".
317: ($event?" onchange='$event'":'').
318: ">\n<option value=''>--- ".&mt('Recent')." ---</option>";
319: foreach my $value (sort(keys(%recent))) {
320: unless ($value =~/^error\:/) {
321: my $escaped = &Apache::loncommon::escape_url($value);
322: &Apache::loncommon::inhibit_menu_check(\$escaped);
323: if ($area eq 'residx') {
324: next if ((!&Apache::lonnet::allowed('bre',$value)) && (!&Apache::lonnet::allowed('bro',$value)));
325: }
326: $return.="\n<option value='$escaped'>".
327: &unescape((split(/\&/,$recent{$value}))[1]).
328: '</option>';
329: }
330: }
331: $return.="\n</select>\n";
332: return $return;
333: }
334:
335: sub get_recent {
336: my ($area, $n) = @_;
337: my %recent=&Apache::lonnet::dump(&recent_filename($area));
338:
339: # Create hash with key as time and recent as value
340: # Begin filling return_hash with any 'always_include' option
341: my %time_hash = ();
342: my %return_hash = ();
343: foreach my $item (keys(%recent)) {
344: my ($thistime,$thisvalue)=(split(/\&/,$recent{$item}));
345: if ($thistime eq 'always_include') {
346: $return_hash{$item} = &unescape($thisvalue);
347: $n--;
348: } else {
349: $time_hash{$thistime} = $item;
350: }
351: }
352:
353: # Sort by decreasing time and return key value pairs
354: my $idx = 1;
355: foreach my $item (reverse(sort(keys(%time_hash)))) {
356: $return_hash{$time_hash{$item}} =
357: &unescape((split(/\&/,$recent{$time_hash{$item}}))[1]);
358: if ($n && ($idx++ >= $n)) {last;}
359: }
360:
361: return %return_hash;
362: }
363:
364: sub get_recent_frozen {
365: my ($area) = @_;
366: my %recent=&Apache::lonnet::dump(&recent_filename($area));
367:
368: # Create hash with all 'frozen' items
369: my %return_hash = ();
370: foreach my $item (keys(%recent)) {
371: my ($thistime,$thisvalue)=(split(/\&/,$recent{$item}));
372: if ($thistime eq 'always_include') {
373: $return_hash{$item} = &unescape($thisvalue);
374: }
375: }
376: return %return_hash;
377: }
378:
379:
380:
381: =pod
382:
383: =item &textbox()
384:
385: =cut
386:
387: ##############################################
388: ##############################################
389: sub textbox {
390: my ($name,$value,$size,$special) = @_;
391: $size = 40 if (! defined($size));
392: $value = &HTML::Entities::encode($value,'<>&"');
393: my $Str = '<input type="text" name="'.$name.'" size="'.$size.'" '.
394: 'value="'.$value.'" '.$special.' />';
395: return $Str;
396: }
397:
398: ##############################################
399: ##############################################
400:
401: =pod
402:
403: =item &checkbox()
404:
405: =cut
406:
407: ##############################################
408: ##############################################
409: sub checkbox {
410: my ($name,$checked,$value,$special) = @_;
411: my $Str = '<input type="checkbox" name="'.$name.'" ';
412: if (defined($value)) {
413: $Str .= 'value="'.$value.'"';
414: }
415: if ($checked) {
416: $Str .= ' checked="checked"';
417: }
418: $Str .= $special.' />';
419: return $Str;
420: }
421:
422:
423: =pod
424:
425: =item &radiobutton()
426:
427: =cut
428:
429: ##############################################
430: ##############################################
431: sub radio {
432: my ($name,$checked,$value) = @_;
433: my $Str = '<input type="radio" name="'.$name.'" ';
434: if (defined($value)) {
435: $Str .= 'value="'.$value.'"';
436: }
437: if ($checked eq $value) {
438: $Str .= ' checked="checked"';
439: }
440: $Str .= ' />';
441: return $Str;
442: }
443:
444: ##############################################
445: ##############################################
446:
447: =pod
448:
449: =item &date_setter()
450:
451: &date_setter returns html and javascript for a compact date-setting form.
452: To retrieve values from it, use &get_date_from_form.
453:
454: Inputs
455:
456: =over 4
457:
458: =item $dname
459:
460: The name to prepend to the form elements.
461: The form elements defined will be dname_year, dname_month, dname_day,
462: dname_hour, dname_min, and dname_sec.
463:
464: =item $currentvalue
465:
466: The current setting for this time parameter. A unix format time
467: (time in seconds since the beginning of Jan 1st, 1970, GMT.
468: An undefined value is taken to indicate the value is the current time
469: unless it is requested to leave it empty. See $includeempty.
470: Also, to be explicit, a value of 'now' also indicates the current time.
471:
472: =item $special
473:
474: Additional html/javascript to be associated with each element in
475: the date_setter. See lonparmset for example usage.
476:
477: =item $includeempty
478:
479: If it is set (true) and no date/time value is provided,
480: the date/time fields are left empty.
481:
482: =item $state
483:
484: Specifies the initial state of the form elements. Either 'disabled' or empty.
485: Defaults to empty, which indicates the form elements are not disabled.
486:
487: =item $no_hh_mm_ss
488:
489: If true, text boxes for hours, minutes and seconds are omitted.
490:
491: =item $defhour
492:
493: Default value for hours (a default of 0 is used otherwise).
494:
495: =item $defmin
496:
497: Default value for minutes (a default of 0 is used otherwise).
498:
499: =item defsec
500:
501: Default value for seconds (a default of 0 is used otherwise).
502:
503: =item $nolink
504:
505: If true, a "Select calendar" link (to pop-up a calendar) is not displayed
506: to the right of the items.
507:
508: =item $no_mm_ss
509:
510: If true, text boxes for minutes and seconds are omitted.
511:
512: =item $no_ss
513:
514: If true, text boxes for seconds are omitted.
515:
516: =back
517:
518: Bugs
519:
520: The method used to restrict user input will fail in the year 2400.
521:
522: =cut
523:
524: ##############################################
525: ##############################################
526: sub date_setter {
527: my ($formname,$dname,$currentvalue,$special,$includeempty,$state,
528: $no_hh_mm_ss,$defhour,$defmin,$defsec,$nolink,$no_mm_ss,$no_ss) = @_;
529: my $now = time;
530:
531: my $tzname;
532: my ($sec,$min,$hour,$mday,$month,$year) = ('', '', undef,''.''.'');
533: #other potentially useful values: wkday,yrday,is_daylight_savings
534:
535: if (! defined($state) || $state ne 'disabled') {
536: $state = '';
537: } else {
538: $state = 'disabled="disabled"';
539: }
540: if (! defined($no_hh_mm_ss)) {
541: $no_hh_mm_ss = 0;
542: }
543: if ($currentvalue eq 'now') {
544: $currentvalue = $now;
545: }
546:
547: # Default value: Set empty date field to current time
548: # unless empty inclusion is requested
549: if ((!$includeempty) && (!$currentvalue)) {
550: $currentvalue = $now;
551: }
552: # Do we have a date? Split it!
553: if ($currentvalue) {
554: ($tzname,$sec,$min,$hour,$mday,$month,$year) = &get_timedates($currentvalue);
555:
556: #No values provided for hour, min, sec? Use default 0
557: if (($defhour) || ($defmin) || ($defsec)) {
558: $sec = ($defsec ? $defsec : 0);
559: $min = ($defmin ? $defmin : 0);
560: $hour = ($defhour ? $defhour : 0);
561: }
562: }
563: my $result = "\n<!-- $dname date setting form -->\n";
564: $result .= <<ENDJS;
565: <script type="text/javascript">
566: // <![CDATA[
567: function $dname\_checkday() {
568: var day = document.$formname.$dname\_day.value;
569: var month = document.$formname.$dname\_month.value;
570: var year = document.$formname.$dname\_year.value;
571: var valid = true;
572: if (day < 1) {
573: document.$formname.$dname\_day.value = 1;
574: }
575: if (day > 31) {
576: document.$formname.$dname\_day.value = 31;
577: }
578: if ((month == 1) || (month == 3) || (month == 5) ||
579: (month == 7) || (month == 8) || (month == 10) ||
580: (month == 12)) {
581: if (day > 31) {
582: document.$formname.$dname\_day.value = 31;
583: day = 31;
584: }
585: } else if (month == 2 ) {
586: if ((year % 4 == 0) && (year % 100 != 0)) {
587: if (day > 29) {
588: document.$formname.$dname\_day.value = 29;
589: }
590: } else if (day > 29) {
591: document.$formname.$dname\_day.value = 28;
592: }
593: } else if (day > 30) {
594: document.$formname.$dname\_day.value = 30;
595: }
596: }
597:
598: function $dname\_disable() {
599: document.$formname.$dname\_month.disabled=true;
600: document.$formname.$dname\_day.disabled=true;
601: document.$formname.$dname\_year.disabled=true;
602: document.$formname.$dname\_hour.disabled=true;
603: document.$formname.$dname\_minute.disabled=true;
604: document.$formname.$dname\_second.disabled=true;
605: }
606:
607: function $dname\_enable() {
608: document.$formname.$dname\_month.disabled=false;
609: document.$formname.$dname\_day.disabled=false;
610: document.$formname.$dname\_year.disabled=false;
611: document.$formname.$dname\_hour.disabled=false;
612: document.$formname.$dname\_minute.disabled=false;
613: document.$formname.$dname\_second.disabled=false;
614: }
615:
616: function $dname\_opencalendar() {
617: if (! document.$formname.$dname\_month.disabled) {
618: var calwin=window.open(
619: "/adm/announcements?pickdate=yes&formname=$formname&element=$dname&month="+
620: document.$formname.$dname\_month.value+"&year="+
621: document.$formname.$dname\_year.value,
622: "LONCAPAcal",
623: "height=350,width=350,scrollbars=yes,resizable=yes,menubar=no");
624: }
625:
626: }
627: // ]]>
628: </script>
629: ENDJS
630: $result .= ' <span class="LC_nobreak">';
631: my $monthselector = qq{<select name="$dname\_month" $special $state onchange="javascript:$dname\_checkday()" >};
632: # Month
633: my @Months = qw/January February March April May June
634: July August September October November December/;
635: # Pad @Months with a bogus value to make indexing easier
636: unshift(@Months,'If you can read this an error occurred');
637: if ($includeempty) { $monthselector.="<option value=''></option>"; }
638: for(my $m = 1;$m <=$#Months;$m++) {
639: $monthselector .= qq{ <option value="$m"};
640: $monthselector .= ' selected="selected"' if ($m-1 eq $month);
641: $monthselector .= '> '.&mt($Months[$m]).' </option>'."\n";
642: }
643: $monthselector.= ' </select>';
644: # Day
645: my $dayselector = qq{<input type="text" name="$dname\_day" $state value="$mday" size="3" $special onchange="javascript:$dname\_checkday()" />};
646: # Year
647: my $yearselector = qq{<input type="text" name="$dname\_year" $state value="$year" size="5" $special onchange="javascript:$dname\_checkday()" />};
648: #
649: my $hourselector = qq{<select name="$dname\_hour" $special $state >};
650: if ($includeempty) {
651: $hourselector.=qq{<option value=''></option>};
652: }
653: for (my $h = 0;$h<24;$h++) {
654: $hourselector .= qq{<option value="$h"};
655: $hourselector .= ' selected="selected"' if (defined($hour) && $hour == $h);
656: $hourselector .= ">";
657: my $timest='';
658: if ($h == 0) {
659: $timest .= "12 am";
660: } elsif($h == 12) {
661: $timest .= "12 noon";
662: } elsif($h < 12) {
663: $timest .= "$h am";
664: } else {
665: $timest .= $h-12 ." pm";
666: }
667: $timest=&mt($timest);
668: $hourselector .= $timest." </option>\n";
669: }
670: $hourselector .= " </select>\n";
671: my $minuteselector = qq{<input type="text" name="$dname\_minute" $special $state value="$min" size="3" />};
672: my $secondselector= qq{<input type="text" name="$dname\_second" $special $state value="$sec" size="3" />};
673: my $cal_link;
674: unless (($nolink) || ($state eq 'disabled')) {
675: $cal_link = qq{<a href="javascript:$dname\_opencalendar()">};
676: }
677: #
678: my $tzone = ' '.$tzname.' ';
679: if ($no_hh_mm_ss) {
680: $result .= &mt('[_1] [_2] [_3] ',
681: $monthselector,$dayselector,$yearselector).
682: $tzone;
683: } elsif ($no_mm_ss) {
684: $result .= &mt('[_1] [_2] [_3] [_4]',
685: $monthselector,$dayselector,$yearselector,
686: $hourselector).
687: $tzone;
688: } elsif ($no_ss) {
689: $result .= &mt('[_1] [_2] [_3] [_4] [_5]m',
690: $monthselector,$dayselector,$yearselector,
691: $hourselector,$minuteselector).
692: $tzone;
693: } else {
694: $result .= &mt('[_1] [_2] [_3] [_4] [_5]m [_6]s ',
695: $monthselector,$dayselector,$yearselector,
696: $hourselector,$minuteselector,$secondselector).
697: $tzone;
698: }
699: unless (($nolink) || ($state eq 'disabled')) {
700: $result .= &mt('[_1]Select Date[_2]',$cal_link,'</a>');
701: }
702: $result .= "</span>\n<!-- end $dname date setting form -->\n";
703: return $result;
704: }
705:
706: sub get_timedates {
707: my ($epoch) = @_;
708: my $dt = DateTime->from_epoch(epoch => $epoch)
709: ->set_time_zone(&Apache::lonlocal::gettimezone());
710: my $tzname = $dt->time_zone_short_name();
711: my $sec = $dt->second;
712: my $min = $dt->minute;
713: my $hour = $dt->hour;
714: my $mday = $dt->day;
715: my $month = $dt->month;
716: if ($month) {
717: $month --;
718: }
719: my $year = $dt->year;
720: return ($tzname,$sec,$min,$hour,$mday,$month,$year);
721: }
722:
723: sub build_url {
724: my ($base, $fields)=@_;
725: my $url;
726: $url = $base.'?';
727: foreach my $key (keys(%$fields)) {
728: $url.=&escape($key).'='.&escape($$fields{$key}).'&';
729: }
730: $url =~ s/&$//;
731: return $url;
732: }
733:
734:
735: ##############################################
736: ##############################################
737:
738: =pod
739:
740: =item &get_date_from_form()
741:
742: get_date_from_form retrieves the date specified in an &date_setter form.
743:
744: Inputs:
745:
746: =over 4
747:
748: =item $dname
749:
750: The name passed to &date_setter, which prefixes the form elements.
751:
752: =item $defaulttime
753:
754: The unix time to use as the default in case of poor inputs.
755:
756: =back
757:
758: Returns: Unix time represented in the form.
759:
760: =cut
761:
762: ##############################################
763: ##############################################
764: sub get_date_from_form {
765: my ($dname) = @_;
766: my ($sec,$min,$hour,$day,$month,$year);
767: #
768: if (defined($env{'form.'.$dname.'_second'})) {
769: my $tmpsec = $env{'form.'.$dname.'_second'};
770: if (($tmpsec =~ /^\d+$/) && ($tmpsec >= 0) && ($tmpsec < 60)) {
771: $sec = $tmpsec;
772: }
773: if (!defined($tmpsec) || $tmpsec eq '') { $sec = 0; }
774: } else {
775: $sec = 0;
776: }
777: if (defined($env{'form.'.$dname.'_minute'})) {
778: my $tmpmin = $env{'form.'.$dname.'_minute'};
779: if (($tmpmin =~ /^\d+$/) && ($tmpmin >= 0) && ($tmpmin < 60)) {
780: $min = $tmpmin;
781: }
782: if (!defined($tmpmin) || $tmpmin eq '') { $min = 0; }
783: } else {
784: $min = 0;
785: }
786: if (defined($env{'form.'.$dname.'_hour'})) {
787: my $tmphour = $env{'form.'.$dname.'_hour'};
788: if (($tmphour =~ /^\d+$/) && ($tmphour >= 0) && ($tmphour < 24)) {
789: $hour = $tmphour;
790: }
791: } else {
792: $hour = 0;
793: }
794: if (defined($env{'form.'.$dname.'_day'})) {
795: my $tmpday = $env{'form.'.$dname.'_day'};
796: if (($tmpday =~ /^\d+$/) && ($tmpday > 0) && ($tmpday < 32)) {
797: $day = $tmpday;
798: }
799: }
800: if (defined($env{'form.'.$dname.'_month'})) {
801: my $tmpmonth = $env{'form.'.$dname.'_month'};
802: if (($tmpmonth =~ /^\d+$/) && ($tmpmonth > 0) && ($tmpmonth < 13)) {
803: $month = $tmpmonth;
804: }
805: }
806: if (defined($env{'form.'.$dname.'_year'})) {
807: my $tmpyear = $env{'form.'.$dname.'_year'};
808: if (($tmpyear =~ /^\d+$/) && ($tmpyear >= 1970)) {
809: $year = $tmpyear;
810: }
811: }
812: if (($year<1970) || ($year>2037)) { return undef; }
813: if (defined($sec) && defined($min) && defined($hour) &&
814: defined($day) && defined($month) && defined($year)) {
815: my $timezone = &Apache::lonlocal::gettimezone();
816: my $dt = DateTime->new( year => $year,
817: month => $month,
818: day => $day,
819: hour => $hour,
820: minute => $min,
821: second => $sec,
822: time_zone => $timezone,
823: );
824: my $epoch_time = $dt->epoch;
825: if ($epoch_time ne '') {
826: return $epoch_time;
827: } else {
828: return undef;
829: }
830: } else {
831: return undef;
832: }
833: }
834:
835: ##############################################
836: ##############################################
837:
838: =pod
839:
840: =item &pjump_javascript_definition()
841:
842: Returns javascript defining the 'pjump' function, which opens up a
843: parameter setting wizard.
844:
845: =cut
846:
847: ##############################################
848: ##############################################
849: sub pjump_javascript_definition {
850: my $Str = <<END;
851: function pjump(type,dis,value,marker,ret,call,hour,min,sec) {
852: openMyModal("/adm/rat/parameter.html?type="+escape(type)
853: +"&value="+escape(value)+"&marker="+escape(marker)
854: +"&return="+escape(ret)
855: +"&call="+escape(call)+"&name="+escape(dis)
856: +"&defhour="+escape(hour)+"&defmin="+escape(min)
857: +"&defsec="+escape(sec)+"&modal=1",350,350,'no');
858: }
859: END
860: return $Str;
861: }
862:
863: ##############################################
864: ##############################################
865:
866: =pod
867:
868: =item &javascript_nothing()
869:
870: Return an appropriate null for the users browser. This is used
871: as the first arguement for window.open calls when you want a blank
872: window that you can then write to.
873:
874: =cut
875:
876: ##############################################
877: ##############################################
878: sub javascript_nothing {
879: # mozilla and other browsers work with "''", but IE on mac does not.
880: my $nothing = "''";
881: my $user_browser;
882: my $user_os;
883: $user_browser = $env{'browser.type'} if (exists($env{'browser.type'}));
884: $user_os = $env{'browser.os'} if (exists($env{'browser.os'}));
885: if (! defined($user_browser) || ! defined($user_os)) {
886: (undef,$user_browser,undef,undef,undef,$user_os) =
887: &Apache::loncommon::decode_user_agent();
888: }
889: if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
890: $nothing = "'javascript:void(0);'";
891: }
892: return $nothing;
893: }
894:
895: ##############################################
896: ##############################################
897: sub javascript_docopen {
898: my ($mimetype) = @_;
899: $mimetype ||= 'text/html';
900: # safari does not understand document.open() and loads "text/html"
901: my $nothing = "''";
902: my $user_browser;
903: my $user_os;
904: $user_browser = $env{'browser.type'} if (exists($env{'browser.type'}));
905: $user_os = $env{'browser.os'} if (exists($env{'browser.os'}));
906: if (! defined($user_browser) || ! defined($user_os)) {
907: (undef,$user_browser,undef,undef,undef,$user_os) =
908: &Apache::loncommon::decode_user_agent();
909: }
910: if ($user_browser eq 'safari' && $user_os =~ 'mac') {
911: $nothing = "document.clear()";
912: } else {
913: $nothing = "document.open('$mimetype','replace')";
914: }
915: return $nothing;
916: }
917:
918:
919: ##############################################
920: ##############################################
921:
922: =pod
923:
924: =item &StatusOptions()
925:
926: Returns html for a selection box which allows the user to choose the
927: enrollment status of students. The selection box name is 'Status'.
928:
929: Inputs:
930:
931: $status: the currently selected status. If undefined the value of
932: $env{'form.Status'} is taken. If that is undefined, a value of 'Active'
933: is used.
934:
935: $formname: The name of the form. If defined the onchange attribute of
936: the selection box is set to document.$formname.submit().
937:
938: $size: the size (number of lines) of the selection box.
939:
940: $onchange: javascript to use when the value is changed. Enclosed in
941: double quotes, ""s, not single quotes.
942:
943: Returns: a perl string as described.
944:
945: =cut
946:
947: ##############################################
948: ##############################################
949: sub StatusOptions {
950: my ($status, $formName,$size,$onchange,$mult)=@_;
951: $size = 1 if (!defined($size));
952: if (! defined($status)) {
953: $status = 'Active';
954: $status = $env{'form.Status'} if (exists($env{'form.Status'}));
955: }
956:
957: my $Str = '';
958: $Str .= '<select name="Status"';
959: if (defined($mult)){
960: $Str .= ' multiple="multiple" ';
961: }
962: if(defined($formName) && $formName ne '' && ! defined($onchange)) {
963: $Str .= ' onchange="document.'.$formName.'.submit()"';
964: }
965: if (defined($onchange)) {
966: $Str .= ' onchange="'.$onchange.'"';
967: }
968: $Str .= ' size="'.$size.'" ';
969: $Str .= '>'."\n";
970: foreach my $type (['Active', &mt('Currently Has Access')],
971: ['Future', &mt('Will Have Future Access')],
972: ['Expired', &mt('Previously Had Access')],
973: ['Any', &mt('Any Access Status')]) {
974: my ($name,$label) = @$type;
975: $Str .= '<option value="'.$name.'" ';
976: if ($status eq $name) {
977: $Str .= 'selected="selected" ';
978: }
979: $Str .= '>'.$label.'</option>'."\n";
980: }
981:
982: $Str .= '</select>'."\n";
983: }
984:
985: ########################################################
986: ########################################################
987:
988: =pod
989:
990: =item Progess Window Handling Routines
991:
992: These routines handle the creation, update, increment, and closure of
993: progress windows. The progress window reports to the user the number
994: of items completed and an estimate of the time required to complete the rest.
995:
996: =over 4
997:
998:
999: =item &Create_PrgWin()
1000:
1001: Writes javascript to the client to open a progress window and returns a
1002: data structure used for bookkeeping.
1003:
1004: Inputs
1005:
1006: =over 4
1007:
1008: =item $r Apache request
1009:
1010: =item $number_to_do The total number of items being processed.
1011:
1012: =item $preamble Optional HTML to display before the progress bar.
1013:
1014: =back
1015:
1016: Returns a hash containing the progress state data structure.
1017: If $number_to_do is zero or null, an indeterminate progress bar will
1018: be used.
1019:
1020: =item &Update_PrgWin()
1021:
1022: Updates the text in the progress indicator. Does not increment the count.
1023: See &Increment_PrgWin.
1024:
1025: Inputs:
1026:
1027: =over 4
1028:
1029: =item $r Apache request
1030:
1031: =item $prog_state Pointer to the data structure returned by &Create_PrgWin
1032:
1033: =item $displaystring The string to write to the status indicator
1034:
1035: =back
1036:
1037: Returns: none
1038:
1039:
1040: =item Increment_PrgWin()
1041:
1042: Increment the count of items completed for the progress window by $step or 1 if no step is provided.
1043:
1044: Inputs:
1045:
1046: =over 4
1047:
1048: =item $r Apache request
1049:
1050: =item $prog_state Pointer to the data structure returned by Create_PrgWin
1051:
1052: =item $extraInfo A description of the items being iterated over. Typically
1053: 'student'.
1054:
1055: =item $step (optional) counter step. Will be set to default 1 if ommited. step must be greater than 0 or empty.
1056:
1057: =back
1058:
1059: Returns: none
1060:
1061:
1062: =item &Close_PrgWin()
1063:
1064: Closes the progress window.
1065:
1066: Inputs:
1067:
1068: =over 4
1069:
1070: =item $r Apache request
1071:
1072: =item $prog_state Pointer to the data structure returned by Create_PrgWin
1073:
1074: =back
1075:
1076: Returns: none
1077:
1078: =back
1079:
1080: =cut
1081:
1082: ########################################################
1083: ########################################################
1084:
1085:
1086: # Create progress
1087: sub Create_PrgWin {
1088: my ($r,$number_to_do,$preamble)=@_;
1089: my %prog_state;
1090: $prog_state{'done'}=0;
1091: $prog_state{'firststart'}=&Time::HiRes::time();
1092: $prog_state{'laststart'}=&Time::HiRes::time();
1093: $prog_state{'max'}=$number_to_do;
1094: &Apache::loncommon::LCprogressbar($r,$prog_state{'max'},$preamble);
1095: return %prog_state;
1096: }
1097:
1098: # update progress
1099: sub Update_PrgWin {
1100: my ($r,$prog_state,$displayString)=@_;
1101: &Apache::loncommon::LCprogressbarUpdate($r,undef,$displayString,$$prog_state{'max'});
1102: $$prog_state{'laststart'}=&Time::HiRes::time();
1103: }
1104:
1105: # increment progress state
1106: sub Increment_PrgWin {
1107: my ($r,$prog_state,$extraInfo,$step)=@_;
1108: $step = $step > 0 ? $step : 1;
1109: $$prog_state{'done'} += $step;
1110:
1111: # Catch (max modulo step) <> 0
1112: my $current = $$prog_state{'done'};
1113: my $last = ($$prog_state{'max'} - $current);
1114: if ($last <= 0) {
1115: $last = 1;
1116: $current = $$prog_state{'max'};
1117: }
1118:
1119: my $time_est= (&Time::HiRes::time() - $$prog_state{'firststart'})/
1120: $current * $last;
1121: $time_est = int($time_est);
1122: #
1123: my $min = int($time_est/60);
1124: my $sec = $time_est % 60;
1125:
1126: my $lasttime = &Time::HiRes::time()-$$prog_state{'laststart'};
1127: if ($lasttime > 9) {
1128: $lasttime = int($lasttime);
1129: } elsif ($lasttime < 0.01) {
1130: $lasttime = 0;
1131: } else {
1132: $lasttime = sprintf("%3.2f",$lasttime);
1133: }
1134:
1135: $sec = 0 if ($min >= 10); # Don't show seconds if remaining time >= 10 min.
1136: $sec = 1 if ( ($min == 0) && ($sec == 0) ); # Little cheating: pretend to have 1 second remaining instead of 0 to have something to display
1137:
1138: my $timeinfo =
1139: &mt('[_1]/[_2]:'
1140: .' [quant,_3,minute,minutes,] [quant,_4,second ,seconds ,]remaining'
1141: .' ([quant,_5,second] for '.$extraInfo.')',
1142: $current,
1143: $$prog_state{'max'},
1144: $min,
1145: $sec,
1146: $lasttime);
1147: my $percent=0;
1148: if ($$prog_state{'max'}) {
1149: $percent=int(100.*$current/$$prog_state{'max'});
1150: }
1151: &Apache::loncommon::LCprogressbarUpdate($r,$percent,$timeinfo,$$prog_state{'max'});
1152: $$prog_state{'laststart'}=&Time::HiRes::time();
1153: }
1154:
1155: # close Progress Line
1156: sub Close_PrgWin {
1157: my ($r,$prog_state)=@_;
1158: &Apache::loncommon::LCprogressbarClose($r);
1159: undef(%$prog_state);
1160: }
1161:
1162:
1163: # ------------------------------------------------------- Puts directory header
1164:
1165: sub crumbs {
1166: my ($uri,$target,$prefix,$form,$skiplast,$onclick)=@_;
1167: # You cannot crumbnify uploaded or adm resources
1168: if ($uri=~/^\/*(uploaded|adm)\//) { return &mt('(Internal Course/Community Content)'); }
1169: if ($target) {
1170: $target = ' target="'.
1171: &Apache::loncommon::escape_single($target).'"';
1172: }
1173: my $output='<span class="LC_filename">';
1174: $output.=$prefix.'/';
1175: if (($env{'user.adv'}) || ($env{'user.author'})) {
1176: my $path=$prefix.'/';
1177: foreach my $dir (split('/',$uri)) {
1178: if (! $dir) { next; }
1179: $path .= $dir;
1180: if ($path eq $uri) {
1181: if ($skiplast) {
1182: $output.=$dir;
1183: last;
1184: }
1185: } else {
1186: $path.='/';
1187: }
1188: if ($path eq '/res/') {
1189: unless (&Apache::lonnet::allowed('bre',$path)) {
1190: $output.="$dir/";
1191: next;
1192: }
1193: }
1194: my $href_path = &HTML::Entities::encode($path,'<>&"');
1195: &Apache::loncommon::inhibit_menu_check(\$href_path);
1196: if ($form) {
1197: my $href = 'javascript:'.$form.".action='".$href_path."';".$form.'.submit();';
1198: $output.=qq{<a href="$href"$onclick$target>$dir</a>/};
1199: } else {
1200: $output.=qq{<a href="$href_path"$onclick$target>$dir</a>/};
1201: }
1202: }
1203: } else {
1204: foreach my $dir (split('/',$uri)) {
1205: if (! $dir) { next; }
1206: $output.=$dir.'/';
1207: }
1208: }
1209: if ($uri !~ m|/$|) { $output=~s|/$||; }
1210: $output.='</span>';
1211:
1212:
1213: return $output;
1214: }
1215:
1216: # --------------------- A function that generates a window for the spellchecker
1217:
1218: sub spellheader {
1219: my $start_page=
1220: &Apache::loncommon::start_page('Speller Suggestions',undef,
1221: {'only_body' => 1,
1222: 'js_ready' => 1,
1223: 'bgcolor' => '#DDDDDD',
1224: 'add_entries' => {
1225: 'onload' =>
1226: 'document.forms.spellcheckform.submit()',
1227: }
1228: });
1229: my $end_page=
1230: &Apache::loncommon::end_page({'js_ready' => 1});
1231:
1232: my $nothing=&javascript_nothing();
1233: return (<<ENDCHECK);
1234: <script type="text/javascript">
1235: // <![CDATA[
1236: //<!-- BEGIN LON-CAPA Internal
1237: var checkwin;
1238:
1239: function spellcheckerwindow(string) {
1240: var esc_string = string.replace(/\"/g,'"');
1241: checkwin=window.open($nothing,'spellcheckwin','height=320,width=280,resizable=yes,scrollbars=yes,location=no,menubar=no,toolbar=no');
1242: checkwin.document.writeln('$start_page<form name="spellcheckform" action="/adm/spellcheck" method="post"><input type="hidden" name="text" value="'+esc_string+'" /><\\/form>$end_page');
1243: checkwin.document.close();
1244: }
1245: // END LON-CAPA Internal -->
1246: // ]]>
1247: </script>
1248: ENDCHECK
1249: }
1250:
1251: # ---------------------------------- Generate link to spell checker for a field
1252:
1253: sub spelllink {
1254: my ($form,$field)=@_;
1255: my $linktext=&mt('Check Spelling');
1256: return (<<ENDLINK);
1257: <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>
1258: ENDLINK
1259: }
1260:
1261: # ------------------------------------------------- Output headers for CKEditor
1262:
1263: sub htmlareaheaders {
1264: my $s="";
1265: if (&htmlareabrowser()) {
1266: $s.=(<<ENDEDITOR);
1267: <script type="text/javascript" src="/ckeditor/ckeditor.js"></script>
1268: ENDEDITOR
1269: }
1270: $s.=(<<ENDJQUERY);
1271: <script type="text/javascript" src="/adm/jQuery/js/jquery-3.2.1.min.js"></script>
1272: <script type="text/javascript" src="/adm/jQuery/js/jquery-ui-1.12.1.custom.min.js"></script>
1273: <link rel="stylesheet" type="text/css" href="/adm/jQuery/css/smoothness/jquery-ui-1.12.1.custom.min.css" />
1274: <script type="text/javascript" src="/adm/jpicker/js/jpicker-1.1.6.min.js" >
1275: </script>
1276: <link rel="stylesheet" type="text/css" href="/adm/jpicker/css/jPicker-1.1.6.min.css" />
1277: <script type="text/javascript" src="/adm/countdown/js/jquery.countdown.min.js"></script>
1278: <link rel="stylesheet" type="text/css" href="/adm/countdown/css/jquery.countdown.css" />
1279:
1280: <script type="text/javascript" src="/adm/spellchecker/js/jquery.spellchecker.min.js"></script>
1281: <link rel="stylesheet" type="text/css" href="/adm/spellchecker/css/spellchecker.css" />
1282: <script type="text/javascript" src="/adm/nicescroll/jquery.nicescroll.min.js"></script>
1283:
1284: ENDJQUERY
1285: return $s;
1286: }
1287:
1288: # ----------------------------------------------------------------- Preferences
1289:
1290: # ------------------------------------------------- lang to use in html editor
1291: sub htmlarea_lang {
1292: my $lang='en';
1293: if (&mt('htmlarea_lang') ne 'htmlarea_lang') {
1294: $lang=&mt('htmlarea_lang');
1295: }
1296: return $lang;
1297: }
1298:
1299: # return javacsript to activate elements of .colorchooser with jpicker:
1300: # Caller is responsible for enclosing this in <script> tags:
1301: #
1302: sub color_picker {
1303: return '
1304: $(document).ready(function(){
1305: $.fn.jPicker.defaults.images.clientPath="/adm/jpicker/images/";
1306: $(".colorchooser").jPicker({window: { position: {x: "screenCenter", y: "bottom"}}});
1307: });';
1308: }
1309:
1310: # ----------------------------------------- Script to activate only some fields
1311:
1312: sub htmlareaselectactive {
1313: my ($args) = @_;
1314: unless (&htmlareabrowser()) { return ''; }
1315: my $output='<script type="text/javascript" defer="defer">'."\n"
1316: .'// <![CDATA['."\n"
1317: .'//<!-- BEGIN LON-CAPA Internal'."\n";
1318: my $lang = &htmlarea_lang();
1319: my $fullpage = 'false';
1320: my ($dragmath_prefix,$dragmath_helpicon,$dragmath_whitespace);
1321: if (ref($args) eq 'HASH') {
1322: if (exists($args->{'lang'})) {
1323: if ($args->{'lang'} ne '') {
1324: $lang = $args->{'lang'};
1325: }
1326: }
1327: if (exists($args->{'fullpage'})) {
1328: if ($args->{'fullpage'} eq 'true') {
1329: $fullpage = $args->{'fullpage'};
1330: }
1331: }
1332: if (exists($args->{'dragmath'})) {
1333: if ($args->{'dragmath'} ne '') {
1334: $dragmath_prefix = $args->{'dragmath'};
1335: $dragmath_helpicon=&Apache::loncommon::lonhttpdurl("/adm/help/help.png");
1336: $dragmath_whitespace=&Apache::loncommon::lonhttpdurl("/adm/lonIcons/transparent1x1.gif");
1337: }
1338: }
1339: }
1340:
1341: my %lt = &Apache::lonlocal::texthash(
1342: 'plain' => 'Plain text',
1343: 'rich' => 'Rich formatting',
1344: 'plain_title' => 'Disable rich text formatting and edit in plain text',
1345: 'rich_title' => 'Enable rich text formatting (bold, italic, etc.)',
1346: );
1347:
1348: $output.='
1349:
1350: function containsBlockHtml(id) {
1351: 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);
1352: return (re >= 0);
1353: }
1354:
1355: function startRichEditor(id) {
1356: // fix character entities inside <m>
1357: // NOTE: this is not fixing characters inside <parse>
1358: // NOTE: < and > inside <chem> should fix automatically because there should not be a letter after <.
1359: var ta = document.getElementById(id);
1360: var value = ta.value;
1361: var in_m = false; // in the m element
1362: var in_text = false; // in the text inside the m element
1363: var im = -1; // position of <m>
1364: var it = -1; // position of the text inside
1365: for (var i=0; i<value.length; i++) {
1366: if (value.substr(i, 2) == "<m") {
1367: // ignore previous <m> if found twice
1368: in_m = true;
1369: in_text = false;
1370: im = i;
1371: it = -1;
1372: } else if (in_m) {
1373: if (!in_text) {
1374: if (value.charAt(i) == ">") {
1375: in_text = true;
1376: it = i+1;
1377: }
1378: } else if (value.substr(i, 4) == "</m>") {
1379: in_m = false;
1380: var text = value.substr(it, i-it);
1381: var l1 = text.length;
1382: text = text.replace(/</g, "<");
1383: text = text.replace(/>/g, ">");
1384: var l2 = text.length;
1385: value = value.substr(0, it) + text + "</m>" + value.substr(i+4);
1386: i = i + (l2-l1);
1387: }
1388: }
1389: }
1390: ta.value = value;
1391: CKEDITOR.replace(id,
1392: {
1393: customConfig: "/ckeditor/loncapaconfig.js",
1394: language : "'.$lang.'",
1395: fullPage : '.$fullpage.',
1396: }
1397: );
1398: }
1399:
1400: function destroyRichEditor(id) {
1401: CKEDITOR.instances[id].destroy();
1402: // replace character entities < and > in <m> and <chem>
1403: // and "&fctname(" by "&fctname("
1404: // and the quotes inside functions: "&fct(1, "a")" -> "&fct(1, "a")"
1405: var ta = document.getElementById(id);
1406: var value = ta.value;
1407: var in_element = false; // in the m or chem element
1408: var tagname = ""; // m or chem
1409: var in_text = false; // in the text inside the element
1410: var im = -1; // position of start tag
1411: var it = -1; // position of the text inside
1412: for (var i=0; i<value.length; i++) {
1413: if (value.substr(i, 2) == "<m" || value.substr(i, 5) == "<chem") {
1414: // ignore previous tags if found twice
1415: in_element = true;
1416: if (value.substr(i, 2) == "<m")
1417: tagname = "m";
1418: else
1419: tagname = "chem";
1420: in_text = false;
1421: im = i;
1422: it = -1;
1423: } else if (in_element) {
1424: if (!in_text) {
1425: if (value.charAt(i) == ">") {
1426: in_text = true;
1427: it = i+1;
1428: }
1429: } else if (value.substr(i, 3+tagname.length) == "</"+tagname+">") {
1430: in_element = false;
1431: var text = value.substr(it, i-it);
1432: var l1 = text.length;
1433: text = text.replace(/</g, "<");
1434: text = text.replace(/>/g, ">");
1435: var l2 = text.length;
1436: value = value.substr(0, it) + text + value.substr(i);
1437: i = i + (l2-l1);
1438: }
1439: }
1440: }
1441: // fix function names
1442: value = value.replace(/&([a-zA-Z_]+)\(/g, "&$1(");
1443: // fix quotes in functions
1444: var pos_next_fct = value.search(/&[a-zA-Z_]+\(/);
1445: var depth = 0;
1446: for (var i=0; i<value.length; i++) {
1447: if (i == pos_next_fct) {
1448: depth++;
1449: var sub = value.substring(i+1);
1450: var pos2 = sub.search(/&[a-zA-Z_]+\(/);
1451: if (pos2 == -1)
1452: pos_next_fct = -1;
1453: else
1454: pos_next_fct = i + 1 + pos2;
1455: } else if (depth > 0) {
1456: if (value.charAt(i) == ")")
1457: depth--;
1458: else if (value.substr(i, 6) == """)
1459: value = value.substr(0, i) + "\"" + value.substr(i+6);
1460: }
1461: }
1462: // replace the text value
1463: ta.value = value;
1464: }
1465:
1466: function editorHandler(event) {
1467: var rawid = $(this).attr("id");
1468: var id = new RegExp("LC_rt_(.*)").exec(rawid)[1];
1469: event.preventDefault();
1470: var rt_enabled = $(this).hasClass("LC_enable_rt");
1471: if (rt_enabled) {
1472: startRichEditor(id);
1473: $("#LC_rt_"+id).html("<b>« '.$lt{'plain'}.'</b>");
1474: $("#LC_rt_"+id).attr("title", "'.$lt{'plain_title'}.'");
1475: $("#LC_rt_"+id).addClass("LC_disable_rt");
1476: $("#LC_rt_"+id).removeClass("LC_enable_rt");
1477: } else {
1478: destroyRichEditor(id);
1479: $("#LC_rt_"+id).html("<b>'.$lt{'rich'}.' »</b>");
1480: $("#LC_rt_"+id).attr("title", "'.$lt{'rich_title'}.'");
1481: $("#LC_rt_"+id).addClass("LC_enable_rt");
1482: $("#LC_rt_"+id).removeClass("LC_disable_rt");
1483: }';
1484: if ($dragmath_prefix ne '') {
1485: $output .= "\n var visible = '';
1486: if (rt_enabled) {
1487: visible = 'none';
1488: }
1489: editmath_visibility(id,visible);\n";
1490: }
1491: $output .= '
1492: }
1493: $(document).ready(function(){
1494: $(".LC_richAlwaysOn").each(function() {
1495: startRichEditor($(this).attr("id"));
1496: });
1497: $(".LC_richDetectHtml").each(function() {
1498: var id = $(this).attr("id");
1499: var rt_enabled = containsBlockHtml(id);
1500: if(rt_enabled) {
1501: $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"'.$lt{'plain_title'}.'\" class=\"LC_disable_rt\"><b>« '.$lt{'plain'}.'</b></a></div>");
1502: startRichEditor(id);
1503: $("#LC_rt_"+id).click(editorHandler);
1504: }
1505: else {
1506: $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"'.$lt{'rich_title'}.'\" class=\"LC_enable_rt\"><b>'.$lt{'rich'}.' »</b></a></div>");
1507: $("#LC_rt_"+id).click(editorHandler);
1508: }';
1509: if ($dragmath_prefix ne '') {
1510: $output .= "\n var visible = '';
1511: if (rt_enabled) {
1512: visible = 'none';
1513: }
1514: editmath_visibility(id,visible);\n";
1515: }
1516: $output .= '
1517: });
1518: $(".LC_richDefaultOn").each(function() {
1519: var id = $(this).attr("id");
1520: $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"'.$lt{'plain_title'}.'\" class=\"LC_disable_rt\"><b>« '.$lt{'plain'}.'</b></a></div>");
1521: startRichEditor(id);
1522: $("#LC_rt_"+id).click(editorHandler);
1523: });
1524: $(".LC_richDefaultOff").each(function() {
1525: var id = $(this).attr("id");
1526: $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"'.$lt{'rich_title'}.'\" class=\"LC_enable_rt\"><b>'.$lt{'rich'}.' »</b></a></div>");
1527: $("#LC_rt_"+id).click(editorHandler);
1528: });
1529:
1530:
1531: });
1532: ';
1533: $output .= &color_picker;
1534:
1535: # Code to put a due date countdown in 'duedatecountdown' span.
1536: # This is currently located in the breadcrumb headers.
1537: # note that the dueDateLayout is internatinoalized below.
1538: # Here document is used to support the substitution into the javascript below.
1539: # ..which unforunately necessitates escaping the $'s in the javascript.
1540: # There are several times of importance
1541: #
1542: # serverDueDate - The absolute time at which the problem expires.
1543: # serverTime - The server's time when the problem finished computing.
1544: # clientTime - The client's time...as close to serverTime as possible.
1545: # The clientTime will be slightly later due to
1546: # 1. The latency between problem computation and
1547: # the first network action.
1548: # 2. The time required between the page load-start and the actual
1549: # initial javascript execution that got clientTime.
1550: # These are used as follows:
1551: # The difference between clientTime and serverTime are used to
1552: # correct for differences in clock settings between the browser's system and the
1553: # server's.
1554: #
1555: # The difference between clientTime and the time at which the ready() method
1556: # starts executing is used to estimate latencies for page load and submission.
1557: # Since this is an estimate, it is doubled. The latency estimate + one minute
1558: # is used to determine when the countdown timer turns red to warn the user
1559: # to think about submitting.
1560:
1561: my $dueDateLayout = &mt('Due in: {dn} {dl} {hnn}{sep}{mnn}{sep}{snn} [_1]',
1562: "<span id='submitearly'></span>");
1563: my $early = '- <b>'.&mt('Submit Early').'</b>';
1564: my $pastdue = '- <b>'.&mt('Past Due').'</b>';
1565: $output .= <<JAVASCRIPT;
1566:
1567: var documentReadyTime;
1568:
1569: \$(document).ready(function() {
1570: if (typeof(dueDate) != "undefined") {
1571: documentReadyTime = (new Date()).getTime();
1572: \$("#duedatecountdown").countdown({until: dueDate, compact: true,
1573: layout: "$dueDateLayout",
1574: onTick: function (periods) {
1575: var latencyEstimate = (documentReadyTime - clientTime) * 2;
1576: if(\$.countdown.periodsToSeconds(periods) < (300 + latencyEstimate)) {
1577: \$("#submitearly").html("$early");
1578: if (\$.countdown.periodsToSeconds(periods) < 1) {
1579: \$("#submitearly").html("$pastdue");
1580: }
1581: }
1582: if(\$.countdown.periodsToSeconds(periods) < (60 + latencyEstimate)) {
1583: \$(this).css("color", "red"); //Highlight last minute.
1584: }
1585: }
1586: });
1587: }
1588: });
1589:
1590: /* This code describes the spellcheck options that will be used for
1591: items with class 'spellchecked'. It is necessary for those objects'
1592: to explicitly request checking (e.g. onblur is a nice event for that).
1593: */
1594: \$(document).ready(function() {
1595: \$(".spellchecked").spellchecker({
1596: url: "/ajax/spellcheck",
1597: lang: "en",
1598: engine: "pspell",
1599: suggestionBoxPosition: "below",
1600: innerDocument: true
1601: });
1602: \$("textarea.spellchecked").spellchecker({
1603: url: "/ajax/spellcheck",
1604: lang: "en",
1605: engine: "pspell",
1606: suggestionBoxPosition: "below",
1607: innerDocument: true
1608: });
1609:
1610: });
1611:
1612: /* the muli colored editor can generate spellcheck with language 'none'
1613: to disable spellcheck as well
1614: */
1615: function doSpellcheck(element, lang) {
1616: if (lang != 'none') {
1617: \$(element).spellchecker('option', {lang: lang});
1618: \$(element).spellchecker('check');
1619: }
1620: }
1621:
1622:
1623: JAVASCRIPT
1624: if ($dragmath_prefix ne '') {
1625: $output .= '
1626:
1627: function editmath_visibility(id,value) {
1628:
1629: if ((id == "") || (id == null)) {
1630: return;
1631: }
1632: var mathid = "'.$dragmath_prefix.'_"+id;
1633: mathele = document.getElementById(mathid);
1634: if (mathele == null) {
1635: return;
1636: }
1637: mathele.style.display = value;
1638: var mathhelpicon = "'.$dragmath_prefix.'helpicon'.'_"+id;
1639: mathhelpiconele = document.getElementById(mathhelpicon);
1640: if (mathhelpiconele == null) {
1641: return;
1642: }
1643: if (value == "none") {
1644: mathhelpiconele.src = "'.$dragmath_whitespace.'";
1645: } else {
1646: mathhelpiconele.src = "'.$dragmath_helpicon.'";
1647: }
1648: }
1649: ';
1650:
1651: }
1652: $output.="\nwindow.status='Activated Editfields';\n"
1653: .'// END LON-CAPA Internal -->'."\n"
1654: .'// ]]>'."\n"
1655: .'</script>';
1656: return $output;
1657: }
1658:
1659: # --------------------------------------------------------------------- Blocked
1660:
1661: sub htmlareablocked {
1662: unless ($env{'environment.wysiwygeditor'} eq 'on') { return 1; }
1663: return 0;
1664: }
1665:
1666: # ---------------------------------------- Browser capable of running HTMLArea?
1667:
1668: sub htmlareabrowser {
1669: return 1;
1670: }
1671:
1672: #
1673: # Should the "return to content" link be shown?
1674: #
1675:
1676: sub show_return_link {
1677:
1678: unless ($env{'request.course.id'}) { return 0; }
1679: if ($env{'request.noversionuri'}=~m{^/priv/} ||
1680: $env{'request.uri'}=~m{^/priv/}) { return 1; }
1681: return if ($env{'request.noversionuri'} eq '/adm/supplemental');
1682:
1683: if (($env{'request.noversionuri'} =~ m{^/adm/(viewclasslist|navmaps)($|\?)})
1684: || ($env{'request.noversionuri'} =~ m{^/adm/.*/aboutme($|\?)})) {
1685:
1686: return if ($env{'form.register'});
1687: }
1688: return (($env{'request.noversionuri'}=~m{^/(res|public)/} &&
1689: $env{'request.symb'} eq '')
1690: ||
1691: ($env{'request.noversionuri'}=~ m{^/cgi-bin/printout.pl})
1692: ||
1693: (($env{'request.noversionuri'}=~/^\/adm\//) &&
1694: ($env{'request.noversionuri'}!~/^\/adm\/wrapper\//) &&
1695: ($env{'request.noversionuri'}!~
1696: m{^/adm/.*/(smppg|bulletinboard)($|\?)})
1697: ));
1698: }
1699:
1700:
1701: ##
1702: # Set the dueDate variable...note this is done in the timezone
1703: # of the browser.
1704: #
1705: # @param epoch relative time at which the problem is due.
1706: #
1707: # @return the javascript fragment to set the date:
1708: #
1709: sub set_due_date {
1710: my $dueStamp = shift;
1711: my $duems = $dueStamp * 1000; # Javascript Date object needs ms not seconds.
1712:
1713: my $now = time()*1000;
1714:
1715: # This slightly obscure bit of javascript sets the dueDate variable
1716: # to the time in the browser at which the problem was due.
1717: # The code should correct for gross differences between the server
1718: # and client's time setting
1719:
1720: return <<"END";
1721:
1722: <script type="text/javascript">
1723: //<![CDATA[
1724: var serverDueDate = $duems;
1725: var serverTime = $now;
1726: var clientTime = (new Date()).getTime();
1727: var dueDate = new Date(serverDueDate + (clientTime - serverTime));
1728:
1729: //]]>
1730: </script>
1731:
1732: END
1733: }
1734: ##
1735: # Sets the time at which the problem finished computing.
1736: # This just updates the serverTime and clientTime variables above.
1737: # Calling this in e.g. end_problem provides a better estimate of the
1738: # difference beetween the server and client time setting as
1739: # the difference contains less of the latency/problem compute time.
1740: #
1741: sub set_compute_end_time {
1742:
1743: my $now = time()*1000; # Javascript times are in ms.
1744: return <<"END";
1745:
1746: <script type="text/javascript">
1747: //<![CDATA[
1748: serverTime = $now;
1749: clientTime = (new Date()).getTime();
1750: //]]>
1751: </script>
1752:
1753: END
1754: }
1755:
1756: ##
1757: # Client-side javascript to convert any dashes in text pasted
1758: # into textbox(es) for numericalresponse item(s) to a standard
1759: # minus, i.e., - . Calls to dash_to_minus_js() in end_problem()
1760: # and in loncommon::endbodytag() for a .page (arg: dashjs => 1)
1761: #
1762: # Will apply to any input tag with class: LC_numresponse_text.
1763: # Currently set in start_textline for numericalresponse items.
1764: #
1765:
1766: sub dash_to_minus_js {
1767: return <<'ENDJS';
1768:
1769: <script type="text/javascript">
1770: //<![CDATA[
1771: //<!-- BEGIN LON-CAPA Internal
1772: document.addEventListener("DOMContentLoaded", (event) => {
1773: const numresp = document.querySelectorAll("input.LC_numresponse_text");
1774: if (numresp.length > 0) {
1775: numresp.forEach((el) => {
1776: el.addEventListener("paste", (e) => {
1777: e.preventDefault();
1778: e.stopPropagation();
1779: let p = (e.clipboardData || window.clipboardData).getData("text");
1780: p.toString();
1781: p = p.replace(/\p{Dash}/gu, '-');
1782: putInText(p);
1783: });
1784: });
1785: }
1786: const putInText = (newText, el = document.activeElement) => {
1787: const [start, end] = [el.selectionStart, el.selectionEnd];
1788: el.setRangeText(newText, start, end, 'end');
1789: }
1790: });
1791: // END LON-CAPA Internal -->
1792: //]]>
1793: </script>
1794:
1795: ENDJS
1796: }
1797:
1798: ############################################################
1799: ############################################################
1800:
1801: =pod
1802:
1803: =item &breadcrumbs()
1804:
1805: Compiles the previously registered breadcrumbs into an series of links.
1806: Additionally supports a 'component', which will be displayed on the
1807: right side of the breadcrumbs enclosing div (without a link).
1808: A link to help for the component will be included if one is specified.
1809:
1810: All inputs can be undef without problems.
1811:
1812: Inputs: $component (the text on the right side of the breadcrumbs trail),
1813: $component_help (the help item filename (without .tex extension).
1814: $menulink (boolean, controls whether to include a link to /adm/menu)
1815: $helplink (if 'nohelp' don't include the orange help link)
1816: $css_class (optional name for the class to apply to the table for CSS)
1817: $no_mt (optional flag, 1 if &mt() is _not_ to be applied to $component
1818: when including the text on the right.
1819: $CourseBreadcrumbs (optional flag, 1 if &breadcrumbs called from &docs_breadcrumbs,
1820: because breadcrumbs are being)
1821: $topic_help (optional help item to be displayed on right side of the breadcrumbs
1822: row, using loncommon::help_open_topic() to generate the link.
1823: $topic_help_text (text to include in the link in the optional help item
1824: on the right side of the breadcrumbs row.
1825:
1826: Returns a string containing breadcrumbs for the current page.
1827:
1828: =item &clear_breadcrumbs()
1829:
1830: Clears the previously stored breadcrumbs.
1831:
1832: =item &add_breadcrumb()
1833:
1834: Pushes a breadcrumb on the stack of crumbs.
1835:
1836: input: $breadcrumb, a hash reference. The keys 'href','title', and 'text'
1837: are required. If present the keys 'faq' and 'bug' will be used to provide
1838: links to the FAQ and bug sites. If the key 'no_mt' is present the 'title'
1839: and 'text' values won't be sent through &mt()
1840:
1841: returns: nothing
1842:
1843: =cut
1844:
1845: ############################################################
1846: ############################################################
1847: {
1848: my @Crumbs;
1849: my %tools = ();
1850:
1851: sub breadcrumbs {
1852: my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt,
1853: $CourseBreadcrumbs,$topic_help,$topic_help_text) = @_;
1854: #
1855: $css_class ||= 'LC_breadcrumbs';
1856:
1857: # Make the faq and bug data cascade
1858: my $faq = '';
1859: my $bug = '';
1860: my $help = '';
1861: # Crumb Symbol
1862: my $crumbsymbol = '»';
1863: # The last breadcrumb does not have a link, so handle it separately.
1864: my $last = pop(@Crumbs);
1865: #
1866: # The first one should be the course or a menu link
1867: if (!defined($menulink)) { $menulink=1; }
1868: if ($menulink) {
1869: my $description = 'Menu';
1870: my $no_mt_descr = 0;
1871: if ((exists($env{'request.course.id'})) &&
1872: ($env{'request.course.id'} ne '') &&
1873: ($env{'course.'.$env{'request.course.id'}.'.description'} ne '')) {
1874: $description =
1875: $env{'course.'.$env{'request.course.id'}.'.description'};
1876: $no_mt_descr = 1;
1877: if ($env{'request.noversionuri'} =~
1878: m{^/?public/($match_domain)/($match_courseid)/syllabus$}) {
1879: unless (($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1) &&
1880: ($env{'course.'.$env{'request.course.id'}.'.num'} eq $2)) {
1881: $description = 'Menu';
1882: $no_mt_descr = 0;
1883: }
1884: }
1885: }
1886: $menulink = { href =>'/adm/menu',
1887: title =>'Go to main menu',
1888: target =>'_top',
1889: text =>$description,
1890: no_mt =>$no_mt_descr, };
1891: if($last) {
1892: #$last set, so we have some crumbs
1893: unshift(@Crumbs,$menulink);
1894: } else {
1895: #only menulink crumb present
1896: $last = $menulink;
1897: }
1898: }
1899: my $links;
1900: if ((&show_return_link) && (!$CourseBreadcrumbs) && (ref($last) eq 'HASH')) {
1901: my $alttext = &mt('Go Back');
1902: my $hashref = { href => '/adm/flip?postdata=return:',
1903: title => &mt('Back to most recent content resource'),
1904: class => 'LC_menubuttons_link',
1905: };
1906: if ($env{'request.noversionuri'} eq '/adm/searchcat') {
1907: $hashref->{'target'} = '_top';
1908: }
1909: $links=&htmltag( 'a','<img src="/res/adm/pages/tolastloc.png" alt="'.$alttext.'" class="LC_icon" />',
1910: $hashref);
1911: $links=&htmltag('li',$links);
1912: }
1913: $links.= join "",
1914: map {
1915: $faq = $_->{'faq'} if (exists($_->{'faq'}));
1916: $bug = $_->{'bug'} if (exists($_->{'bug'}));
1917: $help = $_->{'help'} if (exists($_->{'help'}));
1918:
1919: my $result = $_->{no_mt} ? $_->{text} : &mt($_->{text});
1920:
1921: if ($_->{href}){
1922: $result = &htmltag( 'a', $result,
1923: { href => $_->{href},
1924: title => $_->{no_mt} ? $_->{title} : &mt($_->{title}),
1925: target => $_->{target}, });
1926: }
1927:
1928: $result = &htmltag( 'li', "$result $crumbsymbol");
1929: } @Crumbs;
1930:
1931: #should the last Element be translated?
1932:
1933: my $lasttext = $last->{'no_mt'} ? $last->{'text'}
1934: : mt( $last->{'text'} );
1935:
1936: # last breadcrumb is the first order heading of a page
1937: # for course breadcrumbs it's just bold
1938:
1939: if ($lasttext ne '') {
1940: $links .= &htmltag( 'li', htmltag($CourseBreadcrumbs ? 'b' : 'h1',
1941: $lasttext), {title => $lasttext});
1942: }
1943:
1944: my $icons = '';
1945: $faq = $last->{'faq'} if (exists($last->{'faq'}));
1946: $bug = $last->{'bug'} if (exists($last->{'bug'}));
1947: $help = $last->{'help'} if (exists($last->{'help'}));
1948: $component_help=($component_help?$component_help:$help);
1949: # if ($faq ne '') {
1950: # $icons .= &Apache::loncommon::help_open_faq($faq);
1951: # }
1952: # if ($bug ne '') {
1953: # $icons .= &Apache::loncommon::help_open_bug($bug);
1954: # }
1955: if ($faq ne '' || $component_help ne '' || $bug ne '') {
1956: $icons .= &Apache::loncommon::help_open_menu($component,
1957: $component_help,
1958: $faq,$bug);
1959: }
1960: if ($topic_help && $topic_help_text) {
1961: $icons .= ' '.&Apache::loncommon::help_open_topic($topic_help,&mt($topic_help_text),'',
1962: undef,600);
1963: }
1964: #
1965:
1966:
1967: if ($links ne '') {
1968: unless ($CourseBreadcrumbs) {
1969: $links = &htmltag('ol', $links, { id => "LC_MenuBreadcrumbs" });
1970: } else {
1971: $links = &htmltag('ul', $links, { class => "LC_CourseBreadcrumbs" });
1972: }
1973: }
1974:
1975:
1976: if (($component) || ($topic_help && $topic_help_text)) {
1977: $links = &htmltag('span',
1978: ( $no_mt ? $component : mt($component) ).
1979: ( $icons ? $icons : '' ),
1980: { class => 'LC_breadcrumbs_component' } )
1981: .$links
1982: ;
1983: }
1984: my $nav_and_tools = 0;
1985: foreach my $item ('navigation','tools') {
1986: if (ref($tools{$item}) eq 'ARRAY') {
1987: $nav_and_tools += scalar(@{$tools{$item}})
1988: }
1989: }
1990: if (($links ne '') || ($nav_and_tools)) {
1991: &render_tools(\$links);
1992: $links = &htmltag('div', $links,
1993: { id => "LC_breadcrumbs" }) unless ($CourseBreadcrumbs) ;
1994: }
1995: my $adv_tools = 0;
1996: if (ref($tools{'advtools'}) eq 'ARRAY') {
1997: $adv_tools = scalar(@{$tools{'advtools'}});
1998: }
1999: if (($links ne '') || ($adv_tools)) {
2000: &render_advtools(\$links);
2001: }
2002:
2003: # Return the @Crumbs stack to what we started with
2004: push(@Crumbs,$last);
2005: shift(@Crumbs);
2006:
2007:
2008: # Return the breadcrumb's line
2009:
2010:
2011:
2012: return "$links";
2013: }
2014:
2015: sub clear_breadcrumbs {
2016: undef(@Crumbs);
2017: undef(%tools);
2018: }
2019:
2020: sub add_breadcrumb {
2021: push(@Crumbs,@_);
2022: }
2023:
2024: =item &add_breadcrumb_tool($category, $html)
2025:
2026: Adds $html to $category of the breadcrumb toolbar container.
2027:
2028: $html is usually a link to a page that invokes a function on the currently
2029: displayed data (e.g. print when viewing a problem)
2030:
2031: Currently there are 3 possible values for $category:
2032:
2033: =over
2034:
2035: =item navigation
2036: left of breadcrumbs line
2037:
2038: =item tools
2039: remaining items in right of breadcrumbs line
2040:
2041: =item advtools
2042: advanced tools shown in a separate box below breadcrumbs line
2043:
2044: =back
2045:
2046: returns: nothing
2047:
2048: =cut
2049:
2050: sub add_breadcrumb_tool {
2051: my ($category, @html) = @_;
2052: return unless @html;
2053: if (!keys(%tools)) {
2054: %tools = ( navigation => [], tools => [], advtools => []);
2055: }
2056:
2057: #this cleans data received from lonmenu::innerregister
2058: @html = grep {defined $_ && $_ ne ''} @html;
2059: for (@html) {
2060: s/align="(right|left)"//;
2061: # s/<span.*?\/span>// if $category ne 'advtools';
2062: }
2063:
2064: push @{$tools{$category}}, @html;
2065: }
2066:
2067: =item &clear_breadcrumb_tools()
2068:
2069: Clears the breadcrumb toolbar container.
2070:
2071: returns: nothing
2072:
2073: =cut
2074:
2075: sub clear_breadcrumb_tools {
2076: undef(%tools);
2077: }
2078:
2079: =item ¤t_breadcrumb_tools()
2080:
2081: returns: a hash containing the current breadcrumb tools.
2082:
2083: =cut
2084:
2085: sub current_breadcrumb_tools {
2086: return %tools;
2087: }
2088:
2089: =item &render_tools(\$breadcrumbs)
2090:
2091: Creates html for breadcrumb tools (categories navigation and tools) and inserts
2092: \$breadcrumbs at the correct position.
2093:
2094: input: \$breadcrumbs - a reference to the string containing prepared
2095: breadcrumbs.
2096:
2097: returns: nothing
2098:
2099: =cut
2100:
2101: #TODO might split this in separate functions for each category
2102: sub render_tools {
2103: my ($breadcrumbs) = @_;
2104: return unless (keys(%tools));
2105:
2106: my $navigation = list_from_array($tools{navigation},
2107: { listattr => { class=>"LC_breadcrumb_tools_navigation" } });
2108: my $tools = list_from_array($tools{tools},
2109: { listattr => { class=>"LC_breadcrumb_tools_tools" } });
2110: $$breadcrumbs = list_from_array([$navigation, $tools, $$breadcrumbs],
2111: { listattr => { class=>'LC_breadcrumb_tools_outerlist' } });
2112: }
2113:
2114: =pod
2115:
2116: =item &render_advtools(\$breadcrumbs)
2117:
2118: Creates html for advanced tools (category advtools) and inserts \$breadcrumbs
2119: at the correct position.
2120:
2121: input: \$breadcrumbs - a reference to the string containing prepared
2122: breadcrumbs (after render_tools call).
2123:
2124: returns: nothing
2125:
2126: =cut
2127:
2128: sub render_advtools {
2129: my ($breadcrumbs) = @_;
2130: return unless (defined $tools{'advtools'})
2131: and (scalar(@{$tools{'advtools'}}) > 0);
2132:
2133: $$breadcrumbs .= Apache::loncommon::head_subbox(
2134: funclist_from_array($tools{'advtools'}) );
2135: }
2136:
2137: } # End of scope for @Crumbs
2138:
2139: sub docs_breadcrumbs {
2140: my ($allowed,$crstype,$contenteditor,$title,$precleared)=@_;
2141: my ($folderpath,@folders,$supplementalflag);
2142: @folders = split('&',$env{'form.folderpath'});
2143: if ($env{'form.folderpath'} =~ /^supplemental/) {
2144: $supplementalflag = 1;
2145: }
2146: my $plain='';
2147: my $container = 'sequence';
2148: my ($randompick,$isencrypted,$ishidden,$is_random_order) = (-1,0,0,0);
2149: my @docs_crumbs;
2150: while (@folders) {
2151: my $folder=shift(@folders);
2152: my $foldername=shift(@folders);
2153: if ($folderpath) {$folderpath.='&';}
2154: $folderpath.=$folder.'&'.$foldername;
2155: my $url = $env{'request.use_absolute'};
2156: if ($allowed) {
2157: $url .= '/adm/coursedocs?folderpath=';
2158: } else {
2159: $url .= '/adm/supplemental?folderpath=';
2160: }
2161: $url .= &escape($folderpath);
2162: my $name=&unescape($foldername);
2163: # each of randompick number, hidden, encrypted, random order, is_page
2164: # are appended with ":"s to the foldername
2165: $name=~s/\:(\d*)\:(\w*)\:(\w*):(\d*)\:?(\d*)$//;
2166: unless ($supplementalflag) {
2167: if ($contenteditor) {
2168: if ($1 ne '') {
2169: $randompick=$1;
2170: } else {
2171: $randompick=-1;
2172: }
2173: if ($2) { $ishidden=1; }
2174: if ($3) { $isencrypted=1; }
2175: if ($4 ne '') { $is_random_order = 1; }
2176: if ($5 == 1) {$container = 'page'; }
2177: }
2178: }
2179: if ($folder eq 'supplemental') {
2180: $name = &mt('Supplemental Content');
2181: }
2182: if ($contenteditor) {
2183: $plain.=$name.' > ';
2184: }
2185: push(@docs_crumbs,
2186: {'href' => $url,
2187: 'title' => $name,
2188: 'text' => $name,
2189: 'no_mt' => 1,
2190: });
2191: }
2192: if ($title) {
2193: push(@docs_crumbs,
2194: {'title' => $title,
2195: 'text' => $title,
2196: 'no_mt' => 1,}
2197: );
2198: }
2199: if (wantarray) {
2200: unless ($precleared) {
2201: &clear_breadcrumbs();
2202: }
2203: &add_breadcrumb(@docs_crumbs);
2204: if ($contenteditor) {
2205: $plain=~s/\>\;\s*$//;
2206: }
2207: my $menulink = 0;
2208: if (!$allowed && !$contenteditor) {
2209: $menulink = 1;
2210: }
2211: return (&breadcrumbs(undef,undef,$menulink,'nohelp',undef,undef,
2212: $contenteditor),
2213: $randompick,$ishidden,$isencrypted,$plain,
2214: $is_random_order,$container);
2215: } else {
2216: return \@docs_crumbs;
2217: }
2218: }
2219:
2220: ############################################################
2221: ############################################################
2222:
2223: # Nested table routines.
2224: #
2225: # Routines to display form items in a multi-row table with 2 columns.
2226: # Uses nested tables to divide form elements into segments.
2227: # For examples of use see loncom/interface/lonnotify.pm
2228: #
2229: # Can be used in following order: ...
2230: # &start_pick_box()
2231: # row1
2232: # row2
2233: # row3 ... etc.
2234: # &submit_row()
2235: # &end_pick_box()
2236: #
2237: # where row1, row 2 etc. are chosen from &role_select_row,&course_select_row,
2238: # &status_select_row and &email_default_row
2239: #
2240: # Can also be used in following order:
2241: #
2242: # &start_pick_box()
2243: # &row_title()
2244: # &row_closure()
2245: # &row_title()
2246: # &row_closure() ... etc.
2247: # &submit_row()
2248: # &end_pick_box()
2249: #
2250: # In general a &submit_row() call should proceed the call to &end_pick_box(),
2251: # as this routine adds a button for form submission.
2252: # &submit_row() does not require a &row_closure after it.
2253: #
2254: # &start_pick_box() creates a bounding table with 1-pixel wide black border.
2255: # rows should be placed between calls to &start_pick_box() and &end_pick_box.
2256: #
2257: # &row_title() adds a title in the left column for each segment.
2258: # &row_closure() closes a row with a 1-pixel wide black line.
2259: #
2260: # &role_select_row() provides a select box from which to choose 1 or more roles
2261: # &course_select_row provides ways of picking groups of courses
2262: # radio buttons: all, by category or by picking from a course picker pop-up
2263: # note: by category option is only displayed if a domain has implemented
2264: # selection by year, semester, department, number etc.
2265: #
2266: # &status_select_row() provides a select box from which to choose 1 or more
2267: # access types (current access, prior access, and future access)
2268: #
2269: # &email_default_row() provides text boxes for default e-mail suffixes for
2270: # different authentication types in a domain.
2271: #
2272: # &row_title() and &row_closure() are called internally by the &*_select_row
2273: # routines, but can also be called directly to start and end rows which have
2274: # needs that are not accommodated by the *_select_row() routines.
2275:
2276: { # Start: row_count block for pick_box
2277: my @row_count;
2278:
2279: sub start_pick_box {
2280: my ($css_class,$id) = @_;
2281: if (defined($css_class)) {
2282: $css_class = 'class="'.$css_class.'"';
2283: } else {
2284: $css_class= 'class="LC_pick_box"';
2285: }
2286: my $table_id;
2287: if (defined($id)) {
2288: $table_id = ' id="'.$id.'"';
2289: }
2290: unshift(@row_count,0);
2291: my $output = <<"END";
2292: <table $css_class $table_id>
2293: END
2294: return $output;
2295: }
2296:
2297: sub end_pick_box {
2298: shift(@row_count);
2299: my $output = <<"END";
2300: </table>
2301: END
2302: return $output;
2303: }
2304:
2305: sub row_headline {
2306: my $output = <<"END";
2307: <tr><td colspan="2">
2308: END
2309: return $output;
2310: }
2311:
2312: sub row_title {
2313: my ($title,$css_title_class,$css_value_class, $css_value_furtherAttributes) = @_;
2314: $row_count[0]++;
2315: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
2316: $css_title_class ||= 'LC_pick_box_title';
2317: $css_title_class = 'class="'.$css_title_class.'"';
2318:
2319: $css_value_class ||= 'LC_pick_box_value';
2320:
2321: if ($title ne '') {
2322: $title .= ':';
2323: }
2324: my $output = <<"ENDONE";
2325: <tr class="LC_pick_box_row" $css_value_furtherAttributes>
2326: <td $css_title_class>
2327: $title
2328: </td>
2329: <td class="$css_value_class $css_class">
2330: ENDONE
2331: return $output;
2332: }
2333:
2334: sub row_closure {
2335: my ($no_separator) =@_;
2336: my $output = <<"ENDTWO";
2337: </td>
2338: </tr>
2339: ENDTWO
2340: if (!$no_separator) {
2341: $output .= <<"ENDTWO";
2342: <tr>
2343: <td colspan="2" class="LC_pick_box_separator">
2344: </td>
2345: </tr>
2346: ENDTWO
2347: }
2348: return $output;
2349: }
2350:
2351: } # End: row_count block for pick_box
2352:
2353: sub role_select_row {
2354: my ($roles,$title,$css_class,$show_separate_custom,$cdom,$cnum) = @_;
2355: my $crstype = 'Course';
2356: if ($cdom ne '' && $cnum ne '') {
2357: $crstype = &Apache::loncommon::course_type($cdom.'_'.$cnum);
2358: }
2359: my $output;
2360: if (defined($title)) {
2361: $output = &row_title($title,$css_class);
2362: }
2363: $output .= qq|
2364: <select name="roles" multiple="multiple">\n|;
2365: foreach my $role (@$roles) {
2366: my $plrole;
2367: if ($role eq 'ow') {
2368: $plrole = &mt('Course Owner');
2369: } elsif ($role eq 'cr') {
2370: if ($show_separate_custom) {
2371: if ($cdom ne '' && $cnum ne '') {
2372: my %course_customroles = &course_custom_roles($cdom,$cnum);
2373: foreach my $crrole (sort(keys(%course_customroles))) {
2374: my ($plcrrole) = ($crrole =~ m|^cr/[^/]+/[^/]+/(.+)$|);
2375: $output .= ' <option value="'.$crrole.'">'.$plcrrole.
2376: '</option>';
2377: }
2378: }
2379: } else {
2380: $plrole = &mt('Custom Role');
2381: }
2382: } else {
2383: $plrole=&Apache::lonnet::plaintext($role,$crstype);
2384: }
2385: if (($role ne 'cr') || (!$show_separate_custom)) {
2386: $output .= ' <option value="'.$role.'">'.$plrole.'</option>';
2387: }
2388: }
2389: $output .= qq| </select>\n|;
2390: if (defined($title)) {
2391: $output .= &row_closure();
2392: }
2393: return $output;
2394: }
2395:
2396: sub course_select_row {
2397: my ($title,$formname,$totcodes,$codetitles,$idlist,$idlist_titles,
2398: $css_class,$crstype,$standardnames) = @_;
2399: my $output = &row_title($title,$css_class);
2400: $output .= &course_selection($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype,$standardnames);
2401: $output .= &row_closure();
2402: return $output;
2403: }
2404:
2405: sub course_selection {
2406: my ($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype,$standardnames) = @_;
2407: my $output = qq|
2408: <script type="text/javascript">
2409: // <![CDATA[
2410: function coursePick (formname) {
2411: for (var i=0; i<formname.coursepick.length; i++) {
2412: if (formname.coursepick[i].value == 'category') {
2413: courseSet('');
2414: }
2415: if (!formname.coursepick[i].checked) {
2416: if (formname.coursepick[i].value == 'specific') {
2417: formname.coursetotal.value = 0;
2418: formname.courselist = '';
2419: }
2420: }
2421: }
2422: }
2423: function setPick (formname) {
2424: for (var i=0; i<formname.coursepick.length; i++) {
2425: if (formname.coursepick[i].value == 'category') {
2426: formname.coursepick[i].checked = true;
2427: }
2428: formname.coursetotal.value = 0;
2429: formname.courselist = '';
2430: }
2431: }
2432: // ]]>
2433: </script>
2434: |;
2435:
2436: my ($allcrs,$pickspec);
2437: if ($crstype eq 'Community') {
2438: $allcrs = &mt('All communities');
2439: $pickspec = &mt('Pick specific communities:');
2440: } else {
2441: $allcrs = &mt('All courses');
2442: $pickspec = &mt('Pick specific course(s):');
2443: }
2444:
2445: my $courseform='<b>'.&Apache::loncommon::selectcourse_link
2446: ($formname,'pickcourse','pickdomain','coursedesc','',1,$crstype).'</b>';
2447: $output .= '<label><input type="radio" name="coursepick" value="all" onclick="coursePick(this.form)" />'.$allcrs.'</label><br />';
2448: if ($totcodes > 0) {
2449: my $numtitles = @$codetitles;
2450: if ($numtitles > 0) {
2451: $output .= '<label><input type="radio" name="coursepick" value="category" onclick="coursePick(this.form);alert('."'".&html_escape(&mt('Choose categories, from left to right'))."'".')" />'.&mt('Pick courses by category:').'</label><br />';
2452: $output .= '<table><tr><td>'.$$codetitles[0].'<br />'."\n".
2453: '<select name="'.$standardnames->[0].
2454: '" onchange="setPick(this.form);courseSet('."'$$codetitles[0]'".')">'."\n".
2455: ' <option value="-1" />Select'."\n";
2456: my @items = ();
2457: my @longitems = ();
2458: if ($$idlist{$$codetitles[0]} =~ /","/) {
2459: @items = split(/","/,$$idlist{$$codetitles[0]});
2460: } else {
2461: $items[0] = $$idlist{$$codetitles[0]};
2462: }
2463: if (defined($$idlist_titles{$$codetitles[0]})) {
2464: if ($$idlist_titles{$$codetitles[0]} =~ /","/) {
2465: @longitems = split(/","/,$$idlist_titles{$$codetitles[0]});
2466: } else {
2467: $longitems[0] = $$idlist_titles{$$codetitles[0]};
2468: }
2469: for (my $i=0; $i<@longitems; $i++) {
2470: if ($longitems[$i] eq '') {
2471: $longitems[$i] = $items[$i];
2472: }
2473: }
2474: } else {
2475: @longitems = @items;
2476: }
2477: for (my $i=0; $i<@items; $i++) {
2478: $output .= ' <option value="'.$items[$i].'">'.$longitems[$i].'</option>';
2479: }
2480: $output .= '</select></td>';
2481: for (my $i=1; $i<$numtitles; $i++) {
2482: $output .= '<td>'.$$codetitles[$i].'<br />'."\n".
2483: '<select name="'.$standardnames->[$i].
2484: '" onchange="courseSet('."'$$codetitles[$i]'".')">'."\n".
2485: '<option value="-1"><-Pick '.$$codetitles[$i-1].'</option>'."\n".
2486: '</select>'."\n".
2487: '</td>';
2488: }
2489: $output .= '</tr></table><br />';
2490: }
2491: }
2492: $output .=
2493: '<label><input type="radio" name="coursepick" value="specific"'
2494: .' onclick="coursePick(this.form);opencrsbrowser('."'".$formname."','dccourse','dcdomain','coursedesc','','1','$crstype'".')" />'
2495: .$pickspec.'</label>'
2496: .' '.$courseform.' '
2497: .&mt('[_1] selected.',
2498: '<input type="text" value="0" size="4" name="coursetotal" readonly="readonly" />'
2499: .'<input type="hidden" name="courselist" value="" />')
2500: .'<br />'."\n";
2501: return $output;
2502: }
2503:
2504: sub status_select_row {
2505: my ($types,$title,$css_class) = @_;
2506: my $output;
2507: if (defined($title)) {
2508: $output = &row_title($title,$css_class,'LC_pick_box_select');
2509: }
2510: $output .= qq|
2511: <select name="types" multiple="multiple">\n|;
2512: foreach my $status_type (sort(keys(%{$types}))) {
2513: $output .= ' <option value="'.$status_type.'">'.$$types{$status_type}.'</option>';
2514: }
2515: $output .= qq| </select>\n|;
2516: if (defined($title)) {
2517: $output .= &row_closure();
2518: }
2519: return $output;
2520: }
2521:
2522: sub email_default_row {
2523: my ($authtypes,$title,$descrip,$css_class) = @_;
2524: my $output = &row_title($title,$css_class);
2525: $output .= $descrip.
2526: &Apache::loncommon::start_data_table().
2527: &Apache::loncommon::start_data_table_header_row().
2528: '<th>'.&mt('Authentication Method').'</th>'.
2529: '<th align="right">'.&mt('Username -> e-mail conversion').'</th>'."\n".
2530: &Apache::loncommon::end_data_table_header_row();
2531: my $rownum = 0;
2532: foreach my $auth (sort(keys(%{$authtypes}))) {
2533: my ($userentry,$size);
2534: if ($auth =~ /^krb/) {
2535: $userentry = '';
2536: $size = 25;
2537: } else {
2538: $userentry = 'username@';
2539: $size = 15;
2540: }
2541: $output .= &Apache::loncommon::start_data_table_row().
2542: '<td> '.$$authtypes{$auth}.'</td>'.
2543: '<td align="right">'.$userentry.
2544: '<input type="text" name="'.$auth.'" size="'.$size.'" /></td>'.
2545: &Apache::loncommon::end_data_table_row();
2546: }
2547: $output .= &Apache::loncommon::end_data_table();
2548: $output .= &row_closure();
2549: return $output;
2550: }
2551:
2552:
2553: sub submit_row {
2554: my ($title,$cmd,$submit_text,$css_class) = @_;
2555: my $output = &row_title($title,$css_class,'LC_pick_box_submit');
2556: $output .= qq|
2557: <br />
2558: <input type="hidden" name="command" value="$cmd" />
2559: <input type="submit" value="$submit_text"/>
2560: <br /><br />
2561: \n|;
2562: return $output;
2563: }
2564:
2565: sub course_custom_roles {
2566: my ($cdom,$cnum) = @_;
2567: my %returnhash=();
2568: my %coursepersonnel=&Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
2569: foreach my $person (sort(keys(%coursepersonnel))) {
2570: my ($role) = ($person =~ /^([^:]+):/);
2571: my ($end,$start) = split(/:/,$coursepersonnel{$person});
2572: if ($end == -1 && $start == -1) {
2573: next;
2574: }
2575: if ($role =~ m|^cr/[^/]+/[^/]+/[^/]|) {
2576: $returnhash{$role} ++;
2577: }
2578: }
2579: return %returnhash;
2580: }
2581:
2582:
2583: sub resource_info_box {
2584: my ($symb,$onlyfolderflag,$stuvcurrent,$stuvdisp,$divforres)=@_;
2585: my $return='';
2586: if (($stuvcurrent ne '') || ($divforres)) {
2587: $return = '<div class="LC_left_float">';
2588: }
2589: if ($symb) {
2590: $return.=&Apache::loncommon::start_data_table();
2591: my ($map,$id,$resource)=&Apache::lonnet::decode_symb($symb);
2592: my $folder=&Apache::lonnet::gettitle($map);
2593: $return.=&Apache::loncommon::start_data_table_row().
2594: '<th align="left">'.&mt('Folder:').'</th><td>'.$folder.'</td>'.
2595: &Apache::loncommon::end_data_table_row();
2596: unless ($onlyfolderflag) {
2597: $return.=&Apache::loncommon::start_data_table_row().
2598: '<th align="left">'.&mt('Resource:').'</th><td>'.&Apache::lonnet::gettitle($symb).'</td>'.
2599: &Apache::loncommon::end_data_table_row();
2600: }
2601: if ($stuvcurrent ne '') {
2602: $return .= &Apache::loncommon::start_data_table_row().
2603: '<th align="left">'.&mt("Student's current version:").'</th><td>'.$stuvcurrent.'</td>'.
2604: &Apache::loncommon::end_data_table_row();
2605: }
2606: if ($stuvdisp ne '') {
2607: $return .= &Apache::loncommon::start_data_table_row().
2608: '<th align="left">'.&mt("Student's version displayed:").'</th><td>'.$stuvdisp.'</td>'.
2609: &Apache::loncommon::end_data_table_row();
2610: }
2611: $return.=&Apache::loncommon::end_data_table();
2612: } else {
2613: $return='<p><span class="LC_error">'.&mt('No context provided.').'</span></p>';
2614: }
2615: if (($stuvcurrent ne '') || ($divforres)) {
2616: $return .= '</div>';
2617: }
2618: return $return;
2619: }
2620:
2621: # display_usage
2622: #
2623: # Generates a div containing a block, filled to show percentage of current quota used
2624: #
2625: # Quotas available for user portfolios, group portfolios, authoring spaces, and course
2626: # content stored directly within a course (i.e., excluding published content).
2627: #
2628:
2629: sub display_usage {
2630: my ($current_disk_usage,$disk_quota,$context) = @_;
2631: my $usage = $current_disk_usage/1024;
2632: my $quota = $disk_quota/1024;
2633: my $percent;
2634: if ($disk_quota == 0) {
2635: $percent = 100.0;
2636: } else {
2637: $percent = 100*($current_disk_usage/$disk_quota);
2638: }
2639: $usage = sprintf("%.2f",$usage);
2640: $quota = sprintf("%.2f",$quota);
2641: $percent = sprintf("%.0f",$percent);
2642: my ($color,$cssclass);
2643: if ($percent <= 60) {
2644: $color = '#00A000';
2645: } elsif ($percent > 60 && $percent < 90) {
2646: $color = '#FFD300';
2647: $cssclass = 'class="LC_warning"';
2648: } elsif( $percent >= 90) {
2649: $color = '#FF0000';
2650: $cssclass = 'class="LC_error"';
2651: }
2652: my $prog_width = $percent;
2653: if ($prog_width > 100) {
2654: $prog_width = 100;
2655: }
2656: my $display = 'block';
2657: if ($context eq 'authoring') {
2658: $display = 'inline';
2659: }
2660: return '
2661: <div id="meter1" align="left" style="display:'.$display.'" '.$cssclass.'>'.&mt('Currently using [_1] of the [_2] available.',$usage.' MB <span style="font-weight:bold;">('.$percent.'%)</span>',$quota.' MB')."\n".
2662: ' <div id="meter2" style="display:block; margin-top:3px; margin-bottom:3px; margin-left:0px; margin-right:0px; width:400px; border:1px solid #000000; height:10px;">'."\n".
2663: ' <div id="meter3" style="display:block; background-color:'.$color.'; width:'.$prog_width.'%; height:10px; color:#000000; margin:0px;"></div>'."\n".
2664: ' </div>'."\n".
2665: ' </div>';
2666: }
2667:
2668: ##############################################
2669: ##############################################
2670:
2671: # topic_bar
2672: #
2673: # Generates a div containing an (optional) number with a white background followed by a
2674: # title with a background color defined in the corresponding CSS: LC_topic_bar
2675: # Inputs:
2676: # 1. number to display.
2677: # If input for number is empty only the title will be displayed.
2678: # 2. title text to display.
2679: # 3. optional id for the <div>
2680: # Outputs - a scalar containing html mark-up for the div.
2681:
2682: sub topic_bar {
2683: my ($num,$title,$id) = @_;
2684: my $number = '';
2685: if ($num ne '') {
2686: $number = '<span>'.$num.'</span>';
2687: }
2688: if ($id ne '') {
2689: $id = 'id="'.$id.'"';
2690: }
2691: return '<div class="LC_topic_bar" '.$id.'>'.$number.$title.'</div>';
2692: }
2693:
2694: ##############################################
2695: ##############################################
2696: # echo_form_input
2697: #
2698: # Generates html markup to add form elements from the referrer page
2699: # as hidden form elements (values encoded) in the new page.
2700: #
2701: # Intended to support two types of use
2702: # (a) to allow backing up to earlier pages in a multi-page
2703: # form submission process using a breadcrumb trail.
2704: #
2705: # (b) to allow the current page to be reloaded with form elements
2706: # set on previous page to remain unchanged. An example would
2707: # be where the a page containing a dynamically-built table of data is
2708: # is to be redisplayed, with only the sort order of the data changed.
2709: #
2710: # Inputs:
2711: # 1. Reference to array of form elements in the submitted form on
2712: # the referrer page which are to be excluded from the echoed elements.
2713: #
2714: # 2. Reference to array of regular expressions, which if matched in the
2715: # name of the form element n the referrer page will be omitted from echo.
2716: #
2717: # Outputs: A scalar containing the html markup for the echoed form
2718: # elements (all as hidden elements, with values encoded).
2719:
2720:
2721: sub echo_form_input {
2722: my ($excluded,$regexps) = @_;
2723: my $output = '';
2724: foreach my $key (keys(%env)) {
2725: if ($key =~ /^form\.(.+)$/) {
2726: my $name = $1;
2727: my $match = 0;
2728: if (ref($excluded) eq 'ARRAY') {
2729: next if (grep(/^\Q$name\E$/,@{$excluded}));
2730: }
2731: if (ref($regexps) eq 'ARRAY') {
2732: if (@{$regexps} > 0) {
2733: foreach my $regexp (@{$regexps}) {
2734: if ($name =~ /$regexp/) {
2735: $match = 1;
2736: last;
2737: }
2738: }
2739: }
2740: }
2741: next if ($match);
2742: if (ref($env{$key}) eq 'ARRAY') {
2743: foreach my $value (@{$env{$key}}) {
2744: $value = &HTML::Entities::encode($value,'<>&"');
2745: $output .= '<input type="hidden" name="'.$name.
2746: '" value="'.$value.'" />'."\n";
2747: }
2748: } else {
2749: my $value = &HTML::Entities::encode($env{$key},'<>&"');
2750: $output .= '<input type="hidden" name="'.$name.
2751: '" value="'.$value.'" />'."\n";
2752: }
2753: }
2754: }
2755: return $output;
2756: }
2757:
2758: ##############################################
2759: ##############################################
2760: # set_form_elements
2761: #
2762: # Generates javascript to set form elements to values based on
2763: # corresponding values for the same form elements when the page was
2764: # previously submitted.
2765: #
2766: # Last submission values are read from hidden form elements in referring
2767: # page which have the same name, i.e., generated by &echo_form_input().
2768: #
2769: # Intended to be called by onload event.
2770: #
2771: # Inputs:
2772: # (a) Reference to hash of echoed form elements to be set.
2773: #
2774: # In the hash, keys are the form element names, and the values are the
2775: # element type (selectbox, radio, checkbox or text -for textbox, textarea or
2776: # hidden).
2777: #
2778: # (b) Optional reference to hash of stored elements to be set.
2779: #
2780: # If the page being displayed is a page which permits modification of
2781: # previously stored data, e.g., the first page in a multi-page submission,
2782: # then if stored is supplied, form elements will be set to the last stored
2783: # values. If user supplied values are also available for the same elements
2784: # these will replace the stored values.
2785: #
2786: # Output:
2787: #
2788: # javascript function - set_form_elements() which sets form elements,
2789: # expects an argument: formname - the name of the form according to
2790: # the DOM, e.g., document.compose
2791:
2792: sub set_form_elements {
2793: my ($elements,$stored) = @_;
2794: my %values;
2795: my $output .= 'function setFormElements(courseForm) {
2796: ';
2797: if (defined($stored)) {
2798: foreach my $name (keys(%{$stored})) {
2799: if (exists($$elements{$name})) {
2800: if (ref($$stored{$name}) eq 'ARRAY') {
2801: $values{$name} = $$stored{$name};
2802: } else {
2803: @{$values{$name}} = ($$stored{$name});
2804: }
2805: }
2806: }
2807: }
2808:
2809: foreach my $key (keys(%env)) {
2810: if ($key =~ /^form\.(.+)$/) {
2811: my $name = $1;
2812: if (exists($$elements{$name})) {
2813: @{$values{$name}} = &Apache::loncommon::get_env_multiple($key);
2814: }
2815: }
2816: }
2817:
2818: foreach my $name (keys(%values)) {
2819: for (my $i=0; $i<@{$values{$name}}; $i++) {
2820: $values{$name}[$i] = &HTML::Entities::decode($values{$name}[$i],'<>&"');
2821: $values{$name}[$i] =~ s/([\r\n\f]+)/\\n/g;
2822: $values{$name}[$i] =~ s/"/\\"/g;
2823: }
2824: if (($$elements{$name} eq 'text') || ($$elements{$name} eq 'hidden')) {
2825: my $numvalues = @{$values{$name}};
2826: if ($numvalues > 1) {
2827: my $valuestring = join('","',@{$values{$name}});
2828: $output .= qq|
2829: var textvalues = new Array ("$valuestring");
2830: var total = courseForm.elements['$name'].length;
2831: if (total > $numvalues) {
2832: total = $numvalues;
2833: }
2834: for (var i=0; i<total; i++) {
2835: courseForm.elements['$name']\[i].value = textvalues[i];
2836: }
2837: |;
2838: } else {
2839: $output .= qq|
2840: courseForm.elements['$name'].value = "$values{$name}[0]";
2841: |;
2842: }
2843: } else {
2844: $output .= qq|
2845: var elementLength = courseForm.elements['$name'].length;
2846: if (elementLength==undefined) {
2847: |;
2848: foreach my $value (@{$values{$name}}) {
2849: if ($$elements{$name} eq 'selectbox') {
2850: $output .= qq|
2851: if (courseForm.elements['$name'].options[0].value == "$value") {
2852: courseForm.elements['$name'].options[0].selected = true;
2853: }|;
2854: } elsif (($$elements{$name} eq 'radio') ||
2855: ($$elements{$name} eq 'checkbox')) {
2856: $output .= qq|
2857: if (courseForm.elements['$name'].value == "$value") {
2858: courseForm.elements['$name'].checked = true;
2859: } else {
2860: courseForm.elements['$name'].checked = false;
2861: }|;
2862: }
2863: }
2864: $output .= qq|
2865: }
2866: else {
2867: for (var i=0; i<courseForm.elements['$name'].length; i++) {
2868: |;
2869: if ($$elements{$name} eq 'selectbox') {
2870: $output .= qq|
2871: courseForm.elements['$name'].options[i].selected = false;|;
2872: } elsif (($$elements{$name} eq 'radio') ||
2873: ($$elements{$name} eq 'checkbox')) {
2874: $output .= qq|
2875: courseForm.elements['$name']\[i].checked = false;|;
2876: }
2877: $output .= qq|
2878: }
2879: for (var j=0; j<courseForm.elements['$name'].length; j++) {
2880: |;
2881: foreach my $value (@{$values{$name}}) {
2882: if ($$elements{$name} eq 'selectbox') {
2883: $output .= qq|
2884: if (courseForm.elements['$name'].options[j].value == "$value") {
2885: courseForm.elements['$name'].options[j].selected = true;
2886: }|;
2887: } elsif (($$elements{$name} eq 'radio') ||
2888: ($$elements{$name} eq 'checkbox')) {
2889: $output .= qq|
2890: if (courseForm.elements['$name']\[j].value == "$value") {
2891: courseForm.elements['$name']\[j].checked = true;
2892: }|;
2893: }
2894: }
2895: $output .= qq|
2896: }
2897: }
2898: |;
2899: }
2900: }
2901: $output .= "
2902: return;
2903: }\n";
2904: return $output;
2905: }
2906:
2907: ##############################################
2908: ##############################################
2909:
2910: sub file_submissionchk_js {
2911: my ($turninpaths,$multiples) = @_;
2912: my $overwritewarn = &mt('File(s) you uploaded for your submission will overwrite existing file(s) submitted for this item')."\n".
2913: &mt('Continue submission and overwrite the file(s)?');
2914: &js_escape(\$overwritewarn);
2915: my $delfilewarn = &mt('You have indicated you wish to remove some files previously included in your submission.')."\n".
2916: &mt('Continue submission with these files removed?');
2917: &js_escape(\$delfilewarn);
2918: my ($turninpathtext,$multtext,$arrayindexofjs);
2919: if (ref($turninpaths) eq 'HASH') {
2920: foreach my $key (sort(keys(%{$turninpaths}))) {
2921: $turninpathtext .= " if (prefix == '$key') {\n".
2922: " return '$turninpaths->{$key}';\n".
2923: " }\n";
2924: }
2925: }
2926: $turninpathtext .= " return '';\n";
2927: if (ref($multiples) eq 'HASH') {
2928: foreach my $key (sort(keys(%{$multiples}))) {
2929: $multtext .= " if (prefix == '$key') {\n".
2930: " return '$multiples->{$key}';\n".
2931: " }\n";
2932: }
2933: }
2934: $multtext .= " return '';\n";
2935:
2936: $arrayindexofjs = &Apache::loncommon::javascript_array_indexof();
2937: return <<"ENDSCRIPT";
2938: <script type="text/javascript">
2939: // <![CDATA[
2940:
2941: function file_submission_check(formname,path,multiresp) {
2942: var elemnum = formname.elements.length;
2943: if (elemnum == 0) {
2944: return true;
2945: }
2946: var alloverwrites = [];
2947: var alldelconfirm = [];
2948: var result = [];
2949: var submitter;
2950: var subprefix;
2951: var allsub = getIndexByName(formname,'all_submit');
2952: if (allsub == -1) {
2953: var idx = getIndexByName(formname,'submitted');
2954: if (idx != -1) {
2955: var subval = String(formname.elements[idx].value);
2956: submitter = subval.replace(/^part_/,'');
2957: result = overwritten_check(formname,path,multiresp,submitter);
2958: alloverwrites.push.apply(alloverwrites,result['overwrite']);
2959: alldelconfirm.push.apply(alldelconfirm,result['delete']);
2960: }
2961: } else {
2962: if (formname.elements[allsub].type == 'submit') {
2963: var partsub = /^\\d+\\.\\d+_submit_.+\$/;
2964: var allprefixes = [];
2965: var allparts = [];
2966: for (var i=0; i<formname.elements.length; i++) {
2967: if (formname.elements[i].type == 'submit') {
2968: var elemname = formname.elements[i].name;
2969: var subname = String(elemname);
2970: var savesub = String(elemname);
2971: if (partsub.test(subname)) {
2972: var prefix = subname.replace(/_submit_.+\$/,'');
2973: if (allprefixes.indexOf(prefix) == -1) {
2974: allprefixes.push(prefix);
2975: allparts[prefix] = [];
2976: }
2977: var part = savesub.replace(/^\\d+\\.\\d+_submit_/,'');
2978: allparts[prefix].push(part);
2979: }
2980: }
2981: }
2982: for (var k=0; k<allprefixes.length; k++) {
2983: var idx = getIndexByName(formname,allprefixes[k]+'_submitted');
2984: if (idx > -1) {
2985: if (formname.elements[idx].value != 'yes') {
2986: submitterval = formname.elements[idx].value;
2987: submitter = submitterval.replace(/^part_/,'');
2988: subprefix = allprefixes[k];
2989: result = overwritten_check(formname,path,multiresp,submitter,subprefix);
2990: alloverwrites.push.apply(alloverwrites,result['overwrite']);
2991: alldelconfirm.push.apply(alldelconfirm,result['delete']);
2992: break;
2993: }
2994: }
2995: }
2996: if (submitter == '' || submitter == undefined) {
2997: for (var m=0; m<allprefixes.length; m++) {
2998: for (var n=0; n<allparts[allprefixes[m]].length; n++) {
2999: var result = overwritten_check(formname,path,multiresp,allparts[allprefixes[m]][n],allprefixes[m]);
3000: alloverwrites.push.apply(alloverwrites,result['overwrite']);
3001: alldelconfirm.push.apply(alldelconfirm,result['delete']);
3002: }
3003: }
3004: }
3005: }
3006: }
3007: if (alloverwrites.length > 0) {
3008: if (!confirm("$overwritewarn")) {
3009: for (var n=0; n<alloverwrites.length; n++) {
3010: formname.elements[alloverwrites[n]].value = "";
3011: }
3012: return false;
3013: }
3014: }
3015: if (alldelconfirm.length > 0) {
3016: if (!confirm("$delfilewarn")) {
3017: for (var p=0; p<alldelconfirm.length; p++) {
3018: formname.elements[alldelconfirm[p]].checked = false;
3019: }
3020: return false;
3021: }
3022: }
3023: return true;
3024: }
3025:
3026: function getIndexByName(formname,item) {
3027: for (var i=0;i<formname.elements.length;i++) {
3028: if (formname.elements[i].name == item) {
3029: return i;
3030: }
3031: }
3032: return -1;
3033: }
3034:
3035: function overwritten_check(formname,path,multiresp,part,prefix) {
3036: var result = [];
3037: result['overwrite'] = [];
3038: result['delete'] = [];
3039: var elemnum = formname.elements.length;
3040: if (elemnum == 0) {
3041: return result;
3042: }
3043: var uploadstr;
3044: var deletestr;
3045: if ((prefix != undefined) && (prefix != '')) {
3046: var prepend = prefix+'_';
3047: uploadstr = new RegExp("^"+prepend+"HWFILE"+part+".+\$");
3048: deletestr = new RegExp("^"+prepend+"HWFILE"+part+".+_\\\\d+_delete\$");
3049: multiresp = check_for_multiples(prepend);
3050: path = check_for_turninpath(prepend);
3051: } else {
3052: uploadstr = new RegExp("^HWFILE"+part+".+\$");
3053: deletestr = new RegExp("^HWFILE"+part+".+_\\\\d+_delete\$");
3054: }
3055: var alluploads = [];
3056: var allchecked = [];
3057: var allskipdel = [];
3058: var fnametrim = /[^\\/\\\\]+\$/;
3059: for (var i=0; i<formname.elements.length; i++) {
3060: var id = formname.elements[i].id;
3061: if (id != '') {
3062: if (uploadstr.test(id)) {
3063: if (formname.elements[i].type == 'file') {
3064: alluploads.push(id);
3065: } else {
3066: if (deletestr.test(id)) {
3067: if (formname.elements[i].type == 'checkbox') {
3068: if (formname.elements[i].checked) {
3069: allchecked.push(id);
3070: }
3071: }
3072: }
3073: }
3074: }
3075: }
3076: }
3077: for (var j=0; j<alluploads.length; j++) {
3078: var delstr = new RegExp("^"+alluploads[j]+"_\\\\d+_delete\$");
3079: var delboxes = [];
3080: for (var k=0; k<formname.elements.length; k++) {
3081: var id = formname.elements[k].id;
3082: if ((id != '') && (id != undefined)) {
3083: if (delstr.test(id)) {
3084: if (formname.elements[k].type == 'checkbox') {
3085: delboxes.push(id);
3086: }
3087: }
3088: }
3089: }
3090: if (delboxes.length > 0) {
3091: if ((formname.elements[alluploads[j]].value != undefined) &&
3092: (formname.elements[alluploads[j]].value != '')) {
3093: var filepath = formname.elements[alluploads[j]].value;
3094: var newfilename = fnametrim.exec(filepath);
3095: if (newfilename != null) {
3096: var filename = String(newfilename);
3097: var nospaces = filename.replace(/\\s+/g,'_');
3098: var nospecials = nospaces.replace(/[^\\/\\w\\.\\-]/g,'');
3099: var cleanfilename = nospecials.replace(/\\.(\\d+\\.)/g,"_\$1");
3100: if (cleanfilename != '') {
3101: var fullpath = path+"/"+cleanfilename;
3102: if (multiresp == 1) {
3103: var partid = String(alluploads[i]);
3104: var subdir = partid.replace(/^\\d*.?\\d*_?HWFILE/,'');
3105: if (subdir != "" && subdir != undefined) {
3106: fullpath = path+"/"+subdir+"/"+cleanfilename;
3107: }
3108: }
3109: for (var m=0; m<delboxes.length; m++) {
3110: if (fullpath == formname.elements[delboxes[m]].value) {
3111: if (formname.elements[delboxes[m]].checked) {
3112: allskipdel.push(delboxes[m]);
3113: } else {
3114: result['overwrite'].push(alluploads[j]);
3115: }
3116: break;
3117: }
3118: }
3119: }
3120: }
3121: }
3122: }
3123: }
3124: if (allchecked.length > 0) {
3125: if (allskipdel.length > 0) {
3126: for (var n=0; n<allchecked.length; n++) {
3127: if (allskipdel.indexOf(allchecked[n]) == -1) {
3128: result['delete'].push(allchecked[n]);
3129: }
3130: }
3131: } else {
3132: result['delete'].push.apply(result['delete'],allchecked);
3133: }
3134: }
3135: return result;
3136: }
3137:
3138: function check_for_multiples(prefix) {
3139: $multtext
3140: }
3141:
3142: function check_for_turninpath(prefix) {
3143: $turninpathtext
3144: }
3145:
3146: // ]]>
3147: </script>
3148:
3149: $arrayindexofjs
3150:
3151: ENDSCRIPT
3152: }
3153:
3154: ##############################################
3155: ##############################################
3156:
3157: sub resize_scrollbox_js {
3158: my ($context,$tabidstr,$tid) = @_;
3159: my (%names,$paddingwfrac,$offsetwfrac,$offsetv,$minw,$minv);
3160: if ($context eq 'docs') {
3161: %names = (
3162: boxw => 'contenteditor',
3163: item => 'contentlist',
3164: header => 'uploadfileresult',
3165: scroll => 'contentscroll',
3166: boxh => 'contenteditor',
3167: );
3168: $paddingwfrac = 0.09;
3169: $offsetwfrac = 0.015;
3170: $offsetv = 20;
3171: $minw = 250;
3172: $minv = 200;
3173: } elsif ($context eq 'params') {
3174: %names = (
3175: boxw => 'parameditor',
3176: item => 'mapmenuinner',
3177: header => 'parmstep1',
3178: scroll => 'mapmenuscroll',
3179: boxh => 'parmlevel',
3180: );
3181: $paddingwfrac = 0.2;
3182: $offsetwfrac = 0.015;
3183: $offsetv = 80;
3184: $minw = 100;
3185: $minv = 100;
3186: }
3187: my $viewport_js = &Apache::loncommon::viewport_geometry_js();
3188: my $output = '
3189:
3190: window.onresize=callResize;
3191:
3192: ';
3193: if ($context eq 'docs') {
3194: if ($env{'form.active'}) {
3195: $output .= "\nvar activeTab = '$env{'form.active'}$tid';\n";
3196: } else {
3197: $output .= "\nvar activeTab = '';\n";
3198: }
3199: }
3200: $output .= <<"FIRST";
3201:
3202: $viewport_js
3203:
3204: function resize_scrollbox(scrollboxname,chkw,chkh) {
3205: var scrollboxid = 'div_'+scrollboxname;
3206: var scrolltableid = 'table_'+scrollboxname;
3207: var scrollbox;
3208: var scrolltable;
3209: var ismobile = '$env{'browser.mobile'}';
3210:
3211: if (document.getElementById("$names{'boxw'}") == null) {
3212: return;
3213: }
3214:
3215: if (document.getElementById(scrollboxid) == null) {
3216: return;
3217: } else {
3218: scrollbox = document.getElementById(scrollboxid);
3219: }
3220:
3221:
3222: if (document.getElementById(scrolltableid) == null) {
3223: return;
3224: } else {
3225: scrolltable = document.getElementById(scrolltableid);
3226: }
3227:
3228: init_geometry();
3229: var vph = Geometry.getViewportHeight();
3230: var vpw = Geometry.getViewportWidth();
3231:
3232: FIRST
3233: if ($context eq 'docs') {
3234: $output .= "
3235: var alltabs = ['$tabidstr'];
3236: ";
3237: } elsif ($context eq 'params') {
3238: $output .= "
3239: if (document.getElementById('$names{'boxh'}') == null) {
3240: return;
3241: }
3242: ";
3243: }
3244: $output .= <<"SECOND";
3245: var listwchange;
3246: var scrollchange;
3247: if (chkw == 1) {
3248: var boxw = document.getElementById("$names{'boxw'}").offsetWidth;
3249: var itemw;
3250: var itemid = document.getElementById("$names{'item'}");
3251: if (itemid != null) {
3252: itemw = itemid.offsetWidth;
3253: }
3254: var itemwstart = itemw;
3255:
3256: var scrollboxw = scrollbox.offsetWidth;
3257: var scrollboxscrollw = scrollbox.scrollWidth;
3258: var scrollstart = scrollboxw;
3259:
3260: var offsetw = parseInt(vpw * $offsetwfrac);
3261: var paddingw = parseInt(vpw * $paddingwfrac);
3262:
3263: var minscrollboxw = $minw;
3264: var maxcolw = 0;
3265: SECOND
3266: if ($context eq 'docs') {
3267: $output .= <<"DOCSONE";
3268: var actabw = 0;
3269: for (var i=0; i<alltabs.length; i++) {
3270: if (activeTab == alltabs[i]) {
3271: actabw = document.getElementById(alltabs[i]).offsetWidth;
3272: if (actabw > maxcolw) {
3273: maxcolw = actabw;
3274: }
3275: } else {
3276: if (document.getElementById(alltabs[i]) != null) {
3277: var thistab = document.getElementById(alltabs[i]);
3278: thistab.style.visibility = 'hidden';
3279: thistab.style.display = 'block';
3280: var tabw = document.getElementById(alltabs[i]).offsetWidth;
3281: thistab.style.display = 'none';
3282: thistab.style.visibility = '';
3283: if (tabw > maxcolw) {
3284: maxcolw = tabw;
3285: }
3286: }
3287: }
3288: }
3289: DOCSONE
3290: } elsif ($context eq 'params') {
3291: $output .= <<"PARAMSONE";
3292: var parmlevelrows = new Array();
3293: var mapmenucells = new Array();
3294: parmlevelrows = document.getElementById("$names{'boxh'}").rows;
3295: var numrows = parmlevelrows.length;
3296: if (numrows > 1) {
3297: mapmenucells = parmlevelrows[2].getElementsByTagName('td');
3298: }
3299: maxcolw = mapmenucells[0].offsetWidth;
3300: PARAMSONE
3301: }
3302: $output .= <<"THIRD";
3303: if (maxcolw > 0) {
3304: var newscrollboxw;
3305: if (maxcolw+paddingw+scrollboxscrollw<boxw) {
3306: newscrollboxw = boxw-paddingw-maxcolw;
3307: if (newscrollboxw < minscrollboxw) {
3308: newscrollboxw = minscrollboxw;
3309: }
3310: scrollbox.style.width = newscrollboxw+"px";
3311: if (newscrollboxw != scrollboxw) {
3312: var newitemw = newscrollboxw-offsetw;
3313: itemid.style.width = newitemw+"px";
3314: }
3315: } else {
3316: newscrollboxw = boxw-paddingw-maxcolw;
3317: if (newscrollboxw < minscrollboxw) {
3318: newscrollboxw = minscrollboxw;
3319: }
3320: scrollbox.style.width = newscrollboxw+"px";
3321: if (newscrollboxw != scrollboxw) {
3322: var newitemw = newscrollboxw-offsetw;
3323: itemid.style.width = newitemw+"px";
3324: }
3325: }
3326:
3327: if (newscrollboxw != scrollboxw) {
3328: var newscrolltablew = newscrollboxw+offsetw;
3329: scrolltable.style.width = newscrolltablew+"px";
3330: }
3331: }
3332:
3333: if (newscrollboxw != scrollboxw) {
3334: scrollchange = 1;
3335: }
3336:
3337: if (itemid.offsetWidth != itemwstart) {
3338: listwchange = 1;
3339: }
3340: }
3341: if ((chkh == 1) || (listwchange)) {
3342: var itemid = document.getElementById("$names{'item'}");
3343: if (itemid != null) {
3344: itemh = itemid.offsetHeight;
3345: }
3346: var primaryheight = 0;
3347: if (document.getElementById('LC_nav_bar') != null) {
3348: primaryheight = document.getElementById('LC_nav_bar').offsetHeight;
3349: }
3350: var secondaryheight = 0;
3351: if (document.getElementById('LC_secondary_menu') != null) {
3352: secondaryheight = document.getElementById('LC_secondary_menu').offsetHeight;
3353: }
3354: var crumbsheight = 0;
3355: if (document.getElementById('LC_breadcrumbs') != null) {
3356: crumbsheight = document.getElementById('LC_breadcrumbs').offsetHeight;
3357: }
3358: var dccidheight = 0;
3359: if (document.getElementById('dccid') != null) {
3360: dccidheight = document.getElementById('dccid').offsetHeight;
3361: }
3362: var headerheight = 0;
3363: if (document.getElementById("$names{'header'}") != null) {
3364: headerheight = document.getElementById("$names{'header'}").offsetHeight;
3365: }
3366: var tabbedheight = document.getElementById("tabbededitor").offsetHeight;
3367: var boxheight = document.getElementById("$names{'boxh'}").offsetHeight;
3368: var freevspace = vph-(primaryheight+secondaryheight+crumbsheight+dccidheight+headerheight+tabbedheight+boxheight);
3369:
3370: var scrollboxheight = scrollbox.offsetHeight;
3371: var scrollboxscrollheight = scrollbox.scrollHeight;
3372: var scrollboxh = scrollboxheight;
3373:
3374: var minvscrollbox = $minv;
3375: var offsetv = $offsetv;
3376: var newscrollboxheight;
3377: if (freevspace < 0) {
3378: newscrollboxheight = scrollboxheight+freevspace-offsetv;
3379: if (newscrollboxheight < minvscrollbox) {
3380: newscrollboxheight = minvscrollbox;
3381: }
3382: scrollbox.style.height = newscrollboxheight + "px";
3383: } else {
3384: if (scrollboxscrollheight > scrollboxheight) {
3385: if (freevspace > offsetv) {
3386: newscrollboxheight = scrollboxheight+freevspace-offsetv;
3387: if (newscrollboxheight < minvscrollbox) {
3388: newscrollboxheight = minvscrollbox;
3389: }
3390: scrollbox.style.height = newscrollboxheight+"px";
3391: }
3392: }
3393: }
3394: scrollboxheight = scrollbox.offsetHeight;
3395: var itemh = document.getElementById("$names{'item'}").offsetHeight;
3396:
3397: if (scrollboxscrollheight <= scrollboxheight) {
3398: if ((itemh+offsetv)<scrollboxheight) {
3399: newscrollheight = itemh+offsetv;
3400: scrollbox.style.height = newscrollheight+"px";
3401: }
3402: }
3403: var newscrollboxh = scrollbox.offsetHeight;
3404: if (scrollboxh != newscrollboxh) {
3405: scrollchange = 1;
3406: }
3407: }
3408: if (ismobile && scrollchange) {
3409: \$("#div_$names{'scroll'}").getNiceScroll().onResize();
3410: }
3411: return;
3412: }
3413:
3414: function callResize() {
3415: var timer;
3416: clearTimeout(timer);
3417: timer=setTimeout('resize_scrollbox("$names{'scroll'}","1","1")',500);
3418: }
3419:
3420: THIRD
3421: return $output;
3422: }
3423:
3424: ##############################################
3425: ##############################################
3426:
3427: sub javascript_jumpto_resource {
3428: my $confirm_switch = &mt("Editing requires switching to the resource's home server.")."\n".
3429: &mt('Switch server?');
3430: &js_escape(\$confirm_switch);
3431: return (<<ENDUTILITY)
3432:
3433: function go(url) {
3434: if (url!='' && url!= null) {
3435: currentURL = null;
3436: currentSymb= null;
3437: var lcHostname = setLCHost();
3438: if (lcHostname!='' && lcHostname!= null) {
3439: var RegExp = /^https?\:/;
3440: if (RegExp.test(url)) {
3441: window.location.href=url;
3442: } else {
3443: window.location.href=lcHostname+url;
3444: }
3445: } else {
3446: window.location.href=url;
3447: }
3448: }
3449: }
3450:
3451: function need_switchserver(url) {
3452: if (url!='' && url!= null) {
3453: if (confirm("$confirm_switch")) {
3454: go(url);
3455: }
3456: }
3457: return;
3458: }
3459:
3460: ENDUTILITY
3461:
3462: }
3463:
3464: sub jump_to_editres {
3465: my ($cfile,$home,$switchserver,$forceedit,$forcereg,$symb,$folderpath,
3466: $title,$hostname,$idx,$suppurl,$todocs,$suppanchor) = @_;
3467: my ($jscall,$anchor,$usehttp,$usehttps,$is_ext);
3468: if ($switchserver) {
3469: if ($home) {
3470: $cfile = '/adm/switchserver?otherserver='.$home.'&role='.
3471: &HTML::Entities::encode($env{'request.role'},'"<>&');
3472: if ($symb) {
3473: $cfile .= '&symb='.&HTML::Entities::encode($symb,'"<>&');
3474: } elsif ($folderpath) {
3475: $cfile .= '&folderpath='.&HTML::Entities::encode($folderpath,'"<>&');
3476: }
3477: if ($forceedit) {
3478: $cfile .= '&forceedit=1';
3479: }
3480: if ($forcereg) {
3481: $cfile .= '&register=1';
3482: }
3483: $jscall = "need_switchserver('".&Apache::loncommon::escape_single($cfile)."');";
3484: }
3485: } else {
3486: unless ($cfile =~ m{^/priv/}) {
3487: if ($cfile =~ m{^(/adm/wrapper/ext/([^#]+))(?:|#([^#]+))$}) {
3488: $cfile = $1;
3489: my $extlink = $2;
3490: $anchor = $3;
3491: $is_ext = 1;
3492: if (($extlink !~ /^https:/) && ($ENV{'SERVER_PORT'} == 443)) {
3493: unless ((&Apache::lonnet::uses_sts()) || (&Apache::lonnet::waf_allssl($hostname))) {
3494: $usehttp = 1;
3495: }
3496: } elsif ($env{'request.use_absolute'}) {
3497: if ($env{'request.use_absolute'} =~ m{^https://}) {
3498: $usehttps = 1;
3499: }
3500: }
3501: } elsif ($cfile =~ m{^/?public/($match_domain)/($match_courseid)/syllabus}) {
3502: if ($ENV{'SERVER_PORT'} == 443) {
3503: my ($cdom,$cnum) = ($1,$2);
3504: if (($env{'request.course.id'}) &&
3505: ($env{'course.'.$env{'request.course.id'}.'.num'} eq $cnum) &&
3506: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $cdom)) {
3507: if ($env{'course.'.$env{'request.course.id'}.'.externalsyllabus'} =~ m{^http://}) {
3508: unless ((&Apache::lonnet::uses_sts()) || (&Apache::lonnet::waf_allssl($hostname))) {
3509: $usehttp = 1;
3510: }
3511: }
3512: }
3513: } elsif ($env{'request.use_absolute'}) {
3514: if ($env{'request.use_absolute'} =~ m{^https://}) {
3515: $usehttps = 1;
3516: }
3517: }
3518: }
3519: if ($symb) {
3520: if ($anchor ne '') {
3521: if ($symb =~ m{^([^#]+)\Q#$anchor\E$}) {
3522: $symb = $1.&escape(&escape('#')).$anchor;
3523: }
3524: }
3525: $cfile .= (($cfile=~/\?/)?'&':'?')."symb=$symb";
3526: } elsif ($folderpath) {
3527: $cfile .= (($cfile=~/\?/)?'&':'?').
3528: 'folderpath='.&HTML::Entities::encode(&escape($folderpath),'"<>&');
3529: if ($title) {
3530: $cfile .= (($cfile=~/\?/)?'&':'?').
3531: 'title='.&HTML::Entities::encode(&escape($title),'"<>&');
3532: }
3533: if ($idx) {
3534: $cfile .= (($cfile=~/\?/)?'&':'?').'idx='.$idx;
3535: }
3536: if ($suppurl) {
3537: $cfile .= (($cfile=~/\?/)?'&':'?').
3538: 'suppurl='.&HTML::Entities::encode(&escape($suppurl));
3539: }
3540: }
3541: if ($forceedit) {
3542: $cfile .= (($cfile=~/\?/)?'&':'?').'forceedit=1';
3543: if ($usehttps) {
3544: $cfile = $env{'request.use_absolute'}.(($cfile =~ /^\//)? '':'/').$cfile;
3545: }
3546: } elsif ($usehttp) {
3547: if ($hostname ne '') {
3548: $cfile = 'http://'.$hostname.(($cfile =~ /^\//)? '':'/').$cfile;
3549: }
3550: $cfile .= (($cfile=~/\?/)?'&':'?').'usehttp=1';
3551: } elsif ($usehttps) {
3552: $cfile = $env{'request.use_absolute'}.(($cfile =~ /^\//)? '':'/').$cfile;
3553: }
3554: if ($forcereg) {
3555: $cfile .= (($cfile=~/\?/)?'&':'?').'register=1';
3556: }
3557: if ($todocs) {
3558: $cfile .= (($cfile=~/\?/)?'&':'?').'todocs=1';
3559: }
3560: if ($suppanchor ne '') {
3561: $cfile .= (($cfile=~/\?/)?'&':'?').'anchor='.
3562: &HTML::Entities::encode($suppanchor,'"<>&');
3563: }
3564: }
3565: if ($anchor ne '') {
3566: $cfile .= '#'.$anchor;
3567: }
3568: $jscall = "go('".&Apache::loncommon::escape_single($cfile)."')";
3569: }
3570: return $jscall;
3571: }
3572:
3573: ##############################################
3574: ##############################################
3575:
3576: # javascript_valid_email
3577: #
3578: # Generates javascript to validate an e-mail address.
3579: # Returns a javascript function which accepts a form field as argument, and
3580: # returns false if field.value does not satisfy two regular expression matches
3581: # for a valid e-mail address. Backwards compatible with old browsers without
3582: # support for javascript RegExp (just checks for @ in field.value in this case).
3583:
3584: sub javascript_valid_email {
3585: my $scripttag .= <<'END';
3586: function validmail(field,suffix) {
3587: var str = field.value;
3588: if (suffix != '' && suffix != undefined) {
3589: str += suffix;
3590: }
3591: if (window.RegExp) {
3592: var reg1str = "(@.*@)|(\\.\\.)|(@\\.)|(\\.@)|(^\\.)";
3593: var reg2str = "^.+\\@(\\[?)[a-zA-Z0-9\\-\\.]+\\.([a-zA-Z]{2,3}|[0-9]{1,3})(\\]?)$"; //"
3594: var reg1 = new RegExp(reg1str);
3595: var reg2 = new RegExp(reg2str);
3596: if (!reg1.test(str) && reg2.test(str)) {
3597: return true;
3598: }
3599: return false;
3600: }
3601: else
3602: {
3603: if(str.indexOf("@") >= 0) {
3604: return true;
3605: }
3606: return false;
3607: }
3608: }
3609: END
3610: return $scripttag;
3611: }
3612:
3613:
3614: # USAGE: htmltag(element, content, {attribute => value,...});
3615: #
3616: # EXAMPLES:
3617: # - htmltag('a', 'this is an anchor', {href => 'www.example.com',
3618: # title => 'this is a title'})
3619: #
3620: # - You might want to set up needed tags like:
3621: #
3622: # my $h3 = sub { return htmltag( "h3", @_ ) };
3623: #
3624: # ... and use them: $h3->("This is a headline")
3625: #
3626: # - To set up a couple of tags, see sub inittags
3627: #
3628: # NOTES:
3629: # - Empty elements, such as <br/> are correctly terminated,
3630: # i.e. htmltag('br') returns <br/>
3631: # - Empty attributes (title="") are filtered out.
3632: # - The function will not check for deprecated attributes.
3633: #
3634: # OUTPUT: content enclosed in xhtml conform tags
3635: sub htmltag{
3636: return
3637: qq|<$_[0]|
3638: . join( '', map { qq| $_="${$_[2]}{$_}"| if ${$_[2]}{$_} } keys(%{ $_[2] }) )
3639: . ($_[1] ? qq|>$_[1]</$_[0]>| : qq|/>|). "\n";
3640: };
3641:
3642:
3643: # USAGE: inittags(@tags);
3644: #
3645: # EXAMPLES:
3646: # - my ($h1, $h2, $h3) = inittags( qw( h1 h2 h3 ) )
3647: # $h1->("This is a headline") #Returns: <h1>This is a headline</h1>
3648: #
3649: # NOTES: See sub htmltag for further information.
3650: #
3651: # OUTPUT: List of subroutines.
3652: sub inittags {
3653: my @tags = @_;
3654: return map { my $tag = $_;
3655: sub { return htmltag( $tag, @_ ) }
3656: } @tags;
3657: }
3658:
3659:
3660: # USAGE: scripttag(scriptcode, [start|end|both]);
3661: #
3662: # EXAMPLES:
3663: # - scripttag("alert('Hello World!')", 'both')
3664: # returns:
3665: # <script type="text/javascript">
3666: # // BEGIN LON-CAPA Internal
3667: # alert(Hello World!')
3668: # // END LON-CAPA Internal
3669: # </script>
3670: #
3671: # NOTES:
3672: # - works currently only for javascripts
3673: #
3674: # OUTPUT:
3675: # Scriptcode properly enclosed in <script> and CDATA tags (and LC
3676: # Internal markers if 2nd argument is given)
3677: sub scripttag {
3678: my ( $content, $marker ) = @_;
3679: return unless defined $content;
3680:
3681: my $begin = "\n// BEGIN LON-CAPA Internal\n";
3682: my $end = "\n// END LON-CAPA Internal\n";
3683:
3684: if ($marker) {
3685: $content = $begin . $content if $marker eq 'start' or $marker eq 'both';
3686: $content .= $end if $marker eq 'end' or $marker eq 'both';
3687: }
3688:
3689: $content = "\n// <![CDATA[\n$content\n// ]]>\n";
3690:
3691: return htmltag('script', $content, {type => 'text/javascript'});
3692: };
3693:
3694: =pod
3695:
3696: =item &list_from_array( \@array, { listattr =>{}, itemattr =>{} } )
3697:
3698: Constructs a XHTML list from \@array.
3699:
3700: input:
3701:
3702: =over
3703:
3704: =item \@array
3705:
3706: A reference to the array containing text that will be wrapped in <li></li> tags.
3707:
3708: =item { listattr => {}, itemattr =>{} }
3709:
3710: Attributes for <ul> and <li> passed in as hash references.
3711: See htmltag() for more details.
3712:
3713: =back
3714:
3715: returns: XHTML list as String.
3716:
3717: =cut
3718:
3719: # \@items, {listattr => { class => 'abc', id => 'xyx' }, itemattr => {class => 'abc', id => 'xyx'}}
3720: sub list_from_array {
3721: my ($items, $args) = @_;
3722: return unless (ref($items) eq 'ARRAY');
3723: return unless scalar @$items;
3724: my ($ul, $li) = inittags( qw(ul li) );
3725: my $listitems = join '', map { $li->($_, $args->{itemattr}) } @$items;
3726: return $ul->( $listitems, $args->{listattr} );
3727: }
3728:
3729:
3730: ##############################################
3731: ##############################################
3732:
3733: # generate_menu
3734: #
3735: # Generates html markup for a menu.
3736: #
3737: # Inputs:
3738: # An array of following structure:
3739: # ({ categorytitle => 'Categorytitle',
3740: # items => [
3741: # {
3742: # linktext => 'Text to be displayed',
3743: # url => 'URL the link is pointing to, i.e. /adm/site?action=dosomething',
3744: # permission => 'Contains permissions as returned from lonnet::allowed(),
3745: # must evaluate to true in order to activate the link',
3746: # icon => 'icon filename',
3747: # alttext => 'alt text for the icon',
3748: # help => 'Name of the corresponding helpfile',
3749: # linktitle => 'Description of the link (used for title tag)'
3750: # },
3751: # ...
3752: # ]
3753: # },
3754: # ...
3755: # )
3756: #
3757: # Outputs: A scalar containing the html markup for the menu.
3758:
3759: sub generate_menu {
3760: my @menu = @_;
3761: # subs for specific html elements
3762: my ($h3, $div, $ul, $li, $a, $img) = inittags( qw(h3 div ul li a img) );
3763:
3764: my @categories; # each element represents the entire markup for a category
3765:
3766: foreach my $category (@menu) {
3767: my @links; # contains the links for the current $category
3768: foreach my $link (@{$$category{items}}) {
3769: next unless $$link{permission};
3770:
3771: # create the markup for the current $link and push it into @links.
3772: # each entry consists of an image and a text optionally followed
3773: # by a help link.
3774: my $src;
3775: if ($$link{icon} ne '') {
3776: $src = '/res/adm/pages/'.$$link{icon};
3777: }
3778: push(@links,$li->(
3779: $a->(
3780: $img->("", {
3781: class => "LC_noBorder LC_middle",
3782: src => $src,
3783: alt => mt(defined($$link{alttext}) ?
3784: $$link{alttext} : $$link{linktext})
3785: }), {
3786: href => $$link{url},
3787: title => mt($$link{linktitle}),
3788: class => 'LC_menubuttons_link'
3789: }).
3790: $a->(mt($$link{linktext}), {
3791: href => $$link{url},
3792: title => mt($$link{linktitle}),
3793: class => "LC_menubuttons_link"
3794: }).
3795: (defined($$link{help}) ?
3796: Apache::loncommon::help_open_topic($$link{help}) : ''),
3797: {class => "LC_menubuttons_inline_text"}));
3798: }
3799:
3800: # wrap categorytitle in <h3>, concatenate with
3801: # joined and in <ul> tags wrapped @links
3802: # and wrap everything in an enclosing <div> and push it into
3803: # @categories
3804: # such that each element looks like:
3805: # <div><h3>title</h3><ul><li>...</li>...</ul></div>
3806: # the category won't be added if there aren't any links
3807: push(@categories,
3808: $div->($h3->(mt($$category{categorytitle}), {class=>"LC_hcell"}).
3809: $ul->(join('' ,@links), {class =>"LC_ListStyleNormal" }),
3810: {class=>"LC_Box LC_400Box"})) if scalar(@links);
3811: }
3812:
3813: # wrap the joined @categories in another <div> (column layout)
3814: return $div->(join('', @categories), {class => "LC_columnSection"});
3815: }
3816:
3817: ##############################################
3818: ##############################################
3819:
3820: =pod
3821:
3822: =item &start_funclist()
3823:
3824: Start list of available functions
3825:
3826: Typically used to offer a simple list of available functions
3827: at top or bottom of page.
3828: All available functions/actions for the current page
3829: should be included in this list.
3830:
3831: If the optional headline text is not provided, a default text will be used.
3832:
3833:
3834: Related routines:
3835: =over 4
3836: add_item_funclist
3837: end_funclist
3838: =back
3839:
3840:
3841: Inputs: (optional) headline text
3842:
3843: Returns: HTML code with function list start
3844:
3845: =cut
3846:
3847: ##############################################
3848: ##############################################
3849:
3850: sub start_funclist {
3851: my($legendtext)=@_;
3852: $legendtext=&mt('Functions') if !$legendtext;
3853: return '<ul class="LC_funclist"><li style="font-weight:bold; margin-left:0.8em;">'.$legendtext.'</li>'."\n";
3854: }
3855:
3856:
3857: ##############################################
3858: ##############################################
3859:
3860: =pod
3861:
3862: =item &add_item_funclist()
3863:
3864: Adds an item to the list of available functions
3865:
3866: Related routines:
3867: =over 4
3868: start_funclist
3869: end_funclist
3870: =back
3871:
3872: Inputs: content item with text and link to function
3873:
3874: Returns: HTML code with list item for funclist
3875:
3876: =cut
3877:
3878: ##############################################
3879: ##############################################
3880:
3881: sub add_item_funclist {
3882: my($content) = @_;
3883: return '<li>'.$content.'</li>'."\n";
3884: }
3885:
3886: =pod
3887:
3888: =item &end_funclist()
3889:
3890: End list of available functions
3891:
3892: Related routines:
3893: =over 4
3894: start_funclist
3895: add_item_funclist
3896: =back
3897:
3898: Inputs: ./.
3899:
3900: Returns: HTML code with function list end
3901:
3902: =cut
3903:
3904: sub end_funclist {
3905: return "</ul>\n";
3906: }
3907:
3908: =pod
3909:
3910: =item &funclist_from_array( \@array, {legend => 'text for legend'} )
3911:
3912: Constructs a XHTML list from \@array with the first item being visually
3913: highlighted and set to the value of legend or 'Functions' if legend is
3914: empty.
3915:
3916: =over
3917:
3918: =item \@array
3919:
3920: A reference to the array containing text that will be wrapped in <li></li> tags.
3921:
3922: =item { legend => 'text' }
3923:
3924: A string that's used as visually highlighted first item. 'Functions' is used if
3925: it's value evaluates to false.
3926:
3927: =back
3928:
3929: returns: XHTML list as string.
3930:
3931: =back
3932:
3933: =cut
3934:
3935: sub funclist_from_array {
3936: my ($items, $args) = @_;
3937: return unless(ref($items) eq 'ARRAY');
3938: $args->{legend} ||= mt('Functions');
3939: return list_from_array( [$args->{legend}, @$items],
3940: { listattr => {class => 'LC_funclist'} });
3941: }
3942:
3943: =pod
3944:
3945: =over
3946:
3947: =item &actionbox( \@array )
3948:
3949: Constructs a XHTML list from \@array with the first item being visually
3950: highlighted and set to the value 'Actions'. The list is wrapped in a division.
3951:
3952: The actionlist is used to offer contextual actions, mostly at the bottom
3953: of a page, on which the outcome of an processed action is shown,
3954: e.g. a file operation in Authoring Space.
3955:
3956: =over
3957:
3958: =item \@array
3959:
3960: A reference to the array containing text. Details: sub funclist_from_array
3961:
3962: =back
3963:
3964: Returns: XHTML div as string.
3965:
3966: =back
3967:
3968: =cut
3969:
3970: sub actionbox {
3971: my ($items) = @_;
3972: return unless(ref($items) eq 'ARRAY');
3973: return
3974: '<div class="LC_actionbox">'
3975: .&funclist_from_array($items, {legend => &mt('Actions')})
3976: .'</div>';
3977: }
3978:
3979: 1;
3980:
3981: __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