loncom/interface/lonhtmlcommon.pm - diff

Return to lonhtmlcommon.pm CVS log

Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/lonhtmlcommon.pm between versions 1.281 and 1.309

version 1.281, 2010/08/07 19:23:50	version 1.309, 2012/04/16 19:24:59
Line 60 use Time::Local;	Line 60 use Time::Local;
use Time::HiRes;	use Time::HiRes;
use Apache::lonlocal;	use Apache::lonlocal;
use Apache::lonnet;	use Apache::lonnet;
	use HTML::Entities();
use LONCAPA;	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 {	sub coursepreflink {
my ($text,$category)=@_;	my ($text,$category)=@_;
if (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {	if (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
return '<a href="'.&HTML::Entities::encode("/adm/courseprefs?phase=display&actions=$category",'<>&"').'">'.$text.'</a>';	return '<a target="_top" href="'.&HTML::Entities::encode("/adm/courseprefs?phase=display&actions=$category",'<>&"').'"><span class="LC_setting">'.$text.'</span></a>';
} else {	} else {
return '';	return '';
}	}
Line 78 sub raw_href_to_link {	Line 84 sub raw_href_to_link {
return $message;	return $message;
}	}

	sub entity_encode {
	my ($text)=@_;
	return &HTML::Entities::encode($text, '<>&"');
	}

	sub direct_parm_link {
	my ($linktext,$symb,$filter,$part,$target)=@_;
	$symb=&entity_encode($symb);
	$filter=&entity_encode($filter);
	$part=&entity_encode($part);
	if (($symb) && (&Apache::lonnet::allowed('opa')) && ($target ne 'tex')) {
	return "<a target='_top' href='/adm/parmset?symb=$symb&filter=$filter&part=$part'><span class='LC_setting'>$linktext</span></a>";
	} else {
	return $linktext;
	}
	}
##############################################	##############################################
##############################################	##############################################

=item confirm_success	=item &confirm_success()

Successful completion of an operation message	Successful completion of an operation message

Line 107 sub confirm_success {	Line 129 sub confirm_success {

=pod	=pod

=item dragmath_button	=item &dragmath_button()

Creates a button that launches a dragmath popup-window, in which an	Creates a button that launches a dragmath popup-window, in which an
expression can be edited and pasted as LaTeX into a specified textarea.	expression can be edited and pasted as LaTeX into a specified textarea.
Line 121 sub dragmath_button {	Line 143 sub dragmath_button {
my ($textarea,$helpicon) = @_;	my ($textarea,$helpicon) = @_;
my $help_text;	my $help_text;
if ($helpicon) {	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');	my $buttontext=&mt('Edit Math');
return <<ENDDRAGMATH;	return <<ENDDRAGMATH;
Line 133 ENDDRAGMATH	Line 155 ENDDRAGMATH

=pod	=pod

=item dragmath_js	=item &dragmath_js()

Javascript used to open pop-up window containing dragmath applet which	Javascript used to open pop-up window containing dragmath applet which
can be used to paste LaTeX into a textarea.	can be used to paste LaTeX into a textarea.

=cut	=cut

sub dragmath_js {	sub dragmath_js {
Line 155 sub dragmath_js {	Line 178 sub dragmath_js {
ENDDRAGMATHJS	ENDDRAGMATHJS
}	}

	##############################################
	##############################################

	=pod

	=item &dependencies_button()

	Creates a button that launches a popup-window, in which dependencies
	for the web page in the main window can be added to, replaced or deleted.

	=cut

	sub dependencies_button {
	my $buttontext=&mt('Manage Dependencies');
	return <<"END";
	<input type="button" value="$buttontext" onclick="javascript:dependencycheck();" />
	END
	}

	##############################################

	=pod

	=item &dependencycheck_js()

	Javascript used to open pop-up window containing interface to manage
	dependencies for a web page uploaded diretcly to a course.

	=cut

	sub dependencycheck_js {
	my ($symb,$title) = @_;
	my $link = '/adm/dependencies?symb='.&HTML::Entities::encode($symb,'<>&"').
	'&title='.&HTML::Entities::encode($title,'<>&"');
	return <<ENDJS;
	<script type="text/javascript">
	// <![CDATA[
	function dependencycheck() {
	depwin = window.open("$link","","width=750,height=500,resizable,scrollbars=yes");
	}
	// ]]>
	</script>
	ENDJS
	}

##############################################	##############################################
##############################################	##############################################

=pod	=pod

=item authorbombs	=item &authorbombs()

=cut	=cut

Line 295 sub get_recent_frozen {	Line 362 sub get_recent_frozen {

=pod	=pod

=item textbox	=item &textbox()

=cut	=cut

Line 315 sub textbox {	Line 382 sub textbox {

=pod	=pod

=item checkbox	=item &checkbox()

=cut	=cut

Line 337 sub checkbox {	Line 404 sub checkbox {

=pod	=pod

=item radiobutton	=item &radiobutton()

=cut	=cut

Line 361 sub radio {	Line 428 sub radio {

=pod	=pod

=item &date_setter	=item &date_setter()

&date_setter returns html and javascript for a compact date-setting form.	&date_setter returns html and javascript for a compact date-setting form.
To retrieve values from it, use &get_date_from_form().	To retrieve values from it, use &get_date_from_form.

Inputs	Inputs

Line 614 sub build_url {	Line 681 sub build_url {

=pod	=pod

=item &get_date_from_form	=item &get_date_from_form()

get_date_from_form retrieves the date specified in an &date_setter form.	get_date_from_form retrieves the date specified in an &date_setter form.

Line 726 parameter setting wizard.	Line 793 parameter setting wizard.
sub pjump_javascript_definition {	sub pjump_javascript_definition {
my $Str = <<END;	my $Str = <<END;
function pjump(type,dis,value,marker,ret,call,hour,min,sec) {	function pjump(type,dis,value,marker,ret,call,hour,min,sec) {
parmwin=window.open("/adm/rat/parameter.html?type="+escape(type)	openMyModal("/adm/rat/parameter.html?type="+escape(type)
+"&value="+escape(value)+"&marker="+escape(marker)	+"&value="+escape(value)+"&marker="+escape(marker)
+"&return="+escape(ret)	+"&return="+escape(ret)
+"&call="+escape(call)+"&name="+escape(dis)	+"&call="+escape(call)+"&name="+escape(dis)
+"&defhour="+escape(hour)+"&defmin="+escape(min)	+"&defhour="+escape(hour)+"&defmin="+escape(min)
+"&defsec="+escape(sec),"LONCAPAparms",	+"&defsec="+escape(sec)+"&modal=1",350,350,'no');
"height=350,width=350,scrollbars=no,menubar=no");
}	}
END	END
return $Str;	return $Str;
Line 874 of items completed and an estimate of th	Line 940 of items completed and an estimate of th
=over 4	=over 4


=item &Create_PrgWin	=item &Create_PrgWin()

Writes javascript to the client to open a progress window and returns a	Writes javascript to the client to open a progress window and returns a
data structure used for bookkeeping.	data structure used for bookkeeping.
Line 905 Inputs	Line 971 Inputs
Returns a hash containing the progress state data structure.	Returns a hash containing the progress state data structure.


=item &Update_PrgWin	=item &Update_PrgWin()

Updates the text in the progress indicator. Does not increment the count.	Updates the text in the progress indicator. Does not increment the count.
See &Increment_PrgWin.	See &Increment_PrgWin.
Line 925 Inputs:	Line 991 Inputs:
Returns: none	Returns: none


=item Increment_PrgWin	=item Increment_PrgWin()

Increment the count of items completed for the progress window by $step or 1 if no step is provided.	Increment the count of items completed for the progress window by $step or 1 if no step is provided.

Line 947 Inputs:	Line 1013 Inputs:
Returns: none	Returns: none


=item Close_PrgWin	=item &Close_PrgWin()

Closes the progress window.	Closes the progress window.

Line 970 Returns: none	Line 1036 Returns: none
########################################################	########################################################
########################################################	########################################################

my $uniq=0;
sub get_uniq_name {
$uniq++;
return 'uniquename'.$uniq;
}

# Create progress	# Create progress
sub Create_PrgWin {	sub Create_PrgWin {
my ($r, $title, $heading, $number_to_do,$type,$width,$formname,	my ($r,$number_to_do)=@_;
$inputname)=@_;
if (!defined($type)) { $type='popup'; }
if (!defined($width)) { $width=55; }
my %prog_state;	my %prog_state;
$prog_state{'type'}=$type;
if ($type eq 'popup') {
$prog_state{'window'}='popwin';
my $start_page =
&Apache::loncommon::start_page($title,undef,
{'only_body' => 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,&Apache::lonhtmlcommon::scripttag(
"var popwin;
function openpopwin () {
popwin=open(\'\',\'popwin\',\'width=400,height=100\');".
"popwin.document.writeln(\'".$start_page.
"<h4>".&mt("$heading")."<\/h4>".
"<form action=\"\" name=\"popremain\" method=\"post\">".
'<input type="text" size="'.$width.'" name="remaining" value="'.
&mt('Starting').'" /><\\/form>'.$end_page.
"\');".
"popwin.document.close();}".
"\nwindow.setTimeout(openpopwin,0)"
));
$prog_state{'formname'}='popremain';
$prog_state{'inputname'}="remaining";
} elsif ($type eq 'inline') {
$prog_state{'window'}='window';
if (!$formname) {
$prog_state{'formname'}=&get_uniq_name();
&r_print($r,'<form action="" name="'.$prog_state{'formname'}.'">');
} else {
$prog_state{'formname'}=$formname;
}
if (!$inputname) {
$prog_state{'inputname'}=&get_uniq_name();
&r_print($r,&mt("$heading [_1]",' <input type="text" name="'.$prog_state{'inputname'}.'" size="'.$width.'" />'));
} else {
$prog_state{'inputname'}=$inputname;

}
if (!$formname) { &r_print($r,'</form>'); }
&Update_PrgWin($r,\%prog_state,&mt('Starting'));
}

$prog_state{'done'}=0;	$prog_state{'done'}=0;
$prog_state{'firststart'}=&Time::HiRes::time();	$prog_state{'firststart'}=&Time::HiRes::time();
$prog_state{'laststart'}=&Time::HiRes::time();	$prog_state{'laststart'}=&Time::HiRes::time();
$prog_state{'max'}=$number_to_do;	$prog_state{'max'}=$number_to_do;
	&Apache::loncommon::LCprogressbar($r);
return %prog_state;	return %prog_state;
}	}

# update progress	# update progress
sub Update_PrgWin {	sub Update_PrgWin {
my ($r,$prog_state,$displayString)=@_;	my ($r,$prog_state,$displayString)=@_;
&r_print($r,&Apache::lonhtmlcommon::scripttag(	&Apache::loncommon::LCprogressbarUpdate($r,undef,$displayString);
$$prog_state{'window'}.'.document.'.
$$prog_state{'formname'}.'.'.
$$prog_state{'inputname'}.'.value="'.
$displayString.'";'
));
$$prog_state{'laststart'}=&Time::HiRes::time();	$$prog_state{'laststart'}=&Time::HiRes::time();
}	}

Line 1091 sub Increment_PrgWin {	Line 1098 sub Increment_PrgWin {
$min,	$min,
$sec,	$sec,
$lasttime);	$lasttime);
	my $percent=0;
&r_print($r,&Apache::lonhtmlcommon::scripttag(	if ($$prog_state{'max'}) {
$$prog_state{'window'}.'.document.'.	$percent=int(100.*$current/$$prog_state{'max'});
$$prog_state{'formname'}.'.'.	}
$$prog_state{'inputname'}.'.value="'.$timeinfo.'";'	&Apache::loncommon::LCprogressbarUpdate($r,$percent,$timeinfo);
));
$$prog_state{'laststart'}=&Time::HiRes::time();	$$prog_state{'laststart'}=&Time::HiRes::time();
}	}

# close Progress Line	# close Progress Line
sub Close_PrgWin {	sub Close_PrgWin {
my ($r,$prog_state)=@_;	my ($r,$prog_state)=@_;
if ($$prog_state{'type'} eq 'popup') {	&Apache::loncommon::LCprogressbarClose($r);
&r_print($r,&Apache::lonhtmlcommon::scripttag(
'popwin.close()'
));
} elsif ($$prog_state{'type'} eq 'inline') {
&Update_PrgWin($r,$prog_state,&mt('Done'));
}
undef(%$prog_state);	undef(%$prog_state);
}	}

sub r_print {
my ($r,$to_print)=@_;
if ($r) {
$r->print($to_print);
$r->rflush();
} else {
print($to_print);
}
}

# ------------------------------------------------------- Puts directory header	# ------------------------------------------------------- Puts directory header

sub crumbs {	sub crumbs {
my ($uri,$target,$prefix,$form,$skiplast)=@_;	my ($uri,$target,$prefix,$form,$skiplast)=@_;
	# You cannot crumbnify uploaded or adm resources
	if ($uri=~/^\/*(uploaded\|adm)\//) { return &mt('(Internal Course/Group Content)'); }
if ($target) {	if ($target) {
$target = ' target="'.	$target = ' target="'.
&Apache::loncommon::escape_single($target).'"';	&Apache::loncommon::escape_single($target).'"';
Line 1164 sub crumbs {	Line 1156 sub crumbs {
if ($uri !~ m\|/$\|) { $output=~s\|/$\|\|; }	if ($uri !~ m\|/$\|) { $output=~s\|/$\|\|; }
$output.='</span>';	$output.='</span>';


return $output;	return $output;
}	}

Line 1222 sub htmlareaheaders {	Line 1215 sub htmlareaheaders {
ENDEDITOR	ENDEDITOR
}	}
$s.=(<<ENDJQUERY);	$s.=(<<ENDJQUERY);
<script type="text/javascript" src="/adm/jQuery/js/jquery-1.3.2.min.js"></script>	<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.7.2.custom.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.7.2.custom.css" />	<link rel="stylesheet" type="text/css" href="/adm/jQuery/css/smoothness/jquery-ui-1.8.16.custom.css" />
	<script type="text/javascript" src="/adm/jpicker/js/jpicker-1.1.6.min.js" >
	</script>
	<link rel="stylesheet" type="text/css" href="/adm/jpicker/css/jPicker-1.1.6.min.css" />
	<script type='text/javascript' src='/adm/countdown/js/jquery.countdown.js'></script>
	<link rel="stylesheet" type="text/css" src='/adm/countdown/css/jquery.countdown.css' />
ENDJQUERY	ENDJQUERY
return $s;	return $s;
}	}

# ----------------------------------------------------------------- Preferences	# ----------------------------------------------------------------- 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	# ------------------------------------------------- lang to use in html editor
sub htmlarea_lang {	sub htmlarea_lang {
my $lang='en';	my $lang='en';
Line 1265 sub htmlareaselectactive {	Line 1247 sub htmlareaselectactive {
.'// <![CDATA['."\n";	.'// <![CDATA['."\n";
my $lang = &htmlarea_lang();	my $lang = &htmlarea_lang();
my $fullpage = 'false';	my $fullpage = 'false';
my $dragmath_prefix;	my ($dragmath_prefix,$dragmath_helpicon,$dragmath_whitespace);
if (ref($args) eq 'HASH') {	if (ref($args) eq 'HASH') {
if (exists($args->{'lang'})) {	if (exists($args->{'lang'})) {
if ($args->{'lang'} ne '') {	if ($args->{'lang'} ne '') {
Line 1280 sub htmlareaselectactive {	Line 1262 sub htmlareaselectactive {
if (exists($args->{'dragmath'})) {	if (exists($args->{'dragmath'})) {
if ($args->{'dragmath'} ne '') {	if ($args->{'dragmath'} ne '') {
$dragmath_prefix = $args->{'dragmath'};	$dragmath_prefix = $args->{'dragmath'};
	$dragmath_helpicon=&Apache::loncommon::lonhttpdurl("/adm/help/help.png");
	$dragmath_whitespace=&Apache::loncommon::lonhttpdurl("/adm/lonIcons/transparent1x1.gif");
}	}
}	}
}	}
Line 1367 sub htmlareaselectactive {	Line 1351 sub htmlareaselectactive {
$(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>");	$(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);	$("#LC_rt_"+id).click(editorHandler);
});	});
	$.fn.jPicker.defaults.images.clientPath="/adm/jpicker/images/";
	$(".colorchooser").jPicker();


});	});
';	';
	# Code to put a due date countdown in 'duedatecountdown' span.
	# This is currently located in the breadcrumb headers.
	# note that the dueDateLayout is internatinoalized below.
	# Here document is used to support the substitution into the javascript below.
	# ..which unforunately necessitates escaping the $'s in the javascript.
	# There are several times of importance
	#
	# serverDueDate - The absolute time at which the problem expires.
	# serverTime - The server's time when the problem finished computing.
	# clientTime - The client's time...as close to serverTime as possible.
	# The clientTime will be slightly later due to
	# 1. The latency between problem computation and
	# the first network action.
	# 2. The time required between the page load-start and the actual
	# initial javascript execution that got clientTime.
	# These are used as follows:
	# The difference between clientTime and serverTime are used to
	# correct for differences in clock settings between the browser's system and the
	# server's.
	#
	# The difference between clientTime and the time at which the ready() method
	# starts executing is used to estimate latencies for page load and submission.
	# Since this is an estimate, it is doubled. The latency estimate + one minute
	# is used to determine when the countdown timer turns red to warn the user
	# to think about submitting.

	my $dueDateLayout = '<b>' . &mt('Due in: {dn} {dl} {hnn}{sep}{mnn}{sep}{snn} - Submit early!') . '</b>';
	$output .= <<JAVASCRIPT;

	var documentReadyTime;

	\$(document).ready(function() {
	if (typeof(dueDate) != "undefined") {
	documentReadyTime = (new Date()).getTime();
	\$("#duedatecountdown").countdown({until: dueDate, compact: true,
	layout: "$dueDateLayout",
	onTick: function (periods) {
	var latencyEstimate = (documentReadyTime - clientTime) * 2;
	if(\$.countdown.periodsToSeconds(periods) < (60 + latencyEstimate)) {
	\$(this).css("color", "red"); //Highlight last minute.
	}
	}
	});
	}
	});
	JAVASCRIPT
if ($dragmath_prefix ne '') {	if ($dragmath_prefix ne '') {
$output .= '	$output .= '

Line 1383 sub htmlareaselectactive {	Line 1417 sub htmlareaselectactive {
return;	return;
}	}
mathele.style.display = value;	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.'";
	}
}	}
';	';

Line 1406 sub htmlareabrowser {	Line 1450 sub htmlareabrowser {
return 1;	return 1;
}	}

	#
	# Should the "return to content" link be shown?
	#

	sub show_return_link {

	unless ($env{'request.course.id'}) { return 0; }
	if ($env{'request.noversionuri'}=~m{^/priv/} \|\|
	$env{'request.uri'}=~m{^/~}) { return 1; }

	if (($env{'request.noversionuri'} =~ m{^/adm/(viewclasslist\|navmaps)($\|\?)})
	\|\| ($env{'request.noversionuri'} =~ m{^/adm/.*/aboutme($\|\?)})) {

	return if ($env{'form.register'});
	}
	return (($env{'request.noversionuri'}=~m{^/(res\|public)/} &&
	$env{'request.symb'} eq '')
	\|\|
	($env{'request.noversionuri'}=~ m{^/cgi-bin/printout.pl})
	\|\|
	(($env{'request.noversionuri'}=~/^\/adm\//) &&
	($env{'request.noversionuri'}!~/^\/adm\/wrapper\//) &&
	($env{'request.noversionuri'}!~
	m{^/adm/.*/(smppg\|bulletinboard)($\|\?)})
	));
	}


	##
	# Set the dueDate variable...note this is done in the timezone
	# of the browser.
	#
	# @param epoch relative time at which the problem is due.
	#
	# @return the javascript fragment to set the date:
	#
	sub set_due_date {
	my $dueStamp = shift;
	my $duems = $dueStamp * 1000; # Javascript Date object needs ms not seconds.

	my $now = time()*1000;

	# This slightly obscure bit of javascript sets the dueDate variable
	# to the time in the browser at which the problem was due.
	# The code should correct for gross differences between the server
	# and client's time setting

	my $js = "
	<script type='text/javascript'>
	//<![CDATA[
	var serverDueDate = $duems;
	var serverTime = $now;
	var clientTime = (new Date()).getTime();
	var dueDate = new Date(serverDueDate + (clientTime - serverTime));

	//]]>
	</script>
	";

	return $js;
	}
	##
	# Sets the time at which the problem finished computing.
	# This just updates the serverTime and clientTime variables above.
	# Calling this in e.g. end_problem provides a better estimate of the
	# difference beetween the server and client time setting as
	# the difference contains less of the latency/problem compute time.
	#
	sub set_compute_end_time {

	my $now = time()*1000; # Javascript times are in ms.
	my $js = "
	<script type='text/javascript'>
	//<![CDATA[
	serverTime = $now;
	clientTime = (new Date()).getTime();
	//]]>
	</script>

	";
	return $js;

	}

############################################################	############################################################
############################################################	############################################################

=pod	=pod

=item breadcrumbs	=item &breadcrumbs()

Compiles the previously registered breadcrumbs into an series of links.	Compiles the previously registered breadcrumbs into an series of links.
Additionally supports a 'component', which will be displayed on the	Additionally supports a 'component', which will be displayed on the
Line 1429 Inputs: $component (the text on the righ	Line 1557 Inputs: $component (the text on the righ
when including the text on the right.	when including the text on the right.
Returns a string containing breadcrumbs for the current page.	Returns a string containing breadcrumbs for the current page.

=item clear_breadcrumbs	=item &clear_breadcrumbs()

Clears the previously stored breadcrumbs.	Clears the previously stored breadcrumbs.

=item add_breadcrumb	=item &add_breadcrumb()

Pushes a breadcrumb on the stack of crumbs.	Pushes a breadcrumb on the stack of crumbs.

Line 1491 returns: nothing	Line 1619 returns: nothing
$last = $menulink;	$last = $menulink;
}	}
}	}
my $links = join "",	my $links;
	if ((&show_return_link) && (!$CourseBreadcrumbs)) {
	my $alttext = &mt('Go Back');
	$links=&htmltag( 'a',"<img src='/res/adm/pages/reload.png' border='0' style='vertical-align:middle;' alt='$alttext' />",
	{ href => '/adm/flip?postdata=return:',
	title => &mt("Back to most recent content resource") });
	$links=&htmltag('li',$links);
	}
	$links.= join "",
map {	map {
$faq = $_->{'faq'} if (exists($_->{'faq'}));	$faq = $_->{'faq'} if (exists($_->{'faq'}));
$bug = $_->{'bug'} if (exists($_->{'bug'}));	$bug = $_->{'bug'} if (exists($_->{'bug'}));
$help = $_->{'help'} if (exists($_->{'help'}));	$help = $_->{'help'} if (exists($_->{'help'}));

my $result = $_->{no_mt} ? $_->{text} : mt($_->{text});	my $result = $_->{no_mt} ? $_->{text} : &mt($_->{text});

if ($_->{href}){	if ($_->{href}){
$result = htmltag( 'a', $result,	$result = &htmltag( 'a', $result,
{ href => $_->{href},	{ href => $_->{href},
title => $_->{no_mt} ? $_->{title} : mt($_->{title}),	title => $_->{no_mt} ? $_->{title} : &mt($_->{title}),
target => $_->{target}, });	target => $_->{target}, });
}	}

$result = htmltag( 'li', "$result $crumbsymbol");	$result = &htmltag( 'li', "$result $crumbsymbol");
} @Crumbs;	} @Crumbs;

#should the last Element be translated?	#should the last Element be translated?
Line 1516 returns: nothing	Line 1652 returns: nothing

# last breadcrumb is the first order heading of a page	# last breadcrumb is the first order heading of a page
# for course breadcrumbs it's just bold	# for course breadcrumbs it's just bold
$links .= htmltag( 'li', htmltag($CourseBreadcrumbs ? 'b' : 'h1',
	$links .= &htmltag( 'li', htmltag($CourseBreadcrumbs ? 'b' : 'h1',
$lasttext), {title => $lasttext});	$lasttext), {title => $lasttext});

	$links .= '<li> <span id="duedatecountdown"></span></li>';

my $icons = '';	my $icons = '';
$faq = $last->{'faq'} if (exists($last->{'faq'}));	$faq = $last->{'faq'} if (exists($last->{'faq'}));
$bug = $last->{'bug'} if (exists($last->{'bug'}));	$bug = $last->{'bug'} if (exists($last->{'bug'}));
Line 1536 returns: nothing	Line 1675 returns: nothing
$faq,$bug);	$faq,$bug);
}	}
#	#



unless ($CourseBreadcrumbs) {	unless ($CourseBreadcrumbs) {
$links = htmltag('ol', $links, { id => "LC_MenuBreadcrumbs" });	$links = &htmltag('ol', $links, { id => "LC_MenuBreadcrumbs" });
} else {	} else {
$links = htmltag('ul', $links, { class => "LC_CourseBreadcrumbs" });	$links = &htmltag('ul', $links, { class => "LC_CourseBreadcrumbs" });
}	}


if ($component) {	if ($component) {
$links = htmltag('span',	$links = &htmltag('span',
( $no_mt ? $component : mt($component) ).	( $no_mt ? $component : mt($component) ).
( $icons ? $icons : '' ),	( $icons ? $icons : '' ),
{ class => 'LC_breadcrumbs_component' } )	{ class => 'LC_breadcrumbs_component' } )
.$links;	.$links
	;
}	}

render_tools(\$links);	&render_tools(\$links);
$links = htmltag('div', $links,	$links = &htmltag('div', $links,
{ id => "LC_breadcrumbs" }) unless ($CourseBreadcrumbs) ;	{ id => "LC_breadcrumbs" }) unless ($CourseBreadcrumbs) ;
render_advtools(\$links);	&render_advtools(\$links);

# Return the @Crumbs stack to what we started with	# Return the @Crumbs stack to what we started with
push(@Crumbs,$last);	push(@Crumbs,$last);
shift(@Crumbs);	shift(@Crumbs);


# Return the breadcrumb's line	# Return the breadcrumb's line



return "$links";	return "$links";
}	}

Line 1573 returns: nothing	Line 1720 returns: nothing
push(@Crumbs,@_);	push(@Crumbs,@_);
}	}

=item add_breadcrumb_tool($category, $html)	=item &add_breadcrumb_tool($category, $html)

Adds $html to $category of the breadcrumb toolbar container.	Adds $html to $category of the breadcrumb toolbar container.

Line 1602 returns: nothing	Line 1749 returns: nothing
sub add_breadcrumb_tool {	sub add_breadcrumb_tool {
my ($category, @html) = @_;	my ($category, @html) = @_;
return unless @html;	return unless @html;
if (!defined(%tools)) {	if (!keys(%tools)) {
%tools = ( navigation => [], tools => [], advtools => []);	%tools = ( navigation => [], tools => [], advtools => []);
}	}

Line 1610 returns: nothing	Line 1757 returns: nothing
@html = grep {defined $_ && $_ ne ''} @html;	@html = grep {defined $_ && $_ ne ''} @html;
for (@html) {	for (@html) {
s/align="(right\|left)"//;	s/align="(right\|left)"//;
s/<span.*?\/span>// if $category ne 'advtools';	# s/<span.*?\/span>// if $category ne 'advtools';
}	}

push @{$tools{$category}}, @html;	push @{$tools{$category}}, @html;
}	}

=item clear_breadcrumb_tools()	=item &clear_breadcrumb_tools()

Clears the breadcrumb toolbar container.	Clears the breadcrumb toolbar container.

Line 1628 returns: nothing	Line 1775 returns: nothing
undef(%tools);	undef(%tools);
}	}

=item render_tools(\$breadcrumbs)	=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.	\$breadcrumbs at the correct position.
Line 1637 input: \$breadcrumbs - a reference to th	Line 1784 input: \$breadcrumbs - a reference to th
breadcrumbs.	breadcrumbs.

returns: nothing	returns: nothing

=cut	=cut

#TODO might split this in separate functions for each category	#TODO might split this in separate functions for each category
sub render_tools {	sub render_tools {
my ($breadcrumbs) = @_;	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" } });	{ listattr => { class=>"LC_breadcrumb_tools_navigation" } });
Line 1652 returns: nothing	Line 1800 returns: nothing
{ listattr => { class=>'LC_breadcrumb_tools_outerlist' } });	{ listattr => { class=>'LC_breadcrumb_tools_outerlist' } });
}	}

=item render_advtools(\$breadcrumbs)	=pod

	=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.	at the correct position.
Line 1661 input: \$breadcrumbs - a reference to th	Line 1811 input: \$breadcrumbs - a reference to th
breadcrumbs (after render_tools call).	breadcrumbs (after render_tools call).

returns: nothing	returns: nothing

=cut	=cut

sub render_advtools {	sub render_advtools {
Line 2026 sub course_custom_roles {	Line 2177 sub course_custom_roles {


sub resource_info_box {	sub resource_info_box {
my ($symb,$onlyfolderflag)=@_;	my ($symb,$onlyfolderflag,$stuvcurrent,$stuvdisp)=@_;
my $return='';	my $return='';
	if ($stuvcurrent ne '') {
	$return = '<div class="LC_left_float">';
	}
if ($symb) {	if ($symb) {
$return=&Apache::loncommon::start_data_table();	$return.=&Apache::loncommon::start_data_table();
my ($map,$id,$resource)=&Apache::lonnet::decode_symb($symb);	my ($map,$id,$resource)=&Apache::lonnet::decode_symb($symb);
my $folder=&Apache::lonnet::gettitle($map);	my $folder=&Apache::lonnet::gettitle($map);
$return.=&Apache::loncommon::start_data_table_row().	$return.=&Apache::loncommon::start_data_table_row().
'<th>'.&mt('Folder:').'</th><td>'.$folder.'</td>'.	'<th align="left">'.&mt('Folder:').'</th><td>'.$folder.'</td>'.
&Apache::loncommon::end_data_table_row();	&Apache::loncommon::end_data_table_row();
unless ($onlyfolderflag) {	unless ($onlyfolderflag) {
$return.=&Apache::loncommon::start_data_table_row().	$return.=&Apache::loncommon::start_data_table_row().
'<th>'.&mt('Resource:').'</th><td>'.&Apache::lonnet::gettitle($symb).'</td>'.	'<th align="left">'.&mt('Resource:').'</th><td>'.&Apache::lonnet::gettitle($symb).'</td>'.
	&Apache::loncommon::end_data_table_row();
	}
	if ($stuvcurrent ne '') {
	$return .= &Apache::loncommon::start_data_table_row().
	'<th align="left">'.&mt("Student's current version:").'</th><td>'.$stuvcurrent.'</td>'.
	&Apache::loncommon::end_data_table_row();
	}
	if ($stuvdisp ne '') {
	$return .= &Apache::loncommon::start_data_table_row().
	'<th align="left">'.&mt("Student's version displayed:").'</th><td>'.$stuvdisp.'</td>'.
&Apache::loncommon::end_data_table_row();	&Apache::loncommon::end_data_table_row();
}	}
$return.=&Apache::loncommon::end_data_table();	$return.=&Apache::loncommon::end_data_table();
} else {	} else {
$return='<p><span class="LC_error">'.&mt('No context provided.').'</span></p>';	$return='<p><span class="LC_error">'.&mt('No context provided.').'</span></p>';
}	}
	if ($stuvcurrent ne '') {
	$return .= '</div>';
	}
return $return;	return $return;

}	}

##############################################	##############################################
Line 2104 sub echo_form_input {	Line 2270 sub echo_form_input {
if ($key =~ /^form\.(.+)$/) {	if ($key =~ /^form\.(.+)$/) {
my $name = $1;	my $name = $1;
my $match = 0;	my $match = 0;
if ((!@{$excluded}) \|\| (!grep/^$name$/,@{$excluded})) {	if (ref($excluded) eq 'ARRAY') {
if (defined($regexps)) {	next if (grep(/^\Q$name\E$/,@{$excluded}));
if (@{$regexps} > 0) {	}
foreach my $regexp (@{$regexps}) {	if (ref($regexps) eq 'ARRAY') {
if ($name =~ /\Q$regexp\E/) {	if (@{$regexps} > 0) {
$match = 1;	foreach my $regexp (@{$regexps}) {
last;	if ($name =~ /$regexp/) {
}	$match = 1;
	last;
}	}
}	}
}	}
if (!$match) {	}
if (ref($env{$key})) {	next if ($match);
foreach my $value (@{$env{$key}}) {	if (ref($env{$key}) eq 'ARRAY') {
$value = &HTML::Entities::encode($value,'<>&"');	foreach my $value (@{$env{$key}}) {
$output .= '<input type="hidden" name="'.$name.	$value = &HTML::Entities::encode($value,'<>&"');
'" value="'.$value.'" />'."\n";	$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";
}
}	}
	} else {
	my $value = &HTML::Entities::encode($env{$key},'<>&"');
	$output .= '<input type="hidden" name="'.$name.
	'" value="'.$value.'" />'."\n";
}	}
}	}
}	}
Line 2286 sub set_form_elements {	Line 2452 sub set_form_elements {
##############################################	##############################################
##############################################	##############################################

	sub file_submissionchk_js {
	my ($turninpaths,$multiples) = @_;
	my $overwritewarn = &mt('File(s) you uploaded for your submission will overwrite existing file(s) submitted for this item').'\\n'.
	&mt('Continue submission and overwrite the file(s)?');
	my $delfilewarn = &mt('You have indicated you wish to remove some files previously included in your submission.').'\\n'.
	&mt('Continue submission with these files removed?');
	my ($turninpathtext,$multtext,$arrayindexofjs);
	if (ref($turninpaths) eq 'HASH') {
	foreach my $key (sort(keys(%{$turninpaths}))) {
	$turninpathtext .= " if (prefix == '$key') {\n".
	" return '$turninpaths->{$key}';\n".
	" }\n";
	}
	}
	$turninpathtext .= " return '';\n";
	if (ref($multiples) eq 'HASH') {
	foreach my $key (sort(keys(%{$multiples}))) {
	$multtext .= " if (prefix == '$key') {\n".
	" return '$multiples->{$key}';\n".
	" }\n";
	}
	}
	$multtext .= " return '';\n";

	$arrayindexofjs = &Apache::loncommon::javascript_array_indexof();
	return <<"ENDSCRIPT";
	<script type="text/javascript">
	// <![CDATA[

	function file_submission_check(formname,path,multiresp) {
	var elemnum = formname.elements.length;
	if (elemnum == 0) {
	return true;
	}
	var alloverwrites = [];
	var alldelconfirm = [];
	var result = [];
	var submitter;
	var subprefix;
	var allsub = getIndexByName(formname,'all_submit');
	if (allsub == -1) {
	var idx = getIndexByName(formname,'submitted');
	if (idx != -1) {
	var subval = String(formname.elements[idx].value);
	submitter = subval.replace(/^part_/,'');
	result = overwritten_check(formname,path,multiresp,submitter);
	alloverwrites.push.apply(alloverwrites,result['overwrite']);
	alldelconfirm.push.apply(alldelconfirm,result['delete']);
	}
	} else {
	if (formname.elements[allsub].type == 'submit') {
	var partsub = /^\\d+\\.\\d+_submit_.+\$/;
	var allprefixes = [];
	var allparts = [];
	for (var i=0; i<formname.elements.length; i++) {
	if (formname.elements[i].type == 'submit') {
	var elemname = formname.elements[i].name;
	var subname = String(elemname);
	var savesub = String(elemname);
	if (partsub.test(subname)) {
	var prefix = subname.replace(/_submit_.+\$/,'');
	if (allprefixes.indexOf(prefix) == -1) {
	allprefixes.push(prefix);
	allparts[prefix] = [];
	}
	var part = savesub.replace(/^\\d+\\.\\d+_submit_/,'');
	allparts[prefix].push(part);
	}
	}
	}
	for (var k=0; k<allprefixes.length; k++) {
	var idx = getIndexByName(formname,allprefixes[k]+'_submitted');
	if (idx > -1) {
	if (formname.elements[idx].value != 'yes') {
	submitterval = formname.elements[idx].value;
	submitter = submitterval.replace(/^part_/,'');
	subprefix = allprefixes[k];
	result = overwritten_check(formname,path,multiresp,submitter,subprefix);
	alloverwrites.push.apply(alloverwrites,result['overwrite']);
	alldelconfirm.push.apply(alldelconfirm,result['delete']);
	break;
	}
	}
	}
	if (submitter == '' \|\| submitter == undefined) {
	for (var m=0; m<allprefixes.length; m++) {
	for (var n=0; n<allparts[allprefixes[m]].length; n++) {
	var result = overwritten_check(formname,path,multiresp,allparts[allprefixes[m]][n],allprefixes[m]);
	alloverwrites.push.apply(alloverwrites,result['overwrite']);
	alldelconfirm.push.apply(alldelconfirm,result['delete']);
	}
	}
	}
	}
	}
	if (alloverwrites.length > 0) {
	if (!confirm("$overwritewarn")) {
	for (var n=0; n<alloverwrites.length; n++) {
	formname.elements[alloverwrites[n]].value = "";
	}
	return false;
	}
	}
	if (alldelconfirm.length > 0) {
	if (!confirm("$delfilewarn")) {
	for (var p=0; p<alldelconfirm.length; p++) {
	formname.elements[alldelconfirm[p]].checked = false;
	}
	return false;
	}
	}
	return true;
	}

	function getIndexByName(formname,item) {
	for (var i=0;i<formname.elements.length;i++) {
	if (formname.elements[i].name == item) {
	return i;
	}
	}
	return -1;
	}

	function overwritten_check(formname,path,multiresp,part,prefix) {
	var result = [];
	result['overwrite'] = [];
	result['delete'] = [];
	var elemnum = formname.elements.length;
	if (elemnum == 0) {
	return result;
	}
	var uploadstr;
	var deletestr;
	if ((prefix != undefined) && (prefix != '')) {
	var prepend = prefix+'_';
	uploadstr = new RegExp("^"+prepend+"HWFILE"+part+".+\$");
	deletestr = new RegExp("^"+prepend+"HWFILE"+part+".+_\\\\d+_delete\$");
	multiresp = check_for_multiples(prepend);
	path = check_for_turninpath(prepend);
	} else {
	uploadstr = new RegExp("^HWFILE"+part+".+\$");
	deletestr = new RegExp("^HWFILE"+part+".+_\\\\d+_delete\$");
	}
	var alluploads = [];
	var allchecked = [];
	var allskipdel = [];
	var fnametrim = /[^\\/\\\\]+\$/;
	for (var i=0; i<formname.elements.length; i++) {
	var id = formname.elements[i].id;
	if (id != '') {
	if (uploadstr.test(id)) {
	if (formname.elements[i].type == 'file') {
	alluploads.push(id);
	} else {
	if (deletestr.test(id)) {
	if (formname.elements[i].type == 'checkbox') {
	if (formname.elements[i].checked) {
	allchecked.push(id);
	}
	}
	}
	}
	}
	}
	}
	for (var j=0; j<alluploads.length; j++) {
	var delstr = new RegExp("^"+alluploads[j]+"_\\\\d+_delete\$");
	var delboxes = [];
	for (var k=0; k<formname.elements.length; k++) {
	var id = formname.elements[k].id;
	if ((id != '') && (id != undefined)) {
	if (delstr.test(id)) {
	if (formname.elements[k].type == 'checkbox') {
	delboxes.push(id);
	}
	}
	}
	}
	if (delboxes.length > 0) {
	if ((formname.elements[alluploads[j]].value != undefined) &&
	(formname.elements[alluploads[j]].value != '')) {
	var filepath = formname.elements[alluploads[j]].value;
	var newfilename = fnametrim.exec(filepath);
	if (newfilename != null) {
	var filename = String(newfilename);
	var nospaces = filename.replace(/\\s+/g,'_');
	var nospecials = nospaces.replace(/[^\\/\\w\\.\\-]/g,'');
	var cleanfilename = nospecials.replace(/\\.(\\d+\\.)/g,"_\$1");
	if (cleanfilename != '') {
	var fullpath = path+"/"+cleanfilename;
	if (multiresp == 1) {
	var partid = String(alluploads[i]);
	var subdir = partid.replace(/^\\d.?\\d_?HWFILE/,'');
	if (subdir != "" && subdir != undefined) {
	fullpath = path+"/"+subdir+"/"+cleanfilename;
	}
	}
	for (var m=0; m<delboxes.length; m++) {
	if (fullpath == formname.elements[delboxes[m]].value) {
	if (formname.elements[delboxes[m]].checked) {
	allskipdel.push(delboxes[m]);
	} else {
	result['overwrite'].push(alluploads[j]);
	}
	break;
	}
	}
	}
	}
	}
	}
	}
	if (allchecked.length > 0) {
	if (allskipdel.length > 0) {
	for (var n=0; n<allchecked.length; n++) {
	if (allskipdel.indexOf(allchecked[n]) == -1) {
	result['delete'].push(allchecked[n]);
	}
	}
	} else {
	result['delete'].push.apply(result['delete'],allchecked);
	}
	}
	return result;
	}

	function check_for_multiples(prefix) {
	$multtext
	}

	function check_for_turninpath(prefix) {
	$turninpathtext
	}

	// ]]>
	</script>

	$arrayindexofjs

	ENDSCRIPT
	}

	##############################################
	##############################################

# javascript_valid_email	# javascript_valid_email
#	#
# Generates javascript to validate an e-mail address.	# Generates javascript to validate an e-mail address.
Line 2401 sub scripttag {	Line 2812 sub scripttag {
return htmltag('script', $content, {type => 'text/javascript'});	return htmltag('script', $content, {type => 'text/javascript'});
};	};

	=pod

=item list_from_array( \@array, { listattr =>{}, itemattr =>{} } )	=item &list_from_array( \@array, { listattr =>{}, itemattr =>{} } )

Constructs a XHTML list from \@array.	Constructs a XHTML list from \@array.

Line 2428 returns: XHTML list as String.	Line 2840 returns: XHTML list as String.
# \@items, {listattr => { class => 'abc', id => 'xyx' }, itemattr => {class => 'abc', id => 'xyx'}}	# \@items, {listattr => { class => 'abc', id => 'xyx' }, itemattr => {class => 'abc', id => 'xyx'}}
sub list_from_array {	sub list_from_array {
my ($items, $args) = @_;	my ($items, $args) = @_;
	return unless (ref($items) eq 'ARRAY');
return unless scalar @$items;	return unless scalar @$items;
my ($ul, $li) = inittags( qw(ul li) );	my ($ul, $li) = inittags( qw(ul li) );
my $listitems = join '', map { $li->($_, $args->{itemattr}) } @$items;	my $listitems = join '', map { $li->($_, $args->{itemattr}) } @$items;
Line 2479 sub generate_menu {	Line 2892 sub generate_menu {
# create the markup for the current $link and push it into @links.	# create the markup for the current $link and push it into @links.
# each entry consists of an image and a text optionally followed	# each entry consists of an image and a text optionally followed
# by a help link.	# by a help link.
	my $src;
	if ($$link{icon} ne '') {
	$src = '/res/adm/pages/'.$$link{icon};
	}
push(@links,$li->(	push(@links,$li->(
$a->(	$a->(
$img->("", {	$img->("", {
class => "LC_noBorder LC_middle",	class => "LC_noBorder LC_middle",
src => "/res/adm/pages/$$link{icon}",	src => $src,
alt => mt(defined($$link{alttext}) ?	alt => mt(defined($$link{alttext}) ?
$$link{alttext} : $$link{linktext})	$$link{alttext} : $$link{linktext})
}), {	}), {
href => $$link{url},	href => $$link{url},
title => mt($$link{linktitle})	title => mt($$link{linktitle}),
	class => 'LC_menubuttons_link'
}).	}).
$a->(mt($$link{linktext}), {	$a->(mt($$link{linktext}), {
href => $$link{url},	href => $$link{url},
Line 2522 sub generate_menu {	Line 2940 sub generate_menu {

=pod	=pod

=item &start_funclist	=item &start_funclist()

Start list of available functions	Start list of available functions

Line 2562 sub start_funclist {	Line 2980 sub start_funclist {

=pod	=pod

=item &add_item_funclist	=item &add_item_funclist()

Adds an item to the list of available functions	Adds an item to the list of available functions

Line 2588 sub add_item_funclist {	Line 3006 sub add_item_funclist {

=pod	=pod

=item &end_funclist	=item &end_funclist()

End list of available functions	End list of available functions

Line 2609 sub end_funclist {	Line 3027 sub end_funclist {

=pod	=pod

=item funclist_from_array( \@array, {legend => 'text for legend'} )	=item &funclist_from_array( \@array, {legend => 'text for legend'} )

Constructs a XHTML list from \@array with the first item being visually	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	highlighted and set to the value of legend or 'Functions' if legend is
Line 2636 returns: XHTML list as string.	Line 3054 returns: XHTML list as string.

sub funclist_from_array {	sub funclist_from_array {
my ($items, $args) = @_;	my ($items, $args) = @_;
	return unless(ref($items) eq 'ARRAY');
$args->{legend} \|\|= mt('Functions');	$args->{legend} \|\|= mt('Functions');
return list_from_array( [$args->{legend}, @$items],	return list_from_array( [$args->{legend}, @$items],
{ listattr => {class => 'LC_funclist'} });	{ listattr => {class => 'LC_funclist'} });

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>

Removed from v.1.281
changed lines
	Added in v.1.309