lib/eggdrop/botnet.c File Reference

---

Detailed Description

Contains all botnet related stuff.

This file contains all functions dealing with other bots on the botnet.

Todo:

A lot ... And then to write a module that actually uses this -_-

Definition in file botnet.c.

#include <eggdrop/eggdrop.h>

Go to the source code of this file.

Data Structures
struct	botnet_search_prio_t
Defines
#define	BAD_BOTNAME_CHARS   " *?@:"
	A string of characters that aren't allowed in a botname.
Functions
static int	botnet_cleanup (void *client_data)
	Deletes all bots marked as deleted.
static void	botnet_really_delete (botnet_bot_t *bot)
	Completely delete a bot.
static int	botnet_clear_all ()
	Deletes all bots.
int	botnet_init ()
	Inits the whole botnet stuff.
int	botnet_shutdown (void)
	Shuts the whole botnet stuff down.
int	botnet_set_name (const char *name)
	Set the botname of this bot.
const char *	botnet_get_name ()
	Returns the bots name on the botnet.
const botnet_bot_t *	botnet_get_head ()
	Returns the first bot in the linked list.
botnet_bot_t *	botnet_lookup (const char *name)
	Find a bot by its name.
botnet_bot_t *	botnet_new (const char *name, user_t *user, botnet_bot_t *uplink, botnet_bot_t *direction, xml_node_t *info, botnet_handler_t *handler, void *client_data, event_owner_t *owner, int netburst)
	Adds a bot to the botnet.
int	botnet_unlink (botnet_entity_t *from, botnet_bot_t *bot, const char *reason)
	To request unlinking a bot.
static void	botnet_recursive_delete (botnet_bot_t *bot, botnet_bot_t *root, const char *reason)
	Deletes a subtree of the botnet.
void	botnet_count_subtree (botnet_bot_t *bot, int *bots, int *members)
	Count the number of bots and partymembers in a subtree.
int	botnet_delete (botnet_bot_t *bot, const char *reason)
	Deletes a bot.
int	botnet_delete_by_owner (struct egg_module *module, void *script)
	Deletes all bots with a given owner.
static void	botnet_recursive_replay_net (botnet_bot_t *dst, botnet_bot_t *start)
	For internal use by botnet_replay_net().
void	botnet_replay_net (botnet_bot_t *dst)
	Sends a replay of the current botnet to a bot.
void	botnet_link_failed (user_t *user, const char *reason)
	Does some cleanup in case a connection attempt to a bot failed.
void	botnet_link_success (botnet_bot_t *bot)
	Does some cleanup after the connection has been fully established.
static int	botnet_find_min (const void *uid, void *userptr, void *param)
	callback function for the user walker.
static int	botnet_link_prio (const void *uid, void *userptr, void *param)
	callback function for the user walker.
void	botnet_autolink ()
	Try to link one or more bots based on their priority setting.
int	botnet_check_direction (botnet_bot_t *direction, botnet_bot_t *src)
int	botnet_link (botnet_entity_t *src, botnet_bot_t *dst, const char *target)
const char *	botnet_get_info (botnet_bot_t *bot, const char *name)
void	botnet_set_info (botnet_bot_t *bot, const char *name, const char *value)
void	botnet_set_info_int (botnet_bot_t *bot, const char *name, int value)
void	botnet_member_join (partychan_t *chan, partymember_t *p, int linking)
	Sends a partyline channel join out to the botnet.
void	botnet_announce_login (partymember_t *p)
	Sends a partyline join out to the botnet.
void	botnet_member_part (partychan_t *chan, partymember_t *p, const char *reason, int len)
void	botnet_chanmsg (partychan_t *chan, botnet_entity_t *src, const char *text, int len)
void	botnet_broadcast (botnet_entity_t *src, const char *text, int len)
void	botnet_set_nick (partymember_t *p, const char *oldnick)
void	botnet_member_quit (partymember_t *p, const char *reason, int len)
void	botnet_botmsg (botnet_bot_t *src, botnet_bot_t *dst, const char *command, const char *text, int len)
void	botnet_botbroadcast (botnet_bot_t *src, const char *command, const char *text, int len)
void	botnet_extension (int mode, botnet_entity_t *src, botnet_bot_t *dst, egg_module_t *mod, const char *cmd, const char *text, int len)
Variables
static const char	rcsid [] = "$Id: botnet.c,v 1.13 2007-09-13 22:20:55 sven Exp $"
static char *	botname
static char *	default_botname = "eggdrop"
static hash_table_t *	bot_ht = NULL
static botnet_bot_t *	bot_head
static botnet_bot_t *	localbot_head
static int	nbots = 0
static int	linking_bots = 0
	Number of bots that are currently in the process of being linked.
static bind_table_t *	BT_request_link
static bind_table_t *	BT_link
static bind_table_t *	BT_disc
static bind_table_t *	BT_bot
static bind_table_t *	BT_extension

---

Define Documentation

#define BAD_BOTNAME_CHARS   " *?@:"

A string of characters that aren't allowed in a botname.

Definition at line 36 of file botnet.c.

Referenced by botnet_new().

---

Function Documentation

void botnet_announce_login

(

partymember_t *

p

)

Sends a partyline join out to the botnet.

This function simply calls the on_login callback for all directly linked bots except the one the event came from. It should only be called by exactly one function.

Parameters:

p

The user that has joined the partyline.

Warning:

If this function is referenced by any other function except partychan_new() it is a bug.

Definition at line 870 of file botnet.c.

References partymember::bot, BOT_DELETED, botnet_bot::client_data, botnet_bot::direction, botnet_bot::flags, botnet_bot::handler, botnet_bot::next_local, and botnet_handler_t::on_login.

Referenced by partymember_new().

{
  botnet_bot_t *tmp;

  for (tmp = localbot_head; tmp; tmp = tmp->next_local) {
    if (tmp->flags & BOT_DELETED || (p->bot && tmp == p->bot->direction)) continue;
    if (tmp->handler && tmp->handler->on_login) tmp->handler->on_login(tmp->client_data, p);
  }
}

void botnet_autolink

(

void

)

Try to link one or more bots based on their priority setting.

This function should be called regulary by the core. If there are no bots in the process of being linked at the moment this function will try to link to some of the bots that are currently not connected to the botnet.

