/* An actor that produces an array that lists the contents of a directory.

   @Copyright (c) 2003-2014 The Regents of the University of California.
   All rights reserved.

   Permission is hereby granted, without written agreement and without
   license or royalty fees, to use, copy, modify, and distribute this
   software and its documentation for any purpose, provided that the
   above copyright notice and the following two paragraphs appear in all
   copies of this software.

   IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
   FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
   ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
   THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGE.

   THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
   PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
   CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
   ENHANCEMENTS, OR MODIFICATIONS.

   PT_COPYRIGHT_VERSION 2
   COPYRIGHTENDKEY
 */
package ptolemy.actor.lib.io;

import java.io.BufferedReader;
import java.io.File;
import java.io.FilenameFilter;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.URLConnection;
import java.net.URLDecoder;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.StringTokenizer;

import ptolemy.actor.lib.SequenceSource;
import ptolemy.actor.parameters.FilePortParameter;
import ptolemy.data.ArrayToken;
import ptolemy.data.BooleanToken;
import ptolemy.data.StringToken;
import ptolemy.data.expr.Parameter;
import ptolemy.data.expr.StringParameter;
import ptolemy.data.type.ArrayType;
import ptolemy.data.type.BaseType;
import ptolemy.kernel.CompositeEntity;
import ptolemy.kernel.util.Attribute;
import ptolemy.kernel.util.IllegalActionException;
import ptolemy.kernel.util.NameDuplicationException;
import ptolemy.util.RecursiveFileFilter;

///////////////////////////////////////////////////////////////////
//// DirectoryListing

/**
 <p>Given a URL or directory name, this actor produces an array of file names
 in that directory that match an (optional) pattern.  The file names
 include the complete path, unless <i>relative</i> is set to true, in which case,
 the names are relative to the directory. The pattern is
 a regular expression. For a reference on regular expression syntax see:
 <a href="http://download.oracle.com/javase/tutorial/essential/regex/#in_browser">
 http://download.oracle.com/javase/tutorial/essential/regex/</a>
 </p><p>
 If <i>directoryOrURL</i> is a local directory (not a URL), then you can
 optionally list only contained files or directories.
 If <i>listOnlyDirectories</i> is true, then only directories will be
 listed on the output.  If <i>listOnlyFiles</i> is true, then only
 files will be listed on the output. If both are true, then an exception
 is thrown.
 </p><p>
 If <i>directoryOrURL</i> is a URL, then this actor assumes that the
 server will list the contents of the referenced directory in an
 HTML file where each file listed will have the following form:
 <pre>
 &lt;a href="filename"&gt;filename&lt;/a&gt;
 </pre>
 If the filename is longer than 20 characters, then only the first
 20 characters of the two appearances of the filename are compared,
 since some servers truncate the file names.
 </p><p>
 If <i>allowEmptyDirectory</i> controls whether reading an empty directory
 will throw an exception.
 </p><p>Note that DirectoryListing returns the contents of the directory
 in a different order depending on whether one is using the Sun JVM
 or the IBM JVM.  Thus, you may want to connect the output to an
 ArraySort actor.</p>

 @author  Christopher Hylands, Edward A. Lee, Contributor: Jianwu Wang
 @version $Id: DirectoryListing.java 70402 2014-10-23 00:52:20Z cxh $
 @since Ptolemy II 4.0
 @Pt.ProposedRating Yellow (eal)
 @Pt.AcceptedRating Red (liuj)
 */
public class DirectoryListing extends SequenceSource implements FilenameFilter {
    /** Construct an actor with the given container and name.
     *  @param container The container.
     *  @param name The name of this actor.
     *  @exception IllegalActionException If the actor cannot be contained
     *   by the proposed container.
     *  @exception NameDuplicationException If the container already has an
     *   actor with this name.
     */
    public DirectoryListing(CompositeEntity container, String name)
            throws IllegalActionException, NameDuplicationException {
        super(container, name);

        // Tell the file browser to allow only selection of directories.
        directoryOrURL = new FilePortParameter(this, "directoryOrURL");
        new Parameter(directoryOrURL, "allowFiles", BooleanToken.FALSE);
        new Parameter(directoryOrURL, "allowDirectories", BooleanToken.TRUE);

        output.setTypeEquals(new ArrayType(BaseType.STRING));

        pattern = new StringParameter(this, "pattern");
        pattern.setExpression("");

        listOnlyDirectories = new Parameter(this, "listOnlyDirectories");
        listOnlyDirectories.setTypeEquals(BaseType.BOOLEAN);
        listOnlyDirectories.setExpression("false");

        listOnlyFiles = new Parameter(this, "listOnlyFiles");
        listOnlyFiles.setTypeEquals(BaseType.BOOLEAN);
        listOnlyFiles.setExpression("false");

        allowEmptyDirectory = new Parameter(this, "allowEmptyDirectory");
        allowEmptyDirectory.setTypeEquals(BaseType.BOOLEAN);
        allowEmptyDirectory.setExpression("false");

        // Show the firingCountLimit parameter last.
        firingCountLimit.moveToLast();

        recursive = new Parameter(this, "recursive");
        recursive.setTypeEquals(BaseType.BOOLEAN);
        recursive.setExpression("false");

        relative = new Parameter(this, "relative");
        relative.setTypeEquals(BaseType.BOOLEAN);
        relative.setExpression("false");
    }

