blob: 013844652bbc390e113441a7a2e8a4b3952ecbf7 [file] [log] [blame]
// Copyright (c) 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <string>
#include "base/basictypes.h"
#include "base/files/file_path.h"
#include "base/gtest_prod_util.h"
#include "base/memory/scoped_ptr.h"
namespace base {
class DictionaryValue;
namespace net {
class NetLogLogger;
class ChromeNetLog;
// NetLogTempFile logs all the NetLog entries into a temporary file
// "chrome-net-export-log.json" created in base::GetTempDir() directory.
// NetLogTempFile maintains the current logging state (state_) and log file type
// (log_type_) of the logging into a chrome-net-export-log.json file.
// The following are the possible states
// a) Only Start is allowed (STATE_NOT_LOGGING, LOG_TYPE_NONE).
// b) Only Stop is allowed (STATE_LOGGING).
// c) Either Send or Start is allowed (STATE_NOT_LOGGING, anything but
// This is created/destroyed on the UI thread, but all other function calls
// occur on the FILE_USER_BLOCKING thread.
// This relies on the UI thread outlasting all other named threads for thread
// safety.
class NetLogTempFile {
// This enum lists the UI button commands it could receive.
enum Command {
DO_START, // Call StartNetLog.
DO_START_STRIP_PRIVATE_DATA, // Call StartNetLog stripping private data.
DO_STOP, // Call StopNetLog.
virtual ~NetLogTempFile(); // Destructs a NetLogTempFile.
// Accepts the button command and executes it.
void ProcessCommand(Command command);
// Returns true and the path to the temporary file. If there is no file to
// send, then it returns false. It also returns false when actively logging to
// the file.
bool GetFilePath(base::FilePath* path);
// Creates a Value summary of the state of the NetLogTempFile. The caller is
// responsible for deleting the returned value.
base::DictionaryValue* GetState();
// Constructs a NetLogTempFile. Only one instance is created in browser
// process.
explicit NetLogTempFile(ChromeNetLog* chrome_net_log);
// Returns path name to base::GetTempDir() directory. Returns false if
// base::GetTempDir() fails.
virtual bool GetNetExportLogDirectory(base::FilePath* path);
// Returns true if |log_path_| exists.
virtual bool NetExportLogExists();
friend class ChromeNetLog;
friend class NetLogTempFileTest;
// Allow tests to access our innards for testing purposes.
FRIEND_TEST_ALL_PREFIXES(NetLogTempFileTest, EnsureInitFailure);
FRIEND_TEST_ALL_PREFIXES(NetLogTempFileTest, EnsureInitAllowStart);
FRIEND_TEST_ALL_PREFIXES(NetLogTempFileTest, EnsureInitAllowStartOrSend);
FRIEND_TEST_ALL_PREFIXES(NetLogTempFileTest, ProcessCommandDoStartAndStop);
FRIEND_TEST_ALL_PREFIXES(NetLogTempFileTest, DoStartClearsFile);
FRIEND_TEST_ALL_PREFIXES(NetLogTempFileTest, CheckAddEvent);
// This enum lists the possible state NetLogTempFile could be in. It is used
// to enable/disable "Start", "Stop" and "Send" (email) UI actions.
enum State {
// Not currently logging to file.
// Currently logging to file.
// The type of the current log file on disk.
enum LogType {
// There is no current log file.
// The file predates this session. May or may not have private data.
// TODO(davidben): This state is kind of silly.
// The file has credentials and cookies stripped.
// The file includes all data.
// Initializes the |state_| to STATE_NOT_LOGGING and |log_type_| to
// LOG_TYPE_NONE (if there is no temporary file from earlier run) or
// LOG_TYPE_UNKNOWN (if there is a temporary file from earlier run). Returns
// false if initialization of |log_path_| fails.
bool EnsureInit();
// Start collecting NetLog data into chrome-net-export-log.json file in
// base::GetTempDir() directory. If |strip_private_data| is true, do not log
// cookies and credentials. It is a no-op if we are already collecting data
// into a file.
void StartNetLog(bool strip_private_data);
// Stop collecting NetLog data into the temporary file. It is a no-op if we
// are not collecting data into a file.
void StopNetLog();
// Updates |log_path_| with base::FilePath to |log_filename_| in the
// base::GetTempDir() directory. Returns false if base::GetTempDir()
// fails.
bool GetNetExportLog();
// Helper function for unit tests.
State state() const { return state_; }
LogType log_type() const { return log_type_; }
State state_; // Current state of NetLogTempFile.
LogType log_type_; // Type of current log file on disk.
// Name of the file. It defaults to chrome-net-export-log.json, but can be
// overwritten by unit tests.
base::FilePath::StringType log_filename_;
base::FilePath log_path_; // base::FilePath to the temporary file.
// |net_log_logger_| watches the NetLog event stream, and sends all entries to
// the file created in StartNetLog().
scoped_ptr<net::NetLogLogger> net_log_logger_;
// The |chrome_net_log_| is owned by the browser process, cached here to avoid
// using global (g_browser_process).
ChromeNetLog* chrome_net_log_;