msi: Support retrieving rows from join tables.
[wine] / dlls / msi / join.c
1 /*
2  * Implementation of the Microsoft Installer (msi.dll)
3  *
4  * Copyright 2006 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 #include <stdarg.h>
22
23 #include "windef.h"
24 #include "winbase.h"
25 #include "winerror.h"
26 #include "msi.h"
27 #include "msiquery.h"
28 #include "objbase.h"
29 #include "objidl.h"
30 #include "msipriv.h"
31 #include "query.h"
32
33 #include "wine/debug.h"
34 #include "wine/unicode.h"
35
36 WINE_DEFAULT_DEBUG_CHANNEL(msidb);
37
38 typedef struct tagJOINTABLE
39 {
40     struct list entry;
41     MSIVIEW *view;
42     UINT columns;
43     UINT rows;
44     UINT next_rows;
45 } JOINTABLE;
46
47 typedef struct tagMSIJOINVIEW
48 {
49     MSIVIEW        view;
50     MSIDATABASE   *db;
51     struct list    tables;
52     UINT           columns;
53     UINT           rows;
54 } MSIJOINVIEW;
55
56 static UINT JOIN_fetch_int( struct tagMSIVIEW *view, UINT row, UINT col, UINT *val )
57 {
58     MSIJOINVIEW *jv = (MSIJOINVIEW*)view;
59     JOINTABLE *table;
60     UINT cols = 0;
61     UINT prev_rows = 1;
62
63     TRACE("%d, %d\n", row, col);
64
65     if (col == 0 || col > jv->columns)
66          return ERROR_FUNCTION_FAILED;
67
68     if (row >= jv->rows)
69          return ERROR_FUNCTION_FAILED;
70
71     LIST_FOR_EACH_ENTRY(table, &jv->tables, JOINTABLE, entry)
72     {
73         if (col <= cols + table->columns)
74         {
75             row = (row % (jv->rows / table->next_rows)) / prev_rows;
76             col -= cols;
77             break;
78         }
79
80         prev_rows *= table->rows;
81         cols += table->columns;
82     }
83
84     return table->view->ops->fetch_int( table->view, row, col, val );
85 }
86
87 static UINT JOIN_fetch_stream( struct tagMSIVIEW *view, UINT row, UINT col, IStream **stm)
88 {
89     MSIJOINVIEW *jv = (MSIJOINVIEW*)view;
90     JOINTABLE *table;
91     UINT cols = 0;
92     UINT prev_rows = 1;
93
94     TRACE("%p %d %d %p\n", jv, row, col, stm );
95
96     if (col == 0 || col > jv->columns)
97          return ERROR_FUNCTION_FAILED;
98
99     if (row >= jv->rows)
100          return ERROR_FUNCTION_FAILED;
101
102     LIST_FOR_EACH_ENTRY(table, &jv->tables, JOINTABLE, entry)
103     {
104         if (col <= cols + table->columns)
105         {
106             row = (row % (jv->rows / table->next_rows)) / prev_rows;
107             col -= cols;
108             break;
109         }
110
111         prev_rows *= table->rows;
112         cols += table->columns;
113     }
114
115     return table->view->ops->fetch_stream( table->view, row, col, stm );
116 }
117
118 static UINT JOIN_get_row( struct tagMSIVIEW *view, UINT row, MSIRECORD **rec )
119 {
120     MSIJOINVIEW *jv = (MSIJOINVIEW*)view;
121
122     TRACE("%p %d %p\n", jv, row, rec);
123
124     return msi_view_get_row( jv->db, view, row, rec );
125 }
126
127 static UINT JOIN_execute( struct tagMSIVIEW *view, MSIRECORD *record )
128 {
129     MSIJOINVIEW *jv = (MSIJOINVIEW*)view;
130     JOINTABLE *table;
131     UINT r, rows;
132
133     TRACE("%p %p\n", jv, record);
134
135     LIST_FOR_EACH_ENTRY(table, &jv->tables, JOINTABLE, entry)
136     {
137         table->view->ops->execute(table->view, NULL);
138
139         r = table->view->ops->get_dimensions(table->view, &table->rows, NULL);
140         if (r != ERROR_SUCCESS)
141         {
142             ERR("failed to get table dimensions\n");
143             return r;
144         }
145
146         /* each table must have at least one row */
147         if (table->rows == 0)
148         {
149             jv->rows = 0;
150             return ERROR_SUCCESS;
151         }
152
153         if (jv->rows == 0)
154             jv->rows = table->rows;
155         else
156             jv->rows *= table->rows;
157     }
158
159     rows = jv->rows;
160     LIST_FOR_EACH_ENTRY(table, &jv->tables, JOINTABLE, entry)
161     {
162         rows /= table->rows;
163         table->next_rows = rows;
164     }
165
166     return ERROR_SUCCESS;
167 }
168
169 static UINT JOIN_close( struct tagMSIVIEW *view )
170 {
171     MSIJOINVIEW *jv = (MSIJOINVIEW*)view;
172     JOINTABLE *table;
173
174     TRACE("%p\n", jv );
175
176     LIST_FOR_EACH_ENTRY(table, &jv->tables, JOINTABLE, entry)
177     {
178         table->view->ops->close(table->view);
179     }
180
181     return ERROR_SUCCESS;
182 }
183
184 static UINT JOIN_get_dimensions( struct tagMSIVIEW *view, UINT *rows, UINT *cols )
185 {
186     MSIJOINVIEW *jv = (MSIJOINVIEW*)view;
187
188     TRACE("%p %p %p\n", jv, rows, cols );
189
190     if (cols)
191         *cols = jv->columns;
192
193     if (rows)
194         *rows = jv->rows;
195
196     return ERROR_SUCCESS;
197 }
198
199 static UINT JOIN_get_column_info( struct tagMSIVIEW *view,
200                 UINT n, LPWSTR *name, UINT *type, BOOL *temporary,
201                 LPWSTR *table_name )
202 {
203     MSIJOINVIEW *jv = (MSIJOINVIEW*)view;
204     JOINTABLE *table;
205     UINT cols = 0;
206
207     TRACE("%p %d %p %p %p %p\n", jv, n, name, type, temporary, table_name );
208
209     if (n == 0 || n > jv->columns)
210         return ERROR_FUNCTION_FAILED;
211
212     LIST_FOR_EACH_ENTRY(table, &jv->tables, JOINTABLE, entry)
213     {
214         if (n <= cols + table->columns)
215             return table->view->ops->get_column_info(table->view, n - cols,
216                                                      name, type, temporary,
217                                                      table_name);
218
219         cols += table->columns;
220     }
221
222     return ERROR_FUNCTION_FAILED;
223 }
224
225 static UINT JOIN_modify( struct tagMSIVIEW *view, MSIMODIFY eModifyMode,
226                          MSIRECORD *rec, UINT row )
227 {
228     TRACE("%p %d %p\n", view, eModifyMode, rec);
229     return ERROR_FUNCTION_FAILED;
230 }
231
232 static UINT JOIN_delete( struct tagMSIVIEW *view )
233 {
234     MSIJOINVIEW *jv = (MSIJOINVIEW*)view;
235     struct list *item, *cursor;
236
237     TRACE("%p\n", jv );
238
239     LIST_FOR_EACH_SAFE(item, cursor, &jv->tables)
240     {
241         JOINTABLE* table = LIST_ENTRY(item, JOINTABLE, entry);
242
243         list_remove(&table->entry);
244         table->view->ops->delete(table->view);
245         table->view = NULL;
246         msi_free(table);
247     }
248
249     msi_free(jv);
250
251     return ERROR_SUCCESS;
252 }
253
254 static UINT JOIN_find_matching_rows( struct tagMSIVIEW *view, UINT col,
255     UINT val, UINT *row, MSIITERHANDLE *handle )
256 {
257     MSIJOINVIEW *jv = (MSIJOINVIEW*)view;
258     UINT i, row_value;
259
260     TRACE("%p, %d, %u, %p\n", view, col, val, *handle);
261
262     if (col == 0 || col > jv->columns)
263         return ERROR_INVALID_PARAMETER;
264
265     for (i = PtrToUlong(*handle); i < jv->rows; i++)
266     {
267         if (view->ops->fetch_int( view, i, col, &row_value ) != ERROR_SUCCESS)
268             continue;
269
270         if (row_value == val)
271         {
272             *row = i;
273             (*(UINT *)handle) = i + 1;
274             return ERROR_SUCCESS;
275         }
276     }
277
278     return ERROR_NO_MORE_ITEMS;
279 }
280
281 static UINT JOIN_sort(struct tagMSIVIEW *view, column_info *columns)
282 {
283     MSIJOINVIEW *jv = (MSIJOINVIEW *)view;
284     JOINTABLE *table;
285     UINT r;
286
287     TRACE("%p %p\n", view, columns);
288
289     LIST_FOR_EACH_ENTRY(table, &jv->tables, JOINTABLE, entry)
290     {
291         r = table->view->ops->sort(table->view, columns);
292         if (r != ERROR_SUCCESS)
293             return r;
294     }
295
296     return ERROR_SUCCESS;
297 }
298
299 static const MSIVIEWOPS join_ops =
300 {
301     JOIN_fetch_int,
302     JOIN_fetch_stream,
303     JOIN_get_row,
304     NULL,
305     NULL,
306     NULL,
307     JOIN_execute,
308     JOIN_close,
309     JOIN_get_dimensions,
310     JOIN_get_column_info,
311     JOIN_modify,
312     JOIN_delete,
313     JOIN_find_matching_rows,
314     NULL,
315     NULL,
316     NULL,
317     NULL,
318     JOIN_sort,
319     NULL,
320 };
321
322 UINT JOIN_CreateView( MSIDATABASE *db, MSIVIEW **view, LPWSTR tables )
323 {
324     MSIJOINVIEW *jv = NULL;
325     UINT r = ERROR_SUCCESS;
326     JOINTABLE *table;
327     LPWSTR ptr;
328
329     TRACE("%p (%s)\n", jv, debugstr_w(tables) );
330
331     jv = msi_alloc_zero( sizeof *jv );
332     if( !jv )
333         return ERROR_FUNCTION_FAILED;
334
335     /* fill the structure */
336     jv->view.ops = &join_ops;
337     jv->db = db;
338     jv->columns = 0;
339     jv->rows = 0;
340
341     list_init(&jv->tables);
342
343     while (*tables)
344     {
345         if ((ptr = strchrW(tables, ' ')))
346             *ptr = '\0';
347
348         table = msi_alloc(sizeof(JOINTABLE));
349         if (!table)
350         {
351             r = ERROR_OUTOFMEMORY;
352             goto end;
353         }
354
355         r = TABLE_CreateView( db, tables, &table->view );
356         if( r != ERROR_SUCCESS )
357         {
358             WARN("can't create table: %s\n", debugstr_w(tables));
359             msi_free(table);
360             r = ERROR_BAD_QUERY_SYNTAX;
361             goto end;
362         }
363
364         r = table->view->ops->get_dimensions( table->view, NULL,
365                                               &table->columns );
366         if( r != ERROR_SUCCESS )
367         {
368             ERR("can't get table dimensions\n");
369             goto end;
370         }
371
372         jv->columns += table->columns;
373
374         list_add_head( &jv->tables, &table->entry );
375
376         if (!ptr)
377             break;
378
379         tables = ptr + 1;
380     }
381
382     *view = &jv->view;
383     return ERROR_SUCCESS;
384
385 end:
386     jv->view.ops->delete( &jv->view );
387
388     return r;
389 }