electron/shell/browser/api/atom_api_url_request.h

// Copyright (c) 2019 GitHub, Inc.
// Use of this source code is governed by the MIT license that can be
// found in the LICENSE file.

#ifndef SHELL_BROWSER_API_ATOM_API_URL_REQUEST_H_
#define SHELL_BROWSER_API_ATOM_API_URL_REQUEST_H_

#include <list>
#include <memory>
#include <string>
#include <vector>

#include "gin/arguments.h"
#include "gin/dictionary.h"
#include "mojo/public/cpp/system/data_pipe_producer.h"
#include "services/network/public/cpp/shared_url_loader_factory.h"
#include "services/network/public/cpp/simple_url_loader.h"
#include "services/network/public/cpp/simple_url_loader_stream_consumer.h"
#include "services/network/public/mojom/data_pipe_getter.mojom.h"
#include "shell/browser/api/event_emitter_deprecated.h"

namespace electron {

namespace api {

class UploadDataPipeGetter;

class URLRequest : public mate::EventEmitter<URLRequest>,
                   public network::SimpleURLLoaderStreamConsumer {
 public:
  static mate::WrappableBase* New(gin::Arguments* args);

  static void BuildPrototype(v8::Isolate* isolate,
                             v8::Local<v8::FunctionTemplate> prototype);

 protected:
  explicit URLRequest(gin::Arguments* args);
  ~URLRequest() override;

  bool NotStarted() const;
  bool Finished() const;

  void Cancel();
  void Close();

  bool Write(v8::Local<v8::Value> data, bool is_last);
  void FollowRedirect();
  bool SetExtraHeader(const std::string& name, const std::string& value);
  void RemoveExtraHeader(const std::string& name);
  void SetChunkedUpload(bool is_chunked_upload);
  gin::Dictionary GetUploadProgress();
  int StatusCode() const;
  std::string StatusMessage() const;
  net::HttpResponseHeaders* RawResponseHeaders() const;
  uint32_t ResponseHttpVersionMajor() const;
  uint32_t ResponseHttpVersionMinor() const;

  // SimpleURLLoaderStreamConsumer:
  void OnDataReceived(base::StringPiece string_piece,
                      base::OnceClosure resume) override;
  void OnComplete(bool success) override;
  void OnRetry(base::OnceClosure start_retry) override;

 private:
  friend class UploadDataPipeGetter;

  void OnResponseStarted(const GURL& final_url,
                         const network::mojom::URLResponseHead& response_head);
  void OnRedirect(const net::RedirectInfo& redirect_info,
                  const network::mojom::URLResponseHead& response_head,
                  std::vector<std::string>* to_be_removed_headers);
  void OnUploadProgress(uint64_t position, uint64_t total);
  void OnWrite(MojoResult result);

  // Write the first data of |pending_writes_|.
  void DoWrite();

  // Start streaming.
  void StartWriting();

  // Manage lifetime of wrapper.
  void Pin();
  void Unpin();

  // Emit events.
  enum class EventType {
    kRequest,
    kResponse,
  };
  void EmitError(EventType type, base::StringPiece error);
  template <typename... Args>
  void EmitEvent(EventType type, Args... args);

  std::unique_ptr<network::ResourceRequest> request_;
  std::unique_ptr<network::SimpleURLLoader> loader_;
  scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory_;
  scoped_refptr<net::HttpResponseHeaders> response_headers_;

  // Redirect mode.
  //
  // Note that we store it ourselves instead of reading from the one stored in
  // |request_|, this is because with multiple redirections, the original one
  // might be modified.
  network::mojom::RedirectMode redirect_mode_ =
      network::mojom::RedirectMode::kFollow;

  // The DataPipeGetter passed to reader.
  bool is_chunked_upload_ = false;
  std::unique_ptr<UploadDataPipeGetter> data_pipe_getter_;

  // Passed from DataPipeGetter for streaming data.
  network::mojom::DataPipeGetter::ReadCallback size_callback_;
  std::unique_ptr<mojo::DataPipeProducer> producer_;

  // Whether request.end() has been called.
  bool last_chunk_written_ = false;

  // Whether the redirect should be followed.
  bool follow_redirect_ = true;

  // Upload progress.
  uint64_t upload_position_ = 0;
  uint64_t upload_total_ = 0;

  // Current status.
  int request_state_ = 0;
  int response_state_ = 0;

  // Pending writes that not yet sent to NetworkService.
  std::list<std::string> pending_writes_;

  // Used by pin/unpin to manage lifetime.
  v8::Global<v8::Object> wrapper_;

  base::WeakPtrFactory<URLRequest> weak_factory_;

  DISALLOW_COPY_AND_ASSIGN(URLRequest);
};

}  // namespace api

}  // namespace electron

#endif  // SHELL_BROWSER_API_ATOM_API_URL_REQUEST_H_