/* * Implementation of the Microsoft Installer (msi.dll) * * Copyright 2005 Aric Stewart for CodeWeavers * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA */ /* * Here are helper functions formally in action.c that are used by a variaty of * actions and functions. */ #include #include "windef.h" #include "winbase.h" #include "winerror.h" #include "wine/debug.h" #include "msipriv.h" #include "winuser.h" #include "wine/unicode.h" #include "action.h" WINE_DEFAULT_DEBUG_CHANNEL(msi); static const WCHAR cszTargetDir[] = {'T','A','R','G','E','T','D','I','R',0}; static const WCHAR cszDatabase[]={'D','A','T','A','B','A','S','E',0}; const WCHAR cszSourceDir[] = {'S','o','u','r','c','e','D','i','r',0}; const WCHAR cszRootDrive[] = {'R','O','O','T','D','R','I','V','E',0}; const WCHAR cszbs[]={'\\',0}; DWORD build_version_dword(LPCWSTR version_string) { SHORT major,minor; WORD build; DWORD rc = 0x00000000; LPCWSTR ptr1; ptr1 = version_string; if (!ptr1) return rc; else major = atoiW(ptr1); if(ptr1) ptr1 = strchrW(ptr1,'.'); if (ptr1) { ptr1++; minor = atoiW(ptr1); } else minor = 0; if (ptr1) ptr1 = strchrW(ptr1,'.'); if (ptr1) { ptr1++; build = atoiW(ptr1); } else build = 0; rc = MAKELONG(build,MAKEWORD(minor,major)); TRACE("%s -> 0x%lx\n",debugstr_w(version_string),rc); return rc; } LPWSTR build_icon_path(MSIPACKAGE *package, LPCWSTR icon_name ) { LPWSTR SystemFolder, dest, FilePath; static const WCHAR szInstaller[] = {'M','i','c','r','o','s','o','f','t','\\', 'I','n','s','t','a','l','l','e','r','\\',0}; static const WCHAR szFolder[] = {'A','p','p','D','a','t','a','F','o','l','d','e','r',0}; SystemFolder = msi_dup_property( package, szFolder ); dest = build_directory_name(3, SystemFolder, szInstaller, package->ProductCode); create_full_pathW(dest); FilePath = build_directory_name(2, dest, icon_name); msi_free(SystemFolder); msi_free(dest); return FilePath; } LPWSTR msi_dup_record_field( MSIRECORD *row, INT index ) { return strdupW( MSI_RecordGetString(row,index) ); } LPWSTR msi_dup_property(MSIPACKAGE *package, LPCWSTR prop) { DWORD sz = 0; LPWSTR str; UINT r; r = MSI_GetPropertyW(package, prop, NULL, &sz); if (r != ERROR_SUCCESS && r != ERROR_MORE_DATA) return NULL; sz++; str = msi_alloc(sz*sizeof(WCHAR)); r = MSI_GetPropertyW(package, prop, str, &sz); if (r != ERROR_SUCCESS) { msi_free(str); str = NULL; } return str; } MSICOMPONENT* get_loaded_component( MSIPACKAGE* package, LPCWSTR Component ) { MSICOMPONENT *comp; LIST_FOR_EACH_ENTRY( comp, &package->components, MSICOMPONENT, entry ) { if (lstrcmpW(Component,comp->Component)==0) return comp; } return NULL; } MSIFEATURE* get_loaded_feature(MSIPACKAGE* package, LPCWSTR Feature ) { MSIFEATURE *feature; LIST_FOR_EACH_ENTRY( feature, &package->features, MSIFEATURE, entry ) { if (lstrcmpW( Feature, feature->Feature )==0) return feature; } return NULL; } MSIFILE* get_loaded_file( MSIPACKAGE* package, LPCWSTR key ) { MSIFILE *file; LIST_FOR_EACH_ENTRY( file, &package->files, MSIFILE, entry ) { if (lstrcmpW( key, file->File )==0) return file; } return NULL; } int track_tempfile( MSIPACKAGE *package, LPCWSTR name, LPCWSTR path ) { MSITEMPFILE *temp; LIST_FOR_EACH_ENTRY( temp, &package->tempfiles, MSITEMPFILE, entry ) { if (lstrcmpW( name, temp->File )==0) { TRACE("tempfile %s already exists with path %s\n", debugstr_w(temp->File), debugstr_w(temp->Path)); return -1; } } temp = msi_alloc_zero( sizeof (MSITEMPFILE) ); if (!temp) return -1; list_add_head( &package->tempfiles, &temp->entry ); temp->File = strdupW( name ); temp->Path = strdupW( path ); TRACE("adding tempfile %s with path %s\n", debugstr_w(temp->File), debugstr_w(temp->Path)); return 0; } MSIFOLDER *get_loaded_folder( MSIPACKAGE *package, LPCWSTR dir ) { MSIFOLDER *folder; LIST_FOR_EACH_ENTRY( folder, &package->folders, MSIFOLDER, entry ) { if (lstrcmpW( dir, folder->Directory )==0) return folder; } return NULL; } static LPWSTR get_source_root( MSIPACKAGE *package ) { LPWSTR path, p; path = msi_dup_property( package, cszSourceDir ); if (path) return path; path = msi_dup_property( package, cszDatabase ); if (path) { p = strrchrW(path,'\\'); if (p) *(p+1) = 0; } return path; } /* * clean_spaces_from_path() * * removes spaces from the beginning and end of path segments * removes multiple \\ characters */ static void clean_spaces_from_path( LPWSTR p ) { LPWSTR q = p; int n, len = 0; while (1) { /* copy until the end of the string or a space */ while (*p != ' ' && (*q = *p)) { p++, len++; /* reduce many backslashes to one */ if (*p != '\\' || *q != '\\') q++; } /* quit at the end of the string */ if (!*p) break; /* count the number of spaces */ n = 0; while (p[n] == ' ') n++; /* if it's leading or trailing space, skip it */ if ( len == 0 || p[-1] == '\\' || p[n] == '\\' ) p += n; else /* copy n spaces */ while (n && (*q++ = *p++)) n--; } } LPWSTR resolve_folder(MSIPACKAGE *package, LPCWSTR name, BOOL source, BOOL set_prop, MSIFOLDER **folder) { MSIFOLDER *f; LPWSTR p, path = NULL; TRACE("Working to resolve %s\n",debugstr_w(name)); if (!name) return NULL; /* special resolving for Target and Source root dir */ if (strcmpW(name,cszTargetDir)==0 || strcmpW(name,cszSourceDir)==0) { if (!source) { LPWSTR check_path; check_path = msi_dup_property( package, cszTargetDir ); if (!check_path) { check_path = msi_dup_property( package, cszRootDrive ); if (set_prop) MSI_SetPropertyW(package,cszTargetDir,check_path); } /* correct misbuilt target dir */ path = build_directory_name(2, check_path, NULL); clean_spaces_from_path( path ); if (strcmpiW(path,check_path)!=0) MSI_SetPropertyW(package,cszTargetDir,path); msi_free(check_path); } else path = get_source_root( package ); if (folder) *folder = get_loaded_folder( package, name ); return path; } f = get_loaded_folder( package, name ); if (!f) return NULL; if (folder) *folder = f; if (!source && f->ResolvedTarget) { path = strdupW( f->ResolvedTarget ); TRACE(" already resolved to %s\n",debugstr_w(path)); return path; } else if (source && f->ResolvedSource) { path = strdupW( f->ResolvedSource ); TRACE(" (source)already resolved to %s\n",debugstr_w(path)); return path; } else if (!source && f->Property) { path = build_directory_name( 2, f->Property, NULL ); TRACE(" internally set to %s\n",debugstr_w(path)); if (set_prop) MSI_SetPropertyW( package, name, path ); return path; } if (f->Parent) { LPWSTR parent = f->Parent->Directory; TRACE(" ! Parent is %s\n", debugstr_w(parent)); p = resolve_folder(package, parent, source, set_prop, NULL); if (!source) { TRACE(" TargetDefault = %s\n", debugstr_w(f->TargetDefault)); path = build_directory_name( 3, p, f->TargetDefault, NULL ); clean_spaces_from_path( path ); f->ResolvedTarget = strdupW( path ); TRACE("target -> %s\n", debugstr_w(path)); if (set_prop) MSI_SetPropertyW(package,name,path); } else { /* source may be in a few different places ... check each of them */ path = NULL; /* try the long path directory */ if (f->SourceLongPath) { path = build_directory_name( 3, p, f->SourceLongPath, NULL ); if (INVALID_FILE_ATTRIBUTES == GetFileAttributesW( path )) { msi_free( path ); path = NULL; } } /* try the short path directory */ if (!path && f->SourceShortPath) { path = build_directory_name( 3, p, f->SourceShortPath, NULL ); if (INVALID_FILE_ATTRIBUTES == GetFileAttributesW( path )) { msi_free( path ); path = NULL; } } /* try the root of the install */ if (!path) path = get_source_root( package ); TRACE("source -> %s\n", debugstr_w(path)); f->ResolvedSource = strdupW( path ); } msi_free(p); } return path; } /* wrapper to resist a need for a full rewrite right now */ DWORD deformat_string(MSIPACKAGE *package, LPCWSTR ptr, WCHAR** data ) { if (ptr) { MSIRECORD *rec = MSI_CreateRecord(1); DWORD size = 0; MSI_RecordSetStringW(rec,0,ptr); MSI_FormatRecordW(package,rec,NULL,&size); if (size >= 0) { size++; *data = msi_alloc(size*sizeof(WCHAR)); if (size > 1) MSI_FormatRecordW(package,rec,*data,&size); else *data[0] = 0; msiobj_release( &rec->hdr ); return sizeof(WCHAR)*size; } msiobj_release( &rec->hdr ); } *data = NULL; return 0; } UINT schedule_action(MSIPACKAGE *package, UINT script, LPCWSTR action) { UINT count; LPWSTR *newbuf = NULL; if (script >= TOTAL_SCRIPTS) { FIXME("Unknown script requested %i\n",script); return ERROR_FUNCTION_FAILED; } TRACE("Scheduling Action %s in script %i\n",debugstr_w(action), script); count = package->script->ActionCount[script]; package->script->ActionCount[script]++; if (count != 0) newbuf = msi_realloc( package->script->Actions[script], package->script->ActionCount[script]* sizeof(LPWSTR)); else newbuf = msi_alloc( sizeof(LPWSTR)); newbuf[count] = strdupW(action); package->script->Actions[script] = newbuf; return ERROR_SUCCESS; } static void remove_tracked_tempfiles(MSIPACKAGE* package) { struct list *item, *cursor; LIST_FOR_EACH_SAFE( item, cursor, &package->tempfiles ) { MSITEMPFILE *temp = LIST_ENTRY( item, MSITEMPFILE, entry ); list_remove( &temp->entry ); TRACE("deleting temp file %s\n", debugstr_w( temp->Path )); DeleteFileW( temp->Path ); msi_free( temp->File ); msi_free( temp->Path ); msi_free( temp ); } } static void free_feature( MSIFEATURE *feature ) { struct list *item, *cursor; LIST_FOR_EACH_SAFE( item, cursor, &feature->Components ) { ComponentList *cl = LIST_ENTRY( item, ComponentList, entry ); list_remove( &cl->entry ); msi_free( cl ); } msi_free( feature->Feature ); msi_free( feature->Feature_Parent ); msi_free( feature->Directory ); msi_free( feature->Description ); msi_free( feature->Title ); msi_free( feature ); } void free_extension( MSIEXTENSION *ext ) { struct list *item, *cursor; LIST_FOR_EACH_SAFE( item, cursor, &ext->verbs ) { MSIVERB *verb = LIST_ENTRY( item, MSIVERB, entry ); list_remove( &verb->entry ); msi_free( verb->Verb ); msi_free( verb->Command ); msi_free( verb->Argument ); msi_free( verb ); } msi_free( ext->Extension ); msi_free( ext->ProgIDText ); msi_free( ext ); } /* Called when the package is being closed */ void ACTION_free_package_structures( MSIPACKAGE* package) { INT i; struct list *item, *cursor; TRACE("Freeing package action data\n"); remove_tracked_tempfiles(package); LIST_FOR_EACH_SAFE( item, cursor, &package->features ) { MSIFEATURE *feature = LIST_ENTRY( item, MSIFEATURE, entry ); list_remove( &feature->entry ); free_feature( feature ); } LIST_FOR_EACH_SAFE( item, cursor, &package->folders ) { MSIFOLDER *folder = LIST_ENTRY( item, MSIFOLDER, entry ); list_remove( &folder->entry ); msi_free( folder->Directory ); msi_free( folder->TargetDefault ); msi_free( folder->SourceLongPath ); msi_free( folder->SourceShortPath ); msi_free( folder->ResolvedTarget ); msi_free( folder->ResolvedSource ); msi_free( folder->Property ); msi_free( folder ); } LIST_FOR_EACH_SAFE( item, cursor, &package->components ) { MSICOMPONENT *comp = LIST_ENTRY( item, MSICOMPONENT, entry ); list_remove( &comp->entry ); msi_free( comp->Component ); msi_free( comp->ComponentId ); msi_free( comp->Directory ); msi_free( comp->Condition ); msi_free( comp->KeyPath ); msi_free( comp->FullKeypath ); msi_free( comp ); } LIST_FOR_EACH_SAFE( item, cursor, &package->files ) { MSIFILE *file = LIST_ENTRY( item, MSIFILE, entry ); list_remove( &file->entry ); msi_free( file->File ); msi_free( file->FileName ); msi_free( file->ShortName ); msi_free( file->LongName ); msi_free( file->Version ); msi_free( file->Language ); msi_free( file->SourcePath ); msi_free( file->TargetPath ); msi_free( file ); } /* clean up extension, progid, class and verb structures */ LIST_FOR_EACH_SAFE( item, cursor, &package->classes ) { MSICLASS *cls = LIST_ENTRY( item, MSICLASS, entry ); list_remove( &cls->entry ); msi_free( cls->clsid ); msi_free( cls->Context ); msi_free( cls->Description ); msi_free( cls->FileTypeMask ); msi_free( cls->IconPath ); msi_free( cls->DefInprocHandler ); msi_free( cls->DefInprocHandler32 ); msi_free( cls->Argument ); msi_free( cls->ProgIDText ); msi_free( cls ); } LIST_FOR_EACH_SAFE( item, cursor, &package->extensions ) { MSIEXTENSION *ext = LIST_ENTRY( item, MSIEXTENSION, entry ); list_remove( &ext->entry ); free_extension( ext ); } LIST_FOR_EACH_SAFE( item, cursor, &package->progids ) { MSIPROGID *progid = LIST_ENTRY( item, MSIPROGID, entry ); list_remove( &progid->entry ); msi_free( progid->ProgID ); msi_free( progid->Description ); msi_free( progid->IconPath ); msi_free( progid ); } LIST_FOR_EACH_SAFE( item, cursor, &package->mimes ) { MSIMIME *mt = LIST_ENTRY( item, MSIMIME, entry ); list_remove( &mt->entry ); msi_free( mt->clsid ); msi_free( mt->ContentType ); msi_free( mt ); } LIST_FOR_EACH_SAFE( item, cursor, &package->appids ) { MSIAPPID *appid = LIST_ENTRY( item, MSIAPPID, entry ); list_remove( &appid->entry ); msi_free( appid->AppID ); msi_free( appid->RemoteServerName ); msi_free( appid->LocalServer ); msi_free( appid->ServiceParameters ); msi_free( appid->DllSurrogate ); msi_free( appid ); } if (package->script) { for (i = 0; i < TOTAL_SCRIPTS; i++) { int j; for (j = 0; j < package->script->ActionCount[i]; j++) msi_free(package->script->Actions[i][j]); msi_free(package->script->Actions[i]); } for (i = 0; i < package->script->UniqueActionsCount; i++) msi_free(package->script->UniqueActions[i]); msi_free(package->script->UniqueActions); msi_free(package->script); } msi_free(package->PackagePath); msi_free(package->ProductCode); msi_free(package->ActionFormat); msi_free(package->LastAction); /* cleanup control event subscriptions */ ControlEvent_CleanupSubscriptions(package); } /* * build_directory_name() * * This function is to save messing round with directory names * It handles adding backslashes between path segments, * and can add \ at the end of the directory name if told to. * * It takes a variable number of arguments. * It always allocates a new string for the result, so make sure * to free the return value when finished with it. * * The first arg is the number of path segments that follow. * The arguments following count are a list of path segments. * A path segment may be NULL. * * Path segments will be added with a \ separating them. * A \ will not be added after the last segment, however if the * last segment is NULL, then the last character will be a \ * */ LPWSTR build_directory_name(DWORD count, ...) { DWORD sz = 1, i; LPWSTR dir; va_list va; va_start(va,count); for(i=0; ihdr); msi_dialog_check_messages(NULL); } void ui_actiondata(MSIPACKAGE *package, LPCWSTR action, MSIRECORD * record) { static const WCHAR Query_t[] = {'S','E','L','E','C','T',' ','*',' ','F','R','O','M',' ', '`','A','c','t','i','o', 'n','T','e','x','t','`',' ', 'W','H','E','R','E',' ', '`','A','c','t','i','o','n','`',' ','=', ' ','\'','%','s','\'',0}; WCHAR message[1024]; MSIRECORD * row = 0; DWORD size; if (!package->LastAction || strcmpW(package->LastAction,action)) { row = MSI_QueryGetRecord(package->db, Query_t, action); if (!row) return; if (MSI_RecordIsNull(row,3)) { msiobj_release(&row->hdr); return; } /* update the cached actionformat */ msi_free(package->ActionFormat); package->ActionFormat = msi_dup_record_field(row,3); msi_free(package->LastAction); package->LastAction = strdupW(action); msiobj_release(&row->hdr); } MSI_RecordSetStringW(record,0,package->ActionFormat); size = 1024; MSI_FormatRecordW(package,record,message,&size); row = MSI_CreateRecord(1); MSI_RecordSetStringW(row,1,message); MSI_ProcessMessage(package, INSTALLMESSAGE_ACTIONDATA, row); msiobj_release(&row->hdr); } BOOL ACTION_VerifyComponentForAction( MSICOMPONENT* comp, INSTALLSTATE check ) { if (!comp) return FALSE; if (comp->Installed == check) return FALSE; if (comp->ActionRequest == check) return TRUE; else return FALSE; } BOOL ACTION_VerifyFeatureForAction( MSIFEATURE* feature, INSTALLSTATE check ) { if (!feature) return FALSE; if (feature->Installed == check) return FALSE; if (feature->ActionRequest == check) return TRUE; else return FALSE; } void reduce_to_longfilename(WCHAR* filename) { LPWSTR p = strchrW(filename,'|'); if (p) memmove(filename, p+1, (strlenW(p+1)+1)*sizeof(WCHAR)); } void reduce_to_shortfilename(WCHAR* filename) { LPWSTR p = strchrW(filename,'|'); if (p) *p = 0; } LPWSTR create_component_advertise_string(MSIPACKAGE* package, MSICOMPONENT* component, LPCWSTR feature) { static const WCHAR fmt[] = {'%','s','%','s','%','c','%','s',0}; WCHAR productid_85[21], component_85[21]; LPWSTR output = NULL; DWORD sz = 0; GUID clsid; /* > is used if there is a component GUID and < if not. */ productid_85[0] = 0; component_85[0] = 0; CLSIDFromString(package->ProductCode, &clsid); encode_base85_guid(&clsid, productid_85); if (component) { CLSIDFromString(component->ComponentId, &clsid); encode_base85_guid(&clsid, component_85); } TRACE("prod=%s feat=%s comp=%s\n", debugstr_w(productid_85), debugstr_w(feature), debugstr_w(component_85)); sz = 20 + lstrlenW(feature) + 20 + 3; output = msi_alloc_zero(sz*sizeof(WCHAR)); sprintfW(output, fmt, productid_85, feature, component?'>':'<', component_85); return output; } /* update compoennt state based on a feature change */ void ACTION_UpdateComponentStates(MSIPACKAGE *package, LPCWSTR szFeature) { INSTALLSTATE newstate; MSIFEATURE *feature; ComponentList *cl; feature = get_loaded_feature(package,szFeature); if (!feature) return; newstate = feature->ActionRequest; LIST_FOR_EACH_ENTRY( cl, &feature->Components, ComponentList, entry ) { MSICOMPONENT* component = cl->component; TRACE("MODIFYING(%i): Component %s (Installed %i, Action %i, Request %i)\n", newstate, debugstr_w(component->Component), component->Installed, component->Action, component->ActionRequest); if (!component->Enabled) continue; if (newstate == INSTALLSTATE_LOCAL) { component->ActionRequest = INSTALLSTATE_LOCAL; component->Action = INSTALLSTATE_LOCAL; } else { ComponentList *clist; MSIFEATURE *f; component->ActionRequest = newstate; component->Action = newstate; /*if any other feature wants is local we need to set it local*/ LIST_FOR_EACH_ENTRY( f, &package->features, MSIFEATURE, entry ) { if ( component->ActionRequest != INSTALLSTATE_LOCAL ) break; LIST_FOR_EACH_ENTRY( clist, &f->Components, ComponentList, entry ) { if ( clist->component == component ) { if (f->ActionRequest == INSTALLSTATE_LOCAL) { TRACE("Saved by %s\n", debugstr_w(f->Feature)); component->ActionRequest = INSTALLSTATE_LOCAL; component->Action = INSTALLSTATE_LOCAL; } break; } } } } TRACE("Result (%i): Component %s (Installed %i, Action %i, Request %i)\n", newstate, debugstr_w(component->Component), component->Installed, component->Action, component->ActionRequest); } } UINT register_unique_action(MSIPACKAGE *package, LPCWSTR action) { UINT count; LPWSTR *newbuf = NULL; if (!package->script) return FALSE; TRACE("Registering Action %s as having fun\n",debugstr_w(action)); count = package->script->UniqueActionsCount; package->script->UniqueActionsCount++; if (count != 0) newbuf = msi_realloc( package->script->UniqueActions, package->script->UniqueActionsCount* sizeof(LPWSTR)); else newbuf = msi_alloc( sizeof(LPWSTR)); newbuf[count] = strdupW(action); package->script->UniqueActions = newbuf; return ERROR_SUCCESS; } BOOL check_unique_action(MSIPACKAGE *package, LPCWSTR action) { INT i; if (!package->script) return FALSE; for (i = 0; i < package->script->UniqueActionsCount; i++) if (!strcmpW(package->script->UniqueActions[i],action)) return TRUE; return FALSE; } WCHAR* generate_error_string(MSIPACKAGE *package, UINT error, DWORD count, ... ) { 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}; MSIRECORD *rec; MSIRECORD *row; DWORD size = 0; DWORD i; va_list va; LPCWSTR str; LPWSTR data; row = MSI_QueryGetRecord(package->db, query, error); if (!row) return 0; rec = MSI_CreateRecord(count+2); str = MSI_RecordGetString(row,1); MSI_RecordSetStringW(rec,0,str); msiobj_release( &row->hdr ); MSI_RecordSetInteger(rec,1,error); va_start(va,count); for (i = 0; i < count; i++) { str = va_arg(va,LPCWSTR); MSI_RecordSetStringW(rec,(i+2),str); } va_end(va); MSI_FormatRecordW(package,rec,NULL,&size); if (size >= 0) { size++; data = msi_alloc(size*sizeof(WCHAR)); if (size > 1) MSI_FormatRecordW(package,rec,data,&size); else data[0] = 0; msiobj_release( &rec->hdr ); return data; } msiobj_release( &rec->hdr ); data = NULL; return data; }