]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - cups/globals.c
Remove all of the Subversion keywords from various source files.
[thirdparty/cups.git] / cups / globals.c
index d104f1b50467b947c7c4e1d737da3451fd479ed4..6131a5cfbc3e6b5d86f50003db4e74b71f46484d 100644 (file)
@@ -1,81 +1,74 @@
 /*
- * "$Id: globals.c 7460 2008-04-16 02:19:54Z mike $"
+ * Global variable access routines for CUPS.
  *
- *   Global variable access routines for the Common UNIX Printing System (CUPS).
+ * Copyright 2007-2015 by Apple Inc.
+ * Copyright 1997-2007 by Easy Software Products, all rights reserved.
  *
- *   Copyright 2007-2008 by Apple Inc.
- *   Copyright 1997-2007 by Easy Software Products, all rights reserved.
+ * These coded instructions, statements, and computer programs are the
+ * property of Apple Inc. and are protected by Federal copyright
+ * law.  Distribution and use rights are outlined in the file "LICENSE.txt"
+ * which should have been included with this file.  If this file is
+ * file is missing or damaged, see the license at "http://www.cups.org/".
  *
- *   These coded instructions, statements, and computer programs are the
- *   property of Apple Inc. and are protected by Federal copyright
- *   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
- *   which should have been included with this file.  If this file is
- *   file is missing or damaged, see the license at "http://www.cups.org/".
- *
- *   This file is subject to the Apple OS-Developed Software exception.
- *
- * Contents:
- *
- *   _cupsGlobals()      - Return a pointer to thread local storage.
- *   cups_env_init()      - Initialize environment variables.
- *   globals_init()       - Initialize globals once.
- *   globals_destructor() - Free memory allocated by _cupsGlobals().
+ * This file is subject to the Apple OS-Developed Software exception.
  */
 
 /*
  * Include necessary headers...
  */
 
-#include "http-private.h"
-#include "globals.h"
-#include <stdlib.h>
+#include "cups-private.h"
 
 
 /*
- * 'cups_env_init()' - Initialize environment variables.
+ * Local globals...
  */
 
-static void
-cups_env_init(_cups_globals_t *g)      /* I - Global data */
-{
-  if ((g->cups_datadir = getenv("CUPS_DATADIR")) == NULL)
-    g->cups_datadir = CUPS_DATADIR;
-
-  if ((g->cups_serverbin = getenv("CUPS_SERVERBIN")) == NULL)
-    g->cups_serverbin = CUPS_SERVERBIN;
-
-  if ((g->cups_serverroot = getenv("CUPS_SERVERROOT")) == NULL)
-    g->cups_serverroot = CUPS_SERVERROOT;
-
-  if ((g->cups_statedir = getenv("CUPS_STATEDIR")) == NULL)
-    g->cups_statedir = CUPS_STATEDIR;
-
-  if ((g->localedir = getenv("LOCALEDIR")) == NULL)
-    g->localedir = CUPS_LOCALEDIR;
-}
-
-
+#ifdef DEBUG
+static int             cups_global_index = 0;
+                                       /* Next thread number */
+#endif /* DEBUG */
+static _cups_threadkey_t cups_globals_key = _CUPS_THREADKEY_INITIALIZER;
+                                       /* Thread local storage key */
 #ifdef HAVE_PTHREAD_H
-/*
- * Implement per-thread globals...
- */
+static pthread_once_t  cups_globals_key_once = PTHREAD_ONCE_INIT;
+                                       /* One-time initialization object */
+#endif /* HAVE_PTHREAD_H */
+#if defined(HAVE_PTHREAD_H) || defined(WIN32)
+static _cups_mutex_t   cups_global_mutex = _CUPS_MUTEX_INITIALIZER;
+                                       /* Global critical section */
+#endif /* HAVE_PTHREAD_H || WIN32 */
+
 
 /*
- * Local globals...
+ * Local functions...
  */
 
