org.ametys.web.repository.page

Class PageDAO

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.web.repository.page.PageDAO

All Implemented Interfaces:

Component, LogEnabled, Serviceable

public class PageDAO
extends AbstractLogEnabled
implements Serviceable, Component

DAO for manipulating pages

Field Summary

Fields

Modifier and Type	Field and Description
static String	__SERVICE_PARAM_UNTOUCHED_BINARY Constant for untouched binary metadata.
private WebContentDAO	_contentDAO
private ContentTypeExtensionPoint	_contentTypeExtensionPoint
private CopySiteComponent	_copySiteComponent
private ContentTypesAssignmentHandler	_cTypeHandler
private CurrentUserProvider	_currentUserProvider
private JSONUtils	_jsonUtils
private ObservationManager	_observationManager
private AmetysObjectResolver	_resolver
private RightManager	_rightManager
private ServiceExtensionPoint	_serviceExtensionPoint
private ServicesAssignmentHandler	_serviceHandler
private SharedContentManager	_sharedContentManager
private SkinsManager	_skinsManager
private TagProviderExtensionPoint	_tagProvider
private TemplatesAssignmentHandler	_templatesHandler
private WebLanguagesManager	_webLanguagesManager
private WorkflowProvider	_workflowProvider
static String	ROLE Avalon Role

Constructor Summary

Constructors

Constructor and Description
PageDAO()

Method Summary

