core/metamod_util.cpp
author Scott Ehlert <ds@alliedmods.net>
Thu Dec 10 00:59:50 2009 -0600 (2009-12-10)
changeset 689 4065ba5e9155
parent 658 8353605c1d97
child 705 a1001281dcb1
permissions -rw-r--r--
Rewrote user message caching code to always use IServerGameDLL::GetUserMessageInfo (bug 4117, r=dvander).

Games where the above function can crash are handled by detouring tier0's Error() function and jumping back to our own code. So in theory this should work on all games now.
dvander@371
     1
/**
dvander@371
     2
 * vim: set ts=4 :
dvander@371
     3
 * ======================================================
dvander@371
     4
 * Metamod:Source
ds@523
     5
 * Copyright (C) 2004-2008 AlliedModders LLC and authors.
dvander@371
     6
 * All rights reserved.
dvander@371
     7
 * ======================================================
dvander@371
     8
 *
dvander@371
     9
 * This software is provided 'as-is', without any express or implied warranty.
dvander@371
    10
 * In no event will the authors be held liable for any damages arising from 
dvander@371
    11
 * the use of this software.
dvander@371
    12
 * 
dvander@371
    13
 * Permission is granted to anyone to use this software for any purpose, 
dvander@371
    14
 * including commercial applications, and to alter it and redistribute it 
dvander@371
    15
 * freely, subject to the following restrictions:
dvander@371
    16
 *
dvander@371
    17
 * 1. The origin of this software must not be misrepresented; you must not 
dvander@371
    18
 * claim that you wrote the original software. If you use this software in a 
dvander@371
    19
 * product, an acknowledgment in the product documentation would be 
dvander@371
    20
 * appreciated but is not required.
dvander@371
    21
 * 2. Altered source versions must be plainly marked as such, and must not be
dvander@371
    22
 * misrepresented as being the original software.
dvander@371
    23
 * 3. This notice may not be removed or altered from any source distribution.
dvander@371
    24
 *
dvander@371
    25
 * Version: $Id$
dvander@371
    26
 */
dvander@371
    27
dvander@371
    28
#include <ctype.h>
dvander@371
    29
#include <string.h>
dvander@371
    30
#include <stdio.h>
dvander@371
    31
#include "metamod_util.h"
dvander@371
    32
#include "metamod_oslink.h"
dvander@371
    33
dvander@371
    34
/**
dvander@371
    35
 * @brief Utility functions
dvander@371
    36
 * @file util.cpp
dvander@371
    37
 */
dvander@371
    38
dvander@371
    39
const char *UTIL_GetExtension(const char *file)
dvander@371
    40
{
dvander@371
    41
	int len = strlen(file);
dvander@371
    42
	int i = 0;
dvander@371
    43
dvander@371
    44
	for (i = len - 1; i >= 0; i--)
dvander@371
    45
	{
dvander@371
    46
		if (file[i] == '/' || file[i] == '\\')
dvander@371
    47
		{
dvander@371
    48
			return NULL;
dvander@371
    49
		}
dvander@371
    50
dvander@371
    51
		if ((file[i] == '.') && (i != len - 1))
dvander@371
    52
		{
dvander@371
    53
			return (const char *)&(file[i + 1]);
dvander@371
    54
		}
dvander@371
    55
	}
dvander@371
    56
dvander@371
    57
	return NULL;
dvander@371
    58
}
dvander@371
    59
dvander@371
    60
void UTIL_TrimLeft(char *buffer)
dvander@371
    61
{
dvander@371
    62
	/* Let's think of this as our iterator */
dvander@371
    63
	char *i = buffer;
dvander@371
    64
dvander@371
    65
	/* Make sure the buffer isn't null */
dvander@371
    66
	if (i && *i)
dvander@371
    67
	{
dvander@371
    68
		/* Add up number of whitespace characters */
dvander@371
    69
		while(isspace((unsigned char) *i))
dvander@371
    70
		{
dvander@371
    71
			i++;
dvander@371
    72
		}
dvander@371
    73
dvander@371
    74
		/* If whitespace chars in buffer then adjust string so first non-whitespace char is at start of buffer */
dvander@371
    75
		if (i != buffer)
dvander@371
    76
		{
dvander@371
    77
			memmove(buffer, i, (strlen(i) + 1) * sizeof(char));
dvander@371
    78
		}
dvander@371
    79
	}
dvander@371
    80
}
dvander@371
    81
