/* * Copyright (C) 2005-2011 Alfresco Software Limited. * * This file is part of Alfresco * * Alfresco 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 3 of the License, or * (at your option) any later version. * * Alfresco 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. * * You should have received a copy of the GNU Lesser General Public License * along with Alfresco. If not, see . */ package org.alfresco.repo.discussion; import java.io.Serializable; import java.util.ArrayList; import java.util.Date; import java.util.HashMap; import java.util.List; import java.util.Map; import org.alfresco.model.ContentModel; import org.alfresco.model.ForumModel; import org.alfresco.query.CannedQueryFactory; import org.alfresco.query.CannedQueryResults; import org.alfresco.query.CannedQuerySortDetails; import org.alfresco.query.EmptyPagingResults; import org.alfresco.query.PagingRequest; import org.alfresco.query.PagingResults; import org.alfresco.repo.domain.node.NodeDAO; import org.alfresco.repo.node.getchildren.GetChildrenAuditableCannedQuery; import org.alfresco.repo.node.getchildren.GetChildrenAuditableCannedQueryFactory; import org.alfresco.repo.node.getchildren.GetChildrenWithTargetAssocsAuditableCannedQuery; import org.alfresco.repo.node.getchildren.GetChildrenWithTargetAssocsAuditableCannedQueryFactory; import org.alfresco.repo.query.NodeBackedEntity; import org.alfresco.repo.query.NodeWithTargetsEntity; import org.alfresco.repo.query.NodeWithTargetsEntity.TargetAndTypeId; import org.alfresco.repo.site.SiteServiceImpl; import org.alfresco.service.cmr.discussion.DiscussionService; import org.alfresco.service.cmr.discussion.PostInfo; import org.alfresco.service.cmr.discussion.PostWithReplies; import org.alfresco.service.cmr.discussion.TopicInfo; import org.alfresco.service.cmr.model.FileFolderService; import org.alfresco.service.cmr.repository.ChildAssociationRef; import org.alfresco.service.cmr.repository.ContentReader; import org.alfresco.service.cmr.repository.ContentService; import org.alfresco.service.cmr.repository.ContentWriter; import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeService; import org.alfresco.service.cmr.site.SiteService; import org.alfresco.service.cmr.tagging.TaggingService; import org.alfresco.service.namespace.QName; import org.alfresco.service.transaction.TransactionService; import org.alfresco.util.Pair; import org.alfresco.util.registry.NamedObjectRegistry; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; /** * @author Nick Burch (based on existing webscript controllers in the REST API) * @since 4.0 */ public class DiscussionServiceImpl implements DiscussionService { public static final String DISCUSSION_COMPONENT = "discussions"; protected static final String CANNED_QUERY_GET_CHILDREN = "discussionGetChildrenCannedQueryFactory"; protected static final String CANNED_QUERY_GET_CHILDREN_TARGETS = "discussionGetChildrenWithTargetAssocsAuditableCannedQueryFactory"; protected static final int MAX_REPLIES_FETCH_SIZE = 1000; /** * The logger */ @SuppressWarnings("unused") private static Log logger = LogFactory.getLog(DiscussionServiceImpl.class); private NodeDAO nodeDAO; private NodeService nodeService; private SiteService siteService; private ContentService contentService; private TaggingService taggingService; private FileFolderService fileFolderService; private TransactionService transactionService; private NamedObjectRegistry> cannedQueryRegistry; public void setNodeDAO(NodeDAO nodeDAO) { this.nodeDAO = nodeDAO; } public void setNodeService(NodeService nodeService) { this.nodeService = nodeService; } public void setSiteService(SiteService siteService) { this.siteService = siteService; } public void setContentService(ContentService contentService) { this.contentService = contentService; } public void setTaggingService(TaggingService taggingService) { this.taggingService = taggingService; } public void setFileFolderService(FileFolderService fileFolderService) { this.fileFolderService = fileFolderService; } public void setTransactionService(TransactionService transactionService) { this.transactionService = transactionService; } /** * Set the registry of {@link CannedQueryFactory canned queries} */ public void setCannedQueryRegistry(NamedObjectRegistry> cannedQueryRegistry) { this.cannedQueryRegistry = cannedQueryRegistry; } /** * Fetches the Discussions Container on a site, creating as required if requested. */ protected NodeRef getSiteDiscussionsContainer(final String siteShortName, boolean create) { return SiteServiceImpl.getSiteContainer( siteShortName, DISCUSSION_COMPONENT, create, siteService, transactionService, taggingService); } private String generateName() { // Generate a unique name // (Should be unique, but will retry for a new one if not) String name = "post-" +(new Date()).getTime() + "_" + Math.round(Math.random()*10000); return name; } private TopicInfo buildTopic(NodeRef nodeRef, NodeRef container, String name) { TopicInfoImpl topic = new TopicInfoImpl(nodeRef, container, name); // Grab all the properties, we need the bulk of them anyway Map props = nodeService.getProperties(nodeRef); // Start with the auditable properties topic.setCreator((String)props.get(ContentModel.PROP_CREATOR)); topic.setModifier((String)props.get(ContentModel.PROP_MODIFIER)); topic.setCreatedAt((Date)props.get(ContentModel.PROP_CREATED)); topic.setModifiedAt((Date)props.get(ContentModel.PROP_MODIFIED)); // Now do the discussion ones // Title is special - in older cases from share it was set on the // First Post but not on the Topic String title = (String)props.get(ContentModel.PROP_TITLE); if(title == null) { // Try the first child PostInfo primaryPost = getPrimaryPost(topic); if(primaryPost != null) { title = primaryPost.getTitle(); } } topic.setTitle(title); // Finally tags topic.setTags(taggingService.getTags(nodeRef)); // All done return topic; } private PostInfo buildPost(NodeRef nodeRef, TopicInfo topic, String name, String preLoadedContents) { PostInfoImpl post = new PostInfoImpl(nodeRef, name, topic); // Grab all the properties, we need the bulk of them anyway Map props = nodeService.getProperties(nodeRef); // Start with the auditable properties post.setCreator((String)props.get(ContentModel.PROP_CREATOR)); post.setModifier((String)props.get(ContentModel.PROP_MODIFIER)); post.setCreatedAt((Date)props.get(ContentModel.PROP_CREATED)); post.setModifiedAt((Date)props.get(ContentModel.PROP_MODIFIED)); post.setUpdatedAt((Date)props.get(ContentModel.PROP_UPDATED)); // Now do the discussion ones post.setTitle((String)props.get(ContentModel.PROP_TITLE)); // Finally, do the content String contents = preLoadedContents; if(contents == null) { ContentReader reader = contentService.getReader(nodeRef, ContentModel.PROP_CONTENT); if(reader != null) { contents = reader.getContentString(); } } post.setContents(contents); // All done return post; } @Override public TopicInfo getTopic(String siteShortName, String topicName) { NodeRef container = getSiteDiscussionsContainer(siteShortName, false); if(container == null) { // No discussions return null; } // We can now fetch by parent nodeRef return getTopic(container, topicName); } @Override public TopicInfo getTopic(NodeRef parentNodeRef, String topicName) { NodeRef topic = nodeService.getChildByName(parentNodeRef, ContentModel.ASSOC_CONTAINS, topicName); if(topic != null) { return buildTopic(topic, parentNodeRef, topicName); } return null; } @Override public PostInfo getPost(TopicInfo topic, String postName) { // Sanity check what we were given if(topic.getNodeRef() == null) { throw new IllegalArgumentException("Can't get posts for a topic that was never persisted!"); } // Fetch NodeRef post = nodeService.getChildByName(topic.getNodeRef(), ContentModel.ASSOC_CONTAINS, postName); if(post != null) { return buildPost(post, topic, postName, null); } return null; } @Override public TopicInfo createTopic(String siteShortName, String title) { // Grab the location to store in NodeRef container = getSiteDiscussionsContainer(siteShortName, true); // Add by Parent NodeRef return createTopic(container, title); } @Override public TopicInfo createTopic(NodeRef parentNodeRef, String title) { // Build the name String name = generateName(); // Get the properties for the node Map props = new HashMap(); props.put(ContentModel.PROP_NAME, name); props.put(ContentModel.PROP_TITLE, title); // Build the node NodeRef nodeRef = nodeService.createNode( parentNodeRef, ContentModel.ASSOC_CONTAINS, QName.createQName(name), ForumModel.TYPE_TOPIC, props ).getChildRef(); // Generate the wrapping object for it // Build it that way, so creator and created date come through return buildTopic(nodeRef, parentNodeRef, name); } @Override public PostInfo createPost(TopicInfo topic, String contents) { // Sanity check what we were given if(topic.getNodeRef() == null) { throw new IllegalArgumentException("Can't create posts for a topic that was never persisted!"); } // Are we going to be the primary post? boolean isPrimary = false; if(getPrimaryPost(topic) == null) { isPrimary = true; } // Decide on the name. If this is the first post in a topic, // it should share the topic's name, otherwise needs a new one String name = generateName(); if(isPrimary) { name = topic.getSystemName(); } // Create the properties for the node Map props = new HashMap(); props.put(ContentModel.PROP_NAME, name); // TODO Remove this shortly, when the webscripts have been // fixed up to avoid their current broken-ness props.put(ContentModel.PROP_PUBLISHED, new Date()); // Do we want a title? By default, primary posts share a title // with the topic, but replies are title-free if(isPrimary) { props.put(ContentModel.PROP_TITLE, topic.getTitle()); } // Build the node NodeRef nodeRef = nodeService.createNode( topic.getNodeRef(), ContentModel.ASSOC_CONTAINS, QName.createQName(name), ForumModel.TYPE_POST, props ).getChildRef(); // Store the content ContentWriter writer = contentService.getWriter(nodeRef, ContentModel.PROP_CONTENT, true); writer.setEncoding("UTF-8"); writer.putContent(contents); // Generate the wrapping object for it // Build it that way, so creator and created date come through return buildPost(nodeRef, topic, name, contents); } @Override public PostInfo createReply(PostInfo parentPost, String contents) { // Sanity check what we were given if(parentPost.getNodeRef() == null) { throw new IllegalArgumentException("Can't reply to a post that was never persisted"); } if(parentPost.getTopic() == null) { throw new IllegalArgumentException("Can't reply to a post with no attached topic"); } // Have the post created PostInfo reply = createPost(parentPost.getTopic(), contents); // Now make it a reply nodeService.createAssociation( reply.getNodeRef(), parentPost.getNodeRef(), ContentModel.ASSOC_REFERENCES ); // All done return reply; } @Override public TopicInfo updateTopic(TopicInfo topic) { // Sanity check what we were given if(topic.getNodeRef() == null) { throw new IllegalArgumentException("Can't update a topic that was never persisted, call create instead"); } // Update the properties NodeRef nodeRef = topic.getNodeRef(); nodeService.setProperty(nodeRef, ContentModel.PROP_TITLE, topic.getTitle()); // Now do the tags taggingService.setTags(nodeRef, topic.getTags()); // All done return topic; } @Override public PostInfo updatePost(PostInfo post) { // Sanity check what we were given if(post.getNodeRef() == null) { throw new IllegalArgumentException("Can't update a post that was never persisted, call create instead"); } // Update the properties NodeRef nodeRef = post.getNodeRef(); nodeService.setProperty(nodeRef, ContentModel.PROP_TITLE, post.getTitle()); // Change the content ContentWriter writer = contentService.getWriter(nodeRef, ContentModel.PROP_CONTENT, true); writer.setEncoding("UTF-8"); writer.putContent(post.getContents()); // Mark it as having been updated Date updatedAt = new Date(); nodeService.setProperty(nodeRef, ContentModel.PROP_UPDATED, updatedAt); if(post instanceof PostInfoImpl) { ((PostInfoImpl)post).setUpdatedAt(updatedAt); ((PostInfoImpl)post).setModifiedAt(updatedAt); } else { // Re-create to get the updated date post = buildPost(nodeRef, post.getTopic(), post.getSystemName(), post.getContents()); } // All done return post; } @Override public void deleteTopic(TopicInfo topic) { if(topic.getNodeRef() == null) { throw new IllegalArgumentException("Can't delete a topic that was never persisted"); } nodeService.deleteNode(topic.getNodeRef()); } @Override public void deletePost(PostInfo post) { if(post.getNodeRef() == null) { throw new IllegalArgumentException("Can't delete a post that was never persisted"); } nodeService.deleteNode(post.getNodeRef()); } @Override public Pair getForNodeRef(NodeRef nodeRef) { QName type = nodeService.getType(nodeRef); TopicInfo topic = null; PostInfo post = null; if(type.equals(ForumModel.TYPE_TOPIC)) { ChildAssociationRef ref = nodeService.getPrimaryParent(nodeRef); String topicName = ref.getQName().getLocalName(); topic = getTopic(ref.getParentRef(), topicName); } else if(type.equals(ForumModel.TYPE_POST)) { ChildAssociationRef toTopic = nodeService.getPrimaryParent(nodeRef); String postName = toTopic.getQName().getLocalName(); NodeRef topicNodeRef = toTopic.getParentRef(); ChildAssociationRef toParent = nodeService.getPrimaryParent(topicNodeRef); String topicName = toParent.getQName().getLocalName(); topic = getTopic(toParent.getParentRef(), topicName); post = getPost(topic, postName); } else { logger.debug("Invalid type " + type + " found"); return null; } // Return what we found return new Pair(topic, post); } @Override public PostInfo getPrimaryPost(TopicInfo topic) { // First up, see if there is a post with the same name as the topic // (That's the normal Share case) PostInfo post = getPost(topic, topic.getSystemName()); if(post != null) { return post; } // Cater for the explorer case, we want the first child List children = nodeService.getChildAssocs(topic.getNodeRef()); if(children.size() == 0) { // No child posts yet return null; } // We want the first one in the list NodeRef postNodeRef = children.get(0).getChildRef(); String postName = children.get(0).getQName().getLocalName(); return buildPost(postNodeRef, topic, postName, null); } @Override public PostInfo getMostRecentPost(TopicInfo topic) { // Do a listing at the Node level, ordered by created date // to get the most recent nodes PagingRequest paging = new PagingRequest(0, 1); CannedQueryResults results = listEntries(topic.getNodeRef(), ForumModel.TYPE_POST, null, false, paging); // Bail if the topic lacks posts if(results.getPage().size() == 0) { // No posts in the topic return null; } // Grab the newest node NodeBackedEntity node = results.getPage().get(0); // Wrap and return return buildPost(node.getNodeRef(), topic, node.getName(), null); } @Override public PagingResults listTopics(String siteShortName, PagingRequest paging) { NodeRef container = getSiteDiscussionsContainer(siteShortName, false); if(container == null) { // No topics return new EmptyPagingResults(); } // We can now fetch by parent nodeRef return listTopics(container, paging); } @Override public PagingResults listTopics(NodeRef nodeRef, PagingRequest paging) { // Do the listing, oldest first CannedQueryResults nodes = listEntries(nodeRef, ForumModel.TYPE_TOPIC, null, true, paging); // Wrap and return return wrap(nodes, nodeRef); } @Override public PagingResults listPosts(TopicInfo topic, PagingRequest paging) { // Do the listing, oldest first CannedQueryResults nodes = listEntries(topic.getNodeRef(), ForumModel.TYPE_POST, null, true, paging); // Wrap and return return wrap(nodes, topic); } @Override public PostWithReplies listPostReplies(TopicInfo topic, int levels) { PostInfo primaryPost = getPrimaryPost(topic); if(primaryPost == null) { return null; } return listPostReplies(primaryPost, levels); } @Override public PostWithReplies listPostReplies(PostInfo primaryPost, int levels) { // Grab the factory GetChildrenWithTargetAssocsAuditableCannedQueryFactory cqFactory = (GetChildrenWithTargetAssocsAuditableCannedQueryFactory)cannedQueryRegistry.getNamedObject(CANNED_QUERY_GET_CHILDREN_TARGETS); // Sort by date CannedQuerySortDetails sorting = cqFactory.createDateAscendingCQSortDetails(); // Run the canned query GetChildrenWithTargetAssocsAuditableCannedQuery cq = (GetChildrenWithTargetAssocsAuditableCannedQuery)cqFactory.getCannedQuery( primaryPost.getTopic().getNodeRef(), ForumModel.TYPE_POST, ContentModel.ASSOC_REFERENCES, sorting, new PagingRequest(MAX_REPLIES_FETCH_SIZE)); // Execute the canned query CannedQueryResults results = cq.execute(); // Prepare to invert Map idToNodeRef = new HashMap(); for(NodeWithTargetsEntity e : results.getPage()) { idToNodeRef.put(e.getId(), e.getNodeRef()); } Map> idToReplies = new HashMap>(); for(NodeWithTargetsEntity e : results.getPage()) { for(TargetAndTypeId idP : e.getTargetIds()) { Long id = idP.getTargetId(); NodeRef nodeRef = idToNodeRef.get(id); if(nodeRef == null) { // References a node outside of this topic continue; } if(id.equals(e.getId())) { // Self reference continue; } if(! idToReplies.containsKey(nodeRef)) { idToReplies.put(nodeRef, new ArrayList()); } idToReplies.get(nodeRef).add(e); } } // Grab the list of NodeRefs to pre-load, and pre-load them List preLoad = new ArrayList(); calculateRepliesPreLoad(primaryPost.getNodeRef(), preLoad, idToReplies, levels); nodeDAO.cacheNodes(preLoad); // Wrap return wrap(primaryPost, idToReplies, levels); } private void calculateRepliesPreLoad(NodeRef nodeRef, List preLoad, Map> idToReplies, int levels) { preLoad.add(nodeRef); if(levels > 0) { List replies = idToReplies.get(nodeRef); if(replies != null && replies.size() > 0) { for(NodeWithTargetsEntity entity : replies) { calculateRepliesPreLoad(entity.getNodeRef(), preLoad, idToReplies, levels-1); } } } } private PostWithReplies wrap(PostInfo post, Map> idToReplies, int levels) { List replies = new ArrayList(); if(levels > 0) { List replyEntities = idToReplies.get(post.getNodeRef()); if(replyEntities != null && replyEntities.size() > 0) { for(NodeWithTargetsEntity entity : replyEntities) { PostInfo replyPost = buildPost(entity.getNodeRef(), post.getTopic(), entity.getName(), null); replies.add(wrap(replyPost, idToReplies, levels-1)); } } } return new PostWithReplies(post, replies); } @Override public PagingResults listPosts(NodeRef nodeRef, PagingRequest paging) { // TODO Auto-generated method stub return null; } @Override public PagingResults listPosts(String siteShortName, PagingRequest paging) { // TODO Auto-generated method stub return null; } /** * Finds nodes in the specified parent container, with the given * type, optionally filtered by creator */ private CannedQueryResults listEntries(NodeRef parent, QName nodeType, String creatorUsername, boolean oldestFirst, PagingRequest paging) { // Grab the factory GetChildrenAuditableCannedQueryFactory getChildrenCannedQueryFactory = (GetChildrenAuditableCannedQueryFactory)cannedQueryRegistry.getNamedObject(CANNED_QUERY_GET_CHILDREN); // Do the sorting, newest first or last by created date (as requested) CannedQuerySortDetails sorting = null; if(oldestFirst) { sorting = getChildrenCannedQueryFactory.createDateAscendingCQSortDetails(); } else { sorting = getChildrenCannedQueryFactory.createDateDescendingCQSortDetails(); } // Run the canned query GetChildrenAuditableCannedQuery cq = (GetChildrenAuditableCannedQuery)getChildrenCannedQueryFactory.getCannedQuery( parent, nodeType, creatorUsername, null, null, null, null, null, sorting, paging); // Execute the canned query CannedQueryResults results = cq.execute(); // Return for wrapping return results; } /** * Our class to wrap up paged results of NodeBackedEntities as * {@link TopicInfo} instances */ private PagingResults wrap(final PagingResults results, final NodeRef container) { // Pre-load the nodes before we create them List ids = new ArrayList(); for(NodeBackedEntity node : results.getPage()) { ids.add(node.getId()); } nodeDAO.cacheNodesById(ids); // Wrap return new PagingResults() { @Override public String getQueryExecutionId() { return results.getQueryExecutionId(); } @Override public List getPage() { List topics = new ArrayList(); for(NodeBackedEntity node : results.getPage()) { NodeRef nodeRef = node.getNodeRef(); String name = node.getName(); topics.add(buildTopic(nodeRef, container, name)); } return topics; } @Override public boolean hasMoreItems() { return results.hasMoreItems(); } @Override public Pair getTotalResultCount() { return results.getTotalResultCount(); } }; } /** * Our class to wrap up paged results of NodeBackedEntities as * {@link PostInfo} instances */ private PagingResults wrap(final PagingResults results, final TopicInfo topic) { // Pre-load the nodes before we create them List ids = new ArrayList(); for(NodeBackedEntity node : results.getPage()) { ids.add(node.getId()); } nodeDAO.cacheNodesById(ids); // Wrap return new PagingResults() { @Override public String getQueryExecutionId() { return results.getQueryExecutionId(); } @Override public List getPage() { List posts = new ArrayList(); for(NodeBackedEntity node : results.getPage()) { NodeRef nodeRef = node.getNodeRef(); String name = node.getName(); posts.add(buildPost(nodeRef, topic, name, null)); } return posts; } @Override public boolean hasMoreItems() { return results.hasMoreItems(); } @Override public Pair getTotalResultCount() { return results.getTotalResultCount(); } }; } }