Update available policies when on configuration file update
[aquarium] / src / main / scala / gr / grnet / aquarium / store / mongodb / MongoDBStore.scala
index c7c008f..16721ed 100644 (file)
@@ -38,14 +38,19 @@ package gr.grnet.aquarium.store.mongodb
 import gr.grnet.aquarium.util.Loggable
 import com.mongodb.util.JSON
 import gr.grnet.aquarium.user.UserState
+import gr.grnet.aquarium.user.UserState.{JsonNames => UserStateJsonNames}
 import gr.grnet.aquarium.util.displayableObjectInfo
 import gr.grnet.aquarium.util.json.JsonSupport
 import collection.mutable.ListBuffer
 import gr.grnet.aquarium.store._
-import gr.grnet.aquarium.logic.events.{WalletEntry, ResourceEvent, AquariumEvent}
-import gr.grnet.aquarium.logic.events.ResourceEvent.JsonNames
+import gr.grnet.aquarium.logic.events.ResourceEvent.{JsonNames => ResourceJsonNames}
+import gr.grnet.aquarium.logic.events.UserEvent.{JsonNames => UserEventJsonNames}
+import gr.grnet.aquarium.logic.events.WalletEntry.{JsonNames => WalletJsonNames}
 import java.util.Date
 import com.ckkloverdos.maybe.Maybe
