com.semanticcms.core.servlet.PageUtils Maven / Gradle / Ivy
/*
* semanticcms-core-servlet - Java API for modeling web page content and relationships in a Servlet environment.
* Copyright (C) 2013, 2014, 2015, 2016, 2017, 2019, 2020, 2021, 2022, 2023 AO Industries, Inc.
* [email protected]
* 7262 Bull Pen Cir
* Mobile, AL 36695
*
* This file is part of semanticcms-core-servlet.
*
* semanticcms-core-servlet 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-servlet 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-servlet. If not, see boolean hasElement(
ServletContext servletContext,
HttpServletRequest request,
HttpServletResponse response,
Page page,
Class elementType,
boolean recursive,
IOPredicateE filter
) throws ServletException, IOException {
if (recursive) {
return CapturePage.traversePagesAnyOrder(
servletContext,
request,
response,
page,
CaptureLevel.META,
page1 -> {
for (Element element : page1.getElements()) {
if (elementType.isAssignableFrom(element.getClass()) && filter.test(elementType.cast(element))) {
return true;
}
}
return null;
},
Page::getChildRefs,
// Child not in missing book
childPage -> childPage.getBook() != null
) != null;
} else {
for (Element element : page.getElements()) {
if (elementType.isAssignableFrom(element.getClass()) && filter.test(elementType.cast(element))) {
return true;
}
}
return false;
}
}
// TODO: Cache result per class per page?
public static boolean hasElement(
ServletContext servletContext,
HttpServletRequest request,
HttpServletResponse response,
Page page,
Class elementType,
boolean recursive
) throws ServletException, IOException {
return hasElement(servletContext, request, response, page, elementType, recursive, element -> true);
}
/**
*
* Finds the allowRobots setting for the given page.
*
*
* When no allowRobots provided, will use the allowRobots(s) of any parent
* page that is within the same book. If there are no parent pages
* in this same book, uses the book's allowRobots.
*
*
* When inheriting allowRobots from multiple parent pages, the allowRobots must
* be in exact agreement. This means exactly the same order and all
* values matching precisely. Any mismatch in allowRobots will result in
* an exception.
*
*/
public static boolean findAllowRobots(
ServletContext servletContext,
HttpServletRequest request,
HttpServletResponse response,
com.semanticcms.core.model.Page page
) throws ServletException, IOException {
// TODO: Traversal
return findAllowRobotsRecursive(
servletContext,
request,
response,
page,
new HashMap<>()
);
}
private static boolean findAllowRobotsRecursive(
ServletContext servletContext,
HttpServletRequest request,
HttpServletResponse response,
com.semanticcms.core.model.Page page,
Map finished
) throws ServletException, IOException {
PageRef pageRef = page.getPageRef();
assert !finished.containsKey(pageRef);
// Use directly set allowRobots first
Boolean pageAllowRobots = page.getAllowRobots();
if (pageAllowRobots == null) {
// Use the allowRobots of all parents in the same book
Book book = pageRef.getBook();
for (ParentRef parentRef : page.getParentRefs()) {
PageRef parentPageRef = parentRef.getPageRef();
if (book.equals(parentPageRef.getBook())) {
// Check finished already
Boolean parentAllowRobots = finished.get(parentPageRef);
if (parentAllowRobots == null) {
// Capture parent and find its allowRobots
parentAllowRobots = findAllowRobotsRecursive(
servletContext,
request,
response,
CapturePage.capturePage(servletContext, request, response, parentPageRef, CaptureLevel.PAGE),
finished
);
}
if (pageAllowRobots == null) {
pageAllowRobots = parentAllowRobots;
} else {
// Must precisely match when have multiple parents
if (!pageAllowRobots.equals(parentAllowRobots)) {
throw new ServletException("Mismatched allowRobots inherited from different parents: " + pageAllowRobots + " does not match " + parentAllowRobots);
}
}
}
}
// No parents in the same book, use book allowRobots
if (pageAllowRobots == null) {
pageAllowRobots = book.getAllowRobots();
}
}
// Store in finished
finished.put(pageRef, pageAllowRobots);
return pageAllowRobots;
}
/**
* Filters for all pageRefs that are present (not missing books).
*/
public static Set filterNotMissingBook(Set pageReferrers) {
int size = pageReferrers.size();
if (size == 0) {
return Collections.emptySet();
} else if (size == 1) {
R pageReferrer = pageReferrers.iterator().next();
if (pageReferrer.getPageRef().getBook() != null) {
return Collections.singleton(pageReferrer);
} else {
return Collections.emptySet();
}
} else {
Set notMissingBooks = AoCollections.newLinkedHashSet(size);
for (R pageReferrer : pageReferrers) {
if (pageReferrer.getPageRef().getBook() != null) {
if (!notMissingBooks.add(pageReferrer)) {
throw new AssertionError();
}
}
}
return Collections.unmodifiableSet(notMissingBooks);
}
}
/**
* Determines the short title for a page and one of its parents.
*/
public static String getShortTitle(PageRef parentPageRef, Page page) {
// Check for per-parent shortTitle first for the given parent
if (parentPageRef != null) {
for (ParentRef parentRef : page.getParentRefs()) {
if (parentRef.getPageRef().equals(parentPageRef)) {
String shortTitle = parentRef.getShortTitle();
if (shortTitle != null) {
return shortTitle;
}
break;
}
}
}
// Use the overall page shortTitle
return page.getShortTitle();
}
/**
* Gets all the parents of the given page that are not in missing books
* and are applicable to the given view.
*
* @return The filtered set of parents, in the order declared by the page.
*/
public static Set getApplicableParents(
ServletContext servletContext,
HttpServletRequest request,
HttpServletResponse response,
View view,
Page page
) throws ServletException, IOException {
Collection parents = CapturePage.capturePages(
servletContext,
request,
response,
filterNotMissingBook(page.getParentRefs()),
CaptureLevel.META // TODO: View provide capture level required for isApplicable check, might be PAGE or (null for none) for some views.
).values();
Set applicableParents = AoCollections.newLinkedHashSet(parents.size());
for (Page parent : parents) {
if (view.isApplicable(servletContext, request, response, parent)) {
applicableParents.add(parent);
}
}
return AoCollections.optimalUnmodifiableSet(applicableParents);
}
public static ReadableDateTime toDateTime(Object o) throws IOException {
if (o instanceof ReadableDateTime) {
return (ReadableDateTime) o;
}
if (o instanceof Long) {
long l = (Long) o;
return l == -1 || l == 0 ? null : new DateTime(l);
}
if (Coercion.isEmpty(o)) {
return null;
}
return new DateTime(o);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy