Remove unused code
[aquarium] / src / main / scala / gr / grnet / aquarium / actor / service / user / UserActor.scala
1 /*
2  * Copyright 2011-2012 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.actor
37 package service
38 package user
39
40 import gr.grnet.aquarium.actor._
41 import gr.grnet.aquarium.user._
42
43 import gr.grnet.aquarium.util.shortClassNameOf
44 import gr.grnet.aquarium.util.chainOfCauses
45 import gr.grnet.aquarium.util.date.TimeHelpers
46 import gr.grnet.aquarium.actor.message.service.router._
47 import message.config.{ActorProviderConfigured, AquariumPropertiesLoaded}
48 import gr.grnet.aquarium.event.im.IMEventModel
49 import akka.config.Supervision.Temporary
50 import akka.actor.PoisonPill
51 import gr.grnet.aquarium.{AquariumException, Configurator}
52
53
54 /**
55  *
56  * @author Christos KK Loverdos <loverdos@gmail.com>
57  */
58
59 class UserActor extends ReflectiveRoleableActor {
60   private[this] var _userID: String = _
61   private[this] var _userState: UserState = _
62
63   self.lifeCycle = Temporary
64
65   private[this] def _shutmedown(): Unit = {
66     if(_haveFullState) {
67       UserActorCache.invalidate(this._userID)
68     }
69
70     self ! PoisonPill
71   }
72
73   override protected def onThrowable(t: Throwable, message: AnyRef) = {
74     ERROR("Oops!\n", chainOfCauses(t).map("!! " + _) mkString "\n")
75     ERROR(t, "Terminating due to: %s(%s)", shortClassNameOf(t), t.getMessage)
76
77     _shutmedown()
78   }
79
80   def role = UserActorRole
81
82   private[this] def _configurator: Configurator = Configurator.MasterConfigurator
83 //  private[this] def _userId = _userState.userId
84
85   private[this] def _timestampTheshold =
86     _configurator.props.getLong(Configurator.Keys.user_state_timestamp_threshold).getOr(10000)
87
88
89   private[this] def _haveFullState = {
90     (this._userID ne null) && (this._userState ne null)
91   }
92
93   def onAquariumPropertiesLoaded(event: AquariumPropertiesLoaded): Unit = {
94   }
95
96   def onActorProviderConfigured(event: ActorProviderConfigured): Unit = {
97   }
98
99   private[this] def _computeAgreementForNewUser(imEvent: IMEventModel): String = {
100     // FIXME: Implement based on the role
101     "default"
102   }
103
104   private[this] def processCreateUser(imEvent: IMEventModel): Unit = {
105     val userID = imEvent.userID
106     this._userID = userID
107
108     val store = _configurator.storeProvider.userStateStore
109     // try find user state. normally should ot exist
110     val latestUserStateOpt = store.findLatestUserStateByUserID(userID)
111     if(latestUserStateOpt.isDefined) {
112       logger.error("Got %s(%s, %s) but user already exists. Ingoring".format(
113         userID,
114         shortClassNameOf(imEvent),
115         imEvent.eventType))
116
117       return
118     }
119
120     val initialAgreementName = _computeAgreementForNewUser(imEvent)
121     val newUserState    = DefaultUserStateComputations.createInitialUserState(
122       userID,
123       imEvent.occurredMillis,
124       imEvent.isActive,
125       0.0,
126       List(imEvent.role),
127       initialAgreementName)
128
129     this._userState = newUserState
130
131     // FIXME: If this fails, then the actor must be shut down.
132     store.insertUserState(newUserState)
133   }
134
135   private[this] def processModifyUser(imEvent: IMEventModel): Unit = {
136     val now = TimeHelpers.nowMillis()
137
138     if(!_haveFullState) {
139       ERROR("Got %s(%s) but have no state. Shutting down", shortClassNameOf(imEvent), imEvent.eventType)
140       _shutmedown()
141       return
142     }
143
144     this._userState = this._userState.modifyFromIMEvent(imEvent, now)
145   }
146
147   def onProcessSetUserID(event: ProcessSetUserID): Unit = {
148     this._userID = event.userID
149   }
150
151   def onProcessIMEvent(event: ProcessIMEvent): Unit = {
152     val imEvent = event.imEvent
153     if(imEvent.isCreateUser) {
154       processCreateUser(imEvent)
155     } else if(imEvent.isModifyUser) {
156       processModifyUser(imEvent)
157     } else {
158       throw new AquariumException("Cannot interpret %s".format(imEvent))
159     }
160   }
161
162   def onRequestUserBalance(event: RequestUserBalance): Unit = {
163     val userId = event.userID
164     // FIXME: Implement threshold
165     self reply UserResponseGetBalance(userId, _userState.creditsSnapshot.creditAmount)
166   }
167
168   def onUserRequestGetState(event: UserRequestGetState): Unit = {
169     val userId = event.userID
170    // FIXME: implement
171     self reply UserResponseGetState(userId, this._userState)
172   }
173
174   def onProcessResourceEvent(event: ProcessResourceEvent): Unit = {
175   }
176
177
178   private[this] def D_userID = {
179     if(this._userID eq null)
180       "<NOT INITIALIZED>" // We always get a userID first
181     else
182       if(this._userState eq null)
183         "%s, NO STATE".format(this._userID)
184       else
185         "%s".format(this._userID)
186   }
187
188   private[this] def DEBUG(fmt: String, args: Any*) =
189     logger.debug("UserActor[%s]: %s".format(D_userID, fmt.format(args: _*)))
190
191   private[this] def INFO(fmt: String, args: Any*) =
192     logger.info("UserActor[%s]: %s".format(D_userID, fmt.format(args: _*)))
193
194   private[this] def WARN(fmt: String, args: Any*) =
195     logger.warn("UserActor[%s]: %s".format(D_userID, fmt.format(args: _*)))
196
197   private[this] def ERROR(fmt: String, args: Any*) =
198     logger.error("UserActor[%s]: %s".format(D_userID, fmt.format(args: _*)))
199
200   private[this] def ERROR(t: Throwable, fmt: String, args: Any*) =
201       logger.error("UserActor[%s]: %s".format(D_userID, fmt.format(args: _*)), t)
202 }