Package org.ametys.cms.repository.comment

Class CommentsDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.repository.comment.CommentsDAO

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

Direct Known Subclasses:

CommentsDAO

public class CommentsDAO
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable

DAO for content's comments

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	The avalon context
protected ObservationManager	_observationManager	The observation manager
protected PopulationContextHelper	_populationContextHelper	The population context helper
protected ReactionableObjectHelper	_reactionableHelper	Helper for reactionable object
protected AmetysObjectResolver	_resolver	The Ametys object resolver
protected RightManager	_rightManager	The right manager
protected UserHelper	_userHelper	The user helper
protected UserManager	_userManager	The user manager
protected UserPopulationDAO	_userPopulationDAO	The user population DAO
protected CurrentUserProvider	_userProvider	The currenrt user provider
static final String	FORM_AUTHOR_EMAIL	The form input name for author email
static final String	FORM_AUTHOR_HIDEEMAIL	The form input name for author email to hide
static final String	FORM_AUTHOR_NAME	The form input name for author name
static final String	FORM_AUTHOR_URL	The form input name for author url
static final String	FORM_CAPTCHA_KEY	The form input name for captcha
static final String	FORM_CAPTCHA_VALUE	The form input name for captcha
static final String	FORM_CONTENTTEXT	The form input name for content
static final String	ROLE	The Avalon role
static final Pattern	URL_VALIDATOR	The pattern to check url

Constructor Summary

Constructors

Constructor	Description
CommentsDAO()

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	_setCommentAttributes(CommentableContent content, Comment comment, Map<String,Object> formValues)	Set comment attributes
Map<String,Object>	addComment(String contentId, String commentId, Map<String,Object> formValues, Map<String,Object> contextualParameters)	Add a new comment
boolean	canDeleteComment(String contentId)	Determines if current user is allowed to delete a comment
boolean	canDeleteComment(Content content, Comment comment)	Determines if current user is allowed to delete a comment
void	contextualize(Context context)
Map<String,Object>	deleteComment(String contentId, String commentId)	Delete a comment
Map<String,Object>	getComment(Content content, Comment comment, int level, Map<String,Object> contextualParameters)	Get JSON representation of a comment
protected Map<String,Object>	getCommentAuthor(Comment comment, Map<String,Object> contextualParameters)	Get JSON representation of a comment's author
List<Map<String,Object>>	getComments(String contentId, Map<String,Object> contextualParameters)	Get the content's comments
protected CommentableContent	getContent(String contentId)	Get the commentable content
List<Map<String,Object>>	getContributorComments(String contentId, Map<String,Object> contextualParameters)	Get the content's contributor comments
protected UserIdentity	getCurrentUser()	Get the current user
List<Map<String,Object>>	getErrors(CommentableContent content, Map<String,Object> formValues)	Get errors when submitting comment
protected Optional<User>	getUserByEmail(String userEmail, Map<String,Object> contextualParameters)	Get the author as a User if exists
protected Map<String,Object>	getUserIdentityProperties(UserIdentity userIdentity, Map<String,Object> contextualParameters)	Get JSON representation of a user identity.
protected List<String>	getUserPopulationsContexts(Request request, Map<String,Object> contextualParameters)	Get the user population contexts
protected Map<String,Object>	getUserProperties(User user, Map<String,Object> contextualParameters)	Get JSON representation of a user
protected Map<String,Object>	getUserPropertiesFromIdentity(UserIdentity userIdentity, Map<String,Object> contextualParameters)	Get JSON representation of a user from its identity.
boolean	isCaptchaRequired(Content content, Map<String,Object> formValues)	Checks if a captcha have to be checked.
boolean	isValidatedByDefault(Content content)	Get the validation flag default value for a content asking all listeners
Map<String,Object>	likeOrUnlikeComment(String contentId, String commentId)	React (like or unlike) to a comment
Map<String,Object>	likeOrUnlikeComment(String contentId, String commentId, Boolean remove)	React (like or unlike) to a comment
Map<String,Object>	reportComment(String contentId, String commentId)	Report a comment
void	saxComment(ContentHandler contentHandler, Comment comment, int level, Map<String,Object> contextualParameters)	SAX a comment
protected void	saxCommentAdditionalProperties(ContentHandler contentHandler, Comment comment, int level, Map<String,Object> contextualParameters)	SAX additional comment properties
protected void	saxUserIdentity(ContentHandler contentHandler, UserIdentity userIdentity, String tagName)	Generate SAX events for all known data of the given user identity
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The Avalon role

FORM_AUTHOR_NAME

public static final String FORM_AUTHOR_NAME

