1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/filesys.cpp
3 // Purpose: wxFileSystem class - interface for opening files
4 // Author: Vaclav Slavik
5 // Copyright: (c) 1999 Vaclav Slavik
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
10 #include "wx/wxprec.h"
19 #include "wx/filesys.h"
25 #include "wx/wfstream.h"
26 #include "wx/module.h"
27 #include "wx/mimetype.h"
28 #include "wx/filename.h"
29 #include "wx/tokenzr.h"
32 //--------------------------------------------------------------------------------
33 // wxFileSystemHandler
34 //--------------------------------------------------------------------------------
36 IMPLEMENT_ABSTRACT_CLASS(wxFileSystemHandler
, wxObject
)
39 wxString
wxFileSystemHandler::GetMimeTypeFromExt(const wxString
& location
)
42 wxString loc
= GetRightLocation(location
);
44 int l
= loc
.length(), l2
;
47 for (int i
= l
-1; i
>= 0; i
--)
49 c
= loc
[(unsigned int) i
];
54 ext
= loc
.Right(l2
-i
-1);
57 if ( (c
== wxT('/')) || (c
== wxT('\\')) || (c
== wxT(':')) )
62 static bool s_MinimalMimeEnsured
= false;
63 if (!s_MinimalMimeEnsured
)
65 static const wxFileTypeInfo fallbacks
[] =
67 wxFileTypeInfo(_T("image/jpeg"),
70 _T("JPEG image (from fallback)"),
71 _T("jpg"), _T("jpeg"), _T("JPG"), _T("JPEG"), NULL
),
72 wxFileTypeInfo(_T("image/gif"),
75 _T("GIF image (from fallback)"),
76 _T("gif"), _T("GIF"), NULL
),
77 wxFileTypeInfo(_T("image/png"),
80 _T("PNG image (from fallback)"),
81 _T("png"), _T("PNG"), NULL
),
82 wxFileTypeInfo(_T("image/bmp"),
85 _T("windows bitmap image (from fallback)"),
86 _T("bmp"), _T("BMP"), NULL
),
87 wxFileTypeInfo(_T("text/html"),
90 _T("HTML document (from fallback)"),
91 _T("htm"), _T("html"), _T("HTM"), _T("HTML"), NULL
),
92 // must terminate the table with this!
95 wxTheMimeTypesManager
->AddFallbacks(fallbacks
);
96 s_MinimalMimeEnsured
= true;
99 wxFileType
*ft
= wxTheMimeTypesManager
->GetFileTypeFromExtension(ext
);
100 if ( !ft
|| !ft
-> GetMimeType(&mime
) )
102 mime
= wxEmptyString
;
109 if ( ext
.IsSameAs(wxT("htm"), false) || ext
.IsSameAs(_T("html"), false) )
110 return wxT("text/html");
111 if ( ext
.IsSameAs(wxT("jpg"), false) || ext
.IsSameAs(_T("jpeg"), false) )
112 return wxT("image/jpeg");
113 if ( ext
.IsSameAs(wxT("gif"), false) )
114 return wxT("image/gif");
115 if ( ext
.IsSameAs(wxT("png"), false) )
116 return wxT("image/png");
117 if ( ext
.IsSameAs(wxT("bmp"), false) )
118 return wxT("image/bmp");
119 return wxEmptyString
;
125 wxString
wxFileSystemHandler::GetProtocol(const wxString
& location
) const
127 wxString s
= wxEmptyString
;
128 int i
, l
= location
.length();
131 for (i
= l
-1; (i
>= 0) && ((location
[i
] != wxT('#')) || (!fnd
)); i
--) {
132 if ((location
[i
] == wxT(':')) && (i
!= 1 /*win: C:\path*/)) fnd
= true;
134 if (!fnd
) return wxT("file");
135 for (++i
; (i
< l
) && (location
[i
] != wxT(':')); i
++) s
<< location
[i
];
140 wxString
wxFileSystemHandler::GetLeftLocation(const wxString
& location
) const
145 for (i
= location
.length()-1; i
>= 0; i
--) {
146 if ((location
[i
] == wxT(':')) && (i
!= 1 /*win: C:\path*/)) fnd
= true;
147 else if (fnd
&& (location
[i
] == wxT('#'))) return location
.Left(i
);
149 return wxEmptyString
;
152 wxString
wxFileSystemHandler::GetRightLocation(const wxString
& location
) const
154 int i
, l
= location
.length();
159 ((location
[i
] != wxT(':')) || (i
== 1) || (location
[i
-2] == wxT(':')));
162 if (location
[i
] == wxT('#')) l2
= i
+ 1;
164 if (i
== 0) return wxEmptyString
;
165 else return location
.Mid(i
+ 1, l2
- i
- 2);
168 wxString
wxFileSystemHandler::GetAnchor(const wxString
& location
) const
171 int l
= location
.length();
173 for (int i
= l
-1; i
>= 0; i
--) {
175 if (c
== wxT('#')) return location
.Right(l
-i
-1);
176 else if ((c
== wxT('.')) || (c
== wxT('/')) || (c
== wxT('\\')) || (c
== wxT(':'))) return wxEmptyString
;
178 return wxEmptyString
;
182 wxString
wxFileSystemHandler::FindFirst(const wxString
& WXUNUSED(spec
),
185 return wxEmptyString
;
188 wxString
wxFileSystemHandler::FindNext()
190 return wxEmptyString
;
193 //--------------------------------------------------------------------------------
195 //--------------------------------------------------------------------------------
198 wxString
wxLocalFSHandler::ms_root
;
200 bool wxLocalFSHandler::CanOpen(const wxString
& location
)
202 return GetProtocol(location
) == wxT("file");
205 wxFSFile
* wxLocalFSHandler::OpenFile(wxFileSystem
& WXUNUSED(fs
), const wxString
& location
)
207 // location has Unix path separators
208 wxString right
= GetRightLocation(location
);
209 wxFileName fn
= wxFileSystem::URLToFileName(right
);
210 wxString fullpath
= ms_root
+ fn
.GetFullPath();
212 if (!wxFileExists(fullpath
))
213 return (wxFSFile
*) NULL
;
215 // we need to check whether we can really read from this file, otherwise
216 // wxFSFile is not going to work
217 wxFFileInputStream
*is
= new wxFFileInputStream(fullpath
);
221 return (wxFSFile
*) NULL
;
224 return new wxFSFile(is
,
226 GetMimeTypeFromExt(location
),
229 ,wxDateTime(wxFileModificationTime(fullpath
))
230 #endif // wxUSE_DATETIME
234 wxString
wxLocalFSHandler::FindFirst(const wxString
& spec
, int flags
)
236 wxFileName fn
= wxFileSystem::URLToFileName(GetRightLocation(spec
));
237 return wxFindFirstFile(ms_root
+ fn
.GetFullPath(), flags
);
240 wxString
wxLocalFSHandler::FindNext()
242 return wxFindNextFile();
247 //-----------------------------------------------------------------------------
249 //-----------------------------------------------------------------------------
251 IMPLEMENT_DYNAMIC_CLASS(wxFileSystem
, wxObject
)
252 IMPLEMENT_ABSTRACT_CLASS(wxFSFile
, wxObject
)
255 wxList
wxFileSystem::m_Handlers
;
258 static wxString
MakeCorrectPath(const wxString
& path
)
265 for (i
= 0; i
< cnt
; i
++)
266 if (p
.GetChar(i
) == wxT('\\')) p
.GetWritableChar(i
) = wxT('/'); // Want to be windows-safe
268 if (p
.Left(2) == wxT("./")) { p
= p
.Mid(2); cnt
-= 2; }
270 if (cnt
< 3) return p
;
272 r
<< p
.GetChar(0) << p
.GetChar(1);
274 // skip trailing ../.., if any
275 for (i
= 2; i
< cnt
&& (p
.GetChar(i
) == wxT('/') || p
.GetChar(i
) == wxT('.')); i
++) r
<< p
.GetChar(i
);
277 // remove back references: translate dir1/../dir2 to dir2
281 if (p
.GetChar(i
) == wxT('/') && p
.GetChar(i
-1) == wxT('.') && p
.GetChar(i
-2) == wxT('.'))
283 for (j
= r
.length() - 2; j
>= 0 && r
.GetChar(j
) != wxT('/') && r
.GetChar(j
) != wxT(':'); j
--) {}
284 if (j
>= 0 && r
.GetChar(j
) != wxT(':'))
286 for (j
= j
- 1; j
>= 0 && r
.GetChar(j
) != wxT('/') && r
.GetChar(j
) != wxT(':'); j
--) {}
292 for (; i
< cnt
; i
++) r
<< p
.GetChar(i
);
298 void wxFileSystem::ChangePathTo(const wxString
& location
, bool is_dir
)
302 m_Path
= MakeCorrectPath(location
);
306 if (m_Path
.length() > 0 && m_Path
.Last() != wxT('/') && m_Path
.Last() != wxT(':'))
312 for (i
= m_Path
.length()-1; i
>= 0; i
--)
314 if (m_Path
[(unsigned int) i
] == wxT('/'))
316 if ((i
> 1) && (m_Path
[(unsigned int) (i
-1)] == wxT('/')) && (m_Path
[(unsigned int) (i
-2)] == wxT(':')))
327 else if (m_Path
[(unsigned int) i
] == wxT(':')) {
334 for (i
= 0; i
< (int) m_Path
.length(); i
++)
336 if (m_Path
[(unsigned int) i
] == wxT(':'))
342 if (i
== (int) m_Path
.length())
343 m_Path
= wxEmptyString
;
347 m_Path
.Remove(pathpos
+1);
354 wxFSFile
* wxFileSystem::OpenFile(const wxString
& location
)
356 wxString loc
= MakeCorrectPath(location
);
360 wxList::compatibility_iterator node
;
364 for (i
= 0; i
< ln
; i
++)
368 case wxT('/') : case wxT(':') : case wxT('#') :
372 if (meta
!= 0) break;
374 m_LastName
= wxEmptyString
;
376 // try relative paths first :
377 if (meta
!= wxT(':'))
379 node
= m_Handlers
.GetFirst();
382 wxFileSystemHandler
*h
= (wxFileSystemHandler
*) node
-> GetData();
383 if (h
->CanOpen(m_Path
+ loc
))
385 s
= h
->OpenFile(*this, m_Path
+ loc
);
386 if (s
) { m_LastName
= m_Path
+ loc
; break; }
388 node
= node
->GetNext();
392 // if failed, try absolute paths :
395 node
= m_Handlers
.GetFirst();
398 wxFileSystemHandler
*h
= (wxFileSystemHandler
*) node
->GetData();
401 s
= h
->OpenFile(*this, loc
);
402 if (s
) { m_LastName
= loc
; break; }
404 node
= node
->GetNext();
412 wxString
wxFileSystem::FindFirst(const wxString
& spec
, int flags
)
414 wxList::compatibility_iterator node
;
415 wxString
spec2(spec
);
417 m_FindFileHandler
= NULL
;
419 for (int i
= spec2
.length()-1; i
>= 0; i
--)
420 if (spec2
[(unsigned int) i
] == wxT('\\')) spec2
.GetWritableChar(i
) = wxT('/'); // Want to be windows-safe
422 node
= m_Handlers
.GetFirst();
425 m_FindFileHandler
= (wxFileSystemHandler
*) node
-> GetData();
426 if (m_FindFileHandler
-> CanOpen(m_Path
+ spec2
))
427 return m_FindFileHandler
-> FindFirst(m_Path
+ spec2
, flags
);
428 node
= node
->GetNext();
431 node
= m_Handlers
.GetFirst();
434 m_FindFileHandler
= (wxFileSystemHandler
*) node
-> GetData();
435 if (m_FindFileHandler
-> CanOpen(spec2
))
436 return m_FindFileHandler
-> FindFirst(spec2
, flags
);
437 node
= node
->GetNext();
440 return wxEmptyString
;
445 wxString
wxFileSystem::FindNext()
447 if (m_FindFileHandler
== NULL
) return wxEmptyString
;
448 else return m_FindFileHandler
-> FindNext();
451 bool wxFileSystem::FindFileInPath(wxString
*pStr
,
453 const wxChar
*basename
)
455 // we assume that it's not empty
456 wxCHECK_MSG( !wxIsEmpty(basename
), false,
457 _T("empty file name in wxFileSystem::FindFileInPath"));
459 // skip path separator in the beginning of the file name if present
460 if ( wxIsPathSeparator(*basename
) )
463 wxStringTokenizer
tokenizer(path
, wxPATH_SEP
);
464 while ( tokenizer
.HasMoreTokens() )
466 wxString strFile
= tokenizer
.GetNextToken();
467 if ( !wxEndsWithPathSeparator(strFile
) )
468 strFile
+= wxFILE_SEP_PATH
;
471 wxFSFile
*file
= OpenFile(strFile
);
483 void wxFileSystem::AddHandler(wxFileSystemHandler
*handler
)
485 // prepend the handler to the beginning of the list because handlers added
486 // last should have the highest priority to allow overriding them
487 m_Handlers
.Insert(0u, handler
);
490 bool wxFileSystem::HasHandlerForPath(const wxString
&location
)
492 for ( wxList::compatibility_iterator node
= m_Handlers
.GetFirst();
493 node
; node
= node
->GetNext() )
495 wxFileSystemHandler
*h
= (wxFileSystemHandler
*) node
->GetData();
496 if (h
->CanOpen(location
))
503 void wxFileSystem::CleanUpHandlers()
505 WX_CLEAR_LIST(wxList
, m_Handlers
);
508 static const wxString
g_unixPathString(wxT("/"));
509 static const wxString
g_nativePathString(wxFILE_SEP_PATH
);
511 // Returns the native path for a file URL
512 wxFileName
wxFileSystem::URLToFileName(const wxString
& url
)
516 if ( path
.Find(wxT("file://")) == 0 )
520 else if ( path
.Find(wxT("file:")) == 0 )
524 // Remove preceding double slash on Mac Classic
525 #if defined(__WXMAC__) && !defined(__UNIX__)
526 else if ( path
.Find(wxT("//")) == 0 )
530 path
.Replace(wxT("%25"), wxT("%"));
531 path
.Replace(wxT("%3A"), wxT(":"));
534 // file urls either start with a forward slash (local harddisk),
535 // otherwise they have a servername/sharename notation,
536 // which only exists on msw and corresponds to a unc
537 if ( path
[0u] == wxT('/') && path
[1u] != wxT('/'))
541 else if ( (url
.Find(wxT("file://")) == 0) &&
542 (path
.Find(wxT('/')) != wxNOT_FOUND
) &&
543 (path
.length() > 1) && (path
[1u] != wxT(':')) )
545 path
= wxT("//") + path
;
549 path
.Replace(g_unixPathString
, g_nativePathString
);
551 return wxFileName(path
, wxPATH_NATIVE
);
554 // Returns the file URL for a native path
555 wxString
wxFileSystem::FileNameToURL(const wxFileName
& filename
)
557 wxFileName fn
= filename
;
558 fn
.Normalize(wxPATH_NORM_DOTS
| wxPATH_NORM_TILDE
| wxPATH_NORM_ABSOLUTE
);
559 wxString url
= fn
.GetFullPath(wxPATH_NATIVE
);
562 // unc notation, wxMSW
563 if ( url
.Find(wxT("\\\\")) == 0 )
565 url
= wxT("//") + url
.Mid(2);
569 url
= wxT("/") + url
;
571 url
= wxT("/") + url
;
577 url
.Replace(g_nativePathString
, g_unixPathString
);
578 url
.Replace(wxT("%"), wxT("%25"));
579 url
.Replace(wxT(":"), wxT("%3A"));
580 url
= wxT("file:") + url
;
587 class wxFileSystemModule
: public wxModule
589 DECLARE_DYNAMIC_CLASS(wxFileSystemModule
)
592 virtual bool OnInit()
594 wxFileSystem::AddHandler(new wxLocalFSHandler
);
597 virtual void OnExit()
599 wxFileSystem::CleanUpHandlers();
603 IMPLEMENT_DYNAMIC_CLASS(wxFileSystemModule
, wxModule
)