code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/logic/accounting/Policy.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.logic.accounting
  37
  38 import dsl.{Timeslot, DSLPolicy, DSL}
  39 import gr.grnet.aquarium.Configurator._
  40 import java.io.{InputStream, FileInputStream, File}
  41 import java.util.Date
  42 import gr.grnet.aquarium.util.date.TimeHelpers
  43 import gr.grnet.aquarium.util.Loggable
  44 import java.util.concurrent.atomic.AtomicReference
  45 import gr.grnet.aquarium.Configurator
  46 import gr.grnet.aquarium.Configurator.Keys
  47 import com.ckkloverdos.maybe.{Failed, NoVal, Just}
  48 import collection.immutable.{TreeMap, SortedMap}
  49
  50 /**
  51  * Searches for and loads the applicable accounting policy
  52  *
  53  * @author Georgios Gousios <gousiosg@gmail.com>
  54  */
  55 object Policy extends DSL with Loggable {
  56
  57   /* Pointer to the latest policy */
  58   private[logic] lazy val policies = {
  59     new AtomicReference[SortedMap[Timeslot, DSLPolicy]](reloadPolicies)
  60   }
  61
  62   /* Pointer to the latest policy */
  63   private lazy val currentPolicy = {new AtomicReference[DSLPolicy](latestPolicy)}
  64
  65   /* Configurator to use for loading information about the policy store */
  66   private var config: Configurator = _
  67
  68   /**
  69    * Get the latest defined policy.
  70    */
  71   def policy = currentPolicy.get
  72
  73   /**
  74    * Get the policy that is valid at the specified time instance.
  75    */
  76   def policy(at: Date): DSLPolicy = {
  77     policies.get.find {
  78       a => (a._1.from.before(at) && a._1.to.after(at)) ||
  79            (a._1.from.before(at) && a._1.to == Long.MaxValue)
  80     } match {
  81       case Some(x) => x._2
  82       case None =>
  83         throw new AccountingException("No valid policy for date: %s".format(at))
  84     }
  85   }
  86
  87   /**
  88    * Get the policies that are valid between the specified time instances,
  89    * in a map whose keys are sorted by time.
  90    */
  91   def policies(from: Date, to: Date): SortedMap[Timeslot, DSLPolicy] = {
  92     policies.get.filter {
  93       a => a._1.from.before(from) &&
  94            a._1.to.after(to)
  95     }
  96   }
  97
  98   /**
  99    * Get the policies that are valid throughout the specified
 100    * [[gr.grnet.aquarium.logic.accounting.dsl.Timeslot]]
 101    */
 102   def policies(t: Timeslot): SortedMap[Timeslot, DSLPolicy] = policies(t.from, t.to)
 103
 104   /**
 105    * Load and parse a policy from file.
 106    */
 107   def loadPolicyFromFile(pol: File): DSLPolicy = {
 108
 109     val stream = pol.exists() match {
 110       case true =>
 111         logger.info("Using policy file %s".format(pol.getAbsolutePath))
 112         new FileInputStream(pol)
 113       case false =>
 114         logger.warn(("Cannot find user configured policy file %s, " +
 115           "looking for default policy").format(pol.getAbsolutePath))
 116         getClass.getClassLoader.getResourceAsStream("policy.yaml") match {
 117           case x: InputStream =>
 118             logger.warn("Using default policy, this is problably not what you want")
 119             x
 120           case null =>
 121             logger.error("No valid policy file found, Aquarium will fail")
 122             null
 123         }
 124     }
 125     parse(stream)
 126   }
 127
 128   /**
 129    * Trigger a policy update cycle.
 130    */
 131   def updatePolicies = synchronized {
 132     //XXX: The following update should happen as one transaction
 133     val tmpPol = reloadPolicies
 134     currentPolicy.set(latestPolicy)
 135     policies.set(tmpPol)
 136   }
 137
 138   /**
 139    * Find the latest policy in the list of policies.
 140    */
 141   private def latestPolicy =
 142     policies.get.foldLeft((Timeslot(new Date(1), new Date(2)) -> DSLPolicy.emptyPolicy)) {
 143       (acc, p) =>
 144         if (acc._2 == DSLPolicy.emptyPolicy)
 145           p
 146         else if (p._1.after(acc._1))
 147           p
 148         else
 149           acc
 150     }._2
 151
 152   /**
 153    * Set the configurator to use for loading policy stores. Should only
 154    * used for unit testing.
 155    */
 156   def withConfigurator(config: Configurator): Unit =
 157     this.config = config
 158
 159   /**
 160    * Check whether the policy definition file (in whichever path) is
 161    * newer than the latest stored policy, reload and set it as current.
 162    * This method has side-effects to this object's state.
 163    */
 164   private[logic] def reloadPolicies: SortedMap[Timeslot, DSLPolicy] =
 165     if (config == null)
 166       reloadPolicies(MasterConfigurator)
 167     else
 168       reloadPolicies(config)
 169
 170   private def reloadPolicies(config: Configurator):
 171   SortedMap[Timeslot, DSLPolicy] = {
 172     //1. Load policies from db
 173     val pol = config.policyStore.loadPolicyEntriesAfter(0)
 174
 175     //2. Check whether policy file has been updated
 176     val latestPolicyChange = if (pol.isEmpty) 0 else pol.last.validFrom
 177     val policyf = MasterConfigurator.findConfigFile(PolicyConfName, Keys.aquarium_policy, PolicyConfName)
 178     var updated = false
 179
 180     if (policyf.exists) {
 181       if (policyf.lastModified > latestPolicyChange) {
 182         logger.info("Policy file updated since last check, reloading")
 183         updated = true
 184       } else {
 185         logger.info("Policy file not changed since last check")
 186       }
 187     } else {
 188       logger.warn("User specified policy file %s does not exist, " +
 189         "using stored policy information".format(policyf.getAbsolutePath))
 190     }
 191
 192     if (updated) {
 193       val ts = TimeHelpers.nowMillis
 194       val parsedNew = loadPolicyFromFile(policyf)
 195       val newPolicy = parsedNew.toPolicyEntry.copy(occurredMillis = ts,
 196         receivedMillis = ts, validFrom = ts)
 197
 198       config.policyStore.findPolicyEntry(newPolicy.id) match {
 199         case Just(x) =>
 200           logger.warn("Policy file contents not modified")
 201         case NoVal =>
 202           if (!pol.isEmpty) {
 203             val toUpdate = pol.last.copy(validTo = ts - 1)
 204             config.policyStore.updatePolicyEntry(toUpdate)
 205             config.policyStore.storePolicyEntry(newPolicy)
 206           } else {
 207             config.policyStore.storePolicyEntry(newPolicy)
 208           }
 209         case Failed(e, expl) =>
 210           throw e
 211       }
 212     }
 213
 214     config.policyStore.loadPolicyEntriesAfter(0).foldLeft(new TreeMap[Timeslot, DSLPolicy]()){
 215       (acc, p) =>
 216         acc ++ Map(Timeslot(p.validFrom, p.validTo) -> parse(p.policyYAML))
 217     }
 218   }
 219 }