To determine which bots should be linked in which order the user setting bot.link-priority is used. If it exists and has a positive integer value the bot is considered for linking.

The first time this function is called it will search all user records for the one with the lowest positive link-priority. All bots with this exact priority will be linked simultaniously. Once the last of this connection attempts has succeded or failed this function will be called again and try to link to the bot with the lowest priority that is higher than the privious one. This will continue until no bot to link to is found. In that case the priority threahold is reset to 1. When this function is called by the core the next time the whole process will start again.

Definition at line 727 of file botnet.c.

References botnet_find_min(), botnet_link_prio(), linking_bots, botnet_search_prio_t::min_prio, and user_walk().

Referenced by botnet_link_failed(), botnet_link_success(), core_secondly(), and main().

{
  static int priority = 0;
  botnet_search_prio_t data = {priority, INT_MAX};

  if (linking_bots) return;
  user_walk(botnet_find_min, &data);
  
  if (data.min_prio == INT_MAX) {
    priority = 0;
    return;
  }

  priority = data.min_prio;

  user_walk(botnet_link_prio, &priority);
}

void botnet_botbroadcast	(	botnet_bot_t *	src,
		const char *	command,
		const char *	text,
		int	len
	)

Definition at line 948 of file botnet.c.

References bind_check(), BOT_DELETED, botnet_bot::client_data, botnet_bot::direction, botnet_bot::flags, botnet_bot::handler, botnet_bot::next_local, NULL, and botnet_handler_t::on_botbroadcast.

Referenced by got_bbroadcast(), and got_botbroadcast().

{
  botnet_bot_t *tmp;

  if (!text) len = 0;
  else if (len < 0) len = strlen(text);

  bind_check(BT_bot, NULL, command, src, command, text);

  for (tmp = localbot_head; tmp; tmp = tmp->next_local) {
    if (tmp->flags & BOT_DELETED || (src && tmp == src->direction)) continue;
    if (tmp->handler && tmp->handler->on_botbroadcast) tmp->handler->on_botbroadcast(tmp->client_data, src, command, text, len);
  }
}

void botnet_botmsg	(	botnet_bot_t *	src,
		botnet_bot_t *	dst,
		const char *	command,
		const char *	text,
		int	len
	)

Definition at line 935 of file botnet.c.

References bind_check(), botnet_bot::client_data, botnet_bot::direction, botnet_bot::handler, NULL, and botnet_handler_t::on_botmsg.

Referenced by got_botmsg().

{
  if (!text) len = 0;
  else if (len < 0) len = strlen(text);

  if (dst) {
    botnet_bot_t *dir = dst->direction;
    if (dir->handler && dir->handler->on_botmsg) dir->handler->on_botmsg(dir->client_data, src, dst, command, text, len);
    return;
  }
  bind_check(BT_bot, NULL, command, src, command, text);
}

void botnet_broadcast	(	botnet_entity_t *	src,
		const char *	text,
		int	len
	)

Definition at line 903 of file botnet.c.

References botnet_entity::bot, BOT_DELETED, botnet_bot::client_data, botnet_bot::direction, botnet_bot::flags, botnet_bot::handler, botnet_bot::next_local, botnet_handler_t::on_bcast, and partymember_local_broadcast().

Referenced by got_bcast(), and got_broadcast().

{
  botnet_bot_t *tmp;

  if (len < 0) len = strlen(text);
  for (tmp = localbot_head; tmp; tmp = tmp->next_local) {
    if (tmp->flags & BOT_DELETED || (src && src->bot && tmp == src->bot->direction)) continue;
    if (tmp->handler && tmp->handler->on_bcast) tmp->handler->on_bcast(tmp->client_data, src, text, len);
  }
  partymember_local_broadcast(src, text, len);
}

void botnet_chanmsg	(	partychan_t *	chan,
		botnet_entity_t *	src,
		const char *	text,
		int	len
	)

Definition at line 890 of file botnet.c.

References botnet_entity::bot, partymember::bot, BOT_DELETED, botnet_bot::client_data, botnet_bot::direction, ENTITY_PARTYMEMBER, botnet_bot::flags, botnet_bot::handler, botnet_bot::next_local, botnet_handler_t::on_chanmsg, botnet_entity::user, and botnet_entity::what.

Referenced by chan_msg().

{
  botnet_bot_t *tmp, *srcbot;

  if (src->what == ENTITY_PARTYMEMBER) srcbot = src->user->bot;
  else srcbot = src->bot;

  for (tmp = localbot_head; tmp; tmp = tmp->next_local) {
    if (tmp->flags & BOT_DELETED || (srcbot && tmp == srcbot->direction)) continue;
    if (tmp->handler && tmp->handler->on_chanmsg) tmp->handler->on_chanmsg(tmp->client_data, chan, src, text, len);
  }
}

int botnet_check_direction	(	botnet_bot_t *	direction,
		botnet_bot_t *	src
	)

Definition at line 745 of file botnet.c.

References _, botnet_bot::direction, LOG_MISC, botnet_bot::name, and putlog().

Referenced by get_entity(), got_actchan(), got_away(), got_bcast(), got_botbroadcast(), got_botmsg(), got_chat(), got_join(), got_link(), got_motd(), got_nickchange(), got_nlinked(), got_part(), got_unlinked(), got_versions(), got_who(), and idx_on_read().

{
  if (!src || src->direction != direction) {
    putlog(LOG_MISC, "*", _("Fake message from %s rejected! (direction != %s)."), direction->name, src ? src->name : _("non-existent bot"));
    return 1;
  }
  return 0;
}

static int botnet_cleanup

(

void *

client_data

)

[static]

Deletes all bots marked as deleted.

Parameters:

client_data

Ignored.

Returns:

Always 0.

Todo:

Return something useful or change it to void.

Definition at line 764 of file botnet.c.

References botnet_really_delete(), botnet_bot::flags, botnet_bot::next, and PARTY_DELETED.

Referenced by botnet_delete().

{
  botnet_bot_t *bot, *next;

  for (bot = bot_head; bot; bot = next) {
    next = bot->next;
    if (bot->flags & PARTY_DELETED) botnet_really_delete(bot);
  }
  return 0;
}

static int botnet_clear_all

(

)

[static]

Deletes all bots.

