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"
45 #include "wine/unicode.h"
48 WINE_DEFAULT_DEBUG_CHANNEL(msi);
50 extern const WCHAR szInstallFiles[];
51 extern const WCHAR szDuplicateFiles[];
52 extern const WCHAR szMoveFiles[];
53 extern const WCHAR szPatchFiles[];
54 extern const WCHAR szRemoveDuplicateFiles[];
55 extern const WCHAR szRemoveFiles[];
57 static const WCHAR cszTempFolder[]= {'T','e','m','p','F','o','l','d','e','r',0};
61 * This is a helper function for handling embedded cabinet media
63 static UINT writeout_cabinet_stream(MSIPACKAGE *package, LPCWSTR stream_name,
73 rc = read_raw_stream_data(package->db,stream_name,&data,&size);
74 if (rc != ERROR_SUCCESS)
78 if (MSI_GetPropertyW(package, cszTempFolder, tmp, &write))
79 GetTempPathW(MAX_PATH,tmp);
81 GetTempFileNameW(tmp,stream_name,0,source);
83 track_tempfile(package,strrchrW(source,'\\'), source);
84 the_file = CreateFileW(source, GENERIC_WRITE, 0, NULL, CREATE_ALWAYS,
85 FILE_ATTRIBUTE_NORMAL, NULL);
87 if (the_file == INVALID_HANDLE_VALUE)
89 ERR("Unable to create file %s\n",debugstr_w(source));
90 rc = ERROR_FUNCTION_FAILED;
94 WriteFile(the_file,data,size,&write,NULL);
95 CloseHandle(the_file);
96 TRACE("wrote %li bytes to %s\n",write,debugstr_w(source));
103 /* Support functions for FDI functions */
110 static void * cabinet_alloc(ULONG cb)
112 return msi_alloc(cb);
115 static void cabinet_free(void *pv)
120 static INT_PTR cabinet_open(char *pszFile, int oflag, int pmode)
124 DWORD dwShareMode = 0;
125 DWORD dwCreateDisposition = OPEN_EXISTING;
126 switch (oflag & _O_ACCMODE)
129 dwAccess = GENERIC_READ;
130 dwShareMode = FILE_SHARE_READ | FILE_SHARE_DELETE;
133 dwAccess = GENERIC_WRITE;
134 dwShareMode = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE;
137 dwAccess = GENERIC_READ | GENERIC_WRITE;
138 dwShareMode = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE;
141 if ((oflag & (_O_CREAT | _O_EXCL)) == (_O_CREAT | _O_EXCL))
142 dwCreateDisposition = CREATE_NEW;
143 else if (oflag & _O_CREAT)
144 dwCreateDisposition = CREATE_ALWAYS;
145 handle = CreateFileA( pszFile, dwAccess, dwShareMode, NULL,
146 dwCreateDisposition, 0, NULL );
147 if (handle == INVALID_HANDLE_VALUE)
149 return (INT_PTR) handle;
152 static UINT cabinet_read(INT_PTR hf, void *pv, UINT cb)
154 HANDLE handle = (HANDLE) hf;
156 if (ReadFile(handle, pv, cb, &dwRead, NULL))
161 static UINT cabinet_write(INT_PTR hf, void *pv, UINT cb)
163 HANDLE handle = (HANDLE) hf;
165 if (WriteFile(handle, pv, cb, &dwWritten, NULL))
170 static int cabinet_close(INT_PTR hf)
172 HANDLE handle = (HANDLE) hf;
173 return CloseHandle(handle) ? 0 : -1;
176 static long cabinet_seek(INT_PTR hf, long dist, int seektype)
178 HANDLE handle = (HANDLE) hf;
179 /* flags are compatible and so are passed straight through */
180 return SetFilePointer(handle, dist, NULL, seektype);
183 static void msi_file_update_ui( MSIPACKAGE *package, MSIFILE *f, const WCHAR *action )
189 uirow = MSI_CreateRecord( 9 );
190 MSI_RecordSetStringW( uirow, 1, f->FileName );
191 uipath = strdupW( f->TargetPath );
192 p = strrchrW(uipath,'\\');
195 MSI_RecordSetStringW( uirow, 9, uipath);
196 MSI_RecordSetInteger( uirow, 6, f->FileSize );
197 ui_actiondata( package, action, uirow);
198 msiobj_release( &uirow->hdr );
200 ui_progress( package, 2, f->FileSize, 0, 0);
203 static INT_PTR cabinet_notify(FDINOTIFICATIONTYPE fdint, PFDINOTIFICATION pfdin)
209 CabData *data = (CabData*) pfdin->pv;
215 file = strdupAtoW(pfdin->psz1);
216 f = get_loaded_file(data->package, file);
221 WARN("unknown file in cabinet (%s)\n",debugstr_a(pfdin->psz1));
225 if (f->state != msifs_missing && f->state != msifs_overwrite)
227 TRACE("Skipping extraction of %s\n",debugstr_a(pfdin->psz1));
231 msi_file_update_ui( data->package, f, szInstallFiles );
233 TRACE("extracting %s\n", debugstr_w(f->TargetPath) );
235 attrs = f->Attributes & (FILE_ATTRIBUTE_READONLY|FILE_ATTRIBUTE_HIDDEN|FILE_ATTRIBUTE_SYSTEM);
236 if (!attrs) attrs = FILE_ATTRIBUTE_NORMAL;
238 handle = CreateFileW( f->TargetPath, GENERIC_READ | GENERIC_WRITE, 0,
239 NULL, CREATE_ALWAYS, attrs, NULL );
240 if ( handle == INVALID_HANDLE_VALUE )
242 ERR("failed to create %s (error %ld)\n",
243 debugstr_w( f->TargetPath ), GetLastError() );
247 f->state = msifs_installed;
248 return (INT_PTR) handle;
250 case fdintCLOSE_FILE_INFO:
254 HANDLE handle = (HANDLE) pfdin->hf;
256 if (!DosDateTimeToFileTime(pfdin->date, pfdin->time, &ft))
258 if (!LocalFileTimeToFileTime(&ft, &ftLocal))
260 if (!SetFileTime(handle, &ftLocal, 0, &ftLocal))
270 /***********************************************************************
271 * extract_cabinet_file
273 * Extract files from a cab file.
275 static BOOL extract_cabinet_file(MSIPACKAGE* package, LPCWSTR source,
285 TRACE("Extracting %s to %s\n",debugstr_w(source), debugstr_w(path));
287 hfdi = FDICreate(cabinet_alloc,
298 ERR("FDICreate failed\n");
302 if (!(cabinet = strdupWtoA( source )))
307 if (!(cab_path = strdupWtoA( path )))
314 data.package = package;
315 data.cab_path = cab_path;
317 ret = FDICopy(hfdi, cabinet, "", 0, cabinet_notify, NULL, &data);
320 ERR("FDICopy failed\n");
330 static VOID set_file_source(MSIPACKAGE* package, MSIFILE* file, MSICOMPONENT*
333 if (file->Attributes & msidbFileAttributesNoncompressed)
336 p = resolve_folder(package, comp->Directory, TRUE, FALSE, NULL);
337 path = build_directory_name(2, p, file->ShortName);
338 if (INVALID_FILE_ATTRIBUTES == GetFileAttributesW( path ))
341 path = build_directory_name(2, p, file->LongName);
343 file->SourcePath = path;
347 file->SourcePath = build_directory_name(2, path, file->File);
355 WCHAR source[MAX_PATH];
358 static struct media_info *create_media_info( void )
360 struct media_info *mi;
362 mi = msi_alloc( sizeof *mi );
365 mi->last_sequence = 0;
366 mi->last_volume = NULL;
367 mi->last_path = NULL;
375 static void free_media_info( struct media_info *mi )
377 msi_free( mi->last_path );
381 static UINT ready_media_for_file( MSIPACKAGE *package, struct media_info *mi,
384 UINT rc = ERROR_SUCCESS;
386 static const WCHAR ExecSeqQuery[] =
387 {'S','E','L','E','C','T',' ','*',' ', 'F','R','O','M',' ',
388 '`','M','e','d','i','a','`',' ','W','H','E','R','E',' ',
389 '`','L','a','s','t','S','e','q','u','e','n','c','e','`',' ','>','=',
390 ' ','%', 'i',' ','O','R','D','E','R',' ','B','Y',' ',
391 '`','L','a','s','t','S','e','q','u','e','n','c','e','`',0};
396 MSICOMPONENT *comp = file->Component;
398 if (file->Sequence <= mi->last_sequence)
400 set_file_source(package,file,comp,mi->last_path);
401 TRACE("Media already ready (%u, %u)\n",file->Sequence,mi->last_sequence);
402 return ERROR_SUCCESS;
406 row = MSI_QueryGetRecord(package->db, ExecSeqQuery, file->Sequence);
409 TRACE("Unable to query row\n");
410 return ERROR_FUNCTION_FAILED;
413 seq = MSI_RecordGetInteger(row,2);
414 mi->last_sequence = seq;
416 volume = MSI_RecordGetString(row, 5);
417 prompt = MSI_RecordGetString(row, 3);
419 msi_free(mi->last_path);
420 mi->last_path = NULL;
422 if (file->Attributes & msidbFileAttributesNoncompressed)
424 mi->last_path = resolve_folder(package, comp->Directory, TRUE, FALSE, NULL);
425 set_file_source(package,file,comp,mi->last_path);
427 MsiSourceListAddMediaDiskW(package->ProductCode, NULL,
428 MSIINSTALLCONTEXT_USERMANAGED, MSICODE_PRODUCT, mi->count, volume,
431 MsiSourceListSetInfoW(package->ProductCode, NULL,
432 MSIINSTALLCONTEXT_USERMANAGED,
433 MSICODE_PRODUCT|MSISOURCETYPE_MEDIA,
434 INSTALLPROPERTY_LASTUSEDSOURCEW, mi->last_path);
435 msiobj_release(&row->hdr);
439 cab = MSI_RecordGetString(row,4);
442 TRACE("Source is CAB %s\n",debugstr_w(cab));
443 /* the stream does not contain the # character */
448 writeout_cabinet_stream(package,&cab[1],mi->source);
449 mi->last_path = strdupW(mi->source);
450 *(strrchrW(mi->last_path,'\\')+1)=0;
452 path = msi_dup_property( package, cszSourceDir );
454 MsiSourceListAddMediaDiskW(package->ProductCode, NULL,
455 MSIINSTALLCONTEXT_USERMANAGED, MSICODE_PRODUCT, mi->count,
458 MsiSourceListSetInfoW(package->ProductCode, NULL,
459 MSIINSTALLCONTEXT_USERMANAGED,
460 MSICODE_PRODUCT|MSISOURCETYPE_NETWORK,
461 INSTALLPROPERTY_LASTUSEDSOURCEW, path);
468 mi->last_path = msi_alloc(MAX_PATH*sizeof(WCHAR));
469 if (MSI_GetPropertyW(package, cszSourceDir, mi->source, &sz))
471 ERR("No Source dir defined\n");
472 rc = ERROR_FUNCTION_FAILED;
476 strcpyW(mi->last_path,mi->source);
477 strcatW(mi->source,cab);
479 MsiSourceListSetInfoW(package->ProductCode, NULL,
480 MSIINSTALLCONTEXT_USERMANAGED,
481 MSICODE_PRODUCT|MSISOURCETYPE_MEDIA,
482 INSTALLPROPERTY_LASTUSEDSOURCEW, mi->last_path);
484 /* extract the cab file into a folder in the temp folder */
486 if (MSI_GetPropertyW(package, cszTempFolder,mi->last_path, &sz)
488 GetTempPathW(MAX_PATH,mi->last_path);
491 rc = !extract_cabinet_file(package, mi->source, mi->last_path);
496 mi->last_path = msi_alloc(MAX_PATH*sizeof(WCHAR));
497 MSI_GetPropertyW(package,cszSourceDir,mi->source,&sz);
498 strcpyW(mi->last_path,mi->source);
500 MsiSourceListSetInfoW(package->ProductCode, NULL,
501 MSIINSTALLCONTEXT_USERMANAGED,
502 MSICODE_PRODUCT|MSISOURCETYPE_MEDIA,
503 INSTALLPROPERTY_LASTUSEDSOURCEW, mi->last_path);
505 set_file_source(package, file, comp, mi->last_path);
507 MsiSourceListAddMediaDiskW(package->ProductCode, NULL,
508 MSIINSTALLCONTEXT_USERMANAGED, MSICODE_PRODUCT, mi->count, volume,
511 msiobj_release(&row->hdr);
516 static UINT get_file_target(MSIPACKAGE *package, LPCWSTR file_key,
519 LIST_FOR_EACH_ENTRY( *file, &package->files, MSIFILE, entry )
521 if (lstrcmpW( file_key, (*file)->File )==0)
523 if ((*file)->state >= msifs_overwrite)
524 return ERROR_SUCCESS;
526 return ERROR_FILE_NOT_FOUND;
530 return ERROR_FUNCTION_FAILED;
534 * ACTION_InstallFiles()
536 * For efficiency, this is done in two passes:
537 * 1) Correct all the TargetPaths and determine what files are to be installed.
538 * 2) Extract Cabinets and copy files.
540 UINT ACTION_InstallFiles(MSIPACKAGE *package)
542 struct media_info *mi;
543 UINT rc = ERROR_SUCCESS;
547 /* increment progress bar each time action data is sent */
548 ui_progress(package,1,1,0,0);
550 /* handle the keys for the SourceList */
551 ptr = strrchrW(package->PackagePath,'\\');
555 MsiSourceListSetInfoW(package->ProductCode, NULL,
556 MSIINSTALLCONTEXT_USERMANAGED,
558 INSTALLPROPERTY_PACKAGENAMEW, ptr);
560 /* FIXME("Write DiskPrompt\n"); */
563 LIST_FOR_EACH_ENTRY( file, &package->files, MSIFILE, entry )
565 if (!ACTION_VerifyComponentForAction( file->Component, INSTALLSTATE_LOCAL ))
567 ui_progress(package,2,file->FileSize,0,0);
568 TRACE("File %s is not scheduled for install\n",
569 debugstr_w(file->File));
571 file->state = msifs_skipped;
576 * Despite MSDN specifying that the CreateFolders action
577 * should be called before InstallFiles, some installers don't
578 * do that, and they seem to work correctly. We need to create
579 * directories here to make sure that the files can be copied.
581 msi_create_component_directories( package );
583 mi = create_media_info();
586 LIST_FOR_EACH_ENTRY( file, &package->files, MSIFILE, entry )
588 if (file->state != msifs_missing && file->state != msifs_overwrite)
591 TRACE("Pass 2: %s\n",debugstr_w(file->File));
593 rc = ready_media_for_file( package, mi, file );
594 if (rc != ERROR_SUCCESS)
596 ERR("Unable to ready media\n");
597 rc = ERROR_FUNCTION_FAILED;
601 TRACE("file paths %s to %s\n",debugstr_w(file->SourcePath),
602 debugstr_w(file->TargetPath));
604 if (file->state != msifs_missing && file->state != msifs_overwrite)
607 /* compressed files are extracted in ready_media_for_file */
608 if (~file->Attributes & msidbFileAttributesNoncompressed)
610 if (INVALID_FILE_ATTRIBUTES == GetFileAttributesW(file->TargetPath))
611 ERR("compressed file wasn't extracted (%s)\n",
612 debugstr_w(file->TargetPath));
616 rc = CopyFileW(file->SourcePath,file->TargetPath,FALSE);
620 ERR("Unable to copy file (%s -> %s) (error %d)\n",
621 debugstr_w(file->SourcePath), debugstr_w(file->TargetPath), rc);
622 if (rc == ERROR_ALREADY_EXISTS && file->state == msifs_overwrite)
626 else if (rc == ERROR_FILE_NOT_FOUND)
628 ERR("Source File Not Found! Continuing\n");
631 else if (file->Attributes & msidbFileAttributesVital)
633 ERR("Ignoring Error and continuing (nonvital file)...\n");
639 file->state = msifs_installed;
645 free_media_info( mi );
649 static UINT ITERATE_DuplicateFiles(MSIRECORD *row, LPVOID param)
651 MSIPACKAGE *package = (MSIPACKAGE*)param;
652 WCHAR dest_name[0x100];
653 LPWSTR dest_path, dest;
654 LPCWSTR file_key, component;
660 component = MSI_RecordGetString(row,2);
661 comp = get_loaded_component(package,component);
663 if (!ACTION_VerifyComponentForAction( comp, INSTALLSTATE_LOCAL ))
665 TRACE("Skipping copy due to disabled component %s\n",
666 debugstr_w(component));
668 /* the action taken was the same as the current install state */
669 comp->Action = comp->Installed;
671 return ERROR_SUCCESS;
674 comp->Action = INSTALLSTATE_LOCAL;
676 file_key = MSI_RecordGetString(row,3);
679 ERR("Unable to get file key\n");
680 return ERROR_FUNCTION_FAILED;
683 rc = get_file_target(package,file_key,&file);
685 if (rc != ERROR_SUCCESS)
687 ERR("Original file unknown %s\n",debugstr_w(file_key));
688 return ERROR_SUCCESS;
691 if (MSI_RecordIsNull(row,4))
692 strcpyW(dest_name,strrchrW(file->TargetPath,'\\')+1);
696 MSI_RecordGetStringW(row,4,dest_name,&sz);
697 reduce_to_longfilename(dest_name);
700 if (MSI_RecordIsNull(row,5))
703 dest_path = strdupW(file->TargetPath);
704 p = strrchrW(dest_path,'\\');
711 destkey = MSI_RecordGetString(row,5);
712 dest_path = resolve_folder(package, destkey, FALSE,FALSE,NULL);
716 dest_path = msi_dup_property( package, destkey );
719 FIXME("Unable to get destination folder, try AppSearch properties\n");
720 return ERROR_SUCCESS;
725 dest = build_directory_name(2, dest_path, dest_name);
727 TRACE("Duplicating file %s to %s\n",debugstr_w(file->TargetPath),
730 if (strcmpW(file->TargetPath,dest))
731 rc = !CopyFileW(file->TargetPath,dest,TRUE);
735 if (rc != ERROR_SUCCESS)
736 ERR("Failed to copy file %s -> %s, last error %ld\n",
737 debugstr_w(file->TargetPath), debugstr_w(dest_path), GetLastError());
739 FIXME("We should track these duplicate files as well\n");
744 msi_file_update_ui(package, file, szDuplicateFiles);
746 return ERROR_SUCCESS;
749 UINT ACTION_DuplicateFiles(MSIPACKAGE *package)
753 static const WCHAR ExecSeqQuery[] =
754 {'S','E','L','E','C','T',' ','*',' ','F','R','O','M',' ',
755 '`','D','u','p','l','i','c','a','t','e','F','i','l','e','`',0};
757 rc = MSI_DatabaseOpenViewW(package->db, ExecSeqQuery, &view);
758 if (rc != ERROR_SUCCESS)
759 return ERROR_SUCCESS;
761 rc = MSI_IterateRecords(view, NULL, ITERATE_DuplicateFiles, package);
762 msiobj_release(&view->hdr);
767 UINT ACTION_RemoveFiles( MSIPACKAGE *package )
771 LIST_FOR_EACH_ENTRY( file, &package->files, MSIFILE, entry )
776 if ( !file->Component )
778 if ( file->Component->Installed == INSTALLSTATE_LOCAL )
781 if ( file->state == msifs_installed )
782 ERR("removing installed file %s\n", debugstr_w(file->TargetPath));
784 if ( file->state != msifs_present )
787 TRACE("removing %s\n", debugstr_w(file->File) );
788 if ( !DeleteFileW( file->TargetPath ) )
789 ERR("failed to delete %s\n", debugstr_w(file->TargetPath) );
790 file->state = msifs_missing;
793 uirow = MSI_CreateRecord( 9 );
794 MSI_RecordSetStringW( uirow, 1, file->FileName );
795 uipath = strdupW( file->TargetPath );
796 p = strrchrW(uipath,'\\');
799 MSI_RecordSetStringW( uirow, 9, uipath);
800 ui_actiondata( package, szRemoveFiles, uirow);
801 msiobj_release( &uirow->hdr );
803 /* FIXME: call ui_progress here? */
806 return ERROR_SUCCESS;