Release 1.1.8.
[wine/multimedia.git] / dlls / msi / msipriv.h
blobf856e669f7865eb13fee1d2d0866516b6765f2c1
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 _column_info
149 LPCWSTR table;
150 LPCWSTR column;
151 INT type;
152 BOOL temporary;
153 struct expr *val;
154 struct _column_info *next;
155 } column_info;
157 typedef const struct tagMSICOLUMNHASHENTRY *MSIITERHANDLE;
159 typedef struct tagMSIVIEWOPS
162 * fetch_int - reads one integer from {row,col} in the table
164 * This function should be called after the execute method.
165 * Data returned by the function should not change until
166 * close or delete is called.
167 * To get a string value, query the database's string table with
168 * the integer value returned from this function.
170 UINT (*fetch_int)( struct tagMSIVIEW *view, UINT row, UINT col, UINT *val );
173 * fetch_stream - gets a stream from {row,col} in the table
175 * This function is similar to fetch_int, except fetches a
176 * stream instead of an integer.
178 UINT (*fetch_stream)( struct tagMSIVIEW *view, UINT row, UINT col, IStream **stm );
181 * get_row - gets values from a row
184 UINT (*get_row)( struct tagMSIVIEW *view, UINT row, MSIRECORD **rec );
187 * set_row - sets values in a row as specified by mask
189 * Similar semantics to fetch_int
191 UINT (*set_row)( struct tagMSIVIEW *view, UINT row, MSIRECORD *rec, UINT mask );
194 * Inserts a new row into the database from the records contents
196 UINT (*insert_row)( struct tagMSIVIEW *view, MSIRECORD *record, BOOL temporary );
199 * Deletes a row from the database
201 UINT (*delete_row)( struct tagMSIVIEW *view, UINT row );
204 * execute - loads the underlying data into memory so it can be read
206 UINT (*execute)( struct tagMSIVIEW *view, MSIRECORD *record );
209 * close - clears the data read by execute from memory
211 UINT (*close)( struct tagMSIVIEW *view );
214 * get_dimensions - returns the number of rows or columns in a table.
216 * The number of rows can only be queried after the execute method
217 * is called. The number of columns can be queried at any time.
219 UINT (*get_dimensions)( struct tagMSIVIEW *view, UINT *rows, UINT *cols );
222 * get_column_info - returns the name and type of a specific column
224 * The name is HeapAlloc'ed by this function and should be freed by
225 * the caller.
226 * The column information can be queried at any time.
228 UINT (*get_column_info)( struct tagMSIVIEW *view, UINT n, LPWSTR *name, UINT *type );
231 * modify - not yet implemented properly
233 UINT (*modify)( struct tagMSIVIEW *view, MSIMODIFY eModifyMode, MSIRECORD *record, UINT row );
236 * delete - destroys the structure completely
238 UINT (*delete)( struct tagMSIVIEW * );
241 * find_matching_rows - iterates through rows that match a value
243 * If the column type is a string then a string ID should be passed in.
244 * If the value to be looked up is an integer then no transformation of
245 * the input value is required, except if the column is a string, in which
246 * case a string ID should be passed in.
247 * The handle is an input/output parameter that keeps track of the current
248 * position in the iteration. It must be initialised to zero before the
249 * first call and continued to be passed in to subsequent calls.
251 UINT (*find_matching_rows)( struct tagMSIVIEW *view, UINT col, UINT val, UINT *row, MSIITERHANDLE *handle );
254 * add_ref - increases the reference count of the table
256 UINT (*add_ref)( struct tagMSIVIEW *view );
259 * release - decreases the reference count of the table
261 UINT (*release)( struct tagMSIVIEW *view );
264 * add_column - adds a column to the table
266 UINT (*add_column)( struct tagMSIVIEW *view, LPCWSTR table, UINT number, LPCWSTR column, UINT type, BOOL hold );
269 * remove_column - removes the column represented by table name and column number from the table
271 UINT (*remove_column)( struct tagMSIVIEW *view, LPCWSTR table, UINT number );
274 * sort - orders the table by columns
276 UINT (*sort)( struct tagMSIVIEW *view, column_info *columns );
279 * drop - drops the table from the database
281 UINT (*drop)( struct tagMSIVIEW *view );
282 } MSIVIEWOPS;
284 struct tagMSIVIEW
286 MSIOBJECTHDR hdr;
287 const MSIVIEWOPS *ops;
290 struct msi_dialog_tag;
291 typedef struct msi_dialog_tag msi_dialog;
293 typedef struct tagMSIPACKAGE
295 MSIOBJECTHDR hdr;
296 MSIDATABASE *db;
297 struct list components;
298 struct list features;
299 struct list files;
300 struct list tempfiles;
301 struct list folders;
302 LPWSTR ActionFormat;
303 LPWSTR LastAction;
305 struct list classes;
306 struct list extensions;
307 struct list progids;
308 struct list mimes;
309 struct list appids;
311 struct tagMSISCRIPT *script;
313 struct list RunningActions;
315 LPWSTR BaseURL;
316 LPWSTR PackagePath;
317 LPWSTR ProductCode;
319 UINT CurrentInstallState;
320 msi_dialog *dialog;
321 LPWSTR next_dialog;
322 float center_x;
323 float center_y;
325 UINT WordCount;
326 UINT Context;
328 struct list subscriptions;
330 struct list sourcelist_info;
331 struct list sourcelist_media;
333 unsigned char scheduled_action_running : 1;
334 unsigned char commit_action_running : 1;
335 unsigned char rollback_action_running : 1;
336 } MSIPACKAGE;
338 typedef struct tagMSIPREVIEW
340 MSIOBJECTHDR hdr;
341 MSIPACKAGE *package;
342 msi_dialog *dialog;
343 } MSIPREVIEW;
345 #define MSI_MAX_PROPS 20
347 typedef struct tagMSISUMMARYINFO
349 MSIOBJECTHDR hdr;
350 IStorage *storage;
351 DWORD update_count;
352 PROPVARIANT property[MSI_MAX_PROPS];
353 } MSISUMMARYINFO;
355 typedef struct tagMSIFEATURE
357 struct list entry;
358 LPWSTR Feature;
359 LPWSTR Feature_Parent;
360 LPWSTR Title;
361 LPWSTR Description;
362 INT Display;
363 INT Level;
364 LPWSTR Directory;
365 INT Attributes;
366 INSTALLSTATE Installed;
367 INSTALLSTATE ActionRequest;
368 INSTALLSTATE Action;
369 struct list Children;
370 struct list Components;
371 INT Cost;
372 } MSIFEATURE;
374 typedef struct tagMSICOMPONENT
376 struct list entry;
377 DWORD magic;
378 LPWSTR Component;
379 LPWSTR ComponentId;
380 LPWSTR Directory;
381 INT Attributes;
382 LPWSTR Condition;
383 LPWSTR KeyPath;
384 INSTALLSTATE Installed;
385 INSTALLSTATE ActionRequest;
386 INSTALLSTATE Action;
387 BOOL ForceLocalState;
388 BOOL Enabled;
389 INT Cost;
390 INT RefCount;
391 LPWSTR FullKeypath;
392 LPWSTR AdvertiseString;
394 unsigned int anyAbsent:1;
395 unsigned int hasAdvertiseFeature:1;
396 unsigned int hasLocalFeature:1;
397 unsigned int hasSourceFeature:1;
398 } MSICOMPONENT;
400 typedef struct tagComponentList
402 struct list entry;
403 MSICOMPONENT *component;
404 } ComponentList;
406 typedef struct tagFeatureList
408 struct list entry;
409 MSIFEATURE *feature;
410 } FeatureList;
412 typedef struct tagMSIFOLDER
414 struct list entry;
415 LPWSTR Directory;
416 LPWSTR Parent;
417 LPWSTR TargetDefault;
418 LPWSTR SourceLongPath;
419 LPWSTR SourceShortPath;
421 LPWSTR ResolvedTarget;
422 LPWSTR ResolvedSource;
423 LPWSTR Property; /* initially set property */
424 INT State;
425 /* 0 = uninitialized */
426 /* 1 = existing */
427 /* 2 = created remove if empty */
428 /* 3 = created persist if empty */
429 INT Cost;
430 INT Space;
431 } MSIFOLDER;
433 typedef enum _msi_file_state {
434 msifs_invalid,
435 msifs_missing,
436 msifs_overwrite,
437 msifs_present,
438 msifs_installed,
439 msifs_skipped,
440 } msi_file_state;
442 typedef struct tagMSIFILE
444 struct list entry;
445 LPWSTR File;
446 MSICOMPONENT *Component;
447 LPWSTR FileName;
448 LPWSTR ShortName;
449 LPWSTR LongName;
450 INT FileSize;
451 LPWSTR Version;
452 LPWSTR Language;
453 INT Attributes;
454 INT Sequence;
455 msi_file_state state;
456 LPWSTR TargetPath;
457 BOOL IsCompressed;
458 MSIFILEHASHINFO hash;
459 } MSIFILE;
461 typedef struct tagMSITEMPFILE
463 struct list entry;
464 LPWSTR Path;
465 } MSITEMPFILE;
467 typedef struct tagMSIAPPID
469 struct list entry;
470 LPWSTR AppID; /* Primary key */
471 LPWSTR RemoteServerName;
472 LPWSTR LocalServer;
473 LPWSTR ServiceParameters;
474 LPWSTR DllSurrogate;
475 BOOL ActivateAtStorage;
476 BOOL RunAsInteractiveUser;
477 } MSIAPPID;
479 typedef struct tagMSIPROGID MSIPROGID;
481 typedef struct tagMSICLASS
483 struct list entry;
484 LPWSTR clsid; /* Primary Key */
485 LPWSTR Context; /* Primary Key */
486 MSICOMPONENT *Component;
487 MSIPROGID *ProgID;
488 LPWSTR ProgIDText;
489 LPWSTR Description;
490 MSIAPPID *AppID;
491 LPWSTR FileTypeMask;
492 LPWSTR IconPath;
493 LPWSTR DefInprocHandler;
494 LPWSTR DefInprocHandler32;
495 LPWSTR Argument;
496 MSIFEATURE *Feature;
497 INT Attributes;
498 /* not in the table, set during installation */
499 BOOL Installed;
500 } MSICLASS;
502 typedef struct tagMSIMIME MSIMIME;
504 typedef struct tagMSIEXTENSION
506 struct list entry;
507 LPWSTR Extension; /* Primary Key */
508 MSICOMPONENT *Component;
509 MSIPROGID *ProgID;
510 LPWSTR ProgIDText;
511 MSIMIME *Mime;
512 MSIFEATURE *Feature;
513 /* not in the table, set during installation */
514 BOOL Installed;
515 struct list verbs;
516 } MSIEXTENSION;
518 struct tagMSIPROGID
520 struct list entry;
521 LPWSTR ProgID; /* Primary Key */
522 MSIPROGID *Parent;
523 MSICLASS *Class;
524 LPWSTR Description;
525 LPWSTR IconPath;
526 /* not in the table, set during installation */
527 BOOL InstallMe;
528 MSIPROGID *CurVer;
529 MSIPROGID *VersionInd;
532 typedef struct tagMSIVERB
534 struct list entry;
535 LPWSTR Verb;
536 INT Sequence;
537 LPWSTR Command;
538 LPWSTR Argument;
539 } MSIVERB;
541 struct tagMSIMIME
543 struct list entry;
544 LPWSTR ContentType; /* Primary Key */
545 MSIEXTENSION *Extension;
546 LPWSTR clsid;
547 MSICLASS *Class;
548 /* not in the table, set during installation */
549 BOOL InstallMe;
552 enum SCRIPTS {
553 INSTALL_SCRIPT = 0,
554 COMMIT_SCRIPT = 1,
555 ROLLBACK_SCRIPT = 2,
556 TOTAL_SCRIPTS = 3
559 #define SEQUENCE_UI 0x1
560 #define SEQUENCE_EXEC 0x2
561 #define SEQUENCE_INSTALL 0x10
563 typedef struct tagMSISCRIPT
565 LPWSTR *Actions[TOTAL_SCRIPTS];
566 UINT ActionCount[TOTAL_SCRIPTS];
567 BOOL ExecuteSequenceRun;
568 BOOL CurrentlyScripting;
569 UINT InWhatSequence;
570 LPWSTR *UniqueActions;
571 UINT UniqueActionsCount;
572 } MSISCRIPT;
574 #define MSIHANDLETYPE_ANY 0
575 #define MSIHANDLETYPE_DATABASE 1
576 #define MSIHANDLETYPE_SUMMARYINFO 2
577 #define MSIHANDLETYPE_VIEW 3
578 #define MSIHANDLETYPE_RECORD 4
579 #define MSIHANDLETYPE_PACKAGE 5
580 #define MSIHANDLETYPE_PREVIEW 6
582 #define MSI_MAJORVERSION 3
583 #define MSI_MINORVERSION 1
584 #define MSI_BUILDNUMBER 4000
586 #define GUID_SIZE 39
587 #define SQUISH_GUID_SIZE 33
589 #define MSIHANDLE_MAGIC 0x4d434923
591 DEFINE_GUID(CLSID_IMsiServer, 0x000C101C,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
592 DEFINE_GUID(CLSID_IMsiServerX1, 0x000C103E,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
593 DEFINE_GUID(CLSID_IMsiServerX2, 0x000C1090,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
594 DEFINE_GUID(CLSID_IMsiServerX3, 0x000C1094,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
596 DEFINE_GUID(CLSID_IMsiServerMessage, 0x000C101D,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
598 DEFINE_GUID(CLSID_IWineMsiRemoteCustomAction,0xBA26E6FA,0x4F27,0x4f56,0x95,0x3A,0x3F,0x90,0x27,0x20,0x18,0xAA);
599 DEFINE_GUID(CLSID_IWineMsiRemotePackage,0x902b3592,0x9d08,0x4dfd,0xa5,0x93,0xd0,0x7c,0x52,0x54,0x64,0x21);
601 /* handle unicode/ascii output in the Msi* API functions */
602 typedef struct {
603 BOOL unicode;
604 union {
605 LPSTR a;
606 LPWSTR w;
607 } str;
608 } awstring;
610 typedef struct {
611 BOOL unicode;
612 union {
613 LPCSTR a;
614 LPCWSTR w;
615 } str;
616 } awcstring;
618 UINT msi_strcpy_to_awstring( LPCWSTR str, awstring *awbuf, DWORD *sz );
620 /* msi server interface */
621 extern ITypeLib *get_msi_typelib( LPWSTR *path );
622 extern HRESULT create_msi_custom_remote( IUnknown *pOuter, LPVOID *ppObj );
623 extern HRESULT create_msi_remote_package( IUnknown *pOuter, LPVOID *ppObj );
624 extern HRESULT create_msi_remote_database( IUnknown *pOuter, LPVOID *ppObj );
625 extern IUnknown *msi_get_remote(MSIHANDLE handle);
627 /* handle functions */
628 extern void *msihandle2msiinfo(MSIHANDLE handle, UINT type);
629 extern MSIHANDLE alloc_msihandle( MSIOBJECTHDR * );
630 extern MSIHANDLE alloc_msi_remote_handle( IUnknown *unk );
631 extern void *alloc_msiobject(UINT type, UINT size, msihandledestructor destroy );
632 extern void msiobj_addref(MSIOBJECTHDR *);
633 extern int msiobj_release(MSIOBJECTHDR *);
634 extern void msiobj_lock(MSIOBJECTHDR *);
635 extern void msiobj_unlock(MSIOBJECTHDR *);
636 extern void msi_free_handle_table(void);
638 extern void free_cached_tables( MSIDATABASE *db );
639 extern void msi_free_transforms( MSIDATABASE *db );
640 extern UINT MSI_CommitTables( MSIDATABASE *db );
643 /* string table functions */
644 enum StringPersistence
646 StringPersistent = 0,
647 StringNonPersistent = 1
650 extern BOOL msi_addstringW( string_table *st, UINT string_no, const WCHAR *data, int len, UINT refcount, enum StringPersistence persistence );
651 extern UINT msi_id2stringW( const string_table *st, UINT string_no, LPWSTR buffer, UINT *sz );
652 extern UINT msi_id2stringA( const string_table *st, UINT string_no, LPSTR buffer, UINT *sz );
654 extern UINT msi_string2idW( const string_table *st, LPCWSTR buffer, UINT *id );
655 extern UINT msi_string2idA( const string_table *st, LPCSTR str, UINT *id );
656 extern VOID msi_destroy_stringtable( string_table *st );
657 extern UINT msi_strcmp( const string_table *st, UINT lval, UINT rval, UINT *res );
658 extern const WCHAR *msi_string_lookup_id( const string_table *st, UINT id );
659 extern HRESULT msi_init_string_table( IStorage *stg );
660 extern string_table *msi_load_string_table( IStorage *stg, UINT *bytes_per_strref );
661 extern UINT msi_save_string_table( const string_table *st, IStorage *storage );
663 extern BOOL TABLE_Exists( MSIDATABASE *db, LPCWSTR name );
664 extern MSICONDITION MSI_DatabaseIsTablePersistent( MSIDATABASE *db, LPCWSTR table );
666 extern UINT read_raw_stream_data( MSIDATABASE *db, LPCWSTR stname,
667 USHORT **pdata, UINT *psz );
668 extern UINT read_stream_data( IStorage *stg, LPCWSTR stname, BOOL table,
669 BYTE **pdata, UINT *psz );
670 extern UINT write_stream_data( IStorage *stg, LPCWSTR stname,
671 LPCVOID data, UINT sz, BOOL bTable );
673 /* transform functions */
674 extern UINT msi_table_apply_transform( MSIDATABASE *db, IStorage *stg );
675 extern UINT MSI_DatabaseApplyTransformW( MSIDATABASE *db,
676 LPCWSTR szTransformFile, int iErrorCond );
677 extern void append_storage_to_db( MSIDATABASE *db, IStorage *stg );
679 /* action internals */
680 extern UINT MSI_InstallPackage( MSIPACKAGE *, LPCWSTR, LPCWSTR );
681 extern void ACTION_free_package_structures( MSIPACKAGE* );
682 extern UINT ACTION_DialogBox( MSIPACKAGE*, LPCWSTR);
683 extern UINT ACTION_ForceReboot(MSIPACKAGE *package);
684 extern UINT MSI_Sequence( MSIPACKAGE *package, LPCWSTR szTable, INT iSequenceMode );
685 extern UINT MSI_SetFeatureStates( MSIPACKAGE *package );
686 extern UINT msi_parse_command_line( MSIPACKAGE *package, LPCWSTR szCommandLine,
687 BOOL preserve_case );
689 /* record internals */
690 extern UINT MSI_RecordSetIStream( MSIRECORD *, UINT, IStream *);
691 extern UINT MSI_RecordGetIStream( MSIRECORD *, UINT, IStream **);
692 extern const WCHAR *MSI_RecordGetString( const MSIRECORD *, UINT );
693 extern MSIRECORD *MSI_CreateRecord( UINT );
694 extern UINT MSI_RecordSetInteger( MSIRECORD *, UINT, int );
695 extern UINT MSI_RecordSetStringW( MSIRECORD *, UINT, LPCWSTR );
696 extern UINT MSI_RecordSetStringA( MSIRECORD *, UINT, LPCSTR );
697 extern BOOL MSI_RecordIsNull( MSIRECORD *, UINT );
698 extern UINT MSI_RecordGetStringW( MSIRECORD * , UINT, LPWSTR, LPDWORD);
699 extern UINT MSI_RecordGetStringA( MSIRECORD *, UINT, LPSTR, LPDWORD);
700 extern int MSI_RecordGetInteger( MSIRECORD *, UINT );
701 extern UINT MSI_RecordReadStream( MSIRECORD *, UINT, char *, LPDWORD);
702 extern UINT MSI_RecordGetFieldCount( const MSIRECORD *rec );
703 extern UINT MSI_RecordSetStream( MSIRECORD *, UINT, IStream * );
704 extern UINT MSI_RecordDataSize( MSIRECORD *, UINT );
705 extern UINT MSI_RecordStreamToFile( MSIRECORD *, UINT, LPCWSTR );
706 extern UINT MSI_RecordCopyField( MSIRECORD *, UINT, MSIRECORD *, UINT );
707 extern MSIRECORD *MSI_CloneRecord( MSIRECORD * );
708 extern BOOL MSI_RecordsAreEqual( MSIRECORD *, MSIRECORD * );
710 /* stream internals */
711 extern UINT get_raw_stream( MSIHANDLE hdb, LPCWSTR stname, IStream **stm );
712 extern UINT db_get_raw_stream( MSIDATABASE *db, LPCWSTR stname, IStream **stm );
713 extern void enum_stream_names( IStorage *stg );
714 extern BOOL decode_streamname(LPCWSTR in, LPWSTR out);
715 extern LPWSTR encode_streamname(BOOL bTable, LPCWSTR in);
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_DatabaseImport( MSIDATABASE *, LPCWSTR, LPCWSTR );
725 extern UINT MSI_DatabaseExport( MSIDATABASE *, LPCWSTR, LPCWSTR, LPCWSTR );
726 extern UINT MSI_DatabaseGetPrimaryKeys( MSIDATABASE *, LPCWSTR, MSIRECORD ** );
728 /* view internals */
729 extern UINT MSI_ViewExecute( MSIQUERY*, MSIRECORD * );
730 extern UINT MSI_ViewFetch( MSIQUERY*, MSIRECORD ** );
731 extern UINT MSI_ViewClose( MSIQUERY* );
732 extern UINT MSI_ViewGetColumnInfo(MSIQUERY *, MSICOLINFO, MSIRECORD **);
733 extern UINT MSI_ViewModify( MSIQUERY *, MSIMODIFY, MSIRECORD * );
734 extern UINT VIEW_find_column( MSIVIEW *, LPCWSTR, UINT * );
735 extern UINT msi_view_get_row(MSIDATABASE *, MSIVIEW *, UINT, MSIRECORD **);
737 /* install internals */
738 extern UINT MSI_SetInstallLevel( MSIPACKAGE *package, int iInstallLevel );
740 /* package internals */
741 extern MSIPACKAGE *MSI_CreatePackage( MSIDATABASE *, LPCWSTR );
742 extern UINT MSI_OpenPackageW( LPCWSTR szPackage, MSIPACKAGE **pPackage );
743 extern UINT MSI_SetTargetPathW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
744 extern UINT MSI_SetPropertyW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
745 extern INT MSI_ProcessMessage( MSIPACKAGE *, INSTALLMESSAGE, MSIRECORD * );
746 extern UINT MSI_GetPropertyW( MSIPACKAGE *, LPCWSTR, LPWSTR, LPDWORD );
747 extern UINT MSI_GetPropertyA(MSIPACKAGE *, LPCSTR, LPSTR, LPDWORD );
748 extern MSICONDITION MSI_EvaluateConditionW( MSIPACKAGE *, LPCWSTR );
749 extern UINT MSI_GetComponentStateW( MSIPACKAGE *, LPCWSTR, INSTALLSTATE *, INSTALLSTATE * );
750 extern UINT MSI_GetFeatureStateW( MSIPACKAGE *, LPCWSTR, INSTALLSTATE *, INSTALLSTATE * );
751 extern UINT WINAPI MSI_SetFeatureStateW(MSIPACKAGE*, LPCWSTR, INSTALLSTATE );
752 extern LPCWSTR msi_download_file( LPCWSTR szUrl, LPWSTR filename );
753 extern UINT msi_package_add_info(MSIPACKAGE *, DWORD, DWORD, LPCWSTR, LPWSTR);
754 extern UINT msi_package_add_media_disk(MSIPACKAGE *, DWORD, DWORD, DWORD, LPWSTR, LPWSTR);
755 extern UINT msi_clone_properties(MSIPACKAGE *);
757 /* for deformating */
758 extern UINT MSI_FormatRecordW( MSIPACKAGE *, MSIRECORD *, LPWSTR, LPDWORD );
760 /* registry data encoding/decoding functions */
761 extern BOOL unsquash_guid(LPCWSTR in, LPWSTR out);
762 extern BOOL squash_guid(LPCWSTR in, LPWSTR out);
763 extern BOOL encode_base85_guid(GUID *,LPWSTR);
764 extern BOOL decode_base85_guid(LPCWSTR,GUID*);
765 extern UINT MSIREG_OpenUninstallKey(LPCWSTR szProduct, HKEY* key, BOOL create);
766 extern UINT MSIREG_DeleteUninstallKey(LPCWSTR szProduct);
767 extern UINT MSIREG_OpenProductKey(LPCWSTR szProduct, MSIINSTALLCONTEXT context,
768 HKEY* key, BOOL create);
769 extern UINT MSIREG_OpenFeaturesKey(LPCWSTR szProduct, MSIINSTALLCONTEXT context,
770 HKEY *key, BOOL create);
771 extern UINT MSIREG_OpenUserPatchesKey(LPCWSTR szPatch, HKEY* key, BOOL create);
772 extern UINT MSIREG_OpenInstallerFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
773 UINT MSIREG_OpenUserDataFeaturesKey(LPCWSTR szProduct, MSIINSTALLCONTEXT context,
774 HKEY *key, BOOL create);
775 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
776 extern UINT MSIREG_OpenLocalUserDataComponentKey(LPCWSTR szComponent, HKEY *key, BOOL create);
777 extern UINT MSIREG_OpenUserDataComponentKey(LPCWSTR szComponent, HKEY *key, BOOL create);
778 extern UINT MSIREG_OpenPatchesKey(LPCWSTR szPatch, HKEY* key, BOOL create);
779 extern UINT MSIREG_OpenUserDataProductKey(LPCWSTR szProduct, HKEY* key, BOOL create);
780 extern UINT MSIREG_OpenLocalUserDataProductKey(LPCWSTR szProduct, HKEY* key, BOOL create);
781 extern UINT MSIREG_OpenCurrentUserInstallProps(LPCWSTR szProduct, HKEY* key, BOOL create);
782 extern UINT MSIREG_OpenLocalSystemInstallProps(LPCWSTR szProduct, HKEY* key, BOOL create);
783 extern UINT MSIREG_OpenUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
784 extern UINT MSIREG_OpenUserUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
785 extern UINT MSIREG_DeleteProductKey(LPCWSTR szProduct);
786 extern UINT MSIREG_DeleteUserProductKey(LPCWSTR szProduct);
787 extern UINT MSIREG_DeleteUserDataProductKey(LPCWSTR szProduct);
788 extern UINT MSIREG_OpenLocalSystemProductKey(LPCWSTR szProductCode, HKEY *key, BOOL create);
789 extern UINT MSIREG_OpenLocalSystemComponentKey(LPCWSTR szComponent, HKEY *key, BOOL create);
790 extern UINT MSIREG_DeleteUserFeaturesKey(LPCWSTR szProduct);
791 extern UINT MSIREG_DeleteLocalUserDataComponentKey(LPCWSTR szComponent);
792 extern UINT MSIREG_DeleteUserDataComponentKey(LPCWSTR szComponent);
793 extern UINT MSIREG_DeleteUserUpgradeCodesKey(LPCWSTR szUpgradeCode);
794 extern UINT MSIREG_OpenClassesUpgradeCodesKey(LPCWSTR szUpgradeCode, HKEY* key, BOOL create);
795 extern UINT MSIREG_DeleteLocalClassesProductKey(LPCWSTR szProductCode);
796 extern UINT MSIREG_DeleteLocalClassesFeaturesKey(LPCWSTR szProductCode);
798 extern LPWSTR msi_reg_get_val_str( HKEY hkey, LPCWSTR name );
799 extern BOOL msi_reg_get_val_dword( HKEY hkey, LPCWSTR name, DWORD *val);
801 extern DWORD msi_version_str_to_dword(LPCWSTR p);
802 extern LPWSTR msi_version_dword_to_str(DWORD version);
804 extern LONG msi_reg_set_val_str( HKEY hkey, LPCWSTR name, LPCWSTR value );
805 extern LONG msi_reg_set_val_multi_str( HKEY hkey, LPCWSTR name, LPCWSTR value );
806 extern LONG msi_reg_set_val_dword( HKEY hkey, LPCWSTR name, DWORD val );
807 extern LONG msi_reg_set_subkey_val( HKEY hkey, LPCWSTR path, LPCWSTR name, LPCWSTR val );
809 /* msi dialog interface */
810 typedef UINT (*msi_dialog_event_handler)( MSIPACKAGE*, LPCWSTR, LPCWSTR, msi_dialog* );
811 extern msi_dialog *msi_dialog_create( MSIPACKAGE*, LPCWSTR, msi_dialog*, msi_dialog_event_handler );
812 extern UINT msi_dialog_run_message_loop( msi_dialog* );
813 extern void msi_dialog_end_dialog( msi_dialog* );
814 extern void msi_dialog_check_messages( HANDLE );
815 extern void msi_dialog_do_preview( msi_dialog* );
816 extern void msi_dialog_destroy( msi_dialog* );
817 extern BOOL msi_dialog_register_class( void );
818 extern void msi_dialog_unregister_class( void );
819 extern void msi_dialog_handle_event( msi_dialog*, LPCWSTR, LPCWSTR, MSIRECORD * );
820 extern UINT msi_dialog_reset( msi_dialog *dialog );
821 extern UINT msi_dialog_directorylist_up( msi_dialog *dialog );
822 extern msi_dialog *msi_dialog_get_parent( msi_dialog *dialog );
823 extern LPWSTR msi_dialog_get_name( msi_dialog *dialog );
824 extern UINT msi_spawn_error_dialog( MSIPACKAGE*, LPWSTR, LPWSTR );
826 /* preview */
827 extern MSIPREVIEW *MSI_EnableUIPreview( MSIDATABASE * );
828 extern UINT MSI_PreviewDialogW( MSIPREVIEW *, LPCWSTR );
830 /* summary information */
831 extern MSISUMMARYINFO *MSI_GetSummaryInformationW( IStorage *stg, UINT uiUpdateCount );
832 extern LPWSTR msi_suminfo_dup_string( MSISUMMARYINFO *si, UINT uiProperty );
833 extern LPWSTR msi_get_suminfo_product( IStorage *stg );
835 /* undocumented functions */
836 UINT WINAPI MsiCreateAndVerifyInstallerDirectory( DWORD );
837 UINT WINAPI MsiDecomposeDescriptorW( LPCWSTR, LPWSTR, LPWSTR, LPWSTR, LPDWORD );
838 UINT WINAPI MsiDecomposeDescriptorA( LPCSTR, LPSTR, LPSTR, LPSTR, LPDWORD );
839 LANGID WINAPI MsiLoadStringW( MSIHANDLE, UINT, LPWSTR, int, LANGID );
840 LANGID WINAPI MsiLoadStringA( MSIHANDLE, UINT, LPSTR, int, LANGID );
842 /* UI globals */
843 extern INSTALLUILEVEL gUILevel;
844 extern HWND gUIhwnd;
845 extern INSTALLUI_HANDLERA gUIHandlerA;
846 extern INSTALLUI_HANDLERW gUIHandlerW;
847 extern DWORD gUIFilter;
848 extern LPVOID gUIContext;
849 extern WCHAR gszLogFile[MAX_PATH];
850 extern HINSTANCE msi_hInstance;
852 /* action related functions */
853 extern UINT ACTION_PerformAction(MSIPACKAGE *package, const WCHAR *action, UINT script, BOOL force);
854 extern UINT ACTION_PerformUIAction(MSIPACKAGE *package, const WCHAR *action, UINT script);
855 extern void ACTION_FinishCustomActions( const MSIPACKAGE* package);
856 extern UINT ACTION_CustomAction(MSIPACKAGE *package,const WCHAR *action, UINT script, BOOL execute);
858 static inline void msi_feature_set_state(MSIPACKAGE *package,
859 MSIFEATURE *feature,
860 INSTALLSTATE state)
862 if (!package->ProductCode)
864 feature->ActionRequest = state;
865 feature->Action = state;
867 else if (state == INSTALLSTATE_ABSENT)
869 switch (feature->Installed)
871 case INSTALLSTATE_ABSENT:
872 feature->ActionRequest = INSTALLSTATE_UNKNOWN;
873 feature->Action = INSTALLSTATE_UNKNOWN;
874 break;
875 default:
876 feature->ActionRequest = state;
877 feature->Action = state;
880 else if (state == INSTALLSTATE_SOURCE)
882 switch (feature->Installed)
884 case INSTALLSTATE_ABSENT:
885 case INSTALLSTATE_SOURCE:
886 feature->ActionRequest = state;
887 feature->Action = state;
888 break;
889 case INSTALLSTATE_LOCAL:
890 feature->ActionRequest = INSTALLSTATE_LOCAL;
891 feature->Action = INSTALLSTATE_LOCAL;
892 break;
893 default:
894 feature->ActionRequest = INSTALLSTATE_UNKNOWN;
895 feature->Action = INSTALLSTATE_UNKNOWN;
898 else
900 feature->ActionRequest = state;
901 feature->Action = state;
905 static inline void msi_component_set_state(MSIPACKAGE *package,
906 MSICOMPONENT *comp,
907 INSTALLSTATE state)
909 if (!package->ProductCode)
911 comp->ActionRequest = state;
912 comp->Action = state;
914 else if (state == INSTALLSTATE_ABSENT)
916 switch (comp->Installed)
918 case INSTALLSTATE_LOCAL:
919 case INSTALLSTATE_SOURCE:
920 case INSTALLSTATE_DEFAULT:
921 comp->ActionRequest = state;
922 comp->Action = state;
923 break;
924 default:
925 comp->ActionRequest = INSTALLSTATE_UNKNOWN;
926 comp->Action = INSTALLSTATE_UNKNOWN;
929 else if (state == INSTALLSTATE_SOURCE)
931 if (comp->Installed == INSTALLSTATE_ABSENT ||
932 (comp->Installed == INSTALLSTATE_SOURCE && comp->hasLocalFeature))
934 comp->ActionRequest = state;
935 comp->Action = state;
937 else
939 comp->ActionRequest = INSTALLSTATE_UNKNOWN;
940 comp->Action = INSTALLSTATE_UNKNOWN;
943 else
945 comp->ActionRequest = state;
946 comp->Action = state;
950 /* actions in other modules */
951 extern UINT ACTION_AppSearch(MSIPACKAGE *package);
952 extern UINT ACTION_CCPSearch(MSIPACKAGE *package);
953 extern UINT ACTION_FindRelatedProducts(MSIPACKAGE *package);
954 extern UINT ACTION_InstallFiles(MSIPACKAGE *package);
955 extern UINT ACTION_RemoveFiles(MSIPACKAGE *package);
956 extern UINT ACTION_DuplicateFiles(MSIPACKAGE *package);
957 extern UINT ACTION_RegisterClassInfo(MSIPACKAGE *package);
958 extern UINT ACTION_RegisterProgIdInfo(MSIPACKAGE *package);
959 extern UINT ACTION_RegisterExtensionInfo(MSIPACKAGE *package);
960 extern UINT ACTION_RegisterMIMEInfo(MSIPACKAGE *package);
961 extern UINT ACTION_RegisterFonts(MSIPACKAGE *package);
963 /* Helpers */
964 extern DWORD deformat_string(MSIPACKAGE *package, LPCWSTR ptr, WCHAR** data );
965 extern LPWSTR msi_dup_record_field(MSIRECORD *row, INT index);
966 extern LPWSTR msi_dup_property(MSIPACKAGE *package, LPCWSTR prop);
967 extern int msi_get_property_int( MSIPACKAGE *package, LPCWSTR prop, int def );
968 extern LPWSTR resolve_folder(MSIPACKAGE *package, LPCWSTR name, BOOL source,
969 BOOL set_prop, BOOL load_prop, MSIFOLDER **folder);
970 extern LPWSTR resolve_file_source(MSIPACKAGE *package, MSIFILE *file);
971 extern MSICOMPONENT *get_loaded_component( MSIPACKAGE* package, LPCWSTR Component );
972 extern MSIFEATURE *get_loaded_feature( MSIPACKAGE* package, LPCWSTR Feature );
973 extern MSIFILE *get_loaded_file( MSIPACKAGE* package, LPCWSTR file );
974 extern MSIFOLDER *get_loaded_folder( MSIPACKAGE *package, LPCWSTR dir );
975 extern void msi_reset_folders( MSIPACKAGE *package, BOOL source );
976 extern int track_tempfile(MSIPACKAGE *package, LPCWSTR path);
977 extern UINT schedule_action(MSIPACKAGE *package, UINT script, LPCWSTR action);
978 extern void msi_free_action_script(MSIPACKAGE *package, UINT script);
979 extern LPWSTR build_icon_path(MSIPACKAGE *, LPCWSTR);
980 extern LPWSTR build_directory_name(DWORD , ...);
981 extern BOOL create_full_pathW(const WCHAR *path);
982 extern BOOL ACTION_VerifyComponentForAction(const MSICOMPONENT*, INSTALLSTATE);
983 extern BOOL ACTION_VerifyFeatureForAction(const MSIFEATURE*, INSTALLSTATE);
984 extern void reduce_to_longfilename(WCHAR*);
985 extern void reduce_to_shortfilename(WCHAR*);
986 extern LPWSTR create_component_advertise_string(MSIPACKAGE*, MSICOMPONENT*, LPCWSTR);
987 extern void ACTION_UpdateComponentStates(MSIPACKAGE *package, LPCWSTR szFeature);
988 extern UINT register_unique_action(MSIPACKAGE *, LPCWSTR);
989 extern BOOL check_unique_action(const MSIPACKAGE *, LPCWSTR);
990 extern WCHAR* generate_error_string(MSIPACKAGE *, UINT, DWORD, ... );
991 extern UINT msi_create_component_directories( MSIPACKAGE *package );
992 extern void msi_ui_error( DWORD msg_id, DWORD type );
993 extern UINT msi_set_last_used_source(LPCWSTR product, LPCWSTR usersid,
994 MSIINSTALLCONTEXT context, DWORD options, LPCWSTR value);
996 /* media */
998 typedef BOOL (*PMSICABEXTRACTCB)(MSIPACKAGE *, LPCWSTR, DWORD, LPWSTR *, DWORD *, PVOID);
1000 #define MSICABEXTRACT_BEGINEXTRACT 0x01
1001 #define MSICABEXTRACT_FILEEXTRACTED 0x02
1003 typedef struct
1005 MSIPACKAGE* package;
1006 MSIMEDIAINFO *mi;
1007 PMSICABEXTRACTCB cb;
1008 LPWSTR curfile;
1009 PVOID user;
1010 } MSICABDATA;
1012 extern UINT ready_media(MSIPACKAGE *package, MSIFILE *file, MSIMEDIAINFO *mi);
1013 extern UINT msi_load_media_info(MSIPACKAGE *package, MSIFILE *file, MSIMEDIAINFO *mi);
1014 extern void msi_free_media_info(MSIMEDIAINFO *mi);
1015 extern BOOL msi_cabextract(MSIPACKAGE* package, MSIMEDIAINFO *mi, LPVOID data);
1016 extern UINT find_published_source(MSIPACKAGE *package, MSIMEDIAINFO *mi);
1018 /* control event stuff */
1019 extern VOID ControlEvent_FireSubscribedEvent(MSIPACKAGE *package, LPCWSTR event,
1020 MSIRECORD *data);
1021 extern VOID ControlEvent_CleanupDialogSubscriptions(MSIPACKAGE *package, LPWSTR dialog);
1022 extern VOID ControlEvent_CleanupSubscriptions(MSIPACKAGE *package);
1023 extern VOID ControlEvent_SubscribeToEvent(MSIPACKAGE *package, msi_dialog *dialog,
1024 LPCWSTR event, LPCWSTR control, LPCWSTR attribute);
1025 extern VOID ControlEvent_UnSubscribeToEvent( MSIPACKAGE *package, LPCWSTR event,
1026 LPCWSTR control, LPCWSTR attribute );
1028 /* OLE automation */
1029 extern HRESULT create_msiserver(IUnknown *pOuter, LPVOID *ppObj);
1030 extern HRESULT create_session(MSIHANDLE msiHandle, IDispatch *pInstaller, IDispatch **pDispatch);
1031 extern HRESULT load_type_info(IDispatch *iface, ITypeInfo **pptinfo, REFIID clsid, LCID lcid);
1033 /* Scripting */
1034 extern DWORD call_script(MSIHANDLE hPackage, INT type, LPCWSTR script, LPCWSTR function, LPCWSTR action);
1036 /* User Interface messages from the actions */
1037 extern void ui_progress(MSIPACKAGE *, int, int, int, int);
1038 extern void ui_actiondata(MSIPACKAGE *, LPCWSTR, MSIRECORD *);
1040 /* string consts use a number of places and defined in helpers.c*/
1041 extern const WCHAR cszSourceDir[];
1042 extern const WCHAR cszSOURCEDIR[];
1043 extern const WCHAR szProductCode[];
1044 extern const WCHAR cszRootDrive[];
1045 extern const WCHAR cszbs[];
1047 /* memory allocation macro functions */
1048 static void *msi_alloc( size_t len ) __WINE_ALLOC_SIZE(1);
1049 static inline void *msi_alloc( size_t len )
1051 return HeapAlloc( GetProcessHeap(), 0, len );
1054 static void *msi_alloc_zero( size_t len ) __WINE_ALLOC_SIZE(1);
1055 static inline void *msi_alloc_zero( size_t len )
1057 return HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, len );
1060 static void *msi_realloc( void *mem, size_t len ) __WINE_ALLOC_SIZE(2);
1061 static inline void *msi_realloc( void *mem, size_t len )
1063 return HeapReAlloc( GetProcessHeap(), 0, mem, len );
1066 static void *msi_realloc_zero( void *mem, size_t len ) __WINE_ALLOC_SIZE(2);
1067 static inline void *msi_realloc_zero( void *mem, size_t len )
1069 return HeapReAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, mem, len );
1072 static inline BOOL msi_free( void *mem )
1074 return HeapFree( GetProcessHeap(), 0, mem );
1077 static inline char *strdupWtoA( LPCWSTR str )
1079 LPSTR ret = NULL;
1080 DWORD len;
1082 if (!str) return ret;
1083 len = WideCharToMultiByte( CP_ACP, 0, str, -1, NULL, 0, NULL, NULL);
1084 ret = msi_alloc( len );
1085 if (ret)
1086 WideCharToMultiByte( CP_ACP, 0, str, -1, ret, len, NULL, NULL );
1087 return ret;
1090 static inline LPWSTR strdupAtoW( LPCSTR str )
1092 LPWSTR ret = NULL;
1093 DWORD len;
1095 if (!str) return ret;
1096 len = MultiByteToWideChar( CP_ACP, 0, str, -1, NULL, 0 );
1097 ret = msi_alloc( len * sizeof(WCHAR) );
1098 if (ret)
1099 MultiByteToWideChar( CP_ACP, 0, str, -1, ret, len );
1100 return ret;
1103 static inline LPWSTR strdupW( LPCWSTR src )
1105 LPWSTR dest;
1106 if (!src) return NULL;
1107 dest = msi_alloc( (lstrlenW(src)+1)*sizeof(WCHAR) );
1108 if (dest)
1109 lstrcpyW(dest, src);
1110 return dest;
1113 #endif /* __WINE_MSI_PRIVATE__ */