# ga_outline_lib.pl
# library of routines for DHTML outlining for Google API scripts
# see http://www.staggernation.com for info
# By Kevin Shay, kevin [AT] staggernation [DOT] com
# last modified 4/24/02

sub html_level_nav {
	# navigation line for a topic (includes errors)
	my ($params, $response, @fields) = @_;

	my ($first, $prev, $next, $spacer, $about, $err, $href, $start, $target);

	$spacer = html_spacer($params->{'level'}, 3);
	if ($response->{'err'}) {
		$err = $response->{'err'};
	} elsif (!(defined $response->{'resultElements'} && @{$response->{'resultElements'}})) {
		$err = 'No results found.';
	}
	if ($err) {
		return <<"EOH";
<table cellspacing="3" cellpadding="0" border="0">
<tr valign="top"><td>$spacer</td><td>
<font size="-1"><b>$err</b></font>
</td></tr></table>
EOH
	}
		# top level: target to our own frame; otherwise send results to hidden frame
	$target = ($params->{'level'} == 0) ? '' : ' target="hiddenframe"';
	
		# put reload parameter in links to tell script to reload the subtopics for this topic
	$href = "$this_script?reload=1";
		# copy the specified params to the link
	for (@fields) {
		$href .= "&$_=$params->{$_}" if ($params->{$_});
	}
		# do we need a First link?
	if ($response->{'startIndex'} > 20) {
		$first = qq{&nbsp;&nbsp;<a href="$href&start=1"$target>&lt;&lt;&nbsp;First</a>};
	}
		# do we need a Previous link?
	if ($response->{'startIndex'} > 10) {
		$start = $response->{'startIndex'} - 11;
		$prev =  qq{&nbsp;&nbsp;<a href="$href&start=$start"$target>&lt;&nbsp;Previous</a>};
	}
		# do we need a Next link?
	if ($response->{'endIndex'} < $response->{'estimatedTotalResultsCount'}) {
		$next = <<"EOH";
&nbsp;&nbsp;<a href="$href&start=$response->{'endIndex'}"$target>Next&nbsp;&gt;</a>
EOH
	}
		# searches are zero-based
	$start = $response->{'startIndex'} - 1;
	$google = <<"EOH";
<a href="http://www.google.com/search?q=$response->{'searchQuery'}&start=$start" target="_blank">
View in Google</a>
EOH
	$about = $response->{'estimateIsExact'} ? '' : ' about';
	$response->{'estimatedTotalResultsCount'} = insert_commas($response->{'estimatedTotalResultsCount'});
	return <<"EOH";
<table cellspacing="3" cellpadding="0" border="0">
<tr valign="top"><td>$spacer</td><td>
<font size="-1">$params->{'count_text'}<b>$response->{'startIndex'}-$response->{'endIndex'}</b> 
of$about <b>$response->{'estimatedTotalResultsCount'}</b>. 
<b>$google$first$prev$next</b></font>
</td></tr></table>
EOH
}

sub html_spacer {
	# return a spacer GIF for a specified outline level
	my ($level, $extra) = @_;
	
	return '' unless $level;
	my $indwidth = 20 * $level;
		# any additional offset that was passed
	$indwidth += $extra;
	return <<"EOH";
<img src="/img/_.gif" width="$indwidth" height="1">
EOH
}

