File: content_page_annotator_driver.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 (89 lines) | stat: -rw-r--r-- 3,468 bytes parent folder | download | duplicates (11)
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
// Copyright 2019 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_PAGE_IMAGE_ANNOTATION_CONTENT_RENDERER_CONTENT_PAGE_ANNOTATOR_DRIVER_H_
#define COMPONENTS_PAGE_IMAGE_ANNOTATION_CONTENT_RENDERER_CONTENT_PAGE_ANNOTATOR_DRIVER_H_

#include <map>
#include <utility>

#include "base/gtest_prod_util.h"
#include "components/page_image_annotation/core/page_annotator.h"
#include "content/public/renderer/render_frame_observer.h"
#include "content/public/renderer/render_frame_observer_tracker.h"
#include "third_party/blink/public/web/web_element.h"
#include "ui/base/page_transition_types.h"

namespace page_image_annotation {

// This class holds a PageAnnotator for a given RenderFrame and feeds it
// information about images as they appear / disappear from the page.
//
// This class can also be used to access the Content-level interface (i.e.
// blink::WebElement) for DOM nodes with associated images.
class ContentPageAnnotatorDriver
    : public content::RenderFrameObserver,
      public content::RenderFrameObserverTracker<ContentPageAnnotatorDriver> {
 public:
  ContentPageAnnotatorDriver(const ContentPageAnnotatorDriver&) = delete;
  ContentPageAnnotatorDriver& operator=(const ContentPageAnnotatorDriver&) =
      delete;

  ~ContentPageAnnotatorDriver() override;

  static ContentPageAnnotatorDriver* GetOrCreate(
      content::RenderFrame* render_frame);

  // Given a page URL and a URI fragment (which could possibly be an absolute
  // URL, relative URL or data URI), produces a source ID.
  //
  // The source ID of a URL is the absolute version of the URL. The source ID of
  // a data URI is the base64 encoded SHA256 hash of the data string.
  //
  // If a source ID cannot be generated (e.g. the URI fragment is malformed),
  // the empty string is returned.
  static std::string GenerateSourceId(const GURL& page_url,
                                      const std::string& uri_fragment);

  PageAnnotator& GetPageAnnotator();

  // Returns the element associated with the given node ID. If there is no such
  // element, returns a null blink::WebElement.
  blink::WebElement GetElement(uint64_t node_id);

 private:
  // We delete ourselves on frame destruction, so disallow construction on the
  // stack.
  ContentPageAnnotatorDriver(content::RenderFrame* render_frame);

  // content::RenderFrameObserver:
  void DidDispatchDOMContentLoadedEvent() override;
  void OnDestruct() override;

  // Traverse the DOM starting at the given node, and add all elements with
  // associated images to the |tracked_elements_| map.
  void FindImages(const GURL& page_url, blink::WebElement element);

  // Traverse the DOM for elements with associated images, add these elements to
  // |tracked_elements_|, and send element info to the PageAnnotator.
  void FindAndTrackImages();

  // Return the bitmap associated with the given node ID.
  SkBitmap GetBitmapForId(uint64_t node_id);

  // The next ID to assign to a DOM node.
  uint64_t next_node_id_;

  // The current set of tracked DOM nodes.
  std::map<uint64_t, std::pair<PageAnnotator::ImageMetadata, blink::WebElement>>
      tracked_elements_;

  PageAnnotator page_annotator_;

  base::WeakPtrFactory<ContentPageAnnotatorDriver> weak_ptr_factory_{this};
};

}  // namespace page_image_annotation

#endif  //  COMPONENTS_PAGE_IMAGE_ANNOTATION_CONTENT_RENDERER_CONTENT_PAGE_ANNOTATOR_DRIVER_H_