core-legacy/util.cpp
author David Anderson <dvander@alliedmods.net>
Sun Nov 23 21:22:04 2008 -0600 (2008-11-23)
changeset 580 783e91c5f445
parent 545 07e5df11f9fc
child 662 5a936e981523
permissions -rw-r--r--
Initial import of core-legacy as a gameinfo provider.
dvander@541
     1
/* ======== SourceMM ========
dvander@541
     2
 * Copyright (C) 2004-2008 Metamod:Source Development Team
dvander@541
     3
 * No warranties of any kind
dvander@541
     4
 *
dvander@541
     5
 * License: zlib/libpng
dvander@541
     6
 *
dvander@541
     7
 * Author(s): David "BAILOPAN" Anderson
dvander@541
     8
 * ============================
dvander@541
     9
 */
dvander@541
    10
dvander@541
    11
#include <ctype.h>
dvander@541
    12
#include <string.h>
dvander@541
    13
#include <stdio.h>
dvander@541
    14
#include "util.h"
dvander@541
    15
#include "oslink.h"
dvander@541
    16
dvander@541
    17
/**
dvander@541
    18
 * @brief Utility functions
dvander@541
    19
 * @file util.cpp
dvander@541
    20
 */
dvander@541
    21
dvander@541
    22
const char *UTIL_GetExtension(const char *file)
dvander@541
    23
{
dvander@541
    24
	int len = strlen(file);
dvander@541
    25
	int i = 0;
dvander@541
    26
dvander@541
    27
	for (i = len - 1; i >= 0; i--)
dvander@541
    28
	{
dvander@541
    29
		if (file[i] == '/' || file[i] == '\\')
dvander@541
    30
		{
dvander@541
    31
			return NULL;
dvander@541
    32
		}
dvander@541
    33
dvander@541
    34
		if ((file[i] == '.') && (i != len - 1))
dvander@541
    35
		{
dvander@541
    36
			return (const char *)&(file[i + 1]);
dvander@541
    37
		}
dvander@541
    38
	}
dvander@541
    39
dvander@541
    40
	return NULL;
dvander@541
    41
}
dvander@541
    42
dvander@541
    43
void UTIL_TrimLeft(char *buffer)
dvander@541
    44
{
dvander@541
    45
	/* Let's think of this as our iterator */
dvander@541
    46
	char *i = buffer;
dvander@541
    47
dvander@541
    48
	/* Make sure the buffer isn't null */
dvander@541
    49
	if (i && *i)
dvander@541
    50
	{
dvander@541
    51
		/* Add up number of whitespace characters */
dvander@541
    52
		while(isspace((unsigned char) *i))
dvander@541
    53
		{
dvander@541
    54
			i++;
dvander@541
    55
		}
dvander@541
    56
dvander@541
    57
		/* If whitespace chars in buffer then adjust string so first non-whitespace char is at start of buffer */
dvander@541
    58
		if (i != buffer)
dvander@541
    59
		{
dvander@541
    60
			memmove(buffer, i, (strlen(i) + 1) * sizeof(char));
dvander@541
    61
		}
dvander@541
    62
	}
dvander@541
    63
}
dvander@541
    64
dvander@541
    65
void UTIL_TrimRight(char *buffer)
dvander@541
    66
{
dvander@541
    67
	/* Make sure buffer isn't null */
dvander@541
    68
	if (buffer)
dvander@541
    69
	{
dvander@541
    70
		size_t len = strlen(buffer);
dvander@541
    71
dvander@541
    72
		/* Loop through buffer backwards while replacing whitespace chars with null chars */
dvander@541
    73
		for (size_t i = len - 1; i >= 0; i--)
dvander@541
    74
		{
dvander@541
    75
			if (isspace((unsigned char) buffer[i]))
dvander@541
    76
			{
dvander@541
    77
				buffer[i] = '\0';
dvander@541
    78
			} else {
dvander@541
    79
				break;
dvander@541
    80
			}
dvander@541
    81
		}
dvander@541
    82
	}
dvander@541
    83
}
dvander@541
    84
