netwerk/protocol/wyciwyg/nsWyciwygChannel.cpp

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "nsWyciwyg.h"
   8 #include "nsWyciwygChannel.h"
   9 #include "nsILoadGroup.h"
  10 #include "nsNetUtil.h"
  11 #include "LoadContextInfo.h"
  12 #include "nsICacheService.h" // only to initialize
  13 #include "nsICacheStorageService.h"
  14 #include "nsICacheStorage.h"
  15 #include "nsICacheEntry.h"
  16 #include "CacheObserver.h"
  17 #include "nsCharsetSource.h"
  18 #include "nsProxyRelease.h"
  19 #include "nsThreadUtils.h"
  20 #include "nsIEventTarget.h"
  21 #include "nsIInputStream.h"
  22 #include "nsIInputStreamPump.h"
  23 #include "nsIOutputStream.h"
  24 #include "nsIProgressEventSink.h"
  25 #include "nsIURI.h"
  26 #include "mozilla/DebugOnly.h"
  27 #include "mozilla/unused.h"
  28
  29 typedef mozilla::net::LoadContextInfo LoadContextInfo;
  30
  31 // Must release mChannel on the main thread
  32 class nsWyciwygAsyncEvent : public nsRunnable {
  33 public:
  34   explicit nsWyciwygAsyncEvent(nsWyciwygChannel *aChannel) : mChannel(aChannel) {}
  35
  36   ~nsWyciwygAsyncEvent()
  37   {
  38     nsCOMPtr<nsIThread> thread = do_GetMainThread();
  39     NS_WARN_IF_FALSE(thread, "Couldn't get the main thread!");
  40     if (thread) {
  41       nsIWyciwygChannel *chan = static_cast<nsIWyciwygChannel *>(mChannel);
  42       mozilla::unused << mChannel.forget();
  43       NS_ProxyRelease(thread, chan);
  44     }
  45   }
  46 protected:
  47   nsRefPtr<nsWyciwygChannel> mChannel;
  48 };
  49
  50 class nsWyciwygSetCharsetandSourceEvent : public nsWyciwygAsyncEvent {
  51 public:
  52   explicit nsWyciwygSetCharsetandSourceEvent(nsWyciwygChannel *aChannel)
  53     : nsWyciwygAsyncEvent(aChannel) {}
  54
  55   NS_IMETHOD Run()
  56   {
  57     mChannel->SetCharsetAndSourceInternal();
  58     return NS_OK;
  59   }
  60 };
  61
  62 class nsWyciwygWriteEvent : public nsWyciwygAsyncEvent {
  63 public:
  64   nsWyciwygWriteEvent(nsWyciwygChannel *aChannel, const nsAString &aData)
  65     : nsWyciwygAsyncEvent(aChannel), mData(aData) {}
  66
  67   NS_IMETHOD Run()
  68   {
  69     mChannel->WriteToCacheEntryInternal(mData);
  70     return NS_OK;
  71   }
  72 private:
  73   nsString mData;
  74 };
  75
  76 class nsWyciwygCloseEvent : public nsWyciwygAsyncEvent {
  77 public:
  78   nsWyciwygCloseEvent(nsWyciwygChannel *aChannel, nsresult aReason)
  79     : nsWyciwygAsyncEvent(aChannel), mReason(aReason) {}
  80
  81   NS_IMETHOD Run()
  82   {
  83     mChannel->CloseCacheEntryInternal(mReason);
  84     return NS_OK;
  85   }
  86 private:
  87   nsresult mReason;
  88 };
  89
  90
  91 // nsWyciwygChannel methods
  92 nsWyciwygChannel::nsWyciwygChannel()
  93   : mMode(NONE),
  94     mStatus(NS_OK),
  95     mIsPending(false),
  96     mCharsetAndSourceSet(false),
  97     mNeedToWriteCharset(false),
  98     mCharsetSource(kCharsetUninitialized),
  99     mContentLength(-1),
 100     mLoadFlags(LOAD_NORMAL),
 101     mAppId(NECKO_NO_APP_ID),
 102     mInBrowser(false)
 103 {
 104 }
 105
 106 nsWyciwygChannel::~nsWyciwygChannel()
 107 {
 108 }
 109
 110 NS_IMPL_ISUPPORTS(nsWyciwygChannel,
 111                   nsIChannel,
 112                   nsIRequest,
 113                   nsIStreamListener,
 114                   nsIRequestObserver,
 115                   nsICacheEntryOpenCallback,
 116                   nsIWyciwygChannel,
 117                   nsIPrivateBrowsingChannel)
 118
 119 nsresult
 120 nsWyciwygChannel::Init(nsIURI* uri)
 121 {
 122   NS_ENSURE_ARG_POINTER(uri);
 123
 124   nsresult rv;
 125
 126   if (!mozilla::net::CacheObserver::UseNewCache()) {
 127     // Since nsWyciwygChannel can use the new cache API off the main thread
 128     // and that API normally does this initiation, we need to take care
 129     // of initiating the old cache service here manually.  Will be removed
 130     // with bug 913828.
 131     MOZ_ASSERT(NS_IsMainThread());
 132     nsCOMPtr<nsICacheService> service =
 133       do_GetService(NS_CACHESERVICE_CONTRACTID, &rv);
 134   }
 135
 136   mURI = uri;
 137   mOriginalURI = uri;
 138
 139   nsCOMPtr<nsICacheStorageService> serv =
 140     do_GetService("@mozilla.org/netwerk/cache-storage-service;1", &rv);
 141   NS_ENSURE_SUCCESS(rv, rv);
 142
 143   rv = serv->GetIoTarget(getter_AddRefs(mCacheIOTarget));
 144   NS_ENSURE_SUCCESS(rv, rv);
 145
 146   return NS_OK;
 147 }
 148
 149 ///////////////////////////////////////////////////////////////////////////////
 150 // nsIRequest methods:
 151 ///////////////////////////////////////////////////////////////////////////////
 152
 153 NS_IMETHODIMP
 154 nsWyciwygChannel::GetName(nsACString &aName)
 155 {
 156   return mURI->GetSpec(aName);
 157 }
 158
 159 NS_IMETHODIMP
 160 nsWyciwygChannel::IsPending(bool *aIsPending)
 161 {
 162   *aIsPending = mIsPending;
 163   return NS_OK;
 164 }
 165
 166 NS_IMETHODIMP
 167 nsWyciwygChannel::GetStatus(nsresult *aStatus)
 168 {
 169   if (NS_SUCCEEDED(mStatus) && mPump)
 170     mPump->GetStatus(aStatus);
 171   else
 172     *aStatus = mStatus;
 173   return NS_OK;
 174 }
 175
 176 NS_IMETHODIMP
 177 nsWyciwygChannel::Cancel(nsresult status)
 178 {
 179   mStatus = status;
 180   if (mPump)
 181     mPump->Cancel(status);
 182   // else we're waiting for OnCacheEntryAvailable
 183   return NS_OK;
 184 }
 185
 186 NS_IMETHODIMP
 187 nsWyciwygChannel::Suspend()
 188 {
 189   if (mPump)
 190     mPump->Suspend();
 191   // XXX else, we'll ignore this ... and that's probably bad!
 192   return NS_OK;
 193 }
 194
 195 NS_IMETHODIMP
 196 nsWyciwygChannel::Resume()
 197 {
 198   if (mPump)
 199     mPump->Resume();
 200   // XXX else, we'll ignore this ... and that's probably bad!
 201   return NS_OK;
 202 }
 203
 204 NS_IMETHODIMP
 205 nsWyciwygChannel::GetLoadGroup(nsILoadGroup* *aLoadGroup)
 206 {
 207   *aLoadGroup = mLoadGroup;
 208   NS_IF_ADDREF(*aLoadGroup);
 209   return NS_OK;
 210 }
 211
 212 NS_IMETHODIMP
 213 nsWyciwygChannel::SetLoadGroup(nsILoadGroup* aLoadGroup)
 214 {
 215   if (!CanSetLoadGroup(aLoadGroup)) {
 216     return NS_ERROR_FAILURE;
 217   }
 218
 219   mLoadGroup = aLoadGroup;
 220   NS_QueryNotificationCallbacks(mCallbacks,
 221                                 mLoadGroup,
 222                                 NS_GET_IID(nsIProgressEventSink),
 223                                 getter_AddRefs(mProgressSink));
 224   mPrivateBrowsing = NS_UsePrivateBrowsing(this);
 225   NS_GetAppInfo(this, &mAppId, &mInBrowser);
 226   return NS_OK;
 227 }
 228
 229 NS_IMETHODIMP
 230 nsWyciwygChannel::SetLoadFlags(uint32_t aLoadFlags)
 231 {
 232   mLoadFlags = aLoadFlags;
 233   return NS_OK;
 234 }
 235
 236 NS_IMETHODIMP
 237 nsWyciwygChannel::GetLoadFlags(uint32_t * aLoadFlags)
 238 {
 239   *aLoadFlags = mLoadFlags;
 240   return NS_OK;
 241 }
 242
 243 ////////////////////////////////////////////////////////////////////////////////
 244 // nsIChannel methods:
 245 ///////////////////////////////////////////////////////////////////////////////
 246
 247 NS_IMETHODIMP
 248 nsWyciwygChannel::GetOriginalURI(nsIURI* *aURI)
 249 {
 250   *aURI = mOriginalURI;
 251   NS_ADDREF(*aURI);
 252   return NS_OK;
 253 }
 254
 255 NS_IMETHODIMP
 256 nsWyciwygChannel::SetOriginalURI(nsIURI* aURI)
 257 {
 258   NS_ENSURE_ARG_POINTER(aURI);
 259   mOriginalURI = aURI;
 260   return NS_OK;
 261 }
 262
 263 NS_IMETHODIMP
 264 nsWyciwygChannel::GetURI(nsIURI* *aURI)
 265 {
 266   *aURI = mURI;
 267   NS_IF_ADDREF(*aURI);
 268   return NS_OK;
 269 }
 270
 271 NS_IMETHODIMP
 272 nsWyciwygChannel::GetOwner(nsISupports **aOwner)
 273 {
 274   NS_IF_ADDREF(*aOwner = mOwner);
 275   return NS_OK;
 276 }
 277
 278 NS_IMETHODIMP
 279 nsWyciwygChannel::SetOwner(nsISupports* aOwner)
 280 {
 281   mOwner = aOwner;
 282   return NS_OK;
 283 }
 284
 285 NS_IMETHODIMP
 286 nsWyciwygChannel::GetLoadInfo(nsILoadInfo **aLoadInfo)
 287 {
 288   NS_IF_ADDREF(*aLoadInfo = mLoadInfo);
 289   return NS_OK;
 290 }
 291
 292 NS_IMETHODIMP
 293 nsWyciwygChannel::SetLoadInfo(nsILoadInfo* aLoadInfo)
 294 {
 295   mLoadInfo = aLoadInfo;
 296   return NS_OK;
 297 }
 298
 299 NS_IMETHODIMP
 300 nsWyciwygChannel::GetNotificationCallbacks(nsIInterfaceRequestor* *aCallbacks)
 301 {
 302   *aCallbacks = mCallbacks.get();
 303   NS_IF_ADDREF(*aCallbacks);
 304   return NS_OK;
 305 }
 306
 307 NS_IMETHODIMP
 308 nsWyciwygChannel::SetNotificationCallbacks(nsIInterfaceRequestor* aNotificationCallbacks)
 309 {
 310   if (!CanSetCallbacks(aNotificationCallbacks)) {
 311     return NS_ERROR_FAILURE;
 312   }
 313
 314   mCallbacks = aNotificationCallbacks;
 315   NS_QueryNotificationCallbacks(mCallbacks,
 316                                 mLoadGroup,
 317                                 NS_GET_IID(nsIProgressEventSink),
 318                                 getter_AddRefs(mProgressSink));
 319
 320   mPrivateBrowsing = NS_UsePrivateBrowsing(this);
 321   NS_GetAppInfo(this, &mAppId, &mInBrowser);
 322
 323   return NS_OK;
 324 }
 325
 326 NS_IMETHODIMP
 327 nsWyciwygChannel::GetSecurityInfo(nsISupports * *aSecurityInfo)
 328 {
 329   NS_IF_ADDREF(*aSecurityInfo = mSecurityInfo);
 330
 331   return NS_OK;
 332 }
 333
 334 NS_IMETHODIMP
 335 nsWyciwygChannel::GetContentType(nsACString &aContentType)
 336 {
 337   aContentType.AssignLiteral(WYCIWYG_TYPE);
 338   return NS_OK;
 339 }
 340
 341 NS_IMETHODIMP
 342 nsWyciwygChannel::SetContentType(const nsACString &aContentType)
 343 {
 344   return NS_ERROR_NOT_IMPLEMENTED;
 345 }
 346
 347 NS_IMETHODIMP
 348 nsWyciwygChannel::GetContentCharset(nsACString &aContentCharset)
 349 {
 350   aContentCharset.AssignLiteral("UTF-16");
 351   return NS_OK;
 352 }
 353
 354 NS_IMETHODIMP
 355 nsWyciwygChannel::SetContentCharset(const nsACString &aContentCharset)
 356 {
 357   return NS_ERROR_NOT_IMPLEMENTED;
 358 }
 359
 360 NS_IMETHODIMP
 361 nsWyciwygChannel::GetContentDisposition(uint32_t *aContentDisposition)
 362 {
 363   return NS_ERROR_NOT_AVAILABLE;
 364 }
 365
 366 NS_IMETHODIMP
 367 nsWyciwygChannel::SetContentDisposition(uint32_t aContentDisposition)
 368 {
 369   return NS_ERROR_NOT_AVAILABLE;
 370 }
 371
 372 NS_IMETHODIMP
 373 nsWyciwygChannel::GetContentDispositionFilename(nsAString &aContentDispositionFilename)
 374 {
 375   return NS_ERROR_NOT_AVAILABLE;
 376 }
 377
 378 NS_IMETHODIMP
 379 nsWyciwygChannel::SetContentDispositionFilename(const nsAString &aContentDispositionFilename)
 380 {
 381   return NS_ERROR_NOT_AVAILABLE;
 382 }
 383
 384 NS_IMETHODIMP
 385 nsWyciwygChannel::GetContentDispositionHeader(nsACString &aContentDispositionHeader)
 386 {
 387   return NS_ERROR_NOT_AVAILABLE;
 388 }
 389
 390 NS_IMETHODIMP
 391 nsWyciwygChannel::GetContentLength(int64_t *aContentLength)
 392 {
 393   *aContentLength = mContentLength;
 394   return NS_OK;
 395 }
 396
 397 NS_IMETHODIMP
 398 nsWyciwygChannel::SetContentLength(int64_t aContentLength)
 399 {
 400   mContentLength = aContentLength;
 401
 402   return NS_OK;
 403 }
 404
 405 NS_IMETHODIMP
 406 nsWyciwygChannel::Open(nsIInputStream ** aReturn)
 407 {
 408   return NS_ERROR_NOT_IMPLEMENTED;
 409 }
 410
 411 NS_IMETHODIMP
 412 nsWyciwygChannel::AsyncOpen(nsIStreamListener *listener, nsISupports *ctx)
 413 {
 414   LOG(("nsWyciwygChannel::AsyncOpen [this=%p]\n", this));
 415   MOZ_ASSERT(mMode == NONE, "nsWyciwygChannel already open");
 416
 417   NS_ENSURE_TRUE(!mIsPending, NS_ERROR_IN_PROGRESS);
 418   NS_ENSURE_TRUE(mMode == NONE, NS_ERROR_IN_PROGRESS);
 419   NS_ENSURE_ARG_POINTER(listener);
 420
 421   mMode = READING;
 422
 423   // open a cache entry for this channel...
 424   // mIsPending set to true since OnCacheEntryAvailable may be called
 425   // synchronously and fails when mIsPending found false.
 426   mIsPending = true;
 427   nsresult rv = OpenCacheEntry(mURI, nsICacheStorage::OPEN_READONLY |
 428                                      nsICacheStorage::CHECK_MULTITHREADED);
 429   if (NS_FAILED(rv)) {
 430     LOG(("nsWyciwygChannel::OpenCacheEntry failed [rv=%x]\n", rv));
 431     mIsPending = false;
 432     return rv;
 433   }
 434
 435   // There is no code path that would invoke the listener sooner than
 436   // we get to this line in case OnCacheEntryAvailable is invoked
 437   // synchronously.
 438   mListener = listener;
 439   mListenerContext = ctx;
 440
 441   if (mLoadGroup)
 442     mLoadGroup->AddRequest(this, nullptr);
 443
 444   return NS_OK;
 445 }
 446
 447 //////////////////////////////////////////////////////////////////////////////
 448 // nsIWyciwygChannel
 449 //////////////////////////////////////////////////////////////////////////////
 450
 451 nsresult
 452 nsWyciwygChannel::EnsureWriteCacheEntry()
 453 {
 454   MOZ_ASSERT(mMode == WRITING, "nsWyciwygChannel not open for writing");
 455
 456   if (!mCacheEntry) {
 457     // OPEN_TRUNCATE will give us the entry instantly
 458     nsresult rv = OpenCacheEntry(mURI, nsICacheStorage::OPEN_TRUNCATE);
 459     if (NS_FAILED(rv) || !mCacheEntry) {
 460       LOG(("  could not synchronously open cache entry for write!"));
 461       return NS_ERROR_FAILURE;
 462     }
 463   }
 464
 465   return NS_OK;
 466 }
 467
 468 NS_IMETHODIMP
 469 nsWyciwygChannel::WriteToCacheEntry(const nsAString &aData)
 470 {
 471   if (mMode == READING) {
 472     LOG(("nsWyciwygChannel::WriteToCacheEntry already open for reading"));
 473     MOZ_ASSERT(false);
 474     return NS_ERROR_UNEXPECTED;
 475   }
 476
 477   mMode = WRITING;
 478
 479   if (mozilla::net::CacheObserver::UseNewCache()) {
 480     nsresult rv = EnsureWriteCacheEntry();
 481     if (NS_FAILED(rv)) return rv;
 482   }
 483
 484   return mCacheIOTarget->Dispatch(new nsWyciwygWriteEvent(this, aData),
 485                                   NS_DISPATCH_NORMAL);
 486 }
 487
 488 nsresult
 489 nsWyciwygChannel::WriteToCacheEntryInternal(const nsAString &aData)
 490 {
 491   LOG(("nsWyciwygChannel::WriteToCacheEntryInternal [this=%p]", this));
 492   NS_ASSERTION(IsOnCacheIOThread(), "wrong thread");
 493
 494   nsresult rv;
 495
 496   // With the new cache entry this will just pass as a no-op since we
 497   // are opening the entry in WriteToCacheEntry.
 498   rv = EnsureWriteCacheEntry();
 499   if (NS_WARN_IF(NS_FAILED(rv))) {
 500     return rv;
 501   }
 502
 503   if (mLoadFlags & INHIBIT_PERSISTENT_CACHING) {
 504     rv = mCacheEntry->SetMetaDataElement("inhibit-persistent-caching", "1");
 505     if (NS_FAILED(rv)) return rv;
 506   }
 507
 508   if (mSecurityInfo) {
 509     mCacheEntry->SetSecurityInfo(mSecurityInfo);
 510   }
 511
 512   if (mNeedToWriteCharset) {
 513     WriteCharsetAndSourceToCache(mCharsetSource, mCharset);
 514     mNeedToWriteCharset = false;
 515   }
 516
 517   uint32_t out;
 518   if (!mCacheOutputStream) {
 519     // Get the outputstream from the cache entry.
 520     rv = mCacheEntry->OpenOutputStream(0, getter_AddRefs(mCacheOutputStream));
 521     if (NS_FAILED(rv)) return rv;
 522
 523     // Write out a Byte Order Mark, so that we'll know if the data is
 524     // BE or LE when we go to read it.
 525     char16_t bom = 0xFEFF;
 526     rv = mCacheOutputStream->Write((char *)&bom, sizeof(bom), &out);
 527     if (NS_FAILED(rv)) return rv;
 528   }
 529
 530   return mCacheOutputStream->Write((const char *)PromiseFlatString(aData).get(),
 531                                    aData.Length() * sizeof(char16_t), &out);
 532 }
 533
 534
 535 NS_IMETHODIMP
 536 nsWyciwygChannel::CloseCacheEntry(nsresult reason)
 537 {
 538   return mCacheIOTarget->Dispatch(new nsWyciwygCloseEvent(this, reason),
 539                                   NS_DISPATCH_NORMAL);
 540 }
 541
 542 nsresult
 543 nsWyciwygChannel::CloseCacheEntryInternal(nsresult reason)
 544 {
 545   NS_ASSERTION(IsOnCacheIOThread(), "wrong thread");
 546
 547   if (mCacheEntry) {
 548     LOG(("nsWyciwygChannel::CloseCacheEntryInternal [this=%p ]", this));
 549     mCacheOutputStream = 0;
 550     mCacheInputStream = 0;
 551
 552     if (NS_FAILED(reason))
 553       mCacheEntry->AsyncDoom(nullptr); // here we were calling Doom() ...
 554
 555     mCacheEntry = 0;
 556   }
 557   return NS_OK;
 558 }
 559
 560 NS_IMETHODIMP
 561 nsWyciwygChannel::SetSecurityInfo(nsISupports *aSecurityInfo)
 562 {
 563   mSecurityInfo = aSecurityInfo;
 564
 565   return NS_OK;
 566 }
 567
 568 NS_IMETHODIMP
 569 nsWyciwygChannel::SetCharsetAndSource(int32_t aSource,
 570                                       const nsACString& aCharset)
 571 {
 572   NS_ENSURE_ARG(!aCharset.IsEmpty());
 573
 574   mCharsetAndSourceSet = true;
 575   mCharset = aCharset;
 576   mCharsetSource = aSource;
 577
 578   return mCacheIOTarget->Dispatch(new nsWyciwygSetCharsetandSourceEvent(this),
 579                                   NS_DISPATCH_NORMAL);
 580 }
 581
 582 void
 583 nsWyciwygChannel::SetCharsetAndSourceInternal()
 584 {
 585   NS_ASSERTION(IsOnCacheIOThread(), "wrong thread");
 586
 587   if (mCacheEntry) {
 588     WriteCharsetAndSourceToCache(mCharsetSource, mCharset);
 589   } else {
 590     mNeedToWriteCharset = true;
 591   }
 592 }
 593
 594 NS_IMETHODIMP
 595 nsWyciwygChannel::GetCharsetAndSource(int32_t* aSource, nsACString& aCharset)
 596 {
 597   if (mCharsetAndSourceSet) {
 598     *aSource = mCharsetSource;
 599     aCharset = mCharset;
 600     return NS_OK;
 601   }
 602
 603   if (!mCacheEntry) {
 604     return NS_ERROR_NOT_AVAILABLE;
 605   }
 606
 607   nsXPIDLCString data;
 608   mCacheEntry->GetMetaDataElement("charset", getter_Copies(data));
 609
 610   if (data.IsEmpty()) {
 611     return NS_ERROR_NOT_AVAILABLE;
 612   }
 613
 614   nsXPIDLCString sourceStr;
 615   mCacheEntry->GetMetaDataElement("charset-source", getter_Copies(sourceStr));
 616
 617   int32_t source;
 618   nsresult err;
 619   source = sourceStr.ToInteger(&err);
 620   if (NS_FAILED(err) || source == 0) {
 621     return NS_ERROR_NOT_AVAILABLE;
 622   }
 623
 624   *aSource = source;
 625   aCharset = data;
 626   return NS_OK;
 627 }
 628
 629 //////////////////////////////////////////////////////////////////////////////
 630 // nsICacheEntryOpenCallback
 631 //////////////////////////////////////////////////////////////////////////////
 632
 633 NS_IMETHODIMP
 634 nsWyciwygChannel::OnCacheEntryCheck(nsICacheEntry* entry, nsIApplicationCache* appCache,
 635                                     uint32_t* aResult)
 636 {
 637   *aResult = ENTRY_WANTED;
 638   return NS_OK;
 639 }
 640
 641 NS_IMETHODIMP
 642 nsWyciwygChannel::OnCacheEntryAvailable(nsICacheEntry *aCacheEntry,
 643                                         bool aNew,
 644                                         nsIApplicationCache* aAppCache,
 645                                         nsresult aStatus)
 646 {
 647   LOG(("nsWyciwygChannel::OnCacheEntryAvailable [this=%p entry=%p "
 648        "new=%d status=%x]\n", this, aCacheEntry, aNew, aStatus));
 649
 650   // if the channel's already fired onStopRequest,
 651   // then we should ignore this event.
 652   if (!mIsPending && !aNew)
 653     return NS_OK;
 654
 655   // otherwise, we have to handle this event.
 656   if (NS_SUCCEEDED(aStatus))
 657     mCacheEntry = aCacheEntry;
 658   else if (NS_SUCCEEDED(mStatus))
 659     mStatus = aStatus;
 660
 661   nsresult rv = NS_OK;
 662   if (NS_FAILED(mStatus)) {
 663     LOG(("channel was canceled [this=%p status=%x]\n", this, mStatus));
 664     rv = mStatus;
 665   }
 666   else if (!aNew) { // advance to the next state...
 667     rv = ReadFromCache();
 668   }
 669
 670   // a failure from Connect means that we have to abort the channel.
 671   if (NS_FAILED(rv)) {
 672     CloseCacheEntry(rv);
 673
 674     if (!aNew) {
 675       // Since OnCacheEntryAvailable can be called directly from AsyncOpen
 676       // we must dispatch.
 677       NS_DispatchToCurrentThread(NS_NewRunnableMethod(
 678         this, &nsWyciwygChannel::NotifyListener));
 679     }
 680   }
 681
 682   return NS_OK;
 683 }
 684
 685 //-----------------------------------------------------------------------------
 686 // nsWyciwygChannel::nsIStreamListener
 687 //-----------------------------------------------------------------------------
 688
 689 NS_IMETHODIMP
 690 nsWyciwygChannel::OnDataAvailable(nsIRequest *request, nsISupports *ctx,
 691                                   nsIInputStream *input,
 692                                   uint64_t offset, uint32_t count)
 693 {
 694   LOG(("nsWyciwygChannel::OnDataAvailable [this=%p request=%x offset=%llu count=%u]\n",
 695       this, request, offset, count));
 696
 697   nsresult rv;
 698
 699   rv = mListener->OnDataAvailable(this, mListenerContext, input, offset, count);
 700
 701   // XXX handle 64-bit stuff for real
 702   if (mProgressSink && NS_SUCCEEDED(rv)) {
 703     mProgressSink->OnProgress(this, nullptr, offset + count,
 704                               uint64_t(mContentLength));
 705   }
 706
 707   return rv; // let the pump cancel on failure
 708 }
 709
 710 //////////////////////////////////////////////////////////////////////////////
 711 // nsIRequestObserver
 712 //////////////////////////////////////////////////////////////////////////////
 713
 714 NS_IMETHODIMP
 715 nsWyciwygChannel::OnStartRequest(nsIRequest *request, nsISupports *ctx)
 716 {
 717   LOG(("nsWyciwygChannel::OnStartRequest [this=%p request=%x\n",
 718       this, request));
 719
 720   return mListener->OnStartRequest(this, mListenerContext);
 721 }
 722
 723
 724 NS_IMETHODIMP
 725 nsWyciwygChannel::OnStopRequest(nsIRequest *request, nsISupports *ctx, nsresult status)
 726 {
 727   LOG(("nsWyciwygChannel::OnStopRequest [this=%p request=%x status=%d\n",
 728       this, request, status));
 729
 730   if (NS_SUCCEEDED(mStatus))
 731     mStatus = status;
 732
 733   mListener->OnStopRequest(this, mListenerContext, mStatus);
 734   mListener = 0;
 735   mListenerContext = 0;
 736
 737   if (mLoadGroup)
 738     mLoadGroup->RemoveRequest(this, nullptr, mStatus);
 739
 740   CloseCacheEntry(mStatus);
 741   mPump = 0;
 742   mIsPending = false;
 743
 744   // Drop notification callbacks to prevent cycles.
 745   mCallbacks = 0;
 746   mProgressSink = 0;
 747
 748   return NS_OK;
 749 }
 750
 751 //////////////////////////////////////////////////////////////////////////////
 752 // Helper functions
 753 //////////////////////////////////////////////////////////////////////////////
 754
 755 nsresult
 756 nsWyciwygChannel::OpenCacheEntry(nsIURI *aURI,
 757                                  uint32_t aOpenFlags)
 758 {
 759   nsresult rv;
 760
 761   nsCOMPtr<nsICacheStorageService> cacheService =
 762     do_GetService("@mozilla.org/netwerk/cache-storage-service;1", &rv);
 763   NS_ENSURE_SUCCESS(rv, rv);
 764
 765   bool anonymous = mLoadFlags & LOAD_ANONYMOUS;
 766   nsRefPtr<LoadContextInfo> loadInfo = mozilla::net::GetLoadContextInfo(
 767     mPrivateBrowsing, mAppId, mInBrowser, anonymous);
 768
 769   nsCOMPtr<nsICacheStorage> cacheStorage;
 770   if (mLoadFlags & INHIBIT_PERSISTENT_CACHING)
 771     rv = cacheService->MemoryCacheStorage(loadInfo, getter_AddRefs(cacheStorage));
 772   else
 773     rv = cacheService->DiskCacheStorage(loadInfo, false, getter_AddRefs(cacheStorage));
 774   NS_ENSURE_SUCCESS(rv, rv);
 775
 776   rv = cacheStorage->AsyncOpenURI(aURI, EmptyCString(), aOpenFlags, this);
 777   NS_ENSURE_SUCCESS(rv, rv);
 778
 779   return NS_OK;
 780 }
 781
 782 nsresult
 783 nsWyciwygChannel::ReadFromCache()
 784 {
 785   LOG(("nsWyciwygChannel::ReadFromCache [this=%p] ", this));
 786
 787   NS_ENSURE_TRUE(mCacheEntry, NS_ERROR_FAILURE);
 788   nsresult rv;
 789
 790   // Get the stored security info
 791   mCacheEntry->GetSecurityInfo(getter_AddRefs(mSecurityInfo));
 792
 793   nsAutoCString tmpStr;
 794   rv = mCacheEntry->GetMetaDataElement("inhibit-persistent-caching",
 795                                        getter_Copies(tmpStr));
 796   if (NS_SUCCEEDED(rv) && tmpStr.EqualsLiteral("1"))
 797     mLoadFlags |= INHIBIT_PERSISTENT_CACHING;
 798
 799   // Get a transport to the cached data...
 800   rv = mCacheEntry->OpenInputStream(0, getter_AddRefs(mCacheInputStream));
 801   if (NS_FAILED(rv))
 802     return rv;
 803   NS_ENSURE_TRUE(mCacheInputStream, NS_ERROR_UNEXPECTED);
 804
 805   rv = NS_NewInputStreamPump(getter_AddRefs(mPump), mCacheInputStream);
 806   if (NS_FAILED(rv)) return rv;
 807
 808   // Pump the cache data downstream
 809   return mPump->AsyncRead(this, nullptr);
 810 }
 811
 812 void
 813 nsWyciwygChannel::WriteCharsetAndSourceToCache(int32_t aSource,
 814                                                const nsCString& aCharset)
 815 {
 816   NS_ASSERTION(IsOnCacheIOThread(), "wrong thread");
 817   NS_PRECONDITION(mCacheEntry, "Better have cache entry!");
 818
 819   mCacheEntry->SetMetaDataElement("charset", aCharset.get());
 820
 821   nsAutoCString source;
 822   source.AppendInt(aSource);
 823   mCacheEntry->SetMetaDataElement("charset-source", source.get());
 824 }
 825
 826 void
 827 nsWyciwygChannel::NotifyListener()
 828 {
 829   if (mListener) {
 830     mListener->OnStartRequest(this, mListenerContext);
 831     mListener->OnStopRequest(this, mListenerContext, mStatus);
 832     mListener = 0;
 833     mListenerContext = 0;
 834   }
 835
 836   mIsPending = false;
 837
 838   // Remove ourselves from the load group.
 839   if (mLoadGroup) {
 840     mLoadGroup->RemoveRequest(this, nullptr, mStatus);
 841   }
 842 }
 843
 844 bool
 845 nsWyciwygChannel::IsOnCacheIOThread()
 846 {
 847   bool correctThread;
 848   mCacheIOTarget->IsOnCurrentThread(&correctThread);
 849   return correctThread;
 850 }
 851
 852 // vim: ts=2 sw=2