MultipartMixedContents.cxx

Go to the documentation of this file.

#if defined(HAVE_CONFIG_H)
#include "config.h"
#endif
 
#include "resip/stack/MultipartMixedContents.hxx"
#include "resip/stack/SipMessage.hxx"
#include "rutil/Logger.hxx"
#include "rutil/Random.hxx"
#include "rutil/BaseException.hxx"
#include "rutil/ParseBuffer.hxx"
#include "rutil/WinLeakCheck.hxx"
 
using namespace resip;
using namespace std;
 
#define RESIPROCATE_SUBSYSTEM Subsystem::CONTENTS
 
bool
MultipartMixedContents::init()
{
   static ContentsFactory<MultipartMixedContents> factory;
   (void)factory;
   return true;
}
 
MultipartMixedContents::MultipartMixedContents()
   : Contents(getStaticType()),
     mContents(),
     mRawFirstPart(),
     mDepth(0)
{
   setBoundary();
}
 
MultipartMixedContents::MultipartMixedContents(const Mime& contentsType)
   : Contents(contentsType),
     mContents(),
     mRawFirstPart(),
     mDepth(0)
{
   if (!mType.exists(p_boundary))
   {
      setBoundary();
   }
}
 
MultipartMixedContents::MultipartMixedContents(const HeaderFieldValue& hfv, const Mime& contentsType)
   : Contents(hfv, contentsType),
     mContents(),
     mRawFirstPart(),
     mDepth(0)
{
   if (!mType.exists(p_boundary))
   {
      setBoundary();
   }
}
 
// mRawFirstPart is deliberately not carried over: it is a view into the buffer
// rhs was parsed from, and the copy has a buffer of its own.  Whether the copy
// ends up with a record depends on when it was taken.  Copying an unparsed body
// leaves the copy unparsed as well, holding a deep copy of the buffer, and its
// first access parses that buffer and records a view into it.  Copying a body
// that was already parsed leaves the parts and no record, because nothing
// parses a second time, and checkSignature() then falls back to the
// re-encoding.  See getRawFirstPart() in the header.
MultipartMixedContents::MultipartMixedContents(const MultipartMixedContents& rhs)
   : Contents(rhs),
     mContents(),
     mRawFirstPart(),
     mDepth(rhs.mDepth)
{
   vector<Contents*>::const_iterator j;
 
   // .bwc. Don't trigger a parse of the original by calling parts()
   const vector<Contents*>& list = rhs.mContents;
   
   for ( j = list.begin(); 
         j != list.end(); ++j)
   {
      resip_assert( *j );
      mContents.push_back( (*j)->clone() );
   }
}
 
void
MultipartMixedContents::setBoundary()
{
   Data boundaryToken = Random::getRandomHex(8);
   mType.param(p_boundary) = boundaryToken;
}
 
void
MultipartMixedContents::setBoundary(const Data& boundary)
{
    mType.param(p_boundary) = boundary;
}
 
Data
MultipartMixedContents::getRawFirstPart() const
{
   // The const overload of checkParsed() parses without marking the object
   // DIRTY.  Calling the non-const one here would drop the very bytes this
   // function exists to return.
   checkParsed();
   return mRawFirstPart;
}
 
void
MultipartMixedContents::clear()
{
   for (vector<Contents*>::iterator i = mContents.begin(); 
        i != mContents.end(); ++i)
   {
      delete *i;
   }
   // Assign a fresh Data rather than clear(): clear() keeps the shared pointer
   // and only sets the size to zero.
   mRawFirstPart = Data();
}
 
MultipartMixedContents::~MultipartMixedContents()
{
   clear();
}
 
MultipartMixedContents&
MultipartMixedContents::operator=(const MultipartMixedContents& rhs)
{
   if (this != &rhs)
   {
      // Drop the view first: Contents::operator=() replaces the buffer it
      // points into.  clear() below would do it too, but only after that, and
      // a reader should not have to reason about the order.  Whether a record
      // reappears afterwards depends on when the assignment happened, exactly
      // as for the copy constructor: from a source nothing has read, this
      // object stays unparsed with a buffer of its own and its first access
      // records a view into that buffer; from a source that was already
      // parsed, no record.
      mRawFirstPart = Data();
      Contents::operator=(rhs);
      clear();
      mDepth = rhs.mDepth;
 
      for (vector<Contents*>::const_iterator i = rhs.mContents.begin(); 
           i != rhs.mContents.end(); ++i)
      {
         mContents.push_back( (*i)->clone() );
      }
   }
   return *this;
}
 
Contents* 
MultipartMixedContents::clone() const
{
   return new MultipartMixedContents(*this);
}
 
const Mime& 
MultipartMixedContents::getStaticType() 
{
   static Mime type("multipart","mixed");
   return type;
}
 
EncodeStream& 
MultipartMixedContents::encodeParsed(EncodeStream& str) const
{
   const Data& boundaryToken = mType.param(p_boundary);
   Data boundary(boundaryToken.size() + 2, Data::Preallocate);
   boundary = Symbols::DASHDASH;
   boundary += boundaryToken;
   boundary.replace("\"", ""); // remove quotes
 
   resip_assert( mContents.size() > 0 );
   
   bool first = true;
   for (vector<Contents*>::const_iterator i = mContents.begin(); 
        i != mContents.end(); ++i)
   {
      if (!first)
      {
         str << Symbols::CRLF;
      }
      else
      {
         first = false;
      }
      str << boundary << Symbols::CRLF;
      (*i)->encodeHeaders(str);
      (*i)->encode(str);
   }
 
   // Note:  last CRLF isn't strictly required by RFC2046 ABNF, but some implementations seem to require it so we include it
   str << Symbols::CRLF << boundary << Symbols::DASHDASH << Symbols::CRLF;
   return str;
}
 
