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.api.question
21 
22 import cats.Show
23 import cats.data.NonEmptyList
24 import eu.timepit.refined.auto._
25 import eu.timepit.refined.api.Refined
26 import eu.timepit.refined.collection._
27 import io.circe.generic.semiauto.deriveCodec
28 import io.circe.Codec
29 import io.swagger.annotations.ApiModelProperty
30 import io.circe.refined._
31 import org.make.api.operation.ResultsLinkResponse
32 import org.make.api.proposal.ProposalResponse
33 import org.make.core.technical.Multilingual
34 import org.make.core.feature.FeatureSlug
35 import org.make.core.operation._
36 import org.make.core.operation.indexed.IndexedOperationOfQuestion
37 import org.make.core.partner.{Partner, PartnerKind}
38 import org.make.core.question.{Question, QuestionId}
39 import org.make.core.reference.{Country, Language}
40 import org.make.core.user.{User, UserId}
41 import org.make.core.{CirceFormatters, SlugHelper}
42 
43 import java.time.{LocalDate, ZonedDateTime}
44 import scala.annotation.meta.field
45 
46 final case class ModerationQuestionResponse(
47   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
48   id: QuestionId,
49   slug: String,
50   questions: Multilingual[String Refined NonEmpty],
51   shortTitles: Option[Multilingual[String Refined NonEmpty]],
52   @(ApiModelProperty @field)(dataType = "list[string]", required = true)
53   countries: NonEmptyList[Country],
54   @(ApiModelProperty @field)(dataType = "string", example = "fr", required = true)
55   languages: NonEmptyList[Language]
56 )
57 
58 object ModerationQuestionResponse {
59 
60   def apply(question: Question): ModerationQuestionResponse = ModerationQuestionResponse(
61     id = question.questionId,
62     slug = question.slug,
63     questions = question.questions,
64     shortTitles = question.shortTitles,
65     countries = question.countries,
66     languages = question.languages
67   )
68 
69   implicit val codec: Codec[ModerationQuestionResponse] = deriveCodec
70 }
71 
72 final case class MetasResponse(
73   title: Option[String],
74   description: Option[String],
75   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/picture.png")
76   picture: Option[String]
77 )
78 
79 object MetasResponse {
80   implicit val codec: Codec[MetasResponse] = deriveCodec
81 
82   def apply(metas: Metas, returnedLanguage: Language): MetasResponse =
83     MetasResponse(
84       title = metas.titles.map(_.getTranslationUnsafe(returnedLanguage)),
85       description = metas.descriptions.map(_.getTranslationUnsafe(returnedLanguage)),
86       picture = metas.picture
87     )
88 }
89 
90 final case class WordingResponse(
91   title: String,
92   question: String Refined NonEmpty,
93   description: Option[String],
94   metas: MetasResponse
95 )
96 
97 object WordingResponse {
98   implicit val codec: Codec[WordingResponse] = deriveCodec
99 }
100 
101 final case class IntroCardResponse(enabled: Boolean, title: Option[String], description: Option[String])
102 
103 object IntroCardResponse extends CirceFormatters {
104   implicit val codec: Codec[IntroCardResponse] = deriveCodec
105 }
106 
107 final case class PushProposalCardResponse(enabled: Boolean)
108 
109 object PushProposalCardResponse extends CirceFormatters {
110   implicit val codec: Codec[PushProposalCardResponse] = deriveCodec
111 }
112 
113 final case class FinalCardResponse(
114   enabled: Boolean,
115   withSharing: Boolean,
116   title: Option[String],
117   share: Option[String],
118   learnMoreTitle: Option[String],
119   learnMoreTextButton: Option[String],
120   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/link")
121   linkUrl: Option[String]
122 )
123 
124 object FinalCardResponse extends CirceFormatters {
125   implicit val codec: Codec[FinalCardResponse] = deriveCodec
126 }
127 
128 final case class SequenceCardsConfigurationResponse(
129   introCard: IntroCardResponse,
130   pushProposalCard: PushProposalCardResponse,
131   finalCard: FinalCardResponse
132 )
133 
134 object SequenceCardsConfigurationResponse extends CirceFormatters {
135   implicit val codec: Codec[SequenceCardsConfigurationResponse] = deriveCodec
136 
137   def apply(
138     sequenceCardConfiguration: SequenceCardsConfiguration,
139     returnedLanguage: Language
140   ): SequenceCardsConfigurationResponse = {
141     SequenceCardsConfigurationResponse(
142       introCard = IntroCardResponse(
143         enabled = sequenceCardConfiguration.introCard.enabled,
144         title = sequenceCardConfiguration.introCard.titles.flatMap(_.getTranslation(returnedLanguage)),
145         description = sequenceCardConfiguration.introCard.descriptions.flatMap(_.getTranslation(returnedLanguage))
146       ),
147       pushProposalCard = PushProposalCardResponse(enabled = sequenceCardConfiguration.pushProposalCard.enabled),
148       finalCard = FinalCardResponse(
149         enabled = sequenceCardConfiguration.finalCard.enabled,
150         withSharing = sequenceCardConfiguration.finalCard.sharingEnabled,
151         title = sequenceCardConfiguration.finalCard.titles.flatMap(_.getTranslation(returnedLanguage)),
152         share = sequenceCardConfiguration.finalCard.shareDescriptions.flatMap(_.getTranslation(returnedLanguage)),
153         learnMoreTitle = sequenceCardConfiguration.finalCard.learnMoreTitles.flatMap(_.getTranslation(returnedLanguage)),
154         learnMoreTextButton =
155           sequenceCardConfiguration.finalCard.learnMoreTextButtons.flatMap(_.getTranslation(returnedLanguage)),
156         linkUrl = sequenceCardConfiguration.finalCard.linkUrl
157       )
158     )
159   }
160 }
161 
162 final case class OrganisationPartnerResponse(organisationId: UserId, slug: String)
163 
164 object OrganisationPartnerResponse {
165   implicit val codec: Codec[OrganisationPartnerResponse] = deriveCodec
166 }
167 
168 final case class QuestionPartnerResponse(
169   name: String,
170   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/logo.png")
171   logo: Option[String],
172   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/link")
173   link: Option[String],
174   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555")
175   organisation: Option[OrganisationPartnerResponse],
176   @(ApiModelProperty @field)(dataType = "string", required = true, allowableValues = PartnerKind.swaggerAllowableValues)
177   partnerKind: PartnerKind,
178   weight: Float
179 )
180 
181 object QuestionPartnerResponse extends CirceFormatters {
182   def apply(partner: Partner, organisation: Option[User]): QuestionPartnerResponse = QuestionPartnerResponse(
183     name = partner.name,
184     logo = partner.logo,
185     link = partner.link,
186     organisation = organisation.map { orga =>
187       OrganisationPartnerResponse(
188         organisationId = orga.userId,
189         slug = orga.organisationName.map(SlugHelper.apply).getOrElse("")
190       )
191     },
192     partnerKind = partner.partnerKind,
193     weight = partner.weight
194   )
195 
196   implicit val codec: Codec[QuestionPartnerResponse] = deriveCodec
197 }
198 
199 final case class OperationOfQuestionHighlightsResponse(
200   votesTarget: Int,
201   votesCount: Int,
202   participantsCount: Int,
203   proposalsCount: Int
204 )
205 
206 object OperationOfQuestionHighlightsResponse {
207   implicit val codec: Codec[OperationOfQuestionHighlightsResponse] = deriveCodec
208 }
209 
210 final case class TimelineResponse(
211   action: Option[TimelineElementResponse],
212   result: Option[TimelineElementResponse],
213   workshop: Option[TimelineElementResponse]
214 )
215 
216 object TimelineResponse extends CirceFormatters {
217   implicit val codec: Codec[TimelineResponse] = deriveCodec
218 }
219 
220 final case class TimelineElementResponse(date: LocalDate, dateText: String, description: String)
221 
222 object TimelineElementResponse extends CirceFormatters {
223   implicit val codec: Codec[TimelineElementResponse] = deriveCodec
224 }
225 
226 final case class QuestionDetailsResponse(
227   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
228   questionId: QuestionId,
229   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
230   operationId: OperationId,
231   preferredLanguage: Option[Language],
232   returnedLanguage: Language,
233   wording: WordingResponse,
234   question: String Refined NonEmpty,
235   shortTitle: Option[String Refined NonEmpty],
236   slug: String,
237   @(ApiModelProperty @field)(dataType = "list[string]", required = true)
238   countries: NonEmptyList[Country],
239   @(ApiModelProperty @field)(dataType = "string", example = "fr", required = true)
240   languages: NonEmptyList[Language],
241   startDate: ZonedDateTime,
242   endDate: ZonedDateTime,
243   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
244   canPropose: Boolean,
245   proposalPrefix: String,
246   @(ApiModelProperty @field)(
247     dataType = "string",
248     required = true,
249     allowableValues = OperationKind.swaggerAllowableValues
250   )
251   operationKind: OperationKind,
252   sequenceConfig: SequenceCardsConfigurationResponse,
253   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/about")
254   aboutUrl: Option[String],
255   partners: Seq[QuestionPartnerResponse],
256   theme: QuestionThemeResponse,
257   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/consultation.png")
258   consultationImage: Option[String],
259   @(ApiModelProperty @field)(dataType = "string", example = "consultation alternative")
260   consultationImageAlt: Option[String Refined MaxSize[130]],
261   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/description.png")
262   descriptionImage: Option[String],
263   @(ApiModelProperty @field)(dataType = "string", example = "description alternative")
264   descriptionImageAlt: Option[String Refined MaxSize[130]],
265   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/cobranding-logo.png")
266   cobrandingLogo: Option[String],
267   @(ApiModelProperty @field)(dataType = "string", example = "cobranding logo alternative")
268   cobrandingLogoAlt: Option[String Refined MaxSize[130]],
269   displayResults: Boolean,
270   reportUrl: Option[String],
271   actionsUrl: Option[String],
272   @(ApiModelProperty @field)(dataType = "list[string]", required = true)
273   activeFeatures: Seq[FeatureSlug],
274   featured: Boolean,
275   highlights: OperationOfQuestionHighlightsResponse,
276   timeline: TimelineResponse,
277   controversyCount: Long,
278   topProposalCount: Long,
279   activeFeatureData: ActiveFeatureData,
280   @Deprecated hasDemographics: Boolean,
281   demographicsCardCount: Int,
282   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/results")
283   resultsLink: Option[String]
284 )
285 
286 object QuestionDetailsResponse extends CirceFormatters {
287   def apply(
288     question: Question,
289     operation: Operation,
290     operationOfQuestion: OperationOfQuestion,
291     partners: Seq[Partner],
292     organisations: Seq[User],
293     activeFeatures: Seq[FeatureSlug],
294     controversyCount: Long,
295     topProposalCount: Long,
296     activeFeatureData: ActiveFeatureData,
297     demographicsCardCount: Int,
298     preferredLanguage: Option[Language],
299     returnedLanguage: Language
300   ): QuestionDetailsResponse = QuestionDetailsResponse(
301     questionId = question.questionId,
302     operationId = operation.operationId,
303     preferredLanguage = preferredLanguage,
304     returnedLanguage = returnedLanguage,
305     wording = WordingResponse(
306       title = operationOfQuestion.operationTitles.getTranslationUnsafe(returnedLanguage),
307       question = question.questions.getTranslationUnsafe(returnedLanguage),
308       description = operationOfQuestion.descriptions.flatMap(_.getTranslation(returnedLanguage)),
309       metas = MetasResponse(operationOfQuestion.metas, returnedLanguage)
310     ),
311     question = question.questions.getTranslationUnsafe(returnedLanguage),
312     shortTitle = question.shortTitles.flatMap(_.getTranslation(returnedLanguage)),
313     slug = question.slug,
314     countries = question.countries,
315     languages = question.languages,
316     startDate = operationOfQuestion.startDate,
317     endDate = operationOfQuestion.endDate,
318     canPropose = operationOfQuestion.canPropose,
319     proposalPrefix = operationOfQuestion.proposalPrefixes.getTranslationUnsafe(returnedLanguage),
320     operationKind = operation.operationKind,
321     sequenceConfig =
322       SequenceCardsConfigurationResponse.apply(operationOfQuestion.sequenceCardsConfiguration, returnedLanguage),
323     aboutUrl = operationOfQuestion.aboutUrls.flatMap(_.getTranslation(returnedLanguage)),
324     partners =
325       partners.map(p => QuestionPartnerResponse(p, organisations.find(o => p.organisationId.contains(o.userId)))),
326     theme = QuestionThemeResponse.fromQuestionTheme(operationOfQuestion.theme),
327     consultationImage = operationOfQuestion.consultationImages.flatMap(_.getTranslation(returnedLanguage)),
328     consultationImageAlt = operationOfQuestion.consultationImageAlts.flatMap(_.getTranslation(returnedLanguage)),
329     descriptionImage = operationOfQuestion.descriptionImages.flatMap(_.getTranslation(returnedLanguage)),
330     descriptionImageAlt = operationOfQuestion.descriptionImageAlts.flatMap(_.getTranslation(returnedLanguage)),
331     cobrandingLogo = operationOfQuestion.cobrandingLogo,
332     cobrandingLogoAlt = operationOfQuestion.cobrandingLogoAlt,
333     displayResults = operationOfQuestion.resultsLink.isDefined,
334     reportUrl = operationOfQuestion.reportUrl,
335     actionsUrl = operationOfQuestion.actionsUrl,
336     activeFeatures = activeFeatures,
337     featured = operationOfQuestion.featured,
338     highlights = OperationOfQuestionHighlightsResponse(
339       votesTarget = operationOfQuestion.votesTarget,
340       votesCount = operationOfQuestion.votesCount,
341       participantsCount = operationOfQuestion.participantsCount,
342       proposalsCount = operationOfQuestion.proposalsCount
343     ),
344     timeline = TimelineResponse(
345       action = operationOfQuestion.timeline.action.map(
346         action =>
347           TimelineElementResponse(
348             action.date,
349             action.dateTexts.getTranslation(returnedLanguage).fold("")(_.value),
350             action.descriptions.getTranslation(returnedLanguage).fold("")(_.value)
351           )
352       ),
353       result = operationOfQuestion.timeline.result.map(
354         result =>
355           TimelineElementResponse(
356             result.date,
357             result.dateTexts.getTranslation(returnedLanguage).fold("")(_.value),
358             result.descriptions.getTranslation(returnedLanguage).fold("")(_.value)
359           )
360       ),
361       workshop = operationOfQuestion.timeline.workshop.map(
362         workshop =>
363           TimelineElementResponse(
364             workshop.date,
365             workshop.dateTexts.getTranslation(returnedLanguage).fold("")(_.value),
366             workshop.descriptions.getTranslation(returnedLanguage).fold("")(_.value)
367           )
368       )
369     ),
370     controversyCount = controversyCount,
371     topProposalCount = topProposalCount,
372     activeFeatureData = activeFeatureData,
373     hasDemographics = demographicsCardCount > 0,
374     demographicsCardCount = demographicsCardCount,
375     resultsLink = operationOfQuestion.resultsLink.map(Show[ResultsLink].show)
376   )
377 
378   implicit val codec: Codec[QuestionDetailsResponse] = deriveCodec
379 }
380 
381 final case class QuestionOfOperationResponse(
382   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
383   questionId: QuestionId,
384   questionSlug: String,
385   preferredLanguage: Option[Language],
386   returnedLanguage: Language,
387   question: String Refined NonEmpty,
388   shortTitle: Option[String Refined NonEmpty],
389   operationTitle: String,
390   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/consultation.png")
391   consultationImage: Option[String],
392   @(ApiModelProperty @field)(dataType = "string", example = "consultation image alternative")
393   consultationImageAlt: Option[String Refined MaxSize[130]],
394   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/description.png")
395   descriptionImage: Option[String],
396   @(ApiModelProperty @field)(dataType = "string", example = "description image alternative")
397   descriptionImageAlt: Option[String Refined MaxSize[130]],
398   @(ApiModelProperty @field)(dataType = "list[string]", required = true)
399   countries: NonEmptyList[Country],
400   @(ApiModelProperty @field)(dataType = "string", example = "fr", required = true)
401   languages: NonEmptyList[Language],
402   startDate: ZonedDateTime,
403   endDate: ZonedDateTime,
404   theme: QuestionThemeResponse,
405   displayResults: Boolean,
406   resultsLink: Option[ResultsLinkResponse],
407   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/about")
408   aboutUrl: Option[String],
409   actions: Option[String],
410   featured: Boolean,
411   @Deprecated participantsCount: Int,
412   proposalsCount: Int,
413   votesCount: Int
414 )
415 
416 object QuestionOfOperationResponse extends CirceFormatters {
417   def apply(
418     indexedOperationOfQuestion: IndexedOperationOfQuestion,
419     preferredLanguage: Option[Language]
420   ): QuestionOfOperationResponse = {
421     val returnedLanguage = preferredLanguage.fold(indexedOperationOfQuestion.defaultLanguage)(
422       lang =>
423         indexedOperationOfQuestion.languages
424           .find(language => language.value == lang.value)
425           .getOrElse(indexedOperationOfQuestion.defaultLanguage)
426     )
427     QuestionOfOperationResponse(
428       questionId = indexedOperationOfQuestion.questionId,
429       questionSlug = indexedOperationOfQuestion.slug,
430       preferredLanguage = preferredLanguage,
431       returnedLanguage = returnedLanguage,
432       question = indexedOperationOfQuestion.questions.getTranslationUnsafe(returnedLanguage),
433       shortTitle = indexedOperationOfQuestion.questionShortTitles.flatMap(_.getTranslation(returnedLanguage)),
434       operationTitle = indexedOperationOfQuestion.operationTitles.getTranslationUnsafe(returnedLanguage),
435       consultationImage = indexedOperationOfQuestion.consultationImages.flatMap(_.getTranslation(returnedLanguage)),
436       consultationImageAlt =
437         indexedOperationOfQuestion.consultationImageAlts.flatMap(_.getTranslation(returnedLanguage)),
438       descriptionImage = indexedOperationOfQuestion.descriptionImages.flatMap(_.getTranslation(returnedLanguage)),
439       descriptionImageAlt = indexedOperationOfQuestion.descriptionImageAlts.flatMap(_.getTranslation(returnedLanguage)),
440       countries = indexedOperationOfQuestion.countries,
441       languages = indexedOperationOfQuestion.languages,
442       startDate = indexedOperationOfQuestion.startDate,
443       endDate = indexedOperationOfQuestion.endDate,
444       theme = QuestionThemeResponse.fromQuestionTheme(indexedOperationOfQuestion.theme),
445       displayResults = indexedOperationOfQuestion.resultsLink.isDefined,
446       resultsLink = indexedOperationOfQuestion.resultsLink
447         .flatMap(ResultsLink.parse)
448         .map(ResultsLinkResponse.apply),
449       aboutUrl = indexedOperationOfQuestion.aboutUrls.flatMap(_.getTranslation(returnedLanguage)),
450       actions = indexedOperationOfQuestion.actions,
451       featured = indexedOperationOfQuestion.featured,
452       participantsCount = indexedOperationOfQuestion.participantsCount,
453       proposalsCount = indexedOperationOfQuestion.proposalsCount,
454       votesCount = indexedOperationOfQuestion.votesCount
455     )
456   }
457 
458   implicit val codec: Codec[QuestionOfOperationResponse] = deriveCodec[QuestionOfOperationResponse]
459 }
460 
461 final case class QuestionThemeResponse(
462   @(ApiModelProperty @field)(dataType = "string", example = "#214284", required = true) gradientStart: String,
463   @(ApiModelProperty @field)(dataType = "string", example = "#428421", required = true) gradientEnd: String,
464   @(ApiModelProperty @field)(dataType = "string", example = "#842142", required = true) color: String,
465   @(ApiModelProperty @field)(dataType = "string", example = "#ff0000", required = true) fontColor: String
466 )
467 
468 object QuestionThemeResponse {
469   def fromQuestionTheme(theme: QuestionTheme): QuestionThemeResponse = {
470     QuestionThemeResponse(
471       gradientStart = theme.color,
472       gradientEnd = theme.color,
473       color = theme.color,
474       fontColor = theme.fontColor
475     )
476   }
477 
478   implicit val codec: Codec[QuestionThemeResponse] = deriveCodec
479 }
480 
481 final case class ActiveFeatureData(topProposal: Option[ProposalResponse])
482 
483 object ActiveFeatureData {
484   implicit val codec: Codec[ActiveFeatureData] = deriveCodec
485 }