summaryrefslogtreecommitdiffstats
path: root/mobile/android/geckoview/src/main/java/org/mozilla/geckoview/GeckoSessionHandler.java
blob: 629211a4a61ead3afd06d42261da893a2b07d45f (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
/* -*- Mode: Java; c-basic-offset: 4; tab-width: 20; indent-tabs-mode: nil; -*-
 * vim: ts=4 sw=4 expandtab:
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

package org.mozilla.geckoview;

import android.util.Log;
import androidx.annotation.UiThread;
import org.mozilla.gecko.util.BundleEventListener;
import org.mozilla.gecko.util.EventCallback;
import org.mozilla.gecko.util.GeckoBundle;

/* package */ abstract class GeckoSessionHandler<Delegate> implements BundleEventListener {

  private static final String LOGTAG = "GeckoSessionHandler";
  private static final boolean DEBUG = false;

  private final String mModuleName;
  private final String[] mEvents;
  private Delegate mDelegate;
  private boolean mRegisteredListeners;

  /* package */ GeckoSessionHandler(
      final String module, final GeckoSession session, final String[] events) {
    this(module, session, events, new String[] {});
  }

  /* package */ GeckoSessionHandler(
      final String module,
      final GeckoSession session,
      final String[] events,
      final String[] defaultEvents) {
    session.handlersCount++;

    mModuleName = module;
    mEvents = events;

    // Default events are always active
    session.getEventDispatcher().registerUiThreadListener(this, defaultEvents);
  }

  public Delegate getDelegate() {
    return mDelegate;
  }

  public void setDelegate(final Delegate delegate, final GeckoSession session) {
    if (mDelegate == delegate) {
      return;
    }

    mDelegate = delegate;

    if (!mRegisteredListeners && delegate != null) {
      session.getEventDispatcher().registerUiThreadListener(this, mEvents);
      mRegisteredListeners = true;
    }

    // If session is not open, we will update module state during session opening.
    if (!session.isOpen()) {
      return;
    }

    final GeckoBundle msg = new GeckoBundle(2);
    msg.putString("module", mModuleName);
    msg.putBoolean("enabled", isEnabled());
    session.getEventDispatcher().dispatch("GeckoView:UpdateModuleState", msg);
  }

  public String getName() {
    return mModuleName;
  }

  public boolean isEnabled() {
    return mDelegate != null;
  }

  @Override
  @UiThread
  public void handleMessage(
      final String event, final GeckoBundle message, final EventCallback callback) {
    if (DEBUG) {
      Log.d(LOGTAG, mModuleName + " handleMessage: event = " + event);
    }

    if (mDelegate != null) {
      handleMessage(mDelegate, event, message, callback);
    } else {
      handleDefaultMessage(event, message, callback);
    }
  }

  protected abstract void handleMessage(
      final Delegate delegate,
      final String event,
      final GeckoBundle message,
      final EventCallback callback);

  protected void handleDefaultMessage(
      final String event, final GeckoBundle message, final EventCallback callback) {
    if (callback != null) {
      callback.sendError("No delegate registered");
    }
  }
}