libtransport.git Changeset - 599469670eec

Changeset - 599469670eec

Parent rev.

Child rev.

[Not reviewed]

0 5 0

HanzZ - 15 years ago 2011-02-15 15:48:52
hanzz.k@gmail.com

Docs

5 files changed with 98 insertions and 14 deletions:

include/transport/config.h

include/transport/sqlite3backend.h

include/transport/storagebackend.h

include/transport/transport.h

src/sqlite3backend.cpp

0 comments (0 inline, 0 general)

include/transport/config.h

➞

Show inline comments

 /**
  * libtransport -- C++ library for easy XMPP Transports development
+ *
  * Copyright (C) 2011, Jan Kaluza <hanzz.k@gmail.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., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  */
 #pragma once
 #include <boost/program_options.hpp>
 #include <boost/foreach.hpp>
 #include <boost/format.hpp>
 #include <boost/algorithm/string.hpp>
 #include <boost/assign.hpp>
 #include <boost/bind.hpp>
 #include <boost/signal.hpp>
 #define CONFIG_STRING(PTR, KEY) (*PTR)[KEY].as<std::string>()
 #define CONFIG_INT(PTR, KEY) (*PTR)[KEY].as<int>()
 #define CONFIG_BOOL(PTR, KEY) (*PTR)[KEY].as<bool>()
 #define CONFIG_LIST(PTR, KEY) (*PTR)[KEY].as<std::list<std::string> >()
 namespace Transport {
 typedef boost::program_options::variables_map Variables;
 /// Class used to load.
 /// Represents config file.
 /// It's used to load config file and allows others parts of libtransport to be configured
 /// properly. Config files are text files which use "ini" format. Variables are divided into multiple
 /// sections. Every class is configurable with some variables which change its behavior. Check particular
 /// class documentation to get a list of all relevant variables for that class.
 class Config {
 	public:
 		/// Constructor.
 		Config() {}
 		/// Destructor
 		virtual ~Config() {}
 		/// Loads data from config file. You can pass your extra options which will be recognized by
 		/// the parser using opts parameter.
 		/// \param configfile path to config file
 		/// \param opts extra options which will be recognized by a parser
 		bool load(const std::string &configfile, boost::program_options::options_description &opts);
 		/// Loads data from config file. This function loads only config variables needed by libtransport.
 		/// \see load(const std::string &, boost::program_options::options_description &)
 		/// \param configfile path to config file
 		bool load(const std::string &configfile);
 		/// Returns value of variable defined by key. For variables in sections you can use "section.variable" key format.
 		/// \param key config variable name
 		const boost::program_options::variable_value &operator[] (const std::string &key) {
 			return m_variables[key];
+		}
 		/// This signal is emitted when config is loaded/reloaded.
 		boost::signal<void ()> onConfigReloaded;
 	private:
 		Variables m_variables;
 };
+}

include/transport/sqlite3backend.h

➞

Show inline comments

 /**
  * libtransport -- C++ library for easy XMPP Transports development
+ *
  * Copyright (C) 2011, Jan Kaluza <hanzz.k@gmail.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., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  */
 #pragma once
 #include <string>
 #include <map>
 #include "Swiften/Swiften.h"
 #include "transport/storagebackend.h"
 #include "transport/config.h"
 #include <sqlite3.h>
 namespace Transport {
 /// Used to store transport data into SQLite3 database.
 class SQLite3Backend : public StorageBackend
+{
 	public:
 		/// Creates new SQLite3Backend instance.
 		/// \param config cofiguration, this class uses following Config values:
 		/// 	- database.database - path to SQLite3 database file, database file is created automatically
 		/// 	- service.prefix - prefix for tables created by createDatabase method
 		SQLite3Backend(Config *config);
 		/// Destructor.
 		~SQLite3Backend();
 		/// Connects to the database and creates it if it's needed. This method call createDatabase() function
 		/// automatically.
 		/// \return true if database is opened successfully.
 		bool connect();
 		/// Creates database structure.
 		/// \see connect()
 		/// \return true if database structure has been created successfully. Note that it returns True also if database structure
 		/// already exists.
 		bool createDatabase();
 		/// Stores user into database.
 		/// \param user user struct containing all information about user which have to be stored
 		void setUser(const UserInfo &user);
 		/// Gets user data from database and stores them into user reference.
 		/// \param barejid barejid of user
 		/// \param user UserInfo object where user data will be stored
 		/// \return true if user has been found in database
 		bool getUser(const std::string &barejid, UserInfo &user);
 		/// Changes users online state variable in database.
 		/// \param id id of user - UserInfo.id
 		/// \param online online state
 		void setUserOnline(long id, bool online);
 		void removeUser(long id);
 		/// Removes user and all connected data from database.
 		/// \param id id of user - UserInfo.id
 		/// \return true if user has been found in database and removed
 		bool removeUser(long id);
 		/// Returns JIDs of all buddies in user's roster.
 		/// \param id id of user - UserInfo.id
 		/// \param roster string list used to store user's roster
 		/// \return true if user has been found in database and roster has been fetched
 		bool getBuddies(long id, std::list<std::string> &roster);
 	private:
 		bool exec(const std::string &query);
 		sqlite3 *m_db;
 		Config *m_config;
 		std::string m_prefix;
 };
+}

