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.
29 #include "wine/debug.h"
32 #include "wine/unicode.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 szInstaller
[] =
45 {'M','i','c','r','o','s','o','f','t','\\',
46 'I','n','s','t','a','l','l','e','r','\\',0};
47 static const WCHAR szFolder
[] =
48 {'A','p','p','D','a','t','a','F','o','l','d','e','r',0};
50 SystemFolder
= msi_dup_property( package
, szFolder
);
52 dest
= build_directory_name(3, SystemFolder
, szInstaller
, package
->ProductCode
);
54 create_full_pathW(dest
);
56 FilePath
= build_directory_name(2, dest
, icon_name
);
58 msi_free(SystemFolder
);
63 LPWSTR
msi_dup_record_field( MSIRECORD
*rec
, INT field
)
69 if (MSI_RecordIsNull( rec
, field
))
72 r
= MSI_RecordGetStringW( rec
, field
, NULL
, &sz
);
73 if (r
!= ERROR_SUCCESS
)
77 str
= msi_alloc( sz
* sizeof (WCHAR
) );
81 r
= MSI_RecordGetStringW( rec
, field
, str
, &sz
);
82 if (r
!= ERROR_SUCCESS
)
84 ERR("failed to get string!\n");
91 MSICOMPONENT
* get_loaded_component( MSIPACKAGE
* package
, LPCWSTR Component
)
95 LIST_FOR_EACH_ENTRY( comp
, &package
->components
, MSICOMPONENT
, entry
)
97 if (lstrcmpW(Component
,comp
->Component
)==0)
103 MSIFEATURE
* get_loaded_feature(MSIPACKAGE
* package
, LPCWSTR Feature
)
107 LIST_FOR_EACH_ENTRY( feature
, &package
->features
, MSIFEATURE
, entry
)
109 if (lstrcmpW( Feature
, feature
->Feature
)==0)
115 MSIFILE
* get_loaded_file( MSIPACKAGE
* package
, LPCWSTR key
)
119 LIST_FOR_EACH_ENTRY( file
, &package
->files
, MSIFILE
, entry
)
121 if (lstrcmpW( key
, file
->File
)==0)
127 int track_tempfile( MSIPACKAGE
*package
, LPCWSTR path
)
131 TRACE("%s\n", debugstr_w(path
));
133 LIST_FOR_EACH_ENTRY( temp
, &package
->tempfiles
, MSITEMPFILE
, entry
)
134 if (!lstrcmpW( path
, temp
->Path
))
137 temp
= msi_alloc_zero( sizeof (MSITEMPFILE
) );
141 list_add_head( &package
->tempfiles
, &temp
->entry
);
142 temp
->Path
= strdupW( path
);
147 MSIFOLDER
*get_loaded_folder( MSIPACKAGE
*package
, LPCWSTR dir
)
151 LIST_FOR_EACH_ENTRY( folder
, &package
->folders
, MSIFOLDER
, entry
)
153 if (lstrcmpW( dir
, folder
->Directory
)==0)
159 static LPWSTR
get_source_root( MSIPACKAGE
*package
)
163 path
= msi_dup_property( package
, cszSourceDir
);
167 path
= msi_dup_property( package
, cszDatabase
);
170 p
= strrchrW(path
,'\\');
178 * clean_spaces_from_path()
180 * removes spaces from the beginning and end of path segments
181 * removes multiple \\ characters
183 static void clean_spaces_from_path( LPWSTR p
)
190 /* copy until the end of the string or a space */
191 while (*p
!= ' ' && (*q
= *p
))
194 /* reduce many backslashes to one */
195 if (*p
!= '\\' || *q
!= '\\')
199 /* quit at the end of the string */
203 /* count the number of spaces */
208 /* if it's leading or trailing space, skip it */
209 if ( len
== 0 || p
[-1] == '\\' || p
[n
] == '\\' )
211 else /* copy n spaces */
212 while (n
&& (*q
++ = *p
++)) n
--;
216 LPWSTR
resolve_file_source(MSIPACKAGE
*package
, MSIFILE
*file
)
220 TRACE("Working to resolve source of file %s\n", debugstr_w(file
->File
));
222 if (file
->IsCompressed
)
225 p
= resolve_folder(package
, file
->Component
->Directory
,
226 TRUE
, FALSE
, TRUE
, NULL
);
227 path
= build_directory_name(2, p
, file
->ShortName
);
229 if (file
->LongName
&&
230 GetFileAttributesW(path
) == INVALID_FILE_ATTRIBUTES
)
233 path
= build_directory_name(2, p
, file
->LongName
);
238 TRACE("file %s source resolves to %s\n", debugstr_w(file
->File
),
244 LPWSTR
resolve_folder(MSIPACKAGE
*package
, LPCWSTR name
, BOOL source
,
245 BOOL set_prop
, BOOL load_prop
, MSIFOLDER
**folder
)
248 LPWSTR p
, path
= NULL
, parent
;
250 TRACE("Working to resolve %s\n",debugstr_w(name
));
255 if (!lstrcmpW(name
,cszSourceDir
))
258 f
= get_loaded_folder( package
, name
);
262 /* special resolving for Target and Source root dir */
263 if (!strcmpW(name
,cszTargetDir
))
265 if (!f
->ResolvedTarget
&& !f
->Property
)
268 check_path
= msi_dup_property( package
, cszTargetDir
);
271 check_path
= msi_dup_property( package
, cszRootDrive
);
273 MSI_SetPropertyW(package
,cszTargetDir
,check_path
);
276 /* correct misbuilt target dir */
277 path
= build_directory_name(2, check_path
, NULL
);
278 clean_spaces_from_path( path
);
279 if (strcmpiW(path
,check_path
)!=0)
280 MSI_SetPropertyW(package
,cszTargetDir
,path
);
281 msi_free(check_path
);
283 f
->ResolvedTarget
= path
;
286 if (!f
->ResolvedSource
)
287 f
->ResolvedSource
= get_source_root( package
);
293 if (!source
&& f
->ResolvedTarget
)
295 path
= strdupW( f
->ResolvedTarget
);
296 TRACE(" already resolved to %s\n",debugstr_w(path
));
300 if (source
&& f
->ResolvedSource
)
302 path
= strdupW( f
->ResolvedSource
);
303 TRACE(" (source)already resolved to %s\n",debugstr_w(path
));
307 if (!source
&& f
->Property
)
309 path
= build_directory_name( 2, f
->Property
, NULL
);
311 TRACE(" internally set to %s\n",debugstr_w(path
));
313 MSI_SetPropertyW( package
, name
, path
);
317 if (!source
&& load_prop
&& (path
= msi_dup_property( package
, name
)))
319 f
->ResolvedTarget
= strdupW( path
);
320 TRACE(" property set to %s\n", debugstr_w(path
));
329 TRACE(" ! Parent is %s\n", debugstr_w(parent
));
331 p
= resolve_folder(package
, parent
, source
, set_prop
, load_prop
, NULL
);
334 TRACE(" TargetDefault = %s\n", debugstr_w(f
->TargetDefault
));
336 path
= build_directory_name( 3, p
, f
->TargetDefault
, NULL
);
337 clean_spaces_from_path( path
);
338 f
->ResolvedTarget
= strdupW( path
);
339 TRACE("target -> %s\n", debugstr_w(path
));
341 MSI_SetPropertyW(package
,name
,path
);
347 if (package
->WordCount
& msidbSumInfoSourceTypeCompressed
)
348 path
= get_source_root( package
);
349 else if (package
->WordCount
& msidbSumInfoSourceTypeSFN
)
350 path
= build_directory_name( 3, p
, f
->SourceShortPath
, NULL
);
352 path
= build_directory_name( 3, p
, f
->SourceLongPath
, NULL
);
354 TRACE("source -> %s\n", debugstr_w(path
));
355 f
->ResolvedSource
= strdupW( path
);
362 /* wrapper to resist a need for a full rewrite right now */
363 DWORD
deformat_string(MSIPACKAGE
*package
, LPCWSTR ptr
, WCHAR
** data
)
367 MSIRECORD
*rec
= MSI_CreateRecord(1);
370 MSI_RecordSetStringW(rec
,0,ptr
);
371 MSI_FormatRecordW(package
,rec
,NULL
,&size
);
374 *data
= msi_alloc(size
*sizeof(WCHAR
));
376 MSI_FormatRecordW(package
,rec
,*data
,&size
);
380 msiobj_release( &rec
->hdr
);
381 return sizeof(WCHAR
)*size
;
388 UINT
schedule_action(MSIPACKAGE
*package
, UINT script
, LPCWSTR action
)
391 LPWSTR
*newbuf
= NULL
;
392 if (script
>= TOTAL_SCRIPTS
)
394 FIXME("Unknown script requested %i\n",script
);
395 return ERROR_FUNCTION_FAILED
;
397 TRACE("Scheduling Action %s in script %i\n",debugstr_w(action
), script
);
399 count
= package
->script
->ActionCount
[script
];
400 package
->script
->ActionCount
[script
]++;
402 newbuf
= msi_realloc( package
->script
->Actions
[script
],
403 package
->script
->ActionCount
[script
]* sizeof(LPWSTR
));
405 newbuf
= msi_alloc( sizeof(LPWSTR
));
407 newbuf
[count
] = strdupW(action
);
408 package
->script
->Actions
[script
] = newbuf
;
410 return ERROR_SUCCESS
;
413 void msi_free_action_script(MSIPACKAGE
*package
, UINT script
)
416 for (i
= 0; i
< package
->script
->ActionCount
[script
]; i
++)
417 msi_free(package
->script
->Actions
[script
][i
]);
419 msi_free(package
->script
->Actions
[script
]);
420 package
->script
->Actions
[script
] = NULL
;
421 package
->script
->ActionCount
[script
] = 0;
425 * build_directory_name()
427 * This function is to save messing round with directory names
428 * It handles adding backslashes between path segments,
429 * and can add \ at the end of the directory name if told to.
431 * It takes a variable number of arguments.
432 * It always allocates a new string for the result, so make sure
433 * to free the return value when finished with it.
435 * The first arg is the number of path segments that follow.
436 * The arguments following count are a list of path segments.
437 * A path segment may be NULL.
439 * Path segments will be added with a \ separating them.
440 * A \ will not be added after the last segment, however if the
441 * last segment is NULL, then the last character will be a \
444 LPWSTR
build_directory_name(DWORD count
, ...)
451 for(i
=0; i
<count
; i
++)
453 LPCWSTR str
= va_arg(va
,LPCWSTR
);
455 sz
+= strlenW(str
) + 1;
459 dir
= msi_alloc(sz
*sizeof(WCHAR
));
463 for(i
=0; i
<count
; i
++)
465 LPCWSTR str
= va_arg(va
,LPCWSTR
);
469 if( ((i
+1)!=count
) && dir
[strlenW(dir
)-1]!='\\')
470 strcatW(dir
, szBackSlash
);
475 /***********************************************************************
478 * Recursively create all directories in the path.
480 * shamelessly stolen from setupapi/queue.c
482 BOOL
create_full_pathW(const WCHAR
*path
)
488 new_path
= msi_alloc( (strlenW(path
) + 1) * sizeof(WCHAR
));
490 strcpyW(new_path
, path
);
492 while((len
= strlenW(new_path
)) && new_path
[len
- 1] == '\\')
493 new_path
[len
- 1] = 0;
495 while(!CreateDirectoryW(new_path
, NULL
))
498 DWORD last_error
= GetLastError();
499 if(last_error
== ERROR_ALREADY_EXISTS
)
502 if(last_error
!= ERROR_PATH_NOT_FOUND
)
508 if(!(slash
= strrchrW(new_path
, '\\')))
514 len
= slash
- new_path
;
516 if(!create_full_pathW(new_path
))
521 new_path
[len
] = '\\';
528 void ui_progress(MSIPACKAGE
*package
, int a
, int b
, int c
, int d
)
532 row
= MSI_CreateRecord(4);
533 MSI_RecordSetInteger(row
,1,a
);
534 MSI_RecordSetInteger(row
,2,b
);
535 MSI_RecordSetInteger(row
,3,c
);
536 MSI_RecordSetInteger(row
,4,d
);
537 MSI_ProcessMessage(package
, INSTALLMESSAGE_PROGRESS
, row
);
538 msiobj_release(&row
->hdr
);
540 msi_dialog_check_messages(NULL
);
543 void ui_actiondata(MSIPACKAGE
*package
, LPCWSTR action
, MSIRECORD
* record
)
545 static const WCHAR Query_t
[] =
546 {'S','E','L','E','C','T',' ','*',' ','F','R','O','M',' ',
547 '`','A','c','t','i','o', 'n','T','e','x','t','`',' ',
548 'W','H','E','R','E',' ', '`','A','c','t','i','o','n','`',' ','=',
549 ' ','\'','%','s','\'',0};
554 if (!package
->LastAction
|| strcmpW(package
->LastAction
,action
))
556 row
= MSI_QueryGetRecord(package
->db
, Query_t
, action
);
560 if (MSI_RecordIsNull(row
,3))
562 msiobj_release(&row
->hdr
);
566 /* update the cached actionformat */
567 msi_free(package
->ActionFormat
);
568 package
->ActionFormat
= msi_dup_record_field(row
,3);
570 msi_free(package
->LastAction
);
571 package
->LastAction
= strdupW(action
);
573 msiobj_release(&row
->hdr
);
576 MSI_RecordSetStringW(record
,0,package
->ActionFormat
);
578 MSI_FormatRecordW(package
,record
,message
,&size
);
580 row
= MSI_CreateRecord(1);
581 MSI_RecordSetStringW(row
,1,message
);
583 MSI_ProcessMessage(package
, INSTALLMESSAGE_ACTIONDATA
, row
);
585 msiobj_release(&row
->hdr
);
588 void reduce_to_longfilename(WCHAR
* filename
)
590 LPWSTR p
= strchrW(filename
,'|');
592 memmove(filename
, p
+1, (strlenW(p
+1)+1)*sizeof(WCHAR
));
595 LPWSTR
create_component_advertise_string(MSIPACKAGE
* package
,
596 MSICOMPONENT
* component
, LPCWSTR feature
)
598 static const WCHAR fmt
[] = {'%','s','%','s','%','c','%','s',0};
599 WCHAR productid_85
[21], component_85
[21];
600 LPWSTR output
= NULL
;
604 /* > is used if there is a component GUID and < if not. */
609 CLSIDFromString(package
->ProductCode
, &clsid
);
610 encode_base85_guid(&clsid
, productid_85
);
614 CLSIDFromString(component
->ComponentId
, &clsid
);
615 encode_base85_guid(&clsid
, component_85
);
618 TRACE("prod=%s feat=%s comp=%s\n", debugstr_w(productid_85
),
619 debugstr_w(feature
), debugstr_w(component_85
));
621 sz
= 20 + lstrlenW(feature
) + 20 + 3;
623 output
= msi_alloc_zero(sz
*sizeof(WCHAR
));
625 sprintfW(output
, fmt
, productid_85
, feature
,
626 component
?'>':'<', component_85
);
631 /* update component state based on a feature change */
632 void ACTION_UpdateComponentStates(MSIPACKAGE
*package
, LPCWSTR szFeature
)
634 INSTALLSTATE newstate
;
638 feature
= get_loaded_feature(package
,szFeature
);
642 newstate
= feature
->ActionRequest
;
644 if (newstate
== INSTALLSTATE_ABSENT
)
645 newstate
= INSTALLSTATE_UNKNOWN
;
647 LIST_FOR_EACH_ENTRY( cl
, &feature
->Components
, ComponentList
, entry
)
649 MSICOMPONENT
* component
= cl
->component
;
651 TRACE("MODIFYING(%i): Component %s (Installed %i, Action %i, Request %i)\n",
652 newstate
, debugstr_w(component
->Component
), component
->Installed
,
653 component
->Action
, component
->ActionRequest
);
655 if (!component
->Enabled
)
658 if (newstate
== INSTALLSTATE_LOCAL
)
659 msi_component_set_state(package
, component
, INSTALLSTATE_LOCAL
);
662 ComponentList
*clist
;
665 component
->hasLocalFeature
= FALSE
;
667 msi_component_set_state(package
, component
, newstate
);
669 /*if any other feature wants is local we need to set it local*/
670 LIST_FOR_EACH_ENTRY( f
, &package
->features
, MSIFEATURE
, entry
)
672 if ( f
->ActionRequest
!= INSTALLSTATE_LOCAL
&&
673 f
->ActionRequest
!= INSTALLSTATE_SOURCE
)
678 LIST_FOR_EACH_ENTRY( clist
, &f
->Components
, ComponentList
, entry
)
680 if ( clist
->component
== component
&&
681 (f
->ActionRequest
== INSTALLSTATE_LOCAL
||
682 f
->ActionRequest
== INSTALLSTATE_SOURCE
) )
684 TRACE("Saved by %s\n", debugstr_w(f
->Feature
));
685 component
->hasLocalFeature
= TRUE
;
687 if (component
->Attributes
& msidbComponentAttributesOptional
)
689 if (f
->Attributes
& msidbFeatureAttributesFavorSource
)
690 msi_component_set_state(package
, component
, INSTALLSTATE_SOURCE
);
692 msi_component_set_state(package
, component
, INSTALLSTATE_LOCAL
);
694 else if (component
->Attributes
& msidbComponentAttributesSourceOnly
)
695 msi_component_set_state(package
, component
, INSTALLSTATE_SOURCE
);
697 msi_component_set_state(package
, component
, INSTALLSTATE_LOCAL
);
702 TRACE("Result (%i): Component %s (Installed %i, Action %i, Request %i)\n",
703 newstate
, debugstr_w(component
->Component
), component
->Installed
,
704 component
->Action
, component
->ActionRequest
);
708 UINT
register_unique_action(MSIPACKAGE
*package
, LPCWSTR action
)
711 LPWSTR
*newbuf
= NULL
;
713 if (!package
->script
)
716 TRACE("Registering %s as unique action\n", debugstr_w(action
));
718 count
= package
->script
->UniqueActionsCount
;
719 package
->script
->UniqueActionsCount
++;
721 newbuf
= msi_realloc( package
->script
->UniqueActions
,
722 package
->script
->UniqueActionsCount
* sizeof(LPWSTR
));
724 newbuf
= msi_alloc( sizeof(LPWSTR
));
726 newbuf
[count
] = strdupW(action
);
727 package
->script
->UniqueActions
= newbuf
;
729 return ERROR_SUCCESS
;
732 BOOL
check_unique_action(const MSIPACKAGE
*package
, LPCWSTR action
)
736 if (!package
->script
)
739 for (i
= 0; i
< package
->script
->UniqueActionsCount
; i
++)
740 if (!strcmpW(package
->script
->UniqueActions
[i
],action
))
746 WCHAR
* generate_error_string(MSIPACKAGE
*package
, UINT error
, DWORD count
, ... )
748 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};
758 row
= MSI_QueryGetRecord(package
->db
, query
, error
);
762 rec
= MSI_CreateRecord(count
+2);
764 str
= MSI_RecordGetString(row
,1);
765 MSI_RecordSetStringW(rec
,0,str
);
766 msiobj_release( &row
->hdr
);
767 MSI_RecordSetInteger(rec
,1,error
);
770 for (i
= 0; i
< count
; i
++)
772 str
= va_arg(va
,LPCWSTR
);
773 MSI_RecordSetStringW(rec
,(i
+2),str
);
777 MSI_FormatRecordW(package
,rec
,NULL
,&size
);
780 data
= msi_alloc(size
*sizeof(WCHAR
));
782 MSI_FormatRecordW(package
,rec
,data
,&size
);
785 msiobj_release( &rec
->hdr
);