src/chrome/browser/supervised_user/supervised_user_site_list.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_SUPERVISED_USER_SUPERVISED_USER_SITE_LIST_H_
   6 #define CHROME_BROWSER_SUPERVISED_USER_SUPERVISED_USER_SITE_LIST_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/files/file_path.h"
  12 #include "base/memory/ref_counted.h"
  13 #include "base/memory/scoped_ptr.h"
  14 #include "base/memory/scoped_vector.h"
  15
  16 class Profile;
  17
  18 namespace base {
  19 class DictionaryValue;
  20 class ListValue;
  21 }
  22
  23 // This class represents a "site list" that is part of a content pack. It is
  24 // loaded from a JSON file inside the extension bundle, which defines the sites
  25 // on the list.
  26 // Every site has -- among other attributes -- a whitelist of URLs that are
  27 // required to use it. All sites from all installed content packs together with
  28 // their respective whitelists are combined in the SupervisedUserURLFilter,
  29 // which can tell for a given URL if it is part of the whitelist for any site.
  30 // Effectively, SupervisedUserURLFilter then acts as a big whitelist which is
  31 // the union of the whitelists in all sites in all content packs. See
  32 // http://goo.gl/cBCB8 for a diagram.
  33 class SupervisedUserSiteList {
  34  public:
  35   struct Site {
  36     Site(const base::string16& name, int category_id);
  37     ~Site();
  38
  39     // The human-readable name for the site.
  40     base::string16 name;
  41
  42     // An identifier for the category. Categories are hardcoded and start with
  43     // 1, but apart from the offset correspond to the return values from
  44     // GetCategoryNames() below.
  45     int category_id;
  46
  47     // A list of URL patterns that should be whitelisted for the site.
  48     std::vector<std::string> patterns;
  49
  50     // A list of SHA1 hashes of hostnames that should be whitelisted
  51     // for the site.
  52     std::vector<std::string> hostname_hashes;
  53   };
  54
  55   explicit SupervisedUserSiteList(const base::FilePath& path);
  56   ~SupervisedUserSiteList();
  57
  58   // Creates a copy of the site list.
  59   // Caller takes ownership of the returned value.
  60   SupervisedUserSiteList* Clone() const;
  61
  62   // Returns a list of all categories.
  63   // TODO(bauerb): The list is hardcoded for now, but if we allow custom
  64   // categories, this should live in some registry.
  65   static void GetCategoryNames(std::vector<base::string16>* categories);
  66
  67   // Returns a list of all sites in this site list.
  68   void GetSites(std::vector<Site>* sites);
  69
  70  private:
  71   bool LazyLoad();
  72
  73   base::FilePath path_;
  74   scoped_ptr<base::DictionaryValue> categories_;
  75   scoped_ptr<base::ListValue> sites_;
  76
  77   DISALLOW_COPY_AND_ASSIGN(SupervisedUserSiteList);
  78 };
  79
  80 #endif  // CHROME_BROWSER_SUPERVISED_USER_SUPERVISED_USER_SITE_LIST_H_