Relocate the msi file to prevent cd locking, corrected to properly not
[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_STRING   0x0800
38 #define MSITYPE_NULLABLE 0x1000
39 #define MSITYPE_KEY      0x2000
40
41 #define MSITYPE_BINARY 0x8900
42
43 struct tagMSITABLE;
44 typedef struct tagMSITABLE MSITABLE;
45
46 struct string_table;
47 typedef struct string_table string_table;
48
49 struct tagMSIOBJECTHDR;
50 typedef struct tagMSIOBJECTHDR MSIOBJECTHDR;
51
52 typedef VOID (*msihandledestructor)( MSIOBJECTHDR * );
53
54 struct tagMSIOBJECTHDR
55 {
56     UINT magic;
57     UINT type;
58     DWORD refcount;
59     msihandledestructor destructor;
60     struct tagMSIOBJECTHDR *next;
61     struct tagMSIOBJECTHDR *prev;
62 };
63
64 typedef struct tagMSIDATABASE
65 {
66     MSIOBJECTHDR hdr;
67     IStorage *storage;
68     string_table *strings;
69     LPCWSTR mode;
70     MSITABLE *first_table, *last_table;
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, blank row into the database
133      *  *row receives the number of the new row
134      */
135     UINT (*insert_row)( struct tagMSIVIEW *, UINT *row );
136
137     /*
138      * execute - loads the underlying data into memory so it can be read
139      */
140     UINT (*execute)( struct tagMSIVIEW *, MSIRECORD * );
141
142     /*
143      * close - clears the data read by execute from memory
144      */
145     UINT (*close)( struct tagMSIVIEW * );
146
147     /*
148      * get_dimensions - returns the number of rows or columns in a table.
149      *
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.
152      */
153     UINT (*get_dimensions)( struct tagMSIVIEW *, UINT *rows, UINT *cols );
154
155     /*
156      * get_column_info - returns the name and type of a specific column
157      *
158      *  The name is HeapAlloc'ed by this function and should be freed by
159      *   the caller.
160      *  The column information can be queried at any time.
161      */
162     UINT (*get_column_info)( struct tagMSIVIEW *, UINT n, LPWSTR *name, UINT *type );
163
164     /*
165      * modify - not yet implemented properly
166      */
167     UINT (*modify)( struct tagMSIVIEW *, MSIMODIFY, MSIRECORD * );
168
169     /*
170      * delete - destroys the structure completely
171      */
172     UINT (*delete)( struct tagMSIVIEW * );
173
174 } MSIVIEWOPS;
175
176 struct tagMSIVIEW
177 {
178     MSIOBJECTHDR hdr;
179     MSIVIEWOPS   *ops;
180 };
181
182 struct msi_dialog_tag;
183 typedef struct msi_dialog_tag msi_dialog;
184
185 typedef struct tagMSIPACKAGE
186 {
187     MSIOBJECTHDR hdr;
188     MSIDATABASE *db;
189     struct tagMSIFEATURE *features;
190     UINT loaded_features;
191     struct tagMSIFOLDER  *folders;
192     UINT loaded_folders;
193     struct tagMSICOMPONENT *components;
194     UINT loaded_components;
195     struct tagMSIFILE *files;
196     UINT loaded_files;
197     LPWSTR ActionFormat;
198     LPWSTR LastAction;
199
200     struct tagMSICLASS *classes;
201     UINT loaded_classes;
202     struct tagMSIEXTENSION *extensions;
203     UINT loaded_extensions;
204     struct tagMSIPROGID *progids;
205     UINT loaded_progids;
206     struct tagMSIVERB *verbs;
207     UINT loaded_verbs;
208     struct tagMSIMIME *mimes;
209     UINT loaded_mimes;
210     struct tagMSIAPPID *appids;
211     UINT loaded_appids;
212     
213     struct tagMSISCRIPT *script;
214
215     struct tagMSIRUNNINGACTION *RunningAction;
216     UINT RunningActionCount;
217
218     LPWSTR PackagePath;
219     LPWSTR msiFilePath;
220
221     UINT CurrentInstallState;
222     msi_dialog *dialog;
223     LPWSTR next_dialog;
224     
225     struct list subscriptions;
226 } MSIPACKAGE;
227
228 typedef struct tagMSIPREVIEW
229 {
230     MSIOBJECTHDR hdr;
231     MSIPACKAGE *package;
232     msi_dialog *dialog;
233 } MSIPREVIEW;
234
235 #define MSIHANDLETYPE_ANY 0
236 #define MSIHANDLETYPE_DATABASE 1
237 #define MSIHANDLETYPE_SUMMARYINFO 2
238 #define MSIHANDLETYPE_VIEW 3
239 #define MSIHANDLETYPE_RECORD 4
240 #define MSIHANDLETYPE_PACKAGE 5
241 #define MSIHANDLETYPE_PREVIEW 6
242
243 #define MSI_MAJORVERSION 2
244 #define MSI_MINORVERSION 0
245 #define MSI_BUILDNUMBER 2600
246
247 #define GUID_SIZE 39
248
249 #define MSIHANDLE_MAGIC 0x4d434923
250 #define MSIMAXHANDLES 0xf0
251
252 #define MSISUMINFO_OFFSET 0x30LL
253
254 DEFINE_GUID(CLSID_IMsiServer,   0x000C101C,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
255 DEFINE_GUID(CLSID_IMsiServerX1, 0x000C103E,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
256 DEFINE_GUID(CLSID_IMsiServerX2, 0x000C1090,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
257 DEFINE_GUID(CLSID_IMsiServerX3, 0x000C1094,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
258
259 DEFINE_GUID(CLSID_IMsiServerMessage, 0x000C101D,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
260
261
262 /* handle functions */
263 extern void *msihandle2msiinfo(MSIHANDLE handle, UINT type);
264 extern MSIHANDLE alloc_msihandle( MSIOBJECTHDR * );
265 extern void *alloc_msiobject(UINT type, UINT size, msihandledestructor destroy );
266 extern void msiobj_addref(MSIOBJECTHDR *);
267 extern int msiobj_release(MSIOBJECTHDR *);
268 extern void msiobj_lock(MSIOBJECTHDR *);
269 extern void msiobj_unlock(MSIOBJECTHDR *);
270 extern MSIHANDLE msiobj_findhandle( MSIOBJECTHDR *hdr );
271
272 /* add this table to the list of cached tables in the database */
273 extern void add_table(MSIDATABASE *db, MSITABLE *table);
274 extern void remove_table( MSIDATABASE *db, MSITABLE *table );
275 extern void free_table( MSIDATABASE *db, MSITABLE *table );
276 extern void free_cached_tables( MSIDATABASE *db );
277 extern UINT find_cached_table(MSIDATABASE *db, LPCWSTR name, MSITABLE **table);
278 extern UINT get_table(MSIDATABASE *db, LPCWSTR name, MSITABLE **table);
279 extern UINT load_string_table( MSIDATABASE *db );
280 extern UINT MSI_CommitTables( MSIDATABASE *db );
281 extern HRESULT init_string_table( IStorage *stg );
282
283
284 /* string table functions */
285 extern BOOL msi_addstring( string_table *st, int string_no, const CHAR *data, int len, UINT refcount );
286 extern BOOL msi_addstringW( string_table *st, int string_no, const WCHAR *data, int len, UINT refcount );
287 extern UINT msi_id2stringW( string_table *st, UINT string_no, LPWSTR buffer, UINT *sz );
288 extern UINT msi_id2stringA( string_table *st, UINT string_no, LPSTR buffer, UINT *sz );
289
290 extern LPWSTR MSI_makestring( MSIDATABASE *db, UINT stringid);
291 extern UINT msi_string2idW( string_table *st, LPCWSTR buffer, UINT *id );
292 extern UINT msi_string2idA( string_table *st, LPCSTR str, UINT *id );
293 extern string_table *msi_init_stringtable( int entries, UINT codepage );
294 extern VOID msi_destroy_stringtable( string_table *st );
295 extern UINT msi_string_count( string_table *st );
296 extern UINT msi_id_refcount( string_table *st, UINT i );
297 extern UINT msi_string_totalsize( string_table *st, UINT *last );
298 extern UINT msi_strcmp( string_table *st, UINT lval, UINT rval, UINT *res );
299 extern const WCHAR *msi_string_lookup_id( string_table *st, UINT id );
300 extern UINT msi_string_get_codepage( string_table *st );
301
302
303 extern UINT VIEW_find_column( MSIVIEW *view, LPCWSTR name, UINT *n );
304
305 extern BOOL TABLE_Exists( MSIDATABASE *db, LPWSTR name );
306
307 extern UINT read_raw_stream_data( MSIDATABASE*, LPCWSTR stname,
308                               USHORT **pdata, UINT *psz );
309
310 /* action internals */
311 extern UINT ACTION_DoTopLevelINSTALL( MSIPACKAGE *, LPCWSTR, LPCWSTR, LPCWSTR );
312 extern void ACTION_free_package_structures( MSIPACKAGE* );
313 extern UINT ACTION_DialogBox( MSIPACKAGE*, LPCWSTR);
314
315 /* record internals */
316 extern UINT MSI_RecordSetIStream( MSIRECORD *, unsigned int, IStream *);
317 extern UINT MSI_RecordGetIStream( MSIRECORD *, unsigned int, IStream **);
318 extern const WCHAR *MSI_RecordGetString( MSIRECORD *, unsigned int );
319 extern MSIRECORD *MSI_CreateRecord( unsigned int );
320 extern UINT MSI_RecordSetInteger( MSIRECORD *, unsigned int, int );
321 extern UINT MSI_RecordSetStringW( MSIRECORD *, unsigned int, LPCWSTR );
322 extern UINT MSI_RecordSetStringA( MSIRECORD *, unsigned int, LPCSTR );
323 extern BOOL MSI_RecordIsNull( MSIRECORD *, unsigned int );
324 extern UINT MSI_RecordGetStringW( MSIRECORD * , unsigned int, LPWSTR, DWORD *);
325 extern UINT MSI_RecordGetStringA( MSIRECORD *, unsigned int, LPSTR, DWORD *);
326 extern int MSI_RecordGetInteger( MSIRECORD *, unsigned int );
327 extern UINT MSI_RecordReadStream( MSIRECORD *, unsigned int, char *, DWORD *);
328 extern unsigned int MSI_RecordGetFieldCount( MSIRECORD *rec );
329 extern UINT MSI_RecordSetStreamW( MSIRECORD *, unsigned int, LPCWSTR );
330 extern UINT MSI_RecordSetStreamA( MSIRECORD *, unsigned int, LPCSTR );
331 extern UINT MSI_RecordDataSize( MSIRECORD *, unsigned int );
332 extern UINT MSI_RecordStreamToFile( MSIRECORD *, unsigned int, LPCWSTR );
333
334 /* stream internals */
335 extern UINT get_raw_stream( MSIHANDLE hdb, LPCWSTR stname, IStream **stm );
336 extern UINT db_get_raw_stream( MSIDATABASE *db, LPCWSTR stname, IStream **stm );
337 extern void enum_stream_names( IStorage *stg );
338
339 /* database internals */
340 extern UINT MSI_OpenDatabaseW( LPCWSTR, LPCWSTR, MSIDATABASE ** );
341 extern UINT MSI_DatabaseOpenViewW(MSIDATABASE *, LPCWSTR, MSIQUERY ** );
342 extern UINT MSI_OpenQuery( MSIDATABASE *, MSIQUERY **, LPCWSTR, ... );
343 typedef UINT (*record_func)( MSIRECORD *, LPVOID );
344 extern UINT MSI_IterateRecords( MSIQUERY *, DWORD *, record_func, LPVOID );
345 extern MSIRECORD *MSI_QueryGetRecord( MSIDATABASE *db, LPCWSTR query, ... );
346 extern UINT MSI_DatabaseImport( MSIDATABASE *, LPCWSTR, LPCWSTR );
347 extern UINT MSI_DatabaseExport( MSIDATABASE *, LPCWSTR, LPCWSTR, LPCWSTR );
348 extern UINT MSI_DatabaseGetPrimaryKeys( MSIDATABASE *, LPCWSTR, MSIRECORD ** );
349
350 /* view internals */
351 extern UINT MSI_ViewExecute( MSIQUERY*, MSIRECORD * );
352 extern UINT MSI_ViewFetch( MSIQUERY*, MSIRECORD ** );
353 extern UINT MSI_ViewClose( MSIQUERY* );
354
355 /* package internals */
356 extern MSIPACKAGE *MSI_CreatePackage( MSIDATABASE * );
357 extern UINT MSI_OpenPackageW( LPCWSTR szPackage, MSIPACKAGE ** );
358 extern UINT MSI_SetTargetPathW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
359 extern UINT MSI_SetPropertyW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
360 extern INT MSI_ProcessMessage( MSIPACKAGE *, INSTALLMESSAGE, MSIRECORD * );
361 extern UINT MSI_GetPropertyW( MSIPACKAGE *, LPCWSTR, LPWSTR, DWORD * );
362 extern UINT MSI_GetPropertyA(MSIPACKAGE *, LPCSTR, LPSTR, DWORD* );
363 extern MSICONDITION MSI_EvaluateConditionW( MSIPACKAGE *, LPCWSTR );
364 extern UINT MSI_SetPropertyW( MSIPACKAGE *, LPCWSTR, 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 );
368
369 /* for deformating */
370 extern UINT MSI_FormatRecordW( MSIPACKAGE *, MSIRECORD *, LPWSTR, DWORD * );
371 extern UINT MSI_FormatRecordA( MSIPACKAGE *, MSIRECORD *, LPSTR, DWORD * );
372     
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);
390
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 * );
402
403 /* preview */
404 extern MSIPREVIEW *MSI_EnableUIPreview( MSIDATABASE * );
405 extern UINT MSI_PreviewDialogW( MSIPREVIEW *, LPCWSTR );
406
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 );
413
414 HRESULT WINAPI MSI_DllGetClassObject( REFCLSID, REFIID, LPVOID * );
415 HRESULT WINAPI MSI_DllRegisterServer( void );
416 HRESULT WINAPI MSI_DllUnregisterServer( void );
417 BOOL WINAPI MSI_DllCanUnloadNow( void );
418
419 /* UI globals */
420 extern INSTALLUILEVEL gUILevel;
421 extern HWND gUIhwnd;
422 extern INSTALLUI_HANDLERA gUIHandlerA;
423 extern INSTALLUI_HANDLERW gUIHandlerW;
424 extern DWORD gUIFilter;
425 extern LPVOID gUIContext;
426 extern WCHAR gszLogFile[MAX_PATH];
427
428 inline static char *strdupWtoA( LPCWSTR str )
429 {
430     LPSTR ret = NULL;
431     if (str)
432     {
433         DWORD len = WideCharToMultiByte( CP_ACP, 0, str, -1, NULL, 0, NULL, NULL
434 );
435         if ((ret = HeapAlloc( GetProcessHeap(), 0, len )))
436             WideCharToMultiByte( CP_ACP, 0, str, -1, ret, len, NULL, NULL );
437     }
438     return ret;
439 }
440
441 inline static LPWSTR strdupAtoW( LPCSTR str )
442 {
443     LPWSTR ret = NULL;
444     if (str)
445     {
446         DWORD len = MultiByteToWideChar( CP_ACP, 0, str, -1, NULL, 0 );
447         if ((ret = HeapAlloc( GetProcessHeap(), 0, len * sizeof(WCHAR) )))
448             MultiByteToWideChar( CP_ACP, 0, str, -1, ret, len );
449     }
450     return ret;
451 }
452
453 inline static LPWSTR strdupW( LPCWSTR src )
454 {
455     LPWSTR dest;
456     if (!src) return NULL;
457     dest = HeapAlloc(GetProcessHeap(), 0, (lstrlenW(src)+1)*sizeof(WCHAR));
458     lstrcpyW(dest, src);
459     return dest;
460 }
461
462 #endif /* __WINE_MSI_PRIVATE__ */