--- loncom/interface/lonhtmlcommon.pm 2010/12/05 21:58:49 1.253.2.8 +++ loncom/interface/lonhtmlcommon.pm 2011/01/03 13:10:12 1.285 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # a pile of common html routines # -# $Id: lonhtmlcommon.pm,v 1.253.2.8 2010/12/05 21:58:49 raeburn Exp $ +# $Id: lonhtmlcommon.pm,v 1.285 2011/01/03 13:10:12 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -62,11 +62,16 @@ use Apache::lonlocal; use Apache::lonnet; use LONCAPA; +sub java_not_enabled { + return "\n".''. + &mt('The required Java applet could not be started. Please make sure to have Java installed and active in your browser.'). + "\n"; +} sub coursepreflink { my ($text,$category)=@_; if (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) { - return ''.$text.''; + return '&"').'">'.$text.''; } else { return ''; } @@ -74,15 +79,13 @@ sub coursepreflink { sub raw_href_to_link { my ($message)=@_; - $message=~s/(https?\:\/\/[^\s\'\"]+)(\s|$)/$1<\/tt><\/a>$2/gi; + $message=~s/(https?\:\/\/[^\s\'\"\<]+)([\s\<]|$)/$1<\/tt><\/a>$2/gi; return $message; } ############################################## ############################################## -=pod - =item confirm_success Successful completion of an operation message @@ -92,7 +95,7 @@ Successful completion of an operation me sub confirm_success { my ($message,$failure)=@_; if ($failure) { - return ''."\n" + return ''."\n" .''.&mt('Error').' '."\n" .$message."\n" .''."\n"; @@ -123,7 +126,7 @@ sub dragmath_button { my ($textarea,$helpicon) = @_; my $help_text; if ($helpicon) { - $help_text = &Apache::loncommon::help_open_topic('Authoring_Math_Editor'); + $help_text = &Apache::loncommon::help_open_topic('Authoring_Math_Editor',undef,undef,undef,undef,'mathhelpicon_'.$textarea); } my $buttontext=&mt('Edit Math'); return <}; } # - my $tzone; - unless ($hide_timezone) { - $tzone = ' '.$tzname.' '; - } + my $tzone = ' '.$tzname.' '; if ($no_hh_mm_ss) { $result .= &mt('[_1] [_2] [_3] ', $monthselector,$dayselector,$yearselector). @@ -646,7 +644,7 @@ Returns: Unix time represented in the fo ############################################## ############################################## sub get_date_from_form { - my ($dname,$timezone) = @_; + my ($dname) = @_; my ($sec,$min,$hour,$day,$month,$year); # if (defined($env{'form.'.$dname.'_second'})) { @@ -696,13 +694,7 @@ sub get_date_from_form { if (($year<1970) || ($year>2037)) { return undef; } if (defined($sec) && defined($min) && defined($hour) && defined($day) && defined($month) && defined($year)) { - if (defined($timezone)) { - if (&Apache::lonlocal::gettimezone($timezone) eq 'local') { - $timezone = &Apache::lonlocal::gettimezone(); - } - } else { - $timezone = &Apache::lonlocal::gettimezone(); - } + my $timezone = &Apache::lonlocal::gettimezone(); my $dt = DateTime->new( year => $year, month => $month, day => $day, @@ -940,7 +932,7 @@ Returns: none =item Increment_PrgWin -Increment the count of items completed for the progress window by 1. +Increment the count of items completed for the progress window by $step or 1 if no step is provided. Inputs: @@ -953,6 +945,8 @@ Inputs: =item $extraInfo A description of the items being iterated over. Typically 'student'. +=item $step (optional) counter step. Will be set to default 1 if ommited. step must be greater than 0 or empty. + =back Returns: none @@ -1062,30 +1056,25 @@ sub Update_PrgWin { # increment progress state sub Increment_PrgWin { - my ($r,$prog_state,$extraInfo)=@_; - $$prog_state{'done'}++; + my ($r,$prog_state,$extraInfo,$step)=@_; + $step = $step > 0 ? $step : 1; + $$prog_state{'done'} += $step; + + # Catch (max modulo step) <> 0 + my $current = $$prog_state{'done'}; + my $last = ($$prog_state{'max'} - $current); + if ($last <= 0) { + $last = 1; + $current = $$prog_state{'max'}; + } + my $time_est= (&Time::HiRes::time() - $$prog_state{'firststart'})/ - $$prog_state{'done'} * - ($$prog_state{'max'}-$$prog_state{'done'}); + $current * $last; $time_est = int($time_est); # 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); @@ -1094,27 +1083,24 @@ sub Increment_PrgWin { } else { $lasttime = sprintf("%3.2f",$lasttime); } - if ($lasttime == 1) { - $lasttime = '('.$lasttime.' '.&mt('second for').' '.$extraInfo.')'; - } else { - $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'})); - if (! defined($user_browser) || ! defined($user_os)) { - (undef,$user_browser,undef,undef,undef,$user_os) = - &Apache::loncommon::decode_user_agent(); - } - if ($user_browser eq 'explorer' && $user_os =~ 'mac') { - $lasttime = ''; - } + + $sec = 0 if ($min >= 10); # Don't show seconds if remaining time >= 10 min. + $sec = 1 if ( ($min == 0) && ($sec == 0) ); # Little cheating: pretend to have 1 second remaining instead of 0 to have something to display + + my $timeinfo = + &mt('[_1]/[_2]:' + .' [quant,_3,minute,minutes,] [quant,_4,second ,seconds ,]remaining' + .' ([quant,_5,second] for '.$extraInfo.')', + $current, + $$prog_state{'max'}, + $min, + $sec, + $lasttime); + &r_print($r,&Apache::lonhtmlcommon::scripttag( $$prog_state{'window'}.'.document.'. $$prog_state{'formname'}.'.'. - $$prog_state{'inputname'}.'.value="'. - $$prog_state{'done'}.'/'.$$prog_state{'max'}. - ': '.$time_est.' '.&mt('remaining').' '.$lasttime.'";' + $$prog_state{'inputname'}.'.value="'.$timeinfo.'";' )); $$prog_state{'laststart'}=&Time::HiRes::time(); } @@ -1231,50 +1217,25 @@ sub spelllink { 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; - } -} +# ------------------------------------------------- Output headers for CKEditor sub htmlareaheaders { - return if (&htmlareablocked()); - return if (!&htmlareabrowser()); - return (< -ENDHEADERS + my $s=""; + if (&htmlareabrowser()) { + $s.=(< +ENDEDITOR + } + $s.=(< + + +ENDJQUERY + return $s; } # ----------------------------------------------------------------- Preferences -sub disablelink { - my @fields=@_; - if (defined($#fields)) { - unless ($#fields>=0) { return ''; } - } - return ''.&mt('Disable WYSIWYG Editor').''; -} - -sub enablelink { - my @fields=@_; - if (defined($#fields)) { - unless ($#fields>=0) { return ''; } - } - return ''.&mt('Enable WYSIWYG Editor').''; -} - # ------------------------------------------------- lang to use in html editor sub htmlarea_lang { my $lang='en'; @@ -1287,27 +1248,149 @@ sub htmlarea_lang { # ----------------------------------------- Script to activate only some fields sub htmlareaselectactive { - my @fields=@_; + my ($args) = @_; unless (&htmlareabrowser()) { return ''; } - if (&htmlareablocked()) { return '
'.&enablelink(@fields); } - my $output='
'. - &disablelink(@fields); + .''; return $output; } @@ -1387,75 +1470,55 @@ returns: nothing # The first one should be the course or a menu link if (!defined($menulink)) { $menulink=1; } if ($menulink) { - if ($menulink eq '_nomenu') { - return unless($last); + my $description = 'Menu'; + my $no_mt_descr = 0; + if ((exists($env{'request.course.id'})) && + ($env{'request.course.id'} ne '') && + ($env{'course.'.$env{'request.course.id'}.'.description'} ne '')) { + $description = + $env{'course.'.$env{'request.course.id'}.'.description'}; + $no_mt_descr = 1; + } + $menulink = { href =>'/adm/menu', + title =>'Go to main menu', + target =>'_top', + text =>$description, + no_mt =>$no_mt_descr, }; + if($last) { + #$last set, so we have some crumbs + unshift(@Crumbs,$menulink); } else { - my $description = 'Menu'; - my $href = '/adm/menu'; - my $tooltip = 'Go to main menu'; - my $no_mt_descr = 0; - if ((exists($env{'request.course.id'})) && - ($env{'request.course.id'} ne '') && - !($env{'form.context'} eq 'requestcrs')) { - if ((&Apache::loncommon::needs_gci_custom()) || ($env{'user.domain'} =~ /^\w+citest$/)) { - if ($env{'environment.remotenavmap'} eq 'on') { - # open link using javascript when remote navmap is activated - $href = "javascript:gonav('/adm/navmaps');"; - } else { - $href = '/adm/navmaps'; - } - $tooltip = 'Contents'; - } - if ($env{'course.'.$env{'request.course.id'}.'.description'} ne '') { - $description = - $env{'course.'.$env{'request.course.id'}.'.description'}; - $no_mt_descr = 1; - } - } - $menulink = { href => $href, - title => $tooltip, - target => '_top', - text => $description, - no_mt => $no_mt_descr, }; - if ($last) { - #$last set, so we have some crumbs - unshift(@Crumbs,$menulink); - } else { - #only menulink crumb present - $last = $menulink; - } + #only menulink crumb present + $last = $menulink; } } my $links = join "", - map { - $faq = $_->{'faq'} if (exists($_->{'faq'})); - $bug = $_->{'bug'} if (exists($_->{'bug'})); - $help = $_->{'help'} if (exists($_->{'help'})); - - my $result = $_->{no_mt} ? $_->{text} : mt($_->{text}); - - if ($_->{href}){ - $result = htmltag( 'a', $result, - { - href => $_->{href}, - title => $_->{no_mt} ? - $_->{title} : mt($_->{title}), - target => $_->{target}, - }); - } + map { + $faq = $_->{'faq'} if (exists($_->{'faq'})); + $bug = $_->{'bug'} if (exists($_->{'bug'})); + $help = $_->{'help'} if (exists($_->{'help'})); + + my $result = $_->{no_mt} ? $_->{text} : mt($_->{text}); + + if ($_->{href}){ + $result = htmltag( 'a', $result, + { href => $_->{href}, + title => $_->{no_mt} ? $_->{title} : mt($_->{title}), + target => $_->{target}, }); + } - $result = htmltag( 'li', "$result $crumbsymbol"); - } @Crumbs; + $result = htmltag( 'li', "$result $crumbsymbol"); + } @Crumbs; #should the last Element be translated? - my $lasttext = $last->{'no_mt'} ? $last->{'text'} + my $lasttext = $last->{'no_mt'} ? $last->{'text'} : mt( $last->{'text'} ); # last breadcrumb is the first order heading of a page # for course breadcrumbs it's just bold $links .= htmltag( 'li', htmltag($CourseBreadcrumbs ? 'b' : 'h1', - $lasttext), {title => $lasttext}); + $lasttext), {title => $lasttext}); my $icons = ''; $faq = $last->{'faq'} if (exists($last->{'faq'})); @@ -1515,24 +1578,24 @@ returns: nothing Adds $html to $category of the breadcrumb toolbar container. -$html is usually a link to a page that invokes a function on the currently +$html is usually a link to a page that invokes a function on the currently displayed data (e.g. print when viewing a problem) -Currently there are 3 possible values for $category: +Currently there are 3 possible values for $category: -=over +=over -=item navigation +=item navigation left of breadcrumbs line -=item tools +=item tools right of breadcrumbs line -=item advtools -advanced tools shown in a separate box below breadcrumbs line +=item advtools +advanced tools shown in a separate box below breadcrumbs line =back - + returns: nothing =cut @@ -1540,16 +1603,16 @@ returns: nothing sub add_breadcrumb_tool { my ($category, @html) = @_; return unless @html; - if (!defined(%tools)) { + if (!keys(%tools)) { %tools = ( navigation => [], tools => [], advtools => []); } #this cleans data received from lonmenu::innerregister @html = grep {defined $_ && $_ ne ''} @html; - for (@html) { - s/align="(right|left)"//; - s/// if $category ne 'advtools'; - } + for (@html) { + s/align="(right|left)"//; + s/// if $category ne 'advtools'; + } push @{$tools{$category}}, @html; } @@ -1568,10 +1631,10 @@ returns: nothing =item render_tools(\$breadcrumbs) -Creates html for breadcrumb tools (categories navigation and tools) and inserts +Creates html for breadcrumb tools (categories navigation and tools) and inserts \$breadcrumbs at the correct position. -input: \$breadcrumbs - a reference to the string containing prepared +input: \$breadcrumbs - a reference to the string containing prepared breadcrumbs. returns: nothing @@ -1580,37 +1643,34 @@ returns: nothing #TODO might split this in separate functions for each category sub render_tools { my ($breadcrumbs) = @_; - return unless defined %tools; + return unless (keys(%tools)); - my $navigation = list_from_array($tools{navigation}, + my $navigation = list_from_array($tools{navigation}, { listattr => { class=>"LC_breadcrumb_tools_navigation" } }); - my $tools = list_from_array($tools{tools}, + my $tools = list_from_array($tools{tools}, { listattr => { class=>"LC_breadcrumb_tools_tools" } }); - $$breadcrumbs = list_from_array([$navigation, $tools, $$breadcrumbs], + $$breadcrumbs = list_from_array([$navigation, $tools, $$breadcrumbs], { listattr => { class=>'LC_breadcrumb_tools_outerlist' } }); } -=item render_advtools(\$breadcrumbs,$legend) +=item render_advtools(\$breadcrumbs) -Creates html for advanced tools (category advtools) and inserts \$breadcrumbs +Creates html for advanced tools (category advtools) and inserts \$breadcrumbs at the correct position. -input: \$breadcrumbs - a reference to the string containing prepared +input: \$breadcrumbs - a reference to the string containing prepared breadcrumbs (after render_tools call). returns: nothing =cut sub render_advtools { - my ($breadcrumbs,$legend) = @_; - return unless (defined $tools{'advtools'}) + my ($breadcrumbs) = @_; + return unless (defined $tools{'advtools'}) and (scalar(@{$tools{'advtools'}}) > 0); - my $args; - if ($legend) { - $args = {legend => $legend}; - } + $$breadcrumbs .= Apache::loncommon::head_subbox( - funclist_from_array($tools{'advtools'},$args)); + funclist_from_array($tools{'advtools'}) ); } } # End of scope for @Crumbs @@ -1789,15 +1849,15 @@ sub role_select_row { sub course_select_row { my ($title,$formname,$totcodes,$codetitles,$idlist,$idlist_titles, - $css_class,$crstype) = @_; + $css_class,$crstype,$standardnames) = @_; my $output = &row_title($title,$css_class); - $output .= &course_selection($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype); + $output .= &course_selection($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype,$standardnames); $output .= &row_closure(); return $output; } sub course_selection { - my ($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype) = @_; + my ($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype,$standardnames) = @_; my $output = qq|