msi: Apply any MSI transforms specified by the TRANSFORMS property.
[wine] / dlls / msi / msipriv.h
1 /*
2  * Implementation of the Microsoft Installer (msi.dll)
3  *
4  * Copyright 2002-2005 Mike McCormack for CodeWeavers
5  *
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.
10  *
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.
15  *
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
19  */
20
21 #ifndef __WINE_MSI_PRIVATE__
22 #define __WINE_MSI_PRIVATE__
23
24 #include <stdarg.h>
25
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"
34
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
41
42 #define MSITYPE_IS_BINARY(type) (((type) & ~MSITYPE_NULLABLE) == (MSITYPE_STRING|MSITYPE_VALID))
43
44 struct tagMSITABLE;
45 typedef struct tagMSITABLE MSITABLE;
46
47 struct string_table;
48 typedef struct string_table string_table;
49
50 struct tagMSIOBJECTHDR;
51 typedef struct tagMSIOBJECTHDR MSIOBJECTHDR;
52
53 typedef VOID (*msihandledestructor)( MSIOBJECTHDR * );
54
55 struct tagMSIOBJECTHDR
56 {
57     UINT magic;
58     UINT type;
59     LONG refcount;
60     msihandledestructor destructor;
61 };
62
63 typedef struct tagMSIDATABASE
64 {
65     MSIOBJECTHDR hdr;
66     IStorage *storage;
67     string_table *strings;
68     LPCWSTR mode;
69     struct list tables;
70     struct list transforms;
71 } MSIDATABASE;
72
73 typedef struct tagMSIVIEW MSIVIEW;
74
75 typedef struct tagMSIQUERY
76 {
77     MSIOBJECTHDR hdr;
78     MSIVIEW *view;
79     UINT row;
80     MSIDATABASE *db;
81     struct list mem;
82 } MSIQUERY;
83
84 /* maybe we can use a Variant instead of doing it ourselves? */
85 typedef struct tagMSIFIELD
86 {
87     UINT type;
88     union
89     {
90         INT iVal;
91         LPWSTR szwVal;
92         IStream *stream;
93     } u;
94 } MSIFIELD;
95
96 typedef struct tagMSIRECORD
97 {
98     MSIOBJECTHDR hdr;
99     UINT count;       /* as passed to MsiCreateRecord */
100     MSIFIELD fields[1]; /* nb. array size is count+1 */
101 } MSIRECORD;
102
103 typedef struct tagMSIVIEWOPS
104 {
105     /*
106      * fetch_int - reads one integer from {row,col} in the table
107      *
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.
113      */
114     UINT (*fetch_int)( struct tagMSIVIEW *, UINT row, UINT col, UINT *val );
115
116     /*
117      * fetch_int - reads one integer from {row,col} in the table
118      *
119      *  This function is similar to fetch_int, except fetches a
120      *    stream instead of an integer.
121      */
122     UINT (*fetch_stream)( struct tagMSIVIEW *, UINT row, UINT col, IStream **stm );
123
124     /*
125      * get_int - sets one integer at {row,col} in the table
126      *
127      *  Similar semantics to fetch_int
128      */
129     UINT (*set_int)( struct tagMSIVIEW *, UINT row, UINT col, UINT val );
130
131     /*
132      * Inserts a new row into the database from the records contents
133      */
134     UINT (*insert_row)( struct tagMSIVIEW *, MSIRECORD * );
135
136     /*
137      * execute - loads the underlying data into memory so it can be read
138      */
139     UINT (*execute)( struct tagMSIVIEW *, MSIRECORD * );
140
141     /*
142      * close - clears the data read by execute from memory
143      */
144     UINT (*close)( struct tagMSIVIEW * );
145
146     /*
147      * get_dimensions - returns the number of rows or columns in a table.
148      *
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.
151      */
152     UINT (*get_dimensions)( struct tagMSIVIEW *, UINT *rows, UINT *cols );
153
154     /*
155      * get_column_info - returns the name and type of a specific column
156      *
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.
160      */
161     UINT (*get_column_info)( struct tagMSIVIEW *, UINT n, LPWSTR *name, UINT *type );
162
163     /*
164      * modify - not yet implemented properly
165      */
166     UINT (*modify)( struct tagMSIVIEW *, MSIMODIFY, MSIRECORD * );
167
168     /*
169      * delete - destroys the structure completely
170      */
171     UINT (*delete)( struct tagMSIVIEW * );
172
173 } MSIVIEWOPS;
174
175 struct tagMSIVIEW
176 {
177     MSIOBJECTHDR hdr;
178     MSIVIEWOPS   *ops;
179 };
180
181 struct msi_dialog_tag;
182 typedef struct msi_dialog_tag msi_dialog;
183
184 typedef struct tagMSIPACKAGE
185 {
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;
195
196     struct list classes;
197     struct list extensions;
198     struct list progids;
199     struct list mimes;
200     struct list appids;
201     
202     struct tagMSISCRIPT *script;
203
204     struct list RunningActions;
205
206     LPWSTR PackagePath;
207     LPWSTR ProductCode;
208
209     UINT CurrentInstallState;
210     msi_dialog *dialog;
211     LPWSTR next_dialog;
212     
213     struct list subscriptions;
214 } MSIPACKAGE;
215
216 typedef struct tagMSIPREVIEW
217 {
218     MSIOBJECTHDR hdr;
219     MSIPACKAGE *package;
220     msi_dialog *dialog;
221 } MSIPREVIEW;
222
223 #define MSI_MAX_PROPS 20
224
225 typedef struct tagMSISUMMARYINFO
226 {
227     MSIOBJECTHDR hdr;
228     MSIDATABASE *db;
229     DWORD update_count;
230     PROPVARIANT property[MSI_MAX_PROPS];
231 } MSISUMMARYINFO;
232
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
240
241 #define MSI_MAJORVERSION 2
242 #define MSI_MINORVERSION 0
243 #define MSI_BUILDNUMBER 2600
244
245 #define GUID_SIZE 39
246
247 #define MSIHANDLE_MAGIC 0x4d434923
248 #define MSIMAXHANDLES 0xf0
249
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);
254
255 DEFINE_GUID(CLSID_IMsiServerMessage, 0x000C101D,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
256
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;
265
266 typedef struct {
267     BOOL unicode;
268     union {
269        LPCSTR a;
270        LPCWSTR w;
271     } str;
272 } awcstring;
273
274 UINT msi_strcpy_to_awstring( LPCWSTR str, awstring *awbuf, DWORD *sz );
275
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 *);
284
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 );
290
291
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 );
297
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 );
309
310
311 extern UINT VIEW_find_column( MSIVIEW *view, LPCWSTR name, UINT *n );
312
313 extern BOOL TABLE_Exists( MSIDATABASE *db, LPWSTR name );
314
315 extern UINT read_raw_stream_data( MSIDATABASE*, LPCWSTR stname,
316                               USHORT **pdata, UINT *psz );
317
318 /* transform functions */
319 extern UINT msi_table_apply_transform( MSIDATABASE *db, IStorage *stg );
320 extern UINT MSI_DatabaseApplyTransformW( MSIDATABASE *db, 
321                  LPCWSTR szTransformFile, int iErrorCond );
322
323 /* action internals */
324 extern UINT MSI_InstallPackage( MSIPACKAGE *, LPCWSTR, LPCWSTR );
325 extern void ACTION_free_package_structures( MSIPACKAGE* );
326 extern UINT ACTION_DialogBox( MSIPACKAGE*, LPCWSTR);
327 extern UINT MSI_Sequence( MSIPACKAGE *package, LPCWSTR szTable, INT iSequenceMode );
328
329 /* record internals */
330 extern UINT MSI_RecordSetIStream( MSIRECORD *, unsigned int, IStream *);
331 extern UINT MSI_RecordGetIStream( MSIRECORD *, unsigned int, IStream **);
332 extern const WCHAR *MSI_RecordGetString( MSIRECORD *, unsigned int );
333 extern MSIRECORD *MSI_CreateRecord( unsigned int );
334 extern UINT MSI_RecordSetInteger( MSIRECORD *, unsigned int, int );
335 extern UINT MSI_RecordSetStringW( MSIRECORD *, unsigned int, LPCWSTR );
336 extern UINT MSI_RecordSetStringA( MSIRECORD *, unsigned int, LPCSTR );
337 extern BOOL MSI_RecordIsNull( MSIRECORD *, unsigned int );
338 extern UINT MSI_RecordGetStringW( MSIRECORD * , unsigned int, LPWSTR, DWORD *);
339 extern UINT MSI_RecordGetStringA( MSIRECORD *, unsigned int, LPSTR, DWORD *);
340 extern int MSI_RecordGetInteger( MSIRECORD *, unsigned int );
341 extern UINT MSI_RecordReadStream( MSIRECORD *, unsigned int, char *, DWORD *);
342 extern unsigned int MSI_RecordGetFieldCount( MSIRECORD *rec );
343 extern UINT MSI_RecordSetStreamW( MSIRECORD *, unsigned int, LPCWSTR );
344 extern UINT MSI_RecordSetStreamA( MSIRECORD *, unsigned int, LPCSTR );
345 extern UINT MSI_RecordDataSize( MSIRECORD *, unsigned int );
346 extern UINT MSI_RecordStreamToFile( MSIRECORD *, unsigned int, LPCWSTR );
347
348 /* stream internals */
349 extern UINT get_raw_stream( MSIHANDLE hdb, LPCWSTR stname, IStream **stm );
350 extern UINT db_get_raw_stream( MSIDATABASE *db, LPCWSTR stname, IStream **stm );
351 extern void enum_stream_names( IStorage *stg );
352
353 /* database internals */
354 extern UINT MSI_OpenDatabaseW( LPCWSTR, LPCWSTR, MSIDATABASE ** );
355 extern UINT MSI_DatabaseOpenViewW(MSIDATABASE *, LPCWSTR, MSIQUERY ** );
356 extern UINT MSI_OpenQuery( MSIDATABASE *, MSIQUERY **, LPCWSTR, ... );
357 typedef UINT (*record_func)( MSIRECORD *, LPVOID );
358 extern UINT MSI_IterateRecords( MSIQUERY *, DWORD *, record_func, LPVOID );
359 extern MSIRECORD *MSI_QueryGetRecord( MSIDATABASE *db, LPCWSTR query, ... );
360 extern UINT MSI_DatabaseImport( MSIDATABASE *, LPCWSTR, LPCWSTR );
361 extern UINT MSI_DatabaseExport( MSIDATABASE *, LPCWSTR, LPCWSTR, LPCWSTR );
362 extern UINT MSI_DatabaseGetPrimaryKeys( MSIDATABASE *, LPCWSTR, MSIRECORD ** );
363
364 /* view internals */
365 extern UINT MSI_ViewExecute( MSIQUERY*, MSIRECORD * );
366 extern UINT MSI_ViewFetch( MSIQUERY*, MSIRECORD ** );
367 extern UINT MSI_ViewClose( MSIQUERY* );
368
369 /* package internals */
370 extern MSIPACKAGE *MSI_CreatePackage( MSIDATABASE * );
371 extern UINT MSI_OpenPackageW( LPCWSTR szPackage, MSIPACKAGE ** );
372 extern UINT MSI_SetTargetPathW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
373 extern UINT MSI_SetPropertyW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
374 extern INT MSI_ProcessMessage( MSIPACKAGE *, INSTALLMESSAGE, MSIRECORD * );
375 extern UINT MSI_GetPropertyW( MSIPACKAGE *, LPCWSTR, LPWSTR, DWORD * );
376 extern UINT MSI_GetPropertyA(MSIPACKAGE *, LPCSTR, LPSTR, DWORD* );
377 extern MSICONDITION MSI_EvaluateConditionW( MSIPACKAGE *, LPCWSTR );
378 extern UINT MSI_GetComponentStateW( MSIPACKAGE *, LPWSTR, INSTALLSTATE *, INSTALLSTATE * );
379 extern UINT MSI_GetFeatureStateW( MSIPACKAGE *, LPWSTR, INSTALLSTATE *, INSTALLSTATE * );
380 extern UINT WINAPI MSI_SetFeatureStateW(MSIPACKAGE*, LPCWSTR, INSTALLSTATE );
381
382 /* for deformating */
383 extern UINT MSI_FormatRecordW( MSIPACKAGE *, MSIRECORD *, LPWSTR, DWORD * );
384 extern UINT MSI_FormatRecordA( MSIPACKAGE *, MSIRECORD *, LPSTR, DWORD * );
385     
386 /* registry data encoding/decoding functions */
387 extern BOOL unsquash_guid(LPCWSTR in, LPWSTR out);
388 extern BOOL squash_guid(LPCWSTR in, LPWSTR out);
389 extern BOOL encode_base85_guid(GUID *,LPWSTR);
390 extern BOOL decode_base85_guid(LPCWSTR,GUID*);
391 extern UINT MSIREG_OpenUninstallKey(LPCWSTR szProduct, HKEY* key, BOOL create);
392 extern UINT MSIREG_OpenUserProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
393 extern UINT MSIREG_OpenFeatures(HKEY* key);
394 extern UINT MSIREG_OpenFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
395 extern UINT MSIREG_OpenComponents(HKEY* key);
396 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
397 extern UINT MSIREG_OpenComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
398 extern UINT MSIREG_OpenProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
399 extern UINT MSIREG_OpenUserFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
400 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
401 extern UINT MSIREG_OpenUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
402 extern UINT MSIREG_OpenUserUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
403
404 extern LONG msi_reg_set_val_str( HKEY hkey, LPCWSTR name, LPCWSTR value );
405 extern LONG msi_reg_set_val_multi_str( HKEY hkey, LPCWSTR name, LPCWSTR value );
406 extern LONG msi_reg_set_val_dword( HKEY hkey, LPCWSTR name, DWORD val );
407
408 /* msi dialog interface */
409 typedef UINT (*msi_dialog_event_handler)( MSIPACKAGE*, LPCWSTR, LPCWSTR, msi_dialog* );
410 extern msi_dialog *msi_dialog_create( MSIPACKAGE*, LPCWSTR, msi_dialog_event_handler );
411 extern UINT msi_dialog_run_message_loop( msi_dialog* );
412 extern void msi_dialog_end_dialog( msi_dialog* );
413 extern void msi_dialog_check_messages( HANDLE );
414 extern void msi_dialog_do_preview( msi_dialog* );
415 extern void msi_dialog_destroy( msi_dialog* );
416 extern BOOL msi_dialog_register_class( void );
417 extern void msi_dialog_unregister_class( void );
418 extern void msi_dialog_handle_event( msi_dialog*, LPCWSTR, LPCWSTR, MSIRECORD * );
419 extern UINT msi_dialog_reset( msi_dialog *dialog );
420
421 /* preview */
422 extern MSIPREVIEW *MSI_EnableUIPreview( MSIDATABASE * );
423 extern UINT MSI_PreviewDialogW( MSIPREVIEW *, LPCWSTR );
424
425 /* summary information */
426 extern MSISUMMARYINFO *MSI_GetSummaryInformationW( MSIDATABASE *db, UINT uiUpdateCount );
427 extern LPWSTR msi_suminfo_dup_string( MSISUMMARYINFO *si, UINT uiProperty );
428
429 /* undocumented functions */
430 UINT WINAPI MsiCreateAndVerifyInstallerDirectory( DWORD );
431 UINT WINAPI MsiDecomposeDescriptorW( LPCWSTR, LPWSTR, LPWSTR, LPWSTR, DWORD * );
432 UINT WINAPI MsiDecomposeDescriptorA( LPCSTR, LPSTR, LPSTR, LPSTR, DWORD * );
433 LANGID WINAPI MsiLoadStringW( MSIHANDLE, UINT, LPWSTR, int, LANGID );
434 LANGID WINAPI MsiLoadStringA( MSIHANDLE, UINT, LPSTR, int, LANGID );
435
436 /* UI globals */
437 extern INSTALLUILEVEL gUILevel;
438 extern HWND gUIhwnd;
439 extern INSTALLUI_HANDLERA gUIHandlerA;
440 extern INSTALLUI_HANDLERW gUIHandlerW;
441 extern DWORD gUIFilter;
442 extern LPVOID gUIContext;
443 extern WCHAR gszLogFile[MAX_PATH];
444
445 /* memory allocation macro functions */
446 static inline void *msi_alloc( size_t len )
447 {
448     return HeapAlloc( GetProcessHeap(), 0, len );
449 }
450
451 static inline void *msi_alloc_zero( size_t len )
452 {
453     return HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, len );
454 }
455
456 static inline void *msi_realloc( void *mem, size_t len )
457 {
458     return HeapReAlloc( GetProcessHeap(), 0, mem, len );
459 }
460
461 static inline void *msi_realloc_zero( void *mem, size_t len )
462 {
463     return HeapReAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, mem, len );
464 }
465
466 static inline BOOL msi_free( void *mem )
467 {
468     return HeapFree( GetProcessHeap(), 0, mem );
469 }
470
471 inline static char *strdupWtoA( LPCWSTR str )
472 {
473     LPSTR ret = NULL;
474     DWORD len;
475
476     if (!str) return ret;
477     len = WideCharToMultiByte( CP_ACP, 0, str, -1, NULL, 0, NULL, NULL);
478     ret = msi_alloc( len );
479     if (ret)
480         WideCharToMultiByte( CP_ACP, 0, str, -1, ret, len, NULL, NULL );
481     return ret;
482 }
483
484 inline static LPWSTR strdupAtoW( LPCSTR str )
485 {
486     LPWSTR ret = NULL;
487     DWORD len;
488
489     if (!str) return ret;
490     len = MultiByteToWideChar( CP_ACP, 0, str, -1, NULL, 0 );
491     ret = msi_alloc( len * sizeof(WCHAR) );
492     if (ret)
493         MultiByteToWideChar( CP_ACP, 0, str, -1, ret, len );
494     return ret;
495 }
496
497 inline static LPWSTR strdupW( LPCWSTR src )
498 {
499     LPWSTR dest;
500     if (!src) return NULL;
501     dest = msi_alloc( (lstrlenW(src)+1)*sizeof(WCHAR) );
502     if (dest)
503         lstrcpyW(dest, src);
504     return dest;
505 }
506
507 #endif /* __WINE_MSI_PRIVATE__ */