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         msi_free(stream);
 204         goto done;
 205     }
 206
 207     sv->streams[row] = stream;
 208
 209 done:
 210     msi_free(name);
 211     msi_free(data);
 212     msi_free(encname);
 213
 214     IStream_Release(stm);
 215
 216     return r;
 217 }
 218
 219 static UINT STREAMS_insert_row(struct tagMSIVIEW *view, MSIRECORD *rec, UINT row, BOOL temporary)
 220 {
 221     MSISTREAMSVIEW *sv = (MSISTREAMSVIEW *)view;
 222     UINT i;
 223
 224     TRACE("(%p, %p, %d, %d)\n", view, rec, row, temporary);
 225
 226     if (!streams_set_table_size(sv, ++sv->num_rows))
 227         return ERROR_FUNCTION_FAILED;
 228
 229     if (row == -1)
 230         row = sv->num_rows - 1;
 231
 232     /* shift the rows to make room for the new row */
 233     for (i = sv->num_rows - 1; i > row; i--)
 234     {
 235         sv->streams[i] = sv->streams[i - 1];
 236     }
 237
 238     return STREAMS_set_row(view, row, rec, 0);
 239 }
 240
 241 static UINT STREAMS_delete_row(struct tagMSIVIEW *view, UINT row)
 242 {
 243     FIXME("(%p %d): stub!\n", view, row);
 244     return ERROR_SUCCESS;
 245 }
 246
 247 static UINT STREAMS_execute(struct tagMSIVIEW *view, MSIRECORD *record)
 248 {
 249     TRACE("(%p, %p)\n", view, record);
 250     return ERROR_SUCCESS;
 251 }
 252
 253 static UINT STREAMS_close(struct tagMSIVIEW *view)
 254 {
 255     TRACE("(%p)\n", view);
 256     return ERROR_SUCCESS;
 257 }
 258
 259 static UINT STREAMS_get_dimensions(struct tagMSIVIEW *view, UINT *rows, UINT *cols)
 260 {
 261     MSISTREAMSVIEW *sv = (MSISTREAMSVIEW *)view;
 262
 263     TRACE("(%p, %p, %p)\n", view, rows, cols);
 264
 265     if (cols) *cols = NUM_STREAMS_COLS;
 266     if (rows) *rows = sv->num_rows;
 267
 268     return ERROR_SUCCESS;
 269 }
 270
 271 static UINT STREAMS_get_column_info( struct tagMSIVIEW *view, UINT n, LPCWSTR *name,
 272                                      UINT *type, BOOL *temporary, LPCWSTR *table_name )
 273 {
 274     TRACE("(%p, %d, %p, %p, %p, %p)\n", view, n, name, type, temporary,
 275           table_name);
 276
 277     if (n == 0 || n > NUM_STREAMS_COLS)
 278         return ERROR_INVALID_PARAMETER;
 279
 280     switch (n)
 281     {
 282     case 1:
 283         if (name) *name = szName;
 284         if (type) *type = MSITYPE_STRING | MSITYPE_VALID | MAX_STREAM_NAME_LEN;
 285         break;
 286
 287     case 2:
 288         if (name) *name = szData;
 289         if (type) *type = MSITYPE_STRING | MSITYPE_VALID | MSITYPE_NULLABLE;
 290         break;
 291     }
 292     if (table_name) *table_name = szStreams;
 293     if (temporary) *temporary = FALSE;
 294     return ERROR_SUCCESS;
 295 }
 296
 297 static UINT streams_find_row(MSISTREAMSVIEW *sv, MSIRECORD *rec, UINT *row)
 298 {
 299     LPCWSTR str;
 300     UINT r, i, id, data;
 301
 302     str = MSI_RecordGetString(rec, 1);
 303     r = msi_string2id(sv->db->strings, str, -1, &id);
 304     if (r != ERROR_SUCCESS)
 305         return r;
 306
 307     for (i = 0; i < sv->num_rows; i++)
 308     {
 309         STREAMS_fetch_int(&sv->view, i, 1, &data);
 310
 311         if (data == id)
 312         {
 313             *row = i;
 314             return ERROR_SUCCESS;
 315         }
 316     }
 317
 318     return ERROR_FUNCTION_FAILED;
 319 }
 320
 321 static UINT streams_modify_update(struct tagMSIVIEW *view, MSIRECORD *rec)
 322 {
 323     MSISTREAMSVIEW *sv = (MSISTREAMSVIEW *)view;
 324     UINT r, row;
 325
 326     r = streams_find_row(sv, rec, &row);
 327     if (r != ERROR_SUCCESS)
 328         return ERROR_FUNCTION_FAILED;
 329
 330     return STREAMS_set_row(view, row, rec, 0);
 331 }
 332
 333 static UINT streams_modify_assign(struct tagMSIVIEW *view, MSIRECORD *rec)
 334 {
 335     MSISTREAMSVIEW *sv = (MSISTREAMSVIEW *)view;
 336     UINT r, row;
 337
 338     r = streams_find_row(sv, rec, &row);
 339     if (r == ERROR_SUCCESS)
 340         return streams_modify_update(view, rec);
 341
 342     return STREAMS_insert_row(view, rec, -1, FALSE);
 343 }
 344
 345 static UINT STREAMS_modify(struct tagMSIVIEW *view, MSIMODIFY eModifyMode, MSIRECORD *rec, UINT row)
 346 {
 347     UINT r;
 348
 349     TRACE("%p %d %p\n", view, eModifyMode, rec);
 350
 351     switch (eModifyMode)
 352     {
 353     case MSIMODIFY_ASSIGN:
 354         r = streams_modify_assign(view, rec);
 355         break;
 356
 357     case MSIMODIFY_INSERT:
 358         r = STREAMS_insert_row(view, rec, -1, FALSE);
 359         break;
 360
 361     case MSIMODIFY_UPDATE:
 362         r = streams_modify_update(view, rec);
 363         break;
 364
 365     case MSIMODIFY_VALIDATE_NEW:
 366     case MSIMODIFY_INSERT_TEMPORARY:
 367     case MSIMODIFY_REFRESH:
 368     case MSIMODIFY_REPLACE:
 369     case MSIMODIFY_MERGE:
 370     case MSIMODIFY_DELETE:
 371     case MSIMODIFY_VALIDATE:
 372     case MSIMODIFY_VALIDATE_FIELD:
 373     case MSIMODIFY_VALIDATE_DELETE:
 374         FIXME("%p %d %p - mode not implemented\n", view, eModifyMode, rec );
 375         r = ERROR_CALL_NOT_IMPLEMENTED;
 376         break;
 377
 378     default:
 379         r = ERROR_INVALID_DATA;
 380     }
 381
 382     return r;
 383 }
 384
 385 static UINT STREAMS_delete(struct tagMSIVIEW *view)
 386 {
 387     MSISTREAMSVIEW *sv = (MSISTREAMSVIEW *)view;
 388     UINT i;
 389
 390     TRACE("(%p)\n", view);
 391
 392     for (i = 0; i < sv->num_rows; i++)
 393     {
 394         if (sv->streams[i])
 395         {
 396             if (sv->streams[i]->stream)
 397                 IStream_Release(sv->streams[i]->stream);
 398             msi_free(sv->streams[i]);
 399         }
 400     }
 401
 402     msi_free(sv->streams);
 403     msi_free(sv);
 404
 405     return ERROR_SUCCESS;
 406 }
 407
 408 static UINT STREAMS_find_matching_rows(struct tagMSIVIEW *view, UINT col,
 409                                        UINT val, UINT *row, MSIITERHANDLE *handle)
 410 {
 411     MSISTREAMSVIEW *sv = (MSISTREAMSVIEW *)view;
 412     UINT index = PtrToUlong(*handle);
 413
 414     TRACE("(%p, %d, %d, %p, %p)\n", view, col, val, row, handle);
 415
 416     if (col == 0 || col > NUM_STREAMS_COLS)
 417         return ERROR_INVALID_PARAMETER;
 418
 419     while (index < sv->num_rows)
 420     {
 421         if (sv->streams[index]->str_index == val)
 422         {
 423             *row = index;
 424             break;
 425         }
 426
 427         index++;
 428     }
 429
 430     *handle = UlongToPtr(++index);
 431
 432     if (index > sv->num_rows)
 433         return ERROR_NO_MORE_ITEMS;
 434
 435     return ERROR_SUCCESS;
 436 }
 437
 438 static const MSIVIEWOPS streams_ops =
 439 {
 440     STREAMS_fetch_int,
 441     STREAMS_fetch_stream,
 442     STREAMS_get_row,
 443     STREAMS_set_row,
 444     STREAMS_insert_row,
 445     STREAMS_delete_row,
 446     STREAMS_execute,
 447     STREAMS_close,
 448     STREAMS_get_dimensions,
 449     STREAMS_get_column_info,
 450     STREAMS_modify,
 451     STREAMS_delete,
 452     STREAMS_find_matching_rows,
 453     NULL,
 454     NULL,
 455     NULL,
 456     NULL,
 457     NULL,
 458     NULL,
 459 };
 460
 461 static INT add_streams_to_table(MSISTREAMSVIEW *sv)
 462 {
 463     IEnumSTATSTG *stgenum = NULL;
 464     STATSTG stat;
 465     STREAM *stream = NULL;
 466     HRESULT hr;
 467     UINT r, count = 0, size;
 468     LPWSTR encname;
 469
 470     hr = IStorage_EnumElements(sv->db->storage, 0, NULL, 0, &stgenum);
 471     if (FAILED(hr))
 472         return -1;
 473
 474     sv->max_streams = 1;
 475     sv->streams = msi_alloc_zero(sizeof(STREAM *));
 476     if (!sv->streams)
 477         return -1;
 478
 479     while (TRUE)
 480     {
 481         size = 0;
 482         hr = IEnumSTATSTG_Next(stgenum, 1, &stat, &size);
 483         if (FAILED(hr) || !size)
 484             break;
 485
 486         if (stat.type != STGTY_STREAM)
 487         {
 488             CoTaskMemFree(stat.pwcsName);
 489             continue;
 490         }
 491
 492         /* table streams are not in the _Streams table */
 493         if (*stat.pwcsName == 0x4840)
 494         {
 495             CoTaskMemFree(stat.pwcsName);
 496             continue;
 497         }
 498
 499         stream = create_stream(sv, stat.pwcsName, TRUE, NULL);
 500         if (!stream)
 501         {
 502             count = -1;
 503             CoTaskMemFree(stat.pwcsName);
 504             break;
 505         }
 506
 507         /* these streams appear to be unencoded */
 508         if (*stat.pwcsName == 0x0005)
 509         {
 510             r = msi_get_raw_stream(sv->db, stat.pwcsName, &stream->stream);
 511         }
 512         else
 513         {
 514             encname = encode_streamname(FALSE, stat.pwcsName);
 515             r = msi_get_raw_stream(sv->db, encname, &stream->stream);
 516             msi_free(encname);
 517         }
 518         CoTaskMemFree(stat.pwcsName);
 519
 520         if (r != ERROR_SUCCESS)
 521         {
 522             WARN("unable to get stream %u\n", r);
 523             count = -1;
 524             break;
 525         }
 526
 527         if (!streams_set_table_size(sv, ++count))
 528         {
 529             count = -1;
 530             break;
 531         }
 532
 533         sv->streams[count - 1] = stream;
 534     }
 535
 536     IEnumSTATSTG_Release(stgenum);
 537     return count;
 538 }
 539
 540 UINT STREAMS_CreateView(MSIDATABASE *db, MSIVIEW **view)
 541 {
 542     MSISTREAMSVIEW *sv;
 543     INT rows;
 544
 545     TRACE("(%p, %p)\n", db, view);
 546
 547     sv = msi_alloc_zero( sizeof(MSISTREAMSVIEW) );
 548     if (!sv)
 549         return ERROR_FUNCTION_FAILED;
 550
 551     sv->view.ops = &streams_ops;
 552     sv->db = db;
 553     rows = add_streams_to_table(sv);
 554     if (rows < 0)
 555     {
 556         msi_free( sv );
 557         return ERROR_FUNCTION_FAILED;
 558     }
 559     sv->num_rows = rows;
 560
 561     *view = (MSIVIEW *)sv;
 562
 563     return ERROR_SUCCESS;
 564 }