X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Ffcp%2FAbstractSoneCommand.java;h=1294b4356ab40df16c558b665c2e7449c6644667;hb=689c7065471aedd7f3830e012bb82ca8a0fa697d;hp=fccb6f2a0945527dce7db3f7177fc9f6da745064;hpb=59e855811302ed0dc79f668e65c95f19e67b7c04;p=Sone.git diff --git a/src/main/java/net/pterodactylus/sone/fcp/AbstractSoneCommand.java b/src/main/java/net/pterodactylus/sone/fcp/AbstractSoneCommand.java index fccb6f2..1294b43 100644 --- a/src/main/java/net/pterodactylus/sone/fcp/AbstractSoneCommand.java +++ b/src/main/java/net/pterodactylus/sone/fcp/AbstractSoneCommand.java @@ -44,6 +44,9 @@ public abstract class AbstractSoneCommand extends AbstractCommand { /** The Sone core. */ private final Core core; + /** Whether this command needs write access. */ + private final boolean writeAccess; + /** * Creates a new abstract Sone FCP command. * @@ -51,7 +54,21 @@ public abstract class AbstractSoneCommand extends AbstractCommand { * The Sone core */ protected AbstractSoneCommand(Core core) { + this(core, false); + } + + /** + * Creates a new abstract Sone FCP command. + * + * @param core + * The Sone core + * @param writeAccess + * {@code true} if this command requires write access, + * {@code false} otherwise + */ + protected AbstractSoneCommand(Core core, boolean writeAccess) { this.core = core; + this.writeAccess = writeAccess; } // @@ -67,11 +84,34 @@ public abstract class AbstractSoneCommand extends AbstractCommand { return core; } + /** + * Returns whether this command requires write access. + * + * @return {@code true} if this command require write access, {@code false} + * otherwise + */ + public boolean requiresWriteAccess() { + return writeAccess; + } + // // PROTECTED METHODS // /** + * Encodes text in a way that makes it possible for the text to be stored in + * a {@link SimpleFieldSet}. Backslashes, CR, and LF are prepended with a + * backslash. + * + * @param text + * The text to encode + * @return The encoded text + */ + protected 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 @@ -79,22 +119,49 @@ public abstract class AbstractSoneCommand extends AbstractCommand { * @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) throws FcpException { - try { - String soneId = simpleFieldSet.getString(parameterName); - Sone sone = core.getSone(soneId, false); - if (sone == null) { - throw new FcpException("Could not load Sone from “" + soneId + "”."); - } - return sone; - } catch (FSParseException fspe1) { - throw new FcpException("Could not load Sone ID from “" + parameterName + "”.", fspe1); + protected Sone getSone(SimpleFieldSet simpleFieldSet, String parameterName, boolean localOnly) throws FcpException { + return getSone(simpleFieldSet, parameterName, localOnly, true); + } + + /** + * 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 + "”."); + } + Sone sone = localOnly ? core.getLocalSone(soneId, false) : core.getSone(soneId, false); + if (mandatory && (sone == null)) { + throw new FcpException("Could not load Sone from “" + soneId + "”."); } + return sone; } /** @@ -124,6 +191,32 @@ public abstract class AbstractSoneCommand extends AbstractCommand { } /** + * Returns a reply whose ID is a parameter in the given simple field set. + * + * @param simpleFieldSet + * The simple field set containing the ID of the reply + * @param parameterName + * The name under which the reply ID is stored in the simple + * field set + * @return The reply + * @throws FcpException + * if there is no reply ID stored under the given parameter + * name, or if the reply ID is invalid + */ + protected Reply getReply(SimpleFieldSet simpleFieldSet, String parameterName) throws FcpException { + try { + String replyId = simpleFieldSet.getString(parameterName); + Reply reply = core.getReply(replyId, false); + if (reply == null) { + throw new FcpException("Could not load reply from “" + replyId + "”."); + } + return reply; + } catch (FSParseException fspe1) { + throw new FcpException("Could not reply ID from “" + parameterName + "”.", fspe1); + } + } + + /** * Creates a simple field set from the given collection of Sones. * * @param sones @@ -139,11 +232,11 @@ public abstract class AbstractSoneCommand extends AbstractCommand { int soneIndex = 0; soneBuilder.put(prefix + "Count", sones.size()); for (Sone sone : sones) { - String sonePrefix = prefix + soneIndex++; - soneBuilder.put(sonePrefix + ".ID", sone.getId()); - soneBuilder.put(sonePrefix + ".Name", sone.getName()); - soneBuilder.put(sonePrefix + ".NiceName", SoneAccessor.getNiceName(sone)); - soneBuilder.put(sonePrefix + ".Time", sone.getTime()); + String sonePrefix = prefix + soneIndex++ + "."; + soneBuilder.put(sonePrefix + "ID", sone.getId()); + soneBuilder.put(sonePrefix + "Name", sone.getName()); + soneBuilder.put(sonePrefix + "NiceName", SoneAccessor.getNiceName(sone)); + soneBuilder.put(sonePrefix + "Time", sone.getTime()); } return soneBuilder.get(); @@ -171,7 +264,8 @@ public abstract class AbstractSoneCommand extends AbstractCommand { postBuilder.put(prefix + "Recipient", post.getRecipient().getId()); } postBuilder.put(prefix + "Time", post.getTime()); - postBuilder.put(prefix + "Text", post.getText()); + postBuilder.put(prefix + "Text", encodeString(post.getText())); + postBuilder.put(encodeLikes(core.getLikes(post), prefix + "Likes.")); if (includeReplies) { List replies = core.getReplies(post); @@ -226,14 +320,50 @@ public abstract class AbstractSoneCommand extends AbstractCommand { int replyIndex = 0; replyBuilder.put(prefix + "Replies.Count", replies.size()); for (Reply reply : replies) { - String replyPrefix = prefix + "Replies." + replyIndex++; - replyBuilder.put(replyPrefix + ".ID", reply.getId()); - replyBuilder.put(replyPrefix + ".Sone", reply.getSone().getId()); - replyBuilder.put(replyPrefix + ".Time", reply.getTime()); - replyBuilder.put(replyPrefix + ".Text", reply.getText()); + String replyPrefix = prefix + "Replies." + replyIndex++ + "."; + replyBuilder.put(replyPrefix + "ID", reply.getId()); + replyBuilder.put(replyPrefix + "Sone", reply.getSone().getId()); + replyBuilder.put(replyPrefix + "Time", reply.getTime()); + replyBuilder.put(replyPrefix + "Text", encodeString(reply.getText())); } return replyBuilder.get(); } + /** + * Creates a simple field set from the given collection of Sones that like + * an element. + * + * @param likes + * The liking Sones + * @param prefix + * The prefix for the field names (may be empty but not + * {@code null}) + * @return The simple field set containing the likes + */ + protected SimpleFieldSet encodeLikes(Collection likes, String prefix) { + SimpleFieldSetBuilder likesBuilder = new SimpleFieldSetBuilder(); + + int likeIndex = 0; + likesBuilder.put(prefix + "Count", likes.size()); + for (Sone sone : likes) { + String sonePrefix = prefix + likeIndex++ + "."; + likesBuilder.put(sonePrefix + "ID", sone.getId()); + } + + return likesBuilder.get(); + } + + // + // OBJECT METHODS + // + + /** + * {@inheritDoc} + */ + @Override + public String toString() { + return getClass().getName() + "[writeAccess=" + writeAccess + "]"; + } + }