notepad: Rename the SIZEOF macro to the more descriptive ARRAY_SIZE.
[wine.git] / dlls / msi / msipriv.h
blob8c4bd3a4515f4a9efbb5307c81b6c51e73521982
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 "fdi.h"
30 #include "msi.h"
31 #include "msiquery.h"
32 #include "objbase.h"
33 #include "objidl.h"
34 #include "winnls.h"
35 #include "wine/list.h"
36 #include "wine/debug.h"
38 #define MSI_DATASIZEMASK 0x00ff
39 #define MSITYPE_VALID 0x0100
40 #define MSITYPE_LOCALIZABLE 0x200
41 #define MSITYPE_STRING 0x0800
42 #define MSITYPE_NULLABLE 0x1000
43 #define MSITYPE_KEY 0x2000
44 #define MSITYPE_TEMPORARY 0x4000
47 /* Install UI level mask for AND operation to exclude flags */
48 #define INSTALLUILEVEL_MASK 0x0007
50 #define MSITYPE_IS_BINARY(type) (((type) & ~MSITYPE_NULLABLE) == (MSITYPE_STRING|MSITYPE_VALID))
52 struct tagMSITABLE;
53 typedef struct tagMSITABLE MSITABLE;
55 struct string_table;
56 typedef struct string_table string_table;
58 struct tagMSIOBJECTHDR;
59 typedef struct tagMSIOBJECTHDR MSIOBJECTHDR;
61 typedef VOID (*msihandledestructor)( MSIOBJECTHDR * );
63 struct tagMSIOBJECTHDR
65 UINT magic;
66 UINT type;
67 LONG refcount;
68 msihandledestructor destructor;
71 typedef struct tagMSIDATABASE
73 MSIOBJECTHDR hdr;
74 IStorage *storage;
75 string_table *strings;
76 UINT bytes_per_strref;
77 LPWSTR path;
78 LPWSTR deletefile;
79 LPCWSTR mode;
80 struct list tables;
81 struct list transforms;
82 } MSIDATABASE;
84 typedef struct tagMSIVIEW MSIVIEW;
86 typedef struct tagMSIQUERY
88 MSIOBJECTHDR hdr;
89 MSIVIEW *view;
90 UINT row;
91 MSIDATABASE *db;
92 struct list mem;
93 } MSIQUERY;
95 /* maybe we can use a Variant instead of doing it ourselves? */
96 typedef struct tagMSIFIELD
98 UINT type;
99 union
101 INT iVal;
102 LPWSTR szwVal;
103 IStream *stream;
104 } u;
105 } MSIFIELD;
107 typedef struct tagMSIRECORD
109 MSIOBJECTHDR hdr;
110 UINT count; /* as passed to MsiCreateRecord */
111 MSIFIELD fields[1]; /* nb. array size is count+1 */
112 } MSIRECORD;
114 typedef struct tagMSISOURCELISTINFO
116 struct list entry;
117 DWORD context;
118 DWORD options;
119 LPCWSTR property;
120 LPWSTR value;
121 } MSISOURCELISTINFO;
123 typedef struct tagMSIMEDIADISK
125 struct list entry;
126 DWORD context;
127 DWORD options;
128 DWORD disk_id;
129 LPWSTR volume_label;
130 LPWSTR disk_prompt;
131 } MSIMEDIADISK;
133 typedef struct tagMSIMEDIAINFO
135 UINT disk_id;
136 UINT type;
137 UINT last_sequence;
138 LPWSTR disk_prompt;
139 LPWSTR cabinet;
140 LPWSTR first_volume;
141 LPWSTR volume_label;
142 BOOL is_continuous;
143 BOOL is_extracted;
144 WCHAR source[MAX_PATH];
145 } MSIMEDIAINFO;
147 typedef struct tagMSIPATCHINFO
149 LPWSTR patchcode;
150 LPWSTR transforms;
151 } MSIPATCHINFO;
153 typedef struct _column_info
155 LPCWSTR table;
156 LPCWSTR column;
157 INT type;
158 BOOL temporary;
159 struct expr *val;
160 struct _column_info *next;
161 } column_info;
163 typedef const struct tagMSICOLUMNHASHENTRY *MSIITERHANDLE;
165 typedef struct tagMSIVIEWOPS
168 * fetch_int - reads one integer from {row,col} in the table
170 * This function should be called after the execute method.
171 * Data returned by the function should not change until
172 * close or delete is called.
173 * To get a string value, query the database's string table with
174 * the integer value returned from this function.
176 UINT (*fetch_int)( struct tagMSIVIEW *view, UINT row, UINT col, UINT *val );
179 * fetch_stream - gets a stream from {row,col} in the table
181 * This function is similar to fetch_int, except fetches a
182 * stream instead of an integer.
184 UINT (*fetch_stream)( struct tagMSIVIEW *view, UINT row, UINT col, IStream **stm );
187 * get_row - gets values from a row
190 UINT (*get_row)( struct tagMSIVIEW *view, UINT row, MSIRECORD **rec );
193 * set_row - sets values in a row as specified by mask
195 * Similar semantics to fetch_int
197 UINT (*set_row)( struct tagMSIVIEW *view, UINT row, MSIRECORD *rec, UINT mask );
200 * Inserts a new row into the database from the records contents
202 UINT (*insert_row)( struct tagMSIVIEW *view, MSIRECORD *record, UINT row, BOOL temporary );
205 * Deletes a row from the database
207 UINT (*delete_row)( struct tagMSIVIEW *view, UINT row );
210 * execute - loads the underlying data into memory so it can be read
212 UINT (*execute)( struct tagMSIVIEW *view, MSIRECORD *record );
215 * close - clears the data read by execute from memory
217 UINT (*close)( struct tagMSIVIEW *view );
220 * get_dimensions - returns the number of rows or columns in a table.
222 * The number of rows can only be queried after the execute method
223 * is called. The number of columns can be queried at any time.
225 UINT (*get_dimensions)( struct tagMSIVIEW *view, UINT *rows, UINT *cols );
228 * get_column_info - returns the name and type of a specific column
230 * The name is HeapAlloc'ed by this function and should be freed by
231 * the caller.
232 * The column information can be queried at any time.
234 UINT (*get_column_info)( struct tagMSIVIEW *view, UINT n, LPWSTR *name, UINT *type, BOOL *temporary );
237 * modify - not yet implemented properly
239 UINT (*modify)( struct tagMSIVIEW *view, MSIMODIFY eModifyMode, MSIRECORD *record, UINT row );
242 * delete - destroys the structure completely
244 UINT (*delete)( struct tagMSIVIEW * );
247 * find_matching_rows - iterates through rows that match a value
249 * If the column type is a string then a string ID should be passed in.
250 * If the value to be looked up is an integer then no transformation of
251 * the input value is required, except if the column is a string, in which
252 * case a string ID should be passed in.
253 * The handle is an input/output parameter that keeps track of the current
254 * position in the iteration. It must be initialised to zero before the
255 * first call and continued to be passed in to subsequent calls.
257 UINT (*find_matching_rows)( struct tagMSIVIEW *view, UINT col, UINT val, UINT *row, MSIITERHANDLE *handle );
260 * add_ref - increases the reference count of the table
262 UINT (*add_ref)( struct tagMSIVIEW *view );
265 * release - decreases the reference count of the table
267 UINT (*release)( struct tagMSIVIEW *view );
270 * add_column - adds a column to the table
272 UINT (*add_column)( struct tagMSIVIEW *view, LPCWSTR table, UINT number, LPCWSTR column, UINT type, BOOL hold );
275 * remove_column - removes the column represented by table name and column number from the table
277 UINT (*remove_column)( struct tagMSIVIEW *view, LPCWSTR table, UINT number );
280 * sort - orders the table by columns
282 UINT (*sort)( struct tagMSIVIEW *view, column_info *columns );
285 * drop - drops the table from the database
287 UINT (*drop)( struct tagMSIVIEW *view );
288 } MSIVIEWOPS;
290 struct tagMSIVIEW
292 MSIOBJECTHDR hdr;
293 const MSIVIEWOPS *ops;
296 struct msi_dialog_tag;
297 typedef struct msi_dialog_tag msi_dialog;
299 typedef struct tagMSIPACKAGE
301 MSIOBJECTHDR hdr;
302 MSIDATABASE *db;
303 MSIPATCHINFO *patch;
304 struct list components;
305 struct list features;
306 struct list files;
307 struct list tempfiles;
308 struct list folders;
309 LPWSTR ActionFormat;
310 LPWSTR LastAction;
312 struct list classes;
313 struct list extensions;
314 struct list progids;
315 struct list mimes;
316 struct list appids;
318 struct tagMSISCRIPT *script;
320 struct list RunningActions;
322 LPWSTR BaseURL;
323 LPWSTR PackagePath;
324 LPWSTR ProductCode;
326 UINT CurrentInstallState;
327 msi_dialog *dialog;
328 LPWSTR next_dialog;
329 float center_x;
330 float center_y;
332 UINT WordCount;
333 UINT Context;
335 struct list subscriptions;
337 struct list sourcelist_info;
338 struct list sourcelist_media;
340 unsigned char scheduled_action_running : 1;
341 unsigned char commit_action_running : 1;
342 unsigned char rollback_action_running : 1;
343 } MSIPACKAGE;
345 typedef struct tagMSIPREVIEW
347 MSIOBJECTHDR hdr;
348 MSIPACKAGE *package;
349 msi_dialog *dialog;
350 } MSIPREVIEW;
352 #define MSI_MAX_PROPS 20
354 typedef struct tagMSISUMMARYINFO
356 MSIOBJECTHDR hdr;
357 IStorage *storage;
358 DWORD update_count;
359 PROPVARIANT property[MSI_MAX_PROPS];
360 } MSISUMMARYINFO;
362 typedef struct tagMSIFEATURE
364 struct list entry;
365 LPWSTR Feature;
366 LPWSTR Feature_Parent;
367 LPWSTR Title;
368 LPWSTR Description;
369 INT Display;
370 INT Level;
371 LPWSTR Directory;
372 INT Attributes;
373 INSTALLSTATE Installed;
374 INSTALLSTATE ActionRequest;
375 INSTALLSTATE Action;
376 struct list Children;
377 struct list Components;
378 INT Cost;
379 } MSIFEATURE;
381 typedef struct tagMSICOMPONENT
383 struct list entry;
384 DWORD magic;
385 LPWSTR Component;
386 LPWSTR ComponentId;
387 LPWSTR Directory;
388 INT Attributes;
389 LPWSTR Condition;
390 LPWSTR KeyPath;
391 INSTALLSTATE Installed;
392 INSTALLSTATE ActionRequest;
393 INSTALLSTATE Action;
394 BOOL ForceLocalState;
395 BOOL Enabled;
396 INT Cost;
397 INT RefCount;
398 LPWSTR FullKeypath;
399 LPWSTR AdvertiseString;
401 unsigned int anyAbsent:1;
402 unsigned int hasAdvertiseFeature:1;
403 unsigned int hasLocalFeature:1;
404 unsigned int hasSourceFeature:1;
405 } MSICOMPONENT;
407 typedef struct tagComponentList
409 struct list entry;
410 MSICOMPONENT *component;
411 } ComponentList;
413 typedef struct tagFeatureList
415 struct list entry;
416 MSIFEATURE *feature;
417 } FeatureList;
419 typedef struct tagMSIFOLDER
421 struct list entry;
422 LPWSTR Directory;
423 LPWSTR Parent;
424 LPWSTR TargetDefault;
425 LPWSTR SourceLongPath;
426 LPWSTR SourceShortPath;
428 LPWSTR ResolvedTarget;
429 LPWSTR ResolvedSource;
430 LPWSTR Property; /* initially set property */
431 INT State;
432 /* 0 = uninitialized */
433 /* 1 = existing */
434 /* 2 = created remove if empty */
435 /* 3 = created persist if empty */
436 INT Cost;
437 INT Space;
438 } MSIFOLDER;
440 typedef enum _msi_file_state {
441 msifs_invalid,
442 msifs_missing,
443 msifs_overwrite,
444 msifs_present,
445 msifs_installed,
446 msifs_skipped,
447 } msi_file_state;
449 typedef struct tagMSIFILE
451 struct list entry;
452 LPWSTR File;
453 MSICOMPONENT *Component;
454 LPWSTR FileName;
455 LPWSTR ShortName;
456 LPWSTR LongName;
457 INT FileSize;
458 LPWSTR Version;
459 LPWSTR Language;
460 INT Attributes;
461 INT Sequence;
462 msi_file_state state;
463 LPWSTR TargetPath;
464 BOOL IsCompressed;
465 MSIFILEHASHINFO hash;
466 } MSIFILE;
468 typedef struct tagMSITEMPFILE
470 struct list entry;
471 LPWSTR Path;
472 } MSITEMPFILE;
474 typedef struct tagMSIAPPID
476 struct list entry;
477 LPWSTR AppID; /* Primary key */
478 LPWSTR RemoteServerName;
479 LPWSTR LocalServer;
480 LPWSTR ServiceParameters;
481 LPWSTR DllSurrogate;
482 BOOL ActivateAtStorage;
483 BOOL RunAsInteractiveUser;
484 } MSIAPPID;
486 typedef struct tagMSIPROGID MSIPROGID;
488 typedef struct tagMSICLASS
490 struct list entry;
491 LPWSTR clsid; /* Primary Key */
492 LPWSTR Context; /* Primary Key */
493 MSICOMPONENT *Component;
494 MSIPROGID *ProgID;
495 LPWSTR ProgIDText;
496 LPWSTR Description;
497 MSIAPPID *AppID;
498 LPWSTR FileTypeMask;
499 LPWSTR IconPath;
500 LPWSTR DefInprocHandler;
501 LPWSTR DefInprocHandler32;
502 LPWSTR Argument;
503 MSIFEATURE *Feature;
504 INT Attributes;
505 /* not in the table, set during installation */
506 BOOL Installed;
507 } MSICLASS;
509 typedef struct tagMSIMIME MSIMIME;
511 typedef struct tagMSIEXTENSION
513 struct list entry;
514 LPWSTR Extension; /* Primary Key */
515 MSICOMPONENT *Component;
516 MSIPROGID *ProgID;
517 LPWSTR ProgIDText;
518 MSIMIME *Mime;
519 MSIFEATURE *Feature;
520 /* not in the table, set during installation */
521 BOOL Installed;
522 struct list verbs;
523 } MSIEXTENSION;
525 struct tagMSIPROGID
527 struct list entry;
528 LPWSTR ProgID; /* Primary Key */
529 MSIPROGID *Parent;
530 MSICLASS *Class;
531 LPWSTR Description;
532 LPWSTR IconPath;
533 /* not in the table, set during installation */
534 BOOL InstallMe;
535 MSIPROGID *CurVer;
536 MSIPROGID *VersionInd;
539 typedef struct tagMSIVERB
541 struct list entry;
542 LPWSTR Verb;
543 INT Sequence;
544 LPWSTR Command;
545 LPWSTR Argument;
546 } MSIVERB;
548 struct tagMSIMIME
550 struct list entry;
551 LPWSTR ContentType; /* Primary Key */
552 MSIEXTENSION *Extension;
553 LPWSTR clsid;
554 MSICLASS *Class;
555 /* not in the table, set during installation */
556 BOOL InstallMe;
559 enum SCRIPTS {
560 INSTALL_SCRIPT = 0,
561 COMMIT_SCRIPT = 1,
562 ROLLBACK_SCRIPT = 2,
563 TOTAL_SCRIPTS = 3
566 #define SEQUENCE_UI 0x1
567 #define SEQUENCE_EXEC 0x2
568 #define SEQUENCE_INSTALL 0x10
570 typedef struct tagMSISCRIPT
572 LPWSTR *Actions[TOTAL_SCRIPTS];
573 UINT ActionCount[TOTAL_SCRIPTS];
574 BOOL ExecuteSequenceRun;
575 BOOL CurrentlyScripting;
576 UINT InWhatSequence;
577 LPWSTR *UniqueActions;
578 UINT UniqueActionsCount;
579 } MSISCRIPT;
581 #define MSIHANDLETYPE_ANY 0
582 #define MSIHANDLETYPE_DATABASE 1
583 #define MSIHANDLETYPE_SUMMARYINFO 2
584 #define MSIHANDLETYPE_VIEW 3
585 #define MSIHANDLETYPE_RECORD 4
586 #define MSIHANDLETYPE_PACKAGE 5
587 #define MSIHANDLETYPE_PREVIEW 6
589 #define MSI_MAJORVERSION 3
590 #define MSI_MINORVERSION 1
591 #define MSI_BUILDNUMBER 4000
593 #define GUID_SIZE 39
594 #define SQUISH_GUID_SIZE 33
596 #define MSIHANDLE_MAGIC 0x4d434923
598 DEFINE_GUID(CLSID_IMsiServer, 0x000C101C,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
599 DEFINE_GUID(CLSID_IMsiServerX1, 0x000C103E,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
600 DEFINE_GUID(CLSID_IMsiServerX2, 0x000C1090,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
601 DEFINE_GUID(CLSID_IMsiServerX3, 0x000C1094,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
603 DEFINE_GUID(CLSID_IMsiServerMessage, 0x000C101D,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
605 DEFINE_GUID(CLSID_IWineMsiRemoteCustomAction,0xBA26E6FA,0x4F27,0x4f56,0x95,0x3A,0x3F,0x90,0x27,0x20,0x18,0xAA);
606 DEFINE_GUID(CLSID_IWineMsiRemotePackage,0x902b3592,0x9d08,0x4dfd,0xa5,0x93,0xd0,0x7c,0x52,0x54,0x64,0x21);
608 /* handle unicode/ascii output in the Msi* API functions */
609 typedef struct {
610 BOOL unicode;
611 union {
612 LPSTR a;
613 LPWSTR w;
614 } str;
615 } awstring;
617 typedef struct {
618 BOOL unicode;
619 union {
620 LPCSTR a;
621 LPCWSTR w;
622 } str;
623 } awcstring;
625 UINT msi_strcpy_to_awstring( LPCWSTR str, awstring *awbuf, DWORD *sz );
627 /* msi server interface */
628 extern ITypeLib *get_msi_typelib( LPWSTR *path );
629 extern HRESULT create_msi_custom_remote( IUnknown *pOuter, LPVOID *ppObj );
630 extern HRESULT create_msi_remote_package( IUnknown *pOuter, LPVOID *ppObj );
631 extern HRESULT create_msi_remote_database( IUnknown *pOuter, LPVOID *ppObj );
632 extern IUnknown *msi_get_remote(MSIHANDLE handle);
634 /* handle functions */
635 extern void *msihandle2msiinfo(MSIHANDLE handle, UINT type);
636 extern MSIHANDLE alloc_msihandle( MSIOBJECTHDR * );
637 extern MSIHANDLE alloc_msi_remote_handle( IUnknown *unk );
638 extern void *alloc_msiobject(UINT type, UINT size, msihandledestructor destroy );
639 extern void msiobj_addref(MSIOBJECTHDR *);
640 extern int msiobj_release(MSIOBJECTHDR *);
641 extern void msiobj_lock(MSIOBJECTHDR *);
642 extern void msiobj_unlock(MSIOBJECTHDR *);
643 extern void msi_free_handle_table(void);
645 extern void free_cached_tables( MSIDATABASE *db );
646 extern void msi_free_transforms( MSIDATABASE *db );
647 extern UINT MSI_CommitTables( MSIDATABASE *db );
650 /* string table functions */
651 enum StringPersistence
653 StringPersistent = 0,
654 StringNonPersistent = 1
657 extern BOOL msi_addstringW( string_table *st, UINT string_no, const WCHAR *data, int len, UINT refcount, enum StringPersistence persistence );
659 extern UINT msi_string2idW( const string_table *st, LPCWSTR buffer, UINT *id );
660 extern VOID msi_destroy_stringtable( string_table *st );
661 extern const WCHAR *msi_string_lookup_id( const string_table *st, UINT id );
662 extern HRESULT msi_init_string_table( IStorage *stg );
663 extern string_table *msi_load_string_table( IStorage *stg, UINT *bytes_per_strref );
664 extern UINT msi_save_string_table( const string_table *st, IStorage *storage );
666 extern BOOL TABLE_Exists( MSIDATABASE *db, LPCWSTR name );
667 extern MSICONDITION MSI_DatabaseIsTablePersistent( MSIDATABASE *db, LPCWSTR table );
669 extern UINT read_raw_stream_data( MSIDATABASE *db, LPCWSTR stname,
670 USHORT **pdata, UINT *psz );
671 extern UINT read_stream_data( IStorage *stg, LPCWSTR stname, BOOL table,
672 BYTE **pdata, UINT *psz );
673 extern UINT write_stream_data( IStorage *stg, LPCWSTR stname,
674 LPCVOID data, UINT sz, BOOL bTable );
676 /* transform functions */
677 extern UINT msi_table_apply_transform( MSIDATABASE *db, IStorage *stg );
678 extern UINT MSI_DatabaseApplyTransformW( MSIDATABASE *db,
679 LPCWSTR szTransformFile, int iErrorCond );
680 extern void append_storage_to_db( MSIDATABASE *db, IStorage *stg );
682 /* action internals */
683 extern UINT MSI_InstallPackage( MSIPACKAGE *, LPCWSTR, LPCWSTR );
684 extern void ACTION_free_package_structures( MSIPACKAGE* );
685 extern UINT ACTION_DialogBox( MSIPACKAGE*, LPCWSTR);
686 extern UINT ACTION_ForceReboot(MSIPACKAGE *package);
687 extern UINT MSI_Sequence( MSIPACKAGE *package, LPCWSTR szTable, INT iSequenceMode );
688 extern UINT MSI_SetFeatureStates( MSIPACKAGE *package );
689 extern UINT msi_parse_command_line( MSIPACKAGE *package, LPCWSTR szCommandLine,
690 BOOL preserve_case );
692 /* record internals */
693 extern UINT MSI_RecordSetIStream( MSIRECORD *, UINT, IStream *);
694 extern UINT MSI_RecordGetIStream( MSIRECORD *, UINT, IStream **);
695 extern const WCHAR *MSI_RecordGetString( const MSIRECORD *, UINT );
696 extern MSIRECORD *MSI_CreateRecord( UINT );
697 extern UINT MSI_RecordSetInteger( MSIRECORD *, UINT, int );
698 extern UINT MSI_RecordSetStringW( MSIRECORD *, UINT, LPCWSTR );
699 extern BOOL MSI_RecordIsNull( MSIRECORD *, UINT );
700 extern UINT MSI_RecordGetStringW( MSIRECORD * , UINT, LPWSTR, LPDWORD);
701 extern UINT MSI_RecordGetStringA( MSIRECORD *, UINT, LPSTR, LPDWORD);
702 extern int MSI_RecordGetInteger( MSIRECORD *, UINT );
703 extern UINT MSI_RecordReadStream( MSIRECORD *, UINT, char *, LPDWORD);
704 extern UINT MSI_RecordSetStream(MSIRECORD *, UINT, IStream *);
705 extern UINT MSI_RecordGetFieldCount( const MSIRECORD *rec );
706 extern UINT MSI_RecordStreamToFile( MSIRECORD *, UINT, LPCWSTR );
707 extern UINT MSI_RecordSetStreamFromFileW( MSIRECORD *, UINT, LPCWSTR );
708 extern UINT MSI_RecordCopyField( MSIRECORD *, UINT, MSIRECORD *, UINT );
709 extern MSIRECORD *MSI_CloneRecord( MSIRECORD * );
710 extern BOOL MSI_RecordsAreEqual( MSIRECORD *, MSIRECORD * );
712 /* stream internals */
713 extern UINT get_raw_stream( MSIHANDLE hdb, LPCWSTR stname, IStream **stm );
714 extern void enum_stream_names( IStorage *stg );
715 extern BOOL decode_streamname(LPCWSTR in, LPWSTR out);
717 /* database internals */
718 extern UINT MSI_OpenDatabaseW( LPCWSTR, LPCWSTR, MSIDATABASE ** );
719 extern UINT MSI_DatabaseOpenViewW(MSIDATABASE *, LPCWSTR, MSIQUERY ** );
720 extern UINT MSI_OpenQuery( MSIDATABASE *, MSIQUERY **, LPCWSTR, ... );
721 typedef UINT (*record_func)( MSIRECORD *, LPVOID );
722 extern UINT MSI_IterateRecords( MSIQUERY *, LPDWORD, record_func, LPVOID );
723 extern MSIRECORD *MSI_QueryGetRecord( MSIDATABASE *db, LPCWSTR query, ... );
724 extern UINT MSI_DatabaseGetPrimaryKeys( MSIDATABASE *, LPCWSTR, MSIRECORD ** );
726 /* view internals */
727 extern UINT MSI_ViewExecute( MSIQUERY*, MSIRECORD * );
728 extern UINT MSI_ViewFetch( MSIQUERY*, MSIRECORD ** );
729 extern UINT MSI_ViewClose( MSIQUERY* );
730 extern UINT MSI_ViewGetColumnInfo(MSIQUERY *, MSICOLINFO, MSIRECORD **);
731 extern UINT MSI_ViewModify( MSIQUERY *, MSIMODIFY, MSIRECORD * );
732 extern UINT VIEW_find_column( MSIVIEW *, LPCWSTR, UINT * );
733 extern UINT msi_view_get_row(MSIDATABASE *, MSIVIEW *, UINT, MSIRECORD **);
735 /* install internals */
736 extern UINT MSI_SetInstallLevel( MSIPACKAGE *package, int iInstallLevel );
738 /* package internals */
739 extern MSIPACKAGE *MSI_CreatePackage( MSIDATABASE *, LPCWSTR );
740 extern UINT MSI_OpenPackageW( LPCWSTR szPackage, MSIPACKAGE **pPackage );
741 extern UINT MSI_SetTargetPathW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
742 extern UINT MSI_SetPropertyW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
743 extern INT MSI_ProcessMessage( MSIPACKAGE *, INSTALLMESSAGE, MSIRECORD * );
744 extern UINT MSI_GetPropertyW( MSIPACKAGE *, LPCWSTR, LPWSTR, LPDWORD );
745 extern UINT MSI_GetPropertyA(MSIPACKAGE *, LPCSTR, LPSTR, LPDWORD );
746 extern MSICONDITION MSI_EvaluateConditionW( MSIPACKAGE *, LPCWSTR );
747 extern UINT MSI_GetComponentStateW( MSIPACKAGE *, LPCWSTR, INSTALLSTATE *, INSTALLSTATE * );
748 extern UINT MSI_GetFeatureStateW( MSIPACKAGE *, LPCWSTR, INSTALLSTATE *, INSTALLSTATE * );
749 extern UINT WINAPI MSI_SetFeatureStateW(MSIPACKAGE*, LPCWSTR, INSTALLSTATE );
750 extern LPCWSTR msi_download_file( LPCWSTR szUrl, LPWSTR filename );
751 extern UINT msi_package_add_info(MSIPACKAGE *, DWORD, DWORD, LPCWSTR, LPWSTR);
752 extern UINT msi_package_add_media_disk(MSIPACKAGE *, DWORD, DWORD, DWORD, LPWSTR, LPWSTR);
753 extern UINT msi_clone_properties(MSIPACKAGE *);
755 /* for deformating */
756 extern UINT MSI_FormatRecordW( MSIPACKAGE *, MSIRECORD *, LPWSTR, LPDWORD );
758 /* registry data encoding/decoding functions */
759 extern BOOL unsquash_guid(LPCWSTR in, LPWSTR out);
760 extern BOOL squash_guid(LPCWSTR in, LPWSTR out);
761 extern BOOL encode_base85_guid(GUID *,LPWSTR);
762 extern BOOL decode_base85_guid(LPCWSTR,GUID*);
763 extern UINT MSIREG_OpenUninstallKey(LPCWSTR szProduct, HKEY* key, BOOL create);
764 extern UINT MSIREG_DeleteUninstallKey(LPCWSTR szProduct);
765 extern UINT MSIREG_OpenProductKey(LPCWSTR szProduct, LPCWSTR szUserSid,
766 MSIINSTALLCONTEXT context, HKEY* key, BOOL create);
767 extern UINT MSIREG_OpenFeaturesKey(LPCWSTR szProduct, MSIINSTALLCONTEXT context,
768 HKEY *key, BOOL create);
769 extern UINT MSIREG_OpenUserPatchesKey(LPCWSTR szPatch, HKEY* key, BOOL create);
770 UINT MSIREG_OpenUserDataFeaturesKey(LPCWSTR szProduct, MSIINSTALLCONTEXT context,
771 HKEY *key, BOOL create);
772 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
773 extern UINT MSIREG_OpenUserDataComponentKey(LPCWSTR szComponent, LPCWSTR szUserSid,
774 HKEY *key, BOOL create);
775 extern UINT MSIREG_OpenPatchesKey(LPCWSTR szPatch, HKEY* key, BOOL create);
776 extern UINT MSIREG_OpenUserDataProductKey(LPCWSTR szProduct, MSIINSTALLCONTEXT dwContext,
777 LPCWSTR szUserSid, HKEY *key, BOOL create);
778 extern UINT MSIREG_OpenUserDataPatchKey(LPCWSTR szPatch, MSIINSTALLCONTEXT dwContext,
779 HKEY *key, BOOL create);
780 extern UINT MSIREG_OpenInstallProps(LPCWSTR szProduct, MSIINSTALLCONTEXT dwContext,
781 LPCWSTR szUserSid, HKEY *key, BOOL create);
782 extern UINT MSIREG_OpenUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
783 extern UINT MSIREG_OpenUserUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
784 extern UINT MSIREG_DeleteProductKey(LPCWSTR szProduct);
785 extern UINT MSIREG_DeleteUserProductKey(LPCWSTR szProduct);
786 extern UINT MSIREG_DeleteUserDataProductKey(LPCWSTR szProduct);
787 extern UINT MSIREG_DeleteUserFeaturesKey(LPCWSTR szProduct);
788 extern UINT MSIREG_DeleteUserDataComponentKey(LPCWSTR szComponent, LPCWSTR szUserSid);
789 extern UINT MSIREG_DeleteUserUpgradeCodesKey(LPCWSTR szUpgradeCode);
790 extern UINT MSIREG_OpenClassesUpgradeCodesKey(LPCWSTR szUpgradeCode, HKEY* key, BOOL create);
791 extern UINT MSIREG_DeleteLocalClassesProductKey(LPCWSTR szProductCode);
792 extern UINT MSIREG_DeleteLocalClassesFeaturesKey(LPCWSTR szProductCode);
794 extern LPWSTR msi_reg_get_val_str( HKEY hkey, LPCWSTR name );
795 extern BOOL msi_reg_get_val_dword( HKEY hkey, LPCWSTR name, DWORD *val);
797 extern DWORD msi_version_str_to_dword(LPCWSTR p);
799 extern LONG msi_reg_set_val_str( HKEY hkey, LPCWSTR name, LPCWSTR value );
800 extern LONG msi_reg_set_val_multi_str( HKEY hkey, LPCWSTR name, LPCWSTR value );
801 extern LONG msi_reg_set_val_dword( HKEY hkey, LPCWSTR name, DWORD val );
802 extern LONG msi_reg_set_subkey_val( HKEY hkey, LPCWSTR path, LPCWSTR name, LPCWSTR val );
804 /* msi dialog interface */
805 typedef UINT (*msi_dialog_event_handler)( MSIPACKAGE*, LPCWSTR, LPCWSTR, msi_dialog* );
806 extern msi_dialog *msi_dialog_create( MSIPACKAGE*, LPCWSTR, msi_dialog*, msi_dialog_event_handler );
807 extern UINT msi_dialog_run_message_loop( msi_dialog* );
808 extern void msi_dialog_end_dialog( msi_dialog* );
809 extern void msi_dialog_check_messages( HANDLE );
810 extern void msi_dialog_do_preview( msi_dialog* );
811 extern void msi_dialog_destroy( msi_dialog* );
812 extern void msi_dialog_unregister_class( void );
813 extern void msi_dialog_handle_event( msi_dialog*, LPCWSTR, LPCWSTR, MSIRECORD * );
814 extern UINT msi_dialog_reset( msi_dialog *dialog );
815 extern UINT msi_dialog_directorylist_up( msi_dialog *dialog );
816 extern msi_dialog *msi_dialog_get_parent( msi_dialog *dialog );
817 extern LPWSTR msi_dialog_get_name( msi_dialog *dialog );
818 extern UINT msi_spawn_error_dialog( MSIPACKAGE*, LPWSTR, LPWSTR );
820 /* summary information */
821 extern MSISUMMARYINFO *MSI_GetSummaryInformationW( IStorage *stg, UINT uiUpdateCount );
822 extern LPWSTR msi_suminfo_dup_string( MSISUMMARYINFO *si, UINT uiProperty );
823 extern LPWSTR msi_get_suminfo_product( IStorage *stg );
824 extern UINT msi_add_suminfo( MSIDATABASE *db, LPWSTR **records, int num_records, int num_columns );
826 /* undocumented functions */
827 UINT WINAPI MsiCreateAndVerifyInstallerDirectory( DWORD );
828 UINT WINAPI MsiDecomposeDescriptorW( LPCWSTR, LPWSTR, LPWSTR, LPWSTR, LPDWORD );
829 UINT WINAPI MsiDecomposeDescriptorA( LPCSTR, LPSTR, LPSTR, LPSTR, LPDWORD );
830 LANGID WINAPI MsiLoadStringW( MSIHANDLE, UINT, LPWSTR, int, LANGID );
831 LANGID WINAPI MsiLoadStringA( MSIHANDLE, UINT, LPSTR, int, LANGID );
833 /* UI globals */
834 extern INSTALLUILEVEL gUILevel;
835 extern HWND gUIhwnd;
836 extern INSTALLUI_HANDLERA gUIHandlerA;
837 extern INSTALLUI_HANDLERW gUIHandlerW;
838 extern DWORD gUIFilter;
839 extern LPVOID gUIContext;
840 extern WCHAR gszLogFile[MAX_PATH];
841 extern HINSTANCE msi_hInstance;
843 /* action related functions */
844 extern UINT ACTION_PerformAction(MSIPACKAGE *package, const WCHAR *action, UINT script, BOOL force);
845 extern UINT ACTION_PerformUIAction(MSIPACKAGE *package, const WCHAR *action, UINT script);
846 extern void ACTION_FinishCustomActions( const MSIPACKAGE* package);
847 extern UINT ACTION_CustomAction(MSIPACKAGE *package,const WCHAR *action, UINT script, BOOL execute);
849 static inline void msi_feature_set_state(MSIPACKAGE *package,
850 MSIFEATURE *feature,
851 INSTALLSTATE state)
853 if (!package->ProductCode)
855 feature->ActionRequest = state;
856 feature->Action = state;
858 else if (state == INSTALLSTATE_ABSENT)
860 switch (feature->Installed)
862 case INSTALLSTATE_ABSENT:
863 feature->ActionRequest = INSTALLSTATE_UNKNOWN;
864 feature->Action = INSTALLSTATE_UNKNOWN;
865 break;
866 default:
867 feature->ActionRequest = state;
868 feature->Action = state;
871 else if (state == INSTALLSTATE_SOURCE)
873 switch (feature->Installed)
875 case INSTALLSTATE_ABSENT:
876 case INSTALLSTATE_SOURCE:
877 feature->ActionRequest = state;
878 feature->Action = state;
879 break;
880 case INSTALLSTATE_LOCAL:
881 feature->ActionRequest = INSTALLSTATE_LOCAL;
882 feature->Action = INSTALLSTATE_LOCAL;
883 break;
884 default:
885 feature->ActionRequest = INSTALLSTATE_UNKNOWN;
886 feature->Action = INSTALLSTATE_UNKNOWN;
889 else
891 feature->ActionRequest = state;
892 feature->Action = state;
896 static inline void msi_component_set_state(MSIPACKAGE *package,
897 MSICOMPONENT *comp,
898 INSTALLSTATE state)
900 if (!package->ProductCode)
902 comp->ActionRequest = state;
903 comp->Action = state;
905 else if (state == INSTALLSTATE_ABSENT)
907 switch (comp->Installed)
909 case INSTALLSTATE_LOCAL:
910 case INSTALLSTATE_SOURCE:
911 case INSTALLSTATE_DEFAULT:
912 comp->ActionRequest = state;
913 comp->Action = state;
914 break;
915 default:
916 comp->ActionRequest = INSTALLSTATE_UNKNOWN;
917 comp->Action = INSTALLSTATE_UNKNOWN;
920 else if (state == INSTALLSTATE_SOURCE)
922 if (comp->Installed == INSTALLSTATE_ABSENT ||
923 (comp->Installed == INSTALLSTATE_SOURCE && comp->hasLocalFeature))
925 comp->ActionRequest = state;
926 comp->Action = state;
928 else
930 comp->ActionRequest = INSTALLSTATE_UNKNOWN;
931 comp->Action = INSTALLSTATE_UNKNOWN;
934 else
936 comp->ActionRequest = state;
937 comp->Action = state;
941 /* actions in other modules */
942 extern UINT ACTION_AppSearch(MSIPACKAGE *package);
943 extern UINT ACTION_CCPSearch(MSIPACKAGE *package);
944 extern UINT ACTION_FindRelatedProducts(MSIPACKAGE *package);
945 extern UINT ACTION_InstallFiles(MSIPACKAGE *package);
946 extern UINT ACTION_RemoveFiles(MSIPACKAGE *package);
947 extern UINT ACTION_DuplicateFiles(MSIPACKAGE *package);
948 extern UINT ACTION_RegisterClassInfo(MSIPACKAGE *package);
949 extern UINT ACTION_RegisterProgIdInfo(MSIPACKAGE *package);
950 extern UINT ACTION_RegisterExtensionInfo(MSIPACKAGE *package);
951 extern UINT ACTION_RegisterMIMEInfo(MSIPACKAGE *package);
952 extern UINT ACTION_RegisterFonts(MSIPACKAGE *package);
954 /* Helpers */
955 extern DWORD deformat_string(MSIPACKAGE *package, LPCWSTR ptr, WCHAR** data );
956 extern LPWSTR msi_dup_record_field(MSIRECORD *row, INT index);
957 extern LPWSTR msi_dup_property(MSIPACKAGE *package, LPCWSTR prop);
958 extern int msi_get_property_int( MSIPACKAGE *package, LPCWSTR prop, int def );
959 extern LPWSTR resolve_folder(MSIPACKAGE *package, LPCWSTR name, BOOL source,
960 BOOL set_prop, BOOL load_prop, MSIFOLDER **folder);
961 extern LPWSTR resolve_file_source(MSIPACKAGE *package, MSIFILE *file);
962 extern MSICOMPONENT *get_loaded_component( MSIPACKAGE* package, LPCWSTR Component );
963 extern MSIFEATURE *get_loaded_feature( MSIPACKAGE* package, LPCWSTR Feature );
964 extern MSIFILE *get_loaded_file( MSIPACKAGE* package, LPCWSTR file );
965 extern MSIFOLDER *get_loaded_folder( MSIPACKAGE *package, LPCWSTR dir );
966 extern void msi_reset_folders( MSIPACKAGE *package, BOOL source );
967 extern int track_tempfile(MSIPACKAGE *package, LPCWSTR path);
968 extern UINT schedule_action(MSIPACKAGE *package, UINT script, LPCWSTR action);
969 extern void msi_free_action_script(MSIPACKAGE *package, UINT script);
970 extern LPWSTR build_icon_path(MSIPACKAGE *, LPCWSTR);
971 extern LPWSTR build_directory_name(DWORD , ...);
972 extern BOOL create_full_pathW(const WCHAR *path);
973 extern BOOL ACTION_VerifyComponentForAction(const MSICOMPONENT*, INSTALLSTATE);
974 extern BOOL ACTION_VerifyFeatureForAction(const MSIFEATURE*, INSTALLSTATE);
975 extern void reduce_to_longfilename(WCHAR*);
976 extern LPWSTR create_component_advertise_string(MSIPACKAGE*, MSICOMPONENT*, LPCWSTR);
977 extern void ACTION_UpdateComponentStates(MSIPACKAGE *package, LPCWSTR szFeature);
978 extern UINT register_unique_action(MSIPACKAGE *, LPCWSTR);
979 extern BOOL check_unique_action(const MSIPACKAGE *, LPCWSTR);
980 extern WCHAR* generate_error_string(MSIPACKAGE *, UINT, DWORD, ... );
981 extern UINT msi_create_component_directories( MSIPACKAGE *package );
982 extern UINT msi_set_last_used_source(LPCWSTR product, LPCWSTR usersid,
983 MSIINSTALLCONTEXT context, DWORD options, LPCWSTR value);
985 /* media */
987 typedef BOOL (*PMSICABEXTRACTCB)(MSIPACKAGE *, LPCWSTR, DWORD, LPWSTR *, DWORD *, PVOID);
989 #define MSICABEXTRACT_BEGINEXTRACT 0x01
990 #define MSICABEXTRACT_FILEEXTRACTED 0x02
992 typedef struct
994 MSIPACKAGE* package;
995 MSIMEDIAINFO *mi;
996 PMSICABEXTRACTCB cb;
997 LPWSTR curfile;
998 PVOID user;
999 } MSICABDATA;
1001 extern UINT ready_media(MSIPACKAGE *package, MSIFILE *file, MSIMEDIAINFO *mi);
1002 extern void msi_free_media_info(MSIMEDIAINFO *mi);
1003 extern BOOL msi_cabextract(MSIPACKAGE* package, MSIMEDIAINFO *mi, LPVOID data);
1005 /* control event stuff */
1006 extern VOID ControlEvent_FireSubscribedEvent(MSIPACKAGE *package, LPCWSTR event,
1007 MSIRECORD *data);
1008 extern VOID ControlEvent_CleanupDialogSubscriptions(MSIPACKAGE *package, LPWSTR dialog);
1009 extern VOID ControlEvent_CleanupSubscriptions(MSIPACKAGE *package);
1010 extern VOID ControlEvent_SubscribeToEvent(MSIPACKAGE *package, msi_dialog *dialog,
1011 LPCWSTR event, LPCWSTR control, LPCWSTR attribute);
1013 /* OLE automation */
1014 extern HRESULT create_msiserver(IUnknown *pOuter, LPVOID *ppObj);
1015 extern HRESULT create_session(MSIHANDLE msiHandle, IDispatch *pInstaller, IDispatch **pDispatch);
1016 extern HRESULT load_type_info(IDispatch *iface, ITypeInfo **pptinfo, REFIID clsid, LCID lcid);
1018 /* Scripting */
1019 extern DWORD call_script(MSIHANDLE hPackage, INT type, LPCWSTR script, LPCWSTR function, LPCWSTR action);
1021 /* User Interface messages from the actions */
1022 extern void ui_progress(MSIPACKAGE *, int, int, int, int);
1023 extern void ui_actiondata(MSIPACKAGE *, LPCWSTR, MSIRECORD *);
1025 /* string consts use a number of places and defined in helpers.c*/
1026 extern const WCHAR cszSourceDir[];
1027 extern const WCHAR cszSOURCEDIR[];
1028 extern const WCHAR cszRootDrive[];
1029 extern const WCHAR cszbs[];
1030 extern const WCHAR szLocalSid[];
1032 /* memory allocation macro functions */
1033 static void *msi_alloc( size_t len ) __WINE_ALLOC_SIZE(1);
1034 static inline void *msi_alloc( size_t len )
1036 return HeapAlloc( GetProcessHeap(), 0, len );
1039 static void *msi_alloc_zero( size_t len ) __WINE_ALLOC_SIZE(1);
1040 static inline void *msi_alloc_zero( size_t len )
1042 return HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, len );
1045 static void *msi_realloc( void *mem, size_t len ) __WINE_ALLOC_SIZE(2);
1046 static inline void *msi_realloc( void *mem, size_t len )
1048 return HeapReAlloc( GetProcessHeap(), 0, mem, len );
1051 static void *msi_realloc_zero( void *mem, size_t len ) __WINE_ALLOC_SIZE(2);
1052 static inline void *msi_realloc_zero( void *mem, size_t len )
1054 return HeapReAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, mem, len );
1057 static inline BOOL msi_free( void *mem )
1059 return HeapFree( GetProcessHeap(), 0, mem );
1062 static inline char *strdupWtoA( LPCWSTR str )
1064 LPSTR ret = NULL;
1065 DWORD len;
1067 if (!str) return ret;
1068 len = WideCharToMultiByte( CP_ACP, 0, str, -1, NULL, 0, NULL, NULL);
1069 ret = msi_alloc( len );
1070 if (ret)
1071 WideCharToMultiByte( CP_ACP, 0, str, -1, ret, len, NULL, NULL );
1072 return ret;
1075 static inline LPWSTR strdupAtoW( LPCSTR str )
1077 LPWSTR ret = NULL;
1078 DWORD len;
1080 if (!str) return ret;
1081 len = MultiByteToWideChar( CP_ACP, 0, str, -1, NULL, 0 );
1082 ret = msi_alloc( len * sizeof(WCHAR) );
1083 if (ret)
1084 MultiByteToWideChar( CP_ACP, 0, str, -1, ret, len );
1085 return ret;
1088 static inline LPWSTR strdupW( LPCWSTR src )
1090 LPWSTR dest;
1091 if (!src) return NULL;
1092 dest = msi_alloc( (lstrlenW(src)+1)*sizeof(WCHAR) );
1093 if (dest)
1094 lstrcpyW(dest, src);
1095 return dest;
1098 #endif /* __WINE_MSI_PRIVATE__ */