gdi32: Add separate functions for releasing/freeing DCs to replace the standard GDI...
[wine] / dlls / msi / msipriv.h
1 /*
2  * Implementation of the Microsoft Installer (msi.dll)
3  *
4  * Copyright 2002-2005 Mike McCormack for CodeWeavers
5  * Copyright 2005 Aric Stewart for CodeWeavers
6  *
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.
11  *
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.
16  *
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
20  */
21
22 #ifndef __WINE_MSI_PRIVATE__
23 #define __WINE_MSI_PRIVATE__
24
25 #include <stdarg.h>
26
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"
35
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
42 #define MSITYPE_TEMPORARY 0x4000
43
44 /* Word Count masks */
45 #define MSIWORDCOUNT_SHORTFILENAMES     0x0001
46 #define MSIWORDCOUNT_COMPRESSED         0x0002
47 #define MSIWORDCOUNT_ADMINISTRATIVE     0x0004
48 #define MSIWORDCOUNT_PRIVILEGES         0x0008
49
50 /* Install UI level mask for AND operation to exclude flags */
51 #define INSTALLUILEVEL_MASK             0x0007
52
53 #define MSITYPE_IS_BINARY(type) (((type) & ~MSITYPE_NULLABLE) == (MSITYPE_STRING|MSITYPE_VALID))
54
55 struct tagMSITABLE;
56 typedef struct tagMSITABLE MSITABLE;
57
58 struct string_table;
59 typedef struct string_table string_table;
60
61 struct tagMSIOBJECTHDR;
62 typedef struct tagMSIOBJECTHDR MSIOBJECTHDR;
63
64 typedef VOID (*msihandledestructor)( MSIOBJECTHDR * );
65
66 struct tagMSIOBJECTHDR
67 {
68     UINT magic;
69     UINT type;
70     LONG refcount;
71     msihandledestructor destructor;
72 };
73
74 typedef struct tagMSIDATABASE
75 {
76     MSIOBJECTHDR hdr;
77     IStorage *storage;
78     string_table *strings;
79     UINT bytes_per_strref;
80     LPWSTR path;
81     LPWSTR deletefile;
82     LPCWSTR mode;
83     struct list tables;
84     struct list transforms;
85 } MSIDATABASE;
86
87 typedef struct tagMSIVIEW MSIVIEW;
88
89 typedef struct tagMSIQUERY
90 {
91     MSIOBJECTHDR hdr;
92     MSIVIEW *view;
93     UINT row;
94     MSIDATABASE *db;
95     struct list mem;
96 } MSIQUERY;
97
98 /* maybe we can use a Variant instead of doing it ourselves? */
99 typedef struct tagMSIFIELD
100 {
101     UINT type;
102     union
103     {
104         INT iVal;
105         LPWSTR szwVal;
106         IStream *stream;
107     } u;
108 } MSIFIELD;
109
110 typedef struct tagMSIRECORD
111 {
112     MSIOBJECTHDR hdr;
113     UINT count;       /* as passed to MsiCreateRecord */
114     MSIFIELD fields[1]; /* nb. array size is count+1 */
115 } MSIRECORD;
116
117 typedef struct tagMSISOURCELISTINFO
118 {
119     struct list entry;
120     DWORD context;
121     DWORD options;
122     LPCWSTR property;
123     LPWSTR value;
124 } MSISOURCELISTINFO;
125
126 typedef struct tagMSIMEDIADISK
127 {
128     struct list entry;
129     DWORD context;
130     DWORD options;
131     DWORD disk_id;
132     LPWSTR volume_label;
133     LPWSTR disk_prompt;
134 } MSIMEDIADISK;
135
136 typedef const struct tagMSICOLUMNHASHENTRY *MSIITERHANDLE;
137
138 typedef struct tagMSIVIEWOPS
139 {
140     /*
141      * fetch_int - reads one integer from {row,col} in the table
142      *
143      *  This function should be called after the execute method.
144      *  Data returned by the function should not change until
145      *   close or delete is called.
146      *  To get a string value, query the database's string table with
147      *   the integer value returned from this function.
148      */
149     UINT (*fetch_int)( struct tagMSIVIEW *view, UINT row, UINT col, UINT *val );
150
151     /*
152      * fetch_stream - gets a stream from {row,col} in the table
153      *
154      *  This function is similar to fetch_int, except fetches a
155      *    stream instead of an integer.
156      */
157     UINT (*fetch_stream)( struct tagMSIVIEW *view, UINT row, UINT col, IStream **stm );
158
159     /*
160      * get_row - gets values from a row
161      *
162      */
163     UINT (*get_row)( struct tagMSIVIEW *view, UINT row, MSIRECORD **rec );
164
165     /*
166      * set_row - sets values in a row as specified by mask
167      *
168      *  Similar semantics to fetch_int
169      */
170     UINT (*set_row)( struct tagMSIVIEW *view, UINT row, MSIRECORD *rec, UINT mask );
171
172     /*
173      * Inserts a new row into the database from the records contents
174      */
175     UINT (*insert_row)( struct tagMSIVIEW *view, MSIRECORD *record, BOOL temporary );
176
177     /*
178      * Deletes a row from the database
179      */
180     UINT (*delete_row)( struct tagMSIVIEW *view, UINT row );
181
182     /*
183      * execute - loads the underlying data into memory so it can be read
184      */
185     UINT (*execute)( struct tagMSIVIEW *view, MSIRECORD *record );
186
187     /*
188      * close - clears the data read by execute from memory
189      */
190     UINT (*close)( struct tagMSIVIEW *view );
191
192     /*
193      * get_dimensions - returns the number of rows or columns in a table.
194      *
195      *  The number of rows can only be queried after the execute method
196      *   is called. The number of columns can be queried at any time.
197      */
198     UINT (*get_dimensions)( struct tagMSIVIEW *view, UINT *rows, UINT *cols );
199
200     /*
201      * get_column_info - returns the name and type of a specific column
202      *
203      *  The name is HeapAlloc'ed by this function and should be freed by
204      *   the caller.
205      *  The column information can be queried at any time.
206      */
207     UINT (*get_column_info)( struct tagMSIVIEW *view, UINT n, LPWSTR *name, UINT *type );
208
209     /*
210      * modify - not yet implemented properly
211      */
212     UINT (*modify)( struct tagMSIVIEW *view, MSIMODIFY eModifyMode, MSIRECORD *record, UINT row );
213
214     /*
215      * delete - destroys the structure completely
216      */
217     UINT (*delete)( struct tagMSIVIEW * );
218
219     /*
220      * find_matching_rows - iterates through rows that match a value
221      *
222      * If the column type is a string then a string ID should be passed in.
223      *  If the value to be looked up is an integer then no transformation of
224      *  the input value is required, except if the column is a string, in which
225      *  case a string ID should be passed in.
226      * The handle is an input/output parameter that keeps track of the current
227      *  position in the iteration. It must be initialised to zero before the
228      *  first call and continued to be passed in to subsequent calls.
229      */
230     UINT (*find_matching_rows)( struct tagMSIVIEW *view, UINT col, UINT val, UINT *row, MSIITERHANDLE *handle );
231
232     /*
233      * add_ref - increases the reference count of the table
234      */
235     UINT (*add_ref)( struct tagMSIVIEW *view );
236
237     /*
238      * release - decreases the reference count of the table
239      */
240     UINT (*release)( struct tagMSIVIEW *view );
241
242     /*
243      * add_column - adds a column to the table
244      */
245     UINT (*add_column)( struct tagMSIVIEW *view, LPCWSTR table, UINT number, LPCWSTR column, UINT type, BOOL hold );
246
247     /*
248      * remove_column - removes the column represented by table name and column number from the table
249      */
250     UINT (*remove_column)( struct tagMSIVIEW *view, LPCWSTR table, UINT number );
251 } MSIVIEWOPS;
252
253 struct tagMSIVIEW
254 {
255     MSIOBJECTHDR hdr;
256     const MSIVIEWOPS *ops;
257 };
258
259 struct msi_dialog_tag;
260 typedef struct msi_dialog_tag msi_dialog;
261
262 typedef struct tagMSIPACKAGE
263 {
264     MSIOBJECTHDR hdr;
265     MSIDATABASE *db;
266     struct list components;
267     struct list features;
268     struct list files;
269     struct list tempfiles;
270     struct list folders;
271     LPWSTR ActionFormat;
272     LPWSTR LastAction;
273
274     struct list classes;
275     struct list extensions;
276     struct list progids;
277     struct list mimes;
278     struct list appids;
279
280     struct tagMSISCRIPT *script;
281
282     struct list RunningActions;
283
284     LPWSTR BaseURL;
285     LPWSTR PackagePath;
286     LPWSTR ProductCode;
287
288     UINT CurrentInstallState;
289     msi_dialog *dialog;
290     LPWSTR next_dialog;
291     float center_x;
292     float center_y;
293
294     UINT WordCount;
295
296     struct list subscriptions;
297
298     struct list sourcelist_info;
299     struct list sourcelist_media;
300
301     unsigned char scheduled_action_running : 1;
302     unsigned char commit_action_running : 1;
303     unsigned char rollback_action_running : 1;
304 } MSIPACKAGE;
305
306 typedef struct tagMSIPREVIEW
307 {
308     MSIOBJECTHDR hdr;
309     MSIPACKAGE *package;
310     msi_dialog *dialog;
311 } MSIPREVIEW;
312
313 #define MSI_MAX_PROPS 20
314
315 typedef struct tagMSISUMMARYINFO
316 {
317     MSIOBJECTHDR hdr;
318     IStorage *storage;
319     DWORD update_count;
320     PROPVARIANT property[MSI_MAX_PROPS];
321 } MSISUMMARYINFO;
322
323 typedef struct tagMSIFEATURE
324 {
325     struct list entry;
326     LPWSTR Feature;
327     LPWSTR Feature_Parent;
328     LPWSTR Title;
329     LPWSTR Description;
330     INT Display;
331     INT Level;
332     LPWSTR Directory;
333     INT Attributes;
334     INSTALLSTATE Installed;
335     INSTALLSTATE ActionRequest;
336     INSTALLSTATE Action;
337     struct list Children;
338     struct list Components;
339     INT Cost;
340 } MSIFEATURE;
341
342 typedef struct tagMSICOMPONENT
343 {
344     struct list entry;
345     DWORD magic;
346     LPWSTR Component;
347     LPWSTR ComponentId;
348     LPWSTR Directory;
349     INT Attributes;
350     LPWSTR Condition;
351     LPWSTR KeyPath;
352     INSTALLSTATE Installed;
353     INSTALLSTATE ActionRequest;
354     INSTALLSTATE Action;
355     BOOL ForceLocalState;
356     BOOL Enabled;
357     INT  Cost;
358     INT  RefCount;
359     LPWSTR FullKeypath;
360     LPWSTR AdvertiseString;
361
362     unsigned int hasAdvertiseFeature:1;
363     unsigned int hasLocalFeature:1;
364     unsigned int hasSourceFeature:1;
365 } MSICOMPONENT;
366
367 typedef struct tagComponentList
368 {
369     struct list entry;
370     MSICOMPONENT *component;
371 } ComponentList;
372
373 typedef struct tagFeatureList
374 {
375     struct list entry;
376     MSIFEATURE *feature;
377 } FeatureList;
378
379 typedef struct tagMSIFOLDER
380 {
381     struct list entry;
382     LPWSTR Directory;
383     LPWSTR Parent;
384     LPWSTR TargetDefault;
385     LPWSTR SourceLongPath;
386     LPWSTR SourceShortPath;
387
388     LPWSTR ResolvedTarget;
389     LPWSTR ResolvedSource;
390     LPWSTR Property;   /* initially set property */
391     INT   State;
392         /* 0 = uninitialized */
393         /* 1 = existing */
394         /* 2 = created remove if empty */
395         /* 3 = created persist if empty */
396     INT   Cost;
397     INT   Space;
398 } MSIFOLDER;
399
400 typedef enum _msi_file_state {
401     msifs_invalid,
402     msifs_missing,
403     msifs_overwrite,
404     msifs_present,
405     msifs_installed,
406     msifs_skipped,
407 } msi_file_state;
408
409 typedef struct tagMSIFILE
410 {
411     struct list entry;
412     LPWSTR File;
413     MSICOMPONENT *Component;
414     LPWSTR FileName;
415     LPWSTR ShortName;
416     LPWSTR LongName;
417     INT FileSize;
418     LPWSTR Version;
419     LPWSTR Language;
420     INT Attributes;
421     INT Sequence;
422     msi_file_state state;
423     LPWSTR  SourcePath;
424     LPWSTR  TargetPath;
425     BOOL IsCompressed;
426 } MSIFILE;
427
428 typedef struct tagMSITEMPFILE
429 {
430     struct list entry;
431     LPWSTR Path;
432 } MSITEMPFILE;
433
434 typedef struct tagMSIAPPID
435 {
436     struct list entry;
437     LPWSTR AppID; /* Primary key */
438     LPWSTR RemoteServerName;
439     LPWSTR LocalServer;
440     LPWSTR ServiceParameters;
441     LPWSTR DllSurrogate;
442     BOOL ActivateAtStorage;
443     BOOL RunAsInteractiveUser;
444 } MSIAPPID;
445
446 typedef struct tagMSIPROGID MSIPROGID;
447
448 typedef struct tagMSICLASS
449 {
450     struct list entry;
451     LPWSTR clsid;     /* Primary Key */
452     LPWSTR Context;   /* Primary Key */
453     MSICOMPONENT *Component;
454     MSIPROGID *ProgID;
455     LPWSTR ProgIDText;
456     LPWSTR Description;
457     MSIAPPID *AppID;
458     LPWSTR FileTypeMask;
459     LPWSTR IconPath;
460     LPWSTR DefInprocHandler;
461     LPWSTR DefInprocHandler32;
462     LPWSTR Argument;
463     MSIFEATURE *Feature;
464     INT Attributes;
465     /* not in the table, set during installation */
466     BOOL Installed;
467 } MSICLASS;
468
469 typedef struct tagMSIMIME MSIMIME;
470
471 typedef struct tagMSIEXTENSION
472 {
473     struct list entry;
474     LPWSTR Extension;  /* Primary Key */
475     MSICOMPONENT *Component;
476     MSIPROGID *ProgID;
477     LPWSTR ProgIDText;
478     MSIMIME *Mime;
479     MSIFEATURE *Feature;
480     /* not in the table, set during installation */
481     BOOL Installed;
482     struct list verbs;
483 } MSIEXTENSION;
484
485 struct tagMSIPROGID
486 {
487     struct list entry;
488     LPWSTR ProgID;  /* Primary Key */
489     MSIPROGID *Parent;
490     MSICLASS *Class;
491     LPWSTR Description;
492     LPWSTR IconPath;
493     /* not in the table, set during installation */
494     BOOL InstallMe;
495     MSIPROGID *CurVer;
496     MSIPROGID *VersionInd;
497 };
498
499 typedef struct tagMSIVERB
500 {
501     struct list entry;
502     LPWSTR Verb;
503     INT Sequence;
504     LPWSTR Command;
505     LPWSTR Argument;
506 } MSIVERB;
507
508 struct tagMSIMIME
509 {
510     struct list entry;
511     LPWSTR ContentType;  /* Primary Key */
512     MSIEXTENSION *Extension;
513     LPWSTR clsid;
514     MSICLASS *Class;
515     /* not in the table, set during installation */
516     BOOL InstallMe;
517 };
518
519 enum SCRIPTS {
520     INSTALL_SCRIPT = 0,
521     COMMIT_SCRIPT = 1,
522     ROLLBACK_SCRIPT = 2,
523     TOTAL_SCRIPTS = 3
524 };
525
526 #define SEQUENCE_UI       0x1
527 #define SEQUENCE_EXEC     0x2
528 #define SEQUENCE_INSTALL  0x10
529
530 typedef struct tagMSISCRIPT
531 {
532     LPWSTR  *Actions[TOTAL_SCRIPTS];
533     UINT    ActionCount[TOTAL_SCRIPTS];
534     BOOL    ExecuteSequenceRun;
535     BOOL    CurrentlyScripting;
536     UINT    InWhatSequence;
537     LPWSTR  *UniqueActions;
538     UINT    UniqueActionsCount;
539 } MSISCRIPT;
540
541 #define MSIHANDLETYPE_ANY 0
542 #define MSIHANDLETYPE_DATABASE 1
543 #define MSIHANDLETYPE_SUMMARYINFO 2
544 #define MSIHANDLETYPE_VIEW 3
545 #define MSIHANDLETYPE_RECORD 4
546 #define MSIHANDLETYPE_PACKAGE 5
547 #define MSIHANDLETYPE_PREVIEW 6
548
549 #define MSI_MAJORVERSION 3
550 #define MSI_MINORVERSION 1
551 #define MSI_BUILDNUMBER 4000
552
553 #define GUID_SIZE 39
554
555 #define MSIHANDLE_MAGIC 0x4d434923
556
557 DEFINE_GUID(CLSID_IMsiServer,   0x000C101C,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
558 DEFINE_GUID(CLSID_IMsiServerX1, 0x000C103E,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
559 DEFINE_GUID(CLSID_IMsiServerX2, 0x000C1090,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
560 DEFINE_GUID(CLSID_IMsiServerX3, 0x000C1094,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
561
562 DEFINE_GUID(CLSID_IMsiServerMessage, 0x000C101D,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
563
564 DEFINE_GUID(CLSID_IWineMsiRemoteCustomAction,0xBA26E6FA,0x4F27,0x4f56,0x95,0x3A,0x3F,0x90,0x27,0x20,0x18,0xAA);
565 DEFINE_GUID(CLSID_IWineMsiRemotePackage,0x902b3592,0x9d08,0x4dfd,0xa5,0x93,0xd0,0x7c,0x52,0x54,0x64,0x21);
566
567 /* handle unicode/ascii output in the Msi* API functions */
568 typedef struct {
569     BOOL unicode;
570     union {
571        LPSTR a;
572        LPWSTR w;
573     } str;
574 } awstring;
575
576 typedef struct {
577     BOOL unicode;
578     union {
579        LPCSTR a;
580        LPCWSTR w;
581     } str;
582 } awcstring;
583
584 UINT msi_strcpy_to_awstring( LPCWSTR str, awstring *awbuf, DWORD *sz );
585
586 /* msi server interface */
587 extern ITypeLib *get_msi_typelib( LPWSTR *path );
588 extern HRESULT create_msi_custom_remote( IUnknown *pOuter, LPVOID *ppObj );
589 extern HRESULT create_msi_remote_package( IUnknown *pOuter, LPVOID *ppObj );
590 extern IUnknown *msi_get_remote(MSIHANDLE handle);
591
592 /* handle functions */
593 extern void *msihandle2msiinfo(MSIHANDLE handle, UINT type);
594 extern MSIHANDLE alloc_msihandle( MSIOBJECTHDR * );
595 extern MSIHANDLE alloc_msi_remote_handle( IUnknown *unk );
596 extern void *alloc_msiobject(UINT type, UINT size, msihandledestructor destroy );
597 extern void msiobj_addref(MSIOBJECTHDR *);
598 extern int msiobj_release(MSIOBJECTHDR *);
599 extern void msiobj_lock(MSIOBJECTHDR *);
600 extern void msiobj_unlock(MSIOBJECTHDR *);
601 extern void msi_free_handle_table(void);
602
603 extern void free_cached_tables( MSIDATABASE *db );
604 extern void msi_free_transforms( MSIDATABASE *db );
605 extern UINT MSI_CommitTables( MSIDATABASE *db );
606
607
608 /* string table functions */
609 enum StringPersistence
610 {
611     StringPersistent = 0,
612     StringNonPersistent = 1
613 };
614
615 extern BOOL msi_addstringW( string_table *st, UINT string_no, const WCHAR *data, int len, UINT refcount, enum StringPersistence persistence );
616 extern UINT msi_id2stringW( const string_table *st, UINT string_no, LPWSTR buffer, UINT *sz );
617 extern UINT msi_id2stringA( const string_table *st, UINT string_no, LPSTR buffer, UINT *sz );
618
619 extern UINT msi_string2idW( const string_table *st, LPCWSTR buffer, UINT *id );
620 extern UINT msi_string2idA( const string_table *st, LPCSTR str, UINT *id );
621 extern VOID msi_destroy_stringtable( string_table *st );
622 extern UINT msi_strcmp( const string_table *st, UINT lval, UINT rval, UINT *res );
623 extern const WCHAR *msi_string_lookup_id( const string_table *st, UINT id );
624 extern HRESULT msi_init_string_table( IStorage *stg );
625 extern string_table *msi_load_string_table( IStorage *stg, UINT *bytes_per_strref );
626 extern UINT msi_save_string_table( const string_table *st, IStorage *storage );
627
628
629 extern void msi_table_set_strref(UINT bytes_per_strref);
630 extern BOOL TABLE_Exists( MSIDATABASE *db, LPCWSTR name );
631 extern MSICONDITION MSI_DatabaseIsTablePersistent( MSIDATABASE *db, LPCWSTR table );
632
633 extern UINT read_raw_stream_data( MSIDATABASE *db, LPCWSTR stname,
634                                   USHORT **pdata, UINT *psz );
635 extern UINT read_stream_data( IStorage *stg, LPCWSTR stname, BOOL table,
636                               BYTE **pdata, UINT *psz );
637 extern UINT write_stream_data( IStorage *stg, LPCWSTR stname,
638                                LPCVOID data, UINT sz, BOOL bTable );
639
640 /* transform functions */
641 extern UINT msi_table_apply_transform( MSIDATABASE *db, IStorage *stg );
642 extern UINT MSI_DatabaseApplyTransformW( MSIDATABASE *db,
643                  LPCWSTR szTransformFile, int iErrorCond );
644 extern void append_storage_to_db( MSIDATABASE *db, IStorage *stg );
645
646 /* action internals */
647 extern UINT MSI_InstallPackage( MSIPACKAGE *, LPCWSTR, LPCWSTR );
648 extern void ACTION_free_package_structures( MSIPACKAGE* );
649 extern UINT ACTION_DialogBox( MSIPACKAGE*, LPCWSTR);
650 extern UINT ACTION_ForceReboot(MSIPACKAGE *package);
651 extern UINT MSI_Sequence( MSIPACKAGE *package, LPCWSTR szTable, INT iSequenceMode );
652 extern UINT MSI_SetFeatureStates( MSIPACKAGE *package );
653 extern UINT msi_parse_command_line( MSIPACKAGE *package, LPCWSTR szCommandLine );
654
655 /* record internals */
656 extern UINT MSI_RecordSetIStream( MSIRECORD *, UINT, IStream *);
657 extern UINT MSI_RecordGetIStream( MSIRECORD *, UINT, IStream **);
658 extern const WCHAR *MSI_RecordGetString( const MSIRECORD *, UINT );
659 extern MSIRECORD *MSI_CreateRecord( UINT );
660 extern UINT MSI_RecordSetInteger( MSIRECORD *, UINT, int );
661 extern UINT MSI_RecordSetStringW( MSIRECORD *, UINT, LPCWSTR );
662 extern UINT MSI_RecordSetStringA( MSIRECORD *, UINT, LPCSTR );
663 extern BOOL MSI_RecordIsNull( MSIRECORD *, UINT );
664 extern UINT MSI_RecordGetStringW( MSIRECORD * , UINT, LPWSTR, LPDWORD);
665 extern UINT MSI_RecordGetStringA( MSIRECORD *, UINT, LPSTR, LPDWORD);
666 extern int MSI_RecordGetInteger( MSIRECORD *, UINT );
667 extern UINT MSI_RecordReadStream( MSIRECORD *, UINT, char *, LPDWORD);
668 extern UINT MSI_RecordGetFieldCount( const MSIRECORD *rec );
669 extern UINT MSI_RecordSetStream( MSIRECORD *, UINT, IStream * );
670 extern UINT MSI_RecordDataSize( MSIRECORD *, UINT );
671 extern UINT MSI_RecordStreamToFile( MSIRECORD *, UINT, LPCWSTR );
672 extern UINT MSI_RecordCopyField( MSIRECORD *, UINT, MSIRECORD *, UINT );
673
674 /* stream internals */
675 extern UINT get_raw_stream( MSIHANDLE hdb, LPCWSTR stname, IStream **stm );
676 extern UINT db_get_raw_stream( MSIDATABASE *db, LPCWSTR stname, IStream **stm );
677 extern void enum_stream_names( IStorage *stg );
678 extern BOOL decode_streamname(LPCWSTR in, LPWSTR out);
679 extern LPWSTR encode_streamname(BOOL bTable, LPCWSTR in);
680
681 /* database internals */
682 extern UINT MSI_OpenDatabaseW( LPCWSTR, LPCWSTR, MSIDATABASE ** );
683 extern UINT MSI_DatabaseOpenViewW(MSIDATABASE *, LPCWSTR, MSIQUERY ** );
684 extern UINT MSI_OpenQuery( MSIDATABASE *, MSIQUERY **, LPCWSTR, ... );
685 typedef UINT (*record_func)( MSIRECORD *, LPVOID );
686 extern UINT MSI_IterateRecords( MSIQUERY *, LPDWORD, record_func, LPVOID );
687 extern MSIRECORD *MSI_QueryGetRecord( MSIDATABASE *db, LPCWSTR query, ... );
688 extern UINT MSI_DatabaseImport( MSIDATABASE *, LPCWSTR, LPCWSTR );
689 extern UINT MSI_DatabaseExport( MSIDATABASE *, LPCWSTR, LPCWSTR, LPCWSTR );
690 extern UINT MSI_DatabaseGetPrimaryKeys( MSIDATABASE *, LPCWSTR, MSIRECORD ** );
691
692 /* view internals */
693 extern UINT MSI_ViewExecute( MSIQUERY*, MSIRECORD * );
694 extern UINT MSI_ViewFetch( MSIQUERY*, MSIRECORD ** );
695 extern UINT MSI_ViewClose( MSIQUERY* );
696 extern UINT MSI_ViewGetColumnInfo(MSIQUERY *, MSICOLINFO, MSIRECORD **);
697 extern UINT MSI_ViewModify( MSIQUERY *, MSIMODIFY, MSIRECORD * );
698 extern UINT VIEW_find_column( MSIVIEW *, LPCWSTR, UINT * );
699 extern UINT msi_view_get_row(MSIDATABASE *, MSIVIEW *, UINT, MSIRECORD **);
700
701 /* install internals */
702 extern UINT MSI_SetInstallLevel( MSIPACKAGE *package, int iInstallLevel );
703
704 /* package internals */
705 extern MSIPACKAGE *MSI_CreatePackage( MSIDATABASE *, LPCWSTR );
706 extern UINT MSI_OpenPackageW( LPCWSTR szPackage, MSIPACKAGE **pPackage );
707 extern UINT MSI_SetTargetPathW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
708 extern UINT MSI_SetPropertyW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
709 extern INT MSI_ProcessMessage( MSIPACKAGE *, INSTALLMESSAGE, MSIRECORD * );
710 extern UINT MSI_GetPropertyW( MSIPACKAGE *, LPCWSTR, LPWSTR, LPDWORD );
711 extern UINT MSI_GetPropertyA(MSIPACKAGE *, LPCSTR, LPSTR, LPDWORD );
712 extern MSICONDITION MSI_EvaluateConditionW( MSIPACKAGE *, LPCWSTR );
713 extern UINT MSI_GetComponentStateW( MSIPACKAGE *, LPCWSTR, INSTALLSTATE *, INSTALLSTATE * );
714 extern UINT MSI_GetFeatureStateW( MSIPACKAGE *, LPCWSTR, INSTALLSTATE *, INSTALLSTATE * );
715 extern UINT WINAPI MSI_SetFeatureStateW(MSIPACKAGE*, LPCWSTR, INSTALLSTATE );
716 extern LPCWSTR msi_download_file( LPCWSTR szUrl, LPWSTR filename );
717 extern UINT msi_package_add_info(MSIPACKAGE *, DWORD, DWORD, LPCWSTR, LPWSTR);
718 extern UINT msi_package_add_media_disk(MSIPACKAGE *, DWORD, DWORD, DWORD, LPWSTR, LPWSTR);
719 extern UINT msi_clone_properties(MSIPACKAGE *);
720
721 /* for deformating */
722 extern UINT MSI_FormatRecordW( MSIPACKAGE *, MSIRECORD *, LPWSTR, LPDWORD );
723
724 /* registry data encoding/decoding functions */
725 extern BOOL unsquash_guid(LPCWSTR in, LPWSTR out);
726 extern BOOL squash_guid(LPCWSTR in, LPWSTR out);
727 extern BOOL encode_base85_guid(GUID *,LPWSTR);
728 extern BOOL decode_base85_guid(LPCWSTR,GUID*);
729 extern UINT MSIREG_OpenUninstallKey(LPCWSTR szProduct, HKEY* key, BOOL create);
730 extern UINT MSIREG_OpenUserProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
731 extern UINT MSIREG_OpenUserPatchesKey(LPCWSTR szPatch, HKEY* key, BOOL create);
732 extern UINT MSIREG_OpenFeatures(HKEY* key);
733 extern UINT MSIREG_OpenFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
734 extern UINT MSIREG_OpenUserDataFeaturesKey(LPCWSTR szProduct, HKEY *key, BOOL create);
735 extern UINT MSIREG_OpenComponents(HKEY* key);
736 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
737 extern UINT MSIREG_OpenComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
738 extern UINT MSIREG_OpenUserDataComponentKey(LPCWSTR szComponent, HKEY *key, BOOL create);
739 extern UINT MSIREG_OpenProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
740 extern UINT MSIREG_OpenPatchesKey(LPCWSTR szPatch, HKEY* key, BOOL create);
741 extern UINT MSIREG_OpenUserDataProductKey(LPCWSTR szProduct, HKEY* key, BOOL create);
742 extern UINT MSIREG_OpenInstallPropertiesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
743 extern UINT MSIREG_OpenUserFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
744 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
745 extern UINT MSIREG_OpenUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
746 extern UINT MSIREG_OpenUserUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
747 extern UINT MSIREG_DeleteProductKey(LPCWSTR szProduct);
748 extern UINT MSIREG_DeleteUserProductKey(LPCWSTR szProduct);
749 extern UINT MSIREG_DeleteUserDataProductKey(LPCWSTR szProduct);
750 extern UINT MSIREG_OpenLocalSystemProductKey(LPCWSTR szProductCode, HKEY *key, BOOL create);
751 extern UINT MSIREG_OpenLocalSystemComponentKey(LPCWSTR szComponent, HKEY *key, BOOL create);
752 extern UINT MSIREG_OpenLocalClassesProductKey(LPCWSTR szProductCode, HKEY *key, BOOL create);
753 extern UINT MSIREG_OpenLocalManagedProductKey(LPCWSTR szProductCode, HKEY *key, BOOL create);
754 extern UINT MSIREG_DeleteUserFeaturesKey(LPCWSTR szProduct);
755
756 extern LPWSTR msi_reg_get_val_str( HKEY hkey, LPCWSTR name );
757 extern BOOL msi_reg_get_val_dword( HKEY hkey, LPCWSTR name, DWORD *val);
758
759 extern DWORD msi_version_str_to_dword(LPCWSTR p);
760 extern LPWSTR msi_version_dword_to_str(DWORD version);
761
762 extern LONG msi_reg_set_val_str( HKEY hkey, LPCWSTR name, LPCWSTR value );
763 extern LONG msi_reg_set_val_multi_str( HKEY hkey, LPCWSTR name, LPCWSTR value );
764 extern LONG msi_reg_set_val_dword( HKEY hkey, LPCWSTR name, DWORD val );
765 extern LONG msi_reg_set_subkey_val( HKEY hkey, LPCWSTR path, LPCWSTR name, LPCWSTR val );
766
767 /* msi dialog interface */
768 typedef UINT (*msi_dialog_event_handler)( MSIPACKAGE*, LPCWSTR, LPCWSTR, msi_dialog* );
769 extern msi_dialog *msi_dialog_create( MSIPACKAGE*, LPCWSTR, msi_dialog*, msi_dialog_event_handler );
770 extern UINT msi_dialog_run_message_loop( msi_dialog* );
771 extern void msi_dialog_end_dialog( msi_dialog* );
772 extern void msi_dialog_check_messages( HANDLE );
773 extern void msi_dialog_do_preview( msi_dialog* );
774 extern void msi_dialog_destroy( msi_dialog* );
775 extern BOOL msi_dialog_register_class( void );
776 extern void msi_dialog_unregister_class( void );
777 extern void msi_dialog_handle_event( msi_dialog*, LPCWSTR, LPCWSTR, MSIRECORD * );
778 extern UINT msi_dialog_reset( msi_dialog *dialog );
779 extern UINT msi_dialog_directorylist_up( msi_dialog *dialog );
780 extern msi_dialog *msi_dialog_get_parent( msi_dialog *dialog );
781 extern LPWSTR msi_dialog_get_name( msi_dialog *dialog );
782 extern UINT msi_spawn_error_dialog( MSIPACKAGE*, LPWSTR, LPWSTR );
783
784 /* preview */
785 extern MSIPREVIEW *MSI_EnableUIPreview( MSIDATABASE * );
786 extern UINT MSI_PreviewDialogW( MSIPREVIEW *, LPCWSTR );
787
788 /* summary information */
789 extern MSISUMMARYINFO *MSI_GetSummaryInformationW( IStorage *stg, UINT uiUpdateCount );
790 extern LPWSTR msi_suminfo_dup_string( MSISUMMARYINFO *si, UINT uiProperty );
791 extern LPWSTR msi_get_suminfo_product( IStorage *stg );
792
793 /* undocumented functions */
794 UINT WINAPI MsiCreateAndVerifyInstallerDirectory( DWORD );
795 UINT WINAPI MsiDecomposeDescriptorW( LPCWSTR, LPWSTR, LPWSTR, LPWSTR, LPDWORD );
796 UINT WINAPI MsiDecomposeDescriptorA( LPCSTR, LPSTR, LPSTR, LPSTR, LPDWORD );
797 LANGID WINAPI MsiLoadStringW( MSIHANDLE, UINT, LPWSTR, int, LANGID );
798 LANGID WINAPI MsiLoadStringA( MSIHANDLE, UINT, LPSTR, int, LANGID );
799
800 /* UI globals */
801 extern INSTALLUILEVEL gUILevel;
802 extern HWND gUIhwnd;
803 extern INSTALLUI_HANDLERA gUIHandlerA;
804 extern INSTALLUI_HANDLERW gUIHandlerW;
805 extern DWORD gUIFilter;
806 extern LPVOID gUIContext;
807 extern WCHAR gszLogFile[MAX_PATH];
808 extern HINSTANCE msi_hInstance;
809
810 /* action related functions */
811 extern UINT ACTION_PerformAction(MSIPACKAGE *package, const WCHAR *action, UINT script, BOOL force);
812 extern UINT ACTION_PerformUIAction(MSIPACKAGE *package, const WCHAR *action, UINT script);
813 extern void ACTION_FinishCustomActions( const MSIPACKAGE* package);
814 extern UINT ACTION_CustomAction(MSIPACKAGE *package,const WCHAR *action, UINT script, BOOL execute);
815
816 static inline void msi_feature_set_state( MSIFEATURE *feature, INSTALLSTATE state )
817 {
818     feature->ActionRequest = state;
819     feature->Action = state;
820 }
821
822 static inline void msi_component_set_state( MSICOMPONENT *comp, INSTALLSTATE state )
823 {
824     comp->ActionRequest = state;
825     comp->Action = state;
826 }
827
828 /* actions in other modules */
829 extern UINT ACTION_AppSearch(MSIPACKAGE *package);
830 extern UINT ACTION_FindRelatedProducts(MSIPACKAGE *package);
831 extern UINT ACTION_InstallFiles(MSIPACKAGE *package);
832 extern UINT ACTION_RemoveFiles(MSIPACKAGE *package);
833 extern UINT ACTION_DuplicateFiles(MSIPACKAGE *package);
834 extern UINT ACTION_RegisterClassInfo(MSIPACKAGE *package);
835 extern UINT ACTION_RegisterProgIdInfo(MSIPACKAGE *package);
836 extern UINT ACTION_RegisterExtensionInfo(MSIPACKAGE *package);
837 extern UINT ACTION_RegisterMIMEInfo(MSIPACKAGE *package);
838 extern UINT ACTION_RegisterFonts(MSIPACKAGE *package);
839
840 /* Helpers */
841 extern DWORD deformat_string(MSIPACKAGE *package, LPCWSTR ptr, WCHAR** data );
842 extern LPWSTR msi_dup_record_field(MSIRECORD *row, INT index);
843 extern LPWSTR msi_dup_property(MSIPACKAGE *package, LPCWSTR prop);
844 extern int msi_get_property_int( MSIPACKAGE *package, LPCWSTR prop, int def );
845 extern LPWSTR resolve_folder(MSIPACKAGE *package, LPCWSTR name, BOOL source,
846                       BOOL set_prop, BOOL load_prop, MSIFOLDER **folder);
847 extern MSICOMPONENT *get_loaded_component( MSIPACKAGE* package, LPCWSTR Component );
848 extern MSIFEATURE *get_loaded_feature( MSIPACKAGE* package, LPCWSTR Feature );
849 extern MSIFILE *get_loaded_file( MSIPACKAGE* package, LPCWSTR file );
850 extern MSIFOLDER *get_loaded_folder( MSIPACKAGE *package, LPCWSTR dir );
851 extern int track_tempfile(MSIPACKAGE *package, LPCWSTR path);
852 extern UINT schedule_action(MSIPACKAGE *package, UINT script, LPCWSTR action);
853 extern void msi_free_action_script(MSIPACKAGE *package, UINT script);
854 extern LPWSTR build_icon_path(MSIPACKAGE *, LPCWSTR);
855 extern LPWSTR build_directory_name(DWORD , ...);
856 extern BOOL create_full_pathW(const WCHAR *path);
857 extern BOOL ACTION_VerifyComponentForAction(const MSICOMPONENT*, INSTALLSTATE);
858 extern BOOL ACTION_VerifyFeatureForAction(const MSIFEATURE*, INSTALLSTATE);
859 extern void reduce_to_longfilename(WCHAR*);
860 extern void reduce_to_shortfilename(WCHAR*);
861 extern LPWSTR create_component_advertise_string(MSIPACKAGE*, MSICOMPONENT*, LPCWSTR);
862 extern void ACTION_UpdateComponentStates(MSIPACKAGE *package, LPCWSTR szFeature);
863 extern UINT register_unique_action(MSIPACKAGE *, LPCWSTR);
864 extern BOOL check_unique_action(const MSIPACKAGE *, LPCWSTR);
865 extern WCHAR* generate_error_string(MSIPACKAGE *, UINT, DWORD, ... );
866 extern UINT msi_create_component_directories( MSIPACKAGE *package );
867 extern void msi_ui_error( DWORD msg_id, DWORD type );
868
869 /* control event stuff */
870 extern VOID ControlEvent_FireSubscribedEvent(MSIPACKAGE *package, LPCWSTR event,
871                                       MSIRECORD *data);
872 extern VOID ControlEvent_CleanupDialogSubscriptions(MSIPACKAGE *package, LPWSTR dialog);
873 extern VOID ControlEvent_CleanupSubscriptions(MSIPACKAGE *package);
874 extern VOID ControlEvent_SubscribeToEvent(MSIPACKAGE *package, msi_dialog *dialog,
875                                       LPCWSTR event, LPCWSTR control, LPCWSTR attribute);
876 extern VOID ControlEvent_UnSubscribeToEvent( MSIPACKAGE *package, LPCWSTR event,
877                                       LPCWSTR control, LPCWSTR attribute );
878
879 /* OLE automation */
880 extern HRESULT create_msiserver(IUnknown *pOuter, LPVOID *ppObj);
881 extern HRESULT create_session(MSIHANDLE msiHandle, IDispatch *pInstaller, IDispatch **pDispatch);
882 extern HRESULT load_type_info(IDispatch *iface, ITypeInfo **pptinfo, REFIID clsid, LCID lcid);
883
884 /* Scripting */
885 extern DWORD call_script(MSIHANDLE hPackage, INT type, LPCWSTR script, LPCWSTR function, LPCWSTR action);
886
887 /* User Interface messages from the actions */
888 extern void ui_progress(MSIPACKAGE *, int, int, int, int);
889 extern void ui_actiondata(MSIPACKAGE *, LPCWSTR, MSIRECORD *);
890
891 /* string consts use a number of places  and defined in helpers.c*/
892 extern const WCHAR cszSourceDir[];
893 extern const WCHAR cszSOURCEDIR[];
894 extern const WCHAR szProductCode[];
895 extern const WCHAR cszRootDrive[];
896 extern const WCHAR cszbs[];
897
898 /* memory allocation macro functions */
899 static inline void *msi_alloc( size_t len )
900 {
901     return HeapAlloc( GetProcessHeap(), 0, len );
902 }
903
904 static inline void *msi_alloc_zero( size_t len )
905 {
906     return HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, len );
907 }
908
909 static inline void *msi_realloc( void *mem, size_t len )
910 {
911     return HeapReAlloc( GetProcessHeap(), 0, mem, len );
912 }
913
914 static inline void *msi_realloc_zero( void *mem, size_t len )
915 {
916     return HeapReAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, mem, len );
917 }
918
919 static inline BOOL msi_free( void *mem )
920 {
921     return HeapFree( GetProcessHeap(), 0, mem );
922 }
923
924 static inline char *strdupWtoA( LPCWSTR str )
925 {
926     LPSTR ret = NULL;
927     DWORD len;
928
929     if (!str) return ret;
930     len = WideCharToMultiByte( CP_ACP, 0, str, -1, NULL, 0, NULL, NULL);
931     ret = msi_alloc( len );
932     if (ret)
933         WideCharToMultiByte( CP_ACP, 0, str, -1, ret, len, NULL, NULL );
934     return ret;
935 }
936
937 static inline LPWSTR strdupAtoW( LPCSTR str )
938 {
939     LPWSTR ret = NULL;
940     DWORD len;
941
942     if (!str) return ret;
943     len = MultiByteToWideChar( CP_ACP, 0, str, -1, NULL, 0 );
944     ret = msi_alloc( len * sizeof(WCHAR) );
945     if (ret)
946         MultiByteToWideChar( CP_ACP, 0, str, -1, ret, len );
947     return ret;
948 }
949
950 static inline LPWSTR strdupW( LPCWSTR src )
951 {
952     LPWSTR dest;
953     if (!src) return NULL;
954     dest = msi_alloc( (lstrlenW(src)+1)*sizeof(WCHAR) );
955     if (dest)
956         lstrcpyW(dest, src);
957     return dest;
958 }
959
960 #endif /* __WINE_MSI_PRIVATE__ */