summaryrefslogtreecommitdiffstats
blob: a54c89e4604d092f646e956167797308e52fc7fe (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
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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
/*
 * Copyright (c) 2010-2016 Isode Limited.
 * All rights reserved.
 * See the COPYING file for more information.
 */

#include <Swift/Controllers/Chat/ChatControllerBase.h>

#include <map>
#include <memory>
#include <sstream>

#include <boost/algorithm/string.hpp>
#include <boost/bind.hpp>
#include <boost/date_time/posix_time/posix_time.hpp>
#include <boost/numeric/conversion/cast.hpp>

#include <Swiften/Avatars/AvatarManager.h>
#include <Swiften/Base/Path.h>
#include <Swiften/Base/format.h>
#include <Swiften/Client/StanzaChannel.h>
#include <Swiften/Disco/EntityCapsProvider.h>
#include <Swiften/Elements/Delay.h>
#include <Swiften/Elements/MUCInvitationPayload.h>
#include <Swiften/Elements/MUCUserPayload.h>
#include <Swiften/Queries/Requests/GetSecurityLabelsCatalogRequest.h>

#include <Swift/Controllers/Chat/AutoAcceptMUCInviteDecider.h>
#include <Swift/Controllers/Chat/ChatMessageParser.h>
#include <Swift/Controllers/HighlightManager.h>
#include <Swift/Controllers/Highlighter.h>
#include <Swift/Controllers/Intl.h>
#include <Swift/Controllers/UIEvents/JoinMUCUIEvent.h>
#include <Swift/Controllers/UIEvents/UIEventStream.h>
#include <Swift/Controllers/UIInterfaces/ChatWindow.h>
#include <Swift/Controllers/UIInterfaces/ChatWindowFactory.h>
#include <Swift/Controllers/XMPPEvents/EventController.h>
#include <Swift/Controllers/XMPPEvents/MUCInviteEvent.h>

namespace Swift {

ChatControllerBase::ChatControllerBase(const JID& self, StanzaChannel* stanzaChannel, IQRouter* iqRouter, ChatWindowFactory* chatWindowFactory, const JID &toJID, PresenceOracle* presenceOracle, AvatarManager* avatarManager, bool useDelayForLatency, UIEventStream* eventStream, EventController* eventController, TimerFactory* timerFactory, EntityCapsProvider* entityCapsProvider, HistoryController* historyController, MUCRegistry* mucRegistry, HighlightManager* highlightManager, std::shared_ptr<ChatMessageParser> chatMessageParser, AutoAcceptMUCInviteDecider* autoAcceptMUCInviteDecider) : selfJID_(self), stanzaChannel_(stanzaChannel), iqRouter_(iqRouter), chatWindowFactory_(chatWindowFactory), toJID_(toJID), labelsEnabled_(false), presenceOracle_(presenceOracle), avatarManager_(avatarManager), useDelayForLatency_(useDelayForLatency), eventController_(eventController), timerFactory_(timerFactory), entityCapsProvider_(entityCapsProvider), historyController_(historyController), mucRegistry_(mucRegistry), chatMessageParser_(chatMessageParser), autoAcceptMUCInviteDecider_(autoAcceptMUCInviteDecider), eventStream_(eventStream) {
    chatWindow_ = chatWindowFactory_->createChatWindow(toJID, eventStream);
    chatWindow_->onAllMessagesRead.connect(boost::bind(&ChatControllerBase::handleAllMessagesRead, this));
    chatWindow_->onSendMessageRequest.connect(boost::bind(&ChatControllerBase::handleSendMessageRequest, this, _1, _2));
    chatWindow_->onLogCleared.connect(boost::bind(&ChatControllerBase::handleLogCleared, this));
    entityCapsProvider_->onCapsChanged.connect(boost::bind(&ChatControllerBase::handleCapsChanged, this, _1));
    highlighter_ = highlightManager->createHighlighter();
    ChatControllerBase::setOnline(stanzaChannel->isAvailable() && iqRouter->isAvailable());
    createDayChangeTimer();
}

ChatControllerBase::~ChatControllerBase() {
    if (dateChangeTimer_) {
        dateChangeTimer_->onTick.disconnect(boost::bind(&ChatControllerBase::handleDayChangeTick, this));
        dateChangeTimer_->stop();
    }

    delete highlighter_;
    delete chatWindow_;
}

void ChatControllerBase::handleLogCleared() {
    cancelReplaces();
}

ChatWindow* ChatControllerBase::detachChatWindow() {
    ChatWindow* chatWindow = chatWindow_;
    chatWindow_ = nullptr;
    return chatWindow;
}

void ChatControllerBase::handleCapsChanged(const JID& jid) {
    if (jid.compare(toJID_, JID::WithoutResource) == 0) {
        handleBareJIDCapsChanged(jid);
    }
}

void ChatControllerBase::setCanStartImpromptuChats(bool supportsImpromptu) {
    if (chatWindow_) {
        chatWindow_->setCanInitiateImpromptuChats(supportsImpromptu);
    }
}

void ChatControllerBase::createDayChangeTimer() {
    if (timerFactory_) {
        boost::posix_time::ptime now = boost::posix_time::second_clock::local_time();
        boost::posix_time::ptime midnight(now.date() + boost::gregorian::days(1));
        int millisecondsUntilMidnight = boost::numeric_cast<int>((midnight - now).total_milliseconds());
        dateChangeTimer_ = timerFactory_->createTimer(millisecondsUntilMidnight);
        dateChangeTimer_->onTick.connect(boost::bind(&ChatControllerBase::handleDayChangeTick, this));
        dateChangeTimer_->start();
    }
}

void ChatControllerBase::handleDayChangeTick() {
    dateChangeTimer_->stop();
    boost::posix_time::ptime now = boost::posix_time::second_clock::local_time();
    chatWindow_->addSystemMessage(chatMessageParser_->parseMessageBody(str(format(QT_TRANSLATE_NOOP("", "The day is now %1%")) % std::string(boost::posix_time::to_iso_extended_string(now)).substr(0,10))), ChatWindow::DefaultDirection);
    lastWasPresence_ = false;
    dayTicked();
    createDayChangeTimer();
}

void ChatControllerBase::setEnabled(bool enabled) {
    chatWindow_->setOnline(enabled);
    chatWindow_->setCanInitiateImpromptuChats(false);
}

void ChatControllerBase::setOnline(bool online) {
    setEnabled(online);
}

JID ChatControllerBase::getBaseJID() {
    return JID(toJID_.toBare());
}

void ChatControllerBase::setAvailableServerFeatures(std::shared_ptr<DiscoInfo> info) {
    if (iqRouter_->isAvailable() && info->hasFeature(DiscoInfo::SecurityLabelsCatalogFeature)) {
        GetSecurityLabelsCatalogRequest::ref request = GetSecurityLabelsCatalogRequest::create(getBaseJID(), iqRouter_);
        request->onResponse.connect(boost::bind(&ChatControllerBase::handleSecurityLabelsCatalogResponse, this, _1, _2));
        request->send();
    } else {
        chatWindow_->setSecurityLabelsEnabled(false);
        labelsEnabled_ = false;
    }
}

void ChatControllerBase::handleAllMessagesRead() {
    if (!unreadMessages_.empty()) {
        targetedUnreadMessages_.clear();
        for (std::shared_ptr<StanzaEvent> stanzaEvent : unreadMessages_) {
            stanzaEvent->conclude();
        }
        unreadMessages_.clear();
        updateMessageCount();
    }
}

int ChatControllerBase::getUnreadCount() {
    return boost::numeric_cast<int>(targetedUnreadMessages_.size());
}

void ChatControllerBase::handleSendMessageRequest(const std::string &body, bool isCorrectionMessage) {
    if (!stanzaChannel_->isAvailable() || body.empty()) {
        return;
    }
    std::shared_ptr<Message> message(new Message());
    message->setTo(toJID_);
    message->setType(Swift::Message::Chat);
    message->setBody(body);
    if (labelsEnabled_) {
        if (!isCorrectionMessage) {
            lastLabel_ = chatWindow_->getSelectedSecurityLabel();
        }
        SecurityLabelsCatalog::Item labelItem = lastLabel_;
        if (labelItem.getLabel()) {
            message->addPayload(labelItem.getLabel());
        }
    }
    preSendMessageRequest(message);

    boost::posix_time::ptime now = boost::posix_time::microsec_clock::universal_time();
    if (useDelayForLatency_) {
        message->addPayload(std::make_shared<Delay>(now, selfJID_));
    }
    if (isCorrectionMessage) {
        message->addPayload(std::shared_ptr<Replace> (new Replace(lastSentMessageStanzaID_)));
    }
    message->setID(lastSentMessageStanzaID_ = idGenerator_.generateID());
    stanzaChannel_->sendMessage(message);
    postSendMessage(message->getBody().get(), std::dynamic_pointer_cast<Stanza>(message));
    onActivity(message->getBody().get());

#ifdef SWIFT_EXPERIMENTAL_HISTORY
    logMessage(body, selfJID_, toJID_, now, false);
#endif
}

void ChatControllerBase::handleSecurityLabelsCatalogResponse(std::shared_ptr<SecurityLabelsCatalog> catalog, ErrorPayload::ref error) {
    if (catalog && !error) {
        if (catalog->getItems().size() == 0) {
            chatWindow_->setSecurityLabelsEnabled(false);
            labelsEnabled_ = false;
        } else {
            labelsEnabled_ = true;
            chatWindow_->setAvailableSecurityLabels(catalog->getItems());
            chatWindow_->setSecurityLabelsEnabled(true);
        }
    } else {
        labelsEnabled_ = false;
        chatWindow_->setSecurityLabelsError();
    }
}

void ChatControllerBase::showChatWindow() {
    chatWindow_->show();
}

void ChatControllerBase::activateChatWindow() {
    chatWindow_->activate();
}

bool ChatControllerBase::hasOpenWindow() const {
    return chatWindow_ && chatWindow_->isVisible();
}

ChatWindow::ChatMessage ChatControllerBase::buildChatWindowChatMessage(const std::string& message, bool senderIsSelf, const HighlightAction& fullMessageHighlightAction) {
    ChatWindow::ChatMessage chatMessage;
    chatMessage = chatMessageParser_->parseMessageBody(message, highlighter_->getNick(), senderIsSelf);
    chatMessage.setFullMessageHighlightAction(fullMessageHighlightAction);
    return chatMessage;
}

void ChatControllerBase::handleHighlightActions(const ChatWindow::ChatMessage& chatMessage) {
    std::set<std::string> playedSounds;
    if (chatMessage.getFullMessageHighlightAction().playSound()) {
        highlighter_->handleHighlightAction(chatMessage.getFullMessageHighlightAction());
        playedSounds.insert(chatMessage.getFullMessageHighlightAction().getSoundFile());
    }
    for (std::shared_ptr<ChatWindow::ChatMessagePart> part : chatMessage.getParts()) {
        std::shared_ptr<ChatWindow::ChatHighlightingMessagePart> highlightMessage = std::dynamic_pointer_cast<ChatWindow::ChatHighlightingMessagePart>(part);
        if (highlightMessage && highlightMessage->action.playSound()) {
            if (playedSounds.find(highlightMessage->action.getSoundFile()) == playedSounds.end()) {
                highlighter_->handleHighlightAction(highlightMessage->action);
                playedSounds.insert(highlightMessage->action.getSoundFile());
            }
        }
    }
}

void ChatControllerBase::updateMessageCount() {
    chatWindow_->setUnreadMessageCount(boost::numeric_cast<int>(unreadMessages_.size()));
    onUnreadCountChanged();
}

std::string ChatControllerBase::addMessage(const ChatWindow::ChatMessage& chatMessage, const std::string& senderName, bool senderIsSelf, const std::shared_ptr<SecurityLabel> label, const boost::filesystem::path& avatarPath, const boost::posix_time::ptime& time) {
    if (chatMessage.isMeCommand()) {
        return chatWindow_->addAction(chatMessage, senderName, senderIsSelf, label, pathToString(avatarPath), time);
    }
    else {
        return chatWindow_->addMessage(chatMessage, senderName, senderIsSelf, label, pathToString(avatarPath), time);
    }
}

void ChatControllerBase::replaceMessage(const ChatWindow::ChatMessage& chatMessage, const std::string& id, const boost::posix_time::ptime& time) {
    if (chatMessage.isMeCommand()) {
        chatWindow_->replaceWithAction(chatMessage, id, time);
    }
    else {
        chatWindow_->replaceMessage(chatMessage, id, time);
    }
}

bool ChatControllerBase::isFromContact(const JID& from) {
    return from.toBare() == toJID_.toBare();
}

void ChatControllerBase::handleIncomingMessage(std::shared_ptr<MessageEvent> messageEvent) {
    preHandleIncomingMessage(messageEvent);
    if (messageEvent->isReadable() && !messageEvent->getConcluded()) {
        unreadMessages_.push_back(messageEvent);
        if (messageEvent->targetsMe()) {
            targetedUnreadMessages_.push_back(messageEvent);
        }
    }

    std::shared_ptr<Message> message = messageEvent->getStanza();
    ChatWindow::ChatMessage chatMessage;
    boost::optional<std::string> optionalBody = message->getBody();
    std::string body = optionalBody.get_value_or("");
    if (message->isError()) {
        if (!message->getTo().getResource().empty()) {
            std::string errorMessage = str(format(QT_TRANSLATE_NOOP("", "Couldn't send message: %1%")) % getErrorMessage(message->getPayload<ErrorPayload>()));
            chatWindow_->addErrorMessage(chatMessageParser_->parseMessageBody(errorMessage));
        }
    }
    else if (messageEvent->getStanza()->getPayload<MUCInvitationPayload>()) {
        handleMUCInvitation(messageEvent->getStanza());
        return;
    }
    else if (messageEvent->getStanza()->getPayload<MUCUserPayload>() && messageEvent->getStanza()->getPayload<MUCUserPayload>()->getInvite()) {
        handleMediatedMUCInvitation(messageEvent->getStanza());
        return;
    }
    else {
        if (!messageEvent->isReadable()) {
            return;
        }
        showChatWindow();
        JID from = message->getFrom();
        std::vector<std::shared_ptr<Delay> > delayPayloads = message->getPayloads<Delay>();
        for (size_t i = 0; useDelayForLatency_ && i < delayPayloads.size(); i++) {
            if (!delayPayloads[i]->getFrom()) {
                continue;
            }
            boost::posix_time::ptime now = boost::posix_time::microsec_clock::universal_time();
            std::ostringstream s;
            s << "The following message took " << (now - delayPayloads[i]->getStamp()).total_milliseconds() / 1000.0 <<  " seconds to be delivered from " << delayPayloads[i]->getFrom()->toString() << ".";
            chatWindow_->addSystemMessage(chatMessageParser_->parseMessageBody(std::string(s.str())), ChatWindow::DefaultDirection);
        }
        std::shared_ptr<SecurityLabel> label = message->getPayload<SecurityLabel>();

        // Determine the timestamp
        boost::posix_time::ptime timeStamp = boost::posix_time::microsec_clock::universal_time();
        boost::optional<boost::posix_time::ptime> messageTimeStamp = getMessageTimestamp(message);
        if (messageTimeStamp) {
            timeStamp = *messageTimeStamp;
        }
        onActivity(body);

        // Highlight
        HighlightAction fullMessageHighlight;
        if (!isIncomingMessageFromMe(message)) {
            fullMessageHighlight = highlighter_->findFirstFullMessageMatchAction(body, senderHighlightNameFromMessage(from));
        }

        std::shared_ptr<Replace> replace = message->getPayload<Replace>();
        bool senderIsSelf = isIncomingMessageFromMe(message);
        if (replace) {
            // Should check if the user has a previous message
            std::map<JID, std::string>::iterator lastMessage;
            lastMessage = lastMessagesUIID_.find(from);
            if (lastMessage != lastMessagesUIID_.end()) {
                chatMessage = buildChatWindowChatMessage(body, senderIsSelf, fullMessageHighlight);
                replaceMessage(chatMessage, lastMessagesUIID_[from], timeStamp);
            }
        }
        else {
            chatMessage = buildChatWindowChatMessage(body, senderIsSelf, fullMessageHighlight);
            addMessageHandleIncomingMessage(from, chatMessage, senderIsSelf, label, timeStamp);
        }

        logMessage(body, from, selfJID_, timeStamp, true);
    }
    chatWindow_->show();
    updateMessageCount();
    postHandleIncomingMessage(messageEvent, chatMessage);
}

void ChatControllerBase::addMessageHandleIncomingMessage(const JID& from, const ChatWindow::ChatMessage& message, bool senderIsSelf, std::shared_ptr<SecurityLabel> label, const boost::posix_time::ptime& timeStamp) {
    lastMessagesUIID_[from] = addMessage(message, senderDisplayNameFromMessage(from), senderIsSelf, label, avatarManager_->getAvatarPath(from), timeStamp);
}

std::string ChatControllerBase::getErrorMessage(std::shared_ptr<ErrorPayload> error) {
    std::string defaultMessage = QT_TRANSLATE_NOOP("", "Error sending message");
    if (!error->getText().empty()) {
        return error->getText();
    }
    else {
        switch (error->getCondition()) {
            case ErrorPayload::BadRequest: return QT_TRANSLATE_NOOP("", "Bad request");
            case ErrorPayload::Conflict: return QT_TRANSLATE_NOOP("", "Conflict");
            case ErrorPayload::FeatureNotImplemented: return QT_TRANSLATE_NOOP("", "This feature is not implemented");
            case ErrorPayload::Forbidden: return QT_TRANSLATE_NOOP("", "Forbidden");
            case ErrorPayload::Gone: return QT_TRANSLATE_NOOP("", "Recipient can no longer be contacted");
            case ErrorPayload::InternalServerError: return QT_TRANSLATE_NOOP("", "Internal server error");
            case ErrorPayload::ItemNotFound: return QT_TRANSLATE_NOOP("", "Item not found");
            case ErrorPayload::JIDMalformed: return QT_TRANSLATE_NOOP("", "JID Malformed");
            case ErrorPayload::NotAcceptable: return QT_TRANSLATE_NOOP("", "Message was rejected");
            case ErrorPayload::NotAllowed: return QT_TRANSLATE_NOOP("", "Not allowed");
            case ErrorPayload::NotAuthorized: return QT_TRANSLATE_NOOP("", "Not authorized");
            case ErrorPayload::PaymentRequired: return QT_TRANSLATE_NOOP("", "Payment is required");
            case ErrorPayload::RecipientUnavailable: return QT_TRANSLATE_NOOP("", "Recipient is unavailable");
            case ErrorPayload::Redirect: return QT_TRANSLATE_NOOP("", "Redirect");
            case ErrorPayload::RegistrationRequired: return QT_TRANSLATE_NOOP("", "Registration required");
            case ErrorPayload::RemoteServerNotFound: return QT_TRANSLATE_NOOP("", "Recipient's server not found");
            case ErrorPayload::RemoteServerTimeout: return QT_TRANSLATE_NOOP("", "Remote server timeout");
            case ErrorPayload::ResourceConstraint: return QT_TRANSLATE_NOOP("", "The server is low on resources");
            case ErrorPayload::ServiceUnavailable: return QT_TRANSLATE_NOOP("", "The service is unavailable");
            case ErrorPayload::SubscriptionRequired: return QT_TRANSLATE_NOOP("", "A subscription is required");
            case ErrorPayload::UndefinedCondition: return QT_TRANSLATE_NOOP("", "Undefined condition");
            case ErrorPayload::UnexpectedRequest: return QT_TRANSLATE_NOOP("", "Unexpected request");
        }
    }
    assert(false);
    return defaultMessage;
}

void ChatControllerBase::handleGeneralMUCInvitation(MUCInviteEvent::ref event) {
    unreadMessages_.push_back(event);
    chatWindow_->show();
    updateMessageCount();
    chatWindow_->addMUCInvitation(senderDisplayNameFromMessage(event->getInviter()), event->getRoomJID(), event->getReason(), event->getPassword(), event->getDirect(), event->getImpromptu());
    eventController_->handleIncomingEvent(event);
    lastWasPresence_ = false;
}

void ChatControllerBase::handleMUCInvitation(Message::ref message) {
    MUCInvitationPayload::ref invite = message->getPayload<MUCInvitationPayload>();

    if (autoAcceptMUCInviteDecider_->isAutoAcceptedInvite(message->getFrom(), invite)) {
        eventStream_->send(std::make_shared<JoinMUCUIEvent>(invite->getJID(), boost::optional<std::string>(), boost::optional<std::string>(), false, false, true));
    } else {
        MUCInviteEvent::ref inviteEvent = std::make_shared<MUCInviteEvent>(toJID_, invite->getJID(), invite->getReason(), invite->getPassword(), true, invite->getIsImpromptu());
        handleGeneralMUCInvitation(inviteEvent);
    }
}

void ChatControllerBase::handleMediatedMUCInvitation(Message::ref message) {
    MUCUserPayload::Invite invite = *message->getPayload<MUCUserPayload>()->getInvite();
    JID from = message->getFrom();
    std::string reason;
    if (!invite.reason.empty()) {
        reason = invite.reason;
    }
    std::string password;
    if (message->getPayload<MUCUserPayload>()->getPassword()) {
        password = *message->getPayload<MUCUserPayload>()->getPassword();
    }

    MUCInviteEvent::ref inviteEvent = std::make_shared<MUCInviteEvent>(invite.from, from, reason, password, false, false);
    handleGeneralMUCInvitation(inviteEvent);
}

}