made wxLocalFSHandler public and added Chroot to it

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@11642 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

include/wx/filesys.h

@@ -43,14 +43,7 @@ class wxFileSystem;
 
 class WXDLLEXPORT wxFSFile : public wxObject
 {
-    private:
+public:
-        wxInputStream *m_Stream;
-        wxString m_Location;
-        wxString m_MimeType;
-        wxString m_Anchor;
-        wxDateTime m_Modif;
-
-    public:
     wxFSFile(wxInputStream *stream, const wxString& loc, 
              const wxString& mimetype, const wxString& anchor,
              wxDateTime modif)
@@ -61,24 +54,28 @@ class WXDLLEXPORT wxFSFile : public wxObject
         m_Anchor = anchor;
         m_Modif = modif;
     }
-        virtual ~wxFSFile()
+    virtual ~wxFSFile() { if (m_Stream) delete m_Stream; }
-            {
-                if (m_Stream) delete m_Stream;
-            }
 
-        wxInputStream *GetStream() const {return m_Stream;}
     // returns stream. This doesn't _create_ stream, it only returns
     // pointer to it!!
+    wxInputStream *GetStream() const {return m_Stream;}
 
-        const wxString& GetMimeType() const {return m_MimeType;}
     // returns file's mime type
+    const wxString& GetMimeType() const {return m_MimeType;}
 
-        const wxString& GetLocation() const {return m_Location;}
     // returns the original location (aka filename) of the file
+    const wxString& GetLocation() const {return m_Location;}
 
     const wxString& GetAnchor() const {return m_Anchor;}
 
     wxDateTime GetModificationTime() const {return m_Modif;}
+
+private:
+    wxInputStream *m_Stream;
+    wxString m_Location;
+    wxString m_MimeType;
+    wxString m_Anchor;
+    wxDateTime m_Modif;
 };
 
 
@@ -94,47 +91,47 @@ class WXDLLEXPORT wxFSFile : public wxObject
 
 class WXDLLEXPORT wxFileSystemHandler : public wxObject
 {
-    DECLARE_ABSTRACT_CLASS(wxFileSystemHandler)
+public:
-
-    public:
     wxFileSystemHandler() : wxObject() {}
 
-        virtual bool CanOpen(const wxString& location) = 0;
     // returns TRUE if this handler is able to open given location
+    virtual bool CanOpen(const wxString& location) = 0;
 
-        virtual wxFSFile* OpenFile(wxFileSystem& fs, const wxString& location) = 0;
     // opens given file and returns pointer to input stream.
     // Returns NULL if opening failed.
     // The location is always absolute path.
+    virtual wxFSFile* OpenFile(wxFileSystem& fs, const wxString& location) = 0;
 
-        virtual wxString FindFirst(const wxString& spec, int flags = 0);
-        virtual wxString FindNext();
     // Finds first/next file that matches spec wildcard. flags can be wxDIR for restricting
     // the query to directories or wxFILE for files only or 0 for either.
     // Returns filename or empty string if no more matching file exists
+    virtual wxString FindFirst(const wxString& spec, int flags = 0);
+    virtual wxString FindNext();
 
-    protected:
+protected:
-        wxString GetProtocol(const wxString& location) const;
     // returns protocol ("file", "http", "tar" etc.) The last (most right)
     // protocol is used:
     // {it returns "tar" for "file:subdir/archive.tar.gz#tar:/README.txt"}
+    wxString GetProtocol(const wxString& location) const;
 
-        wxString GetLeftLocation(const wxString& location) const;
     // returns left part of address:
     // {it returns "file:subdir/archive.tar.gz" for "file:subdir/archive.tar.gz#tar:/README.txt"}
+    wxString GetLeftLocation(const wxString& location) const;
 
-        wxString GetAnchor(const wxString& location) const;
     // returns anchor part of address:
     // {it returns "anchor" for "file:subdir/archive.tar.gz#tar:/README.txt#anchor"}
     // NOTE:  anchor is NOT a part of GetLeftLocation()'s return value
+    wxString GetAnchor(const wxString& location) const;
 
-        wxString GetRightLocation(const wxString& location) const;
     // returns right part of address:
     // {it returns "/README.txt" for "file:subdir/archive.tar.gz#tar:/README.txt"}
+    wxString GetRightLocation(const wxString& location) const;
 
-        wxString GetMimeTypeFromExt(const wxString& location);
     // Returns MIME type of the file - w/o need to open it
     // (default behaviour is that it returns type based on extension)
+    wxString GetMimeTypeFromExt(const wxString& location);
+
+    DECLARE_ABSTRACT_CLASS(wxFileSystemHandler)
 };
 
 
