Override Object.toString().

[Sone.git] / src / main / java / net / pterodactylus / sone / fcp / AbstractSoneCommand.java

diff --git a/src/main/java/net/pterodactylus/sone/fcp/AbstractSoneCommand.java b/src/main/java/net/pterodactylus/sone/fcp/AbstractSoneCommand.java
index b183121..5b146c8 100644 (file)
--- 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 + "”.");
                        }
@@ -197,7 +240,7 @@ 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) {
@@ -257,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();
@@ -287,4 +330,16 @@ public abstract class AbstractSoneCommand extends AbstractCommand {
                return likesBuilder.get();
        }
 
+       //
+       // OBJECT METHODS
+       //
+
+       /**
+        * {@inheritDoc}
+        */
+       @Override
+       public String toString() {
+               return getClass().getName() + "[writeAccess=" + writeAccess + "]";
+       }
+
 }