core/LibrarySys.cpp
author David Anderson <dvander@alliedmods.net>
Fri Aug 30 10:16:28 2013 -0700 (2013-08-30)
changeset 4109 10eb68d668af
parent 3261 e4359292e59a
permissions -rw-r--r--
Use Refcounted to manage to NativeEntry (bug 5852 part 4, r=ds).
dvander@370
     1
/**
ds@653
     2
 * vim: set ts=4 :
ds@1330
     3
 * =============================================================================
dvander@1231
     4
 * SourceMod
ds@1947
     5
 * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
ds@1330
     6
 * =============================================================================
dvander@370
     7
 *
ds@1330
     8
 * This program is free software; you can redistribute it and/or modify it under
ds@1330
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330
    10
 * Free Software Foundation.
dvander@1231
    11
 * 
ds@1330
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1330
    15
 * details.
dvander@1231
    16
 *
ds@1330
    17
 * You should have received a copy of the GNU General Public License along with
ds@1330
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1231
    19
 *
ds@1330
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1330
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1330
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
ds@1330
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330
    27
 * or <http://www.sourcemod.net/license.php>.
dvander@370
    28
 *
dvander@370
    29
 * Version: $Id$
dvander@370
    30
 */
dvander@370
    31
dvander@1738
    32
#include <sys/stat.h>
dvander@141
    33
#include <stdio.h>
dvander@351
    34
#include <stdarg.h>
dvander@351
    35
#include <string.h>
dvander@351
    36
#include <sm_platform.h>
dvander@978
    37
#include "sm_stringutil.h"
dvander@141
    38
#include "LibrarySys.h"
dvander@141
    39
dvander@141
    40
LibrarySystem g_LibSys;
dvander@141
    41
dvander@141
    42
CLibrary::~CLibrary()
dvander@141
    43
{
dvander@141
    44
	if (m_lib)
dvander@141
    45
	{
dvander@141
    46
#if defined PLATFORM_WINDOWS
dvander@141
    47
		FreeLibrary(m_lib);
dvander@351
    48
#elif defined PLATFORM_POSIX
dvander@141
    49
		dlclose(m_lib);
dvander@141
    50
#endif
dvander@141
    51
		m_lib = NULL;
dvander@141
    52
	}
dvander@141
    53
}
dvander@141
    54
dvander@141
    55
CLibrary::CLibrary(LibraryHandle me)
dvander@141
    56
{
dvander@141
    57
	m_lib = me;
dvander@141
    58
}
dvander@141
    59
dvander@141
    60
void CLibrary::CloseLibrary()
dvander@141
    61
{
dvander@141
    62
	delete this;
dvander@141
    63
}
dvander@141
    64
dvander@141
    65
void *CLibrary::GetSymbolAddress(const char *symname)
dvander@141
    66
{
dvander@141
    67
#if defined PLATFORM_WINDOWS
dvander@141
    68
	return GetProcAddress(m_lib, symname);
dvander@351
    69
#elif defined PLATFORM_POSIX
dvander@141
    70
	return dlsym(m_lib, symname);
dvander@141
    71
#endif
dvander@141
    72
}
dvander@141
    73
dvander@141
    74
dvander@141
    75
/********************
dvander@141
    76
 ** Directory Code **
dvander@141
    77
 ********************/
dvander@141
    78
dvander@141
    79
dvander@141
    80
CDirectory::CDirectory(const char *path)
dvander@141
    81
{
dvander@141
    82
#if defined PLATFORM_WINDOWS
dvander@141
    83
	char newpath[PLATFORM_MAX_PATH];
dvander@141
    84
	snprintf(newpath, sizeof(newpath), "%s\\*.*", path);
dvander@141
    85
	m_dir = FindFirstFileA(newpath, &m_fd);
dvander@141
    86
	if (!IsValid())
dvander@141
    87
	{
dvander@141
    88
		m_fd.cFileName[0] = '\0';
dvander@141
    89
	}
dvander@351
    90
#elif defined PLATFORM_POSIX
dvander@141
    91
	m_dir = opendir(path);
dvander@141
    92
	if (IsValid())
dvander@141
    93
	{
dvander@141
    94
		/* :TODO: we need to read past "." and ".."! */
dvander@351
    95
		ep = readdir(m_dir);
dvander@141
    96
		snprintf(m_origpath, PLATFORM_MAX_PATH, "%s", path);
dvander@141
    97
	} else {
dvander@141
    98
		ep = NULL;
dvander@141
    99
	}
dvander@141
   100
#endif
dvander@141
   101
}
dvander@141
   102
