servers.h

Go to the documentation of this file.

/*
 *
 * (C) 2003-2013 Anope Team
 * Contact us at team@anope.org
 *
 * Please read COPYING and README for further details.
 *
 * Based on the original code of Epona by Lara.
 * Based on the original code of Services by Andy Church.
 *
 */

#ifndef SERVERS_H
#define SERVERS_H

#include "services.h"
#include "anope.h"
#include "extensible.h"

/* Anope. We are at the top of the server tree, our uplink is
 * almost always me->GetLinks()[0]. We never have an uplink. */
extern CoreExport Server *Me;

namespace Servers
{
        /* Retrieves the next free TS6 UID or SID */
        extern CoreExport const Anope::string TS6_UID_Retrieve();
        extern CoreExport const Anope::string TS6_SID_Retrieve();

        /* Gets our uplink. Note we don't actually have an "uplink", this is just
         * the only server whose uplink *is* Me that is not a juped server.
         * @return Our uplink, or NULL if not uplinked to anything
         */
        extern CoreExport Server* GetUplink();

        /* CAPAB/PROTOCTL given by the uplink */
        extern CoreExport std::set<Anope::string> Capab;
}

class CoreExport Server : public Extensible
{
 private:
        /* Server name */
        Anope::string name;
        /* Hops between services and server */
        unsigned int hops;
        /* Server description */
        Anope::string description;
        /* Server ID */
        Anope::string sid;
        /* Links for this server */
        std::vector<Server *> links;
        /* Uplink for this server */
        Server *uplink;
        /* Server is syncing */
        bool syncing;
        /* The server is juped */
        bool juped;

        /* Reason this server was quit */
        Anope::string quit_reason;

 public:
        Server(Server *uplink, const Anope::string &name, unsigned hops, const Anope::string &description, const Anope::string &sid = "", bool jupe = false);

 private:
        ~Server();

 public:
        /* Number of users on the server */
        unsigned users;

        void Delete(const Anope::string &reason);

        const Anope::string &GetName() const;

        unsigned GetHops() const;

        void SetDescription(const Anope::string &desc);

        const Anope::string &GetDescription() const;

        void SetSID(const Anope::string &sid);

        const Anope::string &GetSID() const;

        const std::vector<Server *> &GetLinks() const;

        Server *GetUplink();

        void AddLink(Server *s);

        void DelLink(Server *s);

        void Sync(bool sync_links);

        bool IsSynced() const;

        void Unsync();

        bool IsULined() const;

        bool IsJuped() const;

        void Notice(const BotInfo *source, const Anope::string &message);

        static Server *Find(const Anope::string &name, Server *s = NULL);
};

#endif // SERVERS_H