Merge pull request #129 from surevine/votes

Support voting in the java server

Author: martin-hewitt

src/main/java/org/buddycloud/channelserver/channel/ValidateEntry.java

@@ -8,10 +8,10 @@
 import org.apache.log4j.Logger;
 import org.buddycloud.channelserver.db.exception.NodeStoreException;
 import org.buddycloud.channelserver.pubsub.model.NodeItem;
+import org.buddycloud.channelserver.pubsub.model.impl.GlobalItemIDImpl;
 import org.dom4j.Element;
 import org.dom4j.dom.DOMElement;
 import org.xmpp.packet.JID;
-import org.xmpp.packet.PacketError;
 
 public class ValidateEntry {
 
@@ -20,6 +20,14 @@ public class ValidateEntry {
 	public static final String UNSUPPORTED_CONTENT_TYPE = "unsupported-content-type";
 	public static final String MAX_THREAD_DEPTH_EXCEEDED = "max-thread-depth-exceeded";
 	public static final String PARENT_ITEM_NOT_FOUND = "parent-item-not-found";
+	public static final String TARGETED_ITEM_NOT_FOUND = "targeted-item-not-found";
+	public static final String IN_REPLY_TO_MISSING = "missing-in-reply-to";
+	public static final String TARGET_ELEMENT_MISSING = "missing-target";
+	public static final String MISSING_TARGET_ID = "missing-target-id";
+	public static final String RATING_OUT_OF_RANGE = "rating-out-of-range";
+	public static final String INVALID_RATING_VALUE = "invalid-rating";
+	public static final String TARGET_MUST_BE_IN_SAME_THREAD = "target-outside-thread";
+	public static final String CAN_ONLY_RATE_A_POST = "invalid-rating-request";
 
 	public static final String CONTENT_TEXT = "text";
 	public static final String CONTENT_XHTML = "xhtml";
@@ -28,6 +36,7 @@ public class ValidateEntry {
 	public static final String NS_ACTIVITYSTREAM = "http://activitystrea.ms/spec/1.0/";
 	public static final String NS_ATOM_THREAD = "http://purl.org/syndication/thread/1.0";
 	public static final String NS_GEOLOCATION = "http://jabber.org/protocol/geoloc";
+	public static final String NS_REVIEW = "http://activitystrea.ms/schema/1.0/review";
 
 	public static final String AUTHOR_URI_PREFIX = "acct:";
 	public static final String AUTHOR_TYPE = "person";
@@ -36,47 +45,54 @@ public class ValidateEntry {
 	public static final String POST_TYPE_COMMENT = "comment";
 
 	public static final String ACTIVITY_VERB_POST = "post";
+	public static final String ACTIVITY_VERB_RATED = "rated";
 
-	private static Logger logger = Logger.getLogger(ValidateEntry.class);
+	private static Logger LOGGER = Logger.getLogger(ValidateEntry.class);
 
 	private Element entry;
 
 	private String errorMessage = "";
-	private String inReplyTo;
+	private String inReplyTo = null;
+	private String targetId = null;
+	private int itemRating = 0;
 	private Element meta;
 	private Element media;
-	
+
 	private JID jid;
 	private String channelServerDomain;
 	private String node;
 	private ChannelManager channelManager;
+	private NodeItem replyingToItem;
+	private NodeItem targetItem;
 
 	Map<String, String> params = new HashMap<String, String>();
 
 	private Element geoloc;
 
-	public ValidateEntry() {}
-	
+	public ValidateEntry() {
+	}
+
 	public ValidateEntry(Element entry) {
 		setEntry(entry);
 	}
-	
+
 	public void setEntry(Element entry) {
 		this.entry = entry;
 	}
 
 	public String getErrorMessage() {
 		return this.errorMessage;
 	}
-	
+
 	public void setChannelManager(ChannelManager channelManager) {
 		this.channelManager = channelManager;
 	}
 
 	/**
 	 * This is a big hackety-hack.
-	 * @throws InterruptedException 
-	 * @throws NodeStoreException 
+	 * 
+	 * @throws InterruptedException
+	 * @throws NodeStoreException
 	 */
 	public boolean isValid() throws NodeStoreException {
 		if (this.entry == null) {
@@ -86,15 +102,16 @@ public boolean isValid() throws NodeStoreException {
 
 		Element id = this.entry.element("id");
 		if ((id == null) || (true == id.getText().isEmpty())) {
-			if (null != id)
+			if (null != id) {
 				id.detach();
-			logger.debug("ID of the entry was missing. We add a default one to it: 1");
+			}
+			LOGGER.debug("ID of the entry was missing. We add a default one to it: 1");
 			this.entry.addElement("id").setText("1");
 		}
 
 		Element title = this.entry.element("title");
 		if (null == title) {
-			logger.debug("Title of the entry was missing. We add a default one to it: 'Post'.");
+			LOGGER.debug("Title of the entry was missing. We add a default one to it: 'Post'.");
 			title = this.entry.addElement("title");
 			title.setText("Post");
 		}
@@ -121,15 +138,22 @@ public boolean isValid() throws NodeStoreException {
 		if (null == updated) {
 
 			String updateTime = Conf.formatDate(new Date());
-			logger.debug("Update of the entry was missing. We add a default one to it: '"
+			LOGGER.debug("Update of the entry was missing. We add a default one to it: '"
 					+ updateTime + "'.");
 			this.entry.addElement("updated").setText(updateTime);
 		}
 
 		this.geoloc = this.entry.element("geoloc");
 
-		Element reply = this.entry.element("in-reply-to");
-		if ((null != reply) && (false == validateInReplyToElement(reply))) {
+		if (false == validateInReplyToElement(this.entry.element("in-reply-to"))) {
+			return false;
+		}
+
+		if (false == validateTargetElement(this.entry.element("target"))) {
+			return false;
+		}
+
+		if (false == validateRatingElement(this.entry.element("rating"))) {
 			return false;
 		}
 
@@ -159,12 +183,8 @@ public Element getPayload() {
 		entry.addElement("id").setText(
 				"tag:" + channelServerDomain + "," + node + "," + id);
 
-		entry.addElement("title").setText(this.params.get("title"));
-
-		Element content = entry.addElement("content");
-		content.setText(this.params.get("content"));
-		content.addAttribute("type", this.params.get("content-type"));
-
+		String title = this.params.get("title");
+		String itemContent = this.params.get("content");
 		String publishedDate = Conf.formatDate(new Date());
 
 		entry.addElement("published").setText(publishedDate);
@@ -192,11 +212,6 @@ public Element getPayload() {
 
 		this.geoloc = this.entry.element("geoloc");
 
-		entry.addElement("activity:verb").setText(activityVerb);
-
-		Element activityObject = entry.addElement("activity:object");
-		activityObject.addElement("activity:object-type").setText(postType);
-
 		if (null != meta) {
 			entry.add(meta.createCopy());
 		}
@@ -205,6 +220,33 @@ public Element getPayload() {
 			entry.add(media.createCopy());
 		}
 
+		if (null != targetId) {
+			GlobalItemIDImpl globalTargetId = new GlobalItemIDImpl(new JID(
+					channelServerDomain), node, targetId);
+			Element target = entry.addElement("activity:target");
+			target.addElement("id").setText(globalTargetId.toString());
+			target.addElement("activity:object-type").setText("post");
+		}
+
+		if (itemRating > 0) {
+			entry.addNamespace("review", NS_REVIEW);
+			String rating = String.format("%d.0", itemRating);
+			entry.addElement("review:rating").setText(rating);
+			title = "Rating";
+			itemContent = "rating:" + rating;
+			activityVerb = ACTIVITY_VERB_RATED;
+		}
+
+		entry.addElement("title").setText(title);
+
+		Element content = entry.addElement("content");
+		content.setText(itemContent);
+		content.addAttribute("type", this.params.get("content-type"));
+
+		entry.addElement("activity:verb").setText(activityVerb);
+		Element activityObject = entry.addElement("activity:object");
+		activityObject.addElement("activity:object-type").setText(postType);
+
 		return entry;
 	}
 
@@ -219,30 +261,99 @@ public void setNode(String node) {
 	public void setTo(String channelServerDomain) {
 		this.channelServerDomain = channelServerDomain;
 	}
-	
 
-	private boolean validateInReplyToElement(Element reply) throws NodeStoreException {
+	private boolean validateInReplyToElement(Element reply)
+			throws NodeStoreException {
+		if (null == reply) {
+			return true;
+		}
 
 		inReplyTo = reply.attributeValue("ref");
-		if (-1 != inReplyTo.indexOf(",")) {
-			String[] tokens = inReplyTo.split(",");
-			inReplyTo = tokens[2];
+		if (true == GlobalItemIDImpl.isGlobalId(inReplyTo)) {
+			inReplyTo = GlobalItemIDImpl.toLocalId(inReplyTo);
 		}
 
-		String[] inReplyToParts = reply.attributeValue("ref").split(",");
-		inReplyTo = inReplyToParts[inReplyToParts.length - 1];
-
-		NodeItem nodeItem = null;
-		if (null == (nodeItem = channelManager.getNodeItem(node, inReplyTo))) {
+		replyingToItem = channelManager.getNodeItem(node,
+				inReplyTo);
+		if (null == replyingToItem) {
 			this.errorMessage = PARENT_ITEM_NOT_FOUND;
 			return false;
 		}
-		if (null != nodeItem.getInReplyTo()) {
-			logger.error("User is attempting to reply to a reply");
+		if (null != replyingToItem.getInReplyTo()) {
+			LOGGER.error("User is attempting to reply to a reply");
 			this.errorMessage = MAX_THREAD_DEPTH_EXCEEDED;
 			return false;
 		}
 		return true;
 	}
 
+	private boolean validateTargetElement(Element target)
+			throws NodeStoreException {
+		if (null == target) {
+			return true;
+		}
+		targetId = target.elementText("id");
+		if ((null == targetId) || (0 == targetId.length())) {
+			this.errorMessage = MISSING_TARGET_ID;
+			return false;
+		}
+		if (null == inReplyTo) {
+			this.errorMessage = IN_REPLY_TO_MISSING;
+			return false;
+		}
+		if (true == GlobalItemIDImpl.isGlobalId(targetId)) {
+			targetId = GlobalItemIDImpl.toLocalId(targetId);
+		}
+		if (true == targetId.equals(replyingToItem.getId())) {
+			targetItem = replyingToItem;
+		} else {
+			targetItem = channelManager.getNodeItem(node, targetId);
+		}
+		if (null == targetItem) {
+			this.errorMessage = TARGETED_ITEM_NOT_FOUND;
+			return false;
+		}
+		if (true == targetItem.getId().equals(targetId)) {
+			return true;
+		}
+		if ((null == targetItem.getInReplyTo())
+				|| (false == targetItem.getInReplyTo().equals(targetId))) {
+			this.errorMessage = TARGET_MUST_BE_IN_SAME_THREAD;
+			return false;
+		}
+		return true;
+	}
+
+	private boolean validateRatingElement(Element rating) {
+		if (null == rating) {
+			return true;
+		}
+		if (null == inReplyTo) {
+			this.errorMessage = IN_REPLY_TO_MISSING;
+			return false;
+		}
+		if (null == targetId) {
+			this.errorMessage = TARGET_ELEMENT_MISSING;
+			return false;
+		}
+		if (targetItem.getPayload().indexOf(NS_REVIEW) > -1) {
+			this.errorMessage = CAN_ONLY_RATE_A_POST;
+			return false;
+		}
+		try {
+			double itemRatingFloat = Double.parseDouble(rating.getTextTrim());
+			if (itemRatingFloat != Math.floor(itemRatingFloat)) {
+				throw new NumberFormatException("Non-integer rating provided");
+			}
+			itemRating = (int) itemRatingFloat;
+		} catch (NumberFormatException e) {
+			this.errorMessage = INVALID_RATING_VALUE;
+			return false;
+		}
+		if ((itemRating < 1) || (itemRating > 5)) {
+			this.errorMessage = RATING_OUT_OF_RANGE;
+			return false;
+		}
+		return true;
+	}
 }