path: root/plugins/Db3x_mmap/src/dbcontacts.cpp

/*

Miranda NG: the free IM client for Microsoft* Windows*

Copyright 2012-14 Miranda NG project,
all portions of this codebase are copyrighted to the people
listed in contributors.txt.

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.
*/

#include "commonheaders.h"

#define NOT_UNREAD (DBEF_READ | DBEF_SENT)

int CDb3Mmap::CheckProto(DBCachedContact *cc, const char *proto)
{
	if (cc->szProto == NULL) {
		char protobuf[MAX_PATH] = { 0 };
		DBVARIANT dbv;
		dbv.type = DBVT_ASCIIZ;
		dbv.pszVal = protobuf;
		dbv.cchVal = sizeof(protobuf);
		if (GetContactSettingStatic(cc->contactID, "Protocol", "p", &dbv) != 0 || (dbv.type != DBVT_ASCIIZ))
			return 0;

		cc->szProto = m_cache->GetCachedSetting(NULL, protobuf, 0, (int)strlen(protobuf));
	}

	return !strcmp(cc->szProto, proto);
}

STDMETHODIMP_(LONG) CDb3Mmap::GetContactCount(void)
{
	mir_cslock lck(m_csDbAccess);
	return m_dbHeader.contactCount;
}

STDMETHODIMP_(MCONTACT) CDb3Mmap::FindFirstContact(const char *szProto)
{
	mir_cslock lck(m_csDbAccess);
	DBCachedContact *cc = m_cache->GetFirstContact();
	if (cc == NULL)
		return NULL;

	if (!szProto || CheckProto(cc, szProto))
		return cc->contactID;

	return FindNextContact(cc->contactID, szProto);
}

STDMETHODIMP_(MCONTACT) CDb3Mmap::FindNextContact(MCONTACT contactID, const char *szProto)
{
	mir_cslock lck(m_csDbAccess);
	while (contactID) {
		DBCachedContact *cc = m_cache->GetNextContact(contactID);
		if (cc == NULL)
			break;

		if (!szProto || CheckProto(cc, szProto))
			return cc->contactID;

		contactID = cc->contactID;
	}

	return NULL;
}

STDMETHODIMP_(LONG) CDb3Mmap::DeleteContact(MCONTACT contactID)
{
	if (contactID == NULL)
		return 1;

	mir_cslockfull lck(m_csDbAccess);
	DBCachedContact *cc = m_cache->GetCachedContact(contactID);
	if (cc == NULL)
		return 1;

	DBContact *dbc = (DBContact*)DBRead(cc->dwDriverData, sizeof(DBContact), NULL);
	if (dbc->signature != DBCONTACT_SIGNATURE)
		return 1;

	if (cc->dwDriverData == m_dbHeader.ofsUser) {
		log0("FATAL: del of user chain attempted.");
		return 1;
	}

	lck.unlock();
	log0("del contact");

	// call notifier while outside mutex
	NotifyEventHooks(hContactDeletedEvent, contactID, 0);

	// get back in
	lck.lock();

	// delete settings chain
	DWORD ofsThis = dbc->ofsFirstSettings;
	DWORD ofsFirstEvent = dbc->ofsFirstEvent;
	while (ofsThis) {
		DBContactSettings *dbcs = (DBContactSettings*)DBRead(ofsThis, sizeof(DBContactSettings), NULL);
		DWORD ofsNext = dbcs->ofsNext;
		DeleteSpace(ofsThis, offsetof(DBContactSettings, blob) + dbcs->cbBlob);
		ofsThis = ofsNext;
	}

	// delete event chain
	ofsThis = ofsFirstEvent;
	while (ofsThis) {
		DBEvent *dbe = (DBEvent*)DBRead(ofsThis, sizeof(DBEvent), NULL);
		DWORD ofsNext = dbe->ofsNext;
		DeleteSpace(ofsThis, offsetof(DBEvent, blob) + dbe->cbBlob);
		ofsThis = ofsNext;
	}

	// find previous contact in chain and change ofsNext
	if (m_dbHeader.ofsFirstContact == cc->dwDriverData) {
		m_dbHeader.ofsFirstContact = dbc->ofsNext;
		DBWrite(0, &m_dbHeader, sizeof(m_dbHeader));
	}
	else {
		DWORD ofsNext = dbc->ofsNext;
		ofsThis = m_dbHeader.ofsFirstContact;
		DBContact *dbcPrev = (DBContact*)DBRead(ofsThis, sizeof(DBContact), NULL);
		while (dbcPrev->ofsNext != cc->dwDriverData) {
			if (dbcPrev->ofsNext == 0) DatabaseCorruption(NULL);
			ofsThis = dbcPrev->ofsNext;
			dbcPrev = (DBContact*)DBRead(ofsThis, sizeof(DBContact), NULL);
		}
		dbcPrev->ofsNext = ofsNext;
		DBWrite(ofsThis, dbcPrev, sizeof(DBContact));
	}

	// delete contact
	DeleteSpace(cc->dwDriverData, sizeof(DBContact));

	// decrement contact count
	m_dbHeader.contactCount--;
	DBWrite(0, &m_dbHeader, sizeof(m_dbHeader));
	DBFlush(0);

	// free cache item
	m_cache->FreeCachedContact(contactID);
	if (contactID == m_hLastCachedContact)
		m_hLastCachedContact = NULL;
	return 0;
}

