File: supervised_user_site_list.h

package info (click to toggle)
chromium-browser 41.0.2272.118-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 2,189,132 kB
  • sloc: cpp: 9,691,462; ansic: 3,341,451; python: 712,689; asm: 518,779; xml: 208,926; java: 169,820; sh: 119,353; perl: 68,907; makefile: 28,311; yacc: 13,305; objc: 11,385; tcl: 3,186; cs: 2,225; sql: 2,217; lex: 2,215; lisp: 1,349; pascal: 1,256; awk: 407; ruby: 155; sed: 53; php: 14; exp: 11
file content (92 lines) | stat: -rw-r--r-- 3,289 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
// Copyright 2014 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 CHROME_BROWSER_SUPERVISED_USER_SUPERVISED_USER_SITE_LIST_H_
#define CHROME_BROWSER_SUPERVISED_USER_SUPERVISED_USER_SITE_LIST_H_

#include <string>
#include <vector>

#include "base/callback_forward.h"
#include "base/files/file_path.h"
#include "base/memory/ref_counted.h"
#include "base/memory/scoped_ptr.h"
#include "base/memory/scoped_vector.h"
#include "base/time/time.h"

class Profile;

namespace base {
class DictionaryValue;
class ListValue;
class Value;
}

// This class represents a "site list" that is part of a content pack. It is
// loaded from a JSON file inside the extension bundle, which defines the sites
// on the list.
// Every site has -- among other attributes -- a whitelist of URLs that are
// required to use it. All sites from all installed content packs together with
// their respective whitelists are combined in the SupervisedUserURLFilter,
// which can tell for a given URL if it is part of the whitelist for any site.
// Effectively, SupervisedUserURLFilter then acts as a big whitelist which is
// the union of the whitelists in all sites in all content packs. See
// http://goo.gl/cBCB8 for a diagram.
class SupervisedUserSiteList
    : public base::RefCountedThreadSafe<SupervisedUserSiteList> {
 public:
  typedef base::Callback<void(const scoped_refptr<SupervisedUserSiteList>&)>
      LoadedCallback;

  struct Site {
    explicit Site(const base::string16& name);
    ~Site();

    // The human-readable name for the site.
    base::string16 name;

    // A list of URL patterns that should be whitelisted for the site.
    std::vector<std::string> patterns;

    // A list of SHA1 hashes of hostnames that should be whitelisted
    // for the site.
    std::vector<std::string> hostname_hashes;

    // Copying and assignment is allowed.
  };

  // Asynchronously loads the site list from |file| and calls |callback| with
  // the newly created object.
  static void Load(const base::FilePath& file, const LoadedCallback& callback);

  // Sets whether the site list should be loaded in-process or out-of-process.
  // In-process loading should only be used in tests (to avoid having to set up
  // child process handling).
  static void SetLoadInProcessForTesting(bool in_process);

  // Returns a list of all sites in this site list.
  const std::vector<Site>& sites() const { return sites_; }

 private:
  friend class base::RefCountedThreadSafe<SupervisedUserSiteList>;

  explicit SupervisedUserSiteList(const base::ListValue& sites);
  ~SupervisedUserSiteList();

  // Static private so they can access the private constructor.
  static void ParseJson(const base::FilePath& path,
                        const SupervisedUserSiteList::LoadedCallback& callback,
                        const std::string& json);
  static void OnJsonParseSucceeded(
      const base::FilePath& path,
      base::TimeTicks start_time,
      const SupervisedUserSiteList::LoadedCallback& callback,
      scoped_ptr<base::Value> value);

  std::vector<Site> sites_;

  DISALLOW_COPY_AND_ASSIGN(SupervisedUserSiteList);
};

#endif  // CHROME_BROWSER_SUPERVISED_USER_SUPERVISED_USER_SITE_LIST_H_