Visit url - Revision history

Philmasterplus at 11:56, 20 December 2020

2020-12-20T11:56:56Z

← Older revision		Revision as of 11:56, 20 December 2020
Line 1:		Line 1:
	<onlyinclude>{{{{{format\|Function2}}}		<onlyinclude>{{{{{format\|Function2}}}
	\|name=~~User:Philmasterplus/Sandbox~~		\|name=visit_url
	\|function1.return_type=buffer		\|function1.return_type=buffer
	\|function1.description=Returns the original HTML source of the page being overridden inside a relay override script.		\|function1.description=Returns the original HTML source of the page being overridden inside a relay override script.

Philmasterplus at 11:56, 20 December 2020

2020-12-20T11:56:43Z

← Older revision		Revision as of 11:56, 20 December 2020
Line 1:		Line 1:
	{{		<onlyinclude>{{{{{format\|Function2}}}
	~~#vardefine:name\|visit_url}}~~{{		\|name=User:Philmasterplus/Sandbox
	~~#vardefine:return_type~~\|~~buffer~~}}{{		\|function1.return_type=buffer
			\|function1.description=Returns the original HTML source of the page being overridden inside a relay override script.
	~~FunctionPage~~\|		\|function2.return_type=buffer
	name=~~{{#var~~:~~name}}~~\|		\|function2.description=Visits a web page and returns its HTML source.
			\|function2.param1=url
	function1=~~{{Function~~\|		\|function2.param1.type=string
	~~name~~=~~{{#var:name}}\|~~		\|function2.param1.description=URL of the page to visit. If a relative URL is provided, it is treated as an in-game page.
	~~aggregate={{#var:aggregate}}~~\|		\|function2.param2=use_POST
	return_type=~~{{#var:return_type}}\|~~		\|function2.param2.type=boolean
	~~return_also={{#var:return_also}}\|~~		\|function2.param2.optional=yes
	}}\|		\|function2.param2.default=true
			\|function2.param2.description=If <code>true</code>, makes an HTTP POST request when visiting the URL. Otherwise, makes a GET request.
	function2=~~{{Function\|~~		\|function2.param3=encoded
	~~name={{#var:name}}~~\|		\|function2.param3.type=boolean
	~~aggregate~~=~~{{#var:aggregate}}\|~~		\|function2.param3.optional=yes
	~~return_type={{#var:return_type}}~~\|		\|function2.param3.default=false
	~~return_also={{#var:return_also}}\|~~		\|function2.param3.description=If <code>true</code>, KoLmafia assumes that <code>url</code> has already been [[wikipedia:Percent-encoding\|URL-encoded]] and will not encode it.
	~~parameter1~~=~~{{Param\|~~string~~\|page}}\|~~		\|description=
	}}\|		<p>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}}.</p>

	~~function3~~=~~{{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}}\|~~
	}}\|

	~~function4~~=~~{{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}}\|~~
	~~parameter3~~=~~{{Param\|boolean\|encoded}}\|~~
	~~p1desc={{Pspan~~\|~~page}} is the page to visit\|~~
	~~p2desc~~=~~{{Pspan\|use_POST}} is true for a POST request and~~ false ~~for a GET request\|~~
	~~p3desc={{Pspan~~\|~~encoded}} is false if the parameter is not used~~. If ~~set to~~ true, ~~then the~~ url ~~is assumed to be pre~~-encoded ~~by the user~~.\|
	}}\|

	~~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}}.</p>

	<p>The version with no parameters is only meaningful in a relay override script; it retrieves the server page that your script is overriding. All four versions behave slightly differently in a relay script; they retrieve a version of the page with any KoLmafia decorations added, rather than the raw page from the server.</p>		<p>The version with no parameters is only meaningful in a relay override script; it retrieves the server page that your script is overriding. All four versions behave slightly differently in a relay script; they retrieve a version of the page with any KoLmafia decorations added, rather than the raw page from the server.</p>

	<p>In a POST request, if &pwd is part of the {{pspan\|page}} string, it will automatically be replaced by &pwd=###### where ###### is the password hash for the current session. For a GET request the password hash will not be added so you'll want to use {{f\|my_hash}}.\|		<p>In a POST request, if &pwd is part of the {{pspan\|page}} string, it will automatically be replaced by &pwd=###### where ###### is the password hash for the current session. For a GET request the password hash will not be added so you'll want to use {{f\|my_hash}}.</p>
			\|code1={{CodeSample
	code1={{CodeSample\|		\|title=Code Samples
	title=Code Samples\|		\|description=Visits your private character sheet.
	description=Visits your private character sheet.\|		\|code=
	code=		<syntaxhighlight lang="java">
	<syntaxhighlight>
	visit_url( "charsheet.php" );		visit_url( "charsheet.php" );
	</syntaxhighlight>}}\|		</syntaxhighlight>}}
			\|code2={{CodeSample
	code2={{CodeSample\|		\|description=Visits Google.
	description=Visits Google.\|		\|code=
	code=		<syntaxhighlight lang="java">
	<syntaxhighlight>
	visit_url( "http://www.google.com/");		visit_url( "http://www.google.com/");
	</syntaxhighlight>}}		</syntaxhighlight>}}
	{{CodeSample\|		\|code3={{CodeSample
	description=Given a player ID, parse a player's profile for his name.\|		\|description=Given a player ID, parse a player's profile for his name.
	code=		\|code=
	<syntaxhighlight>		<syntaxhighlight lang="java">
	string getPlayerName( int playerID ) {		string [int] getPlayerName( int playerID ) {
	string playerName;		string playerName;

Line 88:		Line 62:
	return playerName;		return playerName;
	}		}
	</syntaxhighlight>}}\|		</syntaxhighlight>}}
	see_also={{SeeAlso\|make_url\|run_choice}}\|		\|see_also={{SeeAlso\|make_url\|run_choice}}
	cli_equiv=The CLI commands "text", or "http:" will also visit specified urls.\|		\|cli_equiv=The CLI commands "text", or "http:" will also visit specified urls.
	more_info=Note that this function returns an empty string if the page does not exist or if the request times out.\|		\|more_info=Note that this function returns an empty string if the page does not exist or if the request times out.
	special=Some people claim that it is better to [[append\|append]] the result of this function to a buffer instead of saving it as a string when dealing with an especially large page to avoid time-out. This claim appears to be purely circumstantial and unsupported by the mafia's code.\|		\|special=Some people claim that it is better to [[append\|append]] the result of this function to a buffer instead of saving it as a string when dealing with an especially large page to avoid time-out. This claim appears to be purely circumstantial and unsupported by the mafia's code.
	}}		\|{{{1\|}}}
			}}</onlyinclude>
	[[Category:Adventuring]]		[[Category:Adventuring]]

Fredg1: adding run_choice() in the seeAlso

2019-11-21T23:29:41Z

adding run_choice() in the seeAlso

← Older revision		Revision as of 23:29, 21 November 2019
Line 89:		Line 89:
	}		}
	</syntaxhighlight>}}\|		</syntaxhighlight>}}\|
	see_also={{SeeAlso\|make_url}}\|		see_also={{SeeAlso\|make_url\|run_choice}}\|
	cli_equiv=The CLI commands "text", or "http:" will also visit specified urls.\|		cli_equiv=The CLI commands "text", or "http:" will also visit specified urls.\|
	more_info=Note that this function returns an empty string if the page does not exist or if the request times out.\|		more_info=Note that this function returns an empty string if the page does not exist or if the request times out.\|

Bale: &pwd info for GET and POST

2011-06-08T19:54:54Z

&pwd info for GET and POST

← Older revision		Revision as of 19:54, 8 June 2011
Line 43:		Line 43:
	}}\|		}}\|

	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}}.		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}}.</p>

	The version with no parameters is only meaningful in a relay override script; it retrieves the server page that your script is overriding. All four versions behave slightly differently in a relay script; they retrieve a version of the page with any KoLmafia decorations added, rather than the raw page from the server.\|		<p>The version with no parameters is only meaningful in a relay override script; it retrieves the server page that your script is overriding. All four versions behave slightly differently in a relay script; they retrieve a version of the page with any KoLmafia decorations added, rather than the raw page from the server.</p>

			<p>In a POST request, if &pwd is part of the {{pspan\|page}} string, it will automatically be replaced by &pwd=###### where ###### is the password hash for the current session. For a GET request the password hash will not be added so you'll want to use {{f\|my_hash}}.\|

	code1={{CodeSample\|		code1={{CodeSample\|

Bale at 08:39, 27 April 2011

2011-04-27T08:39:10Z

← Older revision		Revision as of 08:39, 27 April 2011
Line 45:		Line 45:
	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}}.		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}}.

	The version with no parameters is only meaningful in a relay override script; it retrieves the server page that your script is overriding. All ~~three~~ versions behave slightly differently in a relay script; they retrieve a version of the page with any KoLmafia decorations added, rather than the raw page from the server.\|		The version with no parameters is only meaningful in a relay override script; it retrieves the server page that your script is overriding. All four versions behave slightly differently in a relay script; they retrieve a version of the page with any KoLmafia decorations added, rather than the raw page from the server.\|

	code1={{CodeSample\|		code1={{CodeSample\|

Bale: r8940 adds make_url

2011-01-25T22:48:46Z

r8940 adds make_url

← Older revision		Revision as of 22:48, 25 January 2011
Line 87:		Line 87:
	}		}
	</syntaxhighlight>}}\|		</syntaxhighlight>}}\|
			see_also={{SeeAlso\|make_url}}\|
	cli_equiv=The CLI commands "text", or "http:" will also visit specified urls.\|		cli_equiv=The CLI commands "text", or "http:" will also visit specified urls.\|
	more_info=Note that this function returns an empty string if the page does not exist or if the request times out.\|		more_info=Note that this function returns an empty string if the page does not exist or if the request times out.\|

