Contents of /jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileSystemUtils.java

/*
 * Copyright 2005 The Apache Software Foundation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.io;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.StringTokenizer;

/**
 * General File System utilities.
 * <p>
 * This class provides static utility methods for general file system
 * functions.
 *
 * @author Frank W. Zammetti
 * @author Stephen Colebourne
 * @version $Id$
 */
public final class FileSystemUtils {

    private static final int INIT_PROBLEM = -1;
    private static final int OTHER = 0;
    private static final int WINDOWS = 1;
    private static final int UNIX = 2;

    private static final int OS;
    static {
        int os = OTHER;
        try {
            String osName = System.getProperty("os.name");
            if (osName == null) {
                throw new IOException("os.name not found");
            }
            osName = osName.toLowerCase();
            // match
            if (osName.indexOf("windows") != -1) {
                os = WINDOWS;
            } else if (osName.indexOf("linux") != -1 ||
                osName.indexOf("sun os") != -1 ||
                osName.indexOf("sunos") != -1 ||
                osName.indexOf("solaris") != -1 ||
                osName.indexOf("mpe/ix") != -1 ||
                osName.indexOf("hp-ux") != -1 ||
                osName.indexOf("aix") != -1 ||
                osName.indexOf("freebsd") != -1 ||
                osName.indexOf("irix") != -1 ||
                osName.indexOf("digital unix") != -1 ||
                osName.indexOf("unix") != -1 ||
                osName.indexOf("mac os x") != -1) {
                os = UNIX;
            } else {
                os = OTHER;
            }
            
        } catch (Exception ex) {
            os = INIT_PROBLEM;
        }
        OS = os;
    }

    /**
     * Instances should NOT be constructed in standard programming.
     */
    public FileSystemUtils() {
    }

    //-----------------------------------------------------------------------
    /**
     * Returns the free space on a drive or volume in a cross-platform manner.
     * Note that some OS's are NOT currently supported, including OS/390.
     * <pre>
     * FileSystemUtils.getFreeSpace("C:");  // Windows
     * FileSystemUtils.getFreeSpace("/volume");  // *nix
     * </pre>
     * The free space is calculated via the command line.
     * It uses 'dir /-c' on Windows and 'df' on Unix.
     *
     * @param path  the path to get free space for
     * @return the amount of free drive space on the drive or volume
     * @throws IllegalArgumentException if the path is invalid
     * @throws IllegalStateException if an error occurred in initialisation
     * @throws IOException if an error occurs when finding the free space
     */
    public static long getFreeSpace(String path) throws IOException {
        if (path == null || path.length() == 0) {
            throw new IllegalArgumentException("Path must not be empty");
        }
        switch (OS) {
            case WINDOWS:
                return getFreeSpaceWindows(path);
            case UNIX:
                return getFreeSpaceUnix(path);
            case OTHER:
                throw new IllegalStateException("Unsupported operating system");
            default:
                throw new IllegalStateException("Exception caught when determining operating system");
        }
    }

    /**
     * Find free space on the Windows platform using the 'dir' command.
     *
     * @param path  the path to get free space for, including the colon
     * @return the amount of free drive space on the drive
     * @throws IOException if an error occurs
     */
    private static long getFreeSpaceWindows(String path) throws IOException {
        // build and run the 'dir' command
        String line = null;
        String[] cmdAttrbs = new String[3];
        cmdAttrbs[0] = "cmd.exe";
        cmdAttrbs[1] = "/C";
        cmdAttrbs[2] = "dir /-c " + path;
        Process proc = Runtime.getRuntime().exec(cmdAttrbs);

        // read the output until we find the line with 'bytes free'
        long bytes = -1;
        BufferedReader in = null;
        try {
            in = new BufferedReader(new InputStreamReader(proc.getInputStream()));
            line = in.readLine();
            while (line != null) {
                line = line.toLowerCase();
                int bfl = line.indexOf("bytes free");
                if (bfl != -1) {
                    // found "bytes free"
                    // chop off everything AFTER the actual byte count
                    line = line.substring(0, bfl);
                    line = line.trim();
                    // find the LAST space in the string, should be right before the
                    // byte count
                    int lsl = line.lastIndexOf(' ');
                    // now get rid of everything BEFORE that space, and line will
                    // then contain just the byte count
                    line = line.substring(lsl + 1);
                    bytes = Long.parseLong(line);
                }
                line = in.readLine();
            }
        } finally {
            IOUtils.closeQuietly(in);
        }

        if (bytes == -1) {
            throw new IOException(
                    "Command line 'dir' did not find text 'bytes free' in response for path '" +
                    path + "'- check path is of the form 'C:'");
        }
        return bytes;
    }

