selection_owner.cc 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323
  1. // Copyright (c) 2013 The Chromium Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style license that can be
  3. // found in the LICENSE file.
  4. #include "ui/base/x/selection_owner.h"
  5. #include <algorithm>
  6. #include "base/logging.h"
  7. #include "base/memory/ref_counted_memory.h"
  8. #include "ui/base/x/selection_utils.h"
  9. #include "ui/base/x/x11_util.h"
  10. #include "ui/events/platform/x11/x11_event_source.h"
  11. #include "ui/gfx/x/x11_atom_cache.h"
  12. #include "ui/gfx/x/x11_window_event_manager.h"
  13. #include "ui/gfx/x/xproto.h"
  14. #include "ui/gfx/x/xproto_util.h"
  15. namespace ui {
  16. const char kIncr[] = "INCR";
  17. const char kSaveTargets[] = "SAVE_TARGETS";
  18. const char kTargets[] = "TARGETS";
  19. namespace {
  20. const char kAtomPair[] = "ATOM_PAIR";
  21. const char kMultiple[] = "MULTIPLE";
  22. const char kTimestamp[] = "TIMESTAMP";
  23. // The period of |incremental_transfer_abort_timer_|. Arbitrary but must be <=
  24. // than kIncrementalTransferTimeoutMs.
  25. const int KSelectionOwnerTimerPeriodMs = 1000;
  26. // The amount of time to wait for the selection requestor to process the data
  27. // sent by the selection owner before aborting an incremental data transfer.
  28. const int kIncrementalTransferTimeoutMs = 10000;
  29. static_assert(KSelectionOwnerTimerPeriodMs <= kIncrementalTransferTimeoutMs,
  30. "timer period must be <= transfer timeout");
  31. size_t GetMaxIncrementalTransferSize() {
  32. ssize_t size = x11::Connection::Get()->MaxRequestSizeInBytes();
  33. // Conservatively subtract 100 bytes for the GetProperty request, padding etc.
  34. DCHECK_GT(size, 100);
  35. return std::min<size_t>(size - 100, 0x100000);
  36. }
  37. // Gets the value of an atom pair array property. On success, true is returned
  38. // and the value is stored in |value|.
  39. bool GetAtomPairArrayProperty(
  40. x11::Window window,
  41. x11::Atom property,
  42. std::vector<std::pair<x11::Atom, x11::Atom>>* value) {
  43. std::vector<x11::Atom> atoms;
  44. // Since this is an array of atom pairs, ensure ensure |atoms|
  45. // has an element count that's a multiple of 2.
  46. if (!GetArrayProperty(window, property, &atoms) || atoms.size() % 2 != 0)
  47. return false;
  48. value->clear();
  49. for (size_t i = 0; i < atoms.size(); i += 2)
  50. value->push_back(std::make_pair(atoms[i], atoms[i + 1]));
  51. return true;
  52. }
  53. x11::Window GetSelectionOwner(x11::Atom selection) {
  54. auto response = x11::Connection::Get()->GetSelectionOwner({selection}).Sync();
  55. return response ? response->owner : x11::Window::None;
  56. }
  57. void SetSelectionOwner(x11::Window window,
  58. x11::Atom selection,
  59. x11::Time time = x11::Time::CurrentTime) {
  60. x11::Connection::Get()->SetSelectionOwner({window, selection, time});
  61. }
  62. } // namespace
  63. SelectionOwner::SelectionOwner(x11::Connection* connection,
  64. x11::Window x_window,
  65. x11::Atom selection_name)
  66. : x_window_(x_window), selection_name_(selection_name) {}
  67. SelectionOwner::~SelectionOwner() {
  68. // If we are the selection owner, we need to release the selection so we
  69. // don't receive further events. However, we don't call ClearSelectionOwner()
  70. // because we don't want to do this indiscriminately.
  71. if (GetSelectionOwner(selection_name_) == x_window_)
  72. SetSelectionOwner(x11::Window::None, selection_name_);
  73. }
  74. void SelectionOwner::RetrieveTargets(std::vector<x11::Atom>* targets) {
  75. for (const auto& format_target : format_map_)
  76. targets->push_back(format_target.first);
  77. }
  78. void SelectionOwner::TakeOwnershipOfSelection(const SelectionFormatMap& data) {
  79. acquired_selection_timestamp_ = X11EventSource::GetInstance()->GetTimestamp();
  80. SetSelectionOwner(x_window_, selection_name_, acquired_selection_timestamp_);
  81. if (GetSelectionOwner(selection_name_) == x_window_) {
  82. // The X server agrees that we are the selection owner. Commit our data.
  83. format_map_ = data;
  84. }
  85. }
  86. void SelectionOwner::ClearSelectionOwner() {
  87. SetSelectionOwner(x11::Window::None, selection_name_);
  88. format_map_ = SelectionFormatMap();
  89. }
  90. void SelectionOwner::OnSelectionRequest(
  91. const x11::SelectionRequestEvent& request) {
  92. auto requestor = request.requestor;
  93. x11::Atom requested_target = request.target;
  94. x11::Atom requested_property = request.property;
  95. // Incrementally build our selection. By default this is a refusal, and we'll
  96. // override the parts indicating success in the different cases.
  97. x11::SelectionNotifyEvent reply{
  98. .time = request.time,
  99. .requestor = requestor,
  100. .selection = request.selection,
  101. .target = requested_target,
  102. .property = x11::Atom::None, // Indicates failure
  103. };
  104. if (requested_target == x11::GetAtom(kMultiple)) {
  105. // The contents of |requested_property| should be a list of
  106. // <target,property> pairs.
  107. std::vector<std::pair<x11::Atom, x11::Atom>> conversions;
  108. if (GetAtomPairArrayProperty(requestor, requested_property, &conversions)) {
  109. std::vector<x11::Atom> conversion_results;
  110. for (const std::pair<x11::Atom, x11::Atom>& conversion : conversions) {
  111. bool conversion_successful =
  112. ProcessTarget(conversion.first, requestor, conversion.second);
  113. conversion_results.push_back(conversion.first);
  114. conversion_results.push_back(conversion_successful ? conversion.second
  115. : x11::Atom::None);
  116. }
  117. // Set the property to indicate which conversions succeeded. This matches
  118. // what GTK does.
  119. SetArrayProperty(requestor, requested_property, x11::GetAtom(kAtomPair),
  120. conversion_results);
  121. reply.property = requested_property;
  122. }
  123. } else {
  124. if (ProcessTarget(requested_target, requestor, requested_property))
  125. reply.property = requested_property;
  126. }
  127. // Send off the reply.
  128. x11::SendEvent(reply, requestor, x11::EventMask::NoEvent);
  129. }
  130. void SelectionOwner::OnSelectionClear(const x11::SelectionClearEvent& event) {
  131. DVLOG(1) << "SelectionClear";
  132. // TODO(erg): If we receive a SelectionClear event while we're handling data,
  133. // we need to delay clearing.
  134. }
  135. bool SelectionOwner::CanDispatchPropertyEvent(
  136. const x11::PropertyNotifyEvent& event) {
  137. return event.state == x11::Property::Delete &&
  138. FindIncrementalTransferForEvent(event) != incremental_transfers_.end();
  139. }
  140. void SelectionOwner::OnPropertyEvent(const x11::PropertyNotifyEvent& event) {
  141. auto it = FindIncrementalTransferForEvent(event);
  142. if (it == incremental_transfers_.end())
  143. return;
  144. ProcessIncrementalTransfer(&(*it));
  145. if (!it->data.get())
  146. CompleteIncrementalTransfer(it);
  147. }
  148. bool SelectionOwner::ProcessTarget(x11::Atom target,
  149. x11::Window requestor,
  150. x11::Atom property) {
  151. x11::Atom multiple_atom = x11::GetAtom(kMultiple);
  152. x11::Atom save_targets_atom = x11::GetAtom(kSaveTargets);
  153. x11::Atom targets_atom = x11::GetAtom(kTargets);
  154. x11::Atom timestamp_atom = x11::GetAtom(kTimestamp);
  155. if (target == multiple_atom || target == save_targets_atom)
  156. return false;
  157. if (target == timestamp_atom) {
  158. SetProperty(requestor, property, x11::Atom::INTEGER,
  159. acquired_selection_timestamp_);
  160. return true;
  161. }
  162. if (target == targets_atom) {
  163. // We have been asked for TARGETS. Send an atom array back with the data
  164. // types we support.
  165. std::vector<x11::Atom> targets = {timestamp_atom, targets_atom,
  166. save_targets_atom, multiple_atom};
  167. RetrieveTargets(&targets);
  168. SetArrayProperty(requestor, property, x11::Atom::ATOM, targets);
  169. return true;
  170. }
  171. // Try to find the data type in map.
  172. auto it = format_map_.find(target);
  173. if (it != format_map_.end()) {
  174. if (it->second->size() > GetMaxIncrementalTransferSize()) {
  175. // We must send the data back in several chunks due to a limitation in
  176. // the size of X requests. Notify the selection requestor that the data
  177. // will be sent incrementally by returning data of type "INCR".
  178. uint32_t length = it->second->size();
  179. SetProperty(requestor, property, x11::GetAtom(kIncr), length);
  180. // Wait for the selection requestor to indicate that it has processed
  181. // the selection result before sending the first chunk of data. The
  182. // selection requestor indicates this by deleting |property|.
  183. base::TimeTicks timeout =
  184. base::TimeTicks::Now() +
  185. base::Milliseconds(kIncrementalTransferTimeoutMs);
  186. incremental_transfers_.emplace_back(
  187. requestor, target, property,
  188. std::make_unique<x11::XScopedEventSelector>(
  189. requestor, x11::EventMask::PropertyChange),
  190. it->second, 0, timeout);
  191. // Start a timer to abort the data transfer in case that the selection
  192. // requestor does not support the INCR property or gets destroyed during
  193. // the data transfer.
  194. if (!incremental_transfer_abort_timer_.IsRunning()) {
  195. incremental_transfer_abort_timer_.Start(
  196. FROM_HERE, base::Milliseconds(KSelectionOwnerTimerPeriodMs), this,
  197. &SelectionOwner::AbortStaleIncrementalTransfers);
  198. }
  199. } else {
  200. auto& mem = it->second;
  201. std::vector<uint8_t> data(mem->data(), mem->data() + mem->size());
  202. SetArrayProperty(requestor, property, target, data);
  203. }
  204. return true;
  205. }
  206. // I would put error logging here, but GTK ignores TARGETS and spams us
  207. // looking for its own internal types.
  208. return false;
  209. }
  210. void SelectionOwner::ProcessIncrementalTransfer(IncrementalTransfer* transfer) {
  211. size_t remaining = transfer->data->size() - transfer->offset;
  212. size_t chunk_length = std::min(remaining, GetMaxIncrementalTransferSize());
  213. const uint8_t* data = transfer->data->front() + transfer->offset;
  214. std::vector<uint8_t> buf(data, data + chunk_length);
  215. SetArrayProperty(transfer->window, transfer->property, transfer->target, buf);
  216. transfer->offset += chunk_length;
  217. transfer->timeout = base::TimeTicks::Now() +
  218. base::Milliseconds(kIncrementalTransferTimeoutMs);
  219. // When offset == data->size(), we still need to transfer a zero-sized chunk
  220. // to notify the selection requestor that the transfer is complete. Clear
  221. // transfer->data once the zero-sized chunk is sent to indicate that state
  222. // related to this data transfer can be cleared.
  223. if (chunk_length == 0)
  224. transfer->data = nullptr;
  225. }
  226. void SelectionOwner::AbortStaleIncrementalTransfers() {
  227. base::TimeTicks now = base::TimeTicks::Now();
  228. for (int i = static_cast<int>(incremental_transfers_.size()) - 1; i >= 0;
  229. --i) {
  230. if (incremental_transfers_[i].timeout <= now)
  231. CompleteIncrementalTransfer(incremental_transfers_.begin() + i);
  232. }
  233. }
  234. void SelectionOwner::CompleteIncrementalTransfer(
  235. std::vector<IncrementalTransfer>::iterator it) {
  236. incremental_transfers_.erase(it);
  237. if (incremental_transfers_.empty())
  238. incremental_transfer_abort_timer_.Stop();
  239. }
  240. std::vector<SelectionOwner::IncrementalTransfer>::iterator
  241. SelectionOwner::FindIncrementalTransferForEvent(
  242. const x11::PropertyNotifyEvent& prop) {
  243. for (auto it = incremental_transfers_.begin();
  244. it != incremental_transfers_.end(); ++it) {
  245. if (it->window == prop.window && it->property == prop.atom)
  246. return it;
  247. }
  248. return incremental_transfers_.end();
  249. }
  250. SelectionOwner::IncrementalTransfer::IncrementalTransfer(
  251. x11::Window window,
  252. x11::Atom target,
  253. x11::Atom property,
  254. std::unique_ptr<x11::XScopedEventSelector> event_selector,
  255. const scoped_refptr<base::RefCountedMemory>& data,
  256. int offset,
  257. base::TimeTicks timeout)
  258. : window(window),
  259. target(target),
  260. property(property),
  261. event_selector(std::move(event_selector)),
  262. data(data),
  263. offset(offset),
  264. timeout(timeout) {}
  265. SelectionOwner::IncrementalTransfer::IncrementalTransfer(
  266. IncrementalTransfer&& other) = default;
  267. SelectionOwner::IncrementalTransfer&
  268. SelectionOwner::IncrementalTransfer::operator=(IncrementalTransfer&&) = default;
  269. SelectionOwner::IncrementalTransfer::~IncrementalTransfer() = default;
  270. } // namespace ui