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