anope/src/nickcore.cpp

// Anope IRC Services <https://www.anope.org/>
//
// Copyright (C) 2003-2025 Anope Contributors
//
// Anope is free software. You can use, modify, and/or distribute it under the
// terms of version 2 of the GNU General Public License. See docs/LICENSE.txt
// for the complete terms of this license and docs/AUTHORS.txt for a list of
// contributors.
//
// Based on the original code of Epona by Lara
// Based on the original code of Services by Andy Church
//
// SPDX-License-Identifier: GPL-2.0-only

#include "services.h"
#include "modules.h"
#include "account.h"
#include "config.h"
#include <climits>

Serialize::Checker<nickcore_map> NickCoreList(NICKCORE_TYPE);
Serialize::Checker<nickcoreid_map> NickCoreIdList(NICKCORE_TYPE);

NickCore::NickCore(const Anope::string &coredisplay, uint64_t coreid)
	: Serializable(NICKCORE_TYPE)
	, chanaccess(CHANNELINFO_TYPE)
	, uniqueid(coreid)
	, display(coredisplay)
	, aliases(NICKALIAS_TYPE)
{
	if (coredisplay.empty())
		throw CoreException("Empty display passed to NickCore constructor");

	if (!NickCoreList->insert_or_assign(this->display, this).second)
		Log(LOG_DEBUG) << "Duplicate account " << this->display << " in NickCore table";

	// Upgrading users may not have an account identifier.
	if (this->uniqueid && !NickCoreIdList->insert_or_assign(this->uniqueid, this).second)
		Log(LOG_DEBUG) << "Duplicate account id " << this->uniqueid << " in NickCore table";

	FOREACH_MOD(OnNickCoreCreate, (this));
}

NickCore::~NickCore()
{
	FOREACH_MOD(OnDelCore, (this));

	UnsetExtensibles();

	if (!this->chanaccess->empty())
		Log(LOG_DEBUG) << "Non-empty chanaccess list in destructor!";

	for (std::list<User *>::iterator it = this->users.begin(); it != this->users.end();)
	{
		User *user = *it++;
		user->Logout();
	}
	this->users.clear();

	NickCoreList->erase(this->display);
	if (this->uniqueid)
		NickCoreIdList->erase(this->uniqueid);

	if (!this->memos.memos->empty())
	{
		for (unsigned i = 0, end = this->memos.memos->size(); i < end; ++i)
			delete this->memos.GetMemo(i);
		this->memos.memos->clear();
	}
}

NickCore::Type::Type()
	: Serialize::Type(NICKCORE_TYPE)
{
}

void NickCore::Type::Serialize(Serializable *obj, Serialize::Data &data) const
{
	auto *nc = static_cast<NickCore *>(obj);
	data.Store("display", nc->display);
	data.Store("uniqueid", nc->GetId());
	data.Store("pass", nc->pass);
	data.Store("email", nc->email);
	data.Store("language", nc->language);
	data.Store("lastmail", nc->lastmail);
	data.Store("registered", nc->registered);
	data.Store("memomax", nc->memos.memomax);

	std::ostringstream oss;
	for (const auto &ignore : nc->memos.ignores)
		oss << ignore << " ";
	data.Store("memoignores", oss.str());

	Extensible::ExtensibleSerialize(nc, nc, data);
}

