osm_nbi/html_out.py

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