    /**
     * Find free space on the Nix platform using the 'df' command.
     *
     * @param path  the path to get free space for
     * @return the amount of free drive space on the volume
     * @throws IOException if an error occurs
     */
    private static long getFreeSpaceUnix(String path) throws IOException {
        // build and run the 'dir' command
        String[] cmdAttrbs = new String[3];
        cmdAttrbs[0] = "cmd.exe";
        cmdAttrbs[1] = "/C";
        cmdAttrbs[2] = "df " + path;
        Process proc = Runtime.getRuntime().exec(cmdAttrbs);

        // read the output from the command until we come to the second line
        long bytes = -1;
        BufferedReader in = null;
        try {
            in = new BufferedReader(new InputStreamReader(proc.getInputStream()));
            String line1 = in.readLine(); // header line (ignore it)
            String line2 = in.readLine(); // the line we're interested in
            if (line2 == null) {
                // unknown problem, throw exception
                throw new IOException(
                        "Command line 'df' did not return info as expected for path '" +
                        path + "'- response on first line was '" + line1 + '"');
            }
            line2 = line2.trim();

            // Now, we tokenize the string. The fourth element is what we want.
            StringTokenizer tok = new StringTokenizer(line2, " ");
            if (tok.countTokens() < 4) {
                throw new IOException(
                        "Command line 'df' did not return data as expected for path '" +
                        path + "'- check path is valid");
            }
            tok.nextToken(); // Ignore Filesystem
            tok.nextToken(); // Ignore 1K-blocks
            tok.nextToken(); // Ignore Used
            String freeSpace = tok.nextToken();
            bytes = Long.parseLong(freeSpace);

        } finally {
            IOUtils.closeQuietly(in);
        }

        if (bytes == -1) {
            throw new IOException(
                    "Command line 'df' did not find free space in response for path '" +
                    path + "'- check path is valid");
        }
        return bytes;
    }

}
1	/*
2	* Copyright 2005 The Apache Software Foundation.
3	*
4	* Licensed under the Apache License, Version 2.0 (the "License");
5	* you may not use this file except in compliance with the License.
6	* You may obtain a copy of the License at
7	*
8	* http://www.apache.org/licenses/LICENSE-2.0
9	*
10	* Unless required by applicable law or agreed to in writing, software
11	* distributed under the License is distributed on an "AS IS" BASIS,
12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13	* See the License for the specific language governing permissions and
14	* limitations under the License.
15	*/
16	package org.apache.commons.io;
17
18	import java.io.BufferedReader;
19	import java.io.IOException;
20	import java.io.InputStreamReader;
21	import java.util.StringTokenizer;
22
23	/**
24	* General File System utilities.
25	* <p>
26	* This class provides static utility methods for general file system
27	* functions.
28	*
29	* @author Frank W. Zammetti
30	* @author Stephen Colebourne
31	* @version $Id$
32	*/
33	public final class FileSystemUtils {
34
35	private static final int INIT_PROBLEM = -1;
36	private static final int OTHER = 0;
37	private static final int WINDOWS = 1;
38	private static final int UNIX = 2;
39
40	private static final int OS;
41	static {
42	int os = OTHER;
43	try {
44	String osName = System.getProperty("os.name");
45	if (osName == null) {
46	throw new IOException("os.name not found");
47	}
48	osName = osName.toLowerCase();
49	// match
50	if (osName.indexOf("windows") != -1) {
51	os = WINDOWS;
52	} else if (osName.indexOf("linux") != -1 \|\|
53	osName.indexOf("sun os") != -1 \|\|
54	osName.indexOf("sunos") != -1 \|\|
55	osName.indexOf("solaris") != -1 \|\|
56	osName.indexOf("mpe/ix") != -1 \|\|
57	osName.indexOf("hp-ux") != -1 \|\|
58	osName.indexOf("aix") != -1 \|\|
59	osName.indexOf("freebsd") != -1 \|\|
60	osName.indexOf("irix") != -1 \|\|
61	osName.indexOf("digital unix") != -1 \|\|
62	osName.indexOf("unix") != -1 \|\|
63	osName.indexOf("mac os x") != -1) {
64	os = UNIX;
65	} else {
66	os = OTHER;
67	}
68
69	} catch (Exception ex) {
70	os = INIT_PROBLEM;
71	}
72	OS = os;
73	}
74
75	/**
76	* Instances should NOT be constructed in standard programming.
77	*/
78	public FileSystemUtils() {
79	}
80
81	//-----------------------------------------------------------------------
82	/**
83	* Returns the free space on a drive or volume in a cross-platform manner.
84	* Note that some OS's are NOT currently supported, including OS/390.
85	* <pre>
86	* FileSystemUtils.getFreeSpace("C:"); // Windows
87	* FileSystemUtils.getFreeSpace("/volume"); // *nix
88	* </pre>
89	* The free space is calculated via the command line.
90	* It uses 'dir /-c' on Windows and 'df' on Unix.
91	*
92	* @param path the path to get free space for
93	* @return the amount of free drive space on the drive or volume
94	* @throws IllegalArgumentException if the path is invalid
95	* @throws IllegalStateException if an error occurred in initialisation
96	* @throws IOException if an error occurs when finding the free space
97	*/
98	public static long getFreeSpace(String path) throws IOException {
99	if (path == null \|\| path.length() == 0) {
100	throw new IllegalArgumentException("Path must not be empty");
101	}
102	switch (OS) {
103	case WINDOWS:
104	return getFreeSpaceWindows(path);
105	case UNIX:
106	return getFreeSpaceUnix(path);
107	case OTHER:
108	throw new IllegalStateException("Unsupported operating system");
109	default:
110	throw new IllegalStateException("Exception caught when determining operating system");
111	}
112	}
113
114	/**
115	* Find free space on the Windows platform using the 'dir' command.
116	*
117	* @param path the path to get free space for, including the colon
118	* @return the amount of free drive space on the drive
119	* @throws IOException if an error occurs
120	*/
121	private static long getFreeSpaceWindows(String path) throws IOException {
122	// build and run the 'dir' command
123	String line = null;
124	String[] cmdAttrbs = new String[3];
125	cmdAttrbs[0] = "cmd.exe";
126	cmdAttrbs[1] = "/C";
127	cmdAttrbs[2] = "dir /-c " + path;
128	Process proc = Runtime.getRuntime().exec(cmdAttrbs);
129
130	// read the output until we find the line with 'bytes free'
131	long bytes = -1;
132	BufferedReader in = null;
133	try {
134	in = new BufferedReader(new InputStreamReader(proc.getInputStream()));
135	line = in.readLine();
136	while (line != null) {
137	line = line.toLowerCase();
138	int bfl = line.indexOf("bytes free");
139	if (bfl != -1) {
140	// found "bytes free"
141	// chop off everything AFTER the actual byte count
142	line = line.substring(0, bfl);
143	line = line.trim();
144	// find the LAST space in the string, should be right before the
145	// byte count
146	int lsl = line.lastIndexOf(' ');
147	// now get rid of everything BEFORE that space, and line will
148	// then contain just the byte count
149	line = line.substring(lsl + 1);
150	bytes = Long.parseLong(line);
151	}
152	line = in.readLine();
153	}
154	} finally {
155	IOUtils.closeQuietly(in);
156	}
157
158	if (bytes == -1) {
159	throw new IOException(
160	"Command line 'dir' did not find text 'bytes free' in response for path '" +
161	path + "'- check path is of the form 'C:'");
162	}
163	return bytes;
164	}
165
166	/**
167	* Find free space on the Nix platform using the 'df' command.
168	*
169	* @param path the path to get free space for
170	* @return the amount of free drive space on the volume
171	* @throws IOException if an error occurs
172	*/
173	private static long getFreeSpaceUnix(String path) throws IOException {
174	// build and run the 'dir' command
175	String[] cmdAttrbs = new String[3];
176	cmdAttrbs[0] = "cmd.exe";
177	cmdAttrbs[1] = "/C";
178	cmdAttrbs[2] = "df " + path;
179	Process proc = Runtime.getRuntime().exec(cmdAttrbs);
180
181	// read the output from the command until we come to the second line
182	long bytes = -1;
183	BufferedReader in = null;
184	try {
185	in = new BufferedReader(new InputStreamReader(proc.getInputStream()));
186	String line1 = in.readLine(); // header line (ignore it)
187	String line2 = in.readLine(); // the line we're interested in
188	if (line2 == null) {
189	// unknown problem, throw exception
190	throw new IOException(
191	"Command line 'df' did not return info as expected for path '" +
192	path + "'- response on first line was '" + line1 + '"');
193	}
194	line2 = line2.trim();
195
196	// Now, we tokenize the string. The fourth element is what we want.
197	StringTokenizer tok = new StringTokenizer(line2, " ");
198	if (tok.countTokens() < 4) {
199	throw new IOException(
200	"Command line 'df' did not return data as expected for path '" +
201	path + "'- check path is valid");
202	}
203	tok.nextToken(); // Ignore Filesystem
204	tok.nextToken(); // Ignore 1K-blocks
205	tok.nextToken(); // Ignore Used
206	String freeSpace = tok.nextToken();
207	bytes = Long.parseLong(freeSpace);
208
209	} finally {
210	IOUtils.closeQuietly(in);
211	}
212
213	if (bytes == -1) {
214	throw new IOException(
215	"Command line 'df' did not find free space in response for path '" +
216	path + "'- check path is valid");
217	}
218	return bytes;
219	}
220
221	}
Name	Value
svn:eol-style	native
svn:keywords	Date Author Id Revision HeadURL
infrastructure at apache.org	ViewVC Help
Powered by ViewVC 1.1.26