dlls/mshtml/nsevents.c

   1 /*
   2  * Copyright 2007-2008 Jacek Caban for CodeWeavers
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 #include <stdarg.h>
  20 #include <assert.h>
  21
  22 #define COBJMACROS
  23
  24 #include "windef.h"
  25 #include "winbase.h"
  26 #include "winuser.h"
  27 #include "ole2.h"
  28 #include "mshtmcid.h"
  29 #include "shlguid.h"
  30
  31 #include "wine/debug.h"
  32
  33 #include "mshtml_private.h"
  34 #include "htmlscript.h"
  35 #include "htmlevent.h"
  36 #include "binding.h"
  37 #include "resource.h"
  38
  39 WINE_DEFAULT_DEBUG_CHANNEL(mshtml);
  40
  41 typedef struct {
  42     nsIDOMEventListener nsIDOMEventListener_iface;
  43     nsDocumentEventListener *This;
  44 } nsEventListener;
  45
  46 struct nsDocumentEventListener {
  47     nsEventListener blur_listener;
  48     nsEventListener focus_listener;
  49     nsEventListener keypress_listener;
  50     nsEventListener load_listener;
  51     nsEventListener htmlevent_listener;
  52
  53     LONG ref;
  54
  55     HTMLDocumentNode *doc;
  56 };
  57
  58 static LONG release_listener(nsDocumentEventListener *This)
  59 {
  60     LONG ref = InterlockedDecrement(&This->ref);
  61
  62     TRACE("(%p) ref=%d\n", This, ref);
  63
  64     if(!ref)
  65         heap_free(This);
  66
  67     return ref;
  68 }
  69
  70 static inline nsEventListener *impl_from_nsIDOMEventListener(nsIDOMEventListener *iface)
  71 {
  72     return CONTAINING_RECORD(iface, nsEventListener, nsIDOMEventListener_iface);
  73 }
  74
  75 static nsresult NSAPI nsDOMEventListener_QueryInterface(nsIDOMEventListener *iface,
  76         nsIIDRef riid, void **result)
  77 {
  78     nsEventListener *This = impl_from_nsIDOMEventListener(iface);
  79
  80     *result = NULL;
  81
  82     if(IsEqualGUID(&IID_nsISupports, riid)) {
  83         TRACE("(%p)->(IID_nsISupports, %p)\n", This, result);
  84         *result = &This->nsIDOMEventListener_iface;
  85     }else if(IsEqualGUID(&IID_nsIDOMEventListener, riid)) {
  86         TRACE("(%p)->(IID_nsIDOMEventListener %p)\n", This, result);
  87         *result = &This->nsIDOMEventListener_iface;
  88     }
  89
  90     if(*result) {
  91         nsIDOMEventListener_AddRef(&This->nsIDOMEventListener_iface);
  92         return NS_OK;
  93     }
  94
  95     TRACE("(%p)->(%s %p)\n", This, debugstr_guid(riid), result);
  96     return NS_NOINTERFACE;
  97 }
  98
  99 static nsrefcnt NSAPI nsDOMEventListener_AddRef(nsIDOMEventListener *iface)
 100 {
 101     nsEventListener *This = impl_from_nsIDOMEventListener(iface);
 102     LONG ref = InterlockedIncrement(&This->This->ref);
 103
 104     TRACE("(%p) ref=%d\n", This->This, ref);
 105
 106     return ref;
 107 }
 108
 109 static nsrefcnt NSAPI nsDOMEventListener_Release(nsIDOMEventListener *iface)
 110 {
 111     nsEventListener *This = impl_from_nsIDOMEventListener(iface);
 112
 113     return release_listener(This->This);
 114 }
 115
 116 static BOOL is_doc_child_focus(GeckoBrowser *nscontainer)
 117 {
 118     HWND hwnd;
 119
 120     for(hwnd = GetFocus(); hwnd && hwnd != nscontainer->hwnd; hwnd = GetParent(hwnd));
 121
 122     return hwnd != NULL;
 123 }
 124
 125 static nsresult NSAPI handle_blur(nsIDOMEventListener *iface, nsIDOMEvent *event)
 126 {
 127     nsEventListener *This = impl_from_nsIDOMEventListener(iface);
 128     HTMLDocumentNode *doc = This->This->doc;
 129     HTMLDocumentObj *doc_obj;
 130
 131     TRACE("(%p)\n", doc);
 132
 133     if(!doc || !doc->basedoc.doc_obj)
 134         return NS_ERROR_FAILURE;
 135     doc_obj = doc->basedoc.doc_obj;
 136
 137     if(doc_obj->focus && !is_doc_child_focus(doc_obj->nscontainer)) {
 138         doc_obj->focus = FALSE;
 139         notif_focus(doc_obj);
 140     }
 141
 142     return NS_OK;
 143 }
 144
 145 static nsresult NSAPI handle_focus(nsIDOMEventListener *iface, nsIDOMEvent *event)
 146 {
 147     nsEventListener *This = impl_from_nsIDOMEventListener(iface);
 148     HTMLDocumentNode *doc = This->This->doc;
 149     HTMLDocumentObj *doc_obj;
 150
 151     TRACE("(%p)\n", doc);
 152
 153     if(!doc)
 154         return NS_ERROR_FAILURE;
 155     doc_obj = doc->basedoc.doc_obj;
 156
 157     if(!doc_obj->focus) {
 158         doc_obj->focus = TRUE;
 159         notif_focus(doc_obj);
 160     }
 161
 162     return NS_OK;
 163 }
 164
 165 static nsresult NSAPI handle_keypress(nsIDOMEventListener *iface,
 166         nsIDOMEvent *event)
 167 {
 168     nsEventListener *This = impl_from_nsIDOMEventListener(iface);
 169     HTMLDocumentNode *doc = This->This->doc;
 170
 171     if(!doc || !doc->browser)
 172         return NS_ERROR_FAILURE;
 173
 174     TRACE("(%p)->(%p)\n", doc, event);
 175
 176     update_doc(doc->browser->doc, UPDATE_UI);
 177     if(doc->browser->usermode == EDITMODE)
 178         handle_edit_event(doc, event);
 179
 180     return NS_OK;
 181 }
 182
 183 static void handle_docobj_load(HTMLDocumentObj *doc)
 184 {
 185     IOleCommandTarget *olecmd = NULL;
 186     HRESULT hres;
 187
 188     if(doc->nscontainer->editor_controller) {
 189         nsIController_Release(doc->nscontainer->editor_controller);
 190         doc->nscontainer->editor_controller = NULL;
 191     }
 192
 193     if(doc->nscontainer->usermode == EDITMODE)
 194         setup_editor_controller(doc->nscontainer);
 195
 196     if(doc->client) {
 197         hres = IOleClientSite_QueryInterface(doc->client, &IID_IOleCommandTarget, (void**)&olecmd);
 198         if(FAILED(hres))
 199             olecmd = NULL;
 200     }
 201
 202     if(doc->download_state) {
 203         if(olecmd) {
 204             VARIANT progress;
 205
 206             V_VT(&progress) = VT_I4;
 207             V_I4(&progress) = 0;
 208             IOleCommandTarget_Exec(olecmd, NULL, OLECMDID_SETPROGRESSPOS,
 209                     OLECMDEXECOPT_DONTPROMPTUSER, &progress, NULL);
 210         }
 211
 212         set_download_state(doc, 0);
 213     }
 214
 215     if(olecmd) {
 216         IOleCommandTarget_Exec(olecmd, &CGID_ShellDocView, 103, 0, NULL, NULL);
 217         IOleCommandTarget_Exec(olecmd, &CGID_MSHTML, IDM_PARSECOMPLETE, 0, NULL, NULL);
 218         IOleCommandTarget_Exec(olecmd, NULL, OLECMDID_HTTPEQUIV_DONE, 0, NULL, NULL);
 219
 220         IOleCommandTarget_Release(olecmd);
 221     }
 222 }
 223
 224 static nsresult NSAPI handle_load(nsIDOMEventListener *iface, nsIDOMEvent *event)
 225 {
 226     nsEventListener *This = impl_from_nsIDOMEventListener(iface);
 227     HTMLDocumentNode *doc = This->This->doc;
 228     HTMLDocumentObj *doc_obj = NULL;
 229     DOMEvent *load_event;
 230     HRESULT hres;
 231
 232     TRACE("(%p)\n", doc);
 233
 234     if(!doc || !doc->basedoc.window)
 235         return NS_ERROR_FAILURE;
 236     if(doc->basedoc.doc_obj && doc->basedoc.doc_obj->basedoc.doc_node == doc)
 237         doc_obj = doc->basedoc.doc_obj;
 238
 239     connect_scripts(doc->window);
 240
 241     htmldoc_addref(&doc->basedoc);
 242
 243     if(doc_obj)
 244         handle_docobj_load(doc_obj);
 245
 246     set_ready_state(doc->basedoc.window, READYSTATE_COMPLETE);
 247
 248     if(doc_obj) {
 249         if(doc_obj->view_sink)
 250             IAdviseSink_OnViewChange(doc_obj->view_sink, DVASPECT_CONTENT, -1);
 251
 252         set_statustext(doc_obj, IDS_STATUS_DONE, NULL);
 253
 254         update_title(doc_obj);
 255     }
 256
 257     if(doc_obj && doc_obj->nscontainer->usermode != EDITMODE && doc_obj->doc_object_service
 258        && !(doc->basedoc.window->load_flags & BINDING_REFRESH))
 259         IDocObjectService_FireDocumentComplete(doc_obj->doc_object_service,
 260                 &doc->basedoc.window->base.IHTMLWindow2_iface, 0);
 261
 262     if(doc->nsdoc) {
 263         hres = create_document_event(doc, EVENTID_LOAD, &load_event);
 264         if(SUCCEEDED(hres)) {
 265             dispatch_event(&doc->node.event_target, load_event);
 266             IDOMEvent_Release(&load_event->IDOMEvent_iface);
 267         }
 268     }else {
 269         WARN("no nsdoc\n");
 270     }
 271
 272     if(doc->window) {
 273         hres = create_event_from_nsevent(event, &load_event);
 274         if(SUCCEEDED(hres)) {
 275             dispatch_event(&doc->window->event_target, load_event);
 276             IDOMEvent_Release(&load_event->IDOMEvent_iface);
 277         }
 278     }else {
 279         WARN("no window\n");
 280     }
 281
 282     htmldoc_release(&doc->basedoc);
 283     return NS_OK;
 284 }
 285
 286 static nsresult NSAPI handle_htmlevent(nsIDOMEventListener *iface, nsIDOMEvent *nsevent)
 287 {
 288     nsEventListener *This = impl_from_nsIDOMEventListener(iface);
 289     HTMLDocumentNode *doc = This->This->doc;
 290     nsIDOMEventTarget *event_target;
 291     nsIDOMNode *nsnode;
 292     HTMLDOMNode *node;
 293     DOMEvent *event;
 294     nsresult nsres;
 295     HRESULT hres;
 296
 297     TRACE("%p\n", This->This);
 298
 299     if(!doc) {
 300         WARN("NULL doc\n");
 301         return NS_OK;
 302     }
 303
 304     nsres = nsIDOMEvent_GetTarget(nsevent, &event_target);
 305     if(NS_FAILED(nsres) || !event_target) {
 306         ERR("GetEventTarget failed: %08x\n", nsres);
 307         return NS_OK;
 308     }
 309
 310     nsres = nsIDOMEventTarget_QueryInterface(event_target, &IID_nsIDOMNode, (void**)&nsnode);
 311     nsIDOMEventTarget_Release(event_target);
 312     if(NS_FAILED(nsres)) {
 313         ERR("Could not get nsIDOMNode: %08x\n", nsres);
 314         return NS_OK;
 315     }
 316
 317     hres = get_node(nsnode, TRUE, &node);
 318     nsIDOMNode_Release(nsnode);
 319     if(FAILED(hres))
 320         return NS_OK;
 321
 322     hres = create_event_from_nsevent(nsevent, &event);
 323     if(FAILED(hres)) {
 324         node_release(node);
 325         return NS_OK;
 326     }
 327
 328     /* If we fine need for more special cases here, we may consider handling it in a more generic way. */
 329     if(event->event_id == EVENTID_FOCUS || event->event_id == EVENTID_BLUR) {
 330         DOMEvent *focus_event;
 331
 332         hres = create_document_event(doc, event->event_id == EVENTID_FOCUS ? EVENTID_FOCUSIN : EVENTID_FOCUSOUT, &focus_event);
 333         if(SUCCEEDED(hres)) {
 334             dispatch_event(&node->event_target, focus_event);
 335             IDOMEvent_Release(&focus_event->IDOMEvent_iface);
 336         }
 337     }
 338
 339     dispatch_event(&node->event_target, event);
 340
 341     IDOMEvent_Release(&event->IDOMEvent_iface);
 342     node_release(node);
 343     return NS_OK;
 344 }
 345
 346 #define EVENTLISTENER_VTBL(handler) \
 347     { \
 348         nsDOMEventListener_QueryInterface, \
 349         nsDOMEventListener_AddRef, \
 350         nsDOMEventListener_Release, \
 351         handler, \
 352     }
 353
 354 static const nsIDOMEventListenerVtbl blur_vtbl =      EVENTLISTENER_VTBL(handle_blur);
 355 static const nsIDOMEventListenerVtbl focus_vtbl =     EVENTLISTENER_VTBL(handle_focus);
 356 static const nsIDOMEventListenerVtbl keypress_vtbl =  EVENTLISTENER_VTBL(handle_keypress);
 357 static const nsIDOMEventListenerVtbl load_vtbl =      EVENTLISTENER_VTBL(handle_load);
 358 static const nsIDOMEventListenerVtbl htmlevent_vtbl = EVENTLISTENER_VTBL(handle_htmlevent);
 359
 360 static void init_event(nsIDOMEventTarget *target, const PRUnichar *type,
 361         nsIDOMEventListener *listener, BOOL capture)
 362 {
 363     nsAString type_str;
 364     nsresult nsres;
 365
 366     nsAString_InitDepend(&type_str, type);
 367     nsres = nsIDOMEventTarget_AddEventListener(target, &type_str, listener, capture, FALSE, 1);
 368     nsAString_Finish(&type_str);
 369     if(NS_FAILED(nsres))
 370         ERR("AddEventTarget failed: %08x\n", nsres);
 371
 372 }
 373
 374 static void init_listener(nsEventListener *This, nsDocumentEventListener *listener,
 375         const nsIDOMEventListenerVtbl *vtbl)
 376 {
 377     This->nsIDOMEventListener_iface.lpVtbl = vtbl;
 378     This->This = listener;
 379 }
 380
 381 static nsIDOMEventTarget *get_default_document_target(HTMLDocumentNode *doc)
 382 {
 383     nsIDOMEventTarget *target;
 384     nsISupports *target_iface;
 385     nsresult nsres;
 386
 387     target_iface = doc->window ? (nsISupports*)doc->basedoc.window->nswindow : (nsISupports*)doc->nsdoc;
 388     nsres = nsISupports_QueryInterface(target_iface, &IID_nsIDOMEventTarget, (void**)&target);
 389     return NS_SUCCEEDED(nsres) ? target : NULL;
 390 }
 391
 392 void add_nsevent_listener(HTMLDocumentNode *doc, nsIDOMNode *nsnode, LPCWSTR type)
 393 {
 394     nsIDOMEventTarget *target;
 395     nsresult nsres;
 396
 397     if(nsnode) {
 398         nsres = nsIDOMNode_QueryInterface(nsnode, &IID_nsIDOMEventTarget, (void**)&target);
 399         assert(nsres == NS_OK);
 400     }else {
 401         target = get_default_document_target(doc);
 402         if(!target)
 403             return;
 404     }
 405
 406     init_event(target, type, &doc->nsevent_listener->htmlevent_listener.nsIDOMEventListener_iface,
 407             TRUE);
 408     nsIDOMEventTarget_Release(target);
 409 }
 410
 411 static void detach_nslistener(HTMLDocumentNode *doc, const WCHAR *type, nsEventListener *listener, cpp_bool is_capture)
 412 {
 413     nsIDOMEventTarget *target;
 414     nsAString type_str;
 415     nsresult nsres;
 416
 417     target = get_default_document_target(doc);
 418     if(!target)
 419         return;
 420
 421     nsAString_InitDepend(&type_str, type);
 422     nsres = nsIDOMEventTarget_RemoveEventListener(target, &type_str,
 423             &listener->nsIDOMEventListener_iface, is_capture);
 424     nsAString_Finish(&type_str);
 425     nsIDOMEventTarget_Release(target);
 426     if(NS_FAILED(nsres))
 427         ERR("RemoveEventTarget failed: %08x\n", nsres);
 428 }
 429
 430 void detach_nsevent(HTMLDocumentNode *doc, const WCHAR *type)
 431 {
 432     detach_nslistener(doc, type, &doc->nsevent_listener->htmlevent_listener, TRUE);
 433 }
 434
 435 void release_nsevents(HTMLDocumentNode *doc)
 436 {
 437     nsDocumentEventListener *listener = doc->nsevent_listener;
 438
 439     TRACE("%p %p\n", doc, doc->nsevent_listener);
 440
 441     if(!listener)
 442         return;
 443
 444     detach_nslistener(doc, L"blur",     &listener->blur_listener,     TRUE);
 445     detach_nslistener(doc, L"focus",    &listener->focus_listener,    TRUE);
 446     detach_nslistener(doc, L"keypress", &listener->keypress_listener, FALSE);
 447     detach_nslistener(doc, L"load",     &listener->load_listener,     TRUE);
 448
 449     listener->doc = NULL;
 450     release_listener(listener);
 451     doc->nsevent_listener = NULL;
 452 }
 453
 454 void init_nsevents(HTMLDocumentNode *doc)
 455 {
 456     nsDocumentEventListener *listener;
 457     nsIDOMEventTarget *target;
 458
 459     listener = heap_alloc(sizeof(nsDocumentEventListener));
 460     if(!listener)
 461         return;
 462
 463     TRACE("%p %p\n", doc, listener);
 464
 465     listener->ref = 1;
 466     listener->doc = doc;
 467
 468     init_listener(&listener->blur_listener,        listener, &blur_vtbl);
 469     init_listener(&listener->focus_listener,       listener, &focus_vtbl);
 470     init_listener(&listener->keypress_listener,    listener, &keypress_vtbl);
 471     init_listener(&listener->load_listener,        listener, &load_vtbl);
 472     init_listener(&listener->htmlevent_listener,   listener, &htmlevent_vtbl);
 473
 474     doc->nsevent_listener = listener;
 475
 476     target = get_default_document_target(doc);
 477     if(!target)
 478         return;
 479
 480     init_event(target, L"blur",     &listener->blur_listener.nsIDOMEventListener_iface,     TRUE);
 481     init_event(target, L"focus",    &listener->focus_listener.nsIDOMEventListener_iface,    TRUE);
 482     init_event(target, L"keypress", &listener->keypress_listener.nsIDOMEventListener_iface, FALSE);
 483     init_event(target, L"load",     &listener->load_listener.nsIDOMEventListener_iface,     TRUE);
 484
 485     nsIDOMEventTarget_Release(target);
 486 }