org.xhtmlrenderer.demo.browser.PanelManager Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of flying-saucer-examples Show documentation
Show all versions of flying-saucer-examples Show documentation
Misc. Flying Saucer example code. It is not deployed with a release.
/*
* PanelManager.java
* Copyright (c) 2005 Torbjoern Gannholm
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2.1
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
*/
package org.xhtmlrenderer.demo.browser;
import com.google.errorprone.annotations.CheckReturnValue;
import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.Nullable;
import org.xhtmlrenderer.resource.XMLResource;
import org.xhtmlrenderer.swing.DelegatingUserAgent;
import org.xhtmlrenderer.util.GeneralUtil;
import org.xhtmlrenderer.util.Uu;
import org.xhtmlrenderer.util.XRLog;
import org.xml.sax.InputSource;
import javax.xml.transform.sax.SAXSource;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.StringReader;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.net.URLConnection;
import java.util.ArrayList;
import java.util.List;
/**
* PanelManager is a UserAgentCallback responsible for the Browser's resource (XML, image, CSS) lookup. Most of the
* power is in the NaiveUserAgent; the PanelManager adds support for the demo:, file: and demoNav: protocols,
* and keeps track of the history of visited links. There is always a "current" link, and one can use the
* {@link #getBack()}, {@link #getForward()} and {@link #hasForward()} methods to navigate within the history.
* As a NaiveUserAgent, the PanelManager is also a DocumentListener, but must be added to the source of document
* events (like a RootPanel subclass).
*/
public class PanelManager extends DelegatingUserAgent {
private int index = -1;
private final List history = new ArrayList<>();
@Override
@Nullable
@CheckReturnValue
public String resolveURI(@Nullable String uri) {
final String burl = getBaseURL();
URL ref = null;
if (uri == null) return burl;
if (uri.trim().isEmpty()) return burl; //jar URLs don't resolve this right
if (uri.startsWith("demo:")) {
DemoMarker marker = new DemoMarker();
String short_url = uri.substring(5);
if (!short_url.startsWith("/")) {
short_url = "/" + short_url;
}
ref = marker.getClass().getResource(short_url);
Uu.p("ref = " + ref);
} else if (uri.startsWith("demoNav:")) {
DemoMarker marker = new DemoMarker();
String short_url = uri.substring("demoNav:".length());
if (!short_url.startsWith("/")) {
short_url = "/" + short_url;
}
ref = marker.getClass().getResource(short_url);
Uu.p("Demo navigation URI, ref = " + ref);
} else if (uri.startsWith("javascript")) {
Uu.p("Javascript URI, ignoring: " + uri);
} else if (uri.startsWith("news")) {
Uu.p("News URI, ignoring: " + uri);
} else {
try {
URL base;
if (burl == null || burl.isEmpty()) {
base = new File(".").toURI().toURL();
} else {
base = new URL(burl);
}
ref = new URL(base, uri);
} catch (MalformedURLException e) {
Uu.p("URI/URL is malformed: %s or %s (caused by: %s)".formatted(burl, uri, e));
}
}
if (ref == null)
return null;
else
return ref.toExternalForm();
}
@NonNull
@Override
public XMLResource getXMLResource(String uri) {
uri = resolveURI(uri);
if (uri != null && uri.startsWith("file:")) {
File file;
try {
StringBuilder sbURI = GeneralUtil.htmlEscapeSpace(uri);
XRLog.general("Encoded URI: " + sbURI);
file = new File(new URI(sbURI.toString()));
} catch (URISyntaxException e) {
XRLog.exception("Invalid file URI " + uri, e);
return getNotFoundDocument(uri);
}
if (file.isDirectory()) {
String dirList = DirectoryLister.list(file);
return XMLResource.load(new StringReader(dirList));
}
}
XMLResource xr = null;
try {
URLConnection uc = new URL(uri).openConnection();
uc.connect();
String contentType = uc.getContentType();
//Maybe should pop up a choice when content/unknown!
if (contentType.equals("text/plain") || contentType.equals("content/unknown")) {
try (InputStream inputStream = uc.getInputStream()) {
SAXSource source = new SAXSource(new PlainTextXMLReader(inputStream), new InputSource());
xr = XMLResource.load(source);
}
} else if (contentType.startsWith("image")) {
String doc = "![](" + uri + ")
";
xr = XMLResource.load(new StringReader(doc));
} else {
try (InputStream inputStream = uc.getInputStream()) {
xr = XMLResource.load(inputStream);
}
}
} catch (MalformedURLException e) {
XRLog.exception("bad URL given: " + uri, e);
} catch (IOException e) {
XRLog.exception("IO problem for " + uri, e);
}
if (xr == null) {
xr = getNotFoundDocument(uri);
}
return xr;
}
/**
* Used internally when a document can't be loaded--returns XHTML as an XMLResource indicating that fact.
*
* @param uri The URI which could not be loaded.
*
* @return An XMLResource containing XML which about the failure.
*/
private XMLResource getNotFoundDocument(String uri) {
XMLResource xr;
// URI may contain & symbols which can "break" the XHTML we're creating
String cleanUri = GeneralUtil.escapeHTML(uri);
String notFound = "Document not found
Could not access URI
" + cleanUri + "
";
xr = XMLResource.load(new StringReader(notFound));
return xr;
}
/**
* Returns true if the link has been visited by the user in this session. Visit tracking is not persisted.
*/
@Override
public boolean isVisited(@Nullable String uri) {
if (uri == null) return false;
uri = resolveURI(uri);
return history.contains(uri);
}
@Override
public void setBaseURL(@Nullable String url) {
String burl = resolveURI(url);
if (burl == null) burl = "error:FileNotFound";
super.setBaseURL(burl);
// setBaseURL is called by view when document is loaded
if (index >= 0) {
String historic = history.get(index);
if (historic.equals(burl)) return; //moved in history
}
index++;
for (int i = index; i < history.size(); history.remove(i)) ;
history.add(index, burl);
}
/**
* Returns the "next" URI in the history of visiting URIs. Advances the URI tracking (as if browser "forward" was
* used).
*/
public String getForward() {
index++;
return history.get(index);
}
/**
* Returns the "previous" URI in the history of visiting URIs. Moves the URI tracking back (as if browser "back" was
* used).
*/
public String getBack() {
index--;
return history.get(index);
}
/**
* Returns true if there are visited URIs in history "after" the pointer the current URI. This would be the case
* if multiple URIs were visited and the getBack() had been called at least once.
*/
public boolean hasForward() {
return index + 1 < history.size() && index >= 0;
}
/**
* Returns true if there are visited URIs in history "before" the pointer the current URI. This would be the case
* if multiple URIs were visited and the current URI pointer was not at the beginning of the visited URI list.
*/
public boolean hasBack() {
return index > 0;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy