blob: b5bf325f469f3354adacf4c0366aa9a785641777 [file] [log] [blame]
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +00001
2/* Return the initial module search path. */
Guido van Rossumc4995721998-08-08 20:05:31 +00003/* Used by DOS, OS/2, Windows 3.1, Windows 95/98, Windows NT. */
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +00004
Guido van Rossum88716bb2000-03-30 19:45:39 +00005/* ----------------------------------------------------------------
6 PATH RULES FOR WINDOWS:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007 This describes how sys.path is formed on Windows. It describes the
8 functionality, not the implementation (ie, the order in which these
Guido van Rossum88716bb2000-03-30 19:45:39 +00009 are actually fetched is different)
10
11 * Python always adds an empty entry at the start, which corresponds
12 to the current directory.
13
Georg Brandl7eb4b7d2005-07-22 21:49:32 +000014 * If the PYTHONPATH env. var. exists, its entries are added next.
Guido van Rossum88716bb2000-03-30 19:45:39 +000015
16 * We look in the registry for "application paths" - that is, sub-keys
17 under the main PythonPath registry key. These are added next (the
18 order of sub-key processing is undefined).
19 HKEY_CURRENT_USER is searched and added first.
20 HKEY_LOCAL_MACHINE is searched and added next.
21 (Note that all known installers only use HKLM, so HKCU is typically
22 empty)
23
24 * We attempt to locate the "Python Home" - if the PYTHONHOME env var
25 is set, we believe it. Otherwise, we use the path of our host .EXE's
Jeremy Hylton847a9962000-05-26 21:49:07 +000026 to try and locate our "landmark" (lib\\os.py) and deduce our home.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000027 - If we DO have a Python Home: The relevant sub-directories (Lib,
Georg Brandl6e47a332008-05-17 19:15:58 +000028 plat-win, etc) are based on the Python Home
Guido van Rossum88716bb2000-03-30 19:45:39 +000029 - If we DO NOT have a Python Home, the core Python Path is
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000030 loaded from the registry. This is the main PythonPath key,
Guido van Rossum88716bb2000-03-30 19:45:39 +000031 and both HKLM and HKCU are combined to form the path)
32
33 * Iff - we can not locate the Python Home, have not had a PYTHONPATH
34 specified, and can't locate any Registry entries (ie, we have _nothing_
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000035 we can assume is a good path), a default path with relative entries is
Guido van Rossum88716bb2000-03-30 19:45:39 +000036 used (eg. .\Lib;.\plat-win, etc)
37
38
39 The end result of all this is:
40 * When running python.exe, or any other .exe in the main Python directory
41 (either an installed version, or directly from the PCbuild directory),
42 the core path is deduced, and the core paths in the registry are
43 ignored. Other "application paths" in the registry are always read.
44
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000045 * When Python is hosted in another exe (different directory, embedded via
Guido van Rossum88716bb2000-03-30 19:45:39 +000046 COM, etc), the Python Home will not be deduced, so the core path from
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000047 the registry is used. Other "application paths" in the registry are
Guido van Rossum88716bb2000-03-30 19:45:39 +000048 always read.
49
50 * If Python can't find its home and there is no registry (eg, frozen
51 exe, some very strange installation setup) you get a path with
52 some default, but relative, paths.
53
Kristján Valur Jónsson3b69db22010-09-27 05:32:54 +000054 * An embedding application can use Py_SetPath() to override all of
55 these authomatic path computations.
56
Guido van Rossum88716bb2000-03-30 19:45:39 +000057 ---------------------------------------------------------------- */
58
59
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +000060#include "Python.h"
61#include "osdefs.h"
Martin v. Löwis790465f2008-04-05 20:41:37 +000062#include <wchar.h>
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +000063
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000064#ifdef MS_WINDOWS
Guido van Rossum8f1b6511997-08-13 19:55:43 +000065#include <windows.h>
66#endif
67
Thomas Wouters0e3f5912006-08-11 14:57:12 +000068#ifdef HAVE_SYS_TYPES_H
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +000069#include <sys/types.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +000070#endif /* HAVE_SYS_TYPES_H */
71
72#ifdef HAVE_SYS_STAT_H
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +000073#include <sys/stat.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +000074#endif /* HAVE_SYS_STAT_H */
75
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +000076#include <string.h>
77
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +000078/* Search in some common locations for the associated Python libraries.
79 *
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +000080 * Py_GetPath() tries to return a sensible Python module search path.
81 *
Guido van Rossum42a97441998-02-19 21:00:45 +000082 * The approach is an adaptation for Windows of the strategy used in
83 * ../Modules/getpath.c; it uses the Windows Registry as one of its
84 * information sources.
Kristján Valur Jónsson3b69db22010-09-27 05:32:54 +000085 *
86 * Py_SetPath() can be used to override this mechanism. Call Py_SetPath
87 * with a semicolon separated path prior to calling Py_Initialize.
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +000088 */
89
90#ifndef LANDMARK
Martin v. Löwis790465f2008-04-05 20:41:37 +000091#define LANDMARK L"lib\\os.py"
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +000092#endif
93
Martin v. Löwis790465f2008-04-05 20:41:37 +000094static wchar_t prefix[MAXPATHLEN+1];
95static wchar_t progpath[MAXPATHLEN+1];
96static wchar_t dllpath[MAXPATHLEN+1];
97static wchar_t *module_search_path = NULL;
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +000098
Guido van Rossumeea14491997-08-13 21:30:44 +000099
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000100static int
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000101is_sep(wchar_t ch) /* determine if "ch" is a separator character */
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000102{
103#ifdef ALTSEP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000104 return ch == SEP || ch == ALTSEP;
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000105#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000106 return ch == SEP;
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000107#endif
108}
109
Mark Hammond8bf9e3b2000-10-07 11:10:50 +0000110/* assumes 'dir' null terminated in bounds. Never writes
111 beyond existing terminator.
112*/
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000113static void
Martin v. Löwis790465f2008-04-05 20:41:37 +0000114reduce(wchar_t *dir)
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000115{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000116 size_t i = wcslen(dir);
117 while (i > 0 && !is_sep(dir[i]))
118 --i;
119 dir[i] = '\0';
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000120}
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000121
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000122
123static int
Martin v. Löwis790465f2008-04-05 20:41:37 +0000124exists(wchar_t *filename)
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000125{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000126 return GetFileAttributesW(filename) != 0xFFFFFFFF;
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000127}
128
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000129/* Assumes 'filename' MAXPATHLEN+1 bytes long -
Mark Hammond8bf9e3b2000-10-07 11:10:50 +0000130 may extend 'filename' by one character.
131*/
Guido van Rossum43ff1141998-08-08 23:40:40 +0000132static int
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000133ismodule(wchar_t *filename) /* Is module -- check for .pyc/.pyo too */
Guido van Rossum43ff1141998-08-08 23:40:40 +0000134{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000135 if (exists(filename))
136 return 1;
Guido van Rossum43ff1141998-08-08 23:40:40 +0000137
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000138 /* Check for the compiled version of prefix. */
139 if (wcslen(filename) < MAXPATHLEN) {
140 wcscat(filename, Py_OptimizeFlag ? L"o" : L"c");
141 if (exists(filename))
142 return 1;
143 }
144 return 0;
Guido van Rossum43ff1141998-08-08 23:40:40 +0000145}
146
Tim Peters8484fbf2004-08-07 19:12:27 +0000147/* Add a path component, by appending stuff to buffer.
148 buffer must have at least MAXPATHLEN + 1 bytes allocated, and contain a
149 NUL-terminated string with no more than MAXPATHLEN characters (not counting
150 the trailing NUL). It's a fatal error if it contains a string longer than
151 that (callers must be careful!). If these requirements are met, it's
152 guaranteed that buffer will still be a NUL-terminated string with no more
153 than MAXPATHLEN characters at exit. If stuff is too long, only as much of
154 stuff as fits will be appended.
155*/
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000156static void
Martin v. Löwis790465f2008-04-05 20:41:37 +0000157join(wchar_t *buffer, wchar_t *stuff)
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000158{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000159 size_t n, k;
160 if (is_sep(stuff[0]))
161 n = 0;
162 else {
163 n = wcslen(buffer);
164 if (n > 0 && !is_sep(buffer[n-1]) && n < MAXPATHLEN)
165 buffer[n++] = SEP;
166 }
167 if (n > MAXPATHLEN)
168 Py_FatalError("buffer overflow in getpathp.c's joinpath()");
169 k = wcslen(stuff);
170 if (n + k > MAXPATHLEN)
171 k = MAXPATHLEN - n;
172 wcsncpy(buffer+n, stuff, k);
173 buffer[n+k] = '\0';
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000174}
175
Mark Hammond8bf9e3b2000-10-07 11:10:50 +0000176/* gotlandmark only called by search_for_prefix, which ensures
177 'prefix' is null terminated in bounds. join() ensures
178 'landmark' can not overflow prefix if too long.
179*/
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000180static int
Martin v. Löwis790465f2008-04-05 20:41:37 +0000181gotlandmark(wchar_t *landmark)
Guido van Rossume02e48b2000-03-29 01:49:47 +0000182{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000183 int ok;
184 Py_ssize_t n;
Guido van Rossume02e48b2000-03-29 01:49:47 +0000185
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000186 n = wcslen(prefix);
187 join(prefix, landmark);
188 ok = ismodule(prefix);
189 prefix[n] = '\0';
190 return ok;
Guido van Rossume02e48b2000-03-29 01:49:47 +0000191}
192
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000193/* assumes argv0_path is MAXPATHLEN+1 bytes long, already \0 term'd.
Mark Hammond8bf9e3b2000-10-07 11:10:50 +0000194 assumption provided by only caller, calculate_path() */
Guido van Rossume02e48b2000-03-29 01:49:47 +0000195static int
Martin v. Löwis790465f2008-04-05 20:41:37 +0000196search_for_prefix(wchar_t *argv0_path, wchar_t *landmark)
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000197{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000198 /* Search from argv0_path, until landmark is found */
199 wcscpy(prefix, argv0_path);
200 do {
201 if (gotlandmark(landmark))
202 return 1;
203 reduce(prefix);
204 } while (prefix[0]);
205 return 0;
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000206}
207
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000208#ifdef MS_WINDOWS
Martin v. Löwisbc186a82009-02-02 15:32:22 +0000209#ifdef Py_ENABLE_SHARED
Guido van Rossum43ff1141998-08-08 23:40:40 +0000210
Guido van Rossum88716bb2000-03-30 19:45:39 +0000211/* a string loaded from the DLL at startup.*/
212extern const char *PyWin_DLLVersionString;
Guido van Rossum271f9771997-09-29 23:39:31 +0000213
Guido van Rossumeea14491997-08-13 21:30:44 +0000214
215/* Load a PYTHONPATH value from the registry.
216 Load from either HKEY_LOCAL_MACHINE or HKEY_CURRENT_USER.
217
Guido van Rossum88716bb2000-03-30 19:45:39 +0000218 Works in both Unicode and 8bit environments. Only uses the
219 Ex family of functions so it also works with Windows CE.
220
Guido van Rossumeea14491997-08-13 21:30:44 +0000221 Returns NULL, or a pointer that should be freed.
Mark Hammond5edc6272001-02-23 11:38:38 +0000222
223 XXX - this code is pretty strange, as it used to also
224 work on Win16, where the buffer sizes werent available
225 in advance. It could be simplied now Win16/Win32s is dead!
Guido van Rossumeea14491997-08-13 21:30:44 +0000226*/
227
Martin v. Löwis790465f2008-04-05 20:41:37 +0000228static wchar_t *
Guido van Rossum88716bb2000-03-30 19:45:39 +0000229getpythonregpath(HKEY keyBase, int skipcore)
Guido van Rossumeea14491997-08-13 21:30:44 +0000230{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000231 HKEY newKey = 0;
232 DWORD dataSize = 0;
233 DWORD numKeys = 0;
234 LONG rc;
235 wchar_t *retval = NULL;
236 WCHAR *dataBuf = NULL;
237 static const WCHAR keyPrefix[] = L"Software\\Python\\PythonCore\\";
238 static const WCHAR keySuffix[] = L"\\PythonPath";
239 size_t versionLen;
240 DWORD index;
241 WCHAR *keyBuf = NULL;
242 WCHAR *keyBufPtr;
243 WCHAR **ppPaths = NULL;
Guido van Rossum271f9771997-09-29 23:39:31 +0000244
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000245 /* Tried to use sysget("winver") but here is too early :-( */
246 versionLen = strlen(PyWin_DLLVersionString);
247 /* Space for all the chars, plus one \0 */
248 keyBuf = keyBufPtr = malloc(sizeof(keyPrefix) +
249 sizeof(WCHAR)*(versionLen-1) +
250 sizeof(keySuffix));
251 if (keyBuf==NULL) goto done;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000252
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000253 memcpy(keyBufPtr, keyPrefix, sizeof(keyPrefix)-sizeof(WCHAR));
Victor Stinner63941882011-09-29 00:42:28 +0200254 keyBufPtr += Py_ARRAY_LENGTH(keyPrefix) - 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000255 mbstowcs(keyBufPtr, PyWin_DLLVersionString, versionLen);
256 keyBufPtr += versionLen;
257 /* NULL comes with this one! */
258 memcpy(keyBufPtr, keySuffix, sizeof(keySuffix));
259 /* Open the root Python key */
260 rc=RegOpenKeyExW(keyBase,
261 keyBuf, /* subkey */
262 0, /* reserved */
263 KEY_READ,
264 &newKey);
265 if (rc!=ERROR_SUCCESS) goto done;
266 /* Find out how big our core buffer is, and how many subkeys we have */
267 rc = RegQueryInfoKey(newKey, NULL, NULL, NULL, &numKeys, NULL, NULL,
268 NULL, NULL, &dataSize, NULL, NULL);
269 if (rc!=ERROR_SUCCESS) goto done;
270 if (skipcore) dataSize = 0; /* Only count core ones if we want them! */
271 /* Allocate a temp array of char buffers, so we only need to loop
272 reading the registry once
273 */
274 ppPaths = malloc( sizeof(WCHAR *) * numKeys );
275 if (ppPaths==NULL) goto done;
276 memset(ppPaths, 0, sizeof(WCHAR *) * numKeys);
277 /* Loop over all subkeys, allocating a temp sub-buffer. */
278 for(index=0;index<numKeys;index++) {
279 WCHAR keyBuf[MAX_PATH+1];
280 HKEY subKey = 0;
281 DWORD reqdSize = MAX_PATH+1;
282 /* Get the sub-key name */
283 DWORD rc = RegEnumKeyExW(newKey, index, keyBuf, &reqdSize,
284 NULL, NULL, NULL, NULL );
285 if (rc!=ERROR_SUCCESS) goto done;
286 /* Open the sub-key */
287 rc=RegOpenKeyExW(newKey,
288 keyBuf, /* subkey */
289 0, /* reserved */
290 KEY_READ,
291 &subKey);
292 if (rc!=ERROR_SUCCESS) goto done;
293 /* Find the value of the buffer size, malloc, then read it */
294 RegQueryValueExW(subKey, NULL, 0, NULL, NULL, &reqdSize);
295 if (reqdSize) {
296 ppPaths[index] = malloc(reqdSize);
297 if (ppPaths[index]) {
298 RegQueryValueExW(subKey, NULL, 0, NULL,
299 (LPBYTE)ppPaths[index],
300 &reqdSize);
301 dataSize += reqdSize + 1; /* 1 for the ";" */
302 }
303 }
304 RegCloseKey(subKey);
305 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000306
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000307 /* return null if no path to return */
308 if (dataSize == 0) goto done;
309
310 /* original datasize from RegQueryInfo doesn't include the \0 */
311 dataBuf = malloc((dataSize+1) * sizeof(WCHAR));
312 if (dataBuf) {
313 WCHAR *szCur = dataBuf;
314 DWORD reqdSize = dataSize;
315 /* Copy our collected strings */
316 for (index=0;index<numKeys;index++) {
317 if (index > 0) {
318 *(szCur++) = L';';
319 dataSize--;
320 }
321 if (ppPaths[index]) {
322 Py_ssize_t len = wcslen(ppPaths[index]);
323 wcsncpy(szCur, ppPaths[index], len);
324 szCur += len;
325 assert(dataSize > (DWORD)len);
326 dataSize -= (DWORD)len;
327 }
328 }
329 if (skipcore)
330 *szCur = '\0';
331 else {
332 /* If we have no values, we dont need a ';' */
333 if (numKeys) {
334 *(szCur++) = L';';
335 dataSize--;
336 }
337 /* Now append the core path entries -
338 this will include the NULL
339 */
340 rc = RegQueryValueExW(newKey, NULL, 0, NULL,
341 (LPBYTE)szCur, &dataSize);
342 }
343 /* And set the result - caller must free */
344 retval = dataBuf;
345 }
Guido van Rossum88716bb2000-03-30 19:45:39 +0000346done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 /* Loop freeing my temp buffers */
348 if (ppPaths) {
349 for(index=0;index<numKeys;index++)
350 if (ppPaths[index]) free(ppPaths[index]);
351 free(ppPaths);
352 }
353 if (newKey)
354 RegCloseKey(newKey);
355 if (keyBuf)
356 free(keyBuf);
357 return retval;
Guido van Rossumeea14491997-08-13 21:30:44 +0000358}
Martin v. Löwisbc186a82009-02-02 15:32:22 +0000359#endif /* Py_ENABLE_SHARED */
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000360#endif /* MS_WINDOWS */
Guido van Rossumeea14491997-08-13 21:30:44 +0000361
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000362static void
Thomas Wouters78890102000-07-22 19:25:51 +0000363get_progpath(void)
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000364{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000365 extern wchar_t *Py_GetProgramName(void);
366 wchar_t *path = _wgetenv(L"PATH");
367 wchar_t *prog = Py_GetProgramName();
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000368
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000369#ifdef MS_WINDOWS
Martin v. Löwisbc186a82009-02-02 15:32:22 +0000370#ifdef Py_ENABLE_SHARED
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000371 extern HANDLE PyWin_DLLhModule;
372 /* static init of progpath ensures final char remains \0 */
373 if (PyWin_DLLhModule)
374 if (!GetModuleFileNameW(PyWin_DLLhModule, dllpath, MAXPATHLEN))
375 dllpath[0] = 0;
Martin v. Löwisbc186a82009-02-02 15:32:22 +0000376#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000377 dllpath[0] = 0;
Martin v. Löwisbc186a82009-02-02 15:32:22 +0000378#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000379 if (GetModuleFileNameW(NULL, progpath, MAXPATHLEN))
380 return;
Guido van Rossumeea14491997-08-13 21:30:44 +0000381#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000382 if (prog == NULL || *prog == '\0')
383 prog = L"python";
Guido van Rossumeea14491997-08-13 21:30:44 +0000384
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000385 /* If there is no slash in the argv0 path, then we have to
386 * assume python is on the user's $PATH, since there's no
387 * other way to find a directory to start the search from. If
388 * $PATH isn't exported, you lose.
389 */
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000390#ifdef ALTSEP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000391 if (wcschr(prog, SEP) || wcschr(prog, ALTSEP))
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000392#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000393 if (wcschr(prog, SEP))
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000394#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000395 wcsncpy(progpath, prog, MAXPATHLEN);
396 else if (path) {
397 while (1) {
398 wchar_t *delim = wcschr(path, DELIM);
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000399
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000400 if (delim) {
401 size_t len = delim - path;
402 /* ensure we can't overwrite buffer */
403 len = min(MAXPATHLEN,len);
404 wcsncpy(progpath, path, len);
405 *(progpath + len) = '\0';
406 }
407 else
408 wcsncpy(progpath, path, MAXPATHLEN);
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000409
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000410 /* join() is safe for MAXPATHLEN+1 size buffer */
411 join(progpath, prog);
412 if (exists(progpath))
413 break;
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000414
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000415 if (!delim) {
416 progpath[0] = '\0';
417 break;
418 }
419 path = delim + 1;
420 }
421 }
422 else
423 progpath[0] = '\0';
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000424}
425
Vinay Sajip7ded1f02012-05-26 03:45:29 +0100426static int
427find_env_config_value(FILE * env_file, const wchar_t * key, wchar_t * value)
428{
429 int result = 0; /* meaning not found */
430 char buffer[MAXPATHLEN*2+1]; /* allow extra for key, '=', etc. */
431
432 fseek(env_file, 0, SEEK_SET);
433 while (!feof(env_file)) {
434 char * p = fgets(buffer, MAXPATHLEN*2, env_file);
435 wchar_t tmpbuffer[MAXPATHLEN*2+1];
436 PyObject * decoded;
437 int n;
438
439 if (p == NULL)
440 break;
441 n = strlen(p);
442 if (p[n - 1] != '\n') {
443 /* line has overflowed - bail */
444 break;
445 }
446 if (p[0] == '#') /* Comment - skip */
447 continue;
448 decoded = PyUnicode_DecodeUTF8(buffer, n, "surrogateescape");
449 if (decoded != NULL) {
450 Py_ssize_t k;
451 k = PyUnicode_AsWideChar(decoded,
452 tmpbuffer, MAXPATHLEN * 2);
453 Py_DECREF(decoded);
454 if (k >= 0) {
455 wchar_t * tok = wcstok(tmpbuffer, L" \t\r\n");
456 if ((tok != NULL) && !wcscmp(tok, key)) {
457 tok = wcstok(NULL, L" \t");
458 if ((tok != NULL) && !wcscmp(tok, L"=")) {
459 tok = wcstok(NULL, L"\r\n");
460 if (tok != NULL) {
461 wcsncpy(value, tok, MAXPATHLEN);
462 result = 1;
463 break;
464 }
465 }
466 }
467 }
468 }
469 }
470 return result;
471}
472
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000473static void
Thomas Wouters78890102000-07-22 19:25:51 +0000474calculate_path(void)
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000475{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000476 wchar_t argv0_path[MAXPATHLEN+1];
477 wchar_t *buf;
478 size_t bufsz;
479 wchar_t *pythonhome = Py_GetPythonHome();
480 wchar_t *envpath = NULL;
Guido van Rossumeea14491997-08-13 21:30:44 +0000481
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000482#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000483 int skiphome, skipdefault;
484 wchar_t *machinepath = NULL;
485 wchar_t *userpath = NULL;
486 wchar_t zip_path[MAXPATHLEN+1];
487 size_t len;
Amaury Forgeot d'Arc66f8c432009-06-09 21:30:01 +0000488
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000489 if (!Py_IgnoreEnvironmentFlag) {
490 envpath = _wgetenv(L"PYTHONPATH");
491 }
Amaury Forgeot d'Arc66f8c432009-06-09 21:30:01 +0000492#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000493 char *_envpath = Py_GETENV("PYTHONPATH");
494 wchar_t wenvpath[MAXPATHLEN+1];
495 if (_envpath) {
496 size_t r = mbstowcs(wenvpath, _envpath, MAXPATHLEN+1);
497 envpath = wenvpath;
498 if (r == (size_t)-1 || r >= MAXPATHLEN)
499 envpath = NULL;
500 }
Amaury Forgeot d'Arc66f8c432009-06-09 21:30:01 +0000501#endif
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000502
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000503 get_progpath();
504 /* progpath guaranteed \0 terminated in MAXPATH+1 bytes. */
505 wcscpy(argv0_path, progpath);
506 reduce(argv0_path);
Vinay Sajip7ded1f02012-05-26 03:45:29 +0100507
508 /* Search for an environment configuration file, first in the
509 executable's directory and then in the parent directory.
510 If found, open it for use when searching for prefixes.
511 */
512
513 {
514 wchar_t tmpbuffer[MAXPATHLEN+1];
515 wchar_t *env_cfg = L"pyvenv.cfg";
516 FILE * env_file = NULL;
517
518 wcscpy(tmpbuffer, argv0_path);
519 join(tmpbuffer, env_cfg);
520 env_file = _Py_wfopen(tmpbuffer, L"r");
521 if (env_file == NULL) {
522 errno = 0;
523 reduce(tmpbuffer);
524 reduce(tmpbuffer);
525 join(tmpbuffer, env_cfg);
526 env_file = _Py_wfopen(tmpbuffer, L"r");
527 if (env_file == NULL) {
528 errno = 0;
529 }
530 }
531 if (env_file != NULL) {
532 /* Look for a 'home' variable and set argv0_path to it, if found */
533 if (find_env_config_value(env_file, L"home", tmpbuffer)) {
534 wcscpy(argv0_path, tmpbuffer);
535 }
536 fclose(env_file);
537 env_file = NULL;
538 }
539 }
540
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000541 if (pythonhome == NULL || *pythonhome == '\0') {
542 if (search_for_prefix(argv0_path, LANDMARK))
543 pythonhome = prefix;
544 else
545 pythonhome = NULL;
546 }
547 else
548 wcsncpy(prefix, pythonhome, MAXPATHLEN);
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000549
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000550 if (envpath && *envpath == '\0')
551 envpath = NULL;
Guido van Rossumeea14491997-08-13 21:30:44 +0000552
Guido van Rossume02e48b2000-03-29 01:49:47 +0000553
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000554#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000555 /* Calculate zip archive path */
556 if (dllpath[0]) /* use name of python DLL */
557 wcsncpy(zip_path, dllpath, MAXPATHLEN);
558 else /* use name of executable program */
559 wcsncpy(zip_path, progpath, MAXPATHLEN);
560 zip_path[MAXPATHLEN] = '\0';
561 len = wcslen(zip_path);
562 if (len > 4) {
563 zip_path[len-3] = 'z'; /* change ending to "zip" */
564 zip_path[len-2] = 'i';
565 zip_path[len-1] = 'p';
566 }
567 else {
568 zip_path[0] = 0;
569 }
570
571 skiphome = pythonhome==NULL ? 0 : 1;
Martin v. Löwisbc186a82009-02-02 15:32:22 +0000572#ifdef Py_ENABLE_SHARED
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000573 machinepath = getpythonregpath(HKEY_LOCAL_MACHINE, skiphome);
574 userpath = getpythonregpath(HKEY_CURRENT_USER, skiphome);
Martin v. Löwisbc186a82009-02-02 15:32:22 +0000575#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000576 /* We only use the default relative PYTHONPATH if we havent
577 anything better to use! */
578 skipdefault = envpath!=NULL || pythonhome!=NULL || \
579 machinepath!=NULL || userpath!=NULL;
Guido van Rossum43ff1141998-08-08 23:40:40 +0000580#endif
581
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000582 /* We need to construct a path from the following parts.
583 (1) the PYTHONPATH environment variable, if set;
584 (2) for Win32, the zip archive file path;
585 (3) for Win32, the machinepath and userpath, if set;
586 (4) the PYTHONPATH config macro, with the leading "."
587 of each component replaced with pythonhome, if set;
588 (5) the directory containing the executable (argv0_path).
589 The length calculation calculates #4 first.
590 Extra rules:
591 - If PYTHONHOME is set (in any way) item (3) is ignored.
592 - If registry values are used, (4) and (5) are ignored.
593 */
Guido van Rossumeea14491997-08-13 21:30:44 +0000594
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000595 /* Calculate size of return buffer */
596 if (pythonhome != NULL) {
597 wchar_t *p;
598 bufsz = 1;
599 for (p = PYTHONPATH; *p; p++) {
600 if (*p == DELIM)
601 bufsz++; /* number of DELIM plus one */
602 }
603 bufsz *= wcslen(pythonhome);
604 }
605 else
606 bufsz = 0;
607 bufsz += wcslen(PYTHONPATH) + 1;
608 bufsz += wcslen(argv0_path) + 1;
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000609#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000610 if (userpath)
611 bufsz += wcslen(userpath) + 1;
612 if (machinepath)
613 bufsz += wcslen(machinepath) + 1;
614 bufsz += wcslen(zip_path) + 1;
Guido van Rossumeea14491997-08-13 21:30:44 +0000615#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000616 if (envpath != NULL)
617 bufsz += wcslen(envpath) + 1;
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000618
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000619 module_search_path = buf = malloc(bufsz*sizeof(wchar_t));
620 if (buf == NULL) {
621 /* We can't exit, so print a warning and limp along */
622 fprintf(stderr, "Can't malloc dynamic PYTHONPATH.\n");
623 if (envpath) {
624 fprintf(stderr, "Using environment $PYTHONPATH.\n");
625 module_search_path = envpath;
626 }
627 else {
628 fprintf(stderr, "Using default static path.\n");
629 module_search_path = PYTHONPATH;
630 }
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000631#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000632 if (machinepath)
633 free(machinepath);
634 if (userpath)
635 free(userpath);
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000636#endif /* MS_WINDOWS */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000637 return;
638 }
Guido van Rossumeea14491997-08-13 21:30:44 +0000639
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000640 if (envpath) {
641 wcscpy(buf, envpath);
642 buf = wcschr(buf, L'\0');
643 *buf++ = DELIM;
644 }
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000645#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000646 if (zip_path[0]) {
647 wcscpy(buf, zip_path);
648 buf = wcschr(buf, L'\0');
649 *buf++ = DELIM;
650 }
651 if (userpath) {
652 wcscpy(buf, userpath);
653 buf = wcschr(buf, L'\0');
654 *buf++ = DELIM;
655 free(userpath);
656 }
657 if (machinepath) {
658 wcscpy(buf, machinepath);
659 buf = wcschr(buf, L'\0');
660 *buf++ = DELIM;
661 free(machinepath);
662 }
663 if (pythonhome == NULL) {
664 if (!skipdefault) {
665 wcscpy(buf, PYTHONPATH);
666 buf = wcschr(buf, L'\0');
667 }
668 }
Guido van Rossum88716bb2000-03-30 19:45:39 +0000669#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000670 if (pythonhome == NULL) {
671 wcscpy(buf, PYTHONPATH);
672 buf = wcschr(buf, L'\0');
673 }
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000674#endif /* MS_WINDOWS */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000675 else {
676 wchar_t *p = PYTHONPATH;
677 wchar_t *q;
678 size_t n;
679 for (;;) {
680 q = wcschr(p, DELIM);
681 if (q == NULL)
682 n = wcslen(p);
683 else
684 n = q-p;
685 if (p[0] == '.' && is_sep(p[1])) {
686 wcscpy(buf, pythonhome);
687 buf = wcschr(buf, L'\0');
688 p++;
689 n--;
690 }
691 wcsncpy(buf, p, n);
692 buf += n;
693 if (q == NULL)
694 break;
695 *buf++ = DELIM;
696 p = q+1;
697 }
698 }
699 if (argv0_path) {
700 *buf++ = DELIM;
701 wcscpy(buf, argv0_path);
702 buf = wcschr(buf, L'\0');
703 }
704 *buf = L'\0';
705 /* Now to pull one last hack/trick. If sys.prefix is
706 empty, then try and find it somewhere on the paths
707 we calculated. We scan backwards, as our general policy
708 is that Python core directories are at the *end* of
709 sys.path. We assume that our "lib" directory is
710 on the path, and that our 'prefix' directory is
711 the parent of that.
712 */
713 if (*prefix==L'\0') {
714 wchar_t lookBuf[MAXPATHLEN+1];
715 wchar_t *look = buf - 1; /* 'buf' is at the end of the buffer */
716 while (1) {
717 Py_ssize_t nchars;
718 wchar_t *lookEnd = look;
719 /* 'look' will end up one character before the
720 start of the path in question - even if this
721 is one character before the start of the buffer
722 */
723 while (look >= module_search_path && *look != DELIM)
724 look--;
725 nchars = lookEnd-look;
726 wcsncpy(lookBuf, look+1, nchars);
727 lookBuf[nchars] = L'\0';
728 /* Up one level to the parent */
729 reduce(lookBuf);
730 if (search_for_prefix(lookBuf, LANDMARK)) {
731 break;
732 }
733 /* If we are out of paths to search - give up */
734 if (look < module_search_path)
735 break;
736 look--;
737 }
738 }
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000739}
740
741
742/* External interface */
743
Kristján Valur Jónsson3b69db22010-09-27 05:32:54 +0000744void
745Py_SetPath(const wchar_t *path)
746{
747 if (module_search_path != NULL) {
748 free(module_search_path);
749 module_search_path = NULL;
750 }
751 if (path != NULL) {
752 extern wchar_t *Py_GetProgramName(void);
753 wchar_t *prog = Py_GetProgramName();
754 wcsncpy(progpath, prog, MAXPATHLEN);
755 prefix[0] = L'\0';
756 module_search_path = malloc((wcslen(path) + 1) * sizeof(wchar_t));
757 if (module_search_path != NULL)
758 wcscpy(module_search_path, path);
759 }
760}
761
Martin v. Löwis790465f2008-04-05 20:41:37 +0000762wchar_t *
Thomas Wouters78890102000-07-22 19:25:51 +0000763Py_GetPath(void)
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000764{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000765 if (!module_search_path)
766 calculate_path();
767 return module_search_path;
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000768}
769
Martin v. Löwis790465f2008-04-05 20:41:37 +0000770wchar_t *
Thomas Wouters78890102000-07-22 19:25:51 +0000771Py_GetPrefix(void)
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000772{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000773 if (!module_search_path)
774 calculate_path();
775 return prefix;
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000776}
777
Martin v. Löwis790465f2008-04-05 20:41:37 +0000778wchar_t *
Thomas Wouters78890102000-07-22 19:25:51 +0000779Py_GetExecPrefix(void)
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000780{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000781 return Py_GetPrefix();
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000782}
783
Martin v. Löwis790465f2008-04-05 20:41:37 +0000784wchar_t *
Thomas Wouters78890102000-07-22 19:25:51 +0000785Py_GetProgramFullPath(void)
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000786{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000787 if (!module_search_path)
788 calculate_path();
789 return progpath;
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +0000790}
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000791
Victor Stinner63941882011-09-29 00:42:28 +0200792/* Load python3.dll before loading any extension module that might refer
793 to it. That way, we can be sure that always the python3.dll corresponding
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000794 to this python DLL is loaded, not a python3.dll that might be on the path
795 by chance.
796 Return whether the DLL was found.
797*/
798static int python3_checked = 0;
799static HANDLE hPython3;
800int
801_Py_CheckPython3()
802{
803 wchar_t py3path[MAXPATHLEN+1];
804 wchar_t *s;
805 if (python3_checked)
806 return hPython3 != NULL;
807 python3_checked = 1;
808
809 /* If there is a python3.dll next to the python3y.dll,
810 assume this is a build tree; use that DLL */
811 wcscpy(py3path, dllpath);
812 s = wcsrchr(py3path, L'\\');
813 if (!s)
814 s = py3path;
815 wcscpy(s, L"\\python3.dll");
816 hPython3 = LoadLibraryExW(py3path, NULL, LOAD_WITH_ALTERED_SEARCH_PATH);
817 if (hPython3 != NULL)
818 return 1;
819
820 /* Check sys.prefix\DLLs\python3.dll */
821 wcscpy(py3path, Py_GetPrefix());
822 wcscat(py3path, L"\\DLLs\\python3.dll");
823 hPython3 = LoadLibraryExW(py3path, NULL, LOAD_WITH_ALTERED_SEARCH_PATH);
824 return hPython3 != NULL;
825}