summaryrefslogtreecommitdiffstats
blob: 0dcccd9dd49ba90f7f118edcb747d65bd31d2675 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/*
 * Copyright (c) 2010-2013 Kevin Smith
 * Licensed under the GNU General Public License v3.
 * See Documentation/Licenses/GPLv3.txt for more information.
 */

#pragma once

#include <Swiften/JID/JID.h>
#include <Swiften/Base/API.h>
#include <string>
#include <Swiften/Elements/Message.h>
#include <Swiften/Elements/Presence.h>
#include <Swiften/Elements/MUCOccupant.h>
#include <Swiften/MUC/MUCRegistry.h>
#include <Swiften/Elements/MUCOwnerPayload.h>
#include <Swiften/Elements/MUCAdminPayload.h>
#include <Swiften/Elements/Form.h>

#include <boost/shared_ptr.hpp>
#include <Swiften/Base/boost_bsignals.h>
#include <boost/signals/connection.hpp>

#include <map>

namespace Swift {
	class StanzaChannel;
	class IQRouter;
	class DirectedPresenceSender;

	class SWIFTEN_API MUC {
		public:
			typedef boost::shared_ptr<MUC> ref;

			enum JoinResult { JoinSucceeded, JoinFailed };
			enum LeavingType { LeavePart, LeaveKick, LeaveBan, LeaveDestroy, LeaveNotMember, Disconnect };

		public:
			virtual ~MUC();

			/**
			 * Returns the (bare) JID of the MUC.
			 */
			virtual JID getJID() const = 0;

			/**
			 * Returns if the room is unlocked and other people can join the room.
			 * @return True if joinable by others; false otherwise.
			 */
			virtual bool isUnlocked() const = 0;

			virtual void joinAs(const std::string &nick) = 0;
			virtual void joinWithContextSince(const std::string &nick, const boost::posix_time::ptime& since) = 0;
			/*virtual void queryRoomInfo(); */
			/*virtual void queryRoomItems(); */
			/*virtual std::string getCurrentNick() = 0; */
			virtual std::map<std::string, MUCOccupant> getOccupants() const = 0;
			virtual void part() = 0;
			/*virtual void handleIncomingMessage(Message::ref message) = 0; */
			/** Expose public so it can be called when e.g. user goes offline */
			virtual void handleUserLeft(LeavingType) = 0;
			/** Get occupant information*/
			virtual const MUCOccupant& getOccupant(const std::string& nick) = 0;
			virtual bool hasOccupant(const std::string& nick) = 0;
			virtual void kickOccupant(const JID& jid) = 0;
			virtual void changeOccupantRole(const JID& jid, MUCOccupant::Role role) = 0;
			virtual void requestAffiliationList(MUCOccupant::Affiliation) = 0;
			virtual void changeAffiliation(const JID& jid, MUCOccupant::Affiliation affiliation) = 0;
			virtual void changeSubject(const std::string& subject) = 0;
			virtual void requestConfigurationForm() = 0;
			virtual void configureRoom(Form::ref) = 0;
			virtual void cancelConfigureRoom() = 0;
			virtual void destroyRoom() = 0;
			/** Send an invite for the person to join the MUC */
			virtual void invitePerson(const JID& person, const std::string& reason = "", bool isImpromptu = false, bool isReuseChat = false) = 0;
			virtual void setCreateAsReservedIfNew() = 0;
			virtual void setPassword(const boost::optional<std::string>& password) = 0;

		public:
			boost::signal<void (const std::string& /*nick*/)> onJoinComplete;
			boost::signal<void (ErrorPayload::ref)> onJoinFailed;
			boost::signal<void (ErrorPayload::ref, const JID&, MUCOccupant::Role)> onRoleChangeFailed;
			boost::signal<void (ErrorPayload::ref, const JID&, MUCOccupant::Affiliation)> onAffiliationChangeFailed;
			boost::signal<void (ErrorPayload::ref)> onConfigurationFailed;
			boost::signal<void (ErrorPayload::ref)> onAffiliationListFailed;
			boost::signal<void (Presence::ref)> onOccupantPresenceChange;
			boost::signal<void (const std::string&, const MUCOccupant& /*now*/, const MUCOccupant::Role& /*old*/)> onOccupantRoleChanged;
			boost::signal<void (const std::string&, const MUCOccupant::Affiliation& /*new*/, const MUCOccupant::Affiliation& /*old*/)> onOccupantAffiliationChanged;
			boost::signal<void (const MUCOccupant&)> onOccupantJoined;
			boost::signal<void (const MUCOccupant&, LeavingType, const std::string& /*reason*/)> onOccupantLeft;
			boost::signal<void (Form::ref)> onConfigurationFormReceived;
			boost::signal<void (MUCOccupant::Affiliation, const std::vector<JID>&)> onAffiliationListReceived;
			boost::signal<void ()> onUnlocked;
			/* boost::signal<void (const MUCInfo&)> onInfoResult; */
			/* boost::signal<void (const blah&)> onItemsResult; */

	};
}