Serializable *NickCore::Type::Unserialize(Serializable *obj, Serialize::Data &data) const
{
	NickCore *nc;

	Anope::string sdisplay;
	data["display"] >> sdisplay;

	uint64_t sid = 0;
	data["uniqueid"] >> sid;

	if (obj)
		nc = anope_dynamic_static_cast<NickCore *>(obj);
	else
		nc = new NickCore(sdisplay, sid);

	data["pass"] >> nc->pass;
	data["email"] >> nc->email;
	data["language"] >> nc->language;
	data["lastmail"] >> nc->lastmail;
	data["registered"] >> nc->registered;
	data["memomax"] >> nc->memos.memomax;
	{
		Anope::string buf;
		data["memoignores"] >> buf;
		spacesepstream sep(buf);
		nc->memos.ignores.clear();
		while (sep.GetToken(buf))
			nc->memos.ignores.insert(buf);
	}

	Extensible::ExtensibleUnserialize(nc, nc, data);

	// Begin 1.9 compatibility.
	bool b;
	b = false;
	data["extensible:PRIVATE"] >> b;
	if (b)
		nc->Extend<bool>("NS_PRIVATE");
	b = false;
	data["extensible:AUTOOP"] >> b;
	if (b)
		nc->Extend<bool>("AUTOOP");
	b = false;
	data["extensible:HIDE_EMAIL"] >> b;
	if (b)
		nc->Extend<bool>("HIDE_EMAIL");
	b = false;
	data["extensible:HIDE_QUIT"] >> b;
	if (b)
		nc->Extend<bool>("HIDE_QUIT");
	b = false;
	data["extensible:MEMO_RECEIVE"] >> b;
	if (b)
		nc->Extend<bool>("MEMO_RECEIVE");
	b = false;
	data["extensible:MEMO_SIGNON"] >> b;
	if (b)
		nc->Extend<bool>("MEMO_SIGNON");
	b = false;
	data["extensible:KILLPROTECT"] >> b;
	if (b)
		nc->Extend<bool>("PROTECT");
	// End 1.9 compatibility


	// Begin 2.0 compatibility.
	b = false;
	data["KILLPROTECT"] >> b;
	if (b)
	{
		nc->Extend<bool>("PROTECT");
		nc->Extend("PROTECT_AFTER", Config->GetModule("nickserv").Get<time_t>("kill", "60s"));
	}
	b = false;
	data["KILL_QUICK"] >> b;
	if (b)
	{
		nc->Extend<bool>("PROTECT");
		nc->Extend("PROTECT_AFTER", Config->GetModule("nickserv").Get<time_t>("killquick", "20s"));
	}
	b = false;
	data["KILL_IMMED"] >> b;
	if (b)
	{
		nc->Extend<bool>("PROTECT");
		nc->Extend("PROTECT_AFTER", 0);
	}
	// End 2.0 compatibility.

	// Begin 2.1 compatibility.
	if (nc->registered == Anope::CurTime)
		data["time_registered"] >> nc->registered;
	// End 2.1 compatibility.

	return nc;
}

void NickCore::SetDisplay(NickAlias *na)
{
	// If no nick is specified then pick the oldest one.
	if (!na)
	{
		for (auto *alias : *this->aliases)
		{
			if (!na || alias->registered < na->registered)
				na = alias;
		}
	}

	if (!na || na->nc != this || na->nick == this->display)
		return;

	FOREACH_MOD(OnChangeCoreDisplay, (this, na->nick));

	/* Remove the core from the list */
	NickCoreList->erase(this->display);

	this->display = na->nick;
	this->na = na;

	(*NickCoreList)[this->display] = this;
}

bool NickCore::IsServicesOper() const
{
	return this->o != NULL;
}

void NickCore::AddChannelReference(ChannelInfo *ci)
{
	++(*this->chanaccess)[ci];
}

void NickCore::RemoveChannelReference(ChannelInfo *ci)
{
	int &i = (*this->chanaccess)[ci];
	if (--i <= 0)
		this->chanaccess->erase(ci);
}

void NickCore::GetChannelReferences(std::deque<ChannelInfo *> &queue)
{
	queue.clear();
	for (const auto &[ci, _] : *this->chanaccess)
		queue.push_back(ci);
}

NickCore *NickCore::Find(const Anope::string &nick)
{
	nickcore_map::const_iterator it = NickCoreList->find(nick);
	if (it != NickCoreList->end())
	{
		it->second->QueueUpdate();
		return it->second;
	}

	return NULL;
}

NickCore *NickCore::FindId(uint64_t uid)
{
	auto it = NickCoreIdList->find(uid);
	if (it != NickCoreIdList->end())
	{
		it->second->QueueUpdate();
		return it->second;
	}
	return nullptr;
}

uint64_t NickCore::GetId()
{
	if (this->uniqueid)
		return this->uniqueid;

	// We base the account identifier on the account display at registration and
	// when the account was first registered. This should be unique enough that
	// it never collides. In the extremely rare case that it does generate a
	// duplicate id we try with a new suffix.
	uint64_t attempt = 0;
	while (!this->uniqueid)
	{
		const auto newidstr = this->display + "\0" + Anope::ToString(this->registered) + "\0" + Anope::ToString(attempt++);
		const auto newid = Anope::hash_cs()(newidstr);
		if (NickCoreIdList->emplace(newid, this).second)
		{
			this->uniqueid = newid;
			this->QueueUpdate();
			break;
		}
	}

	return this->uniqueid;
}