gecko-dev/netwerk/url-classifier/UrlClassifierCommon.h
Dimi Lee 98b1f35a8b Bug 1652927 - Refine URL Classifier logging r=baku
This patch does the following:
1. Introduce a new log module "nsChannelClassifierLeak" for less
   important debug message
2. Sync the format of debug message - "ClassName::FunctionName - description [this]"
3. Print uri and top-level uri in the entry point of
   AsyncChannelClassifier, remove logging uri in some functions

Differential Revision: https://phabricator.services.mozilla.com/D83610
2020-07-20 10:09:37 +00:00

104 lines
3.7 KiB
C++

/* -*- 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_UrlClassifierCommon_h
#define mozilla_net_UrlClassifierCommon_h
#include "mozilla/Logging.h"
#include "nsString.h"
#include <vector>
class nsIChannel;
class nsIURI;
#define UC_LOG(args) MOZ_LOG(UrlClassifierCommon::sLog, LogLevel::Info, args)
#define UC_LOG_DEBUG(args) \
MOZ_LOG(UrlClassifierCommon::sLog, LogLevel::Debug, args)
#define UC_LOG_WARN(args) \
MOZ_LOG(UrlClassifierCommon::sLog, LogLevel::Warning, args)
#define UC_LOG_LEAK(args) \
MOZ_LOG(UrlClassifierCommon::sLogLeak, LogLevel::Info, args)
#define UC_LOG_ENABLED() \
MOZ_LOG_TEST(UrlClassifierCommon::sLog, LogLevel::Info) || \
MOZ_LOG_TEST(UrlClassifierCommon::sLogLeak, LogLevel::Info)
namespace mozilla {
namespace net {
class UrlClassifierCommon final {
public:
static const nsCString::size_type sMaxSpecLength;
static LazyLogModule sLog;
static LazyLogModule sLogLeak;
static bool AddonMayLoad(nsIChannel* aChannel, nsIURI* aURI);
static bool ShouldEnableProtectionForChannel(nsIChannel* aChannel);
static nsresult SetBlockedContent(nsIChannel* channel, nsresult aErrorCode,
const nsACString& aList,
const nsACString& aProvider,
const nsACString& aFullHash);
static nsresult SetTrackingInfo(nsIChannel* channel,
const nsTArray<nsCString>& aLists,
const nsTArray<nsCString>& aFullHashes);
// Use this function only when you are looking for a pairwise entitylist uri
// with the format: http://toplevel.page/?resource=channel.uri.domain
static nsresult CreatePairwiseEntityListURI(nsIChannel* aChannel,
nsIURI** aURI);
static void AnnotateChannel(nsIChannel* aChannel,
uint32_t aClassificationFlags,
uint32_t aLoadingState);
static bool IsAllowListed(nsIChannel* aChannel);
static bool IsTrackingClassificationFlag(uint32_t aFlag);
static bool IsSocialTrackingClassificationFlag(uint32_t aFlag);
static bool IsCryptominingClassificationFlag(uint32_t aFlag);
// Join the table names in 1 single string.
static void TablesToString(const nsTArray<nsCString>& aList,
nsACString& aString);
struct ClassificationData {
nsCString mPrefix;
uint32_t mFlag;
};
// Checks if the entries in aList are part of the ClassificationData vector
// and it returns the corresponding flags. If none of them is found, the
// default flag is returned.
static uint32_t TablesToClassificationFlags(
const nsTArray<nsCString>& aList,
const std::vector<ClassificationData>& aData, uint32_t aDefaultFlag);
static bool IsPassiveContent(nsIChannel* aChannel);
static void SetClassificationFlagsHelper(nsIChannel* aChannel,
uint32_t aClassificationFlags,
bool aIsThirdParty);
private:
static uint32_t TableToClassificationFlag(
const nsACString& aTable, const std::vector<ClassificationData>& aData);
friend class AsyncUrlChannelClassifier;
static nsresult GetTopWindowURI(nsIChannel* aChannel, nsIURI** aURI);
};
} // namespace net
} // namespace mozilla
#endif // mozilla_net_UrlClassifierCommon_h