Update Node API.

Author: smelamud

pom.xml

@@ -5,7 +5,7 @@
 
     <groupId>org.moera</groupId>
     <artifactId>moeralib</artifactId>
-    <version>0.18.2</version>
+    <version>0.18.3</version>
 
     <name>moeralib</name>
     <description>Java library to interact with Moera decentralized social network</description>

src/main/java/org/moera/lib/node/MoeraNode.java

@@ -1309,15 +1309,18 @@ public PrivateMediaFileInfo uploadPrivateMedia(
      * size, but the best in quality variant of the media, according to the width provided
      * @param download if <code>true</code>, the node will add <code>Content-Disposition: attachment</code> header to
      * the output
+     * @param ignoremalware if <code>true</code>, the node will ignore malware detection and return the media file;
+     * only admin may use this option
      * @param responseConsumer consumer of the data received
      */
     public void getPrivateMedia(
-        String id, Integer width, Boolean download, ResponseConsumer responseConsumer
+        String id, Integer width, Boolean download, Boolean ignoremalware, ResponseConsumer responseConsumer
     ) throws MoeraNodeException {
         var location = "/media/private/%s/data".formatted(ue(id));
         var params = new QueryParam[] {
             QueryParam.of("width", width),
-            QueryParam.of("download", download)
+            QueryParam.of("download", download),
+            QueryParam.of("ignoremalware", ignoremalware)
         };
         call(location, params, "GET", null, responseConsumer);
     }
@@ -1334,6 +1337,21 @@ public PrivateMediaFileInfo getPrivateMediaInfo(String id) throws MoeraNodeExcep
         return call(location, null, "GET", null, returnTypeRef);
     }
 
+    /**
+     * Update media file details.
+     *
+     * @param id media file ID
+     * @param attributes attributes
+     * @return PrivateMediaFileInfo
+     */
+    public PrivateMediaFileInfo updatePrivateMediaInfo(
+        String id, PrivateMediaFileAttributes attributes
+    ) throws MoeraNodeException {
+        var location = "/media/private/%s/info".formatted(ue(id));
+        var returnTypeRef = new TypeReference<PrivateMediaFileInfo>() {};
+        return call(location, null, "PUT", attributes, returnTypeRef);
+    }
+
     /**
      * Get the list of all postings and comments the media file is attached to.
      *
@@ -2218,6 +2236,19 @@ public AsyncOperationCreated verifyRemoteCommentReaction(
         return call(location, null, "POST", Collections.emptyMap(), returnTypeRef);
     }
 
+    /**
+     * Download the private media file from the remote node and store it at the home node.
+     *
+     * @param nodeName name of the remote node
+     * @param id id of the media file
+     * @return PrivateMediaFileInfo
+     */
+    public PrivateMediaFileInfo downloadRemoteMedia(String nodeName, String id) throws MoeraNodeException {
+        var location = "/nodes/%s/media/private/%s/download".formatted(ue(nodeName), ue(id));
+        var returnTypeRef = new TypeReference<PrivateMediaFileInfo>() {};
+        return call(location, null, "POST", Collections.emptyMap(), returnTypeRef);
+    }
+
     /**
      * Add a posting to the remote node and register it in the registry at the local node.
      *

src/main/java/org/moera/lib/node/types/PrivateMediaFileAttributes.java

@@ -0,0 +1,51 @@
+package org.moera.lib.node.types;
+
+// This file is generated
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import org.moera.lib.node.types.validate.ValidationUtil;
+
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class PrivateMediaFileAttributes extends Structure implements Cloneable {
+
+    private String title;
+
+    /**
+     * Retrieves title of the media file, may be used as an alternative to the file name.
+     *
+     * @return the value
+     */
+    public String getTitle() {
+        return title;
+    }
+
+    /**
+     * Sets title of the media file, may be used as an alternative to the file name.
+     *
+     * @param title the value to be set
+     */
+    public void setTitle(String title) {
+        this.title = title;
+    }
+
+    @Override
+    public void validate() {
+        super.validate();
+        ValidationUtil.maxSize(title, 255, "media.title.wrong-size");
+    }
+
+    /**
+     * Creates and returns a copy of this {@code PrivateMediaFileAttributes} object.
+     *
+     * @return a clone of this instance
+     */
+    @Override
+    public PrivateMediaFileAttributes clone() {
+        try {
+            return (PrivateMediaFileAttributes) super.clone();
+        } catch (CloneNotSupportedException e) {
+            throw new IllegalArgumentException("Must implement Cloneable", e);
+        }
+    }
+
+}

src/main/java/org/moera/lib/node/types/PrivateMediaFileInfo.java

