/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is mozilla.org code. * * The Initial Developer of the Original Code is * Netscape Communications Corporation. * Portions created by the Initial Developer are Copyright (C) 1998 * the Initial Developer. All Rights Reserved. * * Contributor(s): * Josh Aas * * Alternatively, the contents of this file may be used under the terms of * either the GNU General Public License Version 2 or later (the "GPL"), or * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ #include "nsJSNPRuntime.h" #include "nsNPAPIPlugin.h" #include "nsNPAPIPluginInstance.h" #include "nsIScriptGlobalObject.h" #include "nsIScriptContext.h" #include "nsDOMJSUtils.h" #include "nsIDocument.h" #include "nsIJSRuntimeService.h" #include "nsIJSContextStack.h" #include "nsIXPConnect.h" #include "nsIDOMElement.h" #include "prmem.h" #include "nsIContent.h" // FIXME(bug 332648): Give me a real API please! #include "jscntxt.h" using namespace mozilla::plugins::parent; // Hash of JSObject wrappers that wraps JSObjects as NPObjects. There // will be one wrapper per JSObject per plugin instance, i.e. if two // plugins access the JSObject x, two wrappers for x will be // created. This is needed to be able to properly drop the wrappers // when a plugin is torn down in case there's a leak in the plugin (we // don't want to leak the world just because a plugin leaks an // NPObject). static PLDHashTable sJSObjWrappers; // Hash of NPObject wrappers that wrap NPObjects as JSObjects. static PLDHashTable sNPObjWrappers; // Global wrapper count. This includes JSObject wrappers *and* // NPObject wrappers. When this count goes to zero, there are no more // wrappers and we can kill off hash tables etc. static PRInt32 sWrapperCount; // The JSRuntime. Used to unroot JSObjects when no JSContext is // reachable. static JSRuntime *sJSRuntime; // The JS context stack, we use this to push a plugin's JSContext onto // while executing JS on the context. static nsIJSContextStack *sContextStack; static nsTArray* sDelayedReleases; // Helper class that reports any JS exceptions that were thrown while // the plugin executed JS. class AutoJSExceptionReporter { public: AutoJSExceptionReporter(JSContext *cx) : mCx(cx) { } ~AutoJSExceptionReporter() { JS_ReportPendingException(mCx); } protected: JSContext *mCx; }; NPClass nsJSObjWrapper::sJSObjWrapperNPClass = { NP_CLASS_STRUCT_VERSION, nsJSObjWrapper::NP_Allocate, nsJSObjWrapper::NP_Deallocate, nsJSObjWrapper::NP_Invalidate, nsJSObjWrapper::NP_HasMethod, nsJSObjWrapper::NP_Invoke, nsJSObjWrapper::NP_InvokeDefault, nsJSObjWrapper::NP_HasProperty, nsJSObjWrapper::NP_GetProperty, nsJSObjWrapper::NP_SetProperty, nsJSObjWrapper::NP_RemoveProperty, nsJSObjWrapper::NP_Enumerate, nsJSObjWrapper::NP_Construct }; static JSBool NPObjWrapper_AddProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp); static JSBool NPObjWrapper_DelProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp); static JSBool NPObjWrapper_SetProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp); static JSBool NPObjWrapper_GetProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp); static JSBool NPObjWrapper_newEnumerate(JSContext *cx, JSObject *obj, JSIterateOp enum_op, jsval *statep, jsid *idp); static JSBool NPObjWrapper_NewResolve(JSContext *cx, JSObject *obj, jsval id, uintN flags, JSObject **objp); static JSBool NPObjWrapper_Convert(JSContext *cx, JSObject *obj, JSType type, jsval *vp); static void NPObjWrapper_Finalize(JSContext *cx, JSObject *obj); static JSBool NPObjWrapper_Call(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsval *rval); static JSBool NPObjWrapper_Construct(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsval *rval); static JSBool CreateNPObjectMember(NPP npp, JSContext *cx, JSObject *obj, NPObject *npobj, jsval id, jsval *vp); static JSClass sNPObjectJSWrapperClass = { NPRUNTIME_JSCLASS_NAME, JSCLASS_HAS_PRIVATE | JSCLASS_NEW_RESOLVE | JSCLASS_NEW_ENUMERATE, NPObjWrapper_AddProperty, NPObjWrapper_DelProperty, NPObjWrapper_GetProperty, NPObjWrapper_SetProperty, (JSEnumerateOp)NPObjWrapper_newEnumerate, (JSResolveOp)NPObjWrapper_NewResolve, NPObjWrapper_Convert, NPObjWrapper_Finalize, nsnull, nsnull, NPObjWrapper_Call, NPObjWrapper_Construct, nsnull, nsnull }; typedef struct NPObjectMemberPrivate { JSObject *npobjWrapper; jsval fieldValue; jsval methodName; NPP npp; } NPObjectMemberPrivate; static JSBool NPObjectMember_Convert(JSContext *cx, JSObject *obj, JSType type, jsval *vp); static void NPObjectMember_Finalize(JSContext *cx, JSObject *obj); static JSBool NPObjectMember_Call(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsval *rval); static uint32 NPObjectMember_Mark(JSContext *cx, JSObject *obj, void *arg); static JSClass sNPObjectMemberClass = { "NPObject Ambiguous Member class", JSCLASS_HAS_PRIVATE, JS_PropertyStub, JS_PropertyStub, JS_PropertyStub, JS_PropertyStub, JS_EnumerateStub, JS_ResolveStub, NPObjectMember_Convert, NPObjectMember_Finalize, nsnull, nsnull, NPObjectMember_Call, nsnull, nsnull, nsnull, NPObjectMember_Mark, nsnull }; static void OnWrapperDestroyed(); static JSBool DelayedReleaseGCCallback(JSContext* cx, JSGCStatus status) { if (JSGC_END == status) { if (sDelayedReleases) { for (PRInt32 i = 0; i < sDelayedReleases->Length(); ++i) { NPObject* obj = (*sDelayedReleases)[i]; if (obj) _releaseobject(obj); OnWrapperDestroyed(); } delete sDelayedReleases; sDelayedReleases = NULL; } } return JS_TRUE; } static void OnWrapperCreated() { if (sWrapperCount++ == 0) { static const char rtsvc_id[] = "@mozilla.org/js/xpc/RuntimeService;1"; nsCOMPtr rtsvc(do_GetService(rtsvc_id)); if (!rtsvc) return; rtsvc->GetRuntime(&sJSRuntime); NS_ASSERTION(sJSRuntime != nsnull, "no JSRuntime?!"); // Register our GC callback to perform delayed destruction of finalized // NPObjects. Leave this callback around and don't ever unregister it. rtsvc->RegisterGCCallback(DelayedReleaseGCCallback); CallGetService("@mozilla.org/js/xpc/ContextStack;1", &sContextStack); } } static void OnWrapperDestroyed() { NS_ASSERTION(sWrapperCount, "Whaaa, unbalanced created/destroyed calls!"); if (--sWrapperCount == 0) { if (sJSObjWrappers.ops) { NS_ASSERTION(sJSObjWrappers.entryCount == 0, "Uh, hash not empty?"); // No more wrappers, and our hash was initialized. Finish the // hash to prevent leaking it. PL_DHashTableFinish(&sJSObjWrappers); sJSObjWrappers.ops = nsnull; } if (sNPObjWrappers.ops) { NS_ASSERTION(sNPObjWrappers.entryCount == 0, "Uh, hash not empty?"); // No more wrappers, and our hash was initialized. Finish the // hash to prevent leaking it. PL_DHashTableFinish(&sNPObjWrappers); sNPObjWrappers.ops = nsnull; } // No more need for this. sJSRuntime = nsnull; NS_IF_RELEASE(sContextStack); } } struct AutoCXPusher { AutoCXPusher(JSContext *cx) { // Precondition explaining why we don't need to worry about errors // in OnWrapperCreated. NS_PRECONDITION(sWrapperCount > 0, "must have live wrappers when using AutoCXPusher"); // Call OnWrapperCreated and OnWrapperDestroyed to ensure that the // last OnWrapperDestroyed doesn't happen while we're on the stack // and null out sContextStack. OnWrapperCreated(); sContextStack->Push(cx); } ~AutoCXPusher() { JSContext *cx = nsnull; sContextStack->Pop(&cx); JSContext *currentCx = nsnull; sContextStack->Peek(¤tCx); if (!currentCx) { // No JS is running, tell the context we're done executing // script. nsIScriptContext *scx = GetScriptContextFromJSContext(cx); if (scx) { scx->ScriptEvaluated(PR_TRUE); } } OnWrapperDestroyed(); } }; static JSContext * GetJSContext(NPP npp) { NS_ENSURE_TRUE(npp, nsnull); nsNPAPIPluginInstance *inst = (nsNPAPIPluginInstance *)npp->ndata; NS_ENSURE_TRUE(inst, nsnull); nsCOMPtr owner; inst->GetOwner(getter_AddRefs(owner)); NS_ENSURE_TRUE(owner, nsnull); nsCOMPtr doc; owner->GetDocument(getter_AddRefs(doc)); NS_ENSURE_TRUE(doc, nsnull); nsCOMPtr documentContainer = doc->GetContainer(); nsCOMPtr sgo(do_GetInterface(documentContainer)); NS_ENSURE_TRUE(sgo, nsnull); nsIScriptContext *scx = sgo->GetContext(); NS_ENSURE_TRUE(scx, nsnull); return (JSContext *)scx->GetNativeContext(); } static NPP LookupNPP(NPObject *npobj); static jsval NPVariantToJSVal(NPP npp, JSContext *cx, const NPVariant *variant) { switch (variant->type) { case NPVariantType_Void : return JSVAL_VOID; case NPVariantType_Null : return JSVAL_NULL; case NPVariantType_Bool : return BOOLEAN_TO_JSVAL(NPVARIANT_TO_BOOLEAN(*variant)); case NPVariantType_Int32 : { // Don't use INT_TO_JSVAL directly to prevent bugs when dealing // with ints larger than what fits in a integer jsval. jsval val; if (::JS_NewNumberValue(cx, NPVARIANT_TO_INT32(*variant), &val)) { return val; } break; } case NPVariantType_Double : { jsval val; if (::JS_NewNumberValue(cx, NPVARIANT_TO_DOUBLE(*variant), &val)) { return val; } break; } case NPVariantType_String : { const NPString *s = &NPVARIANT_TO_STRING(*variant); NS_ConvertUTF8toUTF16 utf16String(s->UTF8Characters, s->UTF8Length); JSString *str = ::JS_NewUCStringCopyN(cx, reinterpret_cast (utf16String.get()), utf16String.Length()); if (str) { return STRING_TO_JSVAL(str); } break; } case NPVariantType_Object: { if (npp) { JSObject *obj = nsNPObjWrapper::GetNewOrUsed(npp, cx, NPVARIANT_TO_OBJECT(*variant)); if (obj) { return OBJECT_TO_JSVAL(obj); } } NS_ERROR("Error wrapping NPObject!"); break; } default: NS_ERROR("Unknown NPVariant type!"); } NS_ERROR("Unable to convert NPVariant to jsval!"); return JSVAL_VOID; } bool JSValToNPVariant(NPP npp, JSContext *cx, jsval val, NPVariant *variant) { NS_ASSERTION(npp, "Must have an NPP to wrap a jsval!"); if (JSVAL_IS_PRIMITIVE(val)) { if (val == JSVAL_VOID) { VOID_TO_NPVARIANT(*variant); } else if (JSVAL_IS_NULL(val)) { NULL_TO_NPVARIANT(*variant); } else if (JSVAL_IS_BOOLEAN(val)) { BOOLEAN_TO_NPVARIANT(JSVAL_TO_BOOLEAN(val), *variant); } else if (JSVAL_IS_INT(val)) { INT32_TO_NPVARIANT(JSVAL_TO_INT(val), *variant); } else if (JSVAL_IS_DOUBLE(val)) { DOUBLE_TO_NPVARIANT(*JSVAL_TO_DOUBLE(val), *variant); } else if (JSVAL_IS_STRING(val)) { JSString *jsstr = JSVAL_TO_STRING(val); nsDependentString str((PRUnichar *)::JS_GetStringChars(jsstr), ::JS_GetStringLength(jsstr)); PRUint32 len; char *p = ToNewUTF8String(str, &len); if (!p) { return false; } STRINGN_TO_NPVARIANT(p, len, *variant); } else { NS_ERROR("Unknown primitive type!"); return false; } return true; } NPObject *npobj = nsJSObjWrapper::GetNewOrUsed(npp, cx, JSVAL_TO_OBJECT(val)); if (!npobj) { return false; } // Pass over ownership of npobj to *variant OBJECT_TO_NPVARIANT(npobj, *variant); return true; } static void ThrowJSException(JSContext *cx, const char *message) { const char *ex = PeekException(); if (ex) { nsAutoString ucex; if (message) { AppendASCIItoUTF16(message, ucex); AppendASCIItoUTF16(" [plugin exception: ", ucex); } AppendUTF8toUTF16(ex, ucex); if (message) { AppendASCIItoUTF16("].", ucex); } JSString *str = ::JS_NewUCStringCopyN(cx, (jschar *)ucex.get(), ucex.Length()); if (str) { ::JS_SetPendingException(cx, STRING_TO_JSVAL(str)); } PopException(); } else { ::JS_ReportError(cx, message); } } static JSBool ReportExceptionIfPending(JSContext *cx) { const char *ex = PeekException(); if (!ex) { return JS_TRUE; } ThrowJSException(cx, nsnull); return JS_FALSE; } nsJSObjWrapper::nsJSObjWrapper(NPP npp) : nsJSObjWrapperKey(nsnull, npp) { MOZ_COUNT_CTOR(nsJSObjWrapper); OnWrapperCreated(); } nsJSObjWrapper::~nsJSObjWrapper() { MOZ_COUNT_DTOR(nsJSObjWrapper); // Invalidate first, since it relies on sJSRuntime and sJSObjWrappers. NP_Invalidate(this); OnWrapperDestroyed(); } // static NPObject * nsJSObjWrapper::NP_Allocate(NPP npp, NPClass *aClass) { NS_ASSERTION(aClass == &sJSObjWrapperNPClass, "Huh, wrong class passed to NP_Allocate()!!!"); return new nsJSObjWrapper(npp); } // static void nsJSObjWrapper::NP_Deallocate(NPObject *npobj) { // nsJSObjWrapper::~nsJSObjWrapper() will call NP_Invalidate(). delete (nsJSObjWrapper *)npobj; } // static void nsJSObjWrapper::NP_Invalidate(NPObject *npobj) { nsJSObjWrapper *jsnpobj = (nsJSObjWrapper *)npobj; if (jsnpobj && jsnpobj->mJSObj) { // Unroot the object's JSObject ::JS_RemoveRootRT(sJSRuntime, &jsnpobj->mJSObj); if (sJSObjWrappers.ops) { // Remove the wrapper from the hash nsJSObjWrapperKey key(jsnpobj->mJSObj, jsnpobj->mNpp); PL_DHashTableOperate(&sJSObjWrappers, &key, PL_DHASH_REMOVE); } // Forget our reference to the JSObject. jsnpobj->mJSObj = nsnull; } } static JSBool GetProperty(JSContext *cx, JSObject *obj, NPIdentifier identifier, jsval *rval) { jsval id = (jsval)identifier; if (JSVAL_IS_STRING(id)) { JSString *str = JSVAL_TO_STRING(id); return ::JS_GetUCProperty(cx, obj, ::JS_GetStringChars(str), ::JS_GetStringLength(str), rval); } NS_ASSERTION(JSVAL_IS_INT(id), "id must be either string or int!\n"); return ::JS_GetElement(cx, obj, JSVAL_TO_INT(id), rval); } // static bool nsJSObjWrapper::NP_HasMethod(NPObject *npobj, NPIdentifier identifier) { NPP npp = NPPStack::Peek(); JSContext *cx = GetJSContext(npp); if (!cx) { NS_ERROR("Null cx in nsJSObjWrapper::NP_HasMethod!"); return PR_FALSE; } if (!npobj) { ThrowJSException(cx, "Null npobj in nsJSObjWrapper::NP_HasMethod!"); return PR_FALSE; } nsJSObjWrapper *npjsobj = (nsJSObjWrapper *)npobj; AutoCXPusher pusher(cx); JSAutoRequest ar(cx); AutoJSExceptionReporter reporter(cx); jsval v; JSBool ok = GetProperty(cx, npjsobj->mJSObj, identifier, &v); return ok && !JSVAL_IS_PRIMITIVE(v) && ::JS_ObjectIsFunction(cx, JSVAL_TO_OBJECT(v)); } static bool doInvoke(NPObject *npobj, NPIdentifier method, const NPVariant *args, uint32_t argCount, PRBool ctorCall, NPVariant *result) { NPP npp = NPPStack::Peek(); JSContext *cx = GetJSContext(npp); if (!cx) { NS_ERROR("Null cx in doInvoke!"); return PR_FALSE; } if (!npobj || !result) { ThrowJSException(cx, "Null npobj, or result in doInvoke!"); return PR_FALSE; } // Initialize *result VOID_TO_NPVARIANT(*result); nsJSObjWrapper *npjsobj = (nsJSObjWrapper *)npobj; jsval fv; AutoCXPusher pusher(cx); JSAutoRequest ar(cx); AutoJSExceptionReporter reporter(cx); if ((jsval)method != JSVAL_VOID) { if (!GetProperty(cx, npjsobj->mJSObj, method, &fv) || ::JS_TypeOfValue(cx, fv) != JSTYPE_FUNCTION) { return PR_FALSE; } } else { fv = OBJECT_TO_JSVAL(npjsobj->mJSObj); } jsval jsargs_buf[8]; jsval *jsargs = jsargs_buf; if (argCount > (sizeof(jsargs_buf) / sizeof(jsval))) { // Our stack buffer isn't large enough to hold all arguments, // malloc a buffer. jsargs = (jsval *)PR_Malloc(argCount * sizeof(jsval)); if (!jsargs) { ::JS_ReportOutOfMemory(cx); return PR_FALSE; } } JSTempValueRooter tvr; JS_PUSH_TEMP_ROOT(cx, 0, jsargs, &tvr); // Convert args for (PRUint32 i = 0; i < argCount; ++i) { jsargs[i] = NPVariantToJSVal(npp, cx, args + i); ++tvr.count; } jsval v; JSBool ok; if (ctorCall) { JSObject *global = ::JS_GetGlobalForObject(cx, npjsobj->mJSObj); JSObject *newObj = ::JS_ConstructObjectWithArguments(cx, JS_GET_CLASS(cx, npjsobj->mJSObj), nsnull, global, argCount, jsargs); if (newObj) { v = OBJECT_TO_JSVAL(newObj); ok = JS_TRUE; } else { ok = JS_FALSE; } } else { ok = ::JS_CallFunctionValue(cx, npjsobj->mJSObj, fv, argCount, jsargs, &v); } JS_POP_TEMP_ROOT(cx, &tvr); if (jsargs != jsargs_buf) PR_Free(jsargs); if (ok) ok = JSValToNPVariant(npp, cx, v, result); // return ok == JS_TRUE to quiet down compiler warning, even if // return ok is what we really want. return ok == JS_TRUE; } // static bool nsJSObjWrapper::NP_Invoke(NPObject *npobj, NPIdentifier method, const NPVariant *args, uint32_t argCount, NPVariant *result) { if ((jsval)method == JSVAL_VOID) { return PR_FALSE; } return doInvoke(npobj, method, args, argCount, PR_FALSE, result); } // static bool nsJSObjWrapper::NP_InvokeDefault(NPObject *npobj, const NPVariant *args, uint32_t argCount, NPVariant *result) { return doInvoke(npobj, (NPIdentifier)JSVAL_VOID, args, argCount, PR_FALSE, result); } // static bool nsJSObjWrapper::NP_HasProperty(NPObject *npobj, NPIdentifier identifier) { NPP npp = NPPStack::Peek(); JSContext *cx = GetJSContext(npp); if (!cx) { NS_ERROR("Null cx in nsJSObjWrapper::NP_HasProperty!"); return PR_FALSE; } if (!npobj) { ThrowJSException(cx, "Null npobj in nsJSObjWrapper::NP_HasProperty!"); return PR_FALSE; } nsJSObjWrapper *npjsobj = (nsJSObjWrapper *)npobj; jsval id = (jsval)identifier; JSBool found, ok = JS_FALSE; AutoCXPusher pusher(cx); JSAutoRequest ar(cx); AutoJSExceptionReporter reporter(cx); if (JSVAL_IS_STRING(id)) { JSString *str = JSVAL_TO_STRING(id); ok = ::JS_HasUCProperty(cx, npjsobj->mJSObj, ::JS_GetStringChars(str), ::JS_GetStringLength(str), &found); } else { NS_ASSERTION(JSVAL_IS_INT(id), "id must be either string or int!\n"); ok = ::JS_HasElement(cx, npjsobj->mJSObj, JSVAL_TO_INT(id), &found); } return ok && found; } // static bool nsJSObjWrapper::NP_GetProperty(NPObject *npobj, NPIdentifier identifier, NPVariant *result) { NPP npp = NPPStack::Peek(); JSContext *cx = GetJSContext(npp); if (!cx) { NS_ERROR("Null cx in nsJSObjWrapper::NP_GetProperty!"); return PR_FALSE; } if (!npobj) { ThrowJSException(cx, "Null npobj in nsJSObjWrapper::NP_GetProperty!"); return PR_FALSE; } nsJSObjWrapper *npjsobj = (nsJSObjWrapper *)npobj; AutoCXPusher pusher(cx); JSAutoRequest ar(cx); AutoJSExceptionReporter reporter(cx); jsval v; return (GetProperty(cx, npjsobj->mJSObj, identifier, &v) && JSValToNPVariant(npp, cx, v, result)); } // static bool nsJSObjWrapper::NP_SetProperty(NPObject *npobj, NPIdentifier identifier, const NPVariant *value) { NPP npp = NPPStack::Peek(); JSContext *cx = GetJSContext(npp); if (!cx) { NS_ERROR("Null cx in nsJSObjWrapper::NP_SetProperty!"); return PR_FALSE; } if (!npobj) { ThrowJSException(cx, "Null npobj in nsJSObjWrapper::NP_SetProperty!"); return PR_FALSE; } nsJSObjWrapper *npjsobj = (nsJSObjWrapper *)npobj; jsval id = (jsval)identifier; JSBool ok = JS_FALSE; AutoCXPusher pusher(cx); JSAutoRequest ar(cx); AutoJSExceptionReporter reporter(cx); jsval v = NPVariantToJSVal(npp, cx, value); JSAutoTempValueRooter tvr(cx, v); if (JSVAL_IS_STRING(id)) { JSString *str = JSVAL_TO_STRING(id); ok = ::JS_SetUCProperty(cx, npjsobj->mJSObj, ::JS_GetStringChars(str), ::JS_GetStringLength(str), &v); } else { NS_ASSERTION(JSVAL_IS_INT(id), "id must be either string or int!\n"); ok = ::JS_SetElement(cx, npjsobj->mJSObj, JSVAL_TO_INT(id), &v); } // return ok == JS_TRUE to quiet down compiler warning, even if // return ok is what we really want. return ok == JS_TRUE; } // static bool nsJSObjWrapper::NP_RemoveProperty(NPObject *npobj, NPIdentifier identifier) { NPP npp = NPPStack::Peek(); JSContext *cx = GetJSContext(npp); if (!cx) { NS_ERROR("Null cx in nsJSObjWrapper::NP_RemoveProperty!"); return PR_FALSE; } if (!npobj) { ThrowJSException(cx, "Null npobj in nsJSObjWrapper::NP_RemoveProperty!"); return PR_FALSE; } nsJSObjWrapper *npjsobj = (nsJSObjWrapper *)npobj; jsval id = (jsval)identifier; JSBool ok = JS_FALSE; AutoCXPusher pusher(cx); JSAutoRequest ar(cx); AutoJSExceptionReporter reporter(cx); jsval deleted = JSVAL_FALSE; if (JSVAL_IS_STRING(id)) { JSString *str = JSVAL_TO_STRING(id); ok = ::JS_DeleteUCProperty2(cx, npjsobj->mJSObj, ::JS_GetStringChars(str), ::JS_GetStringLength(str), &deleted); if (ok && deleted) { // FIXME: See bug 425823, we shouldn't need to do this, and once // that bug is fixed we can remove this code. JSBool hasProp; ok = ::JS_HasUCProperty(cx, npjsobj->mJSObj, ::JS_GetStringChars(str), ::JS_GetStringLength(str), &hasProp); if (ok && hasProp) { // The property might have been deleted, but it got // re-resolved, so no, it's not really deleted. deleted = JSVAL_FALSE; } } } else { NS_ASSERTION(JSVAL_IS_INT(id), "id must be either string or int!\n"); ok = ::JS_DeleteElement2(cx, npjsobj->mJSObj, JSVAL_TO_INT(id), &deleted); if (ok && deleted) { // FIXME: See bug 425823, we shouldn't need to do this, and once // that bug is fixed we can remove this code. JSBool hasProp; ok = ::JS_HasElement(cx, npjsobj->mJSObj, JSVAL_TO_INT(id), &hasProp); if (ok && hasProp) { // The property might have been deleted, but it got // re-resolved, so no, it's not really deleted. deleted = JSVAL_FALSE; } } } // return ok == JS_TRUE to quiet down compiler warning, even if // return ok is what we really want. return ok == JS_TRUE && deleted == JSVAL_TRUE; } //static bool nsJSObjWrapper::NP_Enumerate(NPObject *npobj, NPIdentifier **identifier, uint32_t *count) { NPP npp = NPPStack::Peek(); JSContext *cx = GetJSContext(npp); *identifier = 0; *count = 0; if (!cx) { NS_ERROR("Null cx in nsJSObjWrapper::NP_Enumerate!"); return PR_FALSE; } if (!npobj) { ThrowJSException(cx, "Null npobj in nsJSObjWrapper::NP_Enumerate!"); return PR_FALSE; } nsJSObjWrapper *npjsobj = (nsJSObjWrapper *)npobj; AutoCXPusher pusher(cx); JSAutoRequest ar(cx); AutoJSExceptionReporter reporter(cx); JSIdArray *ida = ::JS_Enumerate(cx, npjsobj->mJSObj); if (!ida) { return PR_FALSE; } *count = ida->length; *identifier = (NPIdentifier *)PR_Malloc(*count * sizeof(NPIdentifier)); if (!*identifier) { ThrowJSException(cx, "Memory allocation failed for NPIdentifier!"); ::JS_DestroyIdArray(cx, ida); return PR_FALSE; } for (PRUint32 i = 0; i < *count; i++) { jsval v; if (!::JS_IdToValue(cx, ida->vector[i], &v)) { ::JS_DestroyIdArray(cx, ida); PR_Free(*identifier); return PR_FALSE; } if (JSVAL_IS_STRING(v)) { JSString *str = JSVAL_TO_STRING(v); if (!JS_InternUCStringN(cx, ::JS_GetStringChars(str), ::JS_GetStringLength(str))) { ::JS_DestroyIdArray(cx, ida); PR_Free(*identifier); return PR_FALSE; } } else { NS_ASSERTION(JSVAL_IS_INT(v), "The element in ida must be either string or int!\n"); } (*identifier)[i] = (NPIdentifier)v; } ::JS_DestroyIdArray(cx, ida); return PR_TRUE; } //static bool nsJSObjWrapper::NP_Construct(NPObject *npobj, const NPVariant *args, uint32_t argCount, NPVariant *result) { return doInvoke(npobj, (NPIdentifier)JSVAL_VOID, args, argCount, PR_TRUE, result); } class JSObjWrapperHashEntry : public PLDHashEntryHdr { public: nsJSObjWrapper *mJSObjWrapper; }; static PLDHashNumber JSObjWrapperHash(PLDHashTable *table, const void *key) { const nsJSObjWrapperKey *e = static_cast(key); return (PLDHashNumber)((PRWord)e->mJSObj ^ (PRWord)e->mNpp) >> 2; } static PRBool JSObjWrapperHashMatchEntry(PLDHashTable *table, const PLDHashEntryHdr *entry, const void *key) { const nsJSObjWrapperKey *objWrapperKey = static_cast(key); const JSObjWrapperHashEntry *e = static_cast(entry); return (e->mJSObjWrapper->mJSObj == objWrapperKey->mJSObj && e->mJSObjWrapper->mNpp == objWrapperKey->mNpp); } // Look up or create an NPObject that wraps the JSObject obj. // static NPObject * nsJSObjWrapper::GetNewOrUsed(NPP npp, JSContext *cx, JSObject *obj) { if (!npp) { NS_ERROR("Null NPP passed to nsJSObjWrapper::GetNewOrUsed()!"); return nsnull; } if (!cx) { cx = GetJSContext(npp); if (!cx) { NS_ERROR("Unable to find a JSContext in " "nsJSObjWrapper::GetNewOrUsed()!"); return nsnull; } } JSClass *clazz = JS_GET_CLASS(cx, obj); if (clazz == &sNPObjectJSWrapperClass) { // obj is one of our own, its private data is the NPObject we're // looking for. NPObject *npobj = (NPObject *)::JS_GetPrivate(cx, obj); if (LookupNPP(npobj) == npp) return _retainobject(npobj); } if (!sJSObjWrappers.ops) { // No hash yet (or any more), initialize it. static PLDHashTableOps ops = { PL_DHashAllocTable, PL_DHashFreeTable, JSObjWrapperHash, JSObjWrapperHashMatchEntry, PL_DHashMoveEntryStub, PL_DHashClearEntryStub, PL_DHashFinalizeStub }; if (!PL_DHashTableInit(&sJSObjWrappers, &ops, nsnull, sizeof(JSObjWrapperHashEntry), 16)) { NS_ERROR("Error initializing PLDHashTable!"); return nsnull; } } nsJSObjWrapperKey key(obj, npp); JSObjWrapperHashEntry *entry = static_cast (PL_DHashTableOperate(&sJSObjWrappers, &key, PL_DHASH_ADD)); if (!entry) { // Out of memory. return nsnull; } if (PL_DHASH_ENTRY_IS_BUSY(entry) && entry->mJSObjWrapper) { // Found a live nsJSObjWrapper, return it. return _retainobject(entry->mJSObjWrapper); } // No existing nsJSObjWrapper, create one. nsJSObjWrapper *wrapper = (nsJSObjWrapper *)_createobject(npp, &sJSObjWrapperNPClass); if (!wrapper) { // OOM? Remove the stale entry from the hash. PL_DHashTableRawRemove(&sJSObjWrappers, entry); return nsnull; } wrapper->mJSObj = obj; entry->mJSObjWrapper = wrapper; NS_ASSERTION(wrapper->mNpp == npp, "nsJSObjWrapper::mNpp not initialized!"); JSAutoRequest ar(cx); // Root the JSObject, its lifetime is now tied to that of the // NPObject. if (!::JS_AddNamedRoot(cx, &wrapper->mJSObj, "nsJSObjWrapper::mJSObject")) { NS_ERROR("Failed to root JSObject!"); _releaseobject(wrapper); PL_DHashTableRawRemove(&sJSObjWrappers, entry); return nsnull; } return wrapper; } static NPObject * GetNPObject(JSContext *cx, JSObject *obj) { while (obj && JS_GET_CLASS(cx, obj) != &sNPObjectJSWrapperClass) { obj = ::JS_GetPrototype(cx, obj); } if (!obj) { return nsnull; } return (NPObject *)::JS_GetPrivate(cx, obj); } // Does not actually add a property because this is always followed by a // SetProperty call. static JSBool NPObjWrapper_AddProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp) { NPObject *npobj = GetNPObject(cx, obj); if (!npobj || !npobj->_class || !npobj->_class->hasProperty || !npobj->_class->hasMethod) { ThrowJSException(cx, "Bad NPObject as private data!"); return JS_FALSE; } PluginDestructionGuard pdg(LookupNPP(npobj)); JSBool hasProperty = npobj->_class->hasProperty(npobj, (NPIdentifier)id); if (!ReportExceptionIfPending(cx)) return JS_FALSE; if (hasProperty) return JS_TRUE; // We must permit methods here since JS_DefineUCFunction() will add // the function as a property JSBool hasMethod = npobj->_class->hasMethod(npobj, (NPIdentifier)id); if (!ReportExceptionIfPending(cx)) return JS_FALSE; if (!hasMethod) { ThrowJSException(cx, "Trying to add unsupported property on NPObject!"); return JS_FALSE; } return JS_TRUE; } static JSBool NPObjWrapper_DelProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp) { NPObject *npobj = GetNPObject(cx, obj); if (!npobj || !npobj->_class || !npobj->_class->hasProperty || !npobj->_class->removeProperty) { ThrowJSException(cx, "Bad NPObject as private data!"); return JS_FALSE; } PluginDestructionGuard pdg(LookupNPP(npobj)); JSBool hasProperty = npobj->_class->hasProperty(npobj, (NPIdentifier)id); if (!ReportExceptionIfPending(cx)) return JS_FALSE; if (!hasProperty) return JS_TRUE; if (!npobj->_class->removeProperty(npobj, (NPIdentifier)id)) *vp = JSVAL_FALSE; return ReportExceptionIfPending(cx); } static JSBool NPObjWrapper_SetProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp) { NPObject *npobj = GetNPObject(cx, obj); if (!npobj || !npobj->_class || !npobj->_class->hasProperty || !npobj->_class->setProperty) { ThrowJSException(cx, "Bad NPObject as private data!"); return JS_FALSE; } // Find out what plugin (NPP) is the owner of the object we're // manipulating, and make it own any JSObject wrappers created here. NPP npp = LookupNPP(npobj); if (!npp) { ThrowJSException(cx, "No NPP found for NPObject!"); return JS_FALSE; } PluginDestructionGuard pdg(npp); JSBool hasProperty = npobj->_class->hasProperty(npobj, (NPIdentifier)id); if (!ReportExceptionIfPending(cx)) return JS_FALSE; if (!hasProperty) { ThrowJSException(cx, "Trying to set unsupported property on NPObject!"); return JS_FALSE; } NPVariant npv; if (!JSValToNPVariant(npp, cx, *vp, &npv)) { ThrowJSException(cx, "Error converting jsval to NPVariant!"); return JS_FALSE; } JSBool ok = npobj->_class->setProperty(npobj, (NPIdentifier)id, &npv); _releasevariantvalue(&npv); // Release the variant if (!ReportExceptionIfPending(cx)) return JS_FALSE; if (!ok) { ThrowJSException(cx, "Error setting property on NPObject!"); return JS_FALSE; } return JS_TRUE; } static JSBool NPObjWrapper_GetProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp) { NPObject *npobj = GetNPObject(cx, obj); if (!npobj || !npobj->_class || !npobj->_class->hasProperty || !npobj->_class->hasMethod || !npobj->_class->getProperty) { ThrowJSException(cx, "Bad NPObject as private data!"); return JS_FALSE; } // Find out what plugin (NPP) is the owner of the object we're // manipulating, and make it own any JSObject wrappers created here. NPP npp = LookupNPP(npobj); if (!npp) { ThrowJSException(cx, "No NPP found for NPObject!"); return JS_FALSE; } PluginDestructionGuard pdg(npp); PRBool hasProperty = npobj->_class->hasProperty(npobj, (NPIdentifier)id); if (!ReportExceptionIfPending(cx)) return JS_FALSE; PRBool hasMethod = npobj->_class->hasMethod(npobj, (NPIdentifier)id); if (!ReportExceptionIfPending(cx)) return JS_FALSE; // We return NPObject Member class here to support ambiguous members. if (hasProperty && hasMethod) return CreateNPObjectMember(npp, cx, obj, npobj, id, vp); if (hasProperty) { NPVariant npv; VOID_TO_NPVARIANT(npv); if (npobj->_class->getProperty(npobj, (NPIdentifier)id, &npv)) *vp = NPVariantToJSVal(npp, cx, &npv); _releasevariantvalue(&npv); if (!ReportExceptionIfPending(cx)) return JS_FALSE; } return JS_TRUE; } static JSBool CallNPMethodInternal(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsval *rval, PRBool ctorCall) { while (obj && JS_GET_CLASS(cx, obj) != &sNPObjectJSWrapperClass) { obj = ::JS_GetPrototype(cx, obj); } if (!obj) { ThrowJSException(cx, "NPMethod called on non-NPObject wrapped JSObject!"); return JS_FALSE; } NPObject *npobj = (NPObject *)::JS_GetPrivate(cx, obj); if (!npobj || !npobj->_class || !npobj->_class->invoke) { ThrowJSException(cx, "Bad NPObject as private data!"); return JS_FALSE; } // Find out what plugin (NPP) is the owner of the object we're // manipulating, and make it own any JSObject wrappers created here. NPP npp = LookupNPP(npobj); if (!npp) { ThrowJSException(cx, "Error finding NPP for NPObject!"); return JS_FALSE; } PluginDestructionGuard pdg(npp); NPVariant npargs_buf[8]; NPVariant *npargs = npargs_buf; if (argc > (sizeof(npargs_buf) / sizeof(NPVariant))) { // Our stack buffer isn't large enough to hold all arguments, // malloc a buffer. npargs = (NPVariant *)PR_Malloc(argc * sizeof(NPVariant)); if (!npargs) { ThrowJSException(cx, "Out of memory!"); return JS_FALSE; } } // Convert arguments PRUint32 i; for (i = 0; i < argc; ++i) { if (!JSValToNPVariant(npp, cx, argv[i], npargs + i)) { ThrowJSException(cx, "Error converting jsvals to NPVariants!"); if (npargs != npargs_buf) { PR_Free(npargs); } return JS_FALSE; } } NPVariant v; VOID_TO_NPVARIANT(v); JSObject *funobj = JSVAL_TO_OBJECT(argv[-2]); JSBool ok; const char *msg = "Error calling method on NPObject!"; if (ctorCall) { // construct a new NPObject based on the NPClass in npobj. Fail if // no construct method is available. if (NP_CLASS_STRUCT_VERSION_HAS_CTOR(npobj->_class) && npobj->_class->construct) { ok = npobj->_class->construct(npobj, npargs, argc, &v); } else { ok = JS_FALSE; msg = "Attempt to construct object from class with no constructor."; } } else if (funobj != obj) { // A obj.function() style call is made, get the method name from // the function object. if (npobj->_class->invoke) { JSFunction *fun = (JSFunction *)::JS_GetPrivate(cx, funobj); jsval method = STRING_TO_JSVAL(::JS_GetFunctionId(fun)); ok = npobj->_class->invoke(npobj, (NPIdentifier)method, npargs, argc, &v); } else { ok = JS_FALSE; msg = "Attempt to call a method on object with no invoke method."; } } else { if (npobj->_class->invokeDefault) { // obj is a callable object that is being called, no method name // available then. Invoke the default method. ok = npobj->_class->invokeDefault(npobj, npargs, argc, &v); } else { ok = JS_FALSE; msg = "Attempt to call a default method on object with no " "invokeDefault method."; } } // Release arguments. for (i = 0; i < argc; ++i) { _releasevariantvalue(npargs + i); } if (npargs != npargs_buf) { PR_Free(npargs); } if (!ok) { // ReportExceptionIfPending returns a return value, which is JS_TRUE // if no exception was thrown. In that case, throw our own. if (ReportExceptionIfPending(cx)) ThrowJSException(cx, msg); return JS_FALSE; } *rval = NPVariantToJSVal(npp, cx, &v); // *rval now owns the value, release our reference. _releasevariantvalue(&v); return ReportExceptionIfPending(cx); } static JSBool CallNPMethod(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsval *rval) { return CallNPMethodInternal(cx, obj, argc, argv, rval, PR_FALSE); } struct NPObjectEnumerateState { PRUint32 index; PRUint32 length; NPIdentifier *value; }; static JSBool NPObjWrapper_newEnumerate(JSContext *cx, JSObject *obj, JSIterateOp enum_op, jsval *statep, jsid *idp) { NPObject *npobj = GetNPObject(cx, obj); NPIdentifier *enum_value; uint32_t length; NPObjectEnumerateState *state; if (!npobj || !npobj->_class) { ThrowJSException(cx, "Bad NPObject as private data!"); return JS_FALSE; } PluginDestructionGuard pdg(LookupNPP(npobj)); NS_ASSERTION(statep, "Must have a statep to enumerate!"); switch(enum_op) { case JSENUMERATE_INIT: state = new NPObjectEnumerateState(); if (!state) { ThrowJSException(cx, "Memory allocation failed for " "NPObjectEnumerateState!"); return JS_FALSE; } if (!NP_CLASS_STRUCT_VERSION_HAS_ENUM(npobj->_class) || !npobj->_class->enumerate) { enum_value = 0; length = 0; } else if (!npobj->_class->enumerate(npobj, &enum_value, &length)) { delete state; if (ReportExceptionIfPending(cx)) { // ReportExceptionIfPending returns a return value, which is JS_TRUE // if no exception was thrown. In that case, throw our own. ThrowJSException(cx, "Error enumerating properties on scriptable " "plugin object"); } return JS_FALSE; } state->value = enum_value; state->length = length; state->index = 0; *statep = PRIVATE_TO_JSVAL(state); if (idp) { *idp = INT_TO_JSVAL(length); } break; case JSENUMERATE_NEXT: state = (NPObjectEnumerateState *)JSVAL_TO_PRIVATE(*statep); enum_value = state->value; length = state->length; if (state->index != length) { return ::JS_ValueToId(cx, (jsval)enum_value[state->index++], idp); } // FALL THROUGH case JSENUMERATE_DESTROY: state = (NPObjectEnumerateState *)JSVAL_TO_PRIVATE(*statep); if (state->value) PR_Free(state->value); delete state; *statep = JSVAL_NULL; break; } return JS_TRUE; } static JSBool NPObjWrapper_NewResolve(JSContext *cx, JSObject *obj, jsval id, uintN flags, JSObject **objp) { NPObject *npobj = GetNPObject(cx, obj); if (!npobj || !npobj->_class || !npobj->_class->hasProperty || !npobj->_class->hasMethod) { ThrowJSException(cx, "Bad NPObject as private data!"); return JS_FALSE; } PluginDestructionGuard pdg(LookupNPP(npobj)); PRBool hasProperty = npobj->_class->hasProperty(npobj, (NPIdentifier)id); if (!ReportExceptionIfPending(cx)) return JS_FALSE; if (hasProperty) { JSBool ok; if (JSVAL_IS_STRING(id)) { JSString *str = JSVAL_TO_STRING(id); ok = ::JS_DefineUCProperty(cx, obj, ::JS_GetStringChars(str), ::JS_GetStringLength(str), JSVAL_VOID, nsnull, nsnull, JSPROP_ENUMERATE); } else { ok = ::JS_DefineElement(cx, obj, JSVAL_TO_INT(id), JSVAL_VOID, nsnull, nsnull, JSPROP_ENUMERATE); } if (!ok) { return JS_FALSE; } *objp = obj; return JS_TRUE; } PRBool hasMethod = npobj->_class->hasMethod(npobj, (NPIdentifier)id); if (!ReportExceptionIfPending(cx)) return JS_FALSE; if (hasMethod) { JSString *str = nsnull; if (JSVAL_IS_STRING(id)) { str = JSVAL_TO_STRING(id); } else { NS_ASSERTION(JSVAL_IS_INT(id), "id must be either string or int!\n"); str = ::JS_ValueToString(cx, id); if (!str) { // OOM. The JS engine throws exceptions for us in this case. return JS_FALSE; } } JSFunction *fnc = ::JS_DefineUCFunction(cx, obj, ::JS_GetStringChars(str), ::JS_GetStringLength(str), CallNPMethod, 0, JSPROP_ENUMERATE); *objp = obj; return fnc != nsnull; } // no property or method return JS_TRUE; } static JSBool NPObjWrapper_Convert(JSContext *cx, JSObject *obj, JSType type, jsval *vp) { // The sole reason we implement this hook is to prevent the JS // engine from calling valueOf() on NPObject's. Some NPObject's may // actually implement a method named valueOf, but it's unlikely to // behave as the JS engine expects it to. IOW, this is an empty hook // that overrides what the default hook does. return JS_TRUE; } static void NPObjWrapper_Finalize(JSContext *cx, JSObject *obj) { NPObject *npobj = (NPObject *)::JS_GetPrivate(cx, obj); if (npobj) { if (sNPObjWrappers.ops) { PL_DHashTableOperate(&sNPObjWrappers, npobj, PL_DHASH_REMOVE); } } if (!sDelayedReleases) sDelayedReleases = new nsTArray; sDelayedReleases->AppendElement(npobj); } static JSBool NPObjWrapper_Call(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsval *rval) { return CallNPMethodInternal(cx, JSVAL_TO_OBJECT(argv[-2]), argc, argv, rval, PR_FALSE); } static JSBool NPObjWrapper_Construct(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsval *rval) { return CallNPMethodInternal(cx, JSVAL_TO_OBJECT(argv[-2]), argc, argv, rval, PR_TRUE); } class NPObjWrapperHashEntry : public PLDHashEntryHdr { public: NPObject *mNPObj; // Must be the first member for the PLDHash stubs to work JSObject *mJSObj; NPP mNpp; }; // An NPObject is going away, make sure we null out the JS object's // private data in case this is an NPObject that came from a plugin // and it's destroyed prematurely. // static void nsNPObjWrapper::OnDestroy(NPObject *npobj) { if (!npobj) { return; } if (npobj->_class == &nsJSObjWrapper::sJSObjWrapperNPClass) { // npobj is one of our own, no private data to clean up here. return; } if (!sNPObjWrappers.ops) { // No hash yet (or any more), no used wrappers available. return; } NPObjWrapperHashEntry *entry = static_cast (PL_DHashTableOperate(&sNPObjWrappers, npobj, PL_DHASH_LOOKUP)); if (PL_DHASH_ENTRY_IS_BUSY(entry) && entry->mJSObj) { // Found a live NPObject wrapper, null out its JSObjects' private // data. JSContext *cx = GetJSContext(entry->mNpp); if (cx) { ::JS_SetPrivate(cx, entry->mJSObj, nsnull); } // Remove the npobj from the hash now that it went away. PL_DHashTableRawRemove(&sNPObjWrappers, entry); OnWrapperDestroyed(); } } // Look up or create a JSObject that wraps the NPObject npobj. // static JSObject * nsNPObjWrapper::GetNewOrUsed(NPP npp, JSContext *cx, NPObject *npobj) { if (!npobj) { NS_ERROR("Null NPObject passed to nsNPObjWrapper::GetNewOrUsed()!"); return nsnull; } if (npobj->_class == &nsJSObjWrapper::sJSObjWrapperNPClass) { // npobj is one of our own, return its existing JSObject. return ((nsJSObjWrapper *)npobj)->mJSObj; } if (!npp) { NS_ERROR("No npp passed to nsNPObjWrapper::GetNewOrUsed()!"); return nsnull; } if (!sNPObjWrappers.ops) { // No hash yet (or any more), initialize it. if (!PL_DHashTableInit(&sNPObjWrappers, PL_DHashGetStubOps(), nsnull, sizeof(NPObjWrapperHashEntry), 16)) { NS_ERROR("Error initializing PLDHashTable!"); return nsnull; } } NPObjWrapperHashEntry *entry = static_cast (PL_DHashTableOperate(&sNPObjWrappers, npobj, PL_DHASH_ADD)); if (!entry) { // Out of memory JS_ReportOutOfMemory(cx); return nsnull; } if (PL_DHASH_ENTRY_IS_BUSY(entry) && entry->mJSObj) { // Found a live NPObject wrapper, return it. return entry->mJSObj; } entry->mNPObj = npobj; entry->mNpp = npp; JSAutoRequest ar(cx); PRUint32 generation = sNPObjWrappers.generation; // No existing JSObject, create one. JSObject *obj = ::JS_NewObject(cx, &sNPObjectJSWrapperClass, nsnull, nsnull); if (generation != sNPObjWrappers.generation) { // Reload entry if the JS_NewObject call caused a GC and reallocated // the table (see bug 445229). This is guaranteed to succeed. entry = static_cast (PL_DHashTableOperate(&sNPObjWrappers, npobj, PL_DHASH_LOOKUP)); NS_ASSERTION(entry && PL_DHASH_ENTRY_IS_BUSY(entry), "Hashtable didn't find what we just added?"); } if (!obj) { // OOM? Remove the stale entry from the hash. PL_DHashTableRawRemove(&sNPObjWrappers, entry); return nsnull; } OnWrapperCreated(); entry->mJSObj = obj; // JS_SetPrivate() never fails. ::JS_SetPrivate(cx, obj, npobj); // The new JSObject now holds on to npobj _retainobject(npobj); return obj; } // PLDHashTable enumeration callbacks for destruction code. static PLDHashOperator JSObjWrapperPluginDestroyedCallback(PLDHashTable *table, PLDHashEntryHdr *hdr, PRUint32 number, void *arg) { JSObjWrapperHashEntry *entry = (JSObjWrapperHashEntry *)hdr; nsJSObjWrapper *npobj = entry->mJSObjWrapper; if (npobj->mNpp == arg) { // Prevent invalidate() and _releaseobject() from touching the hash // we're enumerating. const PLDHashTableOps *ops = table->ops; table->ops = nsnull; if (npobj->_class && npobj->_class->invalidate) { npobj->_class->invalidate(npobj); } _releaseobject(npobj); table->ops = ops; return PL_DHASH_REMOVE; } return PL_DHASH_NEXT; } // Struct for passing an NPP and a JSContext to // NPObjWrapperPluginDestroyedCallback struct NppAndCx { NPP npp; JSContext *cx; }; static PLDHashOperator NPObjWrapperPluginDestroyedCallback(PLDHashTable *table, PLDHashEntryHdr *hdr, PRUint32 number, void *arg) { NPObjWrapperHashEntry *entry = (NPObjWrapperHashEntry *)hdr; NppAndCx *nppcx = reinterpret_cast(arg); if (entry->mNpp == nppcx->npp) { // Prevent invalidate() and deallocate() from touching the hash // we're enumerating. const PLDHashTableOps *ops = table->ops; table->ops = nsnull; NPObject *npobj = entry->mNPObj; if (npobj->_class && npobj->_class->invalidate) { npobj->_class->invalidate(npobj); } #ifdef NS_BUILD_REFCNT_LOGGING { int32_t refCnt = npobj->referenceCount; while (refCnt) { --refCnt; NS_LOG_RELEASE(npobj, refCnt, "BrowserNPObject"); } } #endif // Force deallocation of plugin objects since the plugin they came // from is being torn down. if (npobj->_class && npobj->_class->deallocate) { npobj->_class->deallocate(npobj); } else { PR_Free(npobj); } ::JS_SetPrivate(nppcx->cx, entry->mJSObj, nsnull); table->ops = ops; return PL_DHASH_REMOVE; } return PL_DHASH_NEXT; } // static void nsJSNPRuntime::OnPluginDestroy(NPP npp) { if (sJSObjWrappers.ops) { PL_DHashTableEnumerate(&sJSObjWrappers, JSObjWrapperPluginDestroyedCallback, npp); } // Use the safe JSContext here as we're not always able to find the // JSContext associated with the NPP any more. nsCOMPtr stack = do_GetService("@mozilla.org/js/xpc/ContextStack;1"); if (!stack) { NS_ERROR("No context stack available!"); return; } JSContext *cx; stack->GetSafeJSContext(&cx); if (!cx) { NS_ERROR("No safe JS context available!"); return; } JSAutoRequest ar(cx); if (sNPObjWrappers.ops) { NppAndCx nppcx = { npp, cx }; PL_DHashTableEnumerate(&sNPObjWrappers, NPObjWrapperPluginDestroyedCallback, &nppcx); } // If this plugin was scripted from a webpage, the plugin's // scriptable object will be on the DOM element's prototype // chain. Now that the plugin is being destroyed we need to pull the // plugin's scriptable object out of that prototype chain. if (!npp) { return; } // Find the plugin instance so that we can (eventually) get to the // DOM element nsNPAPIPluginInstance *inst = (nsNPAPIPluginInstance *)npp->ndata; if (!inst) return; nsCOMPtr element; inst->GetDOMElement(getter_AddRefs(element)); if (!element) return; // Get the DOM element's JS object. nsCOMPtr xpc(do_GetService(nsIXPConnect::GetCID())); if (!xpc) return; // OK. Now we have to get our hands on the right scope object, since // GetWrappedNativeOfNativeObject doesn't call PreCreate and hence won't get // the right scope if we pass in something bogus. The right scope lives on // the script global of the element's document. // XXXbz we MUST have a better way of doing this... perhaps // GetWrappedNativeOfNativeObject _should_ call preCreate? nsCOMPtr content(do_QueryInterface(element)); if (!content) { return; } nsIDocument* doc = content->GetOwnerDoc(); if (!doc) { return; } nsIScriptGlobalObject* sgo = doc->GetScriptGlobalObject(); if (!sgo) { return; } nsCOMPtr node(do_QueryInterface(element)); JSObject *obj; if (!node || !(obj = node->GetWrapper())) { return; } JSObject *proto; // Loop over the DOM element's JS object prototype chain and remove // all JS objects of the class sNPObjectJSWrapperClass (there should // be only one, but remove all instances found in case the page put // more than one of the plugin's scriptable objects on the prototype // chain). while (obj && (proto = ::JS_GetPrototype(cx, obj))) { if (JS_GET_CLASS(cx, proto) == &sNPObjectJSWrapperClass) { // We found an NPObject on the proto chain, get its prototype... proto = ::JS_GetPrototype(cx, proto); // ... and pull it out of the chain. ::JS_SetPrototype(cx, obj, proto); } obj = proto; } } // Find the NPP for a NPObject. static NPP LookupNPP(NPObject *npobj) { if (npobj->_class == &nsJSObjWrapper::sJSObjWrapperNPClass) { nsJSObjWrapper* o = static_cast(npobj); return o->mNpp; } NPObjWrapperHashEntry *entry = static_cast (PL_DHashTableOperate(&sNPObjWrappers, npobj, PL_DHASH_ADD)); if (PL_DHASH_ENTRY_IS_FREE(entry)) { return nsnull; } NS_ASSERTION(entry->mNpp, "Live NPObject entry w/o an NPP!"); return entry->mNpp; } JSBool CreateNPObjectMember(NPP npp, JSContext *cx, JSObject *obj, NPObject* npobj, jsval id, jsval *vp) { NS_ENSURE_TRUE(vp, JS_FALSE); if (!npobj || !npobj->_class || !npobj->_class->getProperty || !npobj->_class->invoke) { ThrowJSException(cx, "Bad NPObject"); return JS_FALSE; } NPObjectMemberPrivate *memberPrivate = (NPObjectMemberPrivate *)PR_Malloc(sizeof(NPObjectMemberPrivate)); if (!memberPrivate) return JS_FALSE; // Make sure to clear all members in case something fails here // during initialization. memset(memberPrivate, 0, sizeof(NPObjectMemberPrivate)); JSObject *memobj = ::JS_NewObject(cx, &sNPObjectMemberClass, nsnull, nsnull); if (!memobj) { PR_Free(memberPrivate); return JS_FALSE; } *vp = OBJECT_TO_JSVAL(memobj); ::JS_AddRoot(cx, vp); ::JS_SetPrivate(cx, memobj, (void *)memberPrivate); jsval fieldValue; NPVariant npv; VOID_TO_NPVARIANT(npv); NPBool hasProperty = npobj->_class->getProperty(npobj, (NPIdentifier)id, &npv); if (ReportExceptionIfPending(cx)) { ::JS_RemoveRoot(cx, vp); return JS_FALSE; } if (!hasProperty) { ::JS_RemoveRoot(cx, vp); return JS_FALSE; } fieldValue = NPVariantToJSVal(npp, cx, &npv); // npobjWrapper is the JSObject through which we make sure we don't // outlive the underlying NPObject, so make sure it points to the // real JSObject wrapper for the NPObject. while (JS_GET_CLASS(cx, obj) != &sNPObjectJSWrapperClass) { obj = ::JS_GetPrototype(cx, obj); } memberPrivate->npobjWrapper = obj; memberPrivate->fieldValue = fieldValue; memberPrivate->methodName = id; memberPrivate->npp = npp; ::JS_RemoveRoot(cx, vp); return JS_TRUE; } static JSBool NPObjectMember_Convert(JSContext *cx, JSObject *obj, JSType type, jsval *vp) { NPObjectMemberPrivate *memberPrivate = (NPObjectMemberPrivate *)::JS_GetInstancePrivate(cx, obj, &sNPObjectMemberClass, nsnull); if (!memberPrivate) { NS_ERROR("no Ambiguous Member Private data!"); return JS_FALSE; } switch (type) { case JSTYPE_VOID: case JSTYPE_STRING: case JSTYPE_NUMBER: case JSTYPE_BOOLEAN: case JSTYPE_OBJECT: *vp = memberPrivate->fieldValue; return JS_TRUE; case JSTYPE_FUNCTION: // Leave this to NPObjectMember_Call. return JS_TRUE; default: NS_ERROR("illegal operation on JSObject prototype object"); return JS_FALSE; } } static void NPObjectMember_Finalize(JSContext *cx, JSObject *obj) { NPObjectMemberPrivate *memberPrivate; memberPrivate = (NPObjectMemberPrivate *)::JS_GetPrivate(cx, obj); if (!memberPrivate) return; PR_Free(memberPrivate); } static JSBool NPObjectMember_Call(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsval *rval) { JSObject *memobj = JSVAL_TO_OBJECT(argv[-2]); NS_ENSURE_TRUE(memobj, JS_FALSE); NPObjectMemberPrivate *memberPrivate = (NPObjectMemberPrivate *)::JS_GetInstancePrivate(cx, memobj, &sNPObjectMemberClass, argv); if (!memberPrivate || !memberPrivate->npobjWrapper) return JS_FALSE; NPObject *npobj = GetNPObject(cx, memberPrivate->npobjWrapper); if (!npobj) { ThrowJSException(cx, "Call on invalid member object"); return JS_FALSE; } NPVariant npargs_buf[8]; NPVariant *npargs = npargs_buf; if (argc > (sizeof(npargs_buf) / sizeof(NPVariant))) { // Our stack buffer isn't large enough to hold all arguments, // malloc a buffer. npargs = (NPVariant *)PR_Malloc(argc * sizeof(NPVariant)); if (!npargs) { ThrowJSException(cx, "Out of memory!"); return JS_FALSE; } } // Convert arguments PRUint32 i; for (i = 0; i < argc; ++i) { if (!JSValToNPVariant(memberPrivate->npp, cx, argv[i], npargs + i)) { ThrowJSException(cx, "Error converting jsvals to NPVariants!"); if (npargs != npargs_buf) { PR_Free(npargs); } return JS_FALSE; } } NPVariant npv; JSBool ok; ok = npobj->_class->invoke(npobj, (NPIdentifier)memberPrivate->methodName, npargs, argc, &npv); // Release arguments. for (i = 0; i < argc; ++i) { _releasevariantvalue(npargs + i); } if (npargs != npargs_buf) { PR_Free(npargs); } if (!ok) { // ReportExceptionIfPending returns a return value, which is JS_TRUE // if no exception was thrown. In that case, throw our own. if (ReportExceptionIfPending(cx)) ThrowJSException(cx, "Error calling method on NPObject!"); return JS_FALSE; } *rval = NPVariantToJSVal(memberPrivate->npp, cx, &npv); // *rval now owns the value, release our reference. _releasevariantvalue(&npv); return ReportExceptionIfPending(cx); } static uint32 NPObjectMember_Mark(JSContext *cx, JSObject *obj, void *arg) { NPObjectMemberPrivate *memberPrivate = (NPObjectMemberPrivate *)::JS_GetInstancePrivate(cx, obj, &sNPObjectMemberClass, nsnull); if (!memberPrivate) return 0; if (!JSVAL_IS_PRIMITIVE(memberPrivate->fieldValue)) { ::JS_MarkGCThing(cx, JSVAL_TO_OBJECT(memberPrivate->fieldValue), "NPObject Member => fieldValue", arg); } // There's no strong reference from our private data to the // NPObject, so make sure to mark the NPObject wrapper to keep the // NPObject alive as long as this NPObjectMember is alive. if (memberPrivate->npobjWrapper) { ::JS_MarkGCThing(cx, memberPrivate->npobjWrapper, "NPObject Member => npobjWrapper", arg); } return 0; }