View Javadoc
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    *      http://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  
18  package org.apache.commons.net.ftp.parser;
19  
20  import java.text.ParseException;
21  
22  import org.apache.commons.net.ftp.Configurable;
23  import org.apache.commons.net.ftp.FTPClientConfig;
24  import org.apache.commons.net.ftp.FTPFile;
25  import org.apache.commons.net.ftp.FTPFileEntryParser;
26  
27  /**
28   * Implements of {@link FTPFileEntryParser} and {@link Configurable} for OS/2 Systems.
29   *
30   * @see FTPFileEntryParser Usage instructions.
31   */
32  public class OS2FTPEntryParser extends ConfigurableFTPFileEntryParserImpl
33  
34  {
35  
36      private static final String DEFAULT_DATE_FORMAT = "MM-dd-yy HH:mm"; // 11-09-01 12:30
37      /**
38       * this is the regular expression used by this parser.
39       */
40      private static final String REGEX = "\\s*([0-9]+)\\s*" + "(\\s+|[A-Z]+)\\s*" + "(DIR|\\s+)\\s*" + "(\\S+)\\s+(\\S+)\\s+" /* date stuff */
41              + "(\\S.*)";
42  
43      /**
44       * The default constructor for a OS2FTPEntryParser object.
45       *
46       * @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not be seen under normal conditions. If it is seen, this is a
47       *                                  sign that <code>REGEX</code> is not a valid regular expression.
48       */
49      public OS2FTPEntryParser() {
50          this(null);
51      }
52  
53      /**
54       * This constructor allows the creation of an OS2FTPEntryParser object with something other than the default configuration.
55       *
56       * @param config The {@link FTPClientConfig configuration} object used to configure this parser.
57       * @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not be seen under normal conditions. If it is seen, this is a
58       *                                  sign that <code>REGEX</code> is not a valid regular expression.
59       * @since 1.4
60       */
61      public OS2FTPEntryParser(final FTPClientConfig config) {
62          super(REGEX);
63          configure(config);
64      }
65  
66      /**
67       * Defines a default configuration to be used when this class is instantiated without a {@link FTPClientConfig FTPClientConfig} parameter being specified.
68       *
69       * @return the default configuration for this parser.
70       */
71      @Override
72      protected FTPClientConfig getDefaultConfiguration() {
73          return new FTPClientConfig(FTPClientConfig.SYST_OS2, DEFAULT_DATE_FORMAT, null);
74      }
75  
76      /**
77       * Parses a line of an OS2 FTP server file listing and converts it into a usable format in the form of an <code>FTPFile</code> instance. If the file
78       * listing line doesn't describe a file, <code>null</code> is returned, otherwise a <code>FTPFile</code> instance representing the files in the
79       * directory is returned.
80       *
81       * @param entry A line of text from the file listing
82       * @return An FTPFile instance corresponding to the supplied entry
83       */
84      @Override
85      public FTPFile parseFTPEntry(final String entry) {
86  
87          final FTPFile f = new FTPFile();
88          if (matches(entry)) {
89              final String size = group(1);
90              final String attrib = group(2);
91              final String dirString = group(3);
92              final String datestr = group(4) + " " + group(5);
93              final String name = group(6);
94              try {
95                  f.setTimestamp(super.parseTimestamp(datestr));
96              } catch (final ParseException e) {
97                  // intentionally do nothing
98              }
99  
100             // is it a DIR or a file
101             if (dirString.trim().equals("DIR") || attrib.trim().equals("DIR")) {
102                 f.setType(FTPFile.DIRECTORY_TYPE);
103             } else {
104                 f.setType(FTPFile.FILE_TYPE);
105             }
106 
107             // set the name
108             f.setName(name.trim());
109 
110             // set the size
111             f.setSize(Long.parseLong(size.trim()));
112 
113             return f;
114         }
115         return null;
116 
117     }
118 
119 }