Modifier and Type	Method and Description
private boolean	_canCreate(PagesContainer parentPage)
private boolean	_canDelete(Page page)
private Map<String,Object>	_content2Json(Content content, Locale locale)
private Page	_createPage(PagesContainer parent, String pageTitle, String template)
private void	_getAndSaveParameter(String prefix, ServiceParameter param, Map<String,Object> formValues, ModifiableCompositeMetadata metadataHolder, Map<String,Errors> allErrors)
private void	_getAndSaveRepeater(String prefix, ServiceParameterRepeater repeater, Map<String,Object> formValues, ModifiableCompositeMetadata metadataHolder, Map<String,Errors> allErrors)
private List<String>	_getChildrenPageIds(Page page)
private AmetysObjectIterable<Content>	_getIncomingContentReferences(String pageId)
private AmetysObjectIterable<Page>	_getIncomingPageReferences(String pageId)
private void	_getRepeaters(Map<String,ServiceParameterOrRepeater> parameters, CompositeMetadata metaHolder, List<Map<String,Object>> repeaters, String prefix)
private void	_getValues(CompositeMetadata metaHolder, ServiceParameterOrRepeater param, Map<String,Object> values, String prefix)
private boolean	_hasRight(ContentType contentType, Page page)
private boolean	_hasRight(Service service, Page page)
private boolean	_isLocked(Content content)
private boolean	_isNew(Content content)
private boolean	_isReferenced(Content content)
boolean	_isTagValid(Page page, String tagName) Test if a tag is valid for a specific page
private Map<String,Object>	_page2Json(Page page)
private String[]	_parseValue(Object value)
private Map<String,Object>	_publication2Json(Page page)
private void	_removeOldZones(ModifiablePage page, String templateName)
private void	_setParameterValues(ModifiableCompositeMetadata serviceMetadata, Service service, Map<String,Object> values, Map<String,Errors> allErrors)
private void	_updateContentsAfterCopy(Page createdPage)
private Map<String,Object>	_zone2json(Zone zone)
private Map<String,Object>	_zoneitem2json(ZoneItem zoneItem)
Map<String,Object>	configureService(String serviceId, String zoneItemId, Map<String,Object> parameters) Configure service
Map<String,Object>	copyPage(String id, String target, boolean keepReferences) Copy a page
Map<String,Object>	createPage(String parentId, String title, String longTitle) Create a new page
Map<String,Object>	deletePage(ModifiablePage page, boolean deleteBelongingContents) Delete a page and its sub-pages.
Map<String,Object>	deletePage(String pageId, boolean deleteBelongingContents) Delete a page and its sub-pages.
Map<String,Object>	getAttachmentsRootNode(String id) Returns the page's attachments root node
List<Map<String,Object>>	getAvailableContentTypes(String pageId, String zoneName) Get available content types for specified page
List<Map<String,Object>>	getAvailableContentTypesForCreation(String pageId, String zoneName, String parentId, String pageTitle, String template) Get available content types for a page being created
List<Map<String,Object>>	getAvailableServices(String pageId, String zoneName) Get available services for specified page
List<Map<String,Object>>	getAvailableServicesForCreation(String pageId, String zoneName, String parentId, String pageTitle, String template) Get available services for a page being created
List<Map<String,Object>>	getAvailableTemplates(List<String> pageIds) Get available template for specified pages
List<Map<String,Object>>	getAvailableTemplates(String pageId) Get available template for specified page
List<Map<String,Object>>	getAvailableTemplatesForCreation(String pageId, String parentId, String pageTitle) Get available content types for a page being created
List<String>	getDeleteablePageContentIds(String pageId, boolean onlyNewlyCreatedContents) Get the contents that belong to the Page and its sub-pages and that can be deleted.
Map<String,Object>	getDeleteablePageContents(String id) Get the contents of a Page and its subpages which can be deleted.
List<Content>	getPageContents(Page page) Get the contents of a page and its child pages
List<Content>	getPageContents(Page page, boolean ignoreContentsOfNonRemovablePage) Get the contents of a page and its child pages
Map<String,Object>	getPageInfos(Page page) Get the page's properties
Map<String,Object>	getPageInfos(String pageId) Get the page's properties
Map<String,Object>	getPageParents(String id) Returns the page's parents ids
Map<String,Object>	getPageProperties(String pageId) Get the page's properties
Map<String,Object>	getPagesInfos(List<String> pageIds) Get the properties of given pages
Map<String,Object>	getServiceInfo(String pageId, String serviceId) Get service info
Map<String,Object>	getServiceParameters(String zoneItemId, String serviceId) Get the service parameters values
String	getServiceParametersAction(String serviceId) Get the script class name to execute to add or update this service
Set<String>	getTags(List<String> pageIds) Get the tags from the pages
List<Map<String,Object>>	getUnreferencedContents(String id) Get the unreferenced contents of a Page or a ZoneItem
protected Set<String>	getUserRights(PagesContainer pagesCt) Get the user rights on page container (page or sitemap)
boolean	hasRight(String id, String rightId) Check current user right on given page or sitemap
Map<String,Object>	movePage(String id, String parentId, int index) Move a page
Map<String,String>	pastePage(String targetId, String sourceId, boolean keepReferences) Copy a page under another page
Map<String,Object>	renamePage(String pageId, String title, String longTitle, boolean updatePath, boolean createAlias) Rename a page
void	service(ServiceManager smanager)
Map<String,Object>	setBlank(List<String> pageIds) Set pages as blank page
Map<String,Object>	setLink(List<String> pageIds, String url, String urlType) Set pages as redirection
Map<String,Object>	setService(String pageId, String serviceId, String zoneName, Map<String,Object> parameters) Set service
Map<String,Object>	setTemplate(List<String> pageIds, String templateName) Set a template to pages
Map<String,Object>	setVisibility(List<String> pageIds, boolean visible) Set the visible of pages
Map<String,Object>	tag(List<String> pageIds, List<String> contentIds, List<String> tagNames, Map<String,Object> contextualParameters) Tag a list of contents with the given tags
Map<String,Object>	tag(List<String> pageIds, List<String> contentIds, List<String> tagNames, String mode, Map<String,Object> contextualParameters) Tag a list of contents and/org pages
Map<String,Object>	tag(List<String> pageIds, List<String> tagNames, String mode, Map<String,Object> contextualParameters) Tag a list of pages

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

__SERVICE_PARAM_UNTOUCHED_BINARY

public static final String __SERVICE_PARAM_UNTOUCHED_BINARY

