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