You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
konversation/konversation/src/serverison.h

115 lines
4.4 KiB

/*
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.
*/
/*
serverison.h - Class to give a list of all the nicks known to the
addressbook and watchednick list that are on this
server. There is one instance of this class for
each Server object.
begin: Fri Sep 03 2004
copyright: (C) 2004 by John Tapsell
email: john@geola.co.uk
*/
/**
* @author John Tapsell <john@geola.co.uk>
* @author Gary Cramblitt <garycramblitt@comcast.net>
*/
#ifndef SERVERISON_H
#define SERVERISON_H
#include "nickinfo.h"
class Server;
typedef TQMap<TQString,TDEABC::Addressee> OfflineNickToAddresseeMap;
class ServerISON : public TQObject
{
TQ_OBJECT
public:
explicit ServerISON(Server* server);
/**
* Returns a list of nicks that we want to know whether they are online
* of offline.
*
* Calls getAddressees() and merges with the Watch List from preferences.
* The resulting nicks don't have the servername/servergroup attached.
*
* @returns A list of nicks that we want to know if they are on or not.
*
* @see getAddressees()
*/
TQStringList getWatchList();
/**
* The same list as getWatchList, but with nicks in joined channels eliminated.
* There is no point in performing an ISON on such nicks because we already
* know they are online. This function is called, and the result sent to the
* server as an /ISON command.
*/
TQStringList getISONList();
/**
* Returns _some_ of the nicks that the addressees have.
* It loops through all the addressees that have nickinfos.
*
* - If that addressee has some nicks, and at least one of them is in a
* channel we are in, then we know they are online, so don't add.
* - Otherwise, if that addressee has some nicks, and we think they are
* online, add the nick that they are currently online with. This does
* mean that if they change their nick, they will appear offline for the
* duration between ISON's.
* - Otherwise, add all the nicks we know the addressee has.
*/
TQStringList getAddressees();
/**
* Given the nickname of nick that is offline (or at least not known to be online),
* returns the addressbook entry (if any) for the nick.
* @param nickname Desired nickname. Case insensitive.
* @return Addressbook entry of the nick or empty if not found.
*/
TDEABC::Addressee getOfflineNickAddressee(TQString& nickname);
private slots:
void addressbookChanged();
void nickInfoChanged(Server* server, const NickInfoPtr nickInfo);
void slotServerGroupsChanged();
void slotChannelMembersChanged(Server* server, const TQString& channelName, bool joined, bool parted, const TQString& nickname);
void slotChannelJoinedOrUnjoined(Server* server, const TQString& channelName, bool joined);
private:
/** Map of all offline nicks in the addressbook associated with this server
* or server group and their addressbook entry, indexed by lowercase nickname.
*/
OfflineNickToAddresseeMap m_offlineNickToAddresseeMap;
/// A pointer to the server we are a member of.
Server* m_server;
/// List of nicks to watch that come from addressbook.
TQStringList m_addresseesISON;
/// List from above merged with Watch List from preferences.
TQStringList m_watchList;
/// List from above but with nicks that are in joined channels eliminated.
/// There is no point in doing an ISON on such nicks because we know they are
/// online in one of the channels the user is in.
TQStringList m_ISONList;
/// If this is true, then we need to call recalculateAddressee before returning m_ISONList
bool m_ISONList_invalid;
/**
* Rebuilds list of nicks to watch whenever an addressbook change occurs
* or preferences change (whenever m_ISONLIst_invalid is true).
*/
void recalculateAddressees();
};
#endif