fixing overrelease and out-of-bounds write, fixes #13725

[wxWidgets.git] / src / common / dobjcmn.cpp

diff --git a/src/common/dobjcmn.cpp b/src/common/dobjcmn.cpp
index cbed32d72f9ba9c76ba6d303b6c71d540b8c6a7f..79250414207599d5a1f6b0cb42ca8e7ece49712f 100644 (file)
--- a/src/common/dobjcmn.cpp
+++ b/src/common/dobjcmn.cpp
@@ -18,12 +18,13 @@
 
 #if wxUSE_DATAOBJ
 
 
 #if wxUSE_DATAOBJ
 

+#include "wx/dataobj.h"
+

 #ifndef WX_PRECOMP
     #include "wx/app.h"
 #ifndef WX_PRECOMP
     #include "wx/app.h"

-    #include "wx/debug.h"

 #endif
 
 #endif
 

-#include "wx/dataobj.h"
+#include "wx/textbuf.h"

 
 // ----------------------------------------------------------------------------
 // lists
 
 // ----------------------------------------------------------------------------
 // lists


@@ -86,6 +87,7 @@ bool wxDataObjectBase::IsSupported(const wxDataFormat& format,
 wxDataObjectComposite::wxDataObjectComposite()
 {
     m_preferred = 0;
 wxDataObjectComposite::wxDataObjectComposite()
 {
     m_preferred = 0;

+    m_receivedFormat = wxFormatInvalid;

 }
 
 wxDataObjectComposite::~wxDataObjectComposite()
 }
 
 wxDataObjectComposite::~wxDataObjectComposite()


@@ -94,22 +96,19 @@ wxDataObjectComposite::~wxDataObjectComposite()
 }
 
 wxDataObjectSimple *
 }
 
 wxDataObjectSimple *

-wxDataObjectComposite::GetObject(const wxDataFormat& format) const
+wxDataObjectComposite::GetObject(const wxDataFormat& format, wxDataObjectBase::Direction dir) const

 {
     wxSimpleDataObjectList::compatibility_iterator node = m_dataObjects.GetFirst();
 {
     wxSimpleDataObjectList::compatibility_iterator node = m_dataObjects.GetFirst();

+

     while ( node )
     {
         wxDataObjectSimple *dataObj = node->GetData();
 
     while ( node )
     {
         wxDataObjectSimple *dataObj = node->GetData();
 

-        if ( dataObj->GetFormat() == format )
-        {
-            return dataObj;
-        }
-
+        if (dataObj->IsSupported(format,dir))
+          return dataObj;

         node = node->GetNext();
     }
         node = node->GetNext();
     }

-
-    return (wxDataObjectSimple *)NULL;
+    return NULL;

 }
 
 void wxDataObjectComposite::Add(wxDataObjectSimple *dataObject, bool preferred)
 }
 
 void wxDataObjectComposite::Add(wxDataObjectSimple *dataObject, bool preferred)


@@ -120,6 +119,11 @@ void wxDataObjectComposite::Add(wxDataObjectSimple *dataObject, bool preferred)
     m_dataObjects.Append( dataObject );
 }
 
     m_dataObjects.Append( dataObject );
 }
 

