ClearScript/ClearScript/Windows/WindowsScriptItem.cs at master · tlecomte/ClearScript · GitHub

History

317 lines (259 loc) · 11.1 KB

Raw

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

// Licensed under the MIT license.

using System;

using System.Diagnostics;

using System.Dynamic;

using System.Globalization;

using System.Linq;

using System.Reflection;

using System.Runtime.InteropServices;

using Microsoft.ClearScript.Util;

using Microsoft.ClearScript.Util.COM;

namespace Microsoft.ClearScript.Windows

{

[Guid(TypeGuids.WindowsScriptItem)]

internal sealed class WindowsScriptItem : ScriptItem, IWindowsScriptObject, IDisposable

{

private readonly WindowsScriptEngine engine;

private readonly IDispatchEx target;

private WindowsScriptItem holder;

private readonly InterlockedOneWayFlag disposedFlag = new InterlockedOneWayFlag();

private WindowsScriptItem(WindowsScriptEngine engine, IDispatchEx target)

{

this.engine = engine;

this.target = target;

}

public static object Wrap(WindowsScriptEngine engine, object obj)

{

Debug.Assert(!(obj is IScriptMarshalWrapper));

if (obj == null)

{

return null;

}

if ((obj is IDispatchEx target) && (obj.GetType().IsCOMObject))

{

return new WindowsScriptItem(engine, target);

}

return obj;

}

private IScriptEngineException GetScriptError(Exception exception)

{

if (TryGetScriptError(exception, out var scriptError))

{

return scriptError;

}

return new ScriptEngineException(engine.Name, exception.Message, null, HResult.CLEARSCRIPT_E_SCRIPTITEMEXCEPTION, false, false, null, exception);

}

private bool TryGetScriptError(Exception exception, out IScriptEngineException scriptError)

{

// WORKAROUND: Windows Script items often throw ugly exceptions. The code here

// attempts to clean up specific cases.

while (exception is TargetInvocationException)

{

exception = exception.InnerException;

}

scriptError = exception as IScriptEngineException;

if (scriptError != null)

{

return true;

}

if (exception is COMException comException)

{

var result = comException.ErrorCode;

if (((result == HResult.SCRIPT_E_REPORTED) || (result == HResult.CLEARSCRIPT_E_HOSTEXCEPTION)) && (engine.CurrentScriptFrame != null))

{

scriptError = engine.CurrentScriptFrame.ScriptError ?? engine.CurrentScriptFrame.PendingScriptError;

if (scriptError != null)

{

return true;

}

var hostException = engine.CurrentScriptFrame.HostException;

if (hostException != null)

{

scriptError = new ScriptEngineException(engine.Name, hostException.Message, null, HResult.CLEARSCRIPT_E_HOSTEXCEPTION, false, true, null, hostException);

return true;

}

else if (HResult.GetFacility(result) == HResult.FACILITY_CONTROL)

{

// These exceptions often have awful messages that include COM error codes.

// The engine itself may be able to provide a better message.

if (engine.RuntimeErrorMap.TryGetValue(HResult.GetCode(result), out var runtimeErrorMessage) && (runtimeErrorMessage != exception.Message))

{

scriptError = new ScriptEngineException(engine.Name, runtimeErrorMessage, null, HResult.CLEARSCRIPT_E_SCRIPTITEMEXCEPTION, false, false, null, exception.InnerException);

return true;

}

if (engine.SyntaxErrorMap.TryGetValue(HResult.GetCode(result), out var syntaxErrorMessage) && (syntaxErrorMessage != exception.Message))

{

scriptError = new ScriptEngineException(engine.Name, syntaxErrorMessage, null, HResult.CLEARSCRIPT_E_SCRIPTITEMEXCEPTION, false, false, null, exception.InnerException);

return true;

}

else if ((result == HResult.DISP_E_MEMBERNOTFOUND) || (result == HResult.DISP_E_UNKNOWNNAME))

{

// this usually indicates invalid object or property access in JScript

scriptError = new ScriptEngineException(engine.Name, "Invalid object or property access", null, HResult.CLEARSCRIPT_E_SCRIPTITEMEXCEPTION, false, false, null, exception.InnerException);

return true;

}

else

{

if ((exception is ArgumentException argumentException) && (argumentException.ParamName == null))

{

// this usually indicates invalid object or property access in VBScript

scriptError = new ScriptEngineException(engine.Name, "Invalid object or property access", null, HResult.CLEARSCRIPT_E_SCRIPTITEMEXCEPTION, false, false, null, exception.InnerException);

return true;

}

return false;

}

private void VerifyNotDisposed()

{

if (disposedFlag.IsSet)

{

throw new ObjectDisposedException(ToString());

}

#region ScriptItem overrides

protected override bool TryBindAndInvoke(DynamicMetaObjectBinder binder, object[] args, out object result)

{

VerifyNotDisposed();

var succeeded = DynamicHelpers.TryBindAndInvoke(binder, target, args, out result);

if (!succeeded)

{

if ((result is Exception exception) && (engine.CurrentScriptFrame != null))

{

var scriptError = exception as IScriptEngineException ?? GetScriptError(exception);

if (scriptError.ExecutionStarted && (binder.GetType().FullName != "Microsoft.VisualBasic.CompilerServices.VBGetBinder"))

{

throw (Exception)scriptError;

}

engine.CurrentScriptFrame.ScriptError = scriptError;

}

result = null;

return false;

}

return true;

}

protected override object[] AdjustInvokeArgs(object[] args)

{

// WORKAROUND: JScript seems to require at least one argument to invoke a function

return ((engine is JScriptEngine) && (args.Length < 1)) ? new object[] { Undefined.Value } : args;

}

public override string[] GetPropertyNames()

{

VerifyNotDisposed();

return engine.ScriptInvoke(() => target.GetPropertyNames().ExcludeIndices().ToArray());

}

public override int[] GetPropertyIndices()

{

VerifyNotDisposed();

return engine.ScriptInvoke(() => target.GetPropertyNames().GetIndices().ToArray());

}

#endregion

#region ScriptObject overrides

public override object GetProperty(string name, params object[] args)

{

VerifyNotDisposed();

var result = engine.MarshalToHost(engine.ScriptInvoke(() =>

{

try

{

var value = target.GetProperty(name, false, engine.MarshalToScript(args));

return (value is Nonexistent) ? Undefined.Value : value;

}

catch (Exception exception)

{

if (!name.IsDispIDName(out _) && (exception.HResult != HResult.DISP_E_UNKNOWNNAME))

{

// Property retrieval failed, but a method with the given name exists;

// create a tear-off method. This currently applies only to VBScript.

return new ScriptMethod(this, name);

}

return Undefined.Value;

}

}), false);

if ((result is WindowsScriptItem resultScriptItem) && (resultScriptItem.engine == engine))

{

resultScriptItem.holder = this;

}

return result;

}

public override void SetProperty(string name, params object[] args)

{

VerifyNotDisposed();

engine.ScriptInvoke(() => target.SetProperty(name, false, engine.MarshalToScript(args)));

}

public override bool DeleteProperty(string name)

{

VerifyNotDisposed();

return engine.ScriptInvoke(() => target.DeleteProperty(name, false));

}

public override object GetProperty(int index)

{

VerifyNotDisposed();

return GetProperty(index.ToString(CultureInfo.InvariantCulture));

}

public override void SetProperty(int index, object value)

{

VerifyNotDisposed();

SetProperty(index.ToString(CultureInfo.InvariantCulture), value);

}

public override bool DeleteProperty(int index)

{

VerifyNotDisposed();

return DeleteProperty(index.ToString(CultureInfo.InvariantCulture));

}

public override object Invoke(bool asConstructor, params object[] args)

{

VerifyNotDisposed();

if (asConstructor)

{

return engine.Script.EngineInternal.invokeConstructor(this, args);

}

return engine.Script.EngineInternal.invokeMethod(holder, this, args);

}

public override object InvokeMethod(string name, params object[] args)

{

VerifyNotDisposed();

try

{

return engine.MarshalToHost(engine.ScriptInvoke(() => target.InvokeMethod(name, false, engine.MarshalToScript(args))), false);

}

catch (Exception exception)

{

if (TryGetScriptError(exception, out var scriptError))

{

throw (Exception)scriptError;

}

throw;

}

#endregion

#region IScriptMarshalWrapper implementation

public override ScriptEngine Engine => engine;

public override object Unwrap()

{

return target;

}

#endregion

#region IWindowsScriptObject implementation

object IWindowsScriptObject.GetUnderlyingObject()

{

var pUnkTarget = Marshal.GetIUnknownForObject(target);

var clone = Marshal.GetObjectForIUnknown(pUnkTarget);

Marshal.Release(pUnkTarget);

return clone;

}

#endregion

#region IDisposable implementation

public void Dispose()

{

if (disposedFlag.Set())

{

Marshal.ReleaseComObject(target);

}

#endregion

}

ClearScript/ClearScript/Windows/WindowsScriptItem.cs at master · tlecomte/ClearScript · GitHub

Expand file tree

Breadcrumbs

WindowsScriptItem.cs

Latest commit

History

Breadcrumbs

WindowsScriptItem.cs

File metadata and controls