blob: 6148e965d67858111db3783b3a987887805def66 [file] [log] [blame]
// Copyright 2016 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 <vector>
#include "base/containers/circular_deque.h"
#include "base/macros.h"
namespace offline_pages {
// Maximum number of recorded Logs to keep track of at any moment.
constexpr size_t kMaxLogCount = 50;
// Facilitates the logging of events. Subclasses should create methods that
// call RecordActivity to write into the log. |SetIsLogging|, |GetLogs|, and
// |Clear| are called from the chrome://offline-internals page.
// Logging should be done by calling the corresponding subclass methods when
// a loggable event occurs (i.e. when status has changed for a save request
// or when an offlined page has been accessed/saved).
// This log only keeps track of the last |kMaxLogCount| events.
class OfflineEventLogger {
// This client interface should be implemented by the class which provides the
// ability to pipe the log somewhere else (Eg. a java class which can write
// logs into a file). It's optional and uses SetClient() to attach the client
// to the event logger instance.
class Client {
virtual ~Client() {}
virtual void CustomLog(const std::string& message) = 0;
// Clears the recorded activities.
void Clear();
// Turns logging on/off.
void SetIsLogging(bool is_logging);
// Returns whether we are currently logging.
bool GetIsLogging();
// Dumps the current activity list into |records|.
void GetLogs(std::vector<std::string>* records);
// Write the activity into the cycling log if we are currently logging.
void RecordActivity(const std::string& activity);
// Sets the client for custom logging process if needed.
void SetClient(Client* client);
// Recorded offline page activities.
base::circular_deque<std::string> activities_;
// Whether we are currently recording logs or not.
bool is_logging_;
// Not owned.
Client* client_;
} // namespace offline_pages