+import gr.grnet.aquarium.logic.accounting.Policy
+import gr.grnet.aquarium.logic.accounting.dsl.{Timeslot, DSLPolicy, DSLComplexResource}
+import gr.grnet.aquarium.logic.events._
 import com.mongodb._
 
 /**
@@ -59,25 +64,28 @@ class MongoDBStore(
     val database: String,
     val username: String,
     val password: String)
-  extends ResourceEventStore with UserStateStore with WalletEntryStore with Loggable {
-
-  private[store] lazy val rcevents: DBCollection = getCollection(MongoDBStore.RESOURCE_EVENTS_COLLECTION)
-  private[store] lazy val users: DBCollection = getCollection(MongoDBStore.USERS_COLLECTION)
-  private[store] lazy val imevents: DBCollection = getCollection(MongoDBStore.IM_EVENTS_COLLECTION)
-  private[store] lazy val wallets: DBCollection = getCollection(MongoDBStore.IM_WALLETS)
+  extends ResourceEventStore
+  with UserStateStore
+  with WalletEntryStore
+  with UserEventStore
+  with PolicyStore
+  with Loggable {
+
+  private[store] lazy val resourceEvents = getCollection(MongoDBStore.RESOURCE_EVENTS_COLLECTION)
+  private[store] lazy val userStates     = getCollection(MongoDBStore.USER_STATES_COLLECTION)
+  private[store] lazy val userEvents     = getCollection(MongoDBStore.USER_EVENTS_COLLECTION)
+  private[store] lazy val walletEntries  = getCollection(MongoDBStore.WALLET_ENTRIES_COLLECTION)
+  private[store] lazy val policies      = getCollection(MongoDBStore.POLICIES_COLLECTION)
 
   private[this] def getCollection(name: String): DBCollection = {
     val db = mongo.getDB(database)
-    if(!db.authenticate(username, password.toCharArray)) {
+    //logger.debug("Authenticating to mongo")
+    if(!db.isAuthenticated && !db.authenticate(username, password.toCharArray)) {
       throw new StoreException("Could not authenticate user %s".format(username))
     }
     db.getCollection(name)
   }
 
-  /* TODO: Some of the following methods rely on JSON (de-)serialization).
-  * A method based on proper object serialization would be much faster.
-  */
-
   private[this] def _sortByTimestampAsc[A <: AquariumEvent](one: A, two: A): Boolean = {
     if (one.occurredMillis > two.occurredMillis) false
     else if (one.occurredMillis < two.occurredMillis) true
@@ -92,47 +100,98 @@ class MongoDBStore(
 
   //+ResourceEventStore
   def storeResourceEvent(event: ResourceEvent): Maybe[RecordID] =
-    MongoDBStore.storeAquariumEvent(event, rcevents)
+    MongoDBStore.storeAquariumEvent(event, resourceEvents)
 
   def findResourceEventById(id: String): Maybe[ResourceEvent] =
-    MongoDBStore.findById(id, rcevents, MongoDBStore.dbObjectToResourceEvent)
+    MongoDBStore.findById(id, resourceEvents, MongoDBStore.dbObjectToResourceEvent)
 
   def findResourceEventsByUserId(userId: String)
                                 (sortWith: Option[(ResourceEvent, ResourceEvent) => Boolean]): List[ResourceEvent] = {
-    val query = new BasicDBObject(JsonNames.userId, userId)
+    val query = new BasicDBObject(ResourceJsonNames.userId, userId)
 
-    MongoDBStore.runQuery(query, rcevents)(MongoDBStore.dbObjectToResourceEvent)(sortWith)
+    MongoDBStore.runQuery(query, resourceEvents)(MongoDBStore.dbObjectToResourceEvent)(sortWith)
   }
 
   def findResourceEventsByUserIdAfterTimestamp(userId: String, timestamp: Long): List[ResourceEvent] = {
     val query = new BasicDBObject()
-    query.put(JsonNames.userId, userId)
-    query.put(JsonNames.timestamp, new BasicDBObject("$gte", timestamp))
+    query.put(ResourceJsonNames.userId, userId)
+    query.put(ResourceJsonNames.occurredMillis, new BasicDBObject("$gt", timestamp))
     
-    val sort = new BasicDBObject(JsonNames.timestamp, 1)
+    val sort = new BasicDBObject(ResourceJsonNames.occurredMillis, 1)
+
+    val cursor = resourceEvents.find(query).sort(sort)
+
+    try {
+      val buffer = new scala.collection.mutable.ListBuffer[ResourceEvent]
+      while(cursor.hasNext) {
+        buffer += MongoDBStore.dbObjectToResourceEvent(cursor.next())
+      }
+      buffer.toList.sortWith(_sortByTimestampAsc)
+    } finally {
+      cursor.close()
+    }
+  }
+
+  def findResourceEventHistory(userId: String, resName: String,
+                               instid: Option[String], upTo: Long) : List[ResourceEvent] = {
+    val query = new BasicDBObject()
+    query.put(ResourceJsonNames.userId, userId)
+    query.put(ResourceJsonNames.occurredMillis, new BasicDBObject("$lt", upTo))
+    query.put(ResourceJsonNames.resource, resName)
+
+    instid match {
+      case Some(id) =>
+        Policy.policy.findResource(resName) match {
+          case Some(y) => query.put(ResourceJsonNames.details,
+            new BasicDBObject(y.asInstanceOf[DSLComplexResource].descriminatorField, instid.get))
+          case None =>
+        }
+      case None =>
+    }
 
-    val cursor = rcevents.find(query).sort(sort)
+    val sort = new BasicDBObject(ResourceJsonNames.occurredMillis, 1)
+    val cursor = resourceEvents.find(query).sort(sort)
 
     try {
       val buffer = new scala.collection.mutable.ListBuffer[ResourceEvent]
       while(cursor.hasNext) {
         buffer += MongoDBStore.dbObjectToResourceEvent(cursor.next())
       }
-      buffer.toList
+      buffer.toList.sortWith(_sortByTimestampAsc)
     } finally {
       cursor.close()
     }
   }
+
+  def findResourceEventsForReceivedPeriod(userId: String, startTimeMillis: Long, stopTimeMillis: Long): List[ResourceEvent] = {
+    val query = new BasicDBObject()
+    query.put(ResourceJsonNames.userId, userId)
+    query.put(ResourceJsonNames.receivedMillis, new BasicDBObject("$gte", startTimeMillis))
+    query.put(ResourceJsonNames.receivedMillis, new BasicDBObject("$lte", stopTimeMillis))
+
+    // Sort them by increasing order for occurred time
+    val orderBy = new BasicDBObject(ResourceJsonNames.occurredMillis, 1)
+
+    MongoDBStore.runQuery[ResourceEvent](query, resourceEvents, orderBy)(MongoDBStore.dbObjectToResourceEvent)(None)
+  }
+  
+  def countOutOfSyncEventsForBillingMonth(userId: String, yearOfBillingMonth: Int, billingMonth: Int): Maybe[Long] = {
+    Maybe {
+      // FIXME: Implement
+      0L
+    }
+  }
+
   //-ResourceEventStore
 
   //+UserStateStore
   def storeUserState(userState: UserState): Maybe[RecordID] =
-    MongoDBStore.storeUserState(userState, users)
+    MongoDBStore.storeUserState(userState, userStates)
 
   def findUserStateByUserId(userId: String): Maybe[UserState] = {
     Maybe {
-      val query = new BasicDBObject(JsonNames.userId, userId)
-      val cursor = rcevents find query
+      val query = new BasicDBObject(UserStateJsonNames.userId, userId)
+      val cursor = userStates find query
 
       try {
         if(cursor.hasNext)
@@ -144,14 +203,19 @@ class MongoDBStore(
       }
     }
   }
+
+  def deleteUserState(userId: String) = {
+    val query = new BasicDBObject(UserStateJsonNames.userId, userId)
+    userStates.findAndRemove(query)
+  }
   //-UserStateStore
 
   //+WalletEntryStore
   def storeWalletEntry(entry: WalletEntry): Maybe[RecordID] =
-    MongoDBStore.storeAquariumEvent(entry, wallets)
+    MongoDBStore.storeAquariumEvent(entry, walletEntries)
 
   def findWalletEntryById(id: String): Maybe[WalletEntry] =
-    MongoDBStore.findById[WalletEntry](id, wallets, MongoDBStore.dbObjectToWalletEntry)
+    MongoDBStore.findById[WalletEntry](id, walletEntries, MongoDBStore.dbObjectToWalletEntry)
 
   def findUserWalletEntries(userId: String) = {
     // TODO: optimize
@@ -161,19 +225,25 @@ class MongoDBStore(
   def findUserWalletEntriesFromTo(userId: String, from: Date, to: Date) : List[WalletEntry] = {
     val q = new BasicDBObject()
     // TODO: Is this the correct way for an AND query?
-    q.put(JsonNames.timestamp, new BasicDBObject("$gt", from.getTime))
-    q.put(JsonNames.timestamp, new BasicDBObject("$lt", to.getTime))
-    q.put(JsonNames.userId, userId)
+    q.put(WalletJsonNames.occurredMillis, new BasicDBObject("$gt", from.getTime))
+    q.put(WalletJsonNames.occurredMillis, new BasicDBObject("$lt", to.getTime))
+    q.put(WalletJsonNames.userId, userId)
 
-    MongoDBStore.runQuery[WalletEntry](q, wallets)(MongoDBStore.dbObjectToWalletEntry)(Some(_sortByTimestampAsc))
+    MongoDBStore.runQuery[WalletEntry](q, walletEntries)(MongoDBStore.dbObjectToWalletEntry)(Some(_sortByTimestampAsc))
   }
 
+  def findWalletEntriesAfter(userId: String, from: Date) : List[WalletEntry] = {
+    val q = new BasicDBObject()
+    q.put(WalletJsonNames.occurredMillis, new BasicDBObject("$gt", from.getTime))
+    q.put(WalletJsonNames.userId, userId)
+
+    MongoDBStore.runQuery[WalletEntry](q, walletEntries)(MongoDBStore.dbObjectToWalletEntry)(Some(_sortByTimestampAsc))
+  }
 
-  //-WalletEntryStore
   def findLatestUserWalletEntries(userId: String) = {
     Maybe {
-      val orderBy = new BasicDBObject(JsonNames.occurredMillis, -1) // -1 is descending order
-      val cursor = wallets.find().sort(orderBy)
+      val orderBy = new BasicDBObject(WalletJsonNames.occurredMillis, -1) // -1 is descending order
+      val cursor = walletEntries.find().sort(orderBy)
 
       try {
         val buffer = new scala.collection.mutable.ListBuffer[WalletEntry]
@@ -203,15 +273,98 @@ class MongoDBStore(
       }
     }
   }
+
+  def findPreviousEntry(userId: String, resource: String,
+                        instanceId: String,
+                        finalized: Option[Boolean]): List[WalletEntry] = {
+    val q = new BasicDBObject()
+    q.put(WalletJsonNames.userId, userId)
+    q.put(WalletJsonNames.resource, resource)
+    q.put(WalletJsonNames.instanceId, instanceId)
+    finalized match {
+      case Some(x) => q.put(WalletJsonNames.finalized, x)
+      case None =>
+    }
+
+    MongoDBStore.runQuery[WalletEntry](q, walletEntries)(MongoDBStore.dbObjectToWalletEntry)(Some(_sortByTimestampAsc))
+  }
+  //-WalletEntryStore
+
+  //+UserEventStore
+  def storeUserEvent(event: UserEvent): Maybe[RecordID] =
+    MongoDBStore.storeAny[UserEvent](event, userEvents, UserEventJsonNames.userId,
+      _.userId, MongoDBStore.jsonSupportToDBObject)
+
+
+  def findUserEventById(id: String): Maybe[UserEvent] =
+    MongoDBStore.findById[UserEvent](id, userEvents, MongoDBStore.dbObjectToUserEvent)
+
+  def findUserEventsByUserId(userId: String): List[UserEvent] = {
+    val query = new BasicDBObject(UserEventJsonNames.userId, userId)
+    MongoDBStore.runQuery(query, userEvents)(MongoDBStore.dbObjectToUserEvent)(Some(_sortByTimestampAsc))
+  }
+  //-UserEventStore
+
+  //+PolicyStore
+  def loadPolicies(after: Long): List[PolicyEntry] = {
+    val query = new BasicDBObject(PolicyEntry.JsonNames.validFrom,
+      new BasicDBObject("$gt", after))
+    MongoDBStore.runQuery(query, policies)(MongoDBStore.dbObjectToPolicyEvent)(Some(_sortByTimestampAsc))
+  }
+
+  def storePolicy(policy: PolicyEntry): Maybe[RecordID] = MongoDBStore.storeAquariumEvent(policy, policies)
+
+
+  def updatePolicy(policy: PolicyEntry) = {
+    //Find the entry
+    val query = new BasicDBObject(PolicyEntry.JsonNames.id, policy.id)
+    val policyObject = MongoDBStore.jsonSupportToDBObject(policy)
+    policies.update(query, policyObject, true, false)
+  }
+  //-PolicyStore
 }
 
 object MongoDBStore {
+  object JsonNames {
+    final val _id = "_id"
+  }
+
+  /**
+   * Collection holding the [[gr.grnet.aquarium.logic.events.ResourceEvent]]s.
+   *
+   * Resource events are coming from all systems handling billable resources.
+   */
   final val RESOURCE_EVENTS_COLLECTION = "resevents"
-  final val PROCESSED_RESOURCE_EVENTS_COLLECTION = "procresevents"
-  final val USERS_COLLECTION = "users"
-  final val IM_EVENTS_COLLECTION = "imevents"
-  final val IM_WALLETS = "wallets"
 
+  /**
+   * Collection holding the snapshots of [[gr.grnet.aquarium.user.UserState]].
+   *
+   * [[gr.grnet.aquarium.user.UserState]] is held internally within [[gr.grnet.aquarium.user.actor.UserActor]]s.
+   */
+  final val USER_STATES_COLLECTION = "userstates"
+
+  /**
+   * Collection holding [[gr.grnet.aquarium.logic.events.UserEvent]]s.
+   *
+   * User events are coming from the IM module (external).
+   */
+  final val USER_EVENTS_COLLECTION = "userevents"
+
+  /**
+   * Collection holding [[gr.grnet.aquarium.logic.events.WalletEntry]].
+   *
+   * Wallet entries are generated internally in Aquarium.
+   */
+  final val WALLET_ENTRIES_COLLECTION = "wallets"
+
+  /**
+   * Collection holding [[gr.grnet.aquarium.logic.accounting.dsl.DSLPolicy]].
+   */
+  final val POLICIES_COLLECTION = "policies"
+
+  /* TODO: Some of the following methods rely on JSON (de-)serialization).
+  * A method based on proper object serialization would be much faster.
+  */
   def dbObjectToResourceEvent(dbObject: DBObject): ResourceEvent = {
     ResourceEvent.fromJson(JSON.serialize(dbObject))
   }
@@ -224,8 +377,16 @@ object MongoDBStore {
     WalletEntry.fromJson(JSON.serialize(dbObj))
   }
 
+  def dbObjectToUserEvent(dbObj: DBObject): UserEvent = {
+    UserEvent.fromJson(JSON.serialize(dbObj))
+  }
+
+  def dbObjectToPolicyEvent(dbObj: DBObject): PolicyEntry = {
+    PolicyEntry.fromJson(JSON.serialize(dbObj))
+  }
+
   def findById[A >: Null <: AquariumEvent](id: String, collection: DBCollection, deserializer: (DBObject) => A) : Maybe[A] = Maybe {
-    val query = new BasicDBObject(JsonNames.id, id)
+    val query = new BasicDBObject(ResourceJsonNames.id, id)
     val cursor = collection find query
 
     try {
@@ -268,36 +429,37 @@ object MongoDBStore {
   }
 
   def storeAquariumEvent[A <: AquariumEvent](event: A, collection: DBCollection) : Maybe[RecordID] = {
-    storeAny[A](event, collection, JsonNames.id, (e) => e.id, MongoDBStore.jsonSupportToDBObject)
+    storeAny[A](event, collection, ResourceJsonNames.id, (e) => e.id, MongoDBStore.jsonSupportToDBObject)
   }
 
   def storeUserState(userState: UserState, collection: DBCollection): Maybe[RecordID] = {
-    storeAny[UserState](userState, collection, JsonNames.userId, _.userId, MongoDBStore.jsonSupportToDBObject)
+    storeAny[UserState](userState, collection, ResourceJsonNames.userId, _.userId, MongoDBStore.jsonSupportToDBObject)
   }
 
   def storeAny[A](any: A,
                   collection: DBCollection,
                   idName: String,
                   idValueProvider: (A) => String,
-                  serializer: (A) => DBObject) : Maybe[RecordID] = Maybe {
-    // Store
-    val dbObj = serializer apply any
-    val writeResult = collection insert dbObj
-    writeResult.getLastError().throwOnError()
-
-    // Get back to retrieve unique id
-    val cursor = collection.find(new BasicDBObject(idName, idValueProvider(any)))
+                  serializer: (A) => DBObject) : Maybe[RecordID] = {
+    import com.ckkloverdos.maybe.effect
 
-    try {
-      // TODO: better way to get _id?
-      if(cursor.hasNext)
-        RecordID(cursor.next().get(JsonNames._id).toString)
-      else
-        throw new StoreException("Could not store %s to %s".format(any, collection))
-    } finally {
-      cursor.close()
+    Maybe {
+      val dbObj = serializer apply any
+      val writeResult = collection insert dbObj
+      writeResult.getLastError().throwOnError()
+
+      // Get back to retrieve unique id
+      val cursor = collection.find(new BasicDBObject(idName, idValueProvider(any)))
+      cursor
+    } flatMap { cursor ⇒
+      effect {
+        if(cursor.hasNext)
+          RecordID(cursor.next().get(JsonNames._id).toString)
+        else
+          throw new StoreException("Could not store %s to %s".format(any, collection))
+      } {} { cursor.close() }
     }
- }
+  }
 
   def jsonSupportToDBObject(any: JsonSupport): DBObject = {
     JSON.parse(any.toJson) match {