File: tab_fetcher.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (107 lines) | stat: -rw-r--r-- 3,721 bytes parent folder | download | duplicates (9)
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
// Copyright 2023 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_SEGMENTATION_PLATFORM_EMBEDDER_TAB_FETCHER_H_
#define COMPONENTS_SEGMENTATION_PLATFORM_EMBEDDER_TAB_FETCHER_H_

#include <string>
#include <vector>

#include "base/memory/raw_ptr.h"
#include "components/sessions/core/session_id.h"
#include "components/sessions/core/session_types.h"
#include "components/sync_sessions/session_sync_service.h"
#include "url/gurl.h"

namespace content {
class WebContents;
}
class TabAndroid;

namespace segmentation_platform {

// Interface for fetching and iterating over tabs.
class TabFetcher {
 public:
  // ID that points to a local or foreign tab.
  struct TabEntry {
    // For tabs from sync session.
    TabEntry(SessionID tab_id, const std::string& session_tag);
    // For tabs from local tab model.
    TabEntry(SessionID tab_id,
             content::WebContents* webcontents,
             TabAndroid* tab_android);

    // Session tag that identifies the session across all devices. Only
    // available for synced tabs.
    std::string session_tag;

    // A tab ID for the tab within the session.
    SessionID tab_id;

    // An ID for local tab derived from web contents or tab pointer. Do not use
    // the webcontents or tab by casting this pointer. Use the FindTab to fetch
    // the pointer, since the tab or webcontents could have been destroyed.
    raw_ptr<void, DanglingUntriaged> web_contents_data;
    raw_ptr<void> tab_android_data;
  };

  // Represents a local or foreign tab.
  struct Tab {
    // Local tab's webcontents.
    raw_ptr<content::WebContents, DanglingUntriaged> webcontents = nullptr;
    // Local tab's pointer, only available on Android.
    raw_ptr<TabAndroid> tab_android = nullptr;
    // Foreign tab's session data.
    raw_ptr<const sessions::SessionTab> session_tab = nullptr;

    // URL for the tab.
    GURL tab_url;
    // Returns the time since last modification of the `tab`. Returns
    // TimeDelta::Max() on failure.
    base::TimeDelta time_since_modified;
  };

  explicit TabFetcher(sync_sessions::SessionSyncService* session_sync_service);
  virtual ~TabFetcher() = default;

  // Appends a list of all remote tabs to `tabs`.
  bool FillAllRemoteTabs(std::vector<TabEntry>& tabs);

  // Appends a list of all remote tabs to `tabs` loaded after the given
  // timestamp.
  bool FillAllRemoteTabsAfterTime(std::vector<TabEntry>& tabs,
                                  base::Time tabs_loaded_after_timestamp);

  // Appends a list of all local tabs to `tabs`.
  bool FillAllLocalTabs(std::vector<TabEntry>& tabs);

  // Finds the tab corresponding to the `entry`.
  Tab FindTab(const TabEntry& entry);

  // Returns the count of remote tabs loaded after the given timestamp till now.
  size_t GetRemoteTabsCountAfterTime(base::Time tabs_loaded_after_timestamp);

  // Returns the modified time for the latest remote sync session if sync is
  // enabled.
  std::optional<base::Time> GetLatestRemoteSessionModifiedTime();

 protected:
  // Fills all the local tabs from the tab models in `tabs`.
  virtual bool FillAllLocalTabsFromTabModel(std::vector<TabEntry>& tabs);

  // Fills all the local tabs from the sync sessions database.
  bool FillAllLocalTabsFromSyncSessions(std::vector<TabEntry>& tabs);

  // Returns the local tab corresponding to `entry`. If the tab was closed, then
  // returns an empty Tab.
  virtual Tab FindLocalTab(const TabEntry& entry);

 private:
  const raw_ptr<sync_sessions::SessionSyncService> session_sync_service_;
};

}  // namespace segmentation_platform

#endif  // COMPONENTS_SEGMENTATION_PLATFORM_EMBEDDER_TAB_FETCHER_H_