View source for Visit url

{{
#vardefine:name|visit_url}}{{
#vardefine:return_type|buffer}}{{

FunctionPage|
name={{#var:name}}|
function_category=String Handling Routines|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|page}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|page}}|
parameter2={{Param|boolean|use_POST}}|
p1desc={{Pspan|page}} is the page to visit|
p2desc={{Pspan|use_POST}} is true for a POST request and false for a GET request|
}}|

function_description=Returns the HTML from the visited page (not just what is displayed when visiting the page, but all markup) by performing a POST request if {{pspan|use_POST}} is omitted or true, or a GET request if false. Note that for addresses inside of KoL, it is only necessary to supply the page name for {{pspan|page}}, and KoLmafia will populate the rest of the url. However, pages outside of KoL require the full url to be supplied for {{pspan|page}}.|

improvecode=yes|

code1={{CodeSample|
title=Code Samples|
description=Visits your private character sheet.|
code=
<syntaxhighlight>
visit_url( "charsheet.php" );
</syntaxhighlight>}}|

code2={{CodeSample|
description=Visits google.|
code=
<syntaxhighlight>
visit_url( "http://www.google.com/");
</syntaxhighlight>}}|

code3={{CodeSample|
description=Given a player ID, parse a player's profile for his name.|
code=
<syntaxhighlight>
string getPlayerName( int playerID ) {
	string playerName;

	// use visit_url() to store the player profile's HTML in a string
	string playerProfile = visit_url("/showplayer.php?who=" + playerID);
	if ( contains_text(playerProfile, "<td>Sorry, this player could not be found.</td>") ) {
		print("Player " + playerID + "does not exist.","red");
		return "";
	}
	// find player name in the string returned by visit_url()
	matcher match_name = create_matcher( "<b>([^<]+)</b> \\(#" + playerID + "\\)<br>", playerProfile );
	if ( match_name.find() ) {
		playerName = match_name.group(1);
	}
	else {
		print("Problem occured while parsing for player name","red");
		return "";
	}

	return playerName;
}
</syntaxhighlight>}}|

special=Note that this function returns void if the page does not exist or if the request times-out.
}}
{{RFI|Is the special note correct? It appears to sometimes return an empty string & sometimes void; I'm unclear on how the two interact}}