uhub/src/user.c

/*
 * uhub - A tiny ADC p2p connection hub
 * Copyright (C) 2007-2009, Jan Vidar Krey
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#include "uhub.h"

struct user* user_create(struct hub_info* hub, int sd)
{
	struct user* user = NULL;
	
	hub_log(log_trace, "user_create(), hub=%p, sd=%d", hub, sd);

	user = (struct user*) hub_malloc_zero(sizeof(struct user));

	if (user == NULL)
		return NULL; /* OOM */

	user->ev_write = hub_malloc_zero(sizeof(struct event));
	user->ev_read  = hub_malloc_zero(sizeof(struct event));

	if (!user->ev_write || !user->ev_read)
	{
	    hub_free(user->ev_read);
	    hub_free(user->ev_write);
	    hub_free(user);
	    return NULL;
	}
	
	user->sd = sd;
	user->tm_connected = time(NULL);
	user->hub = hub;
	user->feature_cast = 0;
	
	user->send_queue = list_create();
	user->send_queue_offset = 0;
	user->send_queue_size = 0;
	user->recv_buf_offset = 0;
	user->recv_buf = 0;
	
	user_set_state(user, state_protocol);
	return user;
}

static void clear_send_queue_callback(void* ptr)
{
	adc_msg_free((struct adc_message*) ptr);
}

void user_destroy(struct user* user)
{
	hub_log(log_trace, "user_destroy(), user=%p", user);

	if (user->ev_write)
	{
		event_del(user->ev_write);
		hub_free(user->ev_write);
		user->ev_write = 0;
	}
	
	if (user->ev_read)
	{
		event_del(user->ev_read);
		hub_free(user->ev_read);
		user->ev_read = 0;
	}
	
	net_close(user->sd);
	
	adc_msg_free(user->info);
	user_clear_feature_cast_support(user);
	
	if (user->recv_buf)
	{
		hub_free(user->recv_buf);
	}
	
	if (user->send_queue)
	{
		list_clear(user->send_queue, &clear_send_queue_callback);
		list_destroy(user->send_queue);
	}
	
	hub_free(user);
}

void user_set_state(struct user* user, enum user_state state)
{
	if ((user->state == state_cleanup && state != state_disconnected) || (user->state == state_disconnected))
	{
		puts("PANIC - Ignoring new state");
		return;
	}
	
	user->state = state;
}

void user_set_info(struct user* user, struct adc_message* cmd)
{
	adc_msg_free(user->info);
	user->info = adc_msg_incref(cmd);
}

void user_update_info(struct user* u, struct adc_message* cmd)
{
	char prefix[2];
	char* argument;
	size_t n = 0;
	struct adc_message* cmd_new = adc_msg_copy(u->info);
	if (!cmd_new)
	{
		/* FIXME: OOM! */
		return;
	}
	
	/*
	 * FIXME: Optimization potential:
	 *
	 * remove parts of cmd that do not really change anything in cmd_new.
	 * this can save bandwidth if clients send multiple updates for information
	 * that does not really change anything.
	 */
	argument = adc_msg_get_argument(cmd, n++);
	while (argument)
	{
		if (strlen(argument) >= 2)
		{
			prefix[0] = argument[0];
			prefix[1] = argument[1];
			adc_msg_replace_named_argument(cmd_new, prefix, argument+2);
		}
		
		hub_free(argument);
		argument = adc_msg_get_argument(cmd, n++);
	}
	user_set_info(u, cmd_new);
	adc_msg_free(cmd_new);
}