    ///////////////////////////////////////////////////////////////////
    ////                     ports and parameters                  ////

    /** The directory name or URL from which to read.  This is a string with
     *  any form accepted by {@link ptolemy.actor.parameters.FilePortParameter}.
     *  By default, this is empty. An empty string is equivalent to specifying
     *  "$CWD", the current working directory.
     */
    public FilePortParameter directoryOrURL;

    /** If true, and <i>directoryOrURL</i> refers to a local directory (not a URL),
     *  then only directories will be listed on the output. If <i>directoryOrURL</i>
     *  is a URL, then this parameter is ignored (there appears to be no reliable
     *  way to tell whether the URL refers to a directory or file).
     *  This is a boolean that defaults to false.
     */
    public Parameter listOnlyDirectories;

    /** If true, and <i>directoryOrURL</i> refers to a local directory (not a URL),
     *  then only files will be listed on the output. If <i>directoryOrURL</i>
     *  is a URL, then this parameter is ignored (there appears to be no reliable
     *  way to tell whether the URL refers to a directory or file).
     *  This is a boolean that defaults to false.
     */
    public Parameter listOnlyFiles;

    /** If true, and <i>directoryOrURL</i> refers to a local directory
     *  (not a URL), that is empty, then the output will be empty
     *  string array and no exception is reported. If
     *  <i>directoryOrURL</i> is a URL, then this parameter is ignored
     *  (there appears to be no reliable way to tell whether the URL
     *  refers to a directory or file).  This is a boolean that
     *  defaults to false.
     */
    public Parameter allowEmptyDirectory;

    /** If non-empty, then only output file and directory names that
     *  match the specified (regular expression) pattern.
     *  The default value of this parameter is the empty String "",
     *  which indicates that everything matches.
     */
    public StringParameter pattern;

    /** Whether files in the subdirectories should be searched as well.
     *  The recursive parameter only works if <i>directoryOrURL</i>
     *  refers to a local directory (not a URL).
     *  This is a boolean that defaults to false.
     */
    public Parameter recursive;

    /** If true, then produce an array with file names relative to the
     *  specified directory. This is a boolean that defaults to false,
     *  which causes the absolute (complete) path to be produced.
     */
    public Parameter relative;

    ///////////////////////////////////////////////////////////////////
    ////                         public methods                    ////

    /** Return true if the specified name matches the specified pattern,
     *  or if no pattern has been specified.
     *  @param directory The directory in which the file was found
     *   (ignored, but required by the FilenameFilter interface).
     *  @param name The name of the file or directory.
     *  @return True if the specified name matches.
     */
    @Override
    public boolean accept(File directory, String name) {
        // The accept() method is here primarily for backward
        // compatibility as the DirectoryList class implements
        // FileFilter.  It could be thet Kepler is using this.
        if (_recursiveFileFilter == null) {
            _recursiveFileFilter = new RecursiveFileFilter(_recursive,
                    true /*includeFiles*/, true /*includeDirectories*/,
                    _listOnlyFiles, _listOnlyDirectories, _pattern, false /*escape*/);
        }
        return _recursiveFileFilter.accept(directory, name);
    }

    /** Override the base class to locally cache parameter values.
     *  @param attribute The attribute that has changed.
     *  @exception IllegalActionException If the specified attribute
     *   is <i>URL</i> and the file cannot be opened.
     */
    @Override
    public void attributeChanged(Attribute attribute)
            throws IllegalActionException {
        // Parameter values are cached to avoid code duplication.
        if (attribute == pattern) {
            _pattern = pattern.stringValue();
        } else if (attribute == listOnlyDirectories) {
            _listOnlyDirectories = ((BooleanToken) listOnlyDirectories
                    .getToken()).booleanValue();
        } else if (attribute == listOnlyFiles) {
            _listOnlyFiles = ((BooleanToken) listOnlyFiles.getToken())
                    .booleanValue();
        } else if (attribute == recursive) {
            _recursive = ((BooleanToken) recursive.getToken()).booleanValue();
        } else {
            super.attributeChanged(attribute);
        }
    }

