dlls/msi/msipriv.h

   1 /*
   2  * Implementation of the Microsoft Installer (msi.dll)
   3  *
   4  * Copyright 2002-2005 Mike McCormack for CodeWeavers
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #ifndef __WINE_MSI_PRIVATE__
  22 #define __WINE_MSI_PRIVATE__
  23
  24 #include <stdarg.h>
  25
  26 #include "windef.h"
  27 #include "winbase.h"
  28 #include "msi.h"
  29 #include "msiquery.h"
  30 #include "objbase.h"
  31 #include "objidl.h"
  32 #include "wine/unicode.h"
  33 #include "wine/list.h"
  34
  35 #define MSI_DATASIZEMASK 0x00ff
  36 #define MSITYPE_VALID    0x0100
  37 #define MSITYPE_STRING   0x0800
  38 #define MSITYPE_NULLABLE 0x1000
  39 #define MSITYPE_KEY      0x2000
  40
  41 #define MSITYPE_BINARY 0x8900
  42
  43 struct tagMSITABLE;
  44 typedef struct tagMSITABLE MSITABLE;
  45
  46 struct string_table;
  47 typedef struct string_table string_table;
  48
  49 struct tagMSIOBJECTHDR;
  50 typedef struct tagMSIOBJECTHDR MSIOBJECTHDR;
  51
  52 typedef VOID (*msihandledestructor)( MSIOBJECTHDR * );
  53
  54 struct tagMSIOBJECTHDR
  55 {
  56     UINT magic;
  57     UINT type;
  58     DWORD refcount;
  59     msihandledestructor destructor;
  60     struct tagMSIOBJECTHDR *next;
  61     struct tagMSIOBJECTHDR *prev;
  62 };
  63
  64 typedef struct tagMSIDATABASE
  65 {
  66     MSIOBJECTHDR hdr;
  67     IStorage *storage;
  68     string_table *strings;
  69     LPWSTR mode;
  70     MSITABLE *first_table, *last_table;
  71 } MSIDATABASE;
  72
  73 typedef struct tagMSIVIEW MSIVIEW;
  74
  75 typedef struct tagMSIQUERY
  76 {
  77     MSIOBJECTHDR hdr;
  78     MSIVIEW *view;
  79     UINT row;
  80     MSIDATABASE *db;
  81     struct list mem;
  82 } MSIQUERY;
  83
  84 /* maybe we can use a Variant instead of doing it ourselves? */
  85 typedef struct tagMSIFIELD
  86 {
  87     UINT type;
  88     union
  89     {
  90         INT iVal;
  91         LPWSTR szwVal;
  92         IStream *stream;
  93     } u;
  94 } MSIFIELD;
  95
  96 typedef struct tagMSIRECORD
  97 {
  98     MSIOBJECTHDR hdr;
  99     UINT count;       /* as passed to MsiCreateRecord */
 100     MSIFIELD fields[1]; /* nb. array size is count+1 */
 101 } MSIRECORD;
 102
 103 typedef struct tagMSIVIEWOPS
 104 {
 105     /*
 106      * fetch_int - reads one integer from {row,col} in the table
 107      *
 108      *  This function should be called after the execute method.
 109      *  Data returned by the function should not change until
 110      *   close or delete is called.
 111      *  To get a string value, query the database's string table with
 112      *   the integer value returned from this function.
 113      */
 114     UINT (*fetch_int)( struct tagMSIVIEW *, UINT row, UINT col, UINT *val );
 115
 116     /*
 117      * fetch_int - reads one integer from {row,col} in the table
 118      *
 119      *  This function is similar to fetch_int, except fetches a
 120      *    stream instead of an integer.
 121      */
 122     UINT (*fetch_stream)( struct tagMSIVIEW *, UINT row, UINT col, IStream **stm );
 123
 124     /*
 125      * get_int - sets one integer at {row,col} in the table
 126      *
 127      *  Similar semantics to fetch_int
 128      */
 129     UINT (*set_int)( struct tagMSIVIEW *, UINT row, UINT col, UINT val );
 130
 131     /*
 132      * Inserts a new, blank row into the database
 133      *  *row receives the number of the new row
 134      */
 135     UINT (*insert_row)( struct tagMSIVIEW *, UINT *row );
 136
 137     /*
 138      * execute - loads the underlying data into memory so it can be read
 139      */
 140     UINT (*execute)( struct tagMSIVIEW *, MSIRECORD * );
 141
 142     /*
 143      * close - clears the data read by execute from memory
 144      */
 145     UINT (*close)( struct tagMSIVIEW * );
 146
 147     /*
 148      * get_dimensions - returns the number of rows or columns in a table.
 149      *
 150      *  The number of rows can only be queried after the execute method
 151      *   is called. The number of columns can be queried at any time.
 152      */
 153     UINT (*get_dimensions)( struct tagMSIVIEW *, UINT *rows, UINT *cols );
 154
 155     /*
 156      * get_column_info - returns the name and type of a specific column
 157      *
 158      *  The name is HeapAlloc'ed by this function and should be freed by
 159      *   the caller.
 160      *  The column information can be queried at any time.
 161      */
 162     UINT (*get_column_info)( struct tagMSIVIEW *, UINT n, LPWSTR *name, UINT *type );
 163
 164     /*
 165      * modify - not yet implemented properly
 166      */
 167     UINT (*modify)( struct tagMSIVIEW *, MSIMODIFY, MSIRECORD * );
 168
 169     /*
 170      * delete - destroys the structure completely
 171      */
 172     UINT (*delete)( struct tagMSIVIEW * );
 173
 174 } MSIVIEWOPS;
 175
 176 struct tagMSIVIEW
 177 {
 178     MSIOBJECTHDR hdr;
 179     MSIVIEWOPS   *ops;
 180 };
 181
 182 struct msi_dialog_tag;
 183 typedef struct msi_dialog_tag msi_dialog;
 184
 185 typedef struct tagMSIPACKAGE
 186 {
 187     MSIOBJECTHDR hdr;
 188     MSIDATABASE *db;
 189     struct tagMSIFEATURE *features;
 190     UINT loaded_features;
 191     struct tagMSIFOLDER  *folders;
 192     UINT loaded_folders;
 193     struct tagMSICOMPONENT *components;
 194     UINT loaded_components;
 195     struct tagMSIFILE *files;
 196     UINT loaded_files;
 197     LPWSTR ActionFormat;
 198     LPWSTR LastAction;
 199
 200     LPWSTR *DeferredAction;
 201     UINT DeferredActionCount;
 202
 203     LPWSTR *CommitAction;
 204     UINT CommitActionCount;
 205
 206     struct tagMSIRUNNINGACTION *RunningAction;
 207     UINT RunningActionCount;
 208
 209     LPWSTR PackagePath;
 210
 211     UINT CurrentInstallState;
 212     msi_dialog *dialog;
 213     LPWSTR next_dialog;
 214
 215     BOOL ExecuteSequenceRun;
 216 } MSIPACKAGE;
 217
 218 typedef struct tagMSIPREVIEW
 219 {
 220     MSIOBJECTHDR hdr;
 221     MSIPACKAGE *package;
 222     msi_dialog *dialog;
 223 } MSIPREVIEW;
 224
 225 #define MSIHANDLETYPE_ANY 0
 226 #define MSIHANDLETYPE_DATABASE 1
 227 #define MSIHANDLETYPE_SUMMARYINFO 2
 228 #define MSIHANDLETYPE_VIEW 3
 229 #define MSIHANDLETYPE_RECORD 4
 230 #define MSIHANDLETYPE_PACKAGE 5
 231 #define MSIHANDLETYPE_PREVIEW 6
 232
 233 #define MSI_MAJORVERSION 2
 234 #define MSI_MINORVERSION 0
 235 #define MSI_BUILDNUMBER 2600
 236
 237 #define GUID_SIZE 39
 238
 239 #define MSIHANDLE_MAGIC 0x4d434923
 240 #define MSIMAXHANDLES 0xf0
 241
 242 #define MSISUMINFO_OFFSET 0x30LL
 243
 244 DEFINE_GUID(CLSID_IMsiServer,   0x000C101C,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
 245 DEFINE_GUID(CLSID_IMsiServerX1, 0x000C103E,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
 246 DEFINE_GUID(CLSID_IMsiServerX2, 0x000C1090,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
 247 DEFINE_GUID(CLSID_IMsiServerX3, 0x000C1094,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
 248
 249 DEFINE_GUID(CLSID_IMsiServerMessage, 0x000C101D,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
 250
 251
 252 /* handle functions */
 253 extern void *msihandle2msiinfo(MSIHANDLE handle, UINT type);
 254 extern MSIHANDLE alloc_msihandle( MSIOBJECTHDR * );
 255 extern void *alloc_msiobject(UINT type, UINT size, msihandledestructor destroy );
 256 extern void msiobj_addref(MSIOBJECTHDR *);
 257 extern int msiobj_release(MSIOBJECTHDR *);
 258 extern void msiobj_lock(MSIOBJECTHDR *);
 259 extern void msiobj_unlock(MSIOBJECTHDR *);
 260 extern MSIHANDLE msiobj_findhandle( MSIOBJECTHDR *hdr );
 261
 262 /* add this table to the list of cached tables in the database */
 263 extern void add_table(MSIDATABASE *db, MSITABLE *table);
 264 extern void remove_table( MSIDATABASE *db, MSITABLE *table );
 265 extern void free_table( MSIDATABASE *db, MSITABLE *table );
 266 extern void free_cached_tables( MSIDATABASE *db );
 267 extern UINT find_cached_table(MSIDATABASE *db, LPCWSTR name, MSITABLE **table);
 268 extern UINT get_table(MSIDATABASE *db, LPCWSTR name, MSITABLE **table);
 269 extern UINT load_string_table( MSIDATABASE *db );
 270 extern UINT MSI_CommitTables( MSIDATABASE *db );
 271 extern HRESULT init_string_table( IStorage *stg );
 272
 273
 274 /* string table functions */
 275 extern BOOL msi_addstring( string_table *st, int string_no, const CHAR *data, int len, UINT refcount );
 276 extern BOOL msi_addstringW( string_table *st, int string_no, const WCHAR *data, int len, UINT refcount );
 277 extern UINT msi_id2stringW( string_table *st, UINT string_no, LPWSTR buffer, UINT *sz );
 278 extern UINT msi_id2stringA( string_table *st, UINT string_no, LPSTR buffer, UINT *sz );
 279
 280 extern LPWSTR MSI_makestring( MSIDATABASE *db, UINT stringid);
 281 extern UINT msi_string2idW( string_table *st, LPCWSTR buffer, UINT *id );
 282 extern UINT msi_string2idA( string_table *st, LPCSTR str, UINT *id );
 283 extern string_table *msi_init_stringtable( int entries, UINT codepage );
 284 extern VOID msi_destroy_stringtable( string_table *st );
 285 extern UINT msi_string_count( string_table *st );
 286 extern UINT msi_id_refcount( string_table *st, UINT i );
 287 extern UINT msi_string_totalsize( string_table *st, UINT *last );
 288 extern UINT msi_strcmp( string_table *st, UINT lval, UINT rval, UINT *res );
 289 extern const WCHAR *msi_string_lookup_id( string_table *st, UINT id );
 290 extern UINT msi_string_get_codepage( string_table *st );
 291
 292
 293 extern UINT VIEW_find_column( MSIVIEW *view, LPCWSTR name, UINT *n );
 294
 295 extern BOOL TABLE_Exists( MSIDATABASE *db, LPWSTR name );
 296
 297 extern UINT read_raw_stream_data( MSIDATABASE*, LPCWSTR stname,
 298                               USHORT **pdata, UINT *psz );
 299
 300 /* action internals */
 301 extern UINT ACTION_DoTopLevelINSTALL( MSIPACKAGE *, LPCWSTR, LPCWSTR );
 302 extern void ACTION_free_package_structures( MSIPACKAGE* );
 303 extern UINT ACTION_DialogBox( MSIPACKAGE*, LPCWSTR);
 304
 305 /* record internals */
 306 extern UINT MSI_RecordSetIStream( MSIRECORD *, unsigned int, IStream *);
 307 extern UINT MSI_RecordGetIStream( MSIRECORD *, unsigned int, IStream **);
 308 extern const WCHAR *MSI_RecordGetString( MSIRECORD *, unsigned int );
 309 extern MSIRECORD *MSI_CreateRecord( unsigned int );
 310 extern UINT MSI_RecordSetInteger( MSIRECORD *, unsigned int, int );
 311 extern UINT MSI_RecordSetStringW( MSIRECORD *, unsigned int, LPCWSTR );
 312 extern BOOL MSI_RecordIsNull( MSIRECORD *, unsigned int );
 313 extern UINT MSI_RecordGetStringW( MSIRECORD * , unsigned int, LPWSTR, DWORD *);
 314 extern UINT MSI_RecordGetStringA( MSIRECORD *, unsigned int, LPSTR, DWORD *);
 315 extern int MSI_RecordGetInteger( MSIRECORD *, unsigned int );
 316 extern UINT MSI_RecordReadStream( MSIRECORD *, unsigned int, char *, DWORD *);
 317 extern unsigned int MSI_RecordGetFieldCount( MSIRECORD *rec );
 318
 319 /* stream internals */
 320 extern UINT get_raw_stream( MSIHANDLE hdb, LPCWSTR stname, IStream **stm );
 321 extern UINT db_get_raw_stream( MSIDATABASE *db, LPCWSTR stname, IStream **stm );
 322 extern void enum_stream_names( IStorage *stg );
 323
 324 /* database internals */
 325 extern UINT MSI_OpenDatabaseW( LPCWSTR, LPCWSTR, MSIDATABASE ** );
 326 extern UINT MSI_DatabaseOpenViewW(MSIDATABASE *, LPCWSTR, MSIQUERY ** );
 327 extern UINT MSI_OpenQuery( MSIDATABASE *, MSIQUERY **, LPCWSTR, ... );
 328 typedef UINT (*record_func)( MSIRECORD *rec, LPVOID param );
 329 extern UINT MSI_IterateRecords( MSIQUERY *, DWORD *, record_func, LPVOID );
 330
 331 /* view internals */
 332 extern UINT MSI_ViewExecute( MSIQUERY*, MSIRECORD * );
 333 extern UINT MSI_ViewFetch( MSIQUERY*, MSIRECORD ** );
 334 extern UINT MSI_ViewClose( MSIQUERY* );
 335
 336 /* package internals */
 337 extern MSIPACKAGE *MSI_CreatePackage( MSIDATABASE * );
 338 extern UINT MSI_OpenPackageW( LPCWSTR szPackage, MSIPACKAGE ** );
 339 extern UINT MSI_SetTargetPathW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
 340 extern UINT MSI_SetPropertyW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
 341 extern INT MSI_ProcessMessage( MSIPACKAGE *, INSTALLMESSAGE, MSIRECORD * );
 342 extern UINT MSI_GetPropertyW( MSIPACKAGE *, LPCWSTR, LPWSTR, DWORD * );
 343 extern MSICONDITION MSI_EvaluateConditionW( MSIPACKAGE *, LPCWSTR );
 344 extern UINT MSI_SetPropertyW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
 345 extern UINT MSI_GetComponentStateW( MSIPACKAGE *, LPWSTR, INSTALLSTATE *, INSTALLSTATE * );
 346 extern UINT MSI_GetFeatureStateW( MSIPACKAGE *, LPWSTR, INSTALLSTATE *, INSTALLSTATE * );
 347 extern UINT WINAPI MSI_SetFeatureStateW(MSIPACKAGE*, LPCWSTR, INSTALLSTATE );
 348
 349 /* for deformating */
 350 extern UINT MSI_FormatRecordW(MSIPACKAGE* package, MSIRECORD* record,
 351                               LPWSTR buffer, DWORD *size);
 352
 353 /* registry data encoding/decoding functions */
 354 extern BOOL unsquash_guid(LPCWSTR in, LPWSTR out);
 355 extern BOOL squash_guid(LPCWSTR in, LPWSTR out);
 356 extern BOOL encode_base85_guid(GUID *,LPWSTR);
 357 extern BOOL decode_base85_guid(LPCWSTR,GUID*);
 358 extern UINT MSIREG_OpenUninstallKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 359 extern UINT MSIREG_OpenUserProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 360 extern UINT MSIREG_OpenFeatures(HKEY* key);
 361 extern UINT MSIREG_OpenFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 362 extern UINT MSIREG_OpenComponents(HKEY* key);
 363 extern UINT MSIREG_OpenUserComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
 364 extern UINT MSIREG_OpenComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
 365 extern UINT MSIREG_OpenProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 366 extern UINT MSIREG_OpenUserFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 367 extern UINT MSIREG_OpenUpgradeCodesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 368
 369 /* msi dialog interface */
 370 typedef VOID (*msi_dialog_event_handler)( MSIPACKAGE*, LPCWSTR, LPCWSTR, msi_dialog* );
 371 extern msi_dialog *msi_dialog_create( MSIPACKAGE*, LPCWSTR, msi_dialog_event_handler );
 372 extern UINT msi_dialog_run_message_loop( msi_dialog* );
 373 extern void msi_dialog_end_dialog( msi_dialog* );
 374 extern void msi_dialog_check_messages( HANDLE );
 375 extern void msi_dialog_do_preview( msi_dialog* );
 376 extern void msi_dialog_destroy( msi_dialog* );
 377 extern BOOL msi_dialog_register_class( void );
 378 extern void msi_dialog_unregister_class( void );
 379
 380 /* UI globals */
 381 extern INSTALLUILEVEL gUILevel;
 382 extern HWND gUIhwnd;
 383 extern INSTALLUI_HANDLERA gUIHandlerA;
 384 extern INSTALLUI_HANDLERW gUIHandlerW;
 385 extern DWORD gUIFilter;
 386 extern LPVOID gUIContext;
 387 extern WCHAR gszLogFile[MAX_PATH];
 388
 389 inline static char *strdupWtoA( LPCWSTR str )
 390 {
 391     LPSTR ret = NULL;
 392     if (str)
 393     {
 394         DWORD len = WideCharToMultiByte( CP_ACP, 0, str, -1, NULL, 0, NULL, NULL
 395 );
 396         if ((ret = HeapAlloc( GetProcessHeap(), 0, len )))
 397             WideCharToMultiByte( CP_ACP, 0, str, -1, ret, len, NULL, NULL );
 398     }
 399     return ret;
 400 }
 401
 402 inline static LPWSTR strdupAtoW( LPCSTR str )
 403 {
 404     LPWSTR ret = NULL;
 405     if (str)
 406     {
 407         DWORD len = MultiByteToWideChar( CP_ACP, 0, str, -1, NULL, 0 );
 408         if ((ret = HeapAlloc( GetProcessHeap(), 0, len * sizeof(WCHAR) )))
 409             MultiByteToWideChar( CP_ACP, 0, str, -1, ret, len );
 410     }
 411     return ret;
 412 }
 413
 414 inline static LPWSTR strdupW( LPCWSTR src )
 415 {
 416     LPWSTR dest;
 417     if (!src) return NULL;
 418     dest = HeapAlloc(GetProcessHeap(), 0, (strlenW(src)+1)*sizeof(WCHAR));
 419     strcpyW(dest, src);
 420     return dest;
 421 }
 422
 423 #endif /* __WINE_MSI_PRIVATE__ */