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
  12 #endif
  13
  14 #include "wx/wxprec.h"
  15
  16 #ifdef __BORDLANDC__
  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 static wxFileTypeInfo *gs_FSMimeFallbacks = NULL;
  39
  40 wxString wxFileSystemHandler::GetMimeTypeFromExt(const wxString& location)
  41 {
  42     wxString ext = wxEmptyString, mime = wxEmptyString;
  43     wxString loc = GetRightLocation(location);
  44     char c;
  45     int l = loc.Length(), l2;
  46     wxFileType *ft;
  47
  48     l2 = l;
  49     for (int i = l-1; i >= 0; i--) {
  50         c = loc[(unsigned int) i];
  51         if (c == wxT('#')) l2 = i + 1;
  52         if (c == wxT('.')) {ext = loc.Right(l2-i-1); break;}
  53         if ((c == wxT('/')) || (c == wxT('\\')) || (c == wxT(':'))) {return wxEmptyString;}
  54     }
  55
  56     static bool s_MinimalMimeEnsured = FALSE;
  57     if (!s_MinimalMimeEnsured) {
  58         wxTheMimeTypesManager -> AddFallbacks(gs_FSMimeFallbacks);
  59         s_MinimalMimeEnsured = TRUE;
  60     }
  61
  62     ft = wxTheMimeTypesManager -> GetFileTypeFromExtension(ext);
  63     if ( !ft || !ft -> GetMimeType(&mime) ) {
  64         mime = wxEmptyString;
  65     }
  66
  67     delete ft;
  68
  69     return mime;
  70 }
  71
  72
  73
  74 wxString wxFileSystemHandler::GetProtocol(const wxString& location) const
  75 {
  76     wxString s = wxEmptyString;
  77     int i, l = location.Length();
  78     bool fnd;
  79
  80     fnd = FALSE;
  81     for (i = l-1; (i >= 0) && ((location[i] != wxT('#')) || (!fnd)); i--) {
  82         if ((location[i] == wxT(':')) && (i != 1 /*win: C:\path*/)) fnd = TRUE;
  83     }
  84     if (!fnd) return wxT("file");
  85     for (++i; (i < l) && (location[i] != wxT(':')); i++) s << location[i];
  86     return s;
  87 }
  88
  89
  90 wxString wxFileSystemHandler::GetLeftLocation(const wxString& location) const
  91 {
  92     int i;
  93     bool fnd;
  94
  95     fnd = FALSE;
  96     for (i = location.Length()-1; i >= 0; i--) {
  97         if ((location[i] == wxT(':')) && (i != 1 /*win: C:\path*/)) fnd = TRUE;
  98         else if (fnd && (location[i] == wxT('#'))) return location.Left(i);
  99     }
 100     return wxEmptyString;
 101 }
 102
 103 wxString wxFileSystemHandler::GetRightLocation(const wxString& location) const
 104 {
 105     int i, l = location.Length();
 106     int l2 = l + 1;
 107     for (i = l-1; (i >= 0) && ((location[i] != wxT(':')) || (i == 1) || (location[i-2] == wxT(':'))); i--) {if (location[i] == wxT('#')) l2 = i + 1;}
 108     if (i == 0) return wxEmptyString;
 109     else return location.Mid(i + 1, l2 - i - 2);
 110 }
 111
 112 wxString wxFileSystemHandler::GetAnchor(const wxString& location) const
 113 {
 114     char c;
 115     int l = location.Length();
 116
 117     for (int i = l-1; i >= 0; i--) {
 118         c = location[i];
 119         if (c == wxT('#')) return location.Right(l-i-1);
 120         else if ((c == wxT('.')) || (c == wxT('/')) || (c == wxT('\\')) || (c == wxT(':'))) return wxEmptyString;
 121     }
 122     return wxEmptyString;
 123 }
 124
 125
 126 wxString wxFileSystemHandler::FindFirst(const wxString& WXUNUSED(spec),
 127                                         int WXUNUSED(flags))
 128 {
 129     return wxEmptyString;
 130 }
 131
 132 wxString wxFileSystemHandler::FindNext()
 133 {
 134     return wxEmptyString;
 135 }
 136
 137 //--------------------------------------------------------------------------------
 138 // wxLocalFSHandler
 139 //--------------------------------------------------------------------------------
 140
 141 class wxLocalFSHandler : public wxFileSystemHandler
 142 {
 143     public:
 144         virtual bool CanOpen(const wxString& location);
 145         virtual wxFSFile* OpenFile(wxFileSystem& fs, const wxString& location);
 146         virtual wxString FindFirst(const wxString& spec, int flags = 0);
 147         virtual wxString FindNext();
 148 };
 149
 150
 151 bool wxLocalFSHandler::CanOpen(const wxString& location)
 152 {
 153     return GetProtocol(location) == wxT("file");
 154 }
 155
 156 wxFSFile* wxLocalFSHandler::OpenFile(wxFileSystem& WXUNUSED(fs), const wxString& location)
 157 {
 158     // location has Unix path separators
 159     wxString right = GetRightLocation(location);
 160     wxFileName fn( right, wxPATH_UNIX );
 161
 162     if (!wxFileExists( fn.GetFullPath() ))
 163         return (wxFSFile*) NULL;
 164
 165     return new wxFSFile(new wxFileInputStream( fn.GetFullPath() ),
 166                         right,
 167                         GetMimeTypeFromExt(location),
 168                         GetAnchor(location),
 169                         wxDateTime(wxFileModificationTime( fn.GetFullPath() )));
 170
 171 }
 172
 173 wxString wxLocalFSHandler::FindFirst(const wxString& spec, int flags)
 174 {
 175     wxString right = GetRightLocation(spec);
 176     return wxFindFirstFile(right, flags);
 177 }
 178
 179 wxString wxLocalFSHandler::FindNext()
 180 {
 181     return wxFindNextFile();
 182 }
 183
 184
 185
 186 //-----------------------------------------------------------------------------
 187 // wxFileSystem
 188 //-----------------------------------------------------------------------------
 189
 190 IMPLEMENT_DYNAMIC_CLASS(wxFileSystem, wxObject)
 191
 192
 193 wxList wxFileSystem::m_Handlers;
 194
 195
 196 static wxString MakeCorrectPath(const wxString& path)
 197 {
 198     wxString p(path);
 199     wxString r;
 200     int i, j, cnt;
 201
 202     cnt = p.Length();
 203     for (i = 0; i < cnt; i++)
 204       if (p.GetChar(i) == wxT('\\')) p.GetWritableChar(i) = wxT('/'); // Want to be windows-safe
 205
 206     if (p.Left(2) == wxT("./")) { p = p.Mid(2); cnt -= 2; }
 207
 208     if (cnt < 3) return p;
 209
 210     r << p.GetChar(0) << p.GetChar(1);
 211
 212     // skip trailing ../.., if any
 213     for (i = 2; i < cnt && (p.GetChar(i) == wxT('/') || p.GetChar(i) == wxT('.')); i++) r << p.GetChar(i);
 214
 215     // remove back references: translate dir1/../dir2 to dir2
 216     for (; i < cnt; i++)
 217     {
 218         r << p.GetChar(i);
 219         if (p.GetChar(i) == wxT('/') && p.GetChar(i-1) == wxT('.') && p.GetChar(i-2) == wxT('.'))
 220         {
 221             for (j = r.Length() - 2; j >= 0 && r.GetChar(j) != wxT('/') && r.GetChar(j) != wxT(':'); j--) {}
 222             if (j >= 0 && r.GetChar(j) != wxT(':'))
 223             {
 224                 for (j = j - 1; j >= 0 && r.GetChar(j) != wxT('/') && r.GetChar(j) != wxT(':'); j--) {}
 225                 r.Remove(j + 1);
 226             }
 227         }
 228     }
 229
 230     for (; i < cnt; i++) r << p.GetChar(i);
 231
 232     return r;
 233 }
 234
 235
 236 void wxFileSystem::ChangePathTo(const wxString& location, bool is_dir)
 237 {
 238     int i, pathpos = -1;
 239
 240     m_Path = MakeCorrectPath(location);
 241
 242     if (is_dir)
 243     {
 244         if (m_Path.Length() > 0 && m_Path.Last() != wxT('/') && m_Path.Last() != wxT(':'))
 245                 m_Path << wxT('/');
 246     }
 247
 248     else
 249     {
 250         for (i = m_Path.Length()-1; i >= 0; i--)
 251         {
 252             if (m_Path[(unsigned int) i] == wxT('/'))
 253                 {
 254                 if ((i > 1) && (m_Path[(unsigned int) (i-1)] == wxT('/')) && (m_Path[(unsigned int) (i-2)] == wxT(':')))
 255                         {
 256                     i -= 2;
 257                     continue;
 258                 }
 259                 else
 260                         {
 261                     pathpos = i;
 262                     break;
 263                 }
 264             }
 265             else if (m_Path[(unsigned int) i] == wxT(':')) {
 266                 pathpos = i;
 267                 break;
 268             }
 269         }
 270         if (pathpos == -1)
 271         {
 272             for (i = 0; i < (int) m_Path.Length(); i++)
 273             {
 274                 if (m_Path[(unsigned int) i] == wxT(':'))
 275                         {
 276                     m_Path.Remove(i+1);
 277                     break;
 278                 }
 279             }
 280             if (i == (int) m_Path.Length())
 281                 m_Path = wxEmptyString;
 282         }
 283         else
 284         {
 285             m_Path.Remove(pathpos+1);
 286         }
 287     }
 288 }
 289
 290
 291
 292 wxFSFile* wxFileSystem::OpenFile(const wxString& location)
 293 {
 294     wxString loc = MakeCorrectPath(location);
 295     unsigned i, ln;
 296     char meta;
 297     wxFSFile *s = NULL;
 298     wxNode *node;
 299
 300     ln = loc.Length();
 301     meta = 0;
 302     for (i = 0; i < ln; i++)
 303     {
 304         switch (loc[i])
 305         {
 306             case wxT('/') : case wxT(':') : case wxT('#') :
 307                 meta = loc[i];
 308                 break;
 309         }
 310         if (meta != 0) break;
 311     }
 312     m_LastName = wxEmptyString;
 313
 314     // try relative paths first :
 315     if (meta != wxT(':'))
 316     {
 317         node = m_Handlers.GetFirst();
 318         while (node)
 319         {
 320             wxFileSystemHandler *h = (wxFileSystemHandler*) node -> GetData();
 321             if (h->CanOpen(m_Path + loc))
 322                 {
 323                 s = h->OpenFile(*this, m_Path + loc);
 324                 if (s) { m_LastName = m_Path + loc; break; }
 325             }
 326             node = node->GetNext();
 327         }
 328     }
 329
 330     // if failed, try absolute paths :
 331     if (s == NULL)
 332     {
 333         node = m_Handlers.GetFirst();
 334         while (node)
 335         {
 336             wxFileSystemHandler *h = (wxFileSystemHandler*) node->GetData();
 337             if (h->CanOpen(loc))
 338             {
 339                 s = h->OpenFile(*this, loc);
 340                 if (s) { m_LastName = loc; break; }
 341             }
 342             node = node->GetNext();
 343         }
 344     }
 345     return (s);
 346 }
 347
 348
 349
 350 wxString wxFileSystem::FindFirst(const wxString& spec, int flags)
 351 {
 352     wxNode *node;
 353     wxString spec2(spec);
 354
 355     m_FindFileHandler = NULL;
 356
 357     for (int i = spec2.Length()-1; i >= 0; i--)
 358         if (spec2[(unsigned int) i] == wxT('\\')) spec2.GetWritableChar(i) = wxT('/'); // Want to be windows-safe
 359
 360     node = m_Handlers.GetFirst();
 361     while (node)
 362     {
 363         m_FindFileHandler = (wxFileSystemHandler*) node -> GetData();
 364         if (m_FindFileHandler -> CanOpen(m_Path + spec2))
 365             return m_FindFileHandler -> FindFirst(m_Path + spec2, flags);
 366         node = node->GetNext();
 367     }
 368
 369     node = m_Handlers.GetFirst();
 370     while (node)
 371     {
 372         m_FindFileHandler = (wxFileSystemHandler*) node -> GetData();
 373         if (m_FindFileHandler -> CanOpen(spec2))
 374             return m_FindFileHandler -> FindFirst(spec2, flags);
 375         node = node->GetNext();
 376     }
 377
 378     return wxEmptyString;
 379 }
 380
 381
 382
 383 wxString wxFileSystem::FindNext()
 384 {
 385     if (m_FindFileHandler == NULL) return wxEmptyString;
 386     else return m_FindFileHandler -> FindNext();
 387 }
 388
 389
 390
 391 void wxFileSystem::AddHandler(wxFileSystemHandler *handler)
 392 {
 393     m_Handlers.Append(handler);
 394 }
 395
 396
 397 void wxFileSystem::CleanUpHandlers()
 398 {
 399     m_Handlers.DeleteContents(TRUE);
 400     m_Handlers.Clear();
 401 }
 402
 403
 404
 405
 406 ///// Module:
 407
 408 class wxFileSystemModule : public wxModule
 409 {
 410     DECLARE_DYNAMIC_CLASS(wxFileSystemModule)
 411
 412     public:
 413         virtual bool OnInit()
 414         {
 415             wxFileSystem::AddHandler(new wxLocalFSHandler);
 416
 417             gs_FSMimeFallbacks = new wxFileTypeInfo[6];
 418             gs_FSMimeFallbacks[0] =
 419             wxFileTypeInfo("image/jpeg",
 420                            "",
 421                            "",
 422                            "JPEG image (from fallback)",
 423                            "jpg", "jpeg", NULL);
 424             gs_FSMimeFallbacks[1] =
 425             wxFileTypeInfo("image/gif",
 426                            "",
 427                            "",
 428                            "GIF image (from fallback)",
 429                            "gif", NULL);
 430             gs_FSMimeFallbacks[2] =
 431             wxFileTypeInfo("image/png",
 432                            "",
 433                            "",
 434                            "PNG image (from fallback)",
 435                            "png", NULL);
 436             gs_FSMimeFallbacks[3] =
 437             wxFileTypeInfo("image/bmp",
 438                            "",
 439                            "",
 440                            "windows bitmap image (from fallback)",
 441                            "bmp", NULL);
 442             gs_FSMimeFallbacks[4] =
 443             wxFileTypeInfo("text/html",
 444                            "",
 445                            "",
 446                            "HTML document (from fallback)",
 447                            "htm", "html", NULL);
 448             gs_FSMimeFallbacks[5] =
 449             // must terminate the table with this!
 450             wxFileTypeInfo();
 451
 452             return TRUE;
 453         }
 454         virtual void OnExit()
 455         {
 456             delete [] gs_FSMimeFallbacks;
 457             wxFileSystem::CleanUpHandlers();
 458         }
 459 };
 460
 461 IMPLEMENT_DYNAMIC_CLASS(wxFileSystemModule, wxModule)
 462
 463 #endif
 464   // wxUSE_FILESYSTEM
 465
 466
 467