dlls/msi/msipriv.h

   1 /*
   2  * Implementation of the Microsoft Installer (msi.dll)
   3  *
   4  * Copyright 2002-2005 Mike McCormack for CodeWeavers
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #ifndef __WINE_MSI_PRIVATE__
  22 #define __WINE_MSI_PRIVATE__
  23
  24 #include <stdarg.h>
  25
  26 #include "windef.h"
  27 #include "winbase.h"
  28 #include "msi.h"
  29 #include "msiquery.h"
  30 #include "objbase.h"
  31 #include "objidl.h"
  32 #include "winnls.h"
  33 #include "wine/list.h"
  34
  35 #define MSI_DATASIZEMASK 0x00ff
  36 #define MSITYPE_VALID    0x0100
  37 #define MSITYPE_LOCALIZABLE 0x200
  38 #define MSITYPE_STRING   0x0800
  39 #define MSITYPE_NULLABLE 0x1000
  40 #define MSITYPE_KEY      0x2000
  41
  42 #define MSITYPE_IS_BINARY(type) (((type) & ~MSITYPE_NULLABLE) == (MSITYPE_STRING|MSITYPE_VALID))
  43
  44 struct tagMSITABLE;
  45 typedef struct tagMSITABLE MSITABLE;
  46
  47 struct string_table;
  48 typedef struct string_table string_table;
  49
  50 struct tagMSIOBJECTHDR;
  51 typedef struct tagMSIOBJECTHDR MSIOBJECTHDR;
  52
  53 typedef VOID (*msihandledestructor)( MSIOBJECTHDR * );
  54
  55 struct tagMSIOBJECTHDR
  56 {
  57     UINT magic;
  58     UINT type;
  59     LONG refcount;
  60     msihandledestructor destructor;
  61 };
  62
  63 typedef struct tagMSIDATABASE
  64 {
  65     MSIOBJECTHDR hdr;
  66     IStorage *storage;
  67     string_table *strings;
  68     LPCWSTR mode;
  69     struct list tables;
  70 } MSIDATABASE;
  71
  72 typedef struct tagMSIVIEW MSIVIEW;
  73
  74 typedef struct tagMSIQUERY
  75 {
  76     MSIOBJECTHDR hdr;
  77     MSIVIEW *view;
  78     UINT row;
  79     MSIDATABASE *db;
  80     struct list mem;
  81 } MSIQUERY;
  82
  83 /* maybe we can use a Variant instead of doing it ourselves? */
  84 typedef struct tagMSIFIELD
  85 {
  86     UINT type;
  87     union
  88     {
  89         INT iVal;
  90         LPWSTR szwVal;
  91         IStream *stream;
  92     } u;
  93 } MSIFIELD;
  94
  95 typedef struct tagMSIRECORD
  96 {
  97     MSIOBJECTHDR hdr;
  98     UINT count;       /* as passed to MsiCreateRecord */
  99     MSIFIELD fields[1]; /* nb. array size is count+1 */
 100 } MSIRECORD;
 101
 102 typedef struct tagMSIVIEWOPS
 103 {
 104     /*
 105      * fetch_int - reads one integer from {row,col} in the table
 106      *
 107      *  This function should be called after the execute method.
 108      *  Data returned by the function should not change until
 109      *   close or delete is called.
 110      *  To get a string value, query the database's string table with
 111      *   the integer value returned from this function.
 112      */
 113     UINT (*fetch_int)( struct tagMSIVIEW *, UINT row, UINT col, UINT *val );
 114
 115     /*
 116      * fetch_int - reads one integer from {row,col} in the table
 117      *
 118      *  This function is similar to fetch_int, except fetches a
 119      *    stream instead of an integer.
 120      */
 121     UINT (*fetch_stream)( struct tagMSIVIEW *, UINT row, UINT col, IStream **stm );
 122
 123     /*
 124      * get_int - sets one integer at {row,col} in the table
 125      *
 126      *  Similar semantics to fetch_int
 127      */
 128     UINT (*set_int)( struct tagMSIVIEW *, UINT row, UINT col, UINT val );
 129
 130     /*
 131      * Inserts a new row into the database from the records contents
 132      */
 133     UINT (*insert_row)( struct tagMSIVIEW *, MSIRECORD * );
 134
 135     /*
 136      * execute - loads the underlying data into memory so it can be read
 137      */
 138     UINT (*execute)( struct tagMSIVIEW *, MSIRECORD * );
 139
 140     /*
 141      * close - clears the data read by execute from memory
 142      */
 143     UINT (*close)( struct tagMSIVIEW * );
 144
 145     /*
 146      * get_dimensions - returns the number of rows or columns in a table.
 147      *
 148      *  The number of rows can only be queried after the execute method
 149      *   is called. The number of columns can be queried at any time.
 150      */
 151     UINT (*get_dimensions)( struct tagMSIVIEW *, UINT *rows, UINT *cols );
 152
 153     /*
 154      * get_column_info - returns the name and type of a specific column
 155      *
 156      *  The name is HeapAlloc'ed by this function and should be freed by
 157      *   the caller.
 158      *  The column information can be queried at any time.
 159      */
 160     UINT (*get_column_info)( struct tagMSIVIEW *, UINT n, LPWSTR *name, UINT *type );
 161
 162     /*
 163      * modify - not yet implemented properly
 164      */
 165     UINT (*modify)( struct tagMSIVIEW *, MSIMODIFY, MSIRECORD * );
 166
 167     /*
 168      * delete - destroys the structure completely
 169      */
 170     UINT (*delete)( struct tagMSIVIEW * );
 171
 172 } MSIVIEWOPS;
 173
 174 struct tagMSIVIEW
 175 {
 176     MSIOBJECTHDR hdr;
 177     MSIVIEWOPS   *ops;
 178 };
 179
 180 struct msi_dialog_tag;
 181 typedef struct msi_dialog_tag msi_dialog;
 182
 183 typedef struct tagMSIPACKAGE
 184 {
 185     MSIOBJECTHDR hdr;
 186     MSIDATABASE *db;
 187     struct list components;
 188     struct list features;
 189     struct list files;
 190     struct list tempfiles;
 191     struct list folders;
 192     LPWSTR ActionFormat;
 193     LPWSTR LastAction;
 194
 195     struct list classes;
 196     struct list extensions;
 197     struct list progids;
 198     struct list mimes;
 199     struct list appids;
 200
 201     struct tagMSISCRIPT *script;
 202
 203     struct list RunningActions;
 204
 205     LPWSTR PackagePath;
 206     LPWSTR ProductCode;
 207
 208     UINT CurrentInstallState;
 209     msi_dialog *dialog;
 210     LPWSTR next_dialog;
 211
 212     struct list subscriptions;
 213 } MSIPACKAGE;
 214
 215 typedef struct tagMSIPREVIEW
 216 {
 217     MSIOBJECTHDR hdr;
 218     MSIPACKAGE *package;
 219     msi_dialog *dialog;
 220 } MSIPREVIEW;
 221
 222 #define MSIHANDLETYPE_ANY 0
 223 #define MSIHANDLETYPE_DATABASE 1
 224 #define MSIHANDLETYPE_SUMMARYINFO 2
 225 #define MSIHANDLETYPE_VIEW 3
 226 #define MSIHANDLETYPE_RECORD 4
 227 #define MSIHANDLETYPE_PACKAGE 5
 228 #define MSIHANDLETYPE_PREVIEW 6
 229
 230 #define MSI_MAJORVERSION 2
 231 #define MSI_MINORVERSION 0
 232 #define MSI_BUILDNUMBER 2600
 233
 234 #define GUID_SIZE 39
 235
 236 #define MSIHANDLE_MAGIC 0x4d434923
 237 #define MSIMAXHANDLES 0xf0
 238
 239 DEFINE_GUID(CLSID_IMsiServer,   0x000C101C,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
 240 DEFINE_GUID(CLSID_IMsiServerX1, 0x000C103E,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
 241 DEFINE_GUID(CLSID_IMsiServerX2, 0x000C1090,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
 242 DEFINE_GUID(CLSID_IMsiServerX3, 0x000C1094,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
 243
 244 DEFINE_GUID(CLSID_IMsiServerMessage, 0x000C101D,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
 245
 246 typedef struct {
 247     BOOL unicode;
 248     union {
 249        LPSTR a;
 250        LPWSTR w;
 251     } str;
 252 } awstring;
 253
 254 typedef struct {
 255     BOOL unicode;
 256     union {
 257        LPCSTR a;
 258        LPCWSTR w;
 259     } str;
 260 } awcstring;
 261
 262 /* handle functions */
 263 extern void *msihandle2msiinfo(MSIHANDLE handle, UINT type);
 264 extern MSIHANDLE alloc_msihandle( MSIOBJECTHDR * );
 265 extern void *alloc_msiobject(UINT type, UINT size, msihandledestructor destroy );
 266 extern void msiobj_addref(MSIOBJECTHDR *);
 267 extern int msiobj_release(MSIOBJECTHDR *);
 268 extern void msiobj_lock(MSIOBJECTHDR *);
 269 extern void msiobj_unlock(MSIOBJECTHDR *);
 270
 271 extern void free_cached_tables( MSIDATABASE *db );
 272 extern string_table *load_string_table( IStorage *stg );
 273 extern UINT MSI_CommitTables( MSIDATABASE *db );
 274 extern HRESULT init_string_table( IStorage *stg );
 275
 276
 277 /* string table functions */
 278 extern BOOL msi_addstring( string_table *st, UINT string_no, const CHAR *data, int len, UINT refcount );
 279 extern BOOL msi_addstringW( string_table *st, UINT string_no, const WCHAR *data, int len, UINT refcount );
 280 extern UINT msi_id2stringW( string_table *st, UINT string_no, LPWSTR buffer, UINT *sz );
 281 extern UINT msi_id2stringA( string_table *st, UINT string_no, LPSTR buffer, UINT *sz );
 282
 283 extern LPWSTR MSI_makestring( MSIDATABASE *db, UINT stringid);
 284 extern UINT msi_string2idW( string_table *st, LPCWSTR buffer, UINT *id );
 285 extern UINT msi_string2idA( string_table *st, LPCSTR str, UINT *id );
 286 extern string_table *msi_init_stringtable( int entries, UINT codepage );
 287 extern VOID msi_destroy_stringtable( string_table *st );
 288 extern UINT msi_string_count( string_table *st );
 289 extern UINT msi_id_refcount( string_table *st, UINT i );
 290 extern UINT msi_string_totalsize( string_table *st, UINT *last );
 291 extern UINT msi_strcmp( string_table *st, UINT lval, UINT rval, UINT *res );
 292 extern const WCHAR *msi_string_lookup_id( string_table *st, UINT id );
 293 extern UINT msi_string_get_codepage( string_table *st );
 294
 295
 296 extern UINT VIEW_find_column( MSIVIEW *view, LPCWSTR name, UINT *n );
 297
 298 extern BOOL TABLE_Exists( MSIDATABASE *db, LPWSTR name );
 299
 300 extern UINT read_raw_stream_data( MSIDATABASE*, LPCWSTR stname,
 301                               USHORT **pdata, UINT *psz );
 302
 303 /* action internals */
 304 extern UINT MSI_InstallPackage( MSIPACKAGE *, LPCWSTR, LPCWSTR );
 305 extern void ACTION_free_package_structures( MSIPACKAGE* );
 306 extern UINT ACTION_DialogBox( MSIPACKAGE*, LPCWSTR);
 307 extern UINT MSI_Sequence( MSIPACKAGE *package, LPCWSTR szTable, INT iSequenceMode );
 308
 309 /* record internals */
 310 extern UINT MSI_RecordSetIStream( MSIRECORD *, unsigned int, IStream *);
 311 extern UINT MSI_RecordGetIStream( MSIRECORD *, unsigned int, IStream **);
 312 extern const WCHAR *MSI_RecordGetString( MSIRECORD *, unsigned int );
 313 extern MSIRECORD *MSI_CreateRecord( unsigned int );
 314 extern UINT MSI_RecordSetInteger( MSIRECORD *, unsigned int, int );
 315 extern UINT MSI_RecordSetStringW( MSIRECORD *, unsigned int, LPCWSTR );
 316 extern UINT MSI_RecordSetStringA( MSIRECORD *, unsigned int, LPCSTR );
 317 extern BOOL MSI_RecordIsNull( MSIRECORD *, unsigned int );
 318 extern UINT MSI_RecordGetStringW( MSIRECORD * , unsigned int, LPWSTR, DWORD *);
 319 extern UINT MSI_RecordGetStringA( MSIRECORD *, unsigned int, LPSTR, DWORD *);
 320 extern int MSI_RecordGetInteger( MSIRECORD *, unsigned int );
 321 extern UINT MSI_RecordReadStream( MSIRECORD *, unsigned int, char *, DWORD *);
 322 extern unsigned int MSI_RecordGetFieldCount( MSIRECORD *rec );
 323 extern UINT MSI_RecordSetStreamW( MSIRECORD *, unsigned int, LPCWSTR );
 324 extern UINT MSI_RecordSetStreamA( MSIRECORD *, unsigned int, LPCSTR );
 325 extern UINT MSI_RecordDataSize( MSIRECORD *, unsigned int );
 326 extern UINT MSI_RecordStreamToFile( MSIRECORD *, unsigned int, LPCWSTR );
 327
 328 /* stream internals */
 329 extern UINT get_raw_stream( MSIHANDLE hdb, LPCWSTR stname, IStream **stm );
 330 extern UINT db_get_raw_stream( MSIDATABASE *db, LPCWSTR stname, IStream **stm );
 331 extern void enum_stream_names( IStorage *stg );
 332
 333 /* database internals */
 334 extern UINT MSI_OpenDatabaseW( LPCWSTR, LPCWSTR, MSIDATABASE ** );
 335 extern UINT MSI_DatabaseOpenViewW(MSIDATABASE *, LPCWSTR, MSIQUERY ** );
 336 extern UINT MSI_OpenQuery( MSIDATABASE *, MSIQUERY **, LPCWSTR, ... );
 337 typedef UINT (*record_func)( MSIRECORD *, LPVOID );
 338 extern UINT MSI_IterateRecords( MSIQUERY *, DWORD *, record_func, LPVOID );
 339 extern MSIRECORD *MSI_QueryGetRecord( MSIDATABASE *db, LPCWSTR query, ... );
 340 extern UINT MSI_DatabaseImport( MSIDATABASE *, LPCWSTR, LPCWSTR );
 341 extern UINT MSI_DatabaseExport( MSIDATABASE *, LPCWSTR, LPCWSTR, LPCWSTR );
 342 extern UINT MSI_DatabaseGetPrimaryKeys( MSIDATABASE *, LPCWSTR, MSIRECORD ** );
 343
 344 /* view internals */
 345 extern UINT MSI_ViewExecute( MSIQUERY*, MSIRECORD * );
 346 extern UINT MSI_ViewFetch( MSIQUERY*, MSIRECORD ** );
 347 extern UINT MSI_ViewClose( MSIQUERY* );
 348
 349 /* package internals */
 350 extern MSIPACKAGE *MSI_CreatePackage( MSIDATABASE * );
 351 extern UINT MSI_OpenPackageW( LPCWSTR szPackage, MSIPACKAGE ** );
 352 extern UINT MSI_SetTargetPathW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
 353 extern UINT MSI_SetPropertyW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
 354 extern INT MSI_ProcessMessage( MSIPACKAGE *, INSTALLMESSAGE, MSIRECORD * );
 355 extern UINT MSI_GetPropertyW( MSIPACKAGE *, LPCWSTR, LPWSTR, DWORD * );
 356 extern UINT MSI_GetPropertyA(MSIPACKAGE *, LPCSTR, LPSTR, DWORD* );
 357 extern MSICONDITION MSI_EvaluateConditionW( MSIPACKAGE *, LPCWSTR );
 358 extern UINT MSI_GetComponentStateW( MSIPACKAGE *, LPWSTR, INSTALLSTATE *, INSTALLSTATE * );
 359 extern UINT MSI_GetFeatureStateW( MSIPACKAGE *, LPWSTR, INSTALLSTATE *, INSTALLSTATE * );
 360 extern UINT WINAPI MSI_SetFeatureStateW(MSIPACKAGE*, LPCWSTR, INSTALLSTATE );
 361
 362 /* for deformating */
 363 extern UINT MSI_FormatRecordW( MSIPACKAGE *, MSIRECORD *, LPWSTR, DWORD * );
 364 extern UINT MSI_FormatRecordA( MSIPACKAGE *, MSIRECORD *, LPSTR, DWORD * );
 365
 366 /* registry data encoding/decoding functions */
 367 extern BOOL unsquash_guid(LPCWSTR in, LPWSTR out);
 368 extern BOOL squash_guid(LPCWSTR in, LPWSTR out);
 369 extern BOOL encode_base85_guid(GUID *,LPWSTR);
 370 extern BOOL decode_base85_guid(LPCWSTR,GUID*);
 371 extern UINT MSIREG_OpenUninstallKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 372 extern UINT MSIREG_OpenUserProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 373 extern UINT MSIREG_OpenFeatures(HKEY* key);
 374 extern UINT MSIREG_OpenFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 375 extern UINT MSIREG_OpenComponents(HKEY* key);
 376 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
 377 extern UINT MSIREG_OpenComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
 378 extern UINT MSIREG_OpenProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 379 extern UINT MSIREG_OpenUserFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 380 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
 381 extern UINT MSIREG_OpenUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 382 extern UINT MSIREG_OpenUserUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 383
 384 extern LONG msi_reg_set_val_str( HKEY hkey, LPCWSTR name, LPCWSTR value );
 385 extern LONG msi_reg_set_val_multi_str( HKEY hkey, LPCWSTR name, LPCWSTR value );
 386 extern LONG msi_reg_set_val_dword( HKEY hkey, LPCWSTR name, DWORD val );
 387
 388 /* msi dialog interface */
 389 typedef UINT (*msi_dialog_event_handler)( MSIPACKAGE*, LPCWSTR, LPCWSTR, msi_dialog* );
 390 extern msi_dialog *msi_dialog_create( MSIPACKAGE*, LPCWSTR, msi_dialog_event_handler );
 391 extern UINT msi_dialog_run_message_loop( msi_dialog* );
 392 extern void msi_dialog_end_dialog( msi_dialog* );
 393 extern void msi_dialog_check_messages( HANDLE );
 394 extern void msi_dialog_do_preview( msi_dialog* );
 395 extern void msi_dialog_destroy( msi_dialog* );
 396 extern BOOL msi_dialog_register_class( void );
 397 extern void msi_dialog_unregister_class( void );
 398 extern void msi_dialog_handle_event( msi_dialog*, LPCWSTR, LPCWSTR, MSIRECORD * );
 399
 400 /* preview */
 401 extern MSIPREVIEW *MSI_EnableUIPreview( MSIDATABASE * );
 402 extern UINT MSI_PreviewDialogW( MSIPREVIEW *, LPCWSTR );
 403
 404 /* undocumented functions */
 405 UINT WINAPI MsiCreateAndVerifyInstallerDirectory( DWORD );
 406 UINT WINAPI MsiDecomposeDescriptorW( LPCWSTR, LPWSTR, LPWSTR, LPWSTR, DWORD * );
 407 UINT WINAPI MsiDecomposeDescriptorA( LPCSTR, LPSTR, LPSTR, LPSTR, DWORD * );
 408 LANGID WINAPI MsiLoadStringW( MSIHANDLE, UINT, LPWSTR, int, LANGID );
 409 LANGID WINAPI MsiLoadStringA( MSIHANDLE, UINT, LPSTR, int, LANGID );
 410
 411 /* UI globals */
 412 extern INSTALLUILEVEL gUILevel;
 413 extern HWND gUIhwnd;
 414 extern INSTALLUI_HANDLERA gUIHandlerA;
 415 extern INSTALLUI_HANDLERW gUIHandlerW;
 416 extern DWORD gUIFilter;
 417 extern LPVOID gUIContext;
 418 extern WCHAR gszLogFile[MAX_PATH];
 419
 420 /* memory allocation macro functions */
 421 static inline void *msi_alloc( size_t len )
 422 {
 423     return HeapAlloc( GetProcessHeap(), 0, len );
 424 }
 425
 426 static inline void *msi_alloc_zero( size_t len )
 427 {
 428     return HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, len );
 429 }
 430
 431 static inline void *msi_realloc( void *mem, size_t len )
 432 {
 433     return HeapReAlloc( GetProcessHeap(), 0, mem, len );
 434 }
 435
 436 static inline void *msi_realloc_zero( void *mem, size_t len )
 437 {
 438     return HeapReAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, mem, len );
 439 }
 440
 441 static inline BOOL msi_free( void *mem )
 442 {
 443     return HeapFree( GetProcessHeap(), 0, mem );
 444 }
 445
 446 inline static char *strdupWtoA( LPCWSTR str )
 447 {
 448     LPSTR ret = NULL;
 449     DWORD len;
 450
 451     if (!str) return ret;
 452     len = WideCharToMultiByte( CP_ACP, 0, str, -1, NULL, 0, NULL, NULL);
 453     ret = msi_alloc( len );
 454     if (ret)
 455         WideCharToMultiByte( CP_ACP, 0, str, -1, ret, len, NULL, NULL );
 456     return ret;
 457 }
 458
 459 inline static LPWSTR strdupAtoW( LPCSTR str )
 460 {
 461     LPWSTR ret = NULL;
 462     DWORD len;
 463
 464     if (!str) return ret;
 465     len = MultiByteToWideChar( CP_ACP, 0, str, -1, NULL, 0 );
 466     ret = msi_alloc( len * sizeof(WCHAR) );
 467     if (ret)
 468         MultiByteToWideChar( CP_ACP, 0, str, -1, ret, len );
 469     return ret;
 470 }
 471
 472 inline static LPWSTR strdupW( LPCWSTR src )
 473 {
 474     LPWSTR dest;
 475     if (!src) return NULL;
 476     dest = msi_alloc( (lstrlenW(src)+1)*sizeof(WCHAR) );
 477     if (dest)
 478         lstrcpyW(dest, src);
 479     return dest;
 480 }
 481
 482 #endif /* __WINE_MSI_PRIVATE__ */