X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Ffcp%2FAbstractSoneCommand.java;h=d88872ee9b2d83ad9698ab9c6f12951d665480ed;hb=0df5e91852f737d760c5a9f54c5667309fbadcc2;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..d88872e 100644 --- a/src/main/java/net/pterodactylus/sone/fcp/AbstractSoneCommand.java +++ b/src/main/java/net/pterodactylus/sone/fcp/AbstractSoneCommand.java @@ -22,8 +22,10 @@ import java.util.List; import net.pterodactylus.sone.core.Core; import net.pterodactylus.sone.data.Post; +import net.pterodactylus.sone.data.Profile; import net.pterodactylus.sone.data.Reply; import net.pterodactylus.sone.data.Sone; +import net.pterodactylus.sone.data.Profile.Field; import net.pterodactylus.sone.freenet.SimpleFieldSetBuilder; import net.pterodactylus.sone.freenet.fcp.AbstractCommand; import net.pterodactylus.sone.freenet.fcp.Command; @@ -44,6 +46,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 +56,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 +86,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 +121,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 +193,67 @@ 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 Sone, including {@link Profile} + * information. + * + * @param sone + * The Sone to encode + * @param prefix + * The prefix for the field names (may be empty but not {@code + * null}) + * @param localSone + * An optional local Sone that is used for Sone-specific data, + * 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) { + 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()))); + } + Profile profile = sone.getProfile(); + soneBuilder.put(prefix + "Field.Count", profile.getFields().size()); + int fieldIndex = 0; + for (Field field : profile.getFields()) { + soneBuilder.put(prefix + "Field." + fieldIndex + ".Name", field.getName()); + soneBuilder.put(prefix + "Field." + fieldIndex + ".Value", field.getValue()); + ++fieldIndex; + } + + return soneBuilder.get(); + } + + /** * Creates a simple field set from the given collection of Sones. * * @param sones @@ -171,7 +301,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 +361,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 +391,16 @@ public abstract class AbstractSoneCommand extends AbstractCommand { return likesBuilder.get(); } + // + // OBJECT METHODS + // + + /** + * {@inheritDoc} + */ + @Override + public String toString() { + return getClass().getName() + "[writeAccess=" + writeAccess + "]"; + } + }