dlls/msi/streams.c

   1 /*
   2  * Implementation of the Microsoft Installer (msi.dll)
   3  *
   4  * Copyright 2007 James Hawkins
   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 #define COBJMACROS
  24
  25 #include "windef.h"
  26 #include "winbase.h"
  27 #include "winerror.h"
  28 #include "msi.h"
  29 #include "msiquery.h"
  30 #include "objbase.h"
  31 #include "msipriv.h"
  32 #include "query.h"
  33
  34 #include "wine/debug.h"
  35 #include "wine/unicode.h"
  36
  37 WINE_DEFAULT_DEBUG_CHANNEL(msidb);
  38
  39 #define NUM_STREAMS_COLS    2
  40
  41 typedef struct tabSTREAM
  42 {
  43     UINT str_index;
  44     IStream *stream;
  45 } STREAM;
  46
  47 typedef struct tagMSISTREAMSVIEW
  48 {
  49     MSIVIEW view;
  50     MSIDATABASE *db;
  51     STREAM **streams;
  52     UINT max_streams;
  53     UINT num_rows;
  54     UINT row_size;
  55 } MSISTREAMSVIEW;
  56
  57 static BOOL streams_set_table_size(MSISTREAMSVIEW *sv, UINT size)
  58 {
  59     if (size >= sv->max_streams)
  60     {
  61         sv->max_streams *= 2;
  62         sv->streams = msi_realloc_zero(sv->streams, sv->max_streams * sizeof(STREAM *));
  63         if (!sv->streams)
  64             return FALSE;
  65     }
  66
  67     return TRUE;
  68 }
  69
  70 static STREAM *create_stream(MSISTREAMSVIEW *sv, LPCWSTR name, BOOL encoded, IStream *stm)
  71 {
  72     STREAM *stream;
  73     WCHAR decoded[MAX_STREAM_NAME_LEN];
  74
  75     stream = msi_alloc(sizeof(STREAM));
  76     if (!stream)
  77         return NULL;
  78
  79     if (encoded)
  80     {
  81         decode_streamname(name, decoded);
  82         TRACE("stream -> %s %s\n", debugstr_w(name), debugstr_w(decoded));
  83         name = decoded;
  84     }
  85
  86     stream->str_index = msi_addstringW(sv->db->strings, name, -1, 1, StringNonPersistent);
  87     stream->stream = stm;
  88     return stream;
  89 }
  90
  91 static UINT STREAMS_fetch_int(struct tagMSIVIEW *view, UINT row, UINT col, UINT *val)
  92 {
  93     MSISTREAMSVIEW *sv = (MSISTREAMSVIEW *)view;
  94
  95     TRACE("(%p, %d, %d, %p)\n", view, row, col, val);
  96
  97     if (col != 1)
  98         return ERROR_INVALID_PARAMETER;
  99
 100     if (row >= sv->num_rows)
 101         return ERROR_NO_MORE_ITEMS;
 102
 103     *val = sv->streams[row]->str_index;
 104
 105     return ERROR_SUCCESS;
 106 }
 107
 108 static UINT STREAMS_fetch_stream(struct tagMSIVIEW *view, UINT row, UINT col, IStream **stm)
 109 {
 110     MSISTREAMSVIEW *sv = (MSISTREAMSVIEW *)view;
 111
 112     TRACE("(%p, %d, %d, %p)\n", view, row, col, stm);
 113
 114     if (row >= sv->num_rows)
 115         return ERROR_FUNCTION_FAILED;
 116
 117     IStream_AddRef(sv->streams[row]->stream);
 118     *stm = sv->streams[row]->stream;
 119
 120     return ERROR_SUCCESS;
 121 }
 122
 123 static UINT STREAMS_get_row( struct tagMSIVIEW *view, UINT row, MSIRECORD **rec )
 124 {
 125     MSISTREAMSVIEW *sv = (MSISTREAMSVIEW *)view;
 126
 127     TRACE("%p %d %p\n", sv, row, rec);
 128
 129     return msi_view_get_row( sv->db, view, row, rec );
 130 }
 131
 132 static UINT STREAMS_set_row(struct tagMSIVIEW *view, UINT row, MSIRECORD *rec, UINT mask)
 133 {
 134     MSISTREAMSVIEW *sv = (MSISTREAMSVIEW *)view;
 135     STREAM *stream;
 136     IStream *stm;
 137     STATSTG stat;
 138     LPWSTR encname = NULL, name = NULL;
 139     USHORT *data = NULL;
 140     HRESULT hr;
 141     ULONG count;
 142     UINT r = ERROR_FUNCTION_FAILED;
 143
 144     TRACE("(%p, %d, %p, %08x)\n", view, row, rec, mask);
 145
 146     if (row > sv->num_rows)
 147         return ERROR_FUNCTION_FAILED;
 148
 149     r = MSI_RecordGetIStream(rec, 2, &stm);
 150     if (r != ERROR_SUCCESS)
 151         return r;
 152
 153     hr = IStream_Stat(stm, &stat, STATFLAG_NONAME);
 154     if (FAILED(hr))
 155     {
 156         WARN("failed to stat stream: %08x\n", hr);
 157         goto done;
 158     }
 159
 160     if (stat.cbSize.QuadPart >> 32)
 161     {
 162         WARN("stream too large\n");
 163         goto done;
 164     }
 165
 166     data = msi_alloc(stat.cbSize.QuadPart);
 167     if (!data)
 168         goto done;
 169
 170     hr = IStream_Read(stm, data, stat.cbSize.QuadPart, &count);
 171     if (FAILED(hr) || count != stat.cbSize.QuadPart)
 172     {
 173         WARN("failed to read stream: %08x\n", hr);
 174         goto done;
 175     }
 176
 177     name = strdupW(MSI_RecordGetString(rec, 1));
 178     if (!name)
 179     {
 180         WARN("failed to retrieve stream name\n");
 181         goto done;
 182     }
 183
 184     encname = encode_streamname(FALSE, name);
 185     msi_destroy_stream(sv->db, encname);
 186
 187     r = write_stream_data(sv->db->storage, name, data, count, FALSE);
 188     if (r != ERROR_SUCCESS)
 189     {
 190         WARN("failed to write stream data: %d\n", r);
 191         goto done;
 192     }
 193
 194     stream = create_stream(sv, name, FALSE, NULL);
 195     if (!stream)
 196         goto done;
 197
 198     hr = IStorage_OpenStream(sv->db->storage, encname, 0,
 199                              STGM_READ | STGM_SHARE_EXCLUSIVE, 0, &stream->stream);
 200     if (FAILED(hr))
 201     {
 202         WARN("failed to open stream: %08x\n", hr);
 203         goto done;
 204     }
 205
 206     sv->streams[row] = stream;
 207
 208 done:
 209     msi_free(name);
 210     msi_free(data);
 211     msi_free(encname);
 212
 213     IStream_Release(stm);
 214
 215     return r;
 216 }
 217
 218 static UINT STREAMS_insert_row(struct tagMSIVIEW *view, MSIRECORD *rec, UINT row, BOOL temporary)
 219 {
 220     MSISTREAMSVIEW *sv = (MSISTREAMSVIEW *)view;
 221     UINT i;
 222
 223     TRACE("(%p, %p, %d, %d)\n", view, rec, row, temporary);
 224
 225     if (!streams_set_table_size(sv, ++sv->num_rows))
 226         return ERROR_FUNCTION_FAILED;
 227
 228     if (row == -1)
 229         row = sv->num_rows - 1;
 230
 231     /* shift the rows to make room for the new row */
 232     for (i = sv->num_rows - 1; i > row; i--)
 233     {
 234         sv->streams[i] = sv->streams[i - 1];
 235     }
 236
 237     return STREAMS_set_row(view, row, rec, 0);
 238 }
 239
 240 static UINT STREAMS_delete_row(struct tagMSIVIEW *view, UINT row)
 241 {
 242     FIXME("(%p %d): stub!\n", view, row);
 243     return ERROR_SUCCESS;
 244 }
 245
 246 static UINT STREAMS_execute(struct tagMSIVIEW *view, MSIRECORD *record)
 247 {
 248     TRACE("(%p, %p)\n", view, record);
 249     return ERROR_SUCCESS;
 250 }
 251
 252 static UINT STREAMS_close(struct tagMSIVIEW *view)
 253 {
 254     TRACE("(%p)\n", view);
 255     return ERROR_SUCCESS;
 256 }
 257
 258 static UINT STREAMS_get_dimensions(struct tagMSIVIEW *view, UINT *rows, UINT *cols)
 259 {
 260     MSISTREAMSVIEW *sv = (MSISTREAMSVIEW *)view;
 261
 262     TRACE("(%p, %p, %p)\n", view, rows, cols);
 263
 264     if (cols) *cols = NUM_STREAMS_COLS;
 265     if (rows) *rows = sv->num_rows;
 266
 267     return ERROR_SUCCESS;
 268 }
 269
 270 static UINT STREAMS_get_column_info( struct tagMSIVIEW *view, UINT n, LPCWSTR *name,
 271                                      UINT *type, BOOL *temporary, LPCWSTR *table_name )
 272 {
 273     TRACE("(%p, %d, %p, %p, %p, %p)\n", view, n, name, type, temporary,
 274           table_name);
 275
 276     if (n == 0 || n > NUM_STREAMS_COLS)
 277         return ERROR_INVALID_PARAMETER;
 278
 279     switch (n)
 280     {
 281     case 1:
 282         if (name) *name = szName;
 283         if (type) *type = MSITYPE_STRING | MSITYPE_VALID | MAX_STREAM_NAME_LEN;
 284         break;
 285
 286     case 2:
 287         if (name) *name = szData;
 288         if (type) *type = MSITYPE_STRING | MSITYPE_VALID | MSITYPE_NULLABLE;
 289         break;
 290     }
 291     if (table_name) *table_name = szStreams;
 292     if (temporary) *temporary = FALSE;
 293     return ERROR_SUCCESS;
 294 }
 295
 296 static UINT streams_find_row(MSISTREAMSVIEW *sv, MSIRECORD *rec, UINT *row)
 297 {
 298     LPCWSTR str;
 299     UINT r, i, id, data;
 300
 301     str = MSI_RecordGetString(rec, 1);
 302     r = msi_string2idW(sv->db->strings, str, &id);
 303     if (r != ERROR_SUCCESS)
 304         return r;
 305
 306     for (i = 0; i < sv->num_rows; i++)
 307     {
 308         STREAMS_fetch_int(&sv->view, i, 1, &data);
 309
 310         if (data == id)
 311         {
 312             *row = i;
 313             return ERROR_SUCCESS;
 314         }
 315     }
 316
 317     return ERROR_FUNCTION_FAILED;
 318 }
 319
 320 static UINT streams_modify_update(struct tagMSIVIEW *view, MSIRECORD *rec)
 321 {
 322     MSISTREAMSVIEW *sv = (MSISTREAMSVIEW *)view;
 323     UINT r, row;
 324
 325     r = streams_find_row(sv, rec, &row);
 326     if (r != ERROR_SUCCESS)
 327         return ERROR_FUNCTION_FAILED;
 328
 329     return STREAMS_set_row(view, row, rec, 0);
 330 }
 331
 332 static UINT streams_modify_assign(struct tagMSIVIEW *view, MSIRECORD *rec)
 333 {
 334     MSISTREAMSVIEW *sv = (MSISTREAMSVIEW *)view;
 335     UINT r, row;
 336
 337     r = streams_find_row(sv, rec, &row);
 338     if (r == ERROR_SUCCESS)
 339         return streams_modify_update(view, rec);
 340
 341     return STREAMS_insert_row(view, rec, -1, FALSE);
 342 }
 343
 344 static UINT STREAMS_modify(struct tagMSIVIEW *view, MSIMODIFY eModifyMode, MSIRECORD *rec, UINT row)
 345 {
 346     UINT r;
 347
 348     TRACE("%p %d %p\n", view, eModifyMode, rec);
 349
 350     switch (eModifyMode)
 351     {
 352     case MSIMODIFY_ASSIGN:
 353         r = streams_modify_assign(view, rec);
 354         break;
 355
 356     case MSIMODIFY_INSERT:
 357         r = STREAMS_insert_row(view, rec, -1, FALSE);
 358         break;
 359
 360     case MSIMODIFY_UPDATE:
 361         r = streams_modify_update(view, rec);
 362         break;
 363
 364     case MSIMODIFY_VALIDATE_NEW:
 365     case MSIMODIFY_INSERT_TEMPORARY:
 366     case MSIMODIFY_REFRESH:
 367     case MSIMODIFY_REPLACE:
 368     case MSIMODIFY_MERGE:
 369     case MSIMODIFY_DELETE:
 370     case MSIMODIFY_VALIDATE:
 371     case MSIMODIFY_VALIDATE_FIELD:
 372     case MSIMODIFY_VALIDATE_DELETE:
 373         FIXME("%p %d %p - mode not implemented\n", view, eModifyMode, rec );
 374         r = ERROR_CALL_NOT_IMPLEMENTED;
 375         break;
 376
 377     default:
 378         r = ERROR_INVALID_DATA;
 379     }
 380
 381     return r;
 382 }
 383
 384 static UINT STREAMS_delete(struct tagMSIVIEW *view)
 385 {
 386     MSISTREAMSVIEW *sv = (MSISTREAMSVIEW *)view;
 387     UINT i;
 388
 389     TRACE("(%p)\n", view);
 390
 391     for (i = 0; i < sv->num_rows; i++)
 392     {
 393         if (sv->streams[i])
 394         {
 395             if (sv->streams[i]->stream)
 396                 IStream_Release(sv->streams[i]->stream);
 397             msi_free(sv->streams[i]);
 398         }
 399     }
 400
 401     msi_free(sv->streams);
 402     msi_free(sv);
 403
 404     return ERROR_SUCCESS;
 405 }
 406
 407 static UINT STREAMS_find_matching_rows(struct tagMSIVIEW *view, UINT col,
 408                                        UINT val, UINT *row, MSIITERHANDLE *handle)
 409 {
 410     MSISTREAMSVIEW *sv = (MSISTREAMSVIEW *)view;
 411     UINT index = PtrToUlong(*handle);
 412
 413     TRACE("(%p, %d, %d, %p, %p)\n", view, col, val, row, handle);
 414
 415     if (col == 0 || col > NUM_STREAMS_COLS)
 416         return ERROR_INVALID_PARAMETER;
 417
 418     while (index < sv->num_rows)
 419     {
 420         if (sv->streams[index]->str_index == val)
 421         {
 422             *row = index;
 423             break;
 424         }
 425
 426         index++;
 427     }
 428
 429     *handle = UlongToPtr(++index);
 430
 431     if (index > sv->num_rows)
 432         return ERROR_NO_MORE_ITEMS;
 433
 434     return ERROR_SUCCESS;
 435 }
 436
 437 static const MSIVIEWOPS streams_ops =
 438 {
 439     STREAMS_fetch_int,
 440     STREAMS_fetch_stream,
 441     STREAMS_get_row,
 442     STREAMS_set_row,
 443     STREAMS_insert_row,
 444     STREAMS_delete_row,
 445     STREAMS_execute,
 446     STREAMS_close,
 447     STREAMS_get_dimensions,
 448     STREAMS_get_column_info,
 449     STREAMS_modify,
 450     STREAMS_delete,
 451     STREAMS_find_matching_rows,
 452     NULL,
 453     NULL,
 454     NULL,
 455     NULL,
 456     NULL,
 457     NULL,
 458 };
 459
 460 static INT add_streams_to_table(MSISTREAMSVIEW *sv)
 461 {
 462     IEnumSTATSTG *stgenum = NULL;
 463     STATSTG stat;
 464     STREAM *stream = NULL;
 465     HRESULT hr;
 466     UINT r, count = 0, size;
 467     LPWSTR encname;
 468
 469     hr = IStorage_EnumElements(sv->db->storage, 0, NULL, 0, &stgenum);
 470     if (FAILED(hr))
 471         return -1;
 472
 473     sv->max_streams = 1;
 474     sv->streams = msi_alloc_zero(sizeof(STREAM *));
 475     if (!sv->streams)
 476         return -1;
 477
 478     while (TRUE)
 479     {
 480         size = 0;
 481         hr = IEnumSTATSTG_Next(stgenum, 1, &stat, &size);
 482         if (FAILED(hr) || !size)
 483             break;
 484
 485         if (stat.type != STGTY_STREAM)
 486         {
 487             CoTaskMemFree(stat.pwcsName);
 488             continue;
 489         }
 490
 491         /* table streams are not in the _Streams table */
 492         if (*stat.pwcsName == 0x4840)
 493         {
 494             CoTaskMemFree(stat.pwcsName);
 495             continue;
 496         }
 497
 498         stream = create_stream(sv, stat.pwcsName, TRUE, NULL);
 499         if (!stream)
 500         {
 501             count = -1;
 502             CoTaskMemFree(stat.pwcsName);
 503             break;
 504         }
 505
 506         /* these streams appear to be unencoded */
 507         if (*stat.pwcsName == 0x0005)
 508         {
 509             r = msi_get_raw_stream(sv->db, stat.pwcsName, &stream->stream);
 510         }
 511         else
 512         {
 513             encname = encode_streamname(FALSE, stat.pwcsName);
 514             r = msi_get_raw_stream(sv->db, encname, &stream->stream);
 515             msi_free(encname);
 516         }
 517         CoTaskMemFree(stat.pwcsName);
 518
 519         if (r != ERROR_SUCCESS)
 520         {
 521             WARN("unable to get stream %u\n", r);
 522             count = -1;
 523             break;
 524         }
 525
 526         if (!streams_set_table_size(sv, ++count))
 527         {
 528             count = -1;
 529             break;
 530         }
 531
 532         sv->streams[count - 1] = stream;
 533     }
 534
 535     IEnumSTATSTG_Release(stgenum);
 536     return count;
 537 }
 538
 539 UINT STREAMS_CreateView(MSIDATABASE *db, MSIVIEW **view)
 540 {
 541     MSISTREAMSVIEW *sv;
 542     INT rows;
 543
 544     TRACE("(%p, %p)\n", db, view);
 545
 546     sv = msi_alloc_zero( sizeof(MSISTREAMSVIEW) );
 547     if (!sv)
 548         return ERROR_FUNCTION_FAILED;
 549
 550     sv->view.ops = &streams_ops;
 551     sv->db = db;
 552     rows = add_streams_to_table(sv);
 553     if (rows < 0)
 554     {
 555         msi_free( sv );
 556         return ERROR_FUNCTION_FAILED;
 557     }
 558     sv->num_rows = rows;
 559
 560     *view = (MSIVIEW *)sv;
 561
 562     return ERROR_SUCCESS;
 563 }