dvander@141
   103
CDirectory::~CDirectory()
dvander@141
   104
{
dvander@141
   105
	if (IsValid())
dvander@141
   106
	{
dvander@141
   107
#if defined PLATFORM_WINDOWS
dvander@141
   108
		FindClose(m_dir);
dvander@351
   109
#elif defined PLATFORM_POSIX
dvander@141
   110
		closedir(m_dir);
dvander@141
   111
#endif
dvander@141
   112
	}
dvander@141
   113
}
dvander@141
   114
dvander@141
   115
void CDirectory::NextEntry()
dvander@141
   116
{
dvander@141
   117
#if defined PLATFORM_WINDOWS
dvander@141
   118
	if (FindNextFile(m_dir, &m_fd) == 0)
dvander@141
   119
	{
dvander@141
   120
		FindClose(m_dir);
dvander@141
   121
		m_dir = INVALID_HANDLE_VALUE;
dvander@141
   122
	}
dvander@351
   123
#elif defined PLATFORM_POSIX
dvander@351
   124
	if ((ep=readdir(m_dir)) == NULL)
dvander@141
   125
	{
dvander@141
   126
		closedir(m_dir);
dvander@141
   127
		m_dir = NULL;
dvander@141
   128
	}
dvander@141
   129
#endif
dvander@141
   130
}
dvander@141
   131
dvander@252
   132
bool CDirectory::IsEntryValid()
dvander@252
   133
{
dvander@252
   134
	return IsValid();
dvander@252
   135
}
dvander@252
   136
dvander@141
   137
bool CDirectory::IsEntryDirectory()
dvander@141
   138
{
dvander@141
   139
#if defined PLATFORM_WINDOWS
dvander@141
   140
	return ((m_fd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) == FILE_ATTRIBUTE_DIRECTORY);
dvander@2471
   141
#elif defined PLATFORM_POSIX
dvander@141
   142
	char temppath[PLATFORM_MAX_PATH];
dvander@141
   143
	snprintf(temppath, sizeof(temppath), "%s/%s", m_origpath, GetEntryName());
dvander@351
   144
	return g_LibSys.IsPathDirectory(temppath);
dvander@141
   145
#endif
dvander@141
   146
}
dvander@141
   147
dvander@141
   148
bool CDirectory::IsEntryFile()
dvander@141
   149
{
dvander@141
   150
#if defined PLATFORM_WINDOWS
dvander@141
   151
	return !(m_fd.dwFileAttributes & (FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_DEVICE));
dvander@351
   152
#elif defined PLATFORM_POSIX
dvander@141
   153
	char temppath[PLATFORM_MAX_PATH];
dvander@141
   154
	snprintf(temppath, sizeof(temppath), "%s/%s", m_origpath, GetEntryName());
dvander@351
   155
	return g_LibSys.IsPathFile(temppath);
dvander@141
   156
#endif
dvander@141
   157
}
dvander@141
   158
dvander@141
   159
const char *CDirectory::GetEntryName()
dvander@141
   160
{
dvander@141
   161
#if defined PLATFORM_WINDOWS
dvander@141
   162
	return m_fd.cFileName;
dvander@2471
   163
#elif defined PLATFORM_POSIX
dvander@141
   164
	return ep ? ep->d_name : "";
dvander@141
   165
#endif
dvander@141
   166
}
dvander@141
   167
dvander@141
   168
bool CDirectory::MoreFiles()
dvander@141
   169
{
dvander@141
   170
	return IsValid();
dvander@141
   171
}
dvander@141
   172
dvander@141
   173
bool CDirectory::IsValid()
dvander@141
   174
{
dvander@141
   175
#if defined PLATFORM_WINDOWS
dvander@141
   176
	return (m_dir != INVALID_HANDLE_VALUE);
dvander@2471
   177
#elif defined PLATFORM_POSIX
dvander@141
   178
	return (m_dir != NULL);
dvander@141
   179
#endif
dvander@141
   180
}
dvander@141
   181
dvander@141
   182
