src/msw/mimetype.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        msw/mimetype.cpp
   3 // Purpose:     classes and functions to manage MIME types
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     23.09.98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows license (part of wxExtra library)
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifdef    __GNUG__
  13 #pragma implementation "mimetype.h"
  14 #endif
  15
  16 // for compilers that support precompilation, includes "wx.h".
  17 #include "wx/wxprec.h"
  18
  19 #ifdef __BORLANDC__
  20   #pragma hdrstop
  21 #endif
  22
  23 // Doesn't compile in WIN16 mode
  24 #ifndef __WIN16__
  25
  26 #ifndef WX_PRECOMP
  27   #include "wx/string.h"
  28   #if wxUSE_GUI
  29     #include "wx/icon.h"
  30   #endif
  31 #endif //WX_PRECOMP
  32
  33 #include "wx/log.h"
  34 #include "wx/file.h"
  35 #include "wx/intl.h"
  36 #include "wx/dynarray.h"
  37 #include "wx/confbase.h"
  38
  39 #ifdef __WXMSW__
  40     #include "wx/msw/registry.h"
  41     #include "windows.h"
  42 #endif // OS
  43
  44 #include "wx/msw/mimetype.h"
  45
  46 // other standard headers
  47 #include <ctype.h>
  48
  49 // in case we're compiling in non-GUI mode
  50 class WXDLLEXPORT wxIcon;
  51
  52 // These classes use Windows registry to retrieve the required information.
  53 //
  54 // Keys used (not all of them are documented, so it might actually stop working
  55 // in futur versions of Windows...):
  56 //  1. "HKCR\MIME\Database\Content Type" contains subkeys for all known MIME
  57 //     types, each key has a string value "Extension" which gives (dot preceded)
  58 //     extension for the files of this MIME type.
  59 //
  60 //  2. "HKCR\.ext" contains
  61 //   a) unnamed value containing the "filetype"
  62 //   b) value "Content Type" containing the MIME type
  63 //
  64 // 3. "HKCR\filetype" contains
  65 //   a) unnamed value containing the description
  66 //   b) subkey "DefaultIcon" with single unnamed value giving the icon index in
  67 //      an icon file
  68 //   c) shell\open\command and shell\open\print subkeys containing the commands
  69 //      to open/print the file (the positional parameters are introduced by %1,
  70 //      %2, ... in these strings, we change them to %s ourselves)
  71
  72 // although I don't know of any official documentation which mentions this
  73 // location, uses it, so it isn't likely to change
  74 static const wxChar *MIME_DATABASE_KEY = wxT("MIME\\Database\\Content Type\\");
  75
  76 wxString wxFileTypeImpl::GetCommand(const wxChar *verb) const
  77 {
  78     // suppress possible error messages
  79     wxLogNull nolog;
  80     wxString strKey;
  81
  82     if ( wxRegKey(wxRegKey::HKCR, m_ext + _T("\\shell")).Exists() )
  83         strKey = m_ext;
  84     if ( wxRegKey(wxRegKey::HKCR, m_strFileType + _T("\\shell")).Exists() )
  85         strKey = m_strFileType;
  86
  87     if ( !strKey )
  88     {
  89         // no info
  90         return wxEmptyString;
  91     }
  92
  93     strKey << wxT("\\shell\\") << verb;
  94     wxRegKey key(wxRegKey::HKCR, strKey + _T("\\command"));
  95     wxString command;
  96     if ( key.Open() ) {
  97         // it's the default value of the key
  98         if ( key.QueryValue(wxT(""), command) ) {
  99             // transform it from '%1' to '%s' style format string (now also
 100             // test for %L - apparently MS started using it as well for the
 101             // same purpose)
 102
 103             // NB: we don't make any attempt to verify that the string is valid,
 104             //     i.e. doesn't contain %2, or second %1 or .... But we do make
 105             //     sure that we return a string with _exactly_ one '%s'!
 106             bool foundFilename = FALSE;
 107             size_t len = command.Len();
 108             for ( size_t n = 0; (n < len) && !foundFilename; n++ ) {
 109                 if ( command[n] == wxT('%') &&
 110                      (n + 1 < len) &&
 111                      (command[n + 1] == wxT('1') ||
 112                       command[n + 1] == wxT('L')) ) {
 113                     // replace it with '%s'
 114                     command[n + 1] = wxT('s');
 115
 116                     foundFilename = TRUE;
 117                 }
 118             }
 119
 120 #if wxUSE_DDE
 121             // look whether we must issue some DDE requests to the application
 122             // (and not just launch it)
 123             strKey += _T("\\DDEExec");
 124             wxRegKey keyDDE(wxRegKey::HKCR, strKey);
 125             if ( keyDDE.Open() ) {
 126                 wxString ddeCommand, ddeServer, ddeTopic;
 127                 keyDDE.QueryValue(_T(""), ddeCommand);
 128                 ddeCommand.Replace(_T("%1"), _T("%s"));
 129
 130                 wxRegKey(wxRegKey::HKCR, strKey + _T("\\Application")).
 131                     QueryValue(_T(""), ddeServer);
 132                 wxRegKey(wxRegKey::HKCR, strKey + _T("\\Topic")).
 133                     QueryValue(_T(""), ddeTopic);
 134
 135                 // HACK: we use a special feature of wxExecute which exists
 136                 //       just because we need it here: it will establish DDE
 137                 //       conversation with the program it just launched
 138                 command.Prepend(_T("WX_DDE#"));
 139                 command << _T('#') << ddeServer
 140                         << _T('#') << ddeTopic
 141                         << _T('#') << ddeCommand;
 142             }
 143             else
 144 #endif // wxUSE_DDE
 145                 if ( !foundFilename ) {
 146                 // we didn't find any '%1' - the application doesn't know which
 147                 // file to open (note that we only do it if there is no DDEExec
 148                 // subkey)
 149                 //
 150                 // HACK: append the filename at the end, hope that it will do
 151                 command << wxT(" %s");
 152             }
 153         }
 154     }
 155     //else: no such file type or no value, will return empty string
 156
 157     return command;
 158 }
 159
 160 bool
 161 wxFileTypeImpl::GetOpenCommand(wxString *openCmd,
 162                                const wxFileType::MessageParameters& params)
 163                                const
 164 {
 165     wxString cmd;
 166     if ( m_info ) {
 167         cmd = m_info->GetOpenCommand();
 168     }
 169     else {
 170         cmd = GetCommand(wxT("open"));
 171     }
 172
 173     *openCmd = wxFileType::ExpandCommand(cmd, params);
 174
 175     return !openCmd->IsEmpty();
 176 }
 177
 178 bool
 179 wxFileTypeImpl::GetPrintCommand(wxString *printCmd,
 180                                 const wxFileType::MessageParameters& params)
 181                                 const
 182 {
 183     wxString cmd;
 184     if ( m_info ) {
 185         cmd = m_info->GetPrintCommand();
 186     }
 187     else {
 188         cmd = GetCommand(wxT("print"));
 189     }
 190
 191     *printCmd = wxFileType::ExpandCommand(cmd, params);
 192
 193     return !printCmd->IsEmpty();
 194 }
 195
 196 // TODO this function is half implemented
 197 bool wxFileTypeImpl::GetExtensions(wxArrayString& extensions)
 198 {
 199     if ( m_info ) {
 200         extensions = m_info->GetExtensions();
 201
 202         return TRUE;
 203     }
 204     else if ( m_ext.IsEmpty() ) {
 205         // the only way to get the list of extensions from the file type is to
 206         // scan through all extensions in the registry - too slow...
 207         return FALSE;
 208     }
 209     else {
 210         extensions.Empty();
 211         extensions.Add(m_ext);
 212
 213         // it's a lie too, we don't return _all_ extensions...
 214         return TRUE;
 215     }
 216 }
 217
 218 bool wxFileTypeImpl::GetMimeType(wxString *mimeType) const
 219 {
 220     if ( m_info ) {
 221         // we already have it
 222         *mimeType = m_info->GetMimeType();
 223
 224         return TRUE;
 225     }
 226
 227     // suppress possible error messages
 228     wxLogNull nolog;
 229     wxRegKey key(wxRegKey::HKCR, wxT(".") + m_ext);
 230     if ( key.Open() && key.QueryValue(wxT("Content Type"), *mimeType) ) {
 231         return TRUE;
 232     }
 233     else {
 234         return FALSE;
 235     }
 236 }
 237
 238
 239 bool wxFileTypeImpl::GetMimeTypes(wxArrayString& mimeTypes) const
 240 {
 241     wxString s;
 242
 243     if (GetMimeType(&s))
 244     {
 245         mimeTypes.Clear();
 246         mimeTypes.Add(s);
 247         return TRUE;
 248     }
 249     else
 250         return FALSE;
 251 }
 252
 253
 254 bool wxFileTypeImpl::GetIcon(wxIcon *icon) const
 255 {
 256 #if wxUSE_GUI
 257     if ( m_info ) {
 258         // we don't have icons in the fallback resources
 259         return FALSE;
 260     }
 261
 262     wxString strIconKey;
 263     strIconKey << m_strFileType << wxT("\\DefaultIcon");
 264
 265     // suppress possible error messages
 266     wxLogNull nolog;
 267     wxRegKey key(wxRegKey::HKCR, strIconKey);
 268
 269     if ( key.Open() ) {
 270         wxString strIcon;
 271         // it's the default value of the key
 272         if ( key.QueryValue(wxT(""), strIcon) ) {
 273             // the format is the following: <full path to file>, <icon index>
 274             // NB: icon index may be negative as well as positive and the full
 275             //     path may contain the environment variables inside '%'
 276             wxString strFullPath = strIcon.BeforeLast(wxT(',')),
 277             strIndex = strIcon.AfterLast(wxT(','));
 278
 279             // index may be omitted, in which case BeforeLast(',') is empty and
 280             // AfterLast(',') is the whole string
 281             if ( strFullPath.IsEmpty() ) {
 282                 strFullPath = strIndex;
 283                 strIndex = wxT("0");
 284             }
 285
 286             wxString strExpPath = wxExpandEnvVars(strFullPath);
 287             int nIndex = wxAtoi(strIndex);
 288
 289             HICON hIcon = ExtractIcon(GetModuleHandle(NULL), strExpPath, nIndex);
 290             switch ( (int)hIcon ) {
 291                 case 0: // means no icons were found
 292                 case 1: // means no such file or it wasn't a DLL/EXE/OCX/ICO/...
 293                     wxLogDebug(wxT("incorrect registry entry '%s': no such icon."),
 294                                key.GetName().c_str());
 295                     break;
 296
 297                 default:
 298                     icon->SetHICON((WXHICON)hIcon);
 299                     return TRUE;
 300             }
 301         }
 302     }
 303
 304     // no such file type or no value or incorrect icon entry
 305 #endif // wxUSE_GUI
 306
 307     return FALSE;
 308 }
 309
 310 bool wxFileTypeImpl::GetDescription(wxString *desc) const
 311 {
 312     if ( m_info ) {
 313         // we already have it
 314         *desc = m_info->GetDescription();
 315
 316         return TRUE;
 317     }
 318
 319     // suppress possible error messages
 320     wxLogNull nolog;
 321     wxRegKey key(wxRegKey::HKCR, m_strFileType);
 322
 323     if ( key.Open() ) {
 324         // it's the default value of the key
 325         if ( key.QueryValue(wxT(""), *desc) ) {
 326             return TRUE;
 327         }
 328     }
 329
 330     return FALSE;
 331 }
 332
 333 // extension -> file type
 334 wxFileType *
 335 wxMimeTypesManagerImpl::GetFileTypeFromExtension(const wxString& ext)
 336 {
 337     // add the leading point if necessary
 338     wxString str;
 339     if ( ext[0u] != wxT('.') ) {
 340         str = wxT('.');
 341     }
 342     str << ext;
 343
 344     // suppress possible error messages
 345     wxLogNull nolog;
 346
 347     bool knownExtension = FALSE;
 348
 349     wxString strFileType;
 350     wxRegKey key(wxRegKey::HKCR, str);
 351     if ( key.Open() ) {
 352         // it's the default value of the key
 353         if ( key.QueryValue(wxT(""), strFileType) ) {
 354             // create the new wxFileType object
 355             wxFileType *fileType = new wxFileType;
 356             fileType->m_impl->Init(strFileType, ext);
 357
 358             return fileType;
 359         }
 360         else {
 361             // this extension doesn't have a filetype, but it's known to the
 362             // system and may be has some other useful keys (open command or
 363             // content-type), so still return a file type object for it
 364             knownExtension = TRUE;
 365         }
 366     }
 367
 368     // check the fallbacks
 369     // TODO linear search is potentially slow, perhaps we should use a sorted
 370     //      array?
 371     size_t count = m_fallbacks.GetCount();
 372     for ( size_t n = 0; n < count; n++ ) {
 373         if ( m_fallbacks[n].GetExtensions().Index(ext) != wxNOT_FOUND ) {
 374             wxFileType *fileType = new wxFileType;
 375             fileType->m_impl->Init(m_fallbacks[n]);
 376
 377             return fileType;
 378         }
 379     }
 380
 381     if ( knownExtension )
 382     {
 383         wxFileType *fileType = new wxFileType;
 384         fileType->m_impl->Init(wxEmptyString, ext);
 385
 386         return fileType;
 387     }
 388     else
 389     {
 390         // unknown extension
 391         return NULL;
 392     }
 393 }
 394
 395 // MIME type -> extension -> file type
 396 wxFileType *
 397 wxMimeTypesManagerImpl::GetFileTypeFromMimeType(const wxString& mimeType)
 398 {
 399     wxString strKey = MIME_DATABASE_KEY;
 400     strKey << mimeType;
 401
 402     // suppress possible error messages
 403     wxLogNull nolog;
 404
 405     wxString ext;
 406     wxRegKey key(wxRegKey::HKCR, strKey);
 407     if ( key.Open() ) {
 408         if ( key.QueryValue(wxT("Extension"), ext) ) {
 409             return GetFileTypeFromExtension(ext);
 410         }
 411     }
 412
 413     // check the fallbacks
 414     // TODO linear search is potentially slow, perhaps we should use a sorted
 415     //      array?
 416     size_t count = m_fallbacks.GetCount();
 417     for ( size_t n = 0; n < count; n++ ) {
 418         if ( wxMimeTypesManager::IsOfType(mimeType,
 419                                           m_fallbacks[n].GetMimeType()) ) {
 420             wxFileType *fileType = new wxFileType;
 421             fileType->m_impl->Init(m_fallbacks[n]);
 422
 423             return fileType;
 424         }
 425     }
 426
 427     // unknown MIME type
 428     return NULL;
 429 }
 430
 431 size_t wxMimeTypesManagerImpl::EnumAllFileTypes(wxArrayString& mimetypes)
 432 {
 433     // enumerate all keys under MIME_DATABASE_KEY
 434     wxRegKey key(wxRegKey::HKCR, MIME_DATABASE_KEY);
 435
 436     wxString type;
 437     long cookie;
 438     bool cont = key.GetFirstKey(type, cookie);
 439     while ( cont )
 440     {
 441         mimetypes.Add(type);
 442
 443         cont = key.GetNextKey(type, cookie);
 444     }
 445
 446     return mimetypes.GetCount();
 447 }
 448
 449
 450 #endif
 451   // __WIN16__