cyphesis/tools/AdminClient.h
Al Riddoch 0f44eff410 2006-12-26 Al Riddoch <alriddoch@zepler.org>
* client/BaseClient.cpp, client/BaseClient.h,
	  client/ClientConnection.cpp, common/AtlasFileLoader.cpp,
	  common/AtlasFileLoader.h, common/BaseEntity.cpp, common/BaseEntity.h,
	  common/Property.h, common/accountbase.cpp, common/accountbase.h,
	  rulesets/ActivePropertyFactory.h,
	  rulesets/ActivePropertyFactory_impl.h, rulesets/Area.cpp,
	  rulesets/Area.h, rulesets/AreaProperty.cpp, rulesets/AreaProperty.h,
	  rulesets/BaseMind.cpp, rulesets/BaseMind.h, server/Account.cpp,
	  server/Admin.cpp, server/Admin.h, server/ArithmeticFactory.h,
	  tests/Makefile.am, tools/AdminClient.cpp, tools/AdminClient.h,
	  tools/cycmd.cpp: Add inline documentation.

	* rulesets/ActivePropertyFactory.h: Use handler function pointer
	  typedef for readability.

	* rulesets/AreaProperty.cpp, rulesets/AreaProperty.h: Fix PropertyBase
	  overriding by adding const to the right methods.
2006-12-26 14:30:42 +00:00

111 lines
3.7 KiB
C++

// Cyphesis Online RPG Server and AI Engine
// Copyright (C) 2001 Alistair Riddoch
//
// 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
// $Id: AdminClient.h,v 1.13 2006-12-26 14:30:44 alriddoch Exp $
#ifndef TOOLS_ADMIN_CLIENT_H
#define TOOLS_ADMIN_CLIENT_H
#include "common/globals.h"
#include <Atlas/Objects/Decoder.h>
#include <Atlas/Objects/ObjectsFwd.h>
#include <skstream/skstream_unix.h>
#include <iostream>
#include <set>
#include <cstdio>
namespace Atlas {
class Codec;
namespace Objects { class ObjectsEncoder; }
}
typedef std::multimap<std::string, std::pair<std::pair<std::string, std::string>, Atlas::Message::MapType> > RuleWaitList;
/// \brief Client class to encapsulate functionality of an administrative client
class AdminClient : public Atlas::Objects::ObjectsDecoder
{
private:
/// \brief Flags used to track replies from the server
bool error_flag, reply_flag, login_flag;
/// \brief File descriptor used to communicate with the server
int cli_fd;
/// \brief Atlas encoder used to send to the server
Atlas::Objects::ObjectsEncoder * encoder;
/// \brief Atlas codec used to communicate with the server
Atlas::Codec * codec;
/// \brief iostream used to communicate with the server
basic_socket_stream * ios;
/// \brief Password used to log into the server
std::string password;
/// \brief Username used to log into the server
std::string username;
/// \brief Account identifier returned after successful login
std::string accountId;
/// \brief Stored error message from the last received Error operation
std::string m_errorMessage;
/// \brief Flag set to indicate that the task is complete, and should exit
bool exit;
/// \brief Store of rules which can't be uploaded until their parent has
/// been uploaded
RuleWaitList m_waitingRules;
/// \brief List of names of rules already uploaded
std::set<std::string> m_uploadedRules;
void output(const Atlas::Message::Element & item, bool recurse = true);
protected:
void objectArrived(const Atlas::Objects::Root &);
void infoArrived(const Atlas::Objects::Operation::RootOperation &);
void errorArrived(const Atlas::Objects::Operation::RootOperation &);
int negotiate();
void waitForInfo();
int checkRule(const std::string & id);
public:
AdminClient();
~AdminClient();
void send(const Atlas::Objects::Operation::RootOperation &);
int connect(const std::string & host);
int connect_unix(const std::string & host);
int login();
void loop();
void poll();
void getLogin();
int uploadRule(const std::string & id, const std::string & set,
const Atlas::Message::MapType &);
/// \brief Set the password used to log into the server
void setPassword(const std::string & passwd) {
password = passwd;
}
/// \brief Set the username used to log into the server
void setUsername(const std::string & uname) {
username = uname;
}
void report();
};
#endif // TOOLS_ADMIN_CLIENT_H