The Tor Browser: content/base/src/FileIOObject.cpp@deefc01c0e14 (annotated)

content/base/src/FileIOObject.cpp@deefc01c0e14 (annotated)

content/base/src/FileIOObject.cpp

Thu, 15 Jan 2015 21:03:48 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 15 Jan 2015 21:03:48 +0100
branch: TOR_BUG_9701
changeset 11: deefc01c0e14
permissions: -rw-r--r--

Integrate friendly tips from Tor colleagues to make (or not) 4.5 alpha 3;
This includes removal of overloaded (but unused) methods, and addition of
a overlooked call to DataStruct::SetData(nsISupports, uint32_t, bool.)

 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 /* 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 "FileIOObject.h"
 #include "mozilla/EventDispatcher.h"
 #include "nsDOMFile.h"
 #include "nsError.h"
 #include "nsIDOMEvent.h"
 #include "nsIDOMProgressEvent.h"
 #include "nsComponentManagerUtils.h"
 #define ERROR_STR "error"
 #define ABORT_STR "abort"
 #define PROGRESS_STR "progress"
 namespace mozilla {
 namespace dom {
 const uint64_t kUnknownSize = uint64_t(-1);
 NS_IMPL_ADDREF_INHERITED(FileIOObject, DOMEventTargetHelper)
 NS_IMPL_RELEASE_INHERITED(FileIOObject, DOMEventTargetHelper)
 NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION_INHERITED(FileIOObject)
   NS_INTERFACE_MAP_ENTRY(nsITimerCallback)
   NS_INTERFACE_MAP_ENTRY(nsIStreamListener)
   NS_INTERFACE_MAP_ENTRY(nsIRequestObserver)
 NS_INTERFACE_MAP_END_INHERITING(DOMEventTargetHelper)
 NS_IMPL_CYCLE_COLLECTION_CLASS(FileIOObject)
 NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN_INHERITED(FileIOObject,
                                                   DOMEventTargetHelper)
   NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mProgressNotifier)
   NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mError)
   // Can't traverse mChannel because it's a multithreaded object.
 NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
 NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN_INHERITED(FileIOObject,
                                                 DOMEventTargetHelper)
   NS_IMPL_CYCLE_COLLECTION_UNLINK(mProgressNotifier)
   NS_IMPL_CYCLE_COLLECTION_UNLINK(mError)
   NS_IMPL_CYCLE_COLLECTION_UNLINK(mChannel)
 NS_IMPL_CYCLE_COLLECTION_UNLINK_END
 NS_IMPL_EVENT_HANDLER(FileIOObject, abort)
 NS_IMPL_EVENT_HANDLER(FileIOObject, error)
 NS_IMPL_EVENT_HANDLER(FileIOObject, progress)
 FileIOObject::FileIOObject()
   : mProgressEventWasDelayed(false),
     mTimerIsActive(false),
     mReadyState(0),
     mTotal(0), mTransferred(0)
 {}
 void
 FileIOObject::StartProgressEventTimer()
 {
   if (!mProgressNotifier) {
     mProgressNotifier = do_CreateInstance(NS_TIMER_CONTRACTID);
   }
   if (mProgressNotifier) {
     mProgressEventWasDelayed = false;
     mTimerIsActive = true;
     mProgressNotifier->Cancel();
     mProgressNotifier->InitWithCallback(this, NS_PROGRESS_EVENT_INTERVAL,
                                         nsITimer::TYPE_ONE_SHOT);
   }
 }
 void
 FileIOObject::ClearProgressEventTimer()
 {
   mProgressEventWasDelayed = false;
   mTimerIsActive = false;
   if (mProgressNotifier) {
     mProgressNotifier->Cancel();
   }
 }
 void
 FileIOObject::DispatchError(nsresult rv, nsAString& finalEvent)
 {
   // Set the status attribute, and dispatch the error event
   switch (rv) {
   case NS_ERROR_FILE_NOT_FOUND:
     mError = new DOMError(GetOwner(), NS_LITERAL_STRING("NotFoundError"));
     break;
   case NS_ERROR_FILE_ACCESS_DENIED:
     mError = new DOMError(GetOwner(), NS_LITERAL_STRING("SecurityError"));
     break;
   default:
     mError = new DOMError(GetOwner(), NS_LITERAL_STRING("NotReadableError"));
     break;
   }
   // Dispatch error event to signify load failure
   DispatchProgressEvent(NS_LITERAL_STRING(ERROR_STR));
   DispatchProgressEvent(finalEvent);
 }
 nsresult
 FileIOObject::DispatchProgressEvent(const nsAString& aType)
 {
   nsCOMPtr<nsIDOMEvent> event;
   nsresult rv = NS_NewDOMProgressEvent(getter_AddRefs(event), this,
                                        nullptr, nullptr);
   NS_ENSURE_SUCCESS(rv, rv);
   event->SetTrusted(true);
   nsCOMPtr<nsIDOMProgressEvent> progress = do_QueryInterface(event);
   NS_ENSURE_TRUE(progress, NS_ERROR_UNEXPECTED);
   bool known;
   uint64_t size;
   if (mTotal != kUnknownSize) {
     known = true;
     size = mTotal;
   } else {
     known = false;
     size = 0;
   }
   rv = progress->InitProgressEvent(aType, false, false, known,
                                    mTransferred, size);
   NS_ENSURE_SUCCESS(rv, rv);
   return DispatchDOMEvent(nullptr, event, nullptr, nullptr);
 }
 // nsITimerCallback
 NS_IMETHODIMP
 FileIOObject::Notify(nsITimer* aTimer)
 {
   nsresult rv;
   mTimerIsActive = false;
   if (mProgressEventWasDelayed) {
     rv = DispatchProgressEvent(NS_LITERAL_STRING("progress"));
     NS_ENSURE_SUCCESS(rv, rv);
     StartProgressEventTimer();
   }
   return NS_OK;
 }
 // nsIStreamListener
 NS_IMETHODIMP
 FileIOObject::OnStartRequest(nsIRequest *aRequest, nsISupports *aContext)
 {
   return DoOnStartRequest(aRequest, aContext);
 }
 NS_IMETHODIMP
 FileIOObject::DoOnStartRequest(nsIRequest *request, nsISupports *ctxt)
 {
   return NS_OK;
 }
 NS_IMETHODIMP
 FileIOObject::OnDataAvailable(nsIRequest *aRequest,
                               nsISupports *aContext,
                               nsIInputStream *aInputStream,
                               uint64_t aOffset,
                               uint32_t aCount)
 {
   nsresult rv;
   rv = DoOnDataAvailable(aRequest, aContext, aInputStream, aOffset, aCount);
   NS_ENSURE_SUCCESS(rv, rv);
   mTransferred += aCount;
   //Notify the timer is the appropriate timeframe has passed
   if (mTimerIsActive) {
     mProgressEventWasDelayed = true;
   } else {
     rv = DispatchProgressEvent(NS_LITERAL_STRING(PROGRESS_STR));
     NS_ENSURE_SUCCESS(rv, rv);
     StartProgressEventTimer();
   }
   return NS_OK;
 }
 NS_IMETHODIMP
 FileIOObject::OnStopRequest(nsIRequest* aRequest, nsISupports* aContext,
                             nsresult aStatus)
 {
   // If we're here as a result of a call from Abort(),
   // simply ignore the request.
   if (aRequest != mChannel)
     return NS_OK;
   // Cancel the progress event timer
   ClearProgressEventTimer();
   // FileIOObject must be in DONE stage after an operation
   mReadyState = 2;
   nsString successEvent, termEvent;
   nsresult rv = DoOnStopRequest(aRequest, aContext, aStatus,
                                 successEvent, termEvent);
   NS_ENSURE_SUCCESS(rv, rv);
   // Set the status field as appropriate
   if (NS_FAILED(aStatus)) {
     DispatchError(aStatus, termEvent);
     return NS_OK;
   }
   // Dispatch event to signify end of a successful operation
   DispatchProgressEvent(successEvent);
   DispatchProgressEvent(termEvent);
   return NS_OK;
 }
 void
 FileIOObject::Abort(ErrorResult& aRv)
 {
   if (mReadyState != 1) {
     // XXX The spec doesn't say this
     aRv.Throw(NS_ERROR_DOM_FILE_ABORT_ERR);
     return;
   }
   ClearProgressEventTimer();
   mReadyState = 2; // There are DONE constants on multiple interfaces,
                    // but they all have value 2.
   // XXX The spec doesn't say this
   mError = new DOMError(GetOwner(), NS_LITERAL_STRING("AbortError"));
   nsString finalEvent;
   DoAbort(finalEvent);
   // Dispatch the events
   DispatchProgressEvent(NS_LITERAL_STRING(ABORT_STR));
   DispatchProgressEvent(finalEvent);
 }
 } // namespace dom
 } // namespace mozilla

The Tor Browser / annotate

content/base/src/FileIOObject.cpp@deefc01c0e14 (annotated)

content/base/src/FileIOObject.cpp