File: remote_debugging_server.h

package info (click to toggle)
chromium 145.0.7632.159-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,976,224 kB
  • sloc: cpp: 36,198,469; ansic: 7,634,080; javascript: 3,564,060; python: 1,649,622; xml: 838,470; asm: 717,087; pascal: 185,708; sh: 88,786; perl: 88,718; objc: 79,984; sql: 59,811; cs: 42,452; fortran: 24,101; makefile: 21,144; tcl: 15,277; php: 14,022; yacc: 9,066; ruby: 7,553; awk: 3,720; lisp: 3,233; lex: 1,328; ada: 727; jsp: 228; sed: 36
file content (91 lines) | stat: -rw-r--r-- 3,180 bytes parent folder | download | duplicates (3)
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
// Copyright 2011 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_DEVTOOLS_REMOTE_DEBUGGING_SERVER_H_
#define CHROME_BROWSER_DEVTOOLS_REMOTE_DEBUGGING_SERVER_H_

#include <stdint.h>

#include <memory>

#include "base/files/file_path.h"
#include "base/memory/weak_ptr.h"
#include "base/types/expected.h"
#include "content/public/browser/devtools_agent_host.h"

class PrefChangeRegistrar;
class PrefService;

namespace content {
class DevToolsSocketFactory;
}

class RemoteDebuggingServer {
 public:
  static constexpr int kDefaultDevToolsPort = 9222;

  enum class NotStartedReason {
    // The server was not requested by either specifying the
    // --remote-debugging-port or --remote-debugging-pipe switch.
    kNotRequested,
    // Disabled by enterprise policy.
    kDisabledByPolicy,
    // Disabled as a default user data dir is being used.
    kDisabledByDefaultUserDataDir,
  };
  // Obtains an instance of the RemoteDebuggingServer if one was started by
  // either --remote-debugging-port or --remote-debugging-pipe being supplied on
  // the command line, or nullptr otherwise.
  static base::expected<std::unique_ptr<RemoteDebuggingServer>,
                        NotStartedReason>
  GetInstance(PrefService* local_state);

  static void EnableTetheringForDebug();

#if BUILDFLAG(IS_WIN) || BUILDFLAG(IS_MAC) || BUILDFLAG(IS_LINUX)
  // Enables the default user data dir check even for non-Chrome branded builds,
  // for testing.
  static void EnableDefaultUserDataDirCheckForTesting();
#endif  // BUILDFLAG(IS_WIN) || BUILDFLAG(IS_MAC) || BUILDFLAG(IS_LINUX)

  // Returns the port number from the last session, or a default value.
  // Exposed for testing.
  static int GetPortFromUserDataDir(const base::FilePath& output_dir);

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

  virtual ~RemoteDebuggingServer();

  void StartHttpServerInApprovalMode(PrefService* local_state);

 protected:
  RemoteDebuggingServer();

  virtual void StartHttpServer(
      std::unique_ptr<content::DevToolsSocketFactory> factory,
      const base::FilePath& output_dir,
      const base::FilePath& debug_frontend_dir,
      content::DevToolsAgentHost::RemoteDebuggingServerMode mode);
  virtual void StopHttpServer();
  virtual void StartPipeHandler();
  virtual void StopPipeHandler();

 private:
  void MaybeStartOrStopServerForPrefChange();
  void StartHttpServerInApprovalModeWithPort(const base::FilePath& output_dir,
                                             int port);

  std::unique_ptr<PrefChangeRegistrar> pref_change_registrar_;
  // Used by MaybeStartOrStopServerForPrefChange to ensure that the server is
  // only started once.
  bool is_http_server_running_ = false;
  // Ensures that the server is not started twice at the same time
  // due to the async reading of the ActivePort file.
  bool is_http_server_being_started_ = false;

  base::WeakPtrFactory<RemoteDebuggingServer> weak_factory_{this};
};

#endif  // CHROME_BROWSER_DEVTOOLS_REMOTE_DEBUGGING_SERVER_H_