+wxDataFormat wxDataObjectComposite::GetReceivedFormat() const
+{
+    return m_receivedFormat;
+}
+

 wxDataFormat
 wxDataObjectComposite::GetPreferredFormat(Direction WXUNUSED(dir)) const
 {
 wxDataFormat
 wxDataObjectComposite::GetPreferredFormat(Direction WXUNUSED(dir)) const
 {


@@ -171,21 +175,33 @@ void* wxDataObjectComposite::SetSizeInBuffer( void* buffer, size_t size,
 
 #endif
 
 
 #endif
 

-size_t wxDataObjectComposite::GetFormatCount(Direction WXUNUSED(dir)) const
+size_t wxDataObjectComposite::GetFormatCount(Direction dir) const

 {
 {

-    // TODO what about the Get/Set only formats?
-    return m_dataObjects.GetCount();
+    size_t n = 0;
+
+    // NOTE: some wxDataObjectSimple objects may return a number greater than 1
+    //       from GetFormatCount(): this is the case of e.g. wxTextDataObject
+    //       under wxMac and wxGTK
+    wxSimpleDataObjectList::compatibility_iterator node;
+    for ( node = m_dataObjects.GetFirst(); node; node = node->GetNext() )
+        n += node->GetData()->GetFormatCount(dir);
+
+    return n;

 }
 
 void wxDataObjectComposite::GetAllFormats(wxDataFormat *formats,
 }
 
 void wxDataObjectComposite::GetAllFormats(wxDataFormat *formats,

-                                          Direction WXUNUSED(dir)) const
+                                          Direction dir) const

 {
 {

-    size_t n = 0;
+    size_t index(0);

     wxSimpleDataObjectList::compatibility_iterator node;
     wxSimpleDataObjectList::compatibility_iterator node;

+

     for ( node = m_dataObjects.GetFirst(); node; node = node->GetNext() )
     {
     for ( node = m_dataObjects.GetFirst(); node; node = node->GetNext() )
     {

-        // TODO if ( !outputOnlyToo ) && this one counts ...
-        formats[n++] = node->GetData()->GetFormat();
+        // NOTE: some wxDataObjectSimple objects may return more than 1 format
+        //       from GetAllFormats(): this is the case of e.g. wxTextDataObject
+        //       under wxMac and wxGTK
+        node->GetData()->GetAllFormats(formats+index, dir);
+        index += node->GetData()->GetFormatCount(dir);

     }
 }
 
     }
 }
 


@@ -219,14 +235,26 @@ bool wxDataObjectComposite::SetData(const wxDataFormat& format,
     wxCHECK_MSG( dataObj, false,
                  wxT("unsupported format in wxDataObjectComposite"));
 
     wxCHECK_MSG( dataObj, false,
                  wxT("unsupported format in wxDataObjectComposite"));
 

-    return dataObj->SetData( len, buf );
+    m_receivedFormat = format;
+
+    // Notice that we must pass "format" here as wxTextDataObject, that we can
+    // have as one of our "simple" sub-objects actually is not that simple and
+    // can support multiple formats (ASCII/UTF-8/UTF-16/...) and so needs to
+    // know which one it is given.
+    return dataObj->SetData( format, len, buf );

 }
 
 // ----------------------------------------------------------------------------
 // wxTextDataObject
 // ----------------------------------------------------------------------------
 
 }
 
 // ----------------------------------------------------------------------------
 // wxTextDataObject
 // ----------------------------------------------------------------------------
 

-#if defined(__WXGTK20__) && wxUSE_UNICODE
+#ifdef wxNEEDS_UTF8_FOR_TEXT_DATAOBJ
+
+// FIXME-UTF8: we should be able to merge wchar_t and UTF-8 versions once we
+//             have a way to get UTF-8 string (and its length) in both builds
+//             without loss of efficiency (i.e. extra buffer copy/strlen call)
+
+#if wxUSE_UNICODE_WCHAR

 
 static inline wxMBConv& GetConv(const wxDataFormat& format)
 {
 
 static inline wxMBConv& GetConv(const wxDataFormat& format)
 {


@@ -243,12 +271,15 @@ size_t wxTextDataObject::GetDataSize(const wxDataFormat& format) const
 
 bool wxTextDataObject::GetDataHere(const wxDataFormat& format, void *buf) const
 {
 
 bool wxTextDataObject::GetDataHere(const wxDataFormat& format, void *buf) const
 {

-    if ( buf == NULL )
+    if ( !buf )

         return false;
 
     wxCharBuffer buffer = GetConv(format).cWX2MB( GetText().c_str() );
         return false;
 
     wxCharBuffer buffer = GetConv(format).cWX2MB( GetText().c_str() );

+    if ( !buffer )
+        return false;

 
 

-    strcpy( (char*)buf, buffer );
+    memcpy( (char*) buf, buffer, GetDataSize(format) );
+    // strcpy( (char*) buf, buffer );

 
     return true;
 }
 
     return true;
 }


@@ -266,24 +297,89 @@ bool wxTextDataObject::SetData(const wxDataFormat& format,
     return true;
 }
 
     return true;
 }
 

-#elif wxUSE_UNICODE && defined(__WXMAC__)
+#else // wxUSE_UNICODE_UTF8

 
 

-static wxMBConvUTF16 sUTF16Converter;
+size_t wxTextDataObject::GetDataSize(const wxDataFormat& format) const
+{
+    const wxString& text = GetText();
+    if ( format == wxDF_UNICODETEXT || wxLocaleIsUtf8 )
+    {
+        return text.utf8_length();
+    }
+    else // wxDF_TEXT
+    {
+        const wxCharBuffer buf(wxConvLocal.cWC2MB(text.wc_str()));
+        return buf ? strlen(buf) : 0;
+    }
+}

 
 

-static inline wxMBConv& GetConv(const wxDataFormat& format)
+bool wxTextDataObject::GetDataHere(const wxDataFormat& format, void *buf) const

 {
 {

-    return
-        format == wxDF_UNICODETEXT
-        ? (wxMBConv&) sUTF16Converter
-        : (wxMBConv&) wxConvLocal;
+    if ( !buf )
+        return false;
+
+    const wxString& text = GetText();
+    if ( format == wxDF_UNICODETEXT || wxLocaleIsUtf8 )
+    {
+        memcpy(buf, text.utf8_str(), text.utf8_length());
+    }
+    else // wxDF_TEXT
+    {
+        const wxCharBuffer bufLocal(wxConvLocal.cWC2MB(text.wc_str()));
+        if ( !bufLocal )
+            return false;
+
+        memcpy(buf, bufLocal, strlen(bufLocal));
+    }
+
+    return true;

 }
 
 }
 

-size_t wxTextDataObject::GetDataSize(const wxDataFormat& format) const
+bool wxTextDataObject::SetData(const wxDataFormat& format,
+                               size_t len, const void *buf_)

 {
 {

-    size_t len = GetConv(format).WC2MB( NULL, GetText().c_str(), 0 );
-    len += (format == wxDF_UNICODETEXT ? 2 : 1);
+    const char * const buf = static_cast<const char *>(buf_);
+
+    if ( buf == NULL )
+        return false;

 
 

-    return len;
+    if ( format == wxDF_UNICODETEXT || wxLocaleIsUtf8 )
+    {
+        // normally the data is in UTF-8 so we could use FromUTF8Unchecked()
+        // but it's not absolutely clear what GTK+ does if the clipboard data
+        // is not in UTF-8 so do an extra check for tranquility, it shouldn't
+        // matter much if we lose a bit of performance when pasting from
+        // clipboard
+        SetText(wxString::FromUTF8(buf, len));
+    }
+    else // wxDF_TEXT, convert from current (non-UTF8) locale
+    {
+        SetText(wxConvLocal.cMB2WC(buf, len, NULL));
+    }
+
+    return true;
+}
+
+#endif // wxUSE_UNICODE_WCHAR/wxUSE_UNICODE_UTF8
+
+#elif defined(wxNEEDS_UTF16_FOR_TEXT_DATAOBJ)
+
+namespace
+{
+
+inline wxMBConv& GetConv(const wxDataFormat& format)
+{
+    static wxMBConvUTF16 s_UTF16Converter;
+
+    return format == wxDF_UNICODETEXT ? static_cast<wxMBConv&>(s_UTF16Converter)
+                                      : static_cast<wxMBConv&>(wxConvLocal);
+}
+
+} // anonymous namespace
+
+size_t wxTextDataObject::GetDataSize(const wxDataFormat& format) const
+{
+    return GetConv(format).WC2MB(NULL, GetText().wc_str(), 0);

 }
 
 bool wxTextDataObject::GetDataHere(const wxDataFormat& format, void *buf) const
 }
 
 bool wxTextDataObject::GetDataHere(const wxDataFormat& format, void *buf) const


@@ -291,99 +387,169 @@ bool wxTextDataObject::GetDataHere(const wxDataFormat& format, void *buf) const
     if ( buf == NULL )
         return false;
 
     if ( buf == NULL )
         return false;
 

-    wxCharBuffer buffer = GetConv(format).cWX2MB( GetText().c_str() );
-
-    size_t len = GetConv(format).WC2MB( NULL, GetText().c_str(), 0 );
-    len += (format == wxDF_UNICODETEXT ? 2 : 1);
+    wxCharBuffer buffer(GetConv(format).cWX2MB(GetText().c_str()));

 
 

-    // trailing (uni)char 0
-    memcpy( (char*)buf, (const char*)buffer, len );
+    memcpy(buf, buffer.data(), buffer.length());

 
     return true;
 }
 
 bool wxTextDataObject::SetData(const wxDataFormat& format,
 
     return true;
 }
 
 bool wxTextDataObject::SetData(const wxDataFormat& format,

-                               size_t WXUNUSED(len), const void *buf)
+                               size_t WXUNUSED(len),
+                               const void *buf)

 {
     if ( buf == NULL )
         return false;
 
 {
     if ( buf == NULL )
         return false;
 

-    wxWCharBuffer buffer = GetConv(format).cMB2WX( (const char*)buf );
-
-    SetText( buffer );
+    SetText(GetConv(format).cMB2WX(static_cast<const char*>(buf)));

 
     return true;
 }
 
 
     return true;
 }
 

-#else
+#else // !wxNEEDS_UTF{8,16}_FOR_TEXT_DATAOBJ
+
+// NB: This branch, using native wxChar for the clipboard, is only used under
+//     Windows currently. It's just a coincidence, but Windows is also the only
+//     platform where we need to convert the text to the native EOL format, so
+//     wxTextBuffer::Translate() is only used here and not in the code above.

 
 size_t wxTextDataObject::GetDataSize() const
 {
 
 size_t wxTextDataObject::GetDataSize() const
 {

-    return GetTextLength() * sizeof(wxChar);
+    return (wxTextBuffer::Translate(GetText()).length() + 1)*sizeof(wxChar);

 }
 
 bool wxTextDataObject::GetDataHere(void *buf) const
 {
 }
 
 bool wxTextDataObject::GetDataHere(void *buf) const
 {

-    wxStrcpy( (wxChar*)buf, GetText().c_str() );
+    const wxString textNative = wxTextBuffer::Translate(GetText());
+
+    // NOTE: use wxTmemcpy() instead of wxStrncpy() to allow
+    //       retrieval of strings with embedded NULLs
+    wxTmemcpy(static_cast<wxChar*>(buf),
+              textNative.t_str(),
+              textNative.length() + 1);

 
     return true;
 }
 
 
     return true;
 }
 

-bool wxTextDataObject::SetData(size_t WXUNUSED(len), const void *buf)
+bool wxTextDataObject::SetData(size_t len, const void *buf)

 {
 {

-    SetText( wxString((const wxChar*)buf) );
+    const wxString
+        text = wxString(static_cast<const wxChar*>(buf), len/sizeof(wxChar));
+    SetText(wxTextBuffer::Translate(text, wxTextFileType_Unix));

 
     return true;
 }
 
 
     return true;
 }
 

-#endif
+#endif // different wxTextDataObject implementations

 
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------

-// wxFileDataObjectBase
+// wxHTMLDataObject

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-// VZ: I don't need this in MSW finally, so if it is needed in wxGTK, it should
-//     be moved to gtk/dataobj.cpp
-#if 0
+size_t wxHTMLDataObject::GetDataSize() const
+{
+    const wxScopedCharBuffer buffer(GetHTML().utf8_str());
+
+    size_t size = buffer.length();

 
 

-wxString wxFileDataObjectBase::GetFilenames() const
+#ifdef __WXMSW__
+    // On Windows we need to add some stuff to the string to satisfy
+    // its clipboard format requirements.
+    size += 400;
+#endif
+
+    return size;
+}
+
+bool wxHTMLDataObject::GetDataHere(void *buf) const

 {
 {

-    wxString str;
-    size_t count = m_filenames.GetCount();
-    for ( size_t n = 0; n < count; n++ )
-    {
-        str << m_filenames[n] << wxT('\0');
-    }
+    if ( !buf )
+        return false;

 
 

-    return str;
+    // Windows and Mac always use UTF-8, and docs suggest GTK does as well.
+    const wxScopedCharBuffer html(GetHTML().utf8_str());
+    if ( !html )
+        return false;
+
+    char* const buffer = static_cast<char*>(buf);
+
+#ifdef __WXMSW__
+    // add the extra info that the MSW clipboard format requires.
+
+        // Create a template string for the HTML header...
+    strcpy(buffer,
+        "Version:0.9\r\n"
+        "StartHTML:00000000\r\n"
+        "EndHTML:00000000\r\n"
+        "StartFragment:00000000\r\n"
+        "EndFragment:00000000\r\n"
+        "<html><body>\r\n"
+        "<!--StartFragment -->\r\n");
+
+    // Append the HTML...
+    strcat(buffer, html);
+    strcat(buffer, "\r\n");
+    // Finish up the HTML format...
+    strcat(buffer,
+        "<!--EndFragment-->\r\n"
+        "</body>\r\n"
+        "</html>");
+
+    // Now go back, calculate all the lengths, and write out the
+    // necessary header information. Note, wsprintf() truncates the
+    // string when you overwrite it so you follow up with code to replace
+    // the 0 appended at the end with a '\r'...
+    char *ptr = strstr(buffer, "StartHTML");
+    sprintf(ptr+10, "%08u", (unsigned)(strstr(buffer, "<html>") - buffer));
+    *(ptr+10+8) = '\r';
+
+    ptr = strstr(buffer, "EndHTML");
+    sprintf(ptr+8, "%08u", (unsigned)strlen(buffer));
+    *(ptr+8+8) = '\r';
+
+    ptr = strstr(buffer, "StartFragment");
+    sprintf(ptr+14, "%08u", (unsigned)(strstr(buffer, "<!--StartFrag") - buffer));
+    *(ptr+14+8) = '\r';
+
+    ptr = strstr(buffer, "EndFragment");
+    sprintf(ptr+12, "%08u", (unsigned)(strstr(buffer, "<!--EndFrag") - buffer));
+    *(ptr+12+8) = '\r';
+#else
+    strcpy(buffer, html);
+#endif // __WXMSW__
+
+    return true;

 }
 
 }
 

-void wxFileDataObjectBase::SetFilenames(const wxChar* filenames)
+bool wxHTMLDataObject::SetData(size_t WXUNUSED(len), const void *buf)

 {
 {

-    m_filenames.Empty();
+    if ( buf == NULL )
+        return false;

 
 

-    wxString current;
-    for ( const wxChar *pc = filenames; ; pc++ )
+    // Windows and Mac always use UTF-8, and docs suggest GTK does as well.
+    wxString html = wxString::FromUTF8(static_cast<const char*>(buf));
+
+#ifdef __WXMSW__
+    // To be consistent with other platforms, we only add the Fragment part
+    // of the Windows HTML clipboard format to the data object.
+    int fragmentStart = html.rfind("StartFragment");
+    int fragmentEnd = html.rfind("EndFragment");
+
+    if (fragmentStart != wxNOT_FOUND && fragmentEnd != wxNOT_FOUND)

     {
     {

-        if ( *pc )
-        {
-            current += *pc;
-        }
-        else
-        {
-            if ( !current )
-            {
-                // 2 consecutive NULs - this is the end of the string
-                break;
-            }
+        int startCommentEnd = html.find("-->", fragmentStart) + 3;
+        int endCommentStart = html.rfind("<!--", fragmentEnd);

 
 

-            m_filenames.Add(current);
-            current.Empty();
-        }
+        if (startCommentEnd != wxNOT_FOUND && endCommentStart != wxNOT_FOUND)
+            html = html.Mid(startCommentEnd, endCommentStart - startCommentEnd);

     }
     }

+#endif // __WXMSW__
+
+    SetHTML( html );
+
+    return true;

 }
 
 }
 

-#endif

 
 // ----------------------------------------------------------------------------
 // wxCustomDataObject
 
 // ----------------------------------------------------------------------------
 // wxCustomDataObject


@@ -418,7 +584,7 @@ void wxCustomDataObject::Free()
 {
     delete [] (char*)m_data;
     m_size = 0;
 {
     delete [] (char*)m_data;
     m_size = 0;

-    m_data = (void*)NULL;
+    m_data = NULL;

 }
 
 size_t wxCustomDataObject::GetDataSize() const
 }
 
 size_t wxCustomDataObject::GetDataSize() const