static int convert_support_fourcc(int fourcc)
{
	switch (fourcc)
	{
		case FOURCC('B','A','S','0'): /* Obsolete */
#ifndef OLD_ADC_SUPPORT
			return 0;
#endif
		case FOURCC('B','A','S','E'):
			return feature_base;
			
		case FOURCC('A','U','T','0'):
			return  feature_auto;
		
		case FOURCC('U','C','M','0'):
		case FOURCC('U','C','M','D'):
			return feature_ucmd;
			
		case FOURCC('Z','L','I','F'):
			return feature_zlif;
			
		case FOURCC('B','B','S','0'):
			return feature_bbs;
			
		case FOURCC('T','I','G','R'):
			return feature_tiger;
			
		case FOURCC('B','L','O','M'):
		case FOURCC('B','L','O','0'):
			return feature_bloom;
		
		case FOURCC('P','I','N','G'):
			return feature_ping;
		
		case FOURCC('L','I','N','K'):
			return feature_link;
		
		default:
			hub_log(log_debug, "Unknown extension: %x", fourcc);
			return 0;
	}
}

void user_support_add(struct user* user, int fourcc)
{
	int feature_mask = convert_support_fourcc(fourcc);
	user->flags |= feature_mask;
}

int user_flag_get(struct user* user, enum user_flags flag)
{
    return user->flags & flag;
}

void user_flag_set(struct user* user, enum user_flags flag)
{
    user->flags |= flag;
}

void user_flag_unset(struct user* user, enum user_flags flag)
{
    user->flags &= ~flag;
}

void user_set_nat_override(struct user* user)
{
	user_flag_set(user, flag_nat);
}

int user_is_nat_override(struct user* user)
{
	return user_flag_get(user, flag_nat);
}

void user_support_remove(struct user* user, int fourcc)
{
	int feature_mask = convert_support_fourcc(fourcc);
	user->flags &= ~feature_mask;
}

void user_schedule_destroy(struct user* user)
{
	struct event_data post;
	memset(&post, 0, sizeof(post));
	post.id     = UHUB_EVENT_USER_DESTROY;
	post.ptr    = user;
	event_queue_post(user->hub->queue, &post);
}

void user_disconnect(struct user* user, int reason)
{
	struct event_data post;
	int need_notify = 0;
	
	if (user_is_disconnecting(user))
	{
		return;
	}
	
	/* dont read more data from this user */
	if (user->ev_read)
	{
		event_del(user->ev_read);
		hub_free(user->ev_read);
		user->ev_read = 0;
	}
	
	hub_log(log_trace, "user_disconnect(), user=%p, reason=%d, state=%d", user, reason, user->state);
	
	need_notify = user_is_logged_in(user);
	user->quit_reason = reason;
	user_set_state(user, state_cleanup);
	
	if (need_notify)
	{
		memset(&post, 0, sizeof(post));
		post.id     = UHUB_EVENT_USER_QUIT;
		post.ptr    = user;
		event_queue_post(user->hub->queue, &post);
	}
	else
	{
		user->quit_reason = quit_unknown;
		user_schedule_destroy(user);
	}


}

int user_have_feature_cast_support(struct user* user, char feature[4])
{
	char* tmp = list_get_first(user->feature_cast);
	while (tmp)
	{
		if (strncmp(tmp, feature, 4) == 0)
			return 1;
	
		tmp = list_get_next(user->feature_cast);
	}
	
	return 0;
}

int user_set_feature_cast_support(struct user* u, char feature[4])
{
	if (!u->feature_cast)
	{
		u->feature_cast = list_create();
	}

	if (!u->feature_cast)
	{
		return 0; /* OOM! */
	}

	list_append(u->feature_cast, hub_strndup(feature, 4));
	return 1;
}

void user_clear_feature_cast_support(struct user* u)
{
	if (u->feature_cast)
	{
		list_clear(u->feature_cast, &hub_free);
		list_destroy(u->feature_cast);
		u->feature_cast = 0;
	}
}

int user_is_logged_in(struct user* user)
{
	if (user->state == state_normal)
		return 1;
	return 0;
}

int user_is_connecting(struct user* user)
{
	if (user->state == state_protocol || user->state == state_identify || user->state == state_verify)
		return 1;
	return 0;
}

int user_is_disconnecting(struct user* user)
{
	if (user->state == state_cleanup || user->state == state_disconnected)
		return 1;
	return 0;
}