include/transport/storagebackend.h

➞

Show inline comments

 /**
  * libtransport -- C++ library for easy XMPP Transports development
+ *
  * Copyright (C) 2011, Jan Kaluza <hanzz.k@gmail.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., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  */
 #pragma once
 #include <string>
 #include <map>
 namespace Transport {
 /// Represents all data needed to be stored in database.
 struct UserInfo {
 	long id;
 	std::string jid;
 	std::string uin;
 	std::string password;
 	std::string language;
 	std::string encoding;
 	bool vip;
 	long id;				///< id of user used as primary key in database
 	std::string jid;		///< barejid of XMPP user
 	std::string uin;		///< legacy network username
 	std::string password;	///< password for legacy network
 	std::string language;	///< user's preferred language
 	std::string encoding;	///< user's preferred encoding
 	bool vip;				///< true if user is VIP
 };
 /// Abstract class defining storage backends.
 class StorageBackend
+{
 	public:
 		/// Virtual desctructor.
 		virtual ~StorageBackend() {}
 		/// connect
 		virtual bool connect() = 0;
 		/// createDatabase
 		virtual bool createDatabase() = 0;
 		/// setUser
 		virtual void setUser(const UserInfo &user) = 0;
 		/// getuser
 		virtual bool getUser(const std::string &barejid, UserInfo &user) = 0;
 		/// setUserOnline
 		virtual void setUserOnline(long id, bool online) = 0;
 		virtual void removeUser(long id) = 0;
 		/// removeUser
 		virtual bool removeUser(long id) = 0;
 		/// getBuddies
 		virtual bool getBuddies(long id, std::list<std::string> &roster) = 0;
 		/// onStorageError
 		boost::signal<void (const std::string &statement, const std::string &error)> onStorageError;
 };
+}

include/transport/transport.h

➞

