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.util.Calendar;
21
22 import org.apache.commons.net.ftp.FTPFile;
23
24 /**
25 * Parser for the Connect Enterprise Unix FTP Server From Sterling Commerce. Here is a sample of the sort of output line this parser processes:
26 *
27 * <pre>
28 * "-C--E-----FTP B QUA1I1 18128 41 Aug 12 13:56 QUADTEST"
29 * </pre>
30 * <p>
31 * Note: EnterpriseUnixFTPEntryParser can only be instantiated through the DefaultFTPParserFactory by classname. It will not be chosen by the autodetection
32 * scheme.
33 * </p>
34 *
35 * @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions)
36 * @see org.apache.commons.net.ftp.parser.DefaultFTPFileEntryParserFactory
37 */
38 public class EnterpriseUnixFTPEntryParser extends RegexFTPFileEntryParserImpl {
39
40 /**
41 * months abbreviations looked for by this parser. Also used to determine <b>which</b> month has been matched by the parser.
42 */
43 private static final String MONTHS = "(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)";
44
45 /**
46 * this is the regular expression used by this parser.
47 */
48 private static final String REGEX = "(([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z])"
49 + "([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z]))" + "(\\S*)\\s*" // 12
50 + "(\\S+)\\s*" // 13
51 + "(\\S*)\\s*" // 14 user
52 + "(\\d*)\\s*" // 15 group
53 + "(\\d*)\\s*" // 16 filesize
54 + MONTHS // 17 month
55 + "\\s*" // TODO should the space be optional?
56 // TODO \\d* should be \\d? surely ? Otherwise 01111 is allowed
57 + "((?:[012]\\d*)|(?:3[01]))\\s*" // 18 date [012]\d* or 3[01]
58 + "((\\d\\d\\d\\d)|((?:[01]\\d)|(?:2[0123])):([012345]\\d))\\s"
59 // 20 \d\d\d\d = year OR
60 // 21 [01]\d or 2[0123] hour + ':'
61 // 22 [012345]\d = minute
62 + "(\\S*)(\\s*.*)"; // 23 name
63
64 /**
65 * The sole constructor for a EnterpriseUnixFTPEntryParser object.
66 *
67 */
68 public EnterpriseUnixFTPEntryParser() {
69 super(REGEX);
70 }
71
72 /**
73 * Parses a line of a unix FTP server file listing and converts it into a usable format in the form of an <code> FTPFile </code> instance. If the file
74 * listing line doesn't describe a file, <code> null </code> is returned, otherwise a <code> FTPFile </code> instance representing the files in the
75 * directory is returned.
76 *
77 * @param entry A line of text from the file listing
78 * @return An FTPFile instance corresponding to the supplied entry
79 */
80 @Override
81 public FTPFile parseFTPEntry(final String entry) {
82
83 final FTPFile file = new FTPFile();
84 file.setRawListing(entry);
85
86 if (matches(entry)) {
87 final String usr = group(14);
88 final String grp = group(15);
89 final String filesize = group(16);
90 final String mo = group(17);
91 final String da = group(18);
92 final String yr = group(20);
93 final String hr = group(21);
94 final String min = group(22);
95 final String name = group(23);
96
97 file.setType(FTPFile.FILE_TYPE);
98 file.setUser(usr);
99 file.setGroup(grp);
100 try {
101 file.setSize(Long.parseLong(filesize));
102 } catch (final NumberFormatException e) {
103 // intentionally do nothing
104 }
105
106 final Calendar cal = Calendar.getInstance();
107 cal.set(Calendar.MILLISECOND, 0);
108 cal.set(Calendar.SECOND, 0);
109 cal.set(Calendar.MINUTE, 0);
110 cal.set(Calendar.HOUR_OF_DAY, 0);
111
112 final int pos = MONTHS.indexOf(mo);
113 final int month = pos / 4;
114 final int missingUnit; // the first missing unit
115 try {
116
117 if (yr != null) {
118 // it's a year; there are no hours and minutes
119 cal.set(Calendar.YEAR, Integer.parseInt(yr));
120 missingUnit = Calendar.HOUR_OF_DAY;
121 } else {
122 // it must be hour/minute, or we wouldn't have matched
123 missingUnit = Calendar.SECOND;
124 int year = cal.get(Calendar.YEAR);
125
126 // if the month we're reading is greater than now, it must
127 // be last year
128 if (cal.get(Calendar.MONTH) < month) {
129 year--;
130 }
131 cal.set(Calendar.YEAR, year);
132 cal.set(Calendar.HOUR_OF_DAY, Integer.parseInt(hr));
133 cal.set(Calendar.MINUTE, Integer.parseInt(min));
134 }
135 cal.set(Calendar.MONTH, month);
136 cal.set(Calendar.DAY_OF_MONTH, Integer.parseInt(da));
137 cal.clear(missingUnit);
138 file.setTimestamp(cal);
139 } catch (final NumberFormatException e) {
140 // do nothing, date will be uninitialized
141 }
142 file.setName(name);
143
144 return file;
145 }
146 return null;
147 }
148 }