X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/53b9981048b3b67234bd4fa4c85fe8758eb3c21b..8472511246c9160d4ff40ab86f635fc67c10b54a:/src/common/filesys.cpp diff --git a/src/common/filesys.cpp b/src/common/filesys.cpp index 4fe96086a7..ad395361ce 100644 --- a/src/common/filesys.cpp +++ b/src/common/filesys.cpp @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: filesys.cpp +// Name: src/common/filesys.cpp // Purpose: wxFileSystem class - interface for opening files // Author: Vaclav Slavik // Copyright: (c) 1999 Vaclav Slavik @@ -7,40 +7,59 @@ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) -#pragma implementation "filesys.h" -#endif - #include "wx/wxprec.h" #ifdef __BORLANDC__ -#pragma hdrstop + #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/sysopt.h" +#include "wx/wfstream.h" #include "wx/mimetype.h" #include "wx/filename.h" -#include "wx/log.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) +/* static */ wxString wxFileSystemHandler::GetMimeTypeFromExt(const wxString& location) { wxString ext, mime; wxString loc = GetRightLocation(location); wxChar c; - int l = loc.Length(), l2; + int l = loc.length(), l2; l2 = l; for (int i = l-1; i >= 0; i--) @@ -59,72 +78,83 @@ wxString wxFileSystemHandler::GetMimeTypeFromExt(const wxString& location) #if wxUSE_MIMETYPE static bool s_MinimalMimeEnsured = false; - if (!s_MinimalMimeEnsured) + + // Don't use mime types manager if the application doesn't need it and it would be + // cause an unacceptable delay, especially on startup. +#if wxUSE_SYSTEM_OPTIONS + if ( !wxSystemOptions::GetOptionInt(wxT("filesys.no-mimetypesmanager")) ) +#endif { - static const wxFileTypeInfo fallbacks[] = + if (!s_MinimalMimeEnsured) { - wxFileTypeInfo(_T("image/jpeg"), - _T(""), - _T(""), - _T("JPEG image (from fallback)"), - _T("jpg"), _T("jpeg"), _T("JPG"), _T("JPEG"), NULL), - wxFileTypeInfo(_T("image/gif"), - _T(""), - _T(""), - _T("GIF image (from fallback)"), - _T("gif"), _T("GIF"), NULL), - wxFileTypeInfo(_T("image/png"), - _T(""), - _T(""), - _T("PNG image (from fallback)"), - _T("png"), _T("PNG"), NULL), - wxFileTypeInfo(_T("image/bmp"), - _T(""), - _T(""), - _T("windows bitmap image (from fallback)"), - _T("bmp"), _T("BMP"), NULL), - wxFileTypeInfo(_T("text/html"), - _T(""), - _T(""), - _T("HTML document (from fallback)"), - _T("htm"), _T("html"), _T("HTM"), _T("HTML"), NULL), - // must terminate the table with this! - wxFileTypeInfo() - }; - wxTheMimeTypesManager->AddFallbacks(fallbacks); - s_MinimalMimeEnsured = true; - } + static const wxFileTypeInfo fallbacks[] = + { + wxFileTypeInfo(wxT("image/jpeg"), + wxEmptyString, + wxEmptyString, + wxT("JPEG image (from fallback)"), + wxT("jpg"), wxT("jpeg"), wxT("JPG"), wxT("JPEG"), wxNullPtr), + wxFileTypeInfo(wxT("image/gif"), + wxEmptyString, + wxEmptyString, + wxT("GIF image (from fallback)"), + wxT("gif"), wxT("GIF"), wxNullPtr), + wxFileTypeInfo(wxT("image/png"), + wxEmptyString, + wxEmptyString, + wxT("PNG image (from fallback)"), + wxT("png"), wxT("PNG"), wxNullPtr), + wxFileTypeInfo(wxT("image/bmp"), + wxEmptyString, + wxEmptyString, + wxT("windows bitmap image (from fallback)"), + wxT("bmp"), wxT("BMP"), wxNullPtr), + wxFileTypeInfo(wxT("text/html"), + wxEmptyString, + wxEmptyString, + wxT("HTML document (from fallback)"), + wxT("htm"), wxT("html"), wxT("HTM"), wxT("HTML"), wxNullPtr), + // must terminate the table with this! + wxFileTypeInfo() + }; + wxTheMimeTypesManager->AddFallbacks(fallbacks); + s_MinimalMimeEnsured = true; + } - wxFileType *ft = wxTheMimeTypesManager->GetFileTypeFromExtension(ext); - if ( !ft || !ft -> GetMimeType(&mime) ) - { - mime = wxEmptyString; - } + wxFileType *ft = wxTheMimeTypesManager->GetFileTypeFromExtension(ext); + if ( !ft || !ft -> GetMimeType(&mime) ) + { + mime = wxEmptyString; + } - delete ft; + delete ft; - return mime; -#else - 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) ) - return wxT("image/jpeg"); - if ( ext.IsSameAs(wxT("gif"), false) ) - return wxT("image/gif"); - if ( ext.IsSameAs(wxT("png"), false) ) - return wxT("image/png"); - if ( ext.IsSameAs(wxT("bmp"), false) ) - return wxT("image/bmp"); - return wxEmptyString; + return mime; + } + else #endif + { + if ( ext.IsSameAs(wxT("htm"), false) || ext.IsSameAs(wxT("html"), false) ) + return wxT("text/html"); + if ( ext.IsSameAs(wxT("jpg"), false) || ext.IsSameAs(wxT("jpeg"), false) ) + return wxT("image/jpeg"); + if ( ext.IsSameAs(wxT("gif"), false) ) + return wxT("image/gif"); + if ( ext.IsSameAs(wxT("png"), false) ) + return wxT("image/png"); + if ( ext.IsSameAs(wxT("bmp"), false) ) + return wxT("image/bmp"); + return wxEmptyString; + } } -wxString wxFileSystemHandler::GetProtocol(const wxString& location) const +/* static */ +wxString wxFileSystemHandler::GetProtocol(const wxString& location) { wxString s = wxEmptyString; - int i, l = location.Length(); + int i, l = location.length(); bool fnd = false; for (i = l-1; (i >= 0) && ((location[i] != wxT('#')) || (!fnd)); i--) { @@ -136,21 +166,23 @@ wxString wxFileSystemHandler::GetProtocol(const wxString& location) const } -wxString wxFileSystemHandler::GetLeftLocation(const wxString& location) const +/* static */ +wxString wxFileSystemHandler::GetLeftLocation(const wxString& location) { int i; bool fnd = false; - for (i = location.Length()-1; i >= 0; i--) { + 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; @@ -164,15 +196,18 @@ wxString wxFileSystemHandler::GetRightLocation(const wxString& location) const else return location.Mid(i + 1, l2 - i - 2); } -wxString wxFileSystemHandler::GetAnchor(const wxString& location) const +/* static */ +wxString wxFileSystemHandler::GetAnchor(const wxString& location) { wxChar c; - int l = location.Length(); + 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; } @@ -209,20 +244,26 @@ wxFSFile* wxLocalFSHandler::OpenFile(wxFileSystem& WXUNUSED(fs), const wxString& wxString fullpath = ms_root + fn.GetFullPath(); if (!wxFileExists(fullpath)) - return (wxFSFile*) NULL; + return NULL; // 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); - if ( !is->Ok() ) +#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->IsOk() ) { delete is; - return (wxFSFile*) NULL; + return NULL; } return new wxFSFile(is, - right, - GetMimeTypeFromExt(location), + location, + wxEmptyString, GetAnchor(location) #if wxUSE_DATETIME ,wxDateTime(wxFileModificationTime(fullpath)) @@ -233,12 +274,18 @@ wxFSFile* wxLocalFSHandler::OpenFile(wxFileSystem& WXUNUSED(fs), const wxString& wxString wxLocalFSHandler::FindFirst(const wxString& spec, int flags) { wxFileName fn = wxFileSystem::URLToFileName(GetRightLocation(spec)); - return wxFindFirstFile(ms_root + fn.GetFullPath(), flags); + const wxString found = wxFindFirstFile(ms_root + fn.GetFullPath(), flags); + if ( found.empty() ) + return found; + return wxFileSystem::FileNameToURL(found); } wxString wxLocalFSHandler::FindNext() { - return wxFindNextFile(); + const wxString found = wxFindNextFile(); + if ( found.empty() ) + return found; + return wxFileSystem::FileNameToURL(found); } @@ -254,13 +301,19 @@ IMPLEMENT_ABSTRACT_CLASS(wxFSFile, wxObject) 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 @@ -279,7 +332,7 @@ static wxString MakeCorrectPath(const wxString& path) 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--) {} @@ -302,13 +355,13 @@ void wxFileSystem::ChangePathTo(const wxString& location, bool is_dir) if (is_dir) { - if (m_Path.Length() > 0 && m_Path.Last() != wxT('/') && m_Path.Last() != wxT(':')) + if (!m_Path.empty() && 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('/')) { @@ -330,7 +383,7 @@ void wxFileSystem::ChangePathTo(const wxString& location, bool is_dir) } 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(':')) { @@ -338,7 +391,7 @@ void wxFileSystem::ChangePathTo(const wxString& location, bool is_dir) break; } } - if (i == (int) m_Path.Length()) + if (i == (int) m_Path.length()) m_Path = wxEmptyString; } else @@ -350,19 +403,41 @@ void wxFileSystem::ChangePathTo(const wxString& location, bool is_dir) -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; wxChar meta; wxFSFile *s = NULL; 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]; @@ -381,7 +456,7 @@ wxFSFile* wxFileSystem::OpenFile(const wxString& location) 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(); @@ -397,12 +472,21 @@ wxFSFile* wxFileSystem::OpenFile(const wxString& location) 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); } @@ -415,24 +499,30 @@ wxString wxFileSystem::FindFirst(const wxString& spec, int flags) 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(); } @@ -447,21 +537,82 @@ wxString wxFileSystem::FindNext() 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, + wxT("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() { WX_CLEAR_LIST(wxList, m_Handlers); } -const static wxString g_unixPathString(wxT("/")); -const static wxString g_nativePathString(wxFILE_SEP_PATH); +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) @@ -482,20 +633,19 @@ wxFileName wxFileSystem::URLToFileName(const wxString& url) path = path.Mid(2); #endif - path.Replace(wxT("%25"), wxT("%")); - path.Replace(wxT("%3A"), wxT(":")); + path = wxURI::Unescape(path); -#ifdef __WXMSW__ +#ifdef __WINDOWS__ // 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('/')) + if ( path.length() > 1 && (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.length() > 1) && (path[1u] != wxT(':')) ) { path = wxT("//") + path; } @@ -506,6 +656,42 @@ wxFileName wxFileSystem::URLToFileName(const wxString& url) return wxFileName(path, wxPATH_NATIVE); } +// Escapes non-ASCII and others characters in file: URL to be valid URLs +static wxString EscapeFileNameCharsInURL(const char *in) +{ + wxString s; + + for ( const unsigned char *p = (const unsigned char*)in; *p; ++p ) + { + const unsigned char c = *p; + + // 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() + + if ( c == '/' || c == '-' || c == '.' || c == '_' || c == '~' || + (c >= '0' && c <= '9') || + (c >= 'a' && c <= 'z') || + (c >= 'A' && c <= 'Z') ) + { + s << c; + } + else + { + s << wxString::Format("%%%02x", c); + } + } + + return s; +} + // Returns the file URL for a native path wxString wxFileSystem::FileNameToURL(const wxFileName& filename) { @@ -530,10 +716,10 @@ wxString wxFileSystem::FileNameToURL(const wxFileName& filename) #endif url.Replace(g_nativePathString, g_unixPathString); - url.Replace(wxT("%"), wxT("%25")); - url.Replace(wxT(":"), wxT("%3A")); - url = wxT("file:") + url; - return url; + + // Do wxURI- and common practice-compatible escaping: encode the string + // into UTF-8, then escape anything non-ASCII: + return wxT("file:") + EscapeFileNameCharsInURL(url.utf8_str()); } @@ -544,21 +730,55 @@ class wxFileSystemModule : public wxModule DECLARE_DYNAMIC_CLASS(wxFileSystemModule) public: + wxFileSystemModule() : + wxModule(), + m_handler(NULL) + { + } + virtual bool OnInit() { - wxFileSystem::AddHandler(new wxLocalFSHandler); + m_handler = new wxLocalFSHandler; + wxFileSystem::AddHandler(m_handler); return true; } virtual void OnExit() { + delete wxFileSystem::RemoveHandler(m_handler); + wxFileSystem::CleanUpHandlers(); } + + private: + wxFileSystemHandler* m_handler; + }; IMPLEMENT_DYNAMIC_CLASS(wxFileSystemModule, wxModule) -#endif - // wxUSE_FILESYSTEM +//// wxFSInputStream +wxFSInputStream::wxFSInputStream(const wxString& filename, int flags) +{ + wxFileSystem fs; + m_file = fs.OpenFile(filename, flags | wxFS_READ); + if ( m_file ) + { + wxInputStream* const stream = m_file->GetStream(); + if ( stream ) + { + // Notice that we pass the stream by reference: it shouldn't be + // deleted by us as it's owned by m_file already. + InitParentStream(*stream); + } + } +} + +wxFSInputStream::~wxFSInputStream() +{ + delete m_file; +} +#endif + // wxUSE_FILESYSTEM