dvander@541
    85
bool UTIL_PathCmp(const char *path1, const char *path2)
dvander@541
    86
{
dvander@541
    87
	size_t pos1 = 0, pos2 = 0;
dvander@541
    88
dvander@541
    89
	while (true)
dvander@541
    90
	{
dvander@541
    91
		if (path1[pos1] == '\0' || path2[pos2] == '\0')
dvander@541
    92
		{
dvander@541
    93
			return (path1[pos1] == path2[pos2]);
dvander@541
    94
		}
dvander@541
    95
dvander@541
    96
		if (path1[pos1] == PATH_SEP_CHAR)
dvander@541
    97
		{
dvander@541
    98
			if (path2[pos2] != PATH_SEP_CHAR)
dvander@541
    99
			{
dvander@541
   100
				return false;
dvander@541
   101
			}
dvander@541
   102
dvander@541
   103
			/* Look for extra path chars */
dvander@541
   104
			while (path1[++pos1])
dvander@541
   105
			{
dvander@541
   106
				if (path1[pos1] != PATH_SEP_CHAR)
dvander@541
   107
				{
dvander@541
   108
					break;
dvander@541
   109
				}
dvander@541
   110
			}
dvander@541
   111
			while (path2[++pos2])
dvander@541
   112
			{
dvander@541
   113
				if (path2[pos2] != PATH_SEP_CHAR)
dvander@541
   114
				{
dvander@541
   115
					break;
dvander@541
   116
				}
dvander@541
   117
			}
dvander@541
   118
			continue;
dvander@541
   119
		}
dvander@541
   120
dvander@541
   121
		/* If we're at a different non-alphanumeric, the next character MUST match */
dvander@541
   122
		if (!isalpha(path1[pos1]) && (path1[pos1] != path2[pos2]))
dvander@541
   123
		{
dvander@541
   124
			return false;
dvander@541
   125
		}
dvander@541
   126
dvander@541
   127
	#ifdef WIN32
dvander@541
   128
		if (toupper(path1[pos1]) != toupper(path2[pos2]))
dvander@541
   129
	#else
dvander@541
   130
		if (path1[pos1] != path2[pos2])
dvander@541
   131
	#endif
dvander@541
   132
		{
dvander@541
   133
			return false;
dvander@541
   134
		}
dvander@541
   135
dvander@541
   136
		pos1++;
dvander@541
   137
		pos2++;
dvander@541
   138
	}
dvander@541
   139
}
dvander@541
   140
dvander@541
   141
size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...)
dvander@541
   142
{
dvander@541
   143
	va_list ap;
dvander@541
   144
dvander@541
   145
	va_start(ap, fmt);
dvander@541
   146
	size_t len = vsnprintf(buffer, maxlength, fmt, ap);
dvander@541
   147
	va_end(ap);
dvander@541
   148
dvander@541
   149
	if (len >= maxlength)
dvander@541
   150
	{
dvander@541
   151
		len = maxlength - 1;
dvander@541
   152
		buffer[len] = '\0';
dvander@541
   153
	}
dvander@541
   154
dvander@541
   155
	return len;
dvander@541
   156
}
dvander@541
   157
dvander@541
   158
inline bool pathchar_isalpha(char a)
dvander@541
   159
{
dvander@541
   160
	return (((a & 1<<7) == 0) && isalpha(a));
dvander@541
   161
}
dvander@541
   162
dvander@541
   163
inline bool pathchar_sep(char a)
dvander@541
   164
{
dvander@541
   165
#if defined WIN32
dvander@541
   166
	return (a == '/' || a == '\\');
dvander@541
   167
#elif defined __linux__
dvander@541
   168
	return (a == '/');
dvander@541
   169
#endif
dvander@541
   170
}
dvander@541
   171
dvander@541
   172
inline bool pathstr_isabsolute(const char *str)
dvander@541
   173
{
dvander@541
   174
#if defined WIN32
dvander@541
   175
	return (pathchar_isalpha(str[0]) 
dvander@541
   176
		&& str[1] == ':' 
dvander@541
   177
		&& pathchar_sep(str[2]));
dvander@541
   178
#elif defined __linux__
dvander@541
   179
	return (str[0] == '/');
dvander@541
   180
#endif
dvander@541
   181
}
dvander@541
   182
dvander@541
   183
inline bool pathchar_cmp(char a, char b)
dvander@541
   184
{
dvander@541
   185
#if defined WIN32
dvander@541
   186
	if (pathchar_isalpha(a) && pathchar_isalpha(b))
dvander@541
   187
	{
dvander@541
   188
		return (tolower(a) == tolower(b));
dvander@541
   189
	}
dvander@541
   190
	/* Either path separator is acceptable */
dvander@541
   191
	if (pathchar_sep(a))
dvander@541
   192
	{
dvander@541
   193
		return pathchar_sep(b);
dvander@541
   194
	}
dvander@541
   195
#endif
dvander@541
   196
	return (a == b);
dvander@541
   197
}
dvander@541
   198
dvander@541
   199
/**
dvander@541
   200
 * @brief Forms a relative path given two absolute paths.
dvander@541
   201
 *
dvander@541
   202
 * @param buffer		Buffer to store relative path in.
dvander@541
   203
 * @param maxlength		Maximum length of the output buffer.
dvander@541
   204
 * @param relTo			Destination folder to use as a working directory.
dvander@541
   205
 *						Final folder name should not be pathchar-terminated.
dvander@541
   206
 * @param relFrom		Source file or folder to use as a target.
dvander@541
   207
 * @return				True on success, false on failure.
dvander@541
   208
 */
dvander@541
   209
bool UTIL_Relatize(char buffer[],
dvander@541
   210
				   size_t maxlength,
dvander@541
   211
				   const char *relTo,
dvander@541
   212
				   const char *relFrom)
