21b1db2a405a9f8fda310a23c9baba1f99eaacde
[reactos.git] / reactos / dll / win32 / msi / string.c
1 /*
2 * String Table Functions
3 *
4 * Copyright 2002-2004, Mike McCormack for CodeWeavers
5 * Copyright 2007 Robert Shearman for CodeWeavers
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 */
21
22 #define COBJMACROS
23
24 #include <stdarg.h>
25 #include <assert.h>
26
27 #include "windef.h"
28 #include "winbase.h"
29 #include "winerror.h"
30 #include "wine/debug.h"
31 #include "wine/unicode.h"
32 #include "msi.h"
33 #include "msiquery.h"
34 #include "objbase.h"
35 #include "objidl.h"
36 #include "msipriv.h"
37 #include "winnls.h"
38
39 #include "query.h"
40
41 WINE_DEFAULT_DEBUG_CHANNEL(msidb);
42
43 #define LONG_STR_BYTES 3
44
45 typedef struct _msistring
46 {
47 USHORT persistent_refcount;
48 USHORT nonpersistent_refcount;
49 LPWSTR str;
50 } msistring;
51
52 struct string_table
53 {
54 UINT maxcount; /* the number of strings */
55 UINT freeslot;
56 UINT codepage;
57 UINT sortcount;
58 msistring *strings; /* an array of strings */
59 UINT *sorted; /* index */
60 };
61
62 static string_table *init_stringtable( int entries, UINT codepage )
63 {
64 string_table *st;
65
66 if (codepage != CP_ACP && !IsValidCodePage(codepage))
67 {
68 ERR("invalid codepage %d\n", codepage);
69 return NULL;
70 }
71
72 st = msi_alloc( sizeof (string_table) );
73 if( !st )
74 return NULL;
75 if( entries < 1 )
76 entries = 1;
77
78 st->strings = msi_alloc_zero( sizeof (msistring) * entries );
79 if( !st->strings )
80 {
81 msi_free( st );
82 return NULL;
83 }
84
85 st->sorted = msi_alloc( sizeof (UINT) * entries );
86 if( !st->sorted )
87 {
88 msi_free( st->strings );
89 msi_free( st );
90 return NULL;
91 }
92
93 st->maxcount = entries;
94 st->freeslot = 1;
95 st->codepage = codepage;
96 st->sortcount = 0;
97
98 return st;
99 }
100
101 VOID msi_destroy_stringtable( string_table *st )
102 {
103 UINT i;
104
105 for( i=0; i<st->maxcount; i++ )
106 {
107 if( st->strings[i].persistent_refcount ||
108 st->strings[i].nonpersistent_refcount )
109 msi_free( st->strings[i].str );
110 }
111 msi_free( st->strings );
112 msi_free( st->sorted );
113 msi_free( st );
114 }
115
116 static int st_find_free_entry( string_table *st )
117 {
118 UINT i, sz, *s;
119 msistring *p;
120
121 TRACE("%p\n", st);
122
123 if( st->freeslot )
124 {
125 for( i = st->freeslot; i < st->maxcount; i++ )
126 if( !st->strings[i].persistent_refcount &&
127 !st->strings[i].nonpersistent_refcount )
128 return i;
129 }
130 for( i = 1; i < st->maxcount; i++ )
131 if( !st->strings[i].persistent_refcount &&
132 !st->strings[i].nonpersistent_refcount )
133 return i;
134
135 /* dynamically resize */
136 sz = st->maxcount + 1 + st->maxcount/2;
137 p = msi_realloc_zero( st->strings, sz*sizeof(msistring) );
138 if( !p )
139 return -1;
140
141 s = msi_realloc( st->sorted, sz*sizeof(UINT) );
142 if( !s )
143 {
144 msi_free( p );
145 return -1;
146 }
147
148 st->strings = p;
149 st->sorted = s;
150
151 st->freeslot = st->maxcount;
152 st->maxcount = sz;
153 if( st->strings[st->freeslot].persistent_refcount ||
154 st->strings[st->freeslot].nonpersistent_refcount )
155 ERR("oops. expected freeslot to be free...\n");
156 return st->freeslot;
157 }
158
159 static int find_insert_index( const string_table *st, UINT string_id )
160 {
161 int i, c, low = 0, high = st->sortcount - 1;
162
163 while (low <= high)
164 {
165 i = (low + high) / 2;
166 c = lstrcmpW( st->strings[string_id].str, st->strings[st->sorted[i]].str );
167
168 if (c < 0)
169 high = i - 1;
170 else if (c > 0)
171 low = i + 1;
172 else
173 return -1; /* already exists */
174 }
175 return high + 1;
176 }
177
178 static void insert_string_sorted( string_table *st, UINT string_id )
179 {
180 int i;
181
182 i = find_insert_index( st, string_id );
183 if (i == -1)
184 return;
185
186 memmove( &st->sorted[i] + 1, &st->sorted[i], (st->sortcount - i) * sizeof(UINT) );
187 st->sorted[i] = string_id;
188 st->sortcount++;
189 }
190
191 static void set_st_entry( string_table *st, UINT n, LPWSTR str, USHORT refcount, enum StringPersistence persistence )
192 {
193 if (persistence == StringPersistent)
194 {
195 st->strings[n].persistent_refcount = refcount;
196 st->strings[n].nonpersistent_refcount = 0;
197 }
198 else
199 {
200 st->strings[n].persistent_refcount = 0;
201 st->strings[n].nonpersistent_refcount = refcount;
202 }
203
204 st->strings[n].str = str;
205
206 insert_string_sorted( st, n );
207
208 if( n < st->maxcount )
209 st->freeslot = n + 1;
210 }
211
212 static UINT msi_string2idA( const string_table *st, LPCSTR buffer, UINT *id )
213 {
214 DWORD sz;
215 UINT r = ERROR_INVALID_PARAMETER;
216 LPWSTR str;
217
218 TRACE("Finding string %s in string table\n", debugstr_a(buffer) );
219
220 if( buffer[0] == 0 )
221 {
222 *id = 0;
223 return ERROR_SUCCESS;
224 }
225
226 sz = MultiByteToWideChar( st->codepage, 0, buffer, -1, NULL, 0 );
227 if( sz <= 0 )
228 return r;
229 str = msi_alloc( sz*sizeof(WCHAR) );
230 if( !str )
231 return ERROR_NOT_ENOUGH_MEMORY;
232 MultiByteToWideChar( st->codepage, 0, buffer, -1, str, sz );
233
234 r = msi_string2idW( st, str, id );
235 msi_free( str );
236
237 return r;
238 }
239
240 static int msi_addstring( string_table *st, UINT n, const CHAR *data, int len, USHORT refcount, enum StringPersistence persistence )
241 {
242 LPWSTR str;
243 int sz;
244
245 if( !data )
246 return 0;
247 if( !data[0] )
248 return 0;
249 if( n > 0 )
250 {
251 if( st->strings[n].persistent_refcount ||
252 st->strings[n].nonpersistent_refcount )
253 return -1;
254 }
255 else
256 {
257 if( ERROR_SUCCESS == msi_string2idA( st, data, &n ) )
258 {
259 if (persistence == StringPersistent)
260 st->strings[n].persistent_refcount += refcount;
261 else
262 st->strings[n].nonpersistent_refcount += refcount;
263 return n;
264 }
265 n = st_find_free_entry( st );
266 if( n == -1 )
267 return -1;
268 }
269
270 if( n < 1 )
271 {
272 ERR("invalid index adding %s (%d)\n", debugstr_a( data ), n );
273 return -1;
274 }
275
276 /* allocate a new string */
277 if( len < 0 )
278 len = strlen(data);
279 sz = MultiByteToWideChar( st->codepage, 0, data, len, NULL, 0 );
280 str = msi_alloc( (sz+1)*sizeof(WCHAR) );
281 if( !str )
282 return -1;
283 MultiByteToWideChar( st->codepage, 0, data, len, str, sz );
284 str[sz] = 0;
285
286 set_st_entry( st, n, str, refcount, persistence );
287
288 return n;
289 }
290
291 int msi_addstringW( string_table *st, const WCHAR *data, int len, USHORT refcount, enum StringPersistence persistence )
292 {
293 UINT n;
294 LPWSTR str;
295
296 if( !data )
297 return 0;
298 if( !data[0] )
299 return 0;
300
301 if( msi_string2idW( st, data, &n ) == ERROR_SUCCESS )
302 {
303 if (persistence == StringPersistent)
304 st->strings[n].persistent_refcount += refcount;
305 else
306 st->strings[n].nonpersistent_refcount += refcount;
307 return n;
308 }
309
310 n = st_find_free_entry( st );
311 if( n == -1 )
312 return -1;
313
314 /* allocate a new string */
315 if(len<0)
316 len = strlenW(data);
317 TRACE("%s, n = %d len = %d\n", debugstr_w(data), n, len );
318
319 str = msi_alloc( (len+1)*sizeof(WCHAR) );
320 if( !str )
321 return -1;
322 memcpy( str, data, len*sizeof(WCHAR) );
323 str[len] = 0;
324
325 set_st_entry( st, n, str, refcount, persistence );
326
327 return n;
328 }
329
330 /* find the string identified by an id - return null if there's none */
331 const WCHAR *msi_string_lookup_id( const string_table *st, UINT id )
332 {
333 if( id == 0 )
334 return szEmpty;
335
336 if( id >= st->maxcount )
337 return NULL;
338
339 if( id && !st->strings[id].persistent_refcount && !st->strings[id].nonpersistent_refcount)
340 return NULL;
341
342 return st->strings[id].str;
343 }
344
345 /*
346 * msi_id2stringA
347 *
348 * [in] st - pointer to the string table
349 * [in] id - id of the string to retrieve
350 * [out] buffer - destination of the UTF8 string
351 * [in/out] sz - number of bytes available in the buffer on input
352 * number of bytes used on output
353 *
354 * The size includes the terminating nul character. Short buffers
355 * will be filled, but not nul terminated.
356 */
357 static UINT msi_id2stringA( const string_table *st, UINT id, LPSTR buffer, UINT *sz )
358 {
359 UINT len;
360 const WCHAR *str;
361 int n;
362
363 TRACE("Finding string %d of %d\n", id, st->maxcount);
364
365 str = msi_string_lookup_id( st, id );
366 if( !str )
367 return ERROR_FUNCTION_FAILED;
368
369 len = WideCharToMultiByte( st->codepage, 0, str, -1, NULL, 0, NULL, NULL );
370
371 if( !buffer )
372 {
373 *sz = len;
374 return ERROR_SUCCESS;
375 }
376
377 if( len > *sz )
378 {
379 n = strlenW( str ) + 1;
380 while( n && (len > *sz) )
381 len = WideCharToMultiByte( st->codepage, 0,
382 str, --n, NULL, 0, NULL, NULL );
383 }
384 else
385 n = -1;
386
387 *sz = WideCharToMultiByte( st->codepage, 0, str, n, buffer, len, NULL, NULL );
388
389 return ERROR_SUCCESS;
390 }
391
392 /*
393 * msi_string2idW
394 *
395 * [in] st - pointer to the string table
396 * [in] str - string to find in the string table
397 * [out] id - id of the string, if found
398 */
399 UINT msi_string2idW( const string_table *st, LPCWSTR str, UINT *id )
400 {
401 int i, c, low = 0, high = st->sortcount - 1;
402
403 while (low <= high)
404 {
405 i = (low + high) / 2;
406 c = lstrcmpW( str, st->strings[st->sorted[i]].str );
407
408 if (c < 0)
409 high = i - 1;
410 else if (c > 0)
411 low = i + 1;
412 else
413 {
414 *id = st->sorted[i];
415 return ERROR_SUCCESS;
416 }
417 }
418
419 return ERROR_INVALID_PARAMETER;
420 }
421
422 static void string_totalsize( const string_table *st, UINT *datasize, UINT *poolsize )
423 {
424 UINT i, len, holesize;
425
426 if( st->strings[0].str || st->strings[0].persistent_refcount || st->strings[0].nonpersistent_refcount)
427 ERR("oops. element 0 has a string\n");
428
429 *poolsize = 4;
430 *datasize = 0;
431 holesize = 0;
432 for( i=1; i<st->maxcount; i++ )
433 {
434 if( !st->strings[i].persistent_refcount )
435 {
436 TRACE("[%u] nonpersistent = %s\n", i, debugstr_w(st->strings[i].str));
437 (*poolsize) += 4;
438 }
439 else if( st->strings[i].str )
440 {
441 TRACE("[%u] = %s\n", i, debugstr_w(st->strings[i].str));
442 len = WideCharToMultiByte( st->codepage, 0,
443 st->strings[i].str, -1, NULL, 0, NULL, NULL);
444 if( len )
445 len--;
446 (*datasize) += len;
447 if (len>0xffff)
448 (*poolsize) += 4;
449 (*poolsize) += holesize + 4;
450 holesize = 0;
451 }
452 else
453 holesize += 4;
454 }
455 TRACE("data %u pool %u codepage %x\n", *datasize, *poolsize, st->codepage );
456 }
457
458 static const WCHAR szStringData[] = {
459 '_','S','t','r','i','n','g','D','a','t','a',0 };
460 static const WCHAR szStringPool[] = {
461 '_','S','t','r','i','n','g','P','o','o','l',0 };
462
463 HRESULT msi_init_string_table( IStorage *stg )
464 {
465 USHORT zero[2] = { 0, 0 };
466 UINT ret;
467
468 /* create the StringPool stream... add the zero string to it*/
469 ret = write_stream_data(stg, szStringPool, zero, sizeof zero, TRUE);
470 if (ret != ERROR_SUCCESS)
471 return E_FAIL;
472
473 /* create the StringData stream... make it zero length */
474 ret = write_stream_data(stg, szStringData, NULL, 0, TRUE);
475 if (ret != ERROR_SUCCESS)
476 return E_FAIL;
477
478 return S_OK;
479 }
480
481 string_table *msi_load_string_table( IStorage *stg, UINT *bytes_per_strref )
482 {
483 string_table *st = NULL;
484 CHAR *data = NULL;
485 USHORT *pool = NULL;
486 UINT r, datasize = 0, poolsize = 0, codepage;
487 DWORD i, count, offset, len, n, refs;
488
489 r = read_stream_data( stg, szStringPool, TRUE, (BYTE **)&pool, &poolsize );
490 if( r != ERROR_SUCCESS)
491 goto end;
492 r = read_stream_data( stg, szStringData, TRUE, (BYTE **)&data, &datasize );
493 if( r != ERROR_SUCCESS)
494 goto end;
495
496 if ( (poolsize > 4) && (pool[1] & 0x8000) )
497 *bytes_per_strref = LONG_STR_BYTES;
498 else
499 *bytes_per_strref = sizeof(USHORT);
500
501 count = poolsize/4;
502 if( poolsize > 4 )
503 codepage = pool[0] | ( (pool[1] & ~0x8000) << 16 );
504 else
505 codepage = CP_ACP;
506 st = init_stringtable( count, codepage );
507 if (!st)
508 goto end;
509
510 offset = 0;
511 n = 1;
512 i = 1;
513 while( i<count )
514 {
515 /* the string reference count is always the second word */
516 refs = pool[i*2+1];
517
518 /* empty entries have two zeros, still have a string id */
519 if (pool[i*2] == 0 && refs == 0)
520 {
521 i++;
522 n++;
523 continue;
524 }
525
526 /*
527 * If a string is over 64k, the previous string entry is made null
528 * and its the high word of the length is inserted in the null string's
529 * reference count field.
530 */
531 if( pool[i*2] == 0)
532 {
533 len = (pool[i*2+3] << 16) + pool[i*2+2];
534 i += 2;
535 }
536 else
537 {
538 len = pool[i*2];
539 i += 1;
540 }
541
542 if ( (offset + len) > datasize )
543 {
544 ERR("string table corrupt?\n");
545 break;
546 }
547
548 r = msi_addstring( st, n, data+offset, len, refs, StringPersistent );
549 if( r != n )
550 ERR("Failed to add string %d\n", n );
551 n++;
552 offset += len;
553 }
554
555 if ( datasize != offset )
556 ERR("string table load failed! (%08x != %08x), please report\n", datasize, offset );
557
558 TRACE("Loaded %d strings\n", count);
559
560 end:
561 msi_free( pool );
562 msi_free( data );
563
564 return st;
565 }
566
567 UINT msi_save_string_table( const string_table *st, IStorage *storage )
568 {
569 UINT i, datasize = 0, poolsize = 0, sz, used, r, codepage, n;
570 UINT ret = ERROR_FUNCTION_FAILED;
571 CHAR *data = NULL;
572 USHORT *pool = NULL;
573
574 TRACE("\n");
575
576 /* construct the new table in memory first */
577 string_totalsize( st, &datasize, &poolsize );
578
579 TRACE("%u %u %u\n", st->maxcount, datasize, poolsize );
580
581 pool = msi_alloc( poolsize );
582 if( ! pool )
583 {
584 WARN("Failed to alloc pool %d bytes\n", poolsize );
585 goto err;
586 }
587 data = msi_alloc( datasize );
588 if( ! data )
589 {
590 WARN("Failed to alloc data %d bytes\n", poolsize );
591 goto err;
592 }
593
594 used = 0;
595 codepage = st->codepage;
596 pool[0]=codepage&0xffff;
597 pool[1]=(codepage>>16);
598 n = 1;
599 for( i=1; i<st->maxcount; i++ )
600 {
601 if( !st->strings[i].persistent_refcount )
602 {
603 pool[ n*2 ] = 0;
604 pool[ n*2 + 1] = 0;
605 n++;
606 continue;
607 }
608
609 sz = datasize - used;
610 r = msi_id2stringA( st, i, data+used, &sz );
611 if( r != ERROR_SUCCESS )
612 {
613 ERR("failed to fetch string\n");
614 sz = 0;
615 }
616 if( sz && (sz < (datasize - used ) ) )
617 sz--;
618
619 if (sz)
620 pool[ n*2 + 1 ] = st->strings[i].persistent_refcount;
621 else
622 pool[ n*2 + 1 ] = 0;
623 if (sz < 0x10000)
624 {
625 pool[ n*2 ] = sz;
626 n++;
627 }
628 else
629 {
630 pool[ n*2 ] = 0;
631 pool[ n*2 + 2 ] = sz&0xffff;
632 pool[ n*2 + 3 ] = (sz>>16);
633 n += 2;
634 }
635 used += sz;
636 if( used > datasize )
637 {
638 ERR("oops overran %d >= %d\n", used, datasize);
639 goto err;
640 }
641 }
642
643 if( used != datasize )
644 {
645 ERR("oops used %d != datasize %d\n", used, datasize);
646 goto err;
647 }
648
649 /* write the streams */
650 r = write_stream_data( storage, szStringData, data, datasize, TRUE );
651 TRACE("Wrote StringData r=%08x\n", r);
652 if( r )
653 goto err;
654 r = write_stream_data( storage, szStringPool, pool, poolsize, TRUE );
655 TRACE("Wrote StringPool r=%08x\n", r);
656 if( r )
657 goto err;
658
659 ret = ERROR_SUCCESS;
660
661 err:
662 msi_free( data );
663 msi_free( pool );
664
665 return ret;
666 }