STDMETHODIMP_(HANDLE) CDb3Mmap::AddContact()
{
	DWORD ofsNew;
	log0("add contact");

	DBContact dbc = { 0 };
	dbc.signature = DBCONTACT_SIGNATURE;
	{
		mir_cslock lck(m_csDbAccess);
		ofsNew = CreateNewSpace(sizeof(DBContact));

		dbc.ofsNext = m_dbHeader.ofsFirstContact;
		dbc.dwContactID = m_dwMaxContactId++;
		m_dbHeader.ofsFirstContact = ofsNew;
		m_dbHeader.contactCount++;
		DBWrite(ofsNew, &dbc, sizeof(DBContact));
		DBWrite(0, &m_dbHeader, sizeof(m_dbHeader));
		DBFlush(0);
	}

	DBCachedContact *cc = m_cache->AddContactToCache(dbc.dwContactID);
	cc->dwDriverData = ofsNew;

	NotifyEventHooks(hContactAddedEvent, dbc.dwContactID, 0);
	return (HANDLE)dbc.dwContactID;
}

STDMETHODIMP_(BOOL) CDb3Mmap::IsDbContact(MCONTACT contactID)
{
	DBCachedContact *cc = m_cache->GetCachedContact(contactID);
	if (cc == NULL)
		return FALSE;

	mir_cslock lck(m_csDbAccess);
	DBContact *dbc = (DBContact*)DBRead(cc->dwDriverData, sizeof(DBContact), NULL);
	if (dbc->signature == DBCONTACT_SIGNATURE) {
		m_cache->AddContactToCache(contactID);
		return TRUE;
	}

	return FALSE;
}

/////////////////////////////////////////////////////////////////////////////////////////
// metacontacts support

BOOL CDb3Mmap::MetaDetouchSub(DBCachedContact *cc, int nSub)
{
	CallService(MS_DB_MODULE_DELETE, cc->pSubs[nSub], (LPARAM)META_PROTO);
	return 0;
}

BOOL CDb3Mmap::MetaSetDefault(DBCachedContact *cc)
{
	return db_set_dw(cc->contactID, META_PROTO, "Default", cc->nDefault);
}

static int SortEvent(const DBEvent *p1, const DBEvent *p2)
{
	return (LONG)p1->timestamp - (LONG)p2->timestamp;
}

