OS2FTPEntryParser.java

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * The ASF licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *      https://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */

  17. package org.apache.commons.net.ftp.parser;

  18. import java.text.ParseException;

  19. import org.apache.commons.net.ftp.Configurable;
  20. import org.apache.commons.net.ftp.FTPClientConfig;
  21. import org.apache.commons.net.ftp.FTPFile;
  22. import org.apache.commons.net.ftp.FTPFileEntryParser;

  23. /**
  24.  * Implements of {@link FTPFileEntryParser} and {@link Configurable} for OS/2 Systems.
  25.  *
  26.  * @see FTPFileEntryParser Usage instructions.
  27.  */
  28. public class OS2FTPEntryParser extends ConfigurableFTPFileEntryParserImpl {

  29.     private static final String DEFAULT_DATE_FORMAT = "MM-dd-yy HH:mm"; // 11-09-01 12:30
  30.     /**
  31.      * this is the regular expression used by this parser.
  32.      */
  33.     private static final String REGEX = "\\s*([0-9]+)\\s*" + "(\\s+|[A-Z]+)\\s*" + "(DIR|\\s+)\\s*" + "(\\S+)\\s+(\\S+)\\s+" /* date stuff */
  34.             + "(\\S.*)";

  35.     /**
  36.      * Constructs a new instance.
  37.      *
  38.      * @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not be seen under normal conditions. If it is seen, this is a
  39.      *                                  sign that {@code REGEX} is not a valid regular expression.
  40.      */
  41.     public OS2FTPEntryParser() {
  42.         this(null);
  43.     }

  44.     /**
  45.      * Constructs a new instance with something other than the default configuration.
  46.      *
  47.      * @param config The {@link FTPClientConfig configuration} object used to configure this parser.
  48.      * @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not be seen under normal conditions. If it is seen, this is a
  49.      *                                  sign that {@code REGEX} is not a valid regular expression.
  50.      * @since 1.4
  51.      */
  52.     public OS2FTPEntryParser(final FTPClientConfig config) {
  53.         super(REGEX);
  54.         configure(config);
  55.     }

  56.     /**
  57.      * Gets a new default configuration to be used when this class is instantiated without a {@link FTPClientConfig FTPClientConfig} parameter being specified.
  58.      *
  59.      * @return the default configuration for this parser.
  60.      */
  61.     @Override
  62.     protected FTPClientConfig getDefaultConfiguration() {
  63.         return new FTPClientConfig(FTPClientConfig.SYST_OS2, DEFAULT_DATE_FORMAT, null);
  64.     }

  65.     /**
  66.      * Parses a line of an OS2 FTP server file listing and converts it into a usable format in the form of an {@code FTPFile} instance. If the file
  67.      * listing line doesn't describe a file, {@code null} is returned, otherwise a {@code FTPFile} instance representing the files in the
  68.      * directory is returned.
  69.      *
  70.      * @param entry A line of text from the file listing
  71.      * @return An FTPFile instance corresponding to the supplied entry
  72.      */
  73.     @Override
  74.     public FTPFile parseFTPEntry(final String entry) {

  75.         final FTPFile f = new FTPFile();
  76.         if (matches(entry)) {
  77.             final String size = group(1);
  78.             final String attrib = group(2);
  79.             final String dirString = group(3);
  80.             final String datestr = group(4) + " " + group(5);
  81.             final String name = group(6);
  82.             try {
  83.                 f.setTimestamp(super.parseTimestamp(datestr));
  84.             } catch (final ParseException e) {
  85.                 // intentionally do nothing
  86.             }

  87.             // is it a DIR or a file
  88.             if (dirString.trim().equals("DIR") || attrib.trim().equals("DIR")) {
  89.                 f.setType(FTPFile.DIRECTORY_TYPE);
  90.             } else {
  91.                 f.setType(FTPFile.FILE_TYPE);
  92.             }

  93.             // set the name
  94.             f.setName(name.trim());

  95.             // set the size
  96.             f.setSize(Long.parseLong(size.trim()));

  97.             return f;
  98.         }
  99.         return null;

  100.     }

  101. }