code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/user/UserState.scala

   1 /*
   2  * Copyright 2011 GRNET S.A. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or
   5  * without modification, are permitted provided that the following
   6  * conditions are met:
   7  *
   8  *   1. Redistributions of source code must retain the above
   9  *      copyright notice, this list of conditions and the following
  10  *      disclaimer.
  11  *
  12  *   2. Redistributions in binary form must reproduce the above
  13  *      copyright notice, this list of conditions and the following
  14  *      disclaimer in the documentation and/or other materials
  15  *      provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
  18  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
  21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  24  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  27  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  * The views and conclusions contained in the software and
  31  * documentation are those of the authors and should not be
  32  * interpreted as representing official policies, either expressed
  33  * or implied, of GRNET S.A.
  34  */
  35
  36 package gr.grnet.aquarium.user
  37
  38 import gr.grnet.aquarium.util.json.{JsonHelpers, JsonSupport}
  39 import net.liftweb.json.{parse => parseJson, JsonAST, Xml}
  40 import gr.grnet.aquarium.logic.accounting.dsl.DSLAgreement
  41 import com.ckkloverdos.maybe.{Failed, Just, Maybe}
  42 import gr.grnet.aquarium.logic.accounting.Policy
  43
  44
  45 /**
  46  * A comprehensive representation of the User's state.
  47  *
  48  * Note that it is made of autonomous parts that are actually data snapshots.
  49  *
  50  * The different snapshots need not agree on the snapshot time, ie. some state
  51  * part may be stale, while other may be fresh.
  52  *
  53  * The user state is meant to be partially updated according to relevant events landing on Aquarium.
  54  *
  55  * @author Christos KK Loverdos <loverdos@gmail.com>
  56  */
  57
  58 case class UserState(
  59     userId: String,
  60
  61     /**
  62      * When the user was created in the system (not Aquarium). We use this as a basis for billing periods. Set to
  63      * zero if unknown.
  64      */
  65     startDateMillis: Long,
  66
  67     /**
  68      * Each time the user state is updated, this must be increased.
  69      * The counter is used when accessing user state from the cache (user state store)
  70      * in order to get the latest value for a particular billing period.
  71      */
  72     stateChangeCounter: Long,
  73
  74     /**
  75      * True iff this user state refers to a full billing period, that is a full billing month.
  76      */
  77     isFullBillingPeriod: Boolean,
  78
  79     /**
  80      * The full billing period for which this user state refers to.
  81      * This is set when the user state refers to a full billing period (= month)
  82      * and is used to cache the user state for subsequent queries.
  83      */
  84     fullBillingPeriod: BillingPeriod,
  85
  86     /**
  87      * Counts the number of resource events used to produce this user state for
  88      * the billing period recorded by `billingPeriodSnapshot`
  89      */
  90     resourceEventsCounter: Long,
  91
  92     active: ActiveSuspendedSnapshot,
  93     credits: CreditSnapshot,
  94     agreements: AgreementSnapshot,
  95     roles: RolesSnapshot,
  96     paymentOrders: PaymentOrdersSnapshot,
  97     ownedGroups: OwnedGroupsSnapshot,
  98     groupMemberships: GroupMembershipsSnapshot,
  99     ownedResources: OwnedResourcesSnapshot
 100 ) extends JsonSupport {
 101
 102   private[this] def _allSnapshots: List[Long] = {
 103     List(
 104       active.snapshotTime,
 105       credits.snapshotTime, agreements.snapshotTime, roles.snapshotTime,
 106       paymentOrders.snapshotTime, ownedGroups.snapshotTime, groupMemberships.snapshotTime,
 107       ownedResources.snapshotTime)
 108   }
 109
 110   def oldestSnapshotTime: Long = _allSnapshots min
 111
 112   def newestSnapshotTime: Long  = _allSnapshots max
 113
 114   def maybeDSLAgreement(at: Long): Maybe[DSLAgreement] = {
 115     agreements match {
 116       case snapshot @ AgreementSnapshot(data, _) ⇒
 117         snapshot.getAgreement(at)
 118       case _ ⇒
 119        Failed(new Exception("No agreement snapshot found for user %s".format(userId)))
 120     }
 121   }
 122
 123   def findResourceInstanceSnapshot(resource: String, instanceId: String): Maybe[ResourceInstanceSnapshot] = {
 124     ownedResources.findResourceInstanceSnapshot(resource, instanceId)
 125   }
 126
 127   def getResourceInstanceAmount(resource: String, instanceId: String, defaultValue: Double): Double = {
 128     ownedResources.getResourceInstanceAmount(resource, instanceId, defaultValue)
 129   }
 130
 131   def copyForResourcesSnapshotUpdate(resource: String,   // resource name
 132                                      instanceId: String, // resource instance id
 133                                      newAmount: Double,
 134                                      snapshotTime: Long): UserState = {
 135
 136     val (newResources, _, _) = ownedResources.computeResourcesSnapshotUpdate(resource, instanceId, newAmount, snapshotTime)
 137
 138     this.copy(
 139       ownedResources = newResources,
 140       stateChangeCounter = this.stateChangeCounter + 1)
 141   }
 142
 143   def resourcesMap = ownedResources.toResourcesMap
 144
 145   def safeCredits = credits match {
 146     case c @ CreditSnapshot(_, _) ⇒ c
 147     case _ ⇒ CreditSnapshot(0.0, 0)
 148   }
 149 }
 150
 151
 152 object UserState {
 153   def fromJson(json: String): UserState = {
 154     JsonHelpers.jsonToObject[UserState](json)
 155   }
 156
 157   def fromJValue(jsonAST: JsonAST.JValue): UserState = {
 158     JsonHelpers.jValueToObject[UserState](jsonAST)
 159   }
 160
 161   def fromBytes(bytes: Array[Byte]): UserState = {
 162     JsonHelpers.jsonBytesToObject[UserState](bytes)
 163   }
 164
 165   def fromXml(xml: String): UserState = {
 166     fromJValue(Xml.toJson(scala.xml.XML.loadString(xml)))
 167   }
 168
 169   object JsonNames {
 170     final val _id = "_id"
 171     final val userId = "userId"
 172   }
 173 }
 174
 175 case class BillingPeriod(startMillis: Long, stopMillis: Long)