1: # The LearningOnline Network with CAPA
2: # a pile of common html routines
3: #
4: # $Id: lonhtmlcommon.pm,v 1.358.2.18 2020/09/02 00:42:52 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: ############################################################
1758:
1759: =pod
1760:
1761: =item &breadcrumbs()
1762:
1763: Compiles the previously registered breadcrumbs into an series of links.
1764: Additionally supports a 'component', which will be displayed on the
1765: right side of the breadcrumbs enclosing div (without a link).
1766: A link to help for the component will be included if one is specified.
1767:
1768: All inputs can be undef without problems.
1769:
1770: Inputs: $component (the text on the right side of the breadcrumbs trail),
1771: $component_help (the help item filename (without .tex extension).
1772: $menulink (boolean, controls whether to include a link to /adm/menu)
1773: $helplink (if 'nohelp' don't include the orange help link)
1774: $css_class (optional name for the class to apply to the table for CSS)
1775: $no_mt (optional flag, 1 if &mt() is _not_ to be applied to $component
1776: when including the text on the right.
1777: $CourseBreadcrumbs (optional flag, 1 if &breadcrumbs called from &docs_breadcrumbs,
1778: because breadcrumbs are being)
1779: $topic_help (optional help item to be displayed on right side of the breadcrumbs
1780: row, using loncommon::help_open_topic() to generate the link.
1781: $topic_help_text (text to include in the link in the optional help item
1782: on the right side of the breadcrumbs row.
1783:
1784: Returns a string containing breadcrumbs for the current page.
1785:
1786: =item &clear_breadcrumbs()
1787:
1788: Clears the previously stored breadcrumbs.
1789:
1790: =item &add_breadcrumb()
1791:
1792: Pushes a breadcrumb on the stack of crumbs.
1793:
1794: input: $breadcrumb, a hash reference. The keys 'href','title', and 'text'
1795: are required. If present the keys 'faq' and 'bug' will be used to provide
1796: links to the FAQ and bug sites. If the key 'no_mt' is present the 'title'
1797: and 'text' values won't be sent through &mt()
1798:
1799: returns: nothing
1800:
1801: =cut
1802:
1803: ############################################################
1804: ############################################################
1805: {
1806: my @Crumbs;
1807: my %tools = ();
1808:
1809: sub breadcrumbs {
1810: my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt,
1811: $CourseBreadcrumbs,$topic_help,$topic_help_text) = @_;
1812: #
1813: $css_class ||= 'LC_breadcrumbs';
1814:
1815: # Make the faq and bug data cascade
1816: my $faq = '';
1817: my $bug = '';
1818: my $help = '';
1819: # Crumb Symbol
1820: my $crumbsymbol = '»';
1821: # The last breadcrumb does not have a link, so handle it separately.
1822: my $last = pop(@Crumbs);
1823: #
1824: # The first one should be the course or a menu link
1825: if (!defined($menulink)) { $menulink=1; }
1826: if ($menulink) {
1827: my $description = 'Menu';
1828: my $no_mt_descr = 0;
1829: if ((exists($env{'request.course.id'})) &&
1830: ($env{'request.course.id'} ne '') &&
1831: ($env{'course.'.$env{'request.course.id'}.'.description'} ne '')) {
1832: $description =
1833: $env{'course.'.$env{'request.course.id'}.'.description'};
1834: $no_mt_descr = 1;
1835: if ($env{'request.noversionuri'} =~
1836: m{^/?public/($match_domain)/($match_courseid)/syllabus$}) {
1837: unless (($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1) &&
1838: ($env{'course.'.$env{'request.course.id'}.'.num'} eq $2)) {
1839: $description = 'Menu';
1840: $no_mt_descr = 0;
1841: }
1842: }
1843: }
1844: $menulink = { href =>'/adm/menu',
1845: title =>'Go to main menu',
1846: target =>'_top',
1847: text =>$description,
1848: no_mt =>$no_mt_descr, };
1849: if($last) {
1850: #$last set, so we have some crumbs
1851: unshift(@Crumbs,$menulink);
1852: } else {
1853: #only menulink crumb present
1854: $last = $menulink;
1855: }
1856: }
1857: my $links;
1858: if ((&show_return_link) && (!$CourseBreadcrumbs) && (ref($last) eq 'HASH')) {
1859: my $alttext = &mt('Go Back');
1860: my $hashref = { href => '/adm/flip?postdata=return:',
1861: title => &mt('Back to most recent content resource'),
1862: class => 'LC_menubuttons_link',
1863: };
1864: if ($env{'request.noversionuri'} eq '/adm/searchcat') {
1865: $hashref->{'target'} = '_top';
1866: }
1867: $links=&htmltag( 'a','<img src="/res/adm/pages/tolastloc.png" alt="'.$alttext.'" class="LC_icon" />',
1868: $hashref);
1869: $links=&htmltag('li',$links);
1870: }
1871: $links.= join "",
1872: map {
1873: $faq = $_->{'faq'} if (exists($_->{'faq'}));
1874: $bug = $_->{'bug'} if (exists($_->{'bug'}));
1875: $help = $_->{'help'} if (exists($_->{'help'}));
1876:
1877: my $result = $_->{no_mt} ? $_->{text} : &mt($_->{text});
1878:
1879: if ($_->{href}){
1880: $result = &htmltag( 'a', $result,
1881: { href => $_->{href},
1882: title => $_->{no_mt} ? $_->{title} : &mt($_->{title}),
1883: target => $_->{target}, });
1884: }
1885:
1886: $result = &htmltag( 'li', "$result $crumbsymbol");
1887: } @Crumbs;
1888:
1889: #should the last Element be translated?
1890:
1891: my $lasttext = $last->{'no_mt'} ? $last->{'text'}
1892: : mt( $last->{'text'} );
1893:
1894: # last breadcrumb is the first order heading of a page
1895: # for course breadcrumbs it's just bold
1896:
1897: if ($lasttext ne '') {
1898: $links .= &htmltag( 'li', htmltag($CourseBreadcrumbs ? 'b' : 'h1',
1899: $lasttext), {title => $lasttext});
1900: }
1901:
1902: my $icons = '';
1903: $faq = $last->{'faq'} if (exists($last->{'faq'}));
1904: $bug = $last->{'bug'} if (exists($last->{'bug'}));
1905: $help = $last->{'help'} if (exists($last->{'help'}));
1906: $component_help=($component_help?$component_help:$help);
1907: # if ($faq ne '') {
1908: # $icons .= &Apache::loncommon::help_open_faq($faq);
1909: # }
1910: # if ($bug ne '') {
1911: # $icons .= &Apache::loncommon::help_open_bug($bug);
1912: # }
1913: if ($faq ne '' || $component_help ne '' || $bug ne '') {
1914: $icons .= &Apache::loncommon::help_open_menu($component,
1915: $component_help,
1916: $faq,$bug);
1917: }
1918: if ($topic_help && $topic_help_text) {
1919: $icons .= ' '.&Apache::loncommon::help_open_topic($topic_help,&mt($topic_help_text),'',
1920: undef,600);
1921: }
1922: #
1923:
1924:
1925: if ($links ne '') {
1926: unless ($CourseBreadcrumbs) {
1927: $links = &htmltag('ol', $links, { id => "LC_MenuBreadcrumbs" });
1928: } else {
1929: $links = &htmltag('ul', $links, { class => "LC_CourseBreadcrumbs" });
1930: }
1931: }
1932:
1933:
1934: if (($component) || ($topic_help && $topic_help_text)) {
1935: $links = &htmltag('span',
1936: ( $no_mt ? $component : mt($component) ).
1937: ( $icons ? $icons : '' ),
1938: { class => 'LC_breadcrumbs_component' } )
1939: .$links
1940: ;
1941: }
1942: my $nav_and_tools = 0;
1943: foreach my $item ('navigation','tools') {
1944: if (ref($tools{$item}) eq 'ARRAY') {
1945: $nav_and_tools += scalar(@{$tools{$item}})
1946: }
1947: }
1948: if (($links ne '') || ($nav_and_tools)) {
1949: &render_tools(\$links);
1950: $links = &htmltag('div', $links,
1951: { id => "LC_breadcrumbs" }) unless ($CourseBreadcrumbs) ;
1952: }
1953: my $adv_tools = 0;
1954: if (ref($tools{'advtools'}) eq 'ARRAY') {
1955: $adv_tools = scalar(@{$tools{'advtools'}});
1956: }
1957: if (($links ne '') || ($adv_tools)) {
1958: &render_advtools(\$links);
1959: }
1960:
1961: # Return the @Crumbs stack to what we started with
1962: push(@Crumbs,$last);
1963: shift(@Crumbs);
1964:
1965:
1966: # Return the breadcrumb's line
1967:
1968:
1969:
1970: return "$links";
1971: }
1972:
1973: sub clear_breadcrumbs {
1974: undef(@Crumbs);
1975: undef(%tools);
1976: }
1977:
1978: sub add_breadcrumb {
1979: push(@Crumbs,@_);
1980: }
1981:
1982: =item &add_breadcrumb_tool($category, $html)
1983:
1984: Adds $html to $category of the breadcrumb toolbar container.
1985:
1986: $html is usually a link to a page that invokes a function on the currently
1987: displayed data (e.g. print when viewing a problem)
1988:
1989: Currently there are 3 possible values for $category:
1990:
1991: =over
1992:
1993: =item navigation
1994: left of breadcrumbs line
1995:
1996: =item tools
1997: remaining items in right of breadcrumbs line
1998:
1999: =item advtools
2000: advanced tools shown in a separate box below breadcrumbs line
2001:
2002: =back
2003:
2004: returns: nothing
2005:
2006: =cut
2007:
2008: sub add_breadcrumb_tool {
2009: my ($category, @html) = @_;
2010: return unless @html;
2011: if (!keys(%tools)) {
2012: %tools = ( navigation => [], tools => [], advtools => []);
2013: }
2014:
2015: #this cleans data received from lonmenu::innerregister
2016: @html = grep {defined $_ && $_ ne ''} @html;
2017: for (@html) {
2018: s/align="(right|left)"//;
2019: # s/<span.*?\/span>// if $category ne 'advtools';
2020: }
2021:
2022: push @{$tools{$category}}, @html;
2023: }
2024:
2025: =item &clear_breadcrumb_tools()
2026:
2027: Clears the breadcrumb toolbar container.
2028:
2029: returns: nothing
2030:
2031: =cut
2032:
2033: sub clear_breadcrumb_tools {
2034: undef(%tools);
2035: }
2036:
2037: =item ¤t_breadcrumb_tools()
2038:
2039: returns: a hash containing the current breadcrumb tools.
2040:
2041: =cut
2042:
2043: sub current_breadcrumb_tools {
2044: return %tools;
2045: }
2046:
2047: =item &render_tools(\$breadcrumbs)
2048:
2049: Creates html for breadcrumb tools (categories navigation and tools) and inserts
2050: \$breadcrumbs at the correct position.
2051:
2052: input: \$breadcrumbs - a reference to the string containing prepared
2053: breadcrumbs.
2054:
2055: returns: nothing
2056:
2057: =cut
2058:
2059: #TODO might split this in separate functions for each category
2060: sub render_tools {
2061: my ($breadcrumbs) = @_;
2062: return unless (keys(%tools));
2063:
2064: my $navigation = list_from_array($tools{navigation},
2065: { listattr => { class=>"LC_breadcrumb_tools_navigation" } });
2066: my $tools = list_from_array($tools{tools},
2067: { listattr => { class=>"LC_breadcrumb_tools_tools" } });
2068: $$breadcrumbs = list_from_array([$navigation, $tools, $$breadcrumbs],
2069: { listattr => { class=>'LC_breadcrumb_tools_outerlist' } });
2070: }
2071:
2072: =pod
2073:
2074: =item &render_advtools(\$breadcrumbs)
2075:
2076: Creates html for advanced tools (category advtools) and inserts \$breadcrumbs
2077: at the correct position.
2078:
2079: input: \$breadcrumbs - a reference to the string containing prepared
2080: breadcrumbs (after render_tools call).
2081:
2082: returns: nothing
2083:
2084: =cut
2085:
2086: sub render_advtools {
2087: my ($breadcrumbs) = @_;
2088: return unless (defined $tools{'advtools'})
2089: and (scalar(@{$tools{'advtools'}}) > 0);
2090:
2091: $$breadcrumbs .= Apache::loncommon::head_subbox(
2092: funclist_from_array($tools{'advtools'}) );
2093: }
2094:
2095: } # End of scope for @Crumbs
2096:
2097: sub docs_breadcrumbs {
2098: my ($allowed,$crstype,$contenteditor,$title,$precleared)=@_;
2099: my ($folderpath,@folders,$supplementalflag);
2100: @folders = split('&',$env{'form.folderpath'});
2101: if ($env{'form.folderpath'} =~ /^supplemental/) {
2102: $supplementalflag = 1;
2103: }
2104: my $plain='';
2105: my $container = 'sequence';
2106: my ($randompick,$isencrypted,$ishidden,$is_random_order) = (-1,0,0,0);
2107: my @docs_crumbs;
2108: while (@folders) {
2109: my $folder=shift(@folders);
2110: my $foldername=shift(@folders);
2111: if ($folderpath) {$folderpath.='&';}
2112: $folderpath.=$folder.'&'.$foldername;
2113: my $url = $env{'request.use_absolute'};
2114: if ($allowed) {
2115: $url .= '/adm/coursedocs?folderpath=';
2116: } else {
2117: $url .= '/adm/supplemental?folderpath=';
2118: }
2119: $url .= &escape($folderpath);
2120: my $name=&unescape($foldername);
2121: # each of randompick number, hidden, encrypted, random order, is_page
2122: # are appended with ":"s to the foldername
2123: $name=~s/\:(\d*)\:(\w*)\:(\w*):(\d*)\:?(\d*)$//;
2124: unless ($supplementalflag) {
2125: if ($contenteditor) {
2126: if ($1 ne '') {
2127: $randompick=$1;
2128: } else {
2129: $randompick=-1;
2130: }
2131: if ($2) { $ishidden=1; }
2132: if ($3) { $isencrypted=1; }
2133: if ($4 ne '') { $is_random_order = 1; }
2134: if ($5 == 1) {$container = 'page'; }
2135: }
2136: }
2137: if ($folder eq 'supplemental') {
2138: $name = &mt('Supplemental Content');
2139: }
2140: if ($contenteditor) {
2141: $plain.=$name.' > ';
2142: }
2143: push(@docs_crumbs,
2144: {'href' => $url,
2145: 'title' => $name,
2146: 'text' => $name,
2147: 'no_mt' => 1,
2148: });
2149: }
2150: if ($title) {
2151: push(@docs_crumbs,
2152: {'title' => $title,
2153: 'text' => $title,
2154: 'no_mt' => 1,}
2155: );
2156: }
2157: if (wantarray) {
2158: unless ($precleared) {
2159: &clear_breadcrumbs();
2160: }
2161: &add_breadcrumb(@docs_crumbs);
2162: if ($contenteditor) {
2163: $plain=~s/\>\;\s*$//;
2164: }
2165: my $menulink = 0;
2166: if (!$allowed && !$contenteditor) {
2167: $menulink = 1;
2168: }
2169: return (&breadcrumbs(undef,undef,$menulink,'nohelp',undef,undef,
2170: $contenteditor),
2171: $randompick,$ishidden,$isencrypted,$plain,
2172: $is_random_order,$container);
2173: } else {
2174: return \@docs_crumbs;
2175: }
2176: }
2177:
2178: ############################################################
2179: ############################################################
2180:
2181: # Nested table routines.
2182: #
2183: # Routines to display form items in a multi-row table with 2 columns.
2184: # Uses nested tables to divide form elements into segments.
2185: # For examples of use see loncom/interface/lonnotify.pm
2186: #
2187: # Can be used in following order: ...
2188: # &start_pick_box()
2189: # row1
2190: # row2
2191: # row3 ... etc.
2192: # &submit_row()
2193: # &end_pick_box()
2194: #
2195: # where row1, row 2 etc. are chosen from &role_select_row,&course_select_row,
2196: # &status_select_row and &email_default_row
2197: #
2198: # Can also be used in following order:
2199: #
2200: # &start_pick_box()
2201: # &row_title()
2202: # &row_closure()
2203: # &row_title()
2204: # &row_closure() ... etc.
2205: # &submit_row()
2206: # &end_pick_box()
2207: #
2208: # In general a &submit_row() call should proceed the call to &end_pick_box(),
2209: # as this routine adds a button for form submission.
2210: # &submit_row() does not require a &row_closure after it.
2211: #
2212: # &start_pick_box() creates a bounding table with 1-pixel wide black border.
2213: # rows should be placed between calls to &start_pick_box() and &end_pick_box.
2214: #
2215: # &row_title() adds a title in the left column for each segment.
2216: # &row_closure() closes a row with a 1-pixel wide black line.
2217: #
2218: # &role_select_row() provides a select box from which to choose 1 or more roles
2219: # &course_select_row provides ways of picking groups of courses
2220: # radio buttons: all, by category or by picking from a course picker pop-up
2221: # note: by category option is only displayed if a domain has implemented
2222: # selection by year, semester, department, number etc.
2223: #
2224: # &status_select_row() provides a select box from which to choose 1 or more
2225: # access types (current access, prior access, and future access)
2226: #
2227: # &email_default_row() provides text boxes for default e-mail suffixes for
2228: # different authentication types in a domain.
2229: #
2230: # &row_title() and &row_closure() are called internally by the &*_select_row
2231: # routines, but can also be called directly to start and end rows which have
2232: # needs that are not accommodated by the *_select_row() routines.
2233:
2234: { # Start: row_count block for pick_box
2235: my @row_count;
2236:
2237: sub start_pick_box {
2238: my ($css_class,$id) = @_;
2239: if (defined($css_class)) {
2240: $css_class = 'class="'.$css_class.'"';
2241: } else {
2242: $css_class= 'class="LC_pick_box"';
2243: }
2244: my $table_id;
2245: if (defined($id)) {
2246: $table_id = ' id="'.$id.'"';
2247: }
2248: unshift(@row_count,0);
2249: my $output = <<"END";
2250: <table $css_class $table_id>
2251: END
2252: return $output;
2253: }
2254:
2255: sub end_pick_box {
2256: shift(@row_count);
2257: my $output = <<"END";
2258: </table>
2259: END
2260: return $output;
2261: }
2262:
2263: sub row_headline {
2264: my $output = <<"END";
2265: <tr><td colspan="2">
2266: END
2267: return $output;
2268: }
2269:
2270: sub row_title {
2271: my ($title,$css_title_class,$css_value_class, $css_value_furtherAttributes) = @_;
2272: $row_count[0]++;
2273: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
2274: $css_title_class ||= 'LC_pick_box_title';
2275: $css_title_class = 'class="'.$css_title_class.'"';
2276:
2277: $css_value_class ||= 'LC_pick_box_value';
2278:
2279: if ($title ne '') {
2280: $title .= ':';
2281: }
2282: my $output = <<"ENDONE";
2283: <tr class="LC_pick_box_row" $css_value_furtherAttributes>
2284: <td $css_title_class>
2285: $title
2286: </td>
2287: <td class="$css_value_class $css_class">
2288: ENDONE
2289: return $output;
2290: }
2291:
2292: sub row_closure {
2293: my ($no_separator) =@_;
2294: my $output = <<"ENDTWO";
2295: </td>
2296: </tr>
2297: ENDTWO
2298: if (!$no_separator) {
2299: $output .= <<"ENDTWO";
2300: <tr>
2301: <td colspan="2" class="LC_pick_box_separator">
2302: </td>
2303: </tr>
2304: ENDTWO
2305: }
2306: return $output;
2307: }
2308:
2309: } # End: row_count block for pick_box
2310:
2311: sub role_select_row {
2312: my ($roles,$title,$css_class,$show_separate_custom,$cdom,$cnum) = @_;
2313: my $crstype = 'Course';
2314: if ($cdom ne '' && $cnum ne '') {
2315: $crstype = &Apache::loncommon::course_type($cdom.'_'.$cnum);
2316: }
2317: my $output;
2318: if (defined($title)) {
2319: $output = &row_title($title,$css_class);
2320: }
2321: $output .= qq|
2322: <select name="roles" multiple="multiple">\n|;
2323: foreach my $role (@$roles) {
2324: my $plrole;
2325: if ($role eq 'ow') {
2326: $plrole = &mt('Course Owner');
2327: } elsif ($role eq 'cr') {
2328: if ($show_separate_custom) {
2329: if ($cdom ne '' && $cnum ne '') {
2330: my %course_customroles = &course_custom_roles($cdom,$cnum);
2331: foreach my $crrole (sort(keys(%course_customroles))) {
2332: my ($plcrrole) = ($crrole =~ m|^cr/[^/]+/[^/]+/(.+)$|);
2333: $output .= ' <option value="'.$crrole.'">'.$plcrrole.
2334: '</option>';
2335: }
2336: }
2337: } else {
2338: $plrole = &mt('Custom Role');
2339: }
2340: } else {
2341: $plrole=&Apache::lonnet::plaintext($role,$crstype);
2342: }
2343: if (($role ne 'cr') || (!$show_separate_custom)) {
2344: $output .= ' <option value="'.$role.'">'.$plrole.'</option>';
2345: }
2346: }
2347: $output .= qq| </select>\n|;
2348: if (defined($title)) {
2349: $output .= &row_closure();
2350: }
2351: return $output;
2352: }
2353:
2354: sub course_select_row {
2355: my ($title,$formname,$totcodes,$codetitles,$idlist,$idlist_titles,
2356: $css_class,$crstype,$standardnames) = @_;
2357: my $output = &row_title($title,$css_class);
2358: $output .= &course_selection($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype,$standardnames);
2359: $output .= &row_closure();
2360: return $output;
2361: }
2362:
2363: sub course_selection {
2364: my ($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype,$standardnames) = @_;
2365: my $output = qq|
2366: <script type="text/javascript">
2367: // <![CDATA[
2368: function coursePick (formname) {
2369: for (var i=0; i<formname.coursepick.length; i++) {
2370: if (formname.coursepick[i].value == 'category') {
2371: courseSet('');
2372: }
2373: if (!formname.coursepick[i].checked) {
2374: if (formname.coursepick[i].value == 'specific') {
2375: formname.coursetotal.value = 0;
2376: formname.courselist = '';
2377: }
2378: }
2379: }
2380: }
2381: function setPick (formname) {
2382: for (var i=0; i<formname.coursepick.length; i++) {
2383: if (formname.coursepick[i].value == 'category') {
2384: formname.coursepick[i].checked = true;
2385: }
2386: formname.coursetotal.value = 0;
2387: formname.courselist = '';
2388: }
2389: }
2390: // ]]>
2391: </script>
2392: |;
2393:
2394: my ($allcrs,$pickspec);
2395: if ($crstype eq 'Community') {
2396: $allcrs = &mt('All communities');
2397: $pickspec = &mt('Pick specific communities:');
2398: } else {
2399: $allcrs = &mt('All courses');
2400: $pickspec = &mt('Pick specific course(s):');
2401: }
2402:
2403: my $courseform='<b>'.&Apache::loncommon::selectcourse_link
2404: ($formname,'pickcourse','pickdomain','coursedesc','',1,$crstype).'</b>';
2405: $output .= '<label><input type="radio" name="coursepick" value="all" onclick="coursePick(this.form)" />'.$allcrs.'</label><br />';
2406: if ($totcodes > 0) {
2407: my $numtitles = @$codetitles;
2408: if ($numtitles > 0) {
2409: $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 />';
2410: $output .= '<table><tr><td>'.$$codetitles[0].'<br />'."\n".
2411: '<select name="'.$standardnames->[0].
2412: '" onchange="setPick(this.form);courseSet('."'$$codetitles[0]'".')">'."\n".
2413: ' <option value="-1" />Select'."\n";
2414: my @items = ();
2415: my @longitems = ();
2416: if ($$idlist{$$codetitles[0]} =~ /","/) {
2417: @items = split(/","/,$$idlist{$$codetitles[0]});
2418: } else {
2419: $items[0] = $$idlist{$$codetitles[0]};
2420: }
2421: if (defined($$idlist_titles{$$codetitles[0]})) {
2422: if ($$idlist_titles{$$codetitles[0]} =~ /","/) {
2423: @longitems = split(/","/,$$idlist_titles{$$codetitles[0]});
2424: } else {
2425: $longitems[0] = $$idlist_titles{$$codetitles[0]};
2426: }
2427: for (my $i=0; $i<@longitems; $i++) {
2428: if ($longitems[$i] eq '') {
2429: $longitems[$i] = $items[$i];
2430: }
2431: }
2432: } else {
2433: @longitems = @items;
2434: }
2435: for (my $i=0; $i<@items; $i++) {
2436: $output .= ' <option value="'.$items[$i].'">'.$longitems[$i].'</option>';
2437: }
2438: $output .= '</select></td>';
2439: for (my $i=1; $i<$numtitles; $i++) {
2440: $output .= '<td>'.$$codetitles[$i].'<br />'."\n".
2441: '<select name="'.$standardnames->[$i].
2442: '" onchange="courseSet('."'$$codetitles[$i]'".')">'."\n".
2443: '<option value="-1"><-Pick '.$$codetitles[$i-1].'</option>'."\n".
2444: '</select>'."\n".
2445: '</td>';
2446: }
2447: $output .= '</tr></table><br />';
2448: }
2449: }
2450: $output .=
2451: '<label><input type="radio" name="coursepick" value="specific"'
2452: .' onclick="coursePick(this.form);opencrsbrowser('."'".$formname."','dccourse','dcdomain','coursedesc','','1','$crstype'".')" />'
2453: .$pickspec.'</label>'
2454: .' '.$courseform.' '
2455: .&mt('[_1] selected.',
2456: '<input type="text" value="0" size="4" name="coursetotal" readonly="readonly" />'
2457: .'<input type="hidden" name="courselist" value="" />')
2458: .'<br />'."\n";
2459: return $output;
2460: }
2461:
2462: sub status_select_row {
2463: my ($types,$title,$css_class) = @_;
2464: my $output;
2465: if (defined($title)) {
2466: $output = &row_title($title,$css_class,'LC_pick_box_select');
2467: }
2468: $output .= qq|
2469: <select name="types" multiple="multiple">\n|;
2470: foreach my $status_type (sort(keys(%{$types}))) {
2471: $output .= ' <option value="'.$status_type.'">'.$$types{$status_type}.'</option>';
2472: }
2473: $output .= qq| </select>\n|;
2474: if (defined($title)) {
2475: $output .= &row_closure();
2476: }
2477: return $output;
2478: }
2479:
2480: sub email_default_row {
2481: my ($authtypes,$title,$descrip,$css_class) = @_;
2482: my $output = &row_title($title,$css_class);
2483: $output .= $descrip.
2484: &Apache::loncommon::start_data_table().
2485: &Apache::loncommon::start_data_table_header_row().
2486: '<th>'.&mt('Authentication Method').'</th>'.
2487: '<th align="right">'.&mt('Username -> e-mail conversion').'</th>'."\n".
2488: &Apache::loncommon::end_data_table_header_row();
2489: my $rownum = 0;
2490: foreach my $auth (sort(keys(%{$authtypes}))) {
2491: my ($userentry,$size);
2492: if ($auth =~ /^krb/) {
2493: $userentry = '';
2494: $size = 25;
2495: } else {
2496: $userentry = 'username@';
2497: $size = 15;
2498: }
2499: $output .= &Apache::loncommon::start_data_table_row().
2500: '<td> '.$$authtypes{$auth}.'</td>'.
2501: '<td align="right">'.$userentry.
2502: '<input type="text" name="'.$auth.'" size="'.$size.'" /></td>'.
2503: &Apache::loncommon::end_data_table_row();
2504: }
2505: $output .= &Apache::loncommon::end_data_table();
2506: $output .= &row_closure();
2507: return $output;
2508: }
2509:
2510:
2511: sub submit_row {
2512: my ($title,$cmd,$submit_text,$css_class) = @_;
2513: my $output = &row_title($title,$css_class,'LC_pick_box_submit');
2514: $output .= qq|
2515: <br />
2516: <input type="hidden" name="command" value="$cmd" />
2517: <input type="submit" value="$submit_text"/>
2518: <br /><br />
2519: \n|;
2520: return $output;
2521: }
2522:
2523: sub course_custom_roles {
2524: my ($cdom,$cnum) = @_;
2525: my %returnhash=();
2526: my %coursepersonnel=&Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
2527: foreach my $person (sort(keys(%coursepersonnel))) {
2528: my ($role) = ($person =~ /^([^:]+):/);
2529: my ($end,$start) = split(/:/,$coursepersonnel{$person});
2530: if ($end == -1 && $start == -1) {
2531: next;
2532: }
2533: if ($role =~ m|^cr/[^/]+/[^/]+/[^/]|) {
2534: $returnhash{$role} ++;
2535: }
2536: }
2537: return %returnhash;
2538: }
2539:
2540:
2541: sub resource_info_box {
2542: my ($symb,$onlyfolderflag,$stuvcurrent,$stuvdisp,$divforres)=@_;
2543: my $return='';
2544: if (($stuvcurrent ne '') || ($divforres)) {
2545: $return = '<div class="LC_left_float">';
2546: }
2547: if ($symb) {
2548: $return.=&Apache::loncommon::start_data_table();
2549: my ($map,$id,$resource)=&Apache::lonnet::decode_symb($symb);
2550: my $folder=&Apache::lonnet::gettitle($map);
2551: $return.=&Apache::loncommon::start_data_table_row().
2552: '<th align="left">'.&mt('Folder:').'</th><td>'.$folder.'</td>'.
2553: &Apache::loncommon::end_data_table_row();
2554: unless ($onlyfolderflag) {
2555: $return.=&Apache::loncommon::start_data_table_row().
2556: '<th align="left">'.&mt('Resource:').'</th><td>'.&Apache::lonnet::gettitle($symb).'</td>'.
2557: &Apache::loncommon::end_data_table_row();
2558: }
2559: if ($stuvcurrent ne '') {
2560: $return .= &Apache::loncommon::start_data_table_row().
2561: '<th align="left">'.&mt("Student's current version:").'</th><td>'.$stuvcurrent.'</td>'.
2562: &Apache::loncommon::end_data_table_row();
2563: }
2564: if ($stuvdisp ne '') {
2565: $return .= &Apache::loncommon::start_data_table_row().
2566: '<th align="left">'.&mt("Student's version displayed:").'</th><td>'.$stuvdisp.'</td>'.
2567: &Apache::loncommon::end_data_table_row();
2568: }
2569: $return.=&Apache::loncommon::end_data_table();
2570: } else {
2571: $return='<p><span class="LC_error">'.&mt('No context provided.').'</span></p>';
2572: }
2573: if (($stuvcurrent ne '') || ($divforres)) {
2574: $return .= '</div>';
2575: }
2576: return $return;
2577: }
2578:
2579: # display_usage
2580: #
2581: # Generates a div containing a block, filled to show percentage of current quota used
2582: #
2583: # Quotas available for user portfolios, group portfolios, authoring spaces, and course
2584: # content stored directly within a course (i.e., excluding published content).
2585: #
2586:
2587: sub display_usage {
2588: my ($current_disk_usage,$disk_quota,$context) = @_;
2589: my $usage = $current_disk_usage/1024;
2590: my $quota = $disk_quota/1024;
2591: my $percent;
2592: if ($disk_quota == 0) {
2593: $percent = 100.0;
2594: } else {
2595: $percent = 100*($current_disk_usage/$disk_quota);
2596: }
2597: $usage = sprintf("%.2f",$usage);
2598: $quota = sprintf("%.2f",$quota);
2599: $percent = sprintf("%.0f",$percent);
2600: my ($color,$cssclass);
2601: if ($percent <= 60) {
2602: $color = '#00A000';
2603: } elsif ($percent > 60 && $percent < 90) {
2604: $color = '#FFD300';
2605: $cssclass = 'class="LC_warning"';
2606: } elsif( $percent >= 90) {
2607: $color = '#FF0000';
2608: $cssclass = 'class="LC_error"';
2609: }
2610: my $prog_width = $percent;
2611: if ($prog_width > 100) {
2612: $prog_width = 100;
2613: }
2614: my $display = 'block';
2615: if ($context eq 'authoring') {
2616: $display = 'inline';
2617: }
2618: return '
2619: <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".
2620: ' <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".
2621: ' <div id="meter3" style="display:block; background-color:'.$color.'; width:'.$prog_width.'%; height:10px; color:#000000; margin:0px;"></div>'."\n".
2622: ' </div>'."\n".
2623: ' </div>';
2624: }
2625:
2626: ##############################################
2627: ##############################################
2628:
2629: # topic_bar
2630: #
2631: # Generates a div containing an (optional) number with a white background followed by a
2632: # title with a background color defined in the corresponding CSS: LC_topic_bar
2633: # Inputs:
2634: # 1. number to display.
2635: # If input for number is empty only the title will be displayed.
2636: # 2. title text to display.
2637: # 3. optional id for the <div>
2638: # Outputs - a scalar containing html mark-up for the div.
2639:
2640: sub topic_bar {
2641: my ($num,$title,$id) = @_;
2642: my $number = '';
2643: if ($num ne '') {
2644: $number = '<span>'.$num.'</span>';
2645: }
2646: if ($id ne '') {
2647: $id = 'id="'.$id.'"';
2648: }
2649: return '<div class="LC_topic_bar" '.$id.'>'.$number.$title.'</div>';
2650: }
2651:
2652: ##############################################
2653: ##############################################
2654: # echo_form_input
2655: #
2656: # Generates html markup to add form elements from the referrer page
2657: # as hidden form elements (values encoded) in the new page.
2658: #
2659: # Intended to support two types of use
2660: # (a) to allow backing up to earlier pages in a multi-page
2661: # form submission process using a breadcrumb trail.
2662: #
2663: # (b) to allow the current page to be reloaded with form elements
2664: # set on previous page to remain unchanged. An example would
2665: # be where the a page containing a dynamically-built table of data is
2666: # is to be redisplayed, with only the sort order of the data changed.
2667: #
2668: # Inputs:
2669: # 1. Reference to array of form elements in the submitted form on
2670: # the referrer page which are to be excluded from the echoed elements.
2671: #
2672: # 2. Reference to array of regular expressions, which if matched in the
2673: # name of the form element n the referrer page will be omitted from echo.
2674: #
2675: # Outputs: A scalar containing the html markup for the echoed form
2676: # elements (all as hidden elements, with values encoded).
2677:
2678:
2679: sub echo_form_input {
2680: my ($excluded,$regexps) = @_;
2681: my $output = '';
2682: foreach my $key (keys(%env)) {
2683: if ($key =~ /^form\.(.+)$/) {
2684: my $name = $1;
2685: my $match = 0;
2686: if (ref($excluded) eq 'ARRAY') {
2687: next if (grep(/^\Q$name\E$/,@{$excluded}));
2688: }
2689: if (ref($regexps) eq 'ARRAY') {
2690: if (@{$regexps} > 0) {
2691: foreach my $regexp (@{$regexps}) {
2692: if ($name =~ /$regexp/) {
2693: $match = 1;
2694: last;
2695: }
2696: }
2697: }
2698: }
2699: next if ($match);
2700: if (ref($env{$key}) eq 'ARRAY') {
2701: foreach my $value (@{$env{$key}}) {
2702: $value = &HTML::Entities::encode($value,'<>&"');
2703: $output .= '<input type="hidden" name="'.$name.
2704: '" value="'.$value.'" />'."\n";
2705: }
2706: } else {
2707: my $value = &HTML::Entities::encode($env{$key},'<>&"');
2708: $output .= '<input type="hidden" name="'.$name.
2709: '" value="'.$value.'" />'."\n";
2710: }
2711: }
2712: }
2713: return $output;
2714: }
2715:
2716: ##############################################
2717: ##############################################
2718: # set_form_elements
2719: #
2720: # Generates javascript to set form elements to values based on
2721: # corresponding values for the same form elements when the page was
2722: # previously submitted.
2723: #
2724: # Last submission values are read from hidden form elements in referring
2725: # page which have the same name, i.e., generated by &echo_form_input().
2726: #
2727: # Intended to be called by onload event.
2728: #
2729: # Inputs:
2730: # (a) Reference to hash of echoed form elements to be set.
2731: #
2732: # In the hash, keys are the form element names, and the values are the
2733: # element type (selectbox, radio, checkbox or text -for textbox, textarea or
2734: # hidden).
2735: #
2736: # (b) Optional reference to hash of stored elements to be set.
2737: #
2738: # If the page being displayed is a page which permits modification of
2739: # previously stored data, e.g., the first page in a multi-page submission,
2740: # then if stored is supplied, form elements will be set to the last stored
2741: # values. If user supplied values are also available for the same elements
2742: # these will replace the stored values.
2743: #
2744: # Output:
2745: #
2746: # javascript function - set_form_elements() which sets form elements,
2747: # expects an argument: formname - the name of the form according to
2748: # the DOM, e.g., document.compose
2749:
2750: sub set_form_elements {
2751: my ($elements,$stored) = @_;
2752: my %values;
2753: my $output .= 'function setFormElements(courseForm) {
2754: ';
2755: if (defined($stored)) {
2756: foreach my $name (keys(%{$stored})) {
2757: if (exists($$elements{$name})) {
2758: if (ref($$stored{$name}) eq 'ARRAY') {
2759: $values{$name} = $$stored{$name};
2760: } else {
2761: @{$values{$name}} = ($$stored{$name});
2762: }
2763: }
2764: }
2765: }
2766:
2767: foreach my $key (keys(%env)) {
2768: if ($key =~ /^form\.(.+)$/) {
2769: my $name = $1;
2770: if (exists($$elements{$name})) {
2771: @{$values{$name}} = &Apache::loncommon::get_env_multiple($key);
2772: }
2773: }
2774: }
2775:
2776: foreach my $name (keys(%values)) {
2777: for (my $i=0; $i<@{$values{$name}}; $i++) {
2778: $values{$name}[$i] = &HTML::Entities::decode($values{$name}[$i],'<>&"');
2779: $values{$name}[$i] =~ s/([\r\n\f]+)/\\n/g;
2780: $values{$name}[$i] =~ s/"/\\"/g;
2781: }
2782: if (($$elements{$name} eq 'text') || ($$elements{$name} eq 'hidden')) {
2783: my $numvalues = @{$values{$name}};
2784: if ($numvalues > 1) {
2785: my $valuestring = join('","',@{$values{$name}});
2786: $output .= qq|
2787: var textvalues = new Array ("$valuestring");
2788: var total = courseForm.elements['$name'].length;
2789: if (total > $numvalues) {
2790: total = $numvalues;
2791: }
2792: for (var i=0; i<total; i++) {
2793: courseForm.elements['$name']\[i].value = textvalues[i];
2794: }
2795: |;
2796: } else {
2797: $output .= qq|
2798: courseForm.elements['$name'].value = "$values{$name}[0]";
2799: |;
2800: }
2801: } else {
2802: $output .= qq|
2803: var elementLength = courseForm.elements['$name'].length;
2804: if (elementLength==undefined) {
2805: |;
2806: foreach my $value (@{$values{$name}}) {
2807: if ($$elements{$name} eq 'selectbox') {
2808: $output .= qq|
2809: if (courseForm.elements['$name'].options[0].value == "$value") {
2810: courseForm.elements['$name'].options[0].selected = true;
2811: }|;
2812: } elsif (($$elements{$name} eq 'radio') ||
2813: ($$elements{$name} eq 'checkbox')) {
2814: $output .= qq|
2815: if (courseForm.elements['$name'].value == "$value") {
2816: courseForm.elements['$name'].checked = true;
2817: } else {
2818: courseForm.elements['$name'].checked = false;
2819: }|;
2820: }
2821: }
2822: $output .= qq|
2823: }
2824: else {
2825: for (var i=0; i<courseForm.elements['$name'].length; i++) {
2826: |;
2827: if ($$elements{$name} eq 'selectbox') {
2828: $output .= qq|
2829: courseForm.elements['$name'].options[i].selected = false;|;
2830: } elsif (($$elements{$name} eq 'radio') ||
2831: ($$elements{$name} eq 'checkbox')) {
2832: $output .= qq|
2833: courseForm.elements['$name']\[i].checked = false;|;
2834: }
2835: $output .= qq|
2836: }
2837: for (var j=0; j<courseForm.elements['$name'].length; j++) {
2838: |;
2839: foreach my $value (@{$values{$name}}) {
2840: if ($$elements{$name} eq 'selectbox') {
2841: $output .= qq|
2842: if (courseForm.elements['$name'].options[j].value == "$value") {
2843: courseForm.elements['$name'].options[j].selected = true;
2844: }|;
2845: } elsif (($$elements{$name} eq 'radio') ||
2846: ($$elements{$name} eq 'checkbox')) {
2847: $output .= qq|
2848: if (courseForm.elements['$name']\[j].value == "$value") {
2849: courseForm.elements['$name']\[j].checked = true;
2850: }|;
2851: }
2852: }
2853: $output .= qq|
2854: }
2855: }
2856: |;
2857: }
2858: }
2859: $output .= "
2860: return;
2861: }\n";
2862: return $output;
2863: }
2864:
2865: ##############################################
2866: ##############################################
2867:
2868: sub file_submissionchk_js {
2869: my ($turninpaths,$multiples) = @_;
2870: my $overwritewarn = &mt('File(s) you uploaded for your submission will overwrite existing file(s) submitted for this item')."\n".
2871: &mt('Continue submission and overwrite the file(s)?');
2872: &js_escape(\$overwritewarn);
2873: my $delfilewarn = &mt('You have indicated you wish to remove some files previously included in your submission.')."\n".
2874: &mt('Continue submission with these files removed?');
2875: &js_escape(\$delfilewarn);
2876: my ($turninpathtext,$multtext,$arrayindexofjs);
2877: if (ref($turninpaths) eq 'HASH') {
2878: foreach my $key (sort(keys(%{$turninpaths}))) {
2879: $turninpathtext .= " if (prefix == '$key') {\n".
2880: " return '$turninpaths->{$key}';\n".
2881: " }\n";
2882: }
2883: }
2884: $turninpathtext .= " return '';\n";
2885: if (ref($multiples) eq 'HASH') {
2886: foreach my $key (sort(keys(%{$multiples}))) {
2887: $multtext .= " if (prefix == '$key') {\n".
2888: " return '$multiples->{$key}';\n".
2889: " }\n";
2890: }
2891: }
2892: $multtext .= " return '';\n";
2893:
2894: $arrayindexofjs = &Apache::loncommon::javascript_array_indexof();
2895: return <<"ENDSCRIPT";
2896: <script type="text/javascript">
2897: // <![CDATA[
2898:
2899: function file_submission_check(formname,path,multiresp) {
2900: var elemnum = formname.elements.length;
2901: if (elemnum == 0) {
2902: return true;
2903: }
2904: var alloverwrites = [];
2905: var alldelconfirm = [];
2906: var result = [];
2907: var submitter;
2908: var subprefix;
2909: var allsub = getIndexByName(formname,'all_submit');
2910: if (allsub == -1) {
2911: var idx = getIndexByName(formname,'submitted');
2912: if (idx != -1) {
2913: var subval = String(formname.elements[idx].value);
2914: submitter = subval.replace(/^part_/,'');
2915: result = overwritten_check(formname,path,multiresp,submitter);
2916: alloverwrites.push.apply(alloverwrites,result['overwrite']);
2917: alldelconfirm.push.apply(alldelconfirm,result['delete']);
2918: }
2919: } else {
2920: if (formname.elements[allsub].type == 'submit') {
2921: var partsub = /^\\d+\\.\\d+_submit_.+\$/;
2922: var allprefixes = [];
2923: var allparts = [];
2924: for (var i=0; i<formname.elements.length; i++) {
2925: if (formname.elements[i].type == 'submit') {
2926: var elemname = formname.elements[i].name;
2927: var subname = String(elemname);
2928: var savesub = String(elemname);
2929: if (partsub.test(subname)) {
2930: var prefix = subname.replace(/_submit_.+\$/,'');
2931: if (allprefixes.indexOf(prefix) == -1) {
2932: allprefixes.push(prefix);
2933: allparts[prefix] = [];
2934: }
2935: var part = savesub.replace(/^\\d+\\.\\d+_submit_/,'');
2936: allparts[prefix].push(part);
2937: }
2938: }
2939: }
2940: for (var k=0; k<allprefixes.length; k++) {
2941: var idx = getIndexByName(formname,allprefixes[k]+'_submitted');
2942: if (idx > -1) {
2943: if (formname.elements[idx].value != 'yes') {
2944: submitterval = formname.elements[idx].value;
2945: submitter = submitterval.replace(/^part_/,'');
2946: subprefix = allprefixes[k];
2947: result = overwritten_check(formname,path,multiresp,submitter,subprefix);
2948: alloverwrites.push.apply(alloverwrites,result['overwrite']);
2949: alldelconfirm.push.apply(alldelconfirm,result['delete']);
2950: break;
2951: }
2952: }
2953: }
2954: if (submitter == '' || submitter == undefined) {
2955: for (var m=0; m<allprefixes.length; m++) {
2956: for (var n=0; n<allparts[allprefixes[m]].length; n++) {
2957: var result = overwritten_check(formname,path,multiresp,allparts[allprefixes[m]][n],allprefixes[m]);
2958: alloverwrites.push.apply(alloverwrites,result['overwrite']);
2959: alldelconfirm.push.apply(alldelconfirm,result['delete']);
2960: }
2961: }
2962: }
2963: }
2964: }
2965: if (alloverwrites.length > 0) {
2966: if (!confirm("$overwritewarn")) {
2967: for (var n=0; n<alloverwrites.length; n++) {
2968: formname.elements[alloverwrites[n]].value = "";
2969: }
2970: return false;
2971: }
2972: }
2973: if (alldelconfirm.length > 0) {
2974: if (!confirm("$delfilewarn")) {
2975: for (var p=0; p<alldelconfirm.length; p++) {
2976: formname.elements[alldelconfirm[p]].checked = false;
2977: }
2978: return false;
2979: }
2980: }
2981: return true;
2982: }
2983:
2984: function getIndexByName(formname,item) {
2985: for (var i=0;i<formname.elements.length;i++) {
2986: if (formname.elements[i].name == item) {
2987: return i;
2988: }
2989: }
2990: return -1;
2991: }
2992:
2993: function overwritten_check(formname,path,multiresp,part,prefix) {
2994: var result = [];
2995: result['overwrite'] = [];
2996: result['delete'] = [];
2997: var elemnum = formname.elements.length;
2998: if (elemnum == 0) {
2999: return result;
3000: }
3001: var uploadstr;
3002: var deletestr;
3003: if ((prefix != undefined) && (prefix != '')) {
3004: var prepend = prefix+'_';
3005: uploadstr = new RegExp("^"+prepend+"HWFILE"+part+".+\$");
3006: deletestr = new RegExp("^"+prepend+"HWFILE"+part+".+_\\\\d+_delete\$");
3007: multiresp = check_for_multiples(prepend);
3008: path = check_for_turninpath(prepend);
3009: } else {
3010: uploadstr = new RegExp("^HWFILE"+part+".+\$");
3011: deletestr = new RegExp("^HWFILE"+part+".+_\\\\d+_delete\$");
3012: }
3013: var alluploads = [];
3014: var allchecked = [];
3015: var allskipdel = [];
3016: var fnametrim = /[^\\/\\\\]+\$/;
3017: for (var i=0; i<formname.elements.length; i++) {
3018: var id = formname.elements[i].id;
3019: if (id != '') {
3020: if (uploadstr.test(id)) {
3021: if (formname.elements[i].type == 'file') {
3022: alluploads.push(id);
3023: } else {
3024: if (deletestr.test(id)) {
3025: if (formname.elements[i].type == 'checkbox') {
3026: if (formname.elements[i].checked) {
3027: allchecked.push(id);
3028: }
3029: }
3030: }
3031: }
3032: }
3033: }
3034: }
3035: for (var j=0; j<alluploads.length; j++) {
3036: var delstr = new RegExp("^"+alluploads[j]+"_\\\\d+_delete\$");
3037: var delboxes = [];
3038: for (var k=0; k<formname.elements.length; k++) {
3039: var id = formname.elements[k].id;
3040: if ((id != '') && (id != undefined)) {
3041: if (delstr.test(id)) {
3042: if (formname.elements[k].type == 'checkbox') {
3043: delboxes.push(id);
3044: }
3045: }
3046: }
3047: }
3048: if (delboxes.length > 0) {
3049: if ((formname.elements[alluploads[j]].value != undefined) &&
3050: (formname.elements[alluploads[j]].value != '')) {
3051: var filepath = formname.elements[alluploads[j]].value;
3052: var newfilename = fnametrim.exec(filepath);
3053: if (newfilename != null) {
3054: var filename = String(newfilename);
3055: var nospaces = filename.replace(/\\s+/g,'_');
3056: var nospecials = nospaces.replace(/[^\\/\\w\\.\\-]/g,'');
3057: var cleanfilename = nospecials.replace(/\\.(\\d+\\.)/g,"_\$1");
3058: if (cleanfilename != '') {
3059: var fullpath = path+"/"+cleanfilename;
3060: if (multiresp == 1) {
3061: var partid = String(alluploads[i]);
3062: var subdir = partid.replace(/^\\d*.?\\d*_?HWFILE/,'');
3063: if (subdir != "" && subdir != undefined) {
3064: fullpath = path+"/"+subdir+"/"+cleanfilename;
3065: }
3066: }
3067: for (var m=0; m<delboxes.length; m++) {
3068: if (fullpath == formname.elements[delboxes[m]].value) {
3069: if (formname.elements[delboxes[m]].checked) {
3070: allskipdel.push(delboxes[m]);
3071: } else {
3072: result['overwrite'].push(alluploads[j]);
3073: }
3074: break;
3075: }
3076: }
3077: }
3078: }
3079: }
3080: }
3081: }
3082: if (allchecked.length > 0) {
3083: if (allskipdel.length > 0) {
3084: for (var n=0; n<allchecked.length; n++) {
3085: if (allskipdel.indexOf(allchecked[n]) == -1) {
3086: result['delete'].push(allchecked[n]);
3087: }
3088: }
3089: } else {
3090: result['delete'].push.apply(result['delete'],allchecked);
3091: }
3092: }
3093: return result;
3094: }
3095:
3096: function check_for_multiples(prefix) {
3097: $multtext
3098: }
3099:
3100: function check_for_turninpath(prefix) {
3101: $turninpathtext
3102: }
3103:
3104: // ]]>
3105: </script>
3106:
3107: $arrayindexofjs
3108:
3109: ENDSCRIPT
3110: }
3111:
3112: ##############################################
3113: ##############################################
3114:
3115: sub resize_scrollbox_js {
3116: my ($context,$tabidstr,$tid) = @_;
3117: my (%names,$paddingwfrac,$offsetwfrac,$offsetv,$minw,$minv);
3118: if ($context eq 'docs') {
3119: %names = (
3120: boxw => 'contenteditor',
3121: item => 'contentlist',
3122: header => 'uploadfileresult',
3123: scroll => 'contentscroll',
3124: boxh => 'contenteditor',
3125: );
3126: $paddingwfrac = 0.09;
3127: $offsetwfrac = 0.015;
3128: $offsetv = 20;
3129: $minw = 250;
3130: $minv = 200;
3131: } elsif ($context eq 'params') {
3132: %names = (
3133: boxw => 'parameditor',
3134: item => 'mapmenuinner',
3135: header => 'parmstep1',
3136: scroll => 'mapmenuscroll',
3137: boxh => 'parmlevel',
3138: );
3139: $paddingwfrac = 0.2;
3140: $offsetwfrac = 0.015;
3141: $offsetv = 80;
3142: $minw = 100;
3143: $minv = 100;
3144: }
3145: my $viewport_js = &Apache::loncommon::viewport_geometry_js();
3146: my $output = '
3147:
3148: window.onresize=callResize;
3149:
3150: ';
3151: if ($context eq 'docs') {
3152: if ($env{'form.active'}) {
3153: $output .= "\nvar activeTab = '$env{'form.active'}$tid';\n";
3154: } else {
3155: $output .= "\nvar activeTab = '';\n";
3156: }
3157: }
3158: $output .= <<"FIRST";
3159:
3160: $viewport_js
3161:
3162: function resize_scrollbox(scrollboxname,chkw,chkh) {
3163: var scrollboxid = 'div_'+scrollboxname;
3164: var scrolltableid = 'table_'+scrollboxname;
3165: var scrollbox;
3166: var scrolltable;
3167: var ismobile = '$env{'browser.mobile'}';
3168:
3169: if (document.getElementById("$names{'boxw'}") == null) {
3170: return;
3171: }
3172:
3173: if (document.getElementById(scrollboxid) == null) {
3174: return;
3175: } else {
3176: scrollbox = document.getElementById(scrollboxid);
3177: }
3178:
3179:
3180: if (document.getElementById(scrolltableid) == null) {
3181: return;
3182: } else {
3183: scrolltable = document.getElementById(scrolltableid);
3184: }
3185:
3186: init_geometry();
3187: var vph = Geometry.getViewportHeight();
3188: var vpw = Geometry.getViewportWidth();
3189:
3190: FIRST
3191: if ($context eq 'docs') {
3192: $output .= "
3193: var alltabs = ['$tabidstr'];
3194: ";
3195: } elsif ($context eq 'params') {
3196: $output .= "
3197: if (document.getElementById('$names{'boxh'}') == null) {
3198: return;
3199: }
3200: ";
3201: }
3202: $output .= <<"SECOND";
3203: var listwchange;
3204: var scrollchange;
3205: if (chkw == 1) {
3206: var boxw = document.getElementById("$names{'boxw'}").offsetWidth;
3207: var itemw;
3208: var itemid = document.getElementById("$names{'item'}");
3209: if (itemid != null) {
3210: itemw = itemid.offsetWidth;
3211: }
3212: var itemwstart = itemw;
3213:
3214: var scrollboxw = scrollbox.offsetWidth;
3215: var scrollboxscrollw = scrollbox.scrollWidth;
3216: var scrollstart = scrollboxw;
3217:
3218: var offsetw = parseInt(vpw * $offsetwfrac);
3219: var paddingw = parseInt(vpw * $paddingwfrac);
3220:
3221: var minscrollboxw = $minw;
3222: var maxcolw = 0;
3223: SECOND
3224: if ($context eq 'docs') {
3225: $output .= <<"DOCSONE";
3226: var actabw = 0;
3227: for (var i=0; i<alltabs.length; i++) {
3228: if (activeTab == alltabs[i]) {
3229: actabw = document.getElementById(alltabs[i]).offsetWidth;
3230: if (actabw > maxcolw) {
3231: maxcolw = actabw;
3232: }
3233: } else {
3234: if (document.getElementById(alltabs[i]) != null) {
3235: var thistab = document.getElementById(alltabs[i]);
3236: thistab.style.visibility = 'hidden';
3237: thistab.style.display = 'block';
3238: var tabw = document.getElementById(alltabs[i]).offsetWidth;
3239: thistab.style.display = 'none';
3240: thistab.style.visibility = '';
3241: if (tabw > maxcolw) {
3242: maxcolw = tabw;
3243: }
3244: }
3245: }
3246: }
3247: DOCSONE
3248: } elsif ($context eq 'params') {
3249: $output .= <<"PARAMSONE";
3250: var parmlevelrows = new Array();
3251: var mapmenucells = new Array();
3252: parmlevelrows = document.getElementById("$names{'boxh'}").rows;
3253: var numrows = parmlevelrows.length;
3254: if (numrows > 1) {
3255: mapmenucells = parmlevelrows[2].getElementsByTagName('td');
3256: }
3257: maxcolw = mapmenucells[0].offsetWidth;
3258: PARAMSONE
3259: }
3260: $output .= <<"THIRD";
3261: if (maxcolw > 0) {
3262: var newscrollboxw;
3263: if (maxcolw+paddingw+scrollboxscrollw<boxw) {
3264: newscrollboxw = boxw-paddingw-maxcolw;
3265: if (newscrollboxw < minscrollboxw) {
3266: newscrollboxw = minscrollboxw;
3267: }
3268: scrollbox.style.width = newscrollboxw+"px";
3269: if (newscrollboxw != scrollboxw) {
3270: var newitemw = newscrollboxw-offsetw;
3271: itemid.style.width = newitemw+"px";
3272: }
3273: } else {
3274: newscrollboxw = boxw-paddingw-maxcolw;
3275: if (newscrollboxw < minscrollboxw) {
3276: newscrollboxw = minscrollboxw;
3277: }
3278: scrollbox.style.width = newscrollboxw+"px";
3279: if (newscrollboxw != scrollboxw) {
3280: var newitemw = newscrollboxw-offsetw;
3281: itemid.style.width = newitemw+"px";
3282: }
3283: }
3284:
3285: if (newscrollboxw != scrollboxw) {
3286: var newscrolltablew = newscrollboxw+offsetw;
3287: scrolltable.style.width = newscrolltablew+"px";
3288: }
3289: }
3290:
3291: if (newscrollboxw != scrollboxw) {
3292: scrollchange = 1;
3293: }
3294:
3295: if (itemid.offsetWidth != itemwstart) {
3296: listwchange = 1;
3297: }
3298: }
3299: if ((chkh == 1) || (listwchange)) {
3300: var itemid = document.getElementById("$names{'item'}");
3301: if (itemid != null) {
3302: itemh = itemid.offsetHeight;
3303: }
3304: var primaryheight = document.getElementById('LC_nav_bar').offsetHeight;
3305: var secondaryheight;
3306: if (document.getElementById('LC_secondary_menu') != null) {
3307: secondaryheight = document.getElementById('LC_secondary_menu').offsetHeight;
3308: }
3309: var crumbsheight = document.getElementById('LC_breadcrumbs').offsetHeight;
3310: var dccidheight = 0;
3311: if (document.getElementById('dccid') != null) {
3312: dccidheight = document.getElementById('dccid').offsetHeight;
3313: }
3314: var headerheight = 0;
3315: if (document.getElementById("$names{'header'}") != null) {
3316: headerheight = document.getElementById("$names{'header'}").offsetHeight;
3317: }
3318: var tabbedheight = document.getElementById("tabbededitor").offsetHeight;
3319: var boxheight = document.getElementById("$names{'boxh'}").offsetHeight;
3320: var freevspace = vph-(primaryheight+secondaryheight+crumbsheight+dccidheight+headerheight+tabbedheight+boxheight);
3321:
3322: var scrollboxheight = scrollbox.offsetHeight;
3323: var scrollboxscrollheight = scrollbox.scrollHeight;
3324: var scrollboxh = scrollboxheight;
3325:
3326: var minvscrollbox = $minv;
3327: var offsetv = $offsetv;
3328: var newscrollboxheight;
3329: if (freevspace < 0) {
3330: newscrollboxheight = scrollboxheight+freevspace-offsetv;
3331: if (newscrollboxheight < minvscrollbox) {
3332: newscrollboxheight = minvscrollbox;
3333: }
3334: scrollbox.style.height = newscrollboxheight + "px";
3335: } else {
3336: if (scrollboxscrollheight > scrollboxheight) {
3337: if (freevspace > offsetv) {
3338: newscrollboxheight = scrollboxheight+freevspace-offsetv;
3339: if (newscrollboxheight < minvscrollbox) {
3340: newscrollboxheight = minvscrollbox;
3341: }
3342: scrollbox.style.height = newscrollboxheight+"px";
3343: }
3344: }
3345: }
3346: scrollboxheight = scrollbox.offsetHeight;
3347: var itemh = document.getElementById("$names{'item'}").offsetHeight;
3348:
3349: if (scrollboxscrollheight <= scrollboxheight) {
3350: if ((itemh+offsetv)<scrollboxheight) {
3351: newscrollheight = itemh+offsetv;
3352: scrollbox.style.height = newscrollheight+"px";
3353: }
3354: }
3355: var newscrollboxh = scrollbox.offsetHeight;
3356: if (scrollboxh != newscrollboxh) {
3357: scrollchange = 1;
3358: }
3359: }
3360: if (ismobile && scrollchange) {
3361: \$("#div_$names{'scroll'}").getNiceScroll().onResize();
3362: }
3363: return;
3364: }
3365:
3366: function callResize() {
3367: var timer;
3368: clearTimeout(timer);
3369: timer=setTimeout('resize_scrollbox("$names{'scroll'}","1","1")',500);
3370: }
3371:
3372: THIRD
3373: return $output;
3374: }
3375:
3376: ##############################################
3377: ##############################################
3378:
3379: sub javascript_jumpto_resource {
3380: my $confirm_switch = &mt("Editing requires switching to the resource's home server.")."\n".
3381: &mt('Switch server?');
3382: &js_escape(\$confirm_switch);
3383: return (<<ENDUTILITY)
3384:
3385: function go(url) {
3386: if (url!='' && url!= null) {
3387: currentURL = null;
3388: currentSymb= null;
3389: var lcHostname = setLCHost();
3390: if (lcHostname!='' && lcHostname!= null) {
3391: var RegExp = /^https?\:/;
3392: if (RegExp.test(url)) {
3393: window.location.href=url;
3394: } else {
3395: window.location.href=lcHostname+url;
3396: }
3397: } else {
3398: window.location.href=url;
3399: }
3400: }
3401: }
3402:
3403: function need_switchserver(url) {
3404: if (url!='' && url!= null) {
3405: if (confirm("$confirm_switch")) {
3406: go(url);
3407: }
3408: }
3409: return;
3410: }
3411:
3412: ENDUTILITY
3413:
3414: }
3415:
3416: sub jump_to_editres {
3417: my ($cfile,$home,$switchserver,$forceedit,$forcereg,$symb,$folderpath,
3418: $title,$hostname,$idx,$suppurl,$todocs,$suppanchor) = @_;
3419: my ($jscall,$anchor,$usehttp,$usehttps,$is_ext);
3420: if ($switchserver) {
3421: if ($home) {
3422: $cfile = '/adm/switchserver?otherserver='.$home.'&role='.
3423: &HTML::Entities::encode($env{'request.role'},'"<>&');
3424: if ($symb) {
3425: $cfile .= '&symb='.&HTML::Entities::encode($symb,'"<>&');
3426: } elsif ($folderpath) {
3427: $cfile .= '&folderpath='.&HTML::Entities::encode($folderpath,'"<>&');
3428: }
3429: if ($forceedit) {
3430: $cfile .= '&forceedit=1';
3431: }
3432: if ($forcereg) {
3433: $cfile .= '&register=1';
3434: }
3435: $jscall = "need_switchserver('".&Apache::loncommon::escape_single($cfile)."');";
3436: }
3437: } else {
3438: unless ($cfile =~ m{^/priv/}) {
3439: if ($cfile =~ m{^(/adm/wrapper/ext/([^#]+))(?:|#([^#]+))$}) {
3440: $cfile = $1;
3441: my $extlink = $2;
3442: $anchor = $3;
3443: $is_ext = 1;
3444: if (($extlink !~ /^https:/) && ($ENV{'SERVER_PORT'} == 443)) {
3445: unless (&Apache::lonnet::uses_sts()) {
3446: $usehttp = 1;
3447: }
3448: } elsif ($env{'request.use_absolute'}) {
3449: if ($env{'request.use_absolute'} =~ m{^https://}) {
3450: $usehttps = 1;
3451: }
3452: }
3453: } elsif ($cfile =~ m{^/?public/($match_domain)/($match_courseid)/syllabus}) {
3454: if ($ENV{'SERVER_PORT'} == 443) {
3455: my ($cdom,$cnum) = ($1,$2);
3456: if (($env{'request.course.id'}) &&
3457: ($env{'course.'.$env{'request.course.id'}.'.num'} eq $cnum) &&
3458: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $cdom)) {
3459: if ($env{'course.'.$env{'request.course.id'}.'.externalsyllabus'} =~ m{^http://}) {
3460: unless (&Apache::lonnet::uses_sts()) {
3461: $usehttp = 1;
3462: }
3463: }
3464: }
3465: } elsif ($env{'request.use_absolute'}) {
3466: if ($env{'request.use_absolute'} =~ m{^https://}) {
3467: $usehttps = 1;
3468: }
3469: }
3470: }
3471: if ($symb) {
3472: if ($anchor ne '') {
3473: if ($symb =~ m{^([^#]+)\Q#$anchor\E$}) {
3474: $symb = $1.&escape(&escape('#')).$anchor;
3475: }
3476: }
3477: $cfile .= (($cfile=~/\?/)?'&':'?')."symb=$symb";
3478: } elsif ($folderpath) {
3479: $cfile .= (($cfile=~/\?/)?'&':'?').
3480: 'folderpath='.&HTML::Entities::encode(&escape($folderpath),'"<>&');
3481: if ($title) {
3482: $cfile .= (($cfile=~/\?/)?'&':'?').
3483: 'title='.&HTML::Entities::encode(&escape($title),'"<>&');
3484: }
3485: if ($idx) {
3486: $cfile .= (($cfile=~/\?/)?'&':'?').'idx='.$idx;
3487: }
3488: if ($suppurl) {
3489: $cfile .= (($cfile=~/\?/)?'&':'?').
3490: 'suppurl='.&HTML::Entities::encode(&escape($suppurl));
3491: }
3492: }
3493: if ($forceedit) {
3494: $cfile .= (($cfile=~/\?/)?'&':'?').'forceedit=1';
3495: if ($usehttps) {
3496: $cfile = $env{'request.use_absolute'}.(($cfile =~ /^\//)? '':'/').$cfile;
3497: }
3498: } elsif ($usehttp) {
3499: if ($hostname ne '') {
3500: $cfile = 'http://'.$hostname.(($cfile =~ /^\//)? '':'/').$cfile;
3501: }
3502: $cfile .= (($cfile=~/\?/)?'&':'?').'usehttp=1';
3503: } elsif ($usehttps) {
3504: $cfile = $env{'request.use_absolute'}.(($cfile =~ /^\//)? '':'/').$cfile;
3505: }
3506: if ($forcereg) {
3507: $cfile .= (($cfile=~/\?/)?'&':'?').'register=1';
3508: }
3509: if ($todocs) {
3510: $cfile .= (($cfile=~/\?/)?'&':'?').'todocs=1';
3511: }
3512: if ($suppanchor ne '') {
3513: $cfile .= (($cfile=~/\?/)?'&':'?').'anchor='.
3514: &HTML::Entities::encode($suppanchor,'"<>&');
3515: }
3516: }
3517: if ($anchor ne '') {
3518: $cfile .= '#'.$anchor;
3519: }
3520: $jscall = "go('".&Apache::loncommon::escape_single($cfile)."')";
3521: }
3522: return $jscall;
3523: }
3524:
3525: ##############################################
3526: ##############################################
3527:
3528: # javascript_valid_email
3529: #
3530: # Generates javascript to validate an e-mail address.
3531: # Returns a javascript function which accepts a form field as argument, and
3532: # returns false if field.value does not satisfy two regular expression matches
3533: # for a valid e-mail address. Backwards compatible with old browsers without
3534: # support for javascript RegExp (just checks for @ in field.value in this case).
3535:
3536: sub javascript_valid_email {
3537: my $scripttag .= <<'END';
3538: function validmail(field,suffix) {
3539: var str = field.value;
3540: if (suffix != '' && suffix != undefined) {
3541: str += suffix;
3542: }
3543: if (window.RegExp) {
3544: var reg1str = "(@.*@)|(\\.\\.)|(@\\.)|(\\.@)|(^\\.)";
3545: var reg2str = "^.+\\@(\\[?)[a-zA-Z0-9\\-\\.]+\\.([a-zA-Z]{2,3}|[0-9]{1,3})(\\]?)$"; //"
3546: var reg1 = new RegExp(reg1str);
3547: var reg2 = new RegExp(reg2str);
3548: if (!reg1.test(str) && reg2.test(str)) {
3549: return true;
3550: }
3551: return false;
3552: }
3553: else
3554: {
3555: if(str.indexOf("@") >= 0) {
3556: return true;
3557: }
3558: return false;
3559: }
3560: }
3561: END
3562: return $scripttag;
3563: }
3564:
3565:
3566: # USAGE: htmltag(element, content, {attribute => value,...});
3567: #
3568: # EXAMPLES:
3569: # - htmltag('a', 'this is an anchor', {href => 'www.example.com',
3570: # title => 'this is a title'})
3571: #
3572: # - You might want to set up needed tags like:
3573: #
3574: # my $h3 = sub { return htmltag( "h3", @_ ) };
3575: #
3576: # ... and use them: $h3->("This is a headline")
3577: #
3578: # - To set up a couple of tags, see sub inittags
3579: #
3580: # NOTES:
3581: # - Empty elements, such as <br/> are correctly terminated,
3582: # i.e. htmltag('br') returns <br/>
3583: # - Empty attributes (title="") are filtered out.
3584: # - The function will not check for deprecated attributes.
3585: #
3586: # OUTPUT: content enclosed in xhtml conform tags
3587: sub htmltag{
3588: return
3589: qq|<$_[0]|
3590: . join( '', map { qq| $_="${$_[2]}{$_}"| if ${$_[2]}{$_} } keys(%{ $_[2] }) )
3591: . ($_[1] ? qq|>$_[1]</$_[0]>| : qq|/>|). "\n";
3592: };
3593:
3594:
3595: # USAGE: inittags(@tags);
3596: #
3597: # EXAMPLES:
3598: # - my ($h1, $h2, $h3) = inittags( qw( h1 h2 h3 ) )
3599: # $h1->("This is a headline") #Returns: <h1>This is a headline</h1>
3600: #
3601: # NOTES: See sub htmltag for further information.
3602: #
3603: # OUTPUT: List of subroutines.
3604: sub inittags {
3605: my @tags = @_;
3606: return map { my $tag = $_;
3607: sub { return htmltag( $tag, @_ ) }
3608: } @tags;
3609: }
3610:
3611:
3612: # USAGE: scripttag(scriptcode, [start|end|both]);
3613: #
3614: # EXAMPLES:
3615: # - scripttag("alert('Hello World!')", 'both')
3616: # returns:
3617: # <script type="text/javascript">
3618: # // BEGIN LON-CAPA Internal
3619: # alert(Hello World!')
3620: # // END LON-CAPA Internal
3621: # </script>
3622: #
3623: # NOTES:
3624: # - works currently only for javascripts
3625: #
3626: # OUTPUT:
3627: # Scriptcode properly enclosed in <script> and CDATA tags (and LC
3628: # Internal markers if 2nd argument is given)
3629: sub scripttag {
3630: my ( $content, $marker ) = @_;
3631: return unless defined $content;
3632:
3633: my $begin = "\n// BEGIN LON-CAPA Internal\n";
3634: my $end = "\n// END LON-CAPA Internal\n";
3635:
3636: if ($marker) {
3637: $content = $begin . $content if $marker eq 'start' or $marker eq 'both';
3638: $content .= $end if $marker eq 'end' or $marker eq 'both';
3639: }
3640:
3641: $content = "\n// <![CDATA[\n$content\n// ]]>\n";
3642:
3643: return htmltag('script', $content, {type => 'text/javascript'});
3644: };
3645:
3646: =pod
3647:
3648: =item &list_from_array( \@array, { listattr =>{}, itemattr =>{} } )
3649:
3650: Constructs a XHTML list from \@array.
3651:
3652: input:
3653:
3654: =over
3655:
3656: =item \@array
3657:
3658: A reference to the array containing text that will be wrapped in <li></li> tags.
3659:
3660: =item { listattr => {}, itemattr =>{} }
3661:
3662: Attributes for <ul> and <li> passed in as hash references.
3663: See htmltag() for more details.
3664:
3665: =back
3666:
3667: returns: XHTML list as String.
3668:
3669: =cut
3670:
3671: # \@items, {listattr => { class => 'abc', id => 'xyx' }, itemattr => {class => 'abc', id => 'xyx'}}
3672: sub list_from_array {
3673: my ($items, $args) = @_;
3674: return unless (ref($items) eq 'ARRAY');
3675: return unless scalar @$items;
3676: my ($ul, $li) = inittags( qw(ul li) );
3677: my $listitems = join '', map { $li->($_, $args->{itemattr}) } @$items;
3678: return $ul->( $listitems, $args->{listattr} );
3679: }
3680:
3681:
3682: ##############################################
3683: ##############################################
3684:
3685: # generate_menu
3686: #
3687: # Generates html markup for a menu.
3688: #
3689: # Inputs:
3690: # An array of following structure:
3691: # ({ categorytitle => 'Categorytitle',
3692: # items => [
3693: # {
3694: # linktext => 'Text to be displayed',
3695: # url => 'URL the link is pointing to, i.e. /adm/site?action=dosomething',
3696: # permission => 'Contains permissions as returned from lonnet::allowed(),
3697: # must evaluate to true in order to activate the link',
3698: # icon => 'icon filename',
3699: # alttext => 'alt text for the icon',
3700: # help => 'Name of the corresponding helpfile',
3701: # linktitle => 'Description of the link (used for title tag)'
3702: # },
3703: # ...
3704: # ]
3705: # },
3706: # ...
3707: # )
3708: #
3709: # Outputs: A scalar containing the html markup for the menu.
3710:
3711: sub generate_menu {
3712: my @menu = @_;
3713: # subs for specific html elements
3714: my ($h3, $div, $ul, $li, $a, $img) = inittags( qw(h3 div ul li a img) );
3715:
3716: my @categories; # each element represents the entire markup for a category
3717:
3718: foreach my $category (@menu) {
3719: my @links; # contains the links for the current $category
3720: foreach my $link (@{$$category{items}}) {
3721: next unless $$link{permission};
3722:
3723: # create the markup for the current $link and push it into @links.
3724: # each entry consists of an image and a text optionally followed
3725: # by a help link.
3726: my $src;
3727: if ($$link{icon} ne '') {
3728: $src = '/res/adm/pages/'.$$link{icon};
3729: }
3730: push(@links,$li->(
3731: $a->(
3732: $img->("", {
3733: class => "LC_noBorder LC_middle",
3734: src => $src,
3735: alt => mt(defined($$link{alttext}) ?
3736: $$link{alttext} : $$link{linktext})
3737: }), {
3738: href => $$link{url},
3739: title => mt($$link{linktitle}),
3740: class => 'LC_menubuttons_link'
3741: }).
3742: $a->(mt($$link{linktext}), {
3743: href => $$link{url},
3744: title => mt($$link{linktitle}),
3745: class => "LC_menubuttons_link"
3746: }).
3747: (defined($$link{help}) ?
3748: Apache::loncommon::help_open_topic($$link{help}) : ''),
3749: {class => "LC_menubuttons_inline_text"}));
3750: }
3751:
3752: # wrap categorytitle in <h3>, concatenate with
3753: # joined and in <ul> tags wrapped @links
3754: # and wrap everything in an enclosing <div> and push it into
3755: # @categories
3756: # such that each element looks like:
3757: # <div><h3>title</h3><ul><li>...</li>...</ul></div>
3758: # the category won't be added if there aren't any links
3759: push(@categories,
3760: $div->($h3->(mt($$category{categorytitle}), {class=>"LC_hcell"}).
3761: $ul->(join('' ,@links), {class =>"LC_ListStyleNormal" }),
3762: {class=>"LC_Box LC_400Box"})) if scalar(@links);
3763: }
3764:
3765: # wrap the joined @categories in another <div> (column layout)
3766: return $div->(join('', @categories), {class => "LC_columnSection"});
3767: }
3768:
3769: ##############################################
3770: ##############################################
3771:
3772: =pod
3773:
3774: =item &start_funclist()
3775:
3776: Start list of available functions
3777:
3778: Typically used to offer a simple list of available functions
3779: at top or bottom of page.
3780: All available functions/actions for the current page
3781: should be included in this list.
3782:
3783: If the optional headline text is not provided, a default text will be used.
3784:
3785:
3786: Related routines:
3787: =over 4
3788: add_item_funclist
3789: end_funclist
3790: =back
3791:
3792:
3793: Inputs: (optional) headline text
3794:
3795: Returns: HTML code with function list start
3796:
3797: =cut
3798:
3799: ##############################################
3800: ##############################################
3801:
3802: sub start_funclist {
3803: my($legendtext)=@_;
3804: $legendtext=&mt('Functions') if !$legendtext;
3805: return '<ul class="LC_funclist"><li style="font-weight:bold; margin-left:0.8em;">'.$legendtext.'</li>'."\n";
3806: }
3807:
3808:
3809: ##############################################
3810: ##############################################
3811:
3812: =pod
3813:
3814: =item &add_item_funclist()
3815:
3816: Adds an item to the list of available functions
3817:
3818: Related routines:
3819: =over 4
3820: start_funclist
3821: end_funclist
3822: =back
3823:
3824: Inputs: content item with text and link to function
3825:
3826: Returns: HTML code with list item for funclist
3827:
3828: =cut
3829:
3830: ##############################################
3831: ##############################################
3832:
3833: sub add_item_funclist {
3834: my($content) = @_;
3835: return '<li>'.$content.'</li>'."\n";
3836: }
3837:
3838: =pod
3839:
3840: =item &end_funclist()
3841:
3842: End list of available functions
3843:
3844: Related routines:
3845: =over 4
3846: start_funclist
3847: add_item_funclist
3848: =back
3849:
3850: Inputs: ./.
3851:
3852: Returns: HTML code with function list end
3853:
3854: =cut
3855:
3856: sub end_funclist {
3857: return "</ul>\n";
3858: }
3859:
3860: =pod
3861:
3862: =item &funclist_from_array( \@array, {legend => 'text for legend'} )
3863:
3864: Constructs a XHTML list from \@array with the first item being visually
3865: highlighted and set to the value of legend or 'Functions' if legend is
3866: empty.
3867:
3868: =over
3869:
3870: =item \@array
3871:
3872: A reference to the array containing text that will be wrapped in <li></li> tags.
3873:
3874: =item { legend => 'text' }
3875:
3876: A string that's used as visually highlighted first item. 'Functions' is used if
3877: it's value evaluates to false.
3878:
3879: =back
3880:
3881: returns: XHTML list as string.
3882:
3883: =back
3884:
3885: =cut
3886:
3887: sub funclist_from_array {
3888: my ($items, $args) = @_;
3889: return unless(ref($items) eq 'ARRAY');
3890: $args->{legend} ||= mt('Functions');
3891: return list_from_array( [$args->{legend}, @$items],
3892: { listattr => {class => 'LC_funclist'} });
3893: }
3894:
3895: =pod
3896:
3897: =over
3898:
3899: =item &actionbox( \@array )
3900:
3901: Constructs a XHTML list from \@array with the first item being visually
3902: highlighted and set to the value 'Actions'. The list is wrapped in a division.
3903:
3904: The actionlist is used to offer contextual actions, mostly at the bottom
3905: of a page, on which the outcome of an processed action is shown,
3906: e.g. a file operation in Authoring Space.
3907:
3908: =over
3909:
3910: =item \@array
3911:
3912: A reference to the array containing text. Details: sub funclist_from_array
3913:
3914: =back
3915:
3916: Returns: XHTML div as string.
3917:
3918: =back
3919:
3920: =cut
3921:
3922: sub actionbox {
3923: my ($items) = @_;
3924: return unless(ref($items) eq 'ARRAY');
3925: return
3926: '<div class="LC_actionbox">'
3927: .&funclist_from_array($items, {legend => &mt('Actions')})
3928: .'</div>';
3929: }
3930:
3931: 1;
3932:
3933: __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