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 {@link FTPFileEntryParser} and {@link Configurable} for Netware Systems. Note that some proprietary extensions for Novell-specific operations
29   * are not supported. See <a href="http://www.novell.com/documentation/nw65/index.html?page=/documentation/nw65/ftp_enu/data/fbhbgcfa.html">
30   * http://www.novell.com/documentation/nw65/index.html?page=/documentation/nw65/ftp_enu/data/fbhbgcfa.html</a> for more details.
31   *
32   * @see FTPFileEntryParser Usage instructions.
33   * @since 1.5
34   */
35  public class NetwareFTPEntryParser extends ConfigurableFTPFileEntryParserImpl {
36  
37      /**
38       * Default date format is e.g. Feb 22 2006
39       */
40      private static final String DEFAULT_DATE_FORMAT = "MMM dd yyyy";
41  
42      /**
43       * Default recent date format is e.g. Feb 22 17:32
44       */
45      private static final String DEFAULT_RECENT_DATE_FORMAT = "MMM dd HH:mm";
46  
47      /**
48       * this is the regular expression used by this parser. Example: d [-W---F--] SCION_VOL2 512 Apr 13 23:12 VOL2
49       */
50      private static final String REGEX = "(d|-){1}\\s+" // Directory/file flag
51              + "\\[([-A-Z]+)\\]\\s+" // Attributes RWCEAFMS or -
52              + "(\\S+)\\s+" + "(\\d+)\\s+" // Owner and size
53              + "(\\S+\\s+\\S+\\s+((\\d+:\\d+)|(\\d{4})))" // Long/short date format
54              + "\\s+(.*)"; // Filename (incl. spaces)
55  
56      /**
57       * The default constructor for a NetwareFTPEntryParser object.
58       *
59       * @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not be seen under normal conditions. If it is seen, this is a
60       *                                  sign that <code>REGEX</code> is not a valid regular expression.
61       */
62      public NetwareFTPEntryParser() {
63          this(null);
64      }
65  
66      /**
67       * This constructor allows the creation of an NetwareFTPEntryParser object with something other than the default configuration.
68       *
69       * @param config The {@link FTPClientConfig configuration} object used to configure this parser.
70       * @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not be seen under normal conditions. If it is seen, this is a
71       *                                  sign that <code>REGEX</code> is not a valid regular expression.
72       * @since 1.4
73       */
74      public NetwareFTPEntryParser(final FTPClientConfig config) {
75          super(REGEX);
76          configure(config);
77      }
78  
79      /**
80       * Defines a default configuration to be used when this class is instantiated without a {@link FTPClientConfig FTPClientConfig} parameter being specified.
81       *
82       * @return the default configuration for this parser.
83       */
84      @Override
85      protected FTPClientConfig getDefaultConfiguration() {
86          return new FTPClientConfig(FTPClientConfig.SYST_NETWARE, DEFAULT_DATE_FORMAT, DEFAULT_RECENT_DATE_FORMAT);
87      }
88  
89      /**
90       * Parses a line of an NetwareFTP server file listing and converts it into a usable format in the form of an <code>FTPFile</code> instance. If the file
91       * listing line doesn't describe a file, <code>null</code> is returned, otherwise a <code>FTPFile</code> instance representing the files in the
92       * directory is returned.
93       * <p>
94       * Netware file permissions are in the following format: RWCEAFMS, and are explained as follows:
95       * <ul>
96       * <li><b>S</b> - Supervisor; All rights.
97       * <li><b>R</b> - Read; Right to open and read or execute.
98       * <li><b>W</b> - Write; Right to open and modify.
99       * <li><b>C</b> - Create; Right to create; when assigned to a file, allows a deleted file to be recovered.
100      * <li><b>E</b> - Erase; Right to delete.
101      * <li><b>M</b> - Modify; Right to rename a file and to change attributes.
102      * <li><b>F</b> - File Scan; Right to see directory or file listings.
103      * <li><b>A</b> - Access Control; Right to modify trustee assignments and the Inherited Rights Mask.
104      * </ul>
105      *
106      * See <a href="http://www.novell.com/documentation/nfap10/index.html?page=/documentation/nfap10/nfaubook/data/abxraws.html"> here</a> for more details
107      *
108      * @param entry A line of text from the file listing
109      * @return An FTPFile instance corresponding to the supplied entry
110      */
111     @Override
112     public FTPFile parseFTPEntry(final String entry) {
113 
114         final FTPFile f = new FTPFile();
115         if (matches(entry)) {
116             final String dirString = group(1);
117             final String attrib = group(2);
118             final String user = group(3);
119             final String size = group(4);
120             final String datestr = group(5);
121             final String name = group(9);
122 
123             try {
124                 f.setTimestamp(super.parseTimestamp(datestr));
125             } catch (final ParseException e) {
126                 // intentionally do nothing
127             }
128 
129             // is it a DIR or a file
130             if (dirString.trim().equals("d")) {
131                 f.setType(FTPFile.DIRECTORY_TYPE);
132             } else // Should be "-"
133             {
134                 f.setType(FTPFile.FILE_TYPE);
135             }
136 
137             f.setUser(user);
138 
139             // set the name
140             f.setName(name.trim());
141 
142             // set the size
143             f.setSize(Long.parseLong(size.trim()));
144 
145             // Now set the permissions (or at least a subset thereof - full permissions would probably require
146             // subclassing FTPFile and adding extra metainformation there)
147             if (attrib.indexOf('R') != -1) {
148                 f.setPermission(FTPFile.USER_ACCESS, FTPFile.READ_PERMISSION, true);
149             }
150             if (attrib.indexOf('W') != -1) {
151                 f.setPermission(FTPFile.USER_ACCESS, FTPFile.WRITE_PERMISSION, true);
152             }
153 
154             return f;
155         }
156         return null;
157 
158     }
159 
160 }