@@ -148,43 +145,40 @@ class WXDLLEXPORT wxFileSystemHandler : public wxObject
 
 class WXDLLEXPORT wxFileSystem : public wxObject
 {
-    DECLARE_DYNAMIC_CLASS(wxFileSystem)
+public:
-
-    public:
     wxFileSystem() : wxObject() {m_Path = m_LastName = wxEmptyString; m_Handlers.DeleteContents(TRUE); m_FindFileHandler = NULL;}
 
-        void ChangePathTo(const wxString& location, bool is_dir = FALSE);
     // sets the current location. Every call to OpenFile is
     // relative to this location.
     // NOTE !!
     // unless is_dir = TRUE 'location' is *not* the directory but
     // file contained in this directory
     // (so ChangePathTo("dir/subdir/xh.htm") sets m_Path to "dir/subdir/")
+    void ChangePathTo(const wxString& location, bool is_dir = FALSE);
 
     wxString GetPath() const {return m_Path;}
 
-        wxFSFile* OpenFile(const wxString& location);
     // opens given file and returns pointer to input stream.
     // Returns NULL if opening failed.
     // It first tries to open the file in relative scope
     // (based on ChangePathTo()'s value) and then as an absolute
     // path.
+    wxFSFile* OpenFile(const wxString& location);
 
-        wxString FindFirst(const wxString& spec, int flags = 0);
-        wxString FindNext();
     // Finds first/next file that matches spec wildcard. flags can be wxDIR for restricting
     // the query to directories or wxFILE for files only or 0 for either.
     // Returns filename or empty string if no more matching file exists
+    wxString FindFirst(const wxString& spec, int flags = 0);
+    wxString FindNext();
 
-
-        static void AddHandler(wxFileSystemHandler *handler);
     // Adds FS handler.
     // In fact, this class is only front-end to the FS hanlers :-)
+    static void AddHandler(wxFileSystemHandler *handler);
 
-        static void CleanUpHandlers();
     // remove all items from the m_Handlers list
+    static void CleanUpHandlers();
 
-    private:
+protected:
     wxString m_Path;
             // the path (location) we are currently in
             // this is path, not file!
@@ -196,6 +190,8 @@ class WXDLLEXPORT wxFileSystem : public wxObject
             // list of FS handlers
     wxFileSystemHandler *m_FindFileHandler;
             // handler that succeed in FindFirst query
+
+    DECLARE_DYNAMIC_CLASS(wxFileSystem)
 };
 
 
@@ -222,6 +218,27 @@ special characters :
 
 */
 
+
+class wxLocalFSHandler : public wxFileSystemHandler
+{
+public:
+    virtual bool CanOpen(const wxString& location);
+    virtual wxFSFile* OpenFile(wxFileSystem& fs, const wxString& location);
+    virtual wxString FindFirst(const wxString& spec, int flags = 0);
+    virtual wxString FindNext();
+    
+    // wxLocalFSHandler will prefix all filenames with 'root' before accessing
+    // files on disk. This effectively makes 'root' the top-level directory
+    // and prevents access to files outside this directory.  
+    // (This is similar to Unix command 'chroot'.)
+    static void Chroot(const wxString& root) { ms_root = root; }
+    
+protected:
+    static wxString ms_root;
+};
+
+
+
 #endif
   // wxUSE_FILESYSTEM
 

src/common/filesys.cpp

@@ -138,15 +138,8 @@ wxString wxFileSystemHandler::FindNext()
 // wxLocalFSHandler
 //--------------------------------------------------------------------------------
 
-class wxLocalFSHandler : public wxFileSystemHandler
-{
-    public:
-        virtual bool CanOpen(const wxString& location);
-        virtual wxFSFile* OpenFile(wxFileSystem& fs, const wxString& location);
-        virtual wxString FindFirst(const wxString& spec, int flags = 0);
-        virtual wxString FindNext();
-};
 
+wxString wxLocalFSHandler::ms_root;
 
 bool wxLocalFSHandler::CanOpen(const wxString& location)
 {
@@ -156,23 +149,23 @@ bool wxLocalFSHandler::CanOpen(const wxString& location)
 wxFSFile* wxLocalFSHandler::OpenFile(wxFileSystem& WXUNUSED(fs), const wxString& location)
 {
     // location has Unix path separators
-    wxString right = GetRightLocation(location);
+    wxString right = ms_root + GetRightLocation(location);
-    wxFileName fn( right, wxPATH_UNIX );
+    wxFileName fn(right, wxPATH_UNIX);
     
-    if (!wxFileExists( fn.GetFullPath() ))
+    if (!wxFileExists(fn.GetFullPath()))
         return (wxFSFile*) NULL;
         
-    return new wxFSFile(new wxFileInputStream( fn.GetFullPath() ),
+    return new wxFSFile(new wxFileInputStream(fn.GetFullPath()),
                         right,
                         GetMimeTypeFromExt(location),
                         GetAnchor(location),
-                        wxDateTime(wxFileModificationTime( fn.GetFullPath() )));
+                        wxDateTime(wxFileModificationTime(fn.GetFullPath())));
 
 }
 
 wxString wxLocalFSHandler::FindFirst(const wxString& spec, int flags)
 {
-    wxString right = GetRightLocation(spec);
+    wxString right = ms_root + GetRightLocation(spec);
     return wxFindFirstFile(right, flags);
 }