src/common/filesys.cpp

   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
   6 // CVS-ID:      $Id$
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #include "wx/wxprec.h"
  11
  12 #ifdef __BORLANDC__
  13     #pragma hdrstop
  14 #endif
  15
  16
  17 #if wxUSE_FILESYSTEM
  18
  19 #include "wx/filesys.h"
  20
  21 #ifndef WX_PRECOMP
  22     #include "wx/log.h"
  23     #include "wx/module.h"
  24 #endif
  25
  26 #include "wx/wfstream.h"
  27 #include "wx/mimetype.h"
  28 #include "wx/filename.h"
  29 #include "wx/tokenzr.h"
  30 #include "wx/fileback.h"
  31
  32
  33 //--------------------------------------------------------------------------------
  34 // wxFileSystemHandler
  35 //--------------------------------------------------------------------------------
  36
  37 IMPLEMENT_ABSTRACT_CLASS(wxFileSystemHandler, wxObject)
  38
  39
  40 wxString wxFileSystemHandler::GetMimeTypeFromExt(const wxString& location)
  41 {
  42     wxString ext, mime;
  43     wxString loc = GetRightLocation(location);
  44     wxChar c;
  45     int l = loc.length(), l2;
  46
  47     l2 = l;
  48     for (int i = l-1; i >= 0; i--)
  49     {
  50         c = loc[(unsigned int) i];
  51         if ( c == wxT('#') )
  52             l2 = i + 1;
  53         if ( c == wxT('.') )
  54         {
  55             ext = loc.Right(l2-i-1);
  56             break;
  57         }
  58         if ( (c == wxT('/')) || (c == wxT('\\')) || (c == wxT(':')) )
  59             return wxEmptyString;
  60     }
  61
  62 #if wxUSE_MIMETYPE
  63     static bool s_MinimalMimeEnsured = false;
  64     if (!s_MinimalMimeEnsured)
  65     {
  66         static const wxFileTypeInfo fallbacks[] =
  67         {
  68             wxFileTypeInfo(_T("image/jpeg"),
  69                            wxEmptyString,
  70                            wxEmptyString,
  71                            _T("JPEG image (from fallback)"),
  72                            _T("jpg"), _T("jpeg"), _T("JPG"), _T("JPEG"), NULL),
  73             wxFileTypeInfo(_T("image/gif"),
  74                            wxEmptyString,
  75                            wxEmptyString,
  76                            _T("GIF image (from fallback)"),
  77                            _T("gif"), _T("GIF"), NULL),
  78             wxFileTypeInfo(_T("image/png"),
  79                            wxEmptyString,
  80                            wxEmptyString,
  81                            _T("PNG image (from fallback)"),
  82                            _T("png"), _T("PNG"), NULL),
  83             wxFileTypeInfo(_T("image/bmp"),
  84                            wxEmptyString,
  85                            wxEmptyString,
  86                            _T("windows bitmap image (from fallback)"),
  87                            _T("bmp"), _T("BMP"), NULL),
  88             wxFileTypeInfo(_T("text/html"),
  89                            wxEmptyString,
  90                            wxEmptyString,
  91                            _T("HTML document (from fallback)"),
  92                            _T("htm"), _T("html"), _T("HTM"), _T("HTML"), NULL),
  93             // must terminate the table with this!
  94             wxFileTypeInfo()
  95         };
  96         wxTheMimeTypesManager->AddFallbacks(fallbacks);
  97         s_MinimalMimeEnsured = true;
  98     }
  99
 100     wxFileType *ft = wxTheMimeTypesManager->GetFileTypeFromExtension(ext);
 101     if ( !ft || !ft -> GetMimeType(&mime) )
 102     {
 103         mime = wxEmptyString;
 104     }
 105
 106     delete ft;
 107
 108     return mime;
 109 #else
 110     if ( ext.IsSameAs(wxT("htm"), false) || ext.IsSameAs(_T("html"), false) )
 111         return wxT("text/html");
 112     if ( ext.IsSameAs(wxT("jpg"), false) || ext.IsSameAs(_T("jpeg"), false) )
 113         return wxT("image/jpeg");
 114     if ( ext.IsSameAs(wxT("gif"), false) )
 115         return wxT("image/gif");
 116     if ( ext.IsSameAs(wxT("png"), false) )
 117         return wxT("image/png");
 118     if ( ext.IsSameAs(wxT("bmp"), false) )
 119         return wxT("image/bmp");
 120     return wxEmptyString;
 121 #endif
 122 }
 123
 124
 125
 126 wxString wxFileSystemHandler::GetProtocol(const wxString& location) const
 127 {
 128     wxString s = wxEmptyString;
 129     int i, l = location.length();
 130     bool fnd = false;
 131
 132     for (i = l-1; (i >= 0) && ((location[i] != wxT('#')) || (!fnd)); i--) {
 133         if ((location[i] == wxT(':')) && (i != 1 /*win: C:\path*/)) fnd = true;
 134     }
 135     if (!fnd) return wxT("file");
 136     for (++i; (i < l) && (location[i] != wxT(':')); i++) s << location[i];
 137     return s;
 138 }
 139
 140
 141 wxString wxFileSystemHandler::GetLeftLocation(const wxString& location) const
 142 {
 143     int i;
 144     bool fnd = false;
 145
 146     for (i = location.length()-1; i >= 0; i--) {
 147         if ((location[i] == wxT(':')) && (i != 1 /*win: C:\path*/)) fnd = true;
 148         else if (fnd && (location[i] == wxT('#'))) return location.Left(i);
 149     }
 150     return wxEmptyString;
 151 }
 152
 153 wxString wxFileSystemHandler::GetRightLocation(const wxString& location) const
 154 {
 155     int i, l = location.length();
 156     int l2 = l + 1;
 157
 158     for (i = l-1;
 159          (i >= 0) &&
 160          ((location[i] != wxT(':')) || (i == 1) || (location[i-2] == wxT(':')));
 161          i--)
 162     {
 163         if (location[i] == wxT('#')) l2 = i + 1;
 164     }
 165     if (i == 0) return wxEmptyString;
 166     else return location.Mid(i + 1, l2 - i - 2);
 167 }
 168
 169 wxString wxFileSystemHandler::GetAnchor(const wxString& location) const
 170 {
 171     wxChar c;
 172     int l = location.length();
 173
 174     for (int i = l-1; i >= 0; i--) {
 175         c = location[i];
 176         if (c == wxT('#')) return location.Right(l-i-1);
 177         else if ((c == wxT('.')) || (c == wxT('/')) || (c == wxT('\\')) || (c == wxT(':'))) return wxEmptyString;
 178     }
 179     return wxEmptyString;
 180 }
 181
 182
 183 wxString wxFileSystemHandler::FindFirst(const wxString& WXUNUSED(spec),
 184                                         int WXUNUSED(flags))
 185 {
 186     return wxEmptyString;
 187 }
 188
 189 wxString wxFileSystemHandler::FindNext()
 190 {
 191     return wxEmptyString;
 192 }
 193
 194 //--------------------------------------------------------------------------------
 195 // wxLocalFSHandler
 196 //--------------------------------------------------------------------------------
 197
 198
 199 wxString wxLocalFSHandler::ms_root;
 200
 201 bool wxLocalFSHandler::CanOpen(const wxString& location)
 202 {
 203     return GetProtocol(location) == wxT("file");
 204 }
 205
 206 wxFSFile* wxLocalFSHandler::OpenFile(wxFileSystem& WXUNUSED(fs), const wxString& location)
 207 {
 208     // location has Unix path separators
 209     wxString right = GetRightLocation(location);
 210     wxFileName fn = wxFileSystem::URLToFileName(right);
 211     wxString fullpath = ms_root + fn.GetFullPath();
 212
 213     if (!wxFileExists(fullpath))
 214         return (wxFSFile*) NULL;
 215
 216     // we need to check whether we can really read from this file, otherwise
 217     // wxFSFile is not going to work
 218 #if wxUSE_FILE
 219     wxFileInputStream *is = new wxFileInputStream(fullpath);
 220 #elif wxUSE_FFILE
 221     wxFFileInputStream *is = new wxFFileInputStream(fullpath);
 222 #else
 223 #error One of wxUSE_FILE or wxUSE_FFILE must be set to 1 for wxFSHandler to work
 224 #endif
 225     if ( !is->Ok() )
 226     {
 227         delete is;
 228         return (wxFSFile*) NULL;
 229     }
 230
 231     return new wxFSFile(is,
 232                         right,
 233                         GetMimeTypeFromExt(location),
 234                         GetAnchor(location)
 235 #if wxUSE_DATETIME
 236                         ,wxDateTime(wxFileModificationTime(fullpath))
 237 #endif // wxUSE_DATETIME
 238                         );
 239 }
 240
 241 wxString wxLocalFSHandler::FindFirst(const wxString& spec, int flags)
 242 {
 243     wxFileName fn = wxFileSystem::URLToFileName(GetRightLocation(spec));
 244     return wxFindFirstFile(ms_root + fn.GetFullPath(), flags);
 245 }
 246
 247 wxString wxLocalFSHandler::FindNext()
 248 {
 249     return wxFindNextFile();
 250 }
 251
 252
 253
 254 //-----------------------------------------------------------------------------
 255 // wxFileSystem
 256 //-----------------------------------------------------------------------------
 257
 258 IMPLEMENT_DYNAMIC_CLASS(wxFileSystem, wxObject)
 259 IMPLEMENT_ABSTRACT_CLASS(wxFSFile, wxObject)
 260
 261
 262 wxList wxFileSystem::m_Handlers;
 263
 264
 265 static wxString MakeCorrectPath(const wxString& path)
 266 {
 267     wxString p(path);
 268     wxString r;
 269     int i, j, cnt;
 270
 271     cnt = p.length();
 272     for (i = 0; i < cnt; i++)
 273       if (p.GetChar(i) == wxT('\\')) p.GetWritableChar(i) = wxT('/'); // Want to be windows-safe
 274
 275     if (p.Left(2) == wxT("./")) { p = p.Mid(2); cnt -= 2; }
 276
 277     if (cnt < 3) return p;
 278
 279     r << p.GetChar(0) << p.GetChar(1);
 280
 281     // skip trailing ../.., if any
 282     for (i = 2; i < cnt && (p.GetChar(i) == wxT('/') || p.GetChar(i) == wxT('.')); i++) r << p.GetChar(i);
 283
 284     // remove back references: translate dir1/../dir2 to dir2
 285     for (; i < cnt; i++)
 286     {
 287         r << p.GetChar(i);
 288         if (p.GetChar(i) == wxT('/') && p.GetChar(i-1) == wxT('.') && p.GetChar(i-2) == wxT('.'))
 289         {
 290             for (j = r.length() - 2; j >= 0 && r.GetChar(j) != wxT('/') && r.GetChar(j) != wxT(':'); j--) {}
 291             if (j >= 0 && r.GetChar(j) != wxT(':'))
 292             {
 293                 for (j = j - 1; j >= 0 && r.GetChar(j) != wxT('/') && r.GetChar(j) != wxT(':'); j--) {}
 294                 r.Remove(j + 1);
 295             }
 296         }
 297     }
 298
 299     for (; i < cnt; i++) r << p.GetChar(i);
 300
 301     return r;
 302 }
 303
 304
 305 void wxFileSystem::ChangePathTo(const wxString& location, bool is_dir)
 306 {
 307     int i, pathpos = -1;
 308
 309     m_Path = MakeCorrectPath(location);
 310
 311     if (is_dir)
 312     {
 313         if (m_Path.length() > 0 && m_Path.Last() != wxT('/') && m_Path.Last() != wxT(':'))
 314             m_Path << wxT('/');
 315     }
 316
 317     else
 318     {
 319         for (i = m_Path.length()-1; i >= 0; i--)
 320         {
 321             if (m_Path[(unsigned int) i] == wxT('/'))
 322             {
 323                 if ((i > 1) && (m_Path[(unsigned int) (i-1)] == wxT('/')) && (m_Path[(unsigned int) (i-2)] == wxT(':')))
 324                 {
 325                     i -= 2;
 326                     continue;
 327                 }
 328                 else
 329                 {
 330                     pathpos = i;
 331                     break;
 332                 }
 333             }
 334             else if (m_Path[(unsigned int) i] == wxT(':')) {
 335                 pathpos = i;
 336                 break;
 337             }
 338         }
 339         if (pathpos == -1)
 340         {
 341             for (i = 0; i < (int) m_Path.length(); i++)
 342             {
 343                 if (m_Path[(unsigned int) i] == wxT(':'))
 344                 {
 345                     m_Path.Remove(i+1);
 346                     break;
 347                 }
 348             }
 349             if (i == (int) m_Path.length())
 350                 m_Path = wxEmptyString;
 351         }
 352         else
 353         {
 354             m_Path.Remove(pathpos+1);
 355         }
 356     }
 357 }
 358
 359
 360
 361 wxFSFile* wxFileSystem::OpenFile(const wxString& location, int flags)
 362 {
 363     wxString loc = MakeCorrectPath(location);
 364     unsigned i, ln;
 365     wxChar meta;
 366     wxFSFile *s = NULL;
 367     wxList::compatibility_iterator node;
 368
 369     ln = loc.length();
 370     meta = 0;
 371     for (i = 0; i < ln; i++)
 372     {
 373         switch (loc[i])
 374         {
 375             case wxT('/') : case wxT(':') : case wxT('#') :
 376                 meta = loc[i];
 377                 break;
 378         }
 379         if (meta != 0) break;
 380     }
 381     m_LastName = wxEmptyString;
 382
 383     // try relative paths first :
 384     if (meta != wxT(':'))
 385     {
 386         node = m_Handlers.GetFirst();
 387         while (node)
 388         {
 389             wxFileSystemHandler *h = (wxFileSystemHandler*) node -> GetData();
 390             if (h->CanOpen(m_Path + loc))
 391             {
 392                 s = h->OpenFile(*this, m_Path + loc);
 393                 if (s) { m_LastName = m_Path + loc; break; }
 394             }
 395             node = node->GetNext();
 396         }
 397     }
 398
 399     // if failed, try absolute paths :
 400     if (s == NULL)
 401     {
 402         node = m_Handlers.GetFirst();
 403         while (node)
 404         {
 405             wxFileSystemHandler *h = (wxFileSystemHandler*) node->GetData();
 406             if (h->CanOpen(loc))
 407             {
 408                 s = h->OpenFile(*this, loc);
 409                 if (s) { m_LastName = loc; break; }
 410             }
 411             node = node->GetNext();
 412         }
 413     }
 414
 415     if (s && (flags & wxFS_SEEKABLE) != 0 && !s->GetStream()->IsSeekable())
 416     {
 417         wxBackedInputStream *stream;
 418         stream = new wxBackedInputStream(s->DetachStream());
 419         stream->FindLength();
 420         s->SetStream(stream);
 421     }
 422
 423     return (s);
 424 }
 425
 426
 427
 428 wxString wxFileSystem::FindFirst(const wxString& spec, int flags)
 429 {
 430     wxList::compatibility_iterator node;
 431     wxString spec2(spec);
 432
 433     m_FindFileHandler = NULL;
 434
 435     for (int i = spec2.length()-1; i >= 0; i--)
 436         if (spec2[(unsigned int) i] == wxT('\\')) spec2.GetWritableChar(i) = wxT('/'); // Want to be windows-safe
 437
 438     node = m_Handlers.GetFirst();
 439     while (node)
 440     {
 441         m_FindFileHandler = (wxFileSystemHandler*) node -> GetData();
 442         if (m_FindFileHandler -> CanOpen(m_Path + spec2))
 443             return m_FindFileHandler -> FindFirst(m_Path + spec2, flags);
 444         node = node->GetNext();
 445     }
 446
 447     node = m_Handlers.GetFirst();
 448     while (node)
 449     {
 450         m_FindFileHandler = (wxFileSystemHandler*) node -> GetData();
 451         if (m_FindFileHandler -> CanOpen(spec2))
 452             return m_FindFileHandler -> FindFirst(spec2, flags);
 453         node = node->GetNext();
 454     }
 455
 456     return wxEmptyString;
 457 }
 458
 459
 460
 461 wxString wxFileSystem::FindNext()
 462 {
 463     if (m_FindFileHandler == NULL) return wxEmptyString;
 464     else return m_FindFileHandler -> FindNext();
 465 }
 466
 467 bool wxFileSystem::FindFileInPath(wxString *pStr,
 468                                   const wxChar *path,
 469                                   const wxChar *basename)
 470 {
 471     // we assume that it's not empty
 472     wxCHECK_MSG( !wxIsEmpty(basename), false,
 473                 _T("empty file name in wxFileSystem::FindFileInPath"));
 474
 475     // skip path separator in the beginning of the file name if present
 476     if ( wxIsPathSeparator(*basename) )
 477        basename++;
 478
 479     wxStringTokenizer tokenizer(path, wxPATH_SEP);
 480     while ( tokenizer.HasMoreTokens() )
 481     {
 482         wxString strFile = tokenizer.GetNextToken();
 483         if ( !wxEndsWithPathSeparator(strFile) )
 484             strFile += wxFILE_SEP_PATH;
 485         strFile += basename;
 486
 487         wxFSFile *file = OpenFile(strFile);
 488         if ( file )
 489         {
 490             delete file;
 491             *pStr = strFile;
 492             return true;
 493         }
 494     }
 495
 496     return false;
 497 }
 498
 499 void wxFileSystem::AddHandler(wxFileSystemHandler *handler)
 500 {
 501     // prepend the handler to the beginning of the list because handlers added
 502     // last should have the highest priority to allow overriding them
 503     m_Handlers.Insert((size_t)0, handler);
 504 }
 505
 506 wxFileSystemHandler* wxFileSystem::RemoveHandler(wxFileSystemHandler *handler)
 507 {
 508     // if handler has already been removed (or deleted)
 509     // we return NULL. This is by design in case
 510     // CleanUpHandlers() is called before RemoveHandler
 511     // is called, as we cannot control the order
 512     // which modules are unloaded
 513     if (!m_Handlers.DeleteObject(handler))
 514         return NULL;
 515
 516     return handler;
 517 }
 518
 519
 520 bool wxFileSystem::HasHandlerForPath(const wxString &location)
 521 {
 522     for ( wxList::compatibility_iterator node = m_Handlers.GetFirst();
 523            node; node = node->GetNext() )
 524     {
 525         wxFileSystemHandler *h = (wxFileSystemHandler*) node->GetData();
 526         if (h->CanOpen(location))
 527             return true;
 528     }
 529
 530     return false;
 531 }
 532
 533 void wxFileSystem::CleanUpHandlers()
 534 {
 535     WX_CLEAR_LIST(wxList, m_Handlers);
 536 }
 537
 538 static const wxString g_unixPathString(wxT("/"));
 539 static const wxString g_nativePathString(wxFILE_SEP_PATH);
 540
 541 // Returns the native path for a file URL
 542 wxFileName wxFileSystem::URLToFileName(const wxString& url)
 543 {
 544     wxString path = url;
 545
 546     if ( path.Find(wxT("file://")) == 0 )
 547     {
 548         path = path.Mid(7);
 549     }
 550     else if ( path.Find(wxT("file:")) == 0 )
 551     {
 552         path = path.Mid(5);
 553     }
 554     // Remove preceding double slash on Mac Classic
 555 #if defined(__WXMAC__) && !defined(__UNIX__)
 556     else if ( path.Find(wxT("//")) == 0 )
 557         path = path.Mid(2);
 558 #endif
 559
 560     path.Replace(wxT("%25"), wxT("%"));
 561     path.Replace(wxT("%3A"), wxT(":"));
 562
 563 #ifdef __WXMSW__
 564     // file urls either start with a forward slash (local harddisk),
 565     // otherwise they have a servername/sharename notation,
 566     // which only exists on msw and corresponds to a unc
 567     if ( path[0u] == wxT('/') && path [1u] != wxT('/'))
 568     {
 569         path = path.Mid(1);
 570     }
 571     else if ( (url.Find(wxT("file://")) == 0) &&
 572               (path.Find(wxT('/')) != wxNOT_FOUND) &&
 573               (path.length() > 1) && (path[1u] != wxT(':')) )
 574     {
 575         path = wxT("//") + path;
 576     }
 577 #endif
 578
 579     path.Replace(g_unixPathString, g_nativePathString);
 580
 581     return wxFileName(path, wxPATH_NATIVE);
 582 }
 583
 584 // Returns the file URL for a native path
 585 wxString wxFileSystem::FileNameToURL(const wxFileName& filename)
 586 {
 587     wxFileName fn = filename;
 588     fn.Normalize(wxPATH_NORM_DOTS | wxPATH_NORM_TILDE | wxPATH_NORM_ABSOLUTE);
 589     wxString url = fn.GetFullPath(wxPATH_NATIVE);
 590
 591 #ifndef __UNIX__
 592     // unc notation, wxMSW
 593     if ( url.Find(wxT("\\\\")) == 0 )
 594     {
 595         url = wxT("//") + url.Mid(2);
 596     }
 597     else
 598     {
 599         url = wxT("/") + url;
 600 #ifdef __WXMAC__
 601         url = wxT("/") + url;
 602 #endif
 603
 604     }
 605 #endif
 606
 607     url.Replace(g_nativePathString, g_unixPathString);
 608     url.Replace(wxT("%"), wxT("%25"));
 609     url.Replace(wxT(":"), wxT("%3A"));
 610     url = wxT("file:") + url;
 611     return url;
 612 }
 613
 614
 615 ///// Module:
 616
 617 class wxFileSystemModule : public wxModule
 618 {
 619     DECLARE_DYNAMIC_CLASS(wxFileSystemModule)
 620
 621     public:
 622         wxFileSystemModule() :
 623             wxModule(),
 624             m_handler(NULL)
 625         {
 626         }
 627
 628         virtual bool OnInit()
 629         {
 630             m_handler = new wxLocalFSHandler;
 631             wxFileSystem::AddHandler(m_handler);
 632             return true;
 633         }
 634         virtual void OnExit()
 635         {
 636             delete wxFileSystem::RemoveHandler(m_handler);
 637
 638             wxFileSystem::CleanUpHandlers();
 639         }
 640
 641     private:
 642         wxFileSystemHandler* m_handler;
 643
 644 };
 645
 646 IMPLEMENT_DYNAMIC_CLASS(wxFileSystemModule, wxModule)
 647
 648 #endif
 649   // wxUSE_FILESYSTEM