package org.unix4j.unix.ls;

import java.util.List;
import java.util.Map;
import java.util.Arrays;

import org.unix4j.command.Arguments;
import org.unix4j.context.ExecutionContext;
import org.unix4j.convert.ValueConverter;
import org.unix4j.option.DefaultOptionSet;
import org.unix4j.util.ArgsUtil;
import org.unix4j.util.ArrayUtil;
import org.unix4j.variable.Arg;
import org.unix4j.variable.VariableContext;

import org.unix4j.unix.Ls;

/**
 * Arguments and options for the {@link Ls ls} command.
 */
public final class LsArguments implements Arguments<LsArguments> {
        
        private final LsOptions options;

        
        // operand: <files>
        private java.io.File[] files;
        private boolean filesIsSet = false;
        
        // operand: <paths>
        private String[] paths;
        private boolean pathsIsSet = false;
        
        // operand: <args>
        private String[] args;
        private boolean argsIsSet = false;
        
        /**
         * Constructor to use if no options are specified.
         */
        public LsArguments() {
                this.options = LsOptions.EMPTY;
        }

        /**
         * Constructor with option set containing the selected command options.
         * 
         * @param options the selected options
         * @throws NullPointerException if the argument is null
         */
        public LsArguments(LsOptions options) {
                if (options == null) {
                        throw new NullPointerException("options argument cannot be null");
                }
                this.options = options;
        }
        
        /**
         * Returns the options set containing the selected command options. Returns
         * an empty options set if no option has been selected.
         * 
         * @return set with the selected options
         */
        public LsOptions getOptions() {
                return options;
        }

        /**
         * Constructor string arguments encoding options and arguments, possibly
         * also containing variable expressions. 
         * 
         * @param args string arguments for the command
         * @throws NullPointerException if args is null
         */
        public LsArguments(String... args) {
                this();
                this.args = args;
                this.argsIsSet = true;
        }
        private Object[] resolveVariables(VariableContext context, String... unresolved) {
                final Object[] resolved = new Object[unresolved.length];
                for (int i = 0; i < resolved.length; i++) {
                        final String expression = unresolved[i];
                        if (Arg.isVariable(expression)) {
                                resolved[i] = resolveVariable(context, expression);
                        } else {
                                resolved[i] = expression;
                        }
                }
                return resolved;
        }
        private <V> V convertList(ExecutionContext context, String operandName, Class<V> operandType, List<Object> values) {
                if (values.size() == 1) {
                        final Object value = values.get(0);
                        return convert(context, operandName, operandType, value);
                }
                return convert(context, operandName, operandType, values);
        }

        private Object resolveVariable(VariableContext context, String variable) {
                final Object value = context.getValue(variable);
                if (value != null) {
                        return value;
                }
                throw new IllegalArgumentException("cannot resolve variable " + variable + 
                                " in command: ls " + this);
        }
        private <V> V convert(ExecutionContext context, String operandName, Class<V> operandType, Object value) {
                final ValueConverter<V> converter = context.getValueConverterFor(operandType);
                final V convertedValue;
                if (converter != null) {
                        convertedValue = converter.convert(value);
                } else {
                        if (LsOptions.class.equals(operandType)) {
                                convertedValue = operandType.cast(LsOptions.CONVERTER.convert(value));
                        } else {
                                convertedValue = null;
                        }
                }
                if (convertedValue != null) {
                        return convertedValue;
                }
                throw new IllegalArgumentException("cannot convert --" + operandName + 
                                " value '" + value + "' into the type " + operandType.getName() + 
                                " for ls command");
        }
        
