annotate servlet/src/digilib/io/FileOps.java @ 185:91f28e4fee8f

Servlet version 1.18b2 - added max-image-size parameter for digilib-config - small fixes for the removal of the digilib.Utils class
author robcast
date Tue, 25 Nov 2003 19:26:45 +0100
parents afe7ff98bb71
children b3f9a7f646c5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
85
4e6757e8ccd4 New enhanced ImageLoader stuff.
robcast
parents: 64
diff changeset
1 /* FileOps -- Utility class for file operations
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
2
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
3 Digital Image Library servlet components
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
4
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
5 Copyright (C) 2001, 2002 Robert Casties (robcast@mail.berlios.de)
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
6
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
7 This program is free software; you can redistribute it and/or modify it
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
9 Free Software Foundation; either version 2 of the License, or (at your
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
10 option) any later version.
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
11
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
12 Please read license.txt for the full details. A copy of the GPL
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
13 may be found at http://www.gnu.org/copyleft/lgpl.html
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
14
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
16 along with this program; if not, write to the Free Software
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
18
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
19 */
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
20
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
21 package digilib.io;
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
22
159
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
23 import java.io.File;
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
24 import java.io.FileFilter;
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
25 import java.util.Arrays;
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
26 import java.util.Iterator;
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
27 import java.util.StringTokenizer;
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
28
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
29 public class FileOps {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
30
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
31 public static String[] fileTypes =
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
32 {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
33 "jpg",
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
34 "image/jpeg",
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
35 "jpeg",
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
36 "image/jpeg",
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
37 "jp2",
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
38 "image/jp2",
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
39 "png",
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
40 "image/png",
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
41 "gif",
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
42 "image/gif",
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
43 "tif",
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
44 "image/tiff",
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
45 "tiff",
159
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
46 "image/tiff",
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
47 "txt",
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
48 "text/plain",
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
49 "html",
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
50 "text/html",
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
51 "htm",
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
52 "text/html",
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
53 "xml",
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
54 "text/xml" };
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
55
159
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
56 public static String[] imageExtensions =
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
57 { "jpg", "jpeg", "jp2", "png", "gif", "tif", "tiff" };
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
58
159
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
59 public static String[] textExtensions =
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
60 { "txt", "html", "htm", "xml"};
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
61
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
62 public static final int CLASS_NONE = -1;
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
63 public static final int CLASS_IMAGE = 0;
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
64 public static final int CLASS_TEXT = 1;
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
65 public static final int NUM_CLASSES = 2;
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
66
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
67
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
68 /**
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
69 * get the mime type for a file format (by extension)
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
70 */
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
71 public static String mimeForFile(File f) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
72 String fn = f.getName();
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
73 for (int i = 0; i < fileTypes.length; i += 2) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
74 if (fn.toLowerCase().endsWith(fileTypes[i])) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
75 return fileTypes[i + 1];
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
76 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
77 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
78 return null;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
79 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
80
159
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
81 /**
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
82 * get the file class for the filename (by extension)
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
83 * @param fn
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
84 * @return
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
85 */
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
86 public static int classForFilename(String fn) {
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
87 int n = imageExtensions.length;
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
88 for (int i = 0; i < n; i ++) {
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
89 if (fn.toLowerCase().endsWith(imageExtensions[i])) {
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
90 return CLASS_IMAGE;
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
91 }
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
92 }
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
93 n = textExtensions.length;
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
94 for (int i = 0; i < n; i ++) {
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
95 if (fn.toLowerCase().endsWith(textExtensions[i])) {
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
96 return CLASS_TEXT;
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
97 }
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
98 }
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
99 return CLASS_NONE;
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
100
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
101 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
102
159
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
103 public static Iterator getImageExtensionIterator() {
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
104 return Arrays.asList(imageExtensions).iterator();
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
105 }
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
106
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
107 public static Iterator getTextExtensionIterator() {
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
108 return Arrays.asList(textExtensions).iterator();
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
109 }
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
110
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
111 /**
152
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
112 * convert a string with a list of pathnames into an array of strings
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
113 * using the system's path separator string
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
114 */
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
115 public static String[] pathToArray(String paths) {
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
116 // split list into directories
159
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
117 StringTokenizer dirs = new StringTokenizer(paths, File.pathSeparator);
152
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
118 int n = dirs.countTokens();
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
119 if (n < 1) {
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
120 return null;
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
121 }
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
122 // add directories into array
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
123 String[] pathArray = new String[n];
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
124 for (int i = 0; i < n; i++) {
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
125 String s = dirs.nextToken();
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
126 // make shure the dir name ends with a directory separator
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
127 if (s.endsWith(File.separator)) {
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
128 pathArray[i] = s;
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
129 } else {
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
130 pathArray[i] = s + File.separator;
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
131 }
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
132 }
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
133 return pathArray;
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
134 }
176
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
135
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
136 /** Extract the base of a file name (sans extension).
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
137 *
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
138 * Returns the filename without the extension. The extension is the part behind
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
139 * the last dot in the filename. If the filename has no dot the full file name
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
140 * is returned.
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
141 *
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
142 * @param fn
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
143 * @return
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
144 */
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
145 public static String basename(String fn) {
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
146 int i = fn.lastIndexOf('.');
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
147 if (i > 0) {
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
148 return fn.substring(0, i);
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
149 }
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
150 return fn;
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
151 }
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
152
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
153 /** Extract the extension of a file name.
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
154 *
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
155 * Returns the extension of a file name. The extension is the part behind
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
156 * the last dot in the filename. If the filename has no dot the empty string
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
157 * is returned.
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
158 *
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
159 * @param fn
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
160 * @return
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
161 */
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
162 public static String extname(String fn) {
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
163 int i = fn.lastIndexOf('.');
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
164 if (i > 0) {
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
165 return fn.substring(i+1);
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
166 }
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
167 return "";
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
168 }
152
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
169
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
170 /**
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
171 * FileFilter for image types (helper class for getFile)
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
172 */
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
173 static class ImageFileFilter implements FileFilter {
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
174
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
175 public boolean accept(File f) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
176 if (f.isFile()) {
159
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
177 return ((mimeForFile(f) != null)&&(mimeForFile(f).startsWith("image")));
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
178 } else {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
179 return false;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
180 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
181 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
182 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
183
159
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
184 /**
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
185 * FileFilter for text types (helper class for getFile)
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
186 */
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
187 static class TextFileFilter implements FileFilter {
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
188
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
189 public boolean accept(File f) {
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
190 if (f.isFile()) {
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
191 return ((mimeForFile(f) != null)&&(mimeForFile(f).startsWith("text")));
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
192 } else {
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
193 return false;
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
194 }
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
195 }
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
196 }
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
197
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
198 /** Factory for FileFilters (image or text).
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
199 *
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
200 * @param fileClass
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
201 * @return
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
202 */
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
203 public static FileFilter filterForClass(int fileClass) {
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
204 if (fileClass == CLASS_IMAGE) {
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
205 return new ImageFileFilter();
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
206 }
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
207 if (fileClass == CLASS_TEXT) {
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
208 return new TextFileFilter();
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
209 }
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
210 return null;
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
211 }
e743b853efca servlet version 1.16a4
robcast
parents: 152
diff changeset
212
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
213 }