dvander@371
    82
void UTIL_TrimRight(char *buffer)
dvander@371
    83
{
dvander@371
    84
	/* Make sure buffer isn't null */
dvander@371
    85
	if (buffer)
dvander@371
    86
	{
dvander@371
    87
		size_t len = strlen(buffer);
dvander@371
    88
dvander@371
    89
		/* Loop through buffer backwards while replacing whitespace chars with null chars */
dvander@371
    90
		for (size_t i = len - 1; i >= 0; i--)
dvander@371
    91
		{
dvander@371
    92
			if (isspace((unsigned char) buffer[i]))
dvander@371
    93
			{
dvander@371
    94
				buffer[i] = '\0';
dvander@371
    95
			} else {
dvander@371
    96
				break;
dvander@371
    97
			}
dvander@371
    98
		}
dvander@371
    99
	}
dvander@371
   100
}
dvander@371
   101
dvander@371
   102
bool UTIL_PathCmp(const char *path1, const char *path2)
dvander@371
   103
{
dvander@371
   104
	size_t pos1 = 0, pos2 = 0;
dvander@371
   105
dvander@371
   106
	while (true)
dvander@371
   107
	{
dvander@371
   108
		if (path1[pos1] == '\0' || path2[pos2] == '\0')
dvander@371
   109
		{
dvander@371
   110
			return (path1[pos1] == path2[pos2]);
dvander@371
   111
		}
dvander@371
   112
dvander@371
   113
		if (path1[pos1] == PATH_SEP_CHAR)
dvander@371
   114
		{
dvander@371
   115
			if (path2[pos2] != PATH_SEP_CHAR)
dvander@371
   116
			{
dvander@371
   117
				return false;
dvander@371
   118
			}
dvander@371
   119
dvander@371
   120
			/* Look for extra path chars */
dvander@371
   121
			while (path1[++pos1])
dvander@371
   122
			{
dvander@371
   123
				if (path1[pos1] != PATH_SEP_CHAR)
dvander@371
   124
				{
dvander@371
   125
					break;
dvander@371
   126
				}
dvander@371
   127
			}
dvander@371
   128
			while (path2[++pos2])
dvander@371
   129
			{
dvander@371
   130
				if (path2[pos2] != PATH_SEP_CHAR)
dvander@371
   131
				{
dvander@371
   132
					break;
dvander@371
   133
				}
dvander@371
   134
			}
dvander@371
   135
			continue;
dvander@371
   136
		}
dvander@371
   137
dvander@371
   138
		/* If we're at a different non-alphanumeric, the next character MUST match */
dvander@481
   139
		if ((((unsigned)path1[pos1] & 0x80) && path1[pos1] != path2[pos2])
dvander@481
   140
			||
dvander@481
   141
			!isalpha(path1[pos1]) && (path1[pos1] != path2[pos2])
dvander@481
   142
			)
dvander@371
   143
		{
dvander@371
   144
			return false;
dvander@371
   145
		}
dvander@371
   146
dvander@371
   147
	#ifdef WIN32
dvander@371
   148
		if (toupper(path1[pos1]) != toupper(path2[pos2]))
dvander@371
   149
	#else
dvander@371
   150
		if (path1[pos1] != path2[pos2])
dvander@371
   151
	#endif
dvander@371
   152
		{
dvander@371
   153
			return false;
dvander@371
   154
		}
dvander@371
   155
dvander@371
   156
		pos1++;
dvander@371
   157
		pos2++;
dvander@371
   158
	}
dvander@371
   159
}
dvander@371
   160
dvander@371
   161
size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...)
dvander@371
   162
{
dvander@371
   163
	va_list ap;
dvander@371
   164
dvander@371
   165
	va_start(ap, fmt);
dvander@371
   166
	size_t len = vsnprintf(buffer, maxlength, fmt, ap);
dvander@371
   167
	va_end(ap);
dvander@371
   168
dvander@371
   169
	if (len >= maxlength)
dvander@371
   170
	{
dvander@371
   171
		len = maxlength - 1;
dvander@371
   172
		buffer[len] = '\0';
dvander@371
   173
	}
dvander@371
   174
dvander@371
   175
	return len;
dvander@371
   176
}
dvander@371
   177
