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.operation.indexed
21 
22 import cats.Show
23 
24 import java.time.ZonedDateTime
25 import cats.data.NonEmptyList
26 import enumeratum.values.StringEnum
27 import eu.timepit.refined.api.Refined
28 import eu.timepit.refined.collection._
29 import io.circe.generic.semiauto._
30 import io.circe.refined._
31 import io.circe.Codec
32 import io.swagger.annotations.ApiModelProperty
33 import org.make.core.elasticsearch.ElasticsearchFieldName
34 import org.make.core.CirceFormatters
35 import org.make.core.operation.{OperationId, OperationOfQuestion, QuestionTheme, ResultsLink, SimpleOperation}
36 import org.make.core.question.{Question, QuestionId}
37 import org.make.core.reference.{Country, Language}
38 import org.make.core.technical.Multilingual
39 
40 import scala.annotation.meta.field
41 
42 sealed abstract class OperationOfQuestionElasticsearchFieldName(val value: String, val sortable: Boolean = false)
43     extends ElasticsearchFieldName
44 
45 object OperationOfQuestionElasticsearchFieldName extends StringEnum[OperationOfQuestionElasticsearchFieldName] {
46 
47   sealed abstract class Simple(val field: String, override val sortable: Boolean = false)
48       extends OperationOfQuestionElasticsearchFieldName(field, sortable) {
49     override def parameter: String = field
50   }
51 
52   sealed abstract class Alias(
53     val parameter: String,
54     aliased: OperationOfQuestionElasticsearchFieldName,
55     override val sortable: Boolean = false
56   ) extends OperationOfQuestionElasticsearchFieldName(parameter, sortable) {
57     override def field: String = aliased.field
58   }
59 
60   case object questionId extends Simple("questionId")
61   case object questionKeyword extends Simple("questionKeyword", sortable = true)
62   case object question extends Simple("questionGeneral")
63   case object questionBg extends Simple("questions.bg.standard")
64   case object questionBgStemmed extends Simple("questions.bg.stemmed")
65   case object questionCs extends Simple("questions.cs.standard")
66   case object questionCsStemmed extends Simple("questions.cs.stemmed")
67   case object questionDa extends Simple("questions.da.standard")
68   case object questionDaStemmed extends Simple("questions.da.stemmed")
69   case object questionDe extends Simple("questions.de.standard")
70   case object questionDeStemmed extends Simple("questions.de.stemmed")
71   case object questionEl extends Simple("questions.el.standard")
72   case object questionElStemmed extends Simple("questions.el.stemmed")
73   case object questionEn extends Simple("questions.en.standard")
74   case object questionEnStemmed extends Simple("questions.en.stemmed")
75   case object questionEs extends Simple("questions.es.standard")
76   case object questionEsStemmed extends Simple("questions.es.stemmed")
77   case object questionEt extends Simple("questions.et.standard")
78   case object questionFi extends Simple("questions.fi.standard")
79   case object questionFiStemmed extends Simple("questions.fi.stemmed")
80   case object questionFr extends Simple("questions.fr.standard")
81   case object questionFrStemmed extends Simple("questions.fr.stemmed")
82   case object questionHr extends Simple("questions.hr.standard")
83   case object questionHu extends Simple("questions.hu.standard")
84   case object questionHuStemmed extends Simple("questions.hu.stemmed")
85   case object questionIt extends Simple("questions.it.standard")
86   case object questionItStemmed extends Simple("questions.it.stemmed")
87   case object questionLt extends Simple("questions.lt.standard")
88   case object questionLtStemmed extends Simple("questions.lt.stemmed")
89   case object questionLv extends Simple("questions.lv.standard")
90   case object questionLvStemmed extends Simple("questions.lv.stemmed")
91   case object questionMt extends Simple("questions.mt.standard")
92   case object questionNl extends Simple("questions.nl.standard")
93   case object questionNlStemmed extends Simple("questions.nl.stemmed")
94   case object questionPl extends Simple("questions.pl.standard")
95   case object questionPlStemmed extends Simple("questions.pl.stemmed")
96   case object questionPt extends Simple("questions.pt.standard")
97   case object questionPtStemmed extends Simple("questions.pt.stemmed")
98   case object questionRo extends Simple("questions.ro.standard")
99   case object questionRoStemmed extends Simple("questions.ro.stemmed")
100   case object questionSk extends Simple("questions.sk.standard")
101   case object questionSl extends Simple("questions.sl.standard")
102   case object questionUk extends Simple("questions.uk.standard")
103   case object questionSv extends Simple("questions.sv.standard")
104   case object questionSvStemmed extends Simple("questions.sv.stemmed")
105   case object slug extends Simple("slug", sortable = true)
106   case object startDate extends Simple("startDate", sortable = true)
107   case object endDate extends Simple("endDate", sortable = true)
108   case object countries extends Simple("countries", sortable = true)
109   case object languages extends Simple("languages", sortable = true)
110   case object operationKind extends Simple("operationKind", sortable = true)
111   case object featured extends Simple("featured")
112   case object status extends Simple("status")
113   case object participantsCount extends Simple("participantsCount")
114   case object proposalsCount extends Simple("proposalsCount")
115   case object resultsLink extends Simple("resultsLink")
116 
117   override val values: IndexedSeq[OperationOfQuestionElasticsearchFieldName] = findValues
118   final val swaggerAllowableValues =
119     "question,slug,startDate,endDate,description,countries,country,language,operationKind"
120 }
121 
122 final case class IndexedOperationOfQuestion(
123   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
124   questionId: QuestionId,
125   questions: Multilingual[String Refined NonEmpty],
126   questionGeneral: String Refined NonEmpty,
127   questionKeyword: String Refined NonEmpty,
128   slug: String,
129   questionShortTitles: Option[Multilingual[String Refined NonEmpty]],
130   startDate: ZonedDateTime,
131   endDate: ZonedDateTime,
132   @(ApiModelProperty @field)(
133     dataType = "string",
134     required = true,
135     allowableValues = OperationOfQuestion.Status.swaggerAllowableValues
136   )
137   status: OperationOfQuestion.Status,
138   theme: QuestionTheme,
139   descriptions: Option[Multilingual[String]],
140   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/consultation-image.png")
141   consultationImages: Option[Multilingual[String]],
142   @(ApiModelProperty @field)(dataType = "string", example = "consultation image alternative")
143   consultationImageAlts: Option[Multilingual[String Refined MaxSize[130]]],
144   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/description-image.png")
145   descriptionImages: Option[Multilingual[String]],
146   @(ApiModelProperty @field)(dataType = "string", example = "description image alternative")
147   descriptionImageAlts: Option[Multilingual[String Refined MaxSize[130]]],
148   @(ApiModelProperty @field)(dataType = "list[string]", required = true)
149   countries: NonEmptyList[Country],
150   @(ApiModelProperty @field)(dataType = "string", example = "fr", required = true)
151   languages: NonEmptyList[Language],
152   defaultLanguage: Language,
153   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
154   operationId: OperationId,
155   operationTitles: Multilingual[String],
156   operationKind: String,
157   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/about")
158   aboutUrls: Option[Multilingual[String]],
159   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/results")
160   resultsLink: Option[String],
161   proposalsCount: Int,
162   participantsCount: Int,
163   votesCount: Int,
164   actions: Option[String],
165   featured: Boolean,
166   @(ApiModelProperty @field)(dataType = "double") top20ConsensusThreshold: Option[Double]
167 ) {
168   val immutableFields: IndexedOperationOfQuestion.ImmutableFields =
169     IndexedOperationOfQuestion.ImmutableFields(top20ConsensusThreshold = top20ConsensusThreshold)
170 
171   def applyImmutableFields(fields: IndexedOperationOfQuestion.ImmutableFields): IndexedOperationOfQuestion =
172     this.copy(top20ConsensusThreshold = fields.top20ConsensusThreshold)
173 }
174 
175 object IndexedOperationOfQuestion extends CirceFormatters {
176 
177   implicit val codec: Codec[IndexedOperationOfQuestion] = deriveCodec
178 
179   def createFromOperationOfQuestion(
180     operationOfQuestion: OperationOfQuestion,
181     operation: SimpleOperation,
182     question: Question
183   ): IndexedOperationOfQuestion = {
184     IndexedOperationOfQuestion(
185       questionId = operationOfQuestion.questionId,
186       questions = question.questions,
187       questionGeneral = question.questions.getTranslationUnsafe(question.defaultLanguage),
188       questionKeyword = question.questions.getTranslationUnsafe(question.defaultLanguage),
189       slug = question.slug,
190       questionShortTitles = question.shortTitles,
191       startDate = operationOfQuestion.startDate,
192       endDate = operationOfQuestion.endDate,
193       status = operationOfQuestion.status,
194       theme = operationOfQuestion.theme,
195       descriptions = operationOfQuestion.descriptions,
196       consultationImages = operationOfQuestion.consultationImages,
197       consultationImageAlts = operationOfQuestion.consultationImageAlts,
198       descriptionImages = operationOfQuestion.descriptionImages,
199       descriptionImageAlts = operationOfQuestion.descriptionImageAlts,
200       countries = question.countries,
201       languages = question.languages,
202       defaultLanguage = question.defaultLanguage,
203       operationId = operationOfQuestion.operationId,
204       operationTitles = operationOfQuestion.operationTitles,
205       operationKind = operation.operationKind.value,
206       aboutUrls = operationOfQuestion.aboutUrls,
207       resultsLink = operationOfQuestion.resultsLink.map(Show[ResultsLink].show),
208       proposalsCount = operationOfQuestion.proposalsCount,
209       participantsCount = operationOfQuestion.participantsCount,
210       votesCount = operationOfQuestion.votesCount,
211       actions = operationOfQuestion.actions,
212       featured = operationOfQuestion.featured,
213       top20ConsensusThreshold = None
214     )
215   }
216 
217   final case class ImmutableFields(
218     @(ApiModelProperty @field)(dataType = "double")
219     top20ConsensusThreshold: Option[Double]
220   )
221 
222   object ImmutableFields {
223     val empty: ImmutableFields = ImmutableFields(top20ConsensusThreshold = None)
224   }
225 
226 }
227 
228 final case class OperationOfQuestionSearchResult(total: Long, results: Seq[IndexedOperationOfQuestion])
229 
230 object OperationOfQuestionSearchResult {
231   implicit val codec: Codec[OperationOfQuestionSearchResult] = deriveCodec
232 
233   def empty: OperationOfQuestionSearchResult = OperationOfQuestionSearchResult(0, Seq.empty)
234 }