--- loncom/interface/lonhtmlcommon.pm 2009/11/21 22:36:23 1.247
+++ loncom/interface/lonhtmlcommon.pm 2011/10/23 00:50:58 1.285.2.3
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# a pile of common html routines
#
-# $Id: lonhtmlcommon.pm,v 1.247 2009/11/21 22:36:23 www Exp $
+# $Id: lonhtmlcommon.pm,v 1.285.2.3 2011/10/23 00:50:58 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -60,23 +60,38 @@ use Time::Local;
use Time::HiRes;
use Apache::lonlocal;
use Apache::lonnet;
+use HTML::Entities();
use LONCAPA;
+sub java_not_enabled {
+ return "\n".'<span class="LC_error">'.
+ &mt('The required Java applet could not be started. Please make sure to have Java installed and active in your browser.').
+ "</span>\n";
+}
sub coursepreflink {
my ($text,$category)=@_;
if (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
- return '<a href="/adm/courseprefs?phase=display&actions='.$category.'">'.$text.'</a>';
+ return '<a href="'.&HTML::Entities::encode("/adm/courseprefs?phase=display&actions=$category",'<>&"').'">'.$text.'</a>';
} else {
return '';
}
}
+sub raw_href_to_link {
+ my ($message)=@_;
+ $message=~s/(https?\:\/\/[^\s\'\"\<]+)([\s\<]|$)/<a href="$1"><tt>$1<\/tt><\/a>$2/gi;
+ return $message;
+}
+
+sub entity_encode {
+ my ($text)=@_;
+ return &HTML::Entities::encode($text, '<>&"');
+}
+
##############################################
##############################################
-=pod
-
=item confirm_success
Successful completion of an operation message
@@ -86,7 +101,7 @@ Successful completion of an operation me
sub confirm_success {
my ($message,$failure)=@_;
if ($failure) {
- return '<span class="LC_error">'."\n"
+ return '<span class="LC_error" style="font-size: inherit;">'."\n"
.'<img src="/adm/lonIcons/navmap.wrong.gif" alt="'.&mt('Error').'" /> '."\n"
.$message."\n"
.'</span>'."\n";
@@ -117,7 +132,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 <<ENDDRAGMATH;
@@ -133,7 +148,6 @@ ENDDRAGMATH
Javascript used to open pop-up window containing dragmath applet which
can be used to paste LaTeX into a textarea.
-
=cut
sub dragmath_js {
@@ -232,6 +246,9 @@ 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<option value='$escaped'>".
&unescape((split(/\&/,$recent{$value}))[1]).
'</option>';
@@ -374,7 +391,8 @@ dname_hour, dname_min, and dname_sec.
The current setting for this time parameter. A unix format time
(time in seconds since the beginning of Jan 1st, 1970, GMT.
-An undefined value is taken to indicate the value is the current time.
+An undefined value is taken to indicate the value is the current time
+unless it is requested to leave it empty. See $includeempty.
Also, to be explicit, a value of 'now' also indicates the current time.
=item $special
@@ -384,6 +402,9 @@ the date_setter. See lonparmset for exa
=item $includeempty
+If it is set (true) and no date/time value is provided,
+the date/time fields are left empty.
+
=item $state
Specifies the initial state of the form elements. Either 'disabled' or empty.
@@ -403,7 +424,11 @@ sub date_setter {
my ($formname,$dname,$currentvalue,$special,$includeempty,$state,
$no_hh_mm_ss,$defhour,$defmin,$defsec,$nolink) = @_;
my $now = time;
- my $wasdefined=1;
+
+ my $tzname;
+ my ($sec,$min,$hour,$mday,$month,$year) = ('', '', undef,''.''.'');
+ #other potentially useful values: wkday,yrday,is_daylight_savings
+
if (! defined($state) || $state ne 'disabled') {
$state = '';
}
@@ -411,33 +436,24 @@ sub date_setter {
$no_hh_mm_ss = 0;
}
if ($currentvalue eq 'now') {
- $currentvalue = $now;
+ $currentvalue = $now;
}
- if ((!defined($currentvalue)) || ($currentvalue eq '')) {
- $wasdefined=0;
- if ($includeempty) {
- $currentvalue = 0;
- } else {
- $currentvalue = $now;
- }
+
+ # Default value: Set empty date field to current time
+ # unless empty inclusion is requested
+ if ((!$includeempty) && (!$currentvalue)) {
+ $currentvalue = $now;
}
- # other potentially useful values: wkday,yrday,is_daylight_savings
- my $tzname;
- my ($sec,$min,$hour,$mday,$month,$year)=('','',undef,'','','');
+ # Do we have a date? Split it!
if ($currentvalue) {
- ($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)) {
- $sec=($defsec?$defsec:0);
- $min=($defmin?$defmin:0);
- $hour=($defhour?$defhour:0);
- } elsif (!$includeempty) {
- $sec=0;
- $min=0;
- $hour=0;
- }
+ ($tzname,$sec,$min,$hour,$mday,$month,$year) = &get_timedates($currentvalue);
+
+ #No values provided for hour, min, sec? Use default 0
+ if (($defhour) || ($defmin) || ($defsec)) {
+ $sec = ($defsec ? $defsec : 0);
+ $min = ($defmin ? $defmin : 0);
+ $hour = ($defhour ? $defhour : 0);
+ }
}
my $result = "\n<!-- $dname date setting form -->\n";
$result .= <<ENDJS;
@@ -922,7 +938,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:
@@ -935,6 +951,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
@@ -1044,30 +1062,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);
@@ -1076,27 +1089,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();
}
@@ -1127,47 +1137,45 @@ sub r_print {
# ------------------------------------------------------- Puts directory header
sub crumbs {
- my ($uri,$target,$prefix,$form,$size,$noformat,$skiplast)=@_;
- if (! defined($size)) {
- $size = '+2';
- }
+ my ($uri,$target,$prefix,$form,$skiplast)=@_;
if ($target) {
$target = ' target="'.
&Apache::loncommon::escape_single($target).'"';
}
- my $output='';
- unless ($noformat) { $output.='<br /><tt><b>'; }
- $output.='<font size="'.$size.'">'.$prefix.'/';
- if (($env{'user.adv'}) | ($env{'user.author'})) {
- my $path=$prefix.'/';
- foreach my $dir (split('/',$uri)) {
+ my $output='<span class="LC_filename">';
+ $output.=$prefix.'/';
+ if (($env{'user.adv'}) || ($env{'user.author'})) {
+ my $path=$prefix.'/';
+ foreach my $dir (split('/',$uri)) {
if (! $dir) { next; }
$path .= $dir;
- if ($path eq $uri) {
- if ($skiplast) {
- $output.=$dir;
+ if ($path eq $uri) {
+ if ($skiplast) {
+ $output.=$dir;
last;
- }
- } else {
- $path.='/';
- }
+ }
+ } else {
+ $path.='/';
+ }
my $href_path = &HTML::Entities::encode($path,'<>&"');
- &Apache::loncommon::inhibit_menu_check(\$href_path);
- if ($form) {
- my $href = 'javascript:'.$form.".action='".$href_path."';".$form.'.submit();';
- $output.=qq{<a href="$href" $target>$dir</a>/};
- } else {
- $output.=qq{<a href="$href_path" $target>$dir</a>/};
- }
- }
+ &Apache::loncommon::inhibit_menu_check(\$href_path);
+ if ($form) {
+ my $href = 'javascript:'.$form.".action='".$href_path."';".$form.'.submit();';
+ $output.=qq{<a href="$href"$target>$dir</a>/};
+ } else {
+ $output.=qq{<a href="$href_path"$target>$dir</a>/};
+ }
+ }
} else {
- foreach my $dir (split('/',$uri)) {
+ foreach my $dir (split('/',$uri)) {
if (! $dir) { next; }
- $output.=$dir.'/';
- }
+ $output.=$dir.'/';
+ }
}
if ($uri !~ m|/$|) { $output=~s|/$||; }
- return $output.'</font>'.($noformat?'':'</b></tt><br />');
+ $output.='</span>';
+
+ return $output;
}
# --------------------- A function that generates a window for the spellchecker
@@ -1215,50 +1223,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);
-<script type="text/javascript" src="/fckeditor/fckeditor.js"></script>
-ENDHEADERS
+ my $s="";
+ if (&htmlareabrowser()) {
+ $s.=(<<ENDEDITOR);
+<script type="text/javascript" src="/ckeditor/ckeditor.js"></script>
+ENDEDITOR
+ }
+ $s.=(<<ENDJQUERY);
+<script type="text/javascript" src="/adm/jQuery/js/jquery-1.6.2.min.js"></script>
+<script type="text/javascript" src="/adm/jQuery/js/jquery-ui-1.8.16.custom.min.js"></script>
+<link rel="stylesheet" type="text/css" href="/adm/jQuery/css/smoothness/jquery-ui-1.8.16.custom.css" />
+ENDJQUERY
+ return $s;
}
# ----------------------------------------------------------------- Preferences
-sub disablelink {
- my @fields=@_;
- if (defined($#fields)) {
- unless ($#fields>=0) { return ''; }
- }
- return '<a href="'.&HTML::Entities::encode('/adm/preferences?action=set_wysiwyg&wysiwyg=off&returnurl=','<>&"').&escape($ENV{'REQUEST_URI'}).'">'.&mt('Disable WYSIWYG Editor').'</a>';
-}
-
-sub enablelink {
- my @fields=@_;
- if (defined($#fields)) {
- unless ($#fields>=0) { return ''; }
- }
- return '<a href="'.&HTML::Entities::encode('/adm/preferences?action=set_wysiwyg&wysiwyg=on&returnurl=','<>&"').&escape($ENV{'REQUEST_URI'}).'">'.&mt('Enable WYSIWYG Editor').'</a>';
-}
-
# ------------------------------------------------- lang to use in html editor
sub htmlarea_lang {
my $lang='en';
@@ -1271,27 +1254,149 @@ sub htmlarea_lang {
# ----------------------------------------- Script to activate only some fields
sub htmlareaselectactive {
- my @fields=@_;
+ my ($args) = @_;
unless (&htmlareabrowser()) { return ''; }
- if (&htmlareablocked()) { return '<br />'.&enablelink(@fields); }
- my $output='<script type="text/javascript" defer="1">'."\n"
+ my $output='<script type="text/javascript" defer="defer">'."\n"
.'// <![CDATA['."\n";
my $lang = &htmlarea_lang();
- foreach my $field (@fields) {
- $output.="
-{
- var oFCKeditor = new FCKeditor('$field');
- oFCKeditor.Config['CustomConfigurationsPath'] =
- '/fckeditor/loncapaconfig.js';
- oFCKeditor.ReplaceTextarea();
- oFCKeditor.Config['AutoDetectLanguage'] = false;
- oFCKeditor.Config['DefaultLanguage'] = '$lang';
-}";
+ my $fullpage = 'false';
+ my ($dragmath_prefix,$dragmath_helpicon,$dragmath_whitespace);
+ if (ref($args) eq 'HASH') {
+ if (exists($args->{'lang'})) {
+ if ($args->{'lang'} ne '') {
+ $lang = $args->{'lang'};
+ }
+ }
+ if (exists($args->{'fullpage'})) {
+ if ($args->{'fullpage'} eq 'true') {
+ $fullpage = $args->{'fullpage'};
+ }
+ }
+ if (exists($args->{'dragmath'})) {
+ if ($args->{'dragmath'} ne '') {
+ $dragmath_prefix = $args->{'dragmath'};
+ $dragmath_helpicon=&Apache::loncommon::lonhttpdurl("/adm/help/help.png");
+ $dragmath_whitespace=&Apache::loncommon::lonhttpdurl("/adm/lonIcons/transparent1x1.gif");
+ }
+ }
+ }
+ $output.='
+
+ function containsBlockHtml(id) {
+ var re = $("#"+id).html().search(/(?:\<\;|\<)(br|h1|h2|h3|h4|h5|h6|p|ol|ul|table|pre|address|blockquote|center|div)[\s]*((?:[\/]*[\s]*(?:\>\;|\>)|(?:\>\;|\>)[\s\S]*(?:\<\;|\<)\/[\s]*\1[\s]*\(?:\>\;|\>))/im);
+ return (re >= 0);
+ }
+
+ function startRichEditor(id) {
+ CKEDITOR.replace(id,
+ {
+ customConfig: "/ckeditor/loncapaconfig.js",
+ language : "'.$lang.'",
+ fullPage : '.$fullpage.',
+ }
+ );
+ }
+
+ function destroyRichEditor(id) {
+ CKEDITOR.instances[id].destroy();
+ }
+
+ function editorHandler(event) {
+ var rawid = $(this).attr("id");
+ var id = new RegExp("LC_rt_(.*)").exec(rawid)[1];
+ event.preventDefault();
+ var rt_enabled = $(this).hasClass("LC_enable_rt");
+ if (rt_enabled) {
+ startRichEditor(id);
+ $("#LC_rt_"+id).html("<b>« Plain text</b>");
+ $("#LC_rt_"+id).attr("title", "Disable rich text formatting and edit in plain text");
+ $("#LC_rt_"+id).addClass("LC_disable_rt");
+ $("#LC_rt_"+id).removeClass("LC_enable_rt");
+ } else {
+ destroyRichEditor(id);
+ $("#LC_rt_"+id).html("<b>Rich formatting »</b>");
+ $("#LC_rt_"+id).attr("title", "Enable rich text formatting (bold, italic, etc.)");
+ $("#LC_rt_"+id).addClass("LC_enable_rt");
+ $("#LC_rt_"+id).removeClass("LC_disable_rt");
+ }';
+ if ($dragmath_prefix ne '') {
+ $output .= "\n var visible = '';
+ if (rt_enabled) {
+ visible = 'none';
+ }
+ editmath_visibility(id,visible);\n";
+ }
+ $output .= '
+ }
+ $(document).ready(function(){
+ $(".LC_richAlwaysOn").each(function() {
+ startRichEditor($(this).attr("id"));
+ });
+ $(".LC_richDetectHtml").each(function() {
+ var id = $(this).attr("id");
+ var rt_enabled = containsBlockHtml(id);
+ if(rt_enabled) {
+ $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Disable rich text formatting and edit in plain text\" class=\"LC_disable_rt\"><b>« Plain text</b></a></div>");
+ startRichEditor(id);
+ $("#LC_rt_"+id).click(editorHandler);
+ }
+ else {
+ $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Enable rich text formatting (bold, italic, etc.)\" class=\"LC_enable_rt\"><b>Rich formatting »</b></a></div>");
+ $("#LC_rt_"+id).click(editorHandler);
+ }';
+ if ($dragmath_prefix ne '') {
+ $output .= "\n var visible = '';
+ if (rt_enabled) {
+ visible = 'none';
+ }
+ editmath_visibility(id,visible);\n";
+ }
+ $output .= '
+ });
+ $(".LC_richDefaultOn").each(function() {
+ var id = $(this).attr("id");
+ $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Disable rich text formatting and edit in plain text\" class=\"LC_disable_rt\"><b>« Plain text</b></a></div>");
+ startRichEditor(id);
+ $("#LC_rt_"+id).click(editorHandler);
+ });
+ $(".LC_richDefaultOff").each(function() {
+ var id = $(this).attr("id");
+ $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Enable rich text formatting (bold, italic, etc.)\" class=\"LC_enable_rt\"><b>Rich formatting »</b></a></div>");
+ $("#LC_rt_"+id).click(editorHandler);
+ });
+ });
+';
+ if ($dragmath_prefix ne '') {
+ $output .= '
+
+ function editmath_visibility(id,value) {
+
+ if ((id == "") || (id == null)) {
+ return;
+ }
+ var mathid = "'.$dragmath_prefix.'_"+id;
+ mathele = document.getElementById(mathid);
+ if (mathele == null) {
+ return;
+ }
+ mathele.style.display = value;
+ var mathhelpicon = "'.$dragmath_prefix.'helpicon'.'_"+id;
+ mathhelpiconele = document.getElementById(mathhelpicon);
+ if (mathhelpiconele == null) {
+ return;
+ }
+ if (value == "none") {
+ mathhelpiconele.src = "'.$dragmath_whitespace.'";
+ } else {
+ mathhelpiconele.src = "'.$dragmath_helpicon.'";
+ }
+ }
+';
+
}
$output.="\nwindow.status='Activated Editfields';\n"
.'// ]]>'."\n"
- .'</script><br />'.
- &disablelink(@fields);
+ .'</script>';
return $output;
}
@@ -1373,8 +1478,9 @@ returns: nothing
if ($menulink) {
my $description = 'Menu';
my $no_mt_descr = 0;
- if (exists($env{'request.course.id'}) &&
- $env{'request.course.id'} ne '') {
+ 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;
@@ -1393,28 +1499,32 @@ returns: nothing
}
}
my $links = join "",
- map {
- $faq = $_->{'faq'} if (exists($_->{'faq'}));
- $bug = $_->{'bug'} if (exists($_->{'bug'}));
- $help = $_->{'help'} if (exists($_->{'help'}));
-
- my $result = htmltag( 'a',
- $_->{no_mt} ?
- $_->{text} : mt($_->{text}),
- {
- href => $_->{href},
- title => $_->{no_mt} ?
- $_->{title} : mt($_->{title}),
- target => $_->{target},
- });
- $result = htmltag( 'li', "$result $crumbsymbol");
- } @Crumbs;
+ 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;
#should the last Element be translated?
- $links .= htmltag( 'li',
- htmltag( 'b',
- $last->{'no_mt'} ?
- $last->{'text'} : 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});
my $icons = '';
$faq = $last->{'faq'} if (exists($last->{'faq'}));
@@ -1449,12 +1559,10 @@ returns: nothing
.$links;
}
- #SD START (work in progress!)
- add_tools(\$links);
- #SD END
+ render_tools(\$links);
$links = htmltag('div', $links,
{ id => "LC_breadcrumbs" }) unless ($CourseBreadcrumbs) ;
- add_advtools(\$links);
+ render_advtools(\$links);
# Return the @Crumbs stack to what we started with
push(@Crumbs,$last);
@@ -1472,55 +1580,106 @@ returns: nothing
push(@Crumbs,@_);
}
+=item add_breadcrumb_tool($category, $html)
+
+Adds $html to $category of the breadcrumb toolbar container.
+
+$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:
+
+=over
+
+=item navigation
+left of breadcrumbs line
+
+=item tools
+right of breadcrumbs line
+
+=item advtools
+advanced tools shown in a separate box below breadcrumbs line
+
+=back
+
+returns: nothing
+
+=cut
- #SD START (work in progress!)
sub add_breadcrumb_tool {
- my ($category, $html) = @_;
- return unless $html;
- if (!defined(%tools)) {
- my %tools = ( A => [], B => [], C => []);
+ my ($category, @html) = @_;
+ return unless @html;
+ if (!keys(%tools)) {
+ %tools = ( navigation => [], tools => [], advtools => []);
}
- push @{$tools{$category}}, $html;
+
+ #this cleans data received from lonmenu::innerregister
+ @html = grep {defined $_ && $_ ne ''} @html;
+ for (@html) {
+ s/align="(right|left)"//;
+ if (($category ne 'advtools') && ($category ne 'tools')) {
+ s/<span.*?\/span>//;
+ }
+ }
+
+ push @{$tools{$category}}, @html;
}
+=item clear_breadcrumb_tools()
+
+Clears the breadcrumb toolbar container.
+
+returns: nothing
+
+=cut
+
sub clear_breadcrumb_tools {
undef(%tools);
}
- sub add_tools {
- my ($links) = @_;
- return unless defined %tools;
- my $html = '<ul class="LC_bct">';
- for my $category ('A','B') {
- $html .= '<li class="LC_breadcrumb_tools">'
- . '<ul class="LC_breadcrumb_tools'
- . " LC_breadcrumb_tools_$category\">";
- for my $item (@{$tools{$category}}){
- #SD ugly! I'll fix that later on
- $item =~ s/align="(right|left)"//;
- $item =~ s/<span(.*?)\/span>//;
- $html .= "<li>$item</li>";
- }
- $html .= '</li></ul>';
- if ($category eq 'A') { $html .= "<li>$$links</li>"; }
- }
- $$links = $html.'</ul>';
- }
-
- sub add_advtools {
- my ($links) = @_;
- return unless (defined $tools{'C'}) and (scalar (@{$tools{'C'}}) > 0);
- my $html = start_funclist();
- for my $item (@{$tools{'C'}}){
- next unless $item;
- $item =~ s/align="(right|left)"//;
- $html .= add_item_funclist($item);
- }
- $html .= end_funclist();
- $html = Apache::loncommon::head_subbox($html);
- $$links .= $html;
+=item render_tools(\$breadcrumbs)
+
+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
+breadcrumbs.
+
+returns: nothing
+=cut
+
+#TODO might split this in separate functions for each category
+ sub render_tools {
+ my ($breadcrumbs) = @_;
+ return unless (keys(%tools));
+
+ my $navigation = list_from_array($tools{navigation},
+ { listattr => { class=>"LC_breadcrumb_tools_navigation" } });
+ my $tools = list_from_array($tools{tools},
+ { listattr => { class=>"LC_breadcrumb_tools_tools" } });
+ $$breadcrumbs = list_from_array([$navigation, $tools, $$breadcrumbs],
+ { listattr => { class=>'LC_breadcrumb_tools_outerlist' } });
+ }
+
+=item render_advtools(\$breadcrumbs)
+
+Creates html for advanced tools (category advtools) and inserts \$breadcrumbs
+at the correct position.
+
+input: \$breadcrumbs - a reference to the string containing prepared
+breadcrumbs (after render_tools call).
+
+returns: nothing
+=cut
+
+ sub render_advtools {
+ my ($breadcrumbs) = @_;
+ return unless (defined $tools{'advtools'})
+ and (scalar(@{$tools{'advtools'}}) > 0);
+
+ $$breadcrumbs .= Apache::loncommon::head_subbox(
+ funclist_from_array($tools{'advtools'}) );
}
- #SD END
} # End of scope for @Crumbs
@@ -1653,7 +1812,6 @@ ENDTWO
} # End: row_count block for pick_box
-
sub role_select_row {
my ($roles,$title,$css_class,$show_separate_custom,$cdom,$cnum) = @_;
my $crstype = 'Course';
@@ -1699,15 +1857,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|
<script type="text/javascript">
// <![CDATA[
@@ -1754,7 +1912,7 @@ sub course_selection {
if ($numtitles > 0) {
$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 />';
$output .= '<table><tr><td>'.$$codetitles[0].'<br />'."\n".
- '<select name="'.$$codetitles[0].
+ '<select name="'.$standardnames->[0].
'" onChange="setPick(this.form);courseSet('."'$$codetitles[0]'".')">'."\n".
' <option value="-1" />Select'."\n";
my @items = ();
@@ -1784,7 +1942,7 @@ sub course_selection {
$output .= '</select></td>';
for (my $i=1; $i<$numtitles; $i++) {
$output .= '<td>'.$$codetitles[$i].'<br />'."\n".
- '<select name="'.$$codetitles[$i].
+ '<select name="'.$standardnames->[$i].
'" onChange="courseSet('."'$$codetitles[$i]'".')">'."\n".
'<option value="-1"><-Pick '.$$codetitles[$i-1].'</option>'."\n".
'</select>'."\n".
@@ -1876,32 +2034,53 @@ sub course_custom_roles {
}
+sub resource_info_box {
+ my ($symb,$onlyfolderflag)=@_;
+ my $return='';
+ if ($symb) {
+ $return=&Apache::loncommon::start_data_table();
+ my ($map,$id,$resource)=&Apache::lonnet::decode_symb($symb);
+ my $folder=&Apache::lonnet::gettitle($map);
+ $return.=&Apache::loncommon::start_data_table_row().
+ '<th>'.&mt('Folder:').'</th><td>'.$folder.'</td>'.
+ &Apache::loncommon::end_data_table_row();
+ unless ($onlyfolderflag) {
+ $return.=&Apache::loncommon::start_data_table_row().
+ '<th>'.&mt('Resource:').'</th><td>'.&Apache::lonnet::gettitle($symb).'</td>'.
+ &Apache::loncommon::end_data_table_row();
+ }
+ $return.=&Apache::loncommon::end_data_table();
+ } else {
+ $return='<p><span class="LC_error">'.&mt('No context provided.').'</span></p>';
+ }
+ return $return;
+
+}
+
##############################################
##############################################
# topic_bar
#
-# Generates a div containing an (optional) numbered (static) image followed by a
+# Generates a div containing an (optional) number with a white background followed by a
# title with a background color defined in the corresponding CSS: LC_topic_bar
# Inputs:
-# 1. number to display (corresponding static image should exist).
-# img tag will be included if arg is an integer in the range 1 to 9.
+# 1. number to display.
+# If input for number is empty only the title will be displayed.
# 2. title text to display.
# Outputs - a scalar containing html mark-up for the div.
sub topic_bar {
- my ($imgnum,$title) = @_;
- my $imgtag;
- if ($imgnum =~ /^[1-9]$/) {
- $imgtag = '<img src="/res/adm/pages/bl_step'.$imgnum.'.gif"'.
- ' alt="'.&mt('Step [_1]',$imgnum).'" /> ';
+ my ($num,$title) = @_;
+ my $number = '';
+ if ($num ne '') {
+ $number = '<span>'.$num.'</span>';
}
- return '<div class="LC_topic_bar">'.$imgtag.$title.'</div>';
+ return '<div class="LC_topic_bar">'.$number.$title.'</div>';
}
##############################################
##############################################
-
# echo_form_input
#
# Generates html markup to add form elements from the referrer page
@@ -1934,30 +2113,30 @@ sub echo_form_input {
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 (ref($excluded) eq 'ARRAY') {
+ next if (grep(/^\Q$name\E$/,@{$excluded}));
+ }
+ if (ref($regexps) eq 'ARRAY') {
+ if (@{$regexps} > 0) {
+ foreach my $regexp (@{$regexps}) {
+ if ($name =~ /$regexp/) {
+ $match = 1;
+ last;
}
}
}
- if (!$match) {
- if (ref($env{$key})) {
- foreach my $value (@{$env{$key}}) {
- $value = &HTML::Entities::encode($value,'<>&"');
- $output .= '<input type="hidden" name="'.$name.
- '" value="'.$value.'" />'."\n";
- }
- } else {
- my $value = &HTML::Entities::encode($env{$key},'<>&"');
- $output .= '<input type="hidden" name="'.$name.
- '" value="'.$value.'" />'."\n";
- }
+ }
+ next if ($match);
+ if (ref($env{$key}) eq 'ARRAY') {
+ foreach my $value (@{$env{$key}}) {
+ $value = &HTML::Entities::encode($value,'<>&"');
+ $output .= '<input type="hidden" name="'.$name.
+ '" value="'.$value.'" />'."\n";
}
+ } else {
+ my $value = &HTML::Entities::encode($env{$key},'<>&"');
+ $output .= '<input type="hidden" name="'.$name.
+ '" value="'.$value.'" />'."\n";
}
}
}
@@ -1966,7 +2145,6 @@ sub echo_form_input {
##############################################
##############################################
-
# set_form_elements
#
# Generates javascript to set form elements to values based on
@@ -2184,7 +2362,7 @@ sub htmltag{
# USAGE: inittags(@tags);
#
# EXAMPLES:
-# - my ($h1, $h2, $h3) = initTags( qw( h1 h2 h3 ) )
+# - my ($h1, $h2, $h3) = inittags( qw( h1 h2 h3 ) )
# $h1->("This is a headline") #Returns: <h1>This is a headline</h1>
#
# NOTES: See sub htmltag for further information.
@@ -2233,6 +2411,40 @@ sub scripttag {
};
+=item list_from_array( \@array, { listattr =>{}, itemattr =>{} } )
+
+Constructs a XHTML list from \@array.
+
+input:
+
+=over
+
+=item \@array
+
+A reference to the array containing text that will be wrapped in <li></li> tags.
+
+=item { listattr => {}, itemattr =>{} }
+
+Attributes for <ul> and <li> passed in as hash references.
+See htmltag() for more details.
+
+=back
+
+returns: XHTML list as String.
+
+=cut
+
+# \@items, {listattr => { class => 'abc', id => 'xyx' }, itemattr => {class => 'abc', id => 'xyx'}}
+sub list_from_array {
+ my ($items, $args) = @_;
+ return unless (ref($items) eq 'ARRAY');
+ return unless scalar @$items;
+ my ($ul, $li) = inittags( qw(ul li) );
+ my $listitems = join '', map { $li->($_, $args->{itemattr}) } @$items;
+ return $ul->( $listitems, $args->{listattr} );
+}
+
+
##############################################
##############################################
@@ -2262,12 +2474,6 @@ sub scripttag {
#
# 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
@@ -2283,11 +2489,15 @@ sub generate_menu {
# 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.
+ my $src;
+ if ($$link{icon} ne '') {
+ $src = '/res/adm/pages/'.$$link{icon};
+ }
push(@links,$li->(
$a->(
$img->("", {
class => "LC_noBorder LC_middle",
- src => "/res/adm/pages/$$link{icon}",
+ src => $src,
alt => mt(defined($$link{alttext}) ?
$$link{alttext} : $$link{linktext})
}), {
@@ -2390,9 +2600,6 @@ sub add_item_funclist {
return '<li>'.$content.'</li>'."\n";
}
-##############################################
-##############################################
-
=pod
=item &end_funclist
@@ -2408,16 +2615,47 @@ add_item_funclist
Inputs: ./.
Returns: HTML code with function list end
-
=cut
-##############################################
-##############################################
-
sub end_funclist {
return "</ul>\n";
}
+=pod
+
+=item funclist_from_array( \@array, {legend => 'text for legend'} )
+
+Constructs a XHTML list from \@array with the first item being visually
+highlighted and set to the value of legend or 'Functions' if legend is
+empty.
+
+=over
+
+=item \@array
+
+A reference to the array containing text that will be wrapped in <li></li> tags.
+
+=item { legend => 'text' }
+
+A string that's used as visually highlighted first item. 'Functions' is used if
+it's value evaluates to false.
+
+=back
+
+returns: XHTML list as string.
+
+=back
+
+=cut
+
+sub funclist_from_array {
+ my ($items, $args) = @_;
+ return unless(ref($items) eq 'ARRAY');
+ $args->{legend} ||= mt('Functions');
+ return list_from_array( [$args->{legend}, @$items],
+ { listattr => {class => 'LC_funclist'} });
+}
+
1;
__END__