BOOL CDb3Mmap::MetaMergeHistory(DBCachedContact *ccMeta, DBCachedContact *ccSub)
{
	mir_cslock lck(m_csDbAccess);
	DBContact *dbMeta = (DBContact*)DBRead(ccMeta->dwDriverData, sizeof(DBContact), NULL);
	DBContact *dbSub = (DBContact*)DBRead(ccSub->dwDriverData, sizeof(DBContact), NULL);
	if (dbMeta->signature != DBCONTACT_SIGNATURE || dbSub->signature != DBCONTACT_SIGNATURE)
		return 1;

	// special cases
	if (dbSub->ofsFirstEvent == 0) // hurrah, nothing to do
		return 0;

	if (dbMeta->ofsFirstEvent == 0) { // simply chain history to a meta
		dbMeta->eventCount = dbSub->eventCount;
		dbMeta->ofsFirstEvent = dbSub->ofsFirstEvent;
		dbMeta->ofsLastEvent = dbSub->ofsLastEvent;
		dbMeta->ofsFirstUnread = dbSub->ofsFirstUnread;
		dbMeta->tsFirstUnread = dbSub->tsFirstUnread;
	}
	else {
		// there're events in both meta's & sub's event chains
		// relink sub's event chain to meta without changing events themselves
		LIST<DBEvent> arEvents(20000, SortEvent);
		for (DWORD ofsMeta = dbMeta->ofsFirstEvent; ofsMeta != 0;) {
			DBEvent *pev = (DBEvent*)DBRead(ofsMeta, sizeof(DBEvent), NULL);
			if (pev->signature != DBEVENT_SIGNATURE) // broken chain, don't touch it
				return 2;

			arEvents.insert(pev);
			ofsMeta = pev->ofsNext;
		}

		for (DWORD ofsSub = dbSub->ofsFirstEvent; ofsSub != 0;) {
			DBEvent *pev = (DBEvent*)DBRead(ofsSub, sizeof(DBEvent), NULL);
			if (pev->signature != DBEVENT_SIGNATURE) // broken chain, don't touch it
				return 2;

			arEvents.insert(pev);
			ofsSub = pev->ofsNext;
		}

		// all events are in memory, valid & sorted in the right order.
		// ready? steady? go!
		dbMeta->eventCount = arEvents.getCount();

		DBEvent *pFirst = arEvents[0];
		dbMeta->ofsFirstEvent = DWORD(PBYTE(pFirst) - m_pDbCache);
		pFirst->ofsPrev = 0;
		dbMeta->ofsFirstUnread = (pFirst->flags & NOT_UNREAD) ? 0 : dbMeta->ofsFirstEvent;

		DBEvent *pLast = arEvents[arEvents.getCount()-1];
		dbMeta->ofsLastEvent = DWORD(PBYTE(pLast) - m_pDbCache);
		pLast->ofsNext = 0;

		for (int i = 1; i < arEvents.getCount(); i++) {
			DBEvent *pPrev = arEvents[i-1], *pNext = arEvents[i];
			pPrev->ofsNext = DWORD(PBYTE(pNext) - m_pDbCache);
			pNext->ofsPrev = DWORD(PBYTE(pPrev) - m_pDbCache);

			if (dbMeta->ofsFirstUnread == 0 && !(pNext->flags & NOT_UNREAD))
				dbMeta->ofsFirstUnread = pPrev->ofsNext;
		}
	}

	// remove any traces of history from sub
	dbSub->eventCount = 0;
	dbSub->ofsFirstEvent = dbSub->ofsLastEvent = dbSub->ofsFirstUnread = dbSub->tsFirstUnread = 0;
	FlushViewOfFile(m_pDbCache, 0);
	return 0;
}

