2 * Implementation of the Microsoft Installer (msi.dll)
4 * Copyright 2002-2005 Mike McCormack for CodeWeavers
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.
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.
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21 #ifndef __WINE_MSI_PRIVATE__
22 #define __WINE_MSI_PRIVATE__
33 #include "wine/list.h"
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
42 /* Word Count masks */
43 #define MSIWORDCOUNT_SHORTFILENAMES 0x0001
44 #define MSIWORDCOUNT_COMPRESSED 0x0002
45 #define MSIWORDCOUNT_ADMINISTRATIVE 0x0004
46 #define MSIWORDCOUNT_PRIVILEGES 0x0008
48 #define MSITYPE_IS_BINARY(type) (((type) & ~MSITYPE_NULLABLE) == (MSITYPE_STRING|MSITYPE_VALID))
51 typedef struct tagMSITABLE MSITABLE;
54 typedef struct string_table string_table;
56 struct tagMSIOBJECTHDR;
57 typedef struct tagMSIOBJECTHDR MSIOBJECTHDR;
59 typedef VOID (*msihandledestructor)( MSIOBJECTHDR * );
61 struct tagMSIOBJECTHDR
66 msihandledestructor destructor;
69 typedef struct tagMSIDATABASE
73 string_table *strings;
77 struct list transforms;
80 typedef struct tagMSIVIEW MSIVIEW;
82 typedef struct tagMSIQUERY
91 /* maybe we can use a Variant instead of doing it ourselves? */
92 typedef struct tagMSIFIELD
103 typedef struct tagMSIRECORD
106 UINT count; /* as passed to MsiCreateRecord */
107 MSIFIELD fields[1]; /* nb. array size is count+1 */
110 typedef void *MSIITERHANDLE;
112 typedef struct tagMSIVIEWOPS
115 * fetch_int - reads one integer from {row,col} in the table
117 * This function should be called after the execute method.
118 * Data returned by the function should not change until
119 * close or delete is called.
120 * To get a string value, query the database's string table with
121 * the integer value returned from this function.
123 UINT (*fetch_int)( struct tagMSIVIEW *, UINT row, UINT col, UINT *val );
126 * fetch_stream - gets a stream from {row,col} in the table
128 * This function is similar to fetch_int, except fetches a
129 * stream instead of an integer.
131 UINT (*fetch_stream)( struct tagMSIVIEW *, UINT row, UINT col, IStream **stm );
134 * get_int - sets one integer at {row,col} in the table
136 * Similar semantics to fetch_int
138 UINT (*set_int)( struct tagMSIVIEW *, UINT row, UINT col, UINT val );
141 * Inserts a new row into the database from the records contents
143 UINT (*insert_row)( struct tagMSIVIEW *, MSIRECORD * );
146 * execute - loads the underlying data into memory so it can be read
148 UINT (*execute)( struct tagMSIVIEW *, MSIRECORD * );
151 * close - clears the data read by execute from memory
153 UINT (*close)( struct tagMSIVIEW * );
156 * get_dimensions - returns the number of rows or columns in a table.
158 * The number of rows can only be queried after the execute method
159 * is called. The number of columns can be queried at any time.
161 UINT (*get_dimensions)( struct tagMSIVIEW *, UINT *rows, UINT *cols );
164 * get_column_info - returns the name and type of a specific column
166 * The name is HeapAlloc'ed by this function and should be freed by
168 * The column information can be queried at any time.
170 UINT (*get_column_info)( struct tagMSIVIEW *, UINT n, LPWSTR *name, UINT *type );
173 * modify - not yet implemented properly
175 UINT (*modify)( struct tagMSIVIEW *, MSIMODIFY, MSIRECORD * );
178 * delete - destroys the structure completely
180 UINT (*delete)( struct tagMSIVIEW * );
183 * find_matching_rows - iterates through rows that match a value
185 * If the column type is a string then a string ID should be passed in.
186 * If the value to be looked up is an integer then no transformation of
187 * the input value is required, except if the column is a string, in which
188 * case a string ID should be passed in.
189 * The handle is an input/output parameter that keeps track of the current
190 * position in the iteration. It must be initialised to zero before the
191 * first call and continued to be passed in to subsequent calls.
193 UINT (*find_matching_rows)( struct tagMSIVIEW *, UINT col, UINT val, UINT *row, MSIITERHANDLE *handle );
199 const MSIVIEWOPS *ops;
202 struct msi_dialog_tag;
203 typedef struct msi_dialog_tag msi_dialog;
205 #define PROPERTY_HASH_SIZE 67
207 typedef struct tagMSIPACKAGE
211 struct list components;
212 struct list features;
214 struct list tempfiles;
220 struct list extensions;
225 struct tagMSISCRIPT *script;
227 struct list RunningActions;
232 UINT CurrentInstallState;
240 struct list props[PROPERTY_HASH_SIZE];
242 struct list subscriptions;
245 typedef struct tagMSIPREVIEW
252 #define MSI_MAX_PROPS 20
254 typedef struct tagMSISUMMARYINFO
259 PROPVARIANT property[MSI_MAX_PROPS];
262 #define MSIHANDLETYPE_ANY 0
263 #define MSIHANDLETYPE_DATABASE 1
264 #define MSIHANDLETYPE_SUMMARYINFO 2
265 #define MSIHANDLETYPE_VIEW 3
266 #define MSIHANDLETYPE_RECORD 4
267 #define MSIHANDLETYPE_PACKAGE 5
268 #define MSIHANDLETYPE_PREVIEW 6
270 #define MSI_MAJORVERSION 3
271 #define MSI_MINORVERSION 1
272 #define MSI_BUILDNUMBER 4000
276 #define MSIHANDLE_MAGIC 0x4d434923
278 DEFINE_GUID(CLSID_IMsiServer, 0x000C101C,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
279 DEFINE_GUID(CLSID_IMsiServerX1, 0x000C103E,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
280 DEFINE_GUID(CLSID_IMsiServerX2, 0x000C1090,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
281 DEFINE_GUID(CLSID_IMsiServerX3, 0x000C1094,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
283 DEFINE_GUID(CLSID_IMsiServerMessage, 0x000C101D,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
285 /* handle unicode/ascii output in the Msi* API functions */
302 UINT msi_strcpy_to_awstring( LPCWSTR str, awstring *awbuf, DWORD *sz );
304 /* handle functions */
305 extern void *msihandle2msiinfo(MSIHANDLE handle, UINT type);
306 extern MSIHANDLE alloc_msihandle( MSIOBJECTHDR * );
307 extern void *alloc_msiobject(UINT type, UINT size, msihandledestructor destroy );
308 extern void msiobj_addref(MSIOBJECTHDR *);
309 extern int msiobj_release(MSIOBJECTHDR *);
310 extern void msiobj_lock(MSIOBJECTHDR *);
311 extern void msiobj_unlock(MSIOBJECTHDR *);
312 extern void msi_free_handle_table(void);
314 extern void free_cached_tables( MSIDATABASE *db );
315 extern void msi_free_transforms( MSIDATABASE *db );
316 extern string_table *load_string_table( IStorage *stg );
317 extern UINT MSI_CommitTables( MSIDATABASE *db );
318 extern HRESULT init_string_table( IStorage *stg );
321 /* string table functions */
322 extern BOOL msi_addstring( string_table *st, UINT string_no, const CHAR *data, int len, UINT refcount );
323 extern BOOL msi_addstringW( string_table *st, UINT string_no, const WCHAR *data, int len, UINT refcount );
324 extern UINT msi_id2stringW( string_table *st, UINT string_no, LPWSTR buffer, UINT *sz );
325 extern UINT msi_id2stringA( string_table *st, UINT string_no, LPSTR buffer, UINT *sz );
327 extern LPWSTR MSI_makestring( MSIDATABASE *db, UINT stringid);
328 extern UINT msi_string2idW( string_table *st, LPCWSTR buffer, UINT *id );
329 extern UINT msi_string2idA( string_table *st, LPCSTR str, UINT *id );
330 extern string_table *msi_init_stringtable( int entries, UINT codepage );
331 extern VOID msi_destroy_stringtable( string_table *st );
332 extern UINT msi_string_count( string_table *st );
333 extern UINT msi_id_refcount( string_table *st, UINT i );
334 extern UINT msi_string_totalsize( string_table *st, UINT *datasize, UINT *poolsize );
335 extern UINT msi_strcmp( string_table *st, UINT lval, UINT rval, UINT *res );
336 extern const WCHAR *msi_string_lookup_id( string_table *st, UINT id );
337 extern UINT msi_string_get_codepage( string_table *st );
340 extern BOOL TABLE_Exists( MSIDATABASE *db, LPWSTR name );
341 extern MSICONDITION MSI_DatabaseIsTablePersistent( MSIDATABASE *db, LPCWSTR table );
343 extern UINT read_raw_stream_data( MSIDATABASE*, LPCWSTR stname,
344 USHORT **pdata, UINT *psz );
346 /* transform functions */
347 extern UINT msi_table_apply_transform( MSIDATABASE *db, IStorage *stg );
348 extern UINT MSI_DatabaseApplyTransformW( MSIDATABASE *db,
349 LPCWSTR szTransformFile, int iErrorCond );
351 /* action internals */
352 extern UINT MSI_InstallPackage( MSIPACKAGE *, LPCWSTR, LPCWSTR );
353 extern void ACTION_free_package_structures( MSIPACKAGE* );
354 extern UINT ACTION_DialogBox( MSIPACKAGE*, LPCWSTR);
355 extern UINT MSI_Sequence( MSIPACKAGE *package, LPCWSTR szTable, INT iSequenceMode );
356 extern UINT MSI_SetFeatureStates( MSIPACKAGE *package );
358 /* record internals */
359 extern UINT MSI_RecordSetIStream( MSIRECORD *, unsigned int, IStream *);
360 extern UINT MSI_RecordGetIStream( MSIRECORD *, unsigned int, IStream **);
361 extern const WCHAR *MSI_RecordGetString( MSIRECORD *, unsigned int );
362 extern MSIRECORD *MSI_CreateRecord( unsigned int );
363 extern UINT MSI_RecordSetInteger( MSIRECORD *, unsigned int, int );
364 extern UINT MSI_RecordSetStringW( MSIRECORD *, unsigned int, LPCWSTR );
365 extern UINT MSI_RecordSetStringA( MSIRECORD *, unsigned int, LPCSTR );
366 extern BOOL MSI_RecordIsNull( MSIRECORD *, unsigned int );
367 extern UINT MSI_RecordGetStringW( MSIRECORD * , unsigned int, LPWSTR, DWORD *);
368 extern UINT MSI_RecordGetStringA( MSIRECORD *, unsigned int, LPSTR, DWORD *);
369 extern int MSI_RecordGetInteger( MSIRECORD *, unsigned int );
370 extern UINT MSI_RecordReadStream( MSIRECORD *, unsigned int, char *, DWORD *);
371 extern unsigned int MSI_RecordGetFieldCount( MSIRECORD *rec );
372 extern UINT MSI_RecordSetStreamW( MSIRECORD *, unsigned int, LPCWSTR );
373 extern UINT MSI_RecordSetStreamA( MSIRECORD *, unsigned int, LPCSTR );
374 extern UINT MSI_RecordDataSize( MSIRECORD *, unsigned int );
375 extern UINT MSI_RecordStreamToFile( MSIRECORD *, unsigned int, LPCWSTR );
376 extern UINT MSI_RecordCopyField( MSIRECORD *, unsigned int, MSIRECORD *, unsigned int );
378 /* stream internals */
379 extern UINT get_raw_stream( MSIHANDLE hdb, LPCWSTR stname, IStream **stm );
380 extern UINT db_get_raw_stream( MSIDATABASE *db, LPCWSTR stname, IStream **stm );
381 extern void enum_stream_names( IStorage *stg );
383 /* database internals */
384 extern UINT MSI_OpenDatabaseW( LPCWSTR, LPCWSTR, MSIDATABASE ** );
385 extern UINT MSI_DatabaseOpenViewW(MSIDATABASE *, LPCWSTR, MSIQUERY ** );
386 extern UINT MSI_OpenQuery( MSIDATABASE *, MSIQUERY **, LPCWSTR, ... );
387 typedef UINT (*record_func)( MSIRECORD *, LPVOID );
388 extern UINT MSI_IterateRecords( MSIQUERY *, DWORD *, record_func, LPVOID );
389 extern MSIRECORD *MSI_QueryGetRecord( MSIDATABASE *db, LPCWSTR query, ... );
390 extern UINT MSI_DatabaseImport( MSIDATABASE *, LPCWSTR, LPCWSTR );
391 extern UINT MSI_DatabaseExport( MSIDATABASE *, LPCWSTR, LPCWSTR, LPCWSTR );
392 extern UINT MSI_DatabaseGetPrimaryKeys( MSIDATABASE *, LPCWSTR, MSIRECORD ** );
395 extern UINT MSI_ViewExecute( MSIQUERY*, MSIRECORD * );
396 extern UINT MSI_ViewFetch( MSIQUERY*, MSIRECORD ** );
397 extern UINT MSI_ViewClose( MSIQUERY* );
398 extern UINT MSI_ViewGetColumnInfo(MSIQUERY *, MSICOLINFO, MSIRECORD **);
399 extern UINT VIEW_find_column( MSIVIEW *, LPCWSTR, UINT * );
402 /* install internals */
403 extern UINT MSI_SetInstallLevel( MSIPACKAGE *package, int iInstallLevel );
405 /* package internals */
406 extern MSIPACKAGE *MSI_CreatePackage( MSIDATABASE * );
407 extern UINT MSI_OpenPackageW( LPCWSTR szPackage, MSIPACKAGE ** );
408 extern UINT MSI_SetTargetPathW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
409 extern UINT MSI_SetPropertyW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
410 extern INT MSI_ProcessMessage( MSIPACKAGE *, INSTALLMESSAGE, MSIRECORD * );
411 extern UINT MSI_GetPropertyW( MSIPACKAGE *, LPCWSTR, LPWSTR, DWORD * );
412 extern UINT MSI_GetPropertyA(MSIPACKAGE *, LPCSTR, LPSTR, DWORD* );
413 extern MSICONDITION MSI_EvaluateConditionW( MSIPACKAGE *, LPCWSTR );
414 extern UINT MSI_GetComponentStateW( MSIPACKAGE *, LPCWSTR, INSTALLSTATE *, INSTALLSTATE * );
415 extern UINT MSI_GetFeatureStateW( MSIPACKAGE *, LPCWSTR, INSTALLSTATE *, INSTALLSTATE * );
416 extern UINT WINAPI MSI_SetFeatureStateW(MSIPACKAGE*, LPCWSTR, INSTALLSTATE );
418 /* for deformating */
419 extern UINT MSI_FormatRecordW( MSIPACKAGE *, MSIRECORD *, LPWSTR, DWORD * );
420 extern UINT MSI_FormatRecordA( MSIPACKAGE *, MSIRECORD *, LPSTR, DWORD * );
422 /* registry data encoding/decoding functions */
423 extern BOOL unsquash_guid(LPCWSTR in, LPWSTR out);
424 extern BOOL squash_guid(LPCWSTR in, LPWSTR out);
425 extern BOOL encode_base85_guid(GUID *,LPWSTR);
426 extern BOOL decode_base85_guid(LPCWSTR,GUID*);
427 extern UINT MSIREG_OpenUninstallKey(LPCWSTR szProduct, HKEY* key, BOOL create);
428 extern UINT MSIREG_OpenUserProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
429 extern UINT MSIREG_OpenFeatures(HKEY* key);
430 extern UINT MSIREG_OpenFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
431 extern UINT MSIREG_OpenComponents(HKEY* key);
432 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
433 extern UINT MSIREG_OpenComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
434 extern UINT MSIREG_OpenProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
435 extern UINT MSIREG_OpenUserFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
436 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
437 extern UINT MSIREG_OpenUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
438 extern UINT MSIREG_OpenUserUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
440 extern LPWSTR msi_reg_get_val_str( HKEY hkey, LPCWSTR name );
441 extern BOOL msi_reg_get_val_dword( HKEY hkey, LPCWSTR name, DWORD *val);
443 extern DWORD msi_version_str_to_dword(LPCWSTR p);
444 extern LPWSTR msi_version_dword_to_str(DWORD version);
446 extern LONG msi_reg_set_val_str( HKEY hkey, LPCWSTR name, LPCWSTR value );
447 extern LONG msi_reg_set_val_multi_str( HKEY hkey, LPCWSTR name, LPCWSTR value );
448 extern LONG msi_reg_set_val_dword( HKEY hkey, LPCWSTR name, DWORD val );
449 extern LONG msi_reg_set_subkey_val( HKEY hkey, LPCWSTR path, LPCWSTR name, LPCWSTR val );
451 /* msi dialog interface */
452 typedef UINT (*msi_dialog_event_handler)( MSIPACKAGE*, LPCWSTR, LPCWSTR, msi_dialog* );
453 extern msi_dialog *msi_dialog_create( MSIPACKAGE*, LPCWSTR, msi_dialog_event_handler );
454 extern UINT msi_dialog_run_message_loop( msi_dialog* );
455 extern void msi_dialog_end_dialog( msi_dialog* );
456 extern void msi_dialog_check_messages( HANDLE );
457 extern void msi_dialog_do_preview( msi_dialog* );
458 extern void msi_dialog_destroy( msi_dialog* );
459 extern BOOL msi_dialog_register_class( void );
460 extern void msi_dialog_unregister_class( void );
461 extern void msi_dialog_handle_event( msi_dialog*, LPCWSTR, LPCWSTR, MSIRECORD * );
462 extern UINT msi_dialog_reset( msi_dialog *dialog );
463 extern UINT msi_dialog_directorylist_up( msi_dialog *dialog );
466 extern MSIPREVIEW *MSI_EnableUIPreview( MSIDATABASE * );
467 extern UINT MSI_PreviewDialogW( MSIPREVIEW *, LPCWSTR );
469 /* summary information */
470 extern MSISUMMARYINFO *MSI_GetSummaryInformationW( MSIDATABASE *db, UINT uiUpdateCount );
471 extern LPWSTR msi_suminfo_dup_string( MSISUMMARYINFO *si, UINT uiProperty );
473 /* undocumented functions */
474 UINT WINAPI MsiCreateAndVerifyInstallerDirectory( DWORD );
475 UINT WINAPI MsiDecomposeDescriptorW( LPCWSTR, LPWSTR, LPWSTR, LPWSTR, DWORD * );
476 UINT WINAPI MsiDecomposeDescriptorA( LPCSTR, LPSTR, LPSTR, LPSTR, DWORD * );
477 LANGID WINAPI MsiLoadStringW( MSIHANDLE, UINT, LPWSTR, int, LANGID );
478 LANGID WINAPI MsiLoadStringA( MSIHANDLE, UINT, LPSTR, int, LANGID );
481 extern INSTALLUILEVEL gUILevel;
483 extern INSTALLUI_HANDLERA gUIHandlerA;
484 extern INSTALLUI_HANDLERW gUIHandlerW;
485 extern DWORD gUIFilter;
486 extern LPVOID gUIContext;
487 extern WCHAR gszLogFile[MAX_PATH];
488 extern HINSTANCE msi_hInstance;
490 /* memory allocation macro functions */
491 static inline void *msi_alloc( size_t len )
493 return HeapAlloc( GetProcessHeap(), 0, len );
496 static inline void *msi_alloc_zero( size_t len )
498 return HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, len );
501 static inline void *msi_realloc( void *mem, size_t len )
503 return HeapReAlloc( GetProcessHeap(), 0, mem, len );
506 static inline void *msi_realloc_zero( void *mem, size_t len )
508 return HeapReAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, mem, len );
511 static inline BOOL msi_free( void *mem )
513 return HeapFree( GetProcessHeap(), 0, mem );
516 inline static char *strdupWtoA( LPCWSTR str )
521 if (!str) return ret;
522 len = WideCharToMultiByte( CP_ACP, 0, str, -1, NULL, 0, NULL, NULL);
523 ret = msi_alloc( len );
525 WideCharToMultiByte( CP_ACP, 0, str, -1, ret, len, NULL, NULL );
529 inline static LPWSTR strdupAtoW( LPCSTR str )
534 if (!str) return ret;
535 len = MultiByteToWideChar( CP_ACP, 0, str, -1, NULL, 0 );
536 ret = msi_alloc( len * sizeof(WCHAR) );
538 MultiByteToWideChar( CP_ACP, 0, str, -1, ret, len );
542 inline static LPWSTR strdupW( LPCWSTR src )
545 if (!src) return NULL;
546 dest = msi_alloc( (lstrlenW(src)+1)*sizeof(WCHAR) );
552 #endif /* __WINE_MSI_PRIVATE__ */