A content section represents a collection of content that is * managed as a unit. Content sections typically correspond to major * branches of the public site map. For example, a general news site * might have content sections for World, National, Regional, Science * and Technology stories. Each content section has its own production * and deployment environment, including the following:
* *It can have its own administration roles, including * managers, producers, editors and designers.
It is associated with one or more specific {@link * com.arsdigita.cms.ContentType content types}. For example, the * "Press" section is associated with Press Releases.
It can have its own default workflows and * lifecycles.
In addition to the content pages themselves, it can have * any number of top-level pages for browsing, searching and any * other desired purpose.
By default, each content section is associated with exactly one * {@link com.arsdigita.kernel.PackageInstance package instance} and * can be mounted at exactly one node in the site map.
* * @author Michael Pih * @author Jack Chung * @author Sören Bernsteincom.arsdigita.cms.dispatcher.TemplateResolver.
*/
public TemplateResolver getTemplateResolver() {
if (m_templateResolver == null) {
try {
Class trc = Class.forName(getTemplateResolverClassName());
m_templateResolver = (TemplateResolver) trc.newInstance();
} catch (ClassNotFoundException cnfe) {
throw new UncheckedWrapperException(cnfe);
} catch (InstantiationException ie) {
throw new UncheckedWrapperException(ie);
} catch (IllegalAccessException iae) {
throw new UncheckedWrapperException(iae);
}
}
return m_templateResolver;
}
/**
* Sets the template resolver for this content section.
*
* @param className The name of a class that implements
* com.arsdigita.cms.dispatcher.TemplateResolver.
**/
public void setTemplateResolverClass(String className) {
set(TEMPLATE_RESOLVER_CLASS, className);
m_templateResolver = null;
}
/**
* Get the class name of the {link @com.arsdigita.cms.dispatcher.XMLGenerator}.
*
* @return The class name
*/
public String getXMLGeneratorClassName() {
String xgc = (String) get(XML_GENERATOR_CLASS);
Assert.exists(xgc, "XML Generator class");
return xgc;
}
/**
* Get the XML generator for this content section. The XML generator is
* used to transform content items into a DOM element.
*
* @return The XML generator
*/
public XMLGenerator getXMLGenerator() {
if (m_xmlGenerator == null) {
try {
Class xgc = Class.forName(getXMLGeneratorClassName());
m_xmlGenerator = (XMLGenerator) xgc.newInstance();
} catch (ClassNotFoundException cnfe) {
throw new UncheckedWrapperException(cnfe);
} catch (InstantiationException ie) {
throw new UncheckedWrapperException(ie);
} catch (IllegalAccessException iae) {
throw new UncheckedWrapperException(iae);
}
}
return m_xmlGenerator;
}
/**
* Set the XML generator for this content section.
*
* @param className The class name
*/
public void setXMLGeneratorClass(String className) {
set(XML_GENERATOR_CLASS, className);
m_xmlGenerator = null;
}
//////////////////////////////
//
// Globalization.
//
/**
* Gets the default Locale. This is used for translating or creating
* content if no locale is specified.
*
* @return The default locale for a content section, possibly null
*/
public Locale getDefaultLocale() {
DataObject obj = (DataObject) get(DEFAULT_LOCALE);
if (obj == null) {
return null;
} else {
return new Locale(obj);
}
}
/**
* Sets the default locale for a content section. Only a locale that is
* registered to this section can be set as the default locale for this
* section. If no locale is passed in, unset the default locale, if it
* exists.
*
* @param locale The locale. If null, unset the default locale.
* @pre ( locale in getLocales() || locale == null )
*/
public void setDefaultLocale(Locale locale) {
setAssociation(DEFAULT_LOCALE, locale);
}
/**
* Returns a collection of Locales associated with this content section.
* Each locale represents options for translating content items in this
* section.
*
* @return A collection of locales registered to this content section
* @post ( return != null )
*/
public SectionLocaleCollection getLocales() {
DataAssociation da = (DataAssociation) get(LOCALES);
return new SectionLocaleCollection(da);
}
/**
* Register a locale with this content section.
*
* @param locale The locale
* @pre ( locale != null )
*/
public void addLocale(Locale locale) {
addLocale(locale, false);
}
/**
* Register a locale with this content section. The locale may be
* set as the default locale for this content section.
*
* @param locale The locale
* @param isDefault A flag, if true, which indicates that this locale
* should be the default locale for this content section.
* @pre ( locale != null )
*/
public void addLocale(Locale locale, boolean isDefault) {
DataAssociation da = (DataAssociation) get(LOCALES);
locale.addToAssociation(da);
if (isDefault) {
setDefaultLocale(locale);
}
}
/**
* Unregister a locale from the content section.
*
* @param locale
* @pre ( locale != null )
*/
public void removeLocale(Locale locale) {
DataAssociation da = (DataAssociation) get(LOCALES);
locale.removeFromAssociation(da);
}
//////////////////////////////
//
// Content types.
//
/**
* Get all user-defined content types registered to the content section.
*
* @return A ContentTypeCollection of registered content types
*/
public ContentTypeCollection getContentTypes() {
return getContentTypes(false);
}
public ContentTypeCollection getContentTypes(boolean hidden) {
DataAssociation da = (DataAssociation) get(CONTENT_TYPES);
ContentTypeCollection types = new ContentTypeCollection(da);
// Filter out internal content types.
types.addFilter("mode != 'I'");
if (!hidden) {
types.addFilter("mode != 'H'");
}
return types;
}
public ContentTypeCollection getDescendantsOfContentType(ContentType ct) {
ContentTypeCollection ctc = getContentTypes();
// The Filter Factory
FilterFactory ff = ctc.getFilterFactory();
// Create an or-filter
CompoundFilter or = ff.or();
// The content type must be either of the requested type
or.addFilter(ff.equals(ContentType.ID, ct.getID()));
// Or must be a descendant of the requested type
try {
StringTokenizer strTok = new StringTokenizer(ct.getDescendants(), "/");
while (strTok.hasMoreElements()) {
or.addFilter(ff.equals(ContentType.ID, (String) strTok.nextElement()));
}
} catch (Exception ex) {
// WTF? The selected content type does not exist in the table???
s_log.error("WTF? The selected content type does not exist in the table???");
}
ctc.addFilter(or);
return ctc;
}
/**
* Get all user-defined content types registered to the content section
* that can be created.
*
* @return A ContentTypeCollection of content types that are
* 1) registered to the content section
* 2) user-defined
* 3) possess a non-empty creation component in its AuthoringKit.
*/
public ContentTypeCollection getCreatableContentTypes() {
return getCreatableContentTypes(false);
}
public ContentTypeCollection getCreatableContentTypes(boolean hidden) {
DataAssociation da = (DataAssociation) get(CREATABLE_CONTENT_TYPES);
ContentTypeCollection types = new ContentTypeCollection(da);
// Filter out internal content types.
types.addFilter("mode != 'I'");
if (!hidden) {
types.addFilter("mode != 'H'");
}
return types;
}
/**
* Register a content type to the content section. If the content type is
* already registered to the content section, nothing is done.
*
* @param type The content type
*/
public void addContentType(ContentType type) {
if (!hasContentType(type)) {
DataAssociation da = (DataAssociation) get(CONTENT_TYPES);
type.addToAssociation(da);
}
}
/**
* Unregister a content type from the content section.
*
* @param type The content type
*/
public void removeContentType(ContentType type) {
DataAssociation da = (DataAssociation) get(CONTENT_TYPES);
type.removeFromAssociation(da);
}
/**
* Return true if the content type is registered with this
* content section.
*
* @param type the type to cjeck for
* @return true if the content type is registered with this
* content section.
*/
private boolean hasContentType(ContentType type) {
DataAssociation da = (DataAssociation) get(CONTENT_TYPES);
DataAssociationCursor cursor = da.cursor();
cursor.addEqualsFilter(ID, type.getID());
return (cursor.size() > 0);
}
/**
* Return the user-defined content types that are not registered to
* this content section.
*
* @return A ContentTypeCollection of content types not registered
* to the content section
*/
public ContentTypeCollection getNotAssociatedContentTypes() {
DataAssociation da = (DataAssociation) get(CONTENT_TYPES_NOT_ASSOC);
ContentTypeCollection types = new ContentTypeCollection(da);
// Filter out internal content types.
types.addFilter("mode != 'I'");
return types;
}
//////////////////////////////
//
// Lifecycle definitions.
//
/**
* Get all lifecycle definitions registered to the content section.
*
* @return a LifecycleDefinitionCollection or registered
* lifecycle definition.
*/
public LifecycleDefinitionCollection getLifecycleDefinitions() {
return new LifecycleDefinitionCollection(getLifecycleDefinitionsAssociation());
}
/**
* Register a lifecycle definition to the content section.
*
* @param definition The lifecycle definition
*/
public void addLifecycleDefinition(LifecycleDefinition definition) {
definition.addToAssociation(getLifecycleDefinitionsAssociation());
}
/**
* Unregister a lifecycle definition from the content section.
*
* @param definition The lifecycle definition
*/
public void removeLifecycleDefinition(LifecycleDefinition definition) {
definition.removeFromAssociation(getLifecycleDefinitionsAssociation());
}
private DataAssociation getLifecycleDefinitionsAssociation() {
return (DataAssociation) get(LIFECYCLE_DEFINITIONS);
}
//////////////////////////////
//
// Workflow templates.
//
/**
* Get all workflow templates registered to the content section.
*
* @return a TaskCollection of workflow templates.
*/
public TaskCollection getWorkflowTemplates() {
TaskCollection tasks = new TaskCollection(getWorkflowTemplatesAssociation());
tasks.addOrder("label asc");
return tasks;
}
/**
* Register a workflow template to the content section.
*
* @param template The workflow template
*/
public void addWorkflowTemplate(WorkflowTemplate template) {
this.addWorkflowTemplate(template, false);
}
public void addWorkflowTemplate(WorkflowTemplate template, boolean isDefault) {
DataObject link = template.addToAssociation(getWorkflowTemplatesAssociation());
link.set("isDefault", isDefault);
}
/**
* Unregister a workflow template from the content section.
*
* @param template The workflow template
*/
public void removeWorkflowTemplate(WorkflowTemplate template) {
template.removeFromAssociation(getWorkflowTemplatesAssociation());
}
/**
* Set a WorkflowTemplate as default for this ContentSection by label
*
* @param wf The label of a workflow template to set as new default workflow template
*/
public void setDefaultWorkflowTemplate(String wf) {
TaskCollection taskColl = getWorkflowTemplates();
while (taskColl.next()) {
if(((WorkflowTemplate) taskColl.getTask()).getLabel().equals(wf)) {
((DataObject) taskColl.get("link")).set("isDefault", true);
} else {
((DataObject) taskColl.get("link")).set("isDefault", false);
}
}
}
/**
* Set a WorkflowTemplate as default for this ContentSection
*
* @param wf The workflow template to set as new default workflow template
*/
public void setDefaultWorkflowTemplate(WorkflowTemplate wf) {
TaskCollection taskColl = getWorkflowTemplates();
while (taskColl.next()) {
if(((WorkflowTemplate) taskColl.getTask()).equals(wf)) {
((DataObject) taskColl.get("link")).set("isDefault", true);
} else {
((DataObject) taskColl.get("link")).set("isDefault", false);
}
}
}
/**
* Get the default workflow template for this content section
*
* @return the default workflow template or null, if this method fails
*/
public WorkflowTemplate getDefaultWorkflowTemplate() {
TaskCollection taskColl = getWorkflowTemplates();
while(taskColl.next()) {
if(((Boolean) taskColl.get("link.isDefault"))) {
WorkflowTemplate wf = (WorkflowTemplate) taskColl.getTask();
taskColl.close();
return wf;
}
}
// If we get here, there is no default workflow template set for this section
// To solve this, we fetch the first item and set it as default
taskColl = getWorkflowTemplates();
while(taskColl.next()) {
WorkflowTemplate wf = (WorkflowTemplate) taskColl.getTask();
((DataObject) taskColl.get("link")).set("isDefault", true);
taskColl.close();
return wf;
}
// OK, now we're screwed
return null;
}
private DataAssociation getWorkflowTemplatesAssociation() {
return (DataAssociation) get(WF_TEMPLATES);
}
//////////////////////////////
//
// Finding a content section.
//
/**
* Looks up the section given the SiteNode.
*
* @param path
* @return The content section
* @pre ( path != null )
* @post ( return != null )
*/
public static ContentSection getSectionForPath(String path)
throws DataObjectNotFoundException {
return (ContentSection) retrieveApplicationForPath(path);
}
/**
* Get the content section for an item.
*
* @pre item != null
* @post return != null
* @param item A content item
* @return The content section of an item
*
* @deprecated use {@link ContentItem#getContentSection} instead
*/
public static ContentSection getContentSection(ContentItem item)
throws DataObjectNotFoundException {
return item.getContentSection();
}
/**
* Get the content section for a folder.
*
* @pre item != null
* @post return != null
* @param folder A content folder
* @return The content section of the folder
* @deprecated use {@link ContentItem#getContentSection} instead
*/
public static ContentSection getContentSection(Folder folder)
throws DataObjectNotFoundException {
return folder.getContentSection();
}
/**
* Retrieve all content sections in the system.
*
* @return A collection of content sections
*/
public static ContentSectionCollection getAllSections() {
DataCollection da = SessionManager.getSession().retrieve(BASE_DATA_OBJECT_TYPE);
return new ContentSectionCollection(da);
}
/**
* Retrieve the default content section in the system.
*
* Default section is the first section created during setup, therefore it
* is recognized as the one with the lowest id.
*
* @return The default content section.
*/
public static ContentSection getDefaultSection() {
ContentSectionCollection sections = getAllSections();
sections.addOrder(ID);
sections.next(); // positions on the first section
ContentSection section = (ContentSection) sections.getDomainObject();
if (sections.isFirst() ) {
sections.close();
s_log.debug("Default section is "+section.getName() );
return section;
} else {
sections.close();
s_log.debug("Section found: "+section.getName()+", but not first." );
return null;
}
}
/**
* Convenience method to retrieve the name of the default content section
* in the system.
*
* Default section is the first section created during setup, therefore it
* is recognized as the one with the lowest id.
*
* @return The default content section name.
*/
public static String getDefaultSectionName() {
return getDefaultSection().getBaseDataObjectType();
}
public static ContentSection create(final String name) {
final Category rootCategory = createRootCategory(name);
return create(name, rootCategory);
}
/**
* Creates a content section of the given name using default values and
* returns it.
*
* @param name Name of the content section
* @param rootCategory
* @return ContentSection
*/
public static ContentSection create(final String name,
final Category rootCategory) {
Folder folder = createRootFolder(name);
//Category category = createRootCategory(name);
Group staff = createStaffGroup(name);
// Some default classes for a content section.
String prc = "com.arsdigita.cms.dispatcher.SimplePageResolver";
String irc = "com.arsdigita.cms.dispatcher.MultilingualItemResolver";
String xgc = "com.arsdigita.cms.dispatcher.SimpleXMLGenerator";
String trc = "com.arsdigita.cms.dispatcher.DefaultTemplateResolver";
ContentSection section = ContentSection.create(name,
folder,
rootCategory,
staff,
prc,
irc,
xgc,
trc);
// Set the default context on the root folder to
// the content section
PermissionService.setContext(folder.getOID(), section.getOID());
createDefaultResources(section);
return section;
}
/**
* Create a new content section. This method is called automatically when a
* CMS package instance is created.
*
* @param name The package instance
* @param folder The root folder
* @param category The root category
* @param staff The staff group
* @param prc The page resolver class name
* @param irc The item resolver class name
* @param xgc The XML generator class name
* @return The new content section
*/
public static ContentSection create(String name,
Folder folder,
Category category,
Group staff,
String prc,
String irc,
String xgc) {
/** Set default as template resolver class name */
String trc = "com.arsdigita.cms.dispatcher.DefaultTemplateResolver";
return ContentSection.create(
name,
folder,
category,
staff,
prc,
irc,
xgc,
trc);
}
/**
* Create a new content section. This method is called automatically when a
* CMS package instance is created.
*
* @param name The package instance
* @param folder The root folder
* @param category The root category
* @param staff The staff group
* @param prc The page resolver class name
* @param irc The item resolver class name
* @param xgc The XML generator class name
* @param trc The template resolver class name
* @return The new content section
*/
public static ContentSection create(String name,
Folder folder,
Category category,
Group staff,
String prc,
String irc,
String xgc,
String trc) {
// This could be moved out of here and into the Installer
// (passing it into a modified version of create)
Group viewers = new Group();
viewers.setName(name + " Viewers");
viewers.save();
// Create template root folder.
Folder templates = new Folder();
templates.setName("templates");
templates.setLabel((String) GlobalizationUtil.globalize(
"cms.templates").localize());
templates.save();
//create and initialize the content section application
ContentSection section = (ContentSection) Application
.createApplication(BASE_DATA_OBJECT_TYPE
, name, name, null);
section.initialize(name,
folder,
category,
staff,
prc,
irc,
xgc,
trc,
templates,
viewers);
return section;
}
/**
* Creates and maps default resources to the content section.
*
* @param section The content section
*
* MP: create resource types.
* MP: use the resources API.
* MP: only create resources once.
*/
protected static void createDefaultResources(ContentSection section) {
// XML resources
ResourceType rt = ResourceType.findResourceType("xml");
Resource r = rt.createInstance("com.arsdigita.cms.ui.ContentSectionPage");
r.save();
ResourceMapping rm = r.createInstance(section, "admin");
rm.save();
rm = r.createInstance(section, "admin/index");
rm.save();
// XXX What's up with this? The class doesn't exist anymore.
//r = rt.createInstance("com.arsdigita.cms.user.ItemIndexPage");
//r.save();
//rm = r.createInstance(section, "index");
//rm.save();
r = rt.createInstance("com.arsdigita.cms.ui.ContentItemPage");
r.save();
rm = r.createInstance(section, "admin/item");
rm.save();
}
/**
* Creates the root folder for a content section.
*
* @param name The name of the content section
* @return The root folder
*/
protected static Folder createRootFolder(String name) {
Folder root = new Folder();
root.setName("/");
root.setLabel((String) GlobalizationUtil.globalize(
"cms.installer.root_folder").localize());
root.save();
return root;
}
/**
* Creates the root category for a content section.
*
* @param name The name of the content section
* @return The root category
*/
protected static Category createRootCategory(String name) {
Category root = new Category("/", "Root Category");
root.save();
return root;
}
/**
* Creates default staff group and associated default roles for a
* content section.
*
* @param name The name of the content section
* @return The staff group
*/
private static Group createStaffGroup(String name) {
Group staff = new Group();
staff.setName(name + " Administration");
staff.save();
return staff;
}
/**
* Initialize a newly created content section.
*
* @param name The package instance name
* @param folder The root folder
* @param category The root category
* @param staff The staff group
* @param prc The page resolver class name
* @param irc The item resolver class name
* @param xgc The XML generator class name
* @param trc The template resolver class name
* @return The new content section
*/
public ContentSection initialize(
String name,
Folder folder,
Category category,
Group staff,
String prc,
String irc,
String xgc,
String trc,
Folder templates,
Group viewers) {
setName(name);
//setPackageInstance(pkg);
setRootFolder(folder);
setRootCategory(category);
setStaffGroup(staff);
setPageResolverClassName(prc);
setItemResolverClass(irc);
setXMLGeneratorClass(xgc);
setTemplateResolverClass(trc);
setTemplatesFolder(templates);
setViewersGroup(viewers);
save();
return this;
}
/**
* Fetches the child items of this section. An item is defined to be "in"
* a content section if it can be found directly in the folder hierarchy
* (site map) of the content section. The returned collection
* provides methods to filter by various criteria, for example by name or
* by whether items are folders or not.
*/
public Folder.ItemCollection getItems() {
DataQuery dq = SessionManager.getSession().retrieveQuery(ITEM_QUERY);
dq.setParameter(SECTION_ID, getID());
return new Folder.ItemCollection(dq);
}
@Override
public String getServletPath() {
return URL.SERVLET_DIR + "/content-section";
}
}