Bale: Third parameter added in r8767

2011-01-25T09:08:09Z

Third parameter added in r8767

← Older revision		Revision as of 09:08, 25 January 2011
Line 28:		Line 28:
	parameter1={{Param\|string\|page}}\|		parameter1={{Param\|string\|page}}\|
	parameter2={{Param\|boolean\|use_POST}}\|		parameter2={{Param\|boolean\|use_POST}}\|
			}}\|

			function4={{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}}\|
			parameter3={{Param\|boolean\|encoded}}\|
	p1desc={{Pspan\|page}} is the page to visit\|		p1desc={{Pspan\|page}} is the page to visit\|
	p2desc={{Pspan\|use_POST}} is true for a POST request and false for a GET request\|		p2desc={{Pspan\|use_POST}} is true for a POST request and false for a GET request\|
			p3desc={{Pspan\|encoded}} is false if the parameter is not used. If set to true, then the url is assumed to be pre-encoded by the user.\|
	}}\|		}}\|

Bale at 22:17, 21 May 2010

2010-05-21T22:17:48Z

← Older revision		Revision as of 22:17, 21 May 2010
Line 5:		Line 5:
	FunctionPage\|		FunctionPage\|
	name={{#var:name}}\|		name={{#var:name}}\|
	~~function_category=Adventuring\|~~

	function1={{Function\|		function1={{Function\|
Line 81:		Line 80:
	special=Some people claim that it is better to [[append\|append]] the result of this function to a buffer instead of saving it as a string when dealing with an especially large page to avoid time-out. This claim appears to be purely circumstantial and unsupported by the mafia's code.\|		special=Some people claim that it is better to [[append\|append]] the result of this function to a buffer instead of saving it as a string when dealing with an especially large page to avoid time-out. This claim appears to be purely circumstantial and unsupported by the mafia's code.\|
	}}		}}

			[[Category:Adventuring]]

Bale at 02:19, 13 May 2010

2010-05-13T02:19:18Z

← Older revision		Revision as of 02:19, 13 May 2010
Line 36:		Line 36:

	The version with no parameters is only meaningful in a relay override script; it retrieves the server page that your script is overriding. All three versions behave slightly differently in a relay script; they retrieve a version of the page with any KoLmafia decorations added, rather than the raw page from the server.\|		The version with no parameters is only meaningful in a relay override script; it retrieves the server page that your script is overriding. All three versions behave slightly differently in a relay script; they retrieve a version of the page with any KoLmafia decorations added, rather than the raw page from the server.\|

	~~improvecode=yes\|~~

	code1={{CodeSample\|		code1={{CodeSample\|

Bale at 02:18, 13 May 2010

2010-05-13T02:18:44Z

← Older revision		Revision as of 02:18, 13 May 2010
Line 58:		Line 58:
	<syntaxhighlight>		<syntaxhighlight>
	string getPlayerName( int playerID ) {		string getPlayerName( int playerID ) {
	string playerName;		string playerName;

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

	return playerName;		return playerName;
	}		}
	</syntaxhighlight>}}\|		</syntaxhighlight>}}\|

← Older revision		Revision as of 23:29, 21 November 2019
Line 89:		Line 89:
	}		}
	</syntaxhighlight>}}\|		</syntaxhighlight>}}\|
	see_also={{SeeAlso\|make_url}}\|		see_also={{SeeAlso\|make_url\|run_choice}}\|
	cli_equiv=The CLI commands "text", or "http:" will also visit specified urls.\|		cli_equiv=The CLI commands "text", or "http:" will also visit specified urls.\|
	more_info=Note that this function returns an empty string if the page does not exist or if the request times out.\|		more_info=Note that this function returns an empty string if the page does not exist or if the request times out.\|