    /** Output an array containing file and/or directory names.
     *  @exception IllegalActionException If there's no director or
     *   if the directory or URL is invalid.
     */
    @Override
    public void fire() throws IllegalActionException {
        super.fire();

        directoryOrURL.update();

        URL sourceURL = directoryOrURL.asURL();

        if (sourceURL == null) {
            // Nothing was specified. Default to the current working directory.
            directoryOrURL.setExpression("$CWD");
            sourceURL = directoryOrURL.asURL();
            if (sourceURL == null) {
                throw new IllegalActionException(this,
                        "Cannot determine current working directory.");
            }
        }

        boolean emptyDirectoryAllow = ((BooleanToken) allowEmptyDirectory
                .getToken()).booleanValue();

        if (sourceURL.getProtocol().equals("file")) {
            File sourceFile = directoryOrURL.asFile();

            if (sourceFile.isDirectory()) {
                if (_debugging) {
                    _debug("Reading directory.");
                }

                File[] listedFiles = RecursiveFileFilter.listFiles(sourceFile,
                        _recursive, true /*includeFiles*/,
                        true /*includeDirectories*/, _listOnlyFiles,
                        _listOnlyDirectories, _pattern, false /*escape*/);

                ArrayList<StringToken> result = new ArrayList<StringToken>();
                for (File file : listedFiles) {

                    String path = file.getAbsolutePath();
                    if (((BooleanToken) relative.getToken()).booleanValue()) {
                        // Strip off the directory name and trailing slash.
                        int slash = 1;
                        String directoryName = sourceFile.getAbsolutePath();
                        if (directoryName.endsWith("/")) {
                            slash = 0;
                        }
                        path = path.substring(directoryName.length() + slash);
                    }

                    if (_debugging) {
                        _debug("Path: " + path);
                    }

                    result.add(new StringToken(path));
                }

                if (!emptyDirectoryAllow) {
                    if (result.size() == 0) {
                        throw new IllegalActionException(this,
                                "No files or directories that match the pattern.");
                    }
                }

                StringToken[] resultArray = new StringToken[result.size()];

                for (int i = 0; i < resultArray.length; i++) {
                    resultArray[i] = result.get(i);
                }

                output.broadcast(new ArrayToken(BaseType.STRING, resultArray));
            } else if (sourceFile.isFile()) {
                StringToken[] result = new StringToken[1];
                result[0] = new StringToken(sourceFile.toString());

                if (_debugging) {
                    _debug("Listing just the specified file: "
                            + result[0].stringValue());
                }

                output.broadcast(new ArrayToken(BaseType.STRING, result));
            } else {
                throw new IllegalActionException("'" + directoryOrURL
                        + "' is neither a file " + "nor a directory.");
            }
        } else {
            try {
                _readURL(sourceURL);
            } catch (IOException ex) {
                throw new IllegalActionException(this, ex,
                        "Error reading the URL \'" + directoryOrURL + "\'.");
            }
        }
    }

    ///////////////////////////////////////////////////////////////////
    ////                         private methods                   ////

