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, blank row into the database
133 * *row receives the number of the new row
135 UINT (*insert_row)( struct tagMSIVIEW *, UINT *row );
138 * execute - loads the underlying data into memory so it can be read
140 UINT (*execute)( struct tagMSIVIEW *, MSIRECORD * );
143 * close - clears the data read by execute from memory
145 UINT (*close)( struct tagMSIVIEW * );
148 * get_dimensions - returns the number of rows or columns in a table.
150 * The number of rows can only be queried after the execute method
151 * is called. The number of columns can be queried at any time.
153 UINT (*get_dimensions)( struct tagMSIVIEW *, UINT *rows, UINT *cols );
156 * get_column_info - returns the name and type of a specific column
158 * The name is HeapAlloc'ed by this function and should be freed by
160 * The column information can be queried at any time.
162 UINT (*get_column_info)( struct tagMSIVIEW *, UINT n, LPWSTR *name, UINT *type );
165 * modify - not yet implemented properly
167 UINT (*modify)( struct tagMSIVIEW *, MSIMODIFY, MSIRECORD * );
170 * delete - destroys the structure completely
172 UINT (*delete)( struct tagMSIVIEW * );
182 struct msi_dialog_tag;
183 typedef struct msi_dialog_tag msi_dialog;
185 typedef struct tagMSIPACKAGE
189 struct tagMSIFEATURE *features;
190 UINT loaded_features;
191 struct tagMSIFOLDER *folders;
193 struct tagMSICOMPONENT *components;
194 UINT loaded_components;
195 struct tagMSIFILE *files;
200 struct tagMSICLASS *classes;
202 struct tagMSIEXTENSION *extensions;
203 UINT loaded_extensions;
204 struct tagMSIPROGID *progids;
206 struct tagMSIVERB *verbs;
208 struct tagMSIMIME *mimes;
210 struct tagMSIAPPID *appids;
213 struct tagMSISCRIPT *script;
215 struct tagMSIRUNNINGACTION *RunningAction;
216 UINT RunningActionCount;
222 UINT CurrentInstallState;
226 struct list subscriptions;
229 typedef struct tagMSIPREVIEW
236 #define MSIHANDLETYPE_ANY 0
237 #define MSIHANDLETYPE_DATABASE 1
238 #define MSIHANDLETYPE_SUMMARYINFO 2
239 #define MSIHANDLETYPE_VIEW 3
240 #define MSIHANDLETYPE_RECORD 4
241 #define MSIHANDLETYPE_PACKAGE 5
242 #define MSIHANDLETYPE_PREVIEW 6
244 #define MSI_MAJORVERSION 2
245 #define MSI_MINORVERSION 0
246 #define MSI_BUILDNUMBER 2600
250 #define MSIHANDLE_MAGIC 0x4d434923
251 #define MSIMAXHANDLES 0xf0
253 #define MSISUMINFO_OFFSET 0x30LL
255 DEFINE_GUID(CLSID_IMsiServer, 0x000C101C,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
256 DEFINE_GUID(CLSID_IMsiServerX1, 0x000C103E,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
257 DEFINE_GUID(CLSID_IMsiServerX2, 0x000C1090,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
258 DEFINE_GUID(CLSID_IMsiServerX3, 0x000C1094,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
260 DEFINE_GUID(CLSID_IMsiServerMessage, 0x000C101D,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
263 /* handle functions */
264 extern void *msihandle2msiinfo(MSIHANDLE handle, UINT type);
265 extern MSIHANDLE alloc_msihandle( MSIOBJECTHDR * );
266 extern void *alloc_msiobject(UINT type, UINT size, msihandledestructor destroy );
267 extern void msiobj_addref(MSIOBJECTHDR *);
268 extern int msiobj_release(MSIOBJECTHDR *);
269 extern void msiobj_lock(MSIOBJECTHDR *);
270 extern void msiobj_unlock(MSIOBJECTHDR *);
271 extern MSIHANDLE msiobj_findhandle( MSIOBJECTHDR *hdr );
273 /* add this table to the list of cached tables in the database */
274 extern void add_table(MSIDATABASE *db, MSITABLE *table);
275 extern void remove_table( MSIDATABASE *db, MSITABLE *table );
276 extern void free_table( MSIDATABASE *db, MSITABLE *table );
277 extern void free_cached_tables( MSIDATABASE *db );
278 extern UINT find_cached_table(MSIDATABASE *db, LPCWSTR name, MSITABLE **table);
279 extern UINT get_table(MSIDATABASE *db, LPCWSTR name, MSITABLE **table);
280 extern UINT load_string_table( MSIDATABASE *db );
281 extern UINT MSI_CommitTables( MSIDATABASE *db );
282 extern HRESULT init_string_table( IStorage *stg );
285 /* string table functions */
286 extern BOOL msi_addstring( string_table *st, UINT string_no, const CHAR *data, int len, UINT refcount );
287 extern BOOL msi_addstringW( string_table *st, UINT string_no, const WCHAR *data, int len, UINT refcount );
288 extern UINT msi_id2stringW( string_table *st, UINT string_no, LPWSTR buffer, UINT *sz );
289 extern UINT msi_id2stringA( string_table *st, UINT string_no, LPSTR buffer, UINT *sz );
291 extern LPWSTR MSI_makestring( MSIDATABASE *db, UINT stringid);
292 extern UINT msi_string2idW( string_table *st, LPCWSTR buffer, UINT *id );
293 extern UINT msi_string2idA( string_table *st, LPCSTR str, UINT *id );
294 extern string_table *msi_init_stringtable( int entries, UINT codepage );
295 extern VOID msi_destroy_stringtable( string_table *st );
296 extern UINT msi_string_count( string_table *st );
297 extern UINT msi_id_refcount( string_table *st, UINT i );
298 extern UINT msi_string_totalsize( string_table *st, UINT *last );
299 extern UINT msi_strcmp( string_table *st, UINT lval, UINT rval, UINT *res );
300 extern const WCHAR *msi_string_lookup_id( string_table *st, UINT id );
301 extern UINT msi_string_get_codepage( string_table *st );
304 extern UINT VIEW_find_column( MSIVIEW *view, LPCWSTR name, UINT *n );
306 extern BOOL TABLE_Exists( MSIDATABASE *db, LPWSTR name );
308 extern UINT read_raw_stream_data( MSIDATABASE*, LPCWSTR stname,
309 USHORT **pdata, UINT *psz );
311 /* action internals */
312 extern UINT ACTION_DoTopLevelINSTALL( MSIPACKAGE *, LPCWSTR, LPCWSTR, LPCWSTR );
313 extern void ACTION_free_package_structures( MSIPACKAGE* );
314 extern UINT ACTION_DialogBox( MSIPACKAGE*, LPCWSTR);
316 /* record internals */
317 extern UINT MSI_RecordSetIStream( MSIRECORD *, unsigned int, IStream *);
318 extern UINT MSI_RecordGetIStream( MSIRECORD *, unsigned int, IStream **);
319 extern const WCHAR *MSI_RecordGetString( MSIRECORD *, unsigned int );
320 extern MSIRECORD *MSI_CreateRecord( unsigned int );
321 extern UINT MSI_RecordSetInteger( MSIRECORD *, unsigned int, int );
322 extern UINT MSI_RecordSetStringW( MSIRECORD *, unsigned int, LPCWSTR );
323 extern UINT MSI_RecordSetStringA( MSIRECORD *, unsigned int, LPCSTR );
324 extern BOOL MSI_RecordIsNull( MSIRECORD *, unsigned int );
325 extern UINT MSI_RecordGetStringW( MSIRECORD * , unsigned int, LPWSTR, DWORD *);
326 extern UINT MSI_RecordGetStringA( MSIRECORD *, unsigned int, LPSTR, DWORD *);
327 extern int MSI_RecordGetInteger( MSIRECORD *, unsigned int );
328 extern UINT MSI_RecordReadStream( MSIRECORD *, unsigned int, char *, DWORD *);
329 extern unsigned int MSI_RecordGetFieldCount( MSIRECORD *rec );
330 extern UINT MSI_RecordSetStreamW( MSIRECORD *, unsigned int, LPCWSTR );
331 extern UINT MSI_RecordSetStreamA( MSIRECORD *, unsigned int, LPCSTR );
332 extern UINT MSI_RecordDataSize( MSIRECORD *, unsigned int );
333 extern UINT MSI_RecordStreamToFile( MSIRECORD *, unsigned int, LPCWSTR );
335 /* stream internals */
336 extern UINT get_raw_stream( MSIHANDLE hdb, LPCWSTR stname, IStream **stm );
337 extern UINT db_get_raw_stream( MSIDATABASE *db, LPCWSTR stname, IStream **stm );
338 extern void enum_stream_names( IStorage *stg );
340 /* database internals */
341 extern UINT MSI_OpenDatabaseW( LPCWSTR, LPCWSTR, MSIDATABASE ** );
342 extern UINT MSI_DatabaseOpenViewW(MSIDATABASE *, LPCWSTR, MSIQUERY ** );
343 extern UINT MSI_OpenQuery( MSIDATABASE *, MSIQUERY **, LPCWSTR, ... );
344 typedef UINT (*record_func)( MSIRECORD *, LPVOID );
345 extern UINT MSI_IterateRecords( MSIQUERY *, DWORD *, record_func, LPVOID );
346 extern MSIRECORD *MSI_QueryGetRecord( MSIDATABASE *db, LPCWSTR query, ... );
347 extern UINT MSI_DatabaseImport( MSIDATABASE *, LPCWSTR, LPCWSTR );
348 extern UINT MSI_DatabaseExport( MSIDATABASE *, LPCWSTR, LPCWSTR, LPCWSTR );
349 extern UINT MSI_DatabaseGetPrimaryKeys( MSIDATABASE *, LPCWSTR, MSIRECORD ** );
352 extern UINT MSI_ViewExecute( MSIQUERY*, MSIRECORD * );
353 extern UINT MSI_ViewFetch( MSIQUERY*, MSIRECORD ** );
354 extern UINT MSI_ViewClose( MSIQUERY* );
356 /* package internals */
357 extern MSIPACKAGE *MSI_CreatePackage( MSIDATABASE * );
358 extern UINT MSI_OpenPackageW( LPCWSTR szPackage, MSIPACKAGE ** );
359 extern UINT MSI_SetTargetPathW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
360 extern UINT MSI_SetPropertyW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
361 extern INT MSI_ProcessMessage( MSIPACKAGE *, INSTALLMESSAGE, MSIRECORD * );
362 extern UINT MSI_GetPropertyW( MSIPACKAGE *, LPCWSTR, LPWSTR, DWORD * );
363 extern UINT MSI_GetPropertyA(MSIPACKAGE *, LPCSTR, LPSTR, DWORD* );
364 extern MSICONDITION MSI_EvaluateConditionW( MSIPACKAGE *, LPCWSTR );
365 extern UINT MSI_GetComponentStateW( MSIPACKAGE *, LPWSTR, INSTALLSTATE *, INSTALLSTATE * );
366 extern UINT MSI_GetFeatureStateW( MSIPACKAGE *, LPWSTR, INSTALLSTATE *, INSTALLSTATE * );
367 extern UINT WINAPI MSI_SetFeatureStateW(MSIPACKAGE*, LPCWSTR, INSTALLSTATE );
369 /* for deformating */
370 extern UINT MSI_FormatRecordW( MSIPACKAGE *, MSIRECORD *, LPWSTR, DWORD * );
371 extern UINT MSI_FormatRecordA( MSIPACKAGE *, MSIRECORD *, LPSTR, DWORD * );
373 /* registry data encoding/decoding functions */
374 extern BOOL unsquash_guid(LPCWSTR in, LPWSTR out);
375 extern BOOL squash_guid(LPCWSTR in, LPWSTR out);
376 extern BOOL encode_base85_guid(GUID *,LPWSTR);
377 extern BOOL decode_base85_guid(LPCWSTR,GUID*);
378 extern UINT MSIREG_OpenUninstallKey(LPCWSTR szProduct, HKEY* key, BOOL create);
379 extern UINT MSIREG_OpenUserProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
380 extern UINT MSIREG_OpenFeatures(HKEY* key);
381 extern UINT MSIREG_OpenFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
382 extern UINT MSIREG_OpenComponents(HKEY* key);
383 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
384 extern UINT MSIREG_OpenComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
385 extern UINT MSIREG_OpenProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
386 extern UINT MSIREG_OpenUserFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
387 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
388 extern UINT MSIREG_OpenUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
389 extern UINT MSIREG_OpenUserUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
391 /* msi dialog interface */
392 typedef UINT (*msi_dialog_event_handler)( MSIPACKAGE*, LPCWSTR, LPCWSTR, msi_dialog* );
393 extern msi_dialog *msi_dialog_create( MSIPACKAGE*, LPCWSTR, msi_dialog_event_handler );
394 extern UINT msi_dialog_run_message_loop( msi_dialog* );
395 extern void msi_dialog_end_dialog( msi_dialog* );
396 extern void msi_dialog_check_messages( HANDLE );
397 extern void msi_dialog_do_preview( msi_dialog* );
398 extern void msi_dialog_destroy( msi_dialog* );
399 extern BOOL msi_dialog_register_class( void );
400 extern void msi_dialog_unregister_class( void );
401 extern void msi_dialog_handle_event( msi_dialog*, LPCWSTR, LPCWSTR, MSIRECORD * );
404 extern MSIPREVIEW *MSI_EnableUIPreview( MSIDATABASE * );
405 extern UINT MSI_PreviewDialogW( MSIPREVIEW *, LPCWSTR );
407 /* undocumented functions */
408 UINT WINAPI MsiCreateAndVerifyInstallerDirectory( DWORD );
409 UINT WINAPI MsiDecomposeDescriptorW( LPCWSTR, LPWSTR, LPWSTR, LPWSTR, DWORD * );
410 UINT WINAPI MsiDecomposeDescriptorA( LPCSTR, LPSTR, LPSTR, LPSTR, DWORD * );
411 LANGID WINAPI MsiLoadStringW( MSIHANDLE, UINT, LPWSTR, int, LANGID );
412 LANGID WINAPI MsiLoadStringA( MSIHANDLE, UINT, LPSTR, int, LANGID );
415 extern INSTALLUILEVEL gUILevel;
417 extern INSTALLUI_HANDLERA gUIHandlerA;
418 extern INSTALLUI_HANDLERW gUIHandlerW;
419 extern DWORD gUIFilter;
420 extern LPVOID gUIContext;
421 extern WCHAR gszLogFile[MAX_PATH];
423 inline static char *strdupWtoA( LPCWSTR str )
428 DWORD len = WideCharToMultiByte( CP_ACP, 0, str, -1, NULL, 0, NULL, NULL
430 if ((ret = HeapAlloc( GetProcessHeap(), 0, len )))
431 WideCharToMultiByte( CP_ACP, 0, str, -1, ret, len, NULL, NULL );
436 inline static LPWSTR strdupAtoW( LPCSTR str )
441 DWORD len = MultiByteToWideChar( CP_ACP, 0, str, -1, NULL, 0 );
442 if ((ret = HeapAlloc( GetProcessHeap(), 0, len * sizeof(WCHAR) )))
443 MultiByteToWideChar( CP_ACP, 0, str, -1, ret, len );
448 inline static LPWSTR strdupW( LPCWSTR src )
451 if (!src) return NULL;
452 dest = HeapAlloc(GetProcessHeap(), 0, (lstrlenW(src)+1)*sizeof(WCHAR));
457 #endif /* __WINE_MSI_PRIVATE__ */