Deletes all bots without calling any binds or callbacks (except for on_delete).

Returns:

The number of killed bots.

Warning:

Should probably never be called except during shutdowns and should never ever return a non-zero value.

Todo:

Implement this!

Definition at line 343 of file botnet.c.

Referenced by botnet_shutdown().

{
  int ret = 0;
  return ret;
}

void botnet_count_subtree	(	botnet_bot_t *	bot,
		int *	bots,
		int *	members
	)

Count the number of bots and partymembers in a subtree.

Counts bots and partymembers on and behind a certain bot in the current botnet.

Parameters:

	bot	The bot to start from. Must not be NULL.
	bots	A pointer to the variable to contain the number of bots. May be NULL.
	members	A pointer to the variable to contain the number of partymembers. May be NULL.

Warning:

This function never initializes the parameters bots and members! Do it yourself before every call unless you want to add up more subtrees!

Definition at line 471 of file botnet.c.

References BOT_DELETED, botnet_count_subtree(), botnet_bot::flags, botnet_bot::next, partymember_count_by_bot(), and botnet_bot::uplink.

Referenced by botnet_count_subtree(), and botnet_delete().

{
  int m;
  botnet_bot_t *tmp;

  for (tmp = bot_head; tmp; tmp = tmp->next) {
    if (tmp->flags & BOT_DELETED) continue;
    if (tmp->uplink == bot) botnet_count_subtree(tmp, bots, members);
  }

  m = partymember_count_by_bot(bot);
  if (bots) ++*bots;
  if (members) *members += m;
}

int botnet_delete	(	botnet_bot_t *	bot,
		const char *	reason
	)

Deletes a bot.

Marks a bot as deleted, clears out anything linked via this bot, triggers the binds, logs it and sends it out to the botnet.

Parameters:

	bot	The bot to delete.
	reason	Some text explaining the Hows and Whys of the unlink.

Returns:

0 on success, -1 on failure.

Definition at line 498 of file botnet.c.

References BOT_DELETED, botnet_cleanup(), botnet_count_subtree(), botnet_link_failed(), botnet_recursive_delete(), botnet_bot::client_data, botnet_bot::direction, user::flags, botnet_bot::flags, garbage_add(), GARBAGE_ONCE, botnet_bot::handler, LOG_MISC, botnet_bot::name, botnet_bot::next_local, NULL, botnet_handler_t::on_lost_bot, putlog(), botnet_bot::uplink, botnet_bot::user, and USER_LINKING_BOT.

Referenced by botnet_delete_by_owner(), botnet_unlink(), do_ping(), got_bquit(), got_bye(), got_newbot(), got_nlinked(), got_thisbot(), got_unlinked(), idx_on_delete(), idx_on_eof(), idx_on_read(), oldbotnet_on_delete(), oldbotnet_on_eof(), and oldbotnet_on_read().

{
  char obuf[512];
  const botnet_bot_t *tmp;

  if (bot->flags & BOT_DELETED) return -1;

  if (!bot->uplink) {
    int bots = 0, users = 0;
    botnet_count_subtree(bot, &bots, &users);
    snprintf(obuf, sizeof(obuf), "Unlinked from: %s (%s) (lost %d bots and %d users)", bot->name, reason, bots, users);
    reason = obuf;
  }

  for (tmp = localbot_head; tmp; tmp = tmp->next_local) {
    if (tmp->flags & BOT_DELETED || tmp == bot->direction) continue;
    if (tmp->handler && tmp->handler->on_lost_bot) tmp->handler->on_lost_bot(tmp->client_data, bot, reason);
  }

  botnet_recursive_delete(bot, bot, reason);

  if (!bot->uplink) putlog(LOG_MISC, "*", "%s", reason);
  else putlog(LOG_MISC, "*", "(%s) %s", bot->uplink->name, reason);

  if (bot->user && bot->user->flags & USER_LINKING_BOT) botnet_link_failed(bot->user, reason);

  garbage_add(botnet_cleanup, NULL, GARBAGE_ONCE);

  return 0;
}

int botnet_delete_by_owner	(	struct egg_module *	module,
		void *	script
	)

Deletes all bots with a given owner.

Calls botnet_delete() for every bot with a given owner. In the first search only the list of local bots is searched. After that the whole list is searched but it'd be a really wyrd botnet if a match was found there.

Parameters:

	module	The module whose bots should be deleted.
	script	The script whose bots should be deleted. NULL matches everything.

Returns:

The number of deleted bots. (Not counting recursive deletes.)

Definition at line 542 of file botnet.c.

References _, BOT_DELETED, botnet_delete(), event_owner_b::client_data, botnet_bot::flags, event_owner_b::module, botnet_bot::next_local, and botnet_bot::owner.

Referenced by script_remove_events_by_owner().

{
  int ret = 0;
  botnet_bot_t *tmp;

  for (tmp = localbot_head; tmp; tmp = tmp->next_local) {
    if (tmp->flags & BOT_DELETED) continue;
    if (tmp->owner && tmp->owner->module == module && (!script || tmp->owner->client_data == script)) {
      ++ret;
      botnet_delete(tmp, _("Module unloaded"));
    }
  }

  for (tmp = bot_head; tmp; tmp = tmp->next_local) {
    if (tmp->flags & BOT_DELETED) continue;
    if (tmp->owner && tmp->owner->module == module && (!script || tmp->owner->client_data == script)) {
      ++ret;
      botnet_delete(tmp, _("Module unloaded"));
    }
  }

  return ret;
}

void botnet_extension	(	int	mode,
		botnet_entity_t *	src,
		botnet_bot_t *	dst,
		egg_module_t *	mod,
		const char *	cmd,
		const char *	text,
		int	len
	)

Definition at line 963 of file botnet.c.

References bind_check(), partymember::bot, botnet_entity::bot, BOT_DELETED, botnet_bot::client_data, botnet_bot::direction, ENTITY_BOT, EXTENSION_ALL, EXTENSION_ONE, botnet_bot::flags, botnet_bot::handler, event_owner_b::module, botnet_bot::next_local, NULL, botnet_handler_t::on_extension, botnet_bot::owner, botnet_entity::user, and botnet_entity::what.

Referenced by got_away(), got_extension(), got_motd(), got_privmsg(), got_versions(), and got_who().