dvander@141
   183
/*************************
dvander@141
   184
 ** Library System Code **
dvander@141
   185
 *************************/
dvander@141
   186
dvander@141
   187
dvander@141
   188
bool LibrarySystem::PathExists(const char *path)
dvander@141
   189
{
dvander@141
   190
#if defined PLATFORM_WINDOWS
dvander@141
   191
	DWORD attr = GetFileAttributesA(path);
dvander@141
   192
dvander@141
   193
	return (attr != INVALID_FILE_ATTRIBUTES);
dvander@351
   194
#elif defined PLATFORM_POSIX
dvander@141
   195
	struct stat s;
dvander@141
   196
dvander@141
   197
	return (stat(path, &s) == 0);
dvander@141
   198
#endif
dvander@141
   199
}
dvander@141
   200
dvander@141
   201
bool LibrarySystem::IsPathFile(const char *path)
dvander@141
   202
{
dvander@141
   203
#if defined PLATFORM_WINDOWS
dvander@141
   204
	DWORD attr = GetFileAttributes(path);
dvander@141
   205
dvander@141
   206
	if (attr == INVALID_FILE_ATTRIBUTES)
dvander@141
   207
	{
dvander@141
   208
		return false;
dvander@141
   209
	}
dvander@141
   210
dvander@141
   211
	if (attr & (FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_DEVICE))
dvander@141
   212
	{
dvander@141
   213
		return false;
dvander@141
   214
	}
dvander@141
   215
dvander@141
   216
	return true;
dvander@2471
   217
#elif defined PLATFORM_POSIX
dvander@141
   218
	struct stat s;
dvander@141
   219
dvander@141
   220
	if (stat(path, &s) != 0)
dvander@141
   221
	{
dvander@141
   222
		return false;
dvander@141
   223
	}
dvander@141
   224
dvander@141
   225
	return S_ISREG(s.st_mode) ? true : false;
dvander@141
   226
#endif
dvander@141
   227
}
dvander@141
   228
dvander@141
   229
bool LibrarySystem::IsPathDirectory(const char *path)
dvander@141
   230
{
dvander@141
   231
#if defined PLATFORM_WINDOWS
dvander@141
   232
	DWORD attr = GetFileAttributes(path);
dvander@141
   233
dvander@141
   234
	if (attr == INVALID_FILE_ATTRIBUTES)
dvander@141
   235
	{
dvander@141
   236
		return false;
dvander@141
   237
	}
dvander@141
   238
dvander@141
   239
	if (attr & FILE_ATTRIBUTE_DIRECTORY)
dvander@141
   240
	{
dvander@141
   241
		return true;
dvander@141
   242
	}
dvander@141
   243
ds@3027
   244
#elif defined PLATFORM_POSIX
dvander@141
   245
	struct stat s;
dvander@141
   246
dvander@141
   247
	if (stat(path, &s) != 0)
dvander@141
   248
	{
dvander@141
   249
		return false;
dvander@141
   250
	}
dvander@141
   251
dvander@141
   252
	if (S_ISDIR(s.st_mode))
dvander@141
   253
	{
dvander@141
   254
		return true;
dvander@141
   255
	}
dvander@141
   256
#endif
dvander@141
   257
dvander@141
   258
	return false;
dvander@141
   259
}
dvander@141
   260
dvander@141
   261
IDirectory *LibrarySystem::OpenDirectory(const char *path)
dvander@141
   262
{
dvander@141
   263
	CDirectory *dir = new CDirectory(path);
dvander@141
   264
dvander@141
   265
	if (!dir->IsValid())
dvander@141
   266
	{
dvander@141
   267
		delete dir;
dvander@141
   268
		return NULL;
dvander@141
   269
	}
dvander@141
   270
dvander@141
   271
	return dir;
dvander@141
   272
}
dvander@141
   273
ds@755
   274
void LibrarySystem::GetPlatformError(char *error, size_t maxlength)
dvander@141
   275
{
dvander@2474
   276
#if defined PLATFORM_WINDOWS
dvander@2474
   277
	return GetPlatformErrorEx(GetLastError(), error, maxlength);
dvander@2474
   278
#elif defined PLATFORM_POSIX
dvander@2474
   279
	return GetPlatformErrorEx(errno, error, maxlength);
dvander@2474
   280
#endif
dvander@2474
   281
}
dvander@2474
   282
