CMakeLua/Utilities/cmxmlrpc/xmlrpc_support.c

   1 /* Copyright (C) 2001 by First Peer, Inc. All rights reserved.
   2 **
   3 ** Redistribution and use in source and binary forms, with or without
   4 ** modification, are permitted provided that the following conditions
   5 ** are met:
   6 ** 1. Redistributions of source code must retain the above copyright
   7 **    notice, this list of conditions and the following disclaimer.
   8 ** 2. Redistributions in binary form must reproduce the above copyright
   9 **    notice, this list of conditions and the following disclaimer in the
  10 **    documentation and/or other materials provided with the distribution.
  11 ** 3. The name of the author may not be used to endorse or promote products
  12 **    derived from this software without specific prior written permission.
  13 **
  14 ** THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 ** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 ** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 ** ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 ** FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 ** DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 ** OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 ** HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 ** LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 ** OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 ** SUCH DAMAGE. */
  25
  26 #include "xmlrpc_config.h"
  27
  28 #include <stdlib.h>
  29 #include <stdio.h>
  30 #include <string.h>
  31 #include <ctype.h>
  32
  33 #ifdef WIN32
  34 # define vsnprintf _vsnprintf
  35 #endif
  36
  37 #include "xmlrpc.h"
  38 #include "xmlrpc_int.h"
  39
  40 #ifdef EFENCE
  41                 /* when looking for corruption don't allocate extra slop */
  42 #define BLOCK_ALLOC_MIN (1)
  43 #else
  44 #define BLOCK_ALLOC_MIN (16)
  45 #endif
  46 #define BLOCK_ALLOC_MAX (128 * 1024 * 1024)
  47
  48 #define ERROR_BUFFER_SZ (256)
  49
  50
  51 /*=========================================================================
  52 **  Strings
  53 **=======================================================================*/
  54
  55 void
  56 xmlrpc_strfree(const char * const string) {
  57     free((void*)string);
  58 }
  59
  60
  61 /*=========================================================================
  62 **  Assertions and Error Handling
  63 **=========================================================================
  64 **  Support code for XMLRPC_ASSERT and xmlrpc_env.
  65 */
  66
  67 void xmlrpc_assertion_failed (char* file, int line)
  68 {
  69     fprintf(stderr, "%s:%d: assertion failed\n", file, line);
  70     abort();
  71 }
  72
  73 static char* default_fault_string = "Not enough memory for error message";
  74
  75 void xmlrpc_env_init (xmlrpc_env* env)
  76 {
  77     XMLRPC_ASSERT(env != NULL);
  78
  79     env->fault_occurred = 0;
  80     env->fault_code     = 0;
  81     env->fault_string   = NULL;
  82 }
  83
  84 void xmlrpc_env_clean (xmlrpc_env* env)
  85 {
  86     XMLRPC_ASSERT(env != NULL);
  87
  88     /* env->fault_string may be one of three things:
  89     **   1) a NULL pointer
  90     **   2) a pointer to the default_fault_string
  91     **   3) a pointer to a malloc'd fault string
  92     ** If we have case (3), we'll need to free it. */
  93     if (env->fault_string && env->fault_string != default_fault_string)
  94         free(env->fault_string);
  95     env->fault_string = XMLRPC_BAD_POINTER;
  96 }
  97
  98
  99
 100 void
 101 xmlrpc_env_set_fault(xmlrpc_env * const env,
 102                      int          const faultCode,
 103                      const char * const faultDescription) {
 104
 105     XMLRPC_ASSERT(env != NULL);
 106     XMLRPC_ASSERT(faultDescription != NULL);
 107
 108     /* Clean up any leftover pointers. */
 109     xmlrpc_env_clean(env);
 110
 111     env->fault_occurred = 1;
 112     env->fault_code     = faultCode;
 113
 114     /* Try to copy the fault string. If this fails, use a default. */
 115     env->fault_string = (char*) malloc(strlen(faultDescription) + 1);
 116     if (env->fault_string)
 117         strcpy(env->fault_string, faultDescription);
 118     else
 119         env->fault_string = default_fault_string;
 120 }
 121
 122
 123
 124 void
 125 xmlrpc_env_set_fault_formatted (xmlrpc_env * const envP,
 126                                 int          const code,
 127                                 const char * const format,
 128                                 ...) {
 129     va_list args;
 130     char buffer[ERROR_BUFFER_SZ];
 131
 132     XMLRPC_ASSERT(envP != NULL);
 133     XMLRPC_ASSERT(format != NULL);
 134
 135     /* Print our error message to the buffer. */
 136     va_start(args, format);
 137     vsnprintf(buffer, ERROR_BUFFER_SZ, format, args);
 138     va_end(args);
 139
 140     /* vsnprintf is guaranteed to terminate the buffer, but we're paranoid. */
 141     buffer[ERROR_BUFFER_SZ - 1] = '\0';
 142
 143     /* Set the fault. */
 144     xmlrpc_env_set_fault(envP, code, buffer);
 145 }
 146
 147
 148
 149 void xmlrpc_fatal_error (char* file, int line, char* msg)
 150 {
 151     fprintf(stderr, "%s:%d: %s\n", file, line, msg);
 152     exit(1);
 153 }
 154
 155
 156 /*=========================================================================
 157 **  Resource Limits
 158 **=========================================================================
 159 */
 160
 161 static size_t limits[XMLRPC_LAST_LIMIT_ID + 1] = {
 162     XMLRPC_NESTING_LIMIT_DEFAULT,
 163     XMLRPC_XML_SIZE_LIMIT_DEFAULT
 164 };
 165
 166 void xmlrpc_limit_set (int limit_id, size_t value)
 167 {
 168     XMLRPC_ASSERT(0 <= limit_id && limit_id <= XMLRPC_LAST_LIMIT_ID);
 169     limits[limit_id] = value;
 170 }
 171
 172 size_t xmlrpc_limit_get (int limit_id)
 173 {
 174     XMLRPC_ASSERT(0 <= limit_id && limit_id <= XMLRPC_LAST_LIMIT_ID);
 175     return limits[limit_id];
 176 }
 177
 178
 179 /*=========================================================================
 180 **  xmlrpc_mem_block
 181 **=========================================================================
 182 **  We support resizable blocks of memory. We need these just about
 183 **  everywhere.
 184 */
 185
 186 xmlrpc_mem_block *
 187 xmlrpc_mem_block_new(xmlrpc_env * const env,
 188                      size_t       const size) {
 189     xmlrpc_mem_block* block;
 190
 191     XMLRPC_ASSERT_ENV_OK(env);
 192
 193     block = (xmlrpc_mem_block*) malloc(sizeof(xmlrpc_mem_block));
 194     XMLRPC_FAIL_IF_NULL(block, env, XMLRPC_INTERNAL_ERROR,
 195                         "Can't allocate memory block");
 196
 197     xmlrpc_mem_block_init(env, block, size);
 198     XMLRPC_FAIL_IF_FAULT(env);
 199
 200                      cleanup:
 201     if (env->fault_occurred) {
 202         if (block)
 203             free(block);
 204         return NULL;
 205     } else {
 206         return block;
 207     }
 208 }
 209
 210 /* Destroy an existing xmlrpc_mem_block, and everything it contains. */
 211 void xmlrpc_mem_block_free (xmlrpc_mem_block* block)
 212 {
 213     XMLRPC_ASSERT(block != NULL);
 214     XMLRPC_ASSERT(block->_block != NULL);
 215
 216     xmlrpc_mem_block_clean(block);
 217     free(block);
 218 }
 219
 220 /* Initialize the contents of the provided xmlrpc_mem_block. */
 221 void xmlrpc_mem_block_init (xmlrpc_env* env,
 222                             xmlrpc_mem_block* block,
 223                             size_t size)
 224 {
 225     XMLRPC_ASSERT_ENV_OK(env);
 226     XMLRPC_ASSERT(block != NULL);
 227
 228     block->_size = size;
 229     if (size < BLOCK_ALLOC_MIN)
 230         block->_allocated = BLOCK_ALLOC_MIN;
 231     else
 232         block->_allocated = size;
 233
 234     block->_block = (void*) malloc(block->_allocated);
 235     if (!block->_block)
 236         xmlrpc_env_set_fault_formatted(
 237             env, XMLRPC_INTERNAL_ERROR,
 238             "Can't allocate %u-byte memory block",
 239             block->_allocated);
 240 }
 241
 242 /* Deallocate the contents of the provided xmlrpc_mem_block, but not the
 243 ** block itself. */
 244 void xmlrpc_mem_block_clean (xmlrpc_mem_block* block)
 245 {
 246     XMLRPC_ASSERT(block != NULL);
 247     XMLRPC_ASSERT(block->_block != NULL);
 248
 249     free(block->_block);
 250     block->_block = XMLRPC_BAD_POINTER;
 251 }
 252
 253
 254
 255 /* Get the size of the xmlrpc_mem_block. */
 256 size_t
 257 xmlrpc_mem_block_size(const xmlrpc_mem_block * const block) {
 258
 259     XMLRPC_ASSERT(block != NULL);
 260     return block->_size;
 261 }
 262
 263
 264
 265 /* Get the contents of the xmlrpc_mem_block. */
 266 void *
 267 xmlrpc_mem_block_contents(const xmlrpc_mem_block * const block) {
 268
 269     XMLRPC_ASSERT(block != NULL);
 270     return block->_block;
 271 }
 272
 273
 274
 275 /* Resize an xmlrpc_mem_block, preserving as much of the contents as
 276 ** possible. */
 277 void
 278 xmlrpc_mem_block_resize (xmlrpc_env *       const env,
 279                          xmlrpc_mem_block * const block,
 280                          size_t             const size) {
 281
 282     size_t proposed_alloc;
 283     void* new_block;
 284
 285     XMLRPC_ASSERT_ENV_OK(env);
 286     XMLRPC_ASSERT(block != NULL);
 287
 288     /* Check to see if we already have enough space. Maybe we'll get lucky. */
 289     if (size <= block->_allocated) {
 290         block->_size = size;
 291         return;
 292     }
 293
 294     /* Calculate a new allocation size. */
 295 #ifdef EFENCE
 296     proposed_alloc = size;
 297 #else
 298     proposed_alloc = block->_allocated;
 299     while (proposed_alloc < size && proposed_alloc <= BLOCK_ALLOC_MAX)
 300         proposed_alloc *= 2;
 301 #endif /* DEBUG_MEM_ERRORS */
 302
 303     if (proposed_alloc > BLOCK_ALLOC_MAX)
 304         XMLRPC_FAIL(env, XMLRPC_INTERNAL_ERROR, "Memory block too large");
 305
 306     /* Allocate our new memory block. */
 307     new_block = (void*) malloc(proposed_alloc);
 308     XMLRPC_FAIL_IF_NULL(new_block, env, XMLRPC_INTERNAL_ERROR,
 309                         "Can't resize memory block");
 310
 311     /* Copy over our data and update the xmlrpc_mem_block struct. */
 312     memcpy(new_block, block->_block, block->_size);
 313     free(block->_block);
 314     block->_block     = new_block;
 315     block->_size      = size;
 316     block->_allocated = proposed_alloc;
 317
 318  cleanup:
 319     return;
 320 }
 321
 322 /* Append data to an existing xmlrpc_mem_block. */
 323 void
 324 xmlrpc_mem_block_append(xmlrpc_env *       const env,
 325                         xmlrpc_mem_block * const block,
 326                         void *             const data,
 327                         size_t             const len)
 328 {
 329     size_t size;
 330
 331     XMLRPC_ASSERT_ENV_OK(env);
 332     XMLRPC_ASSERT(block != NULL);
 333
 334     size = block->_size;
 335     xmlrpc_mem_block_resize(env, block, size + len);
 336     XMLRPC_FAIL_IF_FAULT(env);
 337
 338     memcpy(((unsigned char*) block->_block) + size, data, len);
 339
 340  cleanup:
 341     return;
 342 }
 343
 344
 345
 346 void
 347 xmlrpc_traceXml(const char * const label,
 348                 const char * const xml,
 349                 unsigned int const xmlLength) {
 350
 351     if (getenv("XMLRPC_TRACE_XML")) {
 352         unsigned int nonPrintableCount;
 353         unsigned int i;
 354
 355         nonPrintableCount = 0;  /* Initial value */
 356
 357         for (i = 0; i < xmlLength; ++i) {
 358             if (!isprint((int)(xml[i])) && xml[i] != '\n' && xml[i] != '\r')
 359                 ++nonPrintableCount;
 360         }
 361         if (nonPrintableCount > 0)
 362             fprintf(stderr, "%s contains %u nonprintable characters.\n",
 363                     label, nonPrintableCount);
 364
 365         fprintf(stderr, "%s:\n %.*s\n", label, (int)xmlLength, xml);
 366     }
 367 }