extensions/updater/extension.cpp
author David Anderson <dvander@alliedmods.net>
Mon Mar 16 18:43:34 2009 -0400 (2009-03-16)
changeset 2682 2e69fa184c04
parent 2679 ae5536263760
child 2783 5f333027ef04
permissions -rw-r--r--
Fixed auto update URL being set too late (bug 3699, r=pred).
dvander@2562
     1
/**
dvander@2562
     2
 * vim: set ts=4 :
dvander@2562
     3
 * =============================================================================
dvander@2562
     4
 * SourceMod Updater Extension
dvander@2562
     5
 * Copyright (C) 2004-2009 AlliedModders LLC.  All rights reserved.
dvander@2562
     6
 * =============================================================================
dvander@2562
     7
 *
dvander@2562
     8
 * This program is free software; you can redistribute it and/or modify it under
dvander@2562
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
dvander@2562
    10
 * Free Software Foundation.
dvander@2562
    11
 * 
dvander@2562
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
dvander@2562
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
dvander@2562
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
dvander@2562
    15
 * details.
dvander@2562
    16
 *
dvander@2562
    17
 * You should have received a copy of the GNU General Public License along with
dvander@2562
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@2562
    19
 *
dvander@2562
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
dvander@2562
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
dvander@2562
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
dvander@2562
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
dvander@2562
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
dvander@2562
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
dvander@2562
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
dvander@2562
    27
 * or <http://www.sourcemod.net/license.php>.
dvander@2562
    28
 *
dvander@2562
    29
 * Version: $Id$
dvander@2562
    30
 */
dvander@2562
    31
dvander@2562
    32
#include <stdio.h>
dvander@2562
    33
#include <stdarg.h>
dvander@2562
    34
#include <string.h>
dvander@2562
    35
#include <stdlib.h>
dvander@2562
    36
#include "extension.h"
dvander@2562
    37
#include "Updater.h"
dvander@2562
    38
#include <sh_list.h>
dvander@2562
    39
#include <sh_string.h>
dvander@2562
    40
dvander@2575
    41
#define DEFAULT_UPDATE_URL			"http://www.sourcemod.net/update/"
dvander@2575
    42
dvander@2562
    43
using namespace SourceHook;
dvander@2562
    44
dvander@2562
    45
SmUpdater g_Updater;		/**< Global singleton for extension's main interface */
dvander@2562
    46
SMEXT_LINK(&g_Updater);
dvander@2562
    47
dvander@2562
    48
IWebternet *webternet;
dvander@2562
    49
static List<String *> update_errors;
dvander@2562
    50
static IThreadHandle *update_thread;
dvander@2575
    51
static String update_url;
dvander@2562
    52
dvander@2562
    53
bool SmUpdater::SDK_OnLoad(char *error, size_t maxlength, bool late)
dvander@2562
    54
{
dvander@2562
    55
	sharesys->AddDependency(myself, "webternet.ext", true, true);
dvander@2562
    56
dvander@2562
    57
	SM_GET_IFACE(WEBTERNET, webternet);
dvander@2682
    58
dvander@2682
    59
	const char *url = smutils->GetCoreConfigValue("AutoUpdateURL");
dvander@2682
    60
	if (url == NULL)
dvander@2682
    61
	{
dvander@2682
    62
		url = DEFAULT_UPDATE_URL;
dvander@2682
    63
	}
dvander@2682
    64
	update_url.assign(url);
dvander@2562
    65
	
dvander@2562
    66
	ThreadParams params;
dvander@2562
    67
	params.flags = Thread_Default;
dvander@2562
    68
	params.prio = ThreadPrio_Low;
dvander@2562
    69
	update_thread = threader->MakeThread(this, &params);
dvander@2562
    70
dvander@2562
    71
	if (update_thread == NULL)
dvander@2562
    72
	{
dvander@2562
    73
		smutils->Format(error, maxlength, "Could not create thread");
dvander@2562
    74
		return false;
dvander@2562
    75
	}
dvander@2562
    76
dvander@2562
    77
	return true;
dvander@2562
    78
}
dvander@2562
    79
dvander@2562
    80