        @Override
        public LsArguments getForContext(ExecutionContext context) {
                if (context == null) {
                        throw new NullPointerException("context cannot be null");
                }
                if (!argsIsSet || args.length == 0) {
                        //nothing to resolve
                        return this;
                }

                //check if there is at least one variable
                boolean hasVariable = false;
                for (final String arg : args) {
                        if (arg != null && arg.startsWith("$")) {
                                hasVariable = true;
                                break;
                        }
                }
                //resolve variables
                final Object[] resolvedArgs = hasVariable ? resolveVariables(context.getVariableContext(), this.args) : this.args;
                
                //convert now
                final List<String> defaultOperands = Arrays.asList("paths");
                final Map<String, List<Object>> map = ArgsUtil.parseArgs("options", defaultOperands, resolvedArgs);
                final LsOptions.Default options = new LsOptions.Default();
                final LsArguments argsForContext = new LsArguments(options);
                for (final Map.Entry<String, List<Object>> e : map.entrySet()) {
                        if ("files".equals(e.getKey())) {
                                        
                                final java.io.File[] value = convertList(context, "files", java.io.File[].class, e.getValue());  
                                argsForContext.setFiles(value);
                        } else if ("paths".equals(e.getKey())) {
                                        
                                final String[] value = convertList(context, "paths", String[].class, e.getValue());  
                                argsForContext.setPaths(value);
                        } else if ("args".equals(e.getKey())) {
                                throw new IllegalStateException("invalid operand '" + e.getKey() + "' in ls command args: " + Arrays.toString(args));
                        } else if ("options".equals(e.getKey())) {
                                        
                                final LsOptions value = convertList(context, "options", LsOptions.class, e.getValue());  
                                options.setAll(value);
                        } else {
                                throw new IllegalStateException("invalid operand '" + e.getKey() + "' in ls command args: " + Arrays.toString(args));
                        }
                }
                return argsForContext;
        }
        
        /**
         * Returns the {@code <files>} operand value: The files or directories used as starting point for the listing; 
                        relative paths are not resolved (use the string path argument to 
                        enable relative path resolving based on the current working 
                        directory).
         * 
         * @return the {@code <files>} operand value (variables are not resolved)
         * @throws IllegalStateException if this operand has never been set
         * 
         */
        public java.io.File[] getFiles() {
                if (filesIsSet) {
                        return files;
                }
                throw new IllegalStateException("operand has not been set: " + files);
        }

        /**
         * Returns true if the {@code <files>} operand has been set. 
         * <p>
         * Note that this method returns true even if {@code null} was passed to the
         * {@link #setFiles(java.io.File[])} method.
         * 
         * @return      true if the setter for the {@code <files>} operand has 
         *                      been called at least once
         */
        public boolean isFilesSet() {
                return filesIsSet;
        }
        /**
         * Sets {@code <files>}: The files or directories used as starting point for the listing; 
                        relative paths are not resolved (use the string path argument to 
                        enable relative path resolving based on the current working 
                        directory).
         * 
         * @param files the value for the {@code <files>} operand
         */
        public void setFiles(java.io.File... files) {
                this.files = files;
                this.filesIsSet = true;
        }
        /**
         * Returns the {@code <paths>} operand value: The files or directories used as starting point for the listing; 
                        wildcards * and ? are supported; relative paths are resolved on the
            basis of the current working directory.
         * 
         * @return the {@code <paths>} operand value (variables are not resolved)
         * @throws IllegalStateException if this operand has never been set
         * 
         */
        public String[] getPaths() {
                if (pathsIsSet) {
                        return paths;
                }
                throw new IllegalStateException("operand has not been set: " + paths);
        }

        /**
         * Returns true if the {@code <paths>} operand has been set. 
         * <p>
         * Note that this method returns true even if {@code null} was passed to the
         * {@link #setPaths(String[])} method.
         * 
         * @return      true if the setter for the {@code <paths>} operand has 
         *                      been called at least once
         */
        public boolean isPathsSet() {
                return pathsIsSet;
        }
        /**
         * Sets {@code <paths>}: The files or directories used as starting point for the listing; 
                        wildcards * and ? are supported; relative paths are resolved on the
            basis of the current working directory.
         * 
         * @param paths the value for the {@code <paths>} operand
         */
        public void setPaths(String... paths) {
                this.paths = paths;
                this.pathsIsSet = true;
        }
        /**
         * Returns the {@code <args>} operand value: String arguments defining the options and operands for the command. 
                        Options can be specified by acronym (with a leading dash "-") or by 
                        long name (with two leading dashes "--"). Operands other than the
                        default "--paths" operand have to be prefixed with the operand 
                        name (e.g. "--count" for a subsequent count operand value).
         * 
         * @return the {@code <args>} operand value (variables are not resolved)
         * @throws IllegalStateException if this operand has never been set
         * 
         */
        public String[] getArgs() {
                if (argsIsSet) {
                        return args;
                }
                throw new IllegalStateException("operand has not been set: " + args);
        }