    /** Read the URL and produce output.
     *  @param sourceURL The source URL.
     */
    private void _readURL(URL sourceURL) throws IOException,
    IllegalActionException {
        // Handle urls here.
        if (_debugging) {
            _debug("Reading URL: " + sourceURL);
        }

        List<StringToken> resultsList = new LinkedList<StringToken>();

        URLConnection urlConnection = sourceURL.openConnection();
        String contentType = urlConnection.getContentType();

        if (!contentType.startsWith("text/html")
                && !contentType.startsWith("text/plain")) {
            if (!sourceURL.toString().startsWith("jar:")) {
                throw new IllegalActionException(this, "Could not parse '"
                        + directoryOrURL.stringValue() + "'; as URL '"
                        + sourceURL + "', it is not \"text/html\", "
                        + "or \"text/plain\", it is: "
                        + urlConnection.getContentType());
            } else {
                // Reading from a directory from a jar file.

                if (_recursiveFileFilter == null) {
                    _recursiveFileFilter = new RecursiveFileFilter(_recursive,
                            true /*includeFiles*/,
                            true /*includeDirectories*/, _listOnlyFiles,
                            _listOnlyDirectories, _pattern, false /*escape*/);
                }

                // Every thing after the !/
                String path = sourceURL.getPath().substring(
                        sourceURL.getPath().indexOf("!/") + 2);

                // Get rid of the jar:file and read up to the !
                String jarPath = sourceURL.getPath().substring(5,
                        sourceURL.getPath().indexOf("!"));
                JarFile jar = new JarFile(URLDecoder.decode(jarPath, "UTF-8"));

                Enumeration<JarEntry> entries = jar.entries();
                while (entries.hasMoreElements()) {
                    String name = entries.nextElement().getName();
                    if (name.startsWith(path)) {
                        String entry = name.substring(path.length());
                        int slashIndex = entry.indexOf("/");
                        if (slashIndex >= 0) {
                            entry = entry.substring(0, slashIndex);
                        }

                        // FIXME: recursion on URLs not yet supported.
                        if (_recursiveFileFilter.accept(null, entry)) {
                            StringToken results = new StringToken(entry);
                            // Add the results here if it is not present.
                            // We want to preserve the order, otherwise we could
                            // use a Set.
                            if (!resultsList.contains(results)) {
                                resultsList.add(results);
                            }
                        }
                    }
                }
            }
        } else {

            BufferedReader in = null;
            try {
                in = new BufferedReader(new InputStreamReader(
                        urlConnection.getInputStream()));

                if (!contentType.startsWith("text/plain")
                        && !urlConnection.getURL().toString().endsWith("/")) {
                    // text/plain urls need not end with /, but
                    // text/html urls _must_ end with / since the web server
                    // will rewrite them for us.
                    throw new IllegalActionException(this, "Could not parse '"
                            + directoryOrURL.stringValue()
                            + "'; it needs to end with '/'");
                }

                // Parse the contents in a haphazard fashion.
                // The idea is that we look for the <BODY> line and
                // then look for lines that contain HREF
                // If we find a line like HREF="foo">foo, then we report
                // foo as being a file.
                // A more robust way would be to use a spider, see
                // http://www.acme.com/java/software/WebList.html
                String line;
                String target = null;
                boolean sawBody = false;
                boolean sawHREF = false;

                while ((line = in.readLine()) != null) {
                    line = line.trim();

                    if (_debugging) {
                        _debug(line);
                    }

                    if (line.startsWith("<BODY") || line.startsWith("<body")) {
                        if (_debugging) {
                            _debug("Saw Body tag");
                        }
                        sawBody = true;
                    } else {
                        if (sawBody) {
                            StringTokenizer tokenizer = new StringTokenizer(
                                    line, "<\" >=");

                            while (tokenizer.hasMoreTokens()) {
                                String token = tokenizer.nextToken();

                                if (token.compareToIgnoreCase("HREF") == 0) {
                                    if (_debugging) {
                                        _debug("Saw HREF");
                                    }
                                    sawHREF = true;
                                    target = null;
                                } else {
                                    if (sawHREF) {
                                        if (target == null) {
                                            // FIXME: Here, we should check that target
                                            // is a relative pathname.
                                            target = token;
                                        } else {
                                            // Check to see whether the first 20
                                            // characters of the token are
                                            // the same as the last token.
                                            String reference = target;

                                            if (reference.length() > 20) {
                                                reference = target.substring(0,
                                                        20);
                                            }

                                            if (!token.startsWith(reference)) {
                                                if (_debugging) {
                                                    _debug("token \""
                                                            + token
                                                            + "\" does not start with href.");
                                                }
                                                sawHREF = false;
                                            } else {
                                                // Having the first argument be null causes
                                                // accept to determine if target is a file or
                                                // directory by checking for a trailing /.
                                                if (accept(null, target)) {
                                                    if (_debugging) {
                                                        _debug("target \""
                                                                + token
                                                                + "\" was accepted.");
                                                    }

                                                    // Make sure directoryOrURL ends with a slash.
                                                    String base = directoryOrURL
                                                            .stringValue();

                                                    if (!base.endsWith("/")) {
                                                        base = base + "/";
                                                    }

                                                    // FIXME: Is there any way to tell whether
                                                    // the result is a directory or file?
                                                    resultsList
                                                            .add(new StringToken(
                                                                    base
                                                                            + target));
                                                } else {
                                                    if (_debugging) {
                                                        _debug("target \""
                                                                + token
                                                                + "\" was not accepted.");
                                                    }
                                                }

                                                sawHREF = false;
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            } finally {
                if (in != null) {
                    in.close();
                }
            }
        }

        if (_debugging) {
            _debug("----- end of listing.");
            _debug("----- extracted results:");

            Iterator results = resultsList.iterator();

            while (results.hasNext()) {
                _debug(((StringToken) results.next()).stringValue());
            }
        }

        StringToken[] results = new StringToken[resultsList.size()];
        output.broadcast(new ArrayToken(BaseType.STRING,
                resultsList.toArray(results)));
    }

    ///////////////////////////////////////////////////////////////////
    ////                         private members                   ////

    /** Cached value of listOnlyDirectories parameter. */
    private boolean _listOnlyDirectories;

    /** Cached value of listOnlyFiles parameter. */
    private boolean _listOnlyFiles;

    /** Cached value of patternparameter. */
    private String _pattern;

    /** Cached value of recursive parameter. */
    private boolean _recursive;

    /** RecursiveFileFilter used by the accept() method of this class. */
    private RecursiveFileFilter _recursiveFileFilter;
}