/
JavascriptObjectRepository.cs
436 lines (371 loc) · 17.5 KB
/
JavascriptObjectRepository.cs
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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
// Copyright © 2010-2017 The CefSharp Authors. All rights reserved.
//
// Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using System.Threading;
using CefSharp.ModelBinding;
namespace CefSharp.Internals
{
/// <summary>
/// This class manages the registration of objects in the browser
/// process to be exposed to JavaScript in the renderer process.
/// Registration performs method, parameter, property type analysis
/// of the registered objects into meta-data tied to reflection data
/// for later use.
///
/// This class also is the adaptation layer between the BrowserProcessService
/// and the registered objects. This means when the renderer wants to call an
/// exposed method, get a property of an object, or
/// set a property of an object in the browser process, that this
/// class does deals with the previously created meta-data and invokes the correct
/// behavior via reflection APIs.
///
/// All of the registered objects are tracked via meta-data for the objects
/// expressed starting with the JavaScriptObject type.
/// </summary>
public class JavascriptObjectRepository
{
private static long lastId;
/// <summary>
/// A hash from assigned object ids to the objects,
/// this is done to speed up finding the object in O(1) time
/// instead of traversing the JavaScriptRootObject tree.
/// </summary>
private readonly Dictionary<long, JavascriptObject> objects = new Dictionary<long, JavascriptObject>();
/// <summary>
/// This is the root of the objects that get serialized to the child process.
/// </summary>
public JavascriptRootObject RootObject { get; private set; }
/// <summary>
/// This is the root of the objects that get serialized to the child
/// process with cef ipc serialization (wcf not required).
/// </summary>
public JavascriptRootObject AsyncRootObject { get; private set; }
public JavascriptObjectRepository()
{
RootObject = new JavascriptRootObject();
AsyncRootObject = new JavascriptRootObject();
}
public bool HasBoundObjects
{
get { return RootObject.MemberObjects.Count > 0 || AsyncRootObject.MemberObjects.Count > 0; }
}
private JavascriptObject CreateJavascriptObject(bool camelCaseJavascriptNames)
{
var id = Interlocked.Increment(ref lastId);
var result = new JavascriptObject { Id = id, CamelCaseJavascriptNames = camelCaseJavascriptNames };
objects[id] = result;
return result;
}
public void RegisterAsync(string name, object value, BindingOptions options)
{
AsyncRootObject.MemberObjects.Add(CreateInternal(name, value, analyseProperties: false, options: options));
}
public void Register(string name, object value, BindingOptions options)
{
RootObject.MemberObjects.Add(CreateInternal(name, value, analyseProperties: true, options: options));
}
private JavascriptObject CreateInternal(string name, object value, bool analyseProperties, BindingOptions options)
{
var camelCaseJavascriptNames = options == null ? true : options.CamelCaseJavascriptNames;
var jsObject = CreateJavascriptObject(camelCaseJavascriptNames);
jsObject.Value = value;
jsObject.Name = name;
jsObject.JavascriptName = name;
jsObject.Binder = options == null ? null : options.Binder;
jsObject.MethodInterceptor = options == null ? null : options.MethodInterceptor;
AnalyseObjectForBinding(jsObject, analyseMethods: true, analyseProperties: analyseProperties, readPropertyValue: false, camelCaseJavascriptNames: camelCaseJavascriptNames);
return jsObject;
}
public bool TryCallMethod(long objectId, string name, object[] parameters, out object result, out string exception)
{
exception = "";
result = null;
JavascriptObject obj;
if (!objects.TryGetValue(objectId, out obj))
{
return false;
}
var method = obj.Methods.FirstOrDefault(p => p.JavascriptName == name);
if (method == null)
{
throw new InvalidOperationException(string.Format("Method {0} not found on Object of Type {1}", name, obj.Value.GetType()));
}
try
{
//Check if the bound object method contains a ParamArray as the last parameter on the method signature.
//NOTE: No additional parameters are permitted after the params keyword in a method declaration,
//and only one params keyword is permitted in a method declaration.
//https://msdn.microsoft.com/en-AU/library/w5zay9db.aspx
if (method.HasParamArray)
{
var paramList = new List<object>(method.Parameters.Count);
//Loop through all of the method parameters on the bound object.
for (var i = 0; i < method.Parameters.Count; i++)
{
//If the method parameter is a paramArray IE: (params string[] args)
//grab the parameters from the javascript function starting at the current bound object parameter index
//and add create an array that will be passed in as the last bound object method parameter.
if (method.Parameters[i].IsParamArray)
{
var convertedParams = new List<object>();
for (var s = i; s < parameters.Length; s++)
{
convertedParams.Add(parameters[s]);
}
paramList.Add(convertedParams.ToArray());
}
else
{
var jsParam = parameters.ElementAtOrDefault(i);
paramList.Add(jsParam);
}
}
parameters = paramList.ToArray();
}
//Check for parameter count missmatch between the parameters on the javascript function and the
//number of parameters on the bound object method. (This is relevant for methods that have default values)
//NOTE it's possible to have default params and a paramArray, so check missing params last
var missingParams = method.ParameterCount - parameters.Length;
if(missingParams > 0)
{
var paramList = new List<object>(parameters);
for (var i = 0; i < missingParams; i++)
{
paramList.Add(Type.Missing);
}
parameters = paramList.ToArray();
}
try
{
if(obj.Binder != null)
{
for (var i = 0; i < parameters.Length; i++)
{
if(parameters[i] != null)
{
var paramType = method.Parameters[i].Type;
if(parameters[i].GetType() == typeof(Dictionary<string, object>))
{
var dictionary = (Dictionary<string, object>)parameters[i];
parameters[i] = obj.Binder.Bind(dictionary, paramType);
}
else if (parameters[i].GetType() == typeof(List<object>))
{
var list = (List<object>)parameters[i];
parameters[i] = obj.Binder.Bind(list, paramType);
}
}
}
}
if (obj.MethodInterceptor == null)
{
result = method.Function(obj.Value, parameters);
}
else
{
result = obj.MethodInterceptor.Intercept(() => method.Function(obj.Value, parameters), method.ManagedName);
}
}
catch (Exception e)
{
throw new InvalidOperationException("Could not execute method: " + name + "(" + String.Join(", ", parameters) + ") " + (missingParams > 0 ? "- Missing Parameters: " + missingParams : ""), e);
}
if(result != null && IsComplexType(result.GetType()))
{
var jsObject = CreateJavascriptObject(obj.CamelCaseJavascriptNames);
jsObject.Value = result;
jsObject.Name = "FunctionResult(" + name + ")";
jsObject.JavascriptName = jsObject.Name;
AnalyseObjectForBinding(jsObject, analyseMethods: false, analyseProperties:true, readPropertyValue: true, camelCaseJavascriptNames: obj.CamelCaseJavascriptNames);
result = jsObject;
}
return true;
}
catch(TargetInvocationException e)
{
var baseException = e.GetBaseException();
exception = baseException.ToString();
}
catch (Exception ex)
{
exception = ex.ToString();
}
return false;
}
public bool TryGetProperty(long objectId, string name, out object result, out string exception)
{
exception = "";
result = null;
JavascriptObject obj;
if (!objects.TryGetValue(objectId, out obj))
{
return false;
}
var property = obj.Properties.FirstOrDefault(p => p.JavascriptName == name);
if (property == null)
{
throw new InvalidOperationException(string.Format("Property {0} not found on Object of Type {1}", name, obj.Value.GetType()));
}
try
{
result = property.GetValue(obj.Value);
return true;
}
catch (Exception ex)
{
exception = ex.ToString();
}
return false;
}
public bool TrySetProperty(long objectId, string name, object value, out string exception)
{
exception = "";
JavascriptObject obj;
if (!objects.TryGetValue(objectId, out obj))
{
return false;
}
var property = obj.Properties.FirstOrDefault(p => p.JavascriptName == name);
if (property == null)
{
throw new InvalidOperationException(string.Format("Property {0} not found on Object of Type {1}", name, obj.Value.GetType()));
}
try
{
property.SetValue(obj.Value, value);
return true;
}
catch (Exception ex)
{
exception = ex.ToString();
}
return false;
}
/// <summary>
/// Analyse the object and generate metadata which will
/// be used by the browser subprocess to interact with Cef.
/// Method is called recursively
/// </summary>
/// <param name="obj">Javascript object</param>
/// <param name="analyseMethods">Analyse methods for inclusion in metadata model</param>
/// <param name="readPropertyValue">When analysis is done on a property, if true then get it's value for transmission over WCF</param>
/// <param name="camelCaseJavascriptNames">camel case the javascript names of properties/methods</param>
/// <param name="analyseProperties">Analyse properties for binding</param>
private void AnalyseObjectForBinding(JavascriptObject obj, bool analyseMethods, bool readPropertyValue, bool camelCaseJavascriptNames, bool analyseProperties)
{
if (obj.Value == null)
{
return;
}
var type = obj.Value.GetType();
if (type.IsPrimitive || type == typeof(string))
{
return;
}
if (analyseMethods)
{
foreach (var methodInfo in type.GetMethods(BindingFlags.Instance | BindingFlags.Public).Where(p => !p.IsSpecialName))
{
// Type objects can not be serialized.
if (methodInfo.ReturnType == typeof (Type) || Attribute.IsDefined(methodInfo, typeof (JavascriptIgnoreAttribute)))
{
continue;
}
var jsMethod = CreateJavaScriptMethod(methodInfo, camelCaseJavascriptNames);
obj.Methods.Add(jsMethod);
}
}
if (analyseProperties)
{
foreach (var propertyInfo in type.GetProperties(BindingFlags.Instance | BindingFlags.Public).Where(p => !p.IsSpecialName))
{
if (propertyInfo.PropertyType == typeof (Type) || Attribute.IsDefined(propertyInfo, typeof (JavascriptIgnoreAttribute)))
{
continue;
}
var jsProperty = CreateJavaScriptProperty(propertyInfo, camelCaseJavascriptNames);
if (jsProperty.IsComplexType)
{
var jsObject = CreateJavascriptObject(camelCaseJavascriptNames);
jsObject.Name = propertyInfo.Name;
jsObject.JavascriptName = GetJavascriptName(propertyInfo.Name, camelCaseJavascriptNames);
jsObject.Value = jsProperty.GetValue(obj.Value);
jsProperty.JsObject = jsObject;
AnalyseObjectForBinding(jsProperty.JsObject, analyseMethods, readPropertyValue, camelCaseJavascriptNames, true);
}
else if (readPropertyValue)
{
jsProperty.PropertyValue = jsProperty.GetValue(obj.Value);
}
obj.Properties.Add(jsProperty);
}
}
}
private static JavascriptMethod CreateJavaScriptMethod(MethodInfo methodInfo, bool camelCaseJavascriptNames)
{
var jsMethod = new JavascriptMethod();
jsMethod.ManagedName = methodInfo.Name;
jsMethod.JavascriptName = GetJavascriptName(methodInfo.Name, camelCaseJavascriptNames);
jsMethod.Function = methodInfo.Invoke;
jsMethod.ParameterCount = methodInfo.GetParameters().Length;
jsMethod.Parameters = methodInfo.GetParameters()
.Select(t => new MethodParameter()
{
IsParamArray = t.GetCustomAttributes(typeof(ParamArrayAttribute), false).Length > 0,
Type = t.ParameterType
}).ToList();
//Pre compute HasParamArray for a very minor performance gain
jsMethod.HasParamArray = jsMethod.Parameters.LastOrDefault(t => t.IsParamArray) != null;
return jsMethod;
}
private static JavascriptProperty CreateJavaScriptProperty(PropertyInfo propertyInfo, bool camelCaseJavascriptNames)
{
var jsProperty = new JavascriptProperty();
jsProperty.ManagedName = propertyInfo.Name;
jsProperty.JavascriptName = GetJavascriptName(propertyInfo.Name, camelCaseJavascriptNames);
jsProperty.SetValue = (o, v) => propertyInfo.SetValue(o, v, null);
jsProperty.GetValue = (o) => propertyInfo.GetValue(o, null);
jsProperty.IsComplexType = IsComplexType(propertyInfo.PropertyType);
jsProperty.IsReadOnly = !propertyInfo.CanWrite;
return jsProperty;
}
private static bool IsComplexType(Type type)
{
if (type == typeof(void))
{
return false;
}
var baseType = type;
var nullable = type.IsGenericType && type.GetGenericTypeDefinition() == typeof (Nullable<>);
if (nullable)
{
baseType = Nullable.GetUnderlyingType(type);
}
if (baseType == null || baseType.IsArray || baseType.Namespace.StartsWith("System"))
{
return false;
}
if (baseType.IsValueType && !baseType.IsPrimitive && !baseType.IsEnum)
{
return false;
}
return !baseType.IsPrimitive && baseType != typeof(string);
}
private static string GetJavascriptName(string str, bool camelCaseJavascriptNames)
{
if (!camelCaseJavascriptNames)
{
return str;
}
if (string.IsNullOrEmpty(str))
{
return string.Empty;
}
return char.ToLowerInvariant(str[0]) + str.Substring(1);
}
}
}