1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: class for opening files - virtual file system
4 // Author: Vaclav Slavik
5 // Copyright: (c) 1999 Vaclav Slavik
7 // Licence: wxWindows Licence
8 /////////////////////////////////////////////////////////////////////////////
13 #if defined(__GNUG__) && !defined(__APPLE__)
14 #pragma interface "filesys.h"
20 #error You cannot compile virtual file systems without wxUSE_STREAMS
23 #if wxUSE_HTML && !wxUSE_FILESYSTEM
24 #error You cannot compile wxHTML without virtual file systems
29 #include "wx/stream.h"
31 #include "wx/datetime.h"
32 #include "wx/filename.h"
35 class wxFileSystemHandler
;
38 //--------------------------------------------------------------------------------
40 // This class is a file opened using wxFileSystem. It consists of
41 // input stream, location, mime type & optional anchor
42 // (in 'index.htm#chapter2', 'chapter2' is anchor)
43 //--------------------------------------------------------------------------------
45 class WXDLLEXPORT wxFSFile
: public wxObject
48 wxFSFile(wxInputStream
*stream
, const wxString
& loc
,
49 const wxString
& mimetype
, const wxString
& anchor
52 #endif // wxUSE_DATETIME
57 m_MimeType
= mimetype
; m_MimeType
.MakeLower();
61 #endif // wxUSE_DATETIME
64 virtual ~wxFSFile() { if (m_Stream
) delete m_Stream
; }
66 // returns stream. This doesn't _create_ stream, it only returns
68 wxInputStream
*GetStream() const {return m_Stream
;}
70 // returns file's mime type
71 const wxString
& GetMimeType() const {return m_MimeType
;}
73 // returns the original location (aka filename) of the file
74 const wxString
& GetLocation() const {return m_Location
;}
76 const wxString
& GetAnchor() const {return m_Anchor
;}
79 wxDateTime
GetModificationTime() const {return m_Modif
;}
80 #endif // wxUSE_DATETIME
83 wxInputStream
*m_Stream
;
89 #endif // wxUSE_DATETIME
91 DECLARE_ABSTRACT_CLASS(wxFSFile
)
92 DECLARE_NO_COPY_CLASS(wxFSFile
)
99 //--------------------------------------------------------------------------------
100 // wxFileSystemHandler
101 // This class is FS handler for wxFileSystem. It provides
102 // interface to access certain
103 // kinds of files (HTPP, FTP, local, tar.gz etc..)
104 //--------------------------------------------------------------------------------
106 class WXDLLEXPORT wxFileSystemHandler
: public wxObject
109 wxFileSystemHandler() : wxObject() {}
111 // returns TRUE if this handler is able to open given location
112 virtual bool CanOpen(const wxString
& location
) = 0;
114 // opens given file and returns pointer to input stream.
115 // Returns NULL if opening failed.
116 // The location is always absolute path.
117 virtual wxFSFile
* OpenFile(wxFileSystem
& fs
, const wxString
& location
) = 0;
119 // Finds first/next file that matches spec wildcard. flags can be wxDIR for restricting
120 // the query to directories or wxFILE for files only or 0 for either.
121 // Returns filename or empty string if no more matching file exists
122 virtual wxString
FindFirst(const wxString
& spec
, int flags
= 0);
123 virtual wxString
FindNext();
126 // returns protocol ("file", "http", "tar" etc.) The last (most right)
128 // {it returns "tar" for "file:subdir/archive.tar.gz#tar:/README.txt"}
129 wxString
GetProtocol(const wxString
& location
) const;
131 // returns left part of address:
132 // {it returns "file:subdir/archive.tar.gz" for "file:subdir/archive.tar.gz#tar:/README.txt"}
133 wxString
GetLeftLocation(const wxString
& location
) const;
135 // returns anchor part of address:
136 // {it returns "anchor" for "file:subdir/archive.tar.gz#tar:/README.txt#anchor"}
137 // NOTE: anchor is NOT a part of GetLeftLocation()'s return value
138 wxString
GetAnchor(const wxString
& location
) const;
140 // returns right part of address:
141 // {it returns "/README.txt" for "file:subdir/archive.tar.gz#tar:/README.txt"}
142 wxString
GetRightLocation(const wxString
& location
) const;
144 // Returns MIME type of the file - w/o need to open it
145 // (default behaviour is that it returns type based on extension)
146 wxString
GetMimeTypeFromExt(const wxString
& location
);
148 DECLARE_ABSTRACT_CLASS(wxFileSystemHandler
)
154 //--------------------------------------------------------------------------------
156 // This class provides simple interface for opening various
157 // kinds of files (HTPP, FTP, local, tar.gz etc..)
158 //--------------------------------------------------------------------------------
160 class WXDLLEXPORT wxFileSystem
: public wxObject
163 wxFileSystem() : wxObject() {m_Path
= m_LastName
= wxEmptyString
; m_Handlers
.DeleteContents(TRUE
); m_FindFileHandler
= NULL
;}
165 // sets the current location. Every call to OpenFile is
166 // relative to this location.
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
);
173 wxString
GetPath() const {return m_Path
;}
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
180 wxFSFile
* OpenFile(const wxString
& location
);
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);
189 // In fact, this class is only front-end to the FS hanlers :-)
190 static void AddHandler(wxFileSystemHandler
*handler
);
192 // remove all items from the m_Handlers list
193 static void CleanUpHandlers();
195 // Returns the native path for a file URL
196 static wxFileName
URLToFileName(const wxString
& url
);
198 // Returns the file URL for a native path
199 static wxString
FileNameToURL(const wxFileName
& filename
);
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")
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
215 DECLARE_DYNAMIC_CLASS(wxFileSystem
)
216 DECLARE_NO_COPY_CLASS(wxFileSystem
)
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)
229 file:subdir/archive.tar.gz#tar:/README.txt
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)
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!
244 class wxLocalFSHandler
: public wxFileSystemHandler
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();
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
; }
259 static wxString ms_root
;