dvander@2474
   283
void LibrarySystem::GetPlatformErrorEx(int code, char *error, size_t maxlength)
dvander@2474
   284
{
ds@755
   285
	if (error && maxlength)
dvander@141
   286
	{
dvander@141
   287
#if defined PLATFORM_WINDOWS
dvander@2685
   288
		if (FormatMessageA(FORMAT_MESSAGE_FROM_SYSTEM|FORMAT_MESSAGE_IGNORE_INSERTS,
dvander@2685
   289
						   NULL,
dvander@2685
   290
						   (DWORD)code,
dvander@2685
   291
						   MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
dvander@2685
   292
						   (LPSTR)error,
dvander@2685
   293
						   maxlength,
dvander@2685
   294
						   NULL) == 0)
dvander@2685
   295
		{
dvander@2685
   296
			UTIL_Format(error, maxlength, "error code %08x", code);
dvander@2685
   297
		}
dvander@2474
   298
#elif defined PLATFORM_LINUX
dvander@2474
   299
		const char *ae = strerror_r(code, error, maxlength);
dvander@2474
   300
		if (ae != error)
dvander@2474
   301
		{
dvander@2474
   302
			UTIL_Format(error, maxlength, "%s", ae);
dvander@2474
   303
		}
dvander@351
   304
#elif defined PLATFORM_POSIX
dvander@2474
   305
		strerror_r(code, error, maxlength);
dvander@141
   306
#endif
dvander@141
   307
	}
dvander@141
   308
}
dvander@141
   309
dvander@1974
   310
void LibrarySystem::GetLoaderError(char *buffer, size_t maxlength)
dvander@1974
   311
{
dvander@1974
   312
#if defined PLATFORM_WINDOWS
dvander@1974
   313
	GetPlatformError(buffer, maxlength);
dvander@1974
   314
#elif defined PLATFORM_POSIX
dvander@1974
   315
	if (buffer != NULL && maxlength)
dvander@1974
   316
	{
dvander@1974
   317
		strncopy(buffer, dlerror(), maxlength);
dvander@1974
   318
	}
dvander@1974
   319
#endif
dvander@1974
   320
}
dvander@1974
   321
dvander@141
   322
void LibrarySystem::CloseDirectory(IDirectory *dir)
dvander@141
   323
{
dvander@141
   324
	delete dir;
dvander@141
   325
}
dvander@141
   326
ds@755
   327
ILibrary *LibrarySystem::OpenLibrary(const char *path, char *error, size_t maxlength)
dvander@141
   328
{
dvander@141
   329
	LibraryHandle lib;
dvander@141
   330
#if defined PLATFORM_WINDOWS
dvander@141
   331
	lib = LoadLibraryA(path);
dvander@351
   332
#elif defined PLATFORM_POSIX
dvander@141
   333
	lib = dlopen(path, RTLD_NOW);
dvander@1974
   334
#endif
dvander@1974
   335
dvander@1974
   336
	if (lib == NULL)
dvander@141
   337
	{
dvander@1974
   338
		GetLoaderError(error, maxlength);
dvander@1974
   339
		return NULL;
dvander@141
   340
	}
dvander@141
   341
dvander@141
   342
	return new CLibrary(lib);
dvander@141
   343
}
dvander@206
   344
dvander@317
   345
size_t LibrarySystem::PathFormat(char *buffer, size_t len, const char *fmt, ...)
dvander@206
   346
{
dvander@206
   347
	va_list ap;
ds@652
   348
	va_start(ap, fmt);
dvander@206
   349
	size_t mylen = vsnprintf(buffer, len, fmt, ap);
dvander@206
   350
	va_end(ap);
dvander@206
   351
ds@652
   352
	if (mylen >= len)
ds@652
   353
	{
ds@652
   354
		mylen = len - 1;
ds@652
   355
		buffer[mylen] = '\0';
ds@652
   356
	}
faluco@274
   357
dvander@206
   358
	for (size_t i=0; i<mylen; i++)
dvander@206
   359
	{
dvander@206
   360
		if (buffer[i] == PLATFORM_SEP_ALTCHAR)
dvander@206
   361
		{
dvander@206
   362
			buffer[i] = PLATFORM_SEP_CHAR;
dvander@206
   363
		}
dvander@206
   364
	}
dvander@317
   365
dvander@317
   366
	return mylen;
dvander@206
   367
}
ds@794
   368
