com.semanticcms.core.sitemap.SiteMapServlet Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of semanticcms-core-sitemap Show documentation
Show all versions of semanticcms-core-sitemap Show documentation
Automatic sitemaps for SemanticCMS.
/*
* semanticcms-core-sitemap - Automatic sitemaps for SemanticCMS.
* Copyright (C) 2016 AO Industries, Inc.
* [email protected]
* 7262 Bull Pen Cir
* Mobile, AL 36695
*
* This file is part of semanticcms-core-sitemap.
*
* semanticcms-core-sitemap 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 3 of the License, or
* (at your option) any later version.
*
* semanticcms-core-sitemap 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 semanticcms-core-sitemap. If not, see views,
final Book book
) throws ServletException, IOException {
// The most recent is kept here, but set to null the first time a missing
// per page/view last modified time is found
final ReadableInstant[] result = new ReadableInstant[1];
CapturePage.traversePagesAnyOrder(
servletContext,
req,
resp,
book.getContentRoot(),
CaptureLevel.META,
new CapturePage.PageHandler() {
@Override
public Boolean handlePage(Page page) throws ServletException, IOException {
// TODO: Chance for more concurrency here by view?
for(View view : views) {
if(
view.getAllowRobots(servletContext, req, resp, page)
&& view.isApplicable(servletContext, req, resp, page)
) {
ReadableInstant lastModified = view.getLastModified(servletContext, req, resp, page);
if(lastModified == null) {
// Stop searching, return null for this book
result[0] = null;
return false;
} else {
if(
result[0] == null
|| lastModified.compareTo(result[0]) > 0
) {
result[0] = lastModified;
}
}
}
}
return null;
}
},
new CapturePage.TraversalEdges() {
@Override
public Set getEdges(Page page) {
return page.getChildRefs();
}
},
new CapturePage.EdgeFilter() {
@Override
public boolean applyEdge(PageRef childPage) {
return book.equals(childPage.getBook());
}
}
);
return result[0];
}
/**
* The response is not given to getLastModified, but we need it for captures to get
* the last modified.
*/
private static final String RESPONSE_IN_REQUEST_ATTRIBUTE = SiteMapServlet.class.getName() + ".responseInRequest";
@Override
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
Object old = req.getAttribute(RESPONSE_IN_REQUEST_ATTRIBUTE);
try {
req.setAttribute(RESPONSE_IN_REQUEST_ATTRIBUTE, resp);
super.service(req, resp);
} finally {
req.setAttribute(RESPONSE_IN_REQUEST_ATTRIBUTE, old);
}
}
@Override
protected long getLastModified(HttpServletRequest req) {
final ServletContext servletContext = getServletContext();
SemanticCMS semanticCMS = SemanticCMS.getInstance(servletContext);
final Book book = getBook(semanticCMS, req);
if(book == null) {
log("Book not found: " + req.getServletPath());
return -1;
} else {
try {
ReadableInstant lastModified = getLastModified(
getServletContext(),
req,
(HttpServletResponse)req.getAttribute(RESPONSE_IN_REQUEST_ATTRIBUTE),
semanticCMS.getViews(),
book
);
return lastModified == null ? -1 : lastModified.getMillis();
} catch(ServletException e) {
log("getLastModified failed", e);
return -1;
} catch(IOException e) {
log("getLastModified failed", e);
return -1;
}
}
}
@Override
protected void doGet(final HttpServletRequest req, final HttpServletResponse resp) throws ServletException, IOException {
final ServletContext servletContext = getServletContext();
SemanticCMS semanticCMS = SemanticCMS.getInstance(servletContext);
final Book book = getBook(semanticCMS, req);
if(book == null) {
resp.sendError(HttpServletResponse.SC_NOT_FOUND);
return;
}
final SortedSet views = semanticCMS.getViews();
final DateTimeFormatter iso8601 = ISODateTimeFormat.dateTime();
resp.resetBuffer();
resp.setContentType(CONTENT_TYPE);
resp.setCharacterEncoding(ENCODING);
final PrintWriter out = resp.getWriter();
out.println("");
out.println("");
CapturePage.traversePagesDepthFirst(
servletContext,
req,
resp,
book.getContentRoot(),
CaptureLevel.META,
new CapturePage.PageDepthHandler() {
@Override
public Void handlePage(Page page, int depth) throws ServletException, IOException {
assert page.getPageRef().getBook().equals(book);
// TODO: Concurrency: Any benefit to processing each view concurrently? allowRobots and isApplicable can be expensive but should also benefit from capture caching
for(View view : views) {
if(
view.getAllowRobots(servletContext, req, resp, page)
&& view.isApplicable(servletContext, req, resp, page)
) {
out.println(" ");
out.print(" ");
encodeTextInXhtml(view.getCanonicalUrl(servletContext, req, resp, page), out);
out.println(" ");
ReadableInstant lastmod = view.getLastModified(servletContext, req, resp, page);
if(lastmod != null) {
out.print(" ");
encodeTextInXhtml(iso8601.print(lastmod), out);
out.println(" ");
}
out.println(" ");
}
}
return null;
}
},
new CapturePage.TraversalEdges() {
@Override
public Set getEdges(Page page) {
return page.getChildRefs();
}
},
new CapturePage.EdgeFilter() {
@Override
public boolean applyEdge(PageRef childPage) {
return book.equals(childPage.getBook());
}
},
null
);
out.println(" ");
}
}