blob: 37f806cdd7e235b1851dff648991697801cb29e8 [file] [log] [blame]
// Copyright (c) 2012 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.
#ifndef CHROME_BROWSER_UI_GLOBAL_ERROR_GLOBAL_ERROR_SERVICE_H_
#define CHROME_BROWSER_UI_GLOBAL_ERROR_GLOBAL_ERROR_SERVICE_H_
#include <map>
#include <memory>
#include <vector>
#include "base/macros.h"
#include "components/keyed_service/core/keyed_service.h"
class GlobalError;
class Profile;
// This service manages a list of errors that are meant to be shown globally.
// If an error applies to an entire profile and not just to a tab then the
// error should be shown using this service. Examples of global errors are:
// - the previous session crashed for a given profile.
// - a sync error occurred
class GlobalErrorService : public KeyedService {
public:
// Type used to represent the list of currently active errors.
using GlobalErrorList = std::vector<GlobalError*>;
// Constructs a GlobalErrorService object for the given profile. The profile
// maybe NULL for tests.
explicit GlobalErrorService(Profile* profile);
~GlobalErrorService() override;
// Adds the given error to the list of global errors and displays it on
// browser windows. If no browser windows are open then the error is
// displayed once a browser window is opened.
void AddGlobalError(std::unique_ptr<GlobalError> error);
// Hides the given error and removes it from the list of global errors.
// Ownership is returned to the caller.
std::unique_ptr<GlobalError> RemoveGlobalError(GlobalError* error);
// DEPRECATED; DO NOT USE!
// http://crbug.com/673578
//
// These functions allow adding and removing of a GlobalError that is not
// owned by the GlobalErrorService. In this case, the error's lifetime must
// exceed that of the GlobalErrorService.
//
// Do not add more uses of these functions, and remove existing uses.
void AddUnownedGlobalError(GlobalError* error);
void RemoveUnownedGlobalError(GlobalError* error);
// Gets the error with the given command ID or NULL if no such error exists.
// This class maintains ownership of the returned error.
GlobalError* GetGlobalErrorByMenuItemCommandID(int command_id) const;
// Gets the highest severity error that has a app menu item.
// Returns NULL if no such error exists.
GlobalError* GetHighestSeverityGlobalErrorWithAppMenuItem() const;
// Gets the first error that has a bubble view which hasn't been shown yet.
// Returns NULL if no such error exists.
GlobalError* GetFirstGlobalErrorWithBubbleView() const;
// Gets all errors.
const GlobalErrorList& errors() { return all_errors_; }
// Post a notification that a global error has changed and that the error UI
// should update it self. Pass NULL for the given error to mean all error UIs
// should update.
void NotifyErrorsChanged(GlobalError* error);
private:
GlobalErrorList all_errors_;
std::map<GlobalError*, std::unique_ptr<GlobalError>> owned_errors_;
Profile* profile_;
DISALLOW_COPY_AND_ASSIGN(GlobalErrorService);
};
#endif // CHROME_BROWSER_UI_GLOBAL_ERROR_GLOBAL_ERROR_SERVICE_H_