Show inline comments

 /**
  * libtransport -- C++ library for easy XMPP Transports development
+ *
  * Copyright (C) 2011, Jan Kaluza <hanzz.k@gmail.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., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  */
 #pragma once
 #include <vector>
 #include "Swiften/Swiften.h"
 #include "Swiften/Disco/GetDiscoInfoRequest.h"
 #include "Swiften/Disco/EntityCapsManager.h"
 #include "Swiften/Disco/CapsManager.h"
 #include "Swiften/Disco/CapsMemoryStorage.h"
 #include "Swiften/Presence/PresenceOracle.h"
 #include "Swiften/Network/BoostTimerFactory.h"
 #include "Swiften/Network/BoostIOServiceThread.h"
 #include <boost/bind.hpp>
 #include "transport/config.h"
 #define tr(lang,STRING)    (STRING)
 #define _(STRING)    (STRING)
 namespace Transport {
 	// typedef enum { 	CLIENT_FEATURE_ROSTERX = 2,
 	// 				CLIENT_FEATURE_XHTML_IM = 4,
 	// 				CLIENT_FEATURE_FILETRANSFER = 8,
 	// 				CLIENT_FEATURE_CHATSTATES = 16
 	// 				} SpectrumImportantFeatures;
 	//
 	class StorageBackend;
 	class DiscoInfoResponder;
 	/// Represents one transport instance.
 	/// It's used to connect
 	/// the Jabber server and provides transaction layer between Jabber server
 	/// and other classes.
 	class Component {
 		public:
 			/// Creates new Component instance.
 			/// \param loop main event loop
 			/// \param config cofiguration, this class uses following Config values:
 			/// 	- service.jid
 			/// 	- service.password
 			/// 	- service.server
 			/// 	- service.port
 			Component(Swift::EventLoop *loop, Config *config);
 			/// Component destructor.
 			~Component();
 			/// Connects the Jabber server.
 			/// \see Component()
 			void connect();
 			/// Sets disco#info features which are sent as answer to
 			/// disco#info IQ-get. This sets features of transport contact (For example "j2j.domain.tld").
 			/// \param features list of features as sent in disco#info response
 			void setTransportFeatures(std::list<std::string> &features);
 			/// Sets disco#info features which are sent as answer to
 			/// disco#info IQ-get. This sets features of legacy network buddies (For example "me\40gmail.com@j2j.domain.tld").
 			/// \param features list of features as sent in disco#info response
 			void setBuddyFeatures(std::list<std::string> &features);
 			/// Returns Jabber ID of this transport.
 			/// \return Jabber ID of this transport
 			Swift::JID &getJID() { return m_jid; }
 			boost::signal<void (const Swift::ComponentError&)> onConnectionError;
 			/// This signal is emitted when server disconnects the transport because of some error.
 			/// \param error disconnection error
 			boost::signal<void (const Swift::ComponentError &error)> onConnectionError;
 			/// This signal is emitted when transport successfully connects the server.
 			boost::signal<void ()> onConnected;
 			boost::signal<void (const std::string &)> onXMLOut;
 			boost::signal<void (const std::string &)> onXMLIn;
 			/// This signal is emitted when XML stanza is sent to server.
 			/// \param xml xml stanza
 			boost::signal<void (const std::string &xml)> onXMLOut;
 			/// This signal is emitted when XML stanza is received from server.
 			/// \param xml xml stanza
 			boost::signal<void (const std::string &xml)> onXMLIn;
 			/// This signal is emitted when presence from XMPP user (for example "user@domain.tld")
 			/// is received. It's emitted only for presences addressed to transport itself
 			/// (for example to="j2j.domain.tld").
 			/// \param presence presence data
 			boost::signal<void (Swift::Presence::ref presence)> onUserPresenceReceived;
 		private:
 			void handleConnected();
 			void handleConnectionError(const Swift::ComponentError &error);
 			void handlePresenceReceived(Swift::Presence::ref presence);
 // 			void handleMessageReceived(Swift::Message::ref message);
 			void handlePresence(Swift::Presence::ref presence);
 			void handleSubscription(Swift::Presence::ref presence);
 			void handleProbePresence(Swift::Presence::ref presence);
 			void handleDataRead(const Swift::String &data);
 			void handleDataWritten(const Swift::String &data);
 			void handleDiscoInfoResponse(boost::shared_ptr<Swift::DiscoInfo> info, Swift::ErrorPayload::ref error, const Swift::JID& jid);
 // 			void handleCapsChanged(const Swift::JID& jid);
 			Swift::BoostNetworkFactories *m_factories;
 			Swift::Component *m_component;
 			Swift::Timer::ref m_reconnectTimer;
 			Swift::BoostIOServiceThread m_boostIOServiceThread;
 			Swift::EntityCapsManager *m_entityCapsManager;
 			Swift::CapsManager *m_capsManager;
 			Swift::CapsMemoryStorage *m_capsMemoryStorage;
 			Swift::PresenceOracle *m_presenceOracle;
 			StorageBackend *m_storageBackend;
  			DiscoInfoResponder *m_discoInfoResponder;
 // 			SpectrumRegisterHandler *m_registerHandler;
 			int m_reconnectCount;
 			Config* m_config;
 			std::string m_protocol;
 			Swift::JID m_jid;
 		friend class User;
 		friend class UserRegistration;
 	};
+}