{
  botnet_bot_t *tmp, *srcbot = src->what == ENTITY_BOT ? src->bot : src->user->bot;

  if (!text) len = 0;
  else if (len < 0) len = strlen(text);

  if (!dst) bind_check(BT_extension, NULL, cmd, src, cmd, text);
  if (mode == EXTENSION_ONE) {
    if (dst && dst->direction->handler && dst->direction->handler->on_extension)
      dst->direction->handler->on_extension(dst->direction->client_data, src, dst, cmd, text, len);
    return;
  }

  for (tmp = localbot_head; tmp; tmp = tmp->next_local) {
    if (tmp->flags & BOT_DELETED || (srcbot && tmp == srcbot->direction)) continue;
    if (mod && !(tmp->owner && tmp->owner->module == mod)) continue;
    if (tmp->handler && tmp->handler->on_extension)
      tmp->handler->on_extension(tmp->client_data, src, mode == EXTENSION_ALL ? NULL : tmp, cmd, text, len);
  }
}

static int botnet_find_min	(	const void *	uid,
		void *	userptr,
		void *	param
	)			[static]

callback function for the user walker.

This function is a helper function for botnet_autolink(). It is called by user_walk() for every user in the bots database. It searches for the user with the lowest link priority.

Parameters:

	uid	A pointer to the uid of the user. Ignored.
	userptr	A a pointer to the pointer to the user.
	param	A botnet_search_prio_t struct.

Returns:

Always 0 and never checked.

Definition at line 657 of file botnet.c.

References _, botnet_lookup(), user::flags, user::handle, linking_bots, LOG_MISC, botnet_search_prio_t::min_prio, NULL, botnet_search_prio_t::priority, putlog(), USER_BOT, user_get_setting(), USER_LINKED_BOT, and USER_LINKING_BOT.

Referenced by botnet_autolink().

{
  int p;
  char *prio;
  user_t *u = *(user_t **) userptr;
  botnet_search_prio_t *data = param;

  if (!(u->flags & USER_BOT) || u->flags & USER_LINKED_BOT) return 0;
  if (u->flags & USER_LINKING_BOT) {
    putlog(LOG_MISC, "*", _("Warning: botnet_autolink() was called while still connecting to %s."), u->handle);
    if (linking_bots < 1) linking_bots = 1;
    return 0;
  }
  if (botnet_lookup(u->handle) || user_get_setting(u, NULL, "bot.link-priority", &prio)) return 0;

  p = atoi(prio);
  if (p > data->priority && p < data->min_prio) data->min_prio = p;

  return 0;
}

const botnet_bot_t* botnet_get_head

(

void

)

Returns the first bot in the linked list.

Returns:

The first bot on the botnet.

Todo:

There has to be a better way to do whatever needs to be done than messing with this list.

Definition at line 230 of file botnet.c.

Referenced by party_bots().

{
  return bot_head;
}

const char* botnet_get_info	(	botnet_bot_t *	bot,
		const char *	name
	)

Definition at line 814 of file botnet.c.

References botnet_bot::info, and xml_node_get_str().

Referenced by on_new_bot().

{
  char *ret;

  xml_node_get_str(&ret, bot->info, name, 0, (void *) 0);
  return ret;
}

const char* botnet_get_name

(

void

)

Returns the bots name on the botnet.

Returns:

This bot's name.

Definition at line 216 of file botnet.c.

References botname.

Referenced by do_link(), get_entity(), got_botmsg(), got_link(), got_motd(), got_privmsg(), got_versions(), got_who(), idx_on_connect(), on_bcast(), on_botbroadcast(), on_botmsg(), on_chanmsg(), on_extension(), on_join(), on_new_bot(), on_nick(), on_part(), on_privmsg(), on_quit(), party_bots(), party_link(), partymember_lookup(), partymember_new(), recving_login(), and sending_login().

{
  return botname;
}

int botnet_init

(

void

)

Inits the whole botnet stuff.

Returns:

Always 0

Definition at line 137 of file botnet.c.

References BIND_BREAKABLE, BIND_STACKABLE, bind_table_add(), botname, BTN_BOTNET_BOT, BTN_BOTNET_DISC, BTN_BOTNET_EXTENSION, BTN_BOTNET_LINK, BTN_BOTNET_REQUEST_LINK, default_botname, hash_table_create(), HASH_TABLE_STRINGS, nbots, and NULL.

Referenced by eggdrop_init().

{
  nbots = 0;
  bot_head = NULL;
  localbot_head = NULL;

  botname = default_botname;
  bot_ht = hash_table_create(NULL, NULL, 13, HASH_TABLE_STRINGS);

  BT_request_link = bind_table_add(BTN_BOTNET_REQUEST_LINK, 2, "Us", 0, BIND_BREAKABLE);
  BT_link = bind_table_add(BTN_BOTNET_LINK, 1, "B", 0, BIND_STACKABLE);
  BT_disc = bind_table_add(BTN_BOTNET_DISC, 3, "BBs", 0, BIND_STACKABLE);
  BT_bot = bind_table_add(BTN_BOTNET_BOT, 3, "Bss", 0, 0);
  BT_extension = bind_table_add(BTN_BOTNET_EXTENSION, 3, "Ess", 0, 0);
  return 0;
}

int botnet_link	(	botnet_entity_t *	src,
		botnet_bot_t *	dst,
		const char *	target
	)

Definition at line 775 of file botnet.c.

References _, bind_check(), bot_entity, botnet_lookup(), botnet_bot::client_data, botnet_bot::direction, ENTITY_PARTYMEMBER, user::flags, user::handle, botnet_bot::handler, linking_bots, NULL, botnet_handler_t::on_link, partymember_msg(), botnet_entity::user, USER_BOT, user_get_setting(), USER_LINKING_BOT, user_lookup_by_handle(), and botnet_entity::what.

Referenced by botnet_link_prio(), got_link(), got_unlink(), and party_link().

