blob: e8a77dddd5726ef71e28cea42abf0a95f578eb3d (
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
|
// Copyright (c) 2009 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_EXTENSIONS_EXTENSION_FUNCTION_H_
#define CHROME_BROWSER_EXTENSIONS_EXTENSION_FUNCTION_H_
#include <string>
#include "base/values.h"
#include "base/scoped_ptr.h"
#include "base/ref_counted.h"
#include "chrome/browser/extensions/extension_function_dispatcher.h"
class ExtensionFunctionDispatcher;
class Profile;
#define EXTENSION_FUNCTION_VALIDATE(test) do { \
if (!(test)) { \
bad_message_ = true; \
return false; \
} \
} while (0)
#define DECLARE_EXTENSION_FUNCTION_NAME(name) \
public: static const char* function_name() { return name; }
// Abstract base class for extension functions the ExtensionFunctionDispatcher
// knows how to dispatch to.
//
// TODO(aa): This will have to become reference counted when we introduce
// APIs that live beyond a single stack frame.
class ExtensionFunction : public base::RefCounted<ExtensionFunction> {
public:
ExtensionFunction() : request_id_(-1), name_(""), has_callback_(false) {}
virtual ~ExtensionFunction() {}
// Specifies the name of the function.
void set_name(const std::string& name) { name_ = name; }
const std::string name() const { return name_; }
// Specifies the raw arguments to the function, as a JSON value.
virtual void SetArgs(const Value* args) = 0;
// Retrieves the results of the function as a JSON-encoded string (may
// be empty).
virtual const std::string GetResult() = 0;
// Retrieves any error string from the function.
virtual const std::string GetError() = 0;
void set_dispatcher_peer(ExtensionFunctionDispatcher::Peer* peer) {
peer_ = peer;
}
ExtensionFunctionDispatcher* dispatcher() {
return peer_->dispatcher_;
}
void set_request_id(int request_id) { request_id_ = request_id; }
int request_id() { return request_id_; }
void set_has_callback(bool has_callback) { has_callback_ = has_callback; }
bool has_callback() { return has_callback_; }
// Execute the API. Clients should call set_raw_args() and
// set_request_id() before calling this method. Derived classes should be
// ready to return raw_result() and error() before returning from this
// function.
virtual void Run() = 0;
protected:
// Gets the extension that called this function. This can return NULL for
// async functions.
Extension* GetExtension() {
if (dispatcher())
return dispatcher()->GetExtension();
else
return NULL;
}
// The peer to the dispatcher that will service this extension function call.
scoped_refptr<ExtensionFunctionDispatcher::Peer> peer_;
// Id of this request, used to map the response back to the caller.
int request_id_;
// The name of this function.
std::string name_;
// True if the js caller provides a callback function to receive the response
// of this call.
bool has_callback_;
private:
DISALLOW_COPY_AND_ASSIGN(ExtensionFunction);
};
// Base class for an extension function that runs asynchronously *relative to
// the browser's UI thread*.
// Note that once Run() returns, dispatcher() can be NULL, so be sure to
// NULL-check.
// TODO(aa) Remove this extra level of inheritance once the browser stops
// parsing JSON (and instead uses custom serialization of Value objects).
class AsyncExtensionFunction : public ExtensionFunction {
public:
AsyncExtensionFunction() : args_(NULL), bad_message_(false) {}
virtual ~AsyncExtensionFunction() {}
virtual void SetArgs(const Value* args);
virtual const std::string GetResult();
virtual const std::string GetError() { return error_; }
virtual void Run() {
if (!RunImpl())
SendResponse(false);
}
// Derived classes should implement this method to do their work and return
// success/failure.
virtual bool RunImpl() = 0;
protected:
void SendResponse(bool success);
// Note: After Run() returns, dispatcher() can be NULL. Since these getters
// rely on dispatcher(), make sure it is valid before using them.
std::string extension_id();
Profile* profile();
// The arguments to the API. Only non-null if argument were specified.
Value* args_;
// The result of the API. This should be populated by the derived class before
// SendResponse() is called.
scoped_ptr<Value> result_;
// Any detailed error from the API. This should be populated by the derived
// class before Run() returns.
std::string error_;
// Any class that gets a malformed message should set this to true before
// returning. The calling renderer process will be killed.
bool bad_message_;
private:
DISALLOW_COPY_AND_ASSIGN(AsyncExtensionFunction);
};
// A SyncExtensionFunction is an ExtensionFunction that runs synchronously
// *relative to the browser's UI thread*. Note that this has nothing to do with
// running synchronously relative to the extension process. From the extension
// process's point of view, the function is still asynchronous.
//
// This kind of function is convenient for implementing simple APIs that just
// need to interact with things on the browser UI thread.
class SyncExtensionFunction : public AsyncExtensionFunction {
public:
SyncExtensionFunction() {}
// Derived classes should implement this method to do their work and return
// success/failure.
virtual bool RunImpl() = 0;
virtual void Run() {
SendResponse(RunImpl());
}
private:
DISALLOW_COPY_AND_ASSIGN(SyncExtensionFunction);
};
#endif // CHROME_BROWSER_EXTENSIONS_EXTENSION_FUNCTION_H_
|
