File:
[LON-CAPA] /
loncom /
interface /
lonhtmlcommon.pm
Revision
1.147:
download - view:
text,
annotated -
select for diffs
Sat Jul 29 00:31:58 2006 UTC (17 years, 10 months ago) by
raeburn
Branches:
MAIN
CVS tags:
HEAD
Bug 4943. Can now include custom roles used in course to build list of course users from which group members are selected. Also form element names can now contain non-alpha characters without breaking SetFormElements() javascript by referring to elements as formName.elements['name'] etc. Need to rewrite any / in custom role as _ has been eliminated (so conversion no longer required for autosec records in coursegroup.db).
1: # The LearningOnline Network with CAPA
2: # a pile of common html routines
3: #
4: # $Id: lonhtmlcommon.pm,v 1.147 2006/07/29 00:31:58 raeburn Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: ######################################################################
29: ######################################################################
30:
31: =pod
32:
33: =head1 NAME
34:
35: Apache::lonhtmlcommon - routines to do common html things
36:
37: =head1 SYNOPSIS
38:
39: Referenced by other mod_perl Apache modules.
40:
41: =head1 INTRODUCTION
42:
43: lonhtmlcommon is a collection of subroutines used to present information
44: in a consistent html format, or provide other functionality related to
45: html.
46:
47: =head2 General Subroutines
48:
49: =over 4
50:
51: =cut
52:
53: ######################################################################
54: ######################################################################
55:
56: package Apache::lonhtmlcommon;
57:
58: use strict;
59: use Time::Local;
60: use Time::HiRes;
61: use Apache::lonlocal;
62: use Apache::lonnet;
63: use lib '/home/httpd/lib/perl/';
64: use LONCAPA;
65:
66: ##############################################
67: ##############################################
68:
69: =pod
70:
71: =item authorbombs
72:
73: =cut
74:
75: ##############################################
76: ##############################################
77:
78: sub authorbombs {
79: my $url=shift;
80: $url=&Apache::lonnet::declutter($url);
81: my ($udom,$uname)=($url=~/^(\w+)\/(\w+)\//);
82: my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom);
83: foreach (keys %bombs) {
84: if ($_=~/^$udom\/$uname\//) {
85: return '<a href="/adm/bombs/'.$url.
86: '"><img src="'.&Apache::loncommon::lonhttpdurl('/adm/lonMisc/bomb.gif').'" border="0" /></a>'.
87: &Apache::loncommon::help_open_topic('About_Bombs');
88: }
89: }
90: return '';
91: }
92:
93: ##############################################
94: ##############################################
95:
96: sub recent_filename {
97: my $area=shift;
98: return 'nohist_recent_'.&escape($area);
99: }
100:
101: sub store_recent {
102: my ($area,$name,$value,$freeze)=@_;
103: my $file=&recent_filename($area);
104: my %recent=&Apache::lonnet::dump($file);
105: if (scalar(keys(%recent))>20) {
106: # remove oldest value
107: my $oldest=time();
108: my $delkey='';
109: foreach my $item (keys(%recent)) {
110: my $thistime=(split(/\&/,$recent{$item}))[0];
111: if (($thistime ne "always_include") && ($thistime<$oldest)) {
112: $oldest=$thistime;
113: $delkey=$item;
114: }
115: }
116: &Apache::lonnet::del($file,[$delkey]);
117: }
118: # store new value
119: my $timestamp;
120: if ($freeze) {
121: $timestamp = "always_include";
122: } else {
123: $timestamp = time();
124: }
125: &Apache::lonnet::put($file,{ $name =>
126: $timestamp.'&'.&escape($value) });
127: }
128:
129: sub remove_recent {
130: my ($area,$names)=@_;
131: my $file=&recent_filename($area);
132: return &Apache::lonnet::del($file,$names);
133: }
134:
135: sub select_recent {
136: my ($area,$fieldname,$event)=@_;
137: my %recent=&Apache::lonnet::dump(&recent_filename($area));
138: my $return="\n<select name='$fieldname'".
139: ($event?" onchange='$event'":'').
140: ">\n<option value=''>--- ".&mt('Recent')." ---</option>";
141: foreach my $value (sort(keys(%recent))) {
142: unless ($value =~/^error\:/) {
143: my $escaped = &Apache::loncommon::escape_url($value);
144: $return.="\n<option value='$escaped'>".
145: &unescape((split(/\&/,$recent{$value}))[1]).
146: '</option>';
147: }
148: }
149: $return.="\n</select>\n";
150: return $return;
151: }
152:
153: sub get_recent {
154: my ($area, $n) = @_;
155: my %recent=&Apache::lonnet::dump(&recent_filename($area));
156:
157: # Create hash with key as time and recent as value
158: # Begin filling return_hash with any 'always_include' option
159: my %time_hash = ();
160: my %return_hash = ();
161: foreach my $item (keys %recent) {
162: my ($thistime,$thisvalue)=(split(/\&/,$recent{$item}));
163: if ($thistime eq 'always_include') {
164: $return_hash{$item} = &unescape($thisvalue);
165: $n--;
166: } else {
167: $time_hash{$thistime} = $item;
168: }
169: }
170:
171: # Sort by decreasing time and return key value pairs
172: my $idx = 1;
173: foreach my $item (reverse(sort(keys(%time_hash)))) {
174: $return_hash{$time_hash{$item}} =
175: &unescape((split(/\&/,$recent{$time_hash{$item}}))[1]);
176: if ($n && ($idx++ >= $n)) {last;}
177: }
178:
179: return %return_hash;
180: }
181:
182: sub get_recent_frozen {
183: my ($area) = @_;
184: my %recent=&Apache::lonnet::dump(&recent_filename($area));
185:
186: # Create hash with all 'frozen' items
187: my %return_hash = ();
188: foreach my $item (keys(%recent)) {
189: my ($thistime,$thisvalue)=(split(/\&/,$recent{$item}));
190: if ($thistime eq 'always_include') {
191: $return_hash{$item} = &unescape($thisvalue);
192: }
193: }
194: return %return_hash;
195: }
196:
197:
198:
199: =pod
200:
201: =item textbox
202:
203: =cut
204:
205: ##############################################
206: ##############################################
207: sub textbox {
208: my ($name,$value,$size,$special) = @_;
209: $size = 40 if (! defined($size));
210: $value = &HTML::Entities::encode($value,'<>&"');
211: my $Str = '<input type="text" name="'.$name.'" size="'.$size.'" '.
212: 'value="'.$value.'" '.$special.' />';
213: return $Str;
214: }
215:
216: ##############################################
217: ##############################################
218:
219: =pod
220:
221: =item checkbox
222:
223: =cut
224:
225: ##############################################
226: ##############################################
227: sub checkbox {
228: my ($name,$checked,$value) = @_;
229: my $Str = '<input type="checkbox" name="'.$name.'" ';
230: if (defined($value)) {
231: $Str .= 'value="'.$value.'"';
232: }
233: if ($checked) {
234: $Str .= ' checked="1"';
235: }
236: $Str .= ' />';
237: return $Str;
238: }
239:
240:
241: =pod
242:
243: =item radiobutton
244:
245: =cut
246:
247: ##############################################
248: ##############################################
249: sub radio {
250: my ($name,$checked,$value) = @_;
251: my $Str = '<input type="radio" name="'.$name.'" ';
252: if (defined($value)) {
253: $Str .= 'value="'.$value.'"';
254: }
255: if ($checked eq $value) {
256: $Str .= ' checked="1"';
257: }
258: $Str .= ' />';
259: return $Str;
260: }
261:
262: ##############################################
263: ##############################################
264:
265: =pod
266:
267: =item &date_setter
268:
269: &date_setter returns html and javascript for a compact date-setting form.
270: To retrieve values from it, use &get_date_from_form().
271:
272: Inputs
273:
274: =over 4
275:
276: =item $dname
277:
278: The name to prepend to the form elements.
279: The form elements defined will be dname_year, dname_month, dname_day,
280: dname_hour, dname_min, and dname_sec.
281:
282: =item $currentvalue
283:
284: The current setting for this time parameter. A unix format time
285: (time in seconds since the beginning of Jan 1st, 1970, GMT.
286: An undefined value is taken to indicate the value is the current time.
287: Also, to be explicit, a value of 'now' also indicates the current time.
288:
289: =item $special
290:
291: Additional html/javascript to be associated with each element in
292: the date_setter. See lonparmset for example usage.
293:
294: =item $includeempty
295:
296: =item $state
297:
298: Specifies the initial state of the form elements. Either 'disabled' or empty.
299: Defaults to empty, which indiciates the form elements are not disabled.
300:
301: =back
302:
303: Bugs
304:
305: The method used to restrict user input will fail in the year 2400.
306:
307: =cut
308:
309: ##############################################
310: ##############################################
311: sub date_setter {
312: my ($formname,$dname,$currentvalue,$special,$includeempty,$state,
313: $no_hh_mm_ss,$defhour,$defmin,$defsec,$nolink) = @_;
314: my $wasdefined=1;
315: if (! defined($state) || $state ne 'disabled') {
316: $state = '';
317: }
318: if (! defined($no_hh_mm_ss)) {
319: $no_hh_mm_ss = 0;
320: }
321: if ($currentvalue eq 'now') {
322: $currentvalue=time;
323: }
324: if ((!defined($currentvalue)) || ($currentvalue eq '')) {
325: $wasdefined=0;
326: if ($includeempty) {
327: $currentvalue = 0;
328: } else {
329: $currentvalue = time;
330: }
331: }
332: # other potentially useful values: wkday,yrday,is_daylight_savings
333: my ($sec,$min,$hour,$mday,$month,$year)=('','',undef,'','','');
334: if ($currentvalue) {
335: ($sec,$min,$hour,$mday,$month,$year,undef,undef,undef) =
336: localtime($currentvalue);
337: $year += 1900;
338: }
339: unless ($wasdefined) {
340: if (($defhour) || ($defmin) || ($defsec)) {
341: ($sec,$min,$hour,$mday,$month,$year,undef,undef,undef) =
342: localtime(time);
343: $year += 1900;
344: $sec=($defsec?$defsec:0);
345: $min=($defmin?$defmin:0);
346: $hour=($defhour?$defhour:0);
347: } elsif (!$includeempty) {
348: $sec=0;
349: $min=0;
350: $hour=0;
351: }
352: }
353: my $result = "\n<!-- $dname date setting form -->\n";
354: $result .= <<ENDJS;
355: <script type="text/javascript">
356: function $dname\_checkday() {
357: var day = document.$formname.$dname\_day.value;
358: var month = document.$formname.$dname\_month.value;
359: var year = document.$formname.$dname\_year.value;
360: var valid = true;
361: if (day < 1) {
362: document.$formname.$dname\_day.value = 1;
363: }
364: if (day > 31) {
365: document.$formname.$dname\_day.value = 31;
366: }
367: if ((month == 1) || (month == 3) || (month == 5) ||
368: (month == 7) || (month == 8) || (month == 10) ||
369: (month == 12)) {
370: if (day > 31) {
371: document.$formname.$dname\_day.value = 31;
372: day = 31;
373: }
374: } else if (month == 2 ) {
375: if ((year % 4 == 0) && (year % 100 != 0)) {
376: if (day > 29) {
377: document.$formname.$dname\_day.value = 29;
378: }
379: } else if (day > 29) {
380: document.$formname.$dname\_day.value = 28;
381: }
382: } else if (day > 30) {
383: document.$formname.$dname\_day.value = 30;
384: }
385: }
386:
387: function $dname\_disable() {
388: document.$formname.$dname\_month.disabled=true;
389: document.$formname.$dname\_day.disabled=true;
390: document.$formname.$dname\_year.disabled=true;
391: document.$formname.$dname\_hour.disabled=true;
392: document.$formname.$dname\_minute.disabled=true;
393: document.$formname.$dname\_second.disabled=true;
394: }
395:
396: function $dname\_enable() {
397: document.$formname.$dname\_month.disabled=false;
398: document.$formname.$dname\_day.disabled=false;
399: document.$formname.$dname\_year.disabled=false;
400: document.$formname.$dname\_hour.disabled=false;
401: document.$formname.$dname\_minute.disabled=false;
402: document.$formname.$dname\_second.disabled=false;
403: }
404:
405: function $dname\_opencalendar() {
406: if (! document.$formname.$dname\_month.disabled) {
407: var calwin=window.open(
408: "/adm/announcements?pickdate=yes&formname=$formname&element=$dname&month="+
409: document.$formname.$dname\_month.value+"&year="+
410: document.$formname.$dname\_year.value,
411: "LONCAPAcal",
412: "height=350,width=350,scrollbars=yes,resizable=yes,menubar=no");
413: }
414:
415: }
416: </script>
417: ENDJS
418: $result .= ' <span style="white-space: nowrap;">';
419: my $monthselector = qq{<select name="$dname\_month" $special $state onchange="javascript:$dname\_checkday()" >};
420: # Month
421: my @Months = qw/January February March April May June
422: July August September October November December/;
423: # Pad @Months with a bogus value to make indexing easier
424: unshift(@Months,'If you can read this an error occurred');
425: if ($includeempty) { $monthselector.="<option value=''></option>"; }
426: for(my $m = 1;$m <=$#Months;$m++) {
427: $monthselector .= qq{ <option value="$m" };
428: $monthselector .= "selected " if ($m-1 eq $month);
429: $monthselector .= '> '.&mt($Months[$m]).' </option>';
430: }
431: $monthselector.= ' </select>';
432: # Day
433: my $dayselector = qq{<input type="text" name="$dname\_day" $state value="$mday" size="3" $special onchange="javascript:$dname\_checkday()" />};
434: # Year
435: my $yearselector = qq{<input type="year" name="$dname\_year" $state value="$year" size="5" $special onchange="javascript:$dname\_checkday()" />};
436: #
437: my $hourselector = qq{<select name="$dname\_hour" $special $state >};
438: if ($includeempty) {
439: $hourselector.=qq{<option value=''></option>};
440: }
441: for (my $h = 0;$h<24;$h++) {
442: $hourselector .= qq{<option value="$h" };
443: $hourselector .= "selected " if (defined($hour) && $hour == $h);
444: $hourselector .= ">";
445: my $timest='';
446: if ($h == 0) {
447: $timest .= "12 am";
448: } elsif($h == 12) {
449: $timest .= "12 noon";
450: } elsif($h < 12) {
451: $timest .= "$h am";
452: } else {
453: $timest .= $h-12 ." pm";
454: }
455: $timest=&mt($timest);
456: $hourselector .= $timest." </option>\n";
457: }
458: $hourselector .= " </select>\n";
459: my $minuteselector = qq{<input type="text" name="$dname\_minute" $special $state value="$min" size="3" />};
460: my $secondselector= qq{<input type="text" name="$dname\_second" $special $state value="$sec" size="3" />};
461: my $cal_link;
462: if (!$nolink) {
463: $cal_link = qq{<a href="javascript:$dname\_opencalendar()">};
464: }
465: #
466: if ($no_hh_mm_ss) {
467: $result .= &mt('[_1] [_2] [_3] ',
468: $monthselector,$dayselector,$yearselector);
469: if (!$nolink) {
470: $result .= &mt('[_1]Select Date[_2]',$cal_link,'</a>');
471: }
472: } else {
473: $result .= &mt('[_1] [_2] [_3] [_4] [_5]m [_6]s ',
474: $monthselector,$dayselector,$yearselector,
475: $hourselector,$minuteselector,$secondselector);
476: if (!$nolink) {
477: $result .= &mt('[_1]Select Date[_2]',$cal_link,'</a>');
478: }
479: }
480: $result .= "</span>\n<!-- end $dname date setting form -->\n";
481: return $result;
482: }
483:
484: ##############################################
485: ##############################################
486:
487: =pod
488:
489: =item &get_date_from_form
490:
491: get_date_from_form retrieves the date specified in an &date_setter form.
492:
493: Inputs:
494:
495: =over 4
496:
497: =item $dname
498:
499: The name passed to &datesetter, which prefixes the form elements.
500:
501: =item $defaulttime
502:
503: The unix time to use as the default in case of poor inputs.
504:
505: =back
506:
507: Returns: Unix time represented in the form.
508:
509: =cut
510:
511: ##############################################
512: ##############################################
513: sub get_date_from_form {
514: my ($dname) = @_;
515: my ($sec,$min,$hour,$day,$month,$year);
516: #
517: if (defined($env{'form.'.$dname.'_second'})) {
518: my $tmpsec = $env{'form.'.$dname.'_second'};
519: if (($tmpsec =~ /^\d+$/) && ($tmpsec >= 0) && ($tmpsec < 60)) {
520: $sec = $tmpsec;
521: }
522: if (!defined($tmpsec) || $tmpsec eq '') { $sec = 0; }
523: } else {
524: $sec = 0;
525: }
526: if (defined($env{'form.'.$dname.'_minute'})) {
527: my $tmpmin = $env{'form.'.$dname.'_minute'};
528: if (($tmpmin =~ /^\d+$/) && ($tmpmin >= 0) && ($tmpmin < 60)) {
529: $min = $tmpmin;
530: }
531: if (!defined($tmpmin) || $tmpmin eq '') { $min = 0; }
532: } else {
533: $min = 0;
534: }
535: if (defined($env{'form.'.$dname.'_hour'})) {
536: my $tmphour = $env{'form.'.$dname.'_hour'};
537: if (($tmphour =~ /^\d+$/) && ($tmphour >= 0) && ($tmphour < 24)) {
538: $hour = $tmphour;
539: }
540: } else {
541: $hour = 0;
542: }
543: if (defined($env{'form.'.$dname.'_day'})) {
544: my $tmpday = $env{'form.'.$dname.'_day'};
545: if (($tmpday =~ /^\d+$/) && ($tmpday > 0) && ($tmpday < 32)) {
546: $day = $tmpday;
547: }
548: }
549: if (defined($env{'form.'.$dname.'_month'})) {
550: my $tmpmonth = $env{'form.'.$dname.'_month'};
551: if (($tmpmonth =~ /^\d+$/) && ($tmpmonth > 0) && ($tmpmonth < 13)) {
552: $month = $tmpmonth - 1;
553: }
554: }
555: if (defined($env{'form.'.$dname.'_year'})) {
556: my $tmpyear = $env{'form.'.$dname.'_year'};
557: if (($tmpyear =~ /^\d+$/) && ($tmpyear > 1900)) {
558: $year = $tmpyear - 1900;
559: }
560: }
561: if (($year<70) || ($year>137)) { return undef; }
562: if (defined($sec) && defined($min) && defined($hour) &&
563: defined($day) && defined($month) && defined($year) &&
564: eval('&timelocal($sec,$min,$hour,$day,$month,$year)')) {
565: return &timelocal($sec,$min,$hour,$day,$month,$year);
566: } else {
567: return undef;
568: }
569: }
570:
571: ##############################################
572: ##############################################
573:
574: =pod
575:
576: =item &pjump_javascript_definition()
577:
578: Returns javascript defining the 'pjump' function, which opens up a
579: parameter setting wizard.
580:
581: =cut
582:
583: ##############################################
584: ##############################################
585: sub pjump_javascript_definition {
586: my $Str = <<END;
587: function pjump(type,dis,value,marker,ret,call,hour,min,sec) {
588: parmwin=window.open("/adm/rat/parameter.html?type="+escape(type)
589: +"&value="+escape(value)+"&marker="+escape(marker)
590: +"&return="+escape(ret)
591: +"&call="+escape(call)+"&name="+escape(dis)
592: +"&defhour="+escape(hour)+"&defmin="+escape(min)
593: +"&defsec="+escape(sec),"LONCAPAparms",
594: "height=350,width=350,scrollbars=no,menubar=no");
595: }
596: END
597: return $Str;
598: }
599:
600: ##############################################
601: ##############################################
602:
603: =pod
604:
605: =item &javascript_nothing()
606:
607: Return an appropriate null for the users browser. This is used
608: as the first arguement for window.open calls when you want a blank
609: window that you can then write to.
610:
611: =cut
612:
613: ##############################################
614: ##############################################
615: sub javascript_nothing {
616: # mozilla and other browsers work with "''", but IE on mac does not.
617: my $nothing = "''";
618: my $user_browser;
619: my $user_os;
620: $user_browser = $env{'browser.type'} if (exists($env{'browser.type'}));
621: $user_os = $env{'browser.os'} if (exists($env{'browser.os'}));
622: if (! defined($user_browser) || ! defined($user_os)) {
623: (undef,$user_browser,undef,undef,undef,$user_os) =
624: &Apache::loncommon::decode_user_agent();
625: }
626: if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
627: $nothing = "'javascript:void(0);'";
628: }
629: return $nothing;
630: }
631:
632: ##############################################
633: ##############################################
634: sub javascript_docopen {
635: # safari does not understand document.open() and loads "text/html"
636: my $nothing = "''";
637: my $user_browser;
638: my $user_os;
639: $user_browser = $env{'browser.type'} if (exists($env{'browser.type'}));
640: $user_os = $env{'browser.os'} if (exists($env{'browser.os'}));
641: if (! defined($user_browser) || ! defined($user_os)) {
642: (undef,$user_browser,undef,undef,undef,$user_os) =
643: &Apache::loncommon::decode_user_agent();
644: }
645: if ($user_browser eq 'safari' && $user_os =~ 'mac') {
646: $nothing = "document.clear()";
647: } else {
648: $nothing = "document.open('text/html','replace')";
649: }
650: return $nothing;
651: }
652:
653:
654: ##############################################
655: ##############################################
656:
657: =pod
658:
659: =item &StatusOptions()
660:
661: Returns html for a selection box which allows the user to choose the
662: enrollment status of students. The selection box name is 'Status'.
663:
664: Inputs:
665:
666: $status: the currently selected status. If undefined the value of
667: $env{'form.Status'} is taken. If that is undefined, a value of 'Active'
668: is used.
669:
670: $formname: The name of the form. If defined the onchange attribute of
671: the selection box is set to document.$formname.submit().
672:
673: $size: the size (number of lines) of the selection box.
674:
675: $onchange: javascript to use when the value is changed. Enclosed in
676: double quotes, ""s, not single quotes.
677:
678: Returns: a perl string as described.
679:
680: =cut
681:
682: ##############################################
683: ##############################################
684: sub StatusOptions {
685: my ($status, $formName,$size,$onchange)=@_;
686: $size = 1 if (!defined($size));
687: if (! defined($status)) {
688: $status = 'Active';
689: $status = $env{'form.Status'} if (exists($env{'form.Status'}));
690: }
691:
692: my $OpSel1 = '';
693: my $OpSel2 = '';
694: my $OpSel3 = '';
695:
696: if($status eq 'Any') { $OpSel3 = ' selected'; }
697: elsif($status eq 'Expired' ) { $OpSel2 = ' selected'; }
698: else { $OpSel1 = ' selected'; }
699:
700: my $Str = '';
701: $Str .= '<select name="Status"';
702: if(defined($formName) && $formName ne '' && ! defined($onchange)) {
703: $Str .= ' onchange="document.'.$formName.'.submit()"';
704: }
705: if (defined($onchange)) {
706: $Str .= ' onchange="'.$onchange.'"';
707: }
708: $Str .= ' size="'.$size.'" ';
709: $Str .= '>'."\n";
710: $Str .= '<option value="Active" '.$OpSel1.'>'.
711: &mt('Currently Enrolled').'</option>'."\n";
712: $Str .= '<option value="Expired" '.$OpSel2.'>'.
713: &mt('Previously Enrolled').'</option>'."\n";
714: $Str .= '<option value="Any" '.$OpSel3.'>'.
715: &mt('Any Enrollment Status').'</option>'."\n";
716: $Str .= '</select>'."\n";
717: }
718:
719: ########################################################
720: ########################################################
721:
722: =pod
723:
724: =item Progess Window Handling Routines
725:
726: These routines handle the creation, update, increment, and closure of
727: progress windows. The progress window reports to the user the number
728: of items completed and an estimate of the time required to complete the rest.
729:
730: =over 4
731:
732:
733: =item &Create_PrgWin
734:
735: Writes javascript to the client to open a progress window and returns a
736: data structure used for bookkeeping.
737:
738: Inputs
739:
740: =over 4
741:
742: =item $r Apache request
743:
744: =item $title The title of the progress window
745:
746: =item $heading A description (usually 1 line) of the process being initiated.
747:
748: =item $number_to_do The total number of items being processed.
749:
750: =item $type Either 'popup' or 'inline' (popup is assumed if nothing is
751: specified)
752:
753: =item $width Specify the width in charaters of the input field.
754:
755: =item $formname Only useful in the inline case, if a form already exists, this needs to be used and specfiy the name of the form, otherwise the Progress line will be created in a new form of it's own
756:
757: =item $inputname Only useful in the inline case, if a form and an input of type text exists, use this to specify the name of the input field
758:
759: =back
760:
761: Returns a hash containing the progress state data structure.
762:
763:
764: =item &Update_PrgWin
765:
766: Updates the text in the progress indicator. Does not increment the count.
767: See &Increment_PrgWin.
768:
769: Inputs:
770:
771: =over 4
772:
773: =item $r Apache request
774:
775: =item $prog_state Pointer to the data structure returned by &Create_PrgWin
776:
777: =item $displaystring The string to write to the status indicator
778:
779: =back
780:
781: Returns: none
782:
783:
784: =item Increment_PrgWin
785:
786: Increment the count of items completed for the progress window by 1.
787:
788: Inputs:
789:
790: =over 4
791:
792: =item $r Apache request
793:
794: =item $prog_state Pointer to the data structure returned by Create_PrgWin
795:
796: =item $extraInfo A description of the items being iterated over. Typically
797: 'student'.
798:
799: =back
800:
801: Returns: none
802:
803:
804: =item Close_PrgWin
805:
806: Closes the progress window.
807:
808: Inputs:
809:
810: =over 4
811:
812: =item $r Apache request
813:
814: =item $prog_state Pointer to the data structure returned by Create_PrgWin
815:
816: =back
817:
818: Returns: none
819:
820: =back
821:
822: =cut
823:
824: ########################################################
825: ########################################################
826:
827: my $uniq=0;
828: sub get_uniq_name {
829: $uniq++;
830: return 'uniquename'.$uniq;
831: }
832:
833: # Create progress
834: sub Create_PrgWin {
835: my ($r, $title, $heading, $number_to_do,$type,$width,$formname,
836: $inputname)=@_;
837: if (!defined($type)) { $type='popup'; }
838: if (!defined($width)) { $width=55; }
839: my %prog_state;
840: $prog_state{'type'}=$type;
841: if ($type eq 'popup') {
842: $prog_state{'window'}='popwin';
843: my $start_page =
844: &Apache::loncommon::start_page($title,undef,
845: {'only_body' => 1,
846: 'bgcolor' => '#88DDFF',
847: 'js_ready' => 1});
848: my $end_page = &Apache::loncommon::end_page({'js_ready' => 1});
849:
850: #the whole function called through timeout is due to issues
851: #in mozilla Read BUG #2665 if you want to know the whole story
852: &r_print($r,'<script type="text/javascript">'.
853: "var popwin;
854: function openpopwin () {
855: popwin=open(\'\',\'popwin\',\'width=400,height=100\');".
856: "popwin.document.writeln(\'".$start_page.
857: "<h4>$heading<\/h4>".
858: "<form name=\"popremain\" method=\"post\">".
859: '<input type="text" size="'.$width.'" name="remaining" value="'.
860: &mt('Starting').'" /><\\/form>'.$end_page.
861: "\');".
862: "popwin.document.close();}".
863: "\nwindow.setTimeout(openpopwin,0)</script>");
864: $prog_state{'formname'}='popremain';
865: $prog_state{'inputname'}="remaining";
866: } elsif ($type eq 'inline') {
867: $prog_state{'window'}='window';
868: if (!$formname) {
869: $prog_state{'formname'}=&get_uniq_name();
870: &r_print($r,'<form name="'.$prog_state{'formname'}.'">');
871: } else {
872: $prog_state{'formname'}=$formname;
873: }
874: if (!$inputname) {
875: $prog_state{'inputname'}=&get_uniq_name();
876: &r_print($r,$heading.' <input type="text" name="'.$prog_state{'inputname'}.
877: '" size="'.$width.'" />');
878: } else {
879: $prog_state{'inputname'}=$inputname;
880:
881: }
882: if (!$formname) { &r_print($r,'</form>'); }
883: &Update_PrgWin($r,\%prog_state,&mt('Starting'));
884: }
885:
886: $prog_state{'done'}=0;
887: $prog_state{'firststart'}=&Time::HiRes::time();
888: $prog_state{'laststart'}=&Time::HiRes::time();
889: $prog_state{'max'}=$number_to_do;
890:
891: return %prog_state;
892: }
893:
894: # update progress
895: sub Update_PrgWin {
896: my ($r,$prog_state,$displayString)=@_;
897: &r_print($r,'<script>'.$$prog_state{'window'}.'.document.'.
898: $$prog_state{'formname'}.'.'.
899: $$prog_state{'inputname'}.'.value="'.
900: $displayString.'";</script>');
901: $$prog_state{'laststart'}=&Time::HiRes::time();
902: }
903:
904: # increment progress state
905: sub Increment_PrgWin {
906: my ($r,$prog_state,$extraInfo)=@_;
907: $$prog_state{'done'}++;
908: my $time_est= (&Time::HiRes::time() - $$prog_state{'firststart'})/
909: $$prog_state{'done'} *
910: ($$prog_state{'max'}-$$prog_state{'done'});
911: $time_est = int($time_est);
912: #
913: my $min = int($time_est/60);
914: my $sec = $time_est % 60;
915: #
916: my $str;
917: if ($min == 0 && $sec > 1) {
918: $str = '[_2] seconds';
919: } elsif ($min == 1 && $sec > 1) {
920: $str = '1 minute [_2] seconds';
921: } elsif ($min == 1 && $sec < 2) {
922: $str = '1 minute';
923: } elsif ($min < 10 && $sec > 1) {
924: $str = '[_1] minutes, [_2] seconds';
925: } elsif ($min >= 10 || $sec < 2) {
926: $str = '[_1] minutes';
927: }
928: $time_est = &mt($str,$min,$sec);
929: #
930: my $lasttime = &Time::HiRes::time()-$$prog_state{'laststart'};
931: if ($lasttime > 9) {
932: $lasttime = int($lasttime);
933: } elsif ($lasttime < 0.01) {
934: $lasttime = 0;
935: } else {
936: $lasttime = sprintf("%3.2f",$lasttime);
937: }
938: if ($lasttime == 1) {
939: $lasttime = '('.$lasttime.' '.&mt('second for').' '.$extraInfo.')';
940: } else {
941: $lasttime = '('.$lasttime.' '.&mt('seconds for').' '.$extraInfo.')';
942: }
943: #
944: my $user_browser = $env{'browser.type'} if (exists($env{'browser.type'}));
945: my $user_os = $env{'browser.os'} if (exists($env{'browser.os'}));
946: if (! defined($user_browser) || ! defined($user_os)) {
947: (undef,$user_browser,undef,undef,undef,$user_os) =
948: &Apache::loncommon::decode_user_agent();
949: }
950: if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
951: $lasttime = '';
952: }
953: &r_print($r,'<script>'.$$prog_state{'window'}.'.document.'.
954: $$prog_state{'formname'}.'.'.
955: $$prog_state{'inputname'}.'.value="'.
956: $$prog_state{'done'}.'/'.$$prog_state{'max'}.
957: ': '.$time_est.' '.&mt('remaining').' '.$lasttime.'";'.'</script>');
958: $$prog_state{'laststart'}=&Time::HiRes::time();
959: }
960:
961: # close Progress Line
962: sub Close_PrgWin {
963: my ($r,$prog_state)=@_;
964: if ($$prog_state{'type'} eq 'popup') {
965: &r_print($r,'<script>popwin.close()</script>'."\n");
966: } elsif ($$prog_state{'type'} eq 'inline') {
967: &Update_PrgWin($r,$prog_state,&mt('Done'));
968: }
969: undef(%$prog_state);
970: }
971:
972: sub r_print {
973: my ($r,$to_print)=@_;
974: if ($r) {
975: $r->print($to_print);
976: $r->rflush();
977: } else {
978: print($to_print);
979: }
980: }
981:
982: # ------------------------------------------------------- Puts directory header
983:
984: sub crumbs {
985: my ($uri,$target,$prefix,$form,$size,$noformat,$skiplast)=@_;
986: if (! defined($size)) {
987: $size = '+2';
988: }
989: if ($target) {
990: $target = ' target="'.
991: &Apache::loncommon::escape_single($target).'"';
992: }
993: my $output='';
994: unless ($noformat) { $output.='<br /><tt><b>'; }
995: $output.='<font size="'.$size.'">'.$prefix.'/';
996: if ($env{'user.adv'}) {
997: my $path=$prefix.'/';
998: foreach my $dir (split('/',$uri)) {
999: if (! $dir) { next; }
1000: $path .= $dir;
1001: if ($path eq $uri) {
1002: if ($skiplast) {
1003: $output.=$dir;
1004: last;
1005: }
1006: } else {
1007: $path.='/';
1008: }
1009: my $linkpath = &Apache::loncommon::escape_single($path);
1010: if ($form) {
1011: $linkpath=
1012: qq{javascript:$form.action='$linkpath';$form.submit();};
1013: }
1014: $output.=qq{<a href="$linkpath" $target>$dir</a>/};
1015: }
1016: } else {
1017: $output.=$uri;
1018: }
1019: unless ($uri=~/\/$/) { $output=~s/\/$//; }
1020: return $output.'</font>'.($noformat?'':'</b></tt><br />');
1021: }
1022:
1023: # --------------------- A function that generates a window for the spellchecker
1024:
1025: sub spellheader {
1026: my $start_page=
1027: &Apache::loncommon::start_page('Speller Suggestions',undef,
1028: {'only_body' => 1,
1029: 'js_ready' => 1,
1030: 'bgcolor' => '#DDDDDD',
1031: 'add_entries' => {
1032: 'onload' =>
1033: 'document.forms.spellcheckform.submit()',
1034: }
1035: });
1036: my $end_page=
1037: &Apache::loncommon::end_page({'js_ready' => 1});
1038:
1039: my $nothing=&javascript_nothing();
1040: return (<<ENDCHECK);
1041: <script type="text/javascript">
1042: //<!-- BEGIN LON-CAPA Internal
1043: var checkwin;
1044:
1045: function spellcheckerwindow(string) {
1046: var esc_string = string.replace(/\"/g,'"');
1047: checkwin=window.open($nothing,'spellcheckwin','height=320,width=280,resizable=yes,scrollbars=yes,location=no,menubar=no,toolbar=no');
1048: checkwin.document.writeln('$start_page<form name="spellcheckform" action="/adm/spellcheck" method="post"><input type="hidden" name="text" value="'+esc_string+'" /><\/form>$end_page');
1049: checkwin.document.close();
1050: }
1051: // END LON-CAPA Internal -->
1052: </script>
1053: ENDCHECK
1054: }
1055:
1056: # ---------------------------------- Generate link to spell checker for a field
1057:
1058: sub spelllink {
1059: my ($form,$field)=@_;
1060: my $linktext=&mt('Check Spelling');
1061: return (<<ENDLINK);
1062: <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>
1063: ENDLINK
1064: }
1065:
1066: # ------------------------------------------------- Output headers for HTMLArea
1067:
1068: {
1069: my @htmlareafields;
1070: sub init_htmlareafields {
1071: undef(@htmlareafields);
1072: }
1073:
1074: sub add_htmlareafields {
1075: my (@newfields) = @_;
1076: push(@htmlareafields,@newfields);
1077: }
1078:
1079: sub get_htmlareafields {
1080: return @htmlareafields;
1081: }
1082: }
1083:
1084: sub htmlareaheaders {
1085: if (&htmlareablocked()) { return ''; }
1086: unless (&htmlareabrowser()) { return ''; }
1087: my $lang='en';
1088: if (&mt('htmlarea_lang') ne 'htmlarea_lang') {
1089: $lang=&mt('htmlarea_lang');
1090: }
1091: return (<<ENDHEADERS);
1092: <script type="text/javascript">
1093: _editor_url='/htmlarea/';
1094: _editor_lang='$lang';
1095: </script>
1096: <script type="text/javascript" src="/htmlarea/htmlarea.js"></script>
1097: <link rel="stylesheet" type="text/css" href="/htmlarea/htmlarea.css" />
1098: ENDHEADERS
1099: }
1100:
1101: # ------------------------------------------------- Activate additional buttons
1102:
1103: sub htmlareaaddbuttons {
1104: if (&htmlareablocked()) { return ''; }
1105: unless (&htmlareabrowser()) { return ''; }
1106: return (<<ENDADDBUTTON);
1107: var config=new HTMLArea.Config();
1108: config.registerButton('ed_math','LaTeX Inline',
1109: '/htmlarea/images/ed_math.gif',false,
1110: function(editor,id) {
1111: editor.surroundHTML(' <m>\$','\$</m> ');
1112: }
1113: );
1114: config.registerButton('ed_math_eqn','LaTeX Equation',
1115: '/htmlarea/images/ed_math_eqn.gif',false,
1116: function(editor,id) {
1117: editor.surroundHTML(
1118: ' \\n<center><m>\\\\[','\\\\]</m></center>\\n ');
1119: }
1120: );
1121: config.toolbar.push(['ed_math','ed_math_eqn']);
1122: ENDADDBUTTON
1123: }
1124:
1125: # ----------------------------------------------------------------- Preferences
1126:
1127: sub disablelink {
1128: my @fields=@_;
1129: if (defined($#fields)) {
1130: unless ($#fields>=0) { return ''; }
1131: }
1132: return '<a href="'.&HTML::Entities::encode('/adm/preferences?action=set_wysiwyg&wysiwyg=off&returnurl=','<>&"').&escape($ENV{'REQUEST_URI'}).'">'.&mt('Disable WYSIWYG Editor').'</a>';
1133: }
1134:
1135: sub enablelink {
1136: my @fields=@_;
1137: if (defined($#fields)) {
1138: unless ($#fields>=0) { return ''; }
1139: }
1140: return '<a href="'.&HTML::Entities::encode('/adm/preferences?action=set_wysiwyg&wysiwyg=on&returnurl=','<>&"').&escape($ENV{'REQUEST_URI'}).'">'.&mt('Enable WYSIWYG Editor').'</a>';
1141: }
1142:
1143: # ----------------------------------------- Script to activate only some fields
1144:
1145: sub htmlareaselectactive {
1146: my @fields=@_;
1147: unless (&htmlareabrowser()) { return ''; }
1148: if (&htmlareablocked()) { return '<br />'.&enablelink(@fields); }
1149: my $output='<script type="text/javascript" defer="1">'.
1150: &htmlareaaddbuttons();
1151: foreach(@fields) {
1152: $output.="\nHTMLArea.replace('$_',config);";
1153: }
1154: $output.="\nwindow.status='Activated Editfields';\n</script><br />".
1155: &disablelink(@fields);
1156: return $output;
1157: }
1158:
1159: # --------------------------------------------------------------------- Blocked
1160:
1161: sub htmlareablocked {
1162: unless ($env{'environment.wysiwygeditor'} eq 'on') { return 1; }
1163: return 0;
1164: }
1165:
1166: # ---------------------------------------- Browser capable of running HTMLArea?
1167:
1168: sub htmlareabrowser {
1169: return 1;
1170: }
1171:
1172: ############################################################
1173: ############################################################
1174:
1175: =pod
1176:
1177: =item breadcrumbs
1178:
1179: Compiles the previously registered breadcrumbs into an series of links.
1180: FAQ and BUG links will be placed on the left side of the table if they
1181: are defined for the last registered breadcrumb.
1182: Additionally supports a 'component', which will be displayed on the
1183: right side of the table (without a link).
1184: A link to help for the component will be included if one is specified.
1185:
1186: All inputs can be undef without problems.
1187:
1188: Inputs: $component (the large text on the right side of the table),
1189: $component_help
1190: $menulink (boolean, controls whether to include a link to /adm/menu)
1191: $helplink (if 'nohelp' don't include the orange help link)
1192: $css_class (optional name for the class to apply to the table for CSS)
1193: Returns a string containing breadcrumbs for the current page.
1194:
1195: =item clear_breadcrumbs
1196:
1197: Clears the previously stored breadcrumbs.
1198:
1199: =item add_breadcrumb
1200:
1201: Pushes a breadcrumb on the stack of crumbs.
1202:
1203: input: $breadcrumb, a hash reference. The keys 'href','title', and 'text'
1204: are required. If present the keys 'faq' and 'bug' will be used to provide
1205: links to the FAQ and bug sites.
1206:
1207: returns: nothing
1208:
1209: =cut
1210:
1211: ############################################################
1212: ############################################################
1213: {
1214: my @Crumbs;
1215:
1216: sub breadcrumbs {
1217: my ($component,$component_help,$menulink,$helplink,$css_class) = @_;
1218: #
1219: $css_class ||= 'LC_breadcrumbs';
1220: my $Str = "\n".'<table class="'.$css_class.'"><tr><td>';
1221: #
1222: # Make the faq and bug data cascade
1223: my $faq = '';
1224: my $bug = '';
1225: my $help='';
1226: # The last breadcrumb does not have a link, so handle it separately.
1227: my $last = pop(@Crumbs);
1228: #
1229: # The first one should be the course or a menu link
1230: if (!defined($menulink)) { $menulink=1; }
1231: if ($menulink) {
1232: my $description = 'Menu';
1233: if (exists($env{'request.course.id'}) &&
1234: $env{'request.course.id'} ne '') {
1235: $description =
1236: $env{'course.'.$env{'request.course.id'}.'.description'};
1237: }
1238: unshift(@Crumbs,{
1239: href =>'/adm/menu',
1240: title =>'Go to main menu',
1241: target =>'_top',
1242: text =>$description,
1243: });
1244: }
1245: my $links .=
1246: join('->',
1247: map {
1248: $faq = $_->{'faq'} if (exists($_->{'faq'}));
1249: $bug = $_->{'bug'} if (exists($_->{'bug'}));
1250: $help = $_->{'help'} if (exists($_->{'help'}));
1251: my $result = '<a href="'.$_->{'href'}.'" ';
1252: if (defined($_->{'target'}) && $_->{'target'} ne '') {
1253: $result .= 'target="'.$_->{'target'}.'" ';
1254: }
1255: $result .='title="'.&mt($_->{'title'}).'">'.
1256: &mt($_->{'text'}).'</a>';
1257: $result;
1258: } @Crumbs
1259: );
1260: $links .= '->' if ($links ne '');
1261: $links .= '<b>'.&mt($last->{'text'}).'</b>';
1262: #
1263: my $icons = '';
1264: $faq = $last->{'faq'} if (exists($last->{'faq'}));
1265: $bug = $last->{'bug'} if (exists($last->{'bug'}));
1266: $help = $last->{'help'} if (exists($last->{'help'}));
1267: $component_help=($component_help?$component_help:$help);
1268: # if ($faq ne '') {
1269: # $icons .= &Apache::loncommon::help_open_faq($faq);
1270: # }
1271: # if ($bug ne '') {
1272: # $icons .= &Apache::loncommon::help_open_bug($bug);
1273: # }
1274: if ($faq ne '' || $component_help ne '' || $bug ne '') {
1275: $icons .= &Apache::loncommon::help_open_menu($component,
1276: $component_help,
1277: $faq,$bug);
1278: }
1279: #
1280: $Str .= $links.'</td>';
1281: #
1282: if (defined($component)) {
1283: $Str .= '<td class="'.$css_class.'_component">'.
1284: &mt($component);
1285: if ($icons ne '') {
1286: $Str .= ' '.$icons;
1287: }
1288: $Str .= '</td>';
1289: }
1290: $Str .= '</tr></table>'."\n";
1291: #
1292: # Return the @Crumbs stack to what we started with
1293: push(@Crumbs,$last);
1294: shift(@Crumbs);
1295: #
1296: return $Str;
1297: }
1298:
1299: sub clear_breadcrumbs {
1300: undef(@Crumbs);
1301: }
1302:
1303: sub add_breadcrumb {
1304: push (@Crumbs,@_);
1305: }
1306:
1307: } # End of scope for @Crumbs
1308:
1309: ############################################################
1310: ############################################################
1311:
1312: # Nested table routines.
1313: #
1314: # Routines to display form items in a multi-row table with 2 columns.
1315: # Uses nested tables to divide form elements into segments.
1316: # For examples of use see loncom/interface/lonnotify.pm
1317: #
1318: # Can be used in following order: ...
1319: # &start_pick_box()
1320: # row1
1321: # row2
1322: # row3 ... etc.
1323: # &submit_row(0
1324: # &end_pickbox()
1325: #
1326: # where row1, row 2 etc. are chosen from &role_select_row,&course_select_row,
1327: # &status_select_row and &email_default_row
1328: #
1329: # Can also be used in following order:
1330: #
1331: # &start_pick_box()
1332: # &row_title()
1333: # &row_closure()
1334: # &row_title()
1335: # &row_closure() ... etc.
1336: # &submit_row()
1337: # &end_pick_box()
1338: #
1339: # In general a &submit_row() call should proceed the call to &end_pick_box(),
1340: # as this routine adds a button for form submission.
1341: # &submit_row() does not require a &row_closure after it.
1342: #
1343: # &start_pick_box() creates a bounding table with 1-pixel wide black border.
1344: # rows should be placed between calls to &start_pick_box() and &end_pick_box.
1345: #
1346: # &row_title() adds a title in the left column for each segment.
1347: # &row_closure() closes a row with a 1-pixel wide black line.
1348: #
1349: # &role_select_row() provides a select box from which to choose 1 or more roles
1350: # &course_select_row provides ways of picking groups of courses
1351: # radio buttons: all, by category or by picking from a course picker pop-up
1352: # note: by category option is only displayed if a domain has implemented
1353: # selection by year, semester, department, number etc.
1354: #
1355: # &status_select_row() provides a select box from which to choose 1 or more
1356: # access types (current access, prior access, and future access)
1357: #
1358: # &email_default_row() provides text boxes for default e-mail suffixes for
1359: # different authentication types in a domain.
1360: #
1361: # &row_title() and &row_closure() are called internally by the &*_select_row
1362: # routines, but can also be called directly to start and end rows which have
1363: # needs that are not accommodated by the *_select_row() routines.
1364:
1365: sub start_pick_box {
1366: my ($css_class) = @_;
1367: if (defined($css_class)) {
1368: $css_class = 'class="'.$css_class.'"';
1369: } else {
1370: $css_class= 'class="LC_pick_box"';
1371: }
1372: my $output = <<"END";
1373: <table $css_class>
1374: END
1375: return $output;
1376: }
1377:
1378: sub end_pick_box {
1379: my $output = <<"END";
1380: </table>
1381: END
1382: return $output;
1383: }
1384:
1385: sub row_title {
1386: my ($title,$css_title_class,$css_value_class) = @_;
1387: $css_title_class ||= 'LC_pick_box_title';
1388: $css_title_class = 'class="'.$css_title_class.'"';
1389:
1390: $css_value_class ||= 'LC_pick_box_value';
1391: $css_value_class = 'class="'.$css_value_class.'"';
1392:
1393: my $output = <<"ENDONE";
1394: <tr class="LC_pick_box_row">
1395: <td $css_title_class>
1396: $title:
1397: </td>
1398: <td $css_value_class>
1399: ENDONE
1400: return $output;
1401: }
1402:
1403: sub row_closure {
1404: my ($no_separator) =@_;
1405: my $output = <<"ENDTWO";
1406: </td>
1407: </tr>
1408: ENDTWO
1409: if (!$no_separator) {
1410: $output .= <<"ENDTWO";
1411: <tr>
1412: <td colspan="2" class="LC_pick_box_separator">
1413: </td>
1414: </tr>
1415: ENDTWO
1416: }
1417: return $output;
1418: }
1419:
1420: sub role_select_row {
1421: my ($roles,$title,$css_class,$show_separate_custom,$cdom,$cnum) = @_;
1422: my $output;
1423: if (defined($title)) {
1424: $output = &row_title($title,$css_class);
1425: }
1426: $output .= qq|
1427: <select name="roles" multiple >\n|;
1428: foreach my $role (@$roles) {
1429: my $plrole;
1430: if ($role eq 'ow') {
1431: $plrole = &mt('Course Owner');
1432: } elsif ($role eq 'cr') {
1433: if ($show_separate_custom) {
1434: if ($cdom ne '' && $cnum ne '') {
1435: my %course_customroles = &course_custom_roles($cdom,$cnum);
1436: foreach my $crrole (sort(keys(%course_customroles))) {
1437: my ($plcrrole) = ($crrole =~ m|^cr/[^/]+/[^/]+/(.+)$|);
1438: $output .= ' <option value="'.$crrole.'">'.$plcrrole.
1439: '</option>';
1440: }
1441: }
1442: } else {
1443: $plrole = &mt('Custom Role');
1444: }
1445: } else {
1446: $plrole=&Apache::lonnet::plaintext($role);
1447: }
1448: if (($role ne 'cr') || (!$show_separate_custom)) {
1449: $output .= ' <option value="'.$role.'">'.$plrole.'</option>';
1450: }
1451: }
1452: $output .= qq| </select>\n|;
1453: if (defined($title)) {
1454: $output .= &row_closure();
1455: }
1456: return $output;
1457: }
1458:
1459: sub course_select_row {
1460: my ($title,$formname,$totcodes,$codetitles,$idlist,$idlist_titles,
1461: $css_class) = @_;
1462: my $output = &row_title($title,$css_class);
1463: $output .= qq|
1464: <script type="text/javascript">
1465: function coursePick (formname) {
1466: for (var i=0; i<formname.coursepick.length; i++) {
1467: if (formname.coursepick[i].value == 'category') {
1468: courseSet('');
1469: }
1470: if (!formname.coursepick[i].checked) {
1471: if (formname.coursepick[i].value == 'specific') {
1472: formname.coursetotal.value = 0;
1473: formname.courselist = '';
1474: }
1475: }
1476: }
1477: }
1478: function setPick (formname) {
1479: for (var i=0; i<formname.coursepick.length; i++) {
1480: if (formname.coursepick[i].value == 'category') {
1481: formname.coursepick[i].checked = true;
1482: }
1483: formname.coursetotal.value = 0;
1484: formname.courselist = '';
1485: }
1486: }
1487: </script>
1488: |;
1489: my $courseform='<b>'.&Apache::loncommon::selectcourse_link
1490: ($formname,'pickcourse','pickdomain','coursedesc','',1).'</b>';
1491: $output .= '<input type="radio" name="coursepick" value="all" onclick="coursePick(this.form)" />'.&mt('All courses').'<br />';
1492: if ($totcodes > 0) {
1493: my $numtitles = @$codetitles;
1494: if ($numtitles > 0) {
1495: $output .= '<input type="radio" name="coursepick" value="category" onclick="coursePick(this.form);alert('."'".&mt('Choose categories, from left to right')."'".')" />'.&mt('Pick courses by category:').' <br />';
1496: $output .= '<table><tr><td>'.$$codetitles[0].'<br />'."\n".
1497: '<select name="'.$$codetitles[0].
1498: '" onChange="setPick(this.form);courseSet('."'$$codetitles[0]'".')">'."\n".
1499: ' <option value="-1" />Select'."\n";
1500: my @items = ();
1501: my @longitems = ();
1502: if ($$idlist{$$codetitles[0]} =~ /","/) {
1503: @items = split(/","/,$$idlist{$$codetitles[0]});
1504: } else {
1505: $items[0] = $$idlist{$$codetitles[0]};
1506: }
1507: if (defined($$idlist_titles{$$codetitles[0]})) {
1508: if ($$idlist_titles{$$codetitles[0]} =~ /","/) {
1509: @longitems = split(/","/,$$idlist_titles{$$codetitles[0]});
1510: } else {
1511: $longitems[0] = $$idlist_titles{$$codetitles[0]};
1512: }
1513: for (my $i=0; $i<@longitems; $i++) {
1514: if ($longitems[$i] eq '') {
1515: $longitems[$i] = $items[$i];
1516: }
1517: }
1518: } else {
1519: @longitems = @items;
1520: }
1521: for (my $i=0; $i<@items; $i++) {
1522: $output .= ' <option value="'.$items[$i].'">'.$longitems[$i].'</option>';
1523: }
1524: $output .= '</select></td>';
1525: for (my $i=1; $i<$numtitles; $i++) {
1526: $output .= '<td>'.$$codetitles[$i].'<br />'."\n".
1527: '<select name="'.$$codetitles[$i].
1528: '" onChange="courseSet('."'$$codetitles[$i]'".')">'."\n".
1529: '<option value="-1"><-Pick '.$$codetitles[$i-1].'</option>'."\n".
1530: '</select>'."\n".
1531: '</td>';
1532: }
1533: $output .= '</tr></table><br />';
1534: }
1535: }
1536: $output .= '<input type="radio" name="coursepick" value="specific" onclick="coursePick(this.form);opencrsbrowser('."'".$formname."'".','."'".'dccourse'."'".','."'".'dcdomain'."'".','."'".'coursedesc'."','','1'".')" />'.&mt('Pick specific course(s):').' '.$courseform.' <input type="text" value="0" size="4" name="coursetotal" /><input type="hidden" name="courselist" value="" />selected.<br />'."\n";
1537: $output .= &row_closure();
1538: return $output;
1539: }
1540:
1541: sub status_select_row {
1542: my ($types,$title,$css_class) = @_;
1543: my $output;
1544: if (defined($title)) {
1545: $output = &row_title($title,$css_class,'LC_pick_box_select');
1546: }
1547: $output .= qq|
1548: <select name="types" multiple>\n|;
1549: foreach my $status_type (sort(keys(%{$types}))) {
1550: $output .= ' <option value="'.$status_type.'">'.$$types{$status_type}.'</option>';
1551: }
1552: $output .= qq| </select>\n|;
1553: if (defined($title)) {
1554: $output .= &row_closure();
1555: }
1556: return $output;
1557: }
1558:
1559: sub email_default_row {
1560: my ($authtypes,$title,$descrip,$css_class) = @_;
1561: my $output = &row_title($title,$css_class);
1562: my @rowcols = ('#eeeeee','#dddddd');
1563: $output .= $descrip.
1564: &Apache::loncommon::start_data_table().
1565: &Apache::loncommon::start_data_table_header_row().
1566: '<th>'.&mt('Authentication Method').'</th>'.
1567: '<th align="right">'.&mt('Username -> e-mail conversion').'</th>'."\n".
1568: &Apache::loncommon::end_data_table_header_row();
1569: my $rownum = 0;
1570: foreach my $auth (sort(keys(%{$authtypes}))) {
1571: my ($userentry,$size);
1572: if ($auth =~ /^krb/) {
1573: $userentry = '';
1574: $size = 25;
1575: } else {
1576: $userentry = 'username@';
1577: $size = 15;
1578: }
1579: $output .= &Apache::loncommon::start_data_table_row().
1580: '<td> '.$$authtypes{$auth}.'</td>'.
1581: '<td align="right">'.$userentry.
1582: '<input type="text" name="'.$auth.'" size="'.$size.'" /></td>'.
1583: &Apache::loncommon::end_data_table_row();
1584: }
1585: $output .= &Apache::loncommon::end_data_table();
1586: $output .= &row_closure();
1587: return $output;
1588: }
1589:
1590:
1591: sub submit_row {
1592: my ($title,$cmd,$submit_text,$css_class) = @_;
1593: my $output = &row_title($title,$css_class,'LC_pick_box_submit');
1594: $output .= qq|
1595: <br />
1596: <input type="hidden" name="command" value="$cmd" />
1597: <input type="submit" value="$submit_text"/>
1598: <br /><br />
1599: \n|;
1600: return $output;
1601: }
1602:
1603: sub course_custom_roles {
1604: my ($cdom,$cnum) = @_;
1605: my %returnhash=();
1606: my %coursepersonnel=&Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
1607: foreach my $person (sort(keys(%coursepersonnel))) {
1608: my ($role) = ($person =~ /^([^:]+):/);
1609: my ($end,$start) = split(/:/,$coursepersonnel{$person});
1610: if ($end == -1 && $start == -1) {
1611: next;
1612: }
1613: if ($role =~ m|^cr/[^/]+/[^/]+/[^/]|) {
1614: $returnhash{$role} ++;
1615: }
1616: }
1617: return %returnhash;
1618: }
1619:
1620:
1621: ##############################################
1622: ##############################################
1623:
1624: # echo_form_input
1625: #
1626: # Generates html markup to add form elements from the referrer page
1627: # as hidden form elements (values encoded) in the new page.
1628: #
1629: # Intended to support two types of use
1630: # (a) to allow backing up to earlier pages in a multi-page
1631: # form submission process using a breadcrumb trail.
1632: #
1633: # (b) to allow the current page to be reloaded with form elements
1634: # set on previous page to remain unchanged. An example would
1635: # be where the a page containing a dynamically-built table of data is
1636: # is to be redisplayed, with only the sort order of the data changed.
1637: #
1638: # Inputs:
1639: # 1. Reference to array of form elements in the submitted form on
1640: # the referrer page which are to be excluded from the echoed elements.
1641: #
1642: # 2. Reference to array of regular expressions, which if matched in the
1643: # name of the form element n the referrer page will be omitted from echo.
1644: #
1645: # Outputs: A scalar containing the html markup for the echoed form
1646: # elements (all as hidden elements, with values encoded).
1647:
1648:
1649: sub echo_form_input {
1650: my ($excluded,$regexps) = @_;
1651: my $output = '';
1652: foreach my $key (keys(%env)) {
1653: if ($key =~ /^form\.(.+)$/) {
1654: my $name = $1;
1655: my $match = 0;
1656: if ((!@{$excluded}) || (!grep/^$name$/,@{$excluded})) {
1657: if (defined($regexps)) {
1658: if (@{$regexps} > 0) {
1659: foreach my $regexp (@{$regexps}) {
1660: if ($name =~ /\Q$regexp\E/) {
1661: $match = 1;
1662: last;
1663: }
1664: }
1665: }
1666: }
1667: if (!$match) {
1668: if (ref($env{$key})) {
1669: foreach my $value (@{$env{$key}}) {
1670: $value = &HTML::Entities::encode($value,'<>&"');
1671: $output .= '<input type="hidden" name="'.$name.
1672: '" value="'.$value.'" />'."\n";
1673: }
1674: } else {
1675: my $value = &HTML::Entities::encode($env{$key},'<>&"');
1676: $output .= '<input type="hidden" name="'.$name.
1677: '" value="'.$value.'" />'."\n";
1678: }
1679: }
1680: }
1681: }
1682: }
1683: return $output;
1684: }
1685:
1686: ##############################################
1687: ##############################################
1688:
1689: # set_form_elements
1690: #
1691: # Generates javascript to set form elements to values based on
1692: # corresponding values for the same form elements when the page was
1693: # previously submitted.
1694: #
1695: # Last submission values are read from hidden form elements in referring
1696: # page which have the same name, i.e., generated by &echo_form_input().
1697: #
1698: # Intended to be called by onload event.
1699: #
1700: # Inputs:
1701: # (a) Reference to hash of echoed form elements to be set.
1702: #
1703: # In the hash, keys are the form element names, and the values are the
1704: # element type (selectbox, radio, checkbox or text -for textbox, textarea or
1705: # hidden).
1706: #
1707: # (b) Optional reference to hash of stored elements to be set.
1708: #
1709: # If the page being displayed is a page which permits modification of
1710: # previously stored data, e.g., the first page in a multi-page submission,
1711: # then if stored is supplied, form elements will be set to the last stored
1712: # values. If user supplied values are also available for the same elements
1713: # these will replace the stored values.
1714: #
1715: # Output:
1716: #
1717: # javascript function - set_form_elements() which sets form elements,
1718: # expects an argument: formname - the name of the form according to
1719: # the DOM, e.g., document.compose
1720:
1721: sub set_form_elements {
1722: my ($elements,$stored) = @_;
1723: my %values;
1724: my $output .= 'function setFormElements(courseForm) {
1725: ';
1726: if (defined($stored)) {
1727: foreach my $name (keys(%{$stored})) {
1728: if (exists($$elements{$name})) {
1729: if (ref($$stored{$name}) eq 'ARRAY') {
1730: $values{$name} = $$stored{$name};
1731: } else {
1732: @{$values{$name}} = ($$stored{$name});
1733: }
1734: }
1735: }
1736: }
1737:
1738: foreach my $key (keys(%env)) {
1739: if ($key =~ /^form\.(.+)$/) {
1740: my $name = $1;
1741: if (exists($$elements{$name})) {
1742: @{$values{$name}} = &Apache::loncommon::get_env_multiple($key);
1743: }
1744: }
1745: }
1746:
1747: foreach my $name (keys(%values)) {
1748: for (my $i=0; $i<@{$values{$name}}; $i++) {
1749: $values{$name}[$i] = &HTML::Entities::decode($values{$name}[$i],'<>&"');
1750: $values{$name}[$i] =~ s/([\r\n\f]+)/\\n/g;
1751: $values{$name}[$i] =~ s/"/\\"/g;
1752: }
1753: if ($$elements{$name} eq 'text') {
1754: my $numvalues = @{$values{$name}};
1755: if ($numvalues > 1) {
1756: my $valuestring = join('","',@{$values{$name}});
1757: $output .= qq|
1758: var textvalues = new Array ("$valuestring");
1759: var total = courseForm.elements['$name'].length;
1760: if (total > $numvalues) {
1761: total = $numvalues;
1762: }
1763: for (var i=0; i<total; i++) {
1764: courseForm.elements['$name']\[i].value = textvalues[i];
1765: }
1766: |;
1767: } else {
1768: $output .= qq|
1769: courseForm.elements['$name'].value = "$values{$name}[0]";
1770: |;
1771: }
1772: } else {
1773: $output .= qq|
1774: var elementLength = courseForm.elements['$name'].length;
1775: if (elementLength==undefined) {
1776: |;
1777: foreach my $value (@{$values{$name}}) {
1778: if ($$elements{$name} eq 'selectbox') {
1779: $output .= qq|
1780: if (courseForm.elements['$name'].options[0].value == "$value") {
1781: courseForm.elements['$name'].options[0].selected = true;
1782: }|;
1783: } elsif (($$elements{$name} eq 'radio') ||
1784: ($$elements{$name} eq 'checkbox')) {
1785: $output .= qq|
1786: if (courseForm.elements['$name'].value == "$value") {
1787: courseForm.elemenst['$name'].checked = true;
1788: }|;
1789: }
1790: }
1791: $output .= qq|
1792: }
1793: else {
1794: for (var i=0; i<courseForm.elements['$name'].length; i++) {
1795: |;
1796: if ($$elements{$name} eq 'selectbox') {
1797: $output .= qq|
1798: courseForm.elements['$name'].options[i].selected = false;|;
1799: } elsif (($$elements{$name} eq 'radio') ||
1800: ($$elements{$name} eq 'checkbox')) {
1801: $output .= qq|
1802: courseForm.elements['$name']\[i].checked = false;|;
1803: }
1804: $output .= qq|
1805: }
1806: for (var j=0; j<courseForm.elements['$name'].length; j++) {
1807: |;
1808: foreach my $value (@{$values{$name}}) {
1809: if ($$elements{$name} eq 'selectbox') {
1810: $output .= qq|
1811: if (courseForm.elements['$name'].options[j].value == "$value") {
1812: courseForm.elements['$name'].options[j].selected = true;
1813: }|;
1814: } elsif (($$elements{$name} eq 'radio') ||
1815: ($$elements{$name} eq 'checkbox')) {
1816: $output .= qq|
1817: if (courseForm.elements['$name']\[j].value == "$value") {
1818: courseForm.elements['$name']\[j].checked = true;
1819: }|;
1820: }
1821: }
1822: $output .= qq|
1823: }
1824: }
1825: |;
1826: }
1827: }
1828: $output .= "
1829: }\n";
1830: return $output;
1831: }
1832:
1833: 1;
1834:
1835: __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