Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 1 | #!/usr/bin/env python3 |
Alexander Afanasyev | 9bcbc7c | 2014-04-06 19:37:37 -0700 | [diff] [blame] | 2 | # -*- Mode: python; py-indent-offset: 4; indent-tabs-mode: nil; coding: utf-8; -*- |
| 3 | |
| 4 | """ |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 5 | Copyright (c) 2014-2018, Regents of the University of California, |
Junxiao Shi | e273333 | 2016-11-24 14:11:40 +0000 | [diff] [blame] | 6 | Arizona Board of Regents, |
| 7 | Colorado State University, |
| 8 | University Pierre & Marie Curie, Sorbonne University, |
| 9 | Washington University in St. Louis, |
| 10 | Beijing Institute of Technology, |
| 11 | The University of Memphis. |
Alexander Afanasyev | 9bcbc7c | 2014-04-06 19:37:37 -0700 | [diff] [blame] | 12 | |
| 13 | This file is part of NFD (Named Data Networking Forwarding Daemon). |
| 14 | See AUTHORS.md for complete list of NFD authors and contributors. |
| 15 | |
| 16 | NFD is free software: you can redistribute it and/or modify it under the terms |
| 17 | of the GNU General Public License as published by the Free Software Foundation, |
| 18 | either version 3 of the License, or (at your option) any later version. |
| 19 | |
| 20 | NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; |
| 21 | without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR |
| 22 | PURPOSE. See the GNU General Public License for more details. |
| 23 | |
| 24 | You should have received a copy of the GNU General Public License along with |
| 25 | NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>. |
| 26 | """ |
Chengyu Fan | b07788a | 2014-03-31 12:15:36 -0600 | [diff] [blame] | 27 | |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 28 | from http.server import HTTPServer, SimpleHTTPRequestHandler |
| 29 | from socketserver import ThreadingMixIn |
| 30 | import argparse, ipaddress, os, socket, subprocess |
Chengyu Fan | b07788a | 2014-03-31 12:15:36 -0600 | [diff] [blame] | 31 | |
| 32 | |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 33 | class NfdStatusHandler(SimpleHTTPRequestHandler): |
| 34 | """ The handler class to handle requests """ |
Chengyu Fan | b07788a | 2014-03-31 12:15:36 -0600 | [diff] [blame] | 35 | def do_GET(self): |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 36 | if self.path == "/": |
| 37 | self.__serveReport() |
| 38 | elif self.path == "/robots.txt" and self.server.allowRobots: |
| 39 | self.send_error(404) |
Chengyu Fan | b07788a | 2014-03-31 12:15:36 -0600 | [diff] [blame] | 40 | else: |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 41 | super().do_GET() |
Chengyu Fan | b07788a | 2014-03-31 12:15:36 -0600 | [diff] [blame] | 42 | |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 43 | def __serveReport(self): |
| 44 | """ Obtain XML-formatted NFD status report and send it back as response body """ |
Junxiao Shi | 9137e9e | 2016-12-15 21:31:50 +0000 | [diff] [blame] | 45 | try: |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 46 | # enable universal_newlines to get output as string rather than byte sequence |
| 47 | output = subprocess.check_output(["nfdc", "status", "report", "xml"], universal_newlines=True) |
| 48 | except OSError as err: |
| 49 | super().log_message("error invoking nfdc: {}".format(err)) |
| 50 | self.send_error(500) |
| 51 | except subprocess.CalledProcessError as err: |
| 52 | super().log_message("error invoking nfdc: command exited with status {}".format(err.returncode)) |
| 53 | self.send_error(504, "Cannot connect to NFD (code {})".format(err.returncode)) |
| 54 | else: |
Junxiao Shi | 9137e9e | 2016-12-15 21:31:50 +0000 | [diff] [blame] | 55 | # add stylesheet processing instruction after the XML document type declaration |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 56 | # (yes, this is a ugly hack) |
| 57 | pos = output.index(">") + 1 |
Junxiao Shi | 9137e9e | 2016-12-15 21:31:50 +0000 | [diff] [blame] | 58 | xml = output[:pos]\ |
| 59 | + '<?xml-stylesheet type="text/xsl" href="nfd-status.xsl"?>'\ |
| 60 | + output[pos:] |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 61 | self.send_response(200) |
| 62 | self.send_header("Content-Type", "text/xml; charset=UTF-8") |
| 63 | self.end_headers() |
| 64 | self.wfile.write(xml.encode()) |
Chengyu Fan | b07788a | 2014-03-31 12:15:36 -0600 | [diff] [blame] | 65 | |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 66 | # override |
| 67 | def log_message(self, *args): |
| 68 | if self.server.verbose: |
| 69 | super().log_message(*args) |
| 70 | |
| 71 | |
| 72 | class ThreadingHttpServer(ThreadingMixIn, HTTPServer): |
Chengyu Fan | e25b0f0 | 2014-04-05 21:42:40 -0600 | [diff] [blame] | 73 | """ Handle requests using threads """ |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 74 | def __init__(self, bindAddr, port, handler, allowRobots=False, verbose=False): |
| 75 | # socketserver.BaseServer defaults to AF_INET even if you provide an IPv6 address |
| 76 | # see https://bugs.python.org/issue20215 and https://bugs.python.org/issue24209 |
| 77 | if bindAddr.version == 6: |
Chengyu Fan | e25b0f0 | 2014-04-05 21:42:40 -0600 | [diff] [blame] | 78 | self.address_family = socket.AF_INET6 |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 79 | self.allowRobots = allowRobots |
Chengyu Fan | b07788a | 2014-03-31 12:15:36 -0600 | [diff] [blame] | 80 | self.verbose = verbose |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 81 | super().__init__((str(bindAddr), port), handler) |
Chengyu Fan | b07788a | 2014-03-31 12:15:36 -0600 | [diff] [blame] | 82 | |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 83 | |
| 84 | def main(): |
| 85 | def ipAddress(arg): |
| 86 | """ Validate IP address """ |
Chengyu Fan | e25b0f0 | 2014-04-05 21:42:40 -0600 | [diff] [blame] | 87 | try: |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 88 | value = ipaddress.ip_address(arg) |
| 89 | except ValueError: |
| 90 | raise argparse.ArgumentTypeError("{!r} is not a valid IP address".format(arg)) |
| 91 | return value |
| 92 | |
| 93 | def portNumber(arg): |
| 94 | """ Validate port number """ |
Chengyu Fan | e25b0f0 | 2014-04-05 21:42:40 -0600 | [diff] [blame] | 95 | try: |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 96 | value = int(arg) |
| 97 | except ValueError: |
| 98 | value = -1 |
| 99 | if value < 0 or value > 65535: |
| 100 | raise argparse.ArgumentTypeError("{!r} is not a valid port number".format(arg)) |
| 101 | return value |
Chengyu Fan | e25b0f0 | 2014-04-05 21:42:40 -0600 | [diff] [blame] | 102 | |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 103 | parser = argparse.ArgumentParser(description="Serves NFD status page via HTTP") |
| 104 | parser.add_argument("-V", "--version", action="version", version="@VERSION@") |
| 105 | parser.add_argument("-a", "--address", default="127.0.0.1", type=ipAddress, metavar="ADDR", |
| 106 | help="bind to this IP address (default: %(default)s)") |
| 107 | parser.add_argument("-p", "--port", default=8080, type=portNumber, |
| 108 | help="bind to this port number (default: %(default)s)") |
| 109 | parser.add_argument("-f", "--workdir", default="@DATAROOTDIR@/ndn", metavar="DIR", |
| 110 | help="server's working directory (default: %(default)s)") |
| 111 | parser.add_argument("-r", "--robots", action="store_true", |
| 112 | help="allow crawlers and other HTTP bots") |
| 113 | parser.add_argument("-v", "--verbose", action="store_true", |
| 114 | help="turn on verbose logging") |
| 115 | args = parser.parse_args() |
Chengyu Fan | b07788a | 2014-03-31 12:15:36 -0600 | [diff] [blame] | 116 | |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 117 | os.chdir(args.workdir) |
Chengyu Fan | b07788a | 2014-03-31 12:15:36 -0600 | [diff] [blame] | 118 | |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 119 | httpd = ThreadingHttpServer(args.address, args.port, NfdStatusHandler, |
| 120 | allowRobots=args.robots, verbose=args.verbose) |
Alexander Afanasyev | b47d538 | 2014-05-05 14:35:03 -0700 | [diff] [blame] | 121 | |
Chengyu Fan | e25b0f0 | 2014-04-05 21:42:40 -0600 | [diff] [blame] | 122 | if httpd.address_family == socket.AF_INET6: |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 123 | url = "http://[{}]:{}" |
Chengyu Fan | e25b0f0 | 2014-04-05 21:42:40 -0600 | [diff] [blame] | 124 | else: |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 125 | url = "http://{}:{}" |
| 126 | print("Server started at", url.format(*httpd.server_address)) |
Chengyu Fan | b07788a | 2014-03-31 12:15:36 -0600 | [diff] [blame] | 127 | |
| 128 | try: |
| 129 | httpd.serve_forever() |
| 130 | except KeyboardInterrupt: |
| 131 | pass |
Chengyu Fan | b07788a | 2014-03-31 12:15:36 -0600 | [diff] [blame] | 132 | httpd.server_close() |
| 133 | |
Chengyu Fan | b07788a | 2014-03-31 12:15:36 -0600 | [diff] [blame] | 134 | |
Davide Pesavento | 56a741f | 2018-02-10 16:30:59 -0500 | [diff] [blame] | 135 | if __name__ == "__main__": |
| 136 | main() |