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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
// 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_SESSIONS_CORE_BASE_SESSION_SERVICE_COMMANDS_H_
#define COMPONENTS_SESSIONS_CORE_BASE_SESSION_SERVICE_COMMANDS_H_
#include <memory>
#include <optional>
#include <string>
#include "components/sessions/core/serialized_user_agent_override.h"
#include "components/sessions/core/session_command.h"
#include "components/sessions/core/session_id.h"
#include "components/sessions/core/sessions_export.h"
namespace sessions {
class SessionCommand;
class SerializedNavigationEntry;
// These commands create and read common base commands for SessionService and
// PersistentTabRestoreService.
// Creates a SessionCommand that represents a navigation.
std::unique_ptr<SessionCommand> CreateUpdateTabNavigationCommand(
SessionCommand::id_type command_id,
SessionID tab_id,
const sessions::SerializedNavigationEntry& navigation);
// Creates a SessionCommand that represents marking a tab as an application.
std::unique_ptr<SessionCommand> CreateSetTabExtensionAppIDCommand(
SessionCommand::id_type command_id,
SessionID tab_id,
const std::string& extension_id);
// Creates a SessionCommand that containing user agent override used by a
// tab's navigations.
std::unique_ptr<SessionCommand> CreateSetTabUserAgentOverrideCommand(
SessionCommand::id_type command_id,
SessionID tab_id,
const SerializedUserAgentOverride& user_agent_override);
// Creates a SessionCommand stores a browser window's app name.
std::unique_ptr<SessionCommand> CreateSetWindowAppNameCommand(
SessionCommand::id_type command_id,
SessionID window_id,
const std::string& app_name);
// Creates a SessionCommand storing a browser window's user title.
std::unique_ptr<SessionCommand> CreateSetWindowUserTitleCommand(
SessionCommand::id_type command_id,
SessionID window_id,
const std::string& app_name);
// Creates a SessionCommand storing a tab extra data.
std::unique_ptr<SessionCommand> CreateAddExtraDataCommand(
SessionCommand::id_type command,
SessionID session_id,
const std::string& key,
const std::string& data);
// Creates a SessionCommand storing the platform session id.
std::unique_ptr<SessionCommand> CreateSetPlatformSessionIdCommand(
SessionCommand::id_type command_id,
const std::string& platform_session_id);
// Converts a SessionCommand previously created by
// CreateUpdateTabNavigationCommand into a
// SerializedNavigationEntry. Returns true on success. If
// successful |tab_id| is set to the id of the restored tab.
bool RestoreUpdateTabNavigationCommand(
const SessionCommand& command,
sessions::SerializedNavigationEntry* navigation,
SessionID* tab_id);
// Extracts a SessionCommand as previously created by
// CreateSetTabExtensionAppIDCommand into the tab id and application
// extension id.
bool RestoreSetTabExtensionAppIDCommand(const SessionCommand& command,
SessionID* tab_id,
std::string* extension_app_id);
// Extracts a SessionCommand as previously created by
// CreateSetTabUserAgentOverrideCommand into the tab id and user agent and
// structured user agent.
bool RestoreSetTabUserAgentOverrideCommand2(
const SessionCommand& command,
SessionID* tab_id,
std::string* user_agent_override,
std::optional<std::string>* opaque_ua_metadata_override);
// Backwards compatible version that restores versions that didn't have
// structured user agent override.
bool RestoreSetTabUserAgentOverrideCommand(const SessionCommand& command,
SessionID* tab_id,
std::string* user_agent_override);
// Extracts a SessionCommand as previously created by
// CreateSetWindowAppNameCommand into the window id and application name.
bool RestoreSetWindowAppNameCommand(const SessionCommand& command,
SessionID* window_id,
std::string* app_name);
// Extracts a SessionCommand as previously created by
// CreateSetWindowUserTitleCommand into the window id and user title.
bool RestoreSetWindowUserTitleCommand(const SessionCommand& command,
SessionID* window_id,
std::string* user_title);
// Extracts a SessionCommand as previously created by
// CreateAddExtraDataCommand into the tab/window id, key and data.
bool RestoreAddExtraDataCommand(const SessionCommand& command,
SessionID* session_id,
std::string* key,
std::string* data);
// Extracts a SessionCommand as previously created by
// CreateSetPlatformSessionIdCommand into platform_session_id.
bool RestoreSetPlatformSessionIdCommand(const SessionCommand& command,
std::string* platform_session_id);
} // namespace sessions
#endif // COMPONENTS_SESSIONS_CORE_BASE_SESSION_SERVICE_COMMANDS_H_
|
