components/exo/drag_drop_operation.h

// Copyright 2019 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.

#ifndef COMPONENTS_EXO_DRAG_DROP_OPERATION_H_
#define COMPONENTS_EXO_DRAG_DROP_OPERATION_H_

#include <memory>
#include <string>

#include "build/chromeos_buildflags.h"
#include "components/exo/data_device.h"
#include "components/exo/data_offer_observer.h"
#include "components/exo/data_source_observer.h"
#include "components/exo/surface_observer.h"
#include "components/exo/wm_helper.h"
#include "ui/aura/client/drag_drop_client_observer.h"
#include "ui/base/dragdrop/mojom/drag_drop_types.mojom-forward.h"
#include "ui/gfx/geometry/point_f.h"

#if BUILDFLAG(IS_CHROMEOS_ASH)
#include "components/exo/extended_drag_source.h"
#endif

class SkBitmap;

namespace ash {
class DragDropController;
}  // namespace ash

namespace aura {
namespace client {
class DragDropClient;
}  // namespace client
}  // namespace aura

namespace ui {
class OSExchangeData;
}

namespace exo {
class DataExchangeDelegate;
class ScopedDataSource;
class Surface;
class ScopedSurface;

// This class represents an ongoing drag-drop operation started by an exo
// client. It manages its own lifetime. It will delete itself when the drag
// operation completes, is cancelled, or some vital resource is destroyed
// (e.g. the client deletes the data source used to start the drag operation),
// or if another drag operation races with this one to start and wins.
class DragDropOperation : public DataSourceObserver,
                          public SurfaceObserver,
#if BUILDFLAG(IS_CHROMEOS_ASH)
                          public ExtendedDragSource::Observer,
#endif
                          public aura::client::DragDropClientObserver {
 public:
  // Create an operation for a drag-drop originating from a wayland app.
  static base::WeakPtr<DragDropOperation> Create(
      DataExchangeDelegate* data_exchange_delegate,
      DataSource* source,
      Surface* origin,
      Surface* icon,
      const gfx::PointF& drag_start_point,
      ui::mojom::DragEventSource event_source);

  DragDropOperation(const DragDropOperation&) = delete;
  DragDropOperation& operator=(const DragDropOperation&) = delete;

  // Abort the operation if it hasn't been started yet, otherwise do nothing.
  void AbortIfPending();

  // DataSourceObserver:
  void OnDataSourceDestroying(DataSource* source) override;

  // SurfaceObserver:
  void OnSurfaceDestroying(Surface* surface) override;

  // aura::client::DragDropClientObserver:
  void OnDragStarted() override;
#if BUILDFLAG(IS_CHROMEOS_ASH)
  void OnDragActionsChanged(int actions) override;

  // ExtendedDragSource::Observer:
  void OnExtendedDragSourceDestroying(ExtendedDragSource* source) override;
#endif

 private:
  class IconSurface;

  // A private constructor and destructor are used to prevent anyone else from
  // attempting to manage the lifetime of a DragDropOperation.
  DragDropOperation(DataExchangeDelegate* data_exchange_delegate,
                    DataSource* source,
                    Surface* origin,
                    Surface* icon,
                    const gfx::PointF& drag_start_point,
                    ui::mojom::DragEventSource event_source);
  ~DragDropOperation() override;

  void OnDragIconCaptured(const SkBitmap& icon_bitmap);

#if BUILDFLAG(IS_CHROMEOS_ASH)
  // Called when the focused window is a Lacros window and a source
  // DataTransferEndpoint is found in the available MIME types. This
  // is currently used to synchronize drag source metadata from
  // Lacros to Ash.
  void OnDataTransferEndpointRead(const std::string& mime_type,
                                  std::u16string data);
#endif

  void OnTextRead(const std::string& mime_type, std::u16string data);
  void OnHTMLRead(const std::string& mime_type, std::u16string data);
  void OnFilenamesRead(DataExchangeDelegate* data_exchange_delegate,
                       aura::Window* source,
                       const std::string& mime_type,
                       const std::vector<uint8_t>& data);
  void OnFileContentsRead(const std::string& mime_type,
                          const base::FilePath& filename,
                          const std::vector<uint8_t>& data);
  void OnWebCustomDataRead(const std::string& mime_type,
                           const std::vector<uint8_t>& data);

  void ScheduleStartDragDropOperation();

  // This operation triggers a nested RunLoop, and should not be called
  // directly. Use ScheduleStartDragDropOperation instead.
  void StartDragDropOperation();

#if BUILDFLAG(IS_CHROMEOS_ASH)
  void ResetExtendedDragSource();
#endif

  std::unique_ptr<ScopedDataSource> source_;
  std::unique_ptr<ScopedSurface> icon_;
  std::unique_ptr<ScopedSurface> origin_;
  gfx::PointF drag_start_point_;
  std::unique_ptr<ui::OSExchangeData> os_exchange_data_;
#if BUILDFLAG(IS_CHROMEOS_ASH)
  ash::DragDropController* drag_drop_controller_;
#else
  aura::client::DragDropClient* drag_drop_controller_;
#endif  // BUILDFLAG(IS_CHROMEOS_ASH)

  base::RepeatingClosure counter_;

  // Stores whether this object has just started a drag operation. If so, we
  // want to ignore the OnDragStarted event.
  bool started_by_this_object_ = false;

  bool captured_icon_ = false;

  // TODO(crbug.com/994065) This is currently not the actual mime type used by
  // the recipient, just an arbitrary one we pick out of the offered types so we
  // can report back whether or not the drop can succeed. This may need to
  // change in the future.
  std::string mime_type_;

  ui::mojom::DragEventSource event_source_;

#if BUILDFLAG(IS_CHROMEOS_ASH)
  ExtendedDragSource* extended_drag_source_;
#endif

  base::WeakPtrFactory<DragDropOperation> weak_ptr_factory_{this};
};

}  // namespace exo

#endif  // COMPONENTS_EXO_DRAG_DROP_OPERATION_H_