001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      https://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.net.ftp.parser;
019
020import java.util.Calendar;
021
022import org.apache.commons.net.ftp.FTPFile;
023
024/**
025 * Parser for the Connect Enterprise Unix FTP Server From Sterling Commerce. Here is a sample of the sort of output line this parser processes:
026 *
027 * <pre>
028 * "-C--E-----FTP B QUA1I1      18128       41 Aug 12 13:56 QUADTEST"
029 * </pre>
030 * <p>
031 * Note: EnterpriseUnixFTPEntryParser can only be instantiated through the DefaultFTPParserFactory by class name. It will not be chosen by the autodetection
032 * scheme.
033 * </p>
034 *
035 * @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions)
036 * @see org.apache.commons.net.ftp.parser.DefaultFTPFileEntryParserFactory
037 */
038public class EnterpriseUnixFTPEntryParser extends RegexFTPFileEntryParserImpl {
039
040    /**
041     * months abbreviations looked for by this parser. Also used to determine <strong>which</strong> month has been matched by the parser.
042     */
043    private static final String MONTHS = "(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)";
044
045    /**
046     * this is the regular expression used by this parser.
047     */
048    // @formatter:off
049    private static final String REGEX = "(([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z])"
050            + "([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z]))"
051            + "(\\S*)\\s*" // 12
052            + "(\\S+)\\s*" // 13
053            + "(\\S*)\\s*" // 14 user
054            + "(\\d*)\\s*" // 15 group
055            + "(\\d*)\\s*" // 16 file size
056            + MONTHS // 17 month
057            + "\\s*" // TODO should the space be optional?
058            // TODO \\d* should be \\d? surely ? Otherwise 01111 is allowed
059            + "((?:[012]\\d*)|(?:3[01]))\\s*" // 18 date [012]\d* or 3[01]
060            + "((\\d\\d\\d\\d)|((?:[01]\\d)|(?:2[0123])):([012345]\\d))\\s"
061            // 20 \d\d\d\d = year OR
062            // 21 [01]\d or 2[0123] hour + ':'
063            // 22 [012345]\d = minute
064            + "(\\S*)(\\s*.*)"; // 23 name
065    // @formatter:on
066
067    /**
068     * The sole constructor for a EnterpriseUnixFTPEntryParser object.
069     */
070    public EnterpriseUnixFTPEntryParser() {
071        super(REGEX);
072    }
073
074    /**
075     * Parses a line of a Unix FTP server file listing and converts it into a usable format in the form of an {@code FTPFile} instance. If the file
076     * listing line doesn't describe a file, {@code null} is returned, otherwise a {@code FTPFile} instance representing the files in the
077     * directory is returned.
078     *
079     * @param entry A line of text from the file listing
080     * @return An FTPFile instance corresponding to the supplied entry
081     */
082    @Override
083    public FTPFile parseFTPEntry(final String entry) {
084
085        final FTPFile file = new FTPFile();
086        file.setRawListing(entry);
087
088        if (matches(entry)) {
089            final String usr = group(14);
090            final String grp = group(15);
091            final String fileSize = group(16);
092            final String mo = group(17);
093            final String da = group(18);
094            final String yr = group(20);
095            final String hr = group(21);
096            final String min = group(22);
097            final String name = group(23);
098
099            file.setType(FTPFile.FILE_TYPE);
100            file.setUser(usr);
101            file.setGroup(grp);
102            try {
103                file.setSize(Long.parseLong(fileSize));
104            } catch (final NumberFormatException e) {
105                // intentionally do nothing
106            }
107
108            final Calendar cal = Calendar.getInstance();
109            cal.set(Calendar.MILLISECOND, 0);
110            cal.set(Calendar.SECOND, 0);
111            cal.set(Calendar.MINUTE, 0);
112            cal.set(Calendar.HOUR_OF_DAY, 0);
113
114            final int pos = MONTHS.indexOf(mo);
115            final int month = pos / 4;
116            final int missingUnit; // the first missing unit
117            try {
118
119                if (yr != null) {
120                    // it's a year; there are no hours and minutes
121                    cal.set(Calendar.YEAR, Integer.parseInt(yr));
122                    missingUnit = Calendar.HOUR_OF_DAY;
123                } else {
124                    // it must be hour/minute, or we wouldn't have matched
125                    missingUnit = Calendar.SECOND;
126                    int year = cal.get(Calendar.YEAR);
127
128                    // if the month we're reading is greater than now, it must
129                    // be last year
130                    if (cal.get(Calendar.MONTH) < month) {
131                        year--;
132                    }
133                    cal.set(Calendar.YEAR, year);
134                    cal.set(Calendar.HOUR_OF_DAY, Integer.parseInt(hr));
135                    cal.set(Calendar.MINUTE, Integer.parseInt(min));
136                }
137                cal.set(Calendar.MONTH, month);
138                cal.set(Calendar.DAY_OF_MONTH, Integer.parseInt(da));
139                cal.clear(missingUnit);
140                file.setTimestamp(cal);
141            } catch (final NumberFormatException e) {
142                // do nothing, date will be uninitialized
143            }
144            file.setName(name);
145
146            return file;
147        }
148        return null;
149    }
150}