include/wx/filesys.h

   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 #include "wx/defs.h"
  14
  15 #if !wxUSE_STREAMS
  16 #error You cannot compile virtual file systems without wxUSE_STREAMS
  17 #endif
  18
  19 #if wxUSE_HTML && !wxUSE_FILESYSTEM
  20 #error You cannot compile wxHTML without virtual file systems
  21 #endif
  22
  23 #if wxUSE_FILESYSTEM
  24
  25 #include "wx/stream.h"
  26 #include "wx/datetime.h"
  27 #include "wx/filename.h"
  28
  29 class WXDLLIMPEXP_BASE wxFSFile;
  30 class WXDLLIMPEXP_BASE wxFileSystemHandler;
  31 class WXDLLIMPEXP_BASE wxFileSystem;
  32
  33 //--------------------------------------------------------------------------------
  34 // wxFSFile
  35 //                  This class is a file opened using wxFileSystem. It consists of
  36 //                  input stream, location, mime type & optional anchor
  37 //                  (in 'index.htm#chapter2', 'chapter2' is anchor)
  38 //--------------------------------------------------------------------------------
  39
  40 class WXDLLIMPEXP_BASE wxFSFile : public wxObject
  41 {
  42 public:
  43     wxFSFile(wxInputStream *stream, const wxString& loc,
  44              const wxString& mimetype, const wxString& anchor
  45 #if wxUSE_DATETIME
  46              , wxDateTime modif
  47 #endif // wxUSE_DATETIME
  48              )
  49     {
  50         m_Stream = stream;
  51         m_destroy = true;
  52         m_Location = loc;
  53         m_MimeType = mimetype; m_MimeType.MakeLower();
  54         m_Anchor = anchor;
  55 #if wxUSE_DATETIME
  56         m_Modif = modif;
  57 #endif // wxUSE_DATETIME
  58     }
  59
  60     virtual ~wxFSFile() { if (m_Stream && m_destroy) delete m_Stream; }
  61
  62     // returns stream. This doesn't _create_ stream, it only returns
  63     // pointer to it.
  64     wxInputStream *GetStream() const {return m_Stream;}
  65
  66     // gives away the ownership of stream
  67     void DetachStream() { m_destroy = false; }
  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     bool m_destroy;
  84     wxString m_Location;
  85     wxString m_MimeType;
  86     wxString m_Anchor;
  87 #if wxUSE_DATETIME
  88     wxDateTime m_Modif;
  89 #endif // wxUSE_DATETIME
  90
  91     DECLARE_ABSTRACT_CLASS(wxFSFile)
  92     DECLARE_NO_COPY_CLASS(wxFSFile)
  93 };
  94
  95
  96
  97
  98
  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 //--------------------------------------------------------------------------------
 105
 106 class WXDLLIMPEXP_BASE wxFileSystemHandler : public wxObject
 107 {
 108 public:
 109     wxFileSystemHandler() : wxObject() {}
 110
 111     // returns true if this handler is able to open given location
 112     virtual bool CanOpen(const wxString& location) = 0;
 113
 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;
 118
 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();
 124
 125 protected:
 126     // returns protocol ("file", "http", "tar" etc.) The last (most right)
 127     // protocol is used:
 128     // {it returns "tar" for "file:subdir/archive.tar.gz#tar:/README.txt"}
 129     wxString GetProtocol(const wxString& location) const;
 130
 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;
 134
 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;
 139
 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;
 143
 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);
 147
 148     DECLARE_ABSTRACT_CLASS(wxFileSystemHandler)
 149 };
 150
 151
 152
 153
 154 //--------------------------------------------------------------------------------
 155 // wxFileSystem
 156 //                  This class provides simple interface for opening various
 157 //                  kinds of files (HTPP, FTP, local, tar.gz etc..)
 158 //--------------------------------------------------------------------------------
 159
 160 class WXDLLIMPEXP_BASE wxFileSystem : public wxObject
 161 {
 162 public:
 163     wxFileSystem() : wxObject() { m_FindFileHandler = NULL;}
 164     virtual ~wxFileSystem() { }
 165
 166     // sets the current location. Every call to OpenFile is
 167     // relative to this location.
 168     // NOTE !!
 169     // unless is_dir = true 'location' is *not* the directory but
 170     // file contained in this directory
 171     // (so ChangePathTo("dir/subdir/xh.htm") sets m_Path to "dir/subdir/")
 172     void ChangePathTo(const wxString& location, bool is_dir = false);
 173
 174     wxString GetPath() const {return m_Path;}
 175
 176     // opens given file and returns pointer to input stream.
 177     // Returns NULL if opening failed.
 178     // It first tries to open the file in relative scope
 179     // (based on ChangePathTo()'s value) and then as an absolute
 180     // path.
 181     wxFSFile* OpenFile(const wxString& location);
 182
 183     // Finds first/next file that matches spec wildcard. flags can be wxDIR for restricting
 184     // the query to directories or wxFILE for files only or 0 for either.
 185     // Returns filename or empty string if no more matching file exists
 186     wxString FindFirst(const wxString& spec, int flags = 0);
 187     wxString FindNext();
 188
 189     // find a file in a list of directories, returns false if not found
 190     bool FindFileInPath(wxString *pStr, const wxChar *path, const wxChar *file);
 191
 192     // Adds FS handler.
 193     // In fact, this class is only front-end to the FS handlers :-)
 194     static void AddHandler(wxFileSystemHandler *handler);
 195
 196     // Removes FS handler
 197     static wxFileSystemHandler* RemoveHandler(wxFileSystemHandler *handler);
 198
 199
 200     // Returns true if there is a handler which can open the given location.
 201     static bool HasHandlerForPath(const wxString& location);
 202
 203     // remove all items from the m_Handlers list
 204     static void CleanUpHandlers();
 205
 206     // Returns the native path for a file URL
 207     static wxFileName URLToFileName(const wxString& url);
 208
 209     // Returns the file URL for a native path
 210     static wxString FileNameToURL(const wxFileName& filename);
 211
 212
 213 protected:
 214     wxString m_Path;
 215             // the path (location) we are currently in
 216             // this is path, not file!
 217             // (so if you opened test/demo.htm, it is
 218             // "test/", not "test/demo.htm")
 219     wxString m_LastName;
 220             // name of last opened file (full path)
 221     static wxList m_Handlers;
 222             // list of FS handlers
 223     wxFileSystemHandler *m_FindFileHandler;
 224             // handler that succeed in FindFirst query
 225
 226     DECLARE_DYNAMIC_CLASS(wxFileSystem)
 227     DECLARE_NO_COPY_CLASS(wxFileSystem)
 228 };
 229
 230
 231 /*
 232
 233 'location' syntax:
 234
 235 To determine FS type, we're using standard KDE notation:
 236 file:/absolute/path/file.htm
 237 file:relative_path/xxxxx.html
 238 /some/path/x.file               ('file:' is default)
 239 http://www.gnome.org
 240 file:subdir/archive.tar.gz#tar:/README.txt
 241
 242 special characters :
 243   ':' - FS identificator is before this char
 244   '#' - separator. It can be either HTML anchor ("index.html#news")
 245             (in case there is no ':' in the string to the right from it)
 246         or FS separator
 247             (example : http://www.wxhtml.org/wxhtml-0.1.tar.gz#tar:/include/wxhtml/filesys.h"
 248              this would access tgz archive stored on web)
 249   '/' - directory (path) separator. It is used to determine upper-level path.
 250         HEY! Don't use \ even if you're on Windows!
 251
 252 */
 253
 254
 255 class WXDLLIMPEXP_BASE wxLocalFSHandler : public wxFileSystemHandler
 256 {
 257 public:
 258     virtual bool CanOpen(const wxString& location);
 259     virtual wxFSFile* OpenFile(wxFileSystem& fs, const wxString& location);
 260     virtual wxString FindFirst(const wxString& spec, int flags = 0);
 261     virtual wxString FindNext();
 262
 263     // wxLocalFSHandler will prefix all filenames with 'root' before accessing
 264     // files on disk. This effectively makes 'root' the top-level directory
 265     // and prevents access to files outside this directory.
 266     // (This is similar to Unix command 'chroot'.)
 267     static void Chroot(const wxString& root) { ms_root = root; }
 268
 269 protected:
 270     static wxString ms_root;
 271 };
 272
 273
 274
 275 #endif
 276   // wxUSE_FILESYSTEM
 277
 278 #endif
 279   // __FILESYS_H__