2 * Implementation of the Microsoft Installer (msi.dll)
4 * Copyright 2002 Mike McCormack for CodeWeavers
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.
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.
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
21 #ifndef __WINE_MSI_PRIVATE__
22 #define __WINE_MSI_PRIVATE__
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
39 #define MSITYPE_BINARY 0x8900
42 typedef struct tagMSITABLE MSITABLE;
45 typedef struct string_table string_table;
47 struct tagMSIOBJECTHDR;
48 typedef struct tagMSIOBJECTHDR MSIOBJECTHDR;
50 typedef VOID (*msihandledestructor)( MSIOBJECTHDR * );
52 struct tagMSIOBJECTHDR
57 msihandledestructor destructor;
58 struct tagMSIOBJECTHDR *next;
59 struct tagMSIOBJECTHDR *prev;
62 typedef struct tagMSIDATABASE
66 string_table *strings;
68 MSITABLE *first_table, *last_table;
71 typedef struct tagMSIVIEW MSIVIEW;
73 typedef struct tagMSIQUERY
81 /* maybe we can use a Variant instead of doing it ourselves? */
82 typedef struct tagMSIFIELD
93 typedef struct tagMSIRECORD
96 UINT count; /* as passed to MsiCreateRecord */
97 MSIFIELD fields[1]; /* nb. array size is count+1 */
100 typedef struct tagMSIVIEWOPS
103 * fetch_int - reads one integer from {row,col} in the table
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.
111 UINT (*fetch_int)( struct tagMSIVIEW *, UINT row, UINT col, UINT *val );
114 * fetch_int - reads one integer from {row,col} in the table
116 * This function is similar to fetch_int, except fetches a
117 * stream instead of an integer.
119 UINT (*fetch_stream)( struct tagMSIVIEW *, UINT row, UINT col, IStream **stm );
122 * get_int - sets one integer at {row,col} in the table
124 * Similar semantics to fetch_int
126 UINT (*set_int)( struct tagMSIVIEW *, UINT row, UINT col, UINT val );
129 * Inserts a new, blank row into the database
130 * *row receives the number of the new row
132 UINT (*insert_row)( struct tagMSIVIEW *, UINT *row );
135 * execute - loads the underlying data into memory so it can be read
137 UINT (*execute)( struct tagMSIVIEW *, MSIRECORD * );
140 * close - clears the data read by execute from memory
142 UINT (*close)( struct tagMSIVIEW * );
145 * get_dimensions - returns the number of rows or columns in a table.
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.
150 UINT (*get_dimensions)( struct tagMSIVIEW *, UINT *rows, UINT *cols );
153 * get_column_info - returns the name and type of a specific column
155 * The name is HeapAlloc'ed by this function and should be freed by
157 * The column information can be queried at any time.
159 UINT (*get_column_info)( struct tagMSIVIEW *, UINT n, LPWSTR *name, UINT *type );
162 * modify - not yet implemented properly
164 UINT (*modify)( struct tagMSIVIEW *, MSIMODIFY, MSIHANDLE );
167 * delete - destroys the structure completely
169 UINT (*delete)( struct tagMSIVIEW * );
173 typedef struct tagMSISUMMARYINFO
176 IPropertyStorage *propstg;
185 typedef struct tagMSIPACKAGE
189 struct tagMSIFEATURE *features;
190 UINT loaded_features;
191 struct tagMSIFOLDER *folders;
193 struct tagMSICOMPONENT *components;
194 UINT loaded_components;
195 struct tagMSIFILE *files;
200 LPWSTR *DeferredAction;
201 UINT DeferredActionCount;
203 LPWSTR *CommitAction;
204 UINT CommitActionCount;
209 #define MSIHANDLETYPE_ANY 0
210 #define MSIHANDLETYPE_DATABASE 1
211 #define MSIHANDLETYPE_SUMMARYINFO 2
212 #define MSIHANDLETYPE_VIEW 3
213 #define MSIHANDLETYPE_RECORD 4
214 #define MSIHANDLETYPE_PACKAGE 5
216 #define MSI_MAJORVERSION 2
217 #define MSI_MINORVERSION 0
218 #define MSI_BUILDNUMBER 2600
222 #define MSIHANDLE_MAGIC 0x4d434923
223 #define MSIMAXHANDLES 0x80
225 #define MSISUMINFO_OFFSET 0x30LL
227 DEFINE_GUID(CLSID_IMsiServer, 0x000C101C,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
228 DEFINE_GUID(CLSID_IMsiServerX1, 0x000C103E,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
229 DEFINE_GUID(CLSID_IMsiServerX2, 0x000C1090,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
230 DEFINE_GUID(CLSID_IMsiServerX3, 0x000C1094,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
232 DEFINE_GUID(CLSID_IMsiServerMessage, 0x000C101D,0x0000,0x0000,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46);
235 /* handle functions */
236 extern void *msihandle2msiinfo(MSIHANDLE handle, UINT type);
237 extern MSIHANDLE alloc_msihandle( MSIOBJECTHDR * );
238 extern void *alloc_msiobject(UINT type, UINT size, msihandledestructor destroy );
239 extern void msiobj_addref(MSIOBJECTHDR *);
240 extern int msiobj_release(MSIOBJECTHDR *);
241 extern void msiobj_lock(MSIOBJECTHDR *);
242 extern void msiobj_unlock(MSIOBJECTHDR *);
243 extern MSIHANDLE msiobj_findhandle( MSIOBJECTHDR *hdr );
245 /* add this table to the list of cached tables in the database */
246 extern void add_table(MSIDATABASE *db, MSITABLE *table);
247 extern void remove_table( MSIDATABASE *db, MSITABLE *table );
248 extern void free_table( MSIDATABASE *db, MSITABLE *table );
249 extern void free_cached_tables( MSIDATABASE *db );
250 extern UINT find_cached_table(MSIDATABASE *db, LPCWSTR name, MSITABLE **table);
251 extern UINT get_table(MSIDATABASE *db, LPCWSTR name, MSITABLE **table);
252 extern UINT load_string_table( MSIDATABASE *db );
253 extern UINT MSI_CommitTables( MSIDATABASE *db );
254 extern HRESULT init_string_table( IStorage *stg );
257 /* string table functions */
258 extern BOOL msi_addstring( string_table *st, int string_no, const CHAR *data, int len, UINT refcount );
259 extern BOOL msi_addstringW( string_table *st, int string_no, const WCHAR *data, int len, UINT refcount );
260 extern UINT msi_id2stringW( string_table *st, UINT string_no, LPWSTR buffer, UINT *sz );
261 extern UINT msi_id2stringA( string_table *st, UINT string_no, LPSTR buffer, UINT *sz );
263 extern LPWSTR MSI_makestring( MSIDATABASE *db, UINT stringid);
264 extern UINT msi_string2idW( string_table *st, LPCWSTR buffer, UINT *id );
265 extern UINT msi_string2idA( string_table *st, LPCSTR str, UINT *id );
266 extern string_table *msi_init_stringtable( int entries, UINT codepage );
267 extern VOID msi_destroy_stringtable( string_table *st );
268 extern UINT msi_string_count( string_table *st );
269 extern UINT msi_id_refcount( string_table *st, UINT i );
270 extern UINT msi_string_totalsize( string_table *st, UINT *last );
271 extern UINT msi_strcmp( string_table *st, UINT lval, UINT rval, UINT *res );
272 extern const WCHAR *msi_string_lookup_id( string_table *st, UINT id );
273 extern UINT msi_string_get_codepage( string_table *st );
276 extern UINT VIEW_find_column( MSIVIEW *view, LPWSTR name, UINT *n );
278 extern BOOL TABLE_Exists( MSIDATABASE *db, LPWSTR name );
280 extern UINT read_raw_stream_data( MSIDATABASE*, LPCWSTR stname,
281 USHORT **pdata, UINT *psz );
282 extern UINT ACTION_DoTopLevelINSTALL( MSIPACKAGE *, LPCWSTR, LPCWSTR );
283 extern void ACTION_remove_tracked_tempfiles( MSIPACKAGE* );
284 extern void ACTION_free_package_structures( MSIPACKAGE* );
286 /* record internals */
287 extern UINT MSI_RecordSetIStream( MSIRECORD *, unsigned int, IStream *);
288 extern const WCHAR *MSI_RecordGetString( MSIRECORD *, unsigned int );
289 extern MSIRECORD *MSI_CreateRecord( unsigned int );
290 extern UINT MSI_RecordSetInteger( MSIRECORD *, unsigned int, int );
291 extern UINT MSI_RecordSetStringW( MSIRECORD *, unsigned int, LPCWSTR );
292 extern BOOL MSI_RecordIsNull( MSIRECORD *, unsigned int );
293 extern UINT MSI_RecordGetStringW( MSIRECORD * , unsigned int, LPWSTR, DWORD *);
294 extern UINT MSI_RecordGetStringA( MSIRECORD *, unsigned int, LPSTR, DWORD *);
295 extern int MSI_RecordGetInteger( MSIRECORD *, unsigned int );
296 extern UINT MSI_RecordReadStream( MSIRECORD *, unsigned int, char *, DWORD *);
297 extern unsigned int MSI_RecordGetFieldCount( MSIRECORD *rec );
299 /* stream internals */
300 extern UINT get_raw_stream( MSIHANDLE hdb, LPCWSTR stname, IStream **stm );
301 extern UINT db_get_raw_stream( MSIDATABASE *db, LPCWSTR stname, IStream **stm );
302 extern void enum_stream_names( IStorage *stg );
304 /* database internals */
305 extern UINT MSI_OpenDatabaseW( LPCWSTR, LPCWSTR, MSIDATABASE ** );
306 extern UINT MSI_DatabaseOpenViewW(MSIDATABASE *, LPCWSTR, MSIQUERY ** );
309 extern UINT MSI_ViewExecute( MSIQUERY*, MSIRECORD * );
310 extern UINT MSI_ViewFetch( MSIQUERY*, MSIRECORD ** );
311 extern UINT MSI_ViewClose( MSIQUERY* );
313 /* package internals */
314 extern UINT MSI_OpenPackageW(LPCWSTR szPackage, MSIPACKAGE ** );
315 extern UINT MSI_SetTargetPathW( MSIPACKAGE *, LPCWSTR, LPCWSTR);
316 extern UINT MSI_SetPropertyW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
317 extern INT MSI_ProcessMessage( MSIPACKAGE *, INSTALLMESSAGE, MSIRECORD* );
318 extern UINT MSI_GetPropertyW( MSIPACKAGE *, LPCWSTR, LPWSTR, DWORD*);
319 extern MSICONDITION MSI_EvaluateConditionW( MSIPACKAGE *, LPCWSTR );
320 extern UINT MSI_SetPropertyW( MSIPACKAGE *, LPCWSTR, LPCWSTR );
321 extern UINT MSI_GetComponentStateW(MSIPACKAGE *, LPWSTR, INSTALLSTATE *, INSTALLSTATE *);
322 extern UINT MSI_GetFeatureStateW(MSIPACKAGE *, LPWSTR, INSTALLSTATE *, INSTALLSTATE *);
324 /* registry data encoding/decoding functions */
325 BOOL unsquash_guid(LPCWSTR in, LPWSTR out);
326 BOOL squash_guid(LPCWSTR in, LPWSTR out);
327 BOOL encode_base85_guid(GUID *,LPWSTR);
328 BOOL decode_base85_guid(LPCWSTR,GUID*);
331 extern INSTALLUILEVEL gUILevel;
333 extern INSTALLUI_HANDLERA gUIHandler;
334 extern DWORD gUIFilter;
335 extern LPVOID gUIContext;
336 extern WCHAR gszLogFile[MAX_PATH];
338 #endif /* __WINE_MSI_PRIVATE__ */