BOOL CDb3Mmap::MetaSplitHistory(DBCachedContact *ccMeta, DBCachedContact *ccSub)
{
	mir_cslock lck(m_csDbAccess);
	DBContact dbMeta = *(DBContact*)DBRead(ccMeta->dwDriverData, sizeof(DBContact), NULL);
	DBContact dbSub = *(DBContact*)DBRead(ccSub->dwDriverData, sizeof(DBContact), NULL);
	if (dbMeta.signature != DBCONTACT_SIGNATURE || dbSub.signature != DBCONTACT_SIGNATURE)
		return 1;

	if (dbMeta.ofsFirstEvent == 0) // nothing to do
		return 0;

	// drop subContact's history if any
	for (DWORD dwOffset = dbSub.ofsFirstEvent; dwOffset != 0;) {
		DBEvent *pev = (DBEvent*)DBRead(dwOffset, sizeof(DBEvent), NULL);
		if (pev->signature != DBEVENT_SIGNATURE) // broken chain, don't touch it
			return 2;

		DWORD dwNext = pev->ofsNext;
		DeleteSpace(dwOffset, offsetof(DBEvent, blob) + pev->cbBlob);
		dwOffset = dwNext;
	}

	DWORD dwOffset = dbMeta.ofsFirstEvent;
	DBEvent *evMeta = NULL, *evSub = NULL;
	dbSub.eventCount = 0; dbSub.ofsFirstEvent = dbSub.ofsLastEvent = dbSub.ofsFirstUnread = dbSub.tsFirstUnread = 0;
	dbMeta.eventCount = 0; dbMeta.ofsFirstEvent = dbMeta.ofsLastEvent = dbMeta.ofsFirstUnread = dbMeta.tsFirstUnread = 0;

	while (dwOffset != 0) {
		DBEvent *evCurr = (DBEvent*)DBRead(dwOffset, sizeof(DBEvent), NULL);
		if (evCurr->signature != DBEVENT_SIGNATURE)
			break;

		DWORD dwNext = evCurr->ofsNext; evCurr->ofsNext = 0;

		// extract it to sub's chain
		if (evCurr->contactID == ccSub->contactID) {
			dbSub.eventCount++;
			if (evSub != NULL) {
				evSub->ofsNext = dwOffset;
				evCurr->ofsPrev = DWORD(PBYTE(evSub) - m_pDbCache);
			}
			else {
				dbSub.ofsFirstEvent = dwOffset;
				evCurr->ofsPrev = 0;
			}
			if (dbSub.ofsFirstUnread == 0 && !(evCurr->flags & NOT_UNREAD)) {
				dbSub.ofsFirstUnread = dwOffset;
				dbSub.tsFirstUnread = evCurr->timestamp;
			}
			dbSub.ofsLastEvent = dwOffset;
			evSub = evCurr;
		}
		else {
			dbMeta.eventCount++;
			if (evMeta != NULL) {
				evMeta->ofsNext = dwOffset;
				evCurr->ofsPrev = DWORD(PBYTE(evMeta) - m_pDbCache);
			}
			else {
				dbMeta.ofsFirstEvent = dwOffset;
				evCurr->ofsPrev = 0;
			}
			if (dbMeta.ofsFirstUnread == 0 && !(evCurr->flags & NOT_UNREAD)) {
				dbMeta.ofsFirstUnread = dwOffset;
				dbMeta.tsFirstUnread = evCurr->timestamp;
			}
			dbMeta.ofsLastEvent = dwOffset;
			evMeta = evCurr;
		}

		dwOffset = dwNext;
	}

	DBWrite(ccSub->dwDriverData, &dbSub, sizeof(DBContact));
	DBWrite(ccMeta->dwDriverData, &dbMeta, sizeof(DBContact));
	FlushViewOfFile(m_pDbCache, 0);
	return 0;
}

/////////////////////////////////////////////////////////////////////////////////////////
// contacts convertor

#define OLD_CONTACT_SIZE offsetof(DBContact, dwContactID)

void CDb3Mmap::ConvertContacts()
{
	DBContact *pPrev = NULL;

	m_dbHeader.ofsUser = ReallocSpace(m_dbHeader.ofsUser, OLD_CONTACT_SIZE, sizeof(DBContact));

	for (DWORD dwOffset = m_dbHeader.ofsFirstContact; dwOffset != 0;) {
		DBContact *pOld = (DBContact*)DBRead(dwOffset, sizeof(DBContact), NULL);
		DWORD dwNew = ReallocSpace(dwOffset, OLD_CONTACT_SIZE, sizeof(DBContact));
		DBContact *pNew = (DBContact*)DBRead(dwNew, sizeof(DBContact), NULL);
		pNew->dwContactID = m_dwMaxContactId++;

		if (pPrev == NULL)
			m_dbHeader.ofsFirstContact = dwNew;
		else
			pPrev->ofsNext = dwNew;
		pPrev = pNew;

		m_contactsMap.insert(new ConvertedContact(dwOffset, pNew->dwContactID));
		dwOffset = pNew->ofsNext;
	}

	FlushViewOfFile(m_pDbCache, 0);
}

