Entity.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006-2010 Jacek Sieka, arnetheduck on gmail point com
 *
 * 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.
 */

#ifndef ADCHPP_ENTITY_H
#define ADCHPP_ENTITY_H

#include "forward.h"
#include "Buffer.h"
#include "AdcCommand.h"
#include "Plugin.h"
#include "CID.h"

namespace adchpp {

class ADCHPP_VISIBLE Entity : private boost::noncopyable {
public:
    enum State {
        STATE_PROTOCOL,
        STATE_IDENTIFY,
        STATE_VERIFY,
        STATE_NORMAL,
        STATE_DATA
    };

    enum Flag {
        FLAG_BOT = 0x01,
        FLAG_REGISTERED = 0x02,
        FLAG_OP = 0x04,
        FLAG_SU = 0x08,
        FLAG_OWNER = 0x10,
        FLAG_HUB = 0x20,
        FLAG_HIDDEN = 0x40,
        MASK_CLIENT_TYPE = FLAG_BOT | FLAG_REGISTERED | FLAG_OP | FLAG_SU | FLAG_OWNER | FLAG_HUB | FLAG_HIDDEN,

        FLAG_PASSWORD = 0x100,

        FLAG_EXT_AWAY = 0x200,

        FLAG_OK_IP = 0x400,

        FLAG_GHOST = 0x800
    };


    Entity(uint32_t sid_) : sid(sid_), state(STATE_PROTOCOL) { }

    void send(const AdcCommand& cmd) { send(cmd.getBuffer()); }
    virtual void send(const BufferPtr& cmd) = 0;

    ADCHPP_DLL virtual void inject(AdcCommand& cmd);

    ADCHPP_DLL const std::string& getField(const char* name) const;
    ADCHPP_DLL bool hasField(const char* name) const;
    ADCHPP_DLL void setField(const char* name, const std::string& value);

    ADCHPP_DLL bool getAllFields(AdcCommand& cmd) const throw();
    ADCHPP_DLL const BufferPtr& getINF() const;

    ADCHPP_DLL bool addSupports(uint32_t feature);
    ADCHPP_DLL StringList getSupportList() const;
    ADCHPP_DLL bool hasSupport(uint32_t feature) const;
    ADCHPP_DLL bool removeSupports(uint32_t feature);

    ADCHPP_DLL const BufferPtr& getSUP() const;

    uint32_t getSID() const { return sid; }

    ADCHPP_DLL bool isFiltered(const std::string& features) const;

    ADCHPP_DLL void updateFields(const AdcCommand& cmd);
    ADCHPP_DLL void updateSupports(const AdcCommand& cmd) throw();

    ADCHPP_DLL void setPluginData(const PluginDataHandle& handle, void* data) throw();

    ADCHPP_DLL void* getPluginData(const PluginDataHandle& handle) const throw();

    ADCHPP_DLL void clearPluginData(const PluginDataHandle& handle) throw();

    const CID& getCID() const { return cid; }
    void setCID(const CID& cid_) { cid = cid_; }

    State getState() const { return state; }
    void setState(State state_) { state = state_; }

    bool isSet(size_t aFlag) const { return flags.isSet(aFlag); }
    bool isAnySet(size_t aFlag) const { return flags.isAnySet(aFlag); }
    ADCHPP_DLL void setFlag(size_t aFlag);
    ADCHPP_DLL void unsetFlag(size_t aFlag);

    ADCHPP_DLL virtual void disconnect(Util::Reason reason) = 0;

    ADCHPP_DLL virtual size_t getQueuedBytes() const;

    ADCHPP_DLL virtual time_t getOverflow() const;

protected:
    virtual ~Entity();

    typedef std::map<PluginDataHandle, void*> PluginDataMap;

    CID cid;
    uint32_t sid;
    Flags flags;
    State state;

    std::vector<uint32_t> supports;

    std::vector<uint32_t> filters;

    FieldMap fields;

    PluginDataMap pluginData;

    mutable BufferPtr INF;

    mutable BufferPtr SUP;
};

}

#endif /* ADCHPP_ENTITY_H */