UrlClassifierFeatureFactory.h

Enable keyboard shortcuts

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

/* vim: set ts=8 sts=2 et sw=2 tw=80: */

/* 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 mozilla_net_UrlClassifierFeatureFactory_h

#define mozilla_net_UrlClassifierFeatureFactory_h

#include "nsCOMPtr.h"

#include "nsTArray.h"

class nsIChannel;

class nsIUrlClassifierFeature;

namespace mozilla {

namespace net {

class UrlClassifierFeatureFactory final {

 public:

  static void Shutdown();

  static void GetFeaturesFromChannel(

      nsIChannel* aChannel,

      nsTArray<nsCOMPtr<nsIUrlClassifierFeature>>& aFeatures);

  static void GetPhishingProtectionFeatures(

      nsTArray<RefPtr<nsIUrlClassifierFeature>>& aFeatures);

  static already_AddRefed<nsIUrlClassifierFeature> GetFeatureByName(

      const nsACString& aName);

  static void GetFeatureNames(nsTArray<nsCString>& aArray);

  static already_AddRefed<nsIUrlClassifierFeature> CreateFeatureWithTables(

      const nsACString& aName, const nsTArray<nsCString>& aBlocklistTables,

      const nsTArray<nsCString>& aEntitylistTables);

  // Returns true if this error is known as one of the blocking error codes.

  static bool IsClassifierBlockingErrorCode(nsresult aError);

  // Returns true if this event is a known blocking state from

  // nsIWebProgressListener.

  static bool IsClassifierBlockingEventCode(uint32_t aEventCode);

  static uint32_t GetClassifierBlockingEventCode(nsresult aErrorCode);

  // This can be called only if IsClassifierBlockingErrorCode(aError) returns

  // true.

  static const char* ClassifierBlockingErrorCodeToConsoleMessage(

      nsresult aError, nsACString& aCategory);

};

}  // namespace net

}  // namespace mozilla

#endif  // mozilla_net_UrlClassifierFeatureFactory_h