        /**
         * Returns true if the {@code <args>} operand has been set. 
         * 
         * @return      true if the setter for the {@code <args>} operand has 
         *                      been called at least once
         */
        public boolean isArgsSet() {
                return argsIsSet;
        }
        
        /**
         * Returns true if the {@code --}{@link LsOption#allFiles allFiles} option
         * is set. The option is also known as {@code -}a option.
         * <p>
         * Description: Lists all files in the given directory, including hidden files
                        (those whose names start with \".\" in Unix). By default, these 
                        files are excluded from the list.
         * 
         * @return true if the {@code --allFiles} or {@code -a} option is set
         */
        public boolean isAllFiles() {
                return getOptions().isSet(LsOption.allFiles);
        }
        /**
         * Returns true if the {@code --}{@link LsOption#humanReadable humanReadable} option
         * is set. The option is also known as {@code -}h option.
         * <p>
         * Description: Print sizes in human readable format. (e.g., 1K, 234M, 2G, etc.)
         * 
         * @return true if the {@code --humanReadable} or {@code -h} option is set
         */
        public boolean isHumanReadable() {
                return getOptions().isSet(LsOption.humanReadable);
        }
        /**
         * Returns true if the {@code --}{@link LsOption#longFormat longFormat} option
         * is set. The option is also known as {@code -}l option.
         * <p>
         * Description: Long format, displaying file types, permissions, number of hard 
                        links, owner, group, size, date, and filename.
         * 
         * @return true if the {@code --longFormat} or {@code -l} option is set
         */
        public boolean isLongFormat() {
                return getOptions().isSet(LsOption.longFormat);
        }
        /**
         * Returns true if the {@code --}{@link LsOption#recurseSubdirs recurseSubdirs} option
         * is set. The option is also known as {@code -}R option.
         * <p>
         * Description: Recursively lists subdirectories encountered.
         * 
         * @return true if the {@code --recurseSubdirs} or {@code -R} option is set
         */
        public boolean isRecurseSubdirs() {
                return getOptions().isSet(LsOption.recurseSubdirs);
        }
        /**
         * Returns true if the {@code --}{@link LsOption#reverseOrder reverseOrder} option
         * is set. The option is also known as {@code -}r option.
         * <p>
         * Description: Reverses the order of the sort to get reverse collating sequence or 
                        oldest first.
         * 
         * @return true if the {@code --reverseOrder} or {@code -r} option is set
         */
        public boolean isReverseOrder() {
                return getOptions().isSet(LsOption.reverseOrder);
        }
        /**
         * Returns true if the {@code --}{@link LsOption#timeSorted timeSorted} option
         * is set. The option is also known as {@code -}t option.
         * <p>
         * Description: Sorts with the primary key being time modified (most recently 
                        modified first) and the secondary key being filename in the 
                        collating sequence.
         * 
         * @return true if the {@code --timeSorted} or {@code -t} option is set
         */
        public boolean isTimeSorted() {
                return getOptions().isSet(LsOption.timeSorted);
        }

        @Override
        public String toString() {
                // ok, we have options or arguments or both
                final StringBuilder sb = new StringBuilder();

                if (argsIsSet) {
                        for (String arg : args) {
                                if (sb.length() > 0) sb.append(' ');
                                sb.append(arg);
                        }
                } else {
                
                        // first the options
                        if (options.size() > 0) {
                                sb.append(DefaultOptionSet.toString(options));
                        }
                        // operand: <files>
                        if (filesIsSet) {
                                if (sb.length() > 0) sb.append(' ');
                                sb.append("--").append("files");
                                sb.append(" ").append(toString(getFiles()));
                        }
                        // operand: <paths>
                        if (pathsIsSet) {
                                if (sb.length() > 0) sb.append(' ');
                                sb.append("--").append("paths");
                                sb.append(" ").append(toString(getPaths()));
                        }
                        // operand: <args>
                        if (argsIsSet) {
                                if (sb.length() > 0) sb.append(' ');
                                sb.append("--").append("args");
                                sb.append(" ").append(toString(getArgs()));
                        }
                }
                
                return sb.toString();
        }
        private static String toString(Object value) {
                if (value != null && value.getClass().isArray()) {
                        return ArrayUtil.toString(value);
                }
                return String.valueOf(value);
        }
}