2 * Copyright (C) 2002 Andreas Mohr
3 * Copyright (C) 2002 Shachar Shemesh
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 /* Wine "bootup" handler application
21 * This app handles the various "hooks" windows allows for applications to perform
22 * as part of the bootstrap process. Theses are roughly devided into three types.
23 * Knowledge base articles that explain this are 137367, 179365, 232487 and 232509.
24 * Also, 119941 has some info on grpconv.exe
25 * The operations performed are (by order of execution):
27 * Preboot (prior to fully loading the Windows kernel):
28 * - wininit.exe (rename operations left in wininit.ini - Win 9x only)
29 * - PendingRenameOperations (rename operations left in the registry - Win NT+ only)
31 * Startup (before the user logs in)
32 * - Services (NT, ?semi-synchronous?, not implemented yet)
33 * - HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\RunServicesOnce (9x, asynch)
34 * - HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\RunServices (9x, asynch)
37 * - HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\RunOnce (all, synch)
38 * - HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Run (all, asynch)
39 * - HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Run (all, asynch)
40 * - Startup folders (all, ?asynch?, no imp)
41 * - HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\RunOnce (all, asynch)
43 * Somewhere in there is processing the RunOnceEx entries (also no imp)
46 * - If a pending rename registry does not start with \??\ the entry is
47 * processed anyways. I'm not sure that is the Windows behaviour.
48 * - Need to check what is the windows behaviour when trying to delete files
49 * and directories that are read-only
50 * - In the pending rename registry processing - there are no traces of the files
51 * processed (requires translations from Unicode to Ansi).
54 #define WIN32_LEAN_AND_MEAN
58 #include <wine/debug.h>
60 WINE_DEFAULT_DEBUG_CHANNEL(wineboot
);
62 #define MAX_LINE_LENGTH (2*MAX_PATH+2)
64 static BOOL
GetLine( HANDLE hFile
, char *buf
, size_t buflen
)
73 if( !ReadFile( hFile
, buf
, 1, &read
, NULL
) || read
!=1 )
78 } while( isspace( *buf
) );
80 while( buf
[i
]!='\n' && i
<=buflen
&&
81 ReadFile( hFile
, buf
+i
+1, 1, &r
, NULL
) )
92 if( i
>0 && buf
[i
-1]=='\r' )
100 /* Performs the rename operations dictated in %SystemRoot%\Wininit.ini.
101 * Returns FALSE if there was an error, or otherwise if all is ok.
103 static BOOL
wininit(void)
105 const char * const RENAME_FILE
="wininit.ini";
106 const char * const RENAME_FILE_TO
="wininit.bak";
107 const char * const RENAME_FILE_SECTION
="[rename]";
108 char buffer
[MAX_LINE_LENGTH
];
112 hFile
=CreateFileA(RENAME_FILE
, GENERIC_READ
,
113 FILE_SHARE_READ
, NULL
, OPEN_EXISTING
, FILE_ATTRIBUTE_NORMAL
,
116 if( hFile
==INVALID_HANDLE_VALUE
)
118 DWORD err
=GetLastError();
120 if( err
==ERROR_FILE_NOT_FOUND
)
122 /* No file - nothing to do. Great! */
123 WINE_TRACE("Wininit.ini not present - no renaming to do\n");
128 WINE_ERR("There was an error in reading wininit.ini file - %ld\n",
134 printf("Wine is finalizing your software installation. This may take a few minutes,\n");
135 printf("though it never actually does.\n");
137 while( GetLine( hFile
, buffer
, sizeof(buffer
) ) &&
138 lstrcmpiA(buffer
,RENAME_FILE_SECTION
)!=0 )
139 ; /* Read the lines until we match the rename section */
141 while( GetLine( hFile
, buffer
, sizeof(buffer
) ) && buffer
[0]!='[' )
143 /* First, make sure this is not a comment */
144 if( buffer
[0]!=';' && buffer
[0]!='\0' )
148 value
=strchr(buffer
, '=');
152 WINE_WARN("Line with no \"=\" in it in wininit.ini - %s\n",
156 /* split the line into key and value */
159 if( lstrcmpiA( "NUL", buffer
)==0 )
161 WINE_TRACE("Deleting file \"%s\"\n", value
);
162 /* A file to delete */
163 if( !DeleteFileA( value
) )
164 WINE_WARN("Error deleting file \"%s\"\n", value
);
167 WINE_TRACE("Renaming file \"%s\" to \"%s\"\n", value
,
170 if( !MoveFileExA(value
, buffer
, MOVEFILE_COPY_ALLOWED
|
171 MOVEFILE_REPLACE_EXISTING
) )
173 WINE_WARN("Error renaming \"%s\" to \"%s\"\n", value
,
181 CloseHandle( hFile
);
183 if( !MoveFileExA( RENAME_FILE
, RENAME_FILE_TO
, MOVEFILE_REPLACE_EXISTING
) )
185 WINE_ERR("Couldn't rename wininit.ini, error %ld\n", GetLastError() );
193 static BOOL
pendingRename(void)
195 static const WCHAR ValueName
[] = {'P','e','n','d','i','n','g',
196 'F','i','l','e','R','e','n','a','m','e',
197 'O','p','e','r','a','t','i','o','n','s',0};
198 static const WCHAR SessionW
[] = { 'S','y','s','t','e','m','\\',
199 'C','u','r','r','e','n','t','C','o','n','t','r','o','l','S','e','t','\\',
200 'C','o','n','t','r','o','l','\\',
201 'S','e','s','s','i','o','n',' ','M','a','n','a','g','e','r',0};
203 const WCHAR
*src
=NULL
, *dst
=NULL
;
208 WINE_TRACE("Entered\n");
210 if( (res
=RegOpenKeyExW( HKEY_LOCAL_MACHINE
, SessionW
, 0, KEY_ALL_ACCESS
, &hSession
))
213 if( res
==ERROR_FILE_NOT_FOUND
)
215 WINE_TRACE("The key was not found - skipping\n");
220 WINE_ERR("Couldn't open key, error %ld\n", res
);
227 res
=RegQueryValueExW( hSession
, ValueName
, NULL
, NULL
/* The value type does not really interest us, as it is not
228 truly a REG_MULTI_SZ anyways */,
230 if( res
==ERROR_FILE_NOT_FOUND
)
232 /* No value - nothing to do. Great! */
233 WINE_TRACE("Value not present - nothing to rename\n");
238 if( res
!=ERROR_SUCCESS
)
240 WINE_ERR("Couldn't query value's length (%ld)\n", res
);
245 buffer
=HeapAlloc( GetProcessHeap(),0,dataLength
);
248 WINE_ERR("Couldn't allocate %lu bytes for the value\n", dataLength
);
253 res
=RegQueryValueExW( hSession
, ValueName
, NULL
, NULL
, (LPBYTE
)buffer
, &dataLength
);
254 if( res
!=ERROR_SUCCESS
)
256 WINE_ERR("Couldn't query value after successfully querying before (%lu),\n"
257 "please report to wine-devel@winehq.org\n", res
);
262 /* Make sure that the data is long enough and ends with two NULLs. This
263 * simplifies the code later on.
265 if( dataLength
<2*sizeof(buffer
[0]) ||
266 buffer
[dataLength
/sizeof(buffer
[0])-1]!='\0' ||
267 buffer
[dataLength
/sizeof(buffer
[0])-2]!='\0' )
269 WINE_ERR("Improper value format - doesn't end with NULL\n");
274 for( src
=buffer
; (src
-buffer
)*sizeof(src
[0])<dataLength
&& *src
!='\0';
275 src
=dst
+lstrlenW(dst
)+1 )
279 WINE_TRACE("processing next command\n");
281 dst
=src
+lstrlenW(src
)+1;
283 /* We need to skip the \??\ header */
284 if( src
[0]=='\\' && src
[1]=='?' && src
[2]=='?' && src
[3]=='\\' )
289 dwFlags
|=MOVEFILE_REPLACE_EXISTING
;
293 if( dst
[0]=='\\' && dst
[1]=='?' && dst
[2]=='?' && dst
[3]=='\\' )
298 /* Rename the file */
299 MoveFileExW( src
, dst
, dwFlags
);
302 /* Delete the file or directory */
303 if( (res
=GetFileAttributesW(src
))!=INVALID_FILE_ATTRIBUTES
)
305 if( (res
&FILE_ATTRIBUTE_DIRECTORY
)==0 )
311 /* It's a directory */
312 RemoveDirectoryW(src
);
316 WINE_ERR("couldn't get file attributes (%ld)\n", GetLastError() );
321 if((res
=RegDeleteValueW(hSession
, ValueName
))!=ERROR_SUCCESS
)
323 WINE_ERR("Error deleting the value (%lu)\n", GetLastError() );
329 HeapFree(GetProcessHeap(), 0, buffer
);
332 RegCloseKey( hSession
);
338 RUNKEY_RUN
, RUNKEY_RUNONCE
, RUNKEY_RUNSERVICES
, RUNKEY_RUNSERVICESONCE
341 const WCHAR runkeys_names
[][30]=
344 {'R','u','n','O','n','c','e',0},
345 {'R','u','n','S','e','r','v','i','c','e','s',0},
346 {'R','u','n','S','e','r','v','i','c','e','s','O','n','c','e',0}
349 #define INVALID_RUNCMD_RETURN -1
351 * This function runs the specified command in the specified dir.
352 * [in,out] cmdline - the command line to run. The function may change the passed buffer.
353 * [in] dir - the dir to run the command in. If it is NULL, then the current dir is used.
354 * [in] wait - whether to wait for the run program to finish before returning.
355 * [in] minimized - Whether to ask the program to run minimized.
358 * If running the process failed, returns INVALID_RUNCMD_RETURN. Use GetLastError to get the error code.
359 * If wait is FALSE - returns 0 if successful.
360 * If wait is TRUE - returns the program's return value.
362 static DWORD
runCmd(LPWSTR cmdline
, LPCWSTR dir
, BOOL wait
, BOOL minimized
)
365 PROCESS_INFORMATION info
;
368 memset(&si
, 0, sizeof(si
));
372 si
.dwFlags
=STARTF_USESHOWWINDOW
;
373 si
.wShowWindow
=SW_MINIMIZE
;
375 memset(&info
, 0, sizeof(info
));
377 if( !CreateProcessW(NULL
, cmdline
, NULL
, NULL
, FALSE
, 0, NULL
, dir
, &si
, &info
) )
379 WINE_ERR("Failed to run command %s (%ld)\n", wine_dbgstr_w(cmdline
),
382 return INVALID_RUNCMD_RETURN
;
385 WINE_TRACE("Successfully ran command %s - Created process handle %p\n",
386 wine_dbgstr_w(cmdline
), info
.hProcess
);
389 { /* wait for the process to exit */
390 WaitForSingleObject(info
.hProcess
, INFINITE
);
391 GetExitCodeProcess(info
.hProcess
, &exit_code
);
394 CloseHandle( info
.hProcess
);
400 * Process a "Run" type registry key.
401 * hkRoot is the HKEY from which "Software\Microsoft\Windows\CurrentVersion" is
403 * szKeyName is the key holding the actual entries.
404 * bDelete tells whether we should delete each value right before executing it.
405 * bSynchronous tells whether we should wait for the prog to complete before
406 * going on to the next prog.
408 static BOOL
ProcessRunKeys( HKEY hkRoot
, LPCWSTR szKeyName
, BOOL bDelete
,
411 static const WCHAR WINKEY_NAME
[]={'S','o','f','t','w','a','r','e','\\',
412 'M','i','c','r','o','s','o','f','t','\\','W','i','n','d','o','w','s','\\',
413 'C','u','r','r','e','n','t','V','e','r','s','i','o','n',0};
414 HKEY hkWin
=NULL
, hkRun
=NULL
;
415 DWORD res
=ERROR_SUCCESS
;
416 DWORD i
, nMaxCmdLine
=0, nMaxValue
=0;
417 WCHAR
*szCmdLine
=NULL
;
420 if (hkRoot
==HKEY_LOCAL_MACHINE
)
421 WINE_TRACE("processing %s entries under HKLM\n",wine_dbgstr_w(szKeyName
) );
423 WINE_TRACE("processing %s entries under HKCU\n",wine_dbgstr_w(szKeyName
) );
425 if( (res
=RegOpenKeyExW( hkRoot
, WINKEY_NAME
, 0, KEY_READ
, &hkWin
))!=ERROR_SUCCESS
)
427 WINE_ERR("RegOpenKey failed on Software\\Microsoft\\Windows\\CurrentVersion (%ld)\n",
433 if( (res
=RegOpenKeyExW( hkWin
, szKeyName
, 0, bDelete
?KEY_ALL_ACCESS
:KEY_READ
, &hkRun
))!=
436 if( res
==ERROR_FILE_NOT_FOUND
)
438 WINE_TRACE("Key doesn't exist - nothing to be done\n");
443 WINE_ERR("RegOpenKey failed on run key (%ld)\n", res
);
448 if( (res
=RegQueryInfoKeyW( hkRun
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, &i
, &nMaxValue
,
449 &nMaxCmdLine
, NULL
, NULL
))!=ERROR_SUCCESS
)
451 WINE_ERR("Couldn't query key info (%ld)\n", res
);
458 WINE_TRACE("No commands to execute.\n");
464 if( (szCmdLine
=HeapAlloc(GetProcessHeap(),0,nMaxCmdLine
))==NULL
)
466 WINE_ERR("Couldn't allocate memory for the commands to be executed\n");
468 res
=ERROR_NOT_ENOUGH_MEMORY
;
472 if( (szValue
=HeapAlloc(GetProcessHeap(),0,(++nMaxValue
)*sizeof(*szValue
)))==NULL
)
474 WINE_ERR("Couldn't allocate memory for the value names\n");
476 res
=ERROR_NOT_ENOUGH_MEMORY
;
482 DWORD nValLength
=nMaxValue
, nDataLength
=nMaxCmdLine
;
487 if( (res
=RegEnumValueW( hkRun
, i
, szValue
, &nValLength
, 0, &type
,
488 (LPBYTE
)szCmdLine
, &nDataLength
))!=ERROR_SUCCESS
)
490 WINE_ERR("Couldn't read in value %ld - %ld\n", i
, res
);
495 if( bDelete
&& (res
=RegDeleteValueW( hkRun
, szValue
))!=ERROR_SUCCESS
)
497 WINE_ERR("Couldn't delete value - %ld, %ld. Running command anyways.\n", i
, res
);
502 WINE_ERR("Incorrect type of value #%ld (%ld)\n", i
, type
);
507 if( (res
=runCmd(szCmdLine
, NULL
, bSynchronous
, FALSE
))==INVALID_RUNCMD_RETURN
)
509 WINE_ERR("Error running cmd #%ld (%ld)\n", i
, GetLastError() );
512 WINE_TRACE("Done processing cmd #%ld\n", i
);
519 RegCloseKey( hkRun
);
521 RegCloseKey( hkWin
);
523 WINE_TRACE("done\n");
525 return res
==ERROR_SUCCESS
?TRUE
:FALSE
;
529 BOOL w9xonly
; /* Perform only operations done on Windows 9x */
530 BOOL ntonly
; /* Perform only operations done on Windows NT */
531 BOOL startup
; /* Perform the operations that are performed every boot */
532 BOOL preboot
; /* Perform file renames typically done before the system starts */
533 BOOL prelogin
; /* Perform the operations typically done before the user logs in */
534 BOOL postlogin
; /* Operations done after login */
537 static const struct op_mask SESSION_START
={FALSE
, FALSE
, TRUE
, TRUE
, TRUE
, TRUE
},
538 SETUP
={FALSE
, FALSE
, FALSE
, TRUE
, TRUE
, TRUE
};
539 #define DEFAULT SESSION_START
541 int main( int argc
, char *argv
[] )
543 struct op_mask ops
; /* Which of the ops do we want to perform? */
544 /* First, set the current directory to SystemRoot */
545 TCHAR gen_path
[MAX_PATH
];
548 res
=GetWindowsDirectory( gen_path
, sizeof(gen_path
) );
552 WINE_ERR("Couldn't get the windows directory - error %ld\n",
558 if( res
>=sizeof(gen_path
) )
560 WINE_ERR("Windows path too long (%ld)\n", res
);
565 if( !SetCurrentDirectory( gen_path
) )
567 WINE_ERR("Cannot set the dir to %s (%ld)\n", gen_path
, GetLastError() );
576 case 'r': /* Restart */
579 case 's': /* Full start */
589 /* Perform the ops by order, stopping if one fails, skipping if necessary */
590 /* Shachar: Sorry for the perl syntax */
591 res
=(ops
.ntonly
|| !ops
.preboot
|| wininit())&&
592 (ops
.w9xonly
|| !ops
.preboot
|| pendingRename()) &&
593 (ops
.ntonly
|| !ops
.prelogin
||
594 ProcessRunKeys( HKEY_LOCAL_MACHINE
, runkeys_names
[RUNKEY_RUNSERVICESONCE
],
596 (ops
.ntonly
|| !ops
.prelogin
|| !ops
.startup
||
597 ProcessRunKeys( HKEY_LOCAL_MACHINE
, runkeys_names
[RUNKEY_RUNSERVICES
],
600 ProcessRunKeys( HKEY_LOCAL_MACHINE
, runkeys_names
[RUNKEY_RUNONCE
],
602 (!ops
.postlogin
|| !ops
.startup
||
603 ProcessRunKeys( HKEY_LOCAL_MACHINE
, runkeys_names
[RUNKEY_RUN
],
605 (!ops
.postlogin
|| !ops
.startup
||
606 ProcessRunKeys( HKEY_CURRENT_USER
, runkeys_names
[RUNKEY_RUN
],
609 WINE_TRACE("Operation done\n");