/////////////////////////////////////////////////////////////////////////////
-// Name: filesys.cpp
+// Name: src/common/filesys.cpp
// Purpose: wxFileSystem class - interface for opening files
// Author: Vaclav Slavik
// Copyright: (c) 1999 Vaclav Slavik
// CVS-ID: $Id$
-// Licence: wxWindows Licence
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-#ifdef __GNUG__
-#pragma implementation "filesys.h"
-#endif
-
#include "wx/wxprec.h"
-#ifdef __BORDLANDC__
-#pragma hdrstop
+#ifdef __BORLANDC__
+ #pragma hdrstop
#endif
#if wxUSE_FILESYSTEM
-#include "wx/wfstream.h"
-#include "wx/module.h"
#include "wx/filesys.h"
+
+#ifndef WX_PRECOMP
+ #include "wx/log.h"
+ #include "wx/module.h"
+#endif
+
+#include "wx/wfstream.h"
#include "wx/mimetype.h"
#include "wx/filename.h"
+#include "wx/tokenzr.h"
+#include "wx/uri.h"
+#include "wx/private/fileback.h"
+// ----------------------------------------------------------------------------
+// wxFSFile
+// ----------------------------------------------------------------------------
+const wxString& wxFSFile::GetMimeType() const
+{
+ if ( m_MimeType.empty() && !m_Location.empty() )
+ {
+ wxConstCast(this, wxFSFile)->m_MimeType =
+ wxFileSystemHandler::GetMimeTypeFromExt(m_Location);
+ }
-//--------------------------------------------------------------------------------
+ return m_MimeType;
+}
+
+// ----------------------------------------------------------------------------
// wxFileSystemHandler
-//--------------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
IMPLEMENT_ABSTRACT_CLASS(wxFileSystemHandler, wxObject)
-#if wxUSE_MIMETYPE
-static wxFileTypeInfo *gs_FSMimeFallbacks = NULL;
-#endif
-
+/* static */
wxString wxFileSystemHandler::GetMimeTypeFromExt(const wxString& location)
{
wxString ext, mime;
wxString loc = GetRightLocation(location);
- char c;
- int l = loc.Length(), l2;
+ wxChar c;
+ int l = loc.length(), l2;
l2 = l;
for (int i = l-1; i >= 0; i--)
}
#if wxUSE_MIMETYPE
- static bool s_MinimalMimeEnsured = FALSE;
- if (!s_MinimalMimeEnsured) {
- wxTheMimeTypesManager->AddFallbacks(gs_FSMimeFallbacks);
- s_MinimalMimeEnsured = TRUE;
+ static bool s_MinimalMimeEnsured = false;
+ if (!s_MinimalMimeEnsured)
+ {
+ static const wxFileTypeInfo fallbacks[] =
+ {
+ wxFileTypeInfo(_T("image/jpeg"),
+ wxEmptyString,
+ wxEmptyString,
+ _T("JPEG image (from fallback)"),
+ _T("jpg"), _T("jpeg"), _T("JPG"), _T("JPEG"), wxNullPtr),
+ wxFileTypeInfo(_T("image/gif"),
+ wxEmptyString,
+ wxEmptyString,
+ _T("GIF image (from fallback)"),
+ _T("gif"), _T("GIF"), wxNullPtr),
+ wxFileTypeInfo(_T("image/png"),
+ wxEmptyString,
+ wxEmptyString,
+ _T("PNG image (from fallback)"),
+ _T("png"), _T("PNG"), wxNullPtr),
+ wxFileTypeInfo(_T("image/bmp"),
+ wxEmptyString,
+ wxEmptyString,
+ _T("windows bitmap image (from fallback)"),
+ _T("bmp"), _T("BMP"), wxNullPtr),
+ wxFileTypeInfo(_T("text/html"),
+ wxEmptyString,
+ wxEmptyString,
+ _T("HTML document (from fallback)"),
+ _T("htm"), _T("html"), _T("HTM"), _T("HTML"), wxNullPtr),
+ // must terminate the table with this!
+ wxFileTypeInfo()
+ };
+ wxTheMimeTypesManager->AddFallbacks(fallbacks);
+ s_MinimalMimeEnsured = true;
}
wxFileType *ft = wxTheMimeTypesManager->GetFileTypeFromExtension(ext);
return mime;
#else
- if ( ext.IsSameAs(wxT("htm"), FALSE) || ext.IsSameAs(_T("html"), FALSE) )
+ if ( ext.IsSameAs(wxT("htm"), false) || ext.IsSameAs(_T("html"), false) )
return wxT("text/html");
- if ( ext.IsSameAs(wxT("jpg"), FALSE) || ext.IsSameAs(_T("jpeg"), FALSE) )
+ if ( ext.IsSameAs(wxT("jpg"), false) || ext.IsSameAs(_T("jpeg"), false) )
return wxT("image/jpeg");
- if ( ext.IsSameAs(wxT("gif"), FALSE) )
+ if ( ext.IsSameAs(wxT("gif"), false) )
return wxT("image/gif");
- if ( ext.IsSameAs(wxT("png"), FALSE) )
+ if ( ext.IsSameAs(wxT("png"), false) )
return wxT("image/png");
- if ( ext.IsSameAs(wxT("bmp"), FALSE) )
+ if ( ext.IsSameAs(wxT("bmp"), false) )
return wxT("image/bmp");
return wxEmptyString;
#endif
-wxString wxFileSystemHandler::GetProtocol(const wxString& location) const
+/* static */
+wxString wxFileSystemHandler::GetProtocol(const wxString& location)
{
wxString s = wxEmptyString;
- int i, l = location.Length();
- bool fnd;
+ int i, l = location.length();
+ bool fnd = false;
- fnd = FALSE;
for (i = l-1; (i >= 0) && ((location[i] != wxT('#')) || (!fnd)); i--) {
- if ((location[i] == wxT(':')) && (i != 1 /*win: C:\path*/)) fnd = TRUE;
+ if ((location[i] == wxT(':')) && (i != 1 /*win: C:\path*/)) fnd = true;
}
if (!fnd) return wxT("file");
for (++i; (i < l) && (location[i] != wxT(':')); i++) s << location[i];
}
-wxString wxFileSystemHandler::GetLeftLocation(const wxString& location) const
+/* static */
+wxString wxFileSystemHandler::GetLeftLocation(const wxString& location)
{
int i;
- bool fnd;
+ bool fnd = false;
- fnd = FALSE;
- for (i = location.Length()-1; i >= 0; i--) {
- if ((location[i] == wxT(':')) && (i != 1 /*win: C:\path*/)) fnd = TRUE;
+ for (i = location.length()-1; i >= 0; i--) {
+ if ((location[i] == wxT(':')) && (i != 1 /*win: C:\path*/)) fnd = true;
else if (fnd && (location[i] == wxT('#'))) return location.Left(i);
}
return wxEmptyString;
}
-wxString wxFileSystemHandler::GetRightLocation(const wxString& location) const
+/* static */
+wxString wxFileSystemHandler::GetRightLocation(const wxString& location)
{
- int i, l = location.Length();
+ int i, l = location.length();
int l2 = l + 1;
- for (i = l-1; (i >= 0) && ((location[i] != wxT(':')) || (i == 1) || (location[i-2] == wxT(':'))); i--) {if (location[i] == wxT('#')) l2 = i + 1;}
+
+ for (i = l-1;
+ (i >= 0) &&
+ ((location[i] != wxT(':')) || (i == 1) || (location[i-2] == wxT(':')));
+ i--)
+ {
+ if (location[i] == wxT('#')) l2 = i + 1;
+ }
if (i == 0) return wxEmptyString;
else return location.Mid(i + 1, l2 - i - 2);
}
-wxString wxFileSystemHandler::GetAnchor(const wxString& location) const
+/* static */
+wxString wxFileSystemHandler::GetAnchor(const wxString& location)
{
- char c;
- int l = location.Length();
+ wxChar c;
+ int l = location.length();
for (int i = l-1; i >= 0; i--) {
c = location[i];
- if (c == wxT('#')) return location.Right(l-i-1);
- else if ((c == wxT('.')) || (c == wxT('/')) || (c == wxT('\\')) || (c == wxT(':'))) return wxEmptyString;
+ if (c == wxT('#'))
+ return location.Right(l-i-1);
+ else if ((c == wxT('/')) || (c == wxT('\\')) || (c == wxT(':')))
+ return wxEmptyString;
}
return wxEmptyString;
}
wxFSFile* wxLocalFSHandler::OpenFile(wxFileSystem& WXUNUSED(fs), const wxString& location)
{
// location has Unix path separators
- wxString right = ms_root + GetRightLocation(location);
- wxFileName fn(right, wxPATH_UNIX);
+ wxString right = GetRightLocation(location);
+ wxFileName fn = wxFileSystem::URLToFileName(right);
+ wxString fullpath = ms_root + fn.GetFullPath();
- if (!wxFileExists(fn.GetFullPath()))
+ if (!wxFileExists(fullpath))
return (wxFSFile*) NULL;
- return new wxFSFile(new wxFFileInputStream(fn.GetFullPath()),
- right,
- GetMimeTypeFromExt(location),
- GetAnchor(location),
- wxDateTime(wxFileModificationTime(fn.GetFullPath())));
+ // we need to check whether we can really read from this file, otherwise
+ // wxFSFile is not going to work
+#if wxUSE_FFILE
+ wxFFileInputStream *is = new wxFFileInputStream(fullpath);
+#elif wxUSE_FILE
+ wxFileInputStream *is = new wxFileInputStream(fullpath);
+#else
+#error One of wxUSE_FILE or wxUSE_FFILE must be set to 1 for wxFSHandler to work
+#endif
+ if ( !is->Ok() )
+ {
+ delete is;
+ return (wxFSFile*) NULL;
+ }
+ return new wxFSFile(is,
+ right,
+ wxEmptyString,
+ GetAnchor(location)
+#if wxUSE_DATETIME
+ ,wxDateTime(wxFileModificationTime(fullpath))
+#endif // wxUSE_DATETIME
+ );
}
wxString wxLocalFSHandler::FindFirst(const wxString& spec, int flags)
{
- wxString right = ms_root + GetRightLocation(spec);
- return wxFindFirstFile(right, flags);
+ wxFileName fn = wxFileSystem::URLToFileName(GetRightLocation(spec));
+ return wxFindFirstFile(ms_root + fn.GetFullPath(), flags);
}
wxString wxLocalFSHandler::FindNext()
wxList wxFileSystem::m_Handlers;
+wxFileSystem::~wxFileSystem()
+{
+ WX_CLEAR_HASH_MAP(wxFSHandlerHash, m_LocalHandlers)
+}
+
+
static wxString MakeCorrectPath(const wxString& path)
{
wxString p(path);
wxString r;
int i, j, cnt;
- cnt = p.Length();
+ cnt = p.length();
for (i = 0; i < cnt; i++)
if (p.GetChar(i) == wxT('\\')) p.GetWritableChar(i) = wxT('/'); // Want to be windows-safe
r << p.GetChar(i);
if (p.GetChar(i) == wxT('/') && p.GetChar(i-1) == wxT('.') && p.GetChar(i-2) == wxT('.'))
{
- for (j = r.Length() - 2; j >= 0 && r.GetChar(j) != wxT('/') && r.GetChar(j) != wxT(':'); j--) {}
+ for (j = r.length() - 2; j >= 0 && r.GetChar(j) != wxT('/') && r.GetChar(j) != wxT(':'); j--) {}
if (j >= 0 && r.GetChar(j) != wxT(':'))
{
for (j = j - 1; j >= 0 && r.GetChar(j) != wxT('/') && r.GetChar(j) != wxT(':'); j--) {}
if (is_dir)
{
- if (m_Path.Length() > 0 && m_Path.Last() != wxT('/') && m_Path.Last() != wxT(':'))
+ if (m_Path.length() > 0 && m_Path.Last() != wxT('/') && m_Path.Last() != wxT(':'))
m_Path << wxT('/');
}
else
{
- for (i = m_Path.Length()-1; i >= 0; i--)
+ for (i = m_Path.length()-1; i >= 0; i--)
{
if (m_Path[(unsigned int) i] == wxT('/'))
{
}
if (pathpos == -1)
{
- for (i = 0; i < (int) m_Path.Length(); i++)
+ for (i = 0; i < (int) m_Path.length(); i++)
{
if (m_Path[(unsigned int) i] == wxT(':'))
{
break;
}
}
- if (i == (int) m_Path.Length())
+ if (i == (int) m_Path.length())
m_Path = wxEmptyString;
}
else
-wxFSFile* wxFileSystem::OpenFile(const wxString& location)
+wxFileSystemHandler *wxFileSystem::MakeLocal(wxFileSystemHandler *h)
+{
+ wxClassInfo *classinfo = h->GetClassInfo();
+
+ if (classinfo->IsDynamic())
+ {
+ wxFileSystemHandler*& local = m_LocalHandlers[classinfo];
+ if (!local)
+ local = (wxFileSystemHandler*)classinfo->CreateObject();
+ return local;
+ }
+ else
+ {
+ return h;
+ }
+}
+
+
+
+wxFSFile* wxFileSystem::OpenFile(const wxString& location, int flags)
{
+ if ((flags & wxFS_READ) == 0)
+ return NULL;
+
wxString loc = MakeCorrectPath(location);
unsigned i, ln;
- char meta;
+ wxChar meta;
wxFSFile *s = NULL;
- wxNode *node;
+ wxList::compatibility_iterator node;
- ln = loc.Length();
+ ln = loc.length();
meta = 0;
for (i = 0; i < ln; i++)
{
- switch (loc[i])
+ switch ( loc[i].GetValue() )
{
case wxT('/') : case wxT(':') : case wxT('#') :
meta = loc[i];
wxFileSystemHandler *h = (wxFileSystemHandler*) node -> GetData();
if (h->CanOpen(m_Path + loc))
{
- s = h->OpenFile(*this, m_Path + loc);
+ s = MakeLocal(h)->OpenFile(*this, m_Path + loc);
if (s) { m_LastName = m_Path + loc; break; }
}
node = node->GetNext();
wxFileSystemHandler *h = (wxFileSystemHandler*) node->GetData();
if (h->CanOpen(loc))
{
- s = h->OpenFile(*this, loc);
+ s = MakeLocal(h)->OpenFile(*this, loc);
if (s) { m_LastName = loc; break; }
}
node = node->GetNext();
}
}
+
+ if (s && (flags & wxFS_SEEKABLE) != 0 && !s->GetStream()->IsSeekable())
+ {
+ wxBackedInputStream *stream;
+ stream = new wxBackedInputStream(s->DetachStream());
+ stream->FindLength();
+ s->SetStream(stream);
+ }
+
return (s);
}
wxString wxFileSystem::FindFirst(const wxString& spec, int flags)
{
- wxNode *node;
+ wxList::compatibility_iterator node;
wxString spec2(spec);
m_FindFileHandler = NULL;
- for (int i = spec2.Length()-1; i >= 0; i--)
+ for (int i = spec2.length()-1; i >= 0; i--)
if (spec2[(unsigned int) i] == wxT('\\')) spec2.GetWritableChar(i) = wxT('/'); // Want to be windows-safe
node = m_Handlers.GetFirst();
while (node)
{
- m_FindFileHandler = (wxFileSystemHandler*) node -> GetData();
- if (m_FindFileHandler -> CanOpen(m_Path + spec2))
+ wxFileSystemHandler *h = (wxFileSystemHandler*) node -> GetData();
+ if (h -> CanOpen(m_Path + spec2))
+ {
+ m_FindFileHandler = MakeLocal(h);
return m_FindFileHandler -> FindFirst(m_Path + spec2, flags);
+ }
node = node->GetNext();
}
node = m_Handlers.GetFirst();
while (node)
{
- m_FindFileHandler = (wxFileSystemHandler*) node -> GetData();
- if (m_FindFileHandler -> CanOpen(spec2))
+ wxFileSystemHandler *h = (wxFileSystemHandler*) node -> GetData();
+ if (h -> CanOpen(spec2))
+ {
+ m_FindFileHandler = MakeLocal(h);
return m_FindFileHandler -> FindFirst(spec2, flags);
+ }
node = node->GetNext();
}
else return m_FindFileHandler -> FindNext();
}
+bool wxFileSystem::FindFileInPath(wxString *pStr,
+ const wxString& path,
+ const wxString& basename)
+{
+ // we assume that it's not empty
+ wxCHECK_MSG( !basename.empty(), false,
+ _T("empty file name in wxFileSystem::FindFileInPath"));
+
+ wxString name;
+ // skip path separator in the beginning of the file name if present
+ if ( wxIsPathSeparator(basename[0u]) )
+ name = basename.substr(1);
+ else
+ name = basename;
+ wxStringTokenizer tokenizer(path, wxPATH_SEP);
+ while ( tokenizer.HasMoreTokens() )
+ {
+ wxString strFile = tokenizer.GetNextToken();
+ if ( !wxEndsWithPathSeparator(strFile) )
+ strFile += wxFILE_SEP_PATH;
+ strFile += name;
+
+ wxFSFile *file = OpenFile(strFile);
+ if ( file )
+ {
+ delete file;
+ *pStr = strFile;
+ return true;
+ }
+ }
+
+ return false;
+}
void wxFileSystem::AddHandler(wxFileSystemHandler *handler)
{
- m_Handlers.Append(handler);
+ // prepend the handler to the beginning of the list because handlers added
+ // last should have the highest priority to allow overriding them
+ m_Handlers.Insert((size_t)0, handler);
}
+wxFileSystemHandler* wxFileSystem::RemoveHandler(wxFileSystemHandler *handler)
+{
+ // if handler has already been removed (or deleted)
+ // we return NULL. This is by design in case
+ // CleanUpHandlers() is called before RemoveHandler
+ // is called, as we cannot control the order
+ // which modules are unloaded
+ if (!m_Handlers.DeleteObject(handler))
+ return NULL;
+
+ return handler;
+}
+
+
+bool wxFileSystem::HasHandlerForPath(const wxString &location)
+{
+ for ( wxList::compatibility_iterator node = m_Handlers.GetFirst();
+ node; node = node->GetNext() )
+ {
+ wxFileSystemHandler *h = (wxFileSystemHandler*) node->GetData();
+ if (h->CanOpen(location))
+ return true;
+ }
+
+ return false;
+}
void wxFileSystem::CleanUpHandlers()
{
- m_Handlers.DeleteContents(TRUE);
- m_Handlers.Clear();
+ WX_CLEAR_LIST(wxList, m_Handlers);
+}
+
+static const wxString g_unixPathString(wxT("/"));
+static const wxString g_nativePathString(wxFILE_SEP_PATH);
+
+// Returns the native path for a file URL
+wxFileName wxFileSystem::URLToFileName(const wxString& url)
+{
+ wxString path = url;
+
+ if ( path.Find(wxT("file://")) == 0 )
+ {
+ path = path.Mid(7);
+ }
+ else if ( path.Find(wxT("file:")) == 0 )
+ {
+ path = path.Mid(5);
+ }
+ // Remove preceding double slash on Mac Classic
+#if defined(__WXMAC__) && !defined(__UNIX__)
+ else if ( path.Find(wxT("//")) == 0 )
+ path = path.Mid(2);
+#endif
+
+ path = wxURI::Unescape(path);
+
+#ifdef __WXMSW__
+ // file urls either start with a forward slash (local harddisk),
+ // otherwise they have a servername/sharename notation,
+ // which only exists on msw and corresponds to a unc
+ if ( path[0u] == wxT('/') && path [1u] != wxT('/'))
+ {
+ path = path.Mid(1);
+ }
+ else if ( (url.Find(wxT("file://")) == 0) &&
+ (path.Find(wxT('/')) != wxNOT_FOUND) &&
+ (path.length() > 1) && (path[1u] != wxT(':')) )
+ {
+ path = wxT("//") + path;
+ }
+#endif
+
+ path.Replace(g_unixPathString, g_nativePathString);
+
+ return wxFileName(path, wxPATH_NATIVE);
}
+// Returns the file URL for a native path
+wxString wxFileSystem::FileNameToURL(const wxFileName& filename)
+{
+ wxFileName fn = filename;
+ fn.Normalize(wxPATH_NORM_DOTS | wxPATH_NORM_TILDE | wxPATH_NORM_ABSOLUTE);
+ wxString url = fn.GetFullPath(wxPATH_NATIVE);
+
+#ifndef __UNIX__
+ // unc notation, wxMSW
+ if ( url.Find(wxT("\\\\")) == 0 )
+ {
+ url = wxT("//") + url.Mid(2);
+ }
+ else
+ {
+ url = wxT("/") + url;
+#ifdef __WXMAC__
+ url = wxT("/") + url;
+#endif
+
+ }
+#endif
+ url.Replace(g_nativePathString, g_unixPathString);
+ url.Replace(wxT("%"), wxT("%25")); // '%'s must be replaced first!
+ url.Replace(wxT("#"), wxT("%23"));
+
+ // notice that all colons *must* be encoded in the paths used by
+ // wxFileSystem even though this makes URLs produced by this method
+ // unusable with IE under Windows as it requires "file:///c:/foo.bar" and
+ // doesn't accept "file:///c%3a/foo.bar" -- but then we never made any
+ // guarantees about general suitability of the strings returned by this
+ // method, they must work with wxFileSystem only and not encoding the colon
+ // breaks handling of "http://wherever/whatever.zip#zip:filename.ext" URLs
+ // so we really can't do this without heavy changes to the parsing code
+ // here, in particular in GetRightLocation()
+ url.Replace(wxT(":"), wxT("%3A"));
+ url = wxT("file:") + url;
+ return url;
+}
///// Module:
DECLARE_DYNAMIC_CLASS(wxFileSystemModule)
public:
+ wxFileSystemModule() :
+ wxModule(),
+ m_handler(NULL)
+ {
+ }
+
virtual bool OnInit()
{
- wxFileSystem::AddHandler(new wxLocalFSHandler);
-
- #if wxUSE_MIMETYPE
- gs_FSMimeFallbacks = new wxFileTypeInfo[6];
- gs_FSMimeFallbacks[0] =
- wxFileTypeInfo("image/jpeg",
- "",
- "",
- "JPEG image (from fallback)",
- "jpg", "jpeg", NULL);
- gs_FSMimeFallbacks[1] =
- wxFileTypeInfo("image/gif",
- "",
- "",
- "GIF image (from fallback)",
- "gif", NULL);
- gs_FSMimeFallbacks[2] =
- wxFileTypeInfo("image/png",
- "",
- "",
- "PNG image (from fallback)",
- "png", NULL);
- gs_FSMimeFallbacks[3] =
- wxFileTypeInfo("image/bmp",
- "",
- "",
- "windows bitmap image (from fallback)",
- "bmp", NULL);
- gs_FSMimeFallbacks[4] =
- wxFileTypeInfo("text/html",
- "",
- "",
- "HTML document (from fallback)",
- "htm", "html", NULL);
- gs_FSMimeFallbacks[5] =
- // must terminate the table with this!
- wxFileTypeInfo();
- #endif
- return TRUE;
+ m_handler = new wxLocalFSHandler;
+ wxFileSystem::AddHandler(m_handler);
+ return true;
}
virtual void OnExit()
{
- #if wxUSE_MIMETYPE
- delete [] gs_FSMimeFallbacks;
- #endif
+ delete wxFileSystem::RemoveHandler(m_handler);
+
wxFileSystem::CleanUpHandlers();
}
+
+ private:
+ wxFileSystemHandler* m_handler;
+
};
IMPLEMENT_DYNAMIC_CLASS(wxFileSystemModule, wxModule)
#endif
// wxUSE_FILESYSTEM
-
-
-