1 /*
2  *  Make.org Core API
3  *  Copyright (C) 2018 Make.org
4  *
5  * This program is free software: you can redistribute it and/or modify
6  *  it under the terms of the GNU Affero General Public License as
7  *  published by the Free Software Foundation, either version 3 of the
8  *  License, or (at your option) any later version.
9  *
10  *  This program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU Affero General Public License for more details.
14  *
15  *  You should have received a copy of the GNU Affero General Public License
16  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
17  *
18  */
19 
20 package org.make.core.user
21 
22 import com.sksamuel.elastic4s.ElasticApi
23 import com.sksamuel.elastic4s.requests.script.Script
24 import com.sksamuel.elastic4s.requests.searches.SearchRequest
25 import com.sksamuel.elastic4s.requests.searches.queries.Query
26 import com.sksamuel.elastic4s.requests.searches.sort.{ScriptSort, ScriptSortType, SortOrder}
27 import org.make.core.question.QuestionId
28 import org.make.core.user.indexed.OrganisationElasticsearchFieldNames
29 import enumeratum.values.StringEnum
30 import enumeratum.values.StringEnumEntry
31 
32 sealed trait OrganisationSortAlgorithm {
33   def sortDefinition(request: SearchRequest): SearchRequest
34 }
35 
36 /*
37  * This algorithm sorts organisations by their participation.
38  * - +1 point per proposal
39  * - +1 point per vote
40  */
41 final case class ParticipationAlgorithm(questionId: QuestionId) extends OrganisationSortAlgorithm {
42 
43   override def sortDefinition(request: SearchRequest): SearchRequest = {
44     val query: Query = request.query.getOrElse(ElasticApi.boolQuery())
45     request
46       .query(
47         ElasticApi
48           .must(
49             query,
50             ElasticApi
51               .nestedQuery(
52                 path = OrganisationElasticsearchFieldNames.countsByQuestion,
53                 query = ElasticApi.must(
54                   ElasticApi
55                     .termQuery(OrganisationElasticsearchFieldNames.countsByQuestionQuestionId, questionId.value),
56                   ElasticApi.scriptQuery(
57                     Script(
58                       "doc['countsByQuestion.proposalsCount'].value + doc['countsByQuestion.votesCount'].value > 0"
59                     )
60                   )
61                 )
62               )
63           )
64       )
65       .sortBy(
66         ScriptSort(
67           script = Script("doc['proposalsCount'].value + doc['votesCount'].value"),
68           scriptSortType = ScriptSortType.NUMBER,
69           order = Some(SortOrder.DESC),
70           nestedFilter = Some(
71             ElasticApi
72               .nestedQuery(
73                 path = OrganisationElasticsearchFieldNames.countsByQuestion,
74                 query =
75                   ElasticApi.termQuery(OrganisationElasticsearchFieldNames.countsByQuestionQuestionId, questionId.value)
76               )
77           )
78         )
79       )
80 
81   }
82 }
83 
84 object ParticipationAlgorithm {
85   val shortName: String = "participation"
86 }
87 
88 sealed abstract class OrganisationAlgorithmSelector(val value: String)
89     extends StringEnumEntry
90     with Product
91     with Serializable {
92   def select(questionId: Option[QuestionId]): Option[OrganisationSortAlgorithm]
93 }
94 
95 object OrganisationAlgorithmSelector extends StringEnum[OrganisationAlgorithmSelector] {
96 
97   case object participation extends OrganisationAlgorithmSelector("participation") {
98     override def select(questionId: Option[QuestionId]): Option[OrganisationSortAlgorithm] =
99       questionId.map(ParticipationAlgorithm(_))
100   }
101 
102   override val values: IndexedSeq[OrganisationAlgorithmSelector] = findValues
103   final val swaggerAllowableValues = "participation"
104   final val sortAlgorithmsName: Seq[String] = Seq(ParticipationAlgorithm.shortName)
105 }