msi: Search the patch package for source cabinet files.
[wine/dibdrv.git] / dlls / msi / msipriv.h
blobfa0c2251692e6d5edb655df7ae72e85a59b4abd8
1 /*
2 * Implementation of the Microsoft Installer (msi.dll)
4 * Copyright 2002-2005 Mike McCormack for CodeWeavers
5 * Copyright 2005 Aric Stewart for CodeWeavers
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
22 #ifndef __WINE_MSI_PRIVATE__
23 #define __WINE_MSI_PRIVATE__
25 #include <stdarg.h>
27 #include "windef.h"
28 #include "winbase.h"
29 #include "msi.h"
30 #include "msiquery.h"
31 #include "objbase.h"
32 #include "objidl.h"
33 #include "winnls.h"
34 #include "wine/list.h"
36 #define MSI_DATASIZEMASK 0x00ff
37 #define MSITYPE_VALID 0x0100
38 #define MSITYPE_LOCALIZABLE 0x200
39 #define MSITYPE_STRING 0x0800
40 #define MSITYPE_NULLABLE 0x1000
41 #define MSITYPE_KEY 0x2000
43 /* Word Count masks */
44 #define MSIWORDCOUNT_SHORTFILENAMES 0x0001
45 #define MSIWORDCOUNT_COMPRESSED 0x0002
46 #define MSIWORDCOUNT_ADMINISTRATIVE 0x0004
47 #define MSIWORDCOUNT_PRIVILEGES 0x0008
49 #define MSITYPE_IS_BINARY(type) (((type) & ~MSITYPE_NULLABLE) == (MSITYPE_STRING|MSITYPE_VALID))
51 struct tagMSITABLE;
52 typedef struct tagMSITABLE MSITABLE;
54 struct string_table;
55 typedef struct string_table string_table;
57 struct tagMSIOBJECTHDR;
58 typedef struct tagMSIOBJECTHDR MSIOBJECTHDR;
60 typedef VOID (*msihandledestructor)( MSIOBJECTHDR * );
62 struct tagMSIOBJECTHDR
64 UINT magic;
65 UINT type;
66 LONG refcount;
67 msihandledestructor destructor;
70 typedef struct tagMSIDATABASE
72 MSIOBJECTHDR hdr;
73 IStorage *storage;
74 string_table *strings;
75 LPWSTR path;
76 LPWSTR deletefile;
77 LPCWSTR mode;
78 struct list tables;
79 struct list transforms;
80 } MSIDATABASE;
82 typedef struct tagMSIVIEW MSIVIEW;
84 typedef struct tagMSIQUERY
86 MSIOBJECTHDR hdr;
87 MSIVIEW *view;
88 UINT row;
89 MSIDATABASE *db;
90 struct list mem;
91 } MSIQUERY;
93 /* maybe we can use a Variant instead of doing it ourselves? */
94 typedef struct tagMSIFIELD
96 UINT type;
97 union
99 INT iVal;
100 LPWSTR szwVal;
101 IStream *stream;
102 } u;
103 } MSIFIELD;
105 typedef struct tagMSIRECORD
107 MSIOBJECTHDR hdr;
108 UINT count; /* as passed to MsiCreateRecord */
109 MSIFIELD fields[1]; /* nb. array size is count+1 */
110 } MSIRECORD;
112 typedef void *MSIITERHANDLE;
114 typedef struct tagMSIVIEWOPS
117 * fetch_int - reads one integer from {row,col} in the table
119 * This function should be called after the execute method.
120 * Data returned by the function should not change until
121 * close or delete is called.
122 * To get a string value, query the database's string table with
123 * the integer value returned from this function.
125 UINT (*fetch_int)( struct tagMSIVIEW *, UINT row, UINT col, UINT *val );
128 * fetch_stream - gets a stream from {row,col} in the table
130 * This function is similar to fetch_int, except fetches a
131 * stream instead of an integer.
133 UINT (*fetch_stream)( struct tagMSIVIEW *, UINT row, UINT col, IStream **stm );
136 * set_row - sets values in a row as specified by mask
138 * Similar semantics to fetch_int
140 UINT (*set_row)( struct tagMSIVIEW *, UINT row, MSIRECORD *rec, UINT mask );
143 * Inserts a new row into the database from the records contents
145 UINT (*insert_row)( struct tagMSIVIEW *, MSIRECORD * );
148 * execute - loads the underlying data into memory so it can be read
150 UINT (*execute)( struct tagMSIVIEW *, MSIRECORD * );
153 * close - clears the data read by execute from memory
155 UINT (*close)( struct tagMSIVIEW * );
158 * get_dimensions - returns the number of rows or columns in a table.
160 * The number of rows can only be queried after the execute method
161 * is called. The number of columns can be queried at any time.
163 UINT (*get_dimensions)( struct tagMSIVIEW *, UINT *rows, UINT *cols );
166 * get_column_info - returns the name and type of a specific column
168 * The name is HeapAlloc'ed by this function and should be freed by
169 * the caller.
170 * The column information can be queried at any time.
172 UINT (*get_column_info)( struct tagMSIVIEW *, UINT n, LPWSTR *name, UINT *type );
175 * modify - not yet implemented properly
177 UINT (*modify)( struct tagMSIVIEW *, MSIMODIFY, MSIRECORD * );
180 * delete - destroys the structure completely
182 UINT (*delete)( struct tagMSIVIEW * );
185 * find_matching_rows - iterates through rows that match a value
187 * If the column type is a string then a string ID should be passed in.
188 * If the value to be looked up is an integer then no transformation of
189 * the input value is required, except if the column is a string, in which
190 * case a string ID should be passed in.
191 * The handle is an input/output parameter that keeps track of the current
192 * position in the iteration. It must be initialised to zero before the
193 * first call and continued to be passed in to subsequent calls.
195 UINT (*find_matching_rows)( struct tagMSIVIEW *, UINT col, UINT val, UINT *row, MSIITERHANDLE *handle );
196 } MSIVIEWOPS;
198 struct tagMSIVIEW
200 MSIOBJECTHDR hdr;
201 const MSIVIEWOPS *ops;
204 struct msi_dialog_tag;
205 typedef struct msi_dialog_tag msi_dialog;
207 #define PROPERTY_HASH_SIZE 67
209 typedef struct tagMSIPACKAGE
211 MSIOBJECTHDR hdr;
212 MSIDATABASE *db;
213 struct list components;
214 struct list features;
215 struct list files;
216 struct list tempfiles;
217 struct list folders;
218 LPWSTR ActionFormat;
219 LPWSTR LastAction;
221 struct list classes;
222 struct list extensions;
223 struct list progids;
224 struct list mimes;
225 struct list appids;
227 struct tagMSISCRIPT *script;
229 struct list RunningActions;
231 LPWSTR PackagePath;
232 LPWSTR ProductCode;
234 UINT CurrentInstallState;
235 msi_dialog *dialog;
236 LPWSTR next_dialog;
237 float center_x;
238 float center_y;
240 UINT WordCount;
242 struct list props[PROPERTY_HASH_SIZE];
244 struct list subscriptions;
245 } MSIPACKAGE;
247 typedef struct tagMSIPREVIEW
249 MSIOBJECTHDR hdr;
250 MSIPACKAGE *package;
251 msi_dialog *dialog;
252 } MSIPREVIEW;
254 #define MSI_MAX_PROPS 20
256 typedef struct tagMSISUMMARYINFO
258 MSIOBJECTHDR hdr;
259 IStorage *storage;
260 DWORD update_count;
261 PROPVARIANT property[MSI_MAX_PROPS];
262 } MSISUMMARYINFO;
264 typedef struct tagMSIFEATURE
266 struct list entry;
267 LPWSTR Feature;
268 LPWSTR Feature_Parent;
269 LPWSTR Title;
270 LPWSTR Description;
271 INT Display;
272 INT Level;
273 LPWSTR Directory;
274 INT Attributes;
275 INSTALLSTATE Installed;
276 INSTALLSTATE ActionRequest;
277 INSTALLSTATE Action;
278 struct list Children;
279 struct list Components;
280 INT Cost;
281 } MSIFEATURE;
283 typedef struct tagMSICOMPONENT
285 struct list entry;
286 DWORD magic;
287 LPWSTR Component;
288 LPWSTR ComponentId;
289 LPWSTR Directory;
290 INT Attributes;
291 LPWSTR Condition;
292 LPWSTR KeyPath;
293 INSTALLSTATE Installed;
294 INSTALLSTATE ActionRequest;
295 INSTALLSTATE Action;
296 BOOL ForceLocalState;
297 BOOL Enabled;
298 INT Cost;
299 INT RefCount;
300 LPWSTR FullKeypath;
301 LPWSTR AdvertiseString;
302 } MSICOMPONENT;
304 typedef struct tagComponentList
306 struct list entry;
307 MSICOMPONENT *component;
308 } ComponentList;
310 typedef struct tagFeatureList
312 struct list entry;
313 MSIFEATURE *feature;
314 } FeatureList;
316 typedef struct tagMSIFOLDER
318 struct list entry;
319 LPWSTR Directory;
320 LPWSTR TargetDefault;
321 LPWSTR SourceLongPath;
322 LPWSTR SourceShortPath;
324 LPWSTR ResolvedTarget;
325 LPWSTR ResolvedSource;
326 LPWSTR Property; /* initially set property */
327 struct tagMSIFOLDER *Parent;
328 INT State;
329 /* 0 = uninitialized */
330 /* 1 = existing */
331 /* 2 = created remove if empty */
332 /* 3 = created persist if empty */
333 INT Cost;
334 INT Space;
335 } MSIFOLDER;
337 typedef enum _msi_file_state {
338 msifs_invalid,
339 msifs_missing,
340 msifs_overwrite,
341 msifs_present,
342 msifs_installed,
343 msifs_skipped,
344 } msi_file_state;
346 typedef struct tagMSIFILE
348 struct list entry;
349 LPWSTR File;
350 MSICOMPONENT *Component;
351 LPWSTR FileName;
352 LPWSTR ShortName;
353 LPWSTR LongName;
354 INT FileSize;
355 LPWSTR Version;
356 LPWSTR Language;
357 INT Attributes;
358 INT Sequence;
359 msi_file_state state;
360 LPWSTR SourcePath;
361 LPWSTR TargetPath;
362 BOOL IsCompressed;
363 } MSIFILE;
365 typedef struct tagMSITEMPFILE
367 struct list entry;
368 LPWSTR File;
369 LPWSTR Path;
370 } MSITEMPFILE;
372 typedef struct tagMSIAPPID
374 struct list entry;
375 LPWSTR AppID; /* Primary key */
376 LPWSTR RemoteServerName;
377 LPWSTR LocalServer;
378 LPWSTR ServiceParameters;
379 LPWSTR DllSurrogate;
380 BOOL ActivateAtStorage;
381 BOOL RunAsInteractiveUser;
382 } MSIAPPID;
384 typedef struct tagMSIPROGID MSIPROGID;
386 typedef struct tagMSICLASS
388 struct list entry;
389 LPWSTR clsid; /* Primary Key */
390 LPWSTR Context; /* Primary Key */
391 MSICOMPONENT *Component;
392 MSIPROGID *ProgID;
393 LPWSTR ProgIDText;
394 LPWSTR Description;
395 MSIAPPID *AppID;
396 LPWSTR FileTypeMask;
397 LPWSTR IconPath;
398 LPWSTR DefInprocHandler;
399 LPWSTR DefInprocHandler32;
400 LPWSTR Argument;
401 MSIFEATURE *Feature;
402 INT Attributes;
403 /* not in the table, set during installation */
404 BOOL Installed;
405 } MSICLASS;
407 typedef struct tagMSIMIME MSIMIME;
409 typedef struct tagMSIEXTENSION
411 struct list entry;
412 LPWSTR Extension; /* Primary Key */
413 MSICOMPONENT *Component;
414 MSIPROGID *ProgID;
415 LPWSTR ProgIDText;
416 MSIMIME *Mime;
417 MSIFEATURE *Feature;
418 /* not in the table, set during installation */
419 BOOL Installed;
420 struct list verbs;
421 } MSIEXTENSION;
423 struct tagMSIPROGID
425 struct list entry;
426 LPWSTR ProgID; /* Primary Key */
427 MSIPROGID *Parent;
428 MSICLASS *Class;
429 LPWSTR Description;
430 LPWSTR IconPath;
431 /* not in the table, set during installation */
432 BOOL InstallMe;
433 MSIPROGID *CurVer;
434 MSIPROGID *VersionInd;
437 typedef struct tagMSIVERB
439 struct list entry;
440 LPWSTR Verb;
441 INT Sequence;
442 LPWSTR Command;
443 LPWSTR Argument;
444 } MSIVERB;
446 struct tagMSIMIME
448 struct list entry;
449 LPWSTR ContentType; /* Primary Key */
450 MSIEXTENSION *Extension;
451 LPWSTR clsid;
452 MSICLASS *Class;
453 /* not in the table, set during installation */
454 BOOL InstallMe;
457 enum SCRIPTS {
458 INSTALL_SCRIPT = 0,
459 COMMIT_SCRIPT = 1,
460 ROLLBACK_SCRIPT = 2,
461 TOTAL_SCRIPTS = 3
464 #define SEQUENCE_UI 0x1
465 #define SEQUENCE_EXEC 0x2
466 #define SEQUENCE_INSTALL 0x10
468 typedef struct tagMSISCRIPT
470 LPWSTR *Actions[TOTAL_SCRIPTS];
471 UINT ActionCount[TOTAL_SCRIPTS];
472 BOOL ExecuteSequenceRun;
473 BOOL CurrentlyScripting;
474 UINT InWhatSequence;
475 LPWSTR *UniqueActions;
476 UINT UniqueActionsCount;
477 } MSISCRIPT;
479 #define MSIHANDLETYPE_ANY 0
480 #define MSIHANDLETYPE_DATABASE 1
481 #define MSIHANDLETYPE_SUMMARYINFO 2
482 #define MSIHANDLETYPE_VIEW 3
483 #define MSIHANDLETYPE_RECORD 4
484 #define MSIHANDLETYPE_PACKAGE 5
485 #define MSIHANDLETYPE_PREVIEW 6
487 #define MSI_MAJORVERSION 3
488 #define MSI_MINORVERSION 1
489 #define MSI_BUILDNUMBER 4000
491 #define GUID_SIZE 39
493 #define MSIHANDLE_MAGIC 0x4d434923
495 DEFINE_GUID(CLSID_IMsiServer, 0x000C101C,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
496 DEFINE_GUID(CLSID_IMsiServerX1, 0x000C103E,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
497 DEFINE_GUID(CLSID_IMsiServerX2, 0x000C1090,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
498 DEFINE_GUID(CLSID_IMsiServerX3, 0x000C1094,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
500 DEFINE_GUID(CLSID_IMsiServerMessage, 0x000C101D,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
502 /* handle unicode/ascii output in the Msi* API functions */
503 typedef struct {
504 BOOL unicode;
505 union {
506 LPSTR a;
507 LPWSTR w;
508 } str;
509 } awstring;
511 typedef struct {
512 BOOL unicode;
513 union {
514 LPCSTR a;
515 LPCWSTR w;
516 } str;
517 } awcstring;
519 UINT msi_strcpy_to_awstring( LPCWSTR str, awstring *awbuf, DWORD *sz );
521 /* handle functions */
522 extern void *msihandle2msiinfo(MSIHANDLE handle, UINT type);
523 extern MSIHANDLE alloc_msihandle( MSIOBJECTHDR * );
524 extern void *alloc_msiobject(UINT type, UINT size, msihandledestructor destroy );
525 extern void msiobj_addref(MSIOBJECTHDR *);
526 extern int msiobj_release(MSIOBJECTHDR *);
527 extern void msiobj_lock(MSIOBJECTHDR *);
528 extern void msiobj_unlock(MSIOBJECTHDR *);
529 extern void msi_free_handle_table(void);
531 extern void free_cached_tables( MSIDATABASE *db );
532 extern void msi_free_transforms( MSIDATABASE *db );
533 extern string_table *load_string_table( IStorage *stg );
534 extern UINT MSI_CommitTables( MSIDATABASE *db );
535 extern HRESULT init_string_table( IStorage *stg );
538 /* string table functions */
539 extern BOOL msi_addstring( string_table *st, UINT string_no, const CHAR *data, int len, UINT refcount );
540 extern BOOL msi_addstringW( string_table *st, UINT string_no, const WCHAR *data, int len, UINT refcount );
541 extern UINT msi_id2stringW( string_table *st, UINT string_no, LPWSTR buffer, UINT *sz );
542 extern UINT msi_id2stringA( string_table *st, UINT string_no, LPSTR buffer, UINT *sz );
544 extern UINT msi_string2idW( string_table *st, LPCWSTR buffer, UINT *id );
545 extern UINT msi_string2idA( string_table *st, LPCSTR str, UINT *id );
546 extern string_table *msi_init_stringtable( int entries, UINT codepage );
547 extern VOID msi_destroy_stringtable( string_table *st );
548 extern UINT msi_string_count( string_table *st );
549 extern UINT msi_id_refcount( string_table *st, UINT i );
550 extern UINT msi_string_totalsize( string_table *st, UINT *datasize, UINT *poolsize );
551 extern UINT msi_strcmp( string_table *st, UINT lval, UINT rval, UINT *res );
552 extern const WCHAR *msi_string_lookup_id( string_table *st, UINT id );
553 extern UINT msi_string_get_codepage( string_table *st );
556 extern BOOL TABLE_Exists( MSIDATABASE *db, LPWSTR name );
557 extern MSICONDITION MSI_DatabaseIsTablePersistent( MSIDATABASE *db, LPCWSTR table );
559 extern UINT read_raw_stream_data( MSIDATABASE*, LPCWSTR stname,
560 USHORT **pdata, UINT *psz );
562 /* transform functions */
563 extern UINT msi_table_apply_transform( MSIDATABASE *db, IStorage *stg );
564 extern UINT MSI_DatabaseApplyTransformW( MSIDATABASE *db,
565 LPCWSTR szTransformFile, int iErrorCond );
566 extern void append_storage_to_db( MSIDATABASE *db, IStorage *stg );
568 /* action internals */
569 extern UINT MSI_InstallPackage( MSIPACKAGE *, LPCWSTR, LPCWSTR );
570 extern void ACTION_free_package_structures( MSIPACKAGE* );
571 extern UINT ACTION_DialogBox( MSIPACKAGE*, LPCWSTR);
572 extern UINT MSI_Sequence( MSIPACKAGE *package, LPCWSTR szTable, INT iSequenceMode );
573 extern UINT MSI_SetFeatureStates( MSIPACKAGE *package );
575 /* record internals */
576 extern UINT MSI_RecordSetIStream( MSIRECORD *, unsigned int, IStream *);
577 extern UINT MSI_RecordGetIStream( MSIRECORD *, unsigned int, IStream **);
578 extern const WCHAR *MSI_RecordGetString( MSIRECORD *, unsigned int );
579 extern MSIRECORD *MSI_CreateRecord( unsigned int );
580 extern UINT MSI_RecordSetInteger( MSIRECORD *, unsigned int, int );
581 extern UINT MSI_RecordSetStringW( MSIRECORD *, unsigned int, LPCWSTR );
582 extern UINT MSI_RecordSetStringA( MSIRECORD *, unsigned int, LPCSTR );
583 extern BOOL MSI_RecordIsNull( MSIRECORD *, unsigned int );
584 extern UINT MSI_RecordGetStringW( MSIRECORD * , unsigned int, LPWSTR, DWORD *);
585 extern UINT MSI_RecordGetStringA( MSIRECORD *, unsigned int, LPSTR, DWORD *);
586 extern int MSI_RecordGetInteger( MSIRECORD *, unsigned int );
587 extern UINT MSI_RecordReadStream( MSIRECORD *, unsigned int, char *, DWORD *);
588 extern unsigned int MSI_RecordGetFieldCount( MSIRECORD *rec );
589 extern UINT MSI_RecordSetStreamW( MSIRECORD *, unsigned int, LPCWSTR );
590 extern UINT MSI_RecordSetStreamA( MSIRECORD *, unsigned int, LPCSTR );
591 extern UINT MSI_RecordDataSize( MSIRECORD *, unsigned int );
592 extern UINT MSI_RecordStreamToFile( MSIRECORD *, unsigned int, LPCWSTR );
593 extern UINT MSI_RecordCopyField( MSIRECORD *, unsigned int, MSIRECORD *, unsigned int );
595 /* stream internals */
596 extern UINT get_raw_stream( MSIHANDLE hdb, LPCWSTR stname, IStream **stm );
597 extern UINT db_get_raw_stream( MSIDATABASE *db, LPCWSTR stname, IStream **stm );
598 extern void enum_stream_names( IStorage *stg );
600 /* database internals */
601 extern UINT MSI_OpenDatabaseW( LPCWSTR, LPCWSTR, MSIDATABASE ** );
602 extern UINT MSI_DatabaseOpenViewW(MSIDATABASE *, LPCWSTR, MSIQUERY ** );
603 extern UINT MSI_OpenQuery( MSIDATABASE *, MSIQUERY **, LPCWSTR, ... );
604 typedef UINT (*record_func)( MSIRECORD *, LPVOID );
605 extern UINT MSI_IterateRecords( MSIQUERY *, DWORD *, record_func, LPVOID );
606 extern MSIRECORD *MSI_QueryGetRecord( MSIDATABASE *db, LPCWSTR query, ... );
607 extern UINT MSI_DatabaseImport( MSIDATABASE *, LPCWSTR, LPCWSTR );
608 extern UINT MSI_DatabaseExport( MSIDATABASE *, LPCWSTR, LPCWSTR, LPCWSTR );
609 extern UINT MSI_DatabaseGetPrimaryKeys( MSIDATABASE *, LPCWSTR, MSIRECORD ** );
611 /* view internals */
612 extern UINT MSI_ViewExecute( MSIQUERY*, MSIRECORD * );
613 extern UINT MSI_ViewFetch( MSIQUERY*, MSIRECORD ** );
614 extern UINT MSI_ViewClose( MSIQUERY* );
615 extern UINT MSI_ViewGetColumnInfo(MSIQUERY *, MSICOLINFO, MSIRECORD **);
616 extern UINT VIEW_find_column( MSIVIEW *, LPCWSTR, UINT * );
619 /* install internals */
620 extern UINT MSI_SetInstallLevel( MSIPACKAGE *package, int iInstallLevel );
622 /* package internals */
623 extern MSIPACKAGE *MSI_CreatePackage( MSIDATABASE * );
624 extern UINT MSI_OpenPackageW( LPCWSTR szPackage, MSIPACKAGE ** );
625 extern UINT MSI_SetTargetPathW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
626 extern UINT MSI_SetPropertyW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
627 extern INT MSI_ProcessMessage( MSIPACKAGE *, INSTALLMESSAGE, MSIRECORD * );
628 extern UINT MSI_GetPropertyW( MSIPACKAGE *, LPCWSTR, LPWSTR, DWORD * );
629 extern UINT MSI_GetPropertyA(MSIPACKAGE *, LPCSTR, LPSTR, DWORD* );
630 extern MSICONDITION MSI_EvaluateConditionW( MSIPACKAGE *, LPCWSTR );
631 extern UINT MSI_GetComponentStateW( MSIPACKAGE *, LPCWSTR, INSTALLSTATE *, INSTALLSTATE * );
632 extern UINT MSI_GetFeatureStateW( MSIPACKAGE *, LPCWSTR, INSTALLSTATE *, INSTALLSTATE * );
633 extern UINT WINAPI MSI_SetFeatureStateW(MSIPACKAGE*, LPCWSTR, INSTALLSTATE );
634 extern LPCWSTR msi_download_file( LPCWSTR szUrl, LPWSTR filename );
636 /* for deformating */
637 extern UINT MSI_FormatRecordW( MSIPACKAGE *, MSIRECORD *, LPWSTR, DWORD * );
638 extern UINT MSI_FormatRecordA( MSIPACKAGE *, MSIRECORD *, LPSTR, DWORD * );
640 /* registry data encoding/decoding functions */
641 extern BOOL unsquash_guid(LPCWSTR in, LPWSTR out);
642 extern BOOL squash_guid(LPCWSTR in, LPWSTR out);
643 extern BOOL encode_base85_guid(GUID *,LPWSTR);
644 extern BOOL decode_base85_guid(LPCWSTR,GUID*);
645 extern UINT MSIREG_OpenUninstallKey(LPCWSTR szProduct, HKEY* key, BOOL create);
646 extern UINT MSIREG_OpenUserProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
647 extern UINT MSIREG_OpenFeatures(HKEY* key);
648 extern UINT MSIREG_OpenFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
649 extern UINT MSIREG_OpenComponents(HKEY* key);
650 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
651 extern UINT MSIREG_OpenComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
652 extern UINT MSIREG_OpenProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
653 extern UINT MSIREG_OpenUserFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
654 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
655 extern UINT MSIREG_OpenUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
656 extern UINT MSIREG_OpenUserUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
658 extern LPWSTR msi_reg_get_val_str( HKEY hkey, LPCWSTR name );
659 extern BOOL msi_reg_get_val_dword( HKEY hkey, LPCWSTR name, DWORD *val);
661 extern DWORD msi_version_str_to_dword(LPCWSTR p);
662 extern LPWSTR msi_version_dword_to_str(DWORD version);
664 extern LONG msi_reg_set_val_str( HKEY hkey, LPCWSTR name, LPCWSTR value );
665 extern LONG msi_reg_set_val_multi_str( HKEY hkey, LPCWSTR name, LPCWSTR value );
666 extern LONG msi_reg_set_val_dword( HKEY hkey, LPCWSTR name, DWORD val );
667 extern LONG msi_reg_set_subkey_val( HKEY hkey, LPCWSTR path, LPCWSTR name, LPCWSTR val );
669 /* msi dialog interface */
670 typedef UINT (*msi_dialog_event_handler)( MSIPACKAGE*, LPCWSTR, LPCWSTR, msi_dialog* );
671 extern msi_dialog *msi_dialog_create( MSIPACKAGE*, LPCWSTR, msi_dialog*, msi_dialog_event_handler );
672 extern UINT msi_dialog_run_message_loop( msi_dialog* );
673 extern void msi_dialog_end_dialog( msi_dialog* );
674 extern void msi_dialog_check_messages( HANDLE );
675 extern void msi_dialog_do_preview( msi_dialog* );
676 extern void msi_dialog_destroy( msi_dialog* );
677 extern BOOL msi_dialog_register_class( void );
678 extern void msi_dialog_unregister_class( void );
679 extern void msi_dialog_handle_event( msi_dialog*, LPCWSTR, LPCWSTR, MSIRECORD * );
680 extern UINT msi_dialog_reset( msi_dialog *dialog );
681 extern UINT msi_dialog_directorylist_up( msi_dialog *dialog );
682 extern msi_dialog *msi_dialog_get_parent( msi_dialog *dialog );
683 extern LPWSTR msi_dialog_get_name( msi_dialog *dialog );
684 extern UINT msi_spawn_error_dialog( MSIPACKAGE*, LPWSTR, LPWSTR );
686 /* preview */
687 extern MSIPREVIEW *MSI_EnableUIPreview( MSIDATABASE * );
688 extern UINT MSI_PreviewDialogW( MSIPREVIEW *, LPCWSTR );
690 /* summary information */
691 extern MSISUMMARYINFO *MSI_GetSummaryInformationW( IStorage *stg, UINT uiUpdateCount );
692 extern LPWSTR msi_suminfo_dup_string( MSISUMMARYINFO *si, UINT uiProperty );
693 extern LPWSTR msi_get_suminfo_product( IStorage *stg );
695 /* undocumented functions */
696 UINT WINAPI MsiCreateAndVerifyInstallerDirectory( DWORD );
697 UINT WINAPI MsiDecomposeDescriptorW( LPCWSTR, LPWSTR, LPWSTR, LPWSTR, DWORD * );
698 UINT WINAPI MsiDecomposeDescriptorA( LPCSTR, LPSTR, LPSTR, LPSTR, DWORD * );
699 LANGID WINAPI MsiLoadStringW( MSIHANDLE, UINT, LPWSTR, int, LANGID );
700 LANGID WINAPI MsiLoadStringA( MSIHANDLE, UINT, LPSTR, int, LANGID );
702 /* UI globals */
703 extern INSTALLUILEVEL gUILevel;
704 extern HWND gUIhwnd;
705 extern INSTALLUI_HANDLERA gUIHandlerA;
706 extern INSTALLUI_HANDLERW gUIHandlerW;
707 extern DWORD gUIFilter;
708 extern LPVOID gUIContext;
709 extern WCHAR gszLogFile[MAX_PATH];
710 extern HINSTANCE msi_hInstance;
712 /* action related functions */
713 extern UINT ACTION_PerformAction(MSIPACKAGE *package, const WCHAR *action, BOOL force);
714 extern UINT ACTION_PerformUIAction(MSIPACKAGE *package, const WCHAR *action);
715 extern void ACTION_FinishCustomActions( MSIPACKAGE* package);
716 extern UINT ACTION_CustomAction(MSIPACKAGE *package,const WCHAR *action, BOOL execute);
718 static inline void msi_feature_set_state( MSIFEATURE *feature, INSTALLSTATE state )
720 feature->ActionRequest = state;
721 feature->Action = state;
724 static inline void msi_component_set_state( MSICOMPONENT *comp, INSTALLSTATE state )
726 comp->ActionRequest = state;
727 comp->Action = state;
730 /* actions in other modules */
731 extern UINT ACTION_AppSearch(MSIPACKAGE *package);
732 extern UINT ACTION_FindRelatedProducts(MSIPACKAGE *package);
733 extern UINT ACTION_InstallFiles(MSIPACKAGE *package);
734 extern UINT ACTION_RemoveFiles(MSIPACKAGE *package);
735 extern UINT ACTION_DuplicateFiles(MSIPACKAGE *package);
736 extern UINT ACTION_RegisterClassInfo(MSIPACKAGE *package);
737 extern UINT ACTION_RegisterProgIdInfo(MSIPACKAGE *package);
738 extern UINT ACTION_RegisterExtensionInfo(MSIPACKAGE *package);
739 extern UINT ACTION_RegisterMIMEInfo(MSIPACKAGE *package);
740 extern UINT ACTION_RegisterFonts(MSIPACKAGE *package);
742 /* Helpers */
743 extern DWORD deformat_string(MSIPACKAGE *package, LPCWSTR ptr, WCHAR** data );
744 extern LPWSTR msi_dup_record_field(MSIRECORD *row, INT index);
745 extern LPWSTR msi_dup_property(MSIPACKAGE *package, LPCWSTR prop);
746 extern int msi_get_property_int( MSIPACKAGE *package, LPCWSTR prop, int def );
747 extern LPWSTR resolve_folder(MSIPACKAGE *package, LPCWSTR name, BOOL source,
748 BOOL set_prop, MSIFOLDER **folder);
749 extern MSICOMPONENT *get_loaded_component( MSIPACKAGE* package, LPCWSTR Component );
750 extern MSIFEATURE *get_loaded_feature( MSIPACKAGE* package, LPCWSTR Feature );
751 extern MSIFILE *get_loaded_file( MSIPACKAGE* package, LPCWSTR file );
752 extern MSIFOLDER *get_loaded_folder( MSIPACKAGE *package, LPCWSTR dir );
753 extern int track_tempfile(MSIPACKAGE *package, LPCWSTR name, LPCWSTR path);
754 extern UINT schedule_action(MSIPACKAGE *package, UINT script, LPCWSTR action);
755 extern LPWSTR build_icon_path(MSIPACKAGE *, LPCWSTR);
756 extern LPWSTR build_directory_name(DWORD , ...);
757 extern BOOL create_full_pathW(const WCHAR *path);
758 extern BOOL ACTION_VerifyComponentForAction(MSICOMPONENT*, INSTALLSTATE);
759 extern BOOL ACTION_VerifyFeatureForAction(MSIFEATURE*, INSTALLSTATE);
760 extern void reduce_to_longfilename(WCHAR*);
761 extern void reduce_to_shortfilename(WCHAR*);
762 extern LPWSTR create_component_advertise_string(MSIPACKAGE*, MSICOMPONENT*, LPCWSTR);
763 extern void ACTION_UpdateComponentStates(MSIPACKAGE *package, LPCWSTR szFeature);
764 extern UINT register_unique_action(MSIPACKAGE *, LPCWSTR);
765 extern BOOL check_unique_action(MSIPACKAGE *, LPCWSTR);
766 extern WCHAR* generate_error_string(MSIPACKAGE *, UINT, DWORD, ... );
767 extern UINT msi_create_component_directories( MSIPACKAGE *package );
768 extern void msi_ui_error( DWORD msg_id, DWORD type );
770 /* control event stuff */
771 extern VOID ControlEvent_FireSubscribedEvent(MSIPACKAGE *package, LPCWSTR event,
772 MSIRECORD *data);
773 extern VOID ControlEvent_CleanupSubscriptions(MSIPACKAGE *package);
774 extern VOID ControlEvent_SubscribeToEvent(MSIPACKAGE *package, msi_dialog *dialog,
775 LPCWSTR event, LPCWSTR control, LPCWSTR attribute);
776 extern VOID ControlEvent_UnSubscribeToEvent( MSIPACKAGE *package, LPCWSTR event,
777 LPCWSTR control, LPCWSTR attribute );
779 /* User Interface messages from the actions */
780 extern void ui_progress(MSIPACKAGE *, int, int, int, int);
781 extern void ui_actiondata(MSIPACKAGE *, LPCWSTR, MSIRECORD *);
783 /* string consts use a number of places and defined in helpers.c*/
784 extern const WCHAR cszSourceDir[];
785 extern const WCHAR cszSOURCEDIR[];
786 extern const WCHAR szProductCode[];
787 extern const WCHAR cszRootDrive[];
788 extern const WCHAR cszbs[];
790 /* memory allocation macro functions */
791 static inline void *msi_alloc( size_t len )
793 return HeapAlloc( GetProcessHeap(), 0, len );
796 static inline void *msi_alloc_zero( size_t len )
798 return HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, len );
801 static inline void *msi_realloc( void *mem, size_t len )
803 return HeapReAlloc( GetProcessHeap(), 0, mem, len );
806 static inline void *msi_realloc_zero( void *mem, size_t len )
808 return HeapReAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, mem, len );
811 static inline BOOL msi_free( void *mem )
813 return HeapFree( GetProcessHeap(), 0, mem );
816 inline static char *strdupWtoA( LPCWSTR str )
818 LPSTR ret = NULL;
819 DWORD len;
821 if (!str) return ret;
822 len = WideCharToMultiByte( CP_ACP, 0, str, -1, NULL, 0, NULL, NULL);
823 ret = msi_alloc( len );
824 if (ret)
825 WideCharToMultiByte( CP_ACP, 0, str, -1, ret, len, NULL, NULL );
826 return ret;
829 inline static LPWSTR strdupAtoW( LPCSTR str )
831 LPWSTR ret = NULL;
832 DWORD len;
834 if (!str) return ret;
835 len = MultiByteToWideChar( CP_ACP, 0, str, -1, NULL, 0 );
836 ret = msi_alloc( len * sizeof(WCHAR) );
837 if (ret)
838 MultiByteToWideChar( CP_ACP, 0, str, -1, ret, len );
839 return ret;
842 inline static LPWSTR strdupW( LPCWSTR src )
844 LPWSTR dest;
845 if (!src) return NULL;
846 dest = msi_alloc( (lstrlenW(src)+1)*sizeof(WCHAR) );
847 if (dest)
848 lstrcpyW(dest, src);
849 return dest;
852 #endif /* __WINE_MSI_PRIVATE__ */