nearby/sharing/attachment_container.h

// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef THIRD_PARTY_NEARBY_SHARING_ATTACHMENT_CONTAINER_H_
#define THIRD_PARTY_NEARBY_SHARING_ATTACHMENT_CONTAINER_H_

#include <cstdint>
#include <memory>
#include <utility>
#include <vector>
#include "absl/container/flat_hash_map.h"
#include "sharing/attachment.h"
#include "sharing/file_attachment.h"
#include "sharing/text_attachment.h"
#include "sharing/wifi_credentials_attachment.h"

namespace nearby::sharing {

// A container for attachments.
// This class is thread-compatible (go/thread-compatible).
class AttachmentContainer {
 public:
  class Builder {
   public:
    Builder() = default;
    Builder(std::vector<TextAttachment> text_attachments,
            std::vector<FileAttachment> file_attachments,
            std::vector<WifiCredentialsAttachment> wifi_credentials_attachments)
        : text_attachments_(std::move(text_attachments)),
          file_attachments_(std::move(file_attachments)),
          wifi_credentials_attachments_(
              std::move(wifi_credentials_attachments)) {}
    Builder& ReserveAttachmentsCount(int text_attachments_count,
                                    int file_attachments_count,
                                    int wifi_credentials_attachments_count);
    Builder& AddTextAttachment(TextAttachment text_attachment);
    Builder& AddFileAttachment(FileAttachment file_attachment);
    Builder& AddWifiCredentialsAttachment(
        WifiCredentialsAttachment wifi_credentials_attachment);

    bool Empty() const {
      return text_attachments_.empty() && file_attachments_.empty() &&
             wifi_credentials_attachments_.empty();
    }

    std::unique_ptr<AttachmentContainer> Build();

   private:
    std::vector<TextAttachment> text_attachments_;
    std::vector<FileAttachment> file_attachments_;
    std::vector<WifiCredentialsAttachment> wifi_credentials_attachments_;
  };

  AttachmentContainer() = default;
  AttachmentContainer(AttachmentContainer&&);
  AttachmentContainer& operator=(AttachmentContainer&&);
  ~AttachmentContainer() = default;

  const std::vector<TextAttachment>& GetTextAttachments() const {
    return text_attachments_;
  }
  const std::vector<FileAttachment>& GetFileAttachments() const {
    return file_attachments_;
  }
  const std::vector<WifiCredentialsAttachment>& GetWifiCredentialsAttachments()
      const {
    return wifi_credentials_attachments_;
  }

  TextAttachment& GetMutableTextAttachment(int index) {
    return text_attachments_[index];
  }

  FileAttachment& GetMutableFileAttachment(int index) {
    return file_attachments_[index];
  }

  WifiCredentialsAttachment& GetMutableWifiCredentialsAttachment(int index) {
    return wifi_credentials_attachments_[index];
  }

  const Attachment* GetAttachment(int64_t id) const {
    const auto it = attachment_id_map_.find(id);
    if (it == attachment_id_map_.end()) {
      return nullptr;
    }
    return it->second;
  }

  // Returns the total number of attachments of all types.
  int GetAttachmentCount() const {
    return text_attachments_.size() + file_attachments_.size() +
           wifi_credentials_attachments_.size();
  }

  // Returns the total size of all attachments.
  int64_t GetTotalAttachmentsSize() const;

  // Returns the total size of all attachments on disk.
  int64_t GetStorageSize() const;

  // Returns true if there are any attachments.
  bool HasAttachments() const {
    return !text_attachments_.empty() || !file_attachments_.empty() ||
           !wifi_credentials_attachments_.empty();
  }

  // Clear the contents of all attachments, but leaving the attachments in
  // place.
  void ClearAttachments();

 private:
  AttachmentContainer(
      std::vector<TextAttachment> text_attachments,
      std::vector<FileAttachment> file_attachments,
      std::vector<WifiCredentialsAttachment> wifi_credentials_attachments);
  // Build id to attachment index.
  void BuildIndex();

  std::vector<TextAttachment> text_attachments_;
  std::vector<FileAttachment> file_attachments_;
  std::vector<WifiCredentialsAttachment> wifi_credentials_attachments_;
  absl::flat_hash_map<int64_t, const Attachment*> attachment_id_map_;
};

}  // namespace nearby::sharing

#endif  // THIRD_PARTY_NEARBY_SHARING_ATTACHMENT_CONTAINER_H_