1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # Base classes used by `nitweb`.
18 import model
::model_views
19 import model
::model_json
23 # Specific nitcorn Action that uses a Model
30 # MModule used to flatten model.
31 var mainmodule
: MModule
33 # Find the MEntity ` with `full_name`.
34 fun find_mentity
(model
: ModelView, full_name
: nullable String): nullable MEntity do
35 if full_name
== null then return null
36 return model
.mentity_by_full_name
(full_name
.from_percent_encoding
)
39 # Init the model view from the `req` uri parameters.
40 fun init_model_view
(req
: HttpRequest): ModelView do
41 var view
= new ModelView(model
)
42 var show_private
= req
.bool_arg
("private") or else false
43 if not show_private
then view
.min_visibility
= protected_visibility
45 view
.include_fictive
= req
.bool_arg
("fictive") or else false
46 view
.include_empty_doc
= req
.bool_arg
("empty-doc") or else true
47 view
.include_test_suite
= req
.bool_arg
("test-suite") or else false
48 view
.include_attribute
= req
.bool_arg
("attributes") or else true
54 # Specific handler for nitweb API.
55 abstract class APIHandler
58 # The JSON API does not filter anything by default.
60 # So we can cache the model view.
61 var view
: ModelView is lazy
do
62 var view
= new ModelView(model
)
63 view
.min_visibility
= private_visibility
64 view
.include_fictive
= true
65 view
.include_empty_doc
= true
66 view
.include_attribute
= true
67 view
.include_test_suite
= true
71 # Try to load the mentity from uri with `/:id`.
73 # Send 400 if `:id` is null.
74 # Send 404 if no entity is found.
75 # Return null in both cases.
76 fun mentity_from_uri
(req
: HttpRequest, res
: HttpResponse): nullable MEntity do
77 var id
= req
.param
("id")
82 var mentity
= find_mentity
(view
, id
)
83 if mentity
== null then
90 # A NitView is rendered by an action.
92 # Renders this view and returns something that can be written to a HTTP response.
93 fun render
: Writable is abstract
96 redef class HttpResponse
97 # Render a NitView as response.
98 fun send_view
(view
: NitView, status
: nullable Int) do send
(view
.render
, status
)
103 # URL to `self` within the web interface.
104 fun web_url
: String is abstract
106 # URL to `self` within the JSON api.
107 fun api_url
: String do return "/api/entity/" / full_name
111 obj
["web_url"] = web_url
112 obj
["api_url"] = api_url
116 # Get the full json repesentation of `self` with MEntityRefs resolved.
117 fun api_json
(handler
: ModelHandler): JsonObject do return json
120 redef class MEntityRef
123 obj
["web_url"] = mentity
.web_url
124 obj
["api_url"] = mentity
.api_url
125 obj
["name"] = mentity
.name
126 obj
["mdoc"] = mentity
.mdoc_or_fallback
127 obj
["visibility"] = mentity
.visibility
128 obj
["location"] = mentity
.location
129 var modifiers
= new JsonArray
130 for modifier
in mentity
.collect_modifiers
do
131 modifiers
.add modifier
133 obj
["modifiers"] = modifiers
140 # Add doc down processing
143 obj
["synopsis"] = synopsis
144 obj
["documentation"] = documentation
145 obj
["comment"] = comment
146 obj
["html_synopsis"] = html_synopsis
.write_to_string
147 obj
["html_documentation"] = html_documentation
.write_to_string
148 obj
["html_comment"] = html_comment
.write_to_string
154 redef var web_url
= "/package/{full_name}" is lazy
158 redef var web_url
= "/group/{full_name}" is lazy
162 redef var web_url
= "/module/{full_name}" is lazy
164 redef fun api_json
(handler
) do
166 obj
["intro_mclassdefs"] = to_mentity_refs
(collect_intro_mclassdefs
(private_view
))
167 obj
["redef_mclassdefs"] = to_mentity_refs
(collect_redef_mclassdefs
(private_view
))
168 obj
["imports"] = to_mentity_refs
(in_importation
.direct_greaters
)
174 redef var web_url
= "/class/{full_name}" is lazy
176 redef fun api_json
(handler
) do
178 obj
["all_mproperties"] = to_mentity_refs
(collect_accessible_mproperties
(private_view
))
179 obj
["intro_mproperties"] = to_mentity_refs
(collect_intro_mproperties
(private_view
))
180 obj
["redef_mproperties"] = to_mentity_refs
(collect_redef_mproperties
(private_view
))
181 var poset
= hierarchy_poset
(handler
.mainmodule
, private_view
)
182 obj
["parents"] = to_mentity_refs
(poset
[self].direct_greaters
)
187 redef class MClassDef
188 redef var web_url
= "/classdef/{full_name}" is lazy
192 obj
["intro"] = to_mentity_ref
(mclass
.intro
)
193 obj
["mpackage"] = to_mentity_ref
(mmodule
.mpackage
)
197 redef fun api_json
(handler
) do
199 obj
["intro_mpropdefs"] = to_mentity_refs
(collect_intro_mpropdefs
(private_view
))
200 obj
["redef_mpropdefs"] = to_mentity_refs
(collect_redef_mpropdefs
(private_view
))
205 redef class MProperty
206 redef var web_url
= "/property/{full_name}" is lazy
210 obj
["intro_mclass"] = to_mentity_ref
(intro_mclassdef
.mclass
)
211 obj
["mpackage"] = to_mentity_ref
(intro_mclassdef
.mmodule
.mpackage
)
217 redef var web_url
= "/propdef/{full_name}" is lazy
221 obj
["intro"] = to_mentity_ref
(mproperty
.intro
)
222 obj
["intro_mclassdef"] = to_mentity_ref
(mproperty
.intro
.mclassdef
)
223 obj
["mmodule"] = to_mentity_ref
(mclassdef
.mmodule
)
224 obj
["mgroup"] = to_mentity_ref
(mclassdef
.mmodule
.mgroup
)
225 obj
["mpackage"] = to_mentity_ref
(mclassdef
.mmodule
.mpackage
)
230 redef class MClassType
231 redef var web_url
= mclass
.web_url
is lazy
234 redef class MNullableType
235 redef var web_url
= mtype
.web_url
is lazy
238 redef class MParameterType
239 redef var web_url
= mclass
.web_url
is lazy
242 redef class MVirtualType
243 redef var web_url
= mproperty
.web_url
is lazy