{
  char *type, *priority;
  user_t *user;
  botnet_entity_t entity_me = bot_entity((botnet_bot_t *) 0);

  if (dst) {
    if (dst->direction->handler && dst->direction->handler->on_link)
      dst->direction->handler->on_link(dst->direction->client_data, src, dst, target);
    return 0;
  }

  user = user_lookup_by_handle(target);
  if (!user || !(user->flags & USER_BOT)) {
    if (src->what == ENTITY_PARTYMEMBER) partymember_msg(src->user, &entity_me, _("Can't link there: No such bot."), -1);
    return -1;
  }
  if (user->flags & USER_LINKING_BOT || botnet_lookup(user->handle)) {
    if (src->what == ENTITY_PARTYMEMBER) partymember_msg(src->user, &entity_me, _("Can't link there: Already linked."), -1);
    return -2;
  }
  if (user_get_setting(user, NULL, "bot.type", &type)) type = "eggdrop";
  if (!user_get_setting(user, NULL, "bot.link-priority", &priority) && atoi(priority) < 0) {
    if (src->what == ENTITY_PARTYMEMBER) partymember_msg(src->user, &entity_me, _("Won't link there: Negative link priority."), -1);
    return -3;
  }

  user->flags |= USER_LINKING_BOT;
  ++linking_bots;
  if (!bind_check(BT_request_link, NULL, type, user, type)) {
    user->flags &= ~USER_LINKING_BOT;
    --linking_bots;
    if (src->what == ENTITY_PARTYMEMBER) partymember_msg(src->user, &entity_me, _("Can't link there: Module not loaded."), -1);
    return -4;
  }

  return 0;
}

void botnet_link_failed	(	user_t *	user,
		const char *	reason
	)

Does some cleanup in case a connection attempt to a bot failed.

This function clears the USER_LINKING_BOT flag, logs some kind of message and runs the botnet_autolink() function.

Parameters:

	user	The user record of the bot that should have been linked.
	reason	Some kind of reason why it didn't work.

Definition at line 619 of file botnet.c.

References _, botnet_autolink(), user::flags, user::handle, linking_bots, LOG_MISC, putlog(), and USER_LINKING_BOT.

Referenced by botnet_delete(), got_version(), idx_on_delete(), idx_on_eof(), oldbotnet_on_delete(), oldbotnet_on_eof(), and oldbotnet_on_read().

{
  putlog(LOG_MISC, "*", _("Failed to link to %s (%s)."), user->handle, reason);
  --linking_bots;
  user->flags &= ~USER_LINKING_BOT;
  if (!linking_bots) botnet_autolink();
}

static int botnet_link_prio	(	const void *	uid,
		void *	userptr,
		void *	param
	)			[static]

callback function for the user walker.

This function is a helper function for botnet_autolink(). It is called by user_walk() for every user in the bots database. It links tries to link to every user with a given priority.

Parameters:

	uid	A pointer to the uid of the user. Ignored.
	userptr	A a pointer to the pointer to the user.
	param	A pointer to an int containing the priority to link to.

Returns:

Always 0 and never checked.

Definition at line 691 of file botnet.c.

References bot_entity, botnet_link(), botnet_lookup(), user::flags, user::handle, NULL, USER_BOT, user_get_setting(), USER_LINKED_BOT, and USER_LINKING_BOT.

Referenced by botnet_autolink().

{
  char *prio;
  user_t *u = *(user_t **) userptr;
  int *priority = param;
  botnet_entity_t me = bot_entity((botnet_bot_t *) 0);

  if (!(u->flags & USER_BOT) || u->flags & (USER_LINKING_BOT | USER_LINKED_BOT)) return 0;
  if (botnet_lookup(u->handle) || user_get_setting(u, NULL, "bot.link-priority", &prio)) return 0;

  if (atoi(prio) == *priority) botnet_link(&me, NULL, u->handle);

  return 0;
}

void botnet_link_success

(

botnet_bot_t *

bot

)

Does some cleanup after the connection has been fully established.

This function clears the USER_LINKING_BOT flag and runs the botnet_autolink() function.

Parameters:

bot

The bot that was linked.

Definition at line 636 of file botnet.c.

References botnet_autolink(), user::flags, linking_bots, botnet_bot::user, USER_LINKED_BOT, and USER_LINKING_BOT.

Referenced by got_endlink().

{
  if (linking_bots > 0 && bot->user->flags & USER_LINKING_BOT) --linking_bots;
  bot->user->flags &= ~USER_LINKING_BOT;
  bot->user->flags |= USER_LINKED_BOT;
  if (!linking_bots) botnet_autolink();
}

botnet_bot_t* botnet_lookup

(

const char *

name

)

Find a bot by its name.

Parameters:

name

The name of the bot to find

Returns:

The bot or NULL if no such bot exists

Definition at line 243 of file botnet.c.

References BOT_DELETED, botnet_bot::flags, hash_table_find(), and NULL.

Referenced by botnet_find_min(), botnet_link(), botnet_link_prio(), botnet_new(), get_entity(), got_away(), got_bcast(), got_botbroadcast(), got_botmsg(), got_chat(), got_join(), got_link(), got_motd(), got_nickchange(), got_nlinked(), got_part(), got_privmsg(), got_unlink(), got_unlinked(), got_versions(), got_who(), party_link(), party_unlink(), partymember_lookup(), and recving_login().

{
  botnet_bot_t *bot = NULL;

  hash_table_find(bot_ht, name, &bot);
  if (bot && bot->flags & BOT_DELETED) return NULL;
  return bot;
}

void botnet_member_join	(	partychan_t *	chan,
		partymember_t *	p,
		int	linking
	)

Sends a partyline channel join out to the botnet.

This function simply calls the on_join callback for all directly linked bots except the one the event came from. It should only be called by exactly one function.

Parameters:

	chan	The partyline channel the user has joined.
	p	The user that has joined the channel.
	linking	True if the join is part of the linking process between two bots.

Warning:

If this function is referenced by any other function except partychan_join() it is a bug.

Definition at line 847 of file botnet.c.

References partymember::bot, BOT_DELETED, botnet_bot::client_data, botnet_bot::direction, botnet_bot::flags, botnet_bot::handler, botnet_bot::next_local, and botnet_handler_t::on_join.

Referenced by partychan_join().

{
  botnet_bot_t *tmp;

  for (tmp = localbot_head; tmp; tmp = tmp->next_local) {
    if (tmp->flags & BOT_DELETED || (p->bot && tmp == p->bot->direction)) continue;
    if (tmp->handler && tmp->handler->on_join) tmp->handler->on_join(tmp->client_data, chan, p, linking);
  }
}

