File: cached_image_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 (122 lines) | stat: -rw-r--r-- 5,272 bytes parent folder | download | duplicates (5)
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
// Copyright 2018 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_IMAGE_FETCHER_CORE_CACHED_IMAGE_FETCHER_H_
#define COMPONENTS_IMAGE_FETCHER_CORE_CACHED_IMAGE_FETCHER_H_

#include <memory>
#include <string>

#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/sequence_checker.h"
#include "components/image_fetcher/core/image_decoder.h"
#include "components/image_fetcher/core/image_fetcher.h"
#include "components/image_fetcher/core/image_fetcher_types.h"
#include "net/traffic_annotation/network_traffic_annotation.h"
#include "ui/gfx/geometry/size.h"
#include "url/gurl.h"

namespace image_fetcher {

class ImageCache;
class ImageFetcher;
struct RequestMetadata;

// Encapsulates a request to simplify argument lists.
struct CachedImageFetcherRequest;

// CachedImageFetcher takes care of fetching images from the network and caching
// them. Has a read-only mode which doesn't perform write operations on the
// cache.
class CachedImageFetcher : public ImageFetcher {
 public:
  CachedImageFetcher(ImageFetcher* image_fetcher,
                     scoped_refptr<ImageCache> image_cache,
                     bool read_only);

  CachedImageFetcher(const CachedImageFetcher&) = delete;
  CachedImageFetcher& operator=(const CachedImageFetcher&) = delete;

  ~CachedImageFetcher() override;

  // ImageFetcher:
  void FetchImageAndData(const GURL& image_url,
                         ImageDataFetcherCallback image_data_callback,
                         ImageFetcherCallback image_callback,
                         ImageFetcherParams params) override;
  ImageDecoder* GetImageDecoder() override;

 private:
  // Cache
  void OnImageFetchedFromCache(CachedImageFetcherRequest request,
                               ImageDataFetcherCallback image_data_callback,
                               ImageFetcherCallback image_callback,
                               bool cache_result_needs_transcoding,
                               std::string image_data);
  void OnImageDecodedFromCache(CachedImageFetcherRequest request,
                               ImageDataFetcherCallback image_data_callback,
                               ImageFetcherCallback image_callback,
                               bool cache_result_needs_transcoding,
                               const gfx::Image& image);

  // Network
  void EnqueueFetchImageFromNetwork(
      CachedImageFetcherRequest request,
      ImageDataFetcherCallback image_data_callback,
      ImageFetcherCallback image_callback);
  void FetchImageFromNetwork(
      CachedImageFetcherRequest request,
      ImageDataFetcherCallback image_data_callback,
      ImageFetcherCallback image_callback);
  void OnImageFetchedWithoutTranscoding(
      CachedImageFetcherRequest request,
      ImageDataFetcherCallback image_data_callback,
      const std::string& image_data,
      const RequestMetadata& request_metadata);
  void OnImageFetchedForTranscoding(CachedImageFetcherRequest request,
                                    ImageFetcherCallback image_data_callback,
                                    const gfx::Image& image,
                                    const RequestMetadata& request_metadata);
  // Encode the given `image_data` and store it.
  // `cache_result_needs_transcoding` is passed along for metrics purposes. It
  // is true when the result 1) comes from cache and 2) wasn't transcoded when
  // last time it was stored in the ImageCache.
  // `is_image_data_transcoded` indicates whether the image to save has been
  // transcoded. An image could be transcoded during network fetching, or loaded
  // from the ImageCache without transcoding before.
  void EncodeAndStoreData(bool cache_result_needs_transcoding,
                          bool is_image_data_transcoded,
                          CachedImageFetcherRequest request,
                          const gfx::Image& image);
  // Store the given `image_data` in the cache. `cache_result_needs_transcoding`
  // is passed along for metrics purposes. It is true when the result 1) comes
  // from cache and 2) wasn't transcoded when last time it was stored in the
  // ImageCache.
  void StoreData(bool cache_result_needs_transcoding,
                 bool is_image_data_transcoded,
                 CachedImageFetcherRequest request,
                 std::string image_data);

  // Owned by ImageFetcherService.
  raw_ptr<ImageFetcher, DanglingUntriaged> image_fetcher_;
  scoped_refptr<ImageCache> image_cache_;

  // Whether the ImageCache is allowed to be modified in any way from requests
  // made by this CachedImageFetcher. This includes updating last used times,
  // writing new data to the cache, or cleaning up unreadable data. Note that
  // the ImageCache may still decide to perform eviction/reconciliation even
  // when only read only CachedImageFetchers are using it.
  bool read_only_;

  // Used to ensure that operations are performed on the sequence that this
  // object was created on.
  SEQUENCE_CHECKER(sequence_checker_);

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

}  // namespace image_fetcher

#endif  // COMPONENTS_IMAGE_FETCHER_CORE_CACHED_IMAGE_FETCHER_H_