Files.java

/*
 * Copyright 2015 Synced Synapse. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.xbmc.kore.jsonrpc.method;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import org.xbmc.kore.jsonrpc.ApiException;
import org.xbmc.kore.jsonrpc.ApiMethod;
import org.xbmc.kore.jsonrpc.type.FilesType;
import org.xbmc.kore.jsonrpc.type.ItemType;
import org.xbmc.kore.jsonrpc.type.ListType;

import java.util.ArrayList;
import java.util.List;

/**
 * All JSON RPC methods in Files.*
 */
public class Files {

    /**
     * Prepare Download
     * Provides a way to download a given file (e.g. providing an URL to the real file location)
     */
    public static final class PrepareDownload extends ApiMethod<FilesType.PrepareDownloadReturnType> {
        public final static String METHOD_NAME = "Files.PrepareDownload";

        /**
         * Provides a way to download a given file (e.g. providing an URL to the real file location)
         */
        public PrepareDownload(String path) {
            super();
            addParameterToRequest("path", path);
        }

        @Override
        public String getMethodName() { return METHOD_NAME; }

        @Override
        public FilesType.PrepareDownloadReturnType resultFromJson(ObjectNode jsonObject) throws ApiException {
            return  new FilesType.PrepareDownloadReturnType(jsonObject.get(RESULT_NODE));
        }
    }

    /**
     * Enums for File.Media
     */
    public interface Media {
        public final static String VIDEO = "video";
        public final static String MUSIC = "music";
        public final static String PICTURES = "pictures";
        public final static String FILES =  "files";
        public final static String PROGRAMS =  "programs";
        public final static String[] allValues = new String[] {
                VIDEO, MUSIC, PICTURES, FILES, PROGRAMS
        };
    }

    /**
     * Files.GetSources command
     */
    public static final class GetSources extends ApiMethod<List<ItemType.Source>> {
        public final static String METHOD_NAME = "Files.GetSources";
        public final static String SOURCE_NODE = "sources";

        /**
         *
         * @param mediaType  See {@link Files.Media} for a
         *                   list of accepted values
         */
        public GetSources(String mediaType) {
            super();
            addParameterToRequest("media", mediaType);
        }

        @Override
        public String getMethodName() { return METHOD_NAME; }

        @Override
        public List<ItemType.Source> resultFromJson(ObjectNode jsonObject) throws ApiException {
            JsonNode resultNode = jsonObject.get(RESULT_NODE);
            ArrayNode items = resultNode.has(SOURCE_NODE) ?
                    (ArrayNode) resultNode.get(SOURCE_NODE) : null;
            if (items == null) {
                return new ArrayList<ItemType.Source>(0);
            }
            ArrayList<ItemType.Source> result = new ArrayList<ItemType.Source>(items.size());

            for (JsonNode item : items) {
                result.add(new ItemType.Source(item));
            }
            return result;
        }
    }

    /**
     * Files.GetDirectory command
     */
    public static final class GetDirectory extends ApiMethod<List<ListType.ItemFile>> {
        public final static String METHOD_NAME = "Files.GetDirectory";
        public final static String SORT_NODE = "sort";
        public final static String FILE_NODE = "files";

        /**
         * Get the directories and files in the given directory
         * @param directory          full path name
         * @param sort_params   sorting criteria
         */
        public GetDirectory(String directory, ListType.Sort sort_params) {
            super();
            addParameterToRequest("directory", directory);
            addParameterToRequest(SORT_NODE, sort_params.toJsonNode());
        }

        /**
         * Get the directories and files in the given directory
         * @param directory Full path name
         * @param media Type of media to retrieve.
         *              See {@link Files.Media} for a list of accepted values
         * @param sort_params Sorting criteria
         * @param properties Properties to retrieve.
         *                   See {@link org.xbmc.kore.jsonrpc.type.ListType.FieldsFiles}
         *                   constants for a list of accepted values
         */
        public GetDirectory(String directory, String media, ListType.Sort sort_params, String... properties) {
            super();
            addParameterToRequest("directory", directory);
            addParameterToRequest("media", media);
            addParameterToRequest("properties", properties);
            addParameterToRequest(SORT_NODE, sort_params.toJsonNode());
        }

        @Override
        public String getMethodName() { return METHOD_NAME; }

        @Override
        public List<ListType.ItemFile> resultFromJson(ObjectNode jsonObject) throws ApiException {
            JsonNode fileNode = jsonObject.get(RESULT_NODE)
                    .get(FILE_NODE);
            if (fileNode == null || fileNode.isNull()) {
                return new ArrayList<ListType.ItemFile>(0);
            }
            ArrayNode items = (ArrayNode) fileNode;
            ArrayList<ListType.ItemFile> result = new ArrayList<ListType.ItemFile>(items.size());
            for (JsonNode item : items) {
                String regex = "\\[.*?\\]";
                JsonNode label = item.get("label");
                if (!label.isNull()) {
                    String new_label = label.textValue().replaceAll(regex, "");
                    ((ObjectNode) item).put("label", new_label);
                }
                result.add(new ListType.ItemFile(item));
            }
            return result;
        }
    }
 }