dvander@371
   178
size_t UTIL_FormatArgs(char *buffer, size_t maxlength, const char *fmt, va_list params)
dvander@371
   179
{
dvander@371
   180
	size_t len = vsnprintf(buffer, maxlength, fmt, params);
dvander@371
   181
dvander@371
   182
	if (len >= maxlength)
dvander@371
   183
	{
dvander@371
   184
		len = maxlength - 1;
dvander@371
   185
		buffer[len] = '\0';
dvander@371
   186
	}
dvander@371
   187
dvander@371
   188
	return len;
dvander@371
   189
}
dvander@371
   190
dvander@371
   191
inline bool pathchar_isalpha(char a)
dvander@371
   192
{
dvander@371
   193
	return (((a & 1<<7) == 0) && isalpha(a));
dvander@371
   194
}
dvander@371
   195
dvander@371
   196
inline bool pathchar_sep(char a)
dvander@371
   197
{
dvander@371
   198
#if defined WIN32
dvander@371
   199
	return (a == '/' || a == '\\');
dvander@371
   200
#elif defined __linux__
dvander@371
   201
	return (a == '/');
dvander@371
   202
#endif
dvander@371
   203
}
dvander@371
   204
dvander@371
   205
inline bool pathstr_isabsolute(const char *str)
dvander@371
   206
{
dvander@371
   207
#if defined WIN32
dvander@371
   208
	return (pathchar_isalpha(str[0]) 
dvander@371
   209
		&& str[1] == ':' 
dvander@371
   210
		&& pathchar_sep(str[2]));
dvander@371
   211
#elif defined __linux__
dvander@371
   212
	return (str[0] == '/');
dvander@371
   213
#endif
dvander@371
   214
}
dvander@371
   215
dvander@371
   216
inline bool pathchar_cmp(char a, char b)
dvander@371
   217
{
dvander@371
   218
#if defined WIN32
dvander@371
   219
	if (pathchar_isalpha(a) && pathchar_isalpha(b))
dvander@371
   220
	{
dvander@371
   221
		return (tolower(a) == tolower(b));
dvander@371
   222
	}
dvander@371
   223
	/* Either path separator is acceptable */
dvander@371
   224
	if (pathchar_sep(a))
dvander@371
   225
	{
dvander@371
   226
		return pathchar_sep(b);
dvander@371
   227
	}
dvander@371
   228
#endif
dvander@371
   229
	return (a == b);
dvander@371
   230
}
dvander@371
   231
dvander@371
   232
/**
dvander@371
   233
 * @brief Forms a relative path given two absolute paths.
dvander@371
   234
 *
dvander@371
   235
 * @param buffer		Buffer to store relative path in.
dvander@371
   236
 * @param maxlength		Maximum length of the output buffer.
dvander@371
   237
 * @param relTo			Destination folder to use as a working directory.
dvander@371
   238
 *						Final folder name should not be pathchar-terminated.
dvander@371
   239
 * @param relFrom		Source file or folder to use as a target.
dvander@371
   240
 * @return				True on success, false on failure.
dvander@371
   241
 */
dvander@371
   242
bool UTIL_Relatize(char buffer[],
dvander@371
   243
				   size_t maxlength,
dvander@371
   244
				   const char *relTo,
dvander@371
   245
				   const char *relFrom)
