3 * =============================================================================
5 * Copyright (C) 2004-2008 AlliedModders LLC. All rights reserved.
6 * =============================================================================
8 * This program is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU General Public License, version 3.0, as published by the
10 * Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
17 * You should have received a copy of the GNU General Public License along with
18 * this program. If not, see <http://www.gnu.org/licenses/>.
20 * As a special exception, AlliedModders LLC gives you permission to link the
21 * code of this program (as well as its derivative works) to "Half-Life 2," the
22 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
23 * by the Valve Corporation. You must obey the GNU General Public License in
24 * all respects for all other code used. Additionally, AlliedModders LLC grants
25 * this exception to all derivative works. AlliedModders LLC defines further
26 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
27 * or <http://www.sourcemod.net/license.php>.
32 #include "GameDataFetcher.h"
35 #ifdef PLATFORM_WINDOWS
39 #include <sys/types.h>
40 #include <sys/socket.h>
41 #include <netinet/in.h>
43 #include <arpa/inet.h>
45 #define INVALID_SOCKET -1
46 #define closesocket close
47 #define WSAGetLastError() errno
50 #include "sh_vector.h"
51 #include "sh_string.h"
52 #include "sm_version.h"
54 #ifdef ORANGEBOX_BUILD
55 #include "convar_sm_ob.h"
57 #include "convar_sm.h"
60 #include "sourcemm_api.h"
63 #include "compat_wrappers.h"
64 #include "sm_stringutil.h"
67 #define QUERY_MAX_LENGTH 1024
69 BuildMD5ableBuffer g_MD5Builder;
70 FetcherThread g_FetchThread;
74 bool g_disableGameDataUpdate = false;
75 bool g_restartAfterUpdate = false;
77 int g_serverPort = 6500;
78 char g_serverAddress[100] = "smupdate.alliedmods.net";
80 void FetcherThread::RunThread(IThreadHandle *pHandle)
82 char lock_path[PLATFORM_MAX_PATH];
83 g_SourceMod.BuildPath(Path_SM, lock_path, sizeof(lock_path), "data/temp");
84 g_LibSys.CreateFolder(lock_path);
86 g_SourceMod.BuildPath(Path_SM, lock_path, sizeof(lock_path), "data/temp/gamedata.lock");
88 g_Logger.LogMessage("Starting Gamedata update fetcher... please report problems to bugs.alliedmods.net");
90 char log_path[PLATFORM_MAX_PATH];
91 g_SourceMod.BuildPath(Path_SM, log_path, sizeof(log_path), "logs/gamedata");
93 g_LibSys.CreateFolder(log_path);
97 tm *curtime = localtime(&t);
99 g_SourceMod.BuildPath(Path_SM, log_path, sizeof(log_path), "logs/gamedata/L%02d%02d.log", curtime->tm_mon + 1, curtime->tm_mday);
101 logfile = fopen(log_path, "a");
105 g_Logger.LogError("Failed to create GameData log file");
109 //Create a blank lock file
110 FILE *fp = fopen(lock_path, "w");
116 char query[QUERY_MAX_LENGTH];
118 /* Check for updated gamedata files */
119 int len = BuildGameDataQuery(query, QUERY_MAX_LENGTH);
123 g_Logger.LogToOpenFile(logfile, "Query Writing failed");
130 if (g_disableGameDataUpdate)
132 g_Logger.LogMessage("Skipping GameData Query due to DisableAutoUpdate being set to true");
139 /* Create a new socket for this connection */
140 int socketDescriptor = ConnectSocket();
142 if (socketDescriptor == INVALID_SOCKET)
149 int sent = SendData(socketDescriptor, query, len);
152 g_Logger.LogToOpenFile(logfile, "Sent gamedata query");
158 g_Logger.LogToOpenFile(logfile, "Failed to send gamedata query data to remote host");
161 closesocket(socketDescriptor);
167 ProcessGameDataQuery(socketDescriptor);
169 /* And we're done! */
170 closesocket(socketDescriptor);
175 void FetcherThread::OnTerminate(IThreadHandle *pHandle, bool cancel)
177 g_blockGameDataLoad = false;
180 int FetcherThread::BuildGameDataQuery(char *buffer, int maxlen)
182 char gamedata_path[PLATFORM_MAX_PATH];
183 g_SourceMod.BuildPath(Path_SM, gamedata_path, sizeof(gamedata_path), "gamedata");
185 IDirectory *dir = g_LibSys.OpenDirectory(gamedata_path);
192 bf_write Writer = bf_write("GameDataQuery", buffer, maxlen);
194 Writer.WriteByte('A'); //Generic Header char
195 Writer.WriteByte('G'); //G for gamedata query, or green, like my hat.
197 short build[4] = { SVN_FILE_VERSION };
199 Writer.WriteBytes(&build[0], 8);
201 Writer.WriteByte(0); // Initialize the file counter - Index 10
203 while (dir->MoreFiles())
205 if (dir->IsEntryFile())
207 const char *name = dir->GetEntryName();
208 size_t len = strlen(name);
209 if (len >= 4 && strcmp(&name[len-4], ".txt") == 0)
214 unsigned char raw[16];
215 char file[PLATFORM_MAX_PATH];
217 g_LibSys.PathFormat(file, sizeof(file), "%s/%s", gamedata_path, name);
219 g_MD5Builder.checksum = &md5;
220 if ((err = g_TextParser.ParseFile_SMC(file, &g_MD5Builder, &states)) == SMCError_Okay)
223 (uint8_t)buffer[10]++; //Increment the file counter
224 Writer.WriteBytes(raw, 16);
226 FileData *data = new FileData();
227 data->filename = new SourceHook::String(file);
228 md5.hex_digest(data->checksum);
229 filenames.push_back(data);
232 g_Logger.LogToOpenFile(logfile, "Parsed file: %s as %s", file, data->checksum);
239 const char *error = g_TextParser.GetSMCErrorString(err);
240 g_Logger.LogToOpenFile(logfile, "Parsing of file %s failed: %s", file, error);
249 return Writer.GetNumBytesWritten();
252 int FetcherThread::ConnectSocket()
254 #if defined PLATFORM_WINDOWS
256 WSAStartup(0x0101, &wsaData);
259 struct protoent *ptrp;
261 if ((ptrp = getprotobyname("tcp")) == NULL)
263 g_Logger.LogToOpenFile(logfile, "Error: Failed to find TCP protocol");
264 return INVALID_SOCKET;
267 int socketDescriptor = socket(AF_INET, SOCK_STREAM, ptrp->p_proto);
269 if (socketDescriptor == INVALID_SOCKET)
272 g_LibSys.GetPlatformErrorEx(WSAGetLastError(), error, sizeof(error));
273 g_Logger.LogToOpenFile(logfile, "Error: Failed to create socket: %s", error);
274 closesocket(socketDescriptor);
275 return INVALID_SOCKET;
279 struct sockaddr_in local_addr;
281 local_addr.sin_family = AF_INET;
282 local_addr.sin_port = htons((u_short)g_serverPort);
284 he = gethostbyname(g_serverAddress);
288 if ((local_addr.sin_addr.s_addr = inet_addr(g_serverAddress)) == INADDR_NONE)
290 g_Logger.LogToOpenFile(logfile, "Couldn't locate address: %s", g_serverAddress);
291 closesocket(socketDescriptor);
292 return INVALID_SOCKET;
297 memcpy(&local_addr.sin_addr, (struct in_addr *)he->h_addr, he->h_length);
300 if (connect(socketDescriptor, (struct sockaddr *) &local_addr, sizeof(local_addr)) < 0)
303 g_LibSys.GetPlatformErrorEx(WSAGetLastError(), error, sizeof(error));
304 g_Logger.LogToOpenFile(logfile, "Couldn't connect to %s: %s", g_serverAddress, error);
305 closesocket(socketDescriptor);
306 return INVALID_SOCKET;
309 return socketDescriptor;
312 void FetcherThread::ProcessGameDataQuery(int socketDescriptor)
317 g_Logger.LogToOpenFile(logfile, "Waiting for reply!");
320 //Read in the header bytes
321 int returnLen = RecvData(socketDescriptor, buffer, 12);
327 g_LibSys.GetPlatformErrorEx(WSAGetLastError(), error, sizeof(error));
328 g_Logger.LogToOpenFile(logfile, "Did not receive reply: %s", error);
333 g_Logger.LogToOpenFile(logfile, "Received Header!");
336 bf_read Reader = bf_read("GameDataQuery", buffer, 12);
338 if (Reader.ReadByte() != 'A' || Reader.ReadByte() != 'G')
341 g_Logger.LogToOpenFile(logfile, "Unknown Query Response");
346 UpdateStatus updateStatus = (UpdateStatus)Reader.ReadByte();
348 short build[4] = {0,0,0,0};
350 build[0] = Reader.ReadShort();
351 build[1] = Reader.ReadShort();
352 build[2] = Reader.ReadShort();
353 build[3] = Reader.ReadShort();
356 g_Logger.LogToOpenFile(logfile,
357 "Update Status: %i - Latest %i.%i.%i.%i",
365 HandleUpdateStatus(updateStatus, build);
367 int changedFiles = Reader.ReadByte();
370 g_Logger.LogToOpenFile(logfile, "Files to download: %i", changedFiles);
373 for (int i=0; i<changedFiles; i++)
375 //Read in the file index and byte count
376 returnLen = RecvData(socketDescriptor, buffer, 5);
380 /* Timeout or fail? */
384 Reader.StartReading(buffer, 5);
386 int index = Reader.ReadByte();
387 int tempLen = Reader.ReadUBitLong(32);
390 g_Logger.LogToOpenFile(logfile, "File index %i and length %i", index, tempLen);
394 memtable->CreateMem(tempLen+1, &memPtr);
396 //Read the contents of our file into the memtable
397 returnLen = RecvData(socketDescriptor, (char *)memPtr, tempLen);
400 g_Logger.LogToOpenFile(logfile, "Received %i bytes", returnLen);
405 /* Timeout or fail? */
409 ((unsigned char *)memPtr)[tempLen] = '\0';
411 FileData *data = filenames.at(index);
412 const char *filename;
415 filename = data->filename->c_str();
417 FILE *fp = fopen(filename, "w");
421 fprintf(fp, "%s", (const char *)memPtr);
426 g_Logger.LogToOpenFile(logfile, "Failed to open file \"%s\" for writing", filename);
437 g_Logger.LogToOpenFile(logfile, "Updated file: %s", filename);
441 g_Logger.LogToOpenFile(logfile, "File Downloads Completed!");
444 bool needsRestart = false;
446 if (changedFiles > 0)
449 g_Logger.LogMessage("New GameData Files have been downloaded to your gamedata directory. Please restart your server for these to take effect");
452 //Read changed file count
453 returnLen = RecvData(socketDescriptor, buffer, 1);
458 g_LibSys.GetPlatformErrorEx(WSAGetLastError(), error, sizeof(error));
459 g_Logger.LogToOpenFile(logfile, "Did not receive count reply: %s", error);
463 Reader.StartReading(buffer, 1);
465 changedFiles = Reader.ReadByte();
467 if (changedFiles < 1)
470 g_Logger.LogToOpenFile(logfile, "No unknown files. We're all done");
475 char *changedFileIndexes = new char[changedFiles];
478 g_Logger.LogToOpenFile(logfile, "%i Files were unknown", changedFiles);
481 returnLen = RecvData(socketDescriptor, changedFileIndexes, changedFiles);
486 g_LibSys.GetPlatformErrorEx(WSAGetLastError(), error, sizeof(error));
487 g_Logger.LogToOpenFile(logfile, "Did not receive list reply: %s", error);
491 Reader.StartReading(changedFileIndexes, changedFiles);
493 for (int i=0; i<changedFiles; i++)
495 int index = Reader.ReadByte();
498 FileData *data = filenames.at(index);
499 const char* pathname;
502 pathname = data->filename->c_str();
509 g_LibSys.GetFileFromPath(fileName, sizeof(fileName), pathname);
511 g_Logger.LogToOpenFile(logfile, "Unknown File %i : %s", index, fileName);
515 delete [] changedFileIndexes;
517 if (needsRestart && g_restartAfterUpdate)
519 /* :TODO: none of this is thread safe. */
520 g_Logger.LogMessage("Automatically restarting server after a successful gamedata update!");
521 engine->ServerCommand("quit\n");
525 int FetcherThread::RecvData(int socketDescriptor, char *buffer, int len)
530 /* Create a 10 Second Timeout */
534 int bytesReceivedTotal = 0;
536 while (bytesReceivedTotal < len)
538 /* Add our socket to a socket set */
540 FD_SET(socketDescriptor, &fds);
542 /* Wait max of 10 seconds for recv to become available */
543 select(socketDescriptor+1, &fds, NULL, NULL, &tv);
545 int bytesReceived = 0;
547 /* Is there a limit on how much we can receive? Some site said 1024 bytes, which will be well short of a file */
548 if (FD_ISSET(socketDescriptor, &fds))
550 bytesReceived = recv(socketDescriptor, buffer+bytesReceivedTotal, len-bytesReceivedTotal, 0);
553 if (bytesReceived == 0 || bytesReceived == -1)
558 bytesReceivedTotal += bytesReceived;
561 return bytesReceivedTotal;
564 int FetcherThread::SendData(int socketDescriptor, char *buffer, int len)
572 int sentBytesTotal = 0;
574 while (sentBytesTotal < len)
577 FD_SET(socketDescriptor, &fds);
579 select(socketDescriptor+1, NULL, &fds, NULL, &tv);
583 if (FD_ISSET(socketDescriptor, &fds))
585 sentBytes = send(socketDescriptor, buffer+sentBytesTotal, len-sentBytesTotal, 0);
588 if (sentBytes == 0 || sentBytes == -1)
593 sentBytesTotal += sentBytes;
596 return sentBytesTotal;
599 void FetcherThread::HandleUpdateStatus(UpdateStatus status, short version[4])
609 case Update_NewBuild:
614 case Update_MinorAvailable:
616 g_Logger.LogMessage("SourceMod Update: A new release of SourceMod is now available from sourcemod.net");
617 g_Logger.LogMessage("Current Version: %i.%i.%i Available: %i.%i.%i", version[0], version[1], version[2], version[0], version[1], version[2]);
621 case Update_MajorAvailable:
623 g_Logger.LogMessage("SourceMod Update: An major release of SourceMod is now available from sourcemod.net");
624 g_Logger.LogMessage("Current Version: %i.%i.%i Available: %i.%i.%i", version[0], version[1], version[2], version[0], version[1], version[2]);
628 case Update_CriticalAvailable:
630 g_Logger.LogError("SourceMod Update: A critical SourceMod release is available from sourcemod.net. It is strongly recommended that you update!");
631 g_Logger.LogMessage("Current Version: %i.%i.%i Available: %i.%i.%i", version[0], version[1], version[2], version[0], version[1], version[2]);
637 bool g_blockGameDataLoad = false;
639 class InitFetch : public SMGlobalClass
642 void OnSourceModAllInitialized_Post()
644 char lock_path[PLATFORM_MAX_PATH];
645 g_SourceMod.BuildPath(Path_SM, lock_path, sizeof(lock_path), "data/temp/gamedata.lock");
647 if (g_LibSys.IsPathFile(lock_path) && g_LibSys.PathExists(lock_path))
649 g_Logger.LogError("sourcemod/data/temp/gamedata.lock file detected. This is most likely due to a crash during GameData updating - Blocking GameData loading");
650 g_Logger.LogError("If this error persists delete the file manually");
651 g_blockGameDataLoad = true;
654 ThreadParams fetchThreadParams = ThreadParams();
655 fetchThreadParams.prio = ThreadPrio_Low;
656 g_pThreader->MakeThread(&g_FetchThread, &fetchThreadParams);
659 ConfigResult OnSourceModConfigChanged(const char *key,
665 if (strcasecmp(key, "DisableAutoUpdate") == 0)
667 if (strcasecmp(value, "yes") == 0)
669 g_disableGameDataUpdate = true;
670 return ConfigResult_Accept;
672 else if (strcasecmp(value, "no") == 0)
674 g_disableGameDataUpdate = false;
675 return ConfigResult_Accept;
678 return ConfigResult_Reject;
681 if (strcasecmp(key, "ForceRestartAfterUpdate") == 0)
683 if (strcasecmp(value, "yes") == 0)
685 g_restartAfterUpdate = true;
686 return ConfigResult_Accept;
688 else if (strcasecmp(value, "no") == 0)
690 g_restartAfterUpdate = false;
691 return ConfigResult_Accept;
694 return ConfigResult_Reject;
697 if (strcasecmp(key, "AutoUpdateServer") == 0)
699 UTIL_Format(g_serverAddress, sizeof(g_serverAddress), "%s", value);
701 return ConfigResult_Accept;
704 if (strcasecmp(key, "AutoUpdatePort") == 0)
706 int port = atoi(value);
710 return ConfigResult_Reject;
715 return ConfigResult_Accept;
718 return ConfigResult_Ignore;
722 BuildMD5ableBuffer::BuildMD5ableBuffer()
724 stringTable = new BaseStringTable(2048);
727 BuildMD5ableBuffer::~BuildMD5ableBuffer()
732 void BuildMD5ableBuffer::ReadSMC_ParseStart()
734 stringTable->Reset();
737 SMCResult BuildMD5ableBuffer::ReadSMC_KeyValue(const SMCStates *states,
741 stringTable->AddString(key);
742 stringTable->AddString(value);
744 return SMCResult_Continue;
747 SMCResult BuildMD5ableBuffer::ReadSMC_NewSection(const SMCStates *states, const char *name)
749 stringTable->AddString(name);
751 return SMCResult_Continue;
754 void BuildMD5ableBuffer::ReadSMC_ParseEnd(bool halted, bool failed)
756 if (halted || failed)
761 void *data = stringTable->GetMemTable()->GetAddress(0);
765 checksum->update((unsigned char *)data, stringTable->GetMemTable()->GetActualMemUsed());
768 checksum->finalize();
771 CON_COMMAND(sm_gamedata_md5, "Checks the MD5 sum for a given gamedata file")
773 #if !defined ORANGEBOX_BUILD
779 g_SMAPI->ConPrint("Usage: sm_gamedata_md5 <file>\n");
783 const char *file = args.Arg(1);
784 if (!file || file[0] == '\0')
786 g_SMAPI->ConPrint("Usage: sm_gamedata_md5 <file>\n");
790 SourceHook::CVector<FileData *>::iterator iter = g_FetchThread.filenames.begin();
794 while (iter != g_FetchThread.filenames.end())
800 g_LibSys.GetFileFromPath(fileName, sizeof(fileName), curData->filename->c_str());
802 if (strcmpi(fileName, file) == 0)
804 g_SMAPI->ConPrintf("MD5 Sum: %s\n", curData->checksum);
811 g_SMAPI->ConPrint("File not found!\n");
814 FetcherThread::~FetcherThread()
817 SourceHook::CVector<FileData *>::iterator iter = filenames.begin();
821 while (iter != filenames.end())
824 delete curData->filename;
826 iter = filenames.erase(iter);
830 FetcherThread::FetcherThread()
832 memtable = new BaseMemTable(4096);