summaryrefslogtreecommitdiff
path: root/indra/llcommon/lleventapi.cpp
blob: 4672371b4f1ffc17e9a80de3c457d68c7e525492 (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
/**
 * @file   lleventapi.cpp
 * @author Nat Goodspeed
 * @date   2009-11-10
 * @brief  Implementation for lleventapi.
 *
 * $LicenseInfo:firstyear=2009&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$
 */

// Precompiled header
#include "linden_common.h"
// associated header
#include "lleventapi.h"
// STL headers
// std headers
// external library headers
// other Linden headers
#include "llerror.h"
#include "lazyeventapi.h"

LLEventAPI::LLEventAPI(const std::string& name, const std::string& desc, const std::string& field):
    lbase(name, field),
    ibase(name),
    mDesc(desc)
{
}

LLEventAPI::LLEventAPI(const LL::LazyEventAPIParams& params):
    LLEventAPI(params.name, params.desc, params.field)
{
    // call initialization functions with our brand-new instance pointer
    params.init(this);
}

LLEventAPI::~LLEventAPI()
{
}

bool LLEventAPI::process(const LLSD& event) const
{
    // LLDispatchListener is documented to let DispatchError propagate if the
    // incoming request has no "reply" key. That may be fine for internal-only
    // use, but LLEventAPI opens the door for external requests. It should NOT
    // be possible for any external requester to crash the viewer with an
    // unhandled exception, especially not by something as simple as omitting
    // the "reply" key.
    try
    {
        return LLDispatchListener::process(event);
    }
    catch (const std::exception& err)
    {
        // log the exception, but otherwise ignore it
        LL_WARNS("LLEventAPI") << LLError::Log::classname(err) << ": " << err.what() << LL_ENDL;
        return false;
    }
}

LLEventAPI::Response::Response(const LLSD& seed, const LLSD& request, const LLSD::String& replyKey):
    mResp(seed),
    mReq(request),
    mKey(replyKey)
{}

LLEventAPI::Response::~Response()
{
    // When you instantiate a stack Response object, if the original
    // request requested a reply, send it when we leave this block, no
    // matter how.
    sendReply(mResp, mReq, mKey);
}

void LLEventAPI::Response::warn(const std::string& warning)
{
    LL_WARNS("LLEventAPI::Response") << warning << LL_ENDL;
    mResp["warnings"].append(warning);
}

void LLEventAPI::Response::error(const std::string& error)
{
    // Use LL_WARNS rather than LL_ERROR: we don't want the viewer to shut
    // down altogether.
    LL_WARNS("LLEventAPI::Response") << error << LL_ENDL;

    mResp["error"] = error;
}