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.sequence
21 import akka.http.scaladsl.server._
22 import grizzled.slf4j.Logging
23 import io.swagger.annotations._
24 import org.make.api.operation.OperationServiceComponent
25 import org.make.api.question.QuestionServiceComponent
26 
27 import javax.ws.rs.Path
28 import org.make.api.technical.directives.FutureDirectivesExtensions._
29 import org.make.api.technical.MakeDirectives.MakeDirectivesDependencies
30 import org.make.api.technical.MakeAuthenticationDirectives
31 import org.make.core.HttpCodes
32 import org.make.core.auth.UserRights
33 import org.make.core.question.QuestionId
34 import org.make.core.sequence.SequenceConfiguration
35 import scalaoauth2.provider.AuthInfo
36 
37 @Api(value = "Admin Sequence")
38 @Path(value = "/admin/sequences-configuration")
39 trait AdminSequenceApi extends Directives {
40 
41   @ApiOperation(
42     value = "admin-get-sequence-config",
43     httpMethod = "GET",
44     code = HttpCodes.OK,
45     authorizations = Array(
46       new Authorization(
47         value = "MakeApi",
48         scopes = Array(new AuthorizationScope(scope = "admin", description = "BO Admin"))
49       )
50     )
51   )
52   @ApiResponses(
53     value = Array(new ApiResponse(code = HttpCodes.OK, message = "Ok", response = classOf[SequenceConfiguration]))
54   )
55   @ApiImplicitParams(
56     value = Array(new ApiImplicitParam(name = "questionIdOrSequenceId", paramType = "path", dataType = "string"))
57   )
58   @Path(value = "/{questionIdOrSequenceId}")
59   def getAdminSequenceConfiguration: Route
60 
61   @ApiOperation(
62     value = "admin-update-sequence-configuration",
63     httpMethod = "PUT",
64     code = HttpCodes.OK,
65     notes = "/!\\ You need to reindex proposals to apply these modifications.",
66     authorizations = Array(
67       new Authorization(
68         value = "MakeApi",
69         scopes = Array(new AuthorizationScope(scope = "admin", description = "BO Admin"))
70       )
71     )
72   )
73   @ApiResponses(value = Array(new ApiResponse(code = HttpCodes.OK, message = "Ok", response = classOf[Boolean])))
74   @ApiImplicitParams(
75     value = Array(
76       new ApiImplicitParam(name = "questionId", paramType = "path", required = true, dataType = "string"),
77       new ApiImplicitParam(
78         value = "body",
79         paramType = "body",
80         dataType = "org.make.api.sequence.SequenceConfigurationRequest"
81       )
82     )
83   )
84   @Path(value = "/{questionId}")
85   def putSequenceConfiguration: Route
86 
87   def routes: Route = getAdminSequenceConfiguration ~ putSequenceConfiguration
88 
89 }
90 
91 trait AdminSequenceApiComponent {
92   def adminSequenceApi: AdminSequenceApi
93 }
94 
95 trait DefaultAdminSequenceApiComponent
96     extends AdminSequenceApiComponent
97     with MakeAuthenticationDirectives
98     with Logging {
99 
100   this: MakeDirectivesDependencies
101     with SequenceServiceComponent
102     with SequenceConfigurationComponent
103     with QuestionServiceComponent
104     with OperationServiceComponent =>
105 
106   override lazy val adminSequenceApi: AdminSequenceApi = new DefaultAdminSequenceApi
107 
108   class DefaultAdminSequenceApi extends AdminSequenceApi {
109 
110     private val questionId: PathMatcher1[QuestionId] = Segment.map(id => QuestionId(id))
111 
112     override def getAdminSequenceConfiguration: Route = {
113       get {
114         path("admin" / "sequences-configuration" / Segment) { id =>
115           makeOperation("GetAdminSequenceConfiguration") { _ =>
116             makeOAuth2 { auth: AuthInfo[UserRights] =>
117               requireAdminRole(auth.user) {
118                 sequenceConfigurationService
119                   .getPersistentSequenceConfigurationByQuestionId(QuestionId(id))
120                   .asDirectiveOrNotFound { result =>
121                     complete(SequenceConfigurationResponse.fromSequenceConfiguration(result))
122                   }
123               }
124             }
125           }
126         }
127       }
128     }
129 
130     override def putSequenceConfiguration: Route = {
131       put {
132         path("admin" / "sequences-configuration" / questionId) { questionId =>
133           makeOperation("PutSequenceConfiguration") { _ =>
134             makeOAuth2 { auth: AuthInfo[UserRights] =>
135               requireAdminRole(auth.user) {
136                 decodeRequest {
137                   entity(as[SequenceConfigurationRequest]) {
138                     sequenceConfigurationRequest: SequenceConfigurationRequest =>
139                       sequenceConfigurationService
140                         .getPersistentSequenceConfigurationByQuestionId(questionId)
141                         .asDirectiveOrNotFound { _ =>
142                           sequenceConfigurationService
143                             .setSequenceConfiguration(
144                               sequenceConfigurationRequest
145                                 .toSequenceConfiguration(questionId)
146                             )
147                             .asDirective {
148                               complete(_)
149                             }
150                         }
151                   }
152                 }
153               }
154             }
155           }
156         }
157       }
158     }
159 
160   }
161 
162 }