// The boundary delimiter MUST occur at the beginning of a line, i.e., following
// a CRLF, and the initial CRLF is considered to be attached to the boundary
// delimiter line rather than part of the preceding part.
void
MultipartMixedContents::parse(ParseBuffer& pb)
{
   // The depth is stamped on this object when the enclosing part created it
   // (below), so this holds whether the parse runs right away or much later
   // from a tree walk such as Helper::getSdp().
   if (mDepth > MaxNestingDepth)
   {
      throw Exception("Multipart nesting too deep", __FILE__, __LINE__);
   }
 
   const Data& boundaryToken = mType.param(p_boundary);
   
   Data boundary(boundaryToken.size() + 4, Data::Preallocate);
   boundary += Symbols::CRLF;
   boundary += Symbols::DASHDASH;
   boundary += boundaryToken;
 
   Data boundaryNoCRLF(boundaryToken.size() + 2, Data::Preallocate);
   boundaryNoCRLF += Symbols::DASHDASH;
   boundaryNoCRLF += boundaryToken;
 
   pb.skipToChars(boundaryNoCRLF);
   pb.skipN(boundaryNoCRLF.size());
   pb.assertNotEof();
 
   // Start from a known state instead of inferring "first part" from mContents
   // being empty: clear() deletes the parts but leaves the vector filled.
   bool firstPartSeen = false;
   mRawFirstPart = Data();
 
   do
   {
      // skip over boundary
 
      if( pb.eof() || *pb.position() != Symbols::CR[0] )
      {
         throw Exception("Invalid line ending, missing CR",__FILE__,__LINE__);
      }
      pb.skipChar();
      if( pb.eof() || *pb.position() != Symbols::LF[0] )
      {
         throw Exception("Invalid line ending, missing LF",__FILE__,__LINE__);
      }
      pb.skipChar();
      
      pb.assertNotEof();
 
      const char* headerStart = pb.position();
 
      // pull out contents type only
      pb.skipToChars("Content-Type");
      if (pb.eof())
      {
         pb.reset(headerStart);
         pb.skipToChars("CONTENT-TYPE");
      }
      pb.assertNotEof();
 
      pb.skipToChar(Symbols::COLON[0]);
      pb.skipChar();
      pb.assertNotEof();
      
      pb.skipWhitespace();
      const char* typeStart = pb.position();
      pb.assertNotEof();
      
      // determine contents-type header buffer
      pb.skipToTermCRLF();
      pb.assertNotEof();
 
      ParseBuffer subPb(typeStart, pb.position() - typeStart);
      Mime contentType;
      contentType.parse(subPb);
      
      pb.assertNotEof();
 
      // determine body start
      pb.reset(typeStart);
      const char* bodyStart = pb.skipToChars(Symbols::CRLFCRLF);
      pb.assertNotEof();
      bodyStart += 4;
 
      // determine contents body buffer
      pb.skipToChars(boundary);
      pb.assertNotEof();
      Data tmp;
      pb.data(tmp, bodyStart);
      if (!firstPartSeen)
      {
         firstPartSeen = true;
         // Keep a view of the first part exactly as it arrived, header block
         // included.  The parse position sits on the CRLF that belongs to the
         // next boundary (RFC 2046 5.1.1), so that CRLF is correctly left out.
         // Data::Share means this points into the buffer being parsed instead
         // of copying it, so an ordinary multipart message costs nothing here.
         // Only the first part is kept: it is the one RFC 1847 signs.
         mRawFirstPart = Data(Data::Share, headerStart,
                              static_cast<Data::size_type>(pb.position() - headerStart));
      }
      // create contents against body
      mContents.push_back(createContents(contentType, tmp));
      // A nested multipart part (of any subtype) sits one level deeper.
      MultipartMixedContents* nested = dynamic_cast<MultipartMixedContents*>(mContents.back());
      if (nested)
      {
         nested->mDepth = mDepth + 1;
      }
      // pre-parse headers
      ParseBuffer headersPb(headerStart, bodyStart-4-headerStart);
      mContents.back()->preParseHeaders(headersPb);
 
      pb.skipN(boundary.size());
 
      const char* loc = pb.position();
      pb.skipChar();
      pb.skipChar();
      Data next;
      pb.data(next, loc);
 
      if ( next == Symbols::DASHDASH )
      {
         break;
      }
      pb.reset( loc );
   }
   while ( !pb.eof() );
 
}
 
/* ====================================================================
 * The Vovida Software License, Version 1.0 
 * 
 * Copyright (c) 2026 SIP Spectrum, Inc. https://www.sipspectrum.com
 * Copyright (c) 2000 Vovida Networks, Inc.  All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 
 * 3. The names "VOCAL", "Vovida Open Communication Application Library",
 *    and "Vovida Open Communication Application Library (VOCAL)" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact vocal@vovida.org.
 *
 * 4. Products derived from this software may not be called "VOCAL", nor
 *    may "VOCAL" appear in their name, without prior written
 *    permission of Vovida Networks, Inc.
 * 
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
 * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL VOVIDA
 * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
 * IN EXCESS OF $1,000, NOR FOR ANY INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 * 
 * ====================================================================
 * 
 * This software consists of voluntary contributions made by Vovida
 * Networks, Inc. and many individuals on behalf of Vovida Networks,
 * Inc.  For more information on Vovida Networks, Inc., please see
 * <http://www.vovida.org/>.
 *
 */