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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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_STRING 0x0800
38 #define MSITYPE_NULLABLE 0x1000
39 #define MSITYPE_KEY 0x2000
41 #define MSITYPE_BINARY 0x8900
44 typedef struct tagMSITABLE MSITABLE;
47 typedef struct string_table string_table;
49 struct tagMSIOBJECTHDR;
50 typedef struct tagMSIOBJECTHDR MSIOBJECTHDR;
52 typedef VOID (*msihandledestructor)( MSIOBJECTHDR * );
54 struct tagMSIOBJECTHDR
59 msihandledestructor destructor;
60 struct tagMSIOBJECTHDR *next;
61 struct tagMSIOBJECTHDR *prev;
64 typedef struct tagMSIDATABASE
68 string_table *strings;
70 MSITABLE *first_table, *last_table;
73 typedef struct tagMSIVIEW MSIVIEW;
75 typedef struct tagMSIQUERY
84 /* maybe we can use a Variant instead of doing it ourselves? */
85 typedef struct tagMSIFIELD
96 typedef struct tagMSIRECORD
99 UINT count; /* as passed to MsiCreateRecord */
100 MSIFIELD fields[1]; /* nb. array size is count+1 */
103 typedef struct tagMSIVIEWOPS
106 * fetch_int - reads one integer from {row,col} in the table
108 * This function should be called after the execute method.
109 * Data returned by the function should not change until
110 * close or delete is called.
111 * To get a string value, query the database's string table with
112 * the integer value returned from this function.
114 UINT (*fetch_int)( struct tagMSIVIEW *, UINT row, UINT col, UINT *val );
117 * fetch_int - reads one integer from {row,col} in the table
119 * This function is similar to fetch_int, except fetches a
120 * stream instead of an integer.
122 UINT (*fetch_stream)( struct tagMSIVIEW *, UINT row, UINT col, IStream **stm );
125 * get_int - sets one integer at {row,col} in the table
127 * Similar semantics to fetch_int
129 UINT (*set_int)( struct tagMSIVIEW *, UINT row, UINT col, UINT val );
132 * Inserts a new row into the database from the records contents
134 UINT (*insert_row)( struct tagMSIVIEW *, MSIRECORD * );
137 * execute - loads the underlying data into memory so it can be read
139 UINT (*execute)( struct tagMSIVIEW *, MSIRECORD * );
142 * close - clears the data read by execute from memory
144 UINT (*close)( struct tagMSIVIEW * );
147 * get_dimensions - returns the number of rows or columns in a table.
149 * The number of rows can only be queried after the execute method
150 * is called. The number of columns can be queried at any time.
152 UINT (*get_dimensions)( struct tagMSIVIEW *, UINT *rows, UINT *cols );
155 * get_column_info - returns the name and type of a specific column
157 * The name is HeapAlloc'ed by this function and should be freed by
159 * The column information can be queried at any time.
161 UINT (*get_column_info)( struct tagMSIVIEW *, UINT n, LPWSTR *name, UINT *type );
164 * modify - not yet implemented properly
166 UINT (*modify)( struct tagMSIVIEW *, MSIMODIFY, MSIRECORD * );
169 * delete - destroys the structure completely
171 UINT (*delete)( struct tagMSIVIEW * );
181 struct msi_dialog_tag;
182 typedef struct msi_dialog_tag msi_dialog;
184 typedef struct tagMSIPACKAGE
188 struct list components;
189 struct list features;
196 struct tagMSIEXTENSION *extensions;
197 UINT loaded_extensions;
198 struct tagMSIPROGID *progids;
200 struct tagMSIVERB *verbs;
205 struct tagMSISCRIPT *script;
207 struct tagMSIRUNNINGACTION *RunningAction;
208 UINT RunningActionCount;
214 UINT CurrentInstallState;
218 struct list subscriptions;
221 typedef struct tagMSIPREVIEW
228 #define MSIHANDLETYPE_ANY 0
229 #define MSIHANDLETYPE_DATABASE 1
230 #define MSIHANDLETYPE_SUMMARYINFO 2
231 #define MSIHANDLETYPE_VIEW 3
232 #define MSIHANDLETYPE_RECORD 4
233 #define MSIHANDLETYPE_PACKAGE 5
234 #define MSIHANDLETYPE_PREVIEW 6
236 #define MSI_MAJORVERSION 2
237 #define MSI_MINORVERSION 0
238 #define MSI_BUILDNUMBER 2600
242 #define MSIHANDLE_MAGIC 0x4d434923
243 #define MSIMAXHANDLES 0xf0
245 #define MSISUMINFO_OFFSET 0x30LL
247 DEFINE_GUID(CLSID_IMsiServer, 0x000C101C,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
248 DEFINE_GUID(CLSID_IMsiServerX1, 0x000C103E,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
249 DEFINE_GUID(CLSID_IMsiServerX2, 0x000C1090,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
250 DEFINE_GUID(CLSID_IMsiServerX3, 0x000C1094,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
252 DEFINE_GUID(CLSID_IMsiServerMessage, 0x000C101D,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
255 /* handle functions */
256 extern void *msihandle2msiinfo(MSIHANDLE handle, UINT type);
257 extern MSIHANDLE alloc_msihandle( MSIOBJECTHDR * );
258 extern void *alloc_msiobject(UINT type, UINT size, msihandledestructor destroy );
259 extern void msiobj_addref(MSIOBJECTHDR *);
260 extern int msiobj_release(MSIOBJECTHDR *);
261 extern void msiobj_lock(MSIOBJECTHDR *);
262 extern void msiobj_unlock(MSIOBJECTHDR *);
263 extern MSIHANDLE msiobj_findhandle( MSIOBJECTHDR *hdr );
265 /* add this table to the list of cached tables in the database */
266 extern void add_table(MSIDATABASE *db, MSITABLE *table);
267 extern void remove_table( MSIDATABASE *db, MSITABLE *table );
268 extern void free_table( MSIDATABASE *db, MSITABLE *table );
269 extern void free_cached_tables( MSIDATABASE *db );
270 extern UINT find_cached_table(MSIDATABASE *db, LPCWSTR name, MSITABLE **table);
271 extern UINT get_table(MSIDATABASE *db, LPCWSTR name, MSITABLE **table);
272 extern UINT load_string_table( MSIDATABASE *db );
273 extern UINT MSI_CommitTables( MSIDATABASE *db );
274 extern HRESULT init_string_table( IStorage *stg );
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 );
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 );
296 extern UINT VIEW_find_column( MSIVIEW *view, LPCWSTR name, UINT *n );
298 extern BOOL TABLE_Exists( MSIDATABASE *db, LPWSTR name );
300 extern UINT read_raw_stream_data( MSIDATABASE*, LPCWSTR stname,
301 USHORT **pdata, UINT *psz );
303 /* action internals */
304 extern UINT ACTION_DoTopLevelINSTALL( MSIPACKAGE *, LPCWSTR, LPCWSTR, LPCWSTR );
305 extern void ACTION_free_package_structures( MSIPACKAGE* );
306 extern UINT ACTION_DialogBox( MSIPACKAGE*, LPCWSTR);
308 /* record internals */
309 extern UINT MSI_RecordSetIStream( MSIRECORD *, unsigned int, IStream *);
310 extern UINT MSI_RecordGetIStream( MSIRECORD *, unsigned int, IStream **);
311 extern const WCHAR *MSI_RecordGetString( MSIRECORD *, unsigned int );
312 extern MSIRECORD *MSI_CreateRecord( unsigned int );
313 extern UINT MSI_RecordSetInteger( MSIRECORD *, unsigned int, int );
314 extern UINT MSI_RecordSetStringW( MSIRECORD *, unsigned int, LPCWSTR );
315 extern UINT MSI_RecordSetStringA( MSIRECORD *, unsigned int, LPCSTR );
316 extern BOOL MSI_RecordIsNull( MSIRECORD *, unsigned int );
317 extern UINT MSI_RecordGetStringW( MSIRECORD * , unsigned int, LPWSTR, DWORD *);
318 extern UINT MSI_RecordGetStringA( MSIRECORD *, unsigned int, LPSTR, DWORD *);
319 extern int MSI_RecordGetInteger( MSIRECORD *, unsigned int );
320 extern UINT MSI_RecordReadStream( MSIRECORD *, unsigned int, char *, DWORD *);
321 extern unsigned int MSI_RecordGetFieldCount( MSIRECORD *rec );
322 extern UINT MSI_RecordSetStreamW( MSIRECORD *, unsigned int, LPCWSTR );
323 extern UINT MSI_RecordSetStreamA( MSIRECORD *, unsigned int, LPCSTR );
324 extern UINT MSI_RecordDataSize( MSIRECORD *, unsigned int );
325 extern UINT MSI_RecordStreamToFile( MSIRECORD *, unsigned int, LPCWSTR );
327 /* stream internals */
328 extern UINT get_raw_stream( MSIHANDLE hdb, LPCWSTR stname, IStream **stm );
329 extern UINT db_get_raw_stream( MSIDATABASE *db, LPCWSTR stname, IStream **stm );
330 extern void enum_stream_names( IStorage *stg );
332 /* database internals */
333 extern UINT MSI_OpenDatabaseW( LPCWSTR, LPCWSTR, MSIDATABASE ** );
334 extern UINT MSI_DatabaseOpenViewW(MSIDATABASE *, LPCWSTR, MSIQUERY ** );
335 extern UINT MSI_OpenQuery( MSIDATABASE *, MSIQUERY **, LPCWSTR, ... );
336 typedef UINT (*record_func)( MSIRECORD *, LPVOID );
337 extern UINT MSI_IterateRecords( MSIQUERY *, DWORD *, record_func, LPVOID );
338 extern MSIRECORD *MSI_QueryGetRecord( MSIDATABASE *db, LPCWSTR query, ... );
339 extern UINT MSI_DatabaseImport( MSIDATABASE *, LPCWSTR, LPCWSTR );
340 extern UINT MSI_DatabaseExport( MSIDATABASE *, LPCWSTR, LPCWSTR, LPCWSTR );
341 extern UINT MSI_DatabaseGetPrimaryKeys( MSIDATABASE *, LPCWSTR, MSIRECORD ** );
344 extern UINT MSI_ViewExecute( MSIQUERY*, MSIRECORD * );
345 extern UINT MSI_ViewFetch( MSIQUERY*, MSIRECORD ** );
346 extern UINT MSI_ViewClose( MSIQUERY* );
348 /* package internals */
349 extern MSIPACKAGE *MSI_CreatePackage( MSIDATABASE * );
350 extern UINT MSI_OpenPackageW( LPCWSTR szPackage, MSIPACKAGE ** );
351 extern UINT MSI_SetTargetPathW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
352 extern UINT MSI_SetPropertyW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
353 extern INT MSI_ProcessMessage( MSIPACKAGE *, INSTALLMESSAGE, MSIRECORD * );
354 extern UINT MSI_GetPropertyW( MSIPACKAGE *, LPCWSTR, LPWSTR, DWORD * );
355 extern UINT MSI_GetPropertyA(MSIPACKAGE *, LPCSTR, LPSTR, DWORD* );
356 extern MSICONDITION MSI_EvaluateConditionW( MSIPACKAGE *, LPCWSTR );
357 extern UINT MSI_GetComponentStateW( MSIPACKAGE *, LPWSTR, INSTALLSTATE *, INSTALLSTATE * );
358 extern UINT MSI_GetFeatureStateW( MSIPACKAGE *, LPWSTR, INSTALLSTATE *, INSTALLSTATE * );
359 extern UINT WINAPI MSI_SetFeatureStateW(MSIPACKAGE*, LPCWSTR, INSTALLSTATE );
361 /* for deformating */
362 extern UINT MSI_FormatRecordW( MSIPACKAGE *, MSIRECORD *, LPWSTR, DWORD * );
363 extern UINT MSI_FormatRecordA( MSIPACKAGE *, MSIRECORD *, LPSTR, DWORD * );
365 /* registry data encoding/decoding functions */
366 extern BOOL unsquash_guid(LPCWSTR in, LPWSTR out);
367 extern BOOL squash_guid(LPCWSTR in, LPWSTR out);
368 extern BOOL encode_base85_guid(GUID *,LPWSTR);
369 extern BOOL decode_base85_guid(LPCWSTR,GUID*);
370 extern UINT MSIREG_OpenUninstallKey(LPCWSTR szProduct, HKEY* key, BOOL create);
371 extern UINT MSIREG_OpenUserProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
372 extern UINT MSIREG_OpenFeatures(HKEY* key);
373 extern UINT MSIREG_OpenFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
374 extern UINT MSIREG_OpenComponents(HKEY* key);
375 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
376 extern UINT MSIREG_OpenComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
377 extern UINT MSIREG_OpenProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
378 extern UINT MSIREG_OpenUserFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
379 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
380 extern UINT MSIREG_OpenUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
381 extern UINT MSIREG_OpenUserUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
383 /* msi dialog interface */
384 typedef UINT (*msi_dialog_event_handler)( MSIPACKAGE*, LPCWSTR, LPCWSTR, msi_dialog* );
385 extern msi_dialog *msi_dialog_create( MSIPACKAGE*, LPCWSTR, msi_dialog_event_handler );
386 extern UINT msi_dialog_run_message_loop( msi_dialog* );
387 extern void msi_dialog_end_dialog( msi_dialog* );
388 extern void msi_dialog_check_messages( HANDLE );
389 extern void msi_dialog_do_preview( msi_dialog* );
390 extern void msi_dialog_destroy( msi_dialog* );
391 extern BOOL msi_dialog_register_class( void );
392 extern void msi_dialog_unregister_class( void );
393 extern void msi_dialog_handle_event( msi_dialog*, LPCWSTR, LPCWSTR, MSIRECORD * );
396 extern MSIPREVIEW *MSI_EnableUIPreview( MSIDATABASE * );
397 extern UINT MSI_PreviewDialogW( MSIPREVIEW *, LPCWSTR );
399 /* undocumented functions */
400 UINT WINAPI MsiCreateAndVerifyInstallerDirectory( DWORD );
401 UINT WINAPI MsiDecomposeDescriptorW( LPCWSTR, LPWSTR, LPWSTR, LPWSTR, DWORD * );
402 UINT WINAPI MsiDecomposeDescriptorA( LPCSTR, LPSTR, LPSTR, LPSTR, DWORD * );
403 LANGID WINAPI MsiLoadStringW( MSIHANDLE, UINT, LPWSTR, int, LANGID );
404 LANGID WINAPI MsiLoadStringA( MSIHANDLE, UINT, LPSTR, int, LANGID );
407 extern INSTALLUILEVEL gUILevel;
409 extern INSTALLUI_HANDLERA gUIHandlerA;
410 extern INSTALLUI_HANDLERW gUIHandlerW;
411 extern DWORD gUIFilter;
412 extern LPVOID gUIContext;
413 extern WCHAR gszLogFile[MAX_PATH];
415 inline static char *strdupWtoA( LPCWSTR str )
420 DWORD len = WideCharToMultiByte( CP_ACP, 0, str, -1, NULL, 0, NULL, NULL
422 if ((ret = HeapAlloc( GetProcessHeap(), 0, len )))
423 WideCharToMultiByte( CP_ACP, 0, str, -1, ret, len, NULL, NULL );
428 inline static LPWSTR strdupAtoW( LPCSTR str )
433 DWORD len = MultiByteToWideChar( CP_ACP, 0, str, -1, NULL, 0 );
434 if ((ret = HeapAlloc( GetProcessHeap(), 0, len * sizeof(WCHAR) )))
435 MultiByteToWideChar( CP_ACP, 0, str, -1, ret, len );
440 inline static LPWSTR strdupW( LPCWSTR src )
443 if (!src) return NULL;
444 dest = HeapAlloc(GetProcessHeap(), 0, (lstrlenW(src)+1)*sizeof(WCHAR));
449 #endif /* __WINE_MSI_PRIVATE__ */