@@ -19,9 +19,12 @@ public class PrivateMediaFileInfo extends Structure implements Cloneable {
     private Integer height;
     private Short orientation;
     private long size;
+    private String title;
     private String textContent;
     private String postingId;
     private List<MediaFilePreviewInfo> previews;
+    private Boolean attachment;
+    private Boolean malware;
     private PrivateMediaFileOperations operations;
 
     /**
@@ -218,6 +221,24 @@ public void setSize(long size) {
         this.size = size;
     }
 
+    /**
+     * Retrieves title of the media file, may be used as an alternative to the file name.
+     *
+     * @return the value
+     */
+    public String getTitle() {
+        return title;
+    }
+
+    /**
+     * Sets title of the media file, may be used as an alternative to the file name.
+     *
+     * @param title the value to be set
+     */
+    public void setTitle(String title) {
+        this.title = title;
+    }
+
     /**
      * Retrieves the text contained in the image, if any.
      *
@@ -272,6 +293,49 @@ public void setPreviews(List<MediaFilePreviewInfo> previews) {
         this.previews = previews;
     }
 
+    /**
+     * Retrieves <code>true</code> if the media cannot be displayed as an image or video and should be displayed as an
+     * attachment instead, <code>false</code> (default) otherwise
+     * .
+     *
+     * @return the value
+     */
+    public Boolean getAttachment() {
+        return attachment;
+    }
+
+    /**
+     * Sets <code>true</code> if the media cannot be displayed as an image or video and should be displayed as an
+     * attachment instead, <code>false</code> (default) otherwise
+     * .
+     *
+     * @param attachment the value to be set
+     */
+    public void setAttachment(Boolean attachment) {
+        this.attachment = attachment;
+    }
+
+    /**
+     * Retrieves <code>true</code> if the media file is considered to be malware, <code>false</code> (default)
+     * otherwise
+     * .
+     *
+     * @return the value
+     */
+    public Boolean getMalware() {
+        return malware;
+    }
+
+    /**
+     * Sets <code>true</code> if the media file is considered to be malware, <code>false</code> (default) otherwise
+     * .
+     *
+     * @param malware the value to be set
+     */
+    public void setMalware(Boolean malware) {
+        this.malware = malware;
+    }
+
     /**
      * Retrieves the supported operations and the corresponding principals.
      *

src/main/java/org/moera/lib/node/types/PrivateMediaFileOperations.java

@@ -12,6 +12,7 @@
 public class PrivateMediaFileOperations implements Cloneable {
 
     private Principal view;
+    private Principal edit;
 
     /**
      * Retrieves the permission to view the media file.
@@ -67,14 +68,69 @@ public void setView(Principal view, Principal defaultValue) {
         this.view = Objects.equals(view, defaultValue) ? null : view;
     }
 
+    /**
+     * Retrieves the permission to edit the media file attributes.
+     * If {@code null}, the default permission is in effect.
+     *
+     * @return the permission, may be {@code null}
+     */
+    public Principal getEdit() {
+        return edit;
+    }
+
+    /**
+     * Retrieves the permission to edit the media file attributes,
+     * or {@code defaultValue} if the permission is {@code null}.
+     *
+     * @param defaultValue the default permission
+     * @return the permission
+     */
+    public Principal getEdit(Principal defaultValue) {
+        return edit != null ? edit : defaultValue;
+    }
+
+    /**
+     * Retrieves the permission to edit the media file attributes,
+     * or {@code defaultValue} if {@code operations} is {@code null} or the permission is {@code null}.
+     *
+     * @param operations permissions data
+     * @param defaultValue the default permission
+     * @return the permission
+     */
+    public static Principal getEdit(PrivateMediaFileOperations operations, Principal defaultValue) {
+        return operations != null ? operations.getEdit(defaultValue) : defaultValue;
+    }
+
+    /**
+     * Sets the permission to edit the media file attributes.
+     * If set to {@code null}, the default permission should be used.
+     *
+     * @param edit the permission to set, may be {@code null}
+     */
+    public void setEdit(Principal edit) {
+        this.edit = edit;
+    }
+
+    /**
+     * Sets the permission to edit the media file attributes.
+     * If the value is equal to {@code defaultValue}, the permission is set to {@code null}.
+     *
+     * @param edit the permission to set
+     * @param defaultValue the default permission
+     */
+    public void setEdit(Principal edit, Principal defaultValue) {
+        this.edit = Objects.equals(edit, defaultValue) ? null : edit;
+    }
+
     /**
      * Checks if all the permissions in the object are {@code null}.
      *
      * @return {@code true} if all the permissions are {@code null}, {@code false} otherwise.
      */
     @JsonIgnore
     public boolean isEmpty() {
-        return view == null;
+        return view == null
+            && edit == null;
     }
 
     /**

src/main/java/org/moera/lib/node/types/RemoteMedia.java

@@ -10,6 +10,8 @@ public class RemoteMedia extends Structure implements Cloneable {
     private String id;
     private String hash;
     private String digest;
+    private String mimeType;
+    private Boolean attachment;
 
     /**
      * Retrieves ID of the media file.
@@ -65,6 +67,46 @@ public void setDigest(String digest) {
         this.digest = digest;
     }
 
+    /**
+     * Retrieves MIME type of the media.
+     *
+     * @return the value
+     */
+    public String getMimeType() {
+        return mimeType;
+    }
+
+    /**
+     * Sets MIME type of the media.
+     *
+     * @param mimeType the value to be set
+     */
+    public void setMimeType(String mimeType) {
+        this.mimeType = mimeType;
+    }
+
+    /**
+     * Retrieves <code>true</code> if the media cannot be displayed as an image or video and should be displayed as an
+     * attachment instead, <code>false</code> (default) otherwise
+     * .
+     *
+     * @return the value
+     */
+    public Boolean getAttachment() {
+        return attachment;
+    }
+
+    /**
+     * Sets <code>true</code> if the media cannot be displayed as an image or video and should be displayed as an
+     * attachment instead, <code>false</code> (default) otherwise
+     * .
+     *
+     * @param attachment the value to be set
+     */
+    public void setAttachment(Boolean attachment) {
+        this.attachment = attachment;
+    }
+
     /**
      * Creates and returns a copy of this {@code RemoteMedia} object.
      *