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