Constant for untouched binary metadata.

See Also:

Constant Field Values

ROLE

public static final String ROLE

Avalon Role

_resolver

private AmetysObjectResolver _resolver

_observationManager

private ObservationManager _observationManager

_currentUserProvider

private CurrentUserProvider _currentUserProvider

_skinsManager

private SkinsManager _skinsManager

_templatesHandler

private TemplatesAssignmentHandler _templatesHandler

_serviceHandler

private ServicesAssignmentHandler _serviceHandler

_cTypeHandler

private ContentTypesAssignmentHandler _cTypeHandler

_contentTypeExtensionPoint

private ContentTypeExtensionPoint _contentTypeExtensionPoint

_serviceExtensionPoint

private ServiceExtensionPoint _serviceExtensionPoint

_workflowProvider

private WorkflowProvider _workflowProvider

_sharedContentManager

private SharedContentManager _sharedContentManager

_tagProvider

private TagProviderExtensionPoint _tagProvider

_webLanguagesManager

private WebLanguagesManager _webLanguagesManager

_contentDAO

private WebContentDAO _contentDAO

_copySiteComponent

private CopySiteComponent _copySiteComponent

_rightManager

private RightManager _rightManager

_jsonUtils

private JSONUtils _jsonUtils

Constructor Detail

PageDAO

public PageDAO()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getPagesInfos

public Map<String,Object> getPagesInfos(List<String> pageIds)

Get the properties of given pages

Parameters:

pageIds - the id of pages

Returns:

the properties of pages in a result map

getPageInfos

public Map<String,Object> getPageInfos(String pageId)

Get the page's properties

Parameters:

pageId - the page ID

Returns:

the properties

getPageInfos

public Map<String,Object> getPageInfos(Page page)

Get the page's properties

Parameters:

page - the page

Returns:

the properties

getPageProperties

public Map<String,Object> getPageProperties(String pageId)

Get the page's properties

Parameters:

pageId - the id of page

Returns:

the properties

hasRight

public boolean hasRight(String id,
                        String rightId)

Check current user right on given page or sitemap

Parameters:

id - The id of the page or sitemap

rightId - The if of right to check

Returns:

true if user has right

createPage

public Map<String,Object> createPage(String parentId,
                                     String title,
                                     String longTitle)

Create a new page

Parameters:

parentId - The parent id. Can not be null.

title - The page's title. Can not be null.

longTitle - The page's long title. Can be null or blank.

Returns:

The result map with id of created page

copyPage

public Map<String,Object> copyPage(String id,
                                   String target,
                                   boolean keepReferences)
                            throws RepositoryException

Copy a page

Parameters:

id - The id of page to copy

target - The id of parent target page

keepReferences - true to keep references

Returns:

the result map

Throws:

RepositoryException - if an error occurred during copy

pastePage

public Map<String,String> pastePage(String targetId,
                                    String sourceId,
                                    boolean keepReferences)
                             throws RepositoryException

Copy a page under another page

Parameters:

targetId - the page to copy in

sourceId - the page to copy

keepReferences - true to keep references for contents, or false to duplicate contents

Returns:

The id of created page is a result map.

Throws:

RepositoryException - if an error occurs

movePage

public Map<String,Object> movePage(String id,
                                   String parentId,
                                   int index)

Move a page

Parameters:

id - The page id

parentId - The id of parent destination

index - The position in parent child nodes where page will be inserted. -1 means as the last child.

Returns:

the result map

_canCreate

private boolean _canCreate(PagesContainer parentPage)

_canDelete

private boolean _canDelete(Page page)

setLink

public Map<String,Object> setLink(List<String> pageIds,
                                  String url,
                                  String urlType)

Set pages as redirection

Parameters:

pageIds - the id of pages to modify

url - the url of redirection

urlType - the type of redirection

Returns:

the id of pages which succeeded or failed.

getAvailableTemplates

public List<Map<String,Object>> getAvailableTemplates(String pageId)