← Older revision		Revision as of 19:54, 8 June 2011
Line 43:		Line 43:
	}}\|		}}\|

	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}}.		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}}.</p>

	The version with no parameters is only meaningful in a relay override script; it retrieves the server page that your script is overriding. All four versions behave slightly differently in a relay script; they retrieve a version of the page with any KoLmafia decorations added, rather than the raw page from the server.\|		<p>The version with no parameters is only meaningful in a relay override script; it retrieves the server page that your script is overriding. All four versions behave slightly differently in a relay script; they retrieve a version of the page with any KoLmafia decorations added, rather than the raw page from the server.</p>

			<p>In a POST request, if &pwd is part of the {{pspan\|page}} string, it will automatically be replaced by &pwd=###### where ###### is the password hash for the current session. For a GET request the password hash will not be added so you'll want to use {{f\|my_hash}}.\|

	code1={{CodeSample\|		code1={{CodeSample\|

← Older revision		Revision as of 08:39, 27 April 2011
Line 45:		Line 45:
	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}}.		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}}.

	The version with no parameters is only meaningful in a relay override script; it retrieves the server page that your script is overriding. All ~~three~~ versions behave slightly differently in a relay script; they retrieve a version of the page with any KoLmafia decorations added, rather than the raw page from the server.\|		The version with no parameters is only meaningful in a relay override script; it retrieves the server page that your script is overriding. All four versions behave slightly differently in a relay script; they retrieve a version of the page with any KoLmafia decorations added, rather than the raw page from the server.\|

	code1={{CodeSample\|		code1={{CodeSample\|

← Older revision		Revision as of 22:48, 25 January 2011
Line 87:		Line 87:
	}		}
	</syntaxhighlight>}}\|		</syntaxhighlight>}}\|
			see_also={{SeeAlso\|make_url}}\|
	cli_equiv=The CLI commands "text", or "http:" will also visit specified urls.\|		cli_equiv=The CLI commands "text", or "http:" will also visit specified urls.\|
	more_info=Note that this function returns an empty string if the page does not exist or if the request times out.\|		more_info=Note that this function returns an empty string if the page does not exist or if the request times out.\|

← Older revision		Revision as of 09:08, 25 January 2011
Line 28:		Line 28:
	parameter1={{Param\|string\|page}}\|		parameter1={{Param\|string\|page}}\|
	parameter2={{Param\|boolean\|use_POST}}\|		parameter2={{Param\|boolean\|use_POST}}\|
			}}\|

			function4={{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}}\|
			parameter3={{Param\|boolean\|encoded}}\|
	p1desc={{Pspan\|page}} is the page to visit\|		p1desc={{Pspan\|page}} is the page to visit\|
	p2desc={{Pspan\|use_POST}} is true for a POST request and false for a GET request\|		p2desc={{Pspan\|use_POST}} is true for a POST request and false for a GET request\|
			p3desc={{Pspan\|encoded}} is false if the parameter is not used. If set to true, then the url is assumed to be pre-encoded by the user.\|
	}}\|		}}\|