summaryrefslogtreecommitdiffstats
path: root/dom/plugins/ipc/BrowserStreamChild.cpp
blob: 21e6706ba365fef28981cae8ce23e61ec11b3bb9 (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
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
/* -*- Mode: C++; c-basic-offset: 2; indent-tabs-mode: nil; tab-width: 8 -*- */
/* 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/. */

#include "mozilla/plugins/BrowserStreamChild.h"

#include "mozilla/Attributes.h"
#include "mozilla/plugins/PluginInstanceChild.h"
#include "mozilla/plugins/StreamNotifyChild.h"

namespace mozilla::plugins {

BrowserStreamChild::BrowserStreamChild(PluginInstanceChild* instance,
                                       const nsCString& url,
                                       const uint32_t& length,
                                       const uint32_t& lastmodified,
                                       StreamNotifyChild* notifyData,
                                       const nsCString& headers)
    : mInstance(instance),
      mStreamStatus(kStreamOpen),
      mDestroyPending(NOT_DESTROYED),
      mNotifyPending(false),
      mInstanceDying(false),
      mState(CONSTRUCTING),
      mURL(url),
      mHeaders(headers),
      mStreamNotify(notifyData),
      mDeliveryTracker(this) {
  PLUGIN_LOG_DEBUG(("%s (%s, %i, %i, %p, %s)", FULLFUNCTION, url.get(), length,
                    lastmodified, (void*)notifyData, headers.get()));

  AssertPluginThread();

  memset(&mStream, 0, sizeof(mStream));
  mStream.ndata = static_cast<AStream*>(this);
  mStream.url = NullableStringGet(mURL);
  mStream.end = length;
  mStream.lastmodified = lastmodified;
  mStream.headers = NullableStringGet(mHeaders);
  if (notifyData) {
    mStream.notifyData = notifyData->mClosure;
    notifyData->SetAssociatedStream(this);
  }
}

NPError BrowserStreamChild::StreamConstructed(const nsCString& mimeType,
                                              const bool& seekable,
                                              uint16_t* stype) {
  NPError rv = NPERR_NO_ERROR;

  *stype = NP_NORMAL;
  rv = mInstance->mPluginIface->newstream(
      &mInstance->mData, const_cast<char*>(NullableStringGet(mimeType)),
      &mStream, seekable, stype);

  // NP_NORMAL is the only permissible stream type
  if (*stype != NP_NORMAL) {
    rv = NPERR_INVALID_PARAM;
    // The plugin thinks the stream is alive, so we kill it explicitly
    (void)mInstance->mPluginIface->destroystream(&mInstance->mData, &mStream,
                                                 NPRES_NETWORK_ERR);
  }

  if (rv != NPERR_NO_ERROR) {
    mState = DELETING;
    if (mStreamNotify) {
      mStreamNotify->SetAssociatedStream(nullptr);
      mStreamNotify = nullptr;
    }
  } else {
    mState = ALIVE;
  }

  return rv;
}

BrowserStreamChild::~BrowserStreamChild() {
  NS_ASSERTION(!mStreamNotify, "Should have nulled it by now!");
}

mozilla::ipc::IPCResult BrowserStreamChild::RecvWrite(const int32_t& offset,
                                                      const uint32_t& newlength,
                                                      const Buffer& data) {
  PLUGIN_LOG_DEBUG_FUNCTION;

  AssertPluginThread();

  if (ALIVE != mState)
    MOZ_CRASH("Unexpected state: received data after NPP_DestroyStream?");

  if (kStreamOpen != mStreamStatus) return IPC_OK();

  mStream.end = newlength;

  NS_ASSERTION(data.Length() > 0, "Empty data");

  PendingData* newdata = mPendingData.AppendElement();
  newdata->offset = offset;
  newdata->data = data;
  newdata->curpos = 0;

  EnsureDeliveryPending();

  return IPC_OK();
}

mozilla::ipc::IPCResult BrowserStreamChild::RecvNPP_DestroyStream(
    const NPReason& reason) {
  PLUGIN_LOG_DEBUG_METHOD;

  if (ALIVE != mState)
    MOZ_CRASH("Unexpected state: recevied NPP_DestroyStream twice?");

  mState = DYING;
  mDestroyPending = DESTROY_PENDING;
  if (NPRES_DONE != reason) mStreamStatus = reason;

  EnsureDeliveryPending();
  return IPC_OK();
}

mozilla::ipc::IPCResult BrowserStreamChild::Recv__delete__() {
  AssertPluginThread();

  if (DELETING != mState) MOZ_CRASH("Bad state, not DELETING");

  return IPC_OK();
}

void BrowserStreamChild::EnsureDeliveryPending() {
  MessageLoop::current()->PostTask(
      mDeliveryTracker.NewRunnableMethod(&BrowserStreamChild::Deliver));
}

void BrowserStreamChild::Deliver() {
  while (kStreamOpen == mStreamStatus && mPendingData.Length()) {
    if (DeliverPendingData() && kStreamOpen == mStreamStatus) {
      SetSuspendedTimer();
      return;
    }
  }
  ClearSuspendedTimer();

  NS_ASSERTION(kStreamOpen != mStreamStatus || 0 == mPendingData.Length(),
               "Exit out of the data-delivery loop with pending data");
  mPendingData.Clear();

  if (DESTROY_PENDING == mDestroyPending) {
    mDestroyPending = DESTROYED;
    if (mState != DYING) MOZ_CRASH("mDestroyPending but state not DYING");

    NS_ASSERTION(NPRES_DONE != mStreamStatus, "Success status set too early!");
    if (kStreamOpen == mStreamStatus) mStreamStatus = NPRES_DONE;

    (void)mInstance->mPluginIface->destroystream(&mInstance->mData, &mStream,
                                                 mStreamStatus);
  }
  if (DESTROYED == mDestroyPending && mNotifyPending) {
    NS_ASSERTION(mStreamNotify, "mDestroyPending but no mStreamNotify?");

    mNotifyPending = false;
    mStreamNotify->NPP_URLNotify(mStreamStatus);
    delete mStreamNotify;
    mStreamNotify = nullptr;
  }
  if (DYING == mState && DESTROYED == mDestroyPending && !mStreamNotify &&
      !mInstanceDying) {
    SendStreamDestroyed();
    mState = DELETING;
  }
}

bool BrowserStreamChild::DeliverPendingData() {
  if (mState != ALIVE && mState != DYING) MOZ_CRASH("Unexpected state");

  NS_ASSERTION(mPendingData.Length(), "Called from Deliver with empty pending");

  while (mPendingData[0].curpos <
         static_cast<int32_t>(mPendingData[0].data.Length())) {
    int32_t r =
        mInstance->mPluginIface->writeready(&mInstance->mData, &mStream);
    if (kStreamOpen != mStreamStatus) return false;
    if (0 == r)  // plugin wants to suspend delivery
      return true;

    r = mInstance->mPluginIface->write(
        &mInstance->mData, &mStream,
        mPendingData[0].offset + mPendingData[0].curpos,         // offset
        mPendingData[0].data.Length() - mPendingData[0].curpos,  // length
        const_cast<char*>(mPendingData[0].data.BeginReading() +
                          mPendingData[0].curpos));
    if (kStreamOpen != mStreamStatus) return false;
    if (0 == r) return true;
    if (r < 0) {  // error condition
      mStreamStatus = NPRES_NETWORK_ERR;

      // Set up stream destruction
      EnsureDeliveryPending();
      return false;
    }
    mPendingData[0].curpos += r;
  }
  mPendingData.RemoveElementAt(0);
  return false;
}

void BrowserStreamChild::SetSuspendedTimer() {
  if (mSuspendedTimer.IsRunning()) return;
  mSuspendedTimer.Start(base::TimeDelta::FromMilliseconds(
                            100),  // 100ms copied from Mozilla plugin host
                        this, &BrowserStreamChild::Deliver);
}

void BrowserStreamChild::ClearSuspendedTimer() { mSuspendedTimer.Stop(); }

}  // namespace mozilla::plugins