// Copyright (c) 2006-2008 The Chromium Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. #include "app/os_exchange_data.h" #include "app/l10n_util.h" #include "base/clipboard_util.h" #include "base/file_util.h" #include "base/logging.h" #include "base/pickle.h" #include "base/scoped_handle.h" #include "base/stl_util-inl.h" #include "base/string_util.h" #include "googleurl/src/gurl.h" #include "grit/app_strings.h" #include "net/base/net_util.h" // Creates a new STGMEDIUM object to hold the specified text. The caller // owns the resulting object. The "Bytes" version does not NULL terminate, the // string version does. static STGMEDIUM* GetStorageForBytes(const char* data, size_t bytes); static STGMEDIUM* GetStorageForWString(const std::wstring& data); static STGMEDIUM* GetStorageForString(const std::string& data); // Creates the contents of an Internet Shortcut file for the given URL. static void GetInternetShortcutFileContents(const GURL& url, std::string* data); // Creates a valid file name given a suggested title and URL. static void CreateValidFileNameFromTitle(const GURL& url, const std::wstring& title, std::wstring* validated); // Creates a File Descriptor for the creation of a file to the given URL and // returns a handle to it. static STGMEDIUM* GetStorageForFileDescriptor( const std::wstring& valid_file_name); /////////////////////////////////////////////////////////////////////////////// // FormatEtcEnumerator // // This object implements an enumeration interface. The existence of an // implementation of this interface is exposed to clients through // OSExchangeData's EnumFormatEtc method. Our implementation is nobody's // business but our own, so it lives in this file. // // This Windows API is truly a gem. It wants to be an enumerator but assumes // some sort of sequential data (why not just use an array?). See comments // throughout. // class FormatEtcEnumerator : public IEnumFORMATETC { public: FormatEtcEnumerator(OSExchangeData::StoredData::const_iterator begin, OSExchangeData::StoredData::const_iterator end); ~FormatEtcEnumerator(); // IEnumFORMATETC implementation: HRESULT __stdcall Next( ULONG count, FORMATETC* elements_array, ULONG* elements_fetched); HRESULT __stdcall Skip(ULONG skip_count); HRESULT __stdcall Reset(); HRESULT __stdcall Clone(IEnumFORMATETC** clone); // IUnknown implementation: HRESULT __stdcall QueryInterface(const IID& iid, void** object); ULONG __stdcall AddRef(); ULONG __stdcall Release(); private: // This can only be called from |CloneFromOther|, since it initializes the // contents_ from the other enumerator's contents. FormatEtcEnumerator() : ref_count_(0) { } // Clone a new FormatEtc from another instance of this enumeration. static FormatEtcEnumerator* CloneFromOther(const FormatEtcEnumerator* other); private: // We are _forced_ to use a vector as our internal data model as Windows' // retarded IEnumFORMATETC API assumes a deterministic ordering of elements // through methods like Next and Skip. This exposes the underlying data // structure to the user. Bah. std::vector contents_; // The cursor of the active enumeration - an index into |contents_|. int cursor_; LONG ref_count_; DISALLOW_EVIL_CONSTRUCTORS(FormatEtcEnumerator); }; // Safely makes a copy of all of the relevant bits of a FORMATETC object. static void CloneFormatEtc(FORMATETC* source, FORMATETC* clone) { *clone = *source; if (source->ptd) { source->ptd = static_cast(CoTaskMemAlloc(sizeof(DVTARGETDEVICE))); *(clone->ptd) = *(source->ptd); } } FormatEtcEnumerator::FormatEtcEnumerator( OSExchangeData::StoredData::const_iterator start, OSExchangeData::StoredData::const_iterator end) : ref_count_(0), cursor_(0) { // Copy FORMATETC data from our source into ourselves. while (start != end) { FORMATETC* format_etc = new FORMATETC; CloneFormatEtc(&(*start)->format_etc, format_etc); contents_.push_back(format_etc); ++start; } } FormatEtcEnumerator::~FormatEtcEnumerator() { STLDeleteContainerPointers(contents_.begin(), contents_.end()); } STDMETHODIMP FormatEtcEnumerator::Next( ULONG count, FORMATETC* elements_array, ULONG* elements_fetched) { // MSDN says |elements_fetched| is allowed to be NULL if count is 1. if (!elements_fetched) DCHECK(count == 1); // This method copies count elements into |elements_array|. int index = 0; while (cursor_ < static_cast(contents_.size()) && static_cast(index) < count) { CloneFormatEtc(contents_.at(cursor_), &elements_array[index]); ++cursor_; ++index; } // The out param is for how many we actually copied. if (elements_fetched) *elements_fetched = index; // If the two don't agree, then we fail. return index == count ? S_OK : S_FALSE; } STDMETHODIMP FormatEtcEnumerator::Skip(ULONG skip_count) { cursor_ += skip_count; // MSDN implies it's OK to leave the enumerator trashed. // "Whatever you say, boss" return cursor_ <= static_cast(contents_.size()) ? S_OK : S_FALSE; } STDMETHODIMP FormatEtcEnumerator::Reset() { cursor_ = 0; return S_OK; } STDMETHODIMP FormatEtcEnumerator::Clone(IEnumFORMATETC** clone) { // Clone the current enumerator in its exact state, including cursor. FormatEtcEnumerator* e = CloneFromOther(this); e->AddRef(); *clone = e; return S_OK; } STDMETHODIMP FormatEtcEnumerator::QueryInterface(const IID& iid, void** object) { *object = NULL; if (IsEqualIID(iid, IID_IUnknown) || IsEqualIID(iid, IID_IEnumFORMATETC)) { *object = this; } else { return E_NOINTERFACE; } AddRef(); return S_OK; } ULONG FormatEtcEnumerator::AddRef() { return InterlockedIncrement(&ref_count_); } ULONG FormatEtcEnumerator::Release() { if (InterlockedDecrement(&ref_count_) == 0) { ULONG copied_refcnt = ref_count_; delete this; return copied_refcnt; } return ref_count_; } // static FormatEtcEnumerator* FormatEtcEnumerator::CloneFromOther( const FormatEtcEnumerator* other) { FormatEtcEnumerator* e = new FormatEtcEnumerator; // Copy FORMATETC data from our source into ourselves. std::vector::const_iterator start = other->contents_.begin(); while (start != other->contents_.end()) { FORMATETC* format_etc = new FORMATETC; CloneFormatEtc(*start, format_etc); e->contents_.push_back(format_etc); ++start; } // Carry over e->cursor_ = other->cursor_; return e; } /////////////////////////////////////////////////////////////////////////////// // OSExchangeData, public: // static bool OSExchangeData::HasPlainTextURL(IDataObject* source) { std::wstring plain_text; return (ClipboardUtil::GetPlainText(source, &plain_text) && !plain_text.empty() && GURL(plain_text).is_valid()); } // static bool OSExchangeData::GetPlainTextURL(IDataObject* source, GURL* url) { std::wstring plain_text; if (ClipboardUtil::GetPlainText(source, &plain_text) && !plain_text.empty()) { GURL gurl(plain_text); if (gurl.is_valid()) { *url = gurl; return true; } } return false; } OSExchangeData::OSExchangeData() : ref_count_(0) { } OSExchangeData::OSExchangeData(IDataObject* source) : ref_count_(0) { source_object_ = source; } OSExchangeData::~OSExchangeData() { STLDeleteContainerPointers(contents_.begin(), contents_.end()); } void OSExchangeData::SetString(const std::wstring& data) { STGMEDIUM* storage = GetStorageForWString(data); contents_.push_back(new StoredDataInfo(CF_UNICODETEXT, storage)); // Also add plain text. storage = GetStorageForString(WideToUTF8(data)); contents_.push_back(new StoredDataInfo(CF_TEXT, storage)); } void OSExchangeData::SetURL(const GURL& url, const std::wstring& title) { // NOTE WELL: // Every time you change the order of the first two CLIPFORMATS that get // added here, you need to update the EnumerationViaCOM test case in // the _unittest.cc file to reflect the new arrangement otherwise that test // will fail! It assumes an insertion order. // Add text/x-moz-url for drags from Firefox std::wstring x_moz_url_str = UTF8ToWide(url.spec()); x_moz_url_str += '\n'; x_moz_url_str += title; STGMEDIUM* storage = GetStorageForWString(x_moz_url_str); contents_.push_back(new StoredDataInfo( ClipboardUtil::GetMozUrlFormat()->cfFormat, storage)); // Add a .URL shortcut file for dragging to Explorer. std::wstring valid_file_name; CreateValidFileNameFromTitle(url, title, &valid_file_name); std::string shortcut_url_file_contents; GetInternetShortcutFileContents(url, &shortcut_url_file_contents); SetFileContents(valid_file_name, shortcut_url_file_contents); // Add a UniformResourceLocator link for apps like IE and Word. storage = GetStorageForWString(UTF8ToWide(url.spec())); contents_.push_back(new StoredDataInfo( ClipboardUtil::GetUrlWFormat()->cfFormat, storage)); storage = GetStorageForString(url.spec()); contents_.push_back(new StoredDataInfo( ClipboardUtil::GetUrlFormat()->cfFormat, storage)); // TODO(beng): (http://b/1085501) add CF_HTML... // Also add text representations (these should be last since they're the // least preferable). storage = GetStorageForWString(UTF8ToWide(url.spec())); contents_.push_back(new StoredDataInfo(CF_UNICODETEXT, storage)); storage = GetStorageForString(url.spec()); contents_.push_back(new StoredDataInfo(CF_TEXT, storage)); } void OSExchangeData::SetFilename(const std::wstring& full_path) { const size_t drop_size = sizeof(DROPFILES); const size_t bytes = drop_size + (full_path.length() + 2) * sizeof(wchar_t); HANDLE hdata = ::GlobalAlloc(GMEM_MOVEABLE, bytes); if (!hdata) return; ScopedHGlobal locked_mem(hdata); DROPFILES* drop_files = locked_mem.get(); drop_files->pFiles = sizeof(DROPFILES); drop_files->fWide = TRUE; wchar_t* data = reinterpret_cast((BYTE*)(drop_files) + drop_size); const size_t copy_size = (full_path.length() + 1) * sizeof(wchar_t); memcpy(data, full_path.c_str(), copy_size); data[full_path.length() + 1] = L'\0'; // Double NULL // Set up the STGMEDIUM STGMEDIUM* storage = new STGMEDIUM; storage->tymed = TYMED_HGLOBAL; storage->hGlobal = drop_files; storage->pUnkForRelease = NULL; // Set up the StoredDataInfo StoredDataInfo* info = new StoredDataInfo(CF_HDROP, storage); contents_.push_back(info); } void OSExchangeData::SetPickledData(CLIPFORMAT format, const Pickle& data) { STGMEDIUM* storage = GetStorageForString( std::string(static_cast(data.data()), static_cast(data.size()))); contents_.push_back(new StoredDataInfo(format, storage)); } void OSExchangeData::SetFileContents(const std::wstring& filename, const std::string& file_contents) { // Add CFSTR_FILEDESCRIPTOR STGMEDIUM* storage = GetStorageForFileDescriptor(filename); contents_.push_back(new StoredDataInfo( ClipboardUtil::GetFileDescriptorFormat()->cfFormat, storage)); // Add CFSTR_FILECONTENTS storage = GetStorageForBytes(file_contents.data(), file_contents.length()); contents_.push_back(new StoredDataInfo( ClipboardUtil::GetFileContentFormatZero()->cfFormat, storage)); } void OSExchangeData::SetHtml(const std::wstring& html, const GURL& base_url) { // Add both MS CF_HTML and text/html format. CF_HTML should be in utf-8. std::string utf8_html = WideToUTF8(html); std::string url = base_url.is_valid() ? base_url.spec() : std::string(); std::string cf_html = ClipboardUtil::HtmlToCFHtml(utf8_html, url); STGMEDIUM* storage = GetStorageForBytes(cf_html.c_str(), cf_html.size()); contents_.push_back(new StoredDataInfo( ClipboardUtil::GetHtmlFormat()->cfFormat, storage)); STGMEDIUM* storage_plain = GetStorageForBytes(utf8_html.c_str(), utf8_html.size()); contents_.push_back(new StoredDataInfo( ClipboardUtil::GetTextHtmlFormat()->cfFormat, storage_plain)); } bool OSExchangeData::GetString(std::wstring* data) const { return ClipboardUtil::GetPlainText(source_object_, data); } bool OSExchangeData::GetURLAndTitle(GURL* url, std::wstring* title) const { std::wstring url_str; bool success = ClipboardUtil::GetUrl(source_object_, &url_str, title); if (success) { GURL test_url(url_str); if (test_url.is_valid()) { *url = test_url; return true; } } else if (GetPlainTextURL(source_object_, url)) { title->clear(); return true; } return false; } bool OSExchangeData::GetFilename(std::wstring* full_path) const { std::vector filenames; bool success = ClipboardUtil::GetFilenames(source_object_, &filenames); if (success) full_path->assign(filenames[0]); return success; } bool OSExchangeData::GetPickledData(CLIPFORMAT format, Pickle* data) const { DCHECK(data); FORMATETC format_etc = { format, NULL, DVASPECT_CONTENT, -1, TYMED_HGLOBAL }; bool success = false; STGMEDIUM medium; if (SUCCEEDED(source_object_->GetData(&format_etc, &medium))) { if (medium.tymed & TYMED_HGLOBAL) { ScopedHGlobal c_data(medium.hGlobal); DCHECK(c_data.Size() > 0); // Need to subtract 1 as SetPickledData adds an extra byte to the end. *data = Pickle(c_data.get(), static_cast(c_data.Size() - 1)); success = true; } ReleaseStgMedium(&medium); } return success; } bool OSExchangeData::GetFileContents(std::wstring* filename, std::string* file_contents) const { return ClipboardUtil::GetFileContents(source_object_, filename, file_contents); } bool OSExchangeData::GetHtml(std::wstring* html, GURL* base_url) const { std::string url; bool success = ClipboardUtil::GetHtml(source_object_, html, &url); if (success) *base_url = GURL(url); return success; } bool OSExchangeData::HasString() const { return ClipboardUtil::HasPlainText(source_object_); } bool OSExchangeData::HasURL() const { return (ClipboardUtil::HasUrl(source_object_) || HasPlainTextURL(source_object_)); } bool OSExchangeData::HasFile() const { return ClipboardUtil::HasFilenames(source_object_); } bool OSExchangeData::HasFormat(CLIPFORMAT format) const { FORMATETC format_etc = { format, NULL, DVASPECT_CONTENT, -1, TYMED_HGLOBAL }; return (source_object_->QueryGetData(&format_etc) == S_OK); } /////////////////////////////////////////////////////////////////////////////// // OSExchangeData, IDataObject implementation: // The following function, DuplicateMedium, is derived from WCDataObject.cpp // in the WebKit source code. This is the license information for the file: /* * Copyright (C) 2007 Apple 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. * * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 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. */ static void DuplicateMedium(CLIPFORMAT source_clipformat, STGMEDIUM* source, STGMEDIUM* destination) { switch (source->tymed) { case TYMED_HGLOBAL: destination->hGlobal = static_cast(OleDuplicateData( source->hGlobal, source_clipformat, 0)); break; case TYMED_MFPICT: destination->hMetaFilePict = static_cast(OleDuplicateData( source->hMetaFilePict, source_clipformat, 0)); break; case TYMED_GDI: destination->hBitmap = static_cast(OleDuplicateData( source->hBitmap, source_clipformat, 0)); break; case TYMED_ENHMF: destination->hEnhMetaFile = static_cast(OleDuplicateData( source->hEnhMetaFile, source_clipformat, 0)); break; case TYMED_FILE: destination->lpszFileName = static_cast(OleDuplicateData( source->lpszFileName, source_clipformat, 0)); break; case TYMED_ISTREAM: destination->pstm = source->pstm; destination->pstm->AddRef(); break; case TYMED_ISTORAGE: destination->pstg = source->pstg; destination->pstg->AddRef(); break; } destination->tymed = source->tymed; destination->pUnkForRelease = source->pUnkForRelease; if (destination->pUnkForRelease) destination->pUnkForRelease->AddRef(); } HRESULT OSExchangeData::GetData(FORMATETC* format_etc, STGMEDIUM* medium) { StoredData::const_iterator iter = contents_.begin(); while (iter != contents_.end()) { if ((*iter)->format_etc.cfFormat == format_etc->cfFormat) { DuplicateMedium((*iter)->format_etc.cfFormat, (*iter)->medium, medium); return S_OK; } ++iter; } return DV_E_FORMATETC; } HRESULT OSExchangeData::GetDataHere(FORMATETC* format_etc, STGMEDIUM* medium) { return DATA_E_FORMATETC; } HRESULT OSExchangeData::QueryGetData(FORMATETC* format_etc) { StoredData::const_iterator iter = contents_.begin(); while (iter != contents_.end()) { if ((*iter)->format_etc.cfFormat == format_etc->cfFormat) return S_OK; ++iter; } return DV_E_FORMATETC; } HRESULT OSExchangeData::GetCanonicalFormatEtc( FORMATETC* format_etc, FORMATETC* result) { format_etc->ptd = NULL; return E_NOTIMPL; } HRESULT OSExchangeData::SetData( FORMATETC* format_etc, STGMEDIUM* medium, BOOL should_release) { STGMEDIUM* local_medium = new STGMEDIUM; if (should_release) { *local_medium = *medium; } else { DuplicateMedium(format_etc->cfFormat, medium, local_medium); } StoredDataInfo* info = new StoredDataInfo(format_etc->cfFormat, local_medium); info->medium->tymed = format_etc->tymed; info->owns_medium = !!should_release; contents_.push_back(info); return S_OK; } HRESULT OSExchangeData::EnumFormatEtc( DWORD direction, IEnumFORMATETC** enumerator) { if (direction == DATADIR_GET) { FormatEtcEnumerator* e = new FormatEtcEnumerator(contents_.begin(), contents_.end()); e->AddRef(); *enumerator = e; return S_OK; } return E_NOTIMPL; } HRESULT OSExchangeData::DAdvise( FORMATETC* format_etc, DWORD advf, IAdviseSink* sink, DWORD* connection) { return OLE_E_ADVISENOTSUPPORTED; } HRESULT OSExchangeData::DUnadvise(DWORD connection) { return OLE_E_ADVISENOTSUPPORTED; } HRESULT OSExchangeData::EnumDAdvise(IEnumSTATDATA** enumerator) { return OLE_E_ADVISENOTSUPPORTED; } /////////////////////////////////////////////////////////////////////////////// // OSExchangeData, IUnknown implementation: HRESULT OSExchangeData::QueryInterface(const IID& iid, void** object) { *object = NULL; if (IsEqualIID(iid, IID_IUnknown) || IsEqualIID(iid, IID_IDataObject)) { *object = this; } else { return E_NOINTERFACE; } AddRef(); return S_OK; } ULONG OSExchangeData::AddRef() { return InterlockedIncrement(&ref_count_); } ULONG OSExchangeData::Release() { if (InterlockedDecrement(&ref_count_) == 0) { ULONG copied_refcnt = ref_count_; delete this; return copied_refcnt; } return ref_count_; } /////////////////////////////////////////////////////////////////////////////// // OSExchangeData, private: static STGMEDIUM* GetStorageForBytes(const char* data, size_t bytes) { HANDLE handle = GlobalAlloc(GPTR, static_cast(bytes)); ScopedHGlobal scoped(handle); size_t allocated = static_cast(GlobalSize(handle)); memcpy(scoped.get(), data, allocated); STGMEDIUM* storage = new STGMEDIUM; storage->hGlobal = handle; storage->tymed = TYMED_HGLOBAL; storage->pUnkForRelease = NULL; return storage; } template static HGLOBAL CopyStringToGlobalHandle(const T& payload) { int bytes = static_cast(payload.size() + 1) * sizeof(T::value_type); HANDLE handle = GlobalAlloc(GPTR, bytes); void* data = GlobalLock(handle); size_t allocated = static_cast(GlobalSize(handle)); memcpy(data, payload.c_str(), allocated); static_cast(data)[payload.size()] = '\0'; GlobalUnlock(handle); return handle; } static STGMEDIUM* GetStorageForWString(const std::wstring& data) { STGMEDIUM* storage = new STGMEDIUM; storage->hGlobal = CopyStringToGlobalHandle(data); storage->tymed = TYMED_HGLOBAL; storage->pUnkForRelease = NULL; return storage; } static STGMEDIUM* GetStorageForString(const std::string& data) { STGMEDIUM* storage = new STGMEDIUM; storage->hGlobal = CopyStringToGlobalHandle(data); storage->tymed = TYMED_HGLOBAL; storage->pUnkForRelease = NULL; return storage; } static void GetInternetShortcutFileContents(const GURL& url, std::string* data) { DCHECK(data); static const std::string kInternetShortcutFileStart = "[InternetShortcut]\r\nURL="; static const std::string kInternetShortcutFileEnd = "\r\n"; *data = kInternetShortcutFileStart + url.spec() + kInternetShortcutFileEnd; } static void CreateValidFileNameFromTitle(const GURL& url, const std::wstring& title, std::wstring* validated) { if (title.empty()) { if (url.is_valid()) { *validated = net::GetSuggestedFilename( url, std::string(), std::string(), std::wstring()); } else { // Nothing else can be done, just use a default. *validated = l10n_util::GetString(IDS_APP_UNTITLED_SHORTCUT_FILE_NAME); } } else { *validated = title; file_util::ReplaceIllegalCharacters(validated, '-'); } static const wchar_t extension[] = L".url"; static const size_t max_length = MAX_PATH - arraysize(extension); if (validated->size() > max_length) validated->erase(max_length); *validated += extension; } static STGMEDIUM* GetStorageForFileDescriptor( const std::wstring& valid_file_name) { DCHECK(!valid_file_name.empty() && valid_file_name.size() + 1 <= MAX_PATH); HANDLE handle = GlobalAlloc(GPTR, sizeof(FILEGROUPDESCRIPTOR)); FILEGROUPDESCRIPTOR* descriptor = reinterpret_cast(GlobalLock(handle)); descriptor->cItems = 1; wcscpy_s(descriptor->fgd[0].cFileName, valid_file_name.size() + 1, valid_file_name.c_str()); descriptor->fgd[0].dwFlags = FD_LINKUI; GlobalUnlock(handle); STGMEDIUM* storage = new STGMEDIUM; storage->hGlobal = handle; storage->tymed = TYMED_HGLOBAL; storage->pUnkForRelease = NULL; return storage; }