void SmUpdater::SDK_OnUnload()
dvander@2562
    81
{
dvander@2562
    82
	/* An interface drop might have killed this thread.  
dvander@2562
    83
	 * But if the handle is still there, we have to wait.
dvander@2562
    84
	 */
dvander@2562
    85
	if (update_thread != NULL)
dvander@2562
    86
	{
dvander@2562
    87
		update_thread->WaitForThread();
dvander@2562
    88
		update_thread->DestroyThis();
dvander@2562
    89
	}
dvander@2562
    90
dvander@2562
    91
	/* Clear message tables */
dvander@2634
    92
	List<String *>::iterator iter = update_errors.begin();
dvander@2562
    93
	while (iter != update_errors.end())
dvander@2562
    94
	{
dvander@2562
    95
		iter = update_errors.erase(iter);
dvander@2562
    96
	}
dvander@2562
    97
}
dvander@2562
    98
dvander@2562
    99
bool SmUpdater::QueryInterfaceDrop(SourceMod::SMInterface *pInterface)
dvander@2562
   100
{
dvander@2562
   101
	if (pInterface == webternet)
dvander@2562
   102
	{
dvander@2562
   103
		return false;
dvander@2562
   104
	}
dvander@2562
   105
dvander@2562
   106
	return true;
dvander@2562
   107
}
dvander@2562
   108
dvander@2562
   109
void SmUpdater::NotifyInterfaceDrop(SMInterface *pInterface)
dvander@2562
   110
{
dvander@2562
   111
	if (pInterface == webternet)
dvander@2562
   112
	{
dvander@2562
   113
		/* Can't be in the thread if we're losing this extension. */
dvander@2562
   114
		update_thread->WaitForThread();
dvander@2562
   115
		update_thread->DestroyThis();
dvander@2562
   116
		update_thread = NULL;
dvander@2562
   117
	}
dvander@2562
   118
}
dvander@2562
   119
dvander@2573
   120