src/sqlite3backend.cpp

➞

Show inline comments

@@ @@ -38,101 +38,101 @@ SQLite3Backend::~SQLite3Backend(){ @@
 		sqlite3_close(m_db);
+	}
+}
 bool SQLite3Backend::connect() {
 	if (sqlite3_open(CONFIG_STRING(m_config, "database.database").c_str(), &m_db)) {
 		 sqlite3_close(m_db);
 		 return false;
+	}
 	return createDatabase();
+}
 bool SQLite3Backend::createDatabase() {
 	int not_exist = exec("CREATE TABLE " + m_prefix + "buddies ("
 				"  id INTEGER PRIMARY KEY NOT NULL,"
 				"  user_id int(10) NOT NULL,"
 				"  uin varchar(255) NOT NULL,"
 				"  subscription varchar(20) NOT NULL,"
 				"  nickname varchar(255) NOT NULL,"
 				"  groups varchar(255) NOT NULL,"
 				"  flags int(4) NOT NULL DEFAULT '0'"
 				");");
 	if (not_exist) {
 		exec("CREATE UNIQUE INDEX IF NOT EXISTS user_id ON " + m_prefix + "buddies (user_id, uin);");
 		exec("CREATE TABLE IF NOT EXISTS " + m_prefix + "buddies_settings ("
 					"  user_id int(10) NOT NULL,"
 					"  buddy_id int(10) NOT NULL,"
 					"  var varchar(50) NOT NULL,"
 					"  type int(4) NOT NULL,"
 					"  value varchar(255) NOT NULL,"
 					"  PRIMARY KEY (buddy_id, var)"
 					");");
 		exec("CREATE INDEX IF NOT EXISTS user_id02 ON " + m_prefix + "buddies_settings (user_id);");
 		exec("CREATE TABLE IF NOT EXISTS " + m_prefix + "users ("
 					"  id INTEGER PRIMARY KEY NOT NULL,"
 					"  jid varchar(255) NOT NULL,"
 					"  uin varchar(4095) NOT NULL,"
 					"  password varchar(255) NOT NULL,"
 					"  language varchar(25) NOT NULL,"
 					"  encoding varchar(50) NOT NULL DEFAULT 'utf8',"
 					"  last_login datetime,"
 					"  vip int(1) NOT NULL DEFAULT '0',"
 					"  online int(1) NOT NULL DEFAULT '0'"
 					");");
 		exec("CREATE UNIQUE INDEX IF NOT EXISTS jid ON " + m_prefix + "users (jid);");
 		exec("CREATE TABLE " + m_prefix + "users_settings ("
 					"  user_id int(10) NOT NULL,"
 					"  var varchar(50) NOT NULL,"
 					"  type int(4) NOT NULL,"
 					"  value varchar(255) NOT NULL,"
 					"  PRIMARY KEY (user_id, var)"
 					");");
 		exec("CREATE INDEX IF NOT EXISTS user_id03 ON " + m_prefix + "users_settings (user_id);");
 		exec("CREATE TABLE IF NOT EXISTS " + m_prefix + "db_version ("
 			"  ver INTEGER NOT NULL DEFAULT '3'"
 			");");
 		exec("REPLACE INTO " + m_prefix + "db_version (ver) values(3)");
+	}
 	return true;
+}
 bool SQLite3Backend::exec(const std::string &query) {
 	char *errMsg = 0;
 	int rc = sqlite3_exec(m_db, query.c_str(), NULL, 0, &errMsg);
 	if (rc != SQLITE_OK) {
 		onStorageError(query, errMsg);
 		sqlite3_free(errMsg);
 		return false;
+	}
 	return true;
+}
 void SQLite3Backend::setUser(const UserInfo &user) {
+}
 bool SQLite3Backend::getUser(const std::string &barejid, UserInfo &user) {
 	return true;
+}
 void SQLite3Backend::setUserOnline(long id, bool online) {
+}
 bool SQLite3Backend::getBuddies(long id, std::list<std::string> &roster) {
 	return true;
+}
-void SQLite3Backend::removeUser(long id) {
+bool SQLite3Backend::removeUser(long id) {
+}
+}

0 comments (0 inline, 0 general)