File: web_restrictions_client.h

package info (click to toggle)
chromium-browser 57.0.2987.98-1~deb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 2,637,852 kB
  • ctags: 2,544,394
  • sloc: cpp: 12,815,961; ansic: 3,676,222; python: 1,147,112; asm: 526,608; java: 523,212; xml: 286,794; perl: 92,654; sh: 86,408; objc: 73,271; makefile: 27,698; cs: 18,487; yacc: 13,031; tcl: 12,957; pascal: 4,875; ml: 4,716; lex: 3,904; sql: 3,862; ruby: 1,982; lisp: 1,508; php: 1,368; exp: 404; awk: 325; csh: 117; jsp: 39; sed: 37
file content (126 lines) | stat: -rw-r--r-- 4,237 bytes parent folder | download
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
125
126
// Copyright 2015 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 COMPONENTS_WEB_RESTRICTION_WEB_RESTRICTIONS_CLIENT_H_
#define COMPONENTS_WEB_RESTRICTION_WEB_RESTRICTIONS_CLIENT_H_

#include <jni.h>

#include <list>
#include <string>
#include <unordered_map>

#include "base/android/jni_android.h"
#include "base/android/scoped_java_ref.h"
#include "base/callback.h"
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "base/sequenced_task_runner.h"
#include "base/single_thread_task_runner.h"
#include "base/synchronization/lock.h"
#include "components/web_restrictions/browser/web_restrictions_client_result.h"

namespace web_restrictions {

enum UrlAccess { ALLOW, DISALLOW, PENDING };

class WebRestrictionsClient {
 public:
  // An instance of this class is expected to live through the lifetime of a
  // browser and uses raw pointers in callbacks.
  // Any changes to the class, enable/disable/change should be done through the
  // SetAuthority(...) method.
  WebRestrictionsClient();
  ~WebRestrictionsClient();

  // Register JNI methods.
  static bool Register(JNIEnv* env);

  // Verify the content provider and query it for basic information like does it
  // support handling requests. This should be called everytime the provider
  // changes. An empty authority can be used to disable this class.
  void SetAuthority(const std::string& content_provider_authority);

  // WebRestrictionsProvider:
  UrlAccess ShouldProceed(bool is_main_frame,
                          const std::string& url,
                          const base::Callback<void(bool)>& callback);

  bool SupportsRequest() const;

  void RequestPermission(const std::string& url,
                         const base::Callback<void(bool)>& callback);

  void OnWebRestrictionsChanged(
      JNIEnv* env,
      const base::android::JavaParamRef<jobject>& obj);

  // Get a cached WebRestrictionsResult synchronously, for use when building
  // error pages etc.. May be called on any thread, and will return a fresh copy
  // of the result (hence thread safe).
  std::unique_ptr<WebRestrictionsClientResult> GetCachedWebRestrictionsResult(
      const std::string& url);

 private:
  // Make the test classes friends, so that they can set the authority
  // synchronously
  friend class WebRestrictionsResourceThrottleTest;
  friend class WebRestrictionsClientTest;

  class Cache {
   public:
    Cache();
    ~Cache();
    std::unique_ptr<WebRestrictionsClientResult> GetCacheEntry(
        const std::string& url);
    void SetCacheEntry(const std::string& url,
                       const WebRestrictionsClientResult& entry);
    void RemoveCacheEntry(const std::string& url);
    void Clear();

   private:
    base::Lock lock_;
    std::unordered_map<std::string, WebRestrictionsClientResult> cache_data_;
    DISALLOW_COPY_AND_ASSIGN(Cache);
  };

  void SetAuthorityTask(const std::string& content_provider_authority);

  void RecordURLAccess(const std::string& url);

  void UpdateCache(const std::string& provider_authority,
                   const std::string& url,
                   base::android::ScopedJavaGlobalRef<jobject> result);

  void RequestSupportKnown(const std::string& provider_authority,
                           bool supports_request);

  void ClearCache();

  static base::android::ScopedJavaGlobalRef<jobject> ShouldProceedTask(
      const std::string& url,
      const base::android::JavaRef<jobject>& java_provider);

  void OnShouldProceedComplete(
      std::string provider_authority,
      const std::string& url,
      const base::Callback<void(bool)>& callback,
      const base::android::ScopedJavaGlobalRef<jobject>& result);

  // Set up after SetAuthority().
  bool initialized_;
  bool supports_request_;
  base::android::ScopedJavaGlobalRef<jobject> java_provider_;
  std::string provider_authority_;
  Cache cache_;

  scoped_refptr<base::SequencedTaskRunner> background_task_runner_;
  std::list<std::string> recent_urls_;

  DISALLOW_COPY_AND_ASSIGN(WebRestrictionsClient);
};

}  // namespace web_restrictions

#endif  // COMPONENTS_WEB_RESTRICTION_WEB_RESTRICTIONS_CLIENT_H_