dvander@371
   246
{
dvander@371
   247
	/* We don't allow relative paths in here, force
dvander@371
   248
	 * the user to resolve these himself!
dvander@371
   249
	 */
dvander@371
   250
	if (!pathstr_isabsolute(relTo)
dvander@371
   251
		|| !pathstr_isabsolute(relFrom))
dvander@371
   252
	{
dvander@371
   253
		return false;
dvander@371
   254
	}
dvander@371
   255
dvander@371
   256
#if defined WIN32
dvander@371
   257
	/* Relative paths across drives are not possible */
dvander@371
   258
	if (!pathchar_cmp(relTo[0], relFrom[0]))
dvander@371
   259
	{
dvander@371
   260
		return false;
dvander@371
   261
	}
dvander@371
   262
	/* Get rid of the drive and semicolon part */
dvander@371
   263
	relTo = &relTo[2];
dvander@371
   264
	relFrom = &relFrom[2];
dvander@371
   265
#endif
dvander@371
   266
dvander@371
   267
	/* Eliminate the common root between the paths */
dvander@371
   268
	const char *rootTo = NULL;
dvander@371
   269
	const char *rootFrom = NULL;
dvander@371
   270
	while (*relTo != '\0' && *relFrom != '\0')
dvander@371
   271
	{
dvander@371
   272
		/* If we get to a new path sequence, start over */
dvander@371
   273
		if (pathchar_sep(*relTo)
dvander@371
   274
			&& pathchar_sep(*relFrom))
dvander@371
   275
		{
dvander@371
   276
			rootTo = relTo;
dvander@371
   277
			rootFrom = relFrom;
dvander@371
   278
		/* If the paths don't compare, stop looking for a common root */
dvander@371
   279
		} else if (!pathchar_cmp(*relTo, *relFrom)) {
dvander@371
   280
			break;
dvander@371
   281
		}
dvander@371
   282
		relTo++;
dvander@371
   283
		relFrom++;
dvander@371
   284
	}
dvander@371
   285
dvander@371
   286
	/* NULLs shouldn't happen! */
dvander@371
   287
	if (rootTo == NULL
dvander@371
   288
		|| rootFrom == NULL)
dvander@371
   289
	{
dvander@371
   290
		return false;
dvander@371
   291
	}
dvander@371
   292
dvander@371
   293
	size_t numLevels = 0;
dvander@371
   294
dvander@371
   295
	/* The root case is special! 
dvander@371
   296
	 * Don't count anything from it.
dvander@371
   297
	 */
dvander@371
   298
	if (*(rootTo + 1) != '\0')
dvander@371
   299
	{
dvander@371
   300
		/* Search for how many levels we need to go up.
dvander@371
   301
	 	 * Since the root pointer points to a '/', we increment
dvander@371
   302
		 * the initial pointer by one.
dvander@371
   303
		 */
dvander@371
   304
		while (*rootTo != '\0')
dvander@371
   305
		{
dvander@371
   306
			if (pathchar_sep(*rootTo))
dvander@371
   307
			{
dvander@371
   308
				/* Check for an improper trailing slash,
dvander@371
   309
				 * just to be nice even though the user 
dvander@371
   310
				 * should NOT have done this!
dvander@371
   311
				 */
dvander@371
   312
				if (*(rootTo + 1) == '\0')
dvander@371
   313
				{
dvander@371
   314
					break;
dvander@371
   315
				}
dvander@371
   316
				numLevels++;
dvander@371
   317
			}
dvander@371
   318
			rootTo++;
dvander@371
   319
		}
dvander@371
   320
	}
dvander@371
   321
dvander@371
   322
	/* Now build the new relative path. */
dvander@371
   323
	size_t len, total = 0;
dvander@371
   324
	while (numLevels--)
dvander@371
   325
	{
dvander@371
   326
		len = _snprintf(&buffer[total], maxlength - total, ".." PATH_SEP_STR);
dvander@371
   327
		if (len >= maxlength - total)
dvander@371
   328
		{
dvander@371
   329
			/* Not enough space in the buffer */
dvander@371
   330
			return false;
dvander@371
   331
		}
dvander@371
   332
		total += len;
dvander@371
   333
	}
dvander@371
   334
dvander@371
   335
	/* Add the absolute path. */
dvander@371
   336
	len = _snprintf(&buffer[total], maxlength - total, "%s", &rootFrom[1]);
dvander@371
   337
	if (len >= maxlength - total)
dvander@371
   338
	{
dvander@371
   339
		return false;
dvander@371
   340
	}
dvander@371
   341
dvander@371
   342
	return true;
dvander@371
   343
}
ds@637
   344
ds@658
   345
bool UTIL_VerifySignature(const void *addr, const char *sig, size_t len)
ds@658
   346
{
ds@658
   347
	unsigned char *addr1 = (unsigned char *) addr;
ds@658
   348
	unsigned char *addr2 = (unsigned char *) sig;
ds@658
   349
ds@658
   350
	for (size_t i = 0; i < len; i++)
ds@658
   351
	{
ds@658
   352
		if (addr2[i] == '*')
ds@658
   353
			continue;
ds@658
   354
		if (addr1[i] != addr2[i])
ds@658
   355
			return false;
ds@658
   356
	}
ds@658
   357
ds@658
   358
	return true;
ds@658
   359
}