netwerk/url-classifier/UrlClassifierFeatureBase.cpp

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "UrlClassifierFeatureBase.h"
   8 #include "Classifier.h"
   9 #include "mozilla/Preferences.h"
  10
  11 namespace mozilla {
  12
  13 using namespace safebrowsing;
  14
  15 namespace net {
  16
  17 namespace {
  18
  19 void OnPrefsChange(const char* aPrefName, void* aArray) {
  20   auto* array = static_cast<nsTArray<nsCString>*>(aArray);
  21   MOZ_ASSERT(array);
  22
  23   nsAutoCString value;
  24   Preferences::GetCString(aPrefName, value);
  25   Classifier::SplitTables(value, *array);
  26 }
  27
  28 }  // namespace
  29
  30 NS_INTERFACE_MAP_BEGIN(UrlClassifierFeatureBase)
  31   NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, nsIUrlClassifierFeature)
  32   NS_INTERFACE_MAP_ENTRY(nsIUrlClassifierFeature)
  33   NS_INTERFACE_MAP_ENTRY(nsIUrlClassifierExceptionListObserver)
  34 NS_INTERFACE_MAP_END
  35
  36 NS_IMPL_ADDREF(UrlClassifierFeatureBase)
  37 NS_IMPL_RELEASE(UrlClassifierFeatureBase)
  38
  39 UrlClassifierFeatureBase::UrlClassifierFeatureBase(
  40     const nsACString& aName, const nsACString& aPrefBlocklistTables,
  41     const nsACString& aPrefEntitylistTables,
  42     const nsACString& aPrefBlocklistHosts,
  43     const nsACString& aPrefEntitylistHosts,
  44     const nsACString& aPrefBlocklistTableName,
  45     const nsACString& aPrefEntitylistTableName,
  46     const nsACString& aPrefExceptionHosts)
  47     : mName(aName), mPrefExceptionHosts(aPrefExceptionHosts) {
  48   static_assert(nsIUrlClassifierFeature::blocklist == 0,
  49                 "nsIUrlClassifierFeature::blocklist must be 0");
  50   static_assert(nsIUrlClassifierFeature::entitylist == 1,
  51                 "nsIUrlClassifierFeature::entitylist must be 1");
  52
  53   mPrefTables[nsIUrlClassifierFeature::blocklist] = aPrefBlocklistTables;
  54   mPrefTables[nsIUrlClassifierFeature::entitylist] = aPrefEntitylistTables;
  55
  56   mPrefHosts[nsIUrlClassifierFeature::blocklist] = aPrefBlocklistHosts;
  57   mPrefHosts[nsIUrlClassifierFeature::entitylist] = aPrefEntitylistHosts;
  58
  59   mPrefTableNames[nsIUrlClassifierFeature::blocklist] = aPrefBlocklistTableName;
  60   mPrefTableNames[nsIUrlClassifierFeature::entitylist] =
  61       aPrefEntitylistTableName;
  62 }
  63
  64 UrlClassifierFeatureBase::~UrlClassifierFeatureBase() = default;
  65
  66 void UrlClassifierFeatureBase::InitializePreferences() {
  67   for (uint32_t i = 0; i < 2; ++i) {
  68     if (!mPrefTables[i].IsEmpty()) {
  69       Preferences::RegisterCallbackAndCall(OnPrefsChange, mPrefTables[i],
  70                                            &mTables[i]);
  71     }
  72
  73     if (!mPrefHosts[i].IsEmpty()) {
  74       Preferences::RegisterCallbackAndCall(OnPrefsChange, mPrefHosts[i],
  75                                            &mHosts[i]);
  76     }
  77   }
  78
  79   nsCOMPtr<nsIUrlClassifierExceptionListService> exceptionListService =
  80       do_GetService("@mozilla.org/url-classifier/exception-list-service;1");
  81   if (NS_WARN_IF(!exceptionListService)) {
  82     return;
  83   }
  84
  85   exceptionListService->RegisterAndRunExceptionListObserver(
  86       mName, mPrefExceptionHosts, this);
  87 }
  88
  89 void UrlClassifierFeatureBase::ShutdownPreferences() {
  90   for (uint32_t i = 0; i < 2; ++i) {
  91     if (!mPrefTables[i].IsEmpty()) {
  92       Preferences::UnregisterCallback(OnPrefsChange, mPrefTables[i],
  93                                       &mTables[i]);
  94     }
  95
  96     if (!mPrefHosts[i].IsEmpty()) {
  97       Preferences::UnregisterCallback(OnPrefsChange, mPrefHosts[i], &mHosts[i]);
  98     }
  99   }
 100
 101   nsCOMPtr<nsIUrlClassifierExceptionListService> exceptionListService =
 102       do_GetService("@mozilla.org/url-classifier/exception-list-service;1");
 103   if (exceptionListService) {
 104     exceptionListService->UnregisterExceptionListObserver(mName, this);
 105   }
 106 }
 107
 108 NS_IMETHODIMP
 109 UrlClassifierFeatureBase::OnExceptionListUpdate(const nsACString& aList) {
 110   mExceptionHosts = aList;
 111   return NS_OK;
 112 }
 113
 114 NS_IMETHODIMP
 115 UrlClassifierFeatureBase::GetName(nsACString& aName) {
 116   aName = mName;
 117   return NS_OK;
 118 }
 119
 120 NS_IMETHODIMP
 121 UrlClassifierFeatureBase::GetTables(nsIUrlClassifierFeature::listType aListType,
 122                                     nsTArray<nsCString>& aTables) {
 123   if (aListType != nsIUrlClassifierFeature::blocklist &&
 124       aListType != nsIUrlClassifierFeature::entitylist) {
 125     return NS_ERROR_INVALID_ARG;
 126   }
 127
 128   aTables = mTables[aListType].Clone();
 129   return NS_OK;
 130 }
 131
 132 NS_IMETHODIMP
 133 UrlClassifierFeatureBase::HasTable(const nsACString& aTable,
 134                                    nsIUrlClassifierFeature::listType aListType,
 135                                    bool* aResult) {
 136   NS_ENSURE_ARG_POINTER(aResult);
 137
 138   if (aListType != nsIUrlClassifierFeature::blocklist &&
 139       aListType != nsIUrlClassifierFeature::entitylist) {
 140     return NS_ERROR_INVALID_ARG;
 141   }
 142
 143   *aResult = mTables[aListType].Contains(aTable);
 144   return NS_OK;
 145 }
 146
 147 NS_IMETHODIMP
 148 UrlClassifierFeatureBase::HasHostInPreferences(
 149     const nsACString& aHost, nsIUrlClassifierFeature::listType aListType,
 150     nsACString& aPrefTableName, bool* aResult) {
 151   NS_ENSURE_ARG_POINTER(aResult);
 152
 153   if (aListType != nsIUrlClassifierFeature::blocklist &&
 154       aListType != nsIUrlClassifierFeature::entitylist) {
 155     return NS_ERROR_INVALID_ARG;
 156   }
 157
 158   *aResult = mHosts[aListType].Contains(aHost);
 159   if (*aResult) {
 160     aPrefTableName = mPrefTableNames[aListType];
 161   }
 162   return NS_OK;
 163 }
 164
 165 NS_IMETHODIMP
 166 UrlClassifierFeatureBase::GetExceptionHostList(nsACString& aList) {
 167   aList = mExceptionHosts;
 168   return NS_OK;
 169 }
 170
 171 NS_IMETHODIMP
 172 UrlClassifierFeatureAntiTrackingBase::GetExceptionHostList(nsACString& aList) {
 173   if (!StaticPrefs::privacy_antitracking_enableWebcompat()) {
 174     aList.Truncate();
 175     return NS_OK;
 176   }
 177
 178   return UrlClassifierFeatureBase::GetExceptionHostList(aList);
 179 }
 180
 181 }  // namespace net
 182 }  // namespace mozilla