summaryrefslogtreecommitdiff
path: root/indra/llmessage/lltemplatemessagereader.h
blob: 0f7160d3280c8aa787bccec734764c5338be2421 (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
/**
 * @file lltemplatemessagereader.h
 * @brief Declaration of LLTemplateMessageReader class.
 *
 * $LicenseInfo:firstyear=2007&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef LL_LLTEMPLATEMESSAGEREADER_H
#define LL_LLTEMPLATEMESSAGEREADER_H

#include "llmessagereader.h"

#include <map>

class LLMessageTemplate;
class LLMsgData;

class LLTemplateMessageReader : public LLMessageReader
{
public:

    typedef std::map<U32, LLMessageTemplate*> message_template_number_map_t;

    LLTemplateMessageReader(message_template_number_map_t&);
    virtual ~LLTemplateMessageReader();

    /** All get* methods expect pointers to canonical strings. */
    virtual void getBinaryData(const char *blockname, const char *varname,
                               void *datap, S32 size, S32 blocknum = 0,
                               S32 max_size = S32_MAX);
    virtual void getBOOL(const char *block, const char *var, bool &data,
                         S32 blocknum = 0);
    virtual void getS8(const char *block, const char *var, S8 &data,
                       S32 blocknum = 0);
    virtual void getU8(const char *block, const char *var, U8 &data,
                       S32 blocknum = 0);
    virtual void getS16(const char *block, const char *var, S16 &data,
                        S32 blocknum = 0);
    virtual void getU16(const char *block, const char *var, U16 &data,
                        S32 blocknum = 0);
    virtual void getS32(const char *block, const char *var, S32 &data,
                        S32 blocknum = 0);
    virtual void getF32(const char *block, const char *var, F32 &data,
                        S32 blocknum = 0);
    virtual void getU32(const char *block, const char *var, U32 &data,
                        S32 blocknum = 0);
    virtual void getU64(const char *block, const char *var, U64 &data,
                        S32 blocknum = 0);
    virtual void getF64(const char *block, const char *var, F64 &data,
                        S32 blocknum = 0);
    virtual void getVector3(const char *block, const char *var,
                            LLVector3 &vec, S32 blocknum = 0);
    virtual void getVector4(const char *block, const char *var,
                            LLVector4 &vec, S32 blocknum = 0);
    virtual void getVector3d(const char *block, const char *var,
                             LLVector3d &vec, S32 blocknum = 0);
    virtual void getQuat(const char *block, const char *var, LLQuaternion &q,
                         S32 blocknum = 0);
    virtual void getUUID(const char *block, const char *var, LLUUID &uuid,
                         S32 blocknum = 0);
    virtual void getIPAddr(const char *block, const char *var, U32 &ip,
                           S32 blocknum = 0);
    virtual void getIPPort(const char *block, const char *var, U16 &port,
                           S32 blocknum = 0);
    virtual void getString(const char *block, const char *var,
                           S32 buffer_size, char *buffer, S32 blocknum = 0);
    virtual void getString(const char *block, const char *var,  std::string& outstr,
                           S32 blocknum = 0);

    virtual S32 getNumberOfBlocks(const char *blockname);
    virtual S32 getSize(const char *blockname, const char *varname);
    virtual S32 getSize(const char *blockname, S32 blocknum,
                        const char *varname);

    virtual void clearMessage();

    virtual const char* getMessageName() const;
    virtual S32 getMessageSize() const;

    virtual void copyToBuilder(LLMessageBuilder&) const;

    bool validateMessage(const U8* buffer, S32 buffer_size,
                         const LLHost& sender, bool trusted = false, bool custom = false);
    bool readMessage(const U8* buffer, const LLHost& sender);

    bool isTrusted() const;
    bool isBanned(bool trusted_source) const;
    bool isUdpBanned() const;

    bool decodeData(const U8* buffer, const LLHost& sender, bool custom = false );
    LLMessageTemplate* getTemplate();

private:

    void getData(const char *blockname, const char *varname, void *datap,
                 S32 size = 0, S32 blocknum = 0, S32 max_size = S32_MAX);

    bool decodeTemplate(const U8* buffer, S32 buffer_size,  // inputs
                        LLMessageTemplate** msg_template, bool custom = false ); // outputs

    void logRanOffEndOfPacket( const LLHost& host, const S32 where, const S32 wanted );

    S32 mReceiveSize;
    LLMessageTemplate* mCurrentRMessageTemplate;
    LLMsgData* mCurrentRMessageData;
    message_template_number_map_t& mMessageNumbers;
};

#endif // LL_LLTEMPLATEMESSAGEREADER_H