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
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 )
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, szInstallFiles, 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 );
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 file->SourcePath = build_directory_name(2, p, file->ShortName);
337 file->SourcePath = build_directory_name(2, path, file->File);
340 static BOOL check_volume(LPCWSTR path, LPCWSTR want_volume, LPWSTR volume,
344 WCHAR name[MAX_PATH];
347 if (!(path[0] && path[1] == ':'))
354 TRACE("Checking volume %s .. (%s)\n",debugstr_w(drive), debugstr_w(want_volume));
355 type = GetDriveTypeW(drive);
356 TRACE("drive is of type %x\n",type);
358 if (type == DRIVE_UNKNOWN || type == DRIVE_NO_ROOT_DIR ||
359 type == DRIVE_FIXED || type == DRIVE_RAMDISK)
362 GetVolumeInformationW(drive, name, MAX_PATH, NULL, NULL, NULL, NULL, 0);
363 TRACE("Drive contains %s\n", debugstr_w(name));
364 volume = strdupW(name);
367 return (strcmpiW(want_volume,name)==0);
370 static BOOL check_for_sourcefile(LPCWSTR source)
372 DWORD attrib = GetFileAttributesW(source);
373 return (!(attrib == INVALID_FILE_ATTRIBUTES));
376 static UINT ready_volume(MSIPACKAGE* package, LPCWSTR path, LPWSTR last_volume,
377 MSIRECORD *row,UINT *type )
379 LPWSTR volume = NULL;
380 LPCWSTR want_volume = MSI_RecordGetString(row, 5);
381 BOOL ok = check_volume(path, want_volume, volume, type);
383 TRACE("Readying Volume for %s (%s, %s)\n", debugstr_w(path),
384 debugstr_w(want_volume), debugstr_w(last_volume));
386 if (check_for_sourcefile(path) && !ok)
388 FIXME("Found the Sourcefile but not on the correct volume.(%s,%s,%s)\n",
389 debugstr_w(path),debugstr_w(want_volume), debugstr_w(volume));
390 return ERROR_SUCCESS;
399 prompt = MSI_RecordGetString(row,3);
400 msg = generate_error_string(package, 1302, 1, prompt);
401 rc = MessageBoxW(NULL,msg,NULL,MB_OKCANCEL);
405 ok = check_for_sourcefile(path);
407 return ERROR_INSTALL_USEREXIT;
410 msi_free(last_volume);
411 last_volume = strdupW(volume);
412 return ERROR_SUCCESS;
420 WCHAR source[MAX_PATH];
423 static struct media_info *create_media_info( void )
425 struct media_info *mi;
427 mi = msi_alloc( sizeof *mi );
430 mi->last_sequence = 0;
431 mi->last_volume = NULL;
432 mi->last_path = NULL;
440 static void free_media_info( struct media_info *mi )
442 msi_free( mi->last_path );
446 static UINT ready_media_for_file( MSIPACKAGE *package, struct media_info *mi,
449 UINT rc = ERROR_SUCCESS;
451 static const WCHAR ExecSeqQuery[] =
452 {'S','E','L','E','C','T',' ','*',' ', 'F','R','O','M',' ',
453 '`','M','e','d','i','a','`',' ','W','H','E','R','E',' ',
454 '`','L','a','s','t','S','e','q','u','e','n','c','e','`',' ','>','=',
455 ' ','%', 'i',' ','O','R','D','E','R',' ','B','Y',' ',
456 '`','L','a','s','t','S','e','q','u','e','n','c','e','`',0};
462 MSICOMPONENT *comp = file->Component;
464 if (file->Sequence <= mi->last_sequence)
466 set_file_source(package,file,comp,mi->last_path);
467 TRACE("Media already ready (%u, %u)\n",file->Sequence,mi->last_sequence);
468 return ERROR_SUCCESS;
472 row = MSI_QueryGetRecord(package->db, ExecSeqQuery, file->Sequence);
475 TRACE("Unable to query row\n");
476 return ERROR_FUNCTION_FAILED;
479 seq = MSI_RecordGetInteger(row,2);
480 mi->last_sequence = seq;
482 volume = MSI_RecordGetString(row, 5);
483 prompt = MSI_RecordGetString(row, 3);
485 msi_free(mi->last_path);
486 mi->last_path = NULL;
488 if (file->Attributes & msidbFileAttributesNoncompressed)
490 mi->last_path = resolve_folder(package, comp->Directory, TRUE, FALSE, NULL);
491 set_file_source(package,file,comp,mi->last_path);
492 rc = ready_volume(package, file->SourcePath, mi->last_volume, row,&type);
494 MsiSourceListAddMediaDiskW(package->ProductCode, NULL,
495 MSIINSTALLCONTEXT_USERMANAGED, MSICODE_PRODUCT, mi->count, volume,
498 if (type == DRIVE_REMOVABLE || type == DRIVE_CDROM ||
499 type == DRIVE_RAMDISK)
500 MsiSourceListSetInfoW(package->ProductCode, NULL,
501 MSIINSTALLCONTEXT_USERMANAGED,
502 MSICODE_PRODUCT|MSISOURCETYPE_MEDIA,
503 INSTALLPROPERTY_LASTUSEDSOURCEW, mi->last_path);
505 MsiSourceListSetInfoW(package->ProductCode, NULL,
506 MSIINSTALLCONTEXT_USERMANAGED,
507 MSICODE_PRODUCT|MSISOURCETYPE_NETWORK,
508 INSTALLPROPERTY_LASTUSEDSOURCEW, mi->last_path);
509 msiobj_release(&row->hdr);
513 cab = MSI_RecordGetString(row,4);
516 TRACE("Source is CAB %s\n",debugstr_w(cab));
517 /* the stream does not contain the # character */
522 writeout_cabinet_stream(package,&cab[1],mi->source);
523 mi->last_path = strdupW(mi->source);
524 *(strrchrW(mi->last_path,'\\')+1)=0;
526 path = msi_dup_property( package, cszSourceDir );
528 MsiSourceListAddMediaDiskW(package->ProductCode, NULL,
529 MSIINSTALLCONTEXT_USERMANAGED, MSICODE_PRODUCT, mi->count,
532 MsiSourceListSetInfoW(package->ProductCode, NULL,
533 MSIINSTALLCONTEXT_USERMANAGED,
534 MSICODE_PRODUCT|MSISOURCETYPE_NETWORK,
535 INSTALLPROPERTY_LASTUSEDSOURCEW, path);
542 mi->last_path = msi_alloc(MAX_PATH*sizeof(WCHAR));
543 if (MSI_GetPropertyW(package, cszSourceDir, mi->source, &sz))
545 ERR("No Source dir defined \n");
546 rc = ERROR_FUNCTION_FAILED;
550 strcpyW(mi->last_path,mi->source);
551 strcatW(mi->source,cab);
553 rc = ready_volume(package, mi->source, mi->last_volume, row, &type);
554 if (type == DRIVE_REMOVABLE || type == DRIVE_CDROM ||
555 type == DRIVE_RAMDISK)
556 MsiSourceListSetInfoW(package->ProductCode, NULL,
557 MSIINSTALLCONTEXT_USERMANAGED,
558 MSICODE_PRODUCT|MSISOURCETYPE_MEDIA,
559 INSTALLPROPERTY_LASTUSEDSOURCEW, mi->last_path);
561 MsiSourceListSetInfoW(package->ProductCode, NULL,
562 MSIINSTALLCONTEXT_USERMANAGED,
563 MSICODE_PRODUCT|MSISOURCETYPE_NETWORK,
564 INSTALLPROPERTY_LASTUSEDSOURCEW, mi->last_path);
566 /* extract the cab file into a folder in the temp folder */
568 if (MSI_GetPropertyW(package, cszTempFolder,mi->last_path, &sz)
570 GetTempPathW(MAX_PATH,mi->last_path);
573 rc = !extract_cabinet_file(package, mi->source, mi->last_path);
578 mi->last_path = msi_alloc(MAX_PATH*sizeof(WCHAR));
579 MSI_GetPropertyW(package,cszSourceDir,mi->source,&sz);
580 strcpyW(mi->last_path,mi->source);
581 rc = ready_volume(package, mi->last_path, mi->last_volume, row, &type);
583 if (type == DRIVE_REMOVABLE || type == DRIVE_CDROM ||
584 type == DRIVE_RAMDISK)
585 MsiSourceListSetInfoW(package->ProductCode, NULL,
586 MSIINSTALLCONTEXT_USERMANAGED,
587 MSICODE_PRODUCT|MSISOURCETYPE_MEDIA,
588 INSTALLPROPERTY_LASTUSEDSOURCEW, mi->last_path);
590 MsiSourceListSetInfoW(package->ProductCode, NULL,
591 MSIINSTALLCONTEXT_USERMANAGED,
592 MSICODE_PRODUCT|MSISOURCETYPE_NETWORK,
593 INSTALLPROPERTY_LASTUSEDSOURCEW, mi->last_path);
595 set_file_source(package, file, comp, mi->last_path);
597 MsiSourceListAddMediaDiskW(package->ProductCode, NULL,
598 MSIINSTALLCONTEXT_USERMANAGED, MSICODE_PRODUCT, mi->count, volume,
601 msiobj_release(&row->hdr);
606 static UINT get_file_target(MSIPACKAGE *package, LPCWSTR file_key,
612 return ERROR_INVALID_HANDLE;
614 LIST_FOR_EACH_ENTRY( file, &package->files, MSIFILE, entry )
616 if (lstrcmpW( file_key, file->File )==0)
618 if (file->state >= msifs_overwrite)
620 *file_source = strdupW( file->TargetPath );
621 return ERROR_SUCCESS;
624 return ERROR_FILE_NOT_FOUND;
628 return ERROR_FUNCTION_FAILED;
632 * ACTION_InstallFiles()
634 * For efficiency, this is done in two passes:
635 * 1) Correct all the TargetPaths and determine what files are to be installed.
636 * 2) Extract Cabinets and copy files.
638 UINT ACTION_InstallFiles(MSIPACKAGE *package)
640 struct media_info *mi;
641 UINT rc = ERROR_SUCCESS;
646 return ERROR_INVALID_HANDLE;
648 /* increment progress bar each time action data is sent */
649 ui_progress(package,1,1,0,0);
651 /* handle the keys for the SourceList */
652 ptr = strrchrW(package->PackagePath,'\\');
656 MsiSourceListSetInfoW(package->ProductCode, NULL,
657 MSIINSTALLCONTEXT_USERMANAGED,
659 INSTALLPROPERTY_PACKAGENAMEW, ptr);
661 /* FIXME("Write DiskPrompt\n"); */
664 LIST_FOR_EACH_ENTRY( file, &package->files, MSIFILE, entry )
666 if (!ACTION_VerifyComponentForAction( file->Component, INSTALLSTATE_LOCAL ))
668 ui_progress(package,2,file->FileSize,0,0);
669 TRACE("File %s is not scheduled for install\n",
670 debugstr_w(file->File));
672 file->state = msifs_skipped;
677 * Despite MSDN specifying that the CreateFolders action
678 * should be called before InstallFiles, some installers don't
679 * do that, and they seem to work correctly. We need to create
680 * directories here to make sure that the files can be copied.
682 msi_create_component_directories( package );
684 mi = create_media_info();
687 LIST_FOR_EACH_ENTRY( file, &package->files, MSIFILE, entry )
689 if (file->state != msifs_missing && file->state != msifs_overwrite)
692 TRACE("Pass 2: %s\n",debugstr_w(file->File));
694 rc = ready_media_for_file( package, mi, file );
695 if (rc != ERROR_SUCCESS)
697 ERR("Unable to ready media\n");
698 rc = ERROR_FUNCTION_FAILED;
702 TRACE("file paths %s to %s\n",debugstr_w(file->SourcePath),
703 debugstr_w(file->TargetPath));
705 if (file->state != msifs_missing && file->state != msifs_overwrite)
708 /* compressed files are extracted in ready_media_for_file */
709 if (~file->Attributes & msidbFileAttributesNoncompressed)
711 if (INVALID_FILE_ATTRIBUTES == GetFileAttributesW(file->TargetPath))
712 ERR("compressed file wasn't extracted (%s)\n",
713 debugstr_w(file->TargetPath));
717 rc = CopyFileW(file->SourcePath,file->TargetPath,FALSE);
721 ERR("Unable to copy file (%s -> %s) (error %d)\n",
722 debugstr_w(file->SourcePath), debugstr_w(file->TargetPath), rc);
723 if (rc == ERROR_ALREADY_EXISTS && file->state == msifs_overwrite)
727 else if (rc == ERROR_FILE_NOT_FOUND)
729 ERR("Source File Not Found! Continuing\n");
732 else if (file->Attributes & msidbFileAttributesVital)
734 ERR("Ignoring Error and continuing (nonvital file)...\n");
740 file->state = msifs_installed;
746 free_media_info( mi );
750 static UINT ITERATE_DuplicateFiles(MSIRECORD *row, LPVOID param)
752 MSIPACKAGE *package = (MSIPACKAGE*)param;
753 WCHAR *file_source = NULL;
754 WCHAR dest_name[0x100];
755 LPWSTR dest_path, dest;
756 LPCWSTR file_key, component;
761 component = MSI_RecordGetString(row,2);
762 comp = get_loaded_component(package,component);
764 if (!ACTION_VerifyComponentForAction( comp, INSTALLSTATE_LOCAL ))
766 TRACE("Skipping copy due to disabled component %s\n",
767 debugstr_w(component));
769 /* the action taken was the same as the current install state */
770 comp->Action = comp->Installed;
772 return ERROR_SUCCESS;
775 comp->Action = INSTALLSTATE_LOCAL;
777 file_key = MSI_RecordGetString(row,3);
780 ERR("Unable to get file key\n");
781 return ERROR_FUNCTION_FAILED;
784 rc = get_file_target(package,file_key,&file_source);
786 if (rc != ERROR_SUCCESS)
788 ERR("Original file unknown %s\n",debugstr_w(file_key));
789 msi_free(file_source);
790 return ERROR_SUCCESS;
793 if (MSI_RecordIsNull(row,4))
794 strcpyW(dest_name,strrchrW(file_source,'\\')+1);
798 MSI_RecordGetStringW(row,4,dest_name,&sz);
799 reduce_to_longfilename(dest_name);
802 if (MSI_RecordIsNull(row,5))
805 dest_path = strdupW(file_source);
806 p = strrchrW(dest_path,'\\');
813 destkey = MSI_RecordGetString(row,5);
814 dest_path = resolve_folder(package, destkey, FALSE,FALSE,NULL);
818 dest_path = msi_dup_property( package, destkey );
821 FIXME("Unable to get destination folder, try AppSearch properties\n");
822 msi_free(file_source);
823 return ERROR_SUCCESS;
828 dest = build_directory_name(2, dest_path, dest_name);
830 TRACE("Duplicating file %s to %s\n",debugstr_w(file_source),
833 if (strcmpW(file_source,dest))
834 rc = !CopyFileW(file_source,dest,TRUE);
838 if (rc != ERROR_SUCCESS)
839 ERR("Failed to copy file %s -> %s, last error %ld\n",
840 debugstr_w(file_source), debugstr_w(dest_path), GetLastError());
842 FIXME("We should track these duplicate files as well\n");
846 msi_free(file_source);
848 return ERROR_SUCCESS;
851 UINT ACTION_DuplicateFiles(MSIPACKAGE *package)
855 static const WCHAR ExecSeqQuery[] =
856 {'S','E','L','E','C','T',' ','*',' ','F','R','O','M',' ',
857 '`','D','u','p','l','i','c','a','t','e','F','i','l','e','`',0};
860 return ERROR_INVALID_HANDLE;
862 rc = MSI_DatabaseOpenViewW(package->db, ExecSeqQuery, &view);
863 if (rc != ERROR_SUCCESS)
864 return ERROR_SUCCESS;
866 rc = MSI_IterateRecords(view, NULL, ITERATE_DuplicateFiles, package);
867 msiobj_release(&view->hdr);