]>
Commit | Line | Data |
---|---|---|
1 | ///////////////////////////////////////////////////////////////////////////// | |
2 | // Name: filesys.h | |
3 | // Purpose: class for opening files - virtual file system | |
4 | // Author: Vaclav Slavik | |
5 | // Copyright: (c) 1999 Vaclav Slavik | |
6 | // RCS-ID: $Id$ | |
7 | // Licence: wxWindows Licence | |
8 | ///////////////////////////////////////////////////////////////////////////// | |
9 | ||
10 | #ifndef __FILESYS_H__ | |
11 | #define __FILESYS_H__ | |
12 | ||
13 | #if defined(__GNUG__) && !defined(__APPLE__) | |
14 | #pragma interface "filesys.h" | |
15 | #endif | |
16 | ||
17 | #include "wx/setup.h" | |
18 | ||
19 | #if !wxUSE_STREAMS | |
20 | #error You cannot compile virtual file systems without wxUSE_STREAMS | |
21 | #endif | |
22 | ||
23 | #if wxUSE_HTML && !wxUSE_FILESYSTEM | |
24 | #error You cannot compile wxHTML without virtual file systems | |
25 | #endif | |
26 | ||
27 | #if wxUSE_FILESYSTEM | |
28 | ||
29 | #include "wx/stream.h" | |
30 | #include "wx/datetime.h" | |
31 | #include "wx/filename.h" | |
32 | ||
33 | class wxFSFile; | |
34 | class wxFileSystemHandler; | |
35 | class wxFileSystem; | |
36 | ||
37 | //-------------------------------------------------------------------------------- | |
38 | // wxFSFile | |
39 | // This class is a file opened using wxFileSystem. It consists of | |
40 | // input stream, location, mime type & optional anchor | |
41 | // (in 'index.htm#chapter2', 'chapter2' is anchor) | |
42 | //-------------------------------------------------------------------------------- | |
43 | ||
44 | class WXDLLIMPEXP_BASE wxFSFile : public wxObject | |
45 | { | |
46 | public: | |
47 | wxFSFile(wxInputStream *stream, const wxString& loc, | |
48 | const wxString& mimetype, const wxString& anchor | |
49 | #if wxUSE_DATETIME | |
50 | , wxDateTime modif | |
51 | #endif // wxUSE_DATETIME | |
52 | ) | |
53 | { | |
54 | m_Stream = stream; | |
55 | m_Location = loc; | |
56 | m_MimeType = mimetype; m_MimeType.MakeLower(); | |
57 | m_Anchor = anchor; | |
58 | #if wxUSE_DATETIME | |
59 | m_Modif = modif; | |
60 | #endif // wxUSE_DATETIME | |
61 | } | |
62 | ||
63 | virtual ~wxFSFile() { if (m_Stream) delete m_Stream; } | |
64 | ||
65 | // returns stream. This doesn't _create_ stream, it only returns | |
66 | // pointer to it. | |
67 | wxInputStream *GetStream() const {return m_Stream;} | |
68 | ||
69 | // returns file's mime type | |
70 | const wxString& GetMimeType() const {return m_MimeType;} | |
71 | ||
72 | // returns the original location (aka filename) of the file | |
73 | const wxString& GetLocation() const {return m_Location;} | |
74 | ||
75 | const wxString& GetAnchor() const {return m_Anchor;} | |
76 | ||
77 | #if wxUSE_DATETIME | |
78 | wxDateTime GetModificationTime() const {return m_Modif;} | |
79 | #endif // wxUSE_DATETIME | |
80 | ||
81 | private: | |
82 | wxInputStream *m_Stream; | |
83 | wxString m_Location; | |
84 | wxString m_MimeType; | |
85 | wxString m_Anchor; | |
86 | #if wxUSE_DATETIME | |
87 | wxDateTime m_Modif; | |
88 | #endif // wxUSE_DATETIME | |
89 | ||
90 | DECLARE_ABSTRACT_CLASS(wxFSFile) | |
91 | DECLARE_NO_COPY_CLASS(wxFSFile) | |
92 | }; | |
93 | ||
94 | ||
95 | ||
96 | ||
97 | ||
98 | //-------------------------------------------------------------------------------- | |
99 | // wxFileSystemHandler | |
100 | // This class is FS handler for wxFileSystem. It provides | |
101 | // interface to access certain | |
102 | // kinds of files (HTPP, FTP, local, tar.gz etc..) | |
103 | //-------------------------------------------------------------------------------- | |
104 | ||
105 | class WXDLLIMPEXP_BASE wxFileSystemHandler : public wxObject | |
106 | { | |
107 | public: | |
108 | wxFileSystemHandler() : wxObject() {} | |
109 | ||
110 | // returns TRUE if this handler is able to open given location | |
111 | virtual bool CanOpen(const wxString& location) = 0; | |
112 | ||
113 | // opens given file and returns pointer to input stream. | |
114 | // Returns NULL if opening failed. | |
115 | // The location is always absolute path. | |
116 | virtual wxFSFile* OpenFile(wxFileSystem& fs, const wxString& location) = 0; | |
117 | ||
118 | // Finds first/next file that matches spec wildcard. flags can be wxDIR for restricting | |
119 | // the query to directories or wxFILE for files only or 0 for either. | |
120 | // Returns filename or empty string if no more matching file exists | |
121 | virtual wxString FindFirst(const wxString& spec, int flags = 0); | |
122 | virtual wxString FindNext(); | |
123 | ||
124 | protected: | |
125 | // returns protocol ("file", "http", "tar" etc.) The last (most right) | |
126 | // protocol is used: | |
127 | // {it returns "tar" for "file:subdir/archive.tar.gz#tar:/README.txt"} | |
128 | wxString GetProtocol(const wxString& location) const; | |
129 | ||
130 | // returns left part of address: | |
131 | // {it returns "file:subdir/archive.tar.gz" for "file:subdir/archive.tar.gz#tar:/README.txt"} | |
132 | wxString GetLeftLocation(const wxString& location) const; | |
133 | ||
134 | // returns anchor part of address: | |
135 | // {it returns "anchor" for "file:subdir/archive.tar.gz#tar:/README.txt#anchor"} | |
136 | // NOTE: anchor is NOT a part of GetLeftLocation()'s return value | |
137 | wxString GetAnchor(const wxString& location) const; | |
138 | ||
139 | // returns right part of address: | |
140 | // {it returns "/README.txt" for "file:subdir/archive.tar.gz#tar:/README.txt"} | |
141 | wxString GetRightLocation(const wxString& location) const; | |
142 | ||
143 | // Returns MIME type of the file - w/o need to open it | |
144 | // (default behaviour is that it returns type based on extension) | |
145 | wxString GetMimeTypeFromExt(const wxString& location); | |
146 | ||
147 | DECLARE_ABSTRACT_CLASS(wxFileSystemHandler) | |
148 | }; | |
149 | ||
150 | ||
151 | ||
152 | ||
153 | //-------------------------------------------------------------------------------- | |
154 | // wxFileSystem | |
155 | // This class provides simple interface for opening various | |
156 | // kinds of files (HTPP, FTP, local, tar.gz etc..) | |
157 | //-------------------------------------------------------------------------------- | |
158 | ||
159 | class WXDLLIMPEXP_BASE wxFileSystem : public wxObject | |
160 | { | |
161 | public: | |
162 | wxFileSystem() : wxObject() { m_FindFileHandler = NULL;} | |
163 | virtual ~wxFileSystem() { } | |
164 | ||
165 | // sets the current location. Every call to OpenFile is | |
166 | // relative to this location. | |
167 | // NOTE !! | |
168 | // unless is_dir = TRUE 'location' is *not* the directory but | |
169 | // file contained in this directory | |
170 | // (so ChangePathTo("dir/subdir/xh.htm") sets m_Path to "dir/subdir/") | |
171 | void ChangePathTo(const wxString& location, bool is_dir = FALSE); | |
172 | ||
173 | wxString GetPath() const {return m_Path;} | |
174 | ||
175 | // opens given file and returns pointer to input stream. | |
176 | // Returns NULL if opening failed. | |
177 | // It first tries to open the file in relative scope | |
178 | // (based on ChangePathTo()'s value) and then as an absolute | |
179 | // path. | |
180 | wxFSFile* OpenFile(const wxString& location); | |
181 | ||
182 | // Finds first/next file that matches spec wildcard. flags can be wxDIR for restricting | |
183 | // the query to directories or wxFILE for files only or 0 for either. | |
184 | // Returns filename or empty string if no more matching file exists | |
185 | wxString FindFirst(const wxString& spec, int flags = 0); | |
186 | wxString FindNext(); | |
187 | ||
188 | // Adds FS handler. | |
189 | // In fact, this class is only front-end to the FS hanlers :-) | |
190 | static void AddHandler(wxFileSystemHandler *handler); | |
191 | ||
192 | // remove all items from the m_Handlers list | |
193 | static void CleanUpHandlers(); | |
194 | ||
195 | // Returns the native path for a file URL | |
196 | static wxFileName URLToFileName(const wxString& url); | |
197 | ||
198 | // Returns the file URL for a native path | |
199 | static wxString FileNameToURL(const wxFileName& filename); | |
200 | ||
201 | ||
202 | protected: | |
203 | wxString m_Path; | |
204 | // the path (location) we are currently in | |
205 | // this is path, not file! | |
206 | // (so if you opened test/demo.htm, it is | |
207 | // "test/", not "test/demo.htm") | |
208 | wxString m_LastName; | |
209 | // name of last opened file (full path) | |
210 | static wxList m_Handlers; | |
211 | // list of FS handlers | |
212 | wxFileSystemHandler *m_FindFileHandler; | |
213 | // handler that succeed in FindFirst query | |
214 | ||
215 | DECLARE_DYNAMIC_CLASS(wxFileSystem) | |
216 | DECLARE_NO_COPY_CLASS(wxFileSystem) | |
217 | }; | |
218 | ||
219 | ||
220 | /* | |
221 | ||
222 | 'location' syntax: | |
223 | ||
224 | To determine FS type, we're using standard KDE notation: | |
225 | file:/absolute/path/file.htm | |
226 | file:relative_path/xxxxx.html | |
227 | /some/path/x.file ('file:' is default) | |
228 | http://www.gnome.org | |
229 | file:subdir/archive.tar.gz#tar:/README.txt | |
230 | ||
231 | special characters : | |
232 | ':' - FS identificator is before this char | |
233 | '#' - separator. It can be either HTML anchor ("index.html#news") | |
234 | (in case there is no ':' in the string to the right from it) | |
235 | or FS separator | |
236 | (example : http://www.wxhtml.org/wxhtml-0.1.tar.gz#tar:/include/wxhtml/filesys.h" | |
237 | this would access tgz archive stored on web) | |
238 | '/' - directory (path) separator. It is used to determine upper-level path. | |
239 | HEY! Don't use \ even if you're on Windows! | |
240 | ||
241 | */ | |
242 | ||
243 | ||
244 | class WXDLLIMPEXP_BASE wxLocalFSHandler : public wxFileSystemHandler | |
245 | { | |
246 | public: | |
247 | virtual bool CanOpen(const wxString& location); | |
248 | virtual wxFSFile* OpenFile(wxFileSystem& fs, const wxString& location); | |
249 | virtual wxString FindFirst(const wxString& spec, int flags = 0); | |
250 | virtual wxString FindNext(); | |
251 | ||
252 | // wxLocalFSHandler will prefix all filenames with 'root' before accessing | |
253 | // files on disk. This effectively makes 'root' the top-level directory | |
254 | // and prevents access to files outside this directory. | |
255 | // (This is similar to Unix command 'chroot'.) | |
256 | static void Chroot(const wxString& root) { ms_root = root; } | |
257 | ||
258 | protected: | |
259 | static wxString ms_root; | |
260 | }; | |
261 | ||
262 | ||
263 | ||
264 | #endif | |
265 | // wxUSE_FILESYSTEM | |
266 | ||
267 | #endif | |
268 | // __FILESYS_H__ |