/**
* Stores the cookies currently saved in memory, to the record store.
*
* @param cookiesStorage the name of the record store to hold the cookies.
* @throws IOException
*/
public void storeCookies(String cookiesStorage) throws IOException {
if (savedCookies.size() == 0) {
Log.logInfo("No cookies to store in recordstore.");
return; // nothing to save.
}
try {
try {
connector.rmsDelete(cookiesStorage);
} catch (Throwable e) { // try to delete last save cookies.
Log.logWarn("Failed to delete old saved cookies file. " + e.getMessage());
}
ByteArrayOutputStream bout = new ByteArrayOutputStream();
DataOutputStream dout = new DataOutputStream(bout);
for (int i = 0; i < savedCookies.size(); ++i) {
Cookie c = (Cookie) savedCookies.elementAt(i);
Cookie.serialize(c, dout);
}
byte[] buf = bout.toByteArray();
int free = connector.rmsFree();
if (free < buf.length)
throw new IOException("Not enough free storage space to save cookies.");
connector.rmsWrite(cookiesStorage, buf);
} catch (Throwable e) {
if (e instanceof IOException) throw (IOException) e;
else throw new IOException("Store cookies failed. " + e.getMessage());
}
Log.logInfo("Stored " + savedCookies.size() + " to record store: " + cookiesStorage);
}
public boolean unregisterConnection(Response r) {
if (r == null) {
Log.logWarn("Cannot unregister null connection.");
return false;
}
synchronized (openResponses) {
return openResponses.removeElement(r);
}
}
/**
* If a request is in progress this method will cause the requestResource method to throw a
* InterruptedIOException.
*/
public void cancel() {
synchronized (openResponses) {
try {
Log.logDebug(
"HttpClient.cancel() canceling and removing "
+ openResponses.size()
+ " open connections");
for (int i = 0; i < openResponses.size(); ++i) {
try {
Response r = (Response) openResponses.elementAt(i);
r.setCanceled(true);
r.close();
} catch (Exception e) {
Log.logWarn("HttpClient Failed to cancel request", e);
}
}
} finally {
openResponses.removeAllElements();
}
}
}
private void saveCookie(String cookieStr, String host) {
try {
Cookie newCookie = new Cookie(cookieStr, host);
int idx = savedCookies.indexOf(newCookie); // check to see if cookie already exists
Date expires = newCookie.getExpires();
if (idx > -1) {
savedCookies.removeElementAt(idx);
}
if (expires == null || System.currentTimeMillis() < (expires.getTime())) {
savedCookies.addElement(newCookie);
Log.logDebug("Saved Cookie " + newCookie.getName());
} else // expiration date is in the past.
{
Log.logDebug("Removed (expired: " + expires + ") Cookie: " + newCookie.getName());
}
} catch (Exception e) {
Log.logWarn("Failed to save cookie: " + cookieStr, e);
}
}
public Page handleResponse(Response rsp, Browser browser)
throws UnsupportedEncodingException, IOException, Exception {
Page res = new Page(rsp.getURL());
Log.logWarn(
"Unsupported content-type: " + rsp.getContentType() + ". Requested URL: " + rsp.getURL());
res.setUserMessage(
Lang.get("Usupported content type")
+ " "
+ rsp.getContentType()
+ ". "
+ Lang.get("Cannot open file on location")
+ ": "
+ rsp.getURL());
res.setUserMessageType(Alert.TYPE_WARNING);
try { // the ResponseHandler is responsible to close the connection.
rsp.close();
} catch (IOException e) {
Log.logWarn("Failed to close response.", e);
}
return res;
}
/**
* This method performs a URL encode on the parameters in the URL and if it is relative it
* converts it to absolute.
*
* @param url
* @return The absolute url-encoded URL
*/
public String getAbsolutEncodedURL(String url) {
if (url == null) throw new IllegalArgumentException("Request for resource to null url?");
url = StringUtil.proccessUrl(url, false);
if (url.indexOf("://") == -1 && currentResponse != null) // url path is relevative to current.
{
Log.logDebug("Resolving URL: " + url);
if (url.startsWith("/")) {
url = currentResponse.getBaseURL() + url;
} else {
String base = currentResponse.getBaseURL();
String file = currentResponse.getFile();
int idx = -1;
if (file != null) {
idx = file.lastIndexOf('/');
if (idx == 0) idx = -1; // file starts with "/" ignore that
}
if (idx == -1) {
String s = "";
if (base.endsWith("/") == false) s = "/";
url = base + s + url;
} else {
int start = 0;
if (file.startsWith("/")) start = 1;
String sep = "/";
if (base.endsWith("/")) sep = "";
url = base + sep + file.substring(start, idx) + "/" + url;
}
}
Log.logDebug("URL Resolved to: " + url);
}
return url;
}
private String getCookies(HttpConnection req, String path) {
String host = req.getHost();
if (path == null) path = "/";
boolean includeSecure = req instanceof HttpsConnection;
String res = "";
for (int i = 0; i < savedCookies.size(); ++i) {
Cookie c = (Cookie) savedCookies.elementAt(i);
if (c.match(host, path) && (includeSecure || !c.isSecure())) {
res += c.toString() + "; ";
Log.logDebug("Sending Cookie: " + c.getName());
}
}
return res;
}
/**
* Load the cookies previously stored in the specified recordstore using the {@link
* #storeCookies(String)} method.
*
* @param cookiesStorage
* @throws IOException
*/
public void loadCookies(String cookiesStorage) throws IOException {
try {
InputStream in = connector.rmsRead(cookiesStorage);
if (in == null) return; // no stored cookies found
DataInputStream din = new DataInputStream(in);
int cookiesCount = 0;
while (din.available() > 0) {
Cookie c = Cookie.deSerialize(din);
savedCookies.addElement(c);
cookiesCount++;
}
Log.logInfo("Loaded " + cookiesCount + " cookies from record store: " + cookiesStorage);
} catch (Throwable e) {
if (e instanceof IOException) throw (IOException) e;
else throw new IOException("Load cookies failed. " + e.getMessage());
}
}
/**
* Makes a http request to URL using the set method (HttpConnection.GET or HttpConnection.POST)
* and the supplied request parameters.
*
* @param url
* @param requestMethod
* @param requestProperties User supplied Http request header parameters.
* @param data if method is POST then the post data are in this array.
* @param updateCurrentPage if set to true the HttpClient will remember the URL of this request in
* order to handle feature relative path requests
* @return
* @throws InterruptedIOException
* @throws SecurityException
* @throws IOException
* @throws IllegalStateException
* @throws Exception
*/
public Response requestResource(
String url,
String requestMethod,
Hashtable requestProperties,
byte[] data,
boolean updateCurrentPage)
throws InterruptedIOException, SecurityException, IOException, IllegalStateException,
Exception {
url = getAbsolutEncodedURL(url);
int idx = url.indexOf("://");
if (idx == -1) throw new IllegalArgumentException("URL must start with the protocol.");
String protocol = url.substring(0, idx);
if (protocol.equals("file")) {
// Log.logInfo("File: ["+url+"]");
InputStream in = null;
try {
in = connector.openInputStream(url);
} catch (Exception e) {
Log.logDebug("Exception:" + e.getClass() + ": " + e.getMessage());
}
if (in == null) {
Log.logWarn("Failed to load local resource " + url);
return null;
}
Response result = new Response("", "file", url.substring(7), in);
if (updateCurrentPage) currentResponse = result;
return result;
}
if (protocol.equals("rms")) {
// Log.logInfo("File: ["+url+"]");
InputStream in = null;
String rms = url.substring(6);
try {
in = connector.rmsRead(rms);
} catch (Exception e) {
Log.logDebug("Exception:" + e.getClass() + ": " + e.getMessage());
}
if (in == null) {
Log.logWarn("Failed to load local resource " + url);
return null;
}
Response result = new Response("", "rms", rms, in);
if (updateCurrentPage) currentResponse = result;
return result;
}
HttpConnection conn = null;
Log.logInfo(requestMethod + " [" + url + "]");
try { // the resource is located remotelly. Try to retrieve it.
int mode = Connector.READ_WRITE;
// XXX CREATING A READ ONLY CONNECTION WILL CAUSE SOME BLACKBERRY DEVICES NOT TO WORK. XXX
// if(HttpConnection.POST.equals(requestMethod) && data!=null) mode=Connector.READ_WRITE;
int code;
Response result = new Response();
registerConnection(result);
conn = (HttpConnection) connector.open(url, mode, true);
conn.setRequestMethod(requestMethod);
for (int i = 0; i < defaultHeaderValues.length; ++i) {
conn.setRequestProperty(defaultHeaderValues[i][0], defaultHeaderValues[i][1]);
}
if (requestProperties != null) {
Enumeration propKeys = requestProperties.keys();
while (propKeys.hasMoreElements()) {
String key = (String) propKeys.nextElement();
String val = (String) requestProperties.get(key);
conn.setRequestProperty(key, val);
}
}
// add cookies
String cookies = getCookies(conn, conn.getFile());
if (cookies.length() > 0) {
conn.setRequestProperty("Cookie", cookies);
}
// add referer
if (currentResponse != null && currentResponse.getProtocol().equals("file") == false) {
String q = currentResponse.getQuery();
if (q != null) q = "?" + q;
else q = "";
String referer = currentResponse.getBaseURL() + currentResponse.getFile() + q;
conn.setRequestProperty("Referer", referer);
}
if (mode == Connector.READ_WRITE && data != null) // exoume na grapsoume kiolas.
{
conn.setRequestProperty("Content-Length", "" + data.length);
OutputStream out = conn.openOutputStream();
out.write(data);
out.close();
Log.logDebug("Post data[" + data.length + "] sent.");
}
Log.logDebug("Attempting to retrieve response code..");
code = conn.getResponseCode();
result.setConnection(conn);
Log.logInfo("Response " + code + " " + conn.getResponseMessage());
for (int i = 0; i < 100; ++i) {
String key = conn.getHeaderFieldKey(i);
if (key == null) break;
if (key.toLowerCase().equals("set-cookie")) {
// the cookieStr may be more than one cookies separated by commas.
// First we split the cookies and then we parse them.
// this is a bit tricky since a cookie may contain commas as well...(who thought of that
// delimiter anyway?)
Vector cookieStrings = Cookie.splitCookies(conn.getHeaderField(i));
for (int j = 0; j < cookieStrings.size(); ++j)
saveCookie((String) cookieStrings.elementAt(j), conn.getHost());
} else Log.logDebug(key + ": " + conn.getHeaderField(i));
}
if (code == HttpConnection.HTTP_MOVED_PERM
|| code == HttpConnection.HTTP_MOVED_TEMP
|| // 301 or 307 redirect using the same method (post of get)
code
== HttpConnection.HTTP_SEE_OTHER) // must redirect using the GET method (see protocol)
{
if (updateCurrentPage) currentResponse = result;
if (result.isCanceled()) throw new InterruptedIOException("Redirect canceled by user.");
redirectCount++;
String redirect = conn.getHeaderField("location");
Log.logInfo("Redirect[" + redirectCount + "] " + code + " to location: " + redirect);
if (redirectCount < MAX_REDIRECTS) {
try {
conn.close();
} catch (IOException e) {
Log.logWarn("HttpClient: Failed to close connection on redirect.", e);
}
conn = null; // make old connection null so on finally we will not try to unregister it
// again.
if (code == HttpConnection.HTTP_MOVED_PERM || code == HttpConnection.HTTP_MOVED_TEMP)
return requestResource(
redirect, requestMethod, requestProperties, data, updateCurrentPage);
else
return requestResource(
redirect, HttpConnection.GET, requestProperties, data, updateCurrentPage);
} else {
throw new IllegalStateException("Too many redirects.");
}
} else // response is 200 or another http code.
{
if (updateCurrentPage
&& code == HttpConnection.HTTP_OK) // updateCurrentPage only when response is 200 (OK)
currentResponse = result;
return result;
}
} catch (Exception ex) {
if (ex instanceof InterruptedIOException) Log.logInfo("USER Closed connection to " + url);
else Log.logError("Request to " + url + " failed.", ex);
if (conn != null) {
try {
conn.close();
} catch (IOException e) {
Log.logWarn("Failed to close the connection.", e);
}
}
throw ex;
} finally {
redirectCount = 0;
}
}
