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