--- loncom/interface/lonhtmlcommon.pm 2010/03/19 22:34:23 1.182.4.13 +++ loncom/interface/lonhtmlcommon.pm 2009/05/26 20:06:46 1.219 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # a pile of common html routines # -# $Id: lonhtmlcommon.pm,v 1.182.4.13 2010/03/19 22:34:23 raeburn Exp $ +# $Id: lonhtmlcommon.pm,v 1.219 2009/05/26 20:06:46 droeschl Exp $ # # Copyright Michigan State University Board of Trustees # @@ -62,21 +62,6 @@ use Apache::lonlocal; use Apache::lonnet; use LONCAPA; -sub coursepreflink { - my ($text,$category)=@_; - if (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) { - return ''.$text.''; - } else { - return ''; - } -} - -sub raw_href_to_link { - my ($message)=@_; - $message=~s/(https?\:\/\/[^\s\'\"\<]+)([\s\<]|$)/$1<\/tt><\/a>$2/gi; - return $message; -} - ############################################## ############################################## @@ -91,13 +76,13 @@ Successful completion of an operation me sub confirm_success { my ($message,$failure)=@_; if ($failure) { - return ''."\n" + return ''."\n" .''.&mt('Error').' '."\n" .$message."\n" .''."\n"; } else { return ''."\n" - .''.&mt('OK').' '."\n" + .''.&mt('Ok').' '."\n" .$message."\n" .''."\n"; } @@ -178,7 +163,7 @@ sub authorbombs { foreach (keys %bombs) { if ($_=~/^$udom\/$uname\//) { return ''. + '">'.&mt('Bomb').''. &Apache::loncommon::help_open_topic('About_Bombs'); } } @@ -237,9 +222,6 @@ sub select_recent { unless ($value =~/^error\:/) { my $escaped = &Apache::loncommon::escape_url($value); &Apache::loncommon::inhibit_menu_check(\$escaped); - if ($area eq 'residx') { - next if ((!&Apache::lonnet::allowed('bre',$value)) && (!&Apache::lonnet::allowed('bro',$value))); - } $return.="\n'; @@ -436,8 +418,8 @@ sub date_setter { ($tzname,$sec,$min,$hour,$mday,$month,$year) = &get_timedates($currentvalue); } unless ($wasdefined) { + ($tzname,$sec,$min,$hour,$mday,$month,$year) = &get_timedates($now); if (($defhour) || ($defmin) || ($defsec)) { - ($tzname,$sec,$min,$hour,$mday,$month,$year) = &get_timedates($now); $sec=($defsec?$defsec:0); $min=($defmin?$defmin:0); $hour=($defhour?$defhour:0); @@ -514,7 +496,7 @@ document.$formname.$dname\_year.value, // ]]> ENDJS - $result .= ' '; + $result .= ' '; my $monthselector = qq{'; # Day my $dayselector = qq{}; # Year - my $yearselector = qq{}; + my $yearselector = qq{}; # my $hourselector = qq{<\\/form>'.$end_page. "\');". "popwin.document.close();}". - "\nwindow.setTimeout(openpopwin,0)\n". - '// ]]>'."\n". + "\nwindow.setTimeout(openpopwin,0)". + '// ]]>'. ''); $prog_state{'formname'}='popremain'; $prog_state{'inputname'}="remaining"; @@ -1043,14 +1025,14 @@ sub Create_PrgWin { # update progress sub Update_PrgWin { my ($r,$prog_state,$displayString)=@_; - &r_print($r,''); + $displayString.'";'. + '// ]]>'. + ''); $$prog_state{'laststart'}=&Time::HiRes::time(); } @@ -1068,7 +1050,7 @@ sub Increment_PrgWin { # my $str; if ($min == 0 && $sec > 1) { - $str = '[_1] seconds'; + $str = '[_2] seconds'; } elsif ($min == 1 && $sec > 1) { $str = '1 minute [_2] seconds'; } elsif ($min == 1 && $sec < 2) { @@ -1103,15 +1085,15 @@ sub Increment_PrgWin { if ($user_browser eq 'explorer' && $user_os =~ 'mac') { $lasttime = ''; } - &r_print($r,''); + ': '.$time_est.' '.&mt('remaining').' '.$lasttime.'";'. + '// ]]>'. + ''); $$prog_state{'laststart'}=&Time::HiRes::time(); } @@ -1119,11 +1101,11 @@ sub Increment_PrgWin { sub Close_PrgWin { my ($r,$prog_state)=@_; if ($$prog_state{'type'} eq 'popup') { - &r_print($r,''."\n"); + &r_print($r,''."\n"); } elsif ($$prog_state{'type'} eq 'inline') { &Update_PrgWin($r,$prog_state,&mt('Done')); } @@ -1154,7 +1136,7 @@ sub crumbs { my $output=''; unless ($noformat) { $output.='
'; } $output.=''.$prefix.'/'; - if (($env{'user.adv'}) || ($env{'user.author'})) { + if ($env{'user.adv'}) { my $path=$prefix.'/'; foreach my $dir (split('/',$uri)) { if (! $dir) { next; } @@ -1204,7 +1186,7 @@ sub spellheader { my $nothing=&javascript_nothing(); return (< +
'. &disablelink(@fields); return $output; } @@ -1345,6 +1327,8 @@ Inputs: $component (the large text on th $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) + $no_mt (optional flag, 1 if &mt() is _not_ to be applied to $component + when including the text on the right. Returns a string containing breadcrumbs for the current page. =item clear_breadcrumbs @@ -1370,67 +1354,78 @@ returns: nothing my @Crumbs; sub breadcrumbs { - my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt) = @_; + my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt, $CourseBreadcrumbs) = @_; # - $css_class ||= 'LC_breadcrumbs'; - my $Str = "\n".''; + + + if($CourseBreadcrumbs){ + $Str1 .= $links.''; + } else { + $Str1 .= $links.''; + } # if (defined($component)) { - $Str .= '
'; + $css_class ||= 'LC_breadcrumbs'; + my $Str1 = '
    '; + + if($CourseBreadcrumbs){ + $Str1 = '
      '; + } + + my $Str = ''; # # Make the faq and bug data cascade my $faq = ''; my $bug = ''; - my $help=''; - # Crumb Symbol - my $crumbsymbol = '» '; + my $help=''; + # Crumb Symbol + my $crumbsymbol = '» '; # The last breadcrumb does not have a link, so handle it separately. my $last = pop(@Crumbs); # # The first one should be the course or a menu link - if (!defined($menulink)) { $menulink=1; } + if (!defined($menulink)) { $menulink=1; } if ($menulink) { 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 '')) { + if (exists($env{'request.course.id'}) && + $env{'request.course.id'} ne '') { $description = $env{'course.'.$env{'request.course.id'}.'.description'}; $no_mt_descr = 1; } - unshift(@Crumbs,{ - href =>'/adm/menu', - title =>'Go to main menu', - target =>'_top', - text =>$description, - no_mt =>$no_mt_descr, - }); + $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 { + #only menulink crumb present + $last = $menulink; + } } - my $links .= - join($crumbsymbol, + my $links = join "", map { - $faq = $_->{'faq'} if (exists($_->{'faq'})); - $bug = $_->{'bug'} if (exists($_->{'bug'})); + $faq = $_->{'faq'} if (exists($_->{'faq'})); + $bug = $_->{'bug'} if (exists($_->{'bug'})); $help = $_->{'help'} if (exists($_->{'help'})); - my $result = '{'target'}) && $_->{'target'} ne '') { - $result .= 'target="'.$_->{'target'}.'" '; - } - if ($_->{'no_mt'}) { - $result .='title="'.$_->{'title'}.'">'. - $_->{'text'}.''; - } else { - $result .='title="'.&mt($_->{'title'}).'">'. - &mt($_->{'text'}).''; - } - $result; - } @Crumbs - ); - $links .= $crumbsymbol if ($links ne ''); + + my $result = htmltag( 'a', + $_->{no_mt} ? $_->{text} : mt($_->{text}), + { + href => $_->{href}, + title => $_->{no_mt} ? $_->{title} : mt($_->{title}), + target => $_->{target}, + }); + $result = htmltag( 'li', $crumbsymbol.$result); + } @Crumbs; +#Workaround for edit course. + if(@Crumbs == 0 ){ + $links .= '
    • ' if ($links ne ''); + } else { + $links .= '
    • '.$crumbsymbol if ($links ne ''); + } +#should the last Element be translated? if ($last->{'no_mt'}) { $links .= ''.$last->{'text'}.''; } else { $links .= ''.&mt($last->{'text'}).''; } - # + $links .= '
      • '; my $icons = ''; $faq = $last->{'faq'} if (exists($last->{'faq'})); $bug = $last->{'bug'} if (exists($last->{'bug'})); @@ -1448,10 +1443,17 @@ returns: nothing $faq,$bug); } # - $Str .= $links.'
