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