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