/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */

/* This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef TRRService_h_

#define TRRService_h_

#include "mozilla/Atomics.h"

#include "mozilla/DataStorage.h"

#include "nsHostResolver.h"

#include "nsIObserver.h"

#include "nsWeakReference.h"

class nsIPrefBranch;

namespace mozilla {

namespace net {

class TRRService

  : public nsIObserver

  , public nsITimerCallback

  , public nsSupportsWeakReference

  , public AHostResolver

{

public:

  NS_DECL_THREADSAFE_ISUPPORTS

  NS_DECL_NSIOBSERVER

  NS_DECL_NSITIMERCALLBACK

  TRRService();

  nsresult Init();

  nsresult Start();

  bool Enabled();

  uint32_t Mode() { return mMode; }

  bool AllowRFC1918() { return mRfc1918; }

  bool UseGET() { return mUseGET; }

  bool EarlyAAAA() { return mEarlyAAAA; }

  bool DisableIPv6() { return mDisableIPv6; }

  bool DisableECS() { return mDisableECS; }

  nsresult GetURI(nsCString &result);

  nsresult GetCredentials(nsCString &result);

  uint32_t GetRequestTimeout() { return mTRRTimeout; }

  LookupStatus CompleteLookup(nsHostRecord *, nsresult, mozilla::net::AddrInfo *, bool pb) override;

  LookupStatus CompleteLookupByType(nsHostRecord *, nsresult, const nsTArray<nsCString> *, uint32_t, bool pb) override;

  void TRRBlacklist(const nsACString &host, bool privateBrowsing, bool aParentsToo);

  bool IsTRRBlacklisted(const nsACString &host, bool privateBrowsing, bool fullhost);

  bool MaybeBootstrap(const nsACString &possible, nsACString &result);

private:

  virtual  ~TRRService();

  nsresult ReadPrefs(const char *name);

  void GetPrefBranch(nsIPrefBranch **result);

  void MaybeConfirm();

  bool                      mInitialized;

  Atomic<uint32_t, Relaxed> mMode;

  Atomic<uint32_t, Relaxed> mTRRBlacklistExpireTime;

  Atomic<uint32_t, Relaxed> mTRRTimeout;

  Mutex mLock; // protects mPrivate* string

  nsCString mPrivateURI; // main thread only

  nsCString mPrivateCred; // main thread only

  nsCString mConfirmationNS;

  nsCString mBootstrapAddr;

  Atomic<bool, Relaxed> mWaitForCaptive; // wait for the captive portal to say OK before using TRR

  Atomic<bool, Relaxed> mRfc1918; // okay with local IP addresses in DOH responses?

  Atomic<bool, Relaxed> mCaptiveIsPassed; // set when captive portal check is passed

  Atomic<bool, Relaxed> mUseGET; // do DOH using GET requests (instead of POST)

  Atomic<bool, Relaxed> mEarlyAAAA; // allow use of AAAA results before A is in

  Atomic<bool, Relaxed> mDisableIPv6; // don't even try

  Atomic<bool, Relaxed> mDisableECS;  // disable EDNS Client Subnet in requests

  // TRR Blacklist storage

  RefPtr<DataStorage> mTRRBLStorage;

  Atomic<bool, Relaxed> mClearTRRBLStorage;

  enum ConfirmationState {

    CONFIRM_INIT = 0,

    CONFIRM_TRYING = 1,

    CONFIRM_OK = 2,

    CONFIRM_FAILED = 3

  };

  Atomic<ConfirmationState, Relaxed>  mConfirmationState;

  RefPtr<TRR> mConfirmer;

  nsCOMPtr<nsITimer> mRetryConfirmTimer;

  uint32_t mRetryConfirmInterval; // milliseconds until retry

};

extern TRRService *gTRRService;

} // namespace net

} // namespace mozilla

#endif // TRRService_h_