michael@0: /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
michael@0: /* vim:set ts=4 sts=4 sw=4 cin et: */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: /**
michael@0:  * Based on original code from nsIStringStream.cpp
michael@0:  */
michael@0: 
michael@0: #include "ipc/IPCMessageUtils.h"
michael@0: 
michael@0: #include "nsStringStream.h"
michael@0: #include "nsStreamUtils.h"
michael@0: #include "nsReadableUtils.h"
michael@0: #include "nsISeekableStream.h"
michael@0: #include "nsISupportsPrimitives.h"
michael@0: #include "nsCRT.h"
michael@0: #include "prerror.h"
michael@0: #include "plstr.h"
michael@0: #include "nsIClassInfoImpl.h"
michael@0: #include "mozilla/Attributes.h"
michael@0: #include "mozilla/ipc/InputStreamUtils.h"
michael@0: #include "nsIIPCSerializableInputStream.h"
michael@0: 
michael@0: using namespace mozilla::ipc;
michael@0: 
michael@0: //-----------------------------------------------------------------------------
michael@0: // nsIStringInputStream implementation
michael@0: //-----------------------------------------------------------------------------
michael@0: 
michael@0: class nsStringInputStream MOZ_FINAL : public nsIStringInputStream
michael@0:                                     , public nsISeekableStream
michael@0:                                     , public nsISupportsCString
michael@0:                                     , public nsIIPCSerializableInputStream
michael@0: {
michael@0: public:
michael@0:     NS_DECL_THREADSAFE_ISUPPORTS
michael@0:     NS_DECL_NSIINPUTSTREAM
michael@0:     NS_DECL_NSISTRINGINPUTSTREAM
michael@0:     NS_DECL_NSISEEKABLESTREAM
michael@0:     NS_DECL_NSISUPPORTSPRIMITIVE
michael@0:     NS_DECL_NSISUPPORTSCSTRING
michael@0:     NS_DECL_NSIIPCSERIALIZABLEINPUTSTREAM
michael@0: 
michael@0:     nsStringInputStream()
michael@0:     {
michael@0:         Clear();
michael@0:     }
michael@0: 
michael@0: private:
michael@0:     ~nsStringInputStream()
michael@0:     {}
michael@0: 
michael@0:     uint32_t Length() const
michael@0:     {
michael@0:         return mData.Length();
michael@0:     }
michael@0: 
michael@0:     uint32_t LengthRemaining() const
michael@0:     {
michael@0:         return Length() - mOffset;
michael@0:     }
michael@0: 
michael@0:     void Clear()
michael@0:     {
michael@0:         mData.SetIsVoid(true);
michael@0:     }
michael@0: 
michael@0:     bool Closed()
michael@0:     {
michael@0:         return mData.IsVoid();
michael@0:     }
michael@0: 
michael@0:     nsDependentCSubstring mData;
michael@0:     uint32_t mOffset;
michael@0: };
michael@0: 
michael@0: // This class needs to support threadsafe refcounting since people often
michael@0: // allocate a string stream, and then read it from a background thread.
michael@0: NS_IMPL_ADDREF(nsStringInputStream)
michael@0: NS_IMPL_RELEASE(nsStringInputStream)
michael@0: 
michael@0: NS_IMPL_CLASSINFO(nsStringInputStream, nullptr, nsIClassInfo::THREADSAFE,
michael@0:                   NS_STRINGINPUTSTREAM_CID)
michael@0: NS_IMPL_QUERY_INTERFACE_CI(nsStringInputStream,
michael@0:                            nsIStringInputStream,
michael@0:                            nsIInputStream,
michael@0:                            nsISupportsCString,
michael@0:                            nsISeekableStream,
michael@0:                            nsIIPCSerializableInputStream)
michael@0: NS_IMPL_CI_INTERFACE_GETTER(nsStringInputStream,
michael@0:                             nsIStringInputStream,
michael@0:                             nsIInputStream,
michael@0:                             nsISupportsCString,
michael@0:                             nsISeekableStream)
michael@0: 
michael@0: /////////
michael@0: // nsISupportsCString implementation
michael@0: /////////
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsStringInputStream::GetType(uint16_t *type)
michael@0: {
michael@0:     *type = TYPE_CSTRING;
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsStringInputStream::GetData(nsACString &data)
michael@0: {
michael@0:     // The stream doesn't have any data when it is closed.  We could fake it
michael@0:     // and return an empty string here, but it seems better to keep this return
michael@0:     // value consistent with the behavior of the other 'getter' methods.
michael@0:     if (NS_WARN_IF(Closed()))
michael@0:         return NS_BASE_STREAM_CLOSED;
michael@0: 
michael@0:     data.Assign(mData);
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsStringInputStream::SetData(const nsACString &data)
michael@0: {
michael@0:     mData.Assign(data);
michael@0:     mOffset = 0;
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsStringInputStream::ToString(char **result)
michael@0: {
michael@0:     // NOTE: This method may result in data loss, so we do not implement it.
michael@0:     return NS_ERROR_NOT_IMPLEMENTED;
michael@0: }
michael@0: 
michael@0: /////////
michael@0: // nsIStringInputStream implementation
michael@0: /////////
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsStringInputStream::SetData(const char *data, int32_t dataLen)
michael@0: {
michael@0:     if (NS_WARN_IF(!data))
michael@0:         return NS_ERROR_INVALID_ARG;
michael@0:     mData.Assign(data, dataLen);
michael@0:     mOffset = 0;
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsStringInputStream::AdoptData(char *data, int32_t dataLen)
michael@0: {
michael@0:     if (NS_WARN_IF(!data))
michael@0:         return NS_ERROR_INVALID_ARG;
michael@0:     mData.Adopt(data, dataLen);
michael@0:     mOffset = 0;
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsStringInputStream::ShareData(const char *data, int32_t dataLen)
michael@0: {
michael@0:     if (NS_WARN_IF(!data))
michael@0:         return NS_ERROR_INVALID_ARG;
michael@0: 
michael@0:     if (dataLen < 0)
michael@0:         dataLen = strlen(data);
michael@0: 
michael@0:     mData.Rebind(data, dataLen);
michael@0:     mOffset = 0;
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: /////////
michael@0: // nsIInputStream implementation
michael@0: /////////
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsStringInputStream::Close()
michael@0: {
michael@0:     Clear();
michael@0:     return NS_OK;
michael@0: }
michael@0:     
michael@0: NS_IMETHODIMP
michael@0: nsStringInputStream::Available(uint64_t *aLength)
michael@0: {
michael@0:     NS_ASSERTION(aLength, "null ptr");
michael@0: 
michael@0:     if (Closed())
michael@0:         return NS_BASE_STREAM_CLOSED;
michael@0: 
michael@0:     *aLength = LengthRemaining();
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsStringInputStream::Read(char* aBuf, uint32_t aCount, uint32_t *aReadCount)
michael@0: {
michael@0:     NS_ASSERTION(aBuf, "null ptr");
michael@0:     return ReadSegments(NS_CopySegmentToBuffer, aBuf, aCount, aReadCount);
michael@0: }
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsStringInputStream::ReadSegments(nsWriteSegmentFun writer, void *closure,
michael@0:                                   uint32_t aCount, uint32_t *result)
michael@0: {
michael@0:     NS_ASSERTION(result, "null ptr");
michael@0:     NS_ASSERTION(Length() >= mOffset, "bad stream state");
michael@0: 
michael@0:     if (Closed())
michael@0:         return NS_BASE_STREAM_CLOSED;
michael@0: 
michael@0:     // We may be at end-of-file
michael@0:     uint32_t maxCount = LengthRemaining();
michael@0:     if (maxCount == 0) {
michael@0:         *result = 0;
michael@0:         return NS_OK;
michael@0:     }
michael@0: 
michael@0:     if (aCount > maxCount)
michael@0:         aCount = maxCount;
michael@0:     nsresult rv = writer(this, closure, mData.BeginReading() + mOffset, 0, aCount, result);
michael@0:     if (NS_SUCCEEDED(rv)) {
michael@0:         NS_ASSERTION(*result <= aCount,
michael@0:                      "writer should not write more than we asked it to write");
michael@0:         mOffset += *result;
michael@0:     }
michael@0: 
michael@0:     // errors returned from the writer end here!
michael@0:     return NS_OK;
michael@0: }
michael@0:     
michael@0: NS_IMETHODIMP
michael@0: nsStringInputStream::IsNonBlocking(bool *aNonBlocking)
michael@0: {
michael@0:     *aNonBlocking = true;
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: /////////
michael@0: // nsISeekableStream implementation
michael@0: /////////
michael@0: 
michael@0: NS_IMETHODIMP 
michael@0: nsStringInputStream::Seek(int32_t whence, int64_t offset)
michael@0: {
michael@0:     if (Closed())
michael@0:         return NS_BASE_STREAM_CLOSED;
michael@0: 
michael@0:     // Compute new stream position.  The given offset may be a negative value.
michael@0:  
michael@0:     int64_t newPos = offset;
michael@0:     switch (whence) {
michael@0:     case NS_SEEK_SET:
michael@0:         break;
michael@0:     case NS_SEEK_CUR:
michael@0:         newPos += mOffset;
michael@0:         break;
michael@0:     case NS_SEEK_END:
michael@0:         newPos += Length();
michael@0:         break;
michael@0:     default:
michael@0:         NS_ERROR("invalid whence");
michael@0:         return NS_ERROR_INVALID_ARG;
michael@0:     }
michael@0: 
michael@0:     if (NS_WARN_IF(newPos < 0) || NS_WARN_IF(newPos > Length()))
michael@0:         return NS_ERROR_INVALID_ARG;
michael@0: 
michael@0:     mOffset = (uint32_t)newPos;
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsStringInputStream::Tell(int64_t* outWhere)
michael@0: {
michael@0:     if (Closed())
michael@0:         return NS_BASE_STREAM_CLOSED;
michael@0: 
michael@0:     *outWhere = mOffset;
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsStringInputStream::SetEOF()
michael@0: {
michael@0:     if (Closed())
michael@0:         return NS_BASE_STREAM_CLOSED;
michael@0: 
michael@0:     mOffset = Length();
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: void
michael@0: nsStringInputStream::Serialize(InputStreamParams& aParams,
michael@0:                                FileDescriptorArray& /* aFDs */)
michael@0: {
michael@0:     StringInputStreamParams params;
michael@0:     params.data() = PromiseFlatCString(mData);
michael@0:     aParams = params;
michael@0: }
michael@0: 
michael@0: bool
michael@0: nsStringInputStream::Deserialize(const InputStreamParams& aParams,
michael@0:                                  const FileDescriptorArray& /* aFDs */)
michael@0: {
michael@0:     if (aParams.type() != InputStreamParams::TStringInputStreamParams) {
michael@0:         NS_ERROR("Received unknown parameters from the other process!");
michael@0:         return false;
michael@0:     }
michael@0: 
michael@0:     const StringInputStreamParams& params =
michael@0:         aParams.get_StringInputStreamParams();
michael@0: 
michael@0:     if (NS_FAILED(SetData(params.data()))) {
michael@0:         NS_WARNING("SetData failed!");
michael@0:         return false;
michael@0:     }
michael@0: 
michael@0:     return true;
michael@0: }
michael@0: 
michael@0: nsresult
michael@0: NS_NewByteInputStream(nsIInputStream** aStreamResult,
michael@0:                       const char* aStringToRead, int32_t aLength,
michael@0:                       nsAssignmentType aAssignment)
michael@0: {
michael@0:     NS_PRECONDITION(aStreamResult, "null out ptr");
michael@0: 
michael@0:     nsStringInputStream* stream = new nsStringInputStream();
michael@0:     if (! stream)
michael@0:         return NS_ERROR_OUT_OF_MEMORY;
michael@0: 
michael@0:     NS_ADDREF(stream);
michael@0: 
michael@0:     nsresult rv;
michael@0:     switch (aAssignment) {
michael@0:     case NS_ASSIGNMENT_COPY:
michael@0:         rv = stream->SetData(aStringToRead, aLength);
michael@0:         break;
michael@0:     case NS_ASSIGNMENT_DEPEND:
michael@0:         rv = stream->ShareData(aStringToRead, aLength);
michael@0:         break;
michael@0:     case NS_ASSIGNMENT_ADOPT:
michael@0:         rv = stream->AdoptData(const_cast<char*>(aStringToRead), aLength);
michael@0:         break;
michael@0:     default:
michael@0:         NS_ERROR("invalid assignment type");
michael@0:         rv = NS_ERROR_INVALID_ARG;
michael@0:     }
michael@0:     
michael@0:     if (NS_FAILED(rv)) {
michael@0:         NS_RELEASE(stream);
michael@0:         return rv;
michael@0:     }
michael@0:     
michael@0:     *aStreamResult = stream;
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: nsresult
michael@0: NS_NewStringInputStream(nsIInputStream** aStreamResult,
michael@0:                         const nsAString& aStringToRead)
michael@0: {
michael@0:     NS_LossyConvertUTF16toASCII data(aStringToRead); // truncates high-order bytes
michael@0:     return NS_NewCStringInputStream(aStreamResult, data);
michael@0: }
michael@0: 
michael@0: nsresult
michael@0: NS_NewCStringInputStream(nsIInputStream** aStreamResult,
michael@0:                          const nsACString& aStringToRead)
michael@0: {
michael@0:     NS_PRECONDITION(aStreamResult, "null out ptr");
michael@0: 
michael@0:     nsStringInputStream* stream = new nsStringInputStream();
michael@0:     if (! stream)
michael@0:         return NS_ERROR_OUT_OF_MEMORY;
michael@0: 
michael@0:     NS_ADDREF(stream);
michael@0: 
michael@0:     stream->SetData(aStringToRead);
michael@0: 
michael@0:     *aStreamResult = stream;
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: // factory method for constructing a nsStringInputStream object
michael@0: nsresult
michael@0: nsStringInputStreamConstructor(nsISupports *outer, REFNSIID iid, void **result)
michael@0: {
michael@0:     *result = nullptr;
michael@0: 
michael@0:     if (NS_WARN_IF(outer))
michael@0:         return NS_ERROR_NO_AGGREGATION;
michael@0: 
michael@0:     nsStringInputStream *inst = new nsStringInputStream();
michael@0:     if (!inst)
michael@0:         return NS_ERROR_OUT_OF_MEMORY;
michael@0: 
michael@0:     NS_ADDREF(inst);
michael@0:     nsresult rv = inst->QueryInterface(iid, result);
michael@0:     NS_RELEASE(inst);
michael@0: 
michael@0:     return rv;
michael@0: }