Introduce win32 registry handling through a very apr-ish interface.

  Deals with apr utf-8 encoding of filesystem values, so we preserve
  strings in any locality or nationalized flavor of WinNT, and avoid
  the gunk for Win9x.


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@95875 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 160 insertions, 0 deletions

diff --git a/include/ap_regkey.h b/include/ap_regkey.h
new file mode 100644
index 0000000000..b014a5f737
--- /dev/null
+++ b/include/ap_regkey.h
@@ -0,0 +1,160 @@
+/* ====================================================================
+ * The Apache Software License, Version 1.1
+ *
+ * Copyright (c) 2002 The Apache Software Foundation.  All rights
+ * reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ *
+ * 3. The end-user documentation included with the redistribution,
+ *    if any, must include the following acknowledgment:
+ *       "This product includes software developed by the
+ *        Apache Software Foundation (http://www.apache.org/)."
+ *    Alternately, this acknowledgment may appear in the software itself,
+ *    if and wherever such third-party acknowledgments normally appear.
+ *
+ * 4. The names "Apache" and "Apache Software Foundation" must
+ *    not be used to endorse or promote products derived from this
+ *    software without prior written permission. For written
+ *    permission, please contact apache@apache.org.
+ *
+ * 5. Products derived from this software may not be called "Apache",
+ *    nor may "Apache" appear in their name, without prior written
+ *    permission of the Apache Software Foundation.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation.  For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ *
+ * Portions of this software are based upon public domain software
+ * originally written at the National Center for Supercomputing Applications,
+ * University of Illinois, Urbana-Champaign.
+ */
+
+#ifndef AP_REGKEY_H
+#define AP_REGKEY_H
+
+#include "apr.h"
+#include "apr_pools.h"
+#include "ap_config.h"      /* Just for AP_DECLARE */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef struct ap_regkey_t ap_regkey_t;
+
+AP_DECLARE(const ap_regkey_t *) ap_regkey_const(int i);
+
+/**
+ * Constants for ap_regkey_open() only;
+ */
+#define AP_REGKEY_CLASSES_ROOT         ap_regkey_const(0)
+#define AP_REGKEY_CURRENT_CONFIG       ap_regkey_const(1)
+#define AP_REGKEY_CURRENT_USER         ap_regkey_const(2)
+#define AP_REGKEY_LOCAL_MACHINE        ap_regkey_const(3)
+#define AP_REGKEY_USERS                ap_regkey_const(4)
+#define AP_REGKEY_PERFORMANCE_DATA     ap_regkey_const(5)
+#define AP_REGKEY_DYN_DATA             ap_regkey_const(6)
+
+/**
+ * Open the specified win32 registry key.
+ * @param newkey The opened registry key
+ * @param parentkey The open registry key of the parent, or one of
+ * <PRE>
+ *           AP_REGKEY_CLASSES_ROOT
+ *           AP_REGKEY_CURRENT_CONFIG
+ *           AP_REGKEY_CURRENT_USER
+ *           AP_REGKEY_LOCAL_MACHINE
+ *           AP_REGKEY_USERS
+ *           AP_REGKEY_PERFORMANCE_DATA 
+ *           AP_REGKEY_DYN_DATA 
+ * </PRE>
+ * @param keyname The path of the key relative to the parent key
+ * @param flags Or'ed value of:
+ * <PRE>
+ *           APR_READ             open key for reading
+ *           APR_WRITE            open key for writing
+ *           APR_CREATE           create the key if it doesn't exist
+ *           APR_EXCL             return error if APR_CREATE and file exists
+ * </PRE>
+ * @param pool The pool to alloc newkey and temporary storage within.
+ * @ingroup apr_file_open
+ * @remark If perm is APR_OS_DEFAULT and the file is being created, appropriate 
+ *      default permissions will be used.  *arg1 must point to a valid file_t, 
+ *      or NULL (in which case it will be allocated)
+ */
+AP_DECLARE(apr_status_t) ap_regkey_open(ap_regkey_t **newkey, 
+                                        const ap_regkey_t *parentkey,
+                                        const char *keyname,
+                                        apr_int32_t flags, 
+                                        apr_pool_t *pool);
+
+/**
+ * Close the win32 registry key opened or created by ap_regkey_open().
+ * @param key The registry key to close
+ */
+AP_DECLARE(apr_status_t) ap_regkey_close(ap_regkey_t *key);
+
+/**
+ * Remove the given win32 registry key.
+ * @param parentkey The open registry key of the parent, or one of
+ * <PRE>
+ *           AP_REGKEY_CLASSES_ROOT
+ *           AP_REGKEY_CURRENT_CONFIG
+ *           AP_REGKEY_CURRENT_USER
+ *           AP_REGKEY_LOCAL_MACHINE
+ *           AP_REGKEY_USERS
+ *           AP_REGKEY_PERFORMANCE_DATA 
+ *           AP_REGKEY_DYN_DATA 
+ * </PRE>
+ * @param keyname The path of the key relative to the parent key
+ * @param pool The pool to alloc newkey and temporary storage within.
+ * @remark ap_regkey_remove() is not recursive, although it removes
+ * all values within the given keyname.
+ */
+AP_DECLARE(apr_status_t) ap_regkey_remove(const ap_regkey_t *parent, 
+                                          const char *keyname,
+                                          apr_pool_t *pool);
+
+/**
+ * Retrieve a win32 registry value string from an open key.
+ * @param result The string value retrieved 
+ * @param key The registry key to retrieve the value from
+ * @param valuename The named value to retrieve (pass "" for the default)
+ * @param pool The pool used to store the result.
+ */
+AP_DECLARE(apr_status_t) ap_regkey_value_get(char **result, 
+                                             ap_regkey_t *key, 
+                                             const char *valuename, 
+                                             apr_pool_t *pool);
+
+#ifdef __cplusplus
+}
+#endif
+#endif /* AP_REGKEY_H */