summaryrefslogtreecommitdiffstats
path: root/container-core/src/main/scala/com/yahoo/container/http/filter/FilterChainRepository.scala
blob: 83ca170739039b3037f127eb7f1e9e2a23332c43 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
// Copyright 2016 Yahoo Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.container.http.filter

import com.yahoo.container.core.ChainsConfig
import com.yahoo.component.provider.ComponentRegistry
import com.yahoo.jdisc.http.filter.chain.{RequestFilterChain, ResponseFilterChain}
import com.yahoo.jdisc.http.filter.{RequestFilter, ResponseFilter}
import com.yahoo.jdisc.http.filter.{SecurityResponseFilterChain, SecurityRequestFilterChain, SecurityResponseFilter, SecurityRequestFilter}
import com.yahoo.component.{ComponentSpecification, ComponentId, AbstractComponent}
import com.yahoo.component.chain.model.ChainsModelBuilder
import com.yahoo.component.chain.{Chain, ChainedComponent, ChainsConfigurer}
import com.yahoo.processing.execution.chain.ChainRegistry
import FilterChainRepository._
import scala.collection.JavaConversions._


/**
 * Creates JDisc request/response filter chains.
 * @author tonytv
 */
class FilterChainRepository(chainsConfig: ChainsConfig,
                            requestFilters: ComponentRegistry[RequestFilter],
                            responseFilters: ComponentRegistry[ResponseFilter],
                            securityRequestFilters: ComponentRegistry[SecurityRequestFilter],
                            securityResponseFilters: ComponentRegistry[SecurityResponseFilter]) extends AbstractComponent {

  private val filtersAndChains = new ComponentRegistry[AnyRef]
  addAllFilters(filtersAndChains, requestFilters, responseFilters, securityRequestFilters, securityResponseFilters)
  addAllChains(filtersAndChains, chainsConfig, requestFilters, responseFilters, securityRequestFilters, securityResponseFilters)
  filtersAndChains.freeze()

  def getFilter(componentSpecification: ComponentSpecification) =
    filtersAndChains.getComponent(componentSpecification)
}

 private[filter] object FilterChainRepository {
  case class FilterWrapper(id: ComponentId, filter: AnyRef) extends ChainedComponent(id) {
    def filterType: Class[_] = filter match {
      case f: RequestFilter  => classOf[RequestFilter]
      case f: ResponseFilter => classOf[ResponseFilter]
      case f: SecurityRequestFilter  => classOf[SecurityRequestFilter]
      case f: SecurityResponseFilter => classOf[SecurityResponseFilter]
      case _ => throw new IllegalArgumentException("Unsupported filter type: " + filter.getClass.getName)
    }
  }

  def allFiltersWrapped(registries: ComponentRegistry[_ <: AnyRef]*): ComponentRegistry[FilterWrapper] = {
    val wrappedFilters = new ComponentRegistry[FilterWrapper]

    def registerWrappedFilters(registry: ComponentRegistry[_ <: AnyRef]) {
      for ((id, filter) <- registry.allComponentsById())
        wrappedFilters.register(id, new FilterWrapper(id, filter))
    }

    registries.foreach(registerWrappedFilters)
    wrappedFilters.freeze()
    wrappedFilters
  }

  private def addAllFilters(destination: ComponentRegistry[AnyRef], registries: ComponentRegistry[_ <: AnyRef]*) {
    def wrapSecurityFilter(filter: AnyRef) = {
      if (isSecurityFilter(filter)) createSecurityChain(List(filter))
      else filter
    }

    for {
      registry <- registries
      (id, filter) <- registry.allComponentsById()
    } destination.register(id, wrapSecurityFilter(filter))
  }

  private def addAllChains(destination: ComponentRegistry[AnyRef], chainsConfig: ChainsConfig, filters: ComponentRegistry[_ <: AnyRef]*) {
    val chainRegistry = buildChainsRegistry(chainsConfig, filters)

    for (chain <- chainRegistry.allComponents()) {
      destination.register(chain.getId, toJDiscChain(chain))
    }
  }


  def buildChainsRegistry(chainsConfig: ChainsConfig, filters: Seq[ComponentRegistry[_ <: AnyRef]]) = {
    val chainRegistry = new ChainRegistry[FilterWrapper]
    val chainsModel = ChainsModelBuilder.buildFromConfig(chainsConfig)

    ChainsConfigurer.prepareChainRegistry(chainRegistry, chainsModel, allFiltersWrapped(filters: _*))
    chainRegistry.freeze()
    chainRegistry
  }

  private def toJDiscChain(chain: Chain[FilterWrapper]): AnyRef = {
    checkFilterTypesCompatible(chain)
    val jDiscFilters = chain.components() map {_.filter}

    wrapJDiscChain(wrapSecurityFilters(jDiscFilters.toList))
  }

  def wrapJDiscChain(filters: List[AnyRef]): AnyRef = {
    if (filters.size == 1) filters.head
    else {
      filters.head match {
        case _: RequestFilter  => RequestFilterChain.newInstance(filters.asInstanceOf[List[RequestFilter]])
        case _: ResponseFilter => ResponseFilterChain.newInstance(filters.asInstanceOf[List[ResponseFilter]])
      }
    }
  }

  def wrapSecurityFilters(filters: List[AnyRef]): List[AnyRef] = {
    if (filters.isEmpty) List()
    else {
      val (securityFilters, rest) = filters.span(isSecurityFilter)
      if (securityFilters.isEmpty) {
        val (regularFilters, rest) = filters.span(!isSecurityFilter(_))
        regularFilters ++ wrapSecurityFilters(rest)
      } else {
        createSecurityChain(securityFilters) :: wrapSecurityFilters(rest)
      }
    }
  }

  def createSecurityChain(filters: List[AnyRef]): AnyRef = {
    filters.head match {
      case _: SecurityRequestFilter  => SecurityRequestFilterChain.newInstance(filters.asInstanceOf[List[SecurityRequestFilter]])
      case _: SecurityResponseFilter => SecurityResponseFilterChain.newInstance(filters.asInstanceOf[List[SecurityResponseFilter]])
      case _ => throw new IllegalArgumentException("Unexpected class " + filters.head.getClass)
    }
  }

  def isSecurityFilter(filter: AnyRef) = {
    filter match {
      case _: SecurityRequestFilter => true
      case _: SecurityResponseFilter => true
      case _ => false
    }
  }

  def checkFilterTypesCompatible(chain: Chain[FilterWrapper]) {
    val requestFilters  = Set[Class[_]](classOf[RequestFilter], classOf[SecurityRequestFilter])
    val responseFilters = Set[Class[_]](classOf[ResponseFilter], classOf[SecurityResponseFilter])

    def check(a: FilterWrapper, b: FilterWrapper) {
      if (requestFilters(a.filterType) && responseFilters(b.filterType))
        throw new RuntimeException("Can't mix request and response filters in chain %s: %s, %s".format(chain.getId, a.getId, b.getId))
    }

    overlappingPairIterator(chain.components).foreach {
      case Seq(_) =>
      case Seq(filter1: FilterWrapper, filter2: FilterWrapper) =>
        check(filter1, filter2)
        check(filter2, filter1)
    }
  }

  def overlappingPairIterator[T](s: Seq[T]) = s.iterator.sliding(2, 1)
}