void botnet_member_part	(	partychan_t *	chan,
		partymember_t *	p,
		const char *	reason,
		int	len
	)

Definition at line 880 of file botnet.c.

References partymember::bot, BOT_DELETED, botnet_bot::client_data, botnet_bot::direction, botnet_bot::flags, botnet_bot::handler, botnet_bot::next_local, and botnet_handler_t::on_part.

Referenced by partychan_part().

{
  botnet_bot_t *tmp;

  for (tmp = localbot_head; tmp; tmp = tmp->next_local) {
    if (tmp->flags & BOT_DELETED || (p->bot && tmp == p->bot->direction)) continue;
    if (tmp->handler && tmp->handler->on_part) tmp->handler->on_part(tmp->client_data, chan, p, reason, len);
  }
}

void botnet_member_quit	(	partymember_t *	p,
		const char *	reason,
		int	len
	)

Definition at line 925 of file botnet.c.

References partymember::bot, BOT_DELETED, botnet_bot::client_data, botnet_bot::direction, botnet_bot::flags, botnet_bot::handler, botnet_bot::next_local, and botnet_handler_t::on_quit.

Referenced by partymember_delete().

{
  botnet_bot_t *tmp;

  for (tmp = localbot_head; tmp; tmp = tmp->next_local) {
    if (tmp->flags & BOT_DELETED || (p->bot && tmp == p->bot->direction)) continue;
    if (tmp->handler && tmp->handler->on_quit) tmp->handler->on_quit(tmp->client_data, p, reason, len);
  }
}

botnet_bot_t* botnet_new	(	const char *	name,
		user_t *	user,
		botnet_bot_t *	uplink,
		botnet_bot_t *	direction,
		xml_node_t *	info,
		botnet_handler_t *	handler,
		void *	client_data,
		event_owner_t *	owner,
		int	netburst
	)

Adds a bot to the botnet.

Calling this function will add a bot to the net, inform the rest of the net about it, log it and trigger the link bind.

Parameters:

	name	The name of the bot.
	user	The user entry for this bot. NULL if it's not local.
	uplink	The uplink of this bot. NULL if it's local.
	direction	The bot we have to talk to to reach this bot. NULL for local bots, it'll be set to the bot itself.
	handler	Handler struct containing the functions to call to get stuff done. NULL if it's not local.
	client_data	Some data passed back to the callback functions.
	owner	Owner of this bot and it's callback functions.
	netburst	True if it's part of the syncing between two other linked bots, false if it's a real new link.

Returns:

A pointer to the new bot on success, NULL on error.

Todo:

Find a better way to log this. But for now LOG_MISC is good enough.

Definition at line 272 of file botnet.c.

References BAD_BOTNAME_CHARS, bind_check(), BOT_DELETED, botname, botnet_lookup(), botnet_bot::client_data, botnet_bot::direction, botnet_bot::flags, botnet_bot::handler, hash_table_insert(), botnet_bot::info, LOG_MISC, botnet_bot::name, nbots, botnet_bot::next, botnet_bot::next_local, NULL, botnet_handler_t::on_new_bot, botnet_bot::owner, botnet_bot::partys, botnet_bot::prev, botnet_bot::prev_local, putlog(), botnet_bot::uplink, botnet_bot::user, and xml_node_new().

Referenced by got_newbot(), got_nlinked(), got_version(), recving_login(), and sending_login().

{
  const char *temp;
  botnet_bot_t *bot, *tmp;

  if (!uplink && (!user || !handler)) return 0;
  if ((uplink && !direction) || (!uplink && direction)) return 0;
  if (botnet_lookup(name)) return 0;
  if (!strcmp(botname, name)) return 0;
  for (temp = name; *temp; ++temp) if (*temp < 32 || strchr(BAD_BOTNAME_CHARS, *temp)) return 0;

  bot = malloc(sizeof(*bot));
  if (!direction) direction = bot;

  bot->name = strdup(name);
  bot->flags = 0;
  bot->user = user;
  bot->uplink = uplink;
  bot->direction = direction;
  bot->partys = NULL;
  bot->handler = handler;
  bot->client_data = client_data;
  bot->owner = owner;
  bot->info = info ? info : xml_node_new();

  hash_table_insert(bot_ht, bot->name, bot);
  
  bot->prev = 0;
  bot->next = bot_head;
  if (bot_head) bot_head->prev = bot;
  bot_head = bot;

  bot->prev_local = 0;
  if (!uplink) {
    bot->next_local = localbot_head;
    if (localbot_head) localbot_head->prev_local = bot;
    localbot_head = bot;
  } else {
    bot->next_local = 0;
  }

  ++nbots;

  for (tmp = localbot_head; tmp; tmp = tmp->next_local) {
    if (tmp->flags & BOT_DELETED || tmp == bot->direction) continue;
    if (tmp->handler && tmp->handler->on_new_bot) tmp->handler->on_new_bot(tmp->client_data, bot, netburst);
  }

  bind_check(BT_link, NULL, bot->name, bot);

  if (!netburst) {
    if (!bot->uplink) putlog(LOG_MISC, "*", "Linked to %s.", bot->name);
    else putlog(LOG_MISC, "*", "(%s) Linked to %s.", bot->uplink->name, bot->name);
  }

  return bot;
}

static void botnet_really_delete

(

botnet_bot_t *

bot

)

[static]

Completely delete a bot.

Unlike botnet_delete() this function doesn't call on_delete handlers or trigger binds. It simply removes the bot from the hash table, unlinks it from the bot_head and localbot_head lists and frees the allocated memory.

Parameters:

bot

The bot to delete

Warning:

Should never be called on a bot that hasn't been deleted by botnet_delete() earlier.

Definition at line 403 of file botnet.c.

References BOT_DELETED, botnet_bot::flags, hash_table_remove(), botnet_bot::info, botnet_bot::name, nbots, botnet_bot::next, botnet_bot::next_local, NULL, botnet_bot::prev, botnet_bot::prev_local, botnet_bot::uplink, and xml_node_delete().

Referenced by botnet_cleanup().

