X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Ffcp%2FAbstractSoneCommand.java;h=5b146c8fb55d8cdbf0881fc7f611bdbf7def9b20;hb=4e3ad16ce022e5842ef8e00e71583299445b5069;hp=8c4085cd15dcc8847407dfd5c9f662f5a53d1e4b;hpb=d7f274ad71b8768637d2bd412211a5d982e6fd36;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 8c4085c..5b146c8 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,15 +119,18 @@ 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 { + protected Sone getSone(SimpleFieldSet simpleFieldSet, String parameterName, boolean localOnly) throws FcpException { try { String soneId = simpleFieldSet.getString(parameterName); - Sone sone = core.getSone(soneId, false); + Sone sone = localOnly ? core.getLocalSone(soneId, false) : core.getSone(soneId, false); if (sone == null) { throw new FcpException("Could not load Sone from “" + soneId + "”."); } @@ -124,6 +167,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 @@ -171,7 +240,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); @@ -230,7 +300,7 @@ public abstract class AbstractSoneCommand extends AbstractCommand { 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()); + replyBuilder.put(replyPrefix + "Text", encodeString(reply.getText())); } return replyBuilder.get(); @@ -260,4 +330,16 @@ public abstract class AbstractSoneCommand extends AbstractCommand { return likesBuilder.get(); } + // + // OBJECT METHODS + // + + /** + * {@inheritDoc} + */ + @Override + public String toString() { + return getClass().getName() + "[writeAccess=" + writeAccess + "]"; + } + }