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.541 and 1.553

version 1.541, 2007/07/02 03:36:28	version 1.553, 2007/07/18 01:46:07
Line 240 Inputs: formname, elementname	Line 240 Inputs: formname, elementname

formname and elementname specify the name of the html form and the name	formname and elementname specify the name of the html form and the name
of the element the selection from the search results will be placed in.	of the element the selection from the search results will be placed in.
=back
=cut	=cut

sub browser_and_searcher_javascript {	sub browser_and_searcher_javascript {
Line 524 function uncheckAll(field) {	Line 524 function uncheckAll(field) {
if (field.length > 0) {	if (field.length > 0) {
for (i = 0; i < field.length; i++) {	for (i = 0; i < field.length; i++) {
field[i].checked = false ;	field[i].checked = false ;
} } else {	}
	} else {
field.checked = false ;	field.checked = false ;
}	}
}	}
Line 708 sub help_open_topic {	Line 709 sub help_open_topic {
my ($topic, $text, $stayOnPage, $width, $height) = @_;	my ($topic, $text, $stayOnPage, $width, $height) = @_;
$text = "" if (not defined $text);	$text = "" if (not defined $text);
$stayOnPage = 0 if (not defined $stayOnPage);	$stayOnPage = 0 if (not defined $stayOnPage);
if ($env{'browser.interface'} eq 'textual' \|\|	if ($env{'browser.interface'} eq 'textual') {
$env{'environment.remote'} eq 'off' ) {
$stayOnPage=1;	$stayOnPage=1;
}	}
$width = 350 if (not defined $width);	$width = 350 if (not defined $width);
Line 801 ENDOUTPUT	Line 801 ENDOUTPUT
# now just updates the help link and generates a blue icon	# now just updates the help link and generates a blue icon
sub help_open_menu {	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);
if ($env{'browser.interface'} eq 'textual' \|\|	# formerly only used pop-up help (stayOnPage = 0)
$env{'environment.remote'} eq 'off' ) {	# if environment.remote is on (using remote control UI)
$stayOnPage=1;	# if ($env{'browser.interface'} eq 'textual' \|\|
	# $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;
}	}
my $output;	my $output;
if ($component_help) {	if ($component_help) {
Line 1078 sub changable_area {	Line 1083 sub changable_area {
=pod	=pod

=back	=back

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

=over 4	=over 4
Line 1212 sub create_workbook {	Line 1217 sub create_workbook {

=item * create_text_file	=item * create_text_file

Create a file to write to and eventually make available to the usre.	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
return undefs.	return undefs.

Line 1262 sub domain_select {	Line 1267 sub domain_select {
} &Apache::lonnet::all_domains();	} &Apache::lonnet::all_domains();
if ($multiple) {	if ($multiple) {
$domains{''}=&mt('Any domain');	$domains{''}=&mt('Any domain');
	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
return &multiple_select_form($name,$value,4,\%domains);	return &multiple_select_form($name,$value,4,\%domains);
} else {	} else {
	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
return &select_form($name,$value,%domains);	return &select_form($name,$value,%domains);
}	}
}	}
Line 1429 selected");	Line 1436 selected");
#-------------------------------------------	#-------------------------------------------
sub select_dom_form {	sub select_dom_form {
my ($defdom,$name,$includeempty) = @_;	my ($defdom,$name,$includeempty) = @_;
my @domains = sort(&Apache::lonnet::all_domains());	my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
if ($includeempty) { @domains=('',@domains); }	if ($includeempty) { @domains=('',@domains); }
my $selectdomain = "<select name=\"$name\" size=\"1\">\n";	my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
foreach my $dom (@domains) {	foreach my $dom (@domains) {
Line 2119 sub getnames {	Line 2126 sub getnames {
}	}
}	}

	# -------------------------------------------------------------------- getemails
	=pod

	=item * getemails($uname,$udom)

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

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

	=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 2140 sub getemails {	Line 2160 sub getemails {
}	}
}	}

	sub flush_email_cache {
	my ($uname,$udom)=@_;
	if (!$udom) { $udom =$env{'user.domain'}; }
	if (!$uname) { $uname=$env{'user.name'}; }
	return if ($udom eq 'public' && $uname eq 'public');
	my $id=$uname.':'.$udom;
	&Apache::lonnet::devalidate_cache_new('emailscache',$id);
	}

# ------------------------------------------------------------------ Screenname	# ------------------------------------------------------------------ Screenname

=pod	=pod
Line 3324 sub designparm {	Line 3353 sub designparm {

=back	=back

=head1 HTTP Helpers	=head1 HTML Helpers

=over 4	=over 4

Line 3618 sub make_attr_string {	Line 3647 sub make_attr_string {

=pod	=pod

=back

=head1 HTML Helpers

=over 4

=item * &endbodytag()	=item * &endbodytag()

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

Inputs: none	Inputs: none

=back

=cut	=cut

sub endbodytag {	sub endbodytag {
Line 3648 sub endbodytag {	Line 3669 sub endbodytag {

=pod	=pod

=over 4

=item * &standard_css()	=item * &standard_css()

Returns a style sheet	Returns a style sheet
Line 3660 Inputs: (all optional)	Line 3679 Inputs: (all optional)
function -> force usage of a specific rolish color scheme	function -> force usage of a specific rolish color scheme
bgcolor -> override the default page bgcolor	bgcolor -> override the default page bgcolor

=back

=cut	=cut

sub standard_css {	sub standard_css {
Line 3733 form, .inline { display: inline; }	Line 3750 form, .inline { display: inline; }
.LC_diff_added {	.LC_diff_added {
color: green;	color: green;
}	}
	.LC_unknown {
	color: yellow;
	}

.LC_icon {	.LC_icon {
border: 0px;	border: 0px;
}	}
Line 3740 form, .inline { display: inline; }	Line 3761 form, .inline { display: inline; }
border: 0px;	border: 0px;
height: 22px;	height: 22px;
}	}
	.LC_docs_spacer {
	width: 25px;
	height: 1px;
	border: 0px;
	}

.LC_internal_info {	.LC_internal_info {
color: #999;	color: #999;
Line 4409 table.LC_prior_match tr td {	Line 4435 table.LC_prior_match tr td {
}	}

span.LC_nobreak {	span.LC_nobreak {
white-space: nowrap;	white-space: nowrap;
	}

	table.LC_docs_documents {
	background: #BBBBBB;
	border-width: 0px;
	border-collapse: collapse;
	}

	table.LC_docs_documents td.LC_docs_document {
	border: 2px solid black;
	padding: 4px;
	}

	.LC_docs_course_commands div {
	float: left;
	border: 4px solid #AAAAAA;
	padding: 4px;
	background: #DDDDCC;
	}

	.LC_docs_entry_move {
	border: 0px;
	border-collapse: collapse;
	}

	.LC_docs_entry_move td {
	border: 2px solid #BBBBBB;
	background: #DDDDDD;
	}

	.LC_docs_editor td.LC_docs_entry_commands {
	background: #DDDDDD;
	font-size: x-small;
	}
	.LC_docs_copy {
	color: #000099;
	}
	.LC_docs_cut {
	color: #550044;
	}
	.LC_docs_rename {
	color: #009900;
	}
	.LC_docs_remove {
	color: #990000;
	}

	.LC_docs_reinit_warn,
	.LC_docs_ext_edit {
	font-size: x-small;
	}

	.LC_docs_editor td.LC_docs_entry_title,
	.LC_docs_editor td.LC_docs_entry_icon {
	background: #FFFFBB;
	}
	.LC_docs_editor td.LC_docs_entry_parameter {
	background: #BBBBFF;
	font-size: x-small;
	white-space: nowrap;
	}

	table.LC_docs_adddocs td,
	table.LC_docs_adddocs th {
	border: 1px solid #BBBBBB;
	padding: 4px;
	background: #DDDDDD;
}	}

END	END
Line 4417 END	Line 4510 END

=pod	=pod

=over 4

=item * &headtag()	=item * &headtag()

Returns a uniform footer for LON-CAPA web pages.	Returns a uniform footer for LON-CAPA web pages.
Line 4442 Inputs: $title - optional title for the	Line 4533 Inputs: $title - optional title for the
no_auto_mt_title	no_auto_mt_title
-> prevent &mt()ing the title arg	-> prevent &mt()ing the title arg

=back

=cut	=cut

sub headtag {	sub headtag {
Line 4499 ADDMETA	Line 4588 ADDMETA

=pod	=pod

=over 4

=item * &font_settings()	=item * &font_settings()

Returns neccessary <meta> to set the proper encoding	Returns neccessary <meta> to set the proper encoding

Inputs: none	Inputs: none

=back

=cut	=cut

sub font_settings {	sub font_settings {
Line 4525 sub font_settings {	Line 4610 sub font_settings {

=pod	=pod

=over 4

=item * &xml_begin()	=item * &xml_begin()

Returns the needed doctype and <html>	Returns the needed doctype and <html>

Inputs: none	Inputs: none

=back

=cut	=cut

sub xml_begin {	sub xml_begin {
Line 4559 sub xml_begin {	Line 4640 sub xml_begin {

=pod	=pod

=over 4

=item * &endheadtag()	=item * &endheadtag()

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

Inputs: none	Inputs: none

=back

=cut	=cut

sub endheadtag {	sub endheadtag {
Line 4577 sub endheadtag {	Line 4654 sub endheadtag {

=pod	=pod

=over 4

=item * &head()	=item * &head()

Returns a uniform complete <head>..</head> section for LON-CAPA web pages.	Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
Line 4586 Returns a uniform complete <head>..</hea	Line 4661 Returns a uniform complete <head>..</hea
Inputs: $title - optional title for the page	Inputs: $title - optional title for the page
$head_extra - optional extra HTML to put inside the <head>	$head_extra - optional extra HTML to put inside the <head>

=back

=cut	=cut

sub head {	sub head {
Line 4597 sub head {	Line 4670 sub head {

=pod	=pod

=over 4

=item * &start_page()	=item * &start_page()

Returns a complete <html> .. <body> section for LON-CAPA web pages.	Returns a complete <html> .. <body> section for LON-CAPA web pages.
Line 4637 Inputs: $title - optional title for the	Line 4708 Inputs: $title - optional title for the

no_auto_mt_title -> prevent &mt()ing the title arg	no_auto_mt_title -> prevent &mt()ing the title arg

=back

=cut	=cut

sub start_page {	sub start_page {
Line 4690 sub start_page {	Line 4759 sub start_page {

=pod	=pod

=over 4

=item * &head()	=item * &head()

Returns a complete </body></html> section for LON-CAPA web pages.	Returns a complete </body></html> section for LON-CAPA web pages.
Line 4849 sub simple_error_page {	Line 4916 sub simple_error_page {
}	}
}	}

	=pod

	=item * &inhibit_menu_check($arg)

	Checks for a inhibitmenu state and generates output to preserve it

	Inputs: $arg - can be any of
	- undef - in which case the return value is a string
	to add into arguments list of a uri
	- 'input' - in which case the return value is a HTML
	<form> <input> field of type hidden to
	preserve the value
	- a url - in which case the return value is the url with
	the neccesary cgi args added to preserve the
	inhibitmenu state
	- a ref to a url - no return value, but the string is
	updated to include the neccessary cgi
	args to preserve the inhibitmenu state

	=cut

	sub inhibit_menu_check {
	my ($arg) = @_;
	&get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
	if ($arg eq 'input') {
	if ($env{'form.inhibitmenu'}) {
	return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
	} else {
	return
	}
	}
	if ($env{'form.inhibitmenu'}) {
	if (ref($arg)) {
	$$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
	} elsif ($arg eq '') {
	$arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
	} else {
	$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
	}
	}
	if (!ref($arg)) {
	return $arg;
	}
	}

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

=pod	=pod

	=back

	=head1 User Information Routines

	=over 4

=item * &get_users_function()	=item * &get_users_function()

Used by &bodytag to determine the current users primary role.	Used by &bodytag to determine the current users primary role.
Line 4880 sub get_users_function {	Line 4998 sub get_users_function {

=pod	=pod

=item * &check_user_status	=item * &check_user_status()

Determines current status of supplied role for a	Determines current status of supplied role for a
specific user. Roles can be active, previous or future.	specific user. Roles can be active, previous or future.
Line 5415 sub get_secgrprole_info {	Line 5533 sub get_secgrprole_info {

=pod	=pod

	=back

	=head1 HTTP Helpers

	=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

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

Removed from v.1.541
changed lines
	Added in v.1.553