SimpleHtmlRendererContext class implements
* the {@link org.lobobrowser.html.HtmlRendererContext} interface.
* Note that this class provides rudimentary implementations
* of most callback methods. Overridding some of the methods
* in this class will usually be necessary in a professional application.
*
* A simple way to load a URL into the {@link HtmlPanel} of the
* renderer context is to invoke {@link #navigate(String)}.
*/
public class SimpleHtmlRendererContext implements HtmlRendererContext {
private static final Logger logger = Logger.getLogger(SimpleHtmlRendererContext.class.getName());
private final HtmlPanel htmlPanel;
private final HtmlRendererContext parentRcontext;
/**
* Constructs a SimpleHtmlRendererContext.
* @param contextComponent The component that will render HTML.
* @deprecated Use constructor that takes HtmlPanel and UserAgentContext
*/
public SimpleHtmlRendererContext(HtmlPanel contextComponent) {
this(contextComponent, (UserAgentContext) null);
}
/**
* Constructs a SimpleHtmlRendererContext.
* @param contextComponent The component that will render HTML.
* @see SimpleUserAgentContext
*/
public SimpleHtmlRendererContext(HtmlPanel contextComponent, UserAgentContext ucontext) {
super();
this.htmlPanel = contextComponent;
this.parentRcontext = null;
this.bcontext = ucontext;
}
/**
* Constructs a SimpleHtmlRendererContext that is a child of another
* {@link HtmlRendererContext}.
* @param contextComponent The component that will render HTML.
* @param parentRcontext The parent's renderer context.
*/
public SimpleHtmlRendererContext(HtmlPanel contextComponent, HtmlRendererContext parentRcontext) {
super();
this.htmlPanel = contextComponent;
this.parentRcontext = parentRcontext;
this.bcontext = parentRcontext == null ? null : parentRcontext.getUserAgentContext();
}
public HtmlPanel getHtmlPanel() {
return this.htmlPanel;
}
private volatile String sourceCode;
/**
* Gets the source code of the current HTML document.
*/
public String getSourceCode() {
return this.sourceCode;
}
/**
* Gets a collection of current document frames, by querying
* the document currently held by the local
* {@link org.lobobrowser.html.gui.HtmlPanel}
* instance.
*/
public HTMLCollection getFrames() {
Object rootNode = this.htmlPanel.getRootNode();
if(rootNode instanceof HTMLDocumentImpl) {
return ((HTMLDocumentImpl) rootNode).getFrames();
}
else {
return null;
}
}
/**
* Implements reload as navigation to current URL.
* Override to implement a more robust reloading
* mechanism.
*/
public void reload() {
HTMLDocumentImpl document = (HTMLDocumentImpl) this.htmlPanel.getRootNode();
if(document != null) {
try {
URL url = new URL(document.getDocumentURI());
this.navigate(url, null);
} catch(java.net.MalformedURLException throwable) {
this.warn("reload(): Malformed URL", throwable);
}
}
}
/**
* Implements the link click handler by invoking {@link #navigate(URL, String)}.
*/
public void linkClicked(HTMLElement linkNode, URL url, String target) {
this.navigate(url, target);
}
/**
* Gets the connection proxy used in {@link #navigate(URL, String)}.
* This implementation calls {@link SimpleUserAgentContext#getProxy()}
* if {@link #getUserAgentContext()} returns an instance assignable to {@link SimpleUserAgentContext}.
* The method may be overridden to provide a different proxy setting.
*/
protected Proxy getProxy() {
Object ucontext = this.getUserAgentContext();
if(ucontext instanceof SimpleUserAgentContext) {
return ((SimpleUserAgentContext) ucontext).getProxy();
}
return Proxy.NO_PROXY;
}
/**
* Implements simple navigation with incremental
* rendering by invoking {@link #submitForm(String, URL, String, String, FormInput[])}
* with a GET request method.
*/
public void navigate(final URL href, String target) {
this.submitForm("GET", href, target, null, null);
}
/**
* Convenience method provided to allow loading a document into
* the renderer.
* @param fullURL The absolute URL of the document.
* @see #navigate(URL, String)
*/
public void navigate(String fullURL) throws java.net.MalformedURLException {
java.net.URL href = Urls.createURL(null, fullURL);
this.navigate(href, "_this");
}
/**
* Implements simple navigation and form submission with incremental
* rendering and target processing, including
* frame lookup. Should be overridden to allow for
* more robust browser navigation and form submission.
*
* Notes: *
application/x-www-form-urlencoded.
* true.
*/
protected boolean isNavigationAsynchronous() {
return true;
}
/**
* The connection currently opened by openSync() if any.
*/
protected URLConnection currentConnection;
/**
* Submits a form and/or navigates by making
* a synchronous request. This method is invoked
* by {@link #submitForm(String, URL, String, String, FormInput[])}.
* @param method The request method.
* @param action The action URL.
* @param target The target identifier.
* @param enctype The encoding type.
* @param formInputs The form inputs.
* @throws IOException
* @throws org.xml.sax.SAXException
* @see #submitForm(String, URL, String, String, FormInput[])
*/
protected void submitFormSync(final String method, final java.net.URL action, final String target, String enctype, final FormInput[] formInputs) throws IOException, org.xml.sax.SAXException {
final String actualMethod = method.toUpperCase();
URL resolvedURL;
if("GET".equals(actualMethod) && formInputs != null) {
boolean firstParam = true;
//TODO: What about the userInfo part of the URL?
URL noRefAction = new URL(action.getProtocol(), action.getHost(), action.getPort(), action.getFile());
StringBuffer newUrlBuffer = new StringBuffer(noRefAction.toExternalForm());
if(action.getQuery() == null) {
newUrlBuffer.append("?");
}
else {
newUrlBuffer.append("&");
}
for(int i = 0; i < formInputs.length; i++) {
FormInput parameter = formInputs[i];
String name = parameter.getName();
String encName = URLEncoder.encode(name, "UTF-8");
if(parameter.isText()) {
if(firstParam) {
firstParam = false;
}
else {
newUrlBuffer.append("&");
}
String valueStr = parameter.getTextValue();
String encValue = URLEncoder.encode(valueStr, "UTF-8");
newUrlBuffer.append(encName);
newUrlBuffer.append("=");
newUrlBuffer.append(encValue);
}
else {
logger.warning("postData(): Ignoring non-textual parameter " + name + " for GET.");
}
}
resolvedURL = new java.net.URL(newUrlBuffer.toString());
}
else {
resolvedURL = action;
}
URL urlForLoading;
if(resolvedURL.getProtocol().equalsIgnoreCase("file")) {
// Remove query so it works.
try {
String ref = action.getRef();
String refText = ref == null || ref.length() == 0 ? "" : "#" + ref;
urlForLoading = new URL(resolvedURL.getProtocol(), action.getHost(), action.getPort(), action.getPath() + refText);
} catch(java.net.MalformedURLException throwable) {
this.warn("malformed", throwable);
urlForLoading = action;
}
}
else {
urlForLoading = resolvedURL;
}
if(logger.isLoggable(Level.INFO)) {
logger.info("process(): Loading URI=[" + urlForLoading + "].");
}
long time0 = System.currentTimeMillis();
// Using potentially different URL for loading.
Proxy proxy = SimpleHtmlRendererContext.this.getProxy();
boolean isPost = "POST".equals(actualMethod);
URLConnection connection = proxy == null || proxy == Proxy.NO_PROXY ? urlForLoading.openConnection() : urlForLoading.openConnection(proxy);
this.currentConnection = connection;
try {
connection.setRequestProperty("User-Agent", getUserAgentContext().getUserAgent());
connection.setRequestProperty("Cookie", "");
if (connection instanceof HttpURLConnection) {
HttpURLConnection hc = (HttpURLConnection) connection;
hc.setRequestMethod(actualMethod);
hc.setInstanceFollowRedirects(false);
}
if(isPost) {
connection.setDoOutput(true);
ByteArrayOutputStream bufOut = new ByteArrayOutputStream();
boolean firstParam = true;
if(formInputs != null) {
for(int i = 0; i < formInputs.length; i++) {
FormInput parameter = formInputs[i];
String name = parameter.getName();
String encName = URLEncoder.encode(name, "UTF-8");
if(parameter.isText()) {
if(firstParam) {
firstParam = false;
}
else {
bufOut.write((byte) '&');
}
String valueStr = parameter.getTextValue();
String encValue = URLEncoder.encode(valueStr, "UTF-8");
bufOut.write(encName.getBytes("UTF-8"));
bufOut.write((byte) '=');
bufOut.write(encValue.getBytes("UTF-8"));
}
else {
logger.warning("postData(): Ignoring non-textual parameter " + name + " for POST.");
}
}
}
// Do not add a line break to post content. Some servers
// can be picky about that (namely, java.net).
byte[] postContent = bufOut.toByteArray();
if(connection instanceof HttpURLConnection) {
((HttpURLConnection) connection).setFixedLengthStreamingMode(postContent.length);
}
connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
//connection.setRequestProperty("Content-Length", String.valueOf(postContent.length));
OutputStream postOut = connection.getOutputStream();
postOut.write(postContent);
postOut.flush();
}
if (connection instanceof HttpURLConnection) {
HttpURLConnection hc = (HttpURLConnection) connection;
int responseCode = hc.getResponseCode();
if(logger.isLoggable(Level.INFO)) {
logger.info("process(): HTTP response code: "
+ responseCode);
}
if(responseCode == HttpURLConnection.HTTP_MOVED_PERM || responseCode == HttpURLConnection.HTTP_MOVED_TEMP || responseCode == HttpURLConnection.HTTP_SEE_OTHER) {
String location = hc.getHeaderField("Location");
if(location == null) {
logger.warning("No Location header in redirect from " + action + ".");
}
else {
java.net.URL href;
href = Urls.createURL(action, location);
SimpleHtmlRendererContext.this.navigate(href, target);
}
return;
}
}
InputStream in = connection.getInputStream();
try {
SimpleHtmlRendererContext.this.sourceCode = null;
long time1 = System.currentTimeMillis();
RecordedInputStream rin = new RecordedInputStream(in, 1000000);
InputStream bin = new BufferedInputStream(rin, 8192);
String actualURI = urlForLoading.toExternalForm();
// Only create document, don't parse.
HTMLDocumentImpl document = this.createDocument(new InputSourceImpl(bin, actualURI, getDocumentCharset(connection)));
// Set document in HtmlPanel. Safe to call outside GUI thread.
HtmlPanel panel = htmlPanel;
panel.setDocument(document, SimpleHtmlRendererContext.this);
// Now start loading.
document.load();
long time2 = System.currentTimeMillis();
if(logger.isLoggable(Level.INFO)) {
logger.info("Parsed URI=[" + urlForLoading + "]: Parse elapsed: "
+ (time2 - time1) + " ms. Connection elapsed: "
+ (time1 - time0) + " ms.");
}
String ref = urlForLoading.getRef();
if(ref != null && ref.length() != 0) {
panel.scrollToElement(ref);
}
try {
SimpleHtmlRendererContext.this.sourceCode = rin.getString("ISO-8859-1");
} catch(BufferExceededException bee) {
SimpleHtmlRendererContext.this.sourceCode = "[TOO BIG]";
}
} finally {
in.close();
}
} finally {
this.currentConnection = null;
}
}
/**
* Creates a blank document instance. This method
* is invoked whenever navigation or form submission
* occur. It is provided so it can be overridden
* to create specialized document implmentations.
* @param inputSource The document input source.
* @throws IOException
* @throws org.xml.sax.SAXException
*/
protected HTMLDocumentImpl createDocument(org.xml.sax.InputSource inputSource) throws IOException, org.xml.sax.SAXException {
DocumentBuilderImpl builder = new DocumentBuilderImpl(this.getUserAgentContext(), SimpleHtmlRendererContext.this);
return (HTMLDocumentImpl) builder.createDocument(inputSource);
}
/**
* This method is invoked by {@link #submitForm(String, URL, String, String, FormInput[])}
* to determine the charset of a document. The charset is determined by looking
* at the Content-Type header.
* @param connection A URL connection.
*/
protected String getDocumentCharset(URLConnection connection) {
String encoding = Urls.getCharset(connection);
return encoding == null ? "ISO-8859-1" : encoding;
}
// Methods useful to Window below:
/**
* Opens a simple message dialog.
*/
public void alert(String message) {
JOptionPane.showMessageDialog(this.htmlPanel, message);
}
/**
* It should give up focus on the current browser window. This implementation does nothing
* and should be overridden.
*/
public void blur() {
this.warn("back(): Not overridden");
}
/**
* It should close the current browser window. This implementation does nothing
* and should be overridden.
*/
public void close() {
this.warn("close(): Not overridden");
}
/**
* Opens a simple confirmation window.
*/
public boolean confirm(String message) {
int retValue = JOptionPane.showConfirmDialog(htmlPanel, message, "Confirm", JOptionPane.YES_NO_OPTION);
return retValue == JOptionPane.YES_OPTION;
}
/**
* It should request focus for the current browser window. This implementation does nothing
* and should be overridden.
*/
public void focus() {
this.warn("focus(): Not overridden");
}
/**
* @deprecated Use {@link #open(URL, String, String, boolean)}.
*/
public final HtmlRendererContext open(String url, String windowName, String windowFeatures, boolean replace) {
URL urlObj;
try {
urlObj = new URL(url);
} catch(MalformedURLException mfu) {
throw new IllegalArgumentException("Malformed URL: " + url);
}
return this.open(urlObj, windowName, windowFeatures, replace);
}
/**
* It should open a new browser window. This implementation does nothing
* and should be overridden.
* @param url The requested URL.
* @param windowName A window identifier.
* @param windowFeatures Window features specified in a format equivalent to
* that of window.open() in Javascript.
* @param replace Whether an existing window with the same name should be replaced.
*/
public HtmlRendererContext open(java.net.URL url, String windowName, String windowFeatures, boolean replace) {
this.warn("open(): Not overridden");
return null;
}
/**
* Shows a simple prompt dialog.
*/
public String prompt(String message, String inputDefault) {
return JOptionPane.showInputDialog(htmlPanel, message);
}
/**
* Changes the origin of the HTML block's scrollable area
* according to the position given.
*
* This method may be called outside of the GUI thread.
* The operation is scheduled immediately in that thread as needed.
* @param x The new x coordinate for the origin.
* @param y The new y coordinate for the origin.
*/
public void scroll(int x, int y) {
this.htmlPanel.scroll(x, y);
}
public void scrollBy(int x, int y) {
this.htmlPanel.scrollBy(x, y);
}
/**
* Should return true if and only if the current browser window is closed.
* This implementation returns false and should be overridden.
*/
public boolean isClosed() {
this.warn("isClosed(): Not overridden");
return false;
}
/**
* Should return true if and only if the current browser window is closed.
* This implementation returns false and should be overridden.
*/
public String getDefaultStatus() {
this.warn("getDefaultStatus(): Not overridden");
return "";
}
/**
* It should return the name of the browser window, if this
* renderer context is for the top frame in the window. This
* implementation returns a blank string, so it should be overridden.
*/
public String getName() {
this.warn("getName(): Not overridden");
return "";
}
public HtmlRendererContext getParent() {
return this.parentRcontext;
}
private volatile HtmlRendererContext opener;
public HtmlRendererContext getOpener() {
return this.opener;
}
public void setOpener(HtmlRendererContext opener) {
this.opener = opener;
}
public String getStatus() {
this.warn("getStatus(): Not overridden");
return "";
}
public void setStatus(String message) {
this.warn("setStatus(): Not overridden");
}
public HtmlRendererContext getTop() {
HtmlRendererContext ancestor = this.parentRcontext;
if(ancestor == null) {
return this;
}
return ancestor.getTop();
}
public BrowserFrame createBrowserFrame() {
return new SimpleBrowserFrame(this);
}
public void warn(String message, Throwable throwable) {
if(logger.isLoggable(Level.WARNING)) {
logger.log(Level.WARNING, message, throwable);
}
}
public void error(String message, Throwable throwable) {
if(logger.isLoggable(Level.SEVERE)) {
logger.log(Level.SEVERE, message, throwable);
}
}
public void warn(String message) {
if(logger.isLoggable(Level.WARNING)) {
logger.log(Level.WARNING, message);
}
}
public void error(String message) {
if(logger.isLoggable(Level.SEVERE)) {
logger.log(Level.SEVERE, message);
}
}
/**
* Returns null. This method should be overridden
* to provide OBJECT, EMBED or APPLET functionality.
*/
public HtmlObject getHtmlObject(HTMLElement element) {
return null;
}
public void setDefaultStatus(String message) {
this.warn("setDefaultStatus(): Not overridden.");
}
private UserAgentContext bcontext = null;
/**
* If a {@link org.lobobrowser.html.UserAgentContext} instance
* was provided in the constructor, then that instance is returned.
* Otherwise, an instance of {@link SimpleUserAgentContext} is
* created and returned.
*
* The context returned by this method is used by local request * facilities and other parts of the renderer. */ public UserAgentContext getUserAgentContext() { synchronized(this) { if(this.bcontext == null) { this.warn("getUserAgentContext(): UserAgentContext not provided in constructor. Creating a simple one."); this.bcontext = new SimpleUserAgentContext(); } return this.bcontext; } } /** * Should be overridden to return true if the link * has been visited. */ public boolean isVisitedLink(HTMLLinkElement link) { return false; } /** * This method must be overridden to implement a context menu. */ public boolean onContextMenu(HTMLElement element, MouseEvent event) { return true; } /** * This method can be overridden to receive notifications when the * mouse leaves an element. */ public void onMouseOut(HTMLElement element, MouseEvent event) { } /** * This method can be overridden to receive notifications when the * mouse first enters an element. */ public void onMouseOver(HTMLElement element, MouseEvent event) { } public boolean isImageLoadingEnabled() { return true; } public boolean onDoubleClick(HTMLElement element, MouseEvent event) { return true; } public boolean onMouseClick(HTMLElement element, MouseEvent event) { return true; } private static java.awt.Window getWindow(Component c) { java.awt.Component current = c; while(current != null && !(current instanceof java.awt.Window)) { current = current.getParent(); } return (java.awt.Window) current; } public void resizeBy(int byWidth, int byHeight) { java.awt.Window window = getWindow(this.htmlPanel); if(window != null) { window.setSize(window.getWidth() + byWidth, window.getHeight() + byHeight); } } public void resizeTo(int width, int height) { java.awt.Window window = getWindow(this.htmlPanel); if(window != null) { window.setSize(width, height); } } /** * It should navigate back one page. This implementation does nothing * and should be overridden. */ public void back() { if(logger.isLoggable(Level.WARNING)) { logger.log(Level.WARNING, "back() does nothing, unless overridden."); } } public void forward() { if(logger.isLoggable(Level.WARNING)) { logger.log(Level.WARNING, "forward() does nothing, unless overridden."); } } public String getCurrentURL() { Object node = this.htmlPanel.getRootNode(); if(node instanceof HTMLDocumentImpl) { HTMLDocumentImpl doc = (HTMLDocumentImpl) node; return doc.getDocumentURI(); } return null; } public int getHistoryLength() { return 0; } public String getNextURL() { return null; } public String getPreviousURL() { return null; } public void goToHistoryURL(String url) { if(logger.isLoggable(Level.WARNING)) { logger.log(Level.WARNING, "goToHistoryURL() does nothing, unless overridden."); } } public void moveInHistory(int offset) { if(logger.isLoggable(Level.WARNING)) { logger.log(Level.WARNING, "moveInHistory() does nothing, unless overridden."); } } }