1 /*
2  * sys-emu - A system emulator for tutorials
3  * Copyright (C) 2018 - 2019 osdevelopment-info
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 published by
7  * the Free Software Foundation, either version 3 of the License, or
8  * (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 package info.osdevelopment.sysemu.rest
19 
20 import akka.http.scaladsl.model.headers.`Content-Type`
21 import akka.http.scaladsl.model.{MediaTypes, StatusCodes}
22 import akka.http.scaladsl.server.Directives._
23 import akka.http.scaladsl.server.Route
24 import info.osdevelopment.sysemu.processor.ProcessorDescriptor
25 import info.osdevelopment.sysemu.model.{MessageModel, ProcessorModel, SysEmuJsonProtocol}
26 import io.swagger.v3.oas.annotations.enums.ParameterIn
27 import io.swagger.v3.oas.annotations.{Operation, Parameter}
28 import io.swagger.v3.oas.annotations.media.{ArraySchema, Content, Schema}
29 import io.swagger.v3.oas.annotations.responses.ApiResponse
30 import javax.ws.rs.{GET, Path}
31 import org.slf4j.{Logger, LoggerFactory}
32 import scala.language.postfixOps
33 
34 @Path("/processor")
35 class RestProcessorService extends SysEmuJsonProtocol {
36 
37   val log: Logger = LoggerFactory getLogger classOf[RestProcessorService]
38 
39   def route: Route = {
40     respondWithHeader(`Content-Type`(MediaTypes.`application/json`))
41     pathPrefix("processor") {
42       getAllProcessors ~
43       getProcessor
44     }
45   }
46 
47   @GET
48   @Path("")
49   @Operation(
50     summary = "Get all processors",
51     description = "Return all processors available",
52     responses = Array(
53       new ApiResponse(
54         responseCode = "200",
55         description = "All processors",
56         content = Array(
57           new Content(
58             array = new ArraySchema(
59               schema = new Schema(
60                 implementation = classOf[String],
61                 example = "8086")
62             ),
63             mediaType = "application/json"
64           )
65         )
66       ),
67       new ApiResponse(
68         responseCode = "500",
69         description = "Internal server error"
70       )
71     )
72   )
73   def getAllProcessors: Route = {
74     pathEndOrSingleSlash {
75       get {
76         val processorDescriptors = ProcessorDescriptor.loadProcessors()
77         complete(StatusCodes.OK, processorDescriptors.map(d => d.name))
78       }
79     }
80   }
81 
82   @GET
83   @Path("/{name}")
84   @Operation(
85     summary = "Return a specific processor",
86     description = "Search for the processor specified by the name in the path and return it",
87     parameters = Array(
88       new Parameter(
89         in = ParameterIn.PATH,
90         name = "name",
91         schema = new Schema(
92           name = "name",
93           description = "The name of the processor to retrieve",
94           `type` = "string",
95           example = "8086"
96         )
97       )
98     ),
99     responses = Array(
100       new ApiResponse(
101         responseCode = "200",
102         description = "The processor requested",
103         content = Array(
104           new Content(
105             schema = new Schema(implementation = classOf[ProcessorModel]),
106             mediaType = "application/json"
107           )
108         )
109       ),
110       new ApiResponse(
111         responseCode = "404",
112         description = "When the processor with the given name cannot be found",
113         content = Array(
114           new Content(
115             schema = new Schema(implementation = classOf[MessageModel]),
116             mediaType = "application/json"
117           )
118         )
119       ),
120       new ApiResponse(
121         responseCode = "500",
122         description = "Internal server error"
123       )
124     )
125   )
126   def getProcessor: Route = {
127     pathPrefix(Segment) { name =>
128       get {
129         val processorDescriptor = ProcessorDescriptor loadProcessor name
130         processorDescriptor match {
131           case Some(descriptor) => complete(StatusCodes.OK, ProcessorModel(descriptor))
132           case None =>
133             complete(StatusCodes.NotFound, new MessageModel("No processor with name " + name + " can be found."))
134         }
135       }
136     }
137   }
138 
139 }