Release 1.3.7.
[wine/gsoc-2012-control.git] / dlls / msi / helpers.c
blobf6f458fe2398277e7486fd92198fb5335a4198ee
1 /*
2 * Implementation of the Microsoft Installer (msi.dll)
4 * Copyright 2005 Aric Stewart for CodeWeavers
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.
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.
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
22 * Here are helper functions formally in action.c that are used by a variety of
23 * actions and functions.
26 #include <stdarg.h>
28 #include "windef.h"
29 #include "wine/debug.h"
30 #include "msipriv.h"
31 #include "winuser.h"
32 #include "wine/unicode.h"
33 #include "msidefs.h"
35 WINE_DEFAULT_DEBUG_CHANNEL(msi);
37 static const WCHAR cszTargetDir[] = {'T','A','R','G','E','T','D','I','R',0};
38 static const WCHAR cszDatabase[]={'D','A','T','A','B','A','S','E',0};
40 LPWSTR build_icon_path(MSIPACKAGE *package, LPCWSTR icon_name )
42 LPWSTR SystemFolder, dest, FilePath;
44 static const WCHAR szMicrosoft[] =
45 {'M','i','c','r','o','s','o','f','t','\\',0};
46 static const WCHAR szInstaller[] =
47 {'I','n','s','t','a','l','l','e','r','\\',0};
48 static const WCHAR szADFolder[] =
49 {'A','p','p','D','a','t','a','F','o','l','d','e','r',0};
50 static const WCHAR szWFolder[] =
51 {'W','i','n','d','o','w','s','F','o','l','d','e','r',0};
53 if(package->Context == MSIINSTALLCONTEXT_MACHINE)
54 SystemFolder = msi_dup_property( package->db, szWFolder );
55 else
57 LPWSTR ADTgt = msi_dup_property( package->db, szADFolder );
58 SystemFolder = build_directory_name(2, ADTgt, szMicrosoft);
59 msi_free(ADTgt);
62 dest = build_directory_name(3, SystemFolder, szInstaller, package->ProductCode);
64 create_full_pathW(dest);
66 FilePath = build_directory_name(2, dest, icon_name);
68 msi_free(SystemFolder);
69 msi_free(dest);
70 return FilePath;
73 LPWSTR msi_dup_record_field( MSIRECORD *rec, INT field )
75 DWORD sz = 0;
76 LPWSTR str;
77 UINT r;
79 if (MSI_RecordIsNull( rec, field ))
80 return NULL;
82 r = MSI_RecordGetStringW( rec, field, NULL, &sz );
83 if (r != ERROR_SUCCESS)
84 return NULL;
86 sz ++;
87 str = msi_alloc( sz * sizeof (WCHAR) );
88 if (!str)
89 return str;
90 str[0] = 0;
91 r = MSI_RecordGetStringW( rec, field, str, &sz );
92 if (r != ERROR_SUCCESS)
94 ERR("failed to get string!\n");
95 msi_free( str );
96 return NULL;
98 return str;
101 MSICOMPONENT* get_loaded_component( MSIPACKAGE* package, LPCWSTR Component )
103 MSICOMPONENT *comp;
105 LIST_FOR_EACH_ENTRY( comp, &package->components, MSICOMPONENT, entry )
107 if (!strcmpW( Component, comp->Component ))
108 return comp;
110 return NULL;
113 MSIFEATURE* get_loaded_feature(MSIPACKAGE* package, LPCWSTR Feature )
115 MSIFEATURE *feature;
117 LIST_FOR_EACH_ENTRY( feature, &package->features, MSIFEATURE, entry )
119 if (!strcmpW( Feature, feature->Feature ))
120 return feature;
122 return NULL;
125 MSIFILE* get_loaded_file( MSIPACKAGE* package, LPCWSTR key )
127 MSIFILE *file;
129 LIST_FOR_EACH_ENTRY( file, &package->files, MSIFILE, entry )
131 if (!strcmpW( key, file->File ))
132 return file;
134 return NULL;
137 int track_tempfile( MSIPACKAGE *package, LPCWSTR path )
139 MSITEMPFILE *temp;
141 TRACE("%s\n", debugstr_w(path));
143 LIST_FOR_EACH_ENTRY( temp, &package->tempfiles, MSITEMPFILE, entry )
144 if (!strcmpW( path, temp->Path ))
145 return 0;
147 temp = msi_alloc_zero( sizeof (MSITEMPFILE) );
148 if (!temp)
149 return -1;
151 list_add_head( &package->tempfiles, &temp->entry );
152 temp->Path = strdupW( path );
154 return 0;
157 MSIFOLDER *get_loaded_folder( MSIPACKAGE *package, LPCWSTR dir )
159 MSIFOLDER *folder;
161 LIST_FOR_EACH_ENTRY( folder, &package->folders, MSIFOLDER, entry )
163 if (!strcmpW( dir, folder->Directory ))
164 return folder;
166 return NULL;
169 static LPWSTR get_source_root( MSIPACKAGE *package )
171 LPWSTR path, p;
173 path = msi_dup_property( package->db, cszSourceDir );
174 if (path)
175 return path;
177 path = msi_dup_property( package->db, cszDatabase );
178 if (path)
180 p = strrchrW(path,'\\');
181 if (p)
182 *(p+1) = 0;
184 return path;
188 * clean_spaces_from_path()
190 * removes spaces from the beginning and end of path segments
191 * removes multiple \\ characters
193 static void clean_spaces_from_path( LPWSTR p )
195 LPWSTR q = p;
196 int n, len = 0;
198 while (1)
200 /* copy until the end of the string or a space */
201 while (*p != ' ' && (*q = *p))
203 p++, len++;
204 /* reduce many backslashes to one */
205 if (*p != '\\' || *q != '\\')
206 q++;
209 /* quit at the end of the string */
210 if (!*p)
211 break;
213 /* count the number of spaces */
214 n = 0;
215 while (p[n] == ' ')
216 n++;
218 /* if it's leading or trailing space, skip it */
219 if ( len == 0 || p[-1] == '\\' || p[n] == '\\' )
220 p += n;
221 else /* copy n spaces */
222 while (n && (*q++ = *p++)) n--;
226 LPWSTR resolve_file_source(MSIPACKAGE *package, MSIFILE *file)
228 LPWSTR p, path;
230 TRACE("Working to resolve source of file %s\n", debugstr_w(file->File));
232 if (file->IsCompressed)
233 return NULL;
235 p = resolve_folder(package, file->Component->Directory,
236 TRUE, FALSE, TRUE, NULL);
237 path = build_directory_name(2, p, file->ShortName);
239 if (file->LongName &&
240 GetFileAttributesW(path) == INVALID_FILE_ATTRIBUTES)
242 msi_free(path);
243 path = build_directory_name(2, p, file->LongName);
246 msi_free(p);
248 TRACE("file %s source resolves to %s\n", debugstr_w(file->File),
249 debugstr_w(path));
251 return path;
254 LPWSTR resolve_folder(MSIPACKAGE *package, LPCWSTR name, BOOL source,
255 BOOL set_prop, BOOL load_prop, MSIFOLDER **folder)
257 MSIFOLDER *f;
258 LPWSTR p, path = NULL, parent;
260 TRACE("Working to resolve %s\n",debugstr_w(name));
262 if (!name)
263 return NULL;
265 if (!strcmpW( name, cszSourceDir ))
266 name = cszTargetDir;
268 f = get_loaded_folder( package, name );
269 if (!f)
270 return NULL;
272 /* special resolving for Target and Source root dir */
273 if (!strcmpW( name, cszTargetDir ))
275 if (!f->ResolvedTarget && !f->Property)
277 LPWSTR check_path;
278 check_path = msi_dup_property( package->db, cszTargetDir );
279 if (!check_path)
281 check_path = msi_dup_property( package->db, cszRootDrive );
282 if (set_prop)
283 msi_set_property( package->db, cszTargetDir, check_path );
286 /* correct misbuilt target dir */
287 path = build_directory_name(2, check_path, NULL);
288 clean_spaces_from_path( path );
289 if (strcmpiW( path, check_path ))
290 msi_set_property( package->db, cszTargetDir, path );
291 msi_free(check_path);
293 f->ResolvedTarget = path;
296 if (!f->ResolvedSource)
297 f->ResolvedSource = get_source_root( package );
300 if (folder)
301 *folder = f;
303 if (!source && f->ResolvedTarget)
305 path = strdupW( f->ResolvedTarget );
306 TRACE(" already resolved to %s\n",debugstr_w(path));
307 return path;
310 if (source && f->ResolvedSource)
312 path = strdupW( f->ResolvedSource );
313 TRACE(" (source)already resolved to %s\n",debugstr_w(path));
314 return path;
317 if (!source && f->Property)
319 path = build_directory_name( 2, f->Property, NULL );
321 TRACE(" internally set to %s\n",debugstr_w(path));
322 if (set_prop)
323 msi_set_property( package->db, name, path );
324 return path;
327 if (!source && load_prop && (path = msi_dup_property( package->db, name )))
329 f->ResolvedTarget = strdupW( path );
330 TRACE(" property set to %s\n", debugstr_w(path));
331 return path;
334 if (!f->Parent)
335 return path;
337 parent = f->Parent;
339 TRACE(" ! Parent is %s\n", debugstr_w(parent));
341 p = resolve_folder(package, parent, source, set_prop, load_prop, NULL);
342 if (!source)
344 TRACE(" TargetDefault = %s\n", debugstr_w(f->TargetDefault));
346 path = build_directory_name( 3, p, f->TargetDefault, NULL );
347 clean_spaces_from_path( path );
348 f->ResolvedTarget = strdupW( path );
349 TRACE("target -> %s\n", debugstr_w(path));
350 if (set_prop)
351 msi_set_property( package->db, name, path );
353 else
355 path = NULL;
357 if (package->WordCount & msidbSumInfoSourceTypeCompressed)
358 path = get_source_root( package );
359 else if (package->WordCount & msidbSumInfoSourceTypeSFN)
360 path = build_directory_name( 3, p, f->SourceShortPath, NULL );
361 else
362 path = build_directory_name( 3, p, f->SourceLongPath, NULL );
364 TRACE("source -> %s\n", debugstr_w(path));
365 f->ResolvedSource = strdupW( path );
367 msi_free(p);
369 return path;
372 /* wrapper to resist a need for a full rewrite right now */
373 DWORD deformat_string(MSIPACKAGE *package, LPCWSTR ptr, WCHAR** data )
375 if (ptr)
377 MSIRECORD *rec = MSI_CreateRecord(1);
378 DWORD size = 0;
380 MSI_RecordSetStringW(rec,0,ptr);
381 MSI_FormatRecordW(package,rec,NULL,&size);
383 size++;
384 *data = msi_alloc(size*sizeof(WCHAR));
385 if (size > 1)
386 MSI_FormatRecordW(package,rec,*data,&size);
387 else
388 *data[0] = 0;
390 msiobj_release( &rec->hdr );
391 return sizeof(WCHAR)*size;
394 *data = NULL;
395 return 0;
398 UINT schedule_action(MSIPACKAGE *package, UINT script, LPCWSTR action)
400 UINT count;
401 LPWSTR *newbuf = NULL;
402 if (script >= TOTAL_SCRIPTS)
404 FIXME("Unknown script requested %i\n",script);
405 return ERROR_FUNCTION_FAILED;
407 TRACE("Scheduling Action %s in script %i\n",debugstr_w(action), script);
409 count = package->script->ActionCount[script];
410 package->script->ActionCount[script]++;
411 if (count != 0)
412 newbuf = msi_realloc( package->script->Actions[script],
413 package->script->ActionCount[script]* sizeof(LPWSTR));
414 else
415 newbuf = msi_alloc( sizeof(LPWSTR));
417 newbuf[count] = strdupW(action);
418 package->script->Actions[script] = newbuf;
420 return ERROR_SUCCESS;
423 void msi_free_action_script(MSIPACKAGE *package, UINT script)
425 UINT i;
426 for (i = 0; i < package->script->ActionCount[script]; i++)
427 msi_free(package->script->Actions[script][i]);
429 msi_free(package->script->Actions[script]);
430 package->script->Actions[script] = NULL;
431 package->script->ActionCount[script] = 0;
435 * build_directory_name()
437 * This function is to save messing round with directory names
438 * It handles adding backslashes between path segments,
439 * and can add \ at the end of the directory name if told to.
441 * It takes a variable number of arguments.
442 * It always allocates a new string for the result, so make sure
443 * to free the return value when finished with it.
445 * The first arg is the number of path segments that follow.
446 * The arguments following count are a list of path segments.
447 * A path segment may be NULL.
449 * Path segments will be added with a \ separating them.
450 * A \ will not be added after the last segment, however if the
451 * last segment is NULL, then the last character will be a \
454 LPWSTR build_directory_name(DWORD count, ...)
456 DWORD sz = 1, i;
457 LPWSTR dir;
458 va_list va;
460 va_start(va,count);
461 for(i=0; i<count; i++)
463 LPCWSTR str = va_arg(va,LPCWSTR);
464 if (str)
465 sz += strlenW(str) + 1;
467 va_end(va);
469 dir = msi_alloc(sz*sizeof(WCHAR));
470 dir[0]=0;
472 va_start(va,count);
473 for(i=0; i<count; i++)
475 LPCWSTR str = va_arg(va,LPCWSTR);
476 if (!str)
477 continue;
478 strcatW(dir, str);
479 if( ((i+1)!=count) && dir[strlenW(dir)-1]!='\\')
480 strcatW(dir, szBackSlash);
482 return dir;
485 /***********************************************************************
486 * create_full_pathW
488 * Recursively create all directories in the path.
490 * shamelessly stolen from setupapi/queue.c
492 BOOL create_full_pathW(const WCHAR *path)
494 BOOL ret = TRUE;
495 int len;
496 WCHAR *new_path;
498 new_path = msi_alloc( (strlenW(path) + 1) * sizeof(WCHAR));
500 strcpyW(new_path, path);
502 while((len = strlenW(new_path)) && new_path[len - 1] == '\\')
503 new_path[len - 1] = 0;
505 while(!CreateDirectoryW(new_path, NULL))
507 WCHAR *slash;
508 DWORD last_error = GetLastError();
509 if(last_error == ERROR_ALREADY_EXISTS)
510 break;
512 if(last_error != ERROR_PATH_NOT_FOUND)
514 ret = FALSE;
515 break;
518 if(!(slash = strrchrW(new_path, '\\')))
520 ret = FALSE;
521 break;
524 len = slash - new_path;
525 new_path[len] = 0;
526 if(!create_full_pathW(new_path))
528 ret = FALSE;
529 break;
531 new_path[len] = '\\';
534 msi_free(new_path);
535 return ret;
538 void ui_progress(MSIPACKAGE *package, int a, int b, int c, int d )
540 MSIRECORD * row;
542 row = MSI_CreateRecord(4);
543 MSI_RecordSetInteger(row,1,a);
544 MSI_RecordSetInteger(row,2,b);
545 MSI_RecordSetInteger(row,3,c);
546 MSI_RecordSetInteger(row,4,d);
547 MSI_ProcessMessage(package, INSTALLMESSAGE_PROGRESS, row);
548 msiobj_release(&row->hdr);
550 msi_dialog_check_messages(NULL);
553 void ui_actiondata(MSIPACKAGE *package, LPCWSTR action, MSIRECORD * record)
555 static const WCHAR Query_t[] =
556 {'S','E','L','E','C','T',' ','*',' ','F','R','O','M',' ',
557 '`','A','c','t','i','o', 'n','T','e','x','t','`',' ',
558 'W','H','E','R','E',' ', '`','A','c','t','i','o','n','`',' ','=',
559 ' ','\'','%','s','\'',0};
560 WCHAR message[1024];
561 MSIRECORD * row = 0;
562 DWORD size;
564 if (!package->LastAction || strcmpW(package->LastAction, action))
566 row = MSI_QueryGetRecord(package->db, Query_t, action);
567 if (!row)
568 return;
570 if (MSI_RecordIsNull(row,3))
572 msiobj_release(&row->hdr);
573 return;
576 /* update the cached actionformat */
577 msi_free(package->ActionFormat);
578 package->ActionFormat = msi_dup_record_field(row,3);
580 msi_free(package->LastAction);
581 package->LastAction = strdupW(action);
583 msiobj_release(&row->hdr);
586 MSI_RecordSetStringW(record,0,package->ActionFormat);
587 size = 1024;
588 MSI_FormatRecordW(package,record,message,&size);
590 row = MSI_CreateRecord(1);
591 MSI_RecordSetStringW(row,1,message);
593 MSI_ProcessMessage(package, INSTALLMESSAGE_ACTIONDATA, row);
595 msiobj_release(&row->hdr);
598 void reduce_to_longfilename(WCHAR* filename)
600 LPWSTR p = strchrW(filename,'|');
601 if (p)
602 memmove(filename, p+1, (strlenW(p+1)+1)*sizeof(WCHAR));
605 LPWSTR create_component_advertise_string(MSIPACKAGE* package,
606 MSICOMPONENT* component, LPCWSTR feature)
608 static const WCHAR fmt[] = {'%','s','%','s','%','c','%','s',0};
609 WCHAR productid_85[21], component_85[21];
610 LPWSTR output = NULL;
611 DWORD sz = 0;
612 GUID clsid;
614 /* > is used if there is a component GUID and < if not. */
616 productid_85[0] = 0;
617 component_85[0] = 0;
619 CLSIDFromString(package->ProductCode, &clsid);
620 encode_base85_guid(&clsid, productid_85);
622 if (component)
624 CLSIDFromString(component->ComponentId, &clsid);
625 encode_base85_guid(&clsid, component_85);
628 TRACE("prod=%s feat=%s comp=%s\n", debugstr_w(productid_85),
629 debugstr_w(feature), debugstr_w(component_85));
631 sz = 20 + lstrlenW(feature) + 20 + 3;
633 output = msi_alloc_zero(sz*sizeof(WCHAR));
635 sprintfW(output, fmt, productid_85, feature,
636 component?'>':'<', component_85);
638 return output;
641 /* update component state based on a feature change */
642 void ACTION_UpdateComponentStates(MSIPACKAGE *package, LPCWSTR szFeature)
644 INSTALLSTATE newstate;
645 MSIFEATURE *feature;
646 ComponentList *cl;
648 feature = get_loaded_feature(package,szFeature);
649 if (!feature)
650 return;
652 newstate = feature->ActionRequest;
654 if (newstate == INSTALLSTATE_ABSENT)
655 newstate = INSTALLSTATE_UNKNOWN;
657 LIST_FOR_EACH_ENTRY( cl, &feature->Components, ComponentList, entry )
659 MSICOMPONENT* component = cl->component;
661 TRACE("MODIFYING(%i): Component %s (Installed %i, Action %i, Request %i)\n",
662 newstate, debugstr_w(component->Component), component->Installed,
663 component->Action, component->ActionRequest);
665 if (!component->Enabled)
666 continue;
668 if (newstate == INSTALLSTATE_LOCAL)
669 msi_component_set_state(package, component, INSTALLSTATE_LOCAL);
670 else
672 ComponentList *clist;
673 MSIFEATURE *f;
675 component->hasLocalFeature = FALSE;
677 msi_component_set_state(package, component, newstate);
679 /*if any other feature wants is local we need to set it local*/
680 LIST_FOR_EACH_ENTRY( f, &package->features, MSIFEATURE, entry )
682 if ( f->ActionRequest != INSTALLSTATE_LOCAL &&
683 f->ActionRequest != INSTALLSTATE_SOURCE )
685 continue;
688 LIST_FOR_EACH_ENTRY( clist, &f->Components, ComponentList, entry )
690 if ( clist->component == component &&
691 (f->ActionRequest == INSTALLSTATE_LOCAL ||
692 f->ActionRequest == INSTALLSTATE_SOURCE) )
694 TRACE("Saved by %s\n", debugstr_w(f->Feature));
695 component->hasLocalFeature = TRUE;
697 if (component->Attributes & msidbComponentAttributesOptional)
699 if (f->Attributes & msidbFeatureAttributesFavorSource)
700 msi_component_set_state(package, component, INSTALLSTATE_SOURCE);
701 else
702 msi_component_set_state(package, component, INSTALLSTATE_LOCAL);
704 else if (component->Attributes & msidbComponentAttributesSourceOnly)
705 msi_component_set_state(package, component, INSTALLSTATE_SOURCE);
706 else
707 msi_component_set_state(package, component, INSTALLSTATE_LOCAL);
712 TRACE("Result (%i): Component %s (Installed %i, Action %i, Request %i)\n",
713 newstate, debugstr_w(component->Component), component->Installed,
714 component->Action, component->ActionRequest);
718 UINT register_unique_action(MSIPACKAGE *package, LPCWSTR action)
720 UINT count;
721 LPWSTR *newbuf = NULL;
723 if (!package->script)
724 return FALSE;
726 TRACE("Registering %s as unique action\n", debugstr_w(action));
728 count = package->script->UniqueActionsCount;
729 package->script->UniqueActionsCount++;
730 if (count != 0)
731 newbuf = msi_realloc( package->script->UniqueActions,
732 package->script->UniqueActionsCount* sizeof(LPWSTR));
733 else
734 newbuf = msi_alloc( sizeof(LPWSTR));
736 newbuf[count] = strdupW(action);
737 package->script->UniqueActions = newbuf;
739 return ERROR_SUCCESS;
742 BOOL check_unique_action(const MSIPACKAGE *package, LPCWSTR action)
744 UINT i;
746 if (!package->script)
747 return FALSE;
749 for (i = 0; i < package->script->UniqueActionsCount; i++)
750 if (!strcmpW(package->script->UniqueActions[i], action))
751 return TRUE;
753 return FALSE;
756 WCHAR* generate_error_string(MSIPACKAGE *package, UINT error, DWORD count, ... )
758 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};
760 MSIRECORD *rec;
761 MSIRECORD *row;
762 DWORD size = 0;
763 DWORD i;
764 va_list va;
765 LPCWSTR str;
766 LPWSTR data;
768 row = MSI_QueryGetRecord(package->db, query, error);
769 if (!row)
770 return 0;
772 rec = MSI_CreateRecord(count+2);
774 str = MSI_RecordGetString(row,1);
775 MSI_RecordSetStringW(rec,0,str);
776 msiobj_release( &row->hdr );
777 MSI_RecordSetInteger(rec,1,error);
779 va_start(va,count);
780 for (i = 0; i < count; i++)
782 str = va_arg(va,LPCWSTR);
783 MSI_RecordSetStringW(rec,(i+2),str);
785 va_end(va);
787 MSI_FormatRecordW(package,rec,NULL,&size);
789 size++;
790 data = msi_alloc(size*sizeof(WCHAR));
791 if (size > 1)
792 MSI_FormatRecordW(package,rec,data,&size);
793 else
794 data[0] = 0;
795 msiobj_release( &rec->hdr );
796 return data;