{
  if (!(bot->flags & BOT_DELETED)) --nbots;

  if (bot->prev) bot->prev->next = bot->next;
  else bot_head = bot->next;
  if (bot->next) bot->next->prev = bot->prev;

  if (!bot->uplink) {
    if (bot->prev_local) bot->prev_local->next_local = bot->next_local;
    else localbot_head = bot->next_local;
    if (bot->next_local) bot->next_local->prev_local = bot->prev_local;
  }
  hash_table_remove(bot_ht, bot->name, NULL);

  xml_node_delete(bot->info);
  free(bot->name);
  free(bot);
}

static void botnet_recursive_delete	(	botnet_bot_t *	bot,
		botnet_bot_t *	root,
		const char *	reason
	)			[static]

Deletes a subtree of the botnet.

This function deletes a bot, all partymembers on this bot, all bots linked via this bot and all partymembers on any of these bots.

Parameters:

	bot	The bot to delete.
	root	The bot that was originally unlinked. Should ne the same as bot when it's originally called from another function.
	reason	Some text explaining the How and Why of the unlink.

Definition at line 435 of file botnet.c.

References bind_check(), BOT_DELETED, botnet_bot::client_data, user::flags, botnet_bot::flags, botnet_bot::name, nbots, botnet_bot::next, NULL, event_owner_b::on_delete, botnet_bot::owner, partymember_delete_by_bot(), botnet_bot::uplink, botnet_bot::user, and USER_LINKED_BOT.

Referenced by botnet_delete().

{
  botnet_bot_t *tmp;

  if (bot->flags & BOT_DELETED) return;

  /* First delete all bots linked via this bot */
  for (tmp = bot_head; tmp; tmp = tmp->next) {
    if (tmp->flags & BOT_DELETED) continue;
    if (tmp->uplink == bot) botnet_recursive_delete(tmp, root, reason);
  }

  /* Then delete all partymembers on this bot */
  partymember_delete_by_bot(bot, root, reason);

  /* And finally this bot */
  bind_check(BT_disc, NULL, bot->name, bot, root, reason);
  bot->flags |= BOT_DELETED;
  if (bot->user) bot->user->flags &= ~USER_LINKED_BOT;
  if (bot->owner && bot->owner->on_delete) bot->owner->on_delete(bot->owner, bot->client_data);
  --nbots;
}

static void botnet_recursive_replay_net	(	botnet_bot_t *	dst,
		botnet_bot_t *	start
	)			[static]

For internal use by botnet_replay_net().

Warning:

Don't call this unless you're botnet_replay_net().

Definition at line 572 of file botnet.c.

References BOT_DELETED, partymember::channels, botnet_bot::client_data, botnet_bot::flags, partymember::flags, botnet_bot::handler, partymember::nchannels, botnet_bot::next, partymember::next_on_bot, botnet_handler_t::on_join, botnet_handler_t::on_login, botnet_handler_t::on_new_bot, PARTY_DELETED, partymember_get_local_head(), botnet_bot::partys, and botnet_bot::uplink.

Referenced by botnet_replay_net().

{
  int i;
  botnet_bot_t *tmp;
  partymember_t *p;

  if (start && dst->handler->on_new_bot) dst->handler->on_new_bot(dst->client_data, start, 1);
  
  for (p = start ? start->partys : partymember_get_local_head(); p; p = p->next_on_bot) {
    if (p->flags & PARTY_DELETED) continue;
    if (dst->handler->on_login) dst->handler->on_login(dst->client_data, p);
    for (i = 0; i < p->nchannels; ++i) {
      if (dst->handler->on_join) dst->handler->on_join(dst->client_data, p->channels[i], p, 1);
    }
  }

  for (tmp = bot_head; tmp; tmp = tmp->next) {
    if (tmp->flags & BOT_DELETED || tmp == dst) continue;
    if (tmp->uplink == start) botnet_recursive_replay_net(dst, tmp);
  }
}

void botnet_replay_net

(

botnet_bot_t *

dst

)

Sends a replay of the current botnet to a bot.

This function calls the botnet_handler_t::on_new_bot and botnet_handler_t::on_join callbacks of a bot for every bot and partymember on the botnet. The callbacks are always called with the linking parameter true.

Parameters:

dst

The bot to send it to.

Definition at line 604 of file botnet.c.

References botnet_recursive_replay_net(), and NULL.

Referenced by got_version(), recving_login(), and sending_login().

{
  botnet_recursive_replay_net(dst, NULL);
}

void botnet_set_info	(	botnet_bot_t *	bot,
		const char *	name,
		const char *	value
	)

Definition at line 822 of file botnet.c.

References botnet_bot::info, and xml_node_set_str().

{
  xml_node_set_str(value, bot->info, name, 0, (void *) 0);
}

void botnet_set_info_int	(	botnet_bot_t *	bot,
		const char *	name,
		int	value
	)

Definition at line 827 of file botnet.c.

References botnet_bot::info, and xml_node_set_int().

{
  xml_node_set_int(value, bot->info, name, 0, (void *) 0);
}

int botnet_set_name

(

const char *

name

)

Set the botname of this bot.

This will change the botname of this bot on the fly. It will fail and report an error if there are any bots connected to the botnet or if someone's on the partyline.

Parameters:

name

The new botname.

Returns:

0 on success or -1 on error.

Definition at line 202 of file botnet.c.

References botname, default_botname, nbots, and partymember_get_head().

Referenced by core_init().

{
  if (bot_head || localbot_head || nbots || partymember_get_head()) return -1;
  if (botname != default_botname) free(botname);
  botname = strdup(name);
  return 0;
}

void botnet_set_nick	(	partymember_t *	p,
		const char *	oldnick
	)

Definition at line 915 of file botnet.c.

References partymember::bot, BOT_DELETED, botnet_bot::client_data, botnet_bot::direction, botnet_bot::flags, botnet_bot::handler, botnet_bot::next_local, and botnet_handler_t::on_nick.

Referenced by partymember_set_nick().

{
  botnet_bot_t *tmp;

  for (tmp = localbot_head; tmp; tmp = tmp->next_local) {
    if (tmp->flags & BOT_DELETED || (p->bot && tmp == p->bot->direction)) continue;
    if (tmp->handler && tmp->handler->on_nick) tmp->handler->on_nick(tmp->client_data, p, oldnick);
  }
}

int botnet_shutdown

(

void

)

Shuts the whole botnet stuff down.

Frees all memory, deletes the binds, ...

Returns:

Always 0

Definition at line 162 of file botnet.c.

