--- loncom/interface/lonhtmlcommon.pm 2004/07/03 18:49:42 1.79 +++ loncom/interface/lonhtmlcommon.pm 2005/10/13 18:31:06 1.113 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # a pile of common html routines # -# $Id: lonhtmlcommon.pm,v 1.79 2004/07/03 18:49:42 raeburn Exp $ +# $Id: lonhtmlcommon.pm,v 1.113 2005/10/13 18:31:06 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -55,10 +55,11 @@ html. package Apache::lonhtmlcommon; +use strict; use Time::Local; use Time::HiRes; use Apache::lonlocal; -use strict; +use Apache::lonnet; ############################################## ############################################## @@ -80,7 +81,7 @@ sub authorbombs { foreach (keys %bombs) { if ($_=~/^$udom\/$uname\//) { return ''. + '">'. &Apache::loncommon::help_open_topic('About_Bombs'); } } @@ -99,7 +100,7 @@ sub store_recent { my ($area,$name,$value)=@_; 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 $delkey=''; @@ -117,15 +118,22 @@ sub store_recent { time.'&'.&Apache::lonnet::escape($value) }); } +sub remove_recent { + my ($area,$names)=@_; + my $file=&recent_filename($area); + return &Apache::lonnet::del($file,$names); +} + sub select_recent { my ($area,$fieldname,$event)=@_; my %recent=&Apache::lonnet::dump(&recent_filename($area)); my $return="\n\n"; + $result .= ' '; + my $monthselector = qq{\n"; + $monthselector.= ' '; # Day - $result .= " \n"; + my $dayselector = qq{}; # Year - $result .= " \n"; - $result .= "  "; - if (! $no_hh_mm_ss) { - # Hours - $result .= " \n"; - $result .= " m\n"; - $result .= " s\n"; + my $yearselector = qq{}; + # + my $hourselector = qq{\n"; + my $minuteselector = qq{}; + my $secondselector= qq{}; + my $cal_link = qq{}; + # + if ($no_hh_mm_ss) { + $result .= &mt('[_1] [_2] [_3] [_4]Select Date[_5]', + $monthselector,$dayselector,$yearselector, + $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 .= "\n\n"; return $result; } @@ -406,8 +455,8 @@ sub get_date_from_form { my ($dname) = @_; my ($sec,$min,$hour,$day,$month,$year); # - if (defined($ENV{'form.'.$dname.'_second'})) { - my $tmpsec = $ENV{'form.'.$dname.'_second'}; + if (defined($env{'form.'.$dname.'_second'})) { + my $tmpsec = $env{'form.'.$dname.'_second'}; if (($tmpsec =~ /^\d+$/) && ($tmpsec >= 0) && ($tmpsec < 60)) { $sec = $tmpsec; } @@ -415,8 +464,8 @@ sub get_date_from_form { } else { $sec = 0; } - if (defined($ENV{'form.'.$dname.'_minute'})) { - my $tmpmin = $ENV{'form.'.$dname.'_minute'}; + if (defined($env{'form.'.$dname.'_minute'})) { + my $tmpmin = $env{'form.'.$dname.'_minute'}; if (($tmpmin =~ /^\d+$/) && ($tmpmin >= 0) && ($tmpmin < 60)) { $min = $tmpmin; } @@ -424,28 +473,28 @@ sub get_date_from_form { } else { $min = 0; } - if (defined($ENV{'form.'.$dname.'_hour'})) { - my $tmphour = $ENV{'form.'.$dname.'_hour'}; + if (defined($env{'form.'.$dname.'_hour'})) { + my $tmphour = $env{'form.'.$dname.'_hour'}; if (($tmphour =~ /^\d+$/) && ($tmphour >= 0) && ($tmphour < 24)) { $hour = $tmphour; } } else { $hour = 0; } - if (defined($ENV{'form.'.$dname.'_day'})) { - my $tmpday = $ENV{'form.'.$dname.'_day'}; + if (defined($env{'form.'.$dname.'_day'})) { + my $tmpday = $env{'form.'.$dname.'_day'}; if (($tmpday =~ /^\d+$/) && ($tmpday > 0) && ($tmpday < 32)) { $day = $tmpday; } } - if (defined($ENV{'form.'.$dname.'_month'})) { - my $tmpmonth = $ENV{'form.'.$dname.'_month'}; + if (defined($env{'form.'.$dname.'_month'})) { + my $tmpmonth = $env{'form.'.$dname.'_month'}; if (($tmpmonth =~ /^\d+$/) && ($tmpmonth > 0) && ($tmpmonth < 13)) { $month = $tmpmonth - 1; } } - if (defined($ENV{'form.'.$dname.'_year'})) { - my $tmpyear = $ENV{'form.'.$dname.'_year'}; + if (defined($env{'form.'.$dname.'_year'})) { + my $tmpyear = $env{'form.'.$dname.'_year'}; if (($tmpyear =~ /^\d+$/) && ($tmpyear > 1900)) { $year = $tmpyear - 1900; } @@ -476,11 +525,13 @@ parameter setting wizard. ############################################## sub pjump_javascript_definition { my $Str = <'. "var popwin; function openpopwin () { popwin=open(\'\',\'popwin\',\'width=400,height=100\');". - "popwin.document.writeln(\'$title". + "popwin.document.writeln(\'".$html."$title". "". "

