msi: Clean up after the package tests.
[wine] / dlls / msi / helpers.c
1 /*
2  * Implementation of the Microsoft Installer (msi.dll)
3  *
4  * Copyright 2005 Aric Stewart 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 /*
22  * Here are helper functions formally in action.c that are used by a variaty of
23  * actions and functions.
24  */
25
26 #include <stdarg.h>
27
28 #include "windef.h"
29 #include "winbase.h"
30 #include "winerror.h"
31 #include "wine/debug.h"
32 #include "msipriv.h"
33 #include "winuser.h"
34 #include "wine/unicode.h"
35 #include "msidefs.h"
36
37 WINE_DEFAULT_DEBUG_CHANNEL(msi);
38
39 static const WCHAR cszTargetDir[] = {'T','A','R','G','E','T','D','I','R',0};
40 static const WCHAR cszDatabase[]={'D','A','T','A','B','A','S','E',0};
41
42 const WCHAR cszSourceDir[] = {'S','o','u','r','c','e','D','i','r',0};
43 const WCHAR cszRootDrive[] = {'R','O','O','T','D','R','I','V','E',0};
44 const WCHAR cszbs[]={'\\',0};
45
46 LPWSTR build_icon_path(MSIPACKAGE *package, LPCWSTR icon_name )
47 {
48     LPWSTR SystemFolder, dest, FilePath;
49
50     static const WCHAR szInstaller[] = 
51         {'M','i','c','r','o','s','o','f','t','\\',
52          'I','n','s','t','a','l','l','e','r','\\',0};
53     static const WCHAR szFolder[] =
54         {'A','p','p','D','a','t','a','F','o','l','d','e','r',0};
55
56     SystemFolder = msi_dup_property( package, szFolder );
57
58     dest = build_directory_name(3, SystemFolder, szInstaller, package->ProductCode);
59
60     create_full_pathW(dest);
61
62     FilePath = build_directory_name(2, dest, icon_name);
63
64     msi_free(SystemFolder);
65     msi_free(dest);
66     return FilePath;
67 }
68
69 LPWSTR msi_dup_record_field( MSIRECORD *row, INT index )
70 {
71     return strdupW( MSI_RecordGetString(row,index) );
72 }
73
74 MSICOMPONENT* get_loaded_component( MSIPACKAGE* package, LPCWSTR Component )
75 {
76     MSICOMPONENT *comp;
77
78     LIST_FOR_EACH_ENTRY( comp, &package->components, MSICOMPONENT, entry )
79     {
80         if (lstrcmpW(Component,comp->Component)==0)
81             return comp;
82     }
83     return NULL;
84 }
85
86 MSIFEATURE* get_loaded_feature(MSIPACKAGE* package, LPCWSTR Feature )
87 {
88     MSIFEATURE *feature;
89
90     LIST_FOR_EACH_ENTRY( feature, &package->features, MSIFEATURE, entry )
91     {
92         if (lstrcmpW( Feature, feature->Feature )==0)
93             return feature;
94     }
95     return NULL;
96 }
97
98 MSIFILE* get_loaded_file( MSIPACKAGE* package, LPCWSTR key )
99 {
100     MSIFILE *file;
101
102     LIST_FOR_EACH_ENTRY( file, &package->files, MSIFILE, entry )
103     {
104         if (lstrcmpW( key, file->File )==0)
105             return file;
106     }
107     return NULL;
108 }
109
110 int track_tempfile( MSIPACKAGE *package, LPCWSTR name, LPCWSTR path )
111 {
112     MSITEMPFILE *temp;
113
114     LIST_FOR_EACH_ENTRY( temp, &package->tempfiles, MSITEMPFILE, entry )
115     {
116         if (lstrcmpW( name, temp->File )==0)
117         {
118             TRACE("tempfile %s already exists with path %s\n",
119                 debugstr_w(temp->File), debugstr_w(temp->Path));
120             return -1;
121         }
122     }
123
124     temp = msi_alloc_zero( sizeof (MSITEMPFILE) );
125     if (!temp)
126         return -1;
127
128     list_add_head( &package->tempfiles, &temp->entry );
129
130     temp->File = strdupW( name );
131     temp->Path = strdupW( path );
132
133     TRACE("adding tempfile %s with path %s\n",
134            debugstr_w(temp->File), debugstr_w(temp->Path));
135
136     return 0;
137 }
138
139 MSIFOLDER *get_loaded_folder( MSIPACKAGE *package, LPCWSTR dir )
140 {
141     MSIFOLDER *folder;
142     
143     LIST_FOR_EACH_ENTRY( folder, &package->folders, MSIFOLDER, entry )
144     {
145         if (lstrcmpW( dir, folder->Directory )==0)
146             return folder;
147     }
148     return NULL;
149 }
150
151 static LPWSTR get_source_root( MSIPACKAGE *package )
152 {
153     LPWSTR path, p;
154
155     path = msi_dup_property( package, cszSourceDir );
156     if (path)
157         return path;
158
159     path = msi_dup_property( package, cszDatabase );
160     if (path)
161     {
162         p = strrchrW(path,'\\');
163         if (p)
164             *(p+1) = 0;
165     }
166     return path;
167 }
168
169 /*
170  * clean_spaces_from_path()
171  *
172  * removes spaces from the beginning and end of path segments
173  * removes multiple \\ characters
174  */
175 static void clean_spaces_from_path( LPWSTR p )
176 {
177     LPWSTR q = p;
178     int n, len = 0;
179
180     while (1)
181     {
182         /* copy until the end of the string or a space */
183         while (*p != ' ' && (*q = *p))
184         {
185             p++, len++;
186             /* reduce many backslashes to one */
187             if (*p != '\\' || *q != '\\')
188                 q++;
189         }
190
191         /* quit at the end of the string */
192         if (!*p)
193             break;
194
195         /* count the number of spaces */
196         n = 0;
197         while (p[n] == ' ')
198             n++;
199
200         /* if it's leading or trailing space, skip it */
201         if ( len == 0 || p[-1] == '\\' || p[n] == '\\' )
202             p += n;
203         else  /* copy n spaces */
204             while (n && (*q++ = *p++)) n--;
205     }
206 }
207
208 LPWSTR resolve_folder(MSIPACKAGE *package, LPCWSTR name, BOOL source, 
209                       BOOL set_prop, MSIFOLDER **folder)
210 {
211     MSIFOLDER *f;
212     LPWSTR p, path = NULL;
213
214     TRACE("Working to resolve %s\n",debugstr_w(name));
215
216     if (!name)
217         return NULL;
218
219     f = get_loaded_folder( package, name );
220     if (!f)
221         return NULL;
222
223     /* special resolving for Target and Source root dir */
224     if (strcmpW(name,cszTargetDir)==0 || strcmpW(name,cszSourceDir)==0)
225     {
226         if (!f->ResolvedTarget && !f->Property)
227         {
228             LPWSTR check_path;
229             check_path = msi_dup_property( package, cszTargetDir );
230             if (!check_path)
231             {
232                 check_path = msi_dup_property( package, cszRootDrive );
233                 if (set_prop)
234                     MSI_SetPropertyW(package,cszTargetDir,check_path);
235             }
236
237             /* correct misbuilt target dir */
238             path = build_directory_name(2, check_path, NULL);
239             clean_spaces_from_path( path );
240             if (strcmpiW(path,check_path)!=0)
241                 MSI_SetPropertyW(package,cszTargetDir,path);
242             msi_free(check_path);
243
244             f->ResolvedTarget = path;
245         }
246
247         if (!f->ResolvedSource)
248             f->ResolvedSource = get_source_root( package );
249     }
250
251     if (folder)
252         *folder = f;
253
254     if (!source && f->ResolvedTarget)
255     {
256         path = strdupW( f->ResolvedTarget );
257         TRACE("   already resolved to %s\n",debugstr_w(path));
258         return path;
259     }
260     else if (source && f->ResolvedSource)
261     {
262         path = strdupW( f->ResolvedSource );
263         TRACE("   (source)already resolved to %s\n",debugstr_w(path));
264         return path;
265     }
266     else if (!source && f->Property)
267     {
268         path = build_directory_name( 2, f->Property, NULL );
269                     
270         TRACE("   internally set to %s\n",debugstr_w(path));
271         if (set_prop)
272             MSI_SetPropertyW( package, name, path );
273         return path;
274     }
275
276     if (f->Parent)
277     {
278         LPWSTR parent = f->Parent->Directory;
279
280         TRACE(" ! Parent is %s\n", debugstr_w(parent));
281
282         p = resolve_folder(package, parent, source, set_prop, NULL);
283         if (!source)
284         {
285             TRACE("   TargetDefault = %s\n", debugstr_w(f->TargetDefault));
286
287             path = build_directory_name( 3, p, f->TargetDefault, NULL );
288             clean_spaces_from_path( path );
289             f->ResolvedTarget = strdupW( path );
290             TRACE("target -> %s\n", debugstr_w(path));
291             if (set_prop)
292                 MSI_SetPropertyW(package,name,path);
293         }
294         else 
295         {
296             /* source may be in a few different places ... check each of them */
297             path = NULL;
298
299             /* try the long path directory */
300             if (f->SourceLongPath)
301             {
302                 path = build_directory_name( 3, p, f->SourceLongPath, NULL );
303                 if (INVALID_FILE_ATTRIBUTES == GetFileAttributesW( path ))
304                 {
305                     msi_free( path );
306                     path = NULL;
307                 }
308             }
309
310             /* try the short path directory */
311             if (!path && f->SourceShortPath)
312             {
313                 path = build_directory_name( 3, p, f->SourceShortPath, NULL );
314                 if (INVALID_FILE_ATTRIBUTES == GetFileAttributesW( path ))
315                 {
316                     msi_free( path );
317                     path = NULL;
318                 }
319             }
320
321             /* try the root of the install */
322             if (!path)
323                 path = get_source_root( package );
324
325             TRACE("source -> %s\n", debugstr_w(path));
326             f->ResolvedSource = strdupW( path );
327         }
328         msi_free(p);
329     }
330     return path;
331 }
332
333 /* wrapper to resist a need for a full rewrite right now */
334 DWORD deformat_string(MSIPACKAGE *package, LPCWSTR ptr, WCHAR** data )
335 {
336     if (ptr)
337     {
338         MSIRECORD *rec = MSI_CreateRecord(1);
339         DWORD size = 0;
340
341         MSI_RecordSetStringW(rec,0,ptr);
342         MSI_FormatRecordW(package,rec,NULL,&size);
343         if (size >= 0)
344         {
345             size++;
346             *data = msi_alloc(size*sizeof(WCHAR));
347             if (size > 1)
348                 MSI_FormatRecordW(package,rec,*data,&size);
349             else
350                 *data[0] = 0;
351             msiobj_release( &rec->hdr );
352             return sizeof(WCHAR)*size;
353         }
354         msiobj_release( &rec->hdr );
355     }
356
357     *data = NULL;
358     return 0;
359 }
360
361 UINT schedule_action(MSIPACKAGE *package, UINT script, LPCWSTR action)
362 {
363     UINT count;
364     LPWSTR *newbuf = NULL;
365     if (script >= TOTAL_SCRIPTS)
366     {
367         FIXME("Unknown script requested %i\n",script);
368         return ERROR_FUNCTION_FAILED;
369     }
370     TRACE("Scheduling Action %s in script %i\n",debugstr_w(action), script);
371     
372     count = package->script->ActionCount[script];
373     package->script->ActionCount[script]++;
374     if (count != 0)
375         newbuf = msi_realloc( package->script->Actions[script],
376                         package->script->ActionCount[script]* sizeof(LPWSTR));
377     else
378         newbuf = msi_alloc( sizeof(LPWSTR));
379
380     newbuf[count] = strdupW(action);
381     package->script->Actions[script] = newbuf;
382
383    return ERROR_SUCCESS;
384 }
385
386 static void remove_tracked_tempfiles(MSIPACKAGE* package)
387 {
388     struct list *item, *cursor;
389
390     LIST_FOR_EACH_SAFE( item, cursor, &package->tempfiles )
391     {
392         MSITEMPFILE *temp = LIST_ENTRY( item, MSITEMPFILE, entry );
393
394         list_remove( &temp->entry );
395         TRACE("deleting temp file %s\n", debugstr_w( temp->Path ));
396         DeleteFileW( temp->Path );
397         msi_free( temp->File );
398         msi_free( temp->Path );
399         msi_free( temp );
400     }
401 }
402
403 static void free_feature( MSIFEATURE *feature )
404 {
405     struct list *item, *cursor;
406
407     LIST_FOR_EACH_SAFE( item, cursor, &feature->Children )
408     {
409         FeatureList *fl = LIST_ENTRY( item, FeatureList, entry );
410         list_remove( &fl->entry );
411         msi_free( fl );
412     }
413
414     LIST_FOR_EACH_SAFE( item, cursor, &feature->Components )
415     {
416         ComponentList *cl = LIST_ENTRY( item, ComponentList, entry );
417         list_remove( &cl->entry );
418         msi_free( cl );
419     }
420     msi_free( feature->Feature );
421     msi_free( feature->Feature_Parent );
422     msi_free( feature->Directory );
423     msi_free( feature->Description );
424     msi_free( feature->Title );
425     msi_free( feature );
426 }
427
428 static void free_extension( MSIEXTENSION *ext )
429 {
430     struct list *item, *cursor;
431
432     LIST_FOR_EACH_SAFE( item, cursor, &ext->verbs )
433     {
434         MSIVERB *verb = LIST_ENTRY( item, MSIVERB, entry );
435
436         list_remove( &verb->entry );
437         msi_free( verb->Verb );
438         msi_free( verb->Command );
439         msi_free( verb->Argument );
440         msi_free( verb );
441     }
442
443     msi_free( ext->Extension );
444     msi_free( ext->ProgIDText );
445     msi_free( ext );
446 }
447
448 /* Called when the package is being closed */
449 void ACTION_free_package_structures( MSIPACKAGE* package)
450 {
451     INT i;
452     struct list *item, *cursor;
453     
454     TRACE("Freeing package action data\n");
455
456     remove_tracked_tempfiles(package);
457
458     LIST_FOR_EACH_SAFE( item, cursor, &package->features )
459     {
460         MSIFEATURE *feature = LIST_ENTRY( item, MSIFEATURE, entry );
461         list_remove( &feature->entry );
462         free_feature( feature );
463     }
464
465     LIST_FOR_EACH_SAFE( item, cursor, &package->folders )
466     {
467         MSIFOLDER *folder = LIST_ENTRY( item, MSIFOLDER, entry );
468
469         list_remove( &folder->entry );
470         msi_free( folder->Directory );
471         msi_free( folder->TargetDefault );
472         msi_free( folder->SourceLongPath );
473         msi_free( folder->SourceShortPath );
474         msi_free( folder->ResolvedTarget );
475         msi_free( folder->ResolvedSource );
476         msi_free( folder->Property );
477         msi_free( folder );
478     }
479
480     LIST_FOR_EACH_SAFE( item, cursor, &package->components )
481     {
482         MSICOMPONENT *comp = LIST_ENTRY( item, MSICOMPONENT, entry );
483         
484         list_remove( &comp->entry );
485         msi_free( comp->Component );
486         msi_free( comp->ComponentId );
487         msi_free( comp->Directory );
488         msi_free( comp->Condition );
489         msi_free( comp->KeyPath );
490         msi_free( comp->FullKeypath );
491         msi_free( comp );
492     }
493
494     LIST_FOR_EACH_SAFE( item, cursor, &package->files )
495     {
496         MSIFILE *file = LIST_ENTRY( item, MSIFILE, entry );
497
498         list_remove( &file->entry );
499         msi_free( file->File );
500         msi_free( file->FileName );
501         msi_free( file->ShortName );
502         msi_free( file->LongName );
503         msi_free( file->Version );
504         msi_free( file->Language );
505         msi_free( file->SourcePath );
506         msi_free( file->TargetPath );
507         msi_free( file );
508     }
509
510     /* clean up extension, progid, class and verb structures */
511     LIST_FOR_EACH_SAFE( item, cursor, &package->classes )
512     {
513         MSICLASS *cls = LIST_ENTRY( item, MSICLASS, entry );
514
515         list_remove( &cls->entry );
516         msi_free( cls->clsid );
517         msi_free( cls->Context );
518         msi_free( cls->Description );
519         msi_free( cls->FileTypeMask );
520         msi_free( cls->IconPath );
521         msi_free( cls->DefInprocHandler );
522         msi_free( cls->DefInprocHandler32 );
523         msi_free( cls->Argument );
524         msi_free( cls->ProgIDText );
525         msi_free( cls );
526     }
527
528     LIST_FOR_EACH_SAFE( item, cursor, &package->extensions )
529     {
530         MSIEXTENSION *ext = LIST_ENTRY( item, MSIEXTENSION, entry );
531
532         list_remove( &ext->entry );
533         free_extension( ext );
534     }
535
536     LIST_FOR_EACH_SAFE( item, cursor, &package->progids )
537     {
538         MSIPROGID *progid = LIST_ENTRY( item, MSIPROGID, entry );
539
540         list_remove( &progid->entry );
541         msi_free( progid->ProgID );
542         msi_free( progid->Description );
543         msi_free( progid->IconPath );
544         msi_free( progid );
545     }
546
547     LIST_FOR_EACH_SAFE( item, cursor, &package->mimes )
548     {
549         MSIMIME *mt = LIST_ENTRY( item, MSIMIME, entry );
550
551         list_remove( &mt->entry );
552         msi_free( mt->clsid );
553         msi_free( mt->ContentType );
554         msi_free( mt );
555     }
556
557     LIST_FOR_EACH_SAFE( item, cursor, &package->appids )
558     {
559         MSIAPPID *appid = LIST_ENTRY( item, MSIAPPID, entry );
560
561         list_remove( &appid->entry );
562         msi_free( appid->AppID );
563         msi_free( appid->RemoteServerName );
564         msi_free( appid->LocalServer );
565         msi_free( appid->ServiceParameters );
566         msi_free( appid->DllSurrogate );
567         msi_free( appid );
568     }
569
570     if (package->script)
571     {
572         for (i = 0; i < TOTAL_SCRIPTS; i++)
573         {
574             int j;
575             for (j = 0; j < package->script->ActionCount[i]; j++)
576                 msi_free(package->script->Actions[i][j]);
577         
578             msi_free(package->script->Actions[i]);
579         }
580
581         for (i = 0; i < package->script->UniqueActionsCount; i++)
582             msi_free(package->script->UniqueActions[i]);
583
584         msi_free(package->script->UniqueActions);
585         msi_free(package->script);
586     }
587
588     msi_free(package->PackagePath);
589     msi_free(package->ProductCode);
590     msi_free(package->ActionFormat);
591     msi_free(package->LastAction);
592
593     /* cleanup control event subscriptions */
594     ControlEvent_CleanupSubscriptions(package);
595 }
596
597 /*
598  *  build_directory_name()
599  *
600  *  This function is to save messing round with directory names
601  *  It handles adding backslashes between path segments, 
602  *   and can add \ at the end of the directory name if told to.
603  *
604  *  It takes a variable number of arguments.
605  *  It always allocates a new string for the result, so make sure
606  *   to free the return value when finished with it.
607  *
608  *  The first arg is the number of path segments that follow.
609  *  The arguments following count are a list of path segments.
610  *  A path segment may be NULL.
611  *
612  *  Path segments will be added with a \ separating them.
613  *  A \ will not be added after the last segment, however if the
614  *    last segment is NULL, then the last character will be a \
615  * 
616  */
617 LPWSTR build_directory_name(DWORD count, ...)
618 {
619     DWORD sz = 1, i;
620     LPWSTR dir;
621     va_list va;
622
623     va_start(va,count);
624     for(i=0; i<count; i++)
625     {
626         LPCWSTR str = va_arg(va,LPCWSTR);
627         if (str)
628             sz += strlenW(str) + 1;
629     }
630     va_end(va);
631
632     dir = msi_alloc(sz*sizeof(WCHAR));
633     dir[0]=0;
634
635     va_start(va,count);
636     for(i=0; i<count; i++)
637     {
638         LPCWSTR str = va_arg(va,LPCWSTR);
639         if (!str)
640             continue;
641         strcatW(dir, str);
642         if( ((i+1)!=count) && dir[strlenW(dir)-1]!='\\')
643             strcatW(dir, cszbs);
644     }
645     return dir;
646 }
647
648 /***********************************************************************
649  *            create_full_pathW
650  *
651  * Recursively create all directories in the path.
652  *
653  * shamelessly stolen from setupapi/queue.c
654  */
655 BOOL create_full_pathW(const WCHAR *path)
656 {
657     BOOL ret = TRUE;
658     int len;
659     WCHAR *new_path;
660
661     new_path = msi_alloc( (strlenW(path) + 1) * sizeof(WCHAR));
662
663     strcpyW(new_path, path);
664
665     while((len = strlenW(new_path)) && new_path[len - 1] == '\\')
666     new_path[len - 1] = 0;
667
668     while(!CreateDirectoryW(new_path, NULL))
669     {
670         WCHAR *slash;
671         DWORD last_error = GetLastError();
672         if(last_error == ERROR_ALREADY_EXISTS)
673             break;
674
675         if(last_error != ERROR_PATH_NOT_FOUND)
676         {
677             ret = FALSE;
678             break;
679         }
680
681         if(!(slash = strrchrW(new_path, '\\')))
682         {
683             ret = FALSE;
684             break;
685         }
686
687         len = slash - new_path;
688         new_path[len] = 0;
689         if(!create_full_pathW(new_path))
690         {
691             ret = FALSE;
692             break;
693         }
694         new_path[len] = '\\';
695     }
696
697     msi_free(new_path);
698     return ret;
699 }
700
701 void ui_progress(MSIPACKAGE *package, int a, int b, int c, int d )
702 {
703     MSIRECORD * row;
704
705     row = MSI_CreateRecord(4);
706     MSI_RecordSetInteger(row,1,a);
707     MSI_RecordSetInteger(row,2,b);
708     MSI_RecordSetInteger(row,3,c);
709     MSI_RecordSetInteger(row,4,d);
710     MSI_ProcessMessage(package, INSTALLMESSAGE_PROGRESS, row);
711     msiobj_release(&row->hdr);
712
713     msi_dialog_check_messages(NULL);
714 }
715
716 void ui_actiondata(MSIPACKAGE *package, LPCWSTR action, MSIRECORD * record)
717 {
718     static const WCHAR Query_t[] = 
719         {'S','E','L','E','C','T',' ','*',' ','F','R','O','M',' ',
720          '`','A','c','t','i','o', 'n','T','e','x','t','`',' ',
721          'W','H','E','R','E',' ', '`','A','c','t','i','o','n','`',' ','=', 
722          ' ','\'','%','s','\'',0};
723     WCHAR message[1024];
724     MSIRECORD * row = 0;
725     DWORD size;
726
727     if (!package->LastAction || strcmpW(package->LastAction,action))
728     {
729         row = MSI_QueryGetRecord(package->db, Query_t, action);
730         if (!row)
731             return;
732
733         if (MSI_RecordIsNull(row,3))
734         {
735             msiobj_release(&row->hdr);
736             return;
737         }
738
739         /* update the cached actionformat */
740         msi_free(package->ActionFormat);
741         package->ActionFormat = msi_dup_record_field(row,3);
742
743         msi_free(package->LastAction);
744         package->LastAction = strdupW(action);
745
746         msiobj_release(&row->hdr);
747     }
748
749     MSI_RecordSetStringW(record,0,package->ActionFormat);
750     size = 1024;
751     MSI_FormatRecordW(package,record,message,&size);
752
753     row = MSI_CreateRecord(1);
754     MSI_RecordSetStringW(row,1,message);
755  
756     MSI_ProcessMessage(package, INSTALLMESSAGE_ACTIONDATA, row);
757
758     msiobj_release(&row->hdr);
759 }
760
761 BOOL ACTION_VerifyComponentForAction( MSICOMPONENT* comp, INSTALLSTATE check )
762 {
763     if (!comp)
764         return FALSE;
765
766     if (comp->Installed == check)
767         return FALSE;
768
769     if (comp->ActionRequest == check)
770         return TRUE;
771     else
772         return FALSE;
773 }
774
775 BOOL ACTION_VerifyFeatureForAction( MSIFEATURE* feature, INSTALLSTATE check )
776 {
777     if (!feature)
778         return FALSE;
779
780     if (feature->Installed == check)
781         return FALSE;
782
783     if (feature->ActionRequest == check)
784         return TRUE;
785     else
786         return FALSE;
787 }
788
789 void reduce_to_longfilename(WCHAR* filename)
790 {
791     LPWSTR p = strchrW(filename,'|');
792     if (p)
793         memmove(filename, p+1, (strlenW(p+1)+1)*sizeof(WCHAR));
794 }
795
796 void reduce_to_shortfilename(WCHAR* filename)
797 {
798     LPWSTR p = strchrW(filename,'|');
799     if (p)
800         *p = 0;
801 }
802
803 LPWSTR create_component_advertise_string(MSIPACKAGE* package, 
804                 MSICOMPONENT* component, LPCWSTR feature)
805 {
806     static const WCHAR fmt[] = {'%','s','%','s','%','c','%','s',0};
807     WCHAR productid_85[21], component_85[21];
808     LPWSTR output = NULL;
809     DWORD sz = 0;
810     GUID clsid;
811
812     /* > is used if there is a component GUID and < if not.  */
813
814     productid_85[0] = 0;
815     component_85[0] = 0;
816
817     CLSIDFromString(package->ProductCode, &clsid);
818     encode_base85_guid(&clsid, productid_85);
819
820     if (component)
821     {
822         CLSIDFromString(component->ComponentId, &clsid);
823         encode_base85_guid(&clsid, component_85);
824     }
825
826     TRACE("prod=%s feat=%s comp=%s\n", debugstr_w(productid_85),
827           debugstr_w(feature), debugstr_w(component_85));
828  
829     sz = 20 + lstrlenW(feature) + 20 + 3;
830
831     output = msi_alloc_zero(sz*sizeof(WCHAR));
832
833     sprintfW(output, fmt, productid_85, feature,
834              component?'>':'<', component_85);
835     
836     return output;
837 }
838
839 /* update compoennt state based on a feature change */
840 void ACTION_UpdateComponentStates(MSIPACKAGE *package, LPCWSTR szFeature)
841 {
842     INSTALLSTATE newstate;
843     MSIFEATURE *feature;
844     ComponentList *cl;
845
846     feature = get_loaded_feature(package,szFeature);
847     if (!feature)
848         return;
849
850     newstate = feature->ActionRequest;
851
852     if (newstate == INSTALLSTATE_ABSENT)
853         newstate = INSTALLSTATE_UNKNOWN;
854
855     LIST_FOR_EACH_ENTRY( cl, &feature->Components, ComponentList, entry )
856     {
857         MSICOMPONENT* component = cl->component;
858     
859         TRACE("MODIFYING(%i): Component %s (Installed %i, Action %i, Request %i)\n",
860             newstate, debugstr_w(component->Component), component->Installed, 
861             component->Action, component->ActionRequest);
862         
863         if (!component->Enabled)
864             continue;
865  
866         if (newstate == INSTALLSTATE_LOCAL)
867         {
868             component->ActionRequest = INSTALLSTATE_LOCAL;
869             component->Action = INSTALLSTATE_LOCAL;
870         }
871         else 
872         {
873             ComponentList *clist;
874             MSIFEATURE *f;
875
876             component->ActionRequest = newstate;
877             component->Action = newstate;
878
879             /*if any other feature wants is local we need to set it local*/
880             LIST_FOR_EACH_ENTRY( f, &package->features, MSIFEATURE, entry )
881             {
882                 if ( f->ActionRequest != INSTALLSTATE_LOCAL &&
883                      f->ActionRequest != INSTALLSTATE_SOURCE )
884                 {
885                     continue;
886                 }
887
888                 LIST_FOR_EACH_ENTRY( clist, &f->Components, ComponentList, entry )
889                 {
890                     if ( clist->component == component &&
891                          (f->ActionRequest == INSTALLSTATE_LOCAL ||
892                           f->ActionRequest == INSTALLSTATE_SOURCE) )
893                     {
894                         TRACE("Saved by %s\n", debugstr_w(f->Feature));
895
896                         if (component->Attributes & msidbComponentAttributesOptional)
897                         {
898                             if (f->Attributes & msidbFeatureAttributesFavorSource)
899                             {
900                                 component->Action = INSTALLSTATE_SOURCE;
901                                 component->ActionRequest = INSTALLSTATE_SOURCE;
902                             }
903                             else
904                             {
905                                 component->Action = INSTALLSTATE_LOCAL;
906                                 component->ActionRequest = INSTALLSTATE_LOCAL;
907                             }
908                         }
909                         else if (component->Attributes & msidbComponentAttributesSourceOnly)
910                         {
911                             component->Action = INSTALLSTATE_SOURCE;
912                             component->ActionRequest = INSTALLSTATE_SOURCE;
913                         }
914                         else
915                         {
916                             component->Action = INSTALLSTATE_LOCAL;
917                             component->ActionRequest = INSTALLSTATE_LOCAL;
918                         } 
919                     }
920                 }
921             }
922         }
923         TRACE("Result (%i): Component %s (Installed %i, Action %i, Request %i)\n",
924             newstate, debugstr_w(component->Component), component->Installed, 
925             component->Action, component->ActionRequest);
926     } 
927 }
928
929 UINT register_unique_action(MSIPACKAGE *package, LPCWSTR action)
930 {
931     UINT count;
932     LPWSTR *newbuf = NULL;
933
934     if (!package->script)
935         return FALSE;
936
937     TRACE("Registering Action %s as having fun\n",debugstr_w(action));
938     
939     count = package->script->UniqueActionsCount;
940     package->script->UniqueActionsCount++;
941     if (count != 0)
942         newbuf = msi_realloc( package->script->UniqueActions,
943                         package->script->UniqueActionsCount* sizeof(LPWSTR));
944     else
945         newbuf = msi_alloc( sizeof(LPWSTR));
946
947     newbuf[count] = strdupW(action);
948     package->script->UniqueActions = newbuf;
949
950     return ERROR_SUCCESS;
951 }
952
953 BOOL check_unique_action(MSIPACKAGE *package, LPCWSTR action)
954 {
955     INT i;
956
957     if (!package->script)
958         return FALSE;
959
960     for (i = 0; i < package->script->UniqueActionsCount; i++)
961         if (!strcmpW(package->script->UniqueActions[i],action))
962             return TRUE;
963
964     return FALSE;
965 }
966
967 WCHAR* generate_error_string(MSIPACKAGE *package, UINT error, DWORD count, ... )
968 {
969     static const WCHAR query[] = {'S','E','L','E','C','T',' ','`','M','e','s','s','a','g','e','`',' ','F','R','O','M',' ','`','E','r','r','o','r','`',' ','W','H','E','R','E',' ','`','E','r','r','o','r','`',' ','=',' ','%','i',0};
970
971     MSIRECORD *rec;
972     MSIRECORD *row;
973     DWORD size = 0;
974     DWORD i;
975     va_list va;
976     LPCWSTR str;
977     LPWSTR data;
978
979     row = MSI_QueryGetRecord(package->db, query, error);
980     if (!row)
981         return 0;
982
983     rec = MSI_CreateRecord(count+2);
984
985     str = MSI_RecordGetString(row,1);
986     MSI_RecordSetStringW(rec,0,str);
987     msiobj_release( &row->hdr );
988     MSI_RecordSetInteger(rec,1,error);
989
990     va_start(va,count);
991     for (i = 0; i < count; i++)
992     {
993         str = va_arg(va,LPCWSTR);
994         MSI_RecordSetStringW(rec,(i+2),str);
995     }
996     va_end(va);
997
998     MSI_FormatRecordW(package,rec,NULL,&size);
999     if (size >= 0)
1000     {
1001         size++;
1002         data = msi_alloc(size*sizeof(WCHAR));
1003         if (size > 1)
1004             MSI_FormatRecordW(package,rec,data,&size);
1005         else
1006             data[0] = 0;
1007         msiobj_release( &rec->hdr );
1008         return data;
1009     }
1010
1011     msiobj_release( &rec->hdr );
1012     data = NULL;
1013     return data;
1014 }
1015
1016 void msi_ui_error( DWORD msg_id, DWORD type )
1017 {
1018     WCHAR text[2048];
1019
1020     static const WCHAR title[] = {
1021         'W','i','n','d','o','w','s',' ','I','n','s','t','a','l','l','e','r',0
1022     };
1023
1024     if (!MsiLoadStringW( -1, msg_id, text, sizeof(text) / sizeof(text[0]),
1025                          MAKELANGID(LANG_NEUTRAL, SUBLANG_NEUTRAL) ))
1026         return;
1027
1028     MessageBoxW( NULL, text, title, type );
1029 }