void CDb3Mmap::FillContacts()
{
	LIST<void> arMetas(10);

	for (DWORD dwOffset = m_dbHeader.ofsFirstContact; dwOffset != 0;) {
		DBContact *p = (DBContact*)DBRead(dwOffset, sizeof(DBContact), NULL);
		if (p->signature != DBCONTACT_SIGNATURE)
			break;

		DWORD dwContactID;
		if (m_dbHeader.version >= DB_095_VERSION) {
			dwContactID = p->dwContactID;
			if (dwContactID > m_dwMaxContactId)
				m_dwMaxContactId = dwContactID + 1;
		}
		else dwContactID = m_dwMaxContactId++;

		DBCachedContact *cc = m_cache->AddContactToCache(dwContactID);
		cc->dwDriverData = dwOffset;
		CheckProto(cc, "");

		DBVARIANT dbv; dbv.type = DBVT_DWORD;
		cc->nSubs = (0 != GetContactSetting(dwContactID, META_PROTO, "NumContacts", &dbv)) ? -1 : dbv.dVal;
		if (cc->nSubs != -1) {
			cc->pSubs = (MCONTACT*)mir_alloc(cc->nSubs*sizeof(MCONTACT));
			for (int i = 0; i < cc->nSubs; i++) {
				char setting[100];
				mir_snprintf(setting, sizeof(setting), "Handle%d", i);
				MCONTACT hSub = (0 != GetContactSetting(dwContactID, META_PROTO, setting, &dbv)) ? NULL : dbv.dVal;
				ConvertedContact *pcc = m_contactsMap.find((ConvertedContact*)&hSub);
				if (pcc != NULL) {
					hSub = pcc->hNew;

					DBCONTACTWRITESETTING dbws = { META_PROTO, setting };
					dbws.value.type = DBVT_DWORD;
					dbws.value.dVal = hSub;
					WriteContactSetting(dwContactID, &dbws);
				}
				cc->pSubs[i] = hSub;
			}
		}
		cc->nDefault = (0 != GetContactSetting(dwContactID, META_PROTO, "Default", &dbv)) ? -1 : dbv.dVal;
		cc->parentID = (0 != GetContactSetting(dwContactID, META_PROTO, "ParentMeta", &dbv)) ? NULL : dbv.dVal;

		// whether we need conversion or not
		if (!GetContactSetting(dwContactID, META_PROTO, "MetaID", &dbv))
			arMetas.insert((void*)dwContactID);

		dwOffset = p->ofsNext;
	}

	#if defined(_DEBUG)
		for (int i = 0; i < arMetas.getCount(); i++) {
			MCONTACT hContact = (MCONTACT)arMetas[i];
			DBCachedContact *ccMeta = m_cache->GetCachedContact(hContact);
			if (ccMeta == NULL)
				continue;

			// we don't need it anymore
			DeleteContactSetting(hContact, META_PROTO, "MetaID");

			for (int k = 0; k < ccMeta->nSubs; k++) {
				// store contact id instead of the old mc number
				DBCONTACTWRITESETTING dbws = { META_PROTO, "ParentMeta" };
				dbws.value.type = DBVT_DWORD;
				dbws.value.dVal = hContact;
				WriteContactSetting(ccMeta->pSubs[k], &dbws);

				// wipe out old data from subcontacts
				DeleteContactSetting(ccMeta->pSubs[k], META_PROTO, "ContactNumber");
				DeleteContactSetting(ccMeta->pSubs[k], META_PROTO, "MetaLink");

				DBCachedContact *ccSub = m_cache->GetCachedContact(ccMeta->pSubs[k]);
				if (ccSub)
					MetaMergeHistory(ccMeta, ccSub);
			}
		}
	#endif
}

DWORD CDb3Mmap::GetContactOffset(MCONTACT contactID)
{
	if (contactID == 0)
		return m_dbHeader.ofsUser;

	DBCachedContact *cc = m_cache->GetCachedContact(contactID);
	return (cc == NULL) ? 0 : cc->dwDriverData;
}