components/web_resource/notification_promo.h

   1 // Copyright (c) 2012 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 COMPONENTS_WEB_RESOURCE_NOTIFICATION_PROMO_H_
   6 #define COMPONENTS_WEB_RESOURCE_NOTIFICATION_PROMO_H_
   7
   8 #include <string>
   9
  10 #include "base/basictypes.h"
  11 #include "base/gtest_prod_util.h"
  12 #include "base/memory/ref_counted.h"
  13 #include "base/memory/scoped_ptr.h"
  14 #include "url/gurl.h"
  15
  16 class PrefRegistrySimple;
  17 class PrefService;
  18
  19 namespace base {
  20 class DictionaryValue;
  21 class ListValue;
  22 }
  23
  24 namespace user_prefs {
  25 class PrefRegistrySyncable;
  26 }
  27
  28 namespace version_info {
  29 enum class Channel;
  30 }
  31
  32 namespace web_resource {
  33
  34 // Helper class for PromoResourceService that parses promo notification info
  35 // from json or prefs.
  36 class NotificationPromo {
  37  public:
  38   static GURL PromoServerURL(version_info::Channel channel);
  39
  40   enum PromoType {
  41     NO_PROMO,
  42     NTP_NOTIFICATION_PROMO,
  43     NTP_BUBBLE_PROMO,
  44     MOBILE_NTP_SYNC_PROMO,
  45     MOBILE_NTP_WHATS_NEW_PROMO,
  46   };
  47
  48   explicit NotificationPromo(PrefService* local_state);
  49   ~NotificationPromo();
  50
  51   // Initialize from json/prefs.
  52   void InitFromJson(const base::DictionaryValue& json, PromoType promo_type);
  53   void InitFromPrefs(PromoType promo_type);
  54
  55   // Can this promo be shown?
  56   bool CanShow() const;
  57
  58   // Calculates promo notification start time with group-based time slice
  59   // offset.
  60   double StartTimeForGroup() const;
  61   double EndTime() const;
  62
  63   // Helpers for NewTabPageHandler.
  64   // Mark the promo as closed when the user dismisses it.
  65   static void HandleClosed(PromoType promo_type, PrefService* local_state);
  66   // Mark the promo has having been viewed. This returns true if views
  67   // exceeds the maximum allowed.
  68   static bool HandleViewed(PromoType promo_type, PrefService* local_state);
  69
  70   bool new_notification() const { return new_notification_; }
  71
  72   const std::string& promo_text() const { return promo_text_; }
  73   PromoType promo_type() const { return promo_type_; }
  74   const base::DictionaryValue* promo_payload() const {
  75     return promo_payload_.get();
  76   }
  77
  78   // Register preferences.
  79   static void RegisterPrefs(PrefRegistrySimple* registry);
  80   static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry);
  81   static void MigrateUserPrefs(PrefService* user_prefs);
  82
  83  private:
  84   // For testing.
  85   friend class NotificationPromoTest;
  86
  87   // Check if this promo notification is new based on start/end times,
  88   // and trigger events accordingly.
  89   void CheckForNewNotification();
  90
  91   // Actions on receiving a new promo notification.
  92   void OnNewNotification();
  93
  94   // Flush data members to prefs for storage.
  95   void WritePrefs();
  96
  97   // Tests group_ against max_group_.
  98   // When max_group_ is 0, all groups pass.
  99   bool ExceedsMaxGroup() const;
 100
 101   // Tests views_ against max_views_.
 102   // When max_views_ is 0, we don't cap the number of views.
 103   bool ExceedsMaxViews() const;
 104
 105   // Tests |first_view_time_| + |max_seconds_| and -now().
 106   // When either is 0, we don't cap the number of seconds.
 107   bool ExceedsMaxSeconds() const;
 108
 109   PrefService* local_state_;
 110
 111   PromoType promo_type_;
 112   std::string promo_text_;
 113
 114   scoped_ptr<const base::DictionaryValue> promo_payload_;
 115
 116   double start_;
 117   double end_;
 118
 119   int num_groups_;
 120   int initial_segment_;
 121   int increment_;
 122   int time_slice_;
 123   int max_group_;
 124
 125   // When max_views_ is 0, we don't cap the number of views.
 126   int max_views_;
 127
 128   // When max_seconds_ is 0 or not set, we don't cap the number of seconds a
 129   // promo can be visible.
 130   int max_seconds_;
 131
 132   // Set when the promo is viewed for the first time.
 133   double first_view_time_;
 134
 135   int group_;
 136   int views_;
 137   bool closed_;
 138
 139   bool new_notification_;
 140
 141   DISALLOW_COPY_AND_ASSIGN(NotificationPromo);
 142 };
 143
 144 }  // namespace web_resource
 145
 146 #endif  // COMPONENTS_WEB_RESOURCE_NOTIFICATION_PROMO_H_