msi: Implement the Reset control event.
[wine/wine-gecko.git] / dlls / msi / msipriv.h
blobcb6489734c3d694383bb235fdead673d23573317
1 /*
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__
24 #include <stdarg.h>
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"
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 #define MSITYPE_IS_BINARY(type) (((type) & ~MSITYPE_NULLABLE) == (MSITYPE_STRING|MSITYPE_VALID))
44 struct tagMSITABLE;
45 typedef struct tagMSITABLE MSITABLE;
47 struct string_table;
48 typedef struct string_table string_table;
50 struct tagMSIOBJECTHDR;
51 typedef struct tagMSIOBJECTHDR MSIOBJECTHDR;
53 typedef VOID (*msihandledestructor)( MSIOBJECTHDR * );
55 struct tagMSIOBJECTHDR
57 UINT magic;
58 UINT type;
59 LONG refcount;
60 msihandledestructor destructor;
63 typedef struct tagMSIDATABASE
65 MSIOBJECTHDR hdr;
66 IStorage *storage;
67 string_table *strings;
68 LPCWSTR mode;
69 struct list tables;
70 struct list transforms;
71 } MSIDATABASE;
73 typedef struct tagMSIVIEW MSIVIEW;
75 typedef struct tagMSIQUERY
77 MSIOBJECTHDR hdr;
78 MSIVIEW *view;
79 UINT row;
80 MSIDATABASE *db;
81 struct list mem;
82 } MSIQUERY;
84 /* maybe we can use a Variant instead of doing it ourselves? */
85 typedef struct tagMSIFIELD
87 UINT type;
88 union
90 INT iVal;
91 LPWSTR szwVal;
92 IStream *stream;
93 } u;
94 } MSIFIELD;
96 typedef struct tagMSIRECORD
98 MSIOBJECTHDR hdr;
99 UINT count; /* as passed to MsiCreateRecord */
100 MSIFIELD fields[1]; /* nb. array size is count+1 */
101 } MSIRECORD;
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
158 * the caller.
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 * );
173 } MSIVIEWOPS;
175 struct tagMSIVIEW
177 MSIOBJECTHDR hdr;
178 MSIVIEWOPS *ops;
181 struct msi_dialog_tag;
182 typedef struct msi_dialog_tag msi_dialog;
184 typedef struct tagMSIPACKAGE
186 MSIOBJECTHDR hdr;
187 MSIDATABASE *db;
188 struct list components;
189 struct list features;
190 struct list files;
191 struct list tempfiles;
192 struct list folders;
193 LPWSTR ActionFormat;
194 LPWSTR LastAction;
196 struct list classes;
197 struct list extensions;
198 struct list progids;
199 struct list mimes;
200 struct list appids;
202 struct tagMSISCRIPT *script;
204 struct list RunningActions;
206 LPWSTR PackagePath;
207 LPWSTR ProductCode;
209 UINT CurrentInstallState;
210 msi_dialog *dialog;
211 LPWSTR next_dialog;
213 struct list subscriptions;
214 } MSIPACKAGE;
216 typedef struct tagMSIPREVIEW
218 MSIOBJECTHDR hdr;
219 MSIPACKAGE *package;
220 msi_dialog *dialog;
221 } MSIPREVIEW;
223 #define MSI_MAX_PROPS 20
225 typedef struct tagMSISUMMARYINFO
227 MSIOBJECTHDR hdr;
228 MSIDATABASE *db;
229 DWORD update_count;
230 PROPVARIANT property[MSI_MAX_PROPS];
231 } MSISUMMARYINFO;
233 #define MSIHANDLETYPE_ANY 0
234 #define MSIHANDLETYPE_DATABASE 1
235 #define MSIHANDLETYPE_SUMMARYINFO 2
236 #define MSIHANDLETYPE_VIEW 3
237 #define MSIHANDLETYPE_RECORD 4
238 #define MSIHANDLETYPE_PACKAGE 5
239 #define MSIHANDLETYPE_PREVIEW 6
241 #define MSI_MAJORVERSION 2
242 #define MSI_MINORVERSION 0
243 #define MSI_BUILDNUMBER 2600
245 #define GUID_SIZE 39
247 #define MSIHANDLE_MAGIC 0x4d434923
248 #define MSIMAXHANDLES 0xf0
250 DEFINE_GUID(CLSID_IMsiServer, 0x000C101C,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
251 DEFINE_GUID(CLSID_IMsiServerX1, 0x000C103E,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
252 DEFINE_GUID(CLSID_IMsiServerX2, 0x000C1090,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
253 DEFINE_GUID(CLSID_IMsiServerX3, 0x000C1094,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
255 DEFINE_GUID(CLSID_IMsiServerMessage, 0x000C101D,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
257 /* handle unicode/ascii output in the Msi* API functions */
258 typedef struct {
259 BOOL unicode;
260 union {
261 LPSTR a;
262 LPWSTR w;
263 } str;
264 } awstring;
266 typedef struct {
267 BOOL unicode;
268 union {
269 LPCSTR a;
270 LPCWSTR w;
271 } str;
272 } awcstring;
274 UINT msi_strcpy_to_awstring( LPCWSTR str, awstring *awbuf, DWORD *sz );
276 /* handle functions */
277 extern void *msihandle2msiinfo(MSIHANDLE handle, UINT type);
278 extern MSIHANDLE alloc_msihandle( MSIOBJECTHDR * );
279 extern void *alloc_msiobject(UINT type, UINT size, msihandledestructor destroy );
280 extern void msiobj_addref(MSIOBJECTHDR *);
281 extern int msiobj_release(MSIOBJECTHDR *);
282 extern void msiobj_lock(MSIOBJECTHDR *);
283 extern void msiobj_unlock(MSIOBJECTHDR *);
285 extern void free_cached_tables( MSIDATABASE *db );
286 extern void msi_free_transforms( MSIDATABASE *db );
287 extern string_table *load_string_table( IStorage *stg );
288 extern UINT MSI_CommitTables( MSIDATABASE *db );
289 extern HRESULT init_string_table( IStorage *stg );
292 /* string table functions */
293 extern BOOL msi_addstring( string_table *st, UINT string_no, const CHAR *data, int len, UINT refcount );
294 extern BOOL msi_addstringW( string_table *st, UINT string_no, const WCHAR *data, int len, UINT refcount );
295 extern UINT msi_id2stringW( string_table *st, UINT string_no, LPWSTR buffer, UINT *sz );
296 extern UINT msi_id2stringA( string_table *st, UINT string_no, LPSTR buffer, UINT *sz );
298 extern LPWSTR MSI_makestring( MSIDATABASE *db, UINT stringid);
299 extern UINT msi_string2idW( string_table *st, LPCWSTR buffer, UINT *id );
300 extern UINT msi_string2idA( string_table *st, LPCSTR str, UINT *id );
301 extern string_table *msi_init_stringtable( int entries, UINT codepage );
302 extern VOID msi_destroy_stringtable( string_table *st );
303 extern UINT msi_string_count( string_table *st );
304 extern UINT msi_id_refcount( string_table *st, UINT i );
305 extern UINT msi_string_totalsize( string_table *st, UINT *last );
306 extern UINT msi_strcmp( string_table *st, UINT lval, UINT rval, UINT *res );
307 extern const WCHAR *msi_string_lookup_id( string_table *st, UINT id );
308 extern UINT msi_string_get_codepage( string_table *st );
311 extern UINT VIEW_find_column( MSIVIEW *view, LPCWSTR name, UINT *n );
313 extern BOOL TABLE_Exists( MSIDATABASE *db, LPWSTR name );
315 extern UINT read_raw_stream_data( MSIDATABASE*, LPCWSTR stname,
316 USHORT **pdata, UINT *psz );
318 /* transform functions */
319 extern UINT msi_table_apply_transform( MSIDATABASE *db, IStorage *stg );
321 /* action internals */
322 extern UINT MSI_InstallPackage( MSIPACKAGE *, LPCWSTR, LPCWSTR );
323 extern void ACTION_free_package_structures( MSIPACKAGE* );
324 extern UINT ACTION_DialogBox( MSIPACKAGE*, LPCWSTR);
325 extern UINT MSI_Sequence( MSIPACKAGE *package, LPCWSTR szTable, INT iSequenceMode );
327 /* record internals */
328 extern UINT MSI_RecordSetIStream( MSIRECORD *, unsigned int, IStream *);
329 extern UINT MSI_RecordGetIStream( MSIRECORD *, unsigned int, IStream **);
330 extern const WCHAR *MSI_RecordGetString( MSIRECORD *, unsigned int );
331 extern MSIRECORD *MSI_CreateRecord( unsigned int );
332 extern UINT MSI_RecordSetInteger( MSIRECORD *, unsigned int, int );
333 extern UINT MSI_RecordSetStringW( MSIRECORD *, unsigned int, LPCWSTR );
334 extern UINT MSI_RecordSetStringA( MSIRECORD *, unsigned int, LPCSTR );
335 extern BOOL MSI_RecordIsNull( MSIRECORD *, unsigned int );
336 extern UINT MSI_RecordGetStringW( MSIRECORD * , unsigned int, LPWSTR, DWORD *);
337 extern UINT MSI_RecordGetStringA( MSIRECORD *, unsigned int, LPSTR, DWORD *);
338 extern int MSI_RecordGetInteger( MSIRECORD *, unsigned int );
339 extern UINT MSI_RecordReadStream( MSIRECORD *, unsigned int, char *, DWORD *);
340 extern unsigned int MSI_RecordGetFieldCount( MSIRECORD *rec );
341 extern UINT MSI_RecordSetStreamW( MSIRECORD *, unsigned int, LPCWSTR );
342 extern UINT MSI_RecordSetStreamA( MSIRECORD *, unsigned int, LPCSTR );
343 extern UINT MSI_RecordDataSize( MSIRECORD *, unsigned int );
344 extern UINT MSI_RecordStreamToFile( MSIRECORD *, unsigned int, LPCWSTR );
346 /* stream internals */
347 extern UINT get_raw_stream( MSIHANDLE hdb, LPCWSTR stname, IStream **stm );
348 extern UINT db_get_raw_stream( MSIDATABASE *db, LPCWSTR stname, IStream **stm );
349 extern void enum_stream_names( IStorage *stg );
351 /* database internals */
352 extern UINT MSI_OpenDatabaseW( LPCWSTR, LPCWSTR, MSIDATABASE ** );
353 extern UINT MSI_DatabaseOpenViewW(MSIDATABASE *, LPCWSTR, MSIQUERY ** );
354 extern UINT MSI_OpenQuery( MSIDATABASE *, MSIQUERY **, LPCWSTR, ... );
355 typedef UINT (*record_func)( MSIRECORD *, LPVOID );
356 extern UINT MSI_IterateRecords( MSIQUERY *, DWORD *, record_func, LPVOID );
357 extern MSIRECORD *MSI_QueryGetRecord( MSIDATABASE *db, LPCWSTR query, ... );
358 extern UINT MSI_DatabaseImport( MSIDATABASE *, LPCWSTR, LPCWSTR );
359 extern UINT MSI_DatabaseExport( MSIDATABASE *, LPCWSTR, LPCWSTR, LPCWSTR );
360 extern UINT MSI_DatabaseGetPrimaryKeys( MSIDATABASE *, LPCWSTR, MSIRECORD ** );
362 /* view internals */
363 extern UINT MSI_ViewExecute( MSIQUERY*, MSIRECORD * );
364 extern UINT MSI_ViewFetch( MSIQUERY*, MSIRECORD ** );
365 extern UINT MSI_ViewClose( MSIQUERY* );
367 /* package internals */
368 extern MSIPACKAGE *MSI_CreatePackage( MSIDATABASE * );
369 extern UINT MSI_OpenPackageW( LPCWSTR szPackage, MSIPACKAGE ** );
370 extern UINT MSI_SetTargetPathW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
371 extern UINT MSI_SetPropertyW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
372 extern INT MSI_ProcessMessage( MSIPACKAGE *, INSTALLMESSAGE, MSIRECORD * );
373 extern UINT MSI_GetPropertyW( MSIPACKAGE *, LPCWSTR, LPWSTR, DWORD * );
374 extern UINT MSI_GetPropertyA(MSIPACKAGE *, LPCSTR, LPSTR, DWORD* );
375 extern MSICONDITION MSI_EvaluateConditionW( MSIPACKAGE *, LPCWSTR );
376 extern UINT MSI_GetComponentStateW( MSIPACKAGE *, LPWSTR, INSTALLSTATE *, INSTALLSTATE * );
377 extern UINT MSI_GetFeatureStateW( MSIPACKAGE *, LPWSTR, INSTALLSTATE *, INSTALLSTATE * );
378 extern UINT WINAPI MSI_SetFeatureStateW(MSIPACKAGE*, LPCWSTR, INSTALLSTATE );
380 /* for deformating */
381 extern UINT MSI_FormatRecordW( MSIPACKAGE *, MSIRECORD *, LPWSTR, DWORD * );
382 extern UINT MSI_FormatRecordA( MSIPACKAGE *, MSIRECORD *, LPSTR, DWORD * );
384 /* registry data encoding/decoding functions */
385 extern BOOL unsquash_guid(LPCWSTR in, LPWSTR out);
386 extern BOOL squash_guid(LPCWSTR in, LPWSTR out);
387 extern BOOL encode_base85_guid(GUID *,LPWSTR);
388 extern BOOL decode_base85_guid(LPCWSTR,GUID*);
389 extern UINT MSIREG_OpenUninstallKey(LPCWSTR szProduct, HKEY* key, BOOL create);
390 extern UINT MSIREG_OpenUserProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
391 extern UINT MSIREG_OpenFeatures(HKEY* key);
392 extern UINT MSIREG_OpenFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
393 extern UINT MSIREG_OpenComponents(HKEY* key);
394 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
395 extern UINT MSIREG_OpenComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
396 extern UINT MSIREG_OpenProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
397 extern UINT MSIREG_OpenUserFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
398 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
399 extern UINT MSIREG_OpenUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
400 extern UINT MSIREG_OpenUserUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
402 extern LONG msi_reg_set_val_str( HKEY hkey, LPCWSTR name, LPCWSTR value );
403 extern LONG msi_reg_set_val_multi_str( HKEY hkey, LPCWSTR name, LPCWSTR value );
404 extern LONG msi_reg_set_val_dword( HKEY hkey, LPCWSTR name, DWORD val );
406 /* msi dialog interface */
407 typedef UINT (*msi_dialog_event_handler)( MSIPACKAGE*, LPCWSTR, LPCWSTR, msi_dialog* );
408 extern msi_dialog *msi_dialog_create( MSIPACKAGE*, LPCWSTR, msi_dialog_event_handler );
409 extern UINT msi_dialog_run_message_loop( msi_dialog* );
410 extern void msi_dialog_end_dialog( msi_dialog* );
411 extern void msi_dialog_check_messages( HANDLE );
412 extern void msi_dialog_do_preview( msi_dialog* );
413 extern void msi_dialog_destroy( msi_dialog* );
414 extern BOOL msi_dialog_register_class( void );
415 extern void msi_dialog_unregister_class( void );
416 extern void msi_dialog_handle_event( msi_dialog*, LPCWSTR, LPCWSTR, MSIRECORD * );
417 extern UINT msi_dialog_reset( msi_dialog *dialog );
419 /* preview */
420 extern MSIPREVIEW *MSI_EnableUIPreview( MSIDATABASE * );
421 extern UINT MSI_PreviewDialogW( MSIPREVIEW *, LPCWSTR );
423 /* summary information */
424 extern MSISUMMARYINFO *MSI_GetSummaryInformationW( MSIDATABASE *db, UINT uiUpdateCount );
425 extern LPWSTR msi_suminfo_dup_string( MSISUMMARYINFO *si, UINT uiProperty );
427 /* undocumented functions */
428 UINT WINAPI MsiCreateAndVerifyInstallerDirectory( DWORD );
429 UINT WINAPI MsiDecomposeDescriptorW( LPCWSTR, LPWSTR, LPWSTR, LPWSTR, DWORD * );
430 UINT WINAPI MsiDecomposeDescriptorA( LPCSTR, LPSTR, LPSTR, LPSTR, DWORD * );
431 LANGID WINAPI MsiLoadStringW( MSIHANDLE, UINT, LPWSTR, int, LANGID );
432 LANGID WINAPI MsiLoadStringA( MSIHANDLE, UINT, LPSTR, int, LANGID );
434 /* UI globals */
435 extern INSTALLUILEVEL gUILevel;
436 extern HWND gUIhwnd;
437 extern INSTALLUI_HANDLERA gUIHandlerA;
438 extern INSTALLUI_HANDLERW gUIHandlerW;
439 extern DWORD gUIFilter;
440 extern LPVOID gUIContext;
441 extern WCHAR gszLogFile[MAX_PATH];
443 /* memory allocation macro functions */
444 static inline void *msi_alloc( size_t len )
446 return HeapAlloc( GetProcessHeap(), 0, len );
449 static inline void *msi_alloc_zero( size_t len )
451 return HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, len );
454 static inline void *msi_realloc( void *mem, size_t len )
456 return HeapReAlloc( GetProcessHeap(), 0, mem, len );
459 static inline void *msi_realloc_zero( void *mem, size_t len )
461 return HeapReAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, mem, len );
464 static inline BOOL msi_free( void *mem )
466 return HeapFree( GetProcessHeap(), 0, mem );
469 inline static char *strdupWtoA( LPCWSTR str )
471 LPSTR ret = NULL;
472 DWORD len;
474 if (!str) return ret;
475 len = WideCharToMultiByte( CP_ACP, 0, str, -1, NULL, 0, NULL, NULL);
476 ret = msi_alloc( len );
477 if (ret)
478 WideCharToMultiByte( CP_ACP, 0, str, -1, ret, len, NULL, NULL );
479 return ret;
482 inline static LPWSTR strdupAtoW( LPCSTR str )
484 LPWSTR ret = NULL;
485 DWORD len;
487 if (!str) return ret;
488 len = MultiByteToWideChar( CP_ACP, 0, str, -1, NULL, 0 );
489 ret = msi_alloc( len * sizeof(WCHAR) );
490 if (ret)
491 MultiByteToWideChar( CP_ACP, 0, str, -1, ret, len );
492 return ret;
495 inline static LPWSTR strdupW( LPCWSTR src )
497 LPWSTR dest;
498 if (!src) return NULL;
499 dest = msi_alloc( (lstrlenW(src)+1)*sizeof(WCHAR) );
500 if (dest)
501 lstrcpyW(dest, src);
502 return dest;
505 #endif /* __WINE_MSI_PRIVATE__ */