dlls/msi/msipriv.h

   1 /*
   2  * Implementation of the Microsoft Installer (msi.dll)
   3  *
   4  * Copyright 2002 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
  33 #define MSI_DATASIZEMASK 0x00ff
  34 #define MSITYPE_VALID    0x0100
  35 #define MSITYPE_STRING   0x0800
  36 #define MSITYPE_NULLABLE 0x1000
  37 #define MSITYPE_KEY      0x2000
  38
  39 #define MSITYPE_BINARY 0x8900
  40
  41 struct tagMSITABLE;
  42 typedef struct tagMSITABLE MSITABLE;
  43
  44 struct string_table;
  45 typedef struct string_table string_table;
  46
  47 struct tagMSIOBJECTHDR;
  48 typedef struct tagMSIOBJECTHDR MSIOBJECTHDR;
  49
  50 typedef VOID (*msihandledestructor)( MSIOBJECTHDR * );
  51
  52 struct tagMSIOBJECTHDR
  53 {
  54     UINT magic;
  55     UINT type;
  56     DWORD refcount;
  57     msihandledestructor destructor;
  58     struct tagMSIOBJECTHDR *next;
  59     struct tagMSIOBJECTHDR *prev;
  60 };
  61
  62 typedef struct tagMSIDATABASE
  63 {
  64     MSIOBJECTHDR hdr;
  65     IStorage *storage;
  66     string_table *strings;
  67     LPWSTR mode;
  68     MSITABLE *first_table, *last_table;
  69 } MSIDATABASE;
  70
  71 typedef struct tagMSIVIEW MSIVIEW;
  72
  73 typedef struct tagMSIQUERY
  74 {
  75     MSIOBJECTHDR hdr;
  76     MSIVIEW *view;
  77     UINT row;
  78     MSIDATABASE *db;
  79 } MSIQUERY;
  80
  81 /* maybe we can use a Variant instead of doing it ourselves? */
  82 typedef struct tagMSIFIELD
  83 {
  84     UINT type;
  85     union
  86     {
  87         INT iVal;
  88         LPWSTR szwVal;
  89         IStream *stream;
  90     } u;
  91 } MSIFIELD;
  92
  93 typedef struct tagMSIRECORD
  94 {
  95     MSIOBJECTHDR hdr;
  96     UINT count;       /* as passed to MsiCreateRecord */
  97     MSIFIELD fields[1]; /* nb. array size is count+1 */
  98 } MSIRECORD;
  99
 100 typedef struct tagMSIVIEWOPS
 101 {
 102     /*
 103      * fetch_int - reads one integer from {row,col} in the table
 104      *
 105      *  This function should be called after the execute method.
 106      *  Data returned by the function should not change until
 107      *   close or delete is called.
 108      *  To get a string value, query the database's string table with
 109      *   the integer value returned from this function.
 110      */
 111     UINT (*fetch_int)( struct tagMSIVIEW *, UINT row, UINT col, UINT *val );
 112
 113     /*
 114      * fetch_int - reads one integer from {row,col} in the table
 115      *
 116      *  This function is similar to fetch_int, except fetches a
 117      *    stream instead of an integer.
 118      */
 119     UINT (*fetch_stream)( struct tagMSIVIEW *, UINT row, UINT col, IStream **stm );
 120
 121     /*
 122      * get_int - sets one integer at {row,col} in the table
 123      *
 124      *  Similar semantics to fetch_int
 125      */
 126     UINT (*set_int)( struct tagMSIVIEW *, UINT row, UINT col, UINT val );
 127
 128     /*
 129      * Inserts a new, blank row into the database
 130      *  *row receives the number of the new row
 131      */
 132     UINT (*insert_row)( struct tagMSIVIEW *, UINT *row );
 133
 134     /*
 135      * execute - loads the underlying data into memory so it can be read
 136      */
 137     UINT (*execute)( struct tagMSIVIEW *, MSIRECORD * );
 138
 139     /*
 140      * close - clears the data read by execute from memory
 141      */
 142     UINT (*close)( struct tagMSIVIEW * );
 143
 144     /*
 145      * get_dimensions - returns the number of rows or columns in a table.
 146      *
 147      *  The number of rows can only be queried after the execute method
 148      *   is called. The number of columns can be queried at any time.
 149      */
 150     UINT (*get_dimensions)( struct tagMSIVIEW *, UINT *rows, UINT *cols );
 151
 152     /*
 153      * get_column_info - returns the name and type of a specific column
 154      *
 155      *  The name is HeapAlloc'ed by this function and should be freed by
 156      *   the caller.
 157      *  The column information can be queried at any time.
 158      */
 159     UINT (*get_column_info)( struct tagMSIVIEW *, UINT n, LPWSTR *name, UINT *type );
 160
 161     /*
 162      * modify - not yet implemented properly
 163      */
 164     UINT (*modify)( struct tagMSIVIEW *, MSIMODIFY, MSIHANDLE );
 165
 166     /*
 167      * delete - destroys the structure completely
 168      */
 169     UINT (*delete)( struct tagMSIVIEW * );
 170
 171 } MSIVIEWOPS;
 172
 173 typedef struct tagMSISUMMARYINFO
 174 {
 175     MSIOBJECTHDR hdr;
 176     IPropertyStorage *propstg;
 177 } MSISUMMARYINFO;
 178
 179 struct tagMSIVIEW
 180 {
 181     MSIOBJECTHDR hdr;
 182     MSIVIEWOPS   *ops;
 183 };
 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 } MSIPACKAGE;
 211
 212 typedef struct tagMSIPREVIEW
 213 {
 214     MSIOBJECTHDR hdr;
 215     MSIDATABASE *db;
 216 } MSIPREVIEW;
 217
 218 #define MSIHANDLETYPE_ANY 0
 219 #define MSIHANDLETYPE_DATABASE 1
 220 #define MSIHANDLETYPE_SUMMARYINFO 2
 221 #define MSIHANDLETYPE_VIEW 3
 222 #define MSIHANDLETYPE_RECORD 4
 223 #define MSIHANDLETYPE_PACKAGE 5
 224 #define MSIHANDLETYPE_PREVIEW 6
 225
 226 #define MSI_MAJORVERSION 2
 227 #define MSI_MINORVERSION 0
 228 #define MSI_BUILDNUMBER 2600
 229
 230 #define GUID_SIZE 39
 231
 232 #define MSIHANDLE_MAGIC 0x4d434923
 233 #define MSIMAXHANDLES 0x80
 234
 235 #define MSISUMINFO_OFFSET 0x30LL
 236
 237 DEFINE_GUID(CLSID_IMsiServer,   0x000C101C,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
 238 DEFINE_GUID(CLSID_IMsiServerX1, 0x000C103E,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
 239 DEFINE_GUID(CLSID_IMsiServerX2, 0x000C1090,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
 240 DEFINE_GUID(CLSID_IMsiServerX3, 0x000C1094,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
 241
 242 DEFINE_GUID(CLSID_IMsiServerMessage, 0x000C101D,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
 243
 244
 245 /* handle functions */
 246 extern void *msihandle2msiinfo(MSIHANDLE handle, UINT type);
 247 extern MSIHANDLE alloc_msihandle( MSIOBJECTHDR * );
 248 extern void *alloc_msiobject(UINT type, UINT size, msihandledestructor destroy );
 249 extern void msiobj_addref(MSIOBJECTHDR *);
 250 extern int msiobj_release(MSIOBJECTHDR *);
 251 extern void msiobj_lock(MSIOBJECTHDR *);
 252 extern void msiobj_unlock(MSIOBJECTHDR *);
 253 extern MSIHANDLE msiobj_findhandle( MSIOBJECTHDR *hdr );
 254
 255 /* add this table to the list of cached tables in the database */
 256 extern void add_table(MSIDATABASE *db, MSITABLE *table);
 257 extern void remove_table( MSIDATABASE *db, MSITABLE *table );
 258 extern void free_table( MSIDATABASE *db, MSITABLE *table );
 259 extern void free_cached_tables( MSIDATABASE *db );
 260 extern UINT find_cached_table(MSIDATABASE *db, LPCWSTR name, MSITABLE **table);
 261 extern UINT get_table(MSIDATABASE *db, LPCWSTR name, MSITABLE **table);
 262 extern UINT load_string_table( MSIDATABASE *db );
 263 extern UINT MSI_CommitTables( MSIDATABASE *db );
 264 extern HRESULT init_string_table( IStorage *stg );
 265
 266
 267 /* string table functions */
 268 extern BOOL msi_addstring( string_table *st, int string_no, const CHAR *data, int len, UINT refcount );
 269 extern BOOL msi_addstringW( string_table *st, int string_no, const WCHAR *data, int len, UINT refcount );
 270 extern UINT msi_id2stringW( string_table *st, UINT string_no, LPWSTR buffer, UINT *sz );
 271 extern UINT msi_id2stringA( string_table *st, UINT string_no, LPSTR buffer, UINT *sz );
 272
 273 extern LPWSTR MSI_makestring( MSIDATABASE *db, UINT stringid);
 274 extern UINT msi_string2idW( string_table *st, LPCWSTR buffer, UINT *id );
 275 extern UINT msi_string2idA( string_table *st, LPCSTR str, UINT *id );
 276 extern string_table *msi_init_stringtable( int entries, UINT codepage );
 277 extern VOID msi_destroy_stringtable( string_table *st );
 278 extern UINT msi_string_count( string_table *st );
 279 extern UINT msi_id_refcount( string_table *st, UINT i );
 280 extern UINT msi_string_totalsize( string_table *st, UINT *last );
 281 extern UINT msi_strcmp( string_table *st, UINT lval, UINT rval, UINT *res );
 282 extern const WCHAR *msi_string_lookup_id( string_table *st, UINT id );
 283 extern UINT msi_string_get_codepage( string_table *st );
 284
 285
 286 extern UINT VIEW_find_column( MSIVIEW *view, LPWSTR name, UINT *n );
 287
 288 extern BOOL TABLE_Exists( MSIDATABASE *db, LPWSTR name );
 289
 290 extern UINT read_raw_stream_data( MSIDATABASE*, LPCWSTR stname,
 291                               USHORT **pdata, UINT *psz );
 292
 293 /* action internals */
 294 extern UINT ACTION_DoTopLevelINSTALL( MSIPACKAGE *, LPCWSTR, LPCWSTR );
 295 extern void ACTION_free_package_structures( MSIPACKAGE* );
 296
 297 /* record internals */
 298 extern UINT MSI_RecordSetIStream( MSIRECORD *, unsigned int, IStream *);
 299 extern const WCHAR *MSI_RecordGetString( MSIRECORD *, unsigned int );
 300 extern MSIRECORD *MSI_CreateRecord( unsigned int );
 301 extern UINT MSI_RecordSetInteger( MSIRECORD *, unsigned int, int );
 302 extern UINT MSI_RecordSetStringW( MSIRECORD *, unsigned int, LPCWSTR );
 303 extern BOOL MSI_RecordIsNull( MSIRECORD *, unsigned int );
 304 extern UINT MSI_RecordGetStringW( MSIRECORD * , unsigned int, LPWSTR, DWORD *);
 305 extern UINT MSI_RecordGetStringA( MSIRECORD *, unsigned int, LPSTR, DWORD *);
 306 extern int MSI_RecordGetInteger( MSIRECORD *, unsigned int );
 307 extern UINT MSI_RecordReadStream( MSIRECORD *, unsigned int, char *, DWORD *);
 308 extern unsigned int MSI_RecordGetFieldCount( MSIRECORD *rec );
 309
 310 /* stream internals */
 311 extern UINT get_raw_stream( MSIHANDLE hdb, LPCWSTR stname, IStream **stm );
 312 extern UINT db_get_raw_stream( MSIDATABASE *db, LPCWSTR stname, IStream **stm );
 313 extern void enum_stream_names( IStorage *stg );
 314
 315 /* database internals */
 316 extern UINT MSI_OpenDatabaseW( LPCWSTR, LPCWSTR, MSIDATABASE ** );
 317 extern UINT MSI_DatabaseOpenViewW(MSIDATABASE *, LPCWSTR, MSIQUERY ** );
 318 extern UINT MSI_OpenQuery( MSIDATABASE *, MSIQUERY **, LPCWSTR, ... );
 319
 320 /* view internals */
 321 extern UINT MSI_ViewExecute( MSIQUERY*, MSIRECORD * );
 322 extern UINT MSI_ViewFetch( MSIQUERY*, MSIRECORD ** );
 323 extern UINT MSI_ViewClose( MSIQUERY* );
 324
 325 /* package internals */
 326 extern UINT MSI_OpenPackageW(LPCWSTR szPackage, MSIPACKAGE ** );
 327 extern UINT MSI_SetTargetPathW( MSIPACKAGE *, LPCWSTR, LPCWSTR);
 328 extern UINT MSI_SetPropertyW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
 329 extern INT MSI_ProcessMessage( MSIPACKAGE *, INSTALLMESSAGE, MSIRECORD* );
 330 extern UINT MSI_GetPropertyW( MSIPACKAGE *, LPCWSTR, LPWSTR, DWORD*);
 331 extern MSICONDITION MSI_EvaluateConditionW( MSIPACKAGE *, LPCWSTR );
 332 extern UINT MSI_SetPropertyW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
 333 extern UINT MSI_GetComponentStateW(MSIPACKAGE *, LPWSTR, INSTALLSTATE *, INSTALLSTATE *);
 334 extern UINT MSI_GetFeatureStateW(MSIPACKAGE *, LPWSTR, INSTALLSTATE *, INSTALLSTATE *);
 335
 336 /* for deformating */
 337 extern UINT MSI_FormatRecordW(MSIPACKAGE* package, MSIRECORD* record,
 338                               LPWSTR buffer, DWORD *size);
 339
 340 /* registry data encoding/decoding functions */
 341 BOOL unsquash_guid(LPCWSTR in, LPWSTR out);
 342 BOOL squash_guid(LPCWSTR in, LPWSTR out);
 343 BOOL encode_base85_guid(GUID *,LPWSTR);
 344 BOOL decode_base85_guid(LPCWSTR,GUID*);
 345 UINT MSIREG_OpenUninstallKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 346 UINT MSIREG_OpenUserProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 347 UINT MSIREG_OpenFeatures(HKEY* key);
 348 UINT MSIREG_OpenFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 349 UINT MSIREG_OpenComponents(HKEY* key);
 350 UINT MSIREG_OpenComponentsKey(LPCWSTR szComponent, HKEY* key, BOOL create);
 351 UINT MSIREG_OpenProductsKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 352 UINT MSIREG_OpenUserFeaturesKey(LPCWSTR szProduct, HKEY* key, BOOL create);
 353
 354 /* UI globals */
 355 extern INSTALLUILEVEL gUILevel;
 356 extern HWND gUIhwnd;
 357 extern INSTALLUI_HANDLERA gUIHandlerA;
 358 extern INSTALLUI_HANDLERW gUIHandlerW;
 359 extern DWORD gUIFilter;
 360 extern LPVOID gUIContext;
 361 extern WCHAR gszLogFile[MAX_PATH];
 362
 363 #endif /* __WINE_MSI_PRIVATE__ */