wrc: Clean output files when aborting on an error or signal.
[wine/multimedia.git] / dlls / msi / msipriv.h
blob3262ffa766ce3b97732c11e51d07463e6ab230bc
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, 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 void *MSIITERHANDLE;
105 typedef struct tagMSIVIEWOPS
108 * fetch_int - reads one integer from {row,col} in the table
110 * This function should be called after the execute method.
111 * Data returned by the function should not change until
112 * close or delete is called.
113 * To get a string value, query the database's string table with
114 * the integer value returned from this function.
116 UINT (*fetch_int)( struct tagMSIVIEW *, UINT row, UINT col, UINT *val );
119 * fetch_stream - gets a stream from {row,col} in the table
121 * This function is similar to fetch_int, except fetches a
122 * stream instead of an integer.
124 UINT (*fetch_stream)( struct tagMSIVIEW *, UINT row, UINT col, IStream **stm );
127 * get_int - sets one integer at {row,col} in the table
129 * Similar semantics to fetch_int
131 UINT (*set_int)( struct tagMSIVIEW *, UINT row, UINT col, UINT val );
134 * Inserts a new row into the database from the records contents
136 UINT (*insert_row)( struct tagMSIVIEW *, MSIRECORD * );
139 * execute - loads the underlying data into memory so it can be read
141 UINT (*execute)( struct tagMSIVIEW *, MSIRECORD * );
144 * close - clears the data read by execute from memory
146 UINT (*close)( struct tagMSIVIEW * );
149 * get_dimensions - returns the number of rows or columns in a table.
151 * The number of rows can only be queried after the execute method
152 * is called. The number of columns can be queried at any time.
154 UINT (*get_dimensions)( struct tagMSIVIEW *, UINT *rows, UINT *cols );
157 * get_column_info - returns the name and type of a specific column
159 * The name is HeapAlloc'ed by this function and should be freed by
160 * the caller.
161 * The column information can be queried at any time.
163 UINT (*get_column_info)( struct tagMSIVIEW *, UINT n, LPWSTR *name, UINT *type );
166 * modify - not yet implemented properly
168 UINT (*modify)( struct tagMSIVIEW *, MSIMODIFY, MSIRECORD * );
171 * delete - destroys the structure completely
173 UINT (*delete)( struct tagMSIVIEW * );
176 * find_matching_rows - iterates through rows that match a value
178 * If the column type is a string then a string ID should be passed in.
179 * If the value to be looked up is an integer then no transformation of
180 * the input value is required, except if the column is a string, in which
181 * case a string ID should be passed in.
182 * The handle is an input/output parameter that keeps track of the current
183 * position in the iteration. It must be initialised to zero before the
184 * first call and continued to be passed in to subsequent calls.
186 UINT (*find_matching_rows)( struct tagMSIVIEW *, UINT col, UINT val, UINT *row, MSIITERHANDLE *handle );
187 } MSIVIEWOPS;
189 struct tagMSIVIEW
191 MSIOBJECTHDR hdr;
192 MSIVIEWOPS *ops;
195 struct msi_dialog_tag;
196 typedef struct msi_dialog_tag msi_dialog;
198 typedef struct tagMSIPACKAGE
200 MSIOBJECTHDR hdr;
201 MSIDATABASE *db;
202 struct list components;
203 struct list features;
204 struct list files;
205 struct list tempfiles;
206 struct list folders;
207 LPWSTR ActionFormat;
208 LPWSTR LastAction;
210 struct list classes;
211 struct list extensions;
212 struct list progids;
213 struct list mimes;
214 struct list appids;
216 struct tagMSISCRIPT *script;
218 struct list RunningActions;
220 LPWSTR PackagePath;
221 LPWSTR ProductCode;
223 UINT CurrentInstallState;
224 msi_dialog *dialog;
225 LPWSTR next_dialog;
227 struct list subscriptions;
228 } MSIPACKAGE;
230 typedef struct tagMSIPREVIEW
232 MSIOBJECTHDR hdr;
233 MSIPACKAGE *package;
234 msi_dialog *dialog;
235 } MSIPREVIEW;
237 #define MSI_MAX_PROPS 20
239 typedef struct tagMSISUMMARYINFO
241 MSIOBJECTHDR hdr;
242 MSIDATABASE *db;
243 DWORD update_count;
244 PROPVARIANT property[MSI_MAX_PROPS];
245 } MSISUMMARYINFO;
247 #define MSIHANDLETYPE_ANY 0
248 #define MSIHANDLETYPE_DATABASE 1
249 #define MSIHANDLETYPE_SUMMARYINFO 2
250 #define MSIHANDLETYPE_VIEW 3
251 #define MSIHANDLETYPE_RECORD 4
252 #define MSIHANDLETYPE_PACKAGE 5
253 #define MSIHANDLETYPE_PREVIEW 6
255 #define MSI_MAJORVERSION 2
256 #define MSI_MINORVERSION 0
257 #define MSI_BUILDNUMBER 2600
259 #define GUID_SIZE 39
261 #define MSIHANDLE_MAGIC 0x4d434923
262 #define MSIMAXHANDLES 0xf0
264 DEFINE_GUID(CLSID_IMsiServer, 0x000C101C,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
265 DEFINE_GUID(CLSID_IMsiServerX1, 0x000C103E,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
266 DEFINE_GUID(CLSID_IMsiServerX2, 0x000C1090,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
267 DEFINE_GUID(CLSID_IMsiServerX3, 0x000C1094,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
269 DEFINE_GUID(CLSID_IMsiServerMessage, 0x000C101D,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
271 /* handle unicode/ascii output in the Msi* API functions */
272 typedef struct {
273 BOOL unicode;
274 union {
275 LPSTR a;
276 LPWSTR w;
277 } str;
278 } awstring;
280 typedef struct {
281 BOOL unicode;
282 union {
283 LPCSTR a;
284 LPCWSTR w;
285 } str;
286 } awcstring;
288 UINT msi_strcpy_to_awstring( LPCWSTR str, awstring *awbuf, DWORD *sz );
290 /* handle functions */
291 extern void *msihandle2msiinfo(MSIHANDLE handle, UINT type);
292 extern MSIHANDLE alloc_msihandle( MSIOBJECTHDR * );
293 extern void *alloc_msiobject(UINT type, UINT size, msihandledestructor destroy );
294 extern void msiobj_addref(MSIOBJECTHDR *);
295 extern int msiobj_release(MSIOBJECTHDR *);
296 extern void msiobj_lock(MSIOBJECTHDR *);
297 extern void msiobj_unlock(MSIOBJECTHDR *);
299 extern void free_cached_tables( MSIDATABASE *db );
300 extern void msi_free_transforms( MSIDATABASE *db );
301 extern string_table *load_string_table( IStorage *stg );
302 extern UINT MSI_CommitTables( MSIDATABASE *db );
303 extern HRESULT init_string_table( IStorage *stg );
306 /* string table functions */
307 extern BOOL msi_addstring( string_table *st, UINT string_no, const CHAR *data, int len, UINT refcount );
308 extern BOOL msi_addstringW( string_table *st, UINT string_no, const WCHAR *data, int len, UINT refcount );
309 extern UINT msi_id2stringW( string_table *st, UINT string_no, LPWSTR buffer, UINT *sz );
310 extern UINT msi_id2stringA( string_table *st, UINT string_no, LPSTR buffer, UINT *sz );
312 extern LPWSTR MSI_makestring( MSIDATABASE *db, UINT stringid);
313 extern UINT msi_string2idW( string_table *st, LPCWSTR buffer, UINT *id );
314 extern UINT msi_string2idA( string_table *st, LPCSTR str, UINT *id );
315 extern string_table *msi_init_stringtable( int entries, UINT codepage );
316 extern VOID msi_destroy_stringtable( string_table *st );
317 extern UINT msi_string_count( string_table *st );
318 extern UINT msi_id_refcount( string_table *st, UINT i );
319 extern UINT msi_string_totalsize( string_table *st, UINT *last );
320 extern UINT msi_strcmp( string_table *st, UINT lval, UINT rval, UINT *res );
321 extern const WCHAR *msi_string_lookup_id( string_table *st, UINT id );
322 extern UINT msi_string_get_codepage( string_table *st );
325 extern UINT VIEW_find_column( MSIVIEW *view, LPCWSTR name, UINT *n );
327 extern BOOL TABLE_Exists( MSIDATABASE *db, LPWSTR name );
329 extern UINT read_raw_stream_data( MSIDATABASE*, LPCWSTR stname,
330 USHORT **pdata, UINT *psz );
332 /* transform functions */
333 extern UINT msi_table_apply_transform( MSIDATABASE *db, IStorage *stg );
334 extern UINT MSI_DatabaseApplyTransformW( MSIDATABASE *db,
335 LPCWSTR szTransformFile, int iErrorCond );
337 /* action internals */
338 extern UINT MSI_InstallPackage( MSIPACKAGE *, LPCWSTR, LPCWSTR );
339 extern void ACTION_free_package_structures( MSIPACKAGE* );
340 extern UINT ACTION_DialogBox( MSIPACKAGE*, LPCWSTR);
341 extern UINT MSI_Sequence( MSIPACKAGE *package, LPCWSTR szTable, INT iSequenceMode );
343 /* record internals */
344 extern UINT MSI_RecordSetIStream( MSIRECORD *, unsigned int, IStream *);
345 extern UINT MSI_RecordGetIStream( MSIRECORD *, unsigned int, IStream **);
346 extern const WCHAR *MSI_RecordGetString( MSIRECORD *, unsigned int );
347 extern MSIRECORD *MSI_CreateRecord( unsigned int );
348 extern UINT MSI_RecordSetInteger( MSIRECORD *, unsigned int, int );
349 extern UINT MSI_RecordSetStringW( MSIRECORD *, unsigned int, LPCWSTR );
350 extern UINT MSI_RecordSetStringA( MSIRECORD *, unsigned int, LPCSTR );
351 extern BOOL MSI_RecordIsNull( MSIRECORD *, unsigned int );
352 extern UINT MSI_RecordGetStringW( MSIRECORD * , unsigned int, LPWSTR, DWORD *);
353 extern UINT MSI_RecordGetStringA( MSIRECORD *, unsigned int, LPSTR, DWORD *);
354 extern int MSI_RecordGetInteger( MSIRECORD *, unsigned int );
355 extern UINT MSI_RecordReadStream( MSIRECORD *, unsigned int, char *, DWORD *);
356 extern unsigned int MSI_RecordGetFieldCount( MSIRECORD *rec );
357 extern UINT MSI_RecordSetStreamW( MSIRECORD *, unsigned int, LPCWSTR );
358 extern UINT MSI_RecordSetStreamA( MSIRECORD *, unsigned int, LPCSTR );
359 extern UINT MSI_RecordDataSize( MSIRECORD *, unsigned int );
360 extern UINT MSI_RecordStreamToFile( MSIRECORD *, unsigned int, LPCWSTR );
362 /* stream internals */
363 extern UINT get_raw_stream( MSIHANDLE hdb, LPCWSTR stname, IStream **stm );
364 extern UINT db_get_raw_stream( MSIDATABASE *db, LPCWSTR stname, IStream **stm );
365 extern void enum_stream_names( IStorage *stg );
367 /* database internals */
368 extern UINT MSI_OpenDatabaseW( LPCWSTR, LPCWSTR, MSIDATABASE ** );
369 extern UINT MSI_DatabaseOpenViewW(MSIDATABASE *, LPCWSTR, MSIQUERY ** );
370 extern UINT MSI_OpenQuery( MSIDATABASE *, MSIQUERY **, LPCWSTR, ... );
371 typedef UINT (*record_func)( MSIRECORD *, LPVOID );
372 extern UINT MSI_IterateRecords( MSIQUERY *, DWORD *, record_func, LPVOID );
373 extern MSIRECORD *MSI_QueryGetRecord( MSIDATABASE *db, LPCWSTR query, ... );
374 extern UINT MSI_DatabaseImport( MSIDATABASE *, LPCWSTR, LPCWSTR );
375 extern UINT MSI_DatabaseExport( MSIDATABASE *, LPCWSTR, LPCWSTR, LPCWSTR );
376 extern UINT MSI_DatabaseGetPrimaryKeys( MSIDATABASE *, LPCWSTR, MSIRECORD ** );
378 /* view internals */
379 extern UINT MSI_ViewExecute( MSIQUERY*, MSIRECORD * );
380 extern UINT MSI_ViewFetch( MSIQUERY*, MSIRECORD ** );
381 extern UINT MSI_ViewClose( MSIQUERY* );
383 /* package internals */
384 extern MSIPACKAGE *MSI_CreatePackage( MSIDATABASE * );
385 extern UINT MSI_OpenPackageW( LPCWSTR szPackage, MSIPACKAGE ** );
386 extern UINT MSI_SetTargetPathW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
387 extern UINT MSI_SetPropertyW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
388 extern INT MSI_ProcessMessage( MSIPACKAGE *, INSTALLMESSAGE, MSIRECORD * );
389 extern UINT MSI_GetPropertyW( MSIPACKAGE *, LPCWSTR, LPWSTR, DWORD * );
390 extern UINT MSI_GetPropertyA(MSIPACKAGE *, LPCSTR, LPSTR, DWORD* );
391 extern MSICONDITION MSI_EvaluateConditionW( MSIPACKAGE *, LPCWSTR );
392 extern UINT MSI_GetComponentStateW( MSIPACKAGE *, LPWSTR, INSTALLSTATE *, INSTALLSTATE * );
393 extern UINT MSI_GetFeatureStateW( MSIPACKAGE *, LPWSTR, INSTALLSTATE *, INSTALLSTATE * );
394 extern UINT WINAPI MSI_SetFeatureStateW(MSIPACKAGE*, LPCWSTR, INSTALLSTATE );
396 /* for deformating */
397 extern UINT MSI_FormatRecordW( MSIPACKAGE *, MSIRECORD *, LPWSTR, DWORD * );
398 extern UINT MSI_FormatRecordA( MSIPACKAGE *, MSIRECORD *, LPSTR, DWORD * );
400 /* registry data encoding/decoding functions */
401 extern BOOL unsquash_guid(LPCWSTR in, LPWSTR out);
402 extern BOOL squash_guid(LPCWSTR in, LPWSTR out);
403 extern BOOL encode_base85_guid(GUID *,LPWSTR);
404 extern BOOL decode_base85_guid(LPCWSTR,GUID*);
405 extern UINT MSIREG_OpenUninstallKey(LPCWSTR szProduct, HKEY* key, BOOL create);
406 extern UINT MSIREG_OpenUserProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
407 extern UINT MSIREG_OpenFeatures(HKEY* key);
408 extern UINT MSIREG_OpenFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
409 extern UINT MSIREG_OpenComponents(HKEY* key);
410 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
411 extern UINT MSIREG_OpenComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
412 extern UINT MSIREG_OpenProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
413 extern UINT MSIREG_OpenUserFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
414 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
415 extern UINT MSIREG_OpenUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
416 extern UINT MSIREG_OpenUserUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
418 extern LONG msi_reg_set_val_str( HKEY hkey, LPCWSTR name, LPCWSTR value );
419 extern LONG msi_reg_set_val_multi_str( HKEY hkey, LPCWSTR name, LPCWSTR value );
420 extern LONG msi_reg_set_val_dword( HKEY hkey, LPCWSTR name, DWORD val );
422 /* msi dialog interface */
423 typedef UINT (*msi_dialog_event_handler)( MSIPACKAGE*, LPCWSTR, LPCWSTR, msi_dialog* );
424 extern msi_dialog *msi_dialog_create( MSIPACKAGE*, LPCWSTR, msi_dialog_event_handler );
425 extern UINT msi_dialog_run_message_loop( msi_dialog* );
426 extern void msi_dialog_end_dialog( msi_dialog* );
427 extern void msi_dialog_check_messages( HANDLE );
428 extern void msi_dialog_do_preview( msi_dialog* );
429 extern void msi_dialog_destroy( msi_dialog* );
430 extern BOOL msi_dialog_register_class( void );
431 extern void msi_dialog_unregister_class( void );
432 extern void msi_dialog_handle_event( msi_dialog*, LPCWSTR, LPCWSTR, MSIRECORD * );
433 extern UINT msi_dialog_reset( msi_dialog *dialog );
435 /* preview */
436 extern MSIPREVIEW *MSI_EnableUIPreview( MSIDATABASE * );
437 extern UINT MSI_PreviewDialogW( MSIPREVIEW *, LPCWSTR );
439 /* summary information */
440 extern MSISUMMARYINFO *MSI_GetSummaryInformationW( MSIDATABASE *db, UINT uiUpdateCount );
441 extern LPWSTR msi_suminfo_dup_string( MSISUMMARYINFO *si, UINT uiProperty );
443 /* undocumented functions */
444 UINT WINAPI MsiCreateAndVerifyInstallerDirectory( DWORD );
445 UINT WINAPI MsiDecomposeDescriptorW( LPCWSTR, LPWSTR, LPWSTR, LPWSTR, DWORD * );
446 UINT WINAPI MsiDecomposeDescriptorA( LPCSTR, LPSTR, LPSTR, LPSTR, DWORD * );
447 LANGID WINAPI MsiLoadStringW( MSIHANDLE, UINT, LPWSTR, int, LANGID );
448 LANGID WINAPI MsiLoadStringA( MSIHANDLE, UINT, LPSTR, int, LANGID );
450 /* UI globals */
451 extern INSTALLUILEVEL gUILevel;
452 extern HWND gUIhwnd;
453 extern INSTALLUI_HANDLERA gUIHandlerA;
454 extern INSTALLUI_HANDLERW gUIHandlerW;
455 extern DWORD gUIFilter;
456 extern LPVOID gUIContext;
457 extern WCHAR gszLogFile[MAX_PATH];
459 /* memory allocation macro functions */
460 static inline void *msi_alloc( size_t len )
462 return HeapAlloc( GetProcessHeap(), 0, len );
465 static inline void *msi_alloc_zero( size_t len )
467 return HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, len );
470 static inline void *msi_realloc( void *mem, size_t len )
472 return HeapReAlloc( GetProcessHeap(), 0, mem, len );
475 static inline void *msi_realloc_zero( void *mem, size_t len )
477 return HeapReAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, mem, len );
480 static inline BOOL msi_free( void *mem )
482 return HeapFree( GetProcessHeap(), 0, mem );
485 inline static char *strdupWtoA( LPCWSTR str )
487 LPSTR ret = NULL;
488 DWORD len;
490 if (!str) return ret;
491 len = WideCharToMultiByte( CP_ACP, 0, str, -1, NULL, 0, NULL, NULL);
492 ret = msi_alloc( len );
493 if (ret)
494 WideCharToMultiByte( CP_ACP, 0, str, -1, ret, len, NULL, NULL );
495 return ret;
498 inline static LPWSTR strdupAtoW( LPCSTR str )
500 LPWSTR ret = NULL;
501 DWORD len;
503 if (!str) return ret;
504 len = MultiByteToWideChar( CP_ACP, 0, str, -1, NULL, 0 );
505 ret = msi_alloc( len * sizeof(WCHAR) );
506 if (ret)
507 MultiByteToWideChar( CP_ACP, 0, str, -1, ret, len );
508 return ret;
511 inline static LPWSTR strdupW( LPCWSTR src )
513 LPWSTR dest;
514 if (!src) return NULL;
515 dest = msi_alloc( (lstrlenW(src)+1)*sizeof(WCHAR) );
516 if (dest)
517 lstrcpyW(dest, src);
518 return dest;
521 #endif /* __WINE_MSI_PRIVATE__ */