References bind_table_del(), botname, botnet_clear_all(), default_botname, garbage_run(), hash_table_delete(), LOG_MISC, NULL, and putlog().

Referenced by eggdrop_shutdown().

{
  int leaked;

  /* Since at this point no scripts or modules should be loaded,
   * there should be no botnet. But just to make sure ... */

  leaked = botnet_clear_all();
  if (leaked) putlog(LOG_MISC, "*", "Warning: Some botnet module leaked %d bots. Fix this!", leaked);

  bind_table_del(BT_request_link);
  bind_table_del(BT_link);
  bind_table_del(BT_disc);
  bind_table_del(BT_bot);
  bind_table_del(BT_extension);

  /* force a garbage run since we might have some partymembers 
   * marked as deleted and w/o a garbage_run we may not destroy
   * our hashtable */
  garbage_run();

  hash_table_delete(bot_ht);
  bot_ht = NULL;

  if (botname != default_botname) free(botname);
  return 0;
}

int botnet_unlink	(	botnet_entity_t *	from,
		botnet_bot_t *	bot,
		const char *	reason
	)

To request unlinking a bot.

This function requests the unlinking of a bot on the botnet. If the bot to unlink is not directly linked to this bot, the request is just sent on in the bots direction.

If the bot is directly linked, the link is broken and the unlinked event is sent on in all directions.

Parameters:

	from	Who did it.
	bot	The bot to get rid of.
	reason	Some kind of explanation.

Returns:

0 on success, -1 if the bot's uplink doesn't have an on_unlink handler, -2 if we don't want to unlink.

Todo:

Do some kind of check if we really want the unlink.

Definition at line 369 of file botnet.c.

References _, bot_entity, botnet_delete(), botnet_bot::client_data, botnet_bot::direction, entity_full_name, ENTITY_PARTYMEMBER, botnet_bot::handler, botnet_bot::name, botnet_handler_t::on_lost_bot, botnet_handler_t::on_unlink, partymember_msgf(), botnet_entity::user, and botnet_entity::what.

Referenced by got_unlink(), and party_unlink().

{
  char obuf[512];
  botnet_entity_t me = bot_entity((botnet_bot_t *) 0);

  if (bot->direction != bot) {
    if (!bot->direction->handler || !bot->direction->handler->on_unlink) return -1;
    bot->direction->handler->on_unlink(bot->direction->client_data, from, bot, reason);
    return 0;
  }

  snprintf(obuf, sizeof(obuf), "%s (%s)", reason, entity_full_name(from));

  if (bot->handler && bot->handler->on_lost_bot) bot->handler->on_lost_bot(bot->client_data, bot, obuf);
  if (from->what == ENTITY_PARTYMEMBER) partymember_msgf(from->user, &me, _("Unlinked from %s."), bot->name);
  botnet_delete(bot, reason);

  return 0;
}

---

Variable Documentation

botnet_bot_t* bot_head [static]

Definition at line 47 of file botnet.c.

hash_table_t* bot_ht = NULL [static]

Definition at line 46 of file botnet.c.

char* botname [static]

Definition at line 43 of file botnet.c.

Referenced by botnet_get_name(), botnet_init(), botnet_new(), botnet_set_name(), botnet_shutdown(), expired_mask(), filesys_DCC_CHAT(), party_bots(), and party_unlink().

bind_table_t* BT_bot [static]

Bind:

Triggered by a message coming from another bot in the botnet. The first word is the command and the rest becomes the text argument.

Name:

bot

Flags:

Ignored.

Match:

The command.

Parameters:

	bot	The bot the message is from.
	string	The command.
	string	The rest of the line, possibly nothing.

Note:

This bind is stackable.

Returns:

Any return value will be ignored.

Definition at line 126 of file botnet.c.

bind_table_t* BT_disc [static]

Bind:

This bind is triggered every time a bot is lost from the botnet. If a bot gets disconnected this bind is triggered for all bots behind the lost one first, beginning with the most distant bots. That means that for some bots this bind is triggered for, the uplink still exists in this bots database even though it has already been lost.

Name:

disc

Flags:

Ignored.

Match:

The lost bot's name.

Parameters:

	bot	The lost bot.
	bot	The bot that really got disconnected and caused the bots behind it to get lost.
	string	Some kind of reason for the disconnect.

Note:

This bind is stackable.

Returns:

Any return value will be ignored.

Definition at line 110 of file botnet.c.

bind_table_t* BT_extension [static]

Todo:

Document me

Definition at line 130 of file botnet.c.

bind_table_t* BT_link [static]

Bind:

This bind is triggered every time a new bot is somehow linked to the botnet. There is no way to determine if it happened because it was directly linked or because another bot was linked and introduced it.

Name:

link

Flags:

Ignored.

Match:

The new bot's name.

Parameters:

bot

The new bot.

Note:

This bind is stackable.

Returns:

Any return value will be ignored.

Definition at line 91 of file botnet.c.

bind_table_t* BT_request_link [static]

Bind:

This bind is triggered every time the bot wants to link to another bot for some reason.

Name:

request-link

Flags:

Ignored.

Match:

The bot's type.

Parameters:

	user	The user record of the bot to be linked.
	string	The type of the bot. (Same as the match.)

Note:

This bind is stackable and breakable.

Returns:

A function should return BIND_RET_BREAK if it tried to establish a link or 0 otherwise.

Definition at line 76 of file botnet.c.

char* default_botname = "eggdrop" [static]

Definition at line 44 of file botnet.c.

Referenced by botnet_init(), botnet_set_name(), and botnet_shutdown().

int linking_bots = 0 [static]

Number of bots that are currently in the process of being linked.

Definition at line 49 of file botnet.c.

Referenced by botnet_autolink(), botnet_find_min(), botnet_link(), botnet_link_failed(), and botnet_link_success().

botnet_bot_t * localbot_head [static]

Definition at line 47 of file botnet.c.

int nbots = 0 [static]

Definition at line 48 of file botnet.c.

Referenced by botnet_init(), botnet_new(), botnet_really_delete(), botnet_recursive_delete(), and botnet_set_name().

const char rcsid[] = "$Id: botnet.c,v 1.13 2007-09-13 22:20:55 sven Exp $" [static]

Definition at line 31 of file botnet.c.