RBAC with internal authentication backend - Phase 2
[osm/NBI.git] / osm_nbi / html_out.py
1 # Licensed under the Apache License, Version 2.0 (the "License");
2 # you may not use this file except in compliance with the License.
3 # You may obtain a copy of the License at
4 #
5 # http://www.apache.org/licenses/LICENSE-2.0
6 #
7 # Unless required by applicable law or agreed to in writing, software
8 # distributed under the License is distributed on an "AS IS" BASIS,
9 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
10 # implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
13
14 """
15 Contains html text in variables to make and html response
16 """
17
18 import yaml
19 from http import HTTPStatus
20 from html import escape as html_escape
21
22 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
23
24 html_start = """
25 <!DOCTYPE html>
26 <html>
27 <head>
28 <link href="/osm/static/style.css" rel="stylesheet">
29 <title>Welcome to OSM</title>
30 </head>
31 <body>
32 <div id="osm_topmenu">
33 <div>
34 <a href="https://osm.etsi.org"> <img src="/osm/static/OSM-logo.png" height="42" width="100"
35 style="vertical-align:middle"> </a>
36 <a>( {} )</a>
37 <a href="/osm/pdu/v1/pdu_descriptors">PDUs </a>
38 <a href="/osm/vnfpkgm/v1/vnf_packages">VNFDs </a>
39 <a href="/osm/nsd/v1/ns_descriptors">NSDs </a>
40 <a href="/osm/nslcm/v1/ns_instances">NSs </a>
41 <a href="/osm/nst/v1/netslice_templates">NSTDs </a>
42 <a href="/osm/nsilcm/v1/netslice_instances">NSIs </a>
43 <a href="/osm/admin/v1/users">USERs </a>
44 <a href="/osm/admin/v1/projects">PROJECTs </a>
45 <a href="/osm/admin/v1/tokens">TOKENs </a>
46 <a href="/osm/admin/v1/vim_accounts">VIMs </a>
47 <a href="/osm/admin/v1/wim_accounts">WIMs </a>
48 <a href="/osm/admin/v1/sdns">SDNs </a>
49 <a href="/osm/admin/v1/tokens?METHOD=DELETE">logout </a>
50 </div>
51 </div>
52 """
53
54 html_body = """
55 <h1>{item}</h1>
56 """
57
58 html_end = """
59 </body>
60 </html>
61 """
62
63 html_body_error = "<h2> Error <pre>{}</pre> </h2>"
64
65
66 html_auth2 = """
67 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
68 <html>
69 <head><META http-equiv="Content-Type" content="text/html; charset=UTF-8">
70 <link href="/osm/static/style.css" rel="stylesheet">
71 <title>OSM Login</title>
72 </head>
73 <body>
74 <div id="osm_header">
75 <div>
76 <a href="https://osm.etsi.org"> <h1><img src="/osm/static/OSM-logo.png" style="vertical-align:middle"></h1> </a>
77 </div>
78 </div>
79 <div id="osm_error_message">
80 <h1>{error}</h1>
81 </div>
82 <div class="gerritBody" id="osm_body">
83 <h1>Sign in to OSM</h1>
84 <form action="/osm/admin/v1/tokens" id="login_form" method="POST">
85 <table style="border: 0;">
86 <tr><th>Username</th><td><input id="f_user" name="username" size="25" tabindex="1" type="text"></td></tr>
87 <tr><th>Password</th><td><input id="f_pass" name="password" size="25" tabindex="2" type="password"></td></tr>
88 <tr><td><input tabindex="3" type="submit" value="Sign In"></td></tr>
89 </table>
90 </form>
91 <div style="clear: both; margin-top: 15px; padding-top: 2px; margin-bottom: 15px;">
92 <div id="osm_footer">
93 <div></div>
94 </div>
95 </div>
96 </div>
97 <script src="/osm/static/login.js"> </script>
98 </body>
99 </html>
100 """
101
102 html_upload_body = """
103 <form action="/osm{}" method="post" enctype="multipart/form-data">
104 <h3> <table style="border: 0;"> <tr>
105 <td> Upload {} descriptor (tar.gz) file: <input type="file" name="descriptor_file"/> </td>
106 <td> <input type="submit" value="Upload"/> </td>
107 </tr> </table> </h3>
108 </form>
109 """
110
111 html_nslcmop_body = """
112 <a href="/osm/nslcm/v1/ns_lcm_op_occs?nsInstanceId={id}">nslcm operations </a>
113 <a href="/osm/nslcm/v1/vnf_instances?nsr-id-ref={id}">VNFRS </a>
114 <form action="/osm/nslcm/v1/ns_instances/{id}/terminate" method="post" enctype="multipart/form-data">
115 <h3> <table style="border: 0;"> <tr>
116 <td> <input type="submit" value="Terminate"/> </td>
117 </tr> </table> </h3>
118 </form>
119 """
120
121 html_nsilcmop_body = """
122 <a href="/osm/nsilcm/v1/nsi_lcm_op_occs?netsliceInstanceId={id}">nsilcm operations </a>
123 <form action="/osm/nsilcm/v1/netslice_instances/{id}/terminate" method="post" enctype="multipart/form-data">
124 <h3> <table style="border: 0;"> <tr>
125 <td> <input type="submit" value="Terminate"/> </td>
126 </tr> </table> </h3>
127 </form>
128 """
129
130
131 def format(data, request, response, toke_info):
132 """
133 Format a nice html response, depending on the data
134 :param data:
135 :param request: cherrypy request
136 :param response: cherrypy response
137 :return: string with teh html response
138 """
139 response.headers["Content-Type"] = 'text/html'
140 if response.status == HTTPStatus.UNAUTHORIZED.value:
141 if response.headers.get("WWW-Authenticate") and request.config.get("auth.allow_basic_authentication"):
142 response.headers["WWW-Authenticate"] = "Basic" + response.headers["WWW-Authenticate"][6:]
143 return
144 else:
145 return html_auth2.format(error=data)
146 body = html_body.format(item=request.path_info)
147 if response.status and response.status > 202:
148 body += html_body_error.format(yaml.safe_dump(data, explicit_start=True, indent=4, default_flow_style=False))
149 elif isinstance(data, (list, tuple)):
150 if request.path_info == "/vnfpkgm/v1/vnf_packages":
151 body += html_upload_body.format(request.path_info, "VNFD")
152 elif request.path_info == "/nsd/v1/ns_descriptors":
153 body += html_upload_body.format(request.path_info + "_content", "NSD")
154 elif request.path_info == "/nst/v1/nst_templates":
155 body += html_upload_body.format(request.path_info + "_content", "NSTD")
156 for k in data:
157 if isinstance(k, dict):
158 data_id = k.pop("_id", None)
159 elif isinstance(k, str):
160 data_id = k
161 body += '<p> <a href="/osm/{url}/{id}">{id}</a>: {t} </p>'.format(url=request.path_info, id=data_id,
162 t=html_escape(str(k)))
163 elif isinstance(data, dict):
164 if "Location" in response.headers:
165 body += '<a href="{}"> show </a>'.format(response.headers["Location"])
166 else:
167 body += '<a href="/osm/{}?METHOD=DELETE"> <img src="/osm/static/delete.png" height="25" width="25"> </a>'\
168 .format(request.path_info)
169 if request.path_info.startswith("/nslcm/v1/ns_instances_content/") or \
170 request.path_info.startswith("/nslcm/v1/ns_instances/"):
171 _id = request.path_info[request.path_info.rfind("/")+1:]
172 body += html_nslcmop_body.format(id=_id)
173 elif request.path_info.startswith("/nsilcm/v1/netslice_instances_content/") or \
174 request.path_info.startswith("/nsilcm/v1/netslice_instances/"):
175 _id = request.path_info[request.path_info.rfind("/")+1:]
176 body += html_nsilcmop_body.format(id=_id)
177 body += "<pre>" + html_escape(yaml.safe_dump(data, explicit_start=True, indent=4, default_flow_style=False)) + \
178 "</pre>"
179 elif data is None:
180 if request.method == "DELETE" or "METHOD=DELETE" in request.query_string:
181 body += "<pre> deleted </pre>"
182 else:
183 body = html_escape(str(data))
184 user_text = " "
185 if toke_info:
186 if toke_info.get("username"):
187 user_text += "user: {}".format(toke_info.get("username"))
188 if toke_info.get("project_id"):
189 user_text += ", project: {}".format(toke_info.get("project_id"))
190 return html_start.format(user_text) + body + html_end
191 # yaml.safe_dump(data, explicit_start=True, indent=4, default_flow_style=False)
192 # tags=False,
193 # encoding='utf-8', allow_unicode=True)