Get available template for specified page

Parameters:

pageId - The page's id

Returns:

the list of available template

getAvailableContentTypes

public List<Map<String,Object>> getAvailableContentTypes(String pageId,
                                                         String zoneName)

Get available content types for specified page

Parameters:

pageId - The page's id

zoneName - the name of the zone

Returns:

the list of available content types

getAvailableContentTypesForCreation

public List<Map<String,Object>> getAvailableContentTypesForCreation(String pageId,
                                                                    String zoneName,
                                                                    String parentId,
                                                                    String pageTitle,
                                                                    String template)

Get available content types for a page being created

Parameters:

pageId - The page's id. Can be null of the page is not yet created

zoneName - the name of the zone

parentId - The id of parent page

pageTitle - The title of page to create

template - The template of page to create

Returns:

the list of available services

_hasRight

private boolean _hasRight(ContentType contentType,
                          Page page)

getAvailableServices

public List<Map<String,Object>> getAvailableServices(String pageId,
                                                     String zoneName)

Get available services for specified page

Parameters:

pageId - The page's id

zoneName - the name of the zone

Returns:

the list of available services

getAvailableServicesForCreation

public List<Map<String,Object>> getAvailableServicesForCreation(String pageId,
                                                                String zoneName,
                                                                String parentId,
                                                                String pageTitle,
                                                                String template)

Get available services for a page being created

Parameters:

pageId - The page's id. Can be null of the page is not yet created

zoneName - the name of the zone

parentId - The id of parent page

pageTitle - The title of page to create

template - The template of page to create

Returns:

the list of available services

_createPage

private Page _createPage(PagesContainer parent,
                         String pageTitle,
                         String template)

_hasRight

private boolean _hasRight(Service service,
                          Page page)

getAvailableTemplates

public List<Map<String,Object>> getAvailableTemplates(List<String> pageIds)

Get available template for specified pages

Parameters:

pageIds - The id of pages

Returns:

the list of available template

getAvailableTemplatesForCreation

public List<Map<String,Object>> getAvailableTemplatesForCreation(String pageId,
                                                                 String parentId,
                                                                 String pageTitle)

Get available content types for a page being created

Parameters:

pageId - The page's id. Can be null of the page is not yet created

parentId - The id of parent page

pageTitle - The title of page to create

Returns:

the list of available services

getServiceInfo

public Map<String,Object> getServiceInfo(String pageId,
                                         String serviceId)

Get service info

Parameters:

pageId - Optional, the page id of the service. To get some basic info about the page.

serviceId - The id of the service

Returns:

a Map containing some info about the service (label, url..)

renamePage

public Map<String,Object> renamePage(String pageId,
                                     String title,
                                     String longTitle,
                                     boolean updatePath,
                                     boolean createAlias)

Rename a page

Parameters:

pageId - The id of page to rename

title - The page's title

longTitle - The page's long title.

updatePath - true to update page's path

createAlias - true to create a alias

Returns:

the result map

deletePage

public Map<String,Object> deletePage(String pageId,
                                     boolean deleteBelongingContents)

Delete a page and its sub-pages. The contents that belong only to the deleted page will be deleted if 'deleteBelongingContents' is set to true. The newly created contents are deleted whatever the value if 'deleteBelongingContents'.

Parameters:

pageId - the id of page to delete

deleteBelongingContents - true to delete the contents that belong to the page and its sub-pages only

Returns:

The id of deleted pages

deletePage

public Map<String,Object> deletePage(ModifiablePage page,
                                     boolean deleteBelongingContents)

Delete a page and its sub-pages. The contents that belong only to the deleted page will be deleted if 'deleteBelongingContents' is set to true. The newly created contents are deleted whatever the value if 'deleteBelongingContents'.

Parameters:

page - the page to delete

deleteBelongingContents - true to delete the contents that belong to the page and its sub-pages only

Returns:

The id of deleted pages

setBlank

public Map<String,Object> setBlank(List<String> pageIds)

