annotate servlet/src/digilib/io/FileOps.java @ 152:f4a5cfe37469

Servlet version 1.16a1 - cleanup of DigilibConfig class - now uses new Parameter and ParameterMap classes - new parameter default-quality
author robcast
date Wed, 03 Sep 2003 00:54:38 +0200
parents a398fc09ba71
children e743b853efca
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
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
23 import java.io.*;
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
24 import java.util.*;
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
25
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
26 import digilib.*;
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
27
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
28 public class FileOps {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
29
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
30 private Utils util = null;
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",
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
46 "image/tiff" };
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
47
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
48 public static String[] fileExtensions =
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
49 { "jpg", "jpeg", "jp2", "png", "gif", "tif", "tiff" };
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
50
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
51 public FileOps() {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
52 util = new Utils();
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
53 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
54
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
55 public FileOps(Utils u) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
56 util = u;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
57 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
58
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
59 public void setUtils(Utils u) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
60 util = u;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
61 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
62
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
63 /**
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
64 * get the mime type for a file format (by extension)
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
65 */
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
66 public static String mimeForFile(File f) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
67 String fn = f.getName();
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
68 for (int i = 0; i < fileTypes.length; i += 2) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
69 if (fn.toLowerCase().endsWith(fileTypes[i])) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
70 return fileTypes[i + 1];
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
71 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
72 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
73 return null;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
74 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
75
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
76 public static Iterator getImageExtensionIterator() {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
77 return Arrays.asList(fileExtensions).iterator();
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
78 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
79
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
80 /**
152
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
81 * convert a string with a list of pathnames into an array of strings
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
82 * using the system's path separator string
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
83 */
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
84 public static String[] pathToArray(String paths) {
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
85 // split list into directories
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
86 StringTokenizer dirs =
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
87 new StringTokenizer(paths, File.pathSeparator);
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
88 int n = dirs.countTokens();
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
89 if (n < 1) {
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
90 return null;
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
91 }
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
92 // add directories into array
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
93 String[] pathArray = new String[n];
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
94 for (int i = 0; i < n; i++) {
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
95 String s = dirs.nextToken();
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
96 // make shure the dir name ends with a directory separator
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
97 if (s.endsWith(File.separator)) {
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
98 pathArray[i] = s;
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
99 } else {
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
100 pathArray[i] = s + File.separator;
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
101 }
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
102 }
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
103 return pathArray;
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
104 }
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
105
f4a5cfe37469 Servlet version 1.16a1
robcast
parents: 91
diff changeset
106 /**
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
107 * get a filehandle for a file or directory name
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
108 * returns File number n if fn is directory (starts with 1)
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
109 */
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
110 public File getFile(String fn, int n) throws FileOpException {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
111 util.dprintln(4, "getFile (" + fn + ", " + n + ")");
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
112
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
113 File f = new File(fn);
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
114 // if fn is a file name then return file
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
115 if (f.isFile()) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
116 return f;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
117 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
118 // if fn is a directory name then open directory
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
119 if (f.isDirectory()) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
120 File[] fl = f.listFiles(new ImageFileFilter());
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
121 Arrays.sort(fl);
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
122 if ((n > 0) && (n <= fl.length)) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
123 return fl[n - 1];
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
124 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
125 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
126 throw new FileOpException("Unable to find file: " + fn);
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
127 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
128
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
129 /**
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
130 * get the number of files in a directory
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
131 * (almost the same as getFile)
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
132 * returns 0 in case of problems
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
133 */
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
134 public int getNumFiles(String fn) throws FileOpException {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
135 util.dprintln(4, "getNumFiles (" + fn + ")");
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
136
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
137 File f = new File(fn);
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
138 // if fn is a file name then return 1
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
139 if (f.isFile()) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
140 return 1;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
141 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
142 // if fn is a directory name then return the number of files
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
143 if (f.isDirectory()) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
144 return f.listFiles(new ImageFileFilter()).length;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
145 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
146 // then fn must be something strange...
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
147 return 0;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
148 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
149
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
150 /**
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
151 * get a filehandle for a file or directory name out of a list
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
152 * dirs is a list of base directories, fn is the appended file/dirname
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
153 * searches dirs until fn exists (backwards if fwd is false)
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
154 * returns File number n if fn is directory (starts with 1)
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
155 */
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
156 public File getFileVariant(String[] dirs, String fn, int n, boolean fwd)
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
157 throws FileOpException {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
158 util.dprintln(
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
159 4,
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
160 "getVariantFile (" + dirs + ", " + fn + ", " + n + ")");
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
161
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
162 File f = null;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
163 int nvar = dirs.length;
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
164
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
165 for (int i = 0; i < nvar; i++) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
166 try {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
167 f = getFile(dirs[(fwd) ? i : (nvar - i - 1)] + fn, n);
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
168 } catch (FileOpException e) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
169 f = null;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
170 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
171 if (f != null) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
172 return f;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
173 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
174 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
175 throw new FileOpException("Unable to find file: " + fn);
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
176 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
177
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
178 /**
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
179 * get the number of files in a directory
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
180 * (almost the same as getFileVariant)
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
181 * returns 0 in case of problems
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
182 */
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
183 public int getNumFilesVariant(String[] dirs, String fn, boolean fwd)
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
184 throws FileOpException {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
185 util.dprintln(4, "getNumFilesVariant (" + dirs + ", " + fn + ")");
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
186
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
187 int nf = 0;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
188 int nvar = dirs.length;
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
189
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
190 for (int i = 0; i < nvar; i++) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
191 try {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
192 nf = getNumFiles(dirs[(fwd) ? i : (nvar - i - 1)] + fn);
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
193 } catch (FileOpException e) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
194 nf = 0;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
195 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
196 if (nf > 0) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
197 return nf;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
198 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
199 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
200 return 0;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
201 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
202
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
203 /**
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
204 * FileFilter for image types (helper class for getFile)
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
205 */
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
206 static class ImageFileFilter implements FileFilter {
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
207
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
208 public boolean accept(File f) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
209 if (f.isFile()) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
210 return (mimeForFile(f) != null);
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
211 } else {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
212 return false;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
213 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
214 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
215 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
216
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
217 }