io.gatling.http.cache.ExpiresSupport.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gatling-http Show documentation
gatling-http
There is a newer version: 3.13.1
/*
 * Copyright 2011-2019 GatlingCorp (https://gatling.io)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.gatling.http.cache

import io.gatling.commons.util.Clock
import io.gatling.commons.util.NumberHelper._
import io.gatling.http.{ HeaderNames, HeaderValues }
import io.gatling.http.response.Response

import io.netty.handler.codec.DateFormatter

private[cache] trait ExpiresSupport {

  def clock: Clock

  private val MaxAgePrefix = "max-age="
  private val MaxAgeZero = MaxAgePrefix + "0"

  def extractMaxAgeValue(s: String): Option[Long] = {
    val index = s.indexOf(MaxAgePrefix)
    val start = MaxAgePrefix.length + index
    if (index >= 0 && start <= s.length)
      s.charAt(start) match {
        case '-'            => Some(-1)
        case c if c.isDigit => Some(extractLongValue(s, start))
        case _              => None
      }
    else
      None
  }

  def extractExpiresValue(timestring: String): Option[Long] = {

    def removeQuote(s: String) =
      if (!s.isEmpty) {
        var start = 0
        var end = s.length

        if (s.charAt(0) == '"')
          start += 1

        if (s.charAt(s.length() - 1) == '"')
          end -= 1

        s.substring(start, end)
      } else
        s

    // FIXME use offset instead of 2 substrings
    val trimmedTimeString = removeQuote(timestring.trim)

    Option(DateFormatter.parseHttpDate(trimmedTimeString)).map(_.getTime)
  }

  def getResponseExpires(response: Response): Option[Long] = {
    def pragmaNoCache = response.header(HeaderNames.Pragma).exists(_.contains(HeaderValues.NoCache))
    def cacheControlNoCache = response.header(HeaderNames.CacheControl)
      .exists(h => h.contains(HeaderValues.NoCache) || h.contains(HeaderValues.NoStore) || h.contains(MaxAgeZero))
    def maxAgeAsExpiresValue = response.header(HeaderNames.CacheControl).flatMap(extractMaxAgeValue).map { maxAge =>
      if (maxAge < 0)
        maxAge
      else
        maxAge * 1000 + clock.nowMillis
    }
    def expiresValue = response.header(HeaderNames.Expires).flatMap(extractExpiresValue).filter(_ > clock.nowMillis)

    if (pragmaNoCache || cacheControlNoCache) {
      None
    } else {
      // If a response includes both an Expires header and a max-age directive, the max-age directive overrides the Expires header,
      // even if the Expires header is more restrictive. (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.3)
      maxAgeAsExpiresValue.orElse(expiresValue).filter(_ > 0)
    }
  }
}