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;
214 file = strdupAtoW(pfdin->psz1);
215 f = get_loaded_file(data->package, file);
220 ERR("Unknown File in Cabinet (%s)\n",debugstr_a(pfdin->psz1));
224 if (f->state != msifs_missing && f->state != msifs_overwrite)
226 TRACE("Skipping extraction of %s\n",debugstr_a(pfdin->psz1));
230 msi_file_update_ui( data->package, f, szInstallFiles );
232 TRACE("extracting %s\n", debugstr_w(f->TargetPath) );
234 handle = CreateFileW( f->TargetPath, GENERIC_READ | GENERIC_WRITE, 0,
235 NULL, CREATE_NEW, FILE_ATTRIBUTE_NORMAL, NULL );
236 if ( handle == INVALID_HANDLE_VALUE )
238 ERR("failed to create %s (error %ld)\n",
239 debugstr_w( f->TargetPath ), GetLastError() );
243 f->state = msifs_installed;
244 return (INT_PTR) handle;
246 case fdintCLOSE_FILE_INFO:
250 HANDLE handle = (HANDLE) pfdin->hf;
252 if (!DosDateTimeToFileTime(pfdin->date, pfdin->time, &ft))
254 if (!LocalFileTimeToFileTime(&ft, &ftLocal))
256 if (!SetFileTime(handle, &ftLocal, 0, &ftLocal))
266 /***********************************************************************
267 * extract_cabinet_file
269 * Extract files from a cab file.
271 static BOOL extract_cabinet_file(MSIPACKAGE* package, LPCWSTR source,
281 TRACE("Extracting %s to %s\n",debugstr_w(source), debugstr_w(path));
283 hfdi = FDICreate(cabinet_alloc,
294 ERR("FDICreate failed\n");
298 if (!(cabinet = strdupWtoA( source )))
303 if (!(cab_path = strdupWtoA( path )))
310 data.package = package;
311 data.cab_path = cab_path;
313 ret = FDICopy(hfdi, cabinet, "", 0, cabinet_notify, NULL, &data);
316 ERR("FDICopy failed\n");
326 static VOID set_file_source(MSIPACKAGE* package, MSIFILE* file, MSICOMPONENT*
329 if (file->Attributes & msidbFileAttributesNoncompressed)
332 p = resolve_folder(package, comp->Directory, TRUE, FALSE, NULL);
333 path = build_directory_name(2, p, file->ShortName);
334 if (INVALID_FILE_ATTRIBUTES == GetFileAttributesW( path ))
337 path = build_directory_name(2, p, file->LongName);
339 file->SourcePath = path;
343 file->SourcePath = build_directory_name(2, path, file->File);
351 WCHAR source[MAX_PATH];
354 static struct media_info *create_media_info( void )
356 struct media_info *mi;
358 mi = msi_alloc( sizeof *mi );
361 mi->last_sequence = 0;
362 mi->last_volume = NULL;
363 mi->last_path = NULL;
371 static void free_media_info( struct media_info *mi )
373 msi_free( mi->last_path );
377 static UINT ready_media_for_file( MSIPACKAGE *package, struct media_info *mi,
380 UINT rc = ERROR_SUCCESS;
382 static const WCHAR ExecSeqQuery[] =
383 {'S','E','L','E','C','T',' ','*',' ', 'F','R','O','M',' ',
384 '`','M','e','d','i','a','`',' ','W','H','E','R','E',' ',
385 '`','L','a','s','t','S','e','q','u','e','n','c','e','`',' ','>','=',
386 ' ','%', 'i',' ','O','R','D','E','R',' ','B','Y',' ',
387 '`','L','a','s','t','S','e','q','u','e','n','c','e','`',0};
392 MSICOMPONENT *comp = file->Component;
394 if (file->Sequence <= mi->last_sequence)
396 set_file_source(package,file,comp,mi->last_path);
397 TRACE("Media already ready (%u, %u)\n",file->Sequence,mi->last_sequence);
398 return ERROR_SUCCESS;
402 row = MSI_QueryGetRecord(package->db, ExecSeqQuery, file->Sequence);
405 TRACE("Unable to query row\n");
406 return ERROR_FUNCTION_FAILED;
409 seq = MSI_RecordGetInteger(row,2);
410 mi->last_sequence = seq;
412 volume = MSI_RecordGetString(row, 5);
413 prompt = MSI_RecordGetString(row, 3);
415 msi_free(mi->last_path);
416 mi->last_path = NULL;
418 if (file->Attributes & msidbFileAttributesNoncompressed)
420 mi->last_path = resolve_folder(package, comp->Directory, TRUE, FALSE, NULL);
421 set_file_source(package,file,comp,mi->last_path);
423 MsiSourceListAddMediaDiskW(package->ProductCode, NULL,
424 MSIINSTALLCONTEXT_USERMANAGED, MSICODE_PRODUCT, mi->count, volume,
427 MsiSourceListSetInfoW(package->ProductCode, NULL,
428 MSIINSTALLCONTEXT_USERMANAGED,
429 MSICODE_PRODUCT|MSISOURCETYPE_MEDIA,
430 INSTALLPROPERTY_LASTUSEDSOURCEW, mi->last_path);
431 msiobj_release(&row->hdr);
435 cab = MSI_RecordGetString(row,4);
438 TRACE("Source is CAB %s\n",debugstr_w(cab));
439 /* the stream does not contain the # character */
444 writeout_cabinet_stream(package,&cab[1],mi->source);
445 mi->last_path = strdupW(mi->source);
446 *(strrchrW(mi->last_path,'\\')+1)=0;
448 path = msi_dup_property( package, cszSourceDir );
450 MsiSourceListAddMediaDiskW(package->ProductCode, NULL,
451 MSIINSTALLCONTEXT_USERMANAGED, MSICODE_PRODUCT, mi->count,
454 MsiSourceListSetInfoW(package->ProductCode, NULL,
455 MSIINSTALLCONTEXT_USERMANAGED,
456 MSICODE_PRODUCT|MSISOURCETYPE_NETWORK,
457 INSTALLPROPERTY_LASTUSEDSOURCEW, path);
464 mi->last_path = msi_alloc(MAX_PATH*sizeof(WCHAR));
465 if (MSI_GetPropertyW(package, cszSourceDir, mi->source, &sz))
467 ERR("No Source dir defined\n");
468 rc = ERROR_FUNCTION_FAILED;
472 strcpyW(mi->last_path,mi->source);
473 strcatW(mi->source,cab);
475 MsiSourceListSetInfoW(package->ProductCode, NULL,
476 MSIINSTALLCONTEXT_USERMANAGED,
477 MSICODE_PRODUCT|MSISOURCETYPE_MEDIA,
478 INSTALLPROPERTY_LASTUSEDSOURCEW, mi->last_path);
480 /* extract the cab file into a folder in the temp folder */
482 if (MSI_GetPropertyW(package, cszTempFolder,mi->last_path, &sz)
484 GetTempPathW(MAX_PATH,mi->last_path);
487 rc = !extract_cabinet_file(package, mi->source, mi->last_path);
492 mi->last_path = msi_alloc(MAX_PATH*sizeof(WCHAR));
493 MSI_GetPropertyW(package,cszSourceDir,mi->source,&sz);
494 strcpyW(mi->last_path,mi->source);
496 MsiSourceListSetInfoW(package->ProductCode, NULL,
497 MSIINSTALLCONTEXT_USERMANAGED,
498 MSICODE_PRODUCT|MSISOURCETYPE_MEDIA,
499 INSTALLPROPERTY_LASTUSEDSOURCEW, mi->last_path);
501 set_file_source(package, file, comp, mi->last_path);
503 MsiSourceListAddMediaDiskW(package->ProductCode, NULL,
504 MSIINSTALLCONTEXT_USERMANAGED, MSICODE_PRODUCT, mi->count, volume,
507 msiobj_release(&row->hdr);
512 static UINT get_file_target(MSIPACKAGE *package, LPCWSTR file_key,
515 LIST_FOR_EACH_ENTRY( *file, &package->files, MSIFILE, entry )
517 if (lstrcmpW( file_key, (*file)->File )==0)
519 if ((*file)->state >= msifs_overwrite)
520 return ERROR_SUCCESS;
522 return ERROR_FILE_NOT_FOUND;
526 return ERROR_FUNCTION_FAILED;
530 * ACTION_InstallFiles()
532 * For efficiency, this is done in two passes:
533 * 1) Correct all the TargetPaths and determine what files are to be installed.
534 * 2) Extract Cabinets and copy files.
536 UINT ACTION_InstallFiles(MSIPACKAGE *package)
538 struct media_info *mi;
539 UINT rc = ERROR_SUCCESS;
543 /* increment progress bar each time action data is sent */
544 ui_progress(package,1,1,0,0);
546 /* handle the keys for the SourceList */
547 ptr = strrchrW(package->PackagePath,'\\');
551 MsiSourceListSetInfoW(package->ProductCode, NULL,
552 MSIINSTALLCONTEXT_USERMANAGED,
554 INSTALLPROPERTY_PACKAGENAMEW, ptr);
556 /* FIXME("Write DiskPrompt\n"); */
559 LIST_FOR_EACH_ENTRY( file, &package->files, MSIFILE, entry )
561 if (!ACTION_VerifyComponentForAction( file->Component, INSTALLSTATE_LOCAL ))
563 ui_progress(package,2,file->FileSize,0,0);
564 TRACE("File %s is not scheduled for install\n",
565 debugstr_w(file->File));
567 file->state = msifs_skipped;
572 * Despite MSDN specifying that the CreateFolders action
573 * should be called before InstallFiles, some installers don't
574 * do that, and they seem to work correctly. We need to create
575 * directories here to make sure that the files can be copied.
577 msi_create_component_directories( package );
579 mi = create_media_info();
582 LIST_FOR_EACH_ENTRY( file, &package->files, MSIFILE, entry )
584 if (file->state != msifs_missing && file->state != msifs_overwrite)
587 TRACE("Pass 2: %s\n",debugstr_w(file->File));
589 rc = ready_media_for_file( package, mi, file );
590 if (rc != ERROR_SUCCESS)
592 ERR("Unable to ready media\n");
593 rc = ERROR_FUNCTION_FAILED;
597 TRACE("file paths %s to %s\n",debugstr_w(file->SourcePath),
598 debugstr_w(file->TargetPath));
600 if (file->state != msifs_missing && file->state != msifs_overwrite)
603 /* compressed files are extracted in ready_media_for_file */
604 if (~file->Attributes & msidbFileAttributesNoncompressed)
606 if (INVALID_FILE_ATTRIBUTES == GetFileAttributesW(file->TargetPath))
607 ERR("compressed file wasn't extracted (%s)\n",
608 debugstr_w(file->TargetPath));
612 rc = CopyFileW(file->SourcePath,file->TargetPath,FALSE);
616 ERR("Unable to copy file (%s -> %s) (error %d)\n",
617 debugstr_w(file->SourcePath), debugstr_w(file->TargetPath), rc);
618 if (rc == ERROR_ALREADY_EXISTS && file->state == msifs_overwrite)
622 else if (rc == ERROR_FILE_NOT_FOUND)
624 ERR("Source File Not Found! Continuing\n");
627 else if (file->Attributes & msidbFileAttributesVital)
629 ERR("Ignoring Error and continuing (nonvital file)...\n");
635 file->state = msifs_installed;
641 free_media_info( mi );
645 static UINT ITERATE_DuplicateFiles(MSIRECORD *row, LPVOID param)
647 MSIPACKAGE *package = (MSIPACKAGE*)param;
648 WCHAR dest_name[0x100];
649 LPWSTR dest_path, dest;
650 LPCWSTR file_key, component;
656 component = MSI_RecordGetString(row,2);
657 comp = get_loaded_component(package,component);
659 if (!ACTION_VerifyComponentForAction( comp, INSTALLSTATE_LOCAL ))
661 TRACE("Skipping copy due to disabled component %s\n",
662 debugstr_w(component));
664 /* the action taken was the same as the current install state */
665 comp->Action = comp->Installed;
667 return ERROR_SUCCESS;
670 comp->Action = INSTALLSTATE_LOCAL;
672 file_key = MSI_RecordGetString(row,3);
675 ERR("Unable to get file key\n");
676 return ERROR_FUNCTION_FAILED;
679 rc = get_file_target(package,file_key,&file);
681 if (rc != ERROR_SUCCESS)
683 ERR("Original file unknown %s\n",debugstr_w(file_key));
684 return ERROR_SUCCESS;
687 if (MSI_RecordIsNull(row,4))
688 strcpyW(dest_name,strrchrW(file->TargetPath,'\\')+1);
692 MSI_RecordGetStringW(row,4,dest_name,&sz);
693 reduce_to_longfilename(dest_name);
696 if (MSI_RecordIsNull(row,5))
699 dest_path = strdupW(file->TargetPath);
700 p = strrchrW(dest_path,'\\');
707 destkey = MSI_RecordGetString(row,5);
708 dest_path = resolve_folder(package, destkey, FALSE,FALSE,NULL);
712 dest_path = msi_dup_property( package, destkey );
715 FIXME("Unable to get destination folder, try AppSearch properties\n");
716 return ERROR_SUCCESS;
721 dest = build_directory_name(2, dest_path, dest_name);
723 TRACE("Duplicating file %s to %s\n",debugstr_w(file->TargetPath),
726 if (strcmpW(file->TargetPath,dest))
727 rc = !CopyFileW(file->TargetPath,dest,TRUE);
731 if (rc != ERROR_SUCCESS)
732 ERR("Failed to copy file %s -> %s, last error %ld\n",
733 debugstr_w(file->TargetPath), debugstr_w(dest_path), GetLastError());
735 FIXME("We should track these duplicate files as well\n");
740 msi_file_update_ui(package, file, szDuplicateFiles);
742 return ERROR_SUCCESS;
745 UINT ACTION_DuplicateFiles(MSIPACKAGE *package)
749 static const WCHAR ExecSeqQuery[] =
750 {'S','E','L','E','C','T',' ','*',' ','F','R','O','M',' ',
751 '`','D','u','p','l','i','c','a','t','e','F','i','l','e','`',0};
753 rc = MSI_DatabaseOpenViewW(package->db, ExecSeqQuery, &view);
754 if (rc != ERROR_SUCCESS)
755 return ERROR_SUCCESS;
757 rc = MSI_IterateRecords(view, NULL, ITERATE_DuplicateFiles, package);
758 msiobj_release(&view->hdr);
763 UINT ACTION_RemoveFiles( MSIPACKAGE *package )
767 LIST_FOR_EACH_ENTRY( file, &package->files, MSIFILE, entry )
772 if ( !file->Component )
774 if ( file->Component->Installed == INSTALLSTATE_LOCAL )
777 if ( file->state == msifs_installed )
778 ERR("removing installed file %s\n", debugstr_w(file->TargetPath));
780 if ( file->state != msifs_present )
783 TRACE("removing %s\n", debugstr_w(file->File) );
784 if ( !DeleteFileW( file->TargetPath ) )
785 ERR("failed to delete %s\n", debugstr_w(file->TargetPath) );
786 file->state = msifs_missing;
789 uirow = MSI_CreateRecord( 9 );
790 MSI_RecordSetStringW( uirow, 1, file->FileName );
791 uipath = strdupW( file->TargetPath );
792 p = strrchrW(uipath,'\\');
795 MSI_RecordSetStringW( uirow, 9, uipath);
796 ui_actiondata( package, szRemoveFiles, uirow);
797 msiobj_release( &uirow->hdr );
799 /* FIXME: call ui_progress here? */
802 return ERROR_SUCCESS;