'; + $Str .= "\n".'' + .''; + $Str .= '
'; if ($no_mt) { $Str .= $component; } else { @@ -1460,15 +1462,14 @@ returns: nothing if ($icons ne '') { $Str .= ' '.$icons; } - $Str .= '
'."\n"; } - $Str .= '
'."\n"; # # Return the @Crumbs stack to what we started with push(@Crumbs,$last); shift(@Crumbs); - # - return $Str; + # Return a table and after that the breadcrumb's line + return "$Str\n$Str1"; } sub clear_breadcrumbs { @@ -1613,16 +1614,12 @@ ENDTWO sub role_select_row { my ($roles,$title,$css_class,$show_separate_custom,$cdom,$cnum) = @_; - my $crstype = 'Course'; - if ($cdom ne '' && $cnum ne '') { - $crstype = &Apache::loncommon::course_type($cdom.'_'.$cnum); - } my $output; if (defined($title)) { $output = &row_title($title,$css_class); } $output .= qq| - \n|; foreach my $role (@$roles) { my $plrole; if ($role eq 'ow') { @@ -1641,7 +1638,7 @@ sub role_select_row { $plrole = &mt('Custom Role'); } } else { - $plrole=&Apache::lonnet::plaintext($role,$crstype); + $plrole=&Apache::lonnet::plaintext($role); } if (($role ne 'cr') || (!$show_separate_custom)) { $output .= ' '; @@ -1656,15 +1653,15 @@ sub role_select_row { sub course_select_row { my ($title,$formname,$totcodes,$codetitles,$idlist,$idlist_titles, - $css_class,$crstype) = @_; + $css_class) = @_; 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); $output .= &row_closure(); return $output; } sub course_selection { - my ($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype) = @_; + my ($formname,$totcodes,$codetitles,$idlist,$idlist_titles) = @_; my $output = qq| |; - - my ($allcrs,$pickspec); - if ($crstype eq 'Community') { - $allcrs = &mt('All communities'); - $pickspec = &mt('Pick specific communities:'); - } else { - $allcrs = &mt('All courses'); - $pickspec = &mt('Pick specific course(s):'); - } - my $courseform=''.&Apache::loncommon::selectcourse_link - ($formname,'pickcourse','pickdomain','coursedesc','',1,$crstype).''; - $output .= ''.$allcrs.'
'; + ($formname,'pickcourse','pickdomain','coursedesc','',1).''; + $output .= ''.&mt('All courses').'
'; if ($totcodes > 0) { my $numtitles = @$codetitles; if ($numtitles > 0) { @@ -1750,7 +1737,7 @@ sub course_selection { $output .= '
'; } } - $output .= ''.$pickspec.' '.$courseform.'  selected.
'."\n"; + $output .= ''.&mt('Pick specific course(s):').' '.$courseform.'  selected.
'."\n"; return $output; } @@ -1846,7 +1833,8 @@ sub topic_bar { return '
'.&mt('Step [_1]',$imgnum). - ' '.$title.' + ' "src="/res/adm/pages/bl_step'.$imgnum.'.gif" />  + '.$title.'
'; } @@ -1983,7 +1971,7 @@ sub set_form_elements { $values{$name}[$i] =~ s/([\r\n\f]+)/\\n/g; $values{$name}[$i] =~ s/"/\\"/g; } - if (($$elements{$name} eq 'text') || ($$elements{$name} eq 'hidden')) { + if ($$elements{$name} eq 'text') { my $numvalues = @{$values{$name}}; if ($numvalues > 1) { my $valuestring = join('","',@{$values{$name}}); @@ -2018,8 +2006,6 @@ sub set_form_elements { $output .= qq| if (courseForm.elements['$name'].value == "$value") { courseForm.elements['$name'].checked = true; - } else { - courseForm.elements['$name'].checked = false; }|; } } @@ -2061,7 +2047,6 @@ sub set_form_elements { } } $output .= " - return; }\n"; return $output; } @@ -2104,6 +2089,139 @@ END } +# USAGE: htmltag(element, content, {attribute => value,...}); +# +# EXAMPLES: +# - htmltag('a', 'this is an anchor', {href => 'www.example.com', +# title => 'this is a title'}) +# +# - You might want to set up needed tags like: +# +# my $h3 = sub { return htmltag( "h3", @_ ) }; +# +# ... and use them: $h3->("This is a headline") +# +# - To set up a couple of tags, see sub inittags +# +# NOTES: +# - Empty elements, such as
are correctly terminated, +# i.e. htmltag('br') returns
+# - Empty attributes (title="") are filtered out. +# - The function will not check for deprecated attributes. +# +# OUTPUT: content enclosed in xhtml conform tags +sub htmltag{ + return + qq|<$_[0]| + . join( '', map { qq| $_="${$_[2]}{$_}"| if ${$_[2]}{$_} } keys %{ $_[2] } ) + . ($_[1] ? qq|>$_[1]| : qq|/>|). "\n"; +}; + + +# USAGE: inittags(@tags); +# +# EXAMPLES: +# - my ($h1, $h2, $h3) = initTags( qw( h1 h2 h3 ) ) +# $h1->("This is a headline") #Returns:

This is a headline

+# +# NOTES: See sub htmltag for further information. +# +# OUTPUT: List of subroutines. +sub inittags { + my @tags = @_; + return map { my $tag = $_; + sub { return htmltag( $tag, @_ ) } + } @tags; +} + + +############################################## +############################################## + +# generate_menu +# +# Generates html markup for a menu. +# +# Inputs: +# An array of following structure: +# ({ categorytitle => 'Categorytitle', +# items => [ +# { +# linktext => 'Text to be displayed', +# url => 'URL the link is pointing to, i.e. /adm/site?action=dosomething', +# permission => 'Contains permissions as returned from lonnet::allowed(), +# must evaluate to true in order to activate the link', +# icon => 'icon filename', +# alttext => 'alt text for the icon', +# help => 'Name of the corresponding helpfile', +# linktitle => 'Description of the link (used for title tag)' +# }, +# ... +# ] +# }, +# ... +# ) +# +# Outputs: A scalar containing the html markup for the menu. + +# ---- Remove when done ---- +# This routine is part of the redesign of LON-CAPA and it's +# subject to change during this project. +# Don't rely on its current functionality as it might be +# changed or removed. +# -------------------------- +sub generate_menu { + my @menu = @_; + # subs for specific html elements + my ($h3, $div, $ul, $li, $a, $img) = inittags( qw(h3 div ul li a img) ); + + my @categories; # each element represents the entire markup for a category + + foreach my $category (@menu) { + my @links; # contains the links for the current $category + foreach my $link (@{$$category{items}}) { + next unless $$link{permission}; + + # create the markup for the current $link and push it into @links. + # each entry consists of an image and a text optionally followed + # by a help link. + push @links, $li->( + $a->( + $img->("", { + class => "LC_noBorder LC_middle", + src => "/res/adm/pages/$$link{icon}", + alt => mt(defined($$link{alttext}) ? + $$link{alttext} : $$link{linktext}) + }), { + href => $$link{url}, + title => mt($$link{linktitle}) + }). + $a->(mt($$link{linktext}), { + href => $$link{url}, + title => mt($$link{linktitle}), + class => "LC_menubuttons_link" + }). + (defined($$link{help}) ? + Apache::loncommon::help_open_topic($$link{help}) : ''), + {class => "LC_menubuttons_inline_text"}); + } + + # wrap categorytitle in

, concatenate with + # joined and in
    tags wrapped @links + # and wrap everything in an enclosing
    and push it into + # @categories + # such that each element looks like: + #

    title

    • ...
      • ...
    + # the category won't be added if there aren't any links + push @categories, + $div->($h3->(mt($$category{categorytitle}), {class=>"LC_hcell"}). + $ul->(join('' ,@links), {class =>"LC_ListStyleNormal" }), + {class=>"LC_ContentBoxSpecial LC_400Box"}) if scalar(@links); + } + + # wrap the joined @categories in another
    (column layout) + return $div->(join('', @categories), {class => "LC_columnSection"}); +} 1;