Skip to content
Get Free Trial

HTTP Header Functions

These functions help manipulate HTTP headers to test behaviour of modified browsers or devices.

Since
Sahi Pro 4.0

Modes Browser

_setHttpHeader($key, $value)

Arguments

NameTypeDescription
$keystringHTTP header name
$valuestringHTTP header value

Returns

null

Sets the HTTP header for all further requests made in this browser session. If a HTTP header of given key already exists, it will be replaced.

//Set the User-Agent to that sent by iPad2
var $userAgent = "Mozilla/5.0 (iPad; CPU OS 5_1 like Mac OS X; en-us) " +
"AppleWebKit/534.46 (KHTML, like Gecko) " +
"Version/5.1 Mobile/9B176 Safari/7534.48.3";
_setHttpHeader("User-Agent", $userAgent);
Since
Sahi Pro 4.0

Modes Browser

_addHttpHeader($key, $value)

Arguments

NameTypeDescription
$keystringHTTP header name
$valuestringHTTP header value

Returns

null

Adds the HTTP header for all further requests made in this browser session. If a HTTP header of given key already exists, both old and new headers will be sent.

Since
Sahi Pro 4.0

Modes Browser

_removeHttpHeader($key)

Arguments

NameTypeDescription
$keystringHTTP header name

Returns

null

Removes a particular HTTP header. For example, can be used to check behaviour when user-agent is not sent

_removeHttpHeader("User-Agent");
Since
Sahi Pro 4.0

Modes Browser

_resetHttpHeader($key)

Arguments

NameTypeDescription
$keystringHTTP header name

Returns

null

If _addHttpHeader or _setHttpHeader or _removeHttpHeader had been called in this session before, calling _resetHttpHeader will revert it to the original behaviour, before any of those functions were called.

_removeHttpHeader("User-Agent"); // remove header
// do a few actions
// requests will not be sending user-agent
_resetHttpHeader("User-Agent"); // revert back
// will send user-agent header as the browser normally does.
Since
Sahi Pro 5.1.0

Modes Browser

_mapDomainToIP($urlBase, $ip)

Arguments

NameTypeDescription
$urlBasestringurl with protocol, domain and port (if present). Ex. http://dummy.domain.com/ or https://dummy.domain.com:8080/
$ipstring|objectIP to map url's domain to. If $ip is not specified or is null, any existing mapping for that domain will be removed.

Returns

null

Used to map a domain to a specific IP. For example while testing, a thirdparty service may be mocked out with a server on a local IP.

If you add

_mapDomainToIP("http://www.google.com/", "127.0.0.1");

at the start of the script, all requests to http://www.google.com will be responded to by your localhost server.

_mapDomainToIP("http://www.google.com/"); // remove any previously set mapping.
// All requests to http://www.google.com will now go to http://www.google.com correctly.

The connection between the browser and proxy normally uses keep-alive=true. Sometimes, pages with applets or flex objects hang if keep-alive is true. In such cases, _disableKeepAlive can be used before loading the applet/flex object and then _enableKeepAlive() can be called to restore original behaviour.

Since
Sahi Pro 3.5

Modes Browser

_disableKeepAlive()

Arguments

NameTypeDescription
None

Returns

null

_disableKeepAlive() turns off Keep-Alive between browser and proxy.

Since
Sahi Pro 3.5

Modes Browser

_enableKeepAlive()

Arguments

NameTypeDescription
None

Returns

null

_enableKeepAlive() turns on Keep-Alive between browser and proxy.

Example:

_disableKeepAlive();
_call(loadPageWithFlashWhichHangsOtherwise());
_enableKeepAlive()
Since
Sahi Pro 3.5

Modes Browser

_cookie($name[, $path])

Arguments

NameTypeDescription
$namestringCookie name
$pathstringoptionalLocation for which the cookie is assigned

Returns

stringValue of cookie with given name

_cookie() gets the value of cookie with the given name for the current page.
Provide the path parameter if the cookie was assigned by the server to a specific path.

Since
Sahi Pro 3.5

Modes Browser

_createCookie($name, $value, $days)

Arguments

NameTypeDescription
$namestringCookie name
$valuestringCookie value
$daysintegerDays to expiry

Returns

null
Since
Sahi Pro 3.5

Modes Browser

_deleteCookie($name)

Arguments

NameTypeDescription
$namestringCookie name

Returns

null

Deletes the cookie with given name for the current page. This may or may not work. A better way may be to use the Cookie Manager

Cookies are specific to domains. To see all cookies of a particular domain, you can navigate to http://yourdomain.com/_s_/dyn/Cookies_showAll This page will show you all cookies associated with yourdomain.com. You can choose and delete cookies from this page. This handles httpOnly cookies also.

Note that if you want to delete a cookie from www.yahoo.com, you should navigate to both http://www.yahoo.com/_s_/dyn/Cookies_showAll and http://yahoo.com/_s_/dyn/Cookies_showAll and delete the relevant cookie.