Set pages as blank page

Parameters:

pageIds - the id of pages to modify

Returns:

the id of pages which succeeded or failed.

setTemplate

public Map<String,Object> setTemplate(List<String> pageIds,
                                      String templateName)

Set a template to pages

Parameters:

pageIds - the id of pages to update

templateName - The template name

Returns:

the id of pages which succeeded

getServiceParameters

public Map<String,Object> getServiceParameters(String zoneItemId,
                                               String serviceId)

Get the service parameters values

Parameters:

zoneItemId - the zone item id

serviceId - the service Id

Returns:

the values

_getRepeaters

private void _getRepeaters(Map<String,ServiceParameterOrRepeater> parameters,
                           CompositeMetadata metaHolder,
                           List<Map<String,Object>> repeaters,
                           String prefix)

_getValues

private void _getValues(CompositeMetadata metaHolder,
                        ServiceParameterOrRepeater param,
                        Map<String,Object> values,
                        String prefix)

getServiceParametersAction

public String getServiceParametersAction(String serviceId)

Get the script class name to execute to add or update this service

Parameters:

serviceId - the service id

Returns:

the script class name. Can be empty

setService

public Map<String,Object> setService(String pageId,
                                     String serviceId,
                                     String zoneName,
                                     Map<String,Object> parameters)
                              throws IOException

Set service

Parameters:

pageId - The page id

serviceId - The service id

zoneName - The name of zone of add service into

parameters - the service parameters. Can be empty

Returns:

The result with the ids of updated page, zone and zone item

Throws:

IOException - if an error occurred while saving parameters

configureService

public Map<String,Object> configureService(String serviceId,
                                           String zoneItemId,
                                           Map<String,Object> parameters)
                                    throws IOException

Configure service

Parameters:

serviceId - The service id

zoneItemId - The id of aone item holding this service

parameters - the service parameters to update

Returns:

The result with the ids of updated page, zone and zone item

Throws:

IOException - if an error occurred while saving parameters

_setParameterValues

private void _setParameterValues(ModifiableCompositeMetadata serviceMetadata,
                                 Service service,
                                 Map<String,Object> values,
                                 Map<String,Errors> allErrors)

_getAndSaveParameter

private void _getAndSaveParameter(String prefix,
                                  ServiceParameter param,
                                  Map<String,Object> formValues,
                                  ModifiableCompositeMetadata metadataHolder,
                                  Map<String,Errors> allErrors)

_parseValue

private String[] _parseValue(Object value)

_getAndSaveRepeater

private void _getAndSaveRepeater(String prefix,
                                 ServiceParameterRepeater repeater,
                                 Map<String,Object> formValues,
                                 ModifiableCompositeMetadata metadataHolder,
                                 Map<String,Errors> allErrors)

_removeOldZones

private void _removeOldZones(ModifiablePage page,
                             String templateName)

getTags

public Set<String> getTags(List<String> pageIds)

Get the tags from the pages

Parameters:

pageIds - The ids of the pages

Returns:

the tags of the pages

tag

public Map<String,Object> tag(List<String> pageIds,
                              List<String> tagNames,
                              String mode,
                              Map<String,Object> contextualParameters)

Tag a list of pages

Parameters:

pageIds - The ids of pages to tag

tagNames - The tags

mode - The mode for updating tags: 'REPLACE' to replace tags, 'INSERT' to add tags or 'REMOVE' to remove tags.

contextualParameters - Contextual parameters. Must contain the site name

Returns:

the result

tag

public Map<String,Object> tag(List<String> pageIds,
                              List<String> contentIds,
                              List<String> tagNames,
                              Map<String,Object> contextualParameters)

Tag a list of contents with the given tags

Parameters:

pageIds - The ids of pages to tag

contentIds - The ids of contents to tag

tagNames - The tags

contextualParameters - The contextual parameters

Returns:

the result map

tag