static void PumpUpdate(void *data)
dvander@2562
   121
{
dvander@2562
   122
	String *str;
dvander@2628
   123
	bool new_files = false;
dvander@2562
   124
	List<String *>::iterator iter;
dvander@2562
   125
dvander@2573
   126
	char path[PLATFORM_MAX_PATH];
dvander@2573
   127
	UpdatePart *temp;
dvander@2573
   128
	UpdatePart *part = (UpdatePart*)data;
dvander@2573
   129
	while (part != NULL)
dvander@2573
   130
	{
dvander@2576
   131
		if (strstr(part->file, "..") != NULL)
dvander@2576
   132
		{
dvander@2576
   133
			/* Naughty naughty */
dvander@2576
   134
			AddUpdateError("Detected invalid path escape (..): %s", part->file);
dvander@2576
   135
			goto skip_create;
dvander@2576
   136
		}
dvander@2573
   137
		if (part->data == NULL)
dvander@2573
   138
		{
dvander@2573
   139
			smutils->BuildPath(Path_SM, path, sizeof(path), "gamedata/%s", part->file);
dvander@2573
   140
			if (libsys->IsPathDirectory(path))
dvander@2573
   141
			{
dvander@2679
   142
				goto skip_create;
dvander@2573
   143
			}
dvander@2573
   144
			if (!libsys->CreateFolder(path))
dvander@2573
   145
			{
dvander@2573
   146
				AddUpdateError("Could not create folder: %s", path);
dvander@2573
   147
			}
dvander@2573
   148
			else
dvander@2573
   149
			{
dvander@2573
   150
				smutils->LogMessage(myself, "Created folder \"%s\" from updater", path);
dvander@2573
   151
			}
dvander@2573
   152
		}
dvander@2573
   153
		else
dvander@2573
   154
		{
dvander@2573
   155
			smutils->BuildPath(Path_SM, path, sizeof(path), "gamedata/%s", part->file);
dvander@2630
   156
			FILE *fp = fopen(path, "wb");
dvander@2573
   157
			if (fp == NULL)
dvander@2573
   158
			{
dvander@2573
   159
				AddUpdateError("Could not open %s for writing", path);
dvander@2679
   160
				goto skip_create;
dvander@2573
   161
			}
dvander@2633
   162
			if (fwrite(part->data, 1, part->length, fp) != part->length)
dvander@2633
   163
			{
dvander@2633
   164
				AddUpdateError("Could not write file %s", path);
dvander@2633
   165
			}
dvander@2633
   166
			else
dvander@2633
   167
			{
dvander@2633
   168
				smutils->LogMessage(myself,
dvander@2633
   169
					"Successfully updated gamedata file \"%s\"",
dvander@2633
   170
					part->file);
dvander@2633
   171
				new_files = true;
dvander@2633
   172
			}
dvander@2573
   173
			fclose(fp);
dvander@2573
   174
		}
dvander@2576
   175
skip_create:
dvander@2573
   176
		temp = part->next;
dvander@2573
   177
		free(part->data);
dvander@2573
   178
		free(part->file);
dvander@2573
   179
		delete part;
dvander@2573
   180
		part = temp;
dvander@2573
   181
	}
dvander@2573
   182
dvander@2562
   183
	if (update_errors.size())
dvander@2562
   184
	{
dvander@2562
   185
		smutils->LogError(myself, "--- BEGIN ERRORS FROM AUTOMATIC UPDATER ---");
dvander@2562
   186
dvander@2562
   187
		for (iter = update_errors.begin();
dvander@2562
   188
			 iter != update_errors.end();
dvander@2562
   189
			 iter++)
dvander@2562
   190
		{
dvander@2562
   191
			str = (*iter);
dvander@2562
   192
			smutils->LogError(myself, "%s", str->c_str());
dvander@2562
   193
		}
dvander@2562
   194
dvander@2562
   195
		smutils->LogError(myself, "--- END ERRORS FROM AUTOMATIC UPDATER ---");
dvander@2562
   196
	}
dvander@2628
   197
dvander@2628
   198
	if (new_files)
dvander@2628
   199
	{
dvander@2628
   200
		const char *force_restart = smutils->GetCoreConfigValue("ForceRestartAfterUpdate");
dvander@2628
   201
		if (force_restart == NULL || strcasecmp(force_restart, "yes") != 0)
dvander@2628
   202
		{
dvander@2628
   203
			smutils->LogMessage(myself,
dvander@2628
   204
				"SourceMod has been updated, please reload it or restart your server.");
dvander@2628
   205
		}
dvander@2628
   206
		else
dvander@2628
   207
		{
dvander@2628
   208
			char buffer[255];
dvander@2628
   209
			smutils->Format(buffer,
dvander@2628
   210
				sizeof(buffer),
dvander@2628
   211
				"meta unload %d\n",
dvander@2628
   212
				smutils->GetPluginId());
dvander@2628
   213
			gamehelpers->ServerCommand(buffer);
dvander@2628
   214
			smutils->Format(buffer,
dvander@2628
   215
				sizeof(buffer),
dvander@2628
   216
				"changelevel \"%s\"\n",
dvander@2628
   217
				gamehelpers->GetCurrentMap());
dvander@2628
   218
			gamehelpers->ServerCommand(buffer);
dvander@2628
   219
			gamehelpers->ServerCommand("echo SourceMod has been restarted from an automatic update.\n");
dvander@2628
   220
		}
dvander@2628
   221
	}
dvander@2562
   222
}
dvander@2562
   223
dvander@2562
   224
void SmUpdater::RunThread(IThreadHandle *pHandle)
dvander@2562
   225
{
dvander@2562
   226
	UpdateReader ur;
dvander@2562
   227
dvander@2575
   228
	ur.PerformUpdate(update_url.c_str());
dvander@2562
   229
dvander@2573
   230
	smutils->AddFrameAction(PumpUpdate, ur.DetachParts());
dvander@2562
   231
}
dvander@2562
   232
dvander@2562
   233
void SmUpdater::OnTerminate(IThreadHandle *pHandle, bool cancel)
dvander@2562
   234
{
dvander@2562
   235
}
dvander@2562
   236
dvander@2562
   237
void AddUpdateError(const char *fmt, ...)
dvander@2562
   238
{
dvander@2562
   239
	va_list ap;
dvander@2562
   240
	char buffer[2048];
dvander@2562
   241
dvander@2562
   242
	va_start(ap, fmt);
dvander@2562
   243
	smutils->FormatArgs(buffer, sizeof(buffer), fmt, ap);
dvander@2562
   244
	va_end(ap);
dvander@2562
   245
dvander@2562
   246
	update_errors.push_back(new String(buffer));
dvander@2562
   247
}