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 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 );
57 LPWSTR ADTgt = msi_dup_property( package->db, szADFolder );
58 SystemFolder = build_directory_name(2, ADTgt, szMicrosoft);
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);
73 LPWSTR msi_dup_record_field( MSIRECORD *rec, INT field )
79 if (MSI_RecordIsNull( rec, field ))
82 r = MSI_RecordGetStringW( rec, field, NULL, &sz );
83 if (r != ERROR_SUCCESS)
87 str = msi_alloc( sz * sizeof (WCHAR) );
91 r = MSI_RecordGetStringW( rec, field, str, &sz );
92 if (r != ERROR_SUCCESS)
94 ERR("failed to get string!\n");
101 MSICOMPONENT* get_loaded_component( MSIPACKAGE* package, LPCWSTR Component )
105 LIST_FOR_EACH_ENTRY( comp, &package->components, MSICOMPONENT, entry )
107 if (!strcmpW( Component, comp->Component ))
113 MSIFEATURE* get_loaded_feature(MSIPACKAGE* package, LPCWSTR Feature )
117 LIST_FOR_EACH_ENTRY( feature, &package->features, MSIFEATURE, entry )
119 if (!strcmpW( Feature, feature->Feature ))
125 MSIFILE* get_loaded_file( MSIPACKAGE* package, LPCWSTR key )
129 LIST_FOR_EACH_ENTRY( file, &package->files, MSIFILE, entry )
131 if (!strcmpW( key, file->File ))
137 MSIFILEPATCH* get_loaded_filepatch( MSIPACKAGE* package, LPCWSTR key )
141 /* FIXME: There might be more than one patch */
143 LIST_FOR_EACH_ENTRY( patch, &package->filepatches, MSIFILEPATCH, entry )
145 if (!strcmpW( key, patch->File->File ))
151 int track_tempfile( MSIPACKAGE *package, LPCWSTR path )
155 TRACE("%s\n", debugstr_w(path));
157 LIST_FOR_EACH_ENTRY( temp, &package->tempfiles, MSITEMPFILE, entry )
158 if (!strcmpW( path, temp->Path ))
161 temp = msi_alloc_zero( sizeof (MSITEMPFILE) );
165 list_add_head( &package->tempfiles, &temp->entry );
166 temp->Path = strdupW( path );
171 MSIFOLDER *get_loaded_folder( MSIPACKAGE *package, LPCWSTR dir )
175 LIST_FOR_EACH_ENTRY( folder, &package->folders, MSIFOLDER, entry )
177 if (!strcmpW( dir, folder->Directory ))
183 static LPWSTR get_source_root( MSIPACKAGE *package )
187 path = msi_dup_property( package->db, cszSourceDir );
191 path = msi_dup_property( package->db, cszDatabase );
194 p = strrchrW(path,'\\');
202 * clean_spaces_from_path()
204 * removes spaces from the beginning and end of path segments
205 * removes multiple \\ characters
207 static void clean_spaces_from_path( LPWSTR p )
214 /* copy until the end of the string or a space */
215 while (*p != ' ' && (*q = *p))
218 /* reduce many backslashes to one */
219 if (*p != '\\' || *q != '\\')
223 /* quit at the end of the string */
227 /* count the number of spaces */
232 /* if it's leading or trailing space, skip it */
233 if ( len == 0 || p[-1] == '\\' || p[n] == '\\' )
235 else /* copy n spaces */
236 while (n && (*q++ = *p++)) n--;
240 LPWSTR resolve_file_source(MSIPACKAGE *package, MSIFILE *file)
244 TRACE("Working to resolve source of file %s\n", debugstr_w(file->File));
246 if (file->IsCompressed)
249 p = resolve_source_folder( package, file->Component->Directory, NULL );
250 path = build_directory_name(2, p, file->ShortName);
252 if (file->LongName &&
253 GetFileAttributesW(path) == INVALID_FILE_ATTRIBUTES)
256 path = build_directory_name(2, p, file->LongName);
261 TRACE("file %s source resolves to %s\n", debugstr_w(file->File), debugstr_w(path));
265 LPWSTR resolve_source_folder( MSIPACKAGE *package, LPCWSTR name, MSIFOLDER **folder )
268 LPWSTR p, path = NULL, parent;
270 TRACE("working to resolve %s\n", debugstr_w(name));
272 if (!strcmpW( name, cszSourceDir ))
275 f = get_loaded_folder( package, name );
279 /* special resolving for Target and Source root dir */
280 if (!strcmpW( name, cszTargetDir ))
282 if (!f->ResolvedSource)
283 f->ResolvedSource = get_source_root( package );
289 if (f->ResolvedSource)
291 path = strdupW( f->ResolvedSource );
292 TRACE(" already resolved to %s\n", debugstr_w(path));
300 TRACE(" ! parent is %s\n", debugstr_w(parent));
302 p = resolve_source_folder( package, parent, NULL );
304 if (package->WordCount & msidbSumInfoSourceTypeCompressed)
305 path = get_source_root( package );
306 else if (package->WordCount & msidbSumInfoSourceTypeSFN)
307 path = build_directory_name( 3, p, f->SourceShortPath, NULL );
309 path = build_directory_name( 3, p, f->SourceLongPath, NULL );
311 TRACE("-> %s\n", debugstr_w(path));
312 f->ResolvedSource = strdupW( path );
318 LPWSTR resolve_target_folder( MSIPACKAGE *package, LPCWSTR name, BOOL set_prop, BOOL load_prop,
322 LPWSTR p, path = NULL, parent;
324 TRACE("working to resolve %s\n", debugstr_w(name));
326 f = get_loaded_folder( package, name );
330 /* special resolving for Target and Source root dir */
331 if (!strcmpW( name, cszTargetDir ))
333 if (!f->ResolvedTarget && !f->Property)
336 check_path = msi_dup_property( package->db, cszTargetDir );
339 check_path = msi_dup_property( package->db, cszRootDrive );
341 msi_set_property( package->db, cszTargetDir, check_path );
344 /* correct misbuilt target dir */
345 path = build_directory_name(2, check_path, NULL);
346 clean_spaces_from_path( path );
347 if (strcmpiW( path, check_path ))
348 msi_set_property( package->db, cszTargetDir, path );
349 msi_free(check_path);
351 f->ResolvedTarget = path;
358 if (f->ResolvedTarget)
360 path = strdupW( f->ResolvedTarget );
361 TRACE(" already resolved to %s\n", debugstr_w(path));
367 path = build_directory_name( 2, f->Property, NULL );
368 TRACE(" internally set to %s\n", debugstr_w(path));
369 if (set_prop) msi_set_property( package->db, name, path );
373 if (load_prop && (path = msi_dup_property( package->db, name )))
375 f->ResolvedTarget = strdupW( path );
376 TRACE(" property set to %s\n", debugstr_w(path));
385 TRACE(" ! parent is %s\n", debugstr_w(parent));
387 p = resolve_target_folder( package, parent, set_prop, load_prop, NULL );
389 TRACE(" TargetDefault = %s\n", debugstr_w(f->TargetDefault));
390 path = build_directory_name( 3, p, f->TargetDefault, NULL );
391 clean_spaces_from_path( path );
392 f->ResolvedTarget = strdupW( path );
394 TRACE("-> %s\n", debugstr_w(path));
395 if (set_prop) msi_set_property( package->db, name, path );
401 /* wrapper to resist a need for a full rewrite right now */
402 DWORD deformat_string(MSIPACKAGE *package, LPCWSTR ptr, WCHAR** data )
406 MSIRECORD *rec = MSI_CreateRecord(1);
409 MSI_RecordSetStringW(rec,0,ptr);
410 MSI_FormatRecordW(package,rec,NULL,&size);
413 *data = msi_alloc(size*sizeof(WCHAR));
415 MSI_FormatRecordW(package,rec,*data,&size);
419 msiobj_release( &rec->hdr );
420 return sizeof(WCHAR)*size;
427 UINT schedule_action(MSIPACKAGE *package, UINT script, LPCWSTR action)
430 LPWSTR *newbuf = NULL;
431 if (script >= TOTAL_SCRIPTS)
433 FIXME("Unknown script requested %i\n",script);
434 return ERROR_FUNCTION_FAILED;
436 TRACE("Scheduling Action %s in script %i\n",debugstr_w(action), script);
438 count = package->script->ActionCount[script];
439 package->script->ActionCount[script]++;
441 newbuf = msi_realloc( package->script->Actions[script],
442 package->script->ActionCount[script]* sizeof(LPWSTR));
444 newbuf = msi_alloc( sizeof(LPWSTR));
446 newbuf[count] = strdupW(action);
447 package->script->Actions[script] = newbuf;
449 return ERROR_SUCCESS;
452 void msi_free_action_script(MSIPACKAGE *package, UINT script)
455 for (i = 0; i < package->script->ActionCount[script]; i++)
456 msi_free(package->script->Actions[script][i]);
458 msi_free(package->script->Actions[script]);
459 package->script->Actions[script] = NULL;
460 package->script->ActionCount[script] = 0;
464 * build_directory_name()
466 * This function is to save messing round with directory names
467 * It handles adding backslashes between path segments,
468 * and can add \ at the end of the directory name if told to.
470 * It takes a variable number of arguments.
471 * It always allocates a new string for the result, so make sure
472 * to free the return value when finished with it.
474 * The first arg is the number of path segments that follow.
475 * The arguments following count are a list of path segments.
476 * A path segment may be NULL.
478 * Path segments will be added with a \ separating them.
479 * A \ will not be added after the last segment, however if the
480 * last segment is NULL, then the last character will be a \
483 LPWSTR build_directory_name(DWORD count, ...)
490 for(i=0; i<count; i++)
492 LPCWSTR str = va_arg(va,LPCWSTR);
494 sz += strlenW(str) + 1;
498 dir = msi_alloc(sz*sizeof(WCHAR));
502 for(i=0; i<count; i++)
504 LPCWSTR str = va_arg(va,LPCWSTR);
508 if( ((i+1)!=count) && dir[strlenW(dir)-1]!='\\')
509 strcatW(dir, szBackSlash);
516 /***********************************************************************
519 * Recursively create all directories in the path.
521 * shamelessly stolen from setupapi/queue.c
523 BOOL create_full_pathW(const WCHAR *path)
529 new_path = msi_alloc( (strlenW(path) + 1) * sizeof(WCHAR));
531 strcpyW(new_path, path);
533 while((len = strlenW(new_path)) && new_path[len - 1] == '\\')
534 new_path[len - 1] = 0;
536 while(!CreateDirectoryW(new_path, NULL))
539 DWORD last_error = GetLastError();
540 if(last_error == ERROR_ALREADY_EXISTS)
543 if(last_error != ERROR_PATH_NOT_FOUND)
549 if(!(slash = strrchrW(new_path, '\\')))
555 len = slash - new_path;
557 if(!create_full_pathW(new_path))
562 new_path[len] = '\\';
569 void ui_progress(MSIPACKAGE *package, int a, int b, int c, int d )
573 row = MSI_CreateRecord(4);
574 MSI_RecordSetInteger(row,1,a);
575 MSI_RecordSetInteger(row,2,b);
576 MSI_RecordSetInteger(row,3,c);
577 MSI_RecordSetInteger(row,4,d);
578 MSI_ProcessMessage(package, INSTALLMESSAGE_PROGRESS, row);
579 msiobj_release(&row->hdr);
581 msi_dialog_check_messages(NULL);
584 void ui_actiondata(MSIPACKAGE *package, LPCWSTR action, MSIRECORD * record)
586 static const WCHAR Query_t[] =
587 {'S','E','L','E','C','T',' ','*',' ','F','R','O','M',' ',
588 '`','A','c','t','i','o', 'n','T','e','x','t','`',' ',
589 'W','H','E','R','E',' ', '`','A','c','t','i','o','n','`',' ','=',
590 ' ','\'','%','s','\'',0};
595 if (!package->LastAction || strcmpW(package->LastAction, action))
597 row = MSI_QueryGetRecord(package->db, Query_t, action);
601 if (MSI_RecordIsNull(row,3))
603 msiobj_release(&row->hdr);
607 /* update the cached actionformat */
608 msi_free(package->ActionFormat);
609 package->ActionFormat = msi_dup_record_field(row,3);
611 msi_free(package->LastAction);
612 package->LastAction = strdupW(action);
614 msiobj_release(&row->hdr);
617 MSI_RecordSetStringW(record,0,package->ActionFormat);
619 MSI_FormatRecordW(package,record,message,&size);
621 row = MSI_CreateRecord(1);
622 MSI_RecordSetStringW(row,1,message);
624 MSI_ProcessMessage(package, INSTALLMESSAGE_ACTIONDATA, row);
626 msiobj_release(&row->hdr);
629 void reduce_to_longfilename(WCHAR* filename)
631 LPWSTR p = strchrW(filename,'|');
633 memmove(filename, p+1, (strlenW(p+1)+1)*sizeof(WCHAR));
636 LPWSTR create_component_advertise_string(MSIPACKAGE* package,
637 MSICOMPONENT* component, LPCWSTR feature)
639 static const WCHAR fmt[] = {'%','s','%','s','%','c','%','s',0};
640 WCHAR productid_85[21], component_85[21];
641 LPWSTR output = NULL;
645 /* > is used if there is a component GUID and < if not. */
650 CLSIDFromString(package->ProductCode, &clsid);
651 encode_base85_guid(&clsid, productid_85);
655 CLSIDFromString(component->ComponentId, &clsid);
656 encode_base85_guid(&clsid, component_85);
659 TRACE("prod=%s feat=%s comp=%s\n", debugstr_w(productid_85),
660 debugstr_w(feature), debugstr_w(component_85));
662 sz = 20 + lstrlenW(feature) + 20 + 3;
664 output = msi_alloc_zero(sz*sizeof(WCHAR));
666 sprintfW(output, fmt, productid_85, feature,
667 component?'>':'<', component_85);
672 /* update component state based on a feature change */
673 void ACTION_UpdateComponentStates( MSIPACKAGE *package, MSIFEATURE *feature )
675 INSTALLSTATE newstate;
678 newstate = feature->ActionRequest;
680 if (newstate == INSTALLSTATE_ABSENT)
681 newstate = INSTALLSTATE_UNKNOWN;
683 LIST_FOR_EACH_ENTRY( cl, &feature->Components, ComponentList, entry )
685 MSICOMPONENT* component = cl->component;
687 if (!component->Enabled) continue;
689 TRACE("MODIFYING(%i): Component %s (Installed %i, Action %i, Request %i)\n",
690 newstate, debugstr_w(component->Component), component->Installed,
691 component->Action, component->ActionRequest);
693 if (newstate == INSTALLSTATE_LOCAL)
695 component->Action = INSTALLSTATE_LOCAL;
696 component->ActionRequest = INSTALLSTATE_LOCAL;
700 ComponentList *clist;
703 component->hasLocalFeature = FALSE;
705 component->Action = newstate;
706 component->ActionRequest = newstate;
708 /* if any other feature wants it local we need to set it local */
709 LIST_FOR_EACH_ENTRY( f, &package->features, MSIFEATURE, entry )
711 if ( f->ActionRequest != INSTALLSTATE_LOCAL &&
712 f->ActionRequest != INSTALLSTATE_SOURCE )
717 LIST_FOR_EACH_ENTRY( clist, &f->Components, ComponentList, entry )
719 if ( clist->component == component &&
720 (f->ActionRequest == INSTALLSTATE_LOCAL ||
721 f->ActionRequest == INSTALLSTATE_SOURCE) )
723 TRACE("Saved by %s\n", debugstr_w(f->Feature));
724 component->hasLocalFeature = TRUE;
726 if (component->Attributes & msidbComponentAttributesOptional)
728 if (f->Attributes & msidbFeatureAttributesFavorSource)
730 component->Action = INSTALLSTATE_SOURCE;
731 component->ActionRequest = INSTALLSTATE_SOURCE;
735 component->Action = INSTALLSTATE_LOCAL;
736 component->ActionRequest = INSTALLSTATE_LOCAL;
739 else if (component->Attributes & msidbComponentAttributesSourceOnly)
741 component->Action = INSTALLSTATE_SOURCE;
742 component->ActionRequest = INSTALLSTATE_SOURCE;
746 component->Action = INSTALLSTATE_LOCAL;
747 component->ActionRequest = INSTALLSTATE_LOCAL;
753 TRACE("Result (%i): Component %s (Installed %i, Action %i, Request %i)\n",
754 newstate, debugstr_w(component->Component), component->Installed,
755 component->Action, component->ActionRequest);
759 UINT register_unique_action(MSIPACKAGE *package, LPCWSTR action)
762 LPWSTR *newbuf = NULL;
764 if (!package->script)
767 TRACE("Registering %s as unique action\n", debugstr_w(action));
769 count = package->script->UniqueActionsCount;
770 package->script->UniqueActionsCount++;
772 newbuf = msi_realloc( package->script->UniqueActions,
773 package->script->UniqueActionsCount* sizeof(LPWSTR));
775 newbuf = msi_alloc( sizeof(LPWSTR));
777 newbuf[count] = strdupW(action);
778 package->script->UniqueActions = newbuf;
780 return ERROR_SUCCESS;
783 BOOL check_unique_action(const MSIPACKAGE *package, LPCWSTR action)
787 if (!package->script)
790 for (i = 0; i < package->script->UniqueActionsCount; i++)
791 if (!strcmpW(package->script->UniqueActions[i], action))
797 WCHAR* generate_error_string(MSIPACKAGE *package, UINT error, DWORD count, ... )
799 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};
809 row = MSI_QueryGetRecord(package->db, query, error);
813 rec = MSI_CreateRecord(count+2);
815 str = MSI_RecordGetString(row,1);
816 MSI_RecordSetStringW(rec,0,str);
817 msiobj_release( &row->hdr );
818 MSI_RecordSetInteger(rec,1,error);
821 for (i = 0; i < count; i++)
823 str = va_arg(va,LPCWSTR);
824 MSI_RecordSetStringW(rec,(i+2),str);
828 MSI_FormatRecordW(package,rec,NULL,&size);
831 data = msi_alloc(size*sizeof(WCHAR));
833 MSI_FormatRecordW(package,rec,data,&size);
836 msiobj_release( &rec->hdr );