Gitiles
Code Review Sign In
osm.etsi.org / osm / NBI / e42d203d231fe1dd3a5445fa5f93687f07eafcf2 / . / osm_nbi / html_out.py
blob: 5fd12ce45b947e4eac3e51f8dd4504b30815723d [file] [log] [blame]
tiernod125caf2018-11-22 16:05:54 +0000[diff] [blame]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
tiernoc94c3df2018-02-09 15:38:54 +0100[diff] [blame]14"""
15Contains html text in variables to make and html response
16"""
17
18import yaml
19from http import HTTPStatus
tiernoef4e2242018-10-31 17:09:52 +0100[diff] [blame]20from html import escape as html_escape
tiernoc94c3df2018-02-09 15:38:54 +0100[diff] [blame]21
22__author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
23
24html_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>
tierno2236d202018-05-16 19:05:16 +0200[diff] [blame]34 <a href="https://osm.etsi.org"> <img src="/osm/static/OSM-logo.png" height="42" width="100"
35 style="vertical-align:middle"> </a>
tiernoc94c3df2018-02-09 15:38:54 +0100[diff] [blame]36 <a>( {} )</a>
tierno36ec8602018-11-02 17:27:11 +0100[diff] [blame]37 <a href="/osm/pdu/v1/pdu_descriptors">PDUs </a>
tiernob24258a2018-10-04 18:39:49 +0200[diff] [blame]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>
Felipe Vicensb57758d2018-10-16 16:00:20 +0200[diff] [blame]41 <a href="/osm/nst/v1/netslice_templates">NSTDs </a>
Felipe Vicens07f31722018-10-29 15:16:44 +0100[diff] [blame]42 <a href="/osm/nsilcm/v1/netslice_instances">NSIs </a>
tiernof27c79b2018-03-12 17:08:42 +0100[diff] [blame]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>
tiernof759d822018-06-11 18:54:54 +0200[diff] [blame]46 <a href="/osm/admin/v1/vim_accounts">VIMs </a>
tierno55ba2e62018-12-11 17:22:22 +0000[diff] [blame]47 <a href="/osm/admin/v1/wim_accounts">WIMs </a>
tiernof759d822018-06-11 18:54:54 +0200[diff] [blame]48 <a href="/osm/admin/v1/sdns">SDNs </a>
tierno7fd24872019-12-10 10:57:17 +0000[diff] [blame]49 <a href="/osm/admin/v1/k8sclusters">K8s_clusters </a>
tiernoc67b0e92019-11-05 12:45:29 +0000[diff] [blame]50 <a href="/osm/admin/v1/k8srepos">K8s_repos </a>
tiernof27c79b2018-03-12 17:08:42 +0100[diff] [blame]51 <a href="/osm/admin/v1/tokens?METHOD=DELETE">logout </a>
tiernoc94c3df2018-02-09 15:38:54 +0100[diff] [blame]52 </div>
53 </div>
54"""
55
56html_body = """
57<h1>{item}</h1>
58"""
59
60html_end = """
61</body>
tierno2236d202018-05-16 19:05:16 +0200[diff] [blame]62</html>
tiernoc94c3df2018-02-09 15:38:54 +0100[diff] [blame]63"""
64
65html_body_error = "<h2> Error <pre>{}</pre> </h2>"
66
67
tiernoc94c3df2018-02-09 15:38:54 +0100[diff] [blame]68html_auth2 = """
69<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
70<html>
71<head><META http-equiv="Content-Type" content="text/html; charset=UTF-8">
72 <link href="/osm/static/style.css" rel="stylesheet">
73 <title>OSM Login</title>
74</head>
75<body>
76 <div id="osm_header">
77 <div>
78 <a href="https://osm.etsi.org"> <h1><img src="/osm/static/OSM-logo.png" style="vertical-align:middle"></h1> </a>
79 </div>
80 </div>
81 <div id="osm_error_message">
82 <h1>{error}</h1>
83 </div>
84 <div class="gerritBody" id="osm_body">
85 <h1>Sign in to OSM</h1>
tiernof27c79b2018-03-12 17:08:42 +0100[diff] [blame]86 <form action="/osm/admin/v1/tokens" id="login_form" method="POST">
tiernoc94c3df2018-02-09 15:38:54 +0100[diff] [blame]87 <table style="border: 0;">
88 <tr><th>Username</th><td><input id="f_user" name="username" size="25" tabindex="1" type="text"></td></tr>
89 <tr><th>Password</th><td><input id="f_pass" name="password" size="25" tabindex="2" type="password"></td></tr>
90 <tr><td><input tabindex="3" type="submit" value="Sign In"></td></tr>
91 </table>
92 </form>
93 <div style="clear: both; margin-top: 15px; padding-top: 2px; margin-bottom: 15px;">
94 <div id="osm_footer">
95 <div></div>
96 </div>
97 </div>
98 </div>
99 <script src="/osm/static/login.js"> </script>
100</body>
101</html>
102"""
103
104html_upload_body = """
105<form action="/osm{}" method="post" enctype="multipart/form-data">
106 <h3> <table style="border: 0;"> <tr>
107 <td> Upload {} descriptor (tar.gz) file: <input type="file" name="descriptor_file"/> </td>
108 <td> <input type="submit" value="Upload"/> </td>
109 </tr> </table> </h3>
110</form>
111"""
112
tierno65acb4d2018-04-06 16:42:40 +0200[diff] [blame]113html_nslcmop_body = """
114<a href="/osm/nslcm/v1/ns_lcm_op_occs?nsInstanceId={id}">nslcm operations </a>
tiernof759d822018-06-11 18:54:54 +0200[diff] [blame]115<a href="/osm/nslcm/v1/vnf_instances?nsr-id-ref={id}">VNFRS </a>
tierno65acb4d2018-04-06 16:42:40 +0200[diff] [blame]116<form action="/osm/nslcm/v1/ns_instances/{id}/terminate" method="post" enctype="multipart/form-data">
117 <h3> <table style="border: 0;"> <tr>
118 <td> <input type="submit" value="Terminate"/> </td>
119 </tr> </table> </h3>
120</form>
121"""
122
Felipe Vicens07f31722018-10-29 15:16:44 +0100[diff] [blame]123html_nsilcmop_body = """
Felipe Vicens126af572019-06-05 19:13:04 +0200[diff] [blame]124<a href="/osm/nsilcm/v1/nsi_lcm_op_occs?netsliceInstanceId={id}">nsilcm operations </a>
Felipe Vicens07f31722018-10-29 15:16:44 +0100[diff] [blame]125<form action="/osm/nsilcm/v1/netslice_instances/{id}/terminate" method="post" enctype="multipart/form-data">
126 <h3> <table style="border: 0;"> <tr>
127 <td> <input type="submit" value="Terminate"/> </td>
128 </tr> </table> </h3>
129</form>
130"""
131
tiernoc94c3df2018-02-09 15:38:54 +0100[diff] [blame]132
tierno701018c2019-06-25 11:13:14 +0000[diff] [blame]133def format(data, request, response, toke_info):
tiernoc94c3df2018-02-09 15:38:54 +0100[diff] [blame]134 """
135 Format a nice html response, depending on the data
136 :param data:
137 :param request: cherrypy request
138 :param response: cherrypy response
139 :return: string with teh html response
140 """
141 response.headers["Content-Type"] = 'text/html'
142 if response.status == HTTPStatus.UNAUTHORIZED.value:
143 if response.headers.get("WWW-Authenticate") and request.config.get("auth.allow_basic_authentication"):
144 response.headers["WWW-Authenticate"] = "Basic" + response.headers["WWW-Authenticate"][6:]
145 return
146 else:
147 return html_auth2.format(error=data)
tierno5792d7d2019-08-30 15:37:12 +0000[diff] [blame]148 if request.path_info in ("/version", "/system"):
149 return "<pre>" + yaml.safe_dump(data, explicit_start=False, indent=4, default_flow_style=False) + "</pre>"
tiernoc94c3df2018-02-09 15:38:54 +0100[diff] [blame]150 body = html_body.format(item=request.path_info)
151 if response.status and response.status > 202:
152 body += html_body_error.format(yaml.safe_dump(data, explicit_start=True, indent=4, default_flow_style=False))
153 elif isinstance(data, (list, tuple)):
tiernob24258a2018-10-04 18:39:49 +0200[diff] [blame]154 if request.path_info == "/vnfpkgm/v1/vnf_packages":
tiernoc67b0e92019-11-05 12:45:29 +0000[diff] [blame]155 body += html_upload_body.format(request.path_info + "_content", "VNFD")
tiernob24258a2018-10-04 18:39:49 +0200[diff] [blame]156 elif request.path_info == "/nsd/v1/ns_descriptors":
157 body += html_upload_body.format(request.path_info + "_content", "NSD")
Felipe Vicensb57758d2018-10-16 16:00:20 +0200[diff] [blame]158 elif request.path_info == "/nst/v1/nst_templates":
159 body += html_upload_body.format(request.path_info + "_content", "NSTD")
tiernoc94c3df2018-02-09 15:38:54 +0100[diff] [blame]160 for k in data:
tiernof27c79b2018-03-12 17:08:42 +0100[diff] [blame]161 if isinstance(k, dict):
162 data_id = k.pop("_id", None)
163 elif isinstance(k, str):
164 data_id = k
tiernoef4e2242018-10-31 17:09:52 +0100[diff] [blame]165 body += '<p> <a href="/osm/{url}/{id}">{id}</a>: {t} </p>'.format(url=request.path_info, id=data_id,
166 t=html_escape(str(k)))
tiernoc94c3df2018-02-09 15:38:54 +0100[diff] [blame]167 elif isinstance(data, dict):
168 if "Location" in response.headers:
169 body += '<a href="{}"> show </a>'.format(response.headers["Location"])
170 else:
tierno2236d202018-05-16 19:05:16 +0200[diff] [blame]171 body += '<a href="/osm/{}?METHOD=DELETE"> <img src="/osm/static/delete.png" height="25" width="25"> </a>'\
172 .format(request.path_info)
tierno65acb4d2018-04-06 16:42:40 +0200[diff] [blame]173 if request.path_info.startswith("/nslcm/v1/ns_instances_content/") or \
174 request.path_info.startswith("/nslcm/v1/ns_instances/"):
175 _id = request.path_info[request.path_info.rfind("/")+1:]
176 body += html_nslcmop_body.format(id=_id)
Felipe Vicens07f31722018-10-29 15:16:44 +0100[diff] [blame]177 elif request.path_info.startswith("/nsilcm/v1/netslice_instances_content/") or \
178 request.path_info.startswith("/nsilcm/v1/netslice_instances/"):
179 _id = request.path_info[request.path_info.rfind("/")+1:]
180 body += html_nsilcmop_body.format(id=_id)
tiernoef4e2242018-10-31 17:09:52 +0100[diff] [blame]181 body += "<pre>" + html_escape(yaml.safe_dump(data, explicit_start=True, indent=4, default_flow_style=False)) + \
182 "</pre>"
tierno0f98af52018-03-19 10:28:22 +0100[diff] [blame]183 elif data is None:
184 if request.method == "DELETE" or "METHOD=DELETE" in request.query_string:
185 body += "<pre> deleted </pre>"
tiernoc94c3df2018-02-09 15:38:54 +0100[diff] [blame]186 else:
tiernoef4e2242018-10-31 17:09:52 +0100[diff] [blame]187 body = html_escape(str(data))
tiernoc94c3df2018-02-09 15:38:54 +0100[diff] [blame]188 user_text = " "
tierno701018c2019-06-25 11:13:14 +0000[diff] [blame]189 if toke_info:
190 if toke_info.get("username"):
191 user_text += "user: {}".format(toke_info.get("username"))
192 if toke_info.get("project_id"):
tierno19ee3b02019-08-28 13:30:23 +0000[diff] [blame]193 user_text += ", project: {}".format(toke_info.get("project_name"))
tiernoc94c3df2018-02-09 15:38:54 +0100[diff] [blame]194 return html_start.format(user_text) + body + html_end
tierno2236d202018-05-16 19:05:16 +0200[diff] [blame]195 # yaml.safe_dump(data, explicit_start=True, indent=4, default_flow_style=False)
tiernoc94c3df2018-02-09 15:38:54 +0100[diff] [blame]196 # tags=False,
197 # encoding='utf-8', allow_unicode=True)