The form input name for author name

See Also:

• Constant Field Values

FORM_AUTHOR_EMAIL

public static final String FORM_AUTHOR_EMAIL

The form input name for author email

See Also:

• Constant Field Values

FORM_AUTHOR_HIDEEMAIL

public static final String FORM_AUTHOR_HIDEEMAIL

The form input name for author email to hide

See Also:

• Constant Field Values

FORM_AUTHOR_URL

public static final String FORM_AUTHOR_URL

The form input name for author url

See Also:

• Constant Field Values

FORM_CONTENTTEXT

public static final String FORM_CONTENTTEXT

The form input name for content

See Also:

• Constant Field Values

FORM_CAPTCHA_KEY

public static final String FORM_CAPTCHA_KEY

The form input name for captcha

See Also:

• Constant Field Values

FORM_CAPTCHA_VALUE

public static final String FORM_CAPTCHA_VALUE

The form input name for captcha

See Also:

• Constant Field Values

URL_VALIDATOR

public static final Pattern URL_VALIDATOR

The pattern to check url

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_observationManager

protected ObservationManager _observationManager

The observation manager

_userProvider

protected CurrentUserProvider _userProvider

The currenrt user provider

_userHelper

protected UserHelper _userHelper

The user helper

_rightManager

protected RightManager _rightManager

The right manager

_reactionableHelper

protected ReactionableObjectHelper _reactionableHelper

Helper for reactionable object

_userManager

protected UserManager _userManager

The user manager

_populationContextHelper

protected PopulationContextHelper _populationContextHelper

The population context helper

_userPopulationDAO

protected UserPopulationDAO _userPopulationDAO

The user population DAO

_context

protected Context _context

The avalon context

Constructor Details

CommentsDAO

public CommentsDAO()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getComments

public List<Map<String,Object>> getComments(String contentId,
 Map<String,Object> contextualParameters)
                                     throws IllegalAccessException

Get the content's comments

Parameters:

contentId - the content id

contextualParameters - the contextual parameters

Returns:

the comments

Throws:

IllegalAccessException - if user is not allowed to get comments

getContributorComments

public List<Map<String,Object>> getContributorComments(String contentId,
 Map<String,Object> contextualParameters)

Get the content's contributor comments

Parameters:

contentId - the content id

contextualParameters - the contextual parameters

Returns:

the comments

addComment

public Map<String,Object> addComment(String contentId,
 String commentId,
 Map<String,Object> formValues,
 Map<String,Object> contextualParameters)
                              throws IllegalAccessException

Add a new comment

Parameters:

contentId - the content id

commentId - the id of of parent comment. Can be null if it is not a subcomment

formValues - the form's values

contextualParameters - the contextual parameters

Returns:

the results

Throws:

IllegalAccessException - if anonymous or current user has no access to the content

deleteComment

public Map<String,Object> deleteComment(String contentId,
 String commentId)
                                 throws IllegalAccessException

Delete a comment

Parameters:

contentId - the content id

commentId - the comment id to remove

Returns:

the results

Throws:

IllegalAccessException - if current user is null

canDeleteComment

public boolean canDeleteComment(String contentId)

Determines if current user is allowed to delete a comment

Parameters:

contentId - the content id

Returns:

true if the current user is allowed

canDeleteComment

public boolean canDeleteComment(Content content,
 Comment comment)

Determines if current user is allowed to delete a comment

Parameters:

content - the content

comment - the comment

Returns:

true if the current user is allowed

likeOrUnlikeComment

public Map<String,Object> likeOrUnlikeComment(String contentId,
 String commentId)
                                       throws IllegalAccessException

React (like or unlike) to a comment

Parameters:

contentId - the content id

commentId - the comment id

Returns:

the results

Throws:

IllegalAccessException - if current user is null or user has no access to the content

likeOrUnlikeComment

public Map<String,Object> likeOrUnlikeComment(String contentId,
 String commentId,
 Boolean remove)
                                       throws IllegalAccessException

React (like or unlike) to a comment

Parameters:

contentId - the content id

commentId - the comment id

remove - true to remove the reaction, false to add reaction. If null, check if the current user has already like the comment.

Returns:

the results

Throws:

IllegalAccessException - if current user is null or user has no access to the content

getContent

protected CommentableContent getContent(String contentId)

Get the commentable content

Parameters:

contentId - The content id

Returns:

The content

_setCommentAttributes

protected Map<String,Object> _setCommentAttributes(CommentableContent content,
 Comment comment,
 Map<String,Object> formValues)

Set comment attributes

Parameters:

content - the content

