cups/globals.c

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