[GCM] Add TTL support

google_apis/gcm/base/mcs_util.cc

 // Copyright 2013 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.
 
 #include "google_apis/gcm/base/mcs_util.h"
 
 #include "base/format_macros.h"
 #include "base/logging.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/stringprintf.h"
+#include "base/time/clock.h"
+#include "base/time/time.h"
 
 namespace gcm {
 
 namespace {
 
 // Type names corresponding to MCSProtoTags. Useful for identifying what type
 // of MCS protobuf is contained within a google::protobuf::MessageLite object.
 // WARNING: must match the order in MCSProtoTag.
 const char* kProtoNames[] = {
   "mcs_proto.HeartbeatPing",
@@ skipping 16 matching lines @@
 COMPILE_ASSERT(arraysize(kProtoNames) == kNumProtoTypes,
                ProtoNamesMustIncludeAllTags);
 
 // TODO(zea): replace these with proper values.
 const char kLoginId[] = "login-1";
 const char kLoginDomain[] = "mcs.android.com";
 const char kLoginDeviceIdPrefix[] = "android-";
 const char kLoginSettingName[] = "new_vc";
 const char kLoginSettingValue[] = "1";
 
+// Maximum amount of time to save an unsent outgoing message for.
+const int kMaxTTLSeconds = 4 * 7 * 24 * 60 * 60;  // 4 weeks.
+
 }  // namespace
 
 scoped_ptr<mcs_proto::LoginRequest> BuildLoginRequest(uint64 auth_id,
                                                       uint64 auth_token) {
   // Create a hex encoded auth id for the device id field.
   std::string auth_id_hex;
   auth_id_hex = base::StringPrintf("%" PRIx64, auth_id);
 
   std::string auth_id_str = base::Uint64ToString(auth_id);
   std::string auth_token_str = base::Uint64ToString(auth_token);
@@ skipping 145 matching lines @@
   }
   // Not all message types have last stream ids. Just return 0.
   return 0;
 }
 
 void SetLastStreamIdReceived(uint32 val,
                              google::protobuf::MessageLite* protobuf) {
   if (protobuf->GetTypeName() == kProtoNames[kIqStanzaTag]) {
     reinterpret_cast<mcs_proto::IqStanza*>(protobuf)->
         set_last_stream_id_received(val);
-     return;
+    return;
   } else if (protobuf->GetTypeName() == kProtoNames[kHeartbeatPingTag]) {
     reinterpret_cast<mcs_proto::HeartbeatPing*>(protobuf)->
         set_last_stream_id_received(val);
-     return;
+    return;
   } else if (protobuf->GetTypeName() == kProtoNames[kHeartbeatAckTag]) {
     reinterpret_cast<mcs_proto::HeartbeatAck*>(protobuf)->
         set_last_stream_id_received(val);
-     return;
+    return;
   } else if (protobuf->GetTypeName() == kProtoNames[kDataMessageStanzaTag]) {
     reinterpret_cast<mcs_proto::DataMessageStanza*>(protobuf)->
         set_last_stream_id_received(val);
-     return;
+    return;
   } else if (protobuf->GetTypeName() == kProtoNames[kLoginResponseTag]) {
     reinterpret_cast<mcs_proto::LoginResponse*>(protobuf)->
         set_last_stream_id_received(val);
-     return;
+    return;
   }
   NOTREACHED();
 }
 
+bool HasTTLExpired(const google::protobuf::MessageLite& protobuf,
+                   base::Clock* clock) {
+  if (protobuf.GetTypeName() != kProtoNames[kDataMessageStanzaTag])
+    return false;
+  uint64 ttl = GetTTL(protobuf);
+  uint64 sent =
+      reinterpret_cast<const mcs_proto::DataMessageStanza*>(&protobuf)->sent();
+  return ttl > 0 &&
+      clock->Now() >
+          base::Time::FromInternalValue(
+              (sent + ttl) * base::Time::kMicrosecondsPerSecond);
+}
+
+int GetTTL(const google::protobuf::MessageLite& protobuf) {
+  if (protobuf.GetTypeName() != kProtoNames[kDataMessageStanzaTag])
+    return 0;
+  const mcs_proto::DataMessageStanza* data_message =
+      reinterpret_cast<const mcs_proto::DataMessageStanza*>(&protobuf);
+  if (!data_message->has_ttl())
+    return kMaxTTLSeconds;
+  return data_message->ttl() <= kMaxTTLSeconds ?
+      data_message->ttl() : kMaxTTLSeconds;

[fgorski, 2014/01/02 21:47:35]

I think sanitizing of the input is expected to happen in the layer above so
DCHECK for > kMaxTTLSeconds would work here.

Missing TTL is a perfectly valid scenario. TTL too large is an error.

Will you send the protobuf knowing that TTL is too large? Will that be accepted
by MCS?

[Nicolas Zea, 2014/01/02 21:50:52]

Yeah, I guess this implies it's valid, when it shouldn't be. I'll just change it
to a DCHECK.

+}
+
 }  // namespace gcm