construct/modules/m_map.cc

/*
 *  ircd-ratbox: A slightly useful ircd.
 *  m_map.c: Sends an Undernet compatible map to a user.
 *
 *  Copyright (C) 2002 by the past and present ircd coders, and others.
 *
 *  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 2 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, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
 *  USA
 */

#define USER_COL       50	/* display | Users: %d at col 50 */

using namespace ircd;

static const char map_desc[] = "Provides the MAP command to view network topology information";

static void m_map(struct MsgBuf *msgbuf_p, client::client &client, client::client &source, int parc, const char *parv[]);
static void mo_map(struct MsgBuf *msgbuf_p, client::client &client, client::client &source, int parc, const char *parv[]);

struct Message map_msgtab = {
	"MAP", 0, 0, 0, 0,
	{mg_unreg, {m_map, 0}, mg_ignore, mg_ignore, mg_ignore, {mo_map, 0}}
};

mapi_clist_av1 map_clist[] = { &map_msgtab, NULL };

DECLARE_MODULE_AV2(map, NULL, NULL, map_clist, NULL, NULL, NULL, NULL, map_desc);

static void dump_map(client::client &client, client::client *root, char *pbuf);
static void flattened_map(client::client &client);

static char buf[BUFSIZE];

/* m_map
*/
static void
m_map(struct MsgBuf *msgbuf_p, client::client &client, client::client &source, int parc, const char *parv[])
{
	if((!is_exempt_shide(source) && ConfigServerHide.flatten_links) ||
	   ConfigFileEntry.map_oper_only)
	{
		flattened_map(client);
		sendto_one_numeric(&client, RPL_MAPEND, form_str(RPL_MAPEND));
		return;
	}

	dump_map(client, &me, buf);
	sendto_one_numeric(&client, RPL_MAPEND, form_str(RPL_MAPEND));
}

/*
** mo_map
*/
static void
mo_map(struct MsgBuf *msgbuf_p, client::client &client, client::client &source, int parc, const char *parv[])
{
	dump_map(client, &me, buf);
	cache::serv::send_missing(client);
	sendto_one_numeric(&client, RPL_MAPEND, form_str(RPL_MAPEND));
}

/*
** dump_map
**   dumps server map, called recursively.
*/
static void
dump_map(client::client &client, client::client *root_p, char *pbuf)
{
	int cnt = 0, i = 0, len, frac;
	client::client *server_p;
	rb_dlink_node *ptr;
	*pbuf = '\0';

	rb_strlcat(pbuf, root_p->name, BUFSIZE);
	if (has_id(root_p))
	{
		rb_strlcat(pbuf, "[", BUFSIZE);
		rb_strlcat(pbuf, root_p->id, BUFSIZE);
		rb_strlcat(pbuf, "]", BUFSIZE);
	}
	len = strlen(buf);
	buf[len] = ' ';

	if(len < USER_COL)
	{
		for (i = len + 1; i < USER_COL; i++)
		{
			buf[i] = '-';
		}
	}

	frac = (1000 * users(serv(*root_p)).size() + Count.total / 2) / Count.total;
	snprintf(buf + USER_COL, BUFSIZE - USER_COL,
		 " | Users: %5lu (%2d.%1d%%)", users(serv(*root_p)).size(),
		 frac / 10, frac % 10);

	sendto_one_numeric(&client, RPL_MAP, form_str(RPL_MAP), buf);

	if(!servers(serv(*root_p)).empty())
	{
		cnt += servers(serv(*root_p)).size();

		if(cnt)
		{
			if(pbuf > buf + 3)
			{
				pbuf[-2] = ' ';
				if(pbuf[-3] == '`')
					pbuf[-3] = ' ';
			}
		}
	}
	i = 1;
	for(auto &server_p : servers(serv(*root_p)))
	{
		*pbuf = ' ';
		if(i < cnt)
			*(pbuf + 1) = '|';
		else
			*(pbuf + 1) = '`';

		*(pbuf + 2) = '-';
		*(pbuf + 3) = ' ';
		dump_map(client, server_p, pbuf + 4);

		i++;
	}
}

/*
 * flattened_map - display a version of map that doesn't give away routing
 *                 information to users when flattened links is enabled.
 */
static void
flattened_map(client::client &client)
{
	char buf[BUFSIZE];
	rb_dlink_node *ptr;
	client::client *target_p;
	int i, len;
	unsigned long cnt = 0;

	/* First display me as the root */
	rb_strlcpy(buf, me.name, BUFSIZE);
	len = strlen(buf);
	buf[len] = ' ';

	if(len < USER_COL)
	{
		for (i = len + 1; i < USER_COL; i++)
		{
			buf[i] = '-';
		}
	}

	snprintf(buf + USER_COL, BUFSIZE - USER_COL,
		" | Users: %5lu (%4.1f%%)", users(serv(me)).size(),
		100 * (float) users(serv(me)).size() / (float) Count.total);

	sendto_one_numeric(&client, RPL_MAP, form_str(RPL_MAP), buf);

	/* Next, we run through every other server and list them */
	RB_DLINK_FOREACH(ptr, global_serv_list.head)
	{
		target_p = (client::client *)ptr->data;

		cnt++;

		/* Skip ourselves, it's already counted */
		if(is_me(*target_p))
			continue;

		/* if we're hidden, go on to the next leaf */
		if(!ConfigServerHide.disable_hidden && is_hidden(*target_p))
			continue;

		if (cnt == rb_dlink_list_length(&global_serv_list))
			rb_strlcpy(buf, " `- ", BUFSIZE);
		else
			rb_strlcpy(buf, " |- ", BUFSIZE);

		rb_strlcat(buf, target_p->name, BUFSIZE);
		len = strlen(buf);
		buf[len] = ' ';

		if(len < USER_COL)
		{
			for (i = len + 1; i < USER_COL; i++)
			{
				buf[i] = '-';
			}
		}

		snprintf(buf + USER_COL, BUFSIZE - USER_COL,
			" | Users: %5lu (%4.1f%%)", users(serv(*target_p)).size(),
			100 * (float) users(serv(*target_p)).size() / (float) Count.total);

		sendto_one_numeric(&client, RPL_MAP, form_str(RPL_MAP), buf);
	}
}