--- loncom/interface/lonhtmlcommon.pm 2005/06/03 15:47:29 1.106 +++ loncom/interface/lonhtmlcommon.pm 2006/07/03 01:02:32 1.139 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # a pile of common html routines # -# $Id: lonhtmlcommon.pm,v 1.106 2005/06/03 15:47:29 www Exp $ +# $Id: lonhtmlcommon.pm,v 1.139 2006/07/03 01:02:32 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -60,6 +60,8 @@ use Time::Local; use Time::HiRes; use Apache::lonlocal; use Apache::lonnet; +use lib '/home/httpd/lib/perl/'; +use LONCAPA; ############################################## ############################################## @@ -93,29 +95,35 @@ sub authorbombs { sub recent_filename { my $area=shift; - return 'nohist_recent_'.&Apache::lonnet::escape($area); + return 'nohist_recent_'.&escape($area); } sub store_recent { - my ($area,$name,$value)=@_; + my ($area,$name,$value,$freeze)=@_; my $file=&recent_filename($area); my %recent=&Apache::lonnet::dump($file); - if (scalar(keys(%recent))>10) { + if (scalar(keys(%recent))>20) { # remove oldest value - my $oldest=time; + my $oldest=time(); my $delkey=''; - foreach (keys %recent) { - my $thistime=(split(/\&/,$recent{$_}))[0]; - if ($thistime<$oldest) { + foreach my $item (keys(%recent)) { + my $thistime=(split(/\&/,$recent{$item}))[0]; + if (($thistime ne "always_include") && ($thistime<$oldest)) { $oldest=$thistime; - $delkey=$_; + $delkey=$item; } } &Apache::lonnet::del($file,[$delkey]); } # store new value + my $timestamp; + if ($freeze) { + $timestamp = "always_include"; + } else { + $timestamp = time(); + } &Apache::lonnet::put($file,{ $name => - time.'&'.&Apache::lonnet::escape($value) }); + $timestamp.'&'.&escape($value) }); } sub remove_recent { @@ -130,11 +138,11 @@ sub select_recent { my $return="\n'; return $Str; @@ -207,6 +237,28 @@ sub checkbox { return $Str; } + +=pod + +=item radiobutton + +=cut + +############################################## +############################################## +sub radio { + my ($name,$checked,$value) = @_; + my $Str = ' + ENDJS - $result .= ' '; + $result .= ' '; my $monthselector = qq{\n"; my $minuteselector = qq{}; my $secondselector= qq{}; - my $cal_link = qq{}; + my $cal_link; + if (!$nolink) { + $cal_link = qq{}; + } # if ($no_hh_mm_ss) { - $result .= &mt('[_1] [_2] [_3] [_4]Select Date[_5]', - $monthselector,$dayselector,$yearselector, - $cal_link,''); + $result .= &mt('[_1] [_2] [_3] ', + $monthselector,$dayselector,$yearselector); + if (!$nolink) { + $result .= &mt('[_4]Select Date[_5]',$cal_link,''); + } } else { - $result .= &mt('[_1] [_2] [_3] [_4] [_5]m [_6]s [_7]Select Date[_8]', - $monthselector,$dayselector,$yearselector, - $hourselector,$minuteselector,$secondselector, - $cal_link,''); + $result .= &mt('[_1] [_2] [_3] [_4] [_5]m [_6]s ', + $monthselector,$dayselector,$yearselector, + $hourselector,$minuteselector,$secondselector); + if (!$nolink) { + $result .= &mt('[_7]Select Date[_8]',$cal_link,''); + } } - $result .= "\n\n"; + $result .= "\n\n"; return $result; } @@ -483,7 +561,7 @@ sub get_date_from_form { if (($year<70) || ($year>137)) { return undef; } if (defined($sec) && defined($min) && defined($hour) && defined($day) && defined($month) && defined($year) && - eval(&timelocal($sec,$min,$hour,$day,$month,$year))) { + eval('&timelocal($sec,$min,$hour,$day,$month,$year)')) { return &timelocal($sec,$min,$hour,$day,$month,$year); } else { return undef; @@ -506,11 +584,13 @@ parameter setting wizard. ############################################## sub pjump_javascript_definition { my $Str = < 1, + 'bgcolor' => '#88DDFF', + 'js_ready' => 1}); + my $end_page = &Apache::loncommon::end_page({'js_ready' => 1}); + #the whole function called through timeout is due to issues #in mozilla Read BUG #2665 if you want to know the whole story - &r_print($r,'"); $prog_state{'formname'}='popremain'; @@ -897,7 +982,7 @@ sub r_print { # ------------------------------------------------------- Puts directory header sub crumbs { - my ($uri,$target,$prefix,$form,$size,$noformat)=@_; + my ($uri,$target,$prefix,$form,$size,$noformat,$skiplast)=@_; if (! defined($size)) { $size = '+2'; } @@ -913,7 +998,14 @@ sub crumbs { foreach my $dir (split('/',$uri)) { if (! $dir) { next; } $path .= $dir; - unless ($path eq $uri) { $path.='/'; } + if ($path eq $uri) { + if ($skiplast) { + $output.=$dir; + last; + } + } else { + $path.='/'; + } my $linkpath = &Apache::loncommon::escape_single($path); if ($form) { $linkpath= @@ -931,7 +1023,14 @@ sub crumbs { # --------------------- A function that generates a window for the spellchecker sub spellheader { - my $html=&Apache::lonxml::xmlbegin(); + my $start_page= + &Apache::loncommon::start_page('Speller Suggestions',undef, + {'only_body' => 1, + 'js_ready' => 1, + 'bgcolor' => '#DDDDDD',}); + my $end_page= + &Apache::loncommon::end_page({'js_ready' => 1}); + my $nothing=&javascript_nothing(); return (< @@ -940,7 +1039,7 @@ var checkwin; function spellcheckerwindow() { checkwin=window.open($nothing,'spellcheckwin','height=320,width=280,resizable=yes,scrollbars=yes,location=no,menubar=no,toolbar=no'); - checkwin.document.writeln('$html
'); + checkwin.document.writeln('$start_page
<\/form>$end_page'); checkwin.document.close(); } // END LON-CAPA Internal --> @@ -960,6 +1059,22 @@ ENDLINK # ------------------------------------------------- Output headers for HTMLArea +{ + my @htmlareafields; + sub init_htmlareafields { + undef(@htmlareafields); + } + + sub add_htmlareafields { + my (@newfields) = @_; + push(@htmlareafields,@newfields); + } + + sub get_htmlareafields { + return @htmlareafields; + } +} + sub htmlareaheaders { if (&htmlareablocked()) { return ''; } unless (&htmlareabrowser()) { return ''; } @@ -1007,7 +1122,7 @@ sub disablelink { if (defined($#fields)) { unless ($#fields>=0) { return ''; } } - return ''.&mt('Disable WYSIWYG Editor').''; + return ''.&mt('Disable WYSIWYG Editor').''; } sub enablelink { @@ -1015,7 +1130,7 @@ sub enablelink { if (defined($#fields)) { unless ($#fields>=0) { return ''; } } - return ''.&mt('Enable WYSIWYG Editor').''; + return ''.&mt('Enable WYSIWYG Editor').''; } # ----------------------------------------- Script to activate only some fields @@ -1063,13 +1178,11 @@ A link to help for the component will be All inputs can be undef without problems. -Inputs: $color (the background color of the table returned), - $component (the large text on the right side of the table), +Inputs: $component (the large text on the right side of the table), $component_help - $function (role to get colors from) - $domain (domian of role) $menulink (boolean, controls whether to include a link to /adm/menu) - + $helplink (if 'nohelp' don't include the orange help link) + $css_class (optional name for the class to apply to the table for CSS) Returns a string containing breadcrumbs for the current page. =item clear_breadcrumbs @@ -1094,20 +1207,10 @@ returns: nothing my @Crumbs; sub breadcrumbs { - my ($color,$component,$component_help,$function,$domain,$menulink, - $helplink) = @_; - if (! defined($color)) { - if (! defined($function)) { - $function = &Apache::loncommon::get_users_function(); - } - $color = &Apache::loncommon::designparm($function.'.tabbg', - $domain); - } + my ($component,$component_help,$menulink,$helplink,$css_class) = @_; # - my $Str = "\n". - ''. - ' + + + + + + +ENDTWO + return $output; +} + +sub role_select_row { + my ($roles,$col_width,$tablecolor,$title) = @_; + my $output; + if (defined($title)) { + $output = &row_title($col_width,$tablecolor,$title); + } + $output .= qq| \n|; + if (defined($title)) { + $output .= &row_closure(); + } + return $output; +} + +sub course_select_row { + my ($col_width,$tablecolor,$title,$formname,$totcodes,$codetitles,$idlist,$idlist_titles) = @_; + my $output = &row_title($col_width,$tablecolor,$title); + $output .= " '."\n"; + $output .= &row_closure(); + return $output; +} + +sub status_select_row { + my ($types,$col_width,$tablecolor,$title) = @_; + my $output; + if (defined($title)) { + $output = &row_title($col_width,$tablecolor,$title); + } + $output .= qq| \n|; + if (defined($title)) { + $output .= &row_closure(); + } + return $output; +} + +sub email_default_row { + my ($authtypes,$col_width,$tablecolor,$title,$descrip) = @_; + my $output = &row_title($col_width,$tablecolor,$title); + my @rowcols = ('#eeeeee','#dddddd'); + $output .= ' + + '."\n"; + my $rownum = 0; + foreach my $auth (sort(keys(%{$authtypes}))) { + my ($userentry,$size); + my $rowiter = $rownum%2; + if ($auth =~ /^krb/) { + $userentry = ''; + $size = 25; + } else { + $userentry = 'username@'; + $size = 15; + } + $output .= ''; + $rownum ++; + } + $output .= &end_pick_box(); + $output .= "
\n"; + $output .= &row_closure(); + return $output; +} + + +sub submit_row { + my ($col_width,$tablecolor,$title,$cmd,$submit_text) = @_; + my $output = &row_title($col_width,$tablecolor,$title); + $output .= qq| + \n|; + return $output; +} + +############################################## +############################################## + +# echo_form_input +# +# Generates html markup to add form elements from the referrer page +# as hidden form elements (values encoded) in the new page. +# +# Intended to support two types of use +# (a) to allow backing up to earlier pages in a multi-page +# form submission process using a breadcrumb trail. +# +# (b) to allow the current page to be reloaded with form elements +# set on previous page to remain unchanged. An example would +# be where the a page containing a dynamically-built table of data is +# is to be redisplayed, with only the sort order of the data changed. +# +# Inputs: +# 1. Reference to array of form elements in the submitted form on +# the referrer page which are to be excluded from the echoed elements. +# +# 2. Reference to array of regular expressions, which if matched in the +# name of the form element n the referrer page will be omitted from echo. +# +# Outputs: A scalar containing the html markup for the echoed form +# elements (all as hidden elements, with values encoded). + + +sub echo_form_input { + my ($excluded,$regexps) = @_; + my $output = ''; + foreach my $key (keys(%env)) { + if ($key =~ /^form\.(.+)$/) { + my $name = $1; + my $match = 0; + if ((!@{$excluded}) || (!grep/^$name$/,@{$excluded})) { + if (defined($regexps)) { + if (@{$regexps} > 0) { + foreach my $regexp (@{$regexps}) { + if ($name =~ /\Q$regexp\E/) { + $match = 1; + last; + } + } + } + } + if (!$match) { + if (ref($env{$key})) { + foreach my $value (@{$env{$key}}) { + $value = &HTML::Entities::encode($value,'<>&"'); + $output .= ''."\n"; + } + } else { + my $value = &HTML::Entities::encode($env{$key},'<>&"'); + $output .= ''."\n"; + } + } + } + } + } + return $output; +} + +############################################## +############################################## + +# set_form_elements +# +# Generates javascript to set form elements to values based on +# corresponding values for the same form elements when the page was +# previously submitted. +# +# Last submission values are read from hidden form elements in referring +# page which have the same name, i.e., generated by &echo_form_input(). +# +# Intended to be called by onload event. +# +# Inputs: +# (a) Reference to hash of echoed form elements to be set. +# +# In the hash, keys are the form element names, and the values are the +# element type (selectbox, radio, checkbox or text -for textbox, textarea or +# hidden). +# +# (b) Optional reference to hash of stored elements to be set. +# +# If the page being displayed is a page which permits modification of +# previously stored data, e.g., the first page in a multi-page submission, +# then if stored is supplied, form elements will be set to the last stored +# values. If user supplied values are also available for the same elements +# these will replace the stored values. +# +# Output: +# +# javascript function - set_form_elements() which sets form elements, +# expects an argument: formname - the name of the form according to +# the DOM, e.g., document.compose + +sub set_form_elements { + my ($elements,$stored) = @_; + my %values; + my $output .= 'function setFormElements(courseForm) { +'; + if (defined($stored)) { + foreach my $name (keys(%{$stored})) { + if (exists($$elements{$name})) { + if (ref($$stored{$name}) eq 'ARRAY') { + $values{$name} = $$stored{$name}; + } else { + @{$values{$name}} = ($$stored{$name}); + } + } + } + } + + foreach my $key (keys(%env)) { + if ($key =~ /^form\.(.+)$/) { + my $name = $1; + if (exists($$elements{$name})) { + @{$values{$name}} = &Apache::loncommon::get_env_multiple($key); + } + } + } + + foreach my $name (keys(%values)) { + for (my $i=0; $i<@{$values{$name}}; $i++) { + $values{$name}[$i] = &HTML::Entities::decode($values{$name}[$i],'<>&"'); + $values{$name}[$i] =~ s/([\r\n\f]+)/\\n/g; + $values{$name}[$i] =~ s/"/\\"/g; + } + if ($$elements{$name} eq 'text') { + my $numvalues = @{$values{$name}}; + if ($numvalues > 1) { + my $valuestring = join('","',@{$values{$name}}); + $output .= qq| + var textvalues = new Array ("$valuestring"); + var total = courseForm.$name.length; + if (total > $numvalues) { + total = $numvalues; + } + for (var i=0; i
'. - ''; + $css_class ||= 'LC_breadcrumbs'; + my $Str = "\n".''; + $Str .= $links.''; # if (defined($component)) { - $Str .= ''; + $Str .= ''; } $Str .= '
'; # # Make the faq and bug data cascade my $faq = ''; @@ -1162,17 +1265,19 @@ returns: nothing # $icons .= &Apache::loncommon::help_open_bug($bug); # } if ($helplink ne 'nohelp') { - $icons .= &Apache::loncommon::help_open_menu($color,$component,$component_help,$function,$faq,$bug); + $icons .= &Apache::loncommon::help_open_menu($component, + $component_help, + $faq,$bug); } if ($icons ne '') { $Str .= $icons.' '; } # - $Str .= $links.''. - ''.&mt($component).''. + &mt($component).'
'."\n"; # @@ -1196,6 +1301,500 @@ returns: nothing ############################################################ ############################################################ +# Nested table routines. +# +# Routines to display form items in a multi-row table with 2 columns. +# Uses nested tables to divide form elements into segments. +# For examples of use see loncom/interface/lonnotify.pm +# +# Can be used in following order: ... +# &start_pick_box() +# row1 +# row2 +# row3 ... etc. +# &submit_row(0 +# &end_pickbox() +# +# where row1, row 2 etc. are chosen from &role_select_row,&course_select_row, +# &status_select_row and &email_default_row +# +# Can also be used in following order: +# +# &start_pick_box() +# &row_title() +# &row_closure() +# &row_title() +# &row_closure() ... etc. +# &submit_row() +# &end_pick_box() +# +# In general a &submit_row() call should proceed the call to &end_pick_box(), +# as this routine adds a button for form submission. +# &submit_row() does not require a &row_closure after it. +# +# &start_pick_box() creates a bounding table with 1-pixel wide black border. +# rows should be placed between calls to &start_pick_box() and &end_pick_box. +# +# &row_title() adds a title in the left column for each segment. +# &row_closure() closes a row with a 1-pixel wide black line. +# +# &role_select_row() provides a select box from which to choose 1 or more roles +# &course_select_row provides ways of picking groups of courses +# radio buttons: all, by category or by picking from a course picker pop-up +# note: by category option is only displayed if a domain has implemented +# selection by year, semester, department, number etc. +# +# &status_select_row() provides a select box from which to choose 1 or more +# access types (current access, prior access, and future access) +# +# &email_default_row() provides text boxes for default e-mail suffixes for +# different authentication types in a domain. +# +# &row_title() and &row_closure() are called internally by the &*_select_row +# routines, but can also be called directly to start and end rows which have +# needs that are not accommodated by the *_select_row() routines. + +sub start_pick_box { + my ($table_width) = @_; + my $output = <<"END"; + + + + +
+ + + + +
+ +END + return $output; +} + +sub end_pick_box { + my $output = <<"END"; +
+
+
+END + return $output; +} + +sub row_title { + my ($col_width,$tablecolor,$title) = @_; + my $output = <<"ENDONE"; +
+ + + + +
$title: +
+ 		+ + +ENDONE + return $output; +} + +sub row_closure { + my $output = <<"ENDTWO"; + +
+
+
+
+ + \n"; + $output .= qq| + + |; + my $courseform=''.&Apache::loncommon::selectcourse_link + ($formname,'pickcourse','pickdomain','coursedesc','',1).''; + $output .= ''.&mt('All courses').'
'; + if ($totcodes > 0) { + my $numtitles = @$codetitles; + if ($numtitles > 0) { + $output .= ''.&mt('Pick courses by category:').'
'; + $output .= ''; + for (my $i=1; $i<$numtitles; $i++) { + $output .= ''; + } + $output .= '
'.$$codetitles[0].'
'."\n". + '		'.$$codetitles[$i].'
'."\n". + ''."\n". + '

'; + } + } + $output .= ''.&mt('Pick specific course(s):').' '.$courseform.'  selected.
 + + '.$descrip; + $output .= &start_pick_box(''); + $output .= '
'.&mt('Authentication Method').''.&mt('Username -> e-mail conversion').'
'.$$authtypes{$auth}.''.$userentry.'
+
+ +   +

+