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