chathelpers.h

Go to the documentation of this file.

/********************************************************************************************
* Twitch Broadcasting SDK
*
* This software is supplied under the terms of a license agreement with Twitch Interactive, Inc. and
* may not be copied or used except in accordance with the terms of that agreement
* Copyright (c) 2012-2016 Twitch Interactive, Inc.
*********************************************************************************************/

#pragma once

#include "twitchsdk/core/types/coretypes.h"
#include "twitchsdk/core/mutex.h"
#include "twitchsdk/core/timer.h"
#include "twitchsdk/chat/chattypes.h"
#include <queue>
#include <array>

namespace ttv
{
    namespace chat
    {
        class ChatMessagePacer;
        class UnreadThreadCache;

        Color GetRandomUserColor(const std::string& username);
        SubscriptionStatus ParseSubscriptionStatus(const std::string& str);
        UserMode ParseUserType(const std::string& str);
        
        // Helper function to unescape emoticon tokens received from back-end. Required since the server is escaping the JSON data as HTML.
        void UnescapeEmoticonToken(std::string& token);
    }
}


class ttv::chat::ChatMessagePacer
{
public:
    ChatMessagePacer();
    bool TrackMessage();
    void Clear();

private:
    // Twitch is currently set to blacklist if the client sends more than 20 messages in 30 seconds but we'll be conservative here.
    static const uint kMessagePacingWindowSize = 18;
    static const uint kMessagePacingTimeSpanSeconds = 30;

    std::array<uint64_t, kMessagePacingWindowSize> mMessageSubmissionTimes; 
    uint mNextMessageSubmissionIndex; 
};


class ttv::chat::UnreadThreadCache
{
public:
    struct ThreadData
    {
        std::string threadId;
        MessageId lastReadMessageId;
        MessageId lastMessageId;

        int32_t GetUnreadCount() const;
    };

    UnreadThreadCache();

    uint32_t GetNumUnreadThreads() const { return static_cast<uint32_t>(mNumUnreadThreads); }
    uint32_t GetNumUnreadMessages() const { return static_cast<uint32_t>(mNumUnreadMessages); }
    
    UnreadThreadCounts GetUnreadThreadCounts() const;
    
    void UpdateThread(const std::string& threadId, MessageId lastMessageId, MessageId lastReadMessageId);
    void SetExhaustive(bool exhaustive) { mExhaustive = exhaustive; }
    bool GetExhaustive() const { return mExhaustive; }
    void Clear();
    bool ContainsThread(const std::string& threadId) const;
    
    bool GetDirty() { return mDirty; }
    void MarkClean() { mDirty = false; }

    void RealtimeMessageReceived(const std::string& threadId, MessageId id);
    void RealtimeMessageSent(const std::string& threadId, MessageId id);
    void MarkThreadRead(const std::string& threadId, MessageId lastReadId);
    void MarkThreadRead(const std::string& threadId);

private:
    std::map<std::string, ThreadData> mUnreadThreads;
    int32_t mNumUnreadThreads;
    int32_t mNumUnreadMessages;
    bool mExhaustive; 
    
    bool mDirty; 
};