org.opencms.jsp.CmsJspResourceWrapper Maven / Gradle / Ivy
Show all versions of opencms-core Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library 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 library 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.
*
* For further information about Alkacon Software, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.jsp;
import org.opencms.file.CmsFile;
import org.opencms.file.CmsFolder;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsProperty;
import org.opencms.file.CmsPropertyDefinition;
import org.opencms.file.CmsRequestContext;
import org.opencms.file.CmsResource;
import org.opencms.file.CmsResourceFilter;
import org.opencms.file.types.CmsResourceTypeXmlContent;
import org.opencms.file.types.CmsResourceTypeXmlPage;
import org.opencms.i18n.CmsLocaleGroup;
import org.opencms.jsp.util.CmsJspCategoryAccessBean;
import org.opencms.jsp.util.CmsJspContentAccessBean;
import org.opencms.jsp.util.CmsJspImageBean;
import org.opencms.jsp.util.CmsJspValueTransformers.CmsLocalePropertyLoaderTransformer;
import org.opencms.loader.CmsLoaderException;
import org.opencms.main.CmsException;
import org.opencms.main.CmsLog;
import org.opencms.main.OpenCms;
import org.opencms.relations.CmsRelation;
import org.opencms.relations.CmsRelationFilter;
import org.opencms.security.CmsSecurityException;
import org.opencms.util.CmsCollectionsGenericWrapper;
import org.opencms.util.CmsUUID;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.stream.Collectors;
import org.apache.commons.logging.Log;
/**
* Wrapper subclass of CmsResource with some convenience methods.
*/
public class CmsJspResourceWrapper extends CmsResource {
/** Logger instance for this class. */
@SuppressWarnings("unused")
private static final Log LOG = CmsLog.getLog(CmsJspResourceWrapper.class);
/** Serial version id. */
private static final long serialVersionUID = 1L;
/** Parameter value used to select outgoing relations. */
public static final boolean RELATIONS_OUT = true;
/** Parameter value used to select incoming relations. */
public static final boolean RELATIONS_IN = false;
/** All resources that are sources of incoming relations. */
public List m_incomingRelations;
/** All resources that are targets of outgoing relations. */
public List m_outgoingRelations;
/** All parent folder of this resource in the current site as a list. */
public List m_parentFolders;
/** The category access bean for this resource. */
private CmsJspCategoryAccessBean m_categories;
/** The CMS context. */
private CmsObject m_cms;
/** The resource / file content as a String. */
private String m_content;
/** The file object for this resource. */
private CmsFile m_file;
/** Image bean instance created from this resource. */
private CmsJspImageBean m_imageBean;
/** Stores if this resource is an XML content or not. */
private Boolean m_isXml;
/** The set of locale variants. */
private Map m_localeResources;
/** The main locale. */
private Locale m_mainLocale;
/** The navigation builder for this resource. */
private CmsJspNavBuilder m_navBuilder;
/** The navigation info element for this resource. */
private CmsJspNavElement m_navigation;
/** The default file of this resource, assumed that this resource is a folder. */
private CmsJspResourceWrapper m_navigationDefaultFile;
/** The navigation info elements in this resource, assuming that this resource is a folder. */
private List m_navigationForFolder;
/** The parent folder of this resource in the current site. */
private CmsJspResourceWrapper m_parentFolder;
/** Properties of this resource. */
private Map m_properties;
/** Locale properties of this resource. */
private Map> m_propertiesLocale;
/** Locale properties of this resource with search. */
private Map> m_propertiesLocaleSearch;
/** Properties of this resource with search. */
private Map m_propertiesSearch;
/** The calculated site path of the resource. */
private String m_sitePath;
/** The type name of the resource. */
private String m_typeName;
/** The XML content access bean. */
private CmsJspContentAccessBean m_xml;
/**
* Creates a new instance.
*
* @param cms the current CMS context
* @param res the resource to wrap
*/
private CmsJspResourceWrapper(CmsObject cms, CmsResource res) {
super(
res.getStructureId(),
res.getResourceId(),
res.getRootPath(),
res.getTypeId(),
res.isFolder(),
res.getFlags(),
res.getProjectLastModified(),
res.getState(),
res.getDateCreated(),
res.getUserCreated(),
res.getDateLastModified(),
res.getUserLastModified(),
res.getDateReleased(),
res.getDateExpired(),
res.getSiblingCount(),
res.getLength(),
res.getDateContent(),
res.getVersion());
m_cms = cms;
m_file = null;
m_content = "";
}
/**
* Factory method to create a new {@link CmsJspResourceWrapper} instance from a {@link CmsResource}.
*
* In case the parameter resource already is a wrapped resource AND the OpenCms request context is
* the same as the provided context, the parameter object is returned.
*
* @param cms the current CMS context
* @param res the resource to wrap
*
* @return a new instance of a {@link CmsJspResourceWrapper}
*/
public static CmsJspResourceWrapper wrap(CmsObject cms, CmsResource res) {
CmsJspResourceWrapper result = null;
if ((cms != null) && (res != null)) {
if (res instanceof CmsJspResourceWrapper) {
CmsJspResourceWrapper wrapper = (CmsJspResourceWrapper)res;
if (cms.getRequestContext().getSiteRoot().equals(wrapper.getRequestContext().getSiteRoot())) {
result = wrapper;
} else {
result = new CmsJspResourceWrapper(cms, res);
}
} else {
result = new CmsJspResourceWrapper(cms, res);
}
}
return result;
}
/**
* Two resources are considered equal in case their structure id is equal.
*
* @see CmsResource#equals(java.lang.Object)
*/
@Override
public boolean equals(Object obj) {
if (obj == null) {
return false;
}
if (obj == this) {
return true;
}
if (obj instanceof CmsResource) {
return ((CmsResource)obj).getStructureId().equals(getStructureId());
}
return false;
}
/**
* Returns the categories assigned to this resource.
*
* @return the categories assigned to this resource
*/
public CmsJspCategoryAccessBean getCategories() {
if (m_categories == null) {
m_categories = new CmsJspCategoryAccessBean(m_cms, this);
}
return m_categories;
}
/**
* Returns the OpenCms user context this resource was initialized with.
*
* @return the OpenCms user context this resource was initialized with
*/
public CmsObject getCmsObject() {
return m_cms;
}
/**
* Returns the content of the file as a String.
*
* @return the content of the file as a String
*/
public String getContent() {
if ((m_content.length() == 0) && (getFile() != null)) {
m_content = new String(getFile().getContents());
}
return m_content;
}
/**
* Returns this resources name extension (if present).
*
* The extension will always be lower case.
*
* @return the extension or null if not available
*
* @see CmsResource#getExtension(String)
* @see org.opencms.jsp.util.CmsJspVfsAccessBean#getResourceExtension(Object)
*/
public String getExtension() {
return getExtension(getRootPath());
}
/**
* Returns the full file object for this resource.
*
* @return the full file object for this resource
*/
public CmsFile getFile() {
if ((m_file == null) && !isFolder()) {
try {
m_file = m_cms.readFile(this);
} catch (CmsException e) {
// this should not happen since we are updating from a resource object
}
}
return m_file;
}
/**
* Returns the folder of this resource.
*
* In case this resource already is a {@link CmsFolder}, it is returned without modification.
* In case it is a {@link CmsFile}, the parent folder of the file is returned.
*
* @return the folder of this resource
*
* @see #getSitePathFolder()
*/
public CmsJspResourceWrapper getFolder() {
CmsJspResourceWrapper result;
if (isFolder()) {
result = this;
} else {
result = readResource(getSitePathFolder());
}
return result;
}
/**
* Gets a list of resource wrappers for resources with relations pointing to this resource.
*
* @return the list of resource wrappers
*/
public List getIncomingRelations() {
if (m_incomingRelations == null) {
m_incomingRelations = getRelatedResources(RELATIONS_IN);
}
return m_incomingRelations;
}
/**
* Gets a list of resource wrappers for resources with relations pointing to this resource, for a specific type.
*
* @param typeName name of the type to filter
* @return the list of resource wrappers
*/
public List getIncomingRelations(String typeName) {
return getIncomingRelations().stream().filter(res -> res.getTypeName().equals(typeName)).collect(
Collectors.toList());
}
/**
* Returns true in case this resource is an image in the VFS.
*
* @return true in case this resource is an image in the VFS
*/
public boolean getIsImage() {
return getToImage().isImage();
}
/**
* Returns true in case this resource is an XML content.
*
* @return true in case this resource is an XML content
*/
public boolean getIsXml() {
if (m_isXml == null) {
m_isXml = Boolean.valueOf(
CmsResourceTypeXmlPage.isXmlPage(this) || CmsResourceTypeXmlContent.isXmlContent(this));
}
return m_isXml.booleanValue();
}
/**
* Returns a substituted link to this resource.
*
* @return the link
*/
public String getLink() {
return OpenCms.getLinkManager().substituteLinkForUnknownTarget(
m_cms,
m_cms.getRequestContext().getSitePath(this));
}
/**
* Returns a map of the locale group for the current resource, with locale strings as keys.
*
* @return a map with locale strings as keys and resource wrappers for the corresponding locale variants
*/
public Map getLocaleResource() {
if (m_localeResources != null) {
return m_localeResources;
}
try {
CmsLocaleGroup localeGroup = m_cms.getLocaleGroupService().readLocaleGroup(this);
Map resourcesByLocale = localeGroup.getResourcesByLocale();
Map result = new HashMap<>();
for (Map.Entry entry : resourcesByLocale.entrySet()) {
result.put(entry.getKey().toString(), CmsJspResourceWrapper.wrap(m_cms, entry.getValue()));
}
m_localeResources = result;
return result;
} catch (CmsException e) {
return new HashMap();
}
}
/**
* Returns the main locale for this resource.
*
* @return the main locale for this resource
*/
public Locale getMainLocale() {
if (m_mainLocale != null) {
return m_mainLocale;
}
try {
CmsLocaleGroup localeGroup = m_cms.getLocaleGroupService().readLocaleGroup(this);
m_mainLocale = localeGroup.getMainLocale();
return m_mainLocale;
} catch (CmsException e) {
return null;
}
}
/**
* Returns the mime type for this resource.
*
* In case no valid mime type can be determined from the file extension, text/plain is returned.
*
* @return the mime type for this resource
*/
public String getMimeType() {
return OpenCms.getResourceManager().getMimeType(getRootPath(), null, "text/plain");
}
/**
* Returns the navigation builder for this resource.
*
* This will be initialized with this resource as default URI.
*
* @return the navigation builder for this resource
*/
public CmsJspNavBuilder getNavBuilder() {
if (m_navBuilder == null) {
m_navBuilder = new CmsJspNavBuilder();
m_navBuilder.init(m_cms, null, getSitePath());
}
return m_navBuilder;
}
/**
* Returns the navigation info element for this resource.
*
* @return the navigation info element for this resource
*/
public CmsJspNavElement getNavigation() {
if (m_navigation == null) {
m_navigation = getNavBuilder().getNavigationForResource();
}
return m_navigation;
}
/**
* Returns the default resource for this resource.
*
* If this resource is a file, then this file is returned.
*
* Otherwise, in case this resource is a folder:
*
* - the {@link CmsPropertyDefinition#PROPERTY_DEFAULT_FILE} is checked, and
*
- if still no file could be found, the configured default files in the
*
opencms-vfs.xml configuration are iterated until a match is
* found, and
* - if still no file could be found,
null is returned
*
*
* @return the default file for the given folder
*
* @see CmsObject#readDefaultFile(CmsResource, CmsResourceFilter)
*/
public CmsJspResourceWrapper getNavigationDefaultFile() {
if (m_navigationDefaultFile == null) {
if (isFolder()) {
try {
m_navigationDefaultFile = wrap(m_cms, m_cms.readDefaultFile(this, CmsResourceFilter.DEFAULT));
} catch (CmsSecurityException e) {
if (LOG.isDebugEnabled()) {
LOG.debug(e.getMessage(), e);
}
}
}
} else {
m_navigationDefaultFile = this;
}
return m_navigationDefaultFile;
}
/**
* Returns the navigation info elements in this resource, assuming that this resource is a folder.
*
* @return the navigation info elements in this resource, assuming that this resource is a folder
*/
public List getNavigationForFolder() {
if (m_navigationForFolder == null) {
m_navigationForFolder = getNavBuilder().getNavigationForFolder();
}
return m_navigationForFolder;
}
/**
* Returns the substituted online link to this resource.
*
* @return the link
*/
public String getOnlineLink() {
return OpenCms.getLinkManager().getOnlineLink(m_cms, m_cms.getRequestContext().getSitePath(this));
}
/**
* Gets a list of resources with relations pointing to them from this resources, as resource wrappers.
*
* @return the list of resource wrappers
*/
public List getOutgoingRelations() {
if (m_outgoingRelations == null) {
m_outgoingRelations = getRelatedResources(RELATIONS_OUT);
}
return m_outgoingRelations;
}
/**
* Gets a list of resources with relations pointing to them from this resources, as resource wrappers.
*
* Only gets resources with the given type.
*
* @param typeName the name of the type to filter
* @return the list of resource wrappers
*/
public List getOutgoingRelations(String typeName) {
return getOutgoingRelations().stream().filter(res -> res.getTypeName().equals(typeName)).collect(
Collectors.toList());
}
/**
* Returns the parent folder of this resource in the current site.
*
* The parent folder of a file is the folder of the file.
* The parent folder of a folder is the parent folder of the folder.
* The parent folder of the root folder is null.
*
* @return the parent folder of this resource in the current site
*
* @see #getSitePathParentFolder()
* @see CmsResource#getParentFolder(String)
* @see org.opencms.jsp.util.CmsJspVfsAccessBean#getParentFolder(Object)
*/
public CmsJspResourceWrapper getParentFolder() {
if (m_parentFolder == null) {
String parentFolder = getSitePathParentFolder();
if (parentFolder != null) {
m_parentFolder = readResource(getSitePathParentFolder());
}
}
return m_parentFolder;
}
/**
* Returns all parent folder of this resource in the current site as a list.
*
* First resource in the list will be the direct parent folder of this resource,
* the last element will be the site root folder.
*
* @return all parent folder of this resource in the current site as a list
*/
public List getParentFolders() {
if (m_parentFolders == null) {
m_parentFolders = new ArrayList();
CmsJspResourceWrapper parentFolder = getParentFolder();
while (parentFolder != null) {
m_parentFolders.add(parentFolder);
parentFolder = parentFolder.getParentFolder();
}
}
return m_parentFolders;
}
/**
* Returns the direct properties of this resource in a map.
*
* This is without "search", so it will not include inherited properties from the parent folders.
*
* @return the direct properties of this resource in a map
*/
public Map getProperty() {
if (m_properties == null) {
try {
List properties = m_cms.readPropertyObjects(this, false);
m_properties = CmsProperty.toMap(properties);
} catch (CmsException e) {
if (LOG.isDebugEnabled()) {
LOG.debug(e.getMessage(), e);
}
}
}
return m_properties;
}
/**
* Returns the direct properties of this resource in a map for a given locale.
*
* This is without "search", so it will not include inherited properties from the parent folders.
*
* @return the direct properties of this resource in a map for a given locale
*/
public Map> getPropertyLocale() {
if (m_propertiesLocale == null) {
m_propertiesLocale = CmsCollectionsGenericWrapper.createLazyMap(
new CmsLocalePropertyLoaderTransformer(getCmsObject(), this, false));
// result may still be null
return (m_propertiesLocale == null) ? Collections.EMPTY_MAP : m_propertiesLocale;
}
return m_propertiesLocale;
}
/**
* Returns the searched properties of this resource in a map for a given locale.
*
* This is with "search", so it will include inherited properties from the parent folders.
*
* @return the direct properties of this resource in a map for a given locale
*/
public Map> getPropertyLocaleSearch() {
if (m_propertiesLocaleSearch == null) {
m_propertiesLocaleSearch = CmsCollectionsGenericWrapper.createLazyMap(
new CmsLocalePropertyLoaderTransformer(getCmsObject(), this, true));
// result may still be null
return (m_propertiesLocaleSearch == null) ? Collections.EMPTY_MAP : m_propertiesLocaleSearch;
}
return m_propertiesLocaleSearch;
}
/**
* Returns the searched properties of this resource in a map.
*
* This is with "search", so it will include inherited properties from the parent folders.
*
* @return the direct properties of this resource in a map
*/
public Map getPropertySearch() {
if (m_propertiesSearch == null) {
try {
List properties = m_cms.readPropertyObjects(this, true);
m_propertiesSearch = CmsProperty.toMap(properties);
} catch (CmsException e) {
if (LOG.isDebugEnabled()) {
LOG.debug(e.getMessage(), e);
}
}
}
return m_propertiesSearch;
}
/**
* Returns the OpenCms user request context this resource was initialized with.
*
* @return the OpenCms user request context this resource was initialized with
*/
public CmsRequestContext getRequestContext() {
return m_cms.getRequestContext();
}
/**
* Returns this resources name extension (if present).
*
* The extension will always be lower case.
*
* @return the extension or null if not available
*
* @see CmsResource#getExtension(String)
* @see org.opencms.jsp.util.CmsJspVfsAccessBean#getResourceExtension(Object)
*/
public String getResourceExtension() {
return getExtension();
}
/**
* Returns the name of this resource without the path information.
*
* The resource name of a file is the name of the file.
* The resource name of a folder is the folder name with trailing "/".
* The resource name of the root folder is /.
*
* @return the name of this resource without the path information
*
* @see CmsResource#getName()
* @see org.opencms.jsp.util.CmsJspVfsAccessBean#getResourceName(Object)
*/
public String getResourceName() {
return getName();
}
/**
* Returns the folder name of this resource from the root site.
*
* In case this resource already is a {@link CmsFolder}, the folder path is returned without modification.
* In case it is a {@link CmsFile}, the parent folder name of the file is returned.
*
* @return the folder name of this resource from the root site
*/
public String getRootPathFolder() {
String result;
if (isFile()) {
result = getRootPathParentFolder();
} else {
result = getRootPath();
}
return result;
}
/**
* Returns the directory level of a resource from the root site.
*
* The root folder "/" has level 0,
* a folder "/foo/" would have level 1,
* a folder "/foo/bar/" level 2 etc.
*
* @return the directory level of a resource from the root site
*
* @see CmsResource#getPathLevel(String)
*/
public int getRootPathLevel() {
return getPathLevel(getRootPath());
}
/**
* Returns the parent folder of this resource from the root site.
*
* @return the parent folder of this resource from the root site
*
* @see CmsResource#getParentFolder(String)
*/
public String getRootPathParentFolder() {
return getParentFolder(getRootPath());
}
/**
* Returns the current site path to this resource.
*
* @return the current site path to this resource
*
* @see org.opencms.file.CmsRequestContext#getSitePath(CmsResource)
*/
public String getSitePath() {
if (m_sitePath == null) {
m_sitePath = m_cms.getRequestContext().getSitePath(this);
}
return m_sitePath;
}
/**
* Returns the folder name of this resource in the current site.
*
* In case this resource already is a {@link CmsFolder}, the folder path is returned without modification.
* In case it is a {@link CmsFile}, the parent folder name of the file is returned.
*
* @return the folder name of this resource in the current site
*/
public String getSitePathFolder() {
String result;
if (isFile()) {
result = getSitePathParentFolder();
} else {
result = getSitePath();
}
return result;
}
/**
* Returns the directory level of a resource in the current site.
*
* The root folder "/" has level 0,
* a folder "/foo/" would have level 1,
* a folder "/foo/bar/" level 2 etc.
*
* @return the directory level of a resource in the current site
*
* @see CmsResource#getPathLevel(String)
* @see org.opencms.jsp.util.CmsJspVfsAccessBean#getPathLevel(Object)
*/
public int getSitePathLevel() {
return getPathLevel(getSitePath());
}
/**
* Returns the parent folder of this resource in the current site.
*
* The parent folder of a file is the folder of the file.
* The parent folder of a folder is the parent folder of the folder.
* The parent folder of the root folder is null.
*
* @return the parent folder of this resource in the current site
*
* @see CmsResource#getParentFolder(String)
* @see org.opencms.jsp.util.CmsJspVfsAccessBean#getParentFolder(Object)
*/
public String getSitePathParentFolder() {
return getParentFolder(getSitePath());
}
/**
* Returns a scaled image bean from the wrapped value.
*
* In case the value does not point to an image resource, null is returned.
*
* @return the scaled image bean
*/
public CmsJspImageBean getToImage() {
if (m_imageBean == null) {
m_imageBean = new CmsJspImageBean(getCmsObject(), this, null);
}
return m_imageBean;
}
/**
* Returns this resource wrapper.
*
* This is included because in case {@link org.opencms.jsp.util.CmsJspStandardContextBean#getWrap()} is used, the result may be
* either a {@link org.opencms.jsp.util.CmsJspObjectValueWrapper} or a {@link CmsJspResourceWrapper}.
* Using {@link #getToResource()} on the result will always return a resource wrapper this way.
*
* @return this resource wrapper
*
* @see org.opencms.jsp.util.CmsJspStandardContextBean#getWrap()
* @see org.opencms.jsp.util.CmsJspObjectValueWrapper#getToResource()
*/
public CmsJspResourceWrapper getToResource() {
return this;
}
/**
* Returns an XML content access bean created for this resource.
*
* In case this resource is not an XML content, null is returned.
*
* @return an XML content access bean created for this resource
*
* @see #getIsXml()
*/
public CmsJspContentAccessBean getToXml() {
if ((m_xml == null) && getIsXml()) {
m_xml = new CmsJspContentAccessBean(m_cms, this);
}
return m_xml;
}
/**
* Returns the resource type name.
*
* @return the resource type name
*/
public String getTypeName() {
if (m_typeName == null) {
try {
m_typeName = OpenCms.getResourceManager().getResourceType(getTypeId()).getTypeName();
} catch (CmsLoaderException e) {
// this should never happen, and anyway it is logged in the resource manage already
}
}
return m_typeName;
}
/**
* Returns an XML content access bean created for this resource.
*
* In case this resource is not an XML content, null is returned.
*
* @return an XML content access bean created for this resource
*
* @see #getToXml()
* @see #getIsXml()
*/
public CmsJspContentAccessBean getXml() {
return getToXml();
}
/**
* @see CmsResource#hashCode()
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
if (getStructureId() != null) {
return getStructureId().hashCode();
}
return CmsUUID.getNullUUID().hashCode();
}
/**
* Returns true in case this resource is child resource of the provided resource which is assumed to be a folder.
*
* @param resource the resource to check
*
* @return true in case this resource is child resource of the provided resource which is assumed to be a folder
*/
public boolean isChildResourceOf(CmsResource resource) {
return (resource != null)
&& resource.isFolder()
&& !(getStructureId().equals(resource.getStructureId()))
&& ((getRootPath().indexOf(resource.getRootPath()) == 0));
}
/**
* Returns true in case this resource is child resource of the provided resource path which is assumed to be a folder in the current site.
*
* No check is performed to see if the provided site path resource actually exists.
*
* @param sitePath the resource to check
*
* @return true in case this resource is child resource of the provided resource path which is assumed to be a folder in the current site
*/
public boolean isChildResourceOf(String sitePath) {
return (sitePath != null)
&& ((getSitePath().indexOf(sitePath) == 0))
&& (sitePath.length() < getSitePath().length());
}
/**
* Returns true in case this resource is a parent folder of the provided resource.
*
* @param resource the resource to check
*
* @return true in case this resource is a parent folder of the provided resource
*/
public boolean isParentFolderOf(CmsResource resource) {
return (resource != null)
&& isFolder()
&& !(getStructureId().equals(resource.getStructureId()))
&& ((resource.getRootPath().indexOf(getRootPath()) == 0));
}
/**
* Returns true in case this resource is a parent folder of the provided resource path in the current site.
*
* No check is performed to see if the provided site path resource actually exists.
*
* @param sitePath the path to check
*
* @return true in case this resource is a parent folder of the provided resource path in the current site
*/
public boolean isParentFolderOf(String sitePath) {
return (sitePath != null)
&& isFolder()
&& ((sitePath.indexOf(getSitePath()) == 0))
&& (sitePath.length() > getSitePath().length());
}
/**
* Helper method for getting the related resources for this resource, with a given resource filter.
*
* @param out - true for outgoing relations, false for incoming relations
* @return the list of related resources
*/
private List getRelatedResources(boolean out) {
CmsObject cms = getCmsObject();
List result = new ArrayList<>();
try {
CmsRelationFilter filter = out
? CmsRelationFilter.relationsFromStructureId(getStructureId())
: CmsRelationFilter.relationsToStructureId(getStructureId());
List relations = cms.readRelations(filter);
for (CmsRelation rel : relations) {
try {
CmsResource other = out
? rel.getTarget(cms, CmsResourceFilter.DEFAULT)
: rel.getSource(cms, CmsResourceFilter.DEFAULT);
result.add(wrap(cms, other));
} catch (CmsException e) {
LOG.warn(e.getLocalizedMessage(), e);
}
}
} catch (Exception e) {
LOG.error(e.getLocalizedMessage(), e);
}
return result;
}
/**
* Reads a resource, suppressing possible exceptions.
*
* @param sitePath the site path of the resource to read.
*
* @return the resource of null on case an exception occurred while reading
*/
private CmsJspResourceWrapper readResource(String sitePath) {
CmsJspResourceWrapper result = null;
try {
result = new CmsJspResourceWrapper(m_cms, m_cms.readResource(sitePath));
} catch (CmsException e) {
if (LOG.isDebugEnabled()) {
LOG.debug(e.getMessage(), e);
}
}
return result;
}
}