git.oblomov.eu Git - wine/blob - 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_STRING   0x0800
  38 #define MSITYPE_NULLABLE 0x1000
  39 #define MSITYPE_KEY      0x2000
  40
  41 #define MSITYPE_BINARY 0x8900
  42
  43 struct tagMSITABLE;
  44 typedef struct tagMSITABLE MSITABLE;
  45
  46 struct string_table;
  47 typedef struct string_table string_table;
  48
  49 struct tagMSIOBJECTHDR;
  50 typedef struct tagMSIOBJECTHDR MSIOBJECTHDR;
  51
  52 typedef VOID (*msihandledestructor)( MSIOBJECTHDR * );
  53
  54 struct tagMSIOBJECTHDR
  55 {
  56     UINT magic;
  57     UINT type;
  58     LONG refcount;
  59     msihandledestructor destructor;
  60 };
  61
  62 typedef struct tagMSIDATABASE
  63 {
  64     MSIOBJECTHDR hdr;
  65     IStorage *storage;
  66     string_table *strings;
  67     LPCWSTR mode;
  68     struct list tables;
  69 } MSIDATABASE;
  70
  71 typedef struct tagMSIVIEW MSIVIEW;
  72
  73 typedef struct tagMSIQUERY
  74 {
  75     MSIOBJECTHDR hdr;
  76     MSIVIEW *view;
  77     UINT row;
  78     MSIDATABASE *db;
  79     struct list mem;
  80 } MSIQUERY;
  81
  82 /* maybe we can use a Variant instead of doing it ourselves? */
  83 typedef struct tagMSIFIELD
  84 {
  85     UINT type;
  86     union
  87     {
  88         INT iVal;
  89         LPWSTR szwVal;
  90         IStream *stream;
  91     } u;
  92 } MSIFIELD;
  93
  94 typedef struct tagMSIRECORD
  95 {
  96     MSIOBJECTHDR hdr;
  97     UINT count;       /* as passed to MsiCreateRecord */
  98     MSIFIELD fields[1]; /* nb. array size is count+1 */
  99 } MSIRECORD;
 100
 101 typedef struct tagMSIVIEWOPS
 102 {
 103     /*
 104      * fetch_int - reads one integer from {row,col} in the table
 105      *
 106      *  This function should be called after the execute method.
 107      *  Data returned by the function should not change until
 108      *   close or delete is called.
 109      *  To get a string value, query the database's string table with
 110      *   the integer value returned from this function.
 111      */
 112     UINT (*fetch_int)( struct tagMSIVIEW *, UINT row, UINT col, UINT *val );
 113
 114     /*
 115      * fetch_int - reads one integer from {row,col} in the table
 116      *
 117      *  This function is similar to fetch_int, except fetches a
 118      *    stream instead of an integer.
 119      */
 120     UINT (*fetch_stream)( struct tagMSIVIEW *, UINT row, UINT col, IStream **stm );
 121
 122     /*
 123      * get_int - sets one integer at {row,col} in the table
 124      *
 125      *  Similar semantics to fetch_int
 126      */
 127     UINT (*set_int)( struct tagMSIVIEW *, UINT row, UINT col, UINT val );
 128
 129     /*
 130      * Inserts a new row into the database from the records contents
 131      */
 132     UINT (*insert_row)( struct tagMSIVIEW *, MSIRECORD * );
 133
 134     /*
 135      * execute - loads the underlying data into memory so it can be read
 136      */
 137     UINT (*execute)( struct tagMSIVIEW *, MSIRECORD * );
 138
 139     /*
 140      * close - clears the data read by execute from memory
 141      */
 142     UINT (*close)( struct tagMSIVIEW * );
 143
 144     /*
 145      * get_dimensions - returns the number of rows or columns in a table.
 146      *
 147      *  The number of rows can only be queried after the execute method
 148      *   is called. The number of columns can be queried at any time.
 149      */
 150     UINT (*get_dimensions)( struct tagMSIVIEW *, UINT *rows, UINT *cols );
 151
 152     /*
 153      * get_column_info - returns the name and type of a specific column
 154      *
 155      *  The name is HeapAlloc'ed by this function and should be freed by
 156      *   the caller.
 157      *  The column information can be queried at any time.
 158      */
 159     UINT (*get_column_info)( struct tagMSIVIEW *, UINT n, LPWSTR *name, UINT *type );
 160
 161     /*
 162      * modify - not yet implemented properly
 163      */
 164     UINT (*modify)( struct tagMSIVIEW *, MSIMODIFY, MSIRECORD * );
 165
 166     /*
 167      * delete - destroys the structure completely
 168      */
 169     UINT (*delete)( struct tagMSIVIEW * );
 170
 171 } MSIVIEWOPS;
 172
 173 struct tagMSIVIEW
 174 {
 175     MSIOBJECTHDR hdr;
 176     MSIVIEWOPS   *ops;
 177 };
 178
 179 struct msi_dialog_tag;
 180 typedef struct msi_dialog_tag msi_dialog;
 181
 182 typedef struct tagMSIPACKAGE
 183 {
 184     MSIOBJECTHDR hdr;
 185     MSIDATABASE *db;
 186     struct list components;
 187     struct list features;
 188     struct list files;
 189     struct list tempfiles;
 190     struct list folders;
 191     LPWSTR ActionFormat;
 192     LPWSTR LastAction;
 193
 194     struct list classes;
 195     struct list extensions;
 196     struct list progids;
 197     struct list mimes;
 198     struct list appids;
 199
 200     struct tagMSISCRIPT *script;
 201
 202     struct list RunningActions;
 203
 204     LPWSTR PackagePath;
 205     LPWSTR msiFilePath;
 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 extern MSIHANDLE msiobj_findhandle( MSIOBJECTHDR *hdr );
 271
 272 /* add this table to the list of cached tables in the database */
 273 extern void add_table(MSIDATABASE *db, MSITABLE *table);
 274 extern void remove_table( MSIDATABASE *db, MSITABLE *table );
 275 extern void free_cached_tables( MSIDATABASE *db );
 276 extern UINT find_cached_table(MSIDATABASE *db, LPCWSTR name, MSITABLE **table);
 277 extern UINT get_table(MSIDATABASE *db, LPCWSTR name, MSITABLE **table);
 278 extern string_table *load_string_table( IStorage *stg );
 279 extern UINT MSI_CommitTables( MSIDATABASE *db );
 280 extern HRESULT init_string_table( IStorage *stg );
 281
 282
 283 /* string table functions */
 284 extern BOOL msi_addstring( string_table *st, UINT string_no, const CHAR *data, int len, UINT refcount );
 285 extern BOOL msi_addstringW( string_table *st, UINT string_no, const WCHAR *data, int len, UINT refcount );
 286 extern UINT msi_id2stringW( string_table *st, UINT string_no, LPWSTR buffer, UINT *sz );
 287 extern UINT msi_id2stringA( string_table *st, UINT string_no, LPSTR buffer, UINT *sz );
 288
 289 extern LPWSTR MSI_makestring( MSIDATABASE *db, UINT stringid);
 290 extern UINT msi_string2idW( string_table *st, LPCWSTR buffer, UINT *id );
 291 extern UINT msi_string2idA( string_table *st, LPCSTR str, UINT *id );
 292 extern string_table *msi_init_stringtable( int entries, UINT codepage );
 293 extern VOID msi_destroy_stringtable( string_table *st );
 294 extern UINT msi_string_count( string_table *st );
 295 extern UINT msi_id_refcount( string_table *st, UINT i );
 296 extern UINT msi_string_totalsize( string_table *st, UINT *last );
 297 extern UINT msi_strcmp( string_table *st, UINT lval, UINT rval, UINT *res );
 298 extern const WCHAR *msi_string_lookup_id( string_table *st, UINT id );
 299 extern UINT msi_string_get_codepage( string_table *st );
 300
 301
 302 extern UINT VIEW_find_column( MSIVIEW *view, LPCWSTR name, UINT *n );
 303
 304 extern BOOL TABLE_Exists( MSIDATABASE *db, LPWSTR name );
 305
 306 extern UINT read_raw_stream_data( MSIDATABASE*, LPCWSTR stname,
 307                               USHORT **pdata, UINT *psz );
 308
 309 /* action internals */
 310 extern UINT ACTION_DoTopLevelINSTALL( MSIPACKAGE *, LPCWSTR, LPCWSTR, LPCWSTR );
 311 extern void ACTION_free_package_structures( MSIPACKAGE* );
 312 extern UINT ACTION_DialogBox( MSIPACKAGE*, LPCWSTR);
 313
 314 /* record internals */
 315 extern UINT MSI_RecordSetIStream( MSIRECORD *, unsigned int, IStream *);
 316 extern UINT MSI_RecordGetIStream( MSIRECORD *, unsigned int, IStream **);
 317 extern const WCHAR *MSI_RecordGetString( MSIRECORD *, unsigned int );
 318 extern MSIRECORD *MSI_CreateRecord( unsigned int );
 319 extern UINT MSI_RecordSetInteger( MSIRECORD *, unsigned int, int );
 320 extern UINT MSI_RecordSetStringW( MSIRECORD *, unsigned int, LPCWSTR );
 321 extern UINT MSI_RecordSetStringA( MSIRECORD *, unsigned int, LPCSTR );
 322 extern BOOL MSI_RecordIsNull( MSIRECORD *, unsigned int );
 323 extern UINT MSI_RecordGetStringW( MSIRECORD * , unsigned int, LPWSTR, DWORD *);
 324 extern UINT MSI_RecordGetStringA( MSIRECORD *, unsigned int, LPSTR, DWORD *);
 325 extern int MSI_RecordGetInteger( MSIRECORD *, unsigned int );
 326 extern UINT MSI_RecordReadStream( MSIRECORD *, unsigned int, char *, DWORD *);
 327 extern unsigned int MSI_RecordGetFieldCount( MSIRECORD *rec );
 328 extern UINT MSI_RecordSetStreamW( MSIRECORD *, unsigned int, LPCWSTR );
 329 extern UINT MSI_RecordSetStreamA( MSIRECORD *, unsigned int, LPCSTR );
 330 extern UINT MSI_RecordDataSize( MSIRECORD *, unsigned int );
 331 extern UINT MSI_RecordStreamToFile( MSIRECORD *, unsigned int, LPCWSTR );
 332
 333 /* stream internals */
 334 extern UINT get_raw_stream( MSIHANDLE hdb, LPCWSTR stname, IStream **stm );
 335 extern UINT db_get_raw_stream( MSIDATABASE *db, LPCWSTR stname, IStream **stm );
 336 extern void enum_stream_names( IStorage *stg );
 337
 338 /* database internals */
 339 extern UINT MSI_OpenDatabaseW( LPCWSTR, LPCWSTR, MSIDATABASE ** );
 340 extern UINT MSI_DatabaseOpenViewW(MSIDATABASE *, LPCWSTR, MSIQUERY ** );
 341 extern UINT MSI_OpenQuery( MSIDATABASE *, MSIQUERY **, LPCWSTR, ... );
 342 typedef UINT (*record_func)( MSIRECORD *, LPVOID );
 343 extern UINT MSI_IterateRecords( MSIQUERY *, DWORD *, record_func, LPVOID );
 344 extern MSIRECORD *MSI_QueryGetRecord( MSIDATABASE *db, LPCWSTR query, ... );
 345 extern UINT MSI_DatabaseImport( MSIDATABASE *, LPCWSTR, LPCWSTR );
 346 extern UINT MSI_DatabaseExport( MSIDATABASE *, LPCWSTR, LPCWSTR, LPCWSTR );
 347 extern UINT MSI_DatabaseGetPrimaryKeys( MSIDATABASE *, LPCWSTR, MSIRECORD ** );
 348
 349 /* view internals */
 350 extern UINT MSI_ViewExecute( MSIQUERY*, MSIRECORD * );
 351 extern UINT MSI_ViewFetch( MSIQUERY*, MSIRECORD ** );
 352 extern UINT MSI_ViewClose( MSIQUERY* );
 353
 354 /* package internals */
 355 extern MSIPACKAGE *MSI_CreatePackage( MSIDATABASE * );
 356 extern UINT MSI_OpenPackageW( LPCWSTR szPackage, MSIPACKAGE ** );
 357 extern UINT MSI_SetTargetPathW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
 358 extern UINT MSI_SetPropertyW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
 359 extern INT MSI_ProcessMessage( MSIPACKAGE *, INSTALLMESSAGE, MSIRECORD * );
 360 extern UINT MSI_GetPropertyW( MSIPACKAGE *, LPCWSTR, LPWSTR, DWORD * );
 361 extern UINT MSI_GetPropertyA(MSIPACKAGE *, LPCSTR, LPSTR, DWORD* );
 362 extern MSICONDITION MSI_EvaluateConditionW( MSIPACKAGE *, LPCWSTR );
 363 extern UINT MSI_GetComponentStateW( MSIPACKAGE *, LPWSTR, INSTALLSTATE *, INSTALLSTATE * );
 364 extern UINT MSI_GetFeatureStateW( MSIPACKAGE *, LPWSTR, INSTALLSTATE *, INSTALLSTATE * );
 365 extern UINT WINAPI MSI_SetFeatureStateW(MSIPACKAGE*, LPCWSTR, INSTALLSTATE );
 366
 367 /* for deformating */
 368 extern UINT MSI_FormatRecordW( MSIPACKAGE *, MSIRECORD *, LPWSTR, DWORD * );
 369 extern UINT MSI_FormatRecordA( MSIPACKAGE *, MSIRECORD *, LPSTR, DWORD * );
 370
 371 /* registry data encoding/decoding functions */
 372 extern BOOL unsquash_guid(LPCWSTR in, LPWSTR out);
 373 extern BOOL squash_guid(LPCWSTR in, LPWSTR out);
 374 extern BOOL encode_base85_guid(GUID *,LPWSTR);
 375 extern BOOL decode_base85_guid(LPCWSTR,GUID*);
 376 extern UINT MSIREG_OpenUninstallKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 377 extern UINT MSIREG_OpenUserProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 378 extern UINT MSIREG_OpenFeatures(HKEY* key);
 379 extern UINT MSIREG_OpenFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 380 extern UINT MSIREG_OpenComponents(HKEY* key);
 381 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
 382 extern UINT MSIREG_OpenComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
 383 extern UINT MSIREG_OpenProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 384 extern UINT MSIREG_OpenUserFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 385 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
 386 extern UINT MSIREG_OpenUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 387 extern UINT MSIREG_OpenUserUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 388
 389 extern LONG msi_reg_set_val_str( HKEY hkey, LPCWSTR name, LPCWSTR value );
 390 extern LONG msi_reg_set_val_multi_str( HKEY hkey, LPCWSTR name, LPCWSTR value );
 391 extern LONG msi_reg_set_val_dword( HKEY hkey, LPCWSTR name, DWORD val );
 392
 393 /* msi dialog interface */
 394 typedef UINT (*msi_dialog_event_handler)( MSIPACKAGE*, LPCWSTR, LPCWSTR, msi_dialog* );
 395 extern msi_dialog *msi_dialog_create( MSIPACKAGE*, LPCWSTR, msi_dialog_event_handler );
 396 extern UINT msi_dialog_run_message_loop( msi_dialog* );
 397 extern void msi_dialog_end_dialog( msi_dialog* );
 398 extern void msi_dialog_check_messages( HANDLE );
 399 extern void msi_dialog_do_preview( msi_dialog* );
 400 extern void msi_dialog_destroy( msi_dialog* );
 401 extern BOOL msi_dialog_register_class( void );
 402 extern void msi_dialog_unregister_class( void );
 403 extern void msi_dialog_handle_event( msi_dialog*, LPCWSTR, LPCWSTR, MSIRECORD * );
 404
 405 /* preview */
 406 extern MSIPREVIEW *MSI_EnableUIPreview( MSIDATABASE * );
 407 extern UINT MSI_PreviewDialogW( MSIPREVIEW *, LPCWSTR );
 408
 409 /* undocumented functions */
 410 UINT WINAPI MsiCreateAndVerifyInstallerDirectory( DWORD );
 411 UINT WINAPI MsiDecomposeDescriptorW( LPCWSTR, LPWSTR, LPWSTR, LPWSTR, DWORD * );
 412 UINT WINAPI MsiDecomposeDescriptorA( LPCSTR, LPSTR, LPSTR, LPSTR, DWORD * );
 413 LANGID WINAPI MsiLoadStringW( MSIHANDLE, UINT, LPWSTR, int, LANGID );
 414 LANGID WINAPI MsiLoadStringA( MSIHANDLE, UINT, LPSTR, int, LANGID );
 415
 416 /* UI globals */
 417 extern INSTALLUILEVEL gUILevel;
 418 extern HWND gUIhwnd;
 419 extern INSTALLUI_HANDLERA gUIHandlerA;
 420 extern INSTALLUI_HANDLERW gUIHandlerW;
 421 extern DWORD gUIFilter;
 422 extern LPVOID gUIContext;
 423 extern WCHAR gszLogFile[MAX_PATH];
 424
 425 /* memory allocation macro functions */
 426 static inline void *msi_alloc( size_t len )
 427 {
 428     return HeapAlloc( GetProcessHeap(), 0, len );
 429 }
 430
 431 static inline void *msi_alloc_zero( size_t len )
 432 {
 433     return HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, len );
 434 }
 435
 436 static inline void *msi_realloc( void *mem, size_t len )
 437 {
 438     return HeapReAlloc( GetProcessHeap(), 0, mem, len );
 439 }
 440
 441 static inline void *msi_realloc_zero( void *mem, size_t len )
 442 {
 443     return HeapReAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, mem, len );
 444 }
 445
 446 static inline BOOL msi_free( void *mem )
 447 {
 448     return HeapFree( GetProcessHeap(), 0, mem );
 449 }
 450
 451 inline static char *strdupWtoA( LPCWSTR str )
 452 {
 453     LPSTR ret = NULL;
 454     DWORD len;
 455
 456     if (!str) return ret;
 457     len = WideCharToMultiByte( CP_ACP, 0, str, -1, NULL, 0, NULL, NULL);
 458     ret = msi_alloc( len );
 459     if (ret)
 460         WideCharToMultiByte( CP_ACP, 0, str, -1, ret, len, NULL, NULL );
 461     return ret;
 462 }
 463
 464 inline static LPWSTR strdupAtoW( LPCSTR str )
 465 {
 466     LPWSTR ret = NULL;
 467     DWORD len;
 468
 469     if (!str) return ret;
 470     len = MultiByteToWideChar( CP_ACP, 0, str, -1, NULL, 0 );
 471     ret = msi_alloc( len * sizeof(WCHAR) );
 472     if (ret)
 473         MultiByteToWideChar( CP_ACP, 0, str, -1, ret, len );
 474     return ret;
 475 }
 476
 477 inline static LPWSTR strdupW( LPCWSTR src )
 478 {
 479     LPWSTR dest;
 480     if (!src) return NULL;
 481     dest = msi_alloc( (lstrlenW(src)+1)*sizeof(WCHAR) );
 482     if (dest)
 483         lstrcpyW(dest, src);
 484     return dest;
 485 }
 486
 487 #endif /* __WINE_MSI_PRIVATE__ */