-static pthread_key_t   globals_key = -1;
-                                       /* Thread local storage key */
-static pthread_once_t  globals_key_once = PTHREAD_ONCE_INIT;
-                                       /* One-time initialization object */
+#ifdef WIN32
+static void            cups_fix_path(char *path);
+#endif /* WIN32 */
+static _cups_globals_t *cups_globals_alloc(void);
+#if defined(HAVE_PTHREAD_H) || defined(WIN32)
+static void            cups_globals_free(_cups_globals_t *g);
+#endif /* HAVE_PTHREAD_H || WIN32 */
+#ifdef HAVE_PTHREAD_H
+static void            cups_globals_init(void);
+#endif /* HAVE_PTHREAD_H */
 
 
 /*
- * Local functions...
+ * '_cupsGlobalLock()' - Lock the global mutex.
  */
 
-static void    globals_init();
-static void    globals_destructor(void *value);
+void
+_cupsGlobalLock(void)
+{
+#ifdef HAVE_PTHREAD_H
+  pthread_mutex_lock(&cups_global_mutex);
+#elif defined(WIN32)
+  EnterCriticalSection(&cups_global_mutex.m_criticalSection);
+#endif /* HAVE_PTHREAD_H */
+}
 
 
 /*
@@ -85,125 +78,302 @@ static void       globals_destructor(void *value);
 _cups_globals_t *                      /* O - Pointer to global data */
 _cupsGlobals(void)
 {
-  _cups_globals_t *globals;            /* Pointer to global data */
+  _cups_globals_t *cg;                 /* Pointer to global data */
 
 
- /* 
+#ifdef HAVE_PTHREAD_H
+ /*
   * Initialize the global data exactly once...
   */
 
-  pthread_once(&globals_key_once, globals_init);
+  pthread_once(&cups_globals_key_once, cups_globals_init);
+#endif /* HAVE_PTHREAD_H */
 
  /*
   * See if we have allocated the data yet...
   */
 
-  if ((globals = (_cups_globals_t *)pthread_getspecific(globals_key)) == NULL)
+  if ((cg = (_cups_globals_t *)_cupsThreadGetData(cups_globals_key)) == NULL)
   {
    /*
     * No, allocate memory as set the pointer for the key...
     */
 
-    globals = calloc(1, sizeof(_cups_globals_t));
-    pthread_setspecific(globals_key, globals);
-
-   /*
-    * Initialize variables that have non-zero values
-    */
-
-    globals->encryption  = (http_encryption_t)-1;
-    globals->password_cb = _cupsGetPassword;
-
-    cups_env_init(globals);
+    if ((cg = cups_globals_alloc()) != NULL)
+      _cupsThreadSetData(cups_globals_key, cg);
   }
 
  /*
   * Return the pointer to the data...
   */
 
-  return (globals);
+  return (cg);
 }
 
 
 /*
- * 'globals_init()' - Initialize globals once.
+ * '_cupsGlobalUnlock()' - Unlock the global mutex.
  */
 
-static void
-globals_init()
+void
+_cupsGlobalUnlock(void)
 {
-  pthread_key_create(&globals_key, globals_destructor);
+#ifdef HAVE_PTHREAD_H
+  pthread_mutex_unlock(&cups_global_mutex);
+#elif defined(WIN32)
+  LeaveCriticalSection(&cups_global_mutex.m_criticalSection);
+#endif /* HAVE_PTHREAD_H */
 }
 
 
+#ifdef WIN32
 /*
- * 'globals_destructor()' - Free memory allocated by _cupsGlobals().
+ * 'DllMain()' - Main entry for library.
  */
 
-static void
-globals_destructor(void *value)                /* I - Data to free */
+BOOL WINAPI                            /* O - Success/failure */
+DllMain(HINSTANCE hinst,               /* I - DLL module handle */
+        DWORD     reason,              /* I - Reason */
+        LPVOID    reserved)            /* I - Unused */
 {
-  int                  i;              /* Looping var */
-  _cups_globals_t      *cg;            /* Global data */
+  _cups_globals_t *cg;                 /* Global data */
 
 
-  cg = (_cups_globals_t *)value;
+  (void)hinst;
+  (void)reserved;
 
-  httpClose(cg->http);
+  switch (reason)
+  {
+    case DLL_PROCESS_ATTACH :          /* Called on library initialization */
+        InitializeCriticalSection(&cups_global_mutex.m_criticalSection);
 
-  for (i = 0; i < 3; i ++)
-    cupsFileClose(cg->stdio_files[i]);
+        if ((cups_globals_key = TlsAlloc()) == TLS_OUT_OF_INDEXES)
+          return (FALSE);
+        break;
 
-  if (cg->last_status_message)
-    free(cg->last_status_message);
+    case DLL_THREAD_DETACH :           /* Called when a thread terminates */
+        if ((cg = (_cups_globals_t *)TlsGetValue(cups_globals_key)) != NULL)
+          cups_globals_free(cg);
+        break;
 
-  cupsFreeOptions(cg->cupsd_num_settings, cg->cupsd_settings);
+    case DLL_PROCESS_DETACH :          /* Called when library is unloaded */
+        if ((cg = (_cups_globals_t *)TlsGetValue(cups_globals_key)) != NULL)
+          cups_globals_free(cg);
 
-  free(value);
-}
+        TlsFree(cups_globals_key);
+        DeleteCriticalSection(&cups_global_mutex.m_criticalSection);
+        break;
 
+    default:
+        break;
+  }
+
+  return (TRUE);
+}
+#endif /* WIN32 */
 