comment - the comment

formValues - the form's values

Returns:

the result

reportComment

public Map<String,Object> reportComment(String contentId,
 String commentId)
                                 throws IllegalAccessException

Report a comment

Parameters:

contentId - the content id

commentId - the comment id

Returns:

the results

Throws:

IllegalAccessException - if anonymous or current user has no access to the content

isValidatedByDefault

public boolean isValidatedByDefault(Content content)

Get the validation flag default value for a content asking all listeners

Parameters:

content - The content having a new comment

Returns:

a positive value if the comments have to be validated by default or a negative value in the other case. The absolute value is the priority of your listener. E.G. If a listener set +1 and another -10: the sum is negative (so comments not validated be default).

isCaptchaRequired

public boolean isCaptchaRequired(Content content,
 Map<String,Object> formValues)

Checks if a captcha have to be checked.

Parameters:

content - The content to comment

formValues - The form values

Returns:

true if the comments have to be protected by a captcha or false otherwise

getErrors

public List<Map<String,Object>> getErrors(CommentableContent content,
 Map<String,Object> formValues)

Get errors when submitting comment

Parameters:

content - The content to comment

formValues - The form values to submit a comment

Returns:

An list of error messages (empty if no errors)

getCurrentUser

protected UserIdentity getCurrentUser()

Get the current user

Returns:

The current user

getComment

public Map<String,Object> getComment(Content content,
 Comment comment,
 int level,
 Map<String,Object> contextualParameters)

Get JSON representation of a comment

Parameters:

content - The content

comment - the comment

level - the level of comment (0 for parent comment, 1 for sub-comment, etc ....)

contextualParameters - the contextual parameters

Returns:

the comment as JSON

getCommentAuthor

protected Map<String,Object> getCommentAuthor(Comment comment,
 Map<String,Object> contextualParameters)

Get JSON representation of a comment's author

Parameters:

comment - the comment

contextualParameters - the contextual parameters

Returns:

the comment's author as JSON

getUserByEmail

protected Optional<User> getUserByEmail(String userEmail,
 Map<String,Object> contextualParameters)

Get the author as a User if exists

Parameters:

userEmail - the email of the user to retrieve

contextualParameters - the contextual parameters

Returns:

the user or null

getUserPropertiesFromIdentity

protected Map<String,Object> getUserPropertiesFromIdentity(UserIdentity userIdentity,
 Map<String,Object> contextualParameters)

Get JSON representation of a user from its identity. If the user does not exist, get all known identity properties

Parameters:

userIdentity - the user identity

contextualParameters - the contextual parameters

Returns:

the user as JSON

getUserProperties

protected Map<String,Object> getUserProperties(User user,
 Map<String,Object> contextualParameters)

Get JSON representation of a user

Parameters:

user - the user

contextualParameters - the contextual parameters

Returns:

the user as JSON

getUserIdentityProperties

protected Map<String,Object> getUserIdentityProperties(UserIdentity userIdentity,
 Map<String,Object> contextualParameters)

Get JSON representation of a user identity. Put all known data in the json result

Parameters:

userIdentity - the user identity

contextualParameters - the contextual parameters

Returns:

the user identity as JSON

getUserPopulationsContexts

protected List<String> getUserPopulationsContexts(Request request,
 Map<String,Object> contextualParameters)

Get the user population contexts

Parameters:

request - The request

contextualParameters - The contextual parameters

Returns:

The contexts

Throws:

IllegalArgumentException - If there is no context set

saxComment

public void saxComment(ContentHandler contentHandler,
 Comment comment,
 int level,
 Map<String,Object> contextualParameters)
                throws SAXException

SAX a comment

Parameters:

contentHandler - the content handler

comment - the comment

level - the level of comment

contextualParameters - the contextual parameters

Throws:

SAXException - if an error occurred hile saxing

saxUserIdentity

protected void saxUserIdentity(ContentHandler contentHandler,
 UserIdentity userIdentity,
 String tagName)
                        throws SAXException

Generate SAX events for all known data of the given user identity

Parameters:

contentHandler - the content handler

userIdentity - the user identity

tagName - The XML tag for saxed user

Throws:

SAXException - if an error occurred while generating SAX events

saxCommentAdditionalProperties

protected void saxCommentAdditionalProperties(ContentHandler contentHandler,
 Comment comment,
 int level,
 Map<String,Object> contextualParameters)
                                       throws SAXException

SAX additional comment properties

Parameters:

contentHandler - the content handler

comment - the comment

level - the level of comment

contextualParameters - the contextual parameters

Throws:

SAXException - if an error occurred while saxing