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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
/*
* The Mana Client
* Copyright (C) 2008-2009 The Mana World Development Team
* Copyright (C) 2009-2012 The Mana Developers
*
* This file is part of The Mana Client.
*
* 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
* 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, see <http://www.gnu.org/licenses/>.
*/
#ifndef PLAYER_RELATIONS_H
#define PLAYER_RELATIONS_H
#include <list>
#include <map>
#include <string>
#include <vector>
class Being;
struct PlayerRelation
{
static const unsigned int EMOTE = (1 << 0);
static const unsigned int SPEECH_FLOAT = (1 << 1);
static const unsigned int SPEECH_LOG = (1 << 2);
static const unsigned int WHISPER = (1 << 3);
static const unsigned int TRADE = (1 << 4);
/**
* There are four types of relations:
* NEUTRAL, FRIEND, DISREGARDED, and IGNORED.
*/
static const unsigned int RELATIONS_NR = 4;
static const unsigned int RELATION_PERMISSIONS[RELATIONS_NR];
static const unsigned int DEFAULT = EMOTE
| SPEECH_FLOAT
| SPEECH_LOG
| WHISPER
| TRADE;
enum Relation {
NEUTRAL = 0,
FRIEND = 1,
DISREGARDED = 2,
IGNORED = 3
};
PlayerRelation(Relation relation);
Relation mRelation; // bitmask for all of the above
};
/**
* Ignore strategy: describes how we should handle ignores.
*/
class PlayerIgnoreStrategy
{
public:
std::string mDescription;
std::string mShortName;
virtual ~PlayerIgnoreStrategy() = default;
/**
* Handle the ignoring of the indicated action by the indicated player.
*/
virtual void ignore(Being *being, unsigned int flags) = 0;
};
class PlayerRelationsListener
{
public:
PlayerRelationsListener() = default;
virtual ~PlayerRelationsListener() = default;
virtual void updatedPlayer(const std::string &name) = 0;
};
/**
* Player relations class, represents any particular relations and/or
* preferences the user of the local client has wrt other players (identified
* by std::string).
*/
class PlayerRelationsManager
{
public:
PlayerRelationsManager();
~PlayerRelationsManager();
/**
* Initialise player relations manager (load config file etc.)
*/
void init();
/**
* Load configuration from our config file, or substitute defaults.
*/
void load();
/**
* Save configuration to our config file.
*/
void store();
/**
* Determines whether the player in question is being ignored, filtered by
* the specified flags.
*/
unsigned int checkPermissionSilently(const std::string &player_name,
unsigned int flags);
/**
* Tests whether the player in question is being ignored for any of the
* actions in the specified flags. If so, trigger appropriate side effects
* if requested by the player.
*/
bool hasPermission(Being *being, unsigned int flags);
bool hasPermission(const std::string &being, unsigned int flags);
/**
* Updates the relationship with this player.
*/
void setRelation(const std::string &name,
PlayerRelation::Relation relation);
/**
* Updates the relationship with this player.
*/
PlayerRelation::Relation getRelation(const std::string &name) const;
/**
* Deletes the information recorded for a player.
*/
void removePlayer(const std::string &name);
/**
* Retrieves the default permissions.
*/
unsigned int getDefault() const;
/**
* Sets the default permissions.
*/
void setDefault(unsigned int permissions);
/**
* Retrieves all known player ignore strategies.
*
* The player ignore strategies are allocated statically and must not be
* deleted.
*/
std::vector<PlayerIgnoreStrategy *> *getPlayerIgnoreStrategies();
/**
* Return the current player ignore strategy.
*
* \return A player ignore strategy, or NULL
*/
PlayerIgnoreStrategy *getPlayerIgnoreStrategy() const
{
return mIgnoreStrategy;
}
/**
* Sets the strategy to call when ignoring players.
*/
void setPlayerIgnoreStrategy(PlayerIgnoreStrategy *strategy)
{
mIgnoreStrategy = strategy;
}
/**
* For a given ignore strategy short name, find the appropriate index in
* the ignore strategies vector.
*
* \param shortName The short name of the ignore strategy to look up
* \return The appropriate index, or -1
*/
int getPlayerIgnoreStrategyIndex(const std::string &shortName);
/**
* Retrieves a sorted vector of all players for which we have any relations
* recorded.
*/
std::vector<std::string> *getPlayers() const;
/**
* Removes all recorded player info.
*/
void clear();
/**
* Do we persist our `ignore' setup?
*/
bool getPersistIgnores() const { return mPersistIgnores; }
/**
* Change the `ignore persist' flag.
*
* @param value Whether to persist ignores
*/
void setPersistIgnores(bool value) { mPersistIgnores = value; }
void addListener(PlayerRelationsListener *listener)
{
mListeners.push_back(listener);
}
void removeListener(PlayerRelationsListener *listener)
{
mListeners.remove(listener);
}
private:
void signalUpdate(const std::string &name);
bool mPersistIgnores; // If NOT set, we delete the ignored data upon reloading
unsigned int mDefaultPermissions;
PlayerIgnoreStrategy *mIgnoreStrategy;
std::map<std::string, PlayerRelation *> mRelations;
std::list<PlayerRelationsListener *> mListeners;
std::vector<PlayerIgnoreStrategy *> mIgnoreStrategies;
};
extern PlayerRelationsManager player_relations; // singleton representation of player relations
#endif // PLAYER_RELATIONS_H
|
