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
23 * Actions dealing with files These are
29 * RemoveDuplicateFiles(TODO)
38 #include "wine/debug.h"
42 #include "msvcrt/fcntl.h"
47 #include "wine/unicode.h"
49 WINE_DEFAULT_DEBUG_CHANNEL(msi);
51 extern const WCHAR szInstallFiles[];
52 extern const WCHAR szDuplicateFiles[];
53 extern const WCHAR szMoveFiles[];
54 extern const WCHAR szPatchFiles[];
55 extern const WCHAR szRemoveDuplicateFiles[];
56 extern const WCHAR szRemoveFiles[];
58 static const WCHAR cszTempFolder[]= {'T','e','m','p','F','o','l','d','e','r',0};
67 WCHAR source[MAX_PATH];
70 static UINT msi_change_media( MSIPACKAGE *package, struct media_info *mi )
73 LPWSTR error, error_dialog;
74 UINT r = ERROR_SUCCESS;
76 static const WCHAR szUILevel[] = {'U','I','L','e','v','e','l',0};
77 static const WCHAR error_prop[] = {'E','r','r','o','r','D','i','a','l','o','g',0};
79 if ( msi_get_property_int(package, szUILevel, 0) == INSTALLUILEVEL_NONE && !gUIHandlerA )
82 error = generate_error_string( package, 1302, 1, mi->disk_prompt );
83 error_dialog = msi_dup_property( package, error_prop );
85 while ( r == ERROR_SUCCESS && GetFileAttributesW( mi->source ) == INVALID_FILE_ATTRIBUTES )
87 r = msi_spawn_error_dialog( package, error_dialog, error );
91 msg = strdupWtoA( error );
92 gUIHandlerA( gUIContext, MB_RETRYCANCEL | INSTALLMESSAGE_ERROR, msg );
98 msi_free( error_dialog );
104 * This is a helper function for handling embedded cabinet media
106 static UINT writeout_cabinet_stream(MSIPACKAGE *package, LPCWSTR stream_name,
116 rc = read_raw_stream_data(package->db,stream_name,&data,&size);
117 if (rc != ERROR_SUCCESS)
121 if (MSI_GetPropertyW(package, cszTempFolder, tmp, &write))
122 GetTempPathW(MAX_PATH,tmp);
124 GetTempFileNameW(tmp,stream_name,0,source);
126 track_tempfile(package, source);
127 the_file = CreateFileW(source, GENERIC_WRITE, 0, NULL, CREATE_ALWAYS,
128 FILE_ATTRIBUTE_NORMAL, NULL);
130 if (the_file == INVALID_HANDLE_VALUE)
132 ERR("Unable to create file %s\n",debugstr_w(source));
133 rc = ERROR_FUNCTION_FAILED;
137 WriteFile(the_file,data,size,&write,NULL);
138 CloseHandle(the_file);
139 TRACE("wrote %i bytes to %s\n",write,debugstr_w(source));
146 /* Support functions for FDI functions */
150 struct media_info *mi;
153 static void * cabinet_alloc(ULONG cb)
155 return msi_alloc(cb);
158 static void cabinet_free(void *pv)
163 static INT_PTR cabinet_open(char *pszFile, int oflag, int pmode)
167 DWORD dwShareMode = 0;
168 DWORD dwCreateDisposition = OPEN_EXISTING;
169 switch (oflag & _O_ACCMODE)
172 dwAccess = GENERIC_READ;
173 dwShareMode = FILE_SHARE_READ | FILE_SHARE_DELETE;
176 dwAccess = GENERIC_WRITE;
177 dwShareMode = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE;
180 dwAccess = GENERIC_READ | GENERIC_WRITE;
181 dwShareMode = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE;
184 if ((oflag & (_O_CREAT | _O_EXCL)) == (_O_CREAT | _O_EXCL))
185 dwCreateDisposition = CREATE_NEW;
186 else if (oflag & _O_CREAT)
187 dwCreateDisposition = CREATE_ALWAYS;
188 handle = CreateFileA( pszFile, dwAccess, dwShareMode, NULL,
189 dwCreateDisposition, 0, NULL );
190 if (handle == INVALID_HANDLE_VALUE)
192 return (INT_PTR) handle;
195 static UINT cabinet_read(INT_PTR hf, void *pv, UINT cb)
197 HANDLE handle = (HANDLE) hf;
199 if (ReadFile(handle, pv, cb, &dwRead, NULL))
204 static UINT cabinet_write(INT_PTR hf, void *pv, UINT cb)
206 HANDLE handle = (HANDLE) hf;
208 if (WriteFile(handle, pv, cb, &dwWritten, NULL))
213 static int cabinet_close(INT_PTR hf)
215 HANDLE handle = (HANDLE) hf;
216 return CloseHandle(handle) ? 0 : -1;
219 static long cabinet_seek(INT_PTR hf, long dist, int seektype)
221 HANDLE handle = (HANDLE) hf;
222 /* flags are compatible and so are passed straight through */
223 return SetFilePointer(handle, dist, NULL, seektype);
226 static void msi_file_update_ui( MSIPACKAGE *package, MSIFILE *f, const WCHAR *action )
232 uirow = MSI_CreateRecord( 9 );
233 MSI_RecordSetStringW( uirow, 1, f->FileName );
234 uipath = strdupW( f->TargetPath );
235 p = strrchrW(uipath,'\\');
238 MSI_RecordSetStringW( uirow, 9, uipath);
239 MSI_RecordSetInteger( uirow, 6, f->FileSize );
240 ui_actiondata( package, action, uirow);
241 msiobj_release( &uirow->hdr );
243 ui_progress( package, 2, f->FileSize, 0, 0);
246 static UINT msi_media_get_disk_info( CabData *data )
248 MSIPACKAGE *package = data->package;
252 static const WCHAR query[] =
253 {'S','E','L','E','C','T',' ','*',' ', 'F','R','O','M',' ',
254 '`','M','e','d','i','a','`',' ','W','H','E','R','E',' ',
255 '`','D','i','s','k','I','d','`',' ','=',' ','%','i',0};
257 row = MSI_QueryGetRecord(package->db, query, data->mi->disk_id);
260 TRACE("Unable to query row\n");
261 return ERROR_FUNCTION_FAILED;
264 data->mi->disk_prompt = strdupW(MSI_RecordGetString(row, 3));
265 data->mi->cabinet = strdupW(MSI_RecordGetString(row, 4));
267 ptr = strrchrW(data->mi->source, '\\') + 1;
268 lstrcpyW(ptr, data->mi->cabinet);
269 msiobj_release(&row->hdr);
271 return ERROR_SUCCESS;
274 static INT_PTR cabinet_notify(FDINOTIFICATIONTYPE fdint, PFDINOTIFICATION pfdin)
276 TRACE("(%d)\n", fdint);
280 case fdintPARTIAL_FILE:
282 CabData *data = (CabData *)pfdin->pv;
283 data->mi->is_continuous = FALSE;
286 case fdintNEXT_CABINET:
288 CabData *data = (CabData *)pfdin->pv;
289 struct media_info *mi = data->mi;
290 LPWSTR cab = strdupAtoW(pfdin->psz1);
293 msi_free(mi->disk_prompt);
296 mi->is_continuous = TRUE;
298 rc = msi_media_get_disk_info(data);
299 if (rc != ERROR_SUCCESS)
301 ERR("Failed to get next cabinet information: %d\n", rc);
305 if (lstrcmpiW(mi->cabinet, cab))
308 ERR("Continuous cabinet does not match the next cabinet in the Media table\n");
314 TRACE("Searching for %s\n", debugstr_w(mi->source));
316 if (GetFileAttributesW(mi->source) == INVALID_FILE_ATTRIBUTES)
317 rc = msi_change_media(data->package, mi);
319 if (rc != ERROR_SUCCESS)
326 CabData *data = (CabData*) pfdin->pv;
332 file = strdupAtoW(pfdin->psz1);
333 f = get_loaded_file(data->package, file);
338 WARN("unknown file in cabinet (%s)\n",debugstr_a(pfdin->psz1));
342 if (f->state != msifs_missing && f->state != msifs_overwrite)
344 TRACE("Skipping extraction of %s\n",debugstr_a(pfdin->psz1));
348 msi_file_update_ui( data->package, f, szInstallFiles );
350 TRACE("extracting %s\n", debugstr_w(f->TargetPath) );
352 attrs = f->Attributes & (FILE_ATTRIBUTE_READONLY|FILE_ATTRIBUTE_HIDDEN|FILE_ATTRIBUTE_SYSTEM);
353 if (!attrs) attrs = FILE_ATTRIBUTE_NORMAL;
355 handle = CreateFileW( f->TargetPath, GENERIC_READ | GENERIC_WRITE, 0,
356 NULL, CREATE_ALWAYS, attrs, NULL );
357 if ( handle == INVALID_HANDLE_VALUE )
359 ERR("failed to create %s (error %d)\n",
360 debugstr_w( f->TargetPath ), GetLastError() );
364 f->state = msifs_installed;
365 return (INT_PTR) handle;
367 case fdintCLOSE_FILE_INFO:
371 HANDLE handle = (HANDLE) pfdin->hf;
373 if (!DosDateTimeToFileTime(pfdin->date, pfdin->time, &ft))
375 if (!LocalFileTimeToFileTime(&ft, &ftLocal))
377 if (!SetFileTime(handle, &ftLocal, 0, &ftLocal))
387 /***********************************************************************
388 * extract_cabinet_file
390 * Extract files from a cab file.
392 static BOOL extract_cabinet_file(MSIPACKAGE* package, struct media_info *mi)
394 LPSTR cabinet, cab_path = NULL;
401 TRACE("Extracting %s\n", debugstr_w(mi->source));
403 hfdi = FDICreate(cabinet_alloc, cabinet_free, cabinet_open, cabinet_read,
404 cabinet_write, cabinet_close, cabinet_seek, 0, &erf);
407 ERR("FDICreate failed\n");
411 ptr = strrchrW(mi->source, '\\') + 1;
412 cabinet = strdupWtoA(ptr);
416 cab_path = strdupWtoA(mi->source);
420 cab_path[ptr - mi->source] = '\0';
422 data.package = package;
425 ret = FDICopy(hfdi, cabinet, cab_path, 0, cabinet_notify, NULL, &data);
427 ERR("FDICopy failed\n");
437 static VOID set_file_source(MSIPACKAGE* package, MSIFILE* file, LPCWSTR path)
439 if (!file->IsCompressed)
442 p = resolve_folder(package, file->Component->Directory, TRUE, FALSE, NULL);
443 path = build_directory_name(2, p, file->ShortName);
444 if (INVALID_FILE_ATTRIBUTES == GetFileAttributesW( path ))
447 path = build_directory_name(2, p, file->LongName);
449 file->SourcePath = path;
453 file->SourcePath = build_directory_name(2, path, file->File);
456 static void free_media_info( struct media_info *mi )
458 msi_free( mi->disk_prompt );
459 msi_free( mi->cabinet );
460 msi_free( mi->volume_label );
464 static UINT download_remote_cabinet(MSIPACKAGE *package, struct media_info *mi)
466 WCHAR temppath[MAX_PATH];
470 src = strdupW(package->BaseURL);
472 return ERROR_OUTOFMEMORY;
474 ptr = strrchrW(src, '/');
478 return ERROR_FUNCTION_FAILED;
482 ptr = strrchrW(mi->source, '\\');
483 src = msi_realloc(src, (lstrlenW(src) + lstrlenW(ptr)) * sizeof(WCHAR));
485 return ERROR_OUTOFMEMORY;
487 lstrcatW(src, ptr + 1);
490 cab = msi_download_file(src, temppath);
491 lstrcpyW(mi->source, cab);
494 return ERROR_SUCCESS;
497 static UINT load_media_info(MSIPACKAGE *package, MSIFILE *file, struct media_info *mi)
503 static const WCHAR query[] = {
504 'S','E','L','E','C','T',' ','*',' ', 'F','R','O','M',' ',
505 '`','M','e','d','i','a','`',' ','W','H','E','R','E',' ',
506 '`','L','a','s','t','S','e','q','u','e','n','c','e','`',' ','>','=',
507 ' ','%','i',' ','A','N','D',' ','`','D','i','s','k','I','d','`',' ','>','=',
508 ' ','%','i',' ','O','R','D','E','R',' ','B','Y',' ',
509 '`','D','i','s','k','I','d','`',0
512 row = MSI_QueryGetRecord(package->db, query, file->Sequence, mi->disk_id);
515 TRACE("Unable to query row\n");
516 return ERROR_FUNCTION_FAILED;
519 mi->disk_id = MSI_RecordGetInteger(row, 1);
520 mi->last_sequence = MSI_RecordGetInteger(row, 2);
521 mi->disk_prompt = strdupW(MSI_RecordGetString(row, 3));
522 mi->cabinet = strdupW(MSI_RecordGetString(row, 4));
523 mi->volume_label = strdupW(MSI_RecordGetString(row, 5));
524 msiobj_release(&row->hdr);
526 source_dir = msi_dup_property(package, cszSourceDir);
528 if (mi->cabinet && mi->cabinet[0] == '#')
530 r = writeout_cabinet_stream(package, &mi->cabinet[1], mi->source);
531 if (r != ERROR_SUCCESS)
533 ERR("Failed to extract cabinet stream\n");
534 return ERROR_FUNCTION_FAILED;
539 lstrcpyW(mi->source, source_dir);
543 lstrcatW(mi->source, mi->cabinet);
546 MsiSourceListAddMediaDiskW(package->ProductCode, NULL,
547 MSIINSTALLCONTEXT_USERMANAGED, MSICODE_PRODUCT,
548 mi->disk_id, mi->volume_label, mi->disk_prompt);
550 MsiSourceListSetInfoW(package->ProductCode, NULL,
551 MSIINSTALLCONTEXT_USERMANAGED,
552 MSICODE_PRODUCT | MSISOURCETYPE_MEDIA,
553 INSTALLPROPERTY_LASTUSEDSOURCEW, mi->source);
555 msi_free(source_dir);
556 return ERROR_SUCCESS;
559 static UINT ready_media(MSIPACKAGE *package, MSIFILE *file, struct media_info *mi)
561 UINT rc = ERROR_SUCCESS;
564 /* media info for continuous cabinet is already loaded */
565 if (mi->is_continuous)
566 return ERROR_SUCCESS;
568 rc = load_media_info(package, file, mi);
569 if (rc != ERROR_SUCCESS)
571 ERR("Unable to load media info\n");
572 return ERROR_FUNCTION_FAILED;
575 if (file->IsCompressed &&
576 GetFileAttributesW(mi->source) == INVALID_FILE_ATTRIBUTES)
578 if (package->BaseURL && UrlIsW(package->BaseURL, URLIS_URL))
580 rc = download_remote_cabinet(package, mi);
581 if (rc == ERROR_SUCCESS &&
582 GetFileAttributesW(mi->source) != INVALID_FILE_ATTRIBUTES)
589 rc = msi_change_media(package, mi);
595 static UINT get_file_target(MSIPACKAGE *package, LPCWSTR file_key,
598 LIST_FOR_EACH_ENTRY( *file, &package->files, MSIFILE, entry )
600 if (lstrcmpW( file_key, (*file)->File )==0)
602 if ((*file)->state >= msifs_overwrite)
603 return ERROR_SUCCESS;
605 return ERROR_FILE_NOT_FOUND;
609 return ERROR_FUNCTION_FAILED;
612 static void schedule_install_files(MSIPACKAGE *package)
616 LIST_FOR_EACH_ENTRY(file, &package->files, MSIFILE, entry)
618 if (!ACTION_VerifyComponentForAction(file->Component, INSTALLSTATE_LOCAL))
620 TRACE("File %s is not scheduled for install\n", debugstr_w(file->File));
622 ui_progress(package,2,file->FileSize,0,0);
623 file->state = msifs_skipped;
628 static UINT copy_install_file(MSIFILE *file)
633 TRACE("Copying %s to %s\n", debugstr_w(file->SourcePath),
634 debugstr_w(file->TargetPath));
636 ret = CopyFileW(file->SourcePath, file->TargetPath, FALSE);
639 file->state = msifs_installed;
640 return ERROR_SUCCESS;
643 gle = GetLastError();
644 if (gle == ERROR_ALREADY_EXISTS && file->state == msifs_overwrite)
646 TRACE("overwriting existing file\n");
649 else if (gle == ERROR_FILE_NOT_FOUND)
651 /* FIXME: this needs to be tested, I'm pretty sure it fails */
652 TRACE("Source file not found\n");
655 else if (!(file->Attributes & msidbFileAttributesVital))
657 TRACE("Ignoring error for nonvital\n");
665 * ACTION_InstallFiles()
667 * For efficiency, this is done in two passes:
668 * 1) Correct all the TargetPaths and determine what files are to be installed.
669 * 2) Extract Cabinets and copy files.
671 UINT ACTION_InstallFiles(MSIPACKAGE *package)
673 struct media_info *mi;
674 UINT rc = ERROR_SUCCESS;
678 /* increment progress bar each time action data is sent */
679 ui_progress(package,1,1,0,0);
681 /* handle the keys for the SourceList */
682 ptr = strrchrW(package->PackagePath,'\\');
686 MsiSourceListSetInfoW(package->ProductCode, NULL,
687 MSIINSTALLCONTEXT_USERMANAGED,
689 INSTALLPROPERTY_PACKAGENAMEW, ptr);
692 schedule_install_files(package);
695 * Despite MSDN specifying that the CreateFolders action
696 * should be called before InstallFiles, some installers don't
697 * do that, and they seem to work correctly. We need to create
698 * directories here to make sure that the files can be copied.
700 msi_create_component_directories( package );
702 mi = msi_alloc_zero( sizeof(struct media_info) );
704 LIST_FOR_EACH_ENTRY( file, &package->files, MSIFILE, entry )
706 if (file->state != msifs_missing && file->state != msifs_overwrite)
709 if (file->Sequence > mi->last_sequence || mi->is_continuous)
711 rc = ready_media(package, file, mi);
712 if (rc != ERROR_SUCCESS)
714 ERR("Failed to ready media\n");
715 rc = ERROR_FUNCTION_FAILED;
719 if (file->IsCompressed && !extract_cabinet_file(package, mi))
721 ERR("Failed to extract cabinet: %s\n", debugstr_w(mi->cabinet));
722 rc = ERROR_FUNCTION_FAILED;
727 set_file_source(package, file, mi->source);
729 TRACE("file paths %s to %s\n",debugstr_w(file->SourcePath),
730 debugstr_w(file->TargetPath));
732 if (!file->IsCompressed)
734 rc = copy_install_file(file);
735 if (rc != ERROR_SUCCESS)
737 ERR("Failed to copy %s to %s (%d)\n", debugstr_w(file->SourcePath),
738 debugstr_w(file->TargetPath), rc);
739 rc = ERROR_INSTALL_FAILURE;
743 else if (file->state != msifs_installed)
745 ERR("compressed file wasn't extracted (%s)\n", debugstr_w(file->TargetPath));
746 rc = ERROR_INSTALL_FAILURE;
751 free_media_info( mi );
755 static UINT ITERATE_DuplicateFiles(MSIRECORD *row, LPVOID param)
757 MSIPACKAGE *package = (MSIPACKAGE*)param;
758 WCHAR dest_name[0x100];
759 LPWSTR dest_path, dest;
760 LPCWSTR file_key, component;
766 component = MSI_RecordGetString(row,2);
767 comp = get_loaded_component(package,component);
769 if (!ACTION_VerifyComponentForAction( comp, INSTALLSTATE_LOCAL ))
771 TRACE("Skipping copy due to disabled component %s\n",
772 debugstr_w(component));
774 /* the action taken was the same as the current install state */
775 comp->Action = comp->Installed;
777 return ERROR_SUCCESS;
780 comp->Action = INSTALLSTATE_LOCAL;
782 file_key = MSI_RecordGetString(row,3);
785 ERR("Unable to get file key\n");
786 return ERROR_FUNCTION_FAILED;
789 rc = get_file_target(package,file_key,&file);
791 if (rc != ERROR_SUCCESS)
793 ERR("Original file unknown %s\n",debugstr_w(file_key));
794 return ERROR_SUCCESS;
797 if (MSI_RecordIsNull(row,4))
798 strcpyW(dest_name,strrchrW(file->TargetPath,'\\')+1);
802 MSI_RecordGetStringW(row,4,dest_name,&sz);
803 reduce_to_longfilename(dest_name);
806 if (MSI_RecordIsNull(row,5))
809 dest_path = strdupW(file->TargetPath);
810 p = strrchrW(dest_path,'\\');
817 destkey = MSI_RecordGetString(row,5);
818 dest_path = resolve_folder(package, destkey, FALSE,FALSE,NULL);
822 dest_path = msi_dup_property( package, destkey );
825 FIXME("Unable to get destination folder, try AppSearch properties\n");
826 return ERROR_SUCCESS;
831 dest = build_directory_name(2, dest_path, dest_name);
833 TRACE("Duplicating file %s to %s\n",debugstr_w(file->TargetPath),
836 if (strcmpW(file->TargetPath,dest))
837 rc = !CopyFileW(file->TargetPath,dest,TRUE);
841 if (rc != ERROR_SUCCESS)
842 ERR("Failed to copy file %s -> %s, last error %d\n",
843 debugstr_w(file->TargetPath), debugstr_w(dest_path), GetLastError());
845 FIXME("We should track these duplicate files as well\n");
850 msi_file_update_ui(package, file, szDuplicateFiles);
852 return ERROR_SUCCESS;
855 UINT ACTION_DuplicateFiles(MSIPACKAGE *package)
859 static const WCHAR ExecSeqQuery[] =
860 {'S','E','L','E','C','T',' ','*',' ','F','R','O','M',' ',
861 '`','D','u','p','l','i','c','a','t','e','F','i','l','e','`',0};
863 rc = MSI_DatabaseOpenViewW(package->db, ExecSeqQuery, &view);
864 if (rc != ERROR_SUCCESS)
865 return ERROR_SUCCESS;
867 rc = MSI_IterateRecords(view, NULL, ITERATE_DuplicateFiles, package);
868 msiobj_release(&view->hdr);
873 /* compares the version of a file read from the filesystem and
874 * the version specified in the File table
876 static int msi_compare_file_version( MSIFILE *file )
878 WCHAR version[MAX_PATH];
884 r = MsiGetFileVersionW( file->TargetPath, version, &size, NULL, NULL );
885 if ( r != ERROR_SUCCESS )
888 return lstrcmpW( version, file->Version );
891 UINT ACTION_RemoveFiles( MSIPACKAGE *package )
895 LIST_FOR_EACH_ENTRY( file, &package->files, MSIFILE, entry )
900 if ( !file->Component )
902 if ( file->Component->Installed == INSTALLSTATE_LOCAL )
905 if ( file->state == msifs_installed )
906 ERR("removing installed file %s\n", debugstr_w(file->TargetPath));
908 if ( file->state != msifs_present )
911 /* only remove a file if the version to be installed
912 * is strictly newer than the old file
914 if ( msi_compare_file_version( file ) >= 0 )
917 TRACE("removing %s\n", debugstr_w(file->File) );
918 if ( !DeleteFileW( file->TargetPath ) )
919 ERR("failed to delete %s\n", debugstr_w(file->TargetPath) );
920 file->state = msifs_missing;
923 uirow = MSI_CreateRecord( 9 );
924 MSI_RecordSetStringW( uirow, 1, file->FileName );
925 uipath = strdupW( file->TargetPath );
926 p = strrchrW(uipath,'\\');
929 MSI_RecordSetStringW( uirow, 9, uipath);
930 ui_actiondata( package, szRemoveFiles, uirow);
931 msiobj_release( &uirow->hdr );
933 /* FIXME: call ui_progress here? */
936 return ERROR_SUCCESS;