/*
- * Sone - FcpInterface.java - Copyright © 2011–2012 David Roden
+ * Sone - AbstractSoneCommand.java - Copyright © 2011–2013 David Roden
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
package net.pterodactylus.sone.fcp;
+import static com.google.common.collect.FluentIterable.from;
+import static net.pterodactylus.sone.data.Reply.FUTURE_REPLY_FILTER;
+
import java.util.Collection;
import java.util.List;
import net.pterodactylus.sone.data.PostReply;
import net.pterodactylus.sone.data.Profile;
import net.pterodactylus.sone.data.Profile.Field;
-import net.pterodactylus.sone.data.Reply;
import net.pterodactylus.sone.data.Sone;
import net.pterodactylus.sone.freenet.SimpleFieldSetBuilder;
import net.pterodactylus.sone.freenet.fcp.AbstractCommand;
import net.pterodactylus.sone.freenet.fcp.Command;
import net.pterodactylus.sone.freenet.fcp.FcpException;
import net.pterodactylus.sone.template.SoneAccessor;
-import net.pterodactylus.util.collection.filter.Filters;
+
import freenet.node.FSParseException;
import freenet.support.SimpleFieldSet;
+import com.google.common.base.Optional;
+
/**
* Abstract base implementation of a {@link Command} with Sone-related helper
* methods.
* The text to encode
* @return The encoded text
*/
- protected String encodeString(String text) {
- return text.replaceAll("\\\\", "\\\\").replaceAll("\n", "\\\\n").replaceAll("\r", "\\\\r");
+ protected static String encodeString(String text) {
+ return text.replaceAll("\\\\", "\\\\\\\\").replaceAll("\n", "\\\\n").replaceAll("\r", "\\\\r");
}
- /**
- * Returns a Sone whose ID is a parameter in the given simple field set.
- *
- * @param simpleFieldSet
- * The simple field set containing the ID of the Sone
- * @param parameterName
- * The name under which the Sone ID is stored in the simple field
- * set
- * @param localOnly
- * {@code true} to only return local Sones, {@code false} to
- * return any Sones
- * @return The Sone
- * @throws FcpException
- * if there is no Sone ID stored under the given parameter name,
- * or if the Sone ID is invalid
- */
- protected Sone getSone(SimpleFieldSet simpleFieldSet, String parameterName, boolean localOnly) throws FcpException {
- return getSone(simpleFieldSet, parameterName, localOnly, true);
+ protected Optional<Sone> getOptionalSone(SimpleFieldSet simpleFieldSet, String parameterName) throws FcpException {
+ String soneId = getString(simpleFieldSet, parameterName, null);
+ return (soneId == null) ? Optional.<Sone>absent() : core.getSone(soneId);
}
- /**
- * Returns a Sone whose ID is a parameter in the given simple field set.
- *
- * @param simpleFieldSet
- * The simple field set containing the ID of the Sone
- * @param parameterName
- * The name under which the Sone ID is stored in the simple field
- * set
- * @param localOnly
- * {@code true} to only return local Sones, {@code false} to
- * return any Sones
- * @param mandatory
- * {@code true} if a valid Sone ID is required, {@code false}
- * otherwise
- * @return The Sone, or {@code null} if {@code mandatory} is {@code false}
- * and the Sone ID is invalid
- * @throws FcpException
- * if there is no Sone ID stored under the given parameter name,
- * or if {@code mandatory} is {@code true} and the Sone ID is
- * invalid
- */
- protected Sone getSone(SimpleFieldSet simpleFieldSet, String parameterName, boolean localOnly, boolean mandatory) throws FcpException {
- String soneId = simpleFieldSet.get(parameterName);
- if (mandatory && (soneId == null)) {
- throw new FcpException("Could not load Sone ID from “" + parameterName + "”.");
+ protected Sone getMandatoryLocalSone(SimpleFieldSet simpleFieldSet, String parameterName) throws FcpException {
+ Sone sone = getMandatorySone(simpleFieldSet, parameterName);
+ if (!sone.isLocal()) {
+ throw new FcpException("Could not load Sone from “" + sone.getId() + "”.");
}
- Sone sone = localOnly ? core.getLocalSone(soneId, false) : core.getSone(soneId, false);
- if (mandatory && (sone == null)) {
+ return sone;
+ }
+
+ protected Sone getMandatorySone(SimpleFieldSet simpleFieldSet, String parameterName) throws FcpException {
+ String soneId = getMandatoryParameter(simpleFieldSet, parameterName);
+ Optional<Sone> sone = getMandatorySone(soneId);
+ return sone.get();
+ }
+
+ private Optional<Sone> getMandatorySone(String soneId) throws FcpException {
+ Optional<Sone> sone = core.getSone(soneId);
+ if (!sone.isPresent()) {
throw new FcpException("Could not load Sone from “" + soneId + "”.");
}
return sone;
}
+ private String getMandatoryParameter(SimpleFieldSet simpleFieldSet, String parameterName) throws FcpException {
+ String soneId = simpleFieldSet.get(parameterName);
+ if (soneId == null) {
+ throw new FcpException("Could not load Sone ID from “" + parameterName + "”.");
+ }
+ return soneId;
+ }
+
/**
* Returns a post whose ID is a parameter in the given simple field set.
*
protected Post getPost(SimpleFieldSet simpleFieldSet, String parameterName) throws FcpException {
try {
String postId = simpleFieldSet.getString(parameterName);
- Post post = core.getPost(postId, false);
- if (post == null) {
+ Optional<Post> post = core.getDatabase().getPost(postId);
+ if (!post.isPresent()) {
throw new FcpException("Could not load post from “" + postId + "”.");
}
- return post;
+ return post.get();
} catch (FSParseException fspe1) {
throw new FcpException("Could not post ID from “" + parameterName + "”.", fspe1);
}
protected PostReply getReply(SimpleFieldSet simpleFieldSet, String parameterName) throws FcpException {
try {
String replyId = simpleFieldSet.getString(parameterName);
- PostReply reply = core.getReply(replyId, false);
- if (reply == null) {
+ Optional<PostReply> reply = core.getDatabase().getPostReply(replyId);
+ if (!reply.isPresent()) {
throw new FcpException("Could not load reply from “" + replyId + "”.");
}
- return reply;
+ return reply.get();
} catch (FSParseException fspe1) {
throw new FcpException("Could not reply ID from “" + parameterName + "”.", fspe1);
}
* such as if the Sone is followed by the local Sone
* @return The simple field set containing the given Sone
*/
- protected SimpleFieldSet encodeSone(Sone sone, String prefix, Sone localSone) {
+ protected static SimpleFieldSet encodeSone(Sone sone, String prefix, Optional<Sone> localSone) {
SimpleFieldSetBuilder soneBuilder = new SimpleFieldSetBuilder();
soneBuilder.put(prefix + "Name", sone.getName());
soneBuilder.put(prefix + "NiceName", SoneAccessor.getNiceName(sone));
soneBuilder.put(prefix + "LastUpdated", sone.getTime());
- if (localSone != null) {
- soneBuilder.put(prefix + "Followed", String.valueOf(localSone.hasFriend(sone.getId())));
+ if (localSone.isPresent()) {
+ soneBuilder.put(prefix + "Followed", String.valueOf(localSone.get().hasFriend(sone.getId())));
}
Profile profile = sone.getProfile();
soneBuilder.put(prefix + "Field.Count", profile.getFields().size());
* {@code null})
* @return The simple field set containing the given Sones
*/
- protected SimpleFieldSet encodeSones(Collection<? extends Sone> sones, String prefix) {
+ protected static SimpleFieldSet encodeSones(Collection<? extends Sone> sones, String prefix) {
SimpleFieldSetBuilder soneBuilder = new SimpleFieldSetBuilder();
int soneIndex = 0;
return soneBuilder.get();
}
- /**
- * Creates a simple field set from the given post.
- *
- * @param post
- * The post to encode
- * @param prefix
- * The prefix for the field names (may be empty but not
- * {@code null})
- * @param includeReplies
- * {@code true} to include replies, {@code false} to not include
- * replies
- * @return The simple field set containing the post
- */
- protected SimpleFieldSet encodePost(Post post, String prefix, boolean includeReplies) {
+ protected SimpleFieldSet encodePost(Post post, String prefix) {
+ return createPostBuilderFromPost(post, prefix).get();
+ }
+
+ protected SimpleFieldSet encodePostWithReplies(Post post, String prefix) {
+ SimpleFieldSetBuilder postBuilder = createPostBuilderFromPost(post, prefix);
+
+ List<PostReply> replies = from(post.getReplies()).filter(FUTURE_REPLY_FILTER).toList();
+ postBuilder.put(encodeReplies(replies, prefix));
+
+ return postBuilder.get();
+ }
+
+ private SimpleFieldSetBuilder createPostBuilderFromPost(Post post, String prefix) {
SimpleFieldSetBuilder postBuilder = new SimpleFieldSetBuilder();
postBuilder.put(prefix + "ID", post.getId());
postBuilder.put(prefix + "Sone", post.getSone().getId());
- if (post.getRecipient() != null) {
- postBuilder.put(prefix + "Recipient", post.getRecipient().getId());
+ if (post.getRecipientId().isPresent()) {
+ postBuilder.put(prefix + "Recipient", post.getRecipientId().get());
}
postBuilder.put(prefix + "Time", post.getTime());
postBuilder.put(prefix + "Text", encodeString(post.getText()));
postBuilder.put(encodeLikes(core.getLikes(post), prefix + "Likes."));
- if (includeReplies) {
- List<PostReply> replies = core.getReplies(post);
- postBuilder.put(encodeReplies(replies, prefix));
- }
+ return postBuilder;
+ }
+
+ protected SimpleFieldSet encodePosts(Collection<? extends Post> posts, String prefix) {
+ SimpleFieldSetBuilder postBuilder = createPostBuilderFromPosts(posts, prefix);
return postBuilder.get();
}
- /**
- * Creates a simple field set from the given collection of posts.
- *
- * @param posts
- * The posts to encode
- * @param prefix
- * The prefix for the field names (may be empty but not
- * {@code null})
- * @param includeReplies
- * {@code true} to include the replies, {@code false} to not
- * include the replies
- * @return The simple field set containing the posts
- */
- protected SimpleFieldSet encodePosts(Collection<? extends Post> posts, String prefix, boolean includeReplies) {
+ private SimpleFieldSetBuilder createPostBuilderFromPosts(Collection<? extends Post> posts, String prefix) {
SimpleFieldSetBuilder postBuilder = new SimpleFieldSetBuilder();
int postIndex = 0;
postBuilder.put(prefix + "Count", posts.size());
for (Post post : posts) {
String postPrefix = prefix + postIndex++;
- postBuilder.put(encodePost(post, postPrefix + ".", includeReplies));
- if (includeReplies) {
- postBuilder.put(encodeReplies(Filters.filteredList(core.getReplies(post), Reply.FUTURE_REPLY_FILTER), postPrefix + "."));
- }
+ postBuilder.put(encodePost(post, postPrefix + "."));
+ }
+
+ return postBuilder;
+ }
+
+ protected SimpleFieldSet encodePostsWithReplies(Collection<? extends Post> posts, String prefix) {
+ SimpleFieldSetBuilder postBuilder = createPostBuilderFromPosts(posts, prefix);
+
+ int postIndex = 0;
+ for (Post post : posts) {
+ String postPrefix = prefix + postIndex++;
+ postBuilder.put(encodeReplies(from(post.getReplies()).filter(FUTURE_REPLY_FILTER).toList(), postPrefix + "."));
}
return postBuilder.get();
* {@code null})
* @return The simple field set containing the replies
*/
- protected SimpleFieldSet encodeReplies(Collection<? extends PostReply> replies, String prefix) {
+ protected static SimpleFieldSet encodeReplies(Collection<? extends PostReply> replies, String prefix) {
SimpleFieldSetBuilder replyBuilder = new SimpleFieldSetBuilder();
int replyIndex = 0;
* {@code null})
* @return The simple field set containing the likes
*/
- protected SimpleFieldSet encodeLikes(Collection<? extends Sone> likes, String prefix) {
+ protected static SimpleFieldSet encodeLikes(Collection<? extends Sone> likes, String prefix) {
SimpleFieldSetBuilder likesBuilder = new SimpleFieldSetBuilder();
int likeIndex = 0;
// OBJECT METHODS
//
- /**
- * {@inheritDoc}
- */
@Override
public String toString() {
return getClass().getName() + "[writeAccess=" + writeAccess + "]";
projects / Sone.git / blobdiff