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