sub html_js_funcs {
	# JavaScript to go at top of each page
	my ($framepage) = @_;
	
		# the outline scripts need to be framed, so pass a URL
		# to which we should redirect if we're not called in a frame
	if ($framepage) {
		$framepage = <<"EOH";
if (self == top) {
	top.location.href = '$framepage'
}
EOH
	}
	return <<"EOH";
<div id="testdiv" name="testdiv"></div>
<script language="JavaScript">
<!--
$framepage
var err = false
var testdiv
var findmethod = ''
var topic_children
var topic_img
var topic_a
var subtopic_code
if (document.all) {
	findmethod = 'all'
	testdiv = document.all['testdiv'];
} else if (document.getElementById) {
	findmethod = 'byid'
	testdiv = document.getElementById('testdiv');
} else {
	err = true
}
if (!err) {
	if (typeof(testdiv.innerHTML) == 'undefined') {
		err = true
	}
}
if (err) {
	document.write('<b>This script requires Internet Explorer 5+, Netscape 6, Mozilla, or another browser that supports the innerHTML property.</b>')
}

function collapse(topicid, oldhref) {
	if (findmethod == 'all') {
		topic_children = document.all[topicid+'children']
		topic_img = document.all['img'+topicid]
		topic_a = document.all['a'+topicid]
	} else if (findmethod == 'byid') {
		topic_children = document.getElementById(topicid+'children')
		topic_img = document.getElementById('img'+topicid)
		topic_a = document.getElementById('a'+topicid)
	} else {
		return 0
	}
	if (typeof(topic_children.outerHTML) != 'undefined') {
		//workaround for Windows IE, which leaves a blank line when innerHTML is set
		topic_children.outerHTML = '<div id="' + topicid + 'children"></div>'
	} else {
		topic_children.innerHTML = ''
	}
	topic_img.src = "/img/closed.gif" //toggle betwen modes with image...
	topic_a.href = oldhref //restore original href to expand
}

function expand(topicid) {
	if (findmethod == 'all') {
		topic_children = document.all[topicid+'children']
		topic_img = document.all['img'+topicid]
		topic_a = document.all['a'+topicid]
		subtopic_code = parent.hiddenframe.document.all['takeme']
	} else if (findmethod == 'byid') {
		topic_children = document.getElementById(topicid+'children')
		topic_img = document.getElementById('img'+topicid)
		topic_a = document.getElementById('a'+topicid)
		subtopic_code = parent.hiddenframe.document.getElementById('takeme')
	} else {
		return 0
	}
	if (typeof(topic_children.outerHTML) != 'undefined') {
		//workaround for Windows IE, which leaves a blank line when innerHTML is set
		topic_children.outerHTML = '<div id="' + topicid + 'children">' + subtopic_code.innerHTML + '</div>'
	} else {
		topic_children.innerHTML = subtopic_code.innerHTML
	}
	topic_img.src = "/img/open.gif" //toggle betwen modes with image...
	var oldhref = topic_a.href //save original href so we can go back to expand mode later
	topic_a.href = "javascript:parent.outlineframe.collapse('" + topicid + "','" + oldhref + "');"
}

function reload(topicid) {
	if (findmethod == 'all') {
		topic_children = document.all[topicid+'children']
		subtopic_code = parent.hiddenframe.document.all['takeme']
	} else if (findmethod == 'byid') {
		topic_children = document.getElementById(topicid+'children')
		subtopic_code = parent.hiddenframe.document.getElementById('takeme')
	} else {
		return 0
	}
	if (typeof(topic_children.outerHTML) != 'undefined') {
		//workaround for Windows IE, which leaves a blank line when innerHTML is set
		topic_children.outerHTML = '<div id="' + topicid + 'children">' + subtopic_code.innerHTML + '</div>'
	} else {
		topic_children.innerHTML = subtopic_code.innerHTML
	}
}
//-->
</script>
EOH
}

sub html_js_expand {
	# JavaScript to print at the end of the script output for a subtopic
	# (when expanding);
	# tells calling frame it's time to grab the data in this frame
	my ($id) = shift;
	
	return <<"EOH";
<script language="JavaScript">
	<!--
	parent.outlineframe.expand('$id') //tell calling frame we're loaded
	//-->
</script>
EOH
}

sub html_js_reload {
	# JavaScript to print at the end of the script output for a subtopic
	# (when reloading, i.e. clicking Next, Previous, First);
	# tells calling frame it's time to grab the data in this frame
	my ($id) = shift;
	
	return <<"EOH";
<script language="JavaScript">
	<!--
	parent.outlineframe.reload('$id') //tell calling frame we're loaded
	//-->
</script>
EOH
}

1;