File: log_router.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (92 lines) | stat: -rw-r--r-- 3,309 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_AUTOFILL_CORE_BROWSER_LOGGING_LOG_ROUTER_H_
#define COMPONENTS_AUTOFILL_CORE_BROWSER_LOGGING_LOG_ROUTER_H_

#include <string>
#include <vector>

#include "base/observer_list.h"
#include "base/scoped_observation_traits.h"
#include "base/values.h"
#include "components/autofill/core/browser/logging/text_log_receiver.h"
#include "components/keyed_service/core/keyed_service.h"

namespace autofill {

class RoutingLogManager;
class LogReceiver;

// The router stands between LogManager and LogReceiver instances. Both managers
// and receivers need to register (and unregister) with the router. After that,
// the following communication is enabled:
//   * LogManagers are notified when logging starts or stops being possible
//   * LogReceivers are sent logs routed through LogRouter
class LogRouter : public KeyedService {
 public:
  LogRouter();

  LogRouter(const LogRouter&) = delete;
  LogRouter& operator=(const LogRouter&) = delete;

  ~LogRouter() override;

  // Returns a JSON entry that can be fed into the logger.
  static base::Value::Dict CreateEntryForText(const std::string& text);

  // Passes logs to the router. Only call when there are receivers registered.
  void ProcessLog(const std::string& text);
  void ProcessLog(const base::Value::Dict& node);

  // Enables recording autofill-internals logs to LOG(INFO).
  void LogToTerminal();

  // Returns whether this logger has receivers.
  bool HasReceivers() const;

  // All four (Unr|R)egister* methods below are safe to call from the
  // constructor of the registered object, because they do not call that object,
  // and the router only runs on a single thread.

  // The managers must register to be notified about whether there are some
  // receivers or not. RegisterManager adds |manager| to the right observer list
  // and returns true iff there are some receivers registered.
  bool RegisterManager(RoutingLogManager* manager);
  // Remove |manager| from the observers list.
  void UnregisterManager(RoutingLogManager* manager);

  // The receivers must register to get updates with new logs in the future.
  void RegisterReceiver(LogReceiver* receiver);
  // Remove |receiver| from the observers list.
  void UnregisterReceiver(LogReceiver* receiver);

 private:
  // Observer lists for managers and receivers. The |true| in the template
  // specialization means that they will check that all observers were removed
  // on destruction.
  base::ObserverList<RoutingLogManager, true>::Unchecked managers_;
  base::ObserverList<LogReceiver, true>::Unchecked receivers_;
  TextLogReceiver text_log_receiver_;
};

}  // namespace autofill

namespace base {

template <>
struct ScopedObservationTraits<autofill::LogRouter, autofill::LogReceiver> {
  static void AddObserver(autofill::LogRouter* source,
                          autofill::LogReceiver* observer) {
    source->RegisterReceiver(observer);
  }
  static void RemoveObserver(autofill::LogRouter* source,
                             autofill::LogReceiver* observer) {
    source->UnregisterReceiver(observer);
  }
};

}  // namespace base

#endif  // COMPONENTS_AUTOFILL_CORE_BROWSER_LOGGING_LOG_ROUTER_H_