dvander@541
   213
{
dvander@541
   214
	/* We don't allow relative paths in here, force
dvander@541
   215
	 * the user to resolve these himself!
dvander@541
   216
	 */
dvander@541
   217
	if (!pathstr_isabsolute(relTo)
dvander@541
   218
		|| !pathstr_isabsolute(relFrom))
dvander@541
   219
	{
dvander@541
   220
		return false;
dvander@541
   221
	}
dvander@541
   222
dvander@541
   223
#if defined WIN32
dvander@541
   224
	/* Relative paths across drives are not possible */
dvander@541
   225
	if (!pathchar_cmp(relTo[0], relFrom[0]))
dvander@541
   226
	{
dvander@541
   227
		return false;
dvander@541
   228
	}
dvander@541
   229
	/* Get rid of the drive and semicolon part */
dvander@541
   230
	relTo = &relTo[2];
dvander@541
   231
	relFrom = &relFrom[2];
dvander@541
   232
#endif
dvander@541
   233
dvander@541
   234
	/* Eliminate the common root between the paths */
dvander@541
   235
	const char *rootTo = NULL;
dvander@541
   236
	const char *rootFrom = NULL;
dvander@541
   237
	while (*relTo != '\0' && *relFrom != '\0')
dvander@541
   238
	{
dvander@541
   239
		/* If we get to a new path sequence, start over */
dvander@541
   240
		if (pathchar_sep(*relTo)
dvander@541
   241
			&& pathchar_sep(*relFrom))
dvander@541
   242
		{
dvander@541
   243
			rootTo = relTo;
dvander@541
   244
			rootFrom = relFrom;
dvander@541
   245
		/* If the paths don't compare, stop looking for a common root */
dvander@541
   246
		} else if (!pathchar_cmp(*relTo, *relFrom)) {
dvander@541
   247
			break;
dvander@541
   248
		}
dvander@541
   249
		relTo++;
dvander@541
   250
		relFrom++;
dvander@541
   251
	}
dvander@541
   252
dvander@541
   253
	/* NULLs shouldn't happen! */
dvander@541
   254
	if (rootTo == NULL
dvander@541
   255
		|| rootFrom == NULL)
dvander@541
   256
	{
dvander@541
   257
		return false;
dvander@541
   258
	}
dvander@541
   259
dvander@541
   260
	size_t numLevels = 0;
dvander@541
   261
dvander@541
   262
	/* The root case is special! 
dvander@541
   263
	 * Don't count anything from it.
dvander@541
   264
	 */
dvander@541
   265
	if (*(rootTo + 1) != '\0')
dvander@541
   266
	{
dvander@541
   267
		/* Search for how many levels we need to go up.
dvander@541
   268
	 	 * Since the root pointer points to a '/', we increment
dvander@541
   269
		 * the initial pointer by one.
dvander@541
   270
		 */
dvander@541
   271
		while (*rootTo != '\0')
dvander@541
   272
		{
dvander@541
   273
			if (pathchar_sep(*rootTo))
dvander@541
   274
			{
dvander@541
   275
				/* Check for an improper trailing slash,
dvander@541
   276
				 * just to be nice even though the user 
dvander@541
   277
				 * should NOT have done this!
dvander@541
   278
				 */
dvander@541
   279
				if (*(rootTo + 1) == '\0')
dvander@541
   280
				{
dvander@541
   281
					break;
dvander@541
   282
				}
dvander@541
   283
				numLevels++;
dvander@541
   284
			}
dvander@541
   285
			rootTo++;
dvander@541
   286
		}
dvander@541
   287
	}
dvander@541
   288
dvander@541
   289
	/* Now build the new relative path. */
dvander@541
   290
	size_t len, total = 0;
dvander@541
   291
	while (numLevels--)
dvander@541
   292
	{
dvander@541
   293
		len = _snprintf(&buffer[total], maxlength - total, ".." PATH_SEP_STR);
dvander@541
   294
		if (len >= maxlength - total)
dvander@541
   295
		{
dvander@541
   296
			/* Not enough space in the buffer */
dvander@541
   297
			return false;
dvander@541
   298
		}
dvander@541
   299
		total += len;
dvander@541
   300
	}
dvander@541
   301
dvander@541
   302
	/* Add the absolute path. */
dvander@541
   303
	len = _snprintf(&buffer[total], maxlength - total, "%s", &rootFrom[1]);
dvander@541
   304
	if (len >= maxlength - total)
dvander@541
   305
	{
dvander@541
   306
		return false;
dvander@541
   307
	}
dvander@541
   308
dvander@541
   309
	return true;
dvander@541
   310
}
dvander@541
   311
dvander@541
   312
size_t UTIL_FormatArgs(char *buffer, size_t maxlength, const char *fmt, va_list params)
dvander@541
   313
{
dvander@541
   314
	size_t len = vsnprintf(buffer, maxlength, fmt, params);
dvander@541
   315
dvander@541
   316
	if (len >= maxlength)
dvander@541
   317
	{
dvander@541
   318
		len = maxlength - 1;
dvander@541
   319
		buffer[len] = '\0';
dvander@541
   320
	}
dvander@541
   321
dvander@541
   322
	return len;
dvander@541
   323
}
dvander@541
   324
dvander@541
   325
bool UTIL_VerifySignature(const void *addr, const char *sig, size_t len)
dvander@541
   326
{
dvander@541
   327
	unsigned char *addr1 = (unsigned char *) addr;
dvander@541
   328
	unsigned char *addr2 = (unsigned char *) sig;
dvander@541
   329
dvander@541
   330
	for (size_t i = 0; i < len; i++)
dvander@541
   331
	{
dvander@541
   332
		if (addr2[i] == '*')
dvander@541
   333
			continue;
dvander@541
   334
		if (addr1[i] != addr2[i])
dvander@541
   335
			return false;
dvander@541
   336
	}
dvander@541
   337
dvander@541
   338
	return true;
dvander@541
   339
}