src/common/filesys.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        filesys.cpp
   3 // Purpose:     wxFileSystem class - interface for opening files
   4 // Author:      Vaclav Slavik
   5 // Copyright:   (c) 1999 Vaclav Slavik
   6 // CVS-ID:      $Id$
   7 // Licence:     wxWindows Licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifdef __GNUG__
  11 #pragma implementation "filesys.h"
  12 #endif
  13
  14 #include "wx/wxprec.h"
  15
  16 #ifdef __BORLANDC__
  17 #pragma hdrstop
  18 #endif
  19
  20
  21 #if wxUSE_FILESYSTEM
  22
  23 #include "wx/wfstream.h"
  24 #include "wx/module.h"
  25 #include "wx/filesys.h"
  26 #include "wx/mimetype.h"
  27 #include "wx/filename.h"
  28
  29
  30
  31 //--------------------------------------------------------------------------------
  32 // wxFileSystemHandler
  33 //--------------------------------------------------------------------------------
  34
  35 IMPLEMENT_ABSTRACT_CLASS(wxFileSystemHandler, wxObject)
  36
  37
  38 #if wxUSE_MIMETYPE
  39 static wxFileTypeInfo *gs_FSMimeFallbacks = NULL;
  40 #endif
  41
  42 wxString wxFileSystemHandler::GetMimeTypeFromExt(const wxString& location)
  43 {
  44     wxString ext, mime;
  45     wxString loc = GetRightLocation(location);
  46     char c;
  47     int l = loc.Length(), l2;
  48
  49     l2 = l;
  50     for (int i = l-1; i >= 0; i--)
  51     {
  52         c = loc[(unsigned int) i];
  53         if ( c == wxT('#') )
  54             l2 = i + 1;
  55         if ( c == wxT('.') )
  56         {
  57             ext = loc.Right(l2-i-1);
  58             break;
  59         }
  60         if ( (c == wxT('/')) || (c == wxT('\\')) || (c == wxT(':')) )
  61             return wxEmptyString;
  62     }
  63
  64 #if wxUSE_MIMETYPE
  65     static bool s_MinimalMimeEnsured = FALSE;
  66     if (!s_MinimalMimeEnsured) {
  67         wxTheMimeTypesManager->AddFallbacks(gs_FSMimeFallbacks);
  68         s_MinimalMimeEnsured = TRUE;
  69     }
  70
  71     wxFileType *ft = wxTheMimeTypesManager->GetFileTypeFromExtension(ext);
  72     if ( !ft || !ft -> GetMimeType(&mime) )
  73     {
  74         mime = wxEmptyString;
  75     }
  76
  77     delete ft;
  78
  79     return mime;
  80 #else
  81     if ( ext.IsSameAs(wxT("htm"), FALSE) || ext.IsSameAs(_T("html"), FALSE) )
  82         return wxT("text/html");
  83     if ( ext.IsSameAs(wxT("jpg"), FALSE) || ext.IsSameAs(_T("jpeg"), FALSE) )
  84         return wxT("image/jpeg");
  85     if ( ext.IsSameAs(wxT("gif"), FALSE) )
  86         return wxT("image/gif");
  87     if ( ext.IsSameAs(wxT("png"), FALSE) )
  88         return wxT("image/png");
  89     if ( ext.IsSameAs(wxT("bmp"), FALSE) )
  90         return wxT("image/bmp");
  91     return wxEmptyString;
  92 #endif
  93 }
  94
  95
  96
  97 wxString wxFileSystemHandler::GetProtocol(const wxString& location) const
  98 {
  99     wxString s = wxEmptyString;
 100     int i, l = location.Length();
 101     bool fnd;
 102
 103     fnd = FALSE;
 104     for (i = l-1; (i >= 0) && ((location[i] != wxT('#')) || (!fnd)); i--) {
 105         if ((location[i] == wxT(':')) && (i != 1 /*win: C:\path*/)) fnd = TRUE;
 106     }
 107     if (!fnd) return wxT("file");
 108     for (++i; (i < l) && (location[i] != wxT(':')); i++) s << location[i];
 109     return s;
 110 }
 111
 112
 113 wxString wxFileSystemHandler::GetLeftLocation(const wxString& location) const
 114 {
 115     int i;
 116     bool fnd;
 117
 118     fnd = FALSE;
 119     for (i = location.Length()-1; i >= 0; i--) {
 120         if ((location[i] == wxT(':')) && (i != 1 /*win: C:\path*/)) fnd = TRUE;
 121         else if (fnd && (location[i] == wxT('#'))) return location.Left(i);
 122     }
 123     return wxEmptyString;
 124 }
 125
 126 wxString wxFileSystemHandler::GetRightLocation(const wxString& location) const
 127 {
 128     int i, l = location.Length();
 129     int l2 = l + 1;
 130     for (i = l-1; (i >= 0) && ((location[i] != wxT(':')) || (i == 1) || (location[i-2] == wxT(':'))); i--) {if (location[i] == wxT('#')) l2 = i + 1;}
 131     if (i == 0) return wxEmptyString;
 132     else return location.Mid(i + 1, l2 - i - 2);
 133 }
 134
 135 wxString wxFileSystemHandler::GetAnchor(const wxString& location) const
 136 {
 137     char c;
 138     int l = location.Length();
 139
 140     for (int i = l-1; i >= 0; i--) {
 141         c = location[i];
 142         if (c == wxT('#')) return location.Right(l-i-1);
 143         else if ((c == wxT('.')) || (c == wxT('/')) || (c == wxT('\\')) || (c == wxT(':'))) return wxEmptyString;
 144     }
 145     return wxEmptyString;
 146 }
 147
 148
 149 wxString wxFileSystemHandler::FindFirst(const wxString& WXUNUSED(spec),
 150                                         int WXUNUSED(flags))
 151 {
 152     return wxEmptyString;
 153 }
 154
 155 wxString wxFileSystemHandler::FindNext()
 156 {
 157     return wxEmptyString;
 158 }
 159
 160 //--------------------------------------------------------------------------------
 161 // wxLocalFSHandler
 162 //--------------------------------------------------------------------------------
 163
 164
 165 wxString wxLocalFSHandler::ms_root;
 166
 167 bool wxLocalFSHandler::CanOpen(const wxString& location)
 168 {
 169     return GetProtocol(location) == wxT("file");
 170 }
 171
 172 wxFSFile* wxLocalFSHandler::OpenFile(wxFileSystem& WXUNUSED(fs), const wxString& location)
 173 {
 174     // location has Unix path separators
 175     wxString right = ms_root + GetRightLocation(location);
 176     wxFileName fn = wxFileSystem::URLToFileName(right);
 177
 178     if (!wxFileExists(fn.GetFullPath()))
 179         return (wxFSFile*) NULL;
 180
 181     return new wxFSFile(new wxFFileInputStream(fn.GetFullPath()),
 182                         right,
 183                         GetMimeTypeFromExt(location),
 184                         GetAnchor(location),
 185                         wxDateTime(wxFileModificationTime(fn.GetFullPath())));
 186
 187 }
 188
 189 wxString wxLocalFSHandler::FindFirst(const wxString& spec, int flags)
 190 {
 191     wxString right = ms_root + GetRightLocation(spec);
 192     return wxFindFirstFile(wxFileSystem::URLToFileName(right).GetFullPath(),
 193                            flags);
 194 }
 195
 196 wxString wxLocalFSHandler::FindNext()
 197 {
 198     return wxFindNextFile();
 199 }
 200
 201
 202
 203 //-----------------------------------------------------------------------------
 204 // wxFileSystem
 205 //-----------------------------------------------------------------------------
 206
 207 IMPLEMENT_DYNAMIC_CLASS(wxFileSystem, wxObject)
 208 IMPLEMENT_ABSTRACT_CLASS(wxFSFile, wxObject)
 209
 210
 211 wxList wxFileSystem::m_Handlers;
 212
 213
 214 static wxString MakeCorrectPath(const wxString& path)
 215 {
 216     wxString p(path);
 217     wxString r;
 218     int i, j, cnt;
 219
 220     cnt = p.Length();
 221     for (i = 0; i < cnt; i++)
 222       if (p.GetChar(i) == wxT('\\')) p.GetWritableChar(i) = wxT('/'); // Want to be windows-safe
 223
 224     if (p.Left(2) == wxT("./")) { p = p.Mid(2); cnt -= 2; }
 225
 226     if (cnt < 3) return p;
 227
 228     r << p.GetChar(0) << p.GetChar(1);
 229
 230     // skip trailing ../.., if any
 231     for (i = 2; i < cnt && (p.GetChar(i) == wxT('/') || p.GetChar(i) == wxT('.')); i++) r << p.GetChar(i);
 232
 233     // remove back references: translate dir1/../dir2 to dir2
 234     for (; i < cnt; i++)
 235     {
 236         r << p.GetChar(i);
 237         if (p.GetChar(i) == wxT('/') && p.GetChar(i-1) == wxT('.') && p.GetChar(i-2) == wxT('.'))
 238         {
 239             for (j = r.Length() - 2; j >= 0 && r.GetChar(j) != wxT('/') && r.GetChar(j) != wxT(':'); j--) {}
 240             if (j >= 0 && r.GetChar(j) != wxT(':'))
 241             {
 242                 for (j = j - 1; j >= 0 && r.GetChar(j) != wxT('/') && r.GetChar(j) != wxT(':'); j--) {}
 243                 r.Remove(j + 1);
 244             }
 245         }
 246     }
 247
 248     for (; i < cnt; i++) r << p.GetChar(i);
 249
 250     return r;
 251 }
 252
 253
 254 void wxFileSystem::ChangePathTo(const wxString& location, bool is_dir)
 255 {
 256     int i, pathpos = -1;
 257
 258     m_Path = MakeCorrectPath(location);
 259
 260     if (is_dir)
 261     {
 262         if (m_Path.Length() > 0 && m_Path.Last() != wxT('/') && m_Path.Last() != wxT(':'))
 263             m_Path << wxT('/');
 264     }
 265
 266     else
 267     {
 268         for (i = m_Path.Length()-1; i >= 0; i--)
 269         {
 270             if (m_Path[(unsigned int) i] == wxT('/'))
 271             {
 272                 if ((i > 1) && (m_Path[(unsigned int) (i-1)] == wxT('/')) && (m_Path[(unsigned int) (i-2)] == wxT(':')))
 273                 {
 274                     i -= 2;
 275                     continue;
 276                 }
 277                 else
 278                 {
 279                     pathpos = i;
 280                     break;
 281                 }
 282             }
 283             else if (m_Path[(unsigned int) i] == wxT(':')) {
 284                 pathpos = i;
 285                 break;
 286             }
 287         }
 288         if (pathpos == -1)
 289         {
 290             for (i = 0; i < (int) m_Path.Length(); i++)
 291             {
 292                 if (m_Path[(unsigned int) i] == wxT(':'))
 293                 {
 294                     m_Path.Remove(i+1);
 295                     break;
 296                 }
 297             }
 298             if (i == (int) m_Path.Length())
 299                 m_Path = wxEmptyString;
 300         }
 301         else
 302         {
 303             m_Path.Remove(pathpos+1);
 304         }
 305     }
 306 }
 307
 308
 309
 310 wxFSFile* wxFileSystem::OpenFile(const wxString& location)
 311 {
 312     wxString loc = MakeCorrectPath(location);
 313     unsigned i, ln;
 314     char meta;
 315     wxFSFile *s = NULL;
 316     wxNode *node;
 317
 318     ln = loc.Length();
 319     meta = 0;
 320     for (i = 0; i < ln; i++)
 321     {
 322         switch (loc[i])
 323         {
 324             case wxT('/') : case wxT(':') : case wxT('#') :
 325                 meta = loc[i];
 326                 break;
 327         }
 328         if (meta != 0) break;
 329     }
 330     m_LastName = wxEmptyString;
 331
 332     // try relative paths first :
 333     if (meta != wxT(':'))
 334     {
 335         node = m_Handlers.GetFirst();
 336         while (node)
 337         {
 338             wxFileSystemHandler *h = (wxFileSystemHandler*) node -> GetData();
 339             if (h->CanOpen(m_Path + loc))
 340             {
 341                 s = h->OpenFile(*this, m_Path + loc);
 342                 if (s) { m_LastName = m_Path + loc; break; }
 343             }
 344             node = node->GetNext();
 345         }
 346     }
 347
 348     // if failed, try absolute paths :
 349     if (s == NULL)
 350     {
 351         node = m_Handlers.GetFirst();
 352         while (node)
 353         {
 354             wxFileSystemHandler *h = (wxFileSystemHandler*) node->GetData();
 355             if (h->CanOpen(loc))
 356             {
 357                 s = h->OpenFile(*this, loc);
 358                 if (s) { m_LastName = loc; break; }
 359             }
 360             node = node->GetNext();
 361         }
 362     }
 363     return (s);
 364 }
 365
 366
 367
 368 wxString wxFileSystem::FindFirst(const wxString& spec, int flags)
 369 {
 370     wxNode *node;
 371     wxString spec2(spec);
 372
 373     m_FindFileHandler = NULL;
 374
 375     for (int i = spec2.Length()-1; i >= 0; i--)
 376         if (spec2[(unsigned int) i] == wxT('\\')) spec2.GetWritableChar(i) = wxT('/'); // Want to be windows-safe
 377
 378     node = m_Handlers.GetFirst();
 379     while (node)
 380     {
 381         m_FindFileHandler = (wxFileSystemHandler*) node -> GetData();
 382         if (m_FindFileHandler -> CanOpen(m_Path + spec2))
 383             return m_FindFileHandler -> FindFirst(m_Path + spec2, flags);
 384         node = node->GetNext();
 385     }
 386
 387     node = m_Handlers.GetFirst();
 388     while (node)
 389     {
 390         m_FindFileHandler = (wxFileSystemHandler*) node -> GetData();
 391         if (m_FindFileHandler -> CanOpen(spec2))
 392             return m_FindFileHandler -> FindFirst(spec2, flags);
 393         node = node->GetNext();
 394     }
 395
 396     return wxEmptyString;
 397 }
 398
 399
 400
 401 wxString wxFileSystem::FindNext()
 402 {
 403     if (m_FindFileHandler == NULL) return wxEmptyString;
 404     else return m_FindFileHandler -> FindNext();
 405 }
 406
 407
 408
 409 void wxFileSystem::AddHandler(wxFileSystemHandler *handler)
 410 {
 411     m_Handlers.Append(handler);
 412 }
 413
 414
 415 void wxFileSystem::CleanUpHandlers()
 416 {
 417     m_Handlers.DeleteContents(TRUE);
 418     m_Handlers.Clear();
 419 }
 420
 421 const static wxString g_unixPathString(wxT("/"));
 422 const static wxString g_nativePathString(wxFILE_SEP_PATH);
 423
 424 // Returns the native path for a file URL
 425 wxFileName wxFileSystem::URLToFileName(const wxString& url)
 426 {
 427         wxString path = url;
 428
 429         if ( path.Find(wxT("file://")) == 0 )
 430         {
 431                 path = path.Mid(7);
 432         }
 433
 434 #ifndef __UNIX__
 435         // file urls either start with a forward slash (local harddisk),
 436     // otherwise they have a servername/sharename notation,
 437     // which only exists on msw and corresponds to a unc
 438         if ( path[0u] == wxT('/') && path [1u] != wxT('/'))
 439         {
 440                 path = path.Mid(1);
 441         }
 442         else if ( (url.Find(wxT("file://")) == 0) &&
 443               (path.Find(wxT('/')) != wxNOT_FOUND) &&
 444               (path.Length() > 1) && (path[1u] != wxT(':')) )
 445         {
 446                 path = wxT("//") + path;
 447         }
 448 #endif
 449
 450         path.Replace(g_unixPathString, g_nativePathString);
 451
 452         return wxFileName(path, wxPATH_NATIVE);
 453 }
 454
 455 // Returns the file URL for a native path
 456 wxString wxFileSystem::FileNameToURL(const wxFileName& filename)
 457 {
 458     wxFileName fn = filename;
 459     fn.Normalize(wxPATH_NORM_DOTS | wxPATH_NORM_TILDE | wxPATH_NORM_ABSOLUTE);
 460     wxString url = fn.GetFullPath(wxPATH_NATIVE);
 461
 462 #ifdef __WXMSW__
 463     // unc notation
 464     if ( url.Find(wxT("\\\\")) == 0 )
 465     {
 466         url = url.Mid(2);
 467     }
 468     else
 469     {
 470         url = wxT("/") + url;
 471     }
 472 #endif
 473
 474     url.Replace(g_nativePathString, g_unixPathString);
 475     url = wxT("file://") + url;
 476     return url;
 477 }
 478
 479
 480 ///// Module:
 481
 482 class wxFileSystemModule : public wxModule
 483 {
 484     DECLARE_DYNAMIC_CLASS(wxFileSystemModule)
 485
 486     public:
 487         virtual bool OnInit()
 488         {
 489             wxFileSystem::AddHandler(new wxLocalFSHandler);
 490
 491         #if wxUSE_MIMETYPE
 492             gs_FSMimeFallbacks = new wxFileTypeInfo[6];
 493             gs_FSMimeFallbacks[0] =
 494             wxFileTypeInfo(_T("image/jpeg"),
 495                            _T(""),
 496                            _T(""),
 497                            _T("JPEG image (from fallback)"),
 498                            _T("jpg"), _T("jpeg"), NULL);
 499             gs_FSMimeFallbacks[1] =
 500             wxFileTypeInfo(_T("image/gif"),
 501                            _T(""),
 502                            _T(""),
 503                            _T("GIF image (from fallback)"),
 504                            _T("gif"), NULL);
 505             gs_FSMimeFallbacks[2] =
 506             wxFileTypeInfo(_T("image/png"),
 507                            _T(""),
 508                            _T(""),
 509                            _T("PNG image (from fallback)"),
 510                            _T("png"), NULL);
 511             gs_FSMimeFallbacks[3] =
 512             wxFileTypeInfo(_T("image/bmp"),
 513                            _T(""),
 514                            _T(""),
 515                            _T("windows bitmap image (from fallback)"),
 516                            _T("bmp"), NULL);
 517             gs_FSMimeFallbacks[4] =
 518             wxFileTypeInfo(_T("text/html"),
 519                            _T(""),
 520                            _T(""),
 521                            _T("HTML document (from fallback)"),
 522                            _T("htm"), _T("html"), NULL);
 523             gs_FSMimeFallbacks[5] =
 524             // must terminate the table with this!
 525             wxFileTypeInfo();
 526         #endif
 527             return TRUE;
 528         }
 529         virtual void OnExit()
 530         {
 531         #if wxUSE_MIMETYPE
 532             delete [] gs_FSMimeFallbacks;
 533         #endif
 534             wxFileSystem::CleanUpHandlers();
 535         }
 536 };
 537
 538 IMPLEMENT_DYNAMIC_CLASS(wxFileSystemModule, wxModule)
 539
 540 #endif
 541   // wxUSE_FILESYSTEM
 542
 543
 544