ds@794
   369
const char *LibrarySystem::GetFileExtension(const char *filename)
ds@794
   370
{
ds@2013
   371
	size_t len, end;
ds@794
   372
ds@2011
   373
	len = strlen(filename);
ds@1952
   374
ds@2011
   375
	/* Minimum string length for filename with ext would be 3; example: a.a */
ds@2011
   376
	if (len < 3)
ds@794
   377
	{
ds@2011
   378
		return NULL;
ds@2011
   379
	}
ds@829
   380
ds@2011
   381
	end = len - 1;
ds@2011
   382
ds@2013
   383
	for (size_t i = end; i <= end; i--)
ds@2011
   384
	{
ds@794
   385
		if (filename[i] == PLATFORM_SEP_CHAR || filename[i] == PLATFORM_SEP_ALTCHAR)
ds@794
   386
		{
ds@829
   387
			break;
ds@794
   388
		}
ds@794
   389
ds@2011
   390
		if (filename[i] == '.' && i != end && i != 0)
ds@794
   391
		{
ds@794
   392
			return &filename[++i];
ds@794
   393
		}
ds@794
   394
	}
ds@794
   395
ds@794
   396
	return NULL;
ds@794
   397
}
dvander@978
   398
dvander@1192
   399
bool LibrarySystem::CreateFolder(const char *path)
dvander@978
   400
{
dvander@978
   401
#if defined PLATFORM_WINDOWS
dvander@978
   402
	return (mkdir(path) != -1);
dvander@978
   403
#elif defined PLATFORM_POSIX
dvander@978
   404
	return (mkdir(path, 0775) != -1);
dvander@978
   405
#endif
dvander@978
   406
}
dvander@978
   407
dvander@978
   408
size_t LibrarySystem::GetFileFromPath(char *buffer, size_t maxlength, const char *path)
dvander@978
   409
{
dvander@978
   410
	size_t length = strlen(path);
dvander@978
   411
dvander@978
   412
	for (size_t i = length - 1;
ds@3261
   413
		 i <= length - 1;
dvander@1508
   414
		 i--)
dvander@978
   415
	{
dvander@978
   416
		if (path[i] == '/' 
dvander@978
   417
#if defined PLATFORM_WINDOWS
dvander@978
   418
			|| path[i] == '\\'
dvander@978
   419
#endif
dvander@978
   420
			)
dvander@978
   421
		{
dvander@978
   422
			return UTIL_Format(buffer, maxlength, "%s", &path[i+1]);
dvander@978
   423
		}
dvander@978
   424
	}
dvander@978
   425
dvander@978
   426
	/* We scanned and found no path separator */
dvander@978
   427
	return UTIL_Format(buffer, maxlength, "%s", path);
dvander@978
   428
}
dvander@1738
   429
dvander@1738
   430
bool LibrarySystem::FileTime(const char *path, FileTimeType type, time_t *pTime)
dvander@1738
   431
{
dvander@1738
   432
#ifdef PLATFORM_WINDOWS
dvander@1738
   433
	struct _stat s;
dvander@1738
   434
	if (_stat(path, &s) != 0)
dvander@1738
   435
#elif defined PLATFORM_POSIX
dvander@1738
   436
	struct stat s;
dvander@1738
   437
	if (stat(path, &s) != 0)
dvander@1738
   438
#endif
dvander@1738
   439
	{
dvander@1738
   440
		return false;
dvander@1738
   441
	}
dvander@1738
   442
dvander@1738
   443
	if (type == FileTime_LastAccess)
dvander@1738
   444
	{
dvander@1738
   445
		*pTime = s.st_atime;
dvander@1738
   446
	}
dvander@1738
   447
	else if (type == FileTime_Created)
dvander@1738
   448
	{
dvander@1738
   449
		*pTime = s.st_ctime;
dvander@1738
   450
	}
dvander@1738
   451
	else if (type == FileTime_LastChange)
dvander@1738
   452
	{
dvander@1738
   453
		*pTime = s.st_mtime;
dvander@1738
   454
	}
dvander@1738
   455
dvander@1738
   456
	return true;
dvander@1738
   457
}