loncom/interface/loncommon.pm - diff

Return to loncommon.pm CVS log

Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/loncommon.pm between versions 1.565 and 1.658

version 1.565, 2007/08/18 00:01:37	version 1.658, 2008/05/31 01:51:42
Line 67 use Apache::loncoursedata();	Line 67 use Apache::loncoursedata();
use Apache::lontexconvert();	use Apache::lontexconvert();
use Apache::lonclonecourse();	use Apache::lonclonecourse();
use LONCAPA qw(:DEFAULT :match);	use LONCAPA qw(:DEFAULT :match);
	use DateTime::TimeZone;

# ---------------------------------------------- Designs	# ---------------------------------------------- Designs
use vars qw(%defaultdesign);	use vars qw(%defaultdesign);
Line 78 my $readit;	Line 79 my $readit;
## Global Variables	## Global Variables
##	##


	# ----------------------------------------------- SSI with retries:
	#

	=pod

	=head1 Server Side include with retries:

	=over 4

	=item * &ssi_with_retries(resource,retries form)

	Performs an ssi with some number of retries. Retries continue either
	until the result is ok or until the retry count supplied by the
	caller is exhausted.

	Inputs:

	=over 4

	resource - Identifies the resource to insert.

	retries - Count of the number of retries allowed.

	form - Hash that identifies the rendering options.

	=back

	Returns:

	=over 4

	content - The content of the response. If retries were exhausted this is empty.

	response - The response from the last attempt (which may or may not have been successful.

	=back

	=back

	=cut

	sub ssi_with_retries {
	my ($resource, $retries, %form) = @_;


	my $ok = 0; # True if we got a good response.
	my $content;
	my $response;

	# Try to get the ssi done. within the retries count:

	do {
	($content, $response) = &Apache::lonnet::ssi($resource, %form);
	$ok = $response->is_success;
	if (!$ok) {
	&Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
	}
	$retries--;
	} while (!$ok && ($retries > 0));

	if (!$ok) {
	$content = ''; # On error return an empty content.
	}
	return ($content, $response);

	}



# ----------------------------------------------- Filetypes/Languages/Copyright	# ----------------------------------------------- Filetypes/Languages/Copyright
my %language;	my %language;
my %supported_language;	my %supported_language;
Line 214 BEGIN {	Line 285 BEGIN {

=over 4	=over 4

=item * browser_and_searcher_javascript ()	=item * &browser_and_searcher_javascript()

X<browsing, javascript>X<searching, javascript>Returns a string	X<browsing, javascript>X<searching, javascript>Returns a string
containing javascript with two functions, C<openbrowser> and	containing javascript with two functions, C<openbrowser> and
C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>	C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
tags.	tags.

=item * openbrowser(formname,elementname,only,omit) [javascript]	=item * &openbrowser(formname,elementname,only,omit) [javascript]

inputs: formname, elementname, only, omit	inputs: formname, elementname, only, omit

Line 234 with the given extension. Can be a comm	Line 305 with the given extension. Can be a comm
Specifying 'omit' will restrict the browser to NOT displaying files	Specifying 'omit' will restrict the browser to NOT displaying files
with the given extension. Can be a comma separated list.	with the given extension. Can be a comma separated list.

=item * opensearcher(formname, elementname) [javascript]	=item * &opensearcher(formname,elementname) [javascript]

Inputs: formname, elementname	Inputs: formname, elementname

Line 257 sub browser_and_searcher_javascript {	Line 328 sub browser_and_searcher_javascript {
}	}
url += 'catalogmode=interactive&';	url += 'catalogmode=interactive&';
url += 'mode=$mode&';	url += 'mode=$mode&';
	url += 'inhibitmenu=yes&';
url += 'form=' + formname + '&';	url += 'form=' + formname + '&';
if (only != null) {	if (only != null) {
url += 'only=' + only + '&';	url += 'only=' + only + '&';
Line 318 sub storeresurl {	Line 390 sub storeresurl {
unless ($resurl=~/^\/res/) { return 0; }	unless ($resurl=~/^\/res/) { return 0; }
$resurl=~s/\/$//;	$resurl=~s/\/$//;
&Apache::lonnet::put('environment',{'lastresurl' => $resurl});	&Apache::lonnet::put('environment',{'lastresurl' => $resurl});
&Apache::lonnet::appenv('environment.lastresurl' => $resurl);	&Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
return 1;	return 1;
}	}

Line 367 sub selectstudent_link {	Line 439 sub selectstudent_link {
return '';	return '';
}	}
return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.	return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
'","'.$udomele.'","","1");'."'>".&mt('Select User')."</a>";	'","'.$udomele.'");'."'>".&mt('Select User')."</a>";
}	}
if ($env{'request.role'}=~/^(au\|dc\|su)/) {	if ($env{'request.role'}=~/^(au\|dc\|su)/) {
return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.	return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
Line 376 sub selectstudent_link {	Line 448 sub selectstudent_link {
return '';	return '';
}	}

	sub authorbrowser_javascript {
	return <<"ENDAUTHORBRW";
	<script type="text/javascript">
	var stdeditbrowser;

	function openauthorbrowser(formname,udom) {
	var url = '/adm/pickauthor?';
	url += 'form='+formname+'&roledom='+udom;
	var title = 'Author_Browser';
	var options = 'scrollbars=1,resizable=1,menubar=0';
	options += ',width=700,height=600';
	stdeditbrowser = open(url,title,options,'1');
	stdeditbrowser.focus();
	}

	</script>
	ENDAUTHORBRW
	}

sub coursebrowser_javascript {	sub coursebrowser_javascript {
my ($domainfilter,$sec_element,$formname)=@_;	my ($domainfilter,$sec_element,$formname)=@_;
my $crs_or_grp_alert = &mt('Please select the type of LON-CAPA entity - Course or Group - for which you wish to add/modify a user role');	my $crs_or_grp_alert = &mt('Please select the type of LON-CAPA entity - Course or Group - for which you wish to add/modify a user role');
Line 407 sub coursebrowser_javascript {	Line 498 sub coursebrowser_javascript {
'&cdomelement='+udom+	'&cdomelement='+udom+
'&cnameelement='+desc;	'&cnameelement='+desc;
if (extra_element !=null && extra_element != '') {	if (extra_element !=null && extra_element != '') {
if (formname == 'rolechoice') {	if (formname == 'rolechoice' \|\| formname == 'studentform') {
url += '&roleelement='+extra_element;	url += '&roleelement='+extra_element;
if (domainfilter == null \|\| domainfilter == '') {	if (domainfilter == null \|\| domainfilter == '') {
url += '&domainfilter='+extra_element;	url += '&domainfilter='+extra_element;
Line 471 sub setsec_javascript {	Line 562 sub setsec_javascript {
my ($sec_element,$formname) = @_;	my ($sec_element,$formname) = @_;
my $setsections = qq\|	my $setsections = qq\|
function setSect(sectionlist) {	function setSect(sectionlist) {
var sectionsArray = sectionlist.split(",");	var sectionsArray = new Array();
	if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
	sectionsArray = sectionlist.split(",");
	}
var numSections = sectionsArray.length;	var numSections = sectionsArray.length;
document.$formname.$sec_element.length = 0;	document.$formname.$sec_element.length = 0;
if (numSections == 0) {	if (numSections == 0) {
Line 510 sub selectcourse_link {	Line 604 sub selectcourse_link {
'","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'","'.$selecttype.'");'."'>".&mt('Select Course')."</a>";	'","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'","'.$selecttype.'");'."'>".&mt('Select Course')."</a>";
}	}

	sub selectauthor_link {
	my ($form,$udom)=@_;
	return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
	&mt('Select Author').'</a>';
	}

sub check_uncheck_jscript {	sub check_uncheck_jscript {
my $jscript = <<"ENDSCRT";	my $jscript = <<"ENDSCRT";
function checkAll(field) {	function checkAll(field) {
Line 535 ENDSCRT	Line 635 ENDSCRT
return $jscript;	return $jscript;
}	}

	sub select_timezone {
	my ($name,$selected,$onchange)=@_;
	my $output="<select name='$name' $onchange>\n";
	my @timezones = DateTime::TimeZone->all_names;
	foreach my $tzone (@timezones) {
	$output.= '<option value="'.$tzone.'"';
	if ($tzone eq $selected) {
	$output.=' selected="selected"';
	}
	$output.=">$tzone</option>\n";
	}
	$output.="</select>";
	return $output;
	}

=pod	=pod

=item * linked_select_forms(...)	=item * &linked_select_forms(...)

linked_select_forms returns a string containing a <script></script> block	linked_select_forms returns a string containing a <script></script> block
and html for two <select> menus. The select menus will be linked in that	and html for two <select> menus. The select menus will be linked in that
changing the value of the first menu will result in new values being placed	changing the value of the first menu will result in new values being placed
in the second menu. The values in the select menu will appear in alphabetical	in the second menu. The values in the select menu will appear in alphabetical
order.	order unless a defined order is provided.

linked_select_forms takes the following ordered inputs:	linked_select_forms takes the following ordered inputs:

Line 562 linked_select_forms takes the following	Line 676 linked_select_forms takes the following

=item * $hashref, a reference to a hash containing the data for the menus.	=item * $hashref, a reference to a hash containing the data for the menus.

	=item * $menuorder, the order of values in the first menu

=back	=back

Below is an example of such a hash. Only the 'text', 'default', and	Below is an example of such a hash. Only the 'text', 'default', and
Line 578 $menu{$choice1}->{'select2'}.	Line 694 $menu{$choice1}->{'select2'}.
B2 => "Choice B2",	B2 => "Choice B2",
B3 => "Choice B3",	B3 => "Choice B3",
B4 => "Choice B4"	B4 => "Choice B4"
}	},
	order => ['B4','B3','B1','B2'],
},	},
A2 => { text =>"Choice A2" ,	A2 => { text =>"Choice A2" ,
default => "C2",	default => "C2",
Line 586 $menu{$choice1}->{'select2'}.	Line 703 $menu{$choice1}->{'select2'}.
C1 => "Choice C1",	C1 => "Choice C1",
C2 => "Choice C2",	C2 => "Choice C2",
C3 => "Choice C3"	C3 => "Choice C3"
}	},
	order => ['C2','C1','C3'],
},	},
A3 => { text =>"Choice A3" ,	A3 => { text =>"Choice A3" ,
default => "D6",	default => "D6",
Line 598 $menu{$choice1}->{'select2'}.	Line 716 $menu{$choice1}->{'select2'}.
D5 => "Choice D5",	D5 => "Choice D5",
D6 => "Choice D6",	D6 => "Choice D6",
D7 => "Choice D7"	D7 => "Choice D7"
}	},
	order => ['D4','D3','D2','D1','D7','D6','D5'],
}	}
);	);

Line 610 sub linked_select_forms {	Line 729 sub linked_select_forms {
$firstdefault,	$firstdefault,
$firstselectname,	$firstselectname,
$secondselectname,	$secondselectname,
$hashref	$hashref,
	$menuorder,
) = @_;	) = @_;
my $second = "document.$formname.$secondselectname";	my $second = "document.$formname.$secondselectname";
my $first = "document.$formname.$firstselectname";	my $first = "document.$formname.$firstselectname";
Line 624 sub linked_select_forms {	Line 744 sub linked_select_forms {
$result.="select2data.d_$s1 = new Object();\n";	$result.="select2data.d_$s1 = new Object();\n";
$result.="select2data.d_$s1.def = new String('".	$result.="select2data.d_$s1.def = new String('".
$hashref->{$s1}->{'default'}."');\n";	$hashref->{$s1}->{'default'}."');\n";
$result.="select2data.d_$s1.values = new Array(";	$result.="select2data.d_$s1.values = new Array(";
my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));	my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
	if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
	@s2values = @{$hashref->{$s1}->{'order'}};
	}
$result.="\"@s2values\");\n";	$result.="\"@s2values\");\n";
$result.="select2data.d_$s1.texts = new Array(";	$result.="select2data.d_$s1.texts = new Array(";
my @s2texts;	my @s2texts;
Line 663 function select1_changed() {	Line 786 function select1_changed() {
END	END
# output the initial values for the selection lists	# output the initial values for the selection lists
$result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";	$result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
foreach my $value (sort(keys(%$hashref))) {	my @order = sort(keys(%{$hashref}));
	if (ref($menuorder) eq 'ARRAY') {
	@order = @{$menuorder};
	}
	foreach my $value (@order) {
$result.=" <option value=\"$value\" ";	$result.=" <option value=\"$value\" ";
$result.=" selected=\"selected\" " if ($value eq $firstdefault);	$result.=" selected=\"selected\" " if ($value eq $firstdefault);
$result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";	$result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
Line 673 END	Line 800 END
$result .= $middletext;	$result .= $middletext;
$result .= "<select size=\"1\" name=\"$secondselectname\">\n";	$result .= "<select size=\"1\" name=\"$secondselectname\">\n";
my $seconddefault = $hashref->{$firstdefault}->{'default'};	my $seconddefault = $hashref->{$firstdefault}->{'default'};
foreach my $value (sort(keys(%select2))) {
	my @secondorder = sort(keys(%select2));
	if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
	@secondorder = @{$hashref->{$firstdefault}->{'order'}};
	}
	foreach my $value (@secondorder) {
$result.=" <option value=\"$value\" ";	$result.=" <option value=\"$value\" ";
$result.=" selected=\"selected\" " if ($value eq $seconddefault);	$result.=" selected=\"selected\" " if ($value eq $seconddefault);
$result.=">".&mt($select2{$value})."</option>\n";	$result.=">".&mt($select2{$value})."</option>\n";
Line 685 END	Line 817 END

=pod	=pod

=item * help_open_topic($topic, $text, $stayOnPage, $width, $height)	=item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)

Returns a string corresponding to an HTML link to the given help	Returns a string corresponding to an HTML link to the given help
$topic, where $topic corresponds to the name of a .tex file in	$topic, where $topic corresponds to the name of a .tex file in
Line 721 sub help_open_topic {	Line 853 sub help_open_topic {

my $template = "";	my $template = "";
my $link;	my $link;

$topic=~s/\W/\_/g;	$topic=~s/\W/\_/g;

if (!$stayOnPage)	if (!$stayOnPage) {
{
$link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";	$link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
}	} else {
else
{
$link = "/adm/help/${filename}.hlp";	$link = "/adm/help/${filename}.hlp";
}	}

# Add the text	# Add the text
if ($text ne "")	if ($text ne "") {
{
$template .=	$template .=
"<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".	"<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
"<td bgcolor='#5555FF'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";	"<td bgcolor='#5555FF'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
}	}

# Add the graphic	# Add the graphic
my $title = &mt('Online Help');	my $title = &mt('Online Help');
my $helpicon=&lonhttpdurl("/adm/help/gif/smallHelp.gif");	my $helpicon=&lonhttpdurl("/res/adm/pages/help.png");
$template .= <<"ENDTEMPLATE";	$template .= <<"ENDTEMPLATE";
<a target="_top" href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>	<a target="_top" href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
ENDTEMPLATE	ENDTEMPLATE
Line 764 sub helpLatexCheatsheet {	Line 892 sub helpLatexCheatsheet {
}	}
return '<table><tr><td>'.	return '<table><tr><td>'.
$addOther .	$addOther .
&Apache::loncommon::help_open_topic("Greek_Symbols",'Greek Symbols',	&Apache::loncommon::help_open_topic("Greek_Symbols",&mt('Greek Symbols'),
undef,undef,600)	undef,undef,600)
.'</td><td>'.	.'</td><td>'.
&Apache::loncommon::help_open_topic("Other_Symbols",'Other Symbols',	&Apache::loncommon::help_open_topic("Other_Symbols",&mt('Other Symbols'),
undef,undef,600)	undef,undef,600)
.'</td></tr></table>';	.'</td></tr></table>';
}	}
Line 805 sub help_open_menu {	Line 933 sub help_open_menu {
my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)	my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
= @_;	= @_;
$stayOnPage = 0 if (not defined $stayOnPage);	$stayOnPage = 0 if (not defined $stayOnPage);
# formerly only used pop-up help (stayOnPage = 0)	# only use pop-up help (stayOnPage == 0)
# if environment.remote is on (using remote control UI)	# if environment.remote is on (using remote control UI)
# if ($env{'browser.interface'} eq 'textual' \|\|	if ($env{'browser.interface'} eq 'textual' \|\|
# $env{'environment.remote'} eq 'off' ) {	$env{'environment.remote'} eq 'off' ) {
# $stayOnPage=1;
#}
# Now making pop-up help the default even with remote control
if ($env{'browser.interface'} eq 'textual') {
$stayOnPage=1;	$stayOnPage=1;
}	}
my $output;	my $output;
Line 834 sub help_open_menu {	Line 958 sub help_open_menu {

sub top_nav_help {	sub top_nav_help {
my ($text) = @_;	my ($text) = @_;

$text = &mt($text);	$text = &mt($text);
	my $stay_on_page =
my $stayOnPage =
($env{'browser.interface'} eq 'textual' \|\|	($env{'browser.interface'} eq 'textual' \|\|
$env{'environment.remote'} eq 'off' );	$env{'environment.remote'} eq 'off' );
my $link= ($stayOnPage) ? "javascript:helpMenu('display')"	my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
: "javascript:helpMenu('open')";	: "javascript:helpMenu('open')";
my $banner_link = &update_help_link(undef,undef,undef,undef,$stayOnPage);	my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);

my $title = &mt('Get help');	my $title = &mt('Get help');

Line 870 sub help_menu_js {	Line 992 sub help_menu_js {
'js_ready' => 1,	'js_ready' => 1,
'add_entries' => {	'add_entries' => {
'border' => '0',	'border' => '0',
'rows' => "105,*",},});	'rows' => "110,*",},});
my $end_page =	my $end_page =
&Apache::loncommon::end_page({'frameset' => 1,	&Apache::loncommon::end_page({'frameset' => 1,
'js_ready' => 1,});	'js_ready' => 1,});
Line 1005 ENDTEMPLATE	Line 1127 ENDTEMPLATE

=pod	=pod

=item * change_content_javascript():	=item * &change_content_javascript():

This and the next function allow you to create small sections of an	This and the next function allow you to create small sections of an
otherwise static HTML page that you can update on the fly with	otherwise static HTML page that you can update on the fly with
Line 1060 DOMBASED	Line 1182 DOMBASED

=pod	=pod

=item * changable_area($name, $origContent):	=item * &changable_area($name,$origContent):

This provides a "changable area" that can be modified on the fly via	This provides a "changable area" that can be modified on the fly via
the Javascript code provided in C<change_content_javascript>. $name is	the Javascript code provided in C<change_content_javascript>. $name is
Line 1084 sub changable_area {	Line 1206 sub changable_area {

=pod	=pod

=item * resize_textarea_js	=item * &viewport_geometry_js

	Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.

	=cut


	sub viewport_geometry_js {
	return <<"GEOMETRY";
	var Geometry = {};
	function init_geometry() {
	if (Geometry.init) { return };
	Geometry.init=1;
	if (window.innerHeight) {
	Geometry.getViewportHeight = function() { return window.innerHeight; };
	Geometry.getViewportWidth = function() { return window.innerWidth; };
	Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
	Geometry.getVerticalScroll = function() { return window.pageYOffset; };
	}
	else if (document.documentElement && document.documentElement.clientHeight) {
	Geometry.getViewportHeight =
	function() { return document.documentElement.clientHeight; };
	Geometry.getViewportWidth =
	function() { return document.documentElement.clientWidth; };

	Geometry.getHorizontalScroll =
	function() { return document.documentElement.scrollLeft; };
	Geometry.getVerticalScroll =
	function() { return document.documentElement.scrollTop; };
	}
	else if (document.body.clientHeight) {
	Geometry.getViewportHeight =
	function() { return document.body.clientHeight; };
	Geometry.getViewportWidth =
	function() { return document.body.clientWidth; };
	Geometry.getHorizontalScroll =
	function() { return document.body.scrollLeft; };
	Geometry.getVerticalScroll =
	function() { return document.body.scrollTop; };
	}
	}

	GEOMETRY
	}

	=pod

	=item * &viewport_size_js()

	Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window.

	=cut

	sub viewport_size_js {
	my $geometry = &viewport_geometry_js();
	return <<"DIMS";

	$geometry

	function getViewportDims(width,height) {
	init_geometry();
	width.value = Geometry.getViewportWidth();
	height.value = Geometry.getViewportHeight();
	return;
	}

	DIMS
	}

	=pod

	=item * &resize_textarea_js()

emits the needed javascript to resize a textarea to be as big as possible	emits the needed javascript to resize a textarea to be as big as possible

Line 1093 the id of the element to resize, second	Line 1286 the id of the element to resize, second
surrounds everything that comes after the textarea, this routine needs	surrounds everything that comes after the textarea, this routine needs
to be attached to the <body> for the onload and onresize events.	to be attached to the <body> for the onload and onresize events.

	=back

=cut	=cut

sub resize_textarea_js {	sub resize_textarea_js {
	my $geometry = &viewport_geometry_js();
return <<"RESIZE";	return <<"RESIZE";
<script type="text/javascript">	<script type="text/javascript">
var Geometry = {};	$geometry
function init_geometry() {
if (Geometry.init) { return };	function getX(element) {
Geometry.init=1;	var x = 0;
if (window.innerHeight) {	while (element) {
Geometry.getViewportHeight = function() { return window.innerHeight; };	x += element.offsetLeft;
}	element = element.offsetParent;
else if (document.documentElement && document.documentElement.clientHeight) {	}
Geometry.getViewportHeight =	return x;
function() { return document.documentElement.clientHeight; };	}
}	function getY(element) {
else if (document.body.clientHeight) {	var y = 0;
Geometry.getViewportHeight =	while (element) {
function() { return document.body.clientHeight; };	y += element.offsetTop;
	element = element.offsetParent;
}	}
	return y;
}	}


function resize_textarea(textarea_id,bottom_id) {	function resize_textarea(textarea_id,bottom_id) {
init_geometry();	init_geometry();
var textarea = document.getElementById(textarea_id);	var textarea = document.getElementById(textarea_id);
//alert(textarea);	//alert(textarea);

var textarea_top = textarea.offsetTop;	var textarea_top = getY(textarea);
var textarea_height = textarea.offsetHeight;	var textarea_height = textarea.offsetHeight;
var bottom = document.getElementById(bottom_id);	var bottom = document.getElementById(bottom_id);
var bottom_top = bottom.offsetTop;	var bottom_top = getY(bottom);
var bottom_height = bottom.offsetHeight;	var bottom_height = bottom.offsetHeight;
var window_height = Geometry.getViewportHeight();	var window_height = Geometry.getViewportHeight();
var fudge = 23;	var fudge = 23;
var new_height = window_height-fudge-textarea_top-bottom_height;	var new_height = window_height-fudge-textarea_top-bottom_height;
if (new_height < 300) {	if (new_height < 300) {
new_height = 300;	new_height = 300;
Line 1141 RESIZE	Line 1339 RESIZE

=pod	=pod

=back

=head1 Excel and CSV file utility routines	=head1 Excel and CSV file utility routines

=over 4	=over 4
Line 1154 RESIZE	Line 1350 RESIZE

=pod	=pod

=item * csv_translate($text)	=item * &csv_translate($text)

Translate $text to allow it to be output as a 'comma separated values'	Translate $text to allow it to be output as a 'comma separated values'
format.	format.
Line 1175 sub csv_translate {	Line 1371 sub csv_translate {

=pod	=pod

=item * define_excel_formats	=item * &define_excel_formats()

Define some commonly used Excel cell formats.	Define some commonly used Excel cell formats.

Line 1231 sub define_excel_formats {	Line 1427 sub define_excel_formats {

=pod	=pod

=item * create_workbook	=item * &create_workbook()

Create an Excel worksheet. If it fails, output message on the	Create an Excel worksheet. If it fails, output message on the
request object and return undefs.	request object and return undefs.
Line 1274 sub create_workbook {	Line 1470 sub create_workbook {

=pod	=pod

=item * create_text_file	=item * &create_text_file()

Create a file to write to and eventually make available to the user.	Create a file to write to and eventually make available to the user.
If file creation fails, outputs an error message on the request object and	If file creation fails, outputs an error message on the request object and
Line 1342 sub domain_select {	Line 1538 sub domain_select {

=over 4	=over 4

=cut	=item * &multiple_select_form($name,$value,$size,$hash,$order)

=item * multiple_select_form($name,$value,$size,$hash,$order)

Returns a string containing a <select> element int multiple mode	Returns a string containing a <select> element int multiple mode

Line 1394 sub multiple_select_form {	Line 1588 sub multiple_select_form {

=pod	=pod

=item * select_form($defdom,$name,%hash)	=item * &select_form($defdom,$name,%hash)

Returns a string containing a <select name='$name' size='1'> form to	Returns a string containing a <select name='$name' size='1'> form to
allow a user to select options from a hash option_name => displayed text.	allow a user to select options from a hash option_name => displayed text.
Line 1481 sub select_level_form {	Line 1675 sub select_level_form {

=pod	=pod

=item * select_dom_form($defdom,$name,$includeempty,$showdomdesc)	=item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc)

Returns a string containing a <select name='$name' size='1'> form to	Returns a string containing a <select name='$name' size='1'> form to
allow a user to select the domain to preform an operation in.	allow a user to select the domain to preform an operation in.
Line 1521 sub select_dom_form {	Line 1715 sub select_dom_form {

=pod	=pod

=item * home_server_option_list($domain)	=item * &home_server_form_item($domain,$name,$defaultflag)

returns a string which contains an <option> list to be used in a	input: 4 arguments (two required, two optional) -
<select> form input. See loncreateuser.pm for an example.	$domain - domain of new user
	$name - name of form element
	$default - Value of 'default' causes a default item to be first
	option, and selected by default.
	$hide - Value of 'hide' causes hiding of the name of the server,
	if 1 server found, or default, if 0 found.
	output: returns 2 items:
	(a) form element which contains either:
	(i) <select name="$name">
	<option value="$hostid1">$hostid $servers{$hostid}</option>
	<option value="$hostid2">$hostid $servers{$hostid}</option>
	</select>
	form item if there are multiple library servers in $domain, or
	(ii) an <input type="hidden" name="$name" value="$hostid" /> form item
	if there is only one library server in $domain.

	(b) number of library servers found.

	See loncreateuser.pm for example of use.

=cut	=cut

#-------------------------------------------	#-------------------------------------------
sub home_server_option_list {	sub home_server_form_item {
my $domain = shift;	my ($domain,$name,$default,$hide) = @_;
my %servers = &Apache::lonnet::get_servers($domain,'library');	my %servers = &Apache::lonnet::get_servers($domain,'library');
my $result = '';	my $result;
foreach my $hostid (sort(keys(%servers))) {	my $numlib = keys(%servers);
$result.=	if ($numlib > 1) {
'<option value="'.$hostid.'">'.	$result .= '<select name="'.$name.'" />'."\n";
$hostid.' '.$servers{$hostid}."</option>\n";	if ($default) {
	$result .= '<option value="default" selected>'.&mt('default').
	'</option>'."\n";
	}
	foreach my $hostid (sort(keys(%servers))) {
	$result.= '<option value="'.$hostid.'">'.
	$hostid.' '.$servers{$hostid}."</option>\n";
	}
	$result .= '</select>'."\n";
	} elsif ($numlib == 1) {
	my $hostid;
	foreach my $item (keys(%servers)) {
	$hostid = $item;
	}
	$result .= '<input type="hidden" name="'.$name.'" value="'.
	$hostid.'" />';
	if (!$hide) {
	$result .= $hostid.' '.$servers{$hostid};
	}
	$result .= "\n";
	} elsif ($default) {
	$result .= '<input type="hidden" name="'.$name.
	'" value="default" />';
	if (!$hide) {
	$result .= &mt('default');
	}
	$result .= "\n";
}	}
return $result;	return ($result,$numlib);
}	}

=pod	=pod
Line 1637 sub decode_user_agent {	Line 1875 sub decode_user_agent {

=over 4	=over 4

=item * authform_xxxxxx	=item * &authform_xxxxxx()

The authform_xxxxxx subroutines provide javascript and html forms which	The authform_xxxxxx subroutines provide javascript and html forms which
handle some of the conveniences required for authentication forms.	handle some of the conveniences required for authentication forms.
This is not an optimal method, but it works.	This is not an optimal method, but it works.

See loncreateuser.pm for invocation and use examples.

=over 4	=over 4

=item * authform_header	=item * authform_header
Line 1661 See loncreateuser.pm for invocation and	Line 1897 See loncreateuser.pm for invocation and

=back	=back

=back	See loncreateuser.pm for invocation and use examples.

=cut	=cut

Line 1691 END	Line 1927 END
}	}

my $radioval = "'nochange'";	my $radioval = "'nochange'";
if (exists($in{'curr_authtype'}) &&	if (defined($in{'curr_authtype'})) {
defined($in{'curr_authtype'}) &&	if ($in{'curr_authtype'} ne '') {
$in{'curr_authtype'} ne '') {	$radioval = "'".$in{'curr_authtype'}."arg'";
$radioval = "'$in{'curr_authtype'}arg'";	}
}	}
my $argfield = 'null';	my $argfield = 'null';
if ( grep/^mode$/,(keys %in) ) {	if (defined($in{'mode'})) {
if ($in{'mode'} eq 'modifycourse') {	if ($in{'mode'} eq 'modifycourse') {
if ( grep/^curr_authtype$/,(keys %in) ) {	if (defined($in{'curr_autharg'})) {
$radioval = "'$in{'curr_authtype'}'";	if ($in{'curr_autharg'} ne '') {
}
if ( grep/^curr_autharg$/,(keys %in) ) {
unless ($in{'curr_autharg'} eq '') {
$argfield = "'$in{'curr_autharg'}'";	$argfield = "'$in{'curr_autharg'}'";
}	}
}	}
Line 1786 sub authform_nochange{	Line 2019 sub authform_nochange{
kerb_def_dom => 'MSU.EDU',	kerb_def_dom => 'MSU.EDU',
@_,	@_,
);	);
my $result = '<label>'.&mt('[_1] Do not change login data',	my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
'<input type="radio" name="login" value="nochange" '.	my $result;
'checked="checked" onclick="'.	if (keys(%can_assign) == 0) {
	$result = &mt('Under you current role you are not permitted to change login settings for this user');
	} else {
	$result = '<label>'.&mt('[_1] Do not change login data',
	'<input type="radio" name="login" value="nochange" '.
	'checked="checked" onclick="'.
"javascript:changed_radio('nochange',$in{'formname'});".'" />').	"javascript:changed_radio('nochange',$in{'formname'});".'" />').
'</label>';	'</label>';
	}
return $result;	return $result;
}	}

sub authform_kerberos{	sub authform_kerberos {
my %in = (	my %in = (
formname => 'document.cu',	formname => 'document.cu',
kerb_def_dom => 'MSU.EDU',	kerb_def_dom => 'MSU.EDU',
kerb_def_auth => 'krb4',	kerb_def_auth => 'krb4',
@_,	@_,
);	);
my ($check4,$check5,$krbarg);	my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
	$autharg,$jscall);
	my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
if ($in{'kerb_def_auth'} eq 'krb5') {	if ($in{'kerb_def_auth'} eq 'krb5') {
$check5 = " checked=\"on\"";	$check5 = ' checked="on"';
} else {	} else {
$check4 = " checked=\"on\"";	$check4 = ' checked="on"';
}	}
$krbarg = $in{'kerb_def_dom'};	$krbarg = $in{'kerb_def_dom'};
	if (defined($in{'curr_authtype'})) {
my $krbcheck = "";	if ($in{'curr_authtype'} eq 'krb') {
if ( grep/^curr_authtype$/,(keys %in) ) {	$krbcheck = ' checked="on"';
if ($in{'curr_authtype'} =~ m/^krb/) {	if (defined($in{'mode'})) {
$krbcheck = " checked=\"on\"";	if ($in{'mode'} eq 'modifyuser') {
if ( grep/^curr_autharg$/,(keys %in) ) {	$krbcheck = '';
	}
	}
	if (defined($in{'curr_kerb_ver'})) {
	if ($in{'curr_krb_ver'} eq '5') {
	$check5 = ' checked="on"';
	$check4 = '';
	} else {
	$check4 = ' checked="on"';
	$check5 = '';
	}
	}
	if (defined($in{'curr_autharg'})) {
$krbarg = $in{'curr_autharg'};	$krbarg = $in{'curr_autharg'};
}	}
	if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
	if (defined($in{'curr_autharg'})) {
	$result =
	&mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
	$in{'curr_autharg'},$krbver);
	} else {
	$result =
	&mt('Currently Kerberos authenticated, Version [_1].',$krbver);
	}
	return $result;
	}
	}
	} else {
	if ($authnum == 1) {
	$authtype = '<input type="hidden" name="login" value="krb">';
}	}
}	}
	if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
my $jscall = "javascript:changed_radio('krb',$in{'formname'});";	return;
my $result .= &mt	} elsif ($authtype eq '') {
	if (defined($in{'mode'})) {
	if ($in{'mode'} eq 'modifycourse') {
	if ($authnum == 1) {
	$authtype = '<input type="hidden" name="login" value="krb">';
	}
	}
	}
	}
	$jscall = "javascript:changed_radio('krb',$in{'formname'});";
	if ($authtype eq '') {
	$authtype = '<input type="radio" name="login" value="krb" '.
	'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
	$krbcheck.' />';
	}
	if (($can_assign{'krb4'} && $can_assign{'krb5'}) \|\|
	($can_assign{'krb4'} && !$can_assign{'krb5'} &&
	$in{'curr_authtype'} eq 'krb5') \|\|
	(!$can_assign{'krb4'} && $can_assign{'krb5'} &&
	$in{'curr_authtype'} eq 'krb4')) {
	$result .= &mt
('[_1] Kerberos authenticated with domain [_2] '.	('[_1] Kerberos authenticated with domain [_2] '.
'[_3] Version 4 [_4] Version 5 [_5]',	'[_3] Version 4 [_4] Version 5 [_5]',
'<label><input type="radio" name="login" value="krb" '.	'<label>'.$authtype,
'onclick="'.$jscall.'" onchange="'.$jscall.'"'.$krbcheck.' />',
'</label><input type="text" size="10" name="krbarg" '.	'</label><input type="text" size="10" name="krbarg" '.
'value="'.$krbarg.'" '.	'value="'.$krbarg.'" '.
'onchange="'.$jscall.'" />',	'onchange="'.$jscall.'" />',
'<label><input type="radio" name="krbver" value="4" '.$check4.' />',	'<label><input type="radio" name="krbver" value="4" '.$check4.' />',
'</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',	'</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
'</label>');	'</label>');
	} elsif ($can_assign{'krb4'}) {
	$result .= &mt
	('[_1] Kerberos authenticated with domain [_2] '.
	'[_3] Version 4 [_4]',
	'<label>'.$authtype,
	'</label><input type="text" size="10" name="krbarg" '.
	'value="'.$krbarg.'" '.
	'onchange="'.$jscall.'" />',
	'<label><input type="hidden" name="krbver" value="4" />',
	'</label>');
	} elsif ($can_assign{'krb5'}) {
	$result .= &mt
	('[_1] Kerberos authenticated with domain [_2] '.
	'[_3] Version 5 [_4]',
	'<label>'.$authtype,
	'</label><input type="text" size="10" name="krbarg" '.
	'value="'.$krbarg.'" '.
	'onchange="'.$jscall.'" />',
	'<label><input type="hidden" name="krbver" value="5" />',
	'</label>');
	}
return $result;	return $result;
}	}

sub authform_internal{	sub authform_internal{
my %args = (	my %in = (
formname => 'document.cu',	formname => 'document.cu',
kerb_def_dom => 'MSU.EDU',	kerb_def_dom => 'MSU.EDU',
@_,	@_,
);	);
	my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
my $intcheck = "";	my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
my $intarg = 'value=""';	if (defined($in{'curr_authtype'})) {
if ( grep/^curr_authtype$/,(keys %args) ) {	if ($in{'curr_authtype'} eq 'int') {
if ($args{'curr_authtype'} eq 'int') {	if ($can_assign{'int'}) {
$intcheck = " checked=\"on\"";	$intcheck = 'checked="on" ';
if ( grep/^curr_autharg$/,(keys %args) ) {	if (defined($in{'mode'})) {
$intarg = "value=\"$args{'curr_autharg'}\"";	if ($in{'mode'} eq 'modifyuser') {
	$intcheck = '';
	}
	}
	if (defined($in{'curr_autharg'})) {
	$intarg = $in{'curr_autharg'};
	}
	} else {
	$result = &mt('Currently internally authenticated.');
	return $result;
}	}
}	}
	} else {
	if ($authnum == 1) {
	$authtype = '<input type="hidden" name="login" value="int">';
	}
}	}
	if (!$can_assign{'int'}) {
my $jscall = "javascript:changed_radio('int',$args{'formname'});";	return;
my $result.=&mt	} elsif ($authtype eq '') {
	if (defined($in{'mode'})) {
	if ($in{'mode'} eq 'modifycourse') {
	if ($authnum == 1) {
	$authtype = '<input type="hidden" name="login" value="int">';
	}
	}
	}
	}
	$jscall = "javascript:changed_radio('int',$in{'formname'});";
	if ($authtype eq '') {
	$authtype = '<input type="radio" name="login" value="int" '.$intcheck.
	' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
	}
	$autharg = '<input type="password" size="10" name="intarg" value="'.
	$intarg.'" onchange="'.$jscall.'" />';
	$result = &mt
('[_1] Internally authenticated (with initial password [_2])',	('[_1] Internally authenticated (with initial password [_2])',
'<label><input type="radio" name="login" value="int" '.$intcheck.	'<label>'.$authtype,'</label>'.$autharg);
' onchange="'.$jscall.'" onclick="'.$jscall.'" />',	$result.="<label><input type=\"checkbox\" name=\"visible\" onClick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
'</label><input type="text" size="10" name="intarg" '.$intarg.
' onchange="'.$jscall.'" />');
return $result;	return $result;
}	}

Line 1868 sub authform_local{	Line 2203 sub authform_local{
kerb_def_dom => 'MSU.EDU',	kerb_def_dom => 'MSU.EDU',
@_,	@_,
);	);
	my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
my $loccheck = "";	my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
my $locarg = 'value=""';	if (defined($in{'curr_authtype'})) {
if ( grep/^curr_authtype$/,(keys %in) ) {
if ($in{'curr_authtype'} eq 'loc') {	if ($in{'curr_authtype'} eq 'loc') {
$loccheck = " checked=\"on\"";	if ($can_assign{'loc'}) {
if ( grep/^curr_autharg$/,(keys %in) ) {	$loccheck = 'checked="on" ';
$locarg = "value=\"$in{'curr_autharg'}\"";	if (defined($in{'mode'})) {
	if ($in{'mode'} eq 'modifyuser') {
	$loccheck = '';
	}
	}
	if (defined($in{'curr_autharg'})) {
	$locarg = $in{'curr_autharg'};
	}
	} else {
	$result = &mt('Currently using local (institutional) authentication.');
	return $result;
}	}
}	}
	} else {
	if ($authnum == 1) {
	$authtype = '<input type="hidden" name="login" value="loc">';
	}
}	}
	if (!$can_assign{'loc'}) {
my $jscall = "javascript:changed_radio('loc',$in{'formname'});";	return;
my $result.=&mt('[_1] Local Authentication with argument [_2]',	} elsif ($authtype eq '') {
'<label><input type="radio" name="login" value="loc" '.$loccheck.	if (defined($in{'mode'})) {
' onchange="'.$jscall.'" onclick="'.$jscall.'" />',	if ($in{'mode'} eq 'modifycourse') {
'</label><input type="text" size="10" name="locarg" '.$locarg.	if ($authnum == 1) {
' onchange="'.$jscall.'" />');	$authtype = '<input type="hidden" name="login" value="loc">';
	}
	}
	}
	}
	$jscall = "javascript:changed_radio('loc',$in{'formname'});";
	if ($authtype eq '') {
	$authtype = '<input type="radio" name="login" value="loc" '.
	$loccheck.' onchange="'.$jscall.'" onclick="'.
	$jscall.'" />';
	}
	$autharg = '<input type="text" size="10" name="locarg" value="'.
	$locarg.'" onchange="'.$jscall.'" />';
	$result = &mt('[_1] Local Authentication with argument [_2]',
	'<label>'.$authtype,'</label>'.$autharg);
return $result;	return $result;
}	}

Line 1895 sub authform_filesystem{	Line 2257 sub authform_filesystem{
kerb_def_dom => 'MSU.EDU',	kerb_def_dom => 'MSU.EDU',
@_,	@_,
);	);
my $jscall = "javascript:changed_radio('fsys',$in{'formname'});";	my ($fsyscheck,$result,$authtype,$autharg,$jscall);
my $result.= &mt	my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
	if (defined($in{'curr_authtype'})) {
	if ($in{'curr_authtype'} eq 'fsys') {
	if ($can_assign{'fsys'}) {
	$fsyscheck = 'checked="on" ';
	if (defined($in{'mode'})) {
	if ($in{'mode'} eq 'modifyuser') {
	$fsyscheck = '';
	}
	}
	} else {
	$result = &mt('Currently Filesystem Authenticated.');
	return $result;
	}
	}
	} else {
	if ($authnum == 1) {
	$authtype = '<input type="hidden" name="login" value="fsys">';
	}
	}
	if (!$can_assign{'fsys'}) {
	return;
	} elsif ($authtype eq '') {
	if (defined($in{'mode'})) {
	if ($in{'mode'} eq 'modifycourse') {
	if ($authnum == 1) {
	$authtype = '<input type="hidden" name="login" value="fsys">';
	}
	}
	}
	}
	$jscall = "javascript:changed_radio('fsys',$in{'formname'});";
	if ($authtype eq '') {
	$authtype = '<input type="radio" name="login" value="fsys" '.
	$fsyscheck.' onchange="'.$jscall.'" onclick="'.
	$jscall.'" />';
	}
	$autharg = '<input type="text" size="10" name="fsysarg" value=""'.
	' onchange="'.$jscall.'" />';
	$result = &mt
('[_1] Filesystem Authenticated (with initial password [_2])',	('[_1] Filesystem Authenticated (with initial password [_2])',
'<label><input type="radio" name="login" value="fsys" '.	'<label><input type="radio" name="login" value="fsys" '.
'onchange="'.$jscall.'" onclick="'.$jscall.'" />',	$fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
'</label><input type="text" size="10" name="fsysarg" value="" '.	'</label><input type="password" size="10" name="fsysarg" value="" '.
'onchange="'.$jscall.'" />');	'onchange="'.$jscall.'" />');
return $result;	return $result;
}	}

###############################################################	sub get_assignable_auth {
## Get Authentication Defaults for Domain ##	my ($dom) = @_;
###############################################################	if ($dom eq '') {
	$dom = $env{'request.role.domain'};
=pod	}
	my %can_assign = (
=head1 Domains and Authentication	krb4 => 1,
	krb5 => 1,
Returns default authentication type and an associated argument as	int => 1,
listed in file 'domain.tab'.	loc => 1,
	);
=over 4	my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
	if (ref($domconfig{'usercreation'}) eq 'HASH') {
=item * get_auth_defaults	if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
	my $authhash = $domconfig{'usercreation'}{'authtypes'};
get_auth_defaults($target_domain) returns the default authentication	my $context;
type and an associated argument (initial password or a kerberos domain).	if ($env{'request.role'} =~ /^au/) {
These values are stored in lonTabs/domain.tab	$context = 'author';
	} elsif ($env{'request.role'} =~ /^dc/) {
($def_auth, $def_arg) = &get_auth_defaults($target_domain);	$context = 'domain';
	} elsif ($env{'request.course.id'}) {
If target_domain is not found in domain.tab, returns nothing ('').	$context = 'course';
	}
=cut	if ($context) {
	if (ref($authhash->{$context}) eq 'HASH') {
#-------------------------------------------	%can_assign = %{$authhash->{$context}};
sub get_auth_defaults {	}
my $domain=shift;	}
return (&Apache::lonnet::domain($domain,'auth_def'),	}
&Apache::lonnet::domain($domain,'auth_arg_def'));	}
	my $authnum = 0;
	foreach my $key (keys(%can_assign)) {
	if ($can_assign{$key}) {
	$authnum ++;
	}
	}
	if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
	$authnum --;
	}
	return ($authnum,%can_assign);
}	}
###############################################################
## End Get Authentication Defaults for Domain ##
###############################################################

###############################################################	###############################################################
## Get Kerberos Defaults for Domain ##	## Get Kerberos Defaults for Domain ##
Line 1953 sub get_auth_defaults {	Line 2360 sub get_auth_defaults {

=pod	=pod

=item * get_kerberos_defaults	=item * &get_kerberos_defaults()

get_kerberos_defaults($target_domain) returns the default kerberos	get_kerberos_defaults($target_domain) returns the default kerberos
version and domain. If not found in domain.tabs, it defaults to	version and domain. If not found, it defaults to version 4 and the
version 4 and the domain of the server.	domain of the server.

	=over 4

($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);	($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);

	=back

	=back

=cut	=cut

#-------------------------------------------	#-------------------------------------------
sub get_kerberos_defaults {	sub get_kerberos_defaults {
my $domain=shift;	my $domain=shift;
my ($krbdef,$krbdefdom) =	my ($krbdef,$krbdefdom);
&Apache::loncommon::get_auth_defaults($domain);	my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
unless ($krbdef =~/^krb/ && $krbdefdom) {	if (($domdefaults{'auth_def'} =~/^krb(4\|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
	$krbdef = $domdefaults{'auth_def'};
	$krbdefdom = $domdefaults{'auth_arg_def'};
	} else {
$ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;	$ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
my $krbdefdom=$1;	my $krbdefdom=$1;
$krbdefdom=~tr/a-z/A-Z/;	$krbdefdom=~tr/a-z/A-Z/;
Line 1977 sub get_kerberos_defaults {	Line 2393 sub get_kerberos_defaults {
return ($krbdef,$krbdefdom);	return ($krbdef,$krbdefdom);
}	}

=pod

=back

=cut

###############################################################	###############################################################
## Thesaurus Functions ##	## Thesaurus Functions ##
Line 1993 sub get_kerberos_defaults {	Line 2404 sub get_kerberos_defaults {

=over 4	=over 4

=item * initialize_keywords	=item * &initialize_keywords()

Initializes the package variable %Keywords if it is empty. Uses the	Initializes the package variable %Keywords if it is empty. Uses the
package variable $thesaurus_db_file.	package variable $thesaurus_db_file.
Line 2030 sub initialize_keywords {	Line 2441 sub initialize_keywords {
# Remove special values from %Keywords.	# Remove special values from %Keywords.
foreach my $value ('total.count','average.count') {	foreach my $value ('total.count','average.count') {
delete($Keywords{$value}) if (exists($Keywords{$value}));	delete($Keywords{$value}) if (exists($Keywords{$value}));
}	}
return 1;	return 1;
}	}

Line 2038 sub initialize_keywords {	Line 2449 sub initialize_keywords {

=pod	=pod

=item * keyword($word)	=item * &keyword($word)

Returns true if $word is a keyword. A keyword is a word that appears more	Returns true if $word is a keyword. A keyword is a word that appears more
than the average number of times in the thesaurus database. Calls	than the average number of times in the thesaurus database. Calls
Line 2059 sub keyword {	Line 2470 sub keyword {

=pod	=pod

=item * get_related_words	=item * &get_related_words()

Look up a word in the thesaurus. Takes a scalar argument and returns	Look up a word in the thesaurus. Takes a scalar argument and returns
an array of words. If the keyword is not in the thesaurus, an empty array	an array of words. If the keyword is not in the thesaurus, an empty array
Line 2117 sub get_related_words {	Line 2528 sub get_related_words {

=over 4	=over 4

=item * plainname($uname,$udom,$first)	=item * &plainname($uname,$udom,$first)

Takes a users logon name and returns it as a string in	Takes a users logon name and returns it as a string in
"first middle last generation" form	"first middle last generation" form
Line 2146 sub plainname {	Line 2557 sub plainname {
# -------------------------------------------------------------------- Nickname	# -------------------------------------------------------------------- Nickname
=pod	=pod

=item * nickname($uname,$udom)	=item * &nickname($uname,$udom)

Gets a users name and returns it as a string as	Gets a users name and returns it as a string as

Line 2196 sub getnames {	Line 2607 sub getnames {
}	}

# -------------------------------------------------------------------- getemails	# -------------------------------------------------------------------- getemails

=pod	=pod

=item * getemails($uname,$udom)	=item * &getemails($uname,$udom)

Gets a user's email information and returns it as a hash with keys:	Gets a user's email information and returns it as a hash with keys:
notification, critnotification, permanentemail	notification, critnotification, permanentemail

For notification and critnotification, values are comma-separated lists	For notification and critnotification, values are comma-separated lists
of e-mail address(es); for permanentemail, value is a single e-mail address.	of e-mail addresses; for permanentemail, value is a single e-mail address.


=cut	=cut


sub getemails {	sub getemails {
my ($uname,$udom)=@_;	my ($uname,$udom)=@_;
if ($udom eq 'public' && $uname eq 'public') {	if ($udom eq 'public' && $uname eq 'public') {
Line 2242 sub flush_email_cache {	Line 2656 sub flush_email_cache {

=pod	=pod

=item * screenname($uname,$udom)	=item * &screenname($uname,$udom)

Gets a users screenname and returns it as a string	Gets a users screenname and returns it as a string

Line 2338 sub student_image_tag {	Line 2752 sub student_image_tag {

=over 4	=over 4

=item * languageids()	=item * &languageids()

returns list of all language ids	returns list of all language ids

Line 2350 sub languageids {	Line 2764 sub languageids {

=pod	=pod

=item * languagedescription()	=item * &languagedescription()

returns description of a specified language id	returns description of a specified language id

Line 2375 sub supportedlanguagecode {	Line 2789 sub supportedlanguagecode {

=pod	=pod

=item * copyrightids()	=item * &copyrightids()

returns list of all copyrights	returns list of all copyrights

Line 2387 sub copyrightids {	Line 2801 sub copyrightids {

=pod	=pod

=item * copyrightdescription()	=item * &copyrightdescription()

returns description of a specified copyright id	returns description of a specified copyright id

Line 2399 sub copyrightdescription {	Line 2813 sub copyrightdescription {

=pod	=pod

=item * source_copyrightids()	=item * &source_copyrightids()

returns list of all source copyrights	returns list of all source copyrights

Line 2411 sub source_copyrightids {	Line 2825 sub source_copyrightids {

=pod	=pod

=item * source_copyrightdescription()	=item * &source_copyrightdescription()

returns description of a specified source copyright id	returns description of a specified source copyright id

Line 2423 sub source_copyrightdescription {	Line 2837 sub source_copyrightdescription {

=pod	=pod

=item * filecategories()	=item * &filecategories()

returns list of all file categories	returns list of all file categories

Line 2435 sub filecategories {	Line 2849 sub filecategories {

=pod	=pod

=item * filecategorytypes()	=item * &filecategorytypes()

returns list of file types belonging to a given file	returns list of file types belonging to a given file
category	category
Line 2449 sub filecategorytypes {	Line 2863 sub filecategorytypes {

=pod	=pod

=item * fileembstyle()	=item * &fileembstyle()

returns embedding style for a specified file type	returns embedding style for a specified file type

Line 2473 sub filecategoryselect {	Line 2887 sub filecategoryselect {

=pod	=pod

=item * filedescription()	=item * &filedescription()

returns description for a specified file type	returns description for a specified file type

Line 2487 sub filedescription {	Line 2901 sub filedescription {

=pod	=pod

=item * filedescriptionex()	=item * &filedescriptionex()

returns description for a specified file type with	returns description for a specified file type with
extra formatting	extra formatting
Line 2533 sub display_languages {	Line 2947 sub display_languages {

sub preferred_languages {	sub preferred_languages {
my @languages=();	my @languages=();
	if (($env{'request.role.adv'}) && ($env{'form.languages'})) {
	@languages=(@languages,split(/\s(\,\|\;\|\:)\s/,$env{'form.languages'}));
	}
if ($env{'course.'.$env{'request.course.id'}.'.languages'}) {	if ($env{'course.'.$env{'request.course.id'}.'.languages'}) {
@languages=(@languages,split(/\s(\,\|\;\|\:)\s/,	@languages=(@languages,split(/\s(\,\|\;\|\:)\s/,
$env{'course.'.$env{'request.course.id'}.'.languages'}));	$env{'course.'.$env{'request.course.id'}.'.languages'}));
}	}

if ($env{'environment.languages'}) {	if ($env{'environment.languages'}) {
@languages=(@languages,	@languages=(@languages,
split(/\s(\,\|\;\|\:)\s/,$env{'environment.languages'}));	split(/\s(\,\|\;\|\:)\s/,$env{'environment.languages'}));
}	}
my $browser=(split(/\;/,$ENV{'HTTP_ACCEPT_LANGUAGE'}))[0];	my $browser=$ENV{'HTTP_ACCEPT_LANGUAGE'};
if ($browser) {	if ($browser) {
@languages=(@languages,split(/\s(\,\|\;\|\:)\s/,$browser));	my @browser =
}	map { (split(/\s;\s/,$_))[0] } (split(/\s,\s/,$browser));
if (&Apache::lonnet::domain($env{'user.domain'},'lang_def')) {	push(@languages,@browser);
@languages=(@languages,
&Apache::lonnet::domain($env{'user.domain'},
'lang_def'));
}	}
if (&Apache::lonnet::domain($env{'request.role.domain'},'lang_def')) {
@languages=(@languages,	foreach my $domtype ($env{'user.domain'},$env{'request.role.domain'},
&Apache::lonnet::domain($env{'request.role.domain'},	$Apache::lonnet::perlvar{'lonDefDomain'}) {
'lang_def'));	if ($domtype ne '') {
}	my %domdefs = &Apache::lonnet::get_domain_defaults($domtype);
if (&Apache::lonnet::domain($Apache::lonnet::perlvar{'lonDefDomain'},	if ($domdefs{'lang_def'} ne '') {
'lang_def')) {	push(@languages,$domdefs{'lang_def'});
@languages=(@languages,	}
&Apache::lonnet::domain($Apache::lonnet::perlvar{'lonDefDomain'},	}
'lang_def'));
}	}
# turn "en-ca" into "en-ca,en"	# turn "en-ca" into "en-ca,en"
my @genlanguages;	my @genlanguages;
foreach my $lang (@languages) {	foreach my $lang (@languages) {
unless ($lang=~/\w/) { next; }	unless ($lang=~/\w/) { next; }
push (@genlanguages,$lang);	push(@genlanguages,$lang);
if ($lang=~/(\-\|\_)/) {	if ($lang=~/(\-\|\_)/) {
push(@genlanguages,(split(/(\-\|\_)/,$lang))[0]);	push(@genlanguages,(split(/(\-\|\_)/,$lang))[0]);
}	}
}	}
	#uniqueify the languages list
	my %count;
	@genlanguages = map { $count{$_}++ == 0 ? $_ : () } @genlanguages;
return @genlanguages;	return @genlanguages;
}	}

	sub languages {
	my ($possible_langs) = @_;
	my @preferred_langs = &preferred_languages();
	if (!ref($possible_langs)) {
	if( wantarray ) {
	return @preferred_langs;
	} else {
	return $preferred_langs[0];
	}
	}
	my %possibilities = map { $_ => 1 } (@$possible_langs);
	my @preferred_possibilities;
	foreach my $preferred_lang (@preferred_langs) {
	if (exists($possibilities{$preferred_lang})) {
	push(@preferred_possibilities, $preferred_lang);
	}
	}
	if( wantarray ) {
	return @preferred_possibilities;
	}
	return $preferred_possibilities[0];
	}

###############################################################	###############################################################
## Student Answer Attempts ##	## Student Answer Attempts ##
###############################################################	###############################################################
Line 2583 sub preferred_languages {	Line 3023 sub preferred_languages {

=over 4	=over 4

=item * get_previous_attempt($symb, $username, $domain, $course,	=item * &get_previous_attempt($symb, $username, $domain, $course,
$getattempt, $regexp, $gradesub)	$getattempt, $regexp, $gradesub)

Return string with previous attempt on problem. Arguments:	Return string with previous attempt on problem. Arguments:
Line 2627 sub get_previous_attempt {	Line 3067 sub get_previous_attempt {
$lasthash{$key}=$returnhash{$version.':'.$key};	$lasthash{$key}=$returnhash{$version.':'.$key};
}	}
}	}
$prevattempts='<table border="0" width="100%"><tr><td bgcolor="#777777">';	$prevattempts=&start_data_table().&start_data_table_header_row();
$prevattempts.='<table border="0" width="100%"><tr bgcolor="#e6ffff"><td>History</td>';	$prevattempts.='<th>'.&mt('History').'</th>';
foreach my $key (sort(keys(%lasthash))) {	foreach my $key (sort(keys(%lasthash))) {
my ($ign,@parts) = split(/\./,$key);	my ($ign,@parts) = split(/\./,$key);
if ($#parts > 0) {	if ($#parts > 0) {
my $data=$parts[-1];	my $data=$parts[-1];
pop(@parts);	pop(@parts);
$prevattempts.='<td>Part '.join('.',@parts).'<br />'.$data.' </td>';	$prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
} else {	} else {
if ($#parts == 0) {	if ($#parts == 0) {
$prevattempts.='<th>'.$parts[0].'</th>';	$prevattempts.='<th>'.$parts[0].'</th>';
Line 2643 sub get_previous_attempt {	Line 3083 sub get_previous_attempt {
}	}
}	}
}	}
	$prevattempts.=&end_data_table_header_row();
if ($getattempt eq '') {	if ($getattempt eq '') {
for ($version=1;$version<=$returnhash{'version'};$version++) {	for ($version=1;$version<=$returnhash{'version'};$version++) {
$prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Transaction '.$version.'</td>';	$prevattempts.=&start_data_table_row().
	'<td>'.&mt('Transaction [_1]',$version).'</td>';
foreach my $key (sort(keys(%lasthash))) {	foreach my $key (sort(keys(%lasthash))) {
my $value;	my $value = &format_previous_attempt_value($key,
if ($key =~ /timestamp/) {	$returnhash{$version.':'.$key});
$value=scalar(localtime($returnhash{$version.':'.$key}));	$prevattempts.='<td>'.$value.' </td>';
} else {
$value=$returnhash{$version.':'.$key};
}
$prevattempts.='<td>'.&unescape($value).' </td>';
}	}
	$prevattempts.=&end_data_table_row();
}	}
}	}
$prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Current</td>';	$prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
foreach my $key (sort(keys(%lasthash))) {	foreach my $key (sort(keys(%lasthash))) {
my $value;	my $value = &format_previous_attempt_value($key,$lasthash{$key});
if ($key =~ /timestamp/) {
$value=scalar(localtime($lasthash{$key}));
} else {
$value=$lasthash{$key};
}
$value=&unescape($value);
if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}	if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
$prevattempts.='<td>'.$value.' </td>';	$prevattempts.='<td>'.$value.' </td>';
}	}
$prevattempts.='</tr></table></td></tr></table>';	$prevattempts.= &end_data_table_row().&end_data_table();
} else {	} else {
$prevattempts='Nothing submitted - no attempts.';	$prevattempts=
	&start_data_table().&start_data_table_row().
	'<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
	&end_data_table_row().&end_data_table();
}	}
} else {	} else {
$prevattempts='No data.';	$prevattempts=
	&start_data_table().&start_data_table_row().
	'<td>'.&mt('No data.').'</td>'.
	&end_data_table_row().&end_data_table();
}	}
}	}

	sub format_previous_attempt_value {
	my ($key,$value) = @_;
	if ($key =~ /timestamp/) {
	$value = &Apache::lonlocal::locallocaltime($value);
	} elsif (ref($value) eq 'ARRAY') {
	$value = '('.join(', ', @{ $value }).')';
	} else {
	$value = &unescape($value);
	}
	return $value;
	}


sub relative_to_absolute {	sub relative_to_absolute {
my ($url,$output)=@_;	my ($url,$output)=@_;
my $parser=HTML::TokeParser->new(\$output);	my $parser=HTML::TokeParser->new(\$output);
Line 2715 sub relative_to_absolute {	Line 3167 sub relative_to_absolute {

=pod	=pod

=item * get_student_view	=item * &get_student_view()

show a snapshot of what student was looking at	show a snapshot of what student was looking at

Line 2734 sub get_student_view {	Line 3186 sub get_student_view {
}	}
if (defined($target)) { $form{'grade_target'} = $target; }	if (defined($target)) { $form{'grade_target'} = $target; }
$feedurl=&Apache::lonnet::clutter($feedurl);	$feedurl=&Apache::lonnet::clutter($feedurl);
my $userview=&Apache::lonnet::ssi_body($feedurl,%form);	my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
$userview=~s/\<body[^\>]*\>//gi;	$userview=~s/\<body[^\>]*\>//gi;
$userview=~s/\<\/body\>//gi;	$userview=~s/\<\/body\>//gi;
$userview=~s/\<html\>//gi;	$userview=~s/\<html\>//gi;
Line 2743 sub get_student_view {	Line 3195 sub get_student_view {
$userview=~s/\<\/head\>//gi;	$userview=~s/\<\/head\>//gi;
$userview=~s/action\s*\=/would_be_action\=/gi;	$userview=~s/action\s*\=/would_be_action\=/gi;
$userview=&relative_to_absolute($feedurl,$userview);	$userview=&relative_to_absolute($feedurl,$userview);
return $userview;	if (wantarray) {
	return ($userview,$response);
	} else {
	return $userview;
	}
	}

	sub get_student_view_with_retries {
	my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;

	my $ok = 0; # True if we got a good response.
	my $content;
	my $response;

	# Try to get the student_view done. within the retries count:

	do {
	($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
	$ok = $response->is_success;
	if (!$ok) {
	&Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
	}
	$retries--;
	} while (!$ok && ($retries > 0));

	if (!$ok) {
	$content = ''; # On error return an empty content.
	}
	if (wantarray) {
	return ($content, $response);
	} else {
	return $content;
	}
}	}

=pod	=pod

=item * get_student_answers()	=item * &get_student_answers()

show a snapshot of how student was answering problem	show a snapshot of how student was answering problem

Line 2836 sub pprmlink {	Line 3320 sub pprmlink {
if (!$symb) { $symb=&Apache::lonnet::symbread(); }	if (!$symb) { $symb=&Apache::lonnet::symbread(); }
$symb=&escape($symb);	$symb=&escape($symb);
if ($target) { $target="target=\"$target\""; }	if ($target) { $target="target=\"$target\""; }
return '<a href="/adm/parmset?&command=set&'.	return '<a href="/adm/parmset?command=set&'.
'symb='.$symb.'&uname='.$uname.	'symb='.$symb.'&uname='.$uname.
'&udom='.$udom.'" '.$target.'>'.$text.'</a>';	'&udom='.$udom.'" '.$target.'>'.$text.'</a>';
}	}
##############################################	##############################################

Line 3294 sub get_domainconf {	Line 3778 sub get_domainconf {

my %domconfig = &Apache::lonnet::get_dom('configuration',	my %domconfig = &Apache::lonnet::get_dom('configuration',
['login','rolecolors'],$udom);	['login','rolecolors'],$udom);
my %designhash;	my (%designhash,%legacy);
if (keys(%domconfig) > 0) {	if (keys(%domconfig) > 0) {
if (ref($domconfig{'login'}) eq 'HASH') {	if (ref($domconfig{'login'}) eq 'HASH') {
foreach my $key (keys(%{$domconfig{'login'}})) {	if (keys(%{$domconfig{'login'}})) {
$designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};	foreach my $key (keys(%{$domconfig{'login'}})) {
	$designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
	}
	} else {
	$legacy{'login'} = 1;
}	}
	} else {
	$legacy{'login'} = 1;
}	}
if (ref($domconfig{'rolecolors'}) eq 'HASH') {	if (ref($domconfig{'rolecolors'}) eq 'HASH') {
foreach my $role (keys(%{$domconfig{'rolecolors'}})) {	if (keys(%{$domconfig{'rolecolors'}})) {
if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {	foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {	if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
$designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};	foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
	$designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
	}
}	}
}	}
	} else {
	$legacy{'rolecolors'} = 1;
}	}
	} else {
	$legacy{'rolecolors'} = 1;
}	}
} else {	if (keys(%legacy) > 0) {
my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';	my %legacyhash = &get_legacy_domconf($udom);
my $designfile = $designdir.'/'.$udom.'.tab';	foreach my $item (keys(%legacyhash)) {
if (-e $designfile) {	if ($item =~ /^\Q$udom\E\.login/) {
if ( open (my $fh,"<$designfile") ) {	if ($legacy{'login'}) {
while (my $line = <$fh>) {	$designhash{$item} = $legacyhash{$item};
next if ($line =~ /^\#/);	}
chomp($line);	} else {
my ($key,$val)=(split(/\=/,$line));	if ($legacy{'rolecolors'}) {
if ($val) { $designhash{$udom.'.'.$key}=$val; }	$designhash{$item} = $legacyhash{$item};
	}
}	}
close($fh);
}	}
}	}
if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {	} else {
$designhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";	%designhash = &get_legacy_domconf($udom);
}
}	}
&Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,	&Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
$cachetime);	$cachetime);
return %designhash;	return %designhash;
}	}

	sub get_legacy_domconf {
	my ($udom) = @_;
	my %legacyhash;
	my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
	my $designfile = $designdir.'/'.$udom.'.tab';
	if (-e $designfile) {
	if ( open (my $fh,"<$designfile") ) {
	while (my $line = <$fh>) {
	next if ($line =~ /^\#/);
	chomp($line);
	my ($key,$val)=(split(/\=/,$line));
	if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
	}
	close($fh);
	}
	}
	if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
	$legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
	}
	return %legacyhash;
	}

=pod	=pod

=item * &domainlogo()	=item * &domainlogo()
Line 3382 Returns: value of designparamter $which	Line 3899 Returns: value of designparamter $which
sub designparm {	sub designparm {
my ($which,$domain)=@_;	my ($which,$domain)=@_;
if ($env{'browser.blackwhite'} eq 'on') {	if ($env{'browser.blackwhite'} eq 'on') {
if ($which=~/\.(font\|alink\|vlink\|link)$/) {	if ($which=~/\.(font\|alink\|vlink\|link\|textcol)$/) {
return '#000000';	return '#000000';
}	}
if ($which=~/\.(pgbg\|sidebg)$/) {	if ($which=~/\.(pgbg\|sidebg\|bgcol)$/) {
return '#FFFFFF';	return '#FFFFFF';
}	}
if ($which=~/\.tabbg$/) {	if ($which=~/\.tabbg$/) {
Line 3404 sub designparm {	Line 3921 sub designparm {
$output = $defaultdesign{$which};	$output = $defaultdesign{$which};
}	}
if (($which =~ /^(student\|coordinator\|author\|admin)\.img$/) \|\|	if (($which =~ /^(student\|coordinator\|author\|admin)\.img$/) \|\|
($which =~ /login\.(img\|logo\|domlogo)/)) {	($which =~ /login\.(img\|logo\|domlogo\|login)/)) {
if ($output =~ m{^/(adm\|res)/}) {	if ($output =~ m{^/(adm\|res)/}) {
if ($output =~ m{^/res/}) {	if ($output =~ m{^/res/}) {
my $local_name = &Apache::lonnet::filelocation('',$output);	my $local_name = &Apache::lonnet::filelocation('',$output);
Line 3515 sub bodytag {	Line 4032 sub bodytag {
if (!$realm) { $realm=' '; }	if (!$realm) { $realm=' '; }
# Set messages	# Set messages
my $messages=&domainlogo($domain);	my $messages=&domainlogo($domain);
# Port for miniserver
my $lonhttpdPort=$Apache::lonnet::perlvar{'lonhttpdPort'};
if (!defined($lonhttpdPort)) { $lonhttpdPort='8080'; }

my $extra_body_attr = &make_attr_string($forcereg,\%design);	my $extra_body_attr = &make_attr_string($forcereg,\%design);

Line 3575 ENDROLE	Line 4089 ENDROLE
$dc_info = '('.$dc_info.')';	$dc_info = '('.$dc_info.')';
}	}

if ($env{'environment.remote'} eq 'off') {	if (($env{'environment.remote'} eq 'off') \|\| ($args->{'suppress_header_logos'})) {
# No Remote	# No Remote
if ($env{'request.state'} eq 'construct') {	if ($env{'request.state'} eq 'construct') {
$forcereg=1;	$forcereg=1;
Line 3598 ENDROLE	Line 4112 ENDROLE
$lastitem = $thisdisfn;	$lastitem = $thisdisfn;
}	}
$titleinfo =	$titleinfo =
&Apache::loncommon::help_open_menu('','',3,'Authoring').	&Apache::loncommon::help_open_menu('','',3,'Authoring')
'<b>Construction Space</b>: '.	.'<b>'.&mt('Construction Space').'</b>: '
'<form name="dirs" method="post" action="'.$formaction	.'<form name="dirs" method="post" action="'.$formaction
.'" target="_top"><tt><b>'	.'" target="_top"><tt><b>'
.&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"	.&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"
.&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')	.&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
Line 3635 ENDROLE	Line 4149 ENDROLE

my $imgsrc = $img;	my $imgsrc = $img;
if ($img =~ /^\/adm/) {	if ($img =~ /^\/adm/) {
$imgsrc = 'http://'.$ENV{'HTTP_HOST'}.':'.$lonhttpdPort.$img;	$imgsrc = &lonhttpdurl($img);
}	}
my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';	my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';

Line 3724 sub make_attr_string {	Line 4238 sub make_attr_string {

Returns a uniform footer for LON-CAPA web pages.	Returns a uniform footer for LON-CAPA web pages.

Inputs: none	Inputs: 1 - optional reference to an args hash
	If in the hash, key for noredirectlink has a value which evaluates to true,
	a 'Continue' link is not displayed if the page contains an
	internal redirect in the <head></head> section,
	i.e., $env{'internal.head.redirect'} exists

=cut	=cut

sub endbodytag {	sub endbodytag {
	my ($args) = @_;
my $endbodytag='</body>';	my $endbodytag='</body>';
$endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;	$endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
if ( exists( $env{'internal.head.redirect'} ) ) {	if ( exists( $env{'internal.head.redirect'} ) ) {
$endbodytag=	if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
"<br /><a href=\"$env{'internal.head.redirect'}\">".	$endbodytag=
&mt('Continue').'</a>'.	"<br /><a href=\"$env{'internal.head.redirect'}\">".
$endbodytag;	&mt('Continue').'</a>'.
	$endbodytag;
	}
}	}
return $endbodytag;	return $endbodytag;
}	}
Line 3769 sub standard_css {	Line 4290 sub standard_css {
my $vlink = &designparm($function.'.vlink', $domain);	my $vlink = &designparm($function.'.vlink', $domain);
my $link = &designparm($function.'.link', $domain);	my $link = &designparm($function.'.link', $domain);

my $sans = 'Arial,Helvetica,sans-serif';	my $sans = 'Verdana,Arial,Helvetica,sans-serif';
my $mono = 'monospace';	my $mono = 'monospace';
my $data_table_head = $tabbg;	my $data_table_head = $tabbg;
my $data_table_light = '#EEEEEE';	my $data_table_light = '#EEEEEE';
Line 3787 sub standard_css {	Line 4308 sub standard_css {
my $table_header = '#DDDDDD';	my $table_header = '#DDDDDD';
my $feedback_link_bg = '#BBBBBB';	my $feedback_link_bg = '#BBBBBB';

my $border = ($env{'browser.type'} eq 'explorer') ? '0px 2px 0px 2px'	my $border = ($env{'browser.type'} eq 'explorer' \|\|
: '0px 3px 0px 4px';	$env{'browser.type'} eq 'safari' ) ? '0px 2px 0px 2px'
	: '0px 3px 0px 4px';


return <<END;	return <<END;
Line 3808 table.thinborder tr td {	Line 4330 table.thinborder tr td {

form, .inline { display: inline; }	form, .inline { display: inline; }
.center { text-align: center; }	.center { text-align: center; }
.LC_filename {font-family: $mono;}	.LC_filename {font-family: $mono; white-space:pre;}
.LC_error {	.LC_error {
color: red;	color: red;
font-size: larger;	font-size: larger;
Line 3849 table.LC_pastsubmission {	Line 4371 table.LC_pastsubmission {
margin: 2px;	margin: 2px;
}	}

table#LC_top_nav, table#LC_menubuttons {	table#LC_top_nav, table#LC_menubuttons,table#LC_nav_location {
width: 100%;	width: 100%;
background: $pgbg;	background: $pgbg;
border: 2px;	border: 2px;
Line 3857 table#LC_top_nav, table#LC_menubuttons {	Line 4379 table#LC_top_nav, table#LC_menubuttons {
padding: 0px;	padding: 0px;
}	}

table#LC_title_bar, table.LC_breadcrumbs, table#LC_nav_location,	table#LC_title_bar, table.LC_breadcrumbs,
table#LC_title_bar.LC_with_remote {	table#LC_title_bar.LC_with_remote {
width: 100%;	width: 100%;
border-color: $pgbg;	border-color: $pgbg;
Line 3997 td.LC_menubuttons_img {	Line 4519 td.LC_menubuttons_img {
}	}
.LC_new_mail {	.LC_new_mail {
font-family: $sans;	font-family: $sans;
	background: $tabbg;
font-weight: bold;	font-weight: bold;
}	}

Line 4048 table.LC_data_table, table.LC_mail_list	Line 4571 table.LC_data_table, table.LC_mail_list
border: 1px solid #000000;	border: 1px solid #000000;
border-collapse: separate;	border-collapse: separate;
border-spacing: 1px;	border-spacing: 1px;
	background: $pgbg;
}	}
.LC_data_table_dense {	.LC_data_table_dense {
font-size: small;	font-size: small;
}	}
table.LC_nested_outer {	table.LC_nested_outer {
border: 1px solid #000000;	border: 1px solid #000000;
border-collapse: separate;	border-collapse: collapse;
border-spacing: 0px;	border-spacing: 0px;
width: 100%;	width: 100%;
}	}
table.LC_nested {	table.LC_nested {
border: 0px;	border: 0px;
border-collapse: separate;	border-collapse: collapse;
border-spacing: 0px;	border-spacing: 0px;
width: 100%;	width: 100%;
}	}
Line 4070 table.LC_prior_tries tr th {	Line 4594 table.LC_prior_tries tr th {
background-color: $data_table_head;	background-color: $data_table_head;
font-size: smaller;	font-size: smaller;
}	}
table.LC_data_table tr td,	table.LC_data_table tr.LC_odd_row > td,
table.LC_aboutme_port tr td {	table.LC_aboutme_port tr td {
background-color: $data_table_light;	background-color: $data_table_light;
padding: 2px;	padding: 2px;
}	}
table.LC_data_table tr.LC_even_row td,	table.LC_data_table tr.LC_even_row > td,
table.LC_aboutme_port tr.LC_even_row td {	table.LC_aboutme_port tr.LC_even_row td {
background-color: $data_table_dark;	background-color: $data_table_dark;
}	}
table.LC_data_table tr.LC_data_table_highlight td {	table.LC_data_table tr.LC_data_table_highlight td {
background-color: $data_table_darker;	background-color: $data_table_darker;
}	}
	table.LC_data_table tr td.LC_leftcol_header {
	background-color: $data_table_head;
	font-weight: bold;
	}
table.LC_data_table tr.LC_empty_row td,	table.LC_data_table tr.LC_empty_row td,
table.LC_nested tr.LC_empty_row td {	table.LC_nested tr.LC_empty_row td {
background-color: #FFFFFF;	background-color: #FFFFFF;
Line 4112 table.LC_nested tr.LC_info_row td {	Line 4640 table.LC_nested tr.LC_info_row td {
font-size: small;	font-size: small;
text-align: center;	text-align: center;
}	}
table.LC_nested tr.LC_info_row td.LC_left_item {	table.LC_nested tr.LC_info_row td.LC_left_item,
	table.LC_nested_outer tr th.LC_left_item {
text-align: left;	text-align: left;
}	}
table.LC_nested td {	table.LC_nested td {
Line 4343 table#LC_helpmenu_links a:hover {	Line 4872 table#LC_helpmenu_links a:hover {
border: 1px solid #8888FF;	border: 1px solid #8888FF;
background: #CCCCFF;	background: #CCCCFF;
}	}

table.LC_pick_box {	table.LC_pick_box {
width: 100%;
border-collapse: separate;	border-collapse: separate;
background: white;	background: white;
border: 1px solid black;	border: 1px solid black;
Line 4358 table.LC_pick_box td.LC_pick_box_title {	Line 4885 table.LC_pick_box td.LC_pick_box_title {
width: 184px;	width: 184px;
padding: 8px;	padding: 8px;
}	}
	table.LC_pick_box td.LC_selfenroll_pick_box_title {
	background: $tabbg;
	font-weight: bold;
	text-align: right;
	width: 350px;
	padding: 8px;
	}

	table.LC_pick_box td.LC_pick_box_value {
	text-align: left;
	padding: 8px;
	}
	table.LC_pick_box td.LC_pick_box_select {
	text-align: left;
	padding: 8px;
	}
table.LC_pick_box td.LC_pick_box_separator {	table.LC_pick_box td.LC_pick_box_separator {
padding: 0px;	padding: 0px;
height: 1px;	height: 1px;
Line 4366 table.LC_pick_box td.LC_pick_box_separat	Line 4909 table.LC_pick_box td.LC_pick_box_separat
table.LC_pick_box td.LC_pick_box_submit {	table.LC_pick_box td.LC_pick_box_submit {
text-align: right;	text-align: right;
}	}
	table.LC_pick_box td.LC_evenrow_value {
	text-align: left;
	padding: 8px;
	background-color: $data_table_light;
	}
	table.LC_pick_box td.LC_oddrow_value {
	text-align: left;
	padding: 8px;
	background-color: $data_table_light;
	}
	table.LC_helpform_receipt {
	width: 620px;
	border-collapse: separate;
	background: white;
	border: 1px solid black;
	border-spacing: 1px;
	}
	table.LC_helpform_receipt td.LC_pick_box_title {
	background: $tabbg;
	font-weight: bold;
	text-align: right;
	width: 184px;
	padding: 8px;
	}
	table.LC_helpform_receipt td.LC_evenrow_value {
	text-align: left;
	padding: 8px;
	background-color: $data_table_light;
	}
	table.LC_helpform_receipt td.LC_oddrow_value {
	text-align: left;
	padding: 8px;
	background-color: $data_table_light;
	}
	table.LC_helpform_receipt td.LC_pick_box_separator {
	padding: 0px;
	height: 1px;
	background: black;
	}
	span.LC_helpform_receipt_cat {
	font-weight: bold;
	}
table.LC_group_priv_box {	table.LC_group_priv_box {
background: white;	background: white;
border: 1px solid black;	border: 1px solid black;
Line 4434 table.LC_descriptive_input td.LC_descrip	Line 5018 table.LC_descriptive_input td.LC_descrip
text-align: right;	text-align: right;
font-weight: bold;	font-weight: bold;
}	}
table.LC_feedback_link {	div.LC_feedback_link {
background: $feedback_link_bg;	clear: both;
	background: white;
	width: 100%;
}	}
span.LC_feedback_link {	span.LC_feedback_link {
background: $feedback_link_bg;	background: $feedback_link_bg;
font-size: larger;	font-size: larger;
	}
	span.LC_message_link {
	background: $feedback_link_bg;
	font-size: larger;
	position: absolute;
	right: 1em;
}	}

table.LC_prior_tries {	table.LC_prior_tries {
Line 4511 span.LC_nobreak {	Line 5103 span.LC_nobreak {
white-space: nowrap;	white-space: nowrap;
}	}

	span.LC_cusr_emph {
	font-style: italic;
	}

	span.LC_cusr_subheading {
	font-weight: normal;
	font-size: 85%;
	}

table.LC_docs_documents {	table.LC_docs_documents {
background: #BBBBBB;	background: #BBBBBB;
border-width: 0px;	border-width: 0px;
Line 4578 table.LC_docs_adddocs th {	Line 5179 table.LC_docs_adddocs th {
background: #DDDDDD;	background: #DDDDDD;
}	}

	table.LC_sty_begin {
	background: #BBFFBB;
	}
	table.LC_sty_end {
	background: #FFBBBB;
	}

	table.LC_double_column {
	border-width: 0px;
	border-collapse: collapse;
	width: 100%;
	padding: 2px;
	}

	table.LC_double_column tr td.LC_left_col {
	top: 2px;
	left: 2px;
	width: 47%;
	vertical-align: top;
	}

	table.LC_double_column tr td.LC_right_col {
	top: 2px;
	right: 2px;
	width: 47%;
	vertical-align: top;
	}

	span.LC_role_level {
	font-weight: bold;
	}

	div.LC_left_float {
	float: left;
	padding-right: 5%;
	padding-bottom: 4px;
	}

	div.LC_clear_float_header {
	padding-bottom: 2px;
	}

	div.LC_clear_float_footer {
	padding-top: 10px;
	clear: both;
	}


	div.LC_grade_select_mode {
	font-family: $sans;
	}
	div.LC_grade_select_mode div div {
	margin: 5px;
	}
	div.LC_grade_select_mode_selector {
	margin: 5px;
	float: left;
	}
	div.LC_grade_select_mode_selector_header {
	font: bold medium $sans;
	}
	div.LC_grade_select_mode_type {
	clear: left;
	}

	div.LC_grade_show_user {
	margin-top: 20px;
	border: 1px solid black;
	}
	div.LC_grade_user_name {
	background: #DDDDEE;
	border-bottom: 1px solid black;
	font: bold large $sans;
	}
	div.LC_grade_show_user_odd_row div.LC_grade_user_name {
	background: #DDEEDD;
	}

	div.LC_grade_show_problem,
	div.LC_grade_submissions,
	div.LC_grade_message_center,
	div.LC_grade_info_links,
	div.LC_grade_assign {
	margin: 5px;
	width: 99%;
	background: #FFFFFF;
	}
	div.LC_grade_show_problem_header,
	div.LC_grade_submissions_header,
	div.LC_grade_message_center_header,
	div.LC_grade_assign_header {
	font: bold large $sans;
	}
	div.LC_grade_show_problem_problem,
	div.LC_grade_submissions_body,
	div.LC_grade_message_center_body,
	div.LC_grade_assign_body {
	border: 1px solid black;
	width: 99%;
	background: #FFFFFF;
	}
	span.LC_grade_check_note {
	font: normal medium $sans;
	display: inline;
	position: absolute;
	right: 1em;
	}

	table.LC_scantron_action {
	width: 100%;
	}
	table.LC_scantron_action tr th {
	font: normal bold $sans;
	}

	div.LC_edit_problem_header,
	div.LC_edit_problem_footer {
	font: normal medium $sans;
	margin: 2px;
	}
	div.LC_edit_problem_header,
	div.LC_edit_problem_header div,
	div.LC_edit_problem_footer,
	div.LC_edit_problem_footer div,
	div.LC_edit_problem_editxml_header,
	div.LC_edit_problem_editxml_header div {
	margin-top: 5px;
	}
	div.LC_edit_problem_header_edit_row {
	background: $tabbg;
	padding: 3px;
	margin-bottom: 5px;
	}
	div.LC_edit_problem_header_title {
	font: larger bold $sans;
	background: $tabbg;
	padding: 3px;
	}
	table.LC_edit_problem_header_title {
	font: larger bold $sans;
	width: 100%;
	border-color: $pgbg;
	border-style: solid;
	border-width: $border;

	background: $tabbg;
	border-collapse: collapse;
	padding: 0px
	}

	div.LC_edit_problem_discards {
	float: left;
	padding-bottom: 5px;
	}
	div.LC_edit_problem_saves {
	float: right;
	padding-bottom: 5px;
	}
	hr.LC_edit_problem_divide {
	clear: both;
	color: $tabbg;
	background-color: $tabbg;
	height: 3px;
	border: 0px;
	}
END	END
}	}

Line 4671 Inputs: none	Line 5437 Inputs: none

sub font_settings {	sub font_settings {
my $headerstring='';	my $headerstring='';
if (($env{'browser.os'} eq 'mac') && (!$env{'browser.mathml'})) {	if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
$headerstring.=
'<meta Content-Type="text/html; charset=x-mac-roman" />';
} elsif (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
$headerstring.=	$headerstring.=
'<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';	'<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
}	}
Line 4694 Inputs: none	Line 5457 Inputs: none
sub xml_begin {	sub xml_begin {
my $output='';	my $output='';

&Apache::lonhtmlcommon::init_htmlareafields();	if ($env{'internal.start_page'}==1) {
	&Apache::lonhtmlcommon::init_htmlareafields();
	}

if ($env{'browser.mathml'}) {	if ($env{'browser.mathml'}) {
$output='<?xml version="1.0"?>'	$output='<?xml version="1.0"?>'
Line 4731 sub endheadtag {	Line 5496 sub endheadtag {

Returns a uniform complete <head>..</head> section for LON-CAPA web pages.	Returns a uniform complete <head>..</head> section for LON-CAPA web pages.

Inputs: $title - optional title for the page	Inputs:
$head_extra - optional extra HTML to put inside the <head>
	=over 4

	$title - optional title for the page

	$head_extra - optional extra HTML to put inside the <head>

	=back

=cut	=cut

Line 4747 sub head {	Line 5519 sub head {

Returns a complete <html> .. <body> section for LON-CAPA web pages.	Returns a complete <html> .. <body> section for LON-CAPA web pages.

Inputs: $title - optional title for the page	Inputs:
$head_extra - optional extra HTML to incude inside the <head>
$args - additional optional args supported are:	=over 4
only_body -> is true will set &bodytag() onlybodytag
	$title - optional title for the page

	$head_extra - optional extra HTML to incude inside the <head>

	$args - additional optional args supported are:

	=over 8

	only_body -> is true will set &bodytag() onlybodytag
arg on	arg on
no_nav_bar -> is true will set &bodytag() notopbar arg on	no_nav_bar -> is true will set &bodytag() notopbar arg on
add_entries -> additional attributes to add to the <body>	add_entries -> additional attributes to add to the <body>
domain -> force to color decorate a page for a	domain -> force to color decorate a page for a
specific domain	specific domain
function -> force usage of a specific rolish color	function -> force usage of a specific rolish color
scheme	scheme
redirect -> see &headtag()	redirect -> see &headtag()
bgcolor -> override the default page bg color	bgcolor -> override the default page bg color
js_ready -> return a string ready for being used in	js_ready -> return a string ready for being used in
a javascript writeln	a javascript writeln
html_encode -> return a string ready for being used in	html_encode -> return a string ready for being used in
a html attribute	a html attribute
force_register -> if is true will turn on the &bodytag()	force_register -> if is true will turn on the &bodytag()
$forcereg arg	$forcereg arg
body_title -> alternate text to use instead of $title	body_title -> alternate text to use instead of $title
in the title box that appears, this text	in the title box that appears, this text
is not auto translated like the $title is	is not auto translated like the $title is
frameset -> if true will start with a <frameset>	frameset -> if true will start with a <frameset>
rather than <body>	rather than <body>
no_title -> if true the title bar won't be shown	no_title -> if true the title bar won't be shown
skip_phases -> hash ref of	skip_phases -> hash ref of
head -> skip the <html><head> generation	head -> skip the <html><head> generation
body -> skip all <body> generation	body -> skip all <body> generation
	no_inline_link -> if true and in remote mode, don't show the
no_inline_link -> if true and in remote mode, don't show the
'Switch To Inline Menu' link	'Switch To Inline Menu' link
	no_auto_mt_title -> prevent &mt()ing the title arg
no_auto_mt_title -> prevent &mt()ing the title arg	inherit_jsmath -> when creating popup window in a page,

inherit_jsmath -> when creating popup window in a page,
should it have jsmath forced on by the	should it have jsmath forced on by the
current page	current page

	=back

	=back

=cut	=cut

sub start_page {	sub start_page {
Line 4871 sub end_page {	Line 5653 sub end_page {
if ($args->{'frameset'}) {	if ($args->{'frameset'}) {
$result .= '</frameset>';	$result .= '</frameset>';
} else {	} else {
$result .= &endbodytag();	$result .= &endbodytag($args);
}	}
$result .= "\n</html>";	$result .= "\n</html>";

Line 4943 sub simple_error_page {	Line 5725 sub simple_error_page {
}	}

{	{
my $row_count;	my @row_count;
sub start_data_table {	sub start_data_table {
my ($add_class) = @_;	my ($add_class) = @_;
my $css_class = (join(' ','LC_data_table',$add_class));	my $css_class = (join(' ','LC_data_table',$add_class));
undef($row_count);	unshift(@row_count,0);
return '<table class="'.$css_class.'">'."\n";	return '<table class="'.$css_class.'">'."\n";
}	}

sub end_data_table {	sub end_data_table {
undef($row_count);	shift(@row_count);
return '</table>'."\n";;	return '</table>'."\n";;
}	}

sub start_data_table_row {	sub start_data_table_row {
my ($add_class) = @_;	my ($add_class) = @_;
$row_count++;	$row_count[0]++;
my $css_class = ($row_count % 2)?'':'LC_even_row';	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
$css_class = (join(' ',$css_class,$add_class));	$css_class = (join(' ',$css_class,$add_class));
return '<tr class="'.$css_class.'">'."\n";;	return '<tr class="'.$css_class.'">'."\n";;
}	}

sub continue_data_table_row {	sub continue_data_table_row {
my ($add_class) = @_;	my ($add_class) = @_;
my $css_class = ($row_count % 2)?'':'LC_even_row';	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
$css_class = (join(' ',$css_class,$add_class));	$css_class = (join(' ',$css_class,$add_class));
return '<tr class="'.$css_class.'">'."\n";;	return '<tr class="'.$css_class.'">'."\n";;
}	}
Line 4976 sub simple_error_page {	Line 5758 sub simple_error_page {
}	}

sub start_data_table_empty_row {	sub start_data_table_empty_row {
$row_count++;	$row_count[0]++;
return '<tr class="LC_empty_row" >'."\n";;	return '<tr class="LC_empty_row" >'."\n";;
}	}

Line 5248 previous, future, or all.	Line 6030 previous, future, or all.
5. reference to array of section restrictions (optional)	5. reference to array of section restrictions (optional)
6. reference to results object (hash of hashes).	6. reference to results object (hash of hashes).
7. reference to optional userdata hash	7. reference to optional userdata hash
Keys of top level hash are roles.	8. reference to optional statushash
	9. flag if privileged users (except those set to unhide in
	course settings) should be excluded
	Keys of top level results hash are roles.
Keys of inner hashes are username:domain, with	Keys of inner hashes are username:domain, with
values set to access type.	values set to access type.
Optional userdata hash returns an array with arguments in the	Optional userdata hash returns an array with arguments in the
same order as loncoursedata::get_classlist() for student data.	same order as loncoursedata::get_classlist() for student data.

	Optional statushash returns

Entries for end, start, section and status are blank because	Entries for end, start, section and status are blank because
of the possibility of multiple values for non-student roles.	of the possibility of multiple values for non-student roles.

Line 5262 of the possibility of multiple values fo	Line 6049 of the possibility of multiple values fo
###############################################	###############################################

sub get_course_users {	sub get_course_users {
my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata) = @_;	my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
my %idx = ();	my %idx = ();
my %seclists;	my %seclists;

Line 5282 sub get_course_users {	Line 6069 sub get_course_users {
my $match = 0;	my $match = 0;
my $secmatch = 0;	my $secmatch = 0;
my $section = $$classlist{$student}[$idx{section}];	my $section = $$classlist{$student}[$idx{section}];
	my $status = $$classlist{$student}[$idx{status}];
if ($section eq '') {	if ($section eq '') {
$section = 'none';	$section = 'none';
}	}
Line 5301 sub get_course_users {	Line 6089 sub get_course_users {
next;	next;
}	}
}	}
push(@{$seclists{$student}},$section);
if (defined($$types{'active'})) {	if (defined($$types{'active'})) {
if ($$classlist{$student}[$idx{status}] eq 'Active') {	if ($$classlist{$student}[$idx{status}] eq 'Active') {
push(@{$$users{st}{$student}},'active');	push(@{$$users{st}{$student}},'active');
Line 5309 sub get_course_users {	Line 6096 sub get_course_users {
}	}
}	}
if (defined($$types{'previous'})) {	if (defined($$types{'previous'})) {
if ($$classlist{$student}[$idx{end}] <= $now) {	if ($$classlist{$student}[$idx{status}] eq 'Expired') {
push(@{$$users{st}{$student}},'previous');	push(@{$$users{st}{$student}},'previous');
$match = 1;	$match = 1;
}	}
}	}
if (defined($$types{'future'})) {	if (defined($$types{'future'})) {
if (($$classlist{$student}[$idx{start}] > $now) && ($$classlist{$student}[$idx{end}] > $now) \|\| ($$classlist{$student}[$idx{end}] == 0) \|\| ($$classlist{$student}[$idx{end}] eq '')) {	if ($$classlist{$student}[$idx{status}] eq 'Future') {
push(@{$$users{st}{$student}},'future');	push(@{$$users{st}{$student}},'future');
$match = 1;	$match = 1;
}	}
}	}
if ($match && ref($userdata) eq 'HASH') {	if ($match) {
$$userdata{$student} = $$classlist{$student};	push(@{$seclists{$student}},$section);
	if (ref($userdata) eq 'HASH') {
	$$userdata{$student} = $$classlist{$student};
	}
	if (ref($statushash) eq 'HASH') {
	$statushash->{$student}{'st'}{$section} = $status;
	}
}	}
}	}
}	}
if ((@{$roles} > 1) \|\| ((@{$roles} == 1) && ($$roles[0] ne "st"))) {	if ((@{$roles} > 1) \|\| ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);	my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
my $now = time;	my $now = time;
	my %displaystatus = ( previous => 'Expired',
	active => 'Active',
	future => 'Future',
	);
	my %nothide;
	if ($hidepriv) {
	my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
	foreach my $user (split(/\s\,\s/,$coursehash{'nothideprivileged'})) {
	if ($user !~ /:/) {
	$nothide{join(':',split(/[\@]/,$user))}=1;
	} else {
	$nothide{$user} = 1;
	}
	}
	}
foreach my $person (sort(keys(%coursepersonnel))) {	foreach my $person (sort(keys(%coursepersonnel))) {
my $match = 0;	my $match = 0;
my $secmatch = 0;	my $secmatch = 0;
Line 5361 sub get_course_users {	Line 6169 sub get_course_users {
$usec = 'none';	$usec = 'none';
}	}
if ($uname ne '' && $udom ne '') {	if ($uname ne '' && $udom ne '') {
	if ($hidepriv) {
	if ((&Apache::lonnet::privileged($uname,$udom)) &&
	(!$nothide{$uname.':'.$udom})) {
	next;
	}
	}
if ($end > 0 && $end < $now) {	if ($end > 0 && $end < $now) {
$status = 'previous';	$status = 'previous';
} elsif ($start > $now) {	} elsif ($start > $now) {
Line 5383 sub get_course_users {	Line 6197 sub get_course_users {
if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {	if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
push(@{$seclists{$uname.':'.$udom}},$usec);	push(@{$seclists{$uname.':'.$udom}},$usec);
}	}
	if (ref($statushash) eq 'HASH') {
	$statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
	}
}	}
}	}
}	}
Line 5392 sub get_course_users {	Line 6209 sub get_course_users {
my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);	my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
if ( defined($csettings{'internal.courseowner'}) ) {	if ( defined($csettings{'internal.courseowner'}) ) {
my $owner = $csettings{'internal.courseowner'};	my $owner = $csettings{'internal.courseowner'};
if ($owner !~ /^[^:]+:[^:]+$/) {	next if ($owner eq '');
$owner = $owner.':'.$cdom;	my ($ownername,$ownerdom);
	if ($owner =~ /^([^:]+):([^:]+)$/) {
	$ownername = $1;
	$ownerdom = $2;
	} else {
	$ownername = $owner;
	$ownerdom = $cdom;
	$owner = $ownername.':'.$ownerdom;
}	}
@{$$users{'ow'}{$owner}} = 'any';	@{$$users{'ow'}{$owner}} = 'any';
if (defined($userdata) &&	if (defined($userdata) &&
!exists($$userdata{$owner.':'.$cdom})) {	!exists($$userdata{$owner})) {
&get_user_info($cdom,$owner,\%idx,$userdata);	&get_user_info($ownerdom,$ownername,\%idx,$userdata);
if (!grep(/^none$/,@{$seclists{$owner.':'.$cdom}})) {	if (!grep(/^none$/,@{$seclists{$owner}})) {
push(@{$seclists{$owner.':'.$cdom}},'none');	push(@{$seclists{$owner}},'none');
	}
	if (ref($statushash) eq 'HASH') {
	$statushash->{$owner}{'ow'}{'none'} = 'Any';
}	}
}	}
}	}
Line 5420 sub get_user_info {	Line 6247 sub get_user_info {
&plainname($uname,$udom,'lastname');	&plainname($uname,$udom,'lastname');
$$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;	$$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
$$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;	$$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
	my %idhash = &Apache::lonnet::idrget($udom,($uname));
	$$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
return;	return;
}	}

Line 5540 sub default_quota {	Line 6369 sub default_quota {
my ($udom,$inststatus) = @_;	my ($udom,$inststatus) = @_;
my ($defquota,$settingstatus);	my ($defquota,$settingstatus);
my %quotahash = &Apache::lonnet::get_dom('configuration',	my %quotahash = &Apache::lonnet::get_dom('configuration',
['quota'],$udom);	['quotas'],$udom);
if (ref($quotahash{'quota'}) eq 'HASH') {	if (ref($quotahash{'quotas'}) eq 'HASH') {
if ($inststatus ne '') {	if ($inststatus ne '') {
my @statuses = split(/:/,$inststatus);	my @statuses = split(/:/,$inststatus);
foreach my $item (@statuses) {	foreach my $item (@statuses) {
if ($quotahash{'quota'}{$item} ne '') {	if ($quotahash{'quotas'}{$item} ne '') {
if ($defquota eq '') {	if ($defquota eq '') {
$defquota = $quotahash{'quota'}{$item};	$defquota = $quotahash{'quotas'}{$item};
$settingstatus = $item;	$settingstatus = $item;
} elsif ($quotahash{'quota'}{$item} > $defquota) {	} elsif ($quotahash{'quotas'}{$item} > $defquota) {
$defquota = $quotahash{'quota'}{$item};	$defquota = $quotahash{'quotas'}{$item};
$settingstatus = $item;	$settingstatus = $item;
}	}
}	}
}	}
}	}
if ($defquota eq '') {	if ($defquota eq '') {
$defquota = $quotahash{'quota'}{'default'};	$defquota = $quotahash{'quotas'}{'default'};
$settingstatus = 'default';	$settingstatus = 'default';
}	}
} else {	} else {
Line 5609 sub get_secgrprole_info {	Line 6438 sub get_secgrprole_info {
}	}

sub user_picker {	sub user_picker {
my ($dom,$srch,$forcenewuser) = @_;	my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
my $currdom = $dom;	my $currdom = $dom;
my %curr_selected = (	my %curr_selected = (
srchin => 'dom',	srchin => 'dom',
srchby => 'uname',	srchby => 'lastname',
);	);
my $srchterm;	my $srchterm;
if (ref($srch) eq 'HASH') {	if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
if ($srch->{'srchby'} ne '') {	if ($srch->{'srchby'} ne '') {
$curr_selected{'srchby'} = $srch->{'srchby'};	$curr_selected{'srchby'} = $srch->{'srchby'};
}	}
Line 5632 sub user_picker {	Line 6461 sub user_picker {
$srchterm = $srch->{'srchterm'};	$srchterm = $srch->{'srchterm'};
}	}
my %lt=&Apache::lonlocal::texthash(	my %lt=&Apache::lonlocal::texthash(
	'usr' => 'Search criteria',
'doma' => 'Domain/institution to search',	'doma' => 'Domain/institution to search',
'uname' => 'username',	'uname' => 'username',
'lastname' => 'last name',	'lastname' => 'last name',
'lastfirst' => 'last name, first name',	'lastfirst' => 'last name, first name',
'crs' => 'in this course',	'crs' => 'in this course',
'dom' => 'in this domain',	'dom' => 'in selected LON-CAPA domain',
'alc' => 'all LON-CAPA',	'alc' => 'all LON-CAPA',
'instd' => 'in institutional directory',	'instd' => 'in institutional directory for selected domain',
'exact' => 'is',	'exact' => 'is',
'contains' => 'contains',	'contains' => 'contains',
	'begins' => 'begins with',
	'youm' => "You must include some text to search for.",
	'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
	'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
	'yomc' => "You must choose a domain when using an institutional directory search.",
	'ymcd' => "You must choose a domain when using a domain search.",
	'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
	'whse' => "When searching by last,first you must include at least one character in the first name.",
	'thfo' => "The following need to be corrected before the search can be run:",
);	);
my $domform = &select_dom_form($currdom,'srchdomain',1,1);	my $domform = &select_dom_form($currdom,'srchdomain',1,1);
my $srchinsel = ' <select name="srchin">';	my $srchinsel = ' <select name="srchin">';
Line 5665 sub user_picker {	Line 6504 sub user_picker {
$srchinsel .= "\n </select>\n";	$srchinsel .= "\n </select>\n";

my $srchbysel = ' <select name="srchby">';	my $srchbysel = ' <select name="srchby">';
foreach my $option ('uname','lastname','lastfirst') {	foreach my $option ('lastname','lastfirst','uname') {
if ($curr_selected{'srchby'} eq $option) {	if ($curr_selected{'srchby'} eq $option) {
$srchbysel .= '	$srchbysel .= '
<option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';	<option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
Line 5677 sub user_picker {	Line 6516 sub user_picker {
$srchbysel .= "\n </select>\n";	$srchbysel .= "\n </select>\n";

my $srchtypesel = ' <select name="srchtype">';	my $srchtypesel = ' <select name="srchtype">';
foreach my $option ('exact','contains') {	foreach my $option ('begins','contains','exact') {
if ($curr_selected{'srchtype'} eq $option) {	if ($curr_selected{'srchtype'} eq $option) {
$srchtypesel .= '	$srchtypesel .= '
<option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';	<option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
Line 5691 sub user_picker {	Line 6530 sub user_picker {
my ($newuserscript,$new_user_create);	my ($newuserscript,$new_user_create);

if ($forcenewuser) {	if ($forcenewuser) {
$new_user_create = '<p> <input type="submit" name="forcenew" value="'.&HTML::Entities::encode(&mt('Make new user "[_1]"',$srchterm),'<>&"').'" onclick="javascript:setSearch(\'1\');" /> </p>';	if (ref($srch) eq 'HASH') {
	if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
	if ($cancreate) {
	$new_user_create = '<p> <input type="submit" name="forcenew" value="'.&HTML::Entities::encode(&mt('Make new user "[_1]"',$srchterm),'<>&"').'" onclick="javascript:setSearch(\'1\','.$caller.');" /> </p>';
	} else {
	my $helplink = ' href="javascript:helpMenu('."'display'".')"';
	my %usertypetext = (
	official => 'institutional',
	unofficial => 'non-institutional',
	);
	$new_user_create = '<br /><span class="LC_warning">'.&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.").' '.&mt('Contact the <a[_1]>helpdesk</a> for assistance.',$helplink).'</span><br /><br />';
	}
	}
	}

$newuserscript = <<"ENDSCRIPT";	$newuserscript = <<"ENDSCRIPT";

function setSearch(createnew) {	function setSearch(createnew,callingForm) {
if (createnew == 1) {	if (createnew == 1) {
for (var i=0; i<document.crtuser.srchby.length; i++) {	for (var i=0; i<callingForm.srchby.length; i++) {
if (document.crtuser.srchby.options[i].value == 'uname') {	if (callingForm.srchby.options[i].value == 'uname') {
document.crtuser.srchby.selectedIndex = i;	callingForm.srchby.selectedIndex = i;
}	}
}	}
for (var i=0; i<document.crtuser.srchin.length; i++) {	for (var i=0; i<callingForm.srchin.length; i++) {
if ( document.crtuser.srchin.options[i].value == 'dom') {	if ( callingForm.srchin.options[i].value == 'dom') {
document.crtuser.srchin.selectedIndex = i;	callingForm.srchin.selectedIndex = i;
}	}
}	}
for (var i=0; i<document.crtuser.srchtype.length; i++) {	for (var i=0; i<callingForm.srchtype.length; i++) {
if (document.crtuser.srchtype.options[i].value == 'exact') {	if (callingForm.srchtype.options[i].value == 'exact') {
document.crtuser.srchtype.selectedIndex = i;	callingForm.srchtype.selectedIndex = i;
}	}
}	}
for (var i=0; i<document.crtuser.srchdomain.length; i++) {	for (var i=0; i<callingForm.srchdomain.length; i++) {
if (document.crtuser.srchdomain.options[i].value == '$env{'request.role.domain'}') {	if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
document.crtuser.srchdomain.selectedIndex = i;	callingForm.srchdomain.selectedIndex = i;
}	}
}	}
}	}
Line 5724 ENDSCRIPT	Line 6577 ENDSCRIPT

my $output = <<"END_BLOCK";	my $output = <<"END_BLOCK";
<script type="text/javascript">	<script type="text/javascript">
function validateEntry() {	function validateEntry(callingForm) {

var checkok = 1;	var checkok = 1;
var srchin;	var srchin;
for (var i=0; i<document.crtuser.srchin.length; i++) {	for (var i=0; i<callingForm.srchin.length; i++) {
if ( document.crtuser.srchin[i].checked ) {	if ( callingForm.srchin[i].checked ) {
srchin = document.crtuser.srchin[i].value;	srchin = callingForm.srchin[i].value;
}	}
}	}

var srchtype = document.crtuser.srchtype.options[document.crtuser.srchtype.selectedIndex].value;	var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
var srchby = document.crtuser.srchby.options[document.crtuser.srchby.selectedIndex].value;	var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
var srchdomain = document.crtuser.srchdomain.options[document.crtuser.srchdomain.selectedIndex].value;	var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
var srchterm = document.crtuser.srchterm.value;	var srchterm = callingForm.srchterm.value;
var srchin = document.crtuser.srchin.options[document.crtuser.srchin.selectedIndex].value;	var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
var msg = "";	var msg = "";

if (srchterm == "") {	if (srchterm == "") {
checkok = 0;	checkok = 0;
msg += "You must include some text to search for.\\n";	msg += "$lt{'youm'}\\n";
	}

	if (srchtype== 'begins') {
	if (srchterm.length < 2) {
	checkok = 0;
	msg += "$lt{'thte'}\\n";
	}
}	}

if (srchtype== 'contains') {	if (srchtype== 'contains') {
if (srchterm.length < 3) {	if (srchterm.length < 3) {
checkok = 0;	checkok = 0;
msg += "The text you are searching for must contain at least three characters when using a 'contains' type search.\\n";	msg += "$lt{'thet'}\\n";
}	}
}	}
if (srchin == 'instd') {	if (srchin == 'instd') {
if (srchdomain == '') {	if (srchdomain == '') {
checkok = 0;	checkok = 0;
msg += "You must choose a domain when using an institutional directory search.\\n";	msg += "$lt{'yomc'}\\n";
}	}
}	}
if (srchin == 'dom') {	if (srchin == 'dom') {
if (srchdomain == '') {	if (srchdomain == '') {
checkok = 0;	checkok = 0;
msg += "You must choose a domain when using a domain search.\\n";	msg += "$lt{'ymcd'}\\n";
}	}
}	}
if (srchby == 'lastfirst') {	if (srchby == 'lastfirst') {
if (srchterm.indexOf(",") == -1) {	if (srchterm.indexOf(",") == -1) {
checkok = 0;	checkok = 0;
msg += "When using searching by last,first you must include a comma as separator between last name and first name.\\n";	msg += "$lt{'whus'}\\n";
}	}
if (srchterm.indexOf(",") == srchterm.length -1) {	if (srchterm.indexOf(",") == srchterm.length -1) {
checkok = 0;	checkok = 0;
msg += "When searching by last,first you must include at least one character in the first name.\\n";	msg += "$lt{'whse'}\\n";
}	}
}	}
if (checkok == 0) {	if (checkok == 0) {
alert("The following need to be corrected before the search can be run:\\n"+msg);	alert("$lt{'thfo'}\\n"+msg);
return;	return;
}	}
if (checkok == 1) {	if (checkok == 1) {
document.crtuser.submit();	callingForm.submit();
}	}
}	}

Line 5791 $new_user_create	Line 6651 $new_user_create

<table>	<table>
<tr>	<tr>
	<td>$lt{'doma'}:</td>
	<td>$domform</td>
	</td>
	</tr>
	<tr>
	<td>$lt{'usr'}:</td>
<td>$srchbysel	<td>$srchbysel
$srchtypesel	$srchtypesel
<input type="text" size="15" name="srchterm" value="$srchterm" />	<input type="text" size="15" name="srchterm" value="$srchterm" />
$srchinsel	$srchinsel
</td>	</td>
</tr>	</tr>
<tr>
<td>$lt{'doma'}: $domform</td>
</td>
</tr>
</table>	</table>
<br />	<br />
END_BLOCK	END_BLOCK
Line 5808 END_BLOCK	Line 6670 END_BLOCK
return $output;	return $output;
}	}

	sub user_rule_check {
	my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
	my $response;
	if (ref($usershash) eq 'HASH') {
	foreach my $user (keys(%{$usershash})) {
	my ($uname,$udom) = split(/:/,$user);
	next if ($udom eq '' \|\| $uname eq '');
	my ($id,$newuser);
	if (ref($usershash->{$user}) eq 'HASH') {
	$newuser = $usershash->{$user}->{'newuser'};
	$id = $usershash->{$user}->{'id'};
	}
	my $inst_response;
	if (ref($checks) eq 'HASH') {
	if (defined($checks->{'username'})) {
	($inst_response,%{$inst_results->{$user}}) =
	&Apache::lonnet::get_instuser($udom,$uname);
	} elsif (defined($checks->{'id'})) {
	($inst_response,%{$inst_results->{$user}}) =
	&Apache::lonnet::get_instuser($udom,undef,$id);
	}
	} else {
	($inst_response,%{$inst_results->{$user}}) =
	&Apache::lonnet::get_instuser($udom,$uname);
	return;
	}
	if (!$got_rules->{$udom}) {
	my %domconfig = &Apache::lonnet::get_dom('configuration',
	['usercreation'],$udom);
	if (ref($domconfig{'usercreation'}) eq 'HASH') {
	foreach my $item ('username','id') {
	if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
	$$curr_rules{$udom}{$item} =
	$domconfig{'usercreation'}{$item.'_rule'};
	}
	}
	}
	$got_rules->{$udom} = 1;
	}
	foreach my $item (keys(%{$checks})) {
	if (ref($$curr_rules{$udom}) eq 'HASH') {
	if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
	if (@{$$curr_rules{$udom}{$item}} > 0) {
	my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
	foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
	if ($rule_check{$rule}) {
	$$rulematch{$user}{$item} = $rule;
	if ($inst_response eq 'ok') {
	if (ref($inst_results) eq 'HASH') {
	if (ref($inst_results->{$user}) eq 'HASH') {
	if (keys(%{$inst_results->{$user}}) == 0) {
	$$alerts{$item}{$udom}{$uname} = 1;
	}
	}
	}
	}
	last;
	}
	}
	}
	}
	}
	}
	}
	}
	return;
	}

	sub user_rule_formats {
	my ($domain,$domdesc,$curr_rules,$check) = @_;
	my %text = (
	'username' => 'Usernames',
	'id' => 'IDs',
	);
	my $output;
	my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
	if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
	if (@{$ruleorder} > 0) {
	$output = '<br />'.&mt("$text{$check} with the following format(s) may <span class=\"LC_cusr_emph\">only</span> be used for verified users at [_1]:",$domdesc).' <ul>';
	foreach my $rule (@{$ruleorder}) {
	if (ref($curr_rules) eq 'ARRAY') {
	if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
	if (ref($rules->{$rule}) eq 'HASH') {
	$output .= '<li>'.$rules->{$rule}{'name'}.': '.
	$rules->{$rule}{'desc'}.'</li>';
	}
	}
	}
	}
	$output .= '</ul>';
	}
	}
	return $output;
	}

	sub instrule_disallow_msg {
	my ($checkitem,$domdesc,$count,$mode) = @_;
	my $response;
	my %text = (
	item => 'username',
	items => 'usernames',
	match => 'matches',
	do => 'does',
	action => 'a username',
	one => 'one',
	);
	if ($count > 1) {
	$text{'item'} = 'usernames';
	$text{'match'} ='match';
	$text{'do'} = 'do';
	$text{'action'} = 'usernames',
	$text{'one'} = 'ones';
	}
	if ($checkitem eq 'id') {
	$text{'items'} = 'IDs';
	$text{'item'} = 'ID';
	$text{'action'} = 'an ID';
	if ($count > 1) {
	$text{'item'} = 'IDs';
	$text{'action'} = 'IDs';
	}
	}
	$response = &mt("The $text{'item'} you chose $text{'match'} the format of $text{'items'} defined for <span class=\"LC_cusr_emph\">[_1]</span>, but the $text{'item'} $text{'do'} not exist in the institutional directory.",$domdesc).'<br />';
	if ($mode eq 'upload') {
	if ($checkitem eq 'username') {
	$response .= &mt("You will need to modify your upload file so it will include $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
	} elsif ($checkitem eq 'id') {
	$response .= &mt("Either upload a file which includes $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or when associating fields with data columns, omit an association for the ID/Student Number field.");
	}
	} else {
	if ($checkitem eq 'username') {
	$response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
	} elsif ($checkitem eq 'id') {
	$response .= &mt("You must either choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
	}
	}
	return $response;
	}

	sub personal_data_fieldtitles {
	my %fieldtitles = &Apache::lonlocal::texthash (
	id => 'Student/Employee ID',
	permanentemail => 'E-mail address',
	lastname => 'Last Name',
	firstname => 'First Name',
	middlename => 'Middle Name',
	generation => 'Generation',
	gen => 'Generation',
	);
	return %fieldtitles;
	}

	sub sorted_inst_types {
	my ($dom) = @_;
	my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
	my $othertitle = &mt('All users');
	if ($env{'request.course.id'}) {
	$othertitle = 'any';
	}
	my @types;
	if (ref($order) eq 'ARRAY') {
	@types = @{$order};
	}
	if (@types == 0) {
	if (ref($usertypes) eq 'HASH') {
	@types = sort(keys(%{$usertypes}));
	}
	}
	if (keys(%{$usertypes}) > 0) {
	$othertitle = &mt('Other users');
	if ($env{'request.course.id'}) {
	$othertitle = 'other';
	}
	}
	return ($othertitle,$usertypes,\@types);
	}

	sub get_institutional_codes {
	my ($settings,$allcourses,$LC_code) = @_;
	# Get complete list of course sections to update
	my @currsections = ();
	my @currxlists = ();
	my $coursecode = $$settings{'internal.coursecode'};

	if ($$settings{'internal.sectionnums'} ne '') {
	@currsections = split(/,/,$$settings{'internal.sectionnums'});
	}

	if ($$settings{'internal.crosslistings'} ne '') {
	@currxlists = split(/,/,$$settings{'internal.crosslistings'});
	}

	if (@currxlists > 0) {
	foreach (@currxlists) {
	if (m/^([^:]+):(\w*)$/) {
	unless (grep/^$1$/,@{$allcourses}) {
	push @{$allcourses},$1;
	$$LC_code{$1} = $2;
	}
	}
	}
	}

	if (@currsections > 0) {
	foreach (@currsections) {
	if (m/^(\w+):(\w*)$/) {
	my $sec = $coursecode.$1;
	my $lc_sec = $2;
	unless (grep/^$sec$/,@{$allcourses}) {
	push @{$allcourses},$sec;
	$$LC_code{$sec} = $lc_sec;
	}
	}
	}
	}
	return;
	}

=pod	=pod

Line 5818 END_BLOCK	Line 6896 END_BLOCK

=over 4	=over 4

=item * get_unprocessed_cgi($query,$possible_names)	=item * &get_unprocessed_cgi($query,$possible_names)

Modify the %env hash to contain unprocessed CGI form parameters held in	Modify the %env hash to contain unprocessed CGI form parameters held in
$query. The parameters listed in $possible_names (an array reference),	$query. The parameters listed in $possible_names (an array reference),
Line 5847 sub get_unprocessed_cgi {	Line 6925 sub get_unprocessed_cgi {

=pod	=pod

=item * cacheheader()	=item * &cacheheader()

returns cache-controlling header code	returns cache-controlling header code

Line 5864 sub cacheheader {	Line 6942 sub cacheheader {

=pod	=pod

=item * no_cache($r)	=item * &no_cache($r)

specifies header code to not have cache	specifies header code to not have cache

Line 5900 sub content_type {	Line 6978 sub content_type {

=pod	=pod

=item * add_to_env($name,$value)	=item * &add_to_env($name,$value)

adds $name to the %env hash with value	adds $name to the %env hash with value
$value, if $name already exists, the entry is converted to an array	$value, if $name already exists, the entry is converted to an array
Line 5927 sub add_to_env {	Line 7005 sub add_to_env {

=pod	=pod

=item * get_env_multiple($name)	=item * &get_env_multiple($name)

gets $name from the %env hash, it seemlessly handles the cases where multiple	gets $name from the %env hash, it seemlessly handles the cases where multiple
values may be defined and end up as an array ref.	values may be defined and end up as an array ref.
Line 5959 sub get_env_multiple {	Line 7037 sub get_env_multiple {

=over 4	=over 4

=item * upfile_store($r)	=item * &upfile_store($r)

Store uploaded file, $r should be the HTTP Request object,	Store uploaded file, $r should be the HTTP Request object,
needs $env{'form.upfile'}	needs $env{'form.upfile'}
Line 5989 sub upfile_store {	Line 7067 sub upfile_store {

=pod	=pod

=item * load_tmp_file($r)	=item * &load_tmp_file($r)

Load uploaded file from tmp, $r should be the HTTP Request object,	Load uploaded file from tmp, $r should be the HTTP Request object,
needs $env{'form.datatoken'},	needs $env{'form.datatoken'},
Line 6013 sub load_tmp_file {	Line 7091 sub load_tmp_file {

=pod	=pod

=item * upfile_record_sep()	=item * &upfile_record_sep()

Separate uploaded file into records	Separate uploaded file into records
returns array of records,	returns array of records,
Line 6035 sub upfile_record_sep {	Line 7113 sub upfile_record_sep {

=pod	=pod

=item * record_sep($record)	=item * &record_sep($record)

Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}	Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}

Line 6120 sub record_sep {	Line 7198 sub record_sep {

=pod	=pod

=item * upfile_select_html()	=item * &upfile_select_html()

Return HTML code to select a file from the users machine and specify	Return HTML code to select a file from the users machine and specify
the file type.	the file type.
Line 6167 sub get_samples {	Line 7245 sub get_samples {

=pod	=pod

=item * csv_print_samples($r,$records)	=item * &csv_print_samples($r,$records)

Prints a table of sample values from each column uploaded $r is an	Prints a table of sample values from each column uploaded $r is an
Apache Request ref, $records is an arrayref from	Apache Request ref, $records is an arrayref from
Line 6181 sub csv_print_samples {	Line 7259 sub csv_print_samples {
my ($r,$records) = @_;	my ($r,$records) = @_;
my $samples = &get_samples($records,3);	my $samples = &get_samples($records,3);

$r->print(&mt('Samples').'<br /><table border="2"><tr>');	$r->print(&mt('Samples').'<br />'.&start_data_table().
	&start_data_table_header_row());
foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
$r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }	$r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
$r->print('</tr>');	$r->print(&end_data_table_header_row());
foreach my $hash (@$samples) {	foreach my $hash (@$samples) {
$r->print('<tr>');	$r->print(&start_data_table_row());
foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
$r->print('<td>');	$r->print('<td>');
if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }	if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
$r->print('</td>');	$r->print('</td>');
}	}
$r->print('</tr>');	$r->print(&end_data_table_row());
}	}
$r->print('</tr></table><br />'."\n");	$r->print(&end_data_table().'<br />'."\n");
}	}

######################################################	######################################################
Line 6202 sub csv_print_samples {	Line 7281 sub csv_print_samples {

=pod	=pod

=item * csv_print_select_table($r,$records,$d)	=item * &csv_print_select_table($r,$records,$d)

Prints a table to create associations between values and table columns.	Prints a table to create associations between values and table columns.

Line 6219 sub csv_print_select_table {	Line 7298 sub csv_print_select_table {
my $i=0;	my $i=0;
my $samples = &get_samples($records,1);	my $samples = &get_samples($records,1);
$r->print(&mt('Associate columns with student attributes.')."\n".	$r->print(&mt('Associate columns with student attributes.')."\n".
'<table border="2"><tr>'.	&start_data_table().&start_data_table_header_row().
'<th>'.&mt('Attribute').'</th>'.	'<th>'.&mt('Attribute').'</th>'.
'<th>'.&mt('Column').'</th></tr>'."\n");	'<th>'.&mt('Column').'</th>'.
	&end_data_table_header_row()."\n");
foreach my $array_ref (@$d) {	foreach my $array_ref (@$d) {
my ($value,$display,$defaultcol)=@{ $array_ref };	my ($value,$display,$defaultcol)=@{ $array_ref };
$r->print('<tr><td>'.$display.'</td>');	$r->print(&start_data_table_row().'<tr><td>'.$display.'</td>');

$r->print('<td><select name=f'.$i.	$r->print('<td><select name=f'.$i.
' onchange="javascript:flip(this.form,'.$i.');">');	' onchange="javascript:flip(this.form,'.$i.');">');
Line 6234 sub csv_print_select_table {	Line 7314 sub csv_print_select_table {
($sample eq $defaultcol ? ' selected="selected" ' : '').	($sample eq $defaultcol ? ' selected="selected" ' : '').
'>Column '.($sample+1).'</option>');	'>Column '.($sample+1).'</option>');
}	}
$r->print('</select></td></tr>'."\n");	$r->print('</select></td>'.&end_data_table_row()."\n");
$i++;	$i++;
}	}
	$r->print(&end_data_table());
$i--;	$i--;
return $i;	return $i;
}	}
Line 6246 sub csv_print_select_table {	Line 7327 sub csv_print_select_table {

=pod	=pod

=item * csv_samples_select_table($r,$records,$d)	=item * &csv_samples_select_table($r,$records,$d)

Prints a table of sample values from the upload and can make associate samples to internal names.	Prints a table of sample values from the upload and can make associate samples to internal names.

Line 6263 sub csv_samples_select_table {	Line 7344 sub csv_samples_select_table {
my $i=0;	my $i=0;
#	#
my $samples = &get_samples($records,3);	my $samples = &get_samples($records,3);
$r->print('<table border=2><tr><th>'.	$r->print(&start_data_table().
&mt('Field').'</th><th>'.&mt('Samples').'</th></tr>');	&start_data_table_header_row().'<th>'.
	&mt('Field').'</th><th>'.&mt('Samples').'</th>'.
	&end_data_table_header_row());

foreach my $key (sort(keys(%{ $samples->[0] }))) {	foreach my $key (sort(keys(%{ $samples->[0] }))) {
$r->print('<tr><td><select name="f'.$i.'"'.	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
' onchange="javascript:flip(this.form,'.$i.');">');	' onchange="javascript:flip(this.form,'.$i.');">');
foreach my $option (@$d) {	foreach my $option (@$d) {
my ($value,$display,$defaultcol)=@{ $option };	my ($value,$display,$defaultcol)=@{ $option };
Line 6281 sub csv_samples_select_table {	Line 7364 sub csv_samples_select_table {
$r->print($samples->[$line]{$key}."<br />\n");	$r->print($samples->[$line]{$key}."<br />\n");
}	}
}	}
$r->print('</td></tr>');	$r->print('</td>'.&end_data_table_row());
$i++;	$i++;
}	}
	$r->print(&end_data_table());
$i--;	$i--;
return($i);	return($i);
}	}
Line 6293 sub csv_samples_select_table {	Line 7377 sub csv_samples_select_table {

=pod	=pod

=item clean_excel_name($name)	=item * &clean_excel_name($name)

Returns a replacement for $name which does not contain any illegal characters.	Returns a replacement for $name which does not contain any illegal characters.

Line 6312 sub clean_excel_name {	Line 7396 sub clean_excel_name {

=pod	=pod

=item * check_if_partid_hidden($id,$symb,$udom,$uname)	=item * &check_if_partid_hidden($id,$symb,$udom,$uname)

Returns either 1 or undef	Returns either 1 or undef

Line 6353 sub check_if_partid_hidden {	Line 7437 sub check_if_partid_hidden {

=over 4	=over 4

=item get_cgi_id	=item * &get_cgi_id()

Inputs: none	Inputs: none

Line 6377 sub get_cgi_id {	Line 7461 sub get_cgi_id {

=pod	=pod

=item DrawBarGraph	=item * &DrawBarGraph()

Facilitates the plotting of data in a (stacked) bar graph.	Facilitates the plotting of data in a (stacked) bar graph.
Puts plot definition data into the users environment in order for	Puts plot definition data into the users environment in order for
Line 6512 sub DrawBarGraph {	Line 7596 sub DrawBarGraph {
$ValuesHash{$id.'.'.$key} = $value;	$ValuesHash{$id.'.'.$key} = $value;
}	}
#	#
&Apache::lonnet::appenv(%ValuesHash);	&Apache::lonnet::appenv(\%ValuesHash);
return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';	return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
}	}

Line 6521 sub DrawBarGraph {	Line 7605 sub DrawBarGraph {

=pod	=pod

=item DrawXYGraph	=item * &DrawXYGraph()

Facilitates the plotting of data in an XY graph.	Facilitates the plotting of data in an XY graph.
Puts plot definition data into the users environment in order for	Puts plot definition data into the users environment in order for
Line 6602 sub DrawXYGraph {	Line 7686 sub DrawXYGraph {
$ValuesHash{$id.'.'.$key} = $value;	$ValuesHash{$id.'.'.$key} = $value;
}	}
#	#
&Apache::lonnet::appenv(%ValuesHash);	&Apache::lonnet::appenv(\%ValuesHash);
return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';	return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
}	}

Line 6611 sub DrawXYGraph {	Line 7695 sub DrawXYGraph {

=pod	=pod

=item DrawXYYGraph	=item * &DrawXYYGraph()

Facilitates the plotting of data in an XY graph with two Y axes.	Facilitates the plotting of data in an XY graph with two Y axes.
Puts plot definition data into the users environment in order for	Puts plot definition data into the users environment in order for
Line 6704 sub DrawXYYGraph {	Line 7788 sub DrawXYYGraph {
$ValuesHash{$id.'.'.$key} = $value;	$ValuesHash{$id.'.'.$key} = $value;
}	}
#	#
&Apache::lonnet::appenv(%ValuesHash);	&Apache::lonnet::appenv(\%ValuesHash);
return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';	return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
}	}

Line 6721 Bad place for them but what the hell.	Line 7805 Bad place for them but what the hell.

=over 4	=over 4

=item &chartlink	=item * &chartlink()

Returns a link to the chart for a specific student.	Returns a link to the chart for a specific student.

Line 6760 sub chartlink {	Line 7844 sub chartlink {

=over 4	=over 4

=item &restore_course_settings	=item * &restore_course_settings()

=item &store_course_settings	=item * &store_course_settings()

Restores/Store indicated form parameters from the course environment.	Restores/Store indicated form parameters from the course environment.
Will not overwrite existing values of the form parameters.	Will not overwrite existing values of the form parameters.
Line 6782 a hash ref describing the data to be sto	Line 7866 a hash ref describing the data to be sto

Returns: both routines return nothing	Returns: both routines return nothing

	=back

=cut	=cut

#######################################################	#######################################################
Line 6834 sub store_settings {	Line 7920 sub store_settings {
'got error:'.$put_result);	'got error:'.$put_result);
}	}
# Make sure these settings stick around in this session, too	# Make sure these settings stick around in this session, too
&Apache::lonnet::appenv(%AppHash);	&Apache::lonnet::appenv(\%AppHash);
return;	return;
}	}

Line 6862 sub restore_settings {	Line 7948 sub restore_settings {
}	}
}	}

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

	=pod

	=head1 Domain E-mail Routines

	=over 4

	=item * &build_recipient_list()

	Build recipient lists for three types of e-mail:
	(a) Error Reports, (b) Package Updates, (c) Help requests, generated by
	lonerrorhandler.pm, CHECKRPMS and lonsupportreq.pm respectively.

	Inputs:
	defmail (scalar - email address of default recipient),
	mailing type (scalar - errormail, packagesmail, or helpdeskmail),
	defdom (domain for which to retrieve configuration settings),
	origmail (scalar - email address of recipient from loncapa.conf,
	i.e., predates configuration by DC via domainprefs.pm

	Returns: comma separated list of addresses to which to send e-mail.

	=back

	=cut

	############################################################
	############################################################
	sub build_recipient_list {
	my ($defmail,$mailing,$defdom,$origmail) = @_;
	my @recipients;
	my $otheremails;
	my %domconfig =
	&Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
	if (ref($domconfig{'contacts'}) eq 'HASH') {
	if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
	my @contacts = ('adminemail','supportemail');
	foreach my $item (@contacts) {
	if ($domconfig{'contacts'}{$mailing}{$item}) {
	my $addr = $domconfig{'contacts'}{$item};
	if (!grep(/^\Q$addr\E$/,@recipients)) {
	push(@recipients,$addr);
	}
	}
	$otheremails = $domconfig{'contacts'}{$mailing}{'others'};
	}
	}
	} elsif ($origmail ne '') {
	push(@recipients,$origmail);
	}
	if ($defmail ne '') {
	push(@recipients,$defmail);
	}
	if ($otheremails) {
	my @others;
	if ($otheremails =~ /,/) {
	@others = split(/,/,$otheremails);
	} else {
	push(@others,$otheremails);
	}
	foreach my $addr (@others) {
	if (!grep(/^\Q$addr\E$/,@recipients)) {
	push(@recipients,$addr);
	}
	}
	}
	my $recipientlist = join(',',@recipients);
	return $recipientlist;
	}

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

	=pod

	=head1 Course Catalog Routines

	=over 4

	=item * &gather_categories()

	Converts category definitions - keys of categories hash stored in
	coursecategories in configuration.db on the primary library server in a
	domain - to an array. Also generates javascript and idx hash used to
	generate Domain Coordinator interface for editing Course Categories.

	Inputs:
	categories (reference to hash of category definitions).
	cats (reference to array of arrays/hashes which encapsulates hierarchy of
	categories and subcategories).
	idx (reference to hash of counters used in Domain Coordinator interface for
	editing Course Categories).
	jsarray (reference to array of categories used to create Javascript arrays for
	Domain Coordinator interface for editing Course Categories).

	Returns: nothing

	Side effects: populates cats, idx and jsarray.

	=cut

	sub gather_categories {
	my ($categories,$cats,$idx,$jsarray) = @_;
	my %counters;
	my $num = 0;
	foreach my $item (keys(%{$categories})) {
	my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
	if ($container eq '' && $depth == 0) {
	$cats->[$depth][$categories->{$item}] = $cat;
	} else {
	$cats->[$depth]{$container}[$categories->{$item}] = $cat;
	}
	my ($escitem,$tail) = split(/:/,$item,2);
	if ($counters{$tail} eq '') {
	$counters{$tail} = $num;
	$num ++;
	}
	if (ref($idx) eq 'HASH') {
	$idx->{$item} = $counters{$tail};
	}
	if (ref($jsarray) eq 'ARRAY') {
	push(@{$jsarray->[$counters{$tail}]},$item);
	}
	}
	return;
	}

	=pod

	=item * &extract_categories()

	Used to generate breadcrumb trails for course categories.

	Inputs:
	categories (reference to hash of category definitions).
	cats (reference to array of arrays/hashes which encapsulates hierarchy of
	categories and subcategories).
	trails (reference to array of breacrumb trails for each category).
	allitems (reference to hash - key is category key
	(format: escaped(name):escaped(parent category):depth in hierarchy).
	idx (reference to hash of counters used in Domain Coordinator interface for
	editing Course Categories).
	jsarray (reference to array of categories used to create Javascript arrays for
	Domain Coordinator interface for editing Course Categories).

	Returns: nothing

	Side effects: populates trails and allitems hash references.

	=cut

	sub extract_categories {
	my ($categories,$cats,$trails,$allitems,$idx,$jsarray) = @_;
	if (ref($categories) eq 'HASH') {
	&gather_categories($categories,$cats,$idx,$jsarray);
	if (ref($cats->[0]) eq 'ARRAY') {
	for (my $i=0; $i<@{$cats->[0]}; $i++) {
	my $name = $cats->[0][$i];
	my $item = &escape($name).'::0';
	my $trailstr;
	if ($name eq 'instcode') {
	$trailstr = &mt('Official courses (with institutional codes)');
	} else {
	$trailstr = $name;
	}
	if ($allitems->{$item} eq '') {
	push(@{$trails},$trailstr);
	$allitems->{$item} = scalar(@{$trails})-1;
	}
	my @parents = ($name);
	if (ref($cats->[1]{$name}) eq 'ARRAY') {
	for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
	my $category = $cats->[1]{$name}[$j];
	&recurse_categories($cats,2,$category,$trails,$allitems,\@parents);
	}
	}
	}
	}
	}
	return;
	}

	=pod

	=item *&recurse_categories()

	Recursively used to generate breadcrumb trails for course categories.

	Inputs:
	cats (reference to array of arrays/hashes which encapsulates hierarchy of
	categories and subcategories).
	depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
	category (current course category, for which breadcrumb trail is being generated).
	trails (reference to array of breacrumb trails for each category).
	allitems (reference to hash - key is category key
	(format: escaped(name):escaped(parent category):depth in hierarchy).
	parents (array containing containers directories for current category,
	back to top level).

	Returns: nothing

	Side effects: populates trails and allitems hash references

	=back

	=cut

	sub recurse_categories {
	my ($cats,$depth,$category,$trails,$allitems,$parents) = @_;
	my $shallower = $depth - 1;
	if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
	for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
	my $name = $cats->[$depth]{$category}[$k];
	my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
	my $trailstr = join(' -> ',(@{$parents},$category));
	if ($allitems->{$item} eq '') {
	push(@{$trails},$trailstr);
	$allitems->{$item} = scalar(@{$trails})-1;
	}
	my $deeper = $depth+1;
	push(@{$parents},$category);
	&recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents);
	pop(@{$parents});
	}
	} else {
	my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
	my $trailstr = join(' -> ',(@{$parents},$category));
	if ($allitems->{$item} eq '') {
	push(@{$trails},$trailstr);
	$allitems->{$item} = scalar(@{$trails})-1;
	}
	}
	return;
	}

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


sub commit_customrole {	sub commit_customrole {
my ($udom,$uname,$url,$three,$four,$five,$start,$end) = @_;	my ($udom,$uname,$url,$three,$four,$five,$start,$end) = @_;
my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.'@'.$three.' in '.$url.	my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
($start?', '.&mt('starting').' '.localtime($start):'').	($start?', '.&mt('starting').' '.localtime($start):'').
($end?', ending '.localtime($end):'').': <b>'.	($end?', ending '.localtime($end):'').': <b>'.
&Apache::lonnet::assigncustomrole(	&Apache::lonnet::assigncustomrole(
Line 6888 sub commit_standardrole {	Line 8212 sub commit_standardrole {
my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,	my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
$one,$two,$sec,$context);	$one,$two,$sec,$context);
if (($result =~ /^error/) \|\| ($result eq 'not_in_class') \|\|	if (($result =~ /^error/) \|\| ($result eq 'not_in_class') \|\|
($result eq 'unknown_course')) {	($result eq 'unknown_course') \|\| ($result eq 'refused')) {
$output = "Error: $result\n";	$output = $logmsg.' '.&mt('Error: ').$result."\n";
} else {	} else {
$output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.	$output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
($start?', '.&mt('starting').' '.localtime($start):'').	($start?', '.&mt('starting').' '.localtime($start):'').
Line 6906 sub commit_standardrole {	Line 8230 sub commit_standardrole {
$output = &mt('Assigning').' '.$three.' in '.$url.	$output = &mt('Assigning').' '.$three.' in '.$url.
($start?', '.&mt('starting').' '.localtime($start):'').	($start?', '.&mt('starting').' '.localtime($start):'').
($end?', '.&mt('ending').' '.localtime($end):'').': ';	($end?', '.&mt('ending').' '.localtime($end):'').': ';
my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start);	my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
if ($context eq 'auto') {	if ($context eq 'auto') {
$output .= $result.$linefeed;	$output .= $result.$linefeed;
} else {	} else {
Line 6918 sub commit_standardrole {	Line 8242 sub commit_standardrole {

sub commit_studentrole {	sub commit_studentrole {
my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;	my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
my ($result,$linefeed);	my ($result,$linefeed,$oldsecurl,$newsecurl);
if ($context eq 'auto') {	if ($context eq 'auto') {
$linefeed = "\n";	$linefeed = "\n";
} else {	} else {
Line 6930 sub commit_studentrole {	Line 8254 sub commit_studentrole {
my $secchange = 0;	my $secchange = 0;
my $expire_role_result;	my $expire_role_result;
my $modify_section_result;	my $modify_section_result;
unless ($oldsec eq '-1') {	if ($oldsec ne '-1') {
unless ($sec eq $oldsec) {	if ($oldsec ne $sec) {
$secchange = 1;	$secchange = 1;
	my $now = time;
my $uurl='/'.$cid;	my $uurl='/'.$cid;
$uurl=~s/\_/\//g;	$uurl=~s/\_/\//g;
if ($oldsec) {	if ($oldsec) {
$uurl.='/'.$oldsec;	$uurl.='/'.$oldsec;
}	}
$expire_role_result = &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',time);	$oldsecurl = $uurl;
	$expire_role_result =
	&Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
	if ($env{'request.course.sec'} ne '') {
	if ($expire_role_result eq 'refused') {
	my @roles = ('st');
	my @statuses = ('previous');
	my @roledoms = ($one);
	my $withsec = 1;
	my %roleshash =
	&Apache::lonnet::get_my_roles($uname,$udom,'userroles',
	\@statuses,\@roles,\@roledoms,$withsec);
	if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
	my ($oldstart,$oldend) =
	split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
	if ($oldend > 0 && $oldend <= $now) {
	$expire_role_result = 'ok';
	}
	}
	}
	}
$result = $expire_role_result;	$result = $expire_role_result;
}	}
}	}
if (($expire_role_result eq 'ok') \|\| ($secchange == 0)) {	if (($expire_role_result eq 'ok') \|\| ($secchange == 0)) {
$modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid);	$modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
if ($modify_section_result =~ /^ok/) {	if ($modify_section_result =~ /^ok/) {
if ($secchange == 1) {	if ($secchange == 1) {
$$logmsg .= "Section for $uname switched from old section: $oldsec to new section: $sec".$linefeed;	if ($sec eq '') {
	$$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
	} else {
	$$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
	}
} elsif ($oldsec eq '-1') {	} elsif ($oldsec eq '-1') {
$$logmsg .= "New student role for $uname in section $sec in course $cid".$linefeed;	if ($sec eq '') {
	$$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
	} else {
	$$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
	}
} else {	} else {
$$logmsg .= "Student $uname assigned to unchanged section $sec in course $cid".$linefeed;	if ($sec eq '') {
	$$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
	} else {
	$$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
	}
}	}
} else {	} else {
$$logmsg .= "Error when attempting section change for $uname from old section $oldsec to new section: $sec in course $cid -error: $modify_section_result".$linefeed;	if ($secchange) {
	$$logmsg .= &mt('Error when attempting section change for [_1] from old section "[_2]" to new section: "[_3]" in course [_4] -error:',$uname,$oldsec,$sec,$cid).' '.$modify_section_result.$linefeed;
	} else {
	$$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
	}
}	}
$result = $modify_section_result;	$result = $modify_section_result;
} elsif ($secchange == 1) {	} elsif ($secchange == 1) {
$$logmsg .= "Error when attempting to expire role for $uname in old section $oldsec in course $cid -error: $expire_role_result".$linefeed;	if ($oldsec eq '') {
	$$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
	} else {
	$$logmsg .= &mt('Error when attempting to expire existing role for [_1] in section [_2] in course [_3] -error: ',$uname,$oldsec,$cid).' '.$expire_role_result.$linefeed;
	}
	if ($expire_role_result eq 'refused') {
	my $newsecurl = '/'.$cid;
	$newsecurl =~ s/\_/\//g;
	if ($sec ne '') {
	$newsecurl.='/'.$sec;
	}
	if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
	if ($sec eq '') {
	$$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments unaffiliated with any section.',$sec).$linefeed;
	} else {
	$$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments in other sections.',$sec).$linefeed;
	}
	}
	}
}	}
} else {	} else {
$$logmsg .= "Incomplete course id defined. Addition of user $uname from domain $udom to course $one\_$two, section $sec not completed.$linefeed";	$$logmsg .= &mt('Incomplete course id defined.').$linefeed.&mt('Addition of user [_1] from domain [_2] to course [_3], section [_4] not completed.',$uname,$udom,$one.'_'.$two,$sec).$linefeed;
$result = "error: incomplete course id\n";	$result = "error: incomplete course id\n";
}	}
return $result;	return $result;
Line 6969 sub commit_studentrole {	Line 8348 sub commit_studentrole {
############################################################	############################################################
############################################################	############################################################

	sub check_clone {
	my ($args,$linefeed) = @_;
	my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
	my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
	my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
	my $clonemsg;
	my $can_clone = 0;

	if ($clonehome eq 'no_host') {
	$clonemsg = &mt('No new course created.').$linefeed.&mt('A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
	} else {
	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
	if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
	$can_clone = 1;
	} else {
	my %clonehash = &Apache::lonnet::get('environment',['cloners'],
	$args->{'clonedomain'},$args->{'clonecourse'});
	my @cloners = split(/,/,$clonehash{'cloners'});
	if (grep(/^\*$/,@cloners)) {
	$can_clone = 1;
	} elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
	$can_clone = 1;
	} else {
	my %roleshash =
	&Apache::lonnet::get_my_roles($args->{'ccuname'},
	$args->{'ccdomain'},
	'userroles',['active'],['cc'],
	[$args->{'clonedomain'}]);
	if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) \|\| (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
	$can_clone = 1;
	} else {
	$clonemsg = &mt('No new course created.').$linefeed.&mt('The new course could not be cloned from the existing course because the new course owner ([_1]) does not have cloning rights in the existing course ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
	}
	}
	}
	}
	return ($can_clone, $clonemsg, $cloneid, $clonehome);
	}

sub construct_course {	sub construct_course {
my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;	my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
my $outcome;	my $outcome;
Line 6976 sub construct_course {	Line 8394 sub construct_course {
if ($context eq 'auto') {	if ($context eq 'auto') {
$linefeed = "\n";	$linefeed = "\n";
}	}

	#
	# Are we cloning?
	#
	my ($can_clone, $clonemsg, $cloneid, $clonehome);
	if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
	if ($context ne 'auto') {
	if ($clonemsg ne '') {
	$clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
	}
	}
	$outcome .= $clonemsg.$linefeed;

	if (!$can_clone) {
	return (0,$outcome);
	}
	}

#	#
# Open course	# Open course
#	#
Line 6996 sub construct_course {	Line 8433 sub construct_course {
# if anyone ever decides to not show this, and Utils::Course::new	# if anyone ever decides to not show this, and Utils::Course::new
# will need to be suitably modified.	# will need to be suitably modified.
$outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;	$outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;

#	#
# Check if created correctly	# Check if created correctly
#	#
($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);	($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);	my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
$outcome .= &mt('Created on').': '.$crsuhome.$linefeed;	$outcome .= &mt('Created on').': '.$crsuhome.$linefeed;

#	#
# Are we cloning?	# Do the cloning
#	#
my $cloneid='';	if ($can_clone && $cloneid) {
if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
my $can_clone = 0;	if ($context ne 'auto') {
$cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};	$clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);	}
my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);	$outcome .= $clonemsg.$linefeed;
my $clonemsg;	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
if ($clonehome eq 'no_host') {
$clonemsg = &mt('Attempting to clone non-existing [_1]',$crstype);
if ($context eq 'auto') {
$outcome .= $clonemsg;
} else {
$outcome .= '<font color="red">'.$clonemsg.'</font>';
}
$outcome .= $linefeed;
} else {
my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
if ($env{'request.role.domain'} eq $args->{'form.clonedomain'}) {
$can_clone = 1;
} else {
my %clonehash = &Apache::lonnet::get('environment',['cloners'],
$args->{'clonedomain'},$args->{'clonecourse'});
my @cloners = split(/,/,$clonehash{'cloners'});
my %roleshash =
&Apache::lonnet::get_my_roles($args->{'ccuname'},
$args->{'ccdomain'},'userroles',['active'],['cc'],
[$args->{'clonedomain'}]);
if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) \|\| (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
$can_clone = 1;
} else {
$clonemsg = &mt('The new course was not cloned from an existing course because the course owner ([_1]) does not have cloning rights in the existing course ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
if ($context eq 'auto') {
$outcome .= $clonemsg;
} else {
$outcome .= '<font color="red">'.$clonemsg.'</font>';
}
$outcome .= $linefeed;
}
}
}
if ($can_clone) {
$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
if ($context eq 'auto') {
$outcome = $clonemsg;
} else {
$outcome .= '<font color="green">'.$clonemsg.'</font>';
}
$outcome .= $linefeed;
my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
# Copy all files	# Copy all files
&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid);	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
# Restore URL	# Restore URL
$cenv{'url'}=$oldcenv{'url'};	$cenv{'url'}=$oldcenv{'url'};
# Restore title	# Restore title
$cenv{'description'}=$oldcenv{'description'};	$cenv{'description'}=$oldcenv{'description'};
# restore grading mode
if (defined($oldcenv{'grading'})) {
$cenv{'grading'}=$oldcenv{'grading'};
}
# Mark as cloned	# Mark as cloned
$cenv{'clonedfrom'}=$cloneid;	$cenv{'clonedfrom'}=$cloneid;
delete($cenv{'default_enrollment_start_date'});	# Need to clone grading mode
delete($cenv{'default_enrollment_end_date'});	my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
}	$cenv{'grading'}=$newenv{'grading'};
	# Do not clone these environment entries
	&Apache::lonnet::del('environment',
	['default_enrollment_start_date',
	'default_enrollment_end_date',
	'question.email',
	'policy.email',
	'comment.email',
	'pch.users.denied',
	'plc.users.denied'],
	$$crsudom,$$crsunum);
}	}

#	#
# Set environment (will override cloned, if existing)	# Set environment (will override cloned, if existing)
#	#
Line 7096 sub construct_course {	Line 8498 sub construct_course {
} else {	} else {
$cenv{'internal.courseowner'} = $args->{'curruser'};	$cenv{'internal.courseowner'} = $args->{'curruser'};
}	}

my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.	my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
if ($args->{'crssections'}) {	if ($args->{'crssections'}) {
$cenv{'internal.sectionnums'} = '';	$cenv{'internal.sectionnums'} = '';
Line 7156 sub construct_course {	Line 8557 sub construct_course {
}	}
if ($args->{'notify_dc'}) {	if ($args->{'notify_dc'}) {
if ($uname ne '') {	if ($uname ne '') {
push(@notified,$uname.'@'.$udom);	push(@notified,$uname.':'.$udom);
}	}
}	}
if (@notified > 0) {	if (@notified > 0) {
Line 7178 sub construct_course {	Line 8579 sub construct_course {
' ('.$lt{'adby'}.')';	' ('.$lt{'adby'}.')';
if ($context eq 'auto') {	if ($context eq 'auto') {
$outcome .= $badclass_msg.$linefeed;	$outcome .= $badclass_msg.$linefeed;
$outcome .= '<font color="red">'.$badclass_msg.$linefeed.'<ul>'."\n";	$outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
foreach my $item (@badclasses) {	foreach my $item (@badclasses) {
if ($context eq 'auto') {	if ($context eq 'auto') {
$outcome .= " - $item\n";	$outcome .= " - $item\n";
Line 7189 sub construct_course {	Line 8590 sub construct_course {
if ($context eq 'auto') {	if ($context eq 'auto') {
$outcome .= $linefeed;	$outcome .= $linefeed;
} else {	} else {
$outcome .= "</ul><br /><br /></font>\n";	$outcome .= "</ul><br /><br /></div>\n";
}	}
}	}
}	}
Line 7211 sub construct_course {	Line 8612 sub construct_course {
if ($context eq 'auto') {	if ($context eq 'auto') {
$outcome .= $krb_msg;	$outcome .= $krb_msg;
} else {	} else {
$outcome .= '<font color="red" size="+1">'.$krb_msg.'</font>';	$outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
}	}
$outcome .= $linefeed;	$outcome .= $linefeed;
}	}
Line 7309 sub construct_course {	Line 8710 sub construct_course {
if ($errtext) { $fatal=2; }	if ($errtext) { $fatal=2; }
$outcome .= ($fatal?$errtext:'write ok').$linefeed;	$outcome .= ($fatal?$errtext:'write ok').$linefeed;
}	}
return $outcome;
	return (1,$outcome);
}	}

############################################################	############################################################
Line 7352 sub icon {	Line 8754 sub icon {
return &lonhttpdurl($iconname);	return &lonhttpdurl($iconname);
}	}

sub lonhttpdurl {	sub lonhttpd_port {
my ($url)=@_;
my $lonhttpd_port=$Apache::lonnet::perlvar{'lonhttpdPort'};	my $lonhttpd_port=$Apache::lonnet::perlvar{'lonhttpdPort'};
if (!defined($lonhttpd_port)) { $lonhttpd_port='8080'; }	if (!defined($lonhttpd_port)) { $lonhttpd_port='8080'; }
	# IE doesn't like a secure page getting images from a non-secure
	# port (when logging we haven't parsed the browser type so default
	# back to secure
	if ((!exists($env{'browser.type'}) \|\| $env{'browser.type'} eq 'explorer')
	&& $ENV{'SERVER_PORT'} == 443) {
	return 443;
	}
	return $lonhttpd_port;

	}

	sub lonhttpdurl {
	my ($url)=@_;

	my $lonhttpd_port = &lonhttpd_port();
	if ($lonhttpd_port == 443) {
	return 'https://'.$ENV{'SERVER_NAME'}.$url;
	}
return 'http://'.$ENV{'SERVER_NAME'}.':'.$lonhttpd_port.$url;	return 'http://'.$ENV{'SERVER_NAME'}.':'.$lonhttpd_port.$url;
}	}

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

Removed from v.1.565
changed lines
	Added in v.1.658