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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 * Here are helper functions formally in action.c that are used by a variaty of
23 * actions and functions.
31 #include "wine/debug.h"
34 #include "wine/unicode.h"
37 WINE_DEFAULT_DEBUG_CHANNEL(msi);
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};
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};
46 DWORD build_version_dword(LPCWSTR version_string)
50 DWORD rc = 0x00000000;
53 ptr1 = version_string;
62 ptr1 = strchrW(ptr1,'.');
72 ptr1 = strchrW(ptr1,'.');
82 rc = MAKELONG(build,MAKEWORD(minor,major));
83 TRACE("%s -> 0x%lx\n",debugstr_w(version_string),rc);
87 LPWSTR build_icon_path(MSIPACKAGE *package, LPCWSTR icon_name )
89 LPWSTR SystemFolder, dest, FilePath;
91 static const WCHAR szInstaller[] =
92 {'M','i','c','r','o','s','o','f','t','\\',
93 'I','n','s','t','a','l','l','e','r','\\',0};
94 static const WCHAR szFolder[] =
95 {'A','p','p','D','a','t','a','F','o','l','d','e','r',0};
97 SystemFolder = msi_dup_property( package, szFolder );
99 dest = build_directory_name(3, SystemFolder, szInstaller, package->ProductCode);
101 create_full_pathW(dest);
103 FilePath = build_directory_name(2, dest, icon_name);
105 msi_free(SystemFolder);
110 LPWSTR msi_dup_record_field( MSIRECORD *row, INT index )
112 return strdupW( MSI_RecordGetString(row,index) );
115 LPWSTR msi_dup_property(MSIPACKAGE *package, LPCWSTR prop)
121 r = MSI_GetPropertyW(package, prop, NULL, &sz);
122 if (r != ERROR_SUCCESS && r != ERROR_MORE_DATA)
126 str = msi_alloc(sz*sizeof(WCHAR));
127 r = MSI_GetPropertyW(package, prop, str, &sz);
128 if (r != ERROR_SUCCESS)
136 MSICOMPONENT* get_loaded_component( MSIPACKAGE* package, LPCWSTR Component )
140 LIST_FOR_EACH_ENTRY( comp, &package->components, MSICOMPONENT, entry )
142 if (lstrcmpW(Component,comp->Component)==0)
148 MSIFEATURE* get_loaded_feature(MSIPACKAGE* package, LPCWSTR Feature )
152 LIST_FOR_EACH_ENTRY( feature, &package->features, MSIFEATURE, entry )
154 if (lstrcmpW( Feature, feature->Feature )==0)
160 MSIFILE* get_loaded_file( MSIPACKAGE* package, LPCWSTR key )
164 LIST_FOR_EACH_ENTRY( file, &package->files, MSIFILE, entry )
166 if (lstrcmpW( key, file->File )==0)
172 int track_tempfile( MSIPACKAGE *package, LPCWSTR name, LPCWSTR path )
176 LIST_FOR_EACH_ENTRY( temp, &package->tempfiles, MSITEMPFILE, entry )
178 if (lstrcmpW( name, temp->File )==0)
180 TRACE("tempfile %s already exists with path %s\n",
181 debugstr_w(temp->File), debugstr_w(temp->Path));
186 temp = msi_alloc_zero( sizeof (MSITEMPFILE) );
190 list_add_head( &package->tempfiles, &temp->entry );
192 temp->File = strdupW( name );
193 temp->Path = strdupW( path );
195 TRACE("adding tempfile %s with path %s\n",
196 debugstr_w(temp->File), debugstr_w(temp->Path));
201 MSIFOLDER *get_loaded_folder( MSIPACKAGE *package, LPCWSTR dir )
205 LIST_FOR_EACH_ENTRY( folder, &package->folders, MSIFOLDER, entry )
207 if (lstrcmpW( dir, folder->Directory )==0)
213 LPWSTR resolve_folder(MSIPACKAGE *package, LPCWSTR name, BOOL source,
214 BOOL set_prop, MSIFOLDER **folder)
217 LPWSTR p, path = NULL;
219 TRACE("Working to resolve %s\n",debugstr_w(name));
224 /* special resolving for Target and Source root dir */
225 if (strcmpW(name,cszTargetDir)==0 || strcmpW(name,cszSourceDir)==0)
230 check_path = msi_dup_property( package, cszTargetDir );
233 check_path = msi_dup_property( package, cszRootDrive );
235 MSI_SetPropertyW(package,cszTargetDir,check_path);
238 /* correct misbuilt target dir */
239 path = build_directory_name(2, check_path, NULL);
240 if (strcmpiW(path,check_path)!=0)
241 MSI_SetPropertyW(package,cszTargetDir,path);
242 msi_free(check_path);
246 path = msi_dup_property( package, cszSourceDir );
249 path = msi_dup_property( package, cszDatabase );
252 p = strrchrW(path,'\\');
259 *folder = get_loaded_folder( package, name );
263 f = get_loaded_folder( package, name );
270 if (!source && f->ResolvedTarget)
272 path = strdupW( f->ResolvedTarget );
273 TRACE(" already resolved to %s\n",debugstr_w(path));
276 else if (source && f->ResolvedSource)
278 path = strdupW( f->ResolvedSource );
279 TRACE(" (source)already resolved to %s\n",debugstr_w(path));
282 else if (!source && f->Property)
284 path = build_directory_name( 2, f->Property, NULL );
286 TRACE(" internally set to %s\n",debugstr_w(path));
288 MSI_SetPropertyW( package, name, path );
294 LPWSTR parent = f->Parent->Directory;
296 TRACE(" ! Parent is %s\n", debugstr_w(parent));
298 p = resolve_folder(package, parent, source, set_prop, NULL);
301 TRACE(" TargetDefault = %s\n", debugstr_w(f->TargetDefault));
303 path = build_directory_name( 3, p, f->TargetDefault, NULL );
304 f->ResolvedTarget = strdupW( path );
305 TRACE(" resolved into %s\n",debugstr_w(path));
307 MSI_SetPropertyW(package,name,path);
311 if (f->SourceDefault && f->SourceDefault[0]!='.')
312 path = build_directory_name( 3, p, f->SourceDefault, NULL );
315 TRACE(" (source)resolved into %s\n",debugstr_w(path));
316 f->ResolvedSource = strdupW( path );
323 /* wrapper to resist a need for a full rewrite right now */
324 DWORD deformat_string(MSIPACKAGE *package, LPCWSTR ptr, WCHAR** data )
328 MSIRECORD *rec = MSI_CreateRecord(1);
331 MSI_RecordSetStringW(rec,0,ptr);
332 MSI_FormatRecordW(package,rec,NULL,&size);
336 *data = msi_alloc(size*sizeof(WCHAR));
338 MSI_FormatRecordW(package,rec,*data,&size);
341 msiobj_release( &rec->hdr );
342 return sizeof(WCHAR)*size;
344 msiobj_release( &rec->hdr );
351 UINT schedule_action(MSIPACKAGE *package, UINT script, LPCWSTR action)
354 LPWSTR *newbuf = NULL;
355 if (script >= TOTAL_SCRIPTS)
357 FIXME("Unknown script requested %i\n",script);
358 return ERROR_FUNCTION_FAILED;
360 TRACE("Scheduling Action %s in script %i\n",debugstr_w(action), script);
362 count = package->script->ActionCount[script];
363 package->script->ActionCount[script]++;
365 newbuf = msi_realloc( package->script->Actions[script],
366 package->script->ActionCount[script]* sizeof(LPWSTR));
368 newbuf = msi_alloc( sizeof(LPWSTR));
370 newbuf[count] = strdupW(action);
371 package->script->Actions[script] = newbuf;
373 return ERROR_SUCCESS;
376 static void remove_tracked_tempfiles(MSIPACKAGE* package)
378 struct list *item, *cursor;
380 LIST_FOR_EACH_SAFE( item, cursor, &package->tempfiles )
382 MSITEMPFILE *temp = LIST_ENTRY( item, MSITEMPFILE, entry );
384 list_remove( &temp->entry );
385 TRACE("deleting temp file %s\n", debugstr_w( temp->Path ));
386 DeleteFileW( temp->Path );
387 msi_free( temp->File );
388 msi_free( temp->Path );
393 static void free_feature( MSIFEATURE *feature )
395 struct list *item, *cursor;
397 LIST_FOR_EACH_SAFE( item, cursor, &feature->Components )
399 ComponentList *cl = LIST_ENTRY( item, ComponentList, entry );
400 list_remove( &cl->entry );
403 msi_free( feature->Feature );
404 msi_free( feature->Feature_Parent );
405 msi_free( feature->Directory );
406 msi_free( feature->Description );
407 msi_free( feature->Title );
411 void free_extension( MSIEXTENSION *ext )
413 struct list *item, *cursor;
415 LIST_FOR_EACH_SAFE( item, cursor, &ext->verbs )
417 MSIVERB *verb = LIST_ENTRY( item, MSIVERB, entry );
419 list_remove( &verb->entry );
420 msi_free( verb->Verb );
421 msi_free( verb->Command );
422 msi_free( verb->Argument );
426 msi_free( ext->Extension );
427 msi_free( ext->ProgIDText );
431 /* Called when the package is being closed */
432 void ACTION_free_package_structures( MSIPACKAGE* package)
435 struct list *item, *cursor;
437 TRACE("Freeing package action data\n");
439 remove_tracked_tempfiles(package);
441 LIST_FOR_EACH_SAFE( item, cursor, &package->features )
443 MSIFEATURE *feature = LIST_ENTRY( item, MSIFEATURE, entry );
444 list_remove( &feature->entry );
445 free_feature( feature );
448 LIST_FOR_EACH_SAFE( item, cursor, &package->folders )
450 MSIFOLDER *folder = LIST_ENTRY( item, MSIFOLDER, entry );
452 list_remove( &folder->entry );
453 msi_free( folder->Directory );
454 msi_free( folder->TargetDefault );
455 msi_free( folder->SourceDefault );
456 msi_free( folder->ResolvedTarget );
457 msi_free( folder->ResolvedSource );
458 msi_free( folder->Property );
462 LIST_FOR_EACH_SAFE( item, cursor, &package->components )
464 MSICOMPONENT *comp = LIST_ENTRY( item, MSICOMPONENT, entry );
466 list_remove( &comp->entry );
467 msi_free( comp->Component );
468 msi_free( comp->ComponentId );
469 msi_free( comp->Directory );
470 msi_free( comp->Condition );
471 msi_free( comp->KeyPath );
472 msi_free( comp->FullKeypath );
476 LIST_FOR_EACH_SAFE( item, cursor, &package->files )
478 MSIFILE *file = LIST_ENTRY( item, MSIFILE, entry );
480 list_remove( &file->entry );
481 msi_free( file->File );
482 msi_free( file->FileName );
483 msi_free( file->ShortName );
484 msi_free( file->Version );
485 msi_free( file->Language );
486 msi_free( file->SourcePath );
487 msi_free( file->TargetPath );
491 /* clean up extension, progid, class and verb structures */
492 LIST_FOR_EACH_SAFE( item, cursor, &package->classes )
494 MSICLASS *cls = LIST_ENTRY( item, MSICLASS, entry );
496 list_remove( &cls->entry );
497 msi_free( cls->clsid );
498 msi_free( cls->Context );
499 msi_free( cls->Description );
500 msi_free( cls->FileTypeMask );
501 msi_free( cls->IconPath );
502 msi_free( cls->DefInprocHandler );
503 msi_free( cls->DefInprocHandler32 );
504 msi_free( cls->Argument );
505 msi_free( cls->ProgIDText );
509 LIST_FOR_EACH_SAFE( item, cursor, &package->extensions )
511 MSIEXTENSION *ext = LIST_ENTRY( item, MSIEXTENSION, entry );
513 list_remove( &ext->entry );
514 free_extension( ext );
517 LIST_FOR_EACH_SAFE( item, cursor, &package->progids )
519 MSIPROGID *progid = LIST_ENTRY( item, MSIPROGID, entry );
521 list_remove( &progid->entry );
522 msi_free( progid->ProgID );
523 msi_free( progid->Description );
524 msi_free( progid->IconPath );
528 LIST_FOR_EACH_SAFE( item, cursor, &package->mimes )
530 MSIMIME *mt = LIST_ENTRY( item, MSIMIME, entry );
532 list_remove( &mt->entry );
533 msi_free( mt->clsid );
534 msi_free( mt->ContentType );
538 LIST_FOR_EACH_SAFE( item, cursor, &package->appids )
540 MSIAPPID *appid = LIST_ENTRY( item, MSIAPPID, entry );
542 list_remove( &appid->entry );
543 msi_free( appid->AppID );
544 msi_free( appid->RemoteServerName );
545 msi_free( appid->LocalServer );
546 msi_free( appid->ServiceParameters );
547 msi_free( appid->DllSurrogate );
553 for (i = 0; i < TOTAL_SCRIPTS; i++)
556 for (j = 0; j < package->script->ActionCount[i]; j++)
557 msi_free(package->script->Actions[i][j]);
559 msi_free(package->script->Actions[i]);
562 for (i = 0; i < package->script->UniqueActionsCount; i++)
563 msi_free(package->script->UniqueActions[i]);
565 msi_free(package->script->UniqueActions);
566 msi_free(package->script);
569 msi_free(package->PackagePath);
570 msi_free(package->ProductCode);
571 msi_free(package->ActionFormat);
572 msi_free(package->LastAction);
574 /* cleanup control event subscriptions */
575 ControlEvent_CleanupSubscriptions(package);
579 * build_directory_name()
581 * This function is to save messing round with directory names
582 * It handles adding backslashes between path segments,
583 * and can add \ at the end of the directory name if told to.
585 * It takes a variable number of arguments.
586 * It always allocates a new string for the result, so make sure
587 * to free the return value when finished with it.
589 * The first arg is the number of path segments that follow.
590 * The arguments following count are a list of path segments.
591 * A path segment may be NULL.
593 * Path segments will be added with a \ separating them.
594 * A \ will not be added after the last segment, however if the
595 * last segment is NULL, then the last character will be a \
598 LPWSTR build_directory_name(DWORD count, ...)
605 for(i=0; i<count; i++)
607 LPCWSTR str = va_arg(va,LPCWSTR);
609 sz += strlenW(str) + 1;
613 dir = msi_alloc(sz*sizeof(WCHAR));
617 for(i=0; i<count; i++)
619 LPCWSTR str = va_arg(va,LPCWSTR);
623 if( ((i+1)!=count) && dir[strlenW(dir)-1]!='\\')
629 /***********************************************************************
632 * Recursively create all directories in the path.
634 * shamelessly stolen from setupapi/queue.c
636 BOOL create_full_pathW(const WCHAR *path)
642 new_path = msi_alloc( (strlenW(path) + 1) * sizeof(WCHAR));
644 strcpyW(new_path, path);
646 while((len = strlenW(new_path)) && new_path[len - 1] == '\\')
647 new_path[len - 1] = 0;
649 while(!CreateDirectoryW(new_path, NULL))
652 DWORD last_error = GetLastError();
653 if(last_error == ERROR_ALREADY_EXISTS)
656 if(last_error != ERROR_PATH_NOT_FOUND)
662 if(!(slash = strrchrW(new_path, '\\')))
668 len = slash - new_path;
670 if(!create_full_pathW(new_path))
675 new_path[len] = '\\';
682 void ui_progress(MSIPACKAGE *package, int a, int b, int c, int d )
686 row = MSI_CreateRecord(4);
687 MSI_RecordSetInteger(row,1,a);
688 MSI_RecordSetInteger(row,2,b);
689 MSI_RecordSetInteger(row,3,c);
690 MSI_RecordSetInteger(row,4,d);
691 MSI_ProcessMessage(package, INSTALLMESSAGE_PROGRESS, row);
692 msiobj_release(&row->hdr);
694 msi_dialog_check_messages(NULL);
697 void ui_actiondata(MSIPACKAGE *package, LPCWSTR action, MSIRECORD * record)
699 static const WCHAR Query_t[] =
700 {'S','E','L','E','C','T',' ','*',' ','F','R','O','M',' ',
701 '`','A','c','t','i','o', 'n','T','e','x','t','`',' ',
702 'W','H','E','R','E',' ', '`','A','c','t','i','o','n','`',' ','=',
703 ' ','\'','%','s','\'',0};
707 static const WCHAR szActionData[] =
708 {'A','c','t','i','o','n','D','a','t','a',0};
710 if (!package->LastAction || strcmpW(package->LastAction,action))
712 row = MSI_QueryGetRecord(package->db, Query_t, action);
716 if (MSI_RecordIsNull(row,3))
718 msiobj_release(&row->hdr);
722 /* update the cached actionformat */
723 msi_free(package->ActionFormat);
724 package->ActionFormat = msi_dup_record_field(row,3);
726 msi_free(package->LastAction);
727 package->LastAction = strdupW(action);
729 msiobj_release(&row->hdr);
732 MSI_RecordSetStringW(record,0,package->ActionFormat);
734 MSI_FormatRecordW(package,record,message,&size);
736 row = MSI_CreateRecord(1);
737 MSI_RecordSetStringW(row,1,message);
739 MSI_ProcessMessage(package, INSTALLMESSAGE_ACTIONDATA, row);
741 ControlEvent_FireSubscribedEvent(package,szActionData, row);
743 msiobj_release(&row->hdr);
746 BOOL ACTION_VerifyComponentForAction( MSICOMPONENT* comp, INSTALLSTATE check )
751 if (comp->Installed == check)
754 if (comp->ActionRequest == check)
760 BOOL ACTION_VerifyFeatureForAction( MSIFEATURE* feature, INSTALLSTATE check )
765 if (feature->Installed == check)
768 if (feature->ActionRequest == check)
774 void reduce_to_longfilename(WCHAR* filename)
776 LPWSTR p = strchrW(filename,'|');
778 memmove(filename, p+1, (strlenW(p+1)+1)*sizeof(WCHAR));
781 void reduce_to_shortfilename(WCHAR* filename)
783 LPWSTR p = strchrW(filename,'|');
788 LPWSTR create_component_advertise_string(MSIPACKAGE* package,
789 MSICOMPONENT* component, LPCWSTR feature)
792 WCHAR productid_85[21];
793 WCHAR component_85[21];
795 * I have a fair bit of confusion as to when a < is used and when a > is
796 * used. I do not think i have it right...
798 * Ok it appears that the > is used if there is a guid for the compoenent
799 * and the < is used if not.
801 static WCHAR fmt1[] = {'%','s','%','s','<',0,0};
802 static WCHAR fmt2[] = {'%','s','%','s','>','%','s',0,0};
803 LPWSTR output = NULL;
806 memset(productid_85,0,sizeof(productid_85));
807 memset(component_85,0,sizeof(component_85));
809 CLSIDFromString(package->ProductCode, &clsid);
811 encode_base85_guid(&clsid,productid_85);
813 CLSIDFromString(component->ComponentId, &clsid);
814 encode_base85_guid(&clsid,component_85);
816 TRACE("Doing something with this... %s %s %s\n",
817 debugstr_w(productid_85), debugstr_w(feature),
818 debugstr_w(component_85));
820 sz = lstrlenW(productid_85) + lstrlenW(feature);
822 sz += lstrlenW(component_85);
827 output = msi_alloc(sz);
831 sprintfW(output,fmt2,productid_85,feature,component_85);
833 sprintfW(output,fmt1,productid_85,feature);
838 /* update compoennt state based on a feature change */
839 void ACTION_UpdateComponentStates(MSIPACKAGE *package, LPCWSTR szFeature)
841 INSTALLSTATE newstate;
845 feature = get_loaded_feature(package,szFeature);
849 newstate = feature->ActionRequest;
851 LIST_FOR_EACH_ENTRY( cl, &feature->Components, ComponentList, entry )
853 MSICOMPONENT* component = cl->component;
855 TRACE("MODIFYING(%i): Component %s (Installed %i, Action %i, Request %i)\n",
856 newstate, debugstr_w(component->Component), component->Installed,
857 component->Action, component->ActionRequest);
859 if (!component->Enabled)
862 if (newstate == INSTALLSTATE_LOCAL)
864 component->ActionRequest = INSTALLSTATE_LOCAL;
865 component->Action = INSTALLSTATE_LOCAL;
869 ComponentList *clist;
872 component->ActionRequest = newstate;
873 component->Action = newstate;
875 /*if any other feature wants is local we need to set it local*/
876 LIST_FOR_EACH_ENTRY( f, &package->features, MSIFEATURE, entry )
878 if ( component->ActionRequest != INSTALLSTATE_LOCAL )
881 LIST_FOR_EACH_ENTRY( clist, &f->Components, ComponentList, entry )
883 if ( clist->component == component )
885 if (f->ActionRequest == INSTALLSTATE_LOCAL)
887 TRACE("Saved by %s\n", debugstr_w(f->Feature));
888 component->ActionRequest = INSTALLSTATE_LOCAL;
889 component->Action = INSTALLSTATE_LOCAL;
896 TRACE("Result (%i): Component %s (Installed %i, Action %i, Request %i)\n",
897 newstate, debugstr_w(component->Component), component->Installed,
898 component->Action, component->ActionRequest);
902 UINT register_unique_action(MSIPACKAGE *package, LPCWSTR action)
905 LPWSTR *newbuf = NULL;
907 if (!package->script)
910 TRACE("Registering Action %s as having fun\n",debugstr_w(action));
912 count = package->script->UniqueActionsCount;
913 package->script->UniqueActionsCount++;
915 newbuf = msi_realloc( package->script->UniqueActions,
916 package->script->UniqueActionsCount* sizeof(LPWSTR));
918 newbuf = msi_alloc( sizeof(LPWSTR));
920 newbuf[count] = strdupW(action);
921 package->script->UniqueActions = newbuf;
923 return ERROR_SUCCESS;
926 BOOL check_unique_action(MSIPACKAGE *package, LPCWSTR action)
930 if (!package->script)
933 for (i = 0; i < package->script->UniqueActionsCount; i++)
934 if (!strcmpW(package->script->UniqueActions[i],action))
940 WCHAR* generate_error_string(MSIPACKAGE *package, UINT error, DWORD count, ... )
942 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};
952 row = MSI_QueryGetRecord(package->db, query, error);
956 rec = MSI_CreateRecord(count+2);
958 str = MSI_RecordGetString(row,1);
959 MSI_RecordSetStringW(rec,0,str);
960 msiobj_release( &row->hdr );
961 MSI_RecordSetInteger(rec,1,error);
964 for (i = 0; i < count; i++)
966 str = va_arg(va,LPCWSTR);
967 MSI_RecordSetStringW(rec,(i+2),str);
971 MSI_FormatRecordW(package,rec,NULL,&size);
975 data = msi_alloc(size*sizeof(WCHAR));
977 MSI_FormatRecordW(package,rec,data,&size);
980 msiobj_release( &rec->hdr );
984 msiobj_release( &rec->hdr );