$heading

". "
". @@ -772,20 +845,24 @@ sub Increment_PrgWin { $$prog_state{'done'} * ($$prog_state{'max'}-$$prog_state{'done'}); $time_est = int($time_est); - if (int ($time_est/60) > 0) { - my $min = int($time_est/60); - my $sec = $time_est % 60; - $time_est = $min.' '.&mt('minutes'); - if ($min < 10) { - if ($sec > 1) { - $time_est.= ', '.$sec.' '.&mt('seconds'); - } elsif ($sec > 0) { - $time_est.= ', '.$sec.' '.&mt('second'); - } - } - } else { - $time_est .= ' '.&mt('seconds'); + # + my $min = int($time_est/60); + my $sec = $time_est % 60; + # + my $str; + if ($min == 0 && $sec > 1) { + $str = '[_2] seconds'; + } elsif ($min == 1 && $sec > 1) { + $str = '1 minute [_2] seconds'; + } elsif ($min == 1 && $sec < 2) { + $str = '1 minute'; + } elsif ($min < 10 && $sec > 1) { + $str = '[_1] minutes, [_2] seconds'; + } elsif ($min >= 10 || $sec < 2) { + $str = '[_1] minutes'; } + $time_est = &mt($str,$min,$sec); + # my $lasttime = &Time::HiRes::time()-$$prog_state{'laststart'}; if ($lasttime > 9) { $lasttime = int($lasttime); @@ -800,8 +877,8 @@ sub Increment_PrgWin { $lasttime = '('.$lasttime.' '.&mt('seconds for').' '.$extraInfo.')'; } # - my $user_browser = $ENV{'browser.type'} if (exists($ENV{'browser.type'})); - my $user_os = $ENV{'browser.os'} if (exists($ENV{'browser.os'})); + my $user_browser = $env{'browser.type'} if (exists($env{'browser.type'})); + my $user_os = $env{'browser.os'} if (exists($env{'browser.os'})); if (! defined($user_browser) || ! defined($user_os)) { (undef,$user_browser,undef,undef,undef,$user_os) = &Apache::loncommon::decode_user_agent(); @@ -845,20 +922,25 @@ sub crumbs { if (! defined($size)) { $size = '+2'; } + if ($target) { + $target = ' target="'. + &Apache::loncommon::escape_single($target).'"'; + } my $output=''; unless ($noformat) { $output.='
'; } $output.=''.$prefix.'/'; - if ($ENV{'user.adv'}) { + if ($env{'user.adv'}) { my $path=$prefix.'/'; - foreach (split('/',$uri)) { - unless ($_) { next; } - $path.=$_; + foreach my $dir (split('/',$uri)) { + if (! $dir) { next; } + $path .= $dir; unless ($path eq $uri) { $path.='/'; } - my $linkpath=$path; - if ($form) { - $linkpath="javascript:$form.action='$path';$form.submit();"; - } - $output.=''.$_.'/'; + my $linkpath = &Apache::loncommon::escape_single($path); + if ($form) { + $linkpath= + qq{javascript:$form.action='$linkpath';$form.submit();}; + } + $output.=qq{$dir/}; } } else { $output.=$uri; @@ -867,6 +949,36 @@ sub crumbs { return $output.''.($noformat?'':'
'); } +# --------------------- A function that generates a window for the spellchecker + +sub spellheader { + my $html=&Apache::lonxml::xmlbegin(); + my $nothing=&javascript_nothing(); + return (< +// + +ENDCHECK +} + +# ---------------------------------- Generate link to spell checker for a field + +sub spelllink { + my ($form,$field)=@_; + my $linktext=&mt('Check Spelling'); + return (<$linktext +ENDLINK +} + # ------------------------------------------------- Output headers for HTMLArea sub htmlareaheaders { @@ -895,14 +1007,14 @@ sub htmlareaaddbuttons { config.registerButton('ed_math','LaTeX Inline', '/htmlarea/images/ed_math.gif',false, function(editor,id) { - editor.surroundHTML('\$','\$'); + editor.surroundHTML(' \$','\$ '); } ); config.registerButton('ed_math_eqn','LaTeX Equation', '/htmlarea/images/ed_math_eqn.gif',false, function(editor,id) { editor.surroundHTML( - '
\\\\[','\\\\]
'); + ' \\n
\\\\[','\\\\]
\\n '); } ); config.toolbar.push(['ed_math','ed_math_eqn']); @@ -916,7 +1028,7 @@ sub disablelink { if (defined($#fields)) { unless ($#fields>=0) { return ''; } } - return ''.&mt('Disable WYSIWYG Editor').''; + return ''.&mt('Disable WYSIWYG Editor').''; } sub enablelink { @@ -924,7 +1036,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 @@ -946,7 +1058,7 @@ sub htmlareaselectactive { # --------------------------------------------------------------------- Blocked sub htmlareablocked { - unless ($ENV{'environment.wysiwygeditor'} eq 'on') { return 1; } + unless ($env{'environment.wysiwygeditor'} eq 'on') { return 1; } return 0; } @@ -1003,8 +1115,8 @@ returns: nothing my @Crumbs; sub breadcrumbs { - my ($color,$component,$component_help,$function,$domain,$menulink) = - @_; + my ($color,$component,$component_help,$function,$domain,$menulink, + $helplink) = @_; if (! defined($color)) { if (! defined($function)) { $function = &Apache::loncommon::get_users_function(); @@ -1021,6 +1133,7 @@ returns: nothing # Make the faq and bug data cascade my $faq = ''; my $bug = ''; + my $help=''; # The last breadcrumb does not have a link, so handle it separately. my $last = pop(@Crumbs); # @@ -1028,10 +1141,10 @@ returns: nothing if (!defined($menulink)) { $menulink=1; } if ($menulink) { my $description = 'Menu'; - if (exists($ENV{'request.course.id'}) && - $ENV{'request.course.id'} ne '') { + if (exists($env{'request.course.id'}) && + $env{'request.course.id'} ne '') { $description = - $ENV{'course.'.$ENV{'request.course.id'}.'.description'}; + $env{'course.'.$env{'request.course.id'}.'.description'}; } unshift(@Crumbs,{ href =>'/adm/menu', @@ -1045,6 +1158,7 @@ returns: nothing map { $faq = $_->{'faq'} if (exists($_->{'faq'})); $bug = $_->{'bug'} if (exists($_->{'bug'})); + $help = $_->{'help'} if (exists($_->{'help'})); my $result = '{'target'}) && $_->{'target'} ne '') { $result .= 'target="'.$_->{'target'}.'" '; @@ -1055,18 +1169,22 @@ returns: nothing } @Crumbs ); $links .= '->' if ($links ne ''); - $links .= ''.$last->{'text'}.''; + $links .= ''.&mt($last->{'text'}).''; # my $icons = ''; $faq = $last->{'faq'} if (exists($last->{'faq'})); $bug = $last->{'bug'} if (exists($last->{'bug'})); + $help = $last->{'help'} if (exists($last->{'help'})); + $component_help=($component_help?$component_help:$help); # if ($faq ne '') { # $icons .= &Apache::loncommon::help_open_faq($faq); # } # if ($bug ne '') { # $icons .= &Apache::loncommon::help_open_bug($bug); # } - $icons .= &Apache::loncommon::help_open_menu($color,$component,$component_help,$function,$faq,$bug); + if ($helplink ne 'nohelp') { + $icons .= &Apache::loncommon::help_open_menu($color,$component,$component_help,$function,$faq,$bug); + } if ($icons ne '') { $Str .= $icons.' '; } @@ -1075,12 +1193,7 @@ returns: nothing # if (defined($component)) { $Str .= ''. - ''.&mt($component).''; - if (defined($component_help)) { - $Str .= - &Apache::loncommon::help_open_topic($component_help); - } - $Str.= ''; + ''.&mt($component).''; } $Str .= ''."\n"; # @@ -1104,6 +1217,264 @@ 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"; + +
+ + + + +
+ + +ENDTWO + return $output; +} + +sub role_select_row { + my ($roles,$col_width,$tablecolor,$title) = @_; + my $output = &row_title($col_width,$tablecolor,$title); + $output .= qq| + + \n|; + $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 .= qq| + + |; + my $courseform=''.&Apache::loncommon::selectcourse_link + ($formname,'pickcourse','pickdomain','coursedesc').''; + if ($totcodes > 0) { + $output .= ''.&mt('All courses'); + 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.
'."\n"; + $output .= &row_closure(); + return $output; +} + +sub status_select_row { + my ($types,$col_width,$tablecolor,$title) = @_; + my $output = &row_title($col_width,$tablecolor,$title); + $output .= qq| + + \n|; + $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 .= ' '.$descrip; + $output .= &start_pick_box('50%'); + $output .= ' + '.&mt('Authentication Method').''.&mt('Username -> e-mail conversion').' + '."\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 .= ' '.$$authtypes{$auth}.''.$userentry.''; + $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; +} 1;