public Map<String,Object> tag(List<String> pageIds,
                              List<String> contentIds,
                              List<String> tagNames,
                              String mode,
                              Map<String,Object> contextualParameters)

Tag a list of contents and/org pages

Parameters:

pageIds - The ids of pages to tag

contentIds - The ids of contents to tag

tagNames - The tags

mode - The mode for updating tags: 'REPLACE' to replace tags, 'INSERT' to add tags or 'REMOVE' to remove tags.

contextualParameters - The contextual parameters

Returns:

the result

_isTagValid

public boolean _isTagValid(Page page,
                           String tagName)

Test if a tag is valid for a specific page

Parameters:

page - The page

tagName - The tag name

Returns:

True if the tag is valid

setVisibility

public Map<String,Object> setVisibility(List<String> pageIds,
                                        boolean visible)

Set the visible of pages

Parameters:

pageIds - The id of pages

visible - true to set pages as visible, false otherwise

Returns:

The result map

getDeleteablePageContents

public Map<String,Object> getDeleteablePageContents(String id)

Get the contents of a Page and its subpages which can be deleted. A content is deleteable if user has right, the content is not locked and not referenced by other pages.

Parameters:

id - The id of page

Returns:

The list of deletable contents

getDeleteablePageContentIds

public List<String> getDeleteablePageContentIds(String pageId,
                                                boolean onlyNewlyCreatedContents)

Get the contents that belong to the Page and its sub-pages and that can be deleted. A content is deleteable if user has right, the content is not locked and it's not referenced by other pages. If 'onlyNewlyCreatedContents' is set to 'true', only newly created contents will be returned

Parameters:

pageId - The id of page

onlyNewlyCreatedContents - true to return only the newly created contents

Returns:

The ids of deleteable contents

getUnreferencedContents

public List<Map<String,Object>> getUnreferencedContents(String id)

Get the unreferenced contents of a Page or a ZoneItem

Parameters:

id - The id of page or zone item

Returns:

The list of unreferenced contents

getAttachmentsRootNode

public Map<String,Object> getAttachmentsRootNode(String id)

Returns the page's attachments root node

Parameters:

id - the page's id

Returns:

The attachments' root node informations

getPageParents

public Map<String,Object> getPageParents(String id)

Returns the page's parents ids

Parameters:

id - the page's id

Returns:

The attachments' root node informations

getPageContents

public List<Content> getPageContents(Page page)

Get the contents of a page and its child pages

Parameters:

page - The page

Returns:

The list of contents

getPageContents

public List<Content> getPageContents(Page page,
                                     boolean ignoreContentsOfNonRemovablePage)

Get the contents of a page and its child pages

Parameters:

page - The page

ignoreContentsOfNonRemovablePage - true to ignore contents of non-removable pages (virtual pages)

Returns:

The list of contents

getUserRights

protected Set<String> getUserRights(PagesContainer pagesCt)

Get the user rights on page container (page or sitemap)

Parameters:

pagesCt - The pages container

Returns:

The user's rights

_isReferenced

private boolean _isReferenced(Content content)

_isLocked

private boolean _isLocked(Content content)

_isNew

private boolean _isNew(Content content)

_page2Json

private Map<String,Object> _page2Json(Page page)

_content2Json

private Map<String,Object> _content2Json(Content content,
                                         Locale locale)

_publication2Json

private Map<String,Object> _publication2Json(Page page)

_getIncomingContentReferences

private AmetysObjectIterable<Content> _getIncomingContentReferences(String pageId)

_getIncomingPageReferences

private AmetysObjectIterable<Page> _getIncomingPageReferences(String pageId)

_zone2json

private Map<String,Object> _zone2json(Zone zone)

_zoneitem2json

private Map<String,Object> _zoneitem2json(ZoneItem zoneItem)

_updateContentsAfterCopy

private void _updateContentsAfterCopy(Page createdPage)
                               throws AmetysRepositoryException

Throws:

AmetysRepositoryException

_getChildrenPageIds

private List<String> _getChildrenPageIds(Page page)