]> git.ipfire.org Git - thirdparty/cups.git/blame - cups/globals.c
Import CUPS v1.7.1
[thirdparty/cups.git] / cups / globals.c
CommitLineData
ef416fc2 1/*
61515785 2 * "$Id: globals.c 11113 2013-07-10 14:08:39Z msweet $"
ef416fc2 3 *
71e16022 4 * Global variable access routines for CUPS.
ef416fc2 5 *
0cb67df3 6 * Copyright 2007-2013 by Apple Inc.
f7deaa1a 7 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
ef416fc2 8 *
9 * These coded instructions, statements, and computer programs are the
bc44d920 10 * property of Apple Inc. and are protected by Federal copyright
11 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 * which should have been included with this file. If this file is
13 * file is missing or damaged, see the license at "http://www.cups.org/".
ef416fc2 14 *
15 * This file is subject to the Apple OS-Developed Software exception.
16 *
17 * Contents:
18 *
6d2f911b
MS
19 * _cupsGlobalLock() - Lock the global mutex.
20 * _cupsGlobals() - Return a pointer to thread local storage
21 * _cupsGlobalUnlock() - Unlock the global mutex.
22 * DllMain() - Main entry for library.
12f89d24 23 * cups_fix_path() - Fix a file path to use forward slashes consistently.
6d2f911b
MS
24 * cups_globals_alloc() - Allocate and initialize global data.
25 * cups_globals_free() - Free global data.
26 * cups_globals_init() - Initialize environment variables.
ef416fc2 27 */
28
29/*
30 * Include necessary headers...
31 */
32
71e16022 33#include "cups-private.h"
ef416fc2 34
35
36/*
6d2f911b 37 * Local globals...
ef416fc2 38 */
39
f8b3a85b 40
a469f8a5
MS
41#ifdef DEBUG
42static int cups_global_index = 0;
43 /* Next thread number */
44#endif /* DEBUG */
6d2f911b
MS
45static _cups_threadkey_t cups_globals_key = _CUPS_THREADKEY_INITIALIZER;
46 /* Thread local storage key */
47#ifdef HAVE_PTHREAD_H
48static pthread_once_t cups_globals_key_once = PTHREAD_ONCE_INIT;
49 /* One-time initialization object */
50#endif /* HAVE_PTHREAD_H */
f3c17241 51#if defined(HAVE_PTHREAD_H) || defined(WIN32)
6d2f911b
MS
52static _cups_mutex_t cups_global_mutex = _CUPS_MUTEX_INITIALIZER;
53 /* Global critical section */
f3c17241 54#endif /* HAVE_PTHREAD_H || WIN32 */
f8b3a85b 55
f8b3a85b 56
6d2f911b
MS
57/*
58 * Local functions...
59 */
f8b3a85b 60
12f89d24
MS
61#ifdef WIN32
62static void cups_fix_path(char *path);
63#endif /* WIN32 */
6d2f911b 64static _cups_globals_t *cups_globals_alloc(void);
f3c17241 65#if defined(HAVE_PTHREAD_H) || defined(WIN32)
6d2f911b 66static void cups_globals_free(_cups_globals_t *g);
f3c17241 67#endif /* HAVE_PTHREAD_H || WIN32 */
6d2f911b
MS
68#ifdef HAVE_PTHREAD_H
69static void cups_globals_init(void);
70#endif /* HAVE_PTHREAD_H */
f8b3a85b 71
f8b3a85b 72
6d2f911b
MS
73/*
74 * '_cupsGlobalLock()' - Lock the global mutex.
75 */
f8b3a85b 76
6d2f911b
MS
77void
78_cupsGlobalLock(void)
79{
80#ifdef HAVE_PTHREAD_H
81 pthread_mutex_lock(&cups_global_mutex);
82#elif defined(WIN32)
cc754834 83 EnterCriticalSection(&cups_global_mutex.m_criticalSection);
6d2f911b
MS
84#endif /* HAVE_PTHREAD_H */
85}
f8b3a85b 86
f8b3a85b 87
6d2f911b
MS
88/*
89 * '_cupsGlobals()' - Return a pointer to thread local storage
90 */
f8b3a85b 91
6d2f911b
MS
92_cups_globals_t * /* O - Pointer to global data */
93_cupsGlobals(void)
94{
95 _cups_globals_t *cg; /* Pointer to global data */
f8b3a85b 96
f8b3a85b 97
6d2f911b
MS
98#ifdef HAVE_PTHREAD_H
99 /*
100 * Initialize the global data exactly once...
101 */
102
103 pthread_once(&cups_globals_key_once, cups_globals_init);
104#endif /* HAVE_PTHREAD_H */
105
106 /*
107 * See if we have allocated the data yet...
108 */
109
110 if ((cg = (_cups_globals_t *)_cupsThreadGetData(cups_globals_key)) == NULL)
5180a04c
MS
111 {
112 /*
6d2f911b 113 * No, allocate memory as set the pointer for the key...
5180a04c 114 */
ef416fc2 115
6d2f911b
MS
116 if ((cg = cups_globals_alloc()) != NULL)
117 _cupsThreadSetData(cups_globals_key, cg);
5180a04c 118 }
ef416fc2 119
6d2f911b
MS
120 /*
121 * Return the pointer to the data...
122 */
ef416fc2 123
6d2f911b
MS
124 return (cg);
125}
5180a04c 126
5180a04c 127
6d2f911b
MS
128/*
129 * '_cupsGlobalUnlock()' - Unlock the global mutex.
130 */
5180a04c 131
6d2f911b
MS
132void
133_cupsGlobalUnlock(void)
134{
135#ifdef HAVE_PTHREAD_H
136 pthread_mutex_unlock(&cups_global_mutex);
137#elif defined(WIN32)
cc754834 138 LeaveCriticalSection(&cups_global_mutex.m_criticalSection);
6d2f911b 139#endif /* HAVE_PTHREAD_H */
ef416fc2 140}
141
142
6d2f911b 143#ifdef WIN32
ef416fc2 144/*
6d2f911b 145 * 'DllMain()' - Main entry for library.
ef416fc2 146 */
147
6d2f911b
MS
148BOOL WINAPI /* O - Success/failure */
149DllMain(HINSTANCE hinst, /* I - DLL module handle */
150 DWORD reason, /* I - Reason */
151 LPVOID reserved) /* I - Unused */
152{
153 _cups_globals_t *cg; /* Global data */
ef416fc2 154
ef416fc2 155
6d2f911b
MS
156 (void)hinst;
157 (void)reserved;
ef416fc2 158
6d2f911b
MS
159 switch (reason)
160 {
161 case DLL_PROCESS_ATTACH : /* Called on library initialization */
cc754834 162 InitializeCriticalSection(&cups_global_mutex.m_criticalSection);
6d2f911b
MS
163
164 if ((cups_globals_key = TlsAlloc()) == TLS_OUT_OF_INDEXES)
165 return (FALSE);
166 break;
167
168 case DLL_THREAD_DETACH : /* Called when a thread terminates */
169 if ((cg = (_cups_globals_t *)TlsGetValue(cups_globals_key)) != NULL)
170 cups_globals_free(cg);
171 break;
172
173 case DLL_PROCESS_DETACH : /* Called when library is unloaded */
174 if ((cg = (_cups_globals_t *)TlsGetValue(cups_globals_key)) != NULL)
175 cups_globals_free(cg);
ef416fc2 176
6d2f911b 177 TlsFree(cups_globals_key);
cc754834 178 DeleteCriticalSection(&cups_global_mutex.m_criticalSection);
6d2f911b
MS
179 break;
180
181 default:
182 break;
183 }
184
185 return (TRUE);
186}
187#endif /* WIN32 */
ef416fc2 188
189
190/*
6d2f911b 191 * 'cups_globals_alloc()' - Allocate and initialize global data.
ef416fc2 192 */
193
6d2f911b
MS
194static _cups_globals_t * /* O - Pointer to global data */
195cups_globals_alloc(void)
ef416fc2 196{
6d2f911b
MS
197 _cups_globals_t *cg = malloc(sizeof(_cups_globals_t));
198 /* Pointer to global data */
199#ifdef WIN32
200 HKEY key; /* Registry key */
201 DWORD size; /* Size of string */
12f89d24
MS
202 static char installdir[1024] = "", /* Install directory */
203 confdir[1024] = "", /* Server root directory */
204 localedir[1024] = ""; /* Locale directory */
6d2f911b
MS
205#endif /* WIN32 */
206
ef416fc2 207
6d2f911b
MS
208 if (!cg)
209 return (NULL);
ef416fc2 210
5180a04c 211 /*
6d2f911b
MS
212 * Clear the global storage and set the default encryption and password
213 * callback values...
ef416fc2 214 */
215
6d2f911b 216 memset(cg, 0, sizeof(_cups_globals_t));
c1420c87
MS
217 cg->encryption = (http_encryption_t)-1;
218 cg->password_cb = (cups_password_cb2_t)_cupsGetPassword;
219 cg->any_root = 1;
220 cg->expired_certs = 1;
221 cg->expired_root = 1;
ef416fc2 222
a469f8a5
MS
223#ifdef DEBUG
224 /*
225 * Friendly thread ID for debugging...
226 */
227
228 cg->thread_id = ++ cups_global_index;
229#endif /* DEBUG */
230
ef416fc2 231 /*
6d2f911b
MS
232 * Then set directories as appropriate...
233 */
234
235#ifdef WIN32
12f89d24 236 if (!installdir[0])
ef416fc2 237 {
238 /*
12f89d24 239 * Open the registry...
ef416fc2 240 */
241
5a9febac 242 strlcpy(installdir, "C:/Program Files/cups.org", sizeof(installdir));
12f89d24
MS
243
244 if (!RegOpenKeyEx(HKEY_LOCAL_MACHINE, "SOFTWARE\\cups.org", 0, KEY_READ,
245 &key))
246 {
247 /*
248 * Grab the installation directory...
249 */
250
251 char *ptr; /* Pointer into installdir */
252
253 size = sizeof(installdir);
254 RegQueryValueEx(key, "installdir", NULL, NULL, installdir, &size);
255 RegCloseKey(key);
256
257 for (ptr = installdir; *ptr;)
258 {
259 if (*ptr == '\\')
260 {
261 if (ptr[1])
262 *ptr++ = '/';
263 else
264 *ptr = '\0'; /* Strip trailing \ */
265 }
266 else if (*ptr == '/' && !ptr[1])
267 *ptr = '\0'; /* Strip trailing / */
268 else
269 ptr ++;
270 }
271 }
272
273 snprintf(confdir, sizeof(confdir), "%s/conf", installdir);
274 snprintf(localedir, sizeof(localedir), "%s/locale", installdir);
6d2f911b
MS
275 }
276
6d2f911b
MS
277 if ((cg->cups_datadir = getenv("CUPS_DATADIR")) == NULL)
278 cg->cups_datadir = installdir;
ef416fc2 279
6d2f911b
MS
280 if ((cg->cups_serverbin = getenv("CUPS_SERVERBIN")) == NULL)
281 cg->cups_serverbin = installdir;
282
283 if ((cg->cups_serverroot = getenv("CUPS_SERVERROOT")) == NULL)
284 cg->cups_serverroot = confdir;
285
286 if ((cg->cups_statedir = getenv("CUPS_STATEDIR")) == NULL)
287 cg->cups_statedir = confdir;
288
289 if ((cg->localedir = getenv("LOCALEDIR")) == NULL)
290 cg->localedir = localedir;
291
292#else
293# ifdef HAVE_GETEUID
294 if ((geteuid() != getuid() && getuid()) || getegid() != getgid())
295# else
296 if (!getuid())
297# endif /* HAVE_GETEUID */
298 {
ef416fc2 299 /*
6d2f911b
MS
300 * When running setuid/setgid, don't allow environment variables to override
301 * the directories...
ef416fc2 302 */
303
6d2f911b
MS
304 cg->cups_datadir = CUPS_DATADIR;
305 cg->cups_serverbin = CUPS_SERVERBIN;
306 cg->cups_serverroot = CUPS_SERVERROOT;
307 cg->cups_statedir = CUPS_STATEDIR;
308 cg->localedir = CUPS_LOCALEDIR;
ef416fc2 309 }
6d2f911b
MS
310 else
311 {
312 /*
313 * Allow directories to be overridden by environment variables.
314 */
ef416fc2 315
6d2f911b
MS
316 if ((cg->cups_datadir = getenv("CUPS_DATADIR")) == NULL)
317 cg->cups_datadir = CUPS_DATADIR;
ef416fc2 318
6d2f911b
MS
319 if ((cg->cups_serverbin = getenv("CUPS_SERVERBIN")) == NULL)
320 cg->cups_serverbin = CUPS_SERVERBIN;
ef416fc2 321
6d2f911b
MS
322 if ((cg->cups_serverroot = getenv("CUPS_SERVERROOT")) == NULL)
323 cg->cups_serverroot = CUPS_SERVERROOT;
ef416fc2 324
6d2f911b
MS
325 if ((cg->cups_statedir = getenv("CUPS_STATEDIR")) == NULL)
326 cg->cups_statedir = CUPS_STATEDIR;
ef416fc2 327
6d2f911b
MS
328 if ((cg->localedir = getenv("LOCALEDIR")) == NULL)
329 cg->localedir = CUPS_LOCALEDIR;
330 }
331#endif /* WIN32 */
332
333 return (cg);
ef416fc2 334}
335
336
337/*
6d2f911b 338 * 'cups_globals_free()' - Free global data.
ef416fc2 339 */
340
f3c17241 341#if defined(HAVE_PTHREAD_H) || defined(WIN32)
ef416fc2 342static void
6d2f911b 343cups_globals_free(_cups_globals_t *cg) /* I - Pointer to global data */
ef416fc2 344{
dcb445bc 345 _cups_buffer_t *buffer, /* Current read/write buffer */
1f6f3dbc 346 *next; /* Next buffer */
fa73b229 347
348
e53920b9 349 if (cg->last_status_message)
5f64df29 350 _cupsStrFree(cg->last_status_message);
e53920b9 351
dcb445bc 352 for (buffer = cg->cups_buffers; buffer; buffer = next)
1f6f3dbc
MS
353 {
354 next = buffer->next;
355 free(buffer);
356 }
357
c168a833 358 cupsArrayDelete(cg->leg_size_lut);
f14324a7
MS
359 cupsArrayDelete(cg->ppd_size_lut);
360 cupsArrayDelete(cg->pwg_size_lut);
c168a833 361
6d2f911b 362 httpClose(cg->http);
ef416fc2 363
7cf5915e
MS
364 _httpFreeCredentials(cg->tls_credentials);
365
6d2f911b
MS
366 cupsFileClose(cg->stdio_files[0]);
367 cupsFileClose(cg->stdio_files[1]);
368 cupsFileClose(cg->stdio_files[2]);
ef416fc2 369
6d2f911b 370 cupsFreeOptions(cg->cupsd_num_settings, cg->cupsd_settings);
ef416fc2 371
6d2f911b
MS
372 free(cg);
373}
f3c17241 374#endif /* HAVE_PTHREAD_H || WIN32 */
6d2f911b
MS
375
376
377#ifdef HAVE_PTHREAD_H
ef416fc2 378/*
6d2f911b 379 * 'cups_globals_init()' - Initialize environment variables.
ef416fc2 380 */
381
6d2f911b
MS
382static void
383cups_globals_init(void)
ef416fc2 384{
ef416fc2 385 /*
6d2f911b 386 * Register the global data for this thread...
ef416fc2 387 */
388
6d2f911b 389 pthread_key_create(&cups_globals_key, (void (*)(void *))cups_globals_free);
ef416fc2 390}
391#endif /* HAVE_PTHREAD_H */
392
393
394/*
61515785 395 * End of "$Id: globals.c 11113 2013-07-10 14:08:39Z msweet $".
ef416fc2 396 */