Package io.goobi.viewer.model.annotation.comments

Class CommentManager

java.lang.Object

io.goobi.viewer.model.annotation.comments.CommentManager

All Implemented Interfaces:

AnnotationLister<Comment>

public class CommentManager
extends Object
implements AnnotationLister<Comment>

Class to create comments from a text input for a given PI and page order and to save them using a given AnnotationSaver.

Author:

Florian Alpers

Constructor Summary

Constructors

Constructor	Description
CommentManager(AnnotationSaver saver, AnnotationDeleter deleter, AnnotationLister<Comment> lister, ChangeNotificator... notificators)

Method Summary

Modifier and Type	Method	Description
static String	checkAndCleanScripts(String text, User editor, String pi, Integer page)
void	createComment(String text, User creator, String pi, Integer pageOrder, String license, PublicationStatus publicationStatus)
void	deleteComment(Comment comment)
void	editComment(Comment comment, String text, User editor, PublicationStatus publicationStatus)
List<Comment>	getAllAnnotations()
Optional<Comment>	getAnnotation(Long id)
long	getAnnotationCount(String textQuery, List<String> motivations, List<Long> generators, List<Long> creators, String targetPi, Integer targetPage)
List<Comment>	getAnnotations(int firstIndex, int items, String textQuery, List<String> motivations, List<Long> generators, List<Long> creators, String targetPi, Integer targetPage, String sortField, boolean sortDescending)
static Set<CommentGroup>	getRelevantCommentGroupsForRecord(String pi)	Returns UserGroups linked to CommentGroups (non-core only) whose Solr query matches the given pi.
long	getTotalAnnotationCount()
static boolean	isUserHasAccessToCommentGroups(User user)	Checks whether the given user has access to any comment groups, whether via being admin or owner or member of any linked user group.
static boolean	queryCommentGroupIdentifiers(CommentGroup commentGroup)
static void	shutdown()	Shuts down the background e-mail notification executor.

Methods inherited from class java.lang.Object

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

Constructor Details

CommentManager

public CommentManager(AnnotationSaver saver,
 AnnotationDeleter deleter,
 AnnotationLister<Comment> lister,
 ChangeNotificator... notificators)

Parameters:

saver - strategy used to persist new or edited comments

deleter - strategy used to remove comments

lister - strategy used to retrieve comments

notificators - zero or more notificators for comment change events

Method Details

shutdown

public static void shutdown()

Shuts down the background e-mail notification executor. Called by ContextListener during application shutdown. Waits up to 5 seconds for in-flight notifications to finish.

createComment

public void createComment(String text,
 User creator,
 String pi,
 Integer pageOrder,
 String license,
 PublicationStatus publicationStatus)

Parameters:

text - raw comment text entered by the user

creator - user creating the comment

pi - persistent identifier of the target record

pageOrder - page number the comment is attached to

license - license string to apply to the comment

publicationStatus - initial publication status of the comment

editComment

public void editComment(Comment comment,
 String text,
 User editor,
 PublicationStatus publicationStatus)

Parameters:

comment - the original comment being edited

text - new comment text provided by the editor

editor - user performing the edit

publicationStatus - updated publication status for the comment

deleteComment

public void deleteComment(Comment comment)

Parameters:

comment - the comment to delete

getAllAnnotations

public List<Comment> getAllAnnotations()

Specified by:

getAllAnnotations in interface AnnotationLister<Comment>

getTotalAnnotationCount

public long getTotalAnnotationCount()

Specified by:

getTotalAnnotationCount in interface AnnotationLister<Comment>

getAnnotations

public List<Comment> getAnnotations(int firstIndex,
 int items,
 String textQuery,
 List<String> motivations,
 List<Long> generators,
 List<Long> creators,
 String targetPi,
 Integer targetPage,
 String sortField,
 boolean sortDescending)

Specified by:

getAnnotations in interface AnnotationLister<Comment>

getAnnotationCount

public long getAnnotationCount(String textQuery,
 List<String> motivations,
 List<Long> generators,
 List<Long> creators,
 String targetPi,
 Integer targetPage)

Specified by:

getAnnotationCount in interface AnnotationLister<Comment>

checkAndCleanScripts

public static String checkAndCleanScripts(String text,
 User editor,
 String pi,
 Integer page)

Parameters:

text - raw comment text to sanitize

editor - user who submitted the text

pi - persistent identifier of the target record

page - page number the comment is attached to

Returns:

text stripped of any JS

getAnnotation

public Optional<Comment> getAnnotation(Long id)

Specified by:

getAnnotation in interface AnnotationLister<Comment>

getRelevantCommentGroupsForRecord

public static Set<CommentGroup> getRelevantCommentGroupsForRecord(String pi)
                                                           throws DAOException,
PresentationException,
IndexUnreachableException

Returns UserGroups linked to CommentGroups (non-core only) whose Solr query matches the given pi.

Parameters:

pi - persistent identifier of the record to match against comment group queries

Returns:

Set

Throws:

DAOException

PresentationException

IndexUnreachableException

queryCommentGroupIdentifiers

public static boolean queryCommentGroupIdentifiers(CommentGroup commentGroup)
                                            throws PresentationException,
IndexUnreachableException

Parameters:

commentGroup - comment group whose Solr query should be executed

Returns:

true if commentGroup query has matching identifiers in the index; false otherwise

Throws:

PresentationException

IndexUnreachableException

isUserHasAccessToCommentGroups

public static boolean isUserHasAccessToCommentGroups(User user)
                                              throws DAOException

Checks whether the given user has access to any comment groups, whether via being admin or owner or member of any linked user group.

Parameters:

user - user to check access for

Returns:

true if user has access; false otherwise

Throws:

DAOException