src/common/mimecmn.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        common/mimecmn.cpp
   3 // Purpose:     classes and functions to manage MIME types
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 //  Chris Elliott (biol75@york.ac.uk) 5 Dec 00: write support for Win32
   7 // Created:     23.09.98
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
  10 // Licence:     wxWindows licence (part of wxExtra library)
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // ============================================================================
  14 // declarations
  15 // ============================================================================
  16
  17 // ----------------------------------------------------------------------------
  18 // headers
  19 // ----------------------------------------------------------------------------
  20
  21 #ifdef    __GNUG__
  22     #pragma implementation "mimetypebase.h"
  23 #endif
  24
  25 // for compilers that support precompilation, includes "wx.h".
  26 #include "wx/wxprec.h"
  27
  28 #ifdef __BORLANDC__
  29     #pragma hdrstop
  30 #endif
  31
  32 #if wxUSE_MIMETYPE
  33
  34 #ifndef WX_PRECOMP
  35     #include "wx/module.h"
  36 #endif
  37 // this one is needed for MSVC5
  38 #include "wx/module.h"
  39
  40 #ifndef WX_PRECOMP
  41   #include "wx/string.h"
  42   #if wxUSE_GUI
  43     #include "wx/icon.h"
  44   #endif
  45 #endif //WX_PRECOMP
  46
  47 #include "wx/log.h"
  48 #include "wx/file.h"
  49 #include "wx/intl.h"
  50 #include "wx/dynarray.h"
  51 #include "wx/confbase.h"
  52
  53 #include "wx/mimetype.h"
  54
  55 // other standard headers
  56 #include <ctype.h>
  57
  58 // implementation classes:
  59 #if defined(__WXMSW__)
  60     #include "wx/msw/mimetype.h"
  61 #elif defined(__WXMAC__)
  62     #include "wx/mac/mimetype.h"
  63 #elif defined(__WXPM__)
  64     #include "wx/os2/mimetype.h"
  65 #else // Unix
  66     #include "wx/unix/mimetype.h"
  67 #endif
  68
  69 // ============================================================================
  70 // common classes
  71 // ============================================================================
  72
  73 // ----------------------------------------------------------------------------
  74 // wxFileTypeInfo
  75 // ----------------------------------------------------------------------------
  76
  77 wxFileTypeInfo::wxFileTypeInfo(const wxChar *mimeType,
  78                                const wxChar *openCmd,
  79                                const wxChar *printCmd,
  80                                const wxChar *desc,
  81                                ...)
  82               : m_mimeType(mimeType),
  83                 m_openCmd(openCmd),
  84                 m_printCmd(printCmd),
  85                 m_desc(desc)
  86 {
  87     va_list argptr;
  88     va_start(argptr, desc);
  89
  90     for ( ;; )
  91     {
  92         const wxChar *ext = va_arg(argptr, const wxChar *);
  93         if ( !ext )
  94         {
  95             // NULL terminates the list
  96             break;
  97         }
  98
  99         m_exts.Add(ext);
 100     }
 101
 102     va_end(argptr);
 103 }
 104
 105
 106 wxFileTypeInfo::wxFileTypeInfo(const wxArrayString& sArray)
 107 {
 108     m_mimeType = sArray [0u];
 109     m_openCmd  = sArray [1u];
 110     m_printCmd = sArray [2u];
 111     m_desc     = sArray [3u];
 112
 113     size_t count = sArray.GetCount();
 114     for ( size_t i = 4; i < count; i++ )
 115     {
 116         m_exts.Add(sArray[i]);
 117     }
 118 }
 119
 120 #include "wx/arrimpl.cpp"
 121 WX_DEFINE_OBJARRAY(wxArrayFileTypeInfo);
 122
 123 // ============================================================================
 124 // implementation of the wrapper classes
 125 // ============================================================================
 126
 127 // ----------------------------------------------------------------------------
 128 // wxFileType
 129 // ----------------------------------------------------------------------------
 130
 131 /* static */
 132 wxString wxFileType::ExpandCommand(const wxString& command,
 133                                    const wxFileType::MessageParameters& params)
 134 {
 135     bool hasFilename = FALSE;
 136
 137     wxString str;
 138     for ( const wxChar *pc = command.c_str(); *pc != wxT('\0'); pc++ ) {
 139         if ( *pc == wxT('%') ) {
 140             switch ( *++pc ) {
 141                 case wxT('s'):
 142                     // '%s' expands into file name (quoted because it might
 143                     // contain spaces) - except if there are already quotes
 144                     // there because otherwise some programs may get confused
 145                     // by double double quotes
 146 #if 0
 147                     if ( *(pc - 2) == wxT('"') )
 148                         str << params.GetFileName();
 149                     else
 150                         str << wxT('"') << params.GetFileName() << wxT('"');
 151 #endif
 152                     str << params.GetFileName();
 153                     hasFilename = TRUE;
 154                     break;
 155
 156                 case wxT('t'):
 157                     // '%t' expands into MIME type (quote it too just to be
 158                     // consistent)
 159                     str << wxT('\'') << params.GetMimeType() << wxT('\'');
 160                     break;
 161
 162                 case wxT('{'):
 163                     {
 164                         const wxChar *pEnd = wxStrchr(pc, wxT('}'));
 165                         if ( pEnd == NULL ) {
 166                             wxString mimetype;
 167                             wxLogWarning(_("Unmatched '{' in an entry for mime type %s."),
 168                                          params.GetMimeType().c_str());
 169                             str << wxT("%{");
 170                         }
 171                         else {
 172                             wxString param(pc + 1, pEnd - pc - 1);
 173                             str << wxT('\'') << params.GetParamValue(param) << wxT('\'');
 174                             pc = pEnd;
 175                         }
 176                     }
 177                     break;
 178
 179                 case wxT('n'):
 180                 case wxT('F'):
 181                     // TODO %n is the number of parts, %F is an array containing
 182                     //      the names of temp files these parts were written to
 183                     //      and their mime types.
 184                     break;
 185
 186                 default:
 187                     wxLogDebug(wxT("Unknown field %%%c in command '%s'."),
 188                                *pc, command.c_str());
 189                     str << *pc;
 190             }
 191         }
 192         else {
 193             str << *pc;
 194         }
 195     }
 196
 197     // metamail(1) man page states that if the mailcap entry doesn't have '%s'
 198     // the program will accept the data on stdin so normally we should append
 199     // "< %s" to the end of the command in such case, but not all commands
 200     // behave like this, in particular a common test is 'test -n "$DISPLAY"'
 201     // and appending "< %s" to this command makes the test fail... I don't
 202     // know of the correct solution, try to guess what we have to do.
 203
 204     // test now carried out on reading file so test should never get here
 205     if ( !hasFilename && !str.IsEmpty()
 206 #ifdef __UNIX__
 207                       && !str.StartsWith(_T("test "))
 208 #endif // Unix
 209        ) {
 210         str << wxT(" < '") << params.GetFileName() << wxT('\'');
 211     }
 212
 213     return str;
 214 }
 215
 216 wxFileType::wxFileType(const wxFileTypeInfo& info)
 217 {
 218     m_info = &info;
 219     m_impl = NULL;
 220 }
 221
 222 wxFileType::wxFileType()
 223 {
 224     m_info = NULL;
 225     m_impl = new wxFileTypeImpl;
 226 }
 227
 228 wxFileType::~wxFileType()
 229 {
 230     if ( m_impl )
 231         delete m_impl;
 232 }
 233
 234 bool wxFileType::GetExtensions(wxArrayString& extensions)
 235 {
 236     if ( m_info )
 237     {
 238         extensions = m_info->GetExtensions();
 239         return TRUE;
 240     }
 241
 242     return m_impl->GetExtensions(extensions);
 243 }
 244
 245 bool wxFileType::GetMimeType(wxString *mimeType) const
 246 {
 247     wxCHECK_MSG( mimeType, FALSE, _T("invalid parameter in GetMimeType") );
 248
 249     if ( m_info )
 250     {
 251         *mimeType = m_info->GetMimeType();
 252
 253         return TRUE;
 254     }
 255
 256     return m_impl->GetMimeType(mimeType);
 257 }
 258
 259 bool wxFileType::GetMimeTypes(wxArrayString& mimeTypes) const
 260 {
 261     if ( m_info )
 262     {
 263         mimeTypes.Clear();
 264         mimeTypes.Add(m_info->GetMimeType());
 265
 266         return TRUE;
 267     }
 268
 269     return m_impl->GetMimeTypes(mimeTypes);
 270 }
 271
 272 bool wxFileType::GetIcon(wxIcon *icon,
 273                          wxString *iconFile,
 274                          int *iconIndex,
 275                          int iconSize) const
 276 {
 277     if ( m_info )
 278     {
 279         if ( iconFile )
 280             *iconFile = m_info->GetIconFile();
 281         if ( iconIndex )
 282             *iconIndex = m_info->GetIconIndex();
 283
 284 #if wxUSE_GUI
 285         if ( icon && !m_info->GetIconFile().empty() )
 286         {
 287             // FIXME: what about the index?
 288             icon->LoadFile(m_info->GetIconFile());
 289         }
 290 #endif // wxUSE_GUI
 291
 292         return TRUE;
 293     }
 294
 295 #if defined(__WXMSW__)
 296     return m_impl->GetIcon(icon, iconFile, iconIndex, iconSize);
 297 #elif defined(__UNIX__)
 298     return m_impl->GetIcon(icon, iconFile, iconIndex);
 299 #else
 300     return m_impl->GetIcon(icon);
 301 #endif
 302 }
 303
 304 bool wxFileType::GetDescription(wxString *desc) const
 305 {
 306     wxCHECK_MSG( desc, FALSE, _T("invalid parameter in GetDescription") );
 307
 308     if ( m_info )
 309     {
 310         *desc = m_info->GetDescription();
 311
 312         return TRUE;
 313     }
 314
 315     return m_impl->GetDescription(desc);
 316 }
 317
 318 bool
 319 wxFileType::GetOpenCommand(wxString *openCmd,
 320                            const wxFileType::MessageParameters& params) const
 321 {
 322     wxCHECK_MSG( openCmd, FALSE, _T("invalid parameter in GetOpenCommand") );
 323
 324     if ( m_info )
 325     {
 326         *openCmd = ExpandCommand(m_info->GetOpenCommand(), params);
 327
 328         return TRUE;
 329     }
 330
 331     return m_impl->GetOpenCommand(openCmd, params);
 332 }
 333
 334 wxString wxFileType::GetOpenCommand(const wxString& filename) const
 335 {
 336     wxString cmd;
 337     if ( !GetOpenCommand(&cmd, filename) )
 338     {
 339         // return empty string to indicate an error
 340         cmd.clear();
 341     }
 342
 343     return cmd;
 344 }
 345
 346 bool
 347 wxFileType::GetPrintCommand(wxString *printCmd,
 348                             const wxFileType::MessageParameters& params) const
 349 {
 350     wxCHECK_MSG( printCmd, FALSE, _T("invalid parameter in GetPrintCommand") );
 351
 352     if ( m_info )
 353     {
 354         *printCmd = ExpandCommand(m_info->GetPrintCommand(), params);
 355
 356         return TRUE;
 357     }
 358
 359     return m_impl->GetPrintCommand(printCmd, params);
 360 }
 361
 362
 363 size_t wxFileType::GetAllCommands(wxArrayString *verbs,
 364                                   wxArrayString *commands,
 365                                   const wxFileType::MessageParameters& params) const
 366 {
 367     if ( verbs )
 368         verbs->Clear();
 369     if ( commands )
 370         commands->Clear();
 371
 372 #if defined (__WXMSW__)  || defined(__UNIX__)
 373     return m_impl->GetAllCommands(verbs, commands, params);
 374 #else // !__WXMSW__ || Unix
 375     // we don't know how to retrieve all commands, so just try the 2 we know
 376     // about
 377     size_t count = 0;
 378     wxString cmd;
 379     if ( GetOpenCommand(&cmd, params) )
 380     {
 381         if ( verbs )
 382             verbs->Add(_T("Open"));
 383         if ( commands )
 384             commands->Add(cmd);
 385         count++;
 386     }
 387
 388     if ( GetPrintCommand(&cmd, params) )
 389     {
 390         if ( verbs )
 391             verbs->Add(_T("Print"));
 392         if ( commands )
 393             commands->Add(cmd);
 394
 395         count++;
 396     }
 397
 398     return count;
 399 #endif // __WXMSW__/| __UNIX__
 400 }
 401
 402 bool wxFileType::Unassociate()
 403 {
 404 #if defined(__WXMSW__)
 405     return m_impl->Unassociate();
 406 #elif defined(__UNIX__) && !defined(__WXPM__)
 407     return m_impl->Unassociate(this);
 408 #else
 409     wxFAIL_MSG( _T("not implemented") ); // TODO
 410     return FALSE;
 411 #endif
 412 }
 413
 414 bool wxFileType::SetCommand(const wxString& cmd, const wxString& verb,
 415 bool overwriteprompt)
 416 {
 417 #if defined (__WXMSW__)  || defined(__UNIX__)
 418     return m_impl->SetCommand(cmd, verb, overwriteprompt);
 419 #else
 420     wxFAIL_MSG(_T("not implemented"));
 421     return FALSE;
 422 #endif
 423 }
 424
 425 bool wxFileType::SetDefaultIcon(const wxString& cmd, int index)
 426 {
 427     wxString sTmp = cmd;
 428 #ifdef __WXMSW__
 429     // VZ: should we do this?
 430     // chris elliott : only makes sense in MS windows
 431     if ( sTmp.empty() )
 432         GetOpenCommand(&sTmp, wxFileType::MessageParameters(wxT(""), wxT("")));
 433 #endif
 434     wxCHECK_MSG( !sTmp.empty(), FALSE, _T("need the icon file") );
 435
 436 #if defined (__WXMSW__) || defined(__UNIX__)
 437     return m_impl->SetDefaultIcon (cmd, index);
 438 #else
 439     wxFAIL_MSG(_T("not implemented"));
 440
 441     return FALSE;
 442 #endif
 443 }
 444
 445
 446 // ----------------------------------------------------------------------------
 447 // wxMimeTypesManager
 448 // ----------------------------------------------------------------------------
 449
 450 void wxMimeTypesManager::EnsureImpl()
 451 {
 452     if ( !m_impl )
 453         m_impl = new wxMimeTypesManagerImpl;
 454 }
 455
 456 bool wxMimeTypesManager::IsOfType(const wxString& mimeType,
 457                                   const wxString& wildcard)
 458 {
 459     wxASSERT_MSG( mimeType.Find(wxT('*')) == wxNOT_FOUND,
 460                   wxT("first MIME type can't contain wildcards") );
 461
 462     // all comparaisons are case insensitive (2nd arg of IsSameAs() is FALSE)
 463     if ( wildcard.BeforeFirst(wxT('/')).
 464             IsSameAs(mimeType.BeforeFirst(wxT('/')), FALSE) )
 465     {
 466         wxString strSubtype = wildcard.AfterFirst(wxT('/'));
 467
 468         if ( strSubtype == wxT("*") ||
 469              strSubtype.IsSameAs(mimeType.AfterFirst(wxT('/')), FALSE) )
 470         {
 471             // matches (either exactly or it's a wildcard)
 472             return TRUE;
 473         }
 474     }
 475
 476     return FALSE;
 477 }
 478
 479 wxMimeTypesManager::wxMimeTypesManager()
 480 {
 481     m_impl = NULL;
 482 }
 483
 484 wxMimeTypesManager::~wxMimeTypesManager()
 485 {
 486     if ( m_impl )
 487         delete m_impl;
 488 }
 489
 490 bool wxMimeTypesManager::Unassociate(wxFileType *ft)
 491 {
 492 #if defined(__UNIX__) && !defined(__WXPM__) && !defined(__CYGWIN__) && !defined(__WINE__)
 493     return m_impl->Unassociate(ft);
 494 #else
 495     return ft->Unassociate();
 496 #endif
 497 }
 498
 499
 500 wxFileType *
 501 wxMimeTypesManager::Associate(const wxFileTypeInfo& ftInfo)
 502 {
 503     EnsureImpl();
 504
 505 #if defined(__WXMSW__) || (defined(__UNIX__) && !defined(__WXPM__))
 506     return m_impl->Associate(ftInfo);
 507 #else // other platforms
 508     wxFAIL_MSG( _T("not implemented") ); // TODO
 509     return NULL;
 510 #endif // platforms
 511 }
 512
 513 wxFileType *
 514 wxMimeTypesManager::GetFileTypeFromExtension(const wxString& ext)
 515 {
 516     EnsureImpl();
 517     wxFileType *ft = m_impl->GetFileTypeFromExtension(ext);
 518
 519     if ( !ft ) {
 520         // check the fallbacks
 521         //
 522         // TODO linear search is potentially slow, perhaps we should use a
 523         //       sorted array?
 524         size_t count = m_fallbacks.GetCount();
 525         for ( size_t n = 0; n < count; n++ ) {
 526             if ( m_fallbacks[n].GetExtensions().Index(ext) != wxNOT_FOUND ) {
 527                 ft = new wxFileType(m_fallbacks[n]);
 528
 529                 break;
 530             }
 531         }
 532     }
 533
 534     return ft;
 535 }
 536
 537 wxFileType *
 538 wxMimeTypesManager::GetFileTypeFromMimeType(const wxString& mimeType)
 539 {
 540     EnsureImpl();
 541     wxFileType *ft = m_impl->GetFileTypeFromMimeType(mimeType);
 542
 543     if ( ft ) {
 544         // check the fallbacks
 545         //
 546         // TODO linear search is potentially slow, perhaps we should use a sorted
 547         //      array?
 548         size_t count = m_fallbacks.GetCount();
 549         for ( size_t n = 0; n < count; n++ ) {
 550             if ( wxMimeTypesManager::IsOfType(mimeType,
 551                                               m_fallbacks[n].GetMimeType()) ) {
 552                 ft = new wxFileType(m_fallbacks[n]);
 553
 554                 break;
 555             }
 556         }
 557     }
 558
 559     return ft;
 560 }
 561
 562 bool wxMimeTypesManager::ReadMailcap(const wxString& filename, bool fallback)
 563 {
 564     EnsureImpl();
 565     return m_impl->ReadMailcap(filename, fallback);
 566 }
 567
 568 bool wxMimeTypesManager::ReadMimeTypes(const wxString& filename)
 569 {
 570     EnsureImpl();
 571     return m_impl->ReadMimeTypes(filename);
 572 }
 573
 574 void wxMimeTypesManager::AddFallbacks(const wxFileTypeInfo *filetypes)
 575 {
 576     EnsureImpl();
 577     for ( const wxFileTypeInfo *ft = filetypes; ft && ft->IsValid(); ft++ ) {
 578         AddFallback(*ft);
 579     }
 580 }
 581
 582 size_t wxMimeTypesManager::EnumAllFileTypes(wxArrayString& mimetypes)
 583 {
 584     EnsureImpl();
 585     size_t countAll = m_impl->EnumAllFileTypes(mimetypes);
 586
 587     // add the fallback filetypes
 588     size_t count = m_fallbacks.GetCount();
 589     for ( size_t n = 0; n < count; n++ ) {
 590         if ( mimetypes.Index(m_fallbacks[n].GetMimeType()) == wxNOT_FOUND ) {
 591             mimetypes.Add(m_fallbacks[n].GetMimeType());
 592             countAll++;
 593         }
 594     }
 595
 596     return countAll;
 597 }
 598
 599 void wxMimeTypesManager::Initialize(int mcapStyle,
 600                                     const wxString& sExtraDir)
 601 {
 602 #if defined(__UNIX__) && !defined(__WXPM__) && !defined(__CYGWIN__) && !defined(__WINE__)
 603     EnsureImpl();
 604
 605     m_impl->Initialize(mcapStyle, sExtraDir);
 606 #else
 607         (void)mcapStyle;
 608         (void)sExtraDir;
 609 #endif // Unix
 610 }
 611
 612 // and this function clears all the data from the manager
 613 void wxMimeTypesManager::ClearData()
 614 {
 615 #if defined(__UNIX__) && !defined(__WXPM__) && !defined(__CYGWIN__) && !defined(__WINE__)
 616     EnsureImpl();
 617
 618     m_impl->ClearData();
 619 #endif // Unix
 620 }
 621
 622 // ----------------------------------------------------------------------------
 623 // global data and wxMimeTypeCmnModule
 624 // ----------------------------------------------------------------------------
 625
 626 // private object
 627 static wxMimeTypesManager gs_mimeTypesManager;
 628
 629 // and public pointer
 630 wxMimeTypesManager *wxTheMimeTypesManager = &gs_mimeTypesManager;
 631
 632 class wxMimeTypeCmnModule: public wxModule
 633 {
 634 public:
 635     wxMimeTypeCmnModule() : wxModule() { }
 636     virtual bool OnInit() { return TRUE; }
 637     virtual void OnExit()
 638     {
 639         // this avoids false memory leak allerts:
 640         if ( gs_mimeTypesManager.m_impl != NULL )
 641         {
 642             delete gs_mimeTypesManager.m_impl;
 643             gs_mimeTypesManager.m_impl = NULL;
 644             gs_mimeTypesManager.m_fallbacks.Clear();
 645         }
 646     }
 647
 648     DECLARE_DYNAMIC_CLASS(wxMimeTypeCmnModule)
 649 };
 650
 651 IMPLEMENT_DYNAMIC_CLASS(wxMimeTypeCmnModule, wxModule)
 652
 653 #endif // wxUSE_MIMETYPE