-#else
-/*
- * Implement static globals...
- */
 
 /*
- * '_cupsGlobals()' - Return a pointer to thread local storage.
+ * 'cups_globals_alloc()' - Allocate and initialize global data.
  */
 
-_cups_globals_t *                      /* O - Pointer to global data */
-_cupsGlobals(void)
+static _cups_globals_t *               /* O - Pointer to global data */
+cups_globals_alloc(void)
 {
-  static _cups_globals_t globals;      /* Global data */
-  static int           initialized = 0;/* Global data initialized? */
+  _cups_globals_t *cg = malloc(sizeof(_cups_globals_t));
+                                       /* Pointer to global data */
+#ifdef WIN32
+  HKEY         key;                    /* Registry key */
+  DWORD                size;                   /* Size of string */
+  static char  installdir[1024] = "",  /* Install directory */
+               confdir[1024] = "",     /* Server root directory */
+               localedir[1024] = "";   /* Locale directory */
+#endif /* WIN32 */
+
+
+  if (!cg)
+    return (NULL);
 
+ /*
+  * Clear the global storage and set the default encryption and password
+  * callback values...
+  */
+
+  memset(cg, 0, sizeof(_cups_globals_t));
+  cg->encryption     = (http_encryption_t)-1;
+  cg->password_cb    = (cups_password_cb2_t)_cupsGetPassword;
+  cg->any_root       = -1;
+  cg->expired_certs  = -1;
+  cg->validate_certs = -1;
+
+#ifdef DEBUG
+ /*
+  * Friendly thread ID for debugging...
+  */
+
+  cg->thread_id = ++ cups_global_index;
+#endif /* DEBUG */
 
  /*
-  * Initialize global data as needed...
+  * Then set directories as appropriate...
   */
 
-  if (!initialized)
+#ifdef WIN32
+  if (!installdir[0])
   {
-    initialized = 1;
+   /*
+    * Open the registry...
+    */
+
+    strlcpy(installdir, "C:/Program Files/cups.org", sizeof(installdir));
+
+    if (!RegOpenKeyEx(HKEY_LOCAL_MACHINE, "SOFTWARE\\cups.org", 0, KEY_READ,
+                      &key))
+    {
+     /*
+      * Grab the installation directory...
+      */
+
+      char  *ptr;                      /* Pointer into installdir */
+
+      size = sizeof(installdir);
+      RegQueryValueEx(key, "installdir", NULL, NULL, installdir, &size);
+      RegCloseKey(key);
+
+      for (ptr = installdir; *ptr;)
+      {
+        if (*ptr == '\\')
+        {
+          if (ptr[1])
+            *ptr++ = '/';
+          else
+            *ptr = '\0';               /* Strip trailing \ */
+        }
+        else if (*ptr == '/' && !ptr[1])
+          *ptr = '\0';                 /* Strip trailing / */
+        else
+          ptr ++;
+      }
+    }
+
+    snprintf(confdir, sizeof(confdir), "%s/conf", installdir);
+    snprintf(localedir, sizeof(localedir), "%s/locale", installdir);
+  }
+
+  if ((cg->cups_datadir = getenv("CUPS_DATADIR")) == NULL)
+    cg->cups_datadir = installdir;
+
+  if ((cg->cups_serverbin = getenv("CUPS_SERVERBIN")) == NULL)
+    cg->cups_serverbin = installdir;
+
+  if ((cg->cups_serverroot = getenv("CUPS_SERVERROOT")) == NULL)
+    cg->cups_serverroot = confdir;
+
+  if ((cg->cups_statedir = getenv("CUPS_STATEDIR")) == NULL)
+    cg->cups_statedir = confdir;
 
+  if ((cg->localedir = getenv("LOCALEDIR")) == NULL)
+    cg->localedir = localedir;
+
+#else
+#  ifdef HAVE_GETEUID
+  if ((geteuid() != getuid() && getuid()) || getegid() != getgid())
+#  else
+  if (!getuid())
+#  endif /* HAVE_GETEUID */
+  {
+   /*
+    * When running setuid/setgid, don't allow environment variables to override
+    * the directories...
+    */
+
+    cg->cups_datadir    = CUPS_DATADIR;
+    cg->cups_serverbin  = CUPS_SERVERBIN;
+    cg->cups_serverroot = CUPS_SERVERROOT;
+    cg->cups_statedir   = CUPS_STATEDIR;
+    cg->localedir       = CUPS_LOCALEDIR;
+  }
+  else
+  {
    /*
-    * Initialize global variables...
+    * Allow directories to be overridden by environment variables.
     */
 
-    memset(&globals, 0, sizeof(globals));
+    if ((cg->cups_datadir = getenv("CUPS_DATADIR")) == NULL)
+      cg->cups_datadir = CUPS_DATADIR;
+
+    if ((cg->cups_serverbin = getenv("CUPS_SERVERBIN")) == NULL)
+      cg->cups_serverbin = CUPS_SERVERBIN;
 
-    globals.encryption  = (http_encryption_t)-1;
-    globals.password_cb = _cupsGetPassword;
+    if ((cg->cups_serverroot = getenv("CUPS_SERVERROOT")) == NULL)
+      cg->cups_serverroot = CUPS_SERVERROOT;
 
-    cups_env_init(&globals);
+    if ((cg->cups_statedir = getenv("CUPS_STATEDIR")) == NULL)
+      cg->cups_statedir = CUPS_STATEDIR;
+
+    if ((cg->localedir = getenv("LOCALEDIR")) == NULL)
+      cg->localedir = CUPS_LOCALEDIR;
   }
+#endif /* WIN32 */
 
-  return (&globals);
+  return (cg);
 }
-#endif /* HAVE_PTHREAD_H */
 
 
 /*
- * End of "$Id: globals.c 7460 2008-04-16 02:19:54Z mike $".
+ * 'cups_globals_free()' - Free global data.
  */
+
+#if defined(HAVE_PTHREAD_H) || defined(WIN32)
+static void
+cups_globals_free(_cups_globals_t *cg) /* I - Pointer to global data */
+{
+  _cups_buffer_t       *buffer,        /* Current read/write buffer */
+                       *next;          /* Next buffer */
+
+
+  if (cg->last_status_message)
+    _cupsStrFree(cg->last_status_message);
+
+  for (buffer = cg->cups_buffers; buffer; buffer = next)
+  {
+    next = buffer->next;
+    free(buffer);
+  }
+
+  cupsArrayDelete(cg->leg_size_lut);
+  cupsArrayDelete(cg->ppd_size_lut);
+  cupsArrayDelete(cg->pwg_size_lut);
+
+  httpClose(cg->http);
+
+#ifdef HAVE_SSL
+  _httpFreeCredentials(cg->tls_credentials);
+#endif /* HAVE_SSL */
+
+  cupsFileClose(cg->stdio_files[0]);
+  cupsFileClose(cg->stdio_files[1]);
+  cupsFileClose(cg->stdio_files[2]);
+
+  cupsFreeOptions(cg->cupsd_num_settings, cg->cupsd_settings);
+
+  free(cg);
+}
+#endif /* HAVE_PTHREAD_H || WIN32 */
+
+
+#ifdef HAVE_PTHREAD_H
+/*
+ * 'cups_globals_init()' - Initialize environment variables.
+ */
+
+static void
+cups_globals_init(void)
+{
+ /*
+  * Register the global data for this thread...
+  */
+
+  pthread_key_create(&cups_globals_key, (void (*)(void *))cups_globals_free);
+}
+#endif /* HAVE_PTHREAD_H */