From 1e2c0e679beb33f10c2e551768c17ccd77576b54 Mon Sep 17 00:00:00 2001 From: Roman Bazalevsky Date: Thu, 23 Jul 2015 19:43:57 +0300 Subject: [PATCH 1/1] Initial release. --- LICENSE | 20 + README.md | 8 + clientcounter.py | 38 + plugins/__init__.py | 0 plugins/config/__init__.py | 1 + plugins/config/m3u.py | 8 + plugins/m3u_plugin.py | 87 ++ plugins/modules/M3uParser.py | 61 + plugins/modules/PlaylistGenerator.py | 60 + plugins/modules/PluginInterface.py | 19 + plugins/modules/__init__.py | 0 plugins/modules/ipaddr.py | 1865 ++++++++++++++++++++++++++ plugins/stat_plugin.py | 27 + vlcclient/__init__.py | 1 + vlcclient/vlcclient.py | 224 ++++ vlcclient/vlcmessages.py | 38 + vpconfig.py | 102 ++ vphttp.py | 529 ++++++++ 18 files changed, 3088 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 clientcounter.py create mode 100644 plugins/__init__.py create mode 100644 plugins/config/__init__.py create mode 100644 plugins/config/m3u.py create mode 100644 plugins/m3u_plugin.py create mode 100644 plugins/modules/M3uParser.py create mode 100644 plugins/modules/PlaylistGenerator.py create mode 100644 plugins/modules/PluginInterface.py create mode 100644 plugins/modules/__init__.py create mode 100644 plugins/modules/ipaddr.py create mode 100644 plugins/stat_plugin.py create mode 100644 vlcclient/__init__.py create mode 100644 vlcclient/vlcclient.py create mode 100644 vlcclient/vlcmessages.py create mode 100644 vpconfig.py create mode 100644 vphttp.py diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..12f8cf5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +The MIT License (MIT) + +Copyright (c) 2013 ValdikSS + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..24b72df --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +AceProxy: Ace Stream HTTP Proxy +=============================== +AceProxy allows you to watch [Ace Stream](http://acestream.org/) live streams or BitTorrent files over HTTP. +It's written in Python + gevent and should work on both Linux and Windows (Mac OS should work too, but was not tested) + +Currently it supports Ace Stream Content-ID hashes (PIDs), .acestream files and usual torrent files. + +**For installation, configuration and using info, visit** [Wiki](https://github.com/ValdikSS/aceproxy/wiki) diff --git a/clientcounter.py b/clientcounter.py new file mode 100644 index 0000000..bcfd0b2 --- /dev/null +++ b/clientcounter.py @@ -0,0 +1,38 @@ +''' +Simple Client Counter for VLC VLM +''' + + +class ClientCounter(object): + + def __init__(self): + self.clients = dict() + self.total = 0 + + def get(self, id): + return self.clients.get(id, (False,))[0] + + def add(self, id, ip): + if self.clients.has_key(id): + self.clients[id][0] += 1 + self.clients[id][1].append(ip) + else: + self.clients[id] = [1, [ip]] + + self.total += 1 + return self.clients[id][0] + + def delete(self, id, ip): + if self.clients.has_key(id): + self.total -= 1 + if self.clients[id][0] == 1: + del self.clients[id] + return False + else: + self.clients[id][0] -= 1 + self.clients[id][1].remove(ip) + else: + return False + + return self.clients[id][0] + diff --git a/plugins/__init__.py b/plugins/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/plugins/config/__init__.py b/plugins/config/__init__.py new file mode 100644 index 0000000..8d1c8b6 --- /dev/null +++ b/plugins/config/__init__.py @@ -0,0 +1 @@ + diff --git a/plugins/config/m3u.py b/plugins/config/m3u.py new file mode 100644 index 0000000..ed48a76 --- /dev/null +++ b/plugins/config/m3u.py @@ -0,0 +1,8 @@ +__author__ = 'rvb' +''' +Local Playlist Plugin configuration file +''' + +# Channels urls +m3u_directory = '/var/xupnpd/playlists/' +m3u_default = 'tv.m3u' diff --git a/plugins/m3u_plugin.py b/plugins/m3u_plugin.py new file mode 100644 index 0000000..4104e43 --- /dev/null +++ b/plugins/m3u_plugin.py @@ -0,0 +1,87 @@ +__author__ = 'rvb' +''' +Local Playlist Plugin +(based on ytv plugin by ValdikSS) +http://ip:port/m3u +http://ip:port/m3u/index +http://ip:port/m3u{/list-name} +''' +import json +import logging +import urlparse +from modules.PluginInterface import VPProxyPlugin +from modules.PlaylistGenerator import PlaylistGenerator +from modules.M3uParser import parseM3U +import config.m3u as config +import os + +class M3u(VPProxyPlugin): + + handlers = ('m3u', ) + + logger = logging.getLogger('plugin_m3u') + playlist = None + + def handle(self, connection): + + hostport = connection.headers['Host'] + + self.splitted_path=connection.path.split('/') + + if len(self.splitted_path)>3: + connection.dieWithError() + return + + if len(self.splitted_path)<3: + + m3u_file=config.m3u_directory+'/'+config.m3u_default + + else: + + if self.splitted_path[2]=='index': + for dir in os.walk(config.m3u_directory): + if dir[0]==config.m3u_directory: + text='\n'.join(dir[2]) + + connection.send_response(200) + connection.send_header('Content-Type', 'text/plain') + connection.end_headers() + + listing = text.encode('utf-8') + connection.wfile.write(listing) + + return + + m3u_file=config.m3u_directory+'/'+self.splitted_path[2] + + connection.send_response(200) + connection.send_header('Content-Type', 'application/x-mpegurl') + connection.end_headers() + + try: + playlist=parseM3U(m3u_file) + except: + connection.dieWithError() + return + + if not playlist: + connection.dieWithError() + return + + playlistgen = PlaylistGenerator() + + for record in playlist: + channel=dict() + channel['name']=record.title.decode('utf-8') + channel['url']=record.path.decode('utf-8') + playlistgen.addItem(channel) + + exported = playlistgen.exportm3u(hostport) + exported = exported.encode('utf-8') + connection.wfile.write(exported) + + def getparam(self, key): + if key in self.params: + return self.params[key][0] + else: + return None diff --git a/plugins/modules/M3uParser.py b/plugins/modules/M3uParser.py new file mode 100644 index 0000000..01dbcc9 --- /dev/null +++ b/plugins/modules/M3uParser.py @@ -0,0 +1,61 @@ +# more info on the M3U file format available here: +# http://n4k3d.com/the-m3u-file-format/ + +import sys + +class track(): + def __init__(self, length, title, path): + self.length = length + self.title = title + self.path = path + + +# # # song info lines are formatted like: +#EXTINF:419,Alice In Chains - Rotten Apple +# length (seconds) +# Song title +# # # file name - relative or absolute path of file +# ..\Minus The Bear - Planet of Ice\Minus The Bear_Planet of Ice_01_Burying Luck.mp3 +def parseM3U(infile): + inf = open(infile,'r') + + # # # all m3u files should start with this line: + #EXTM3U + # this is not a valid M3U and we should stop.. + line = inf.readline() + if not line.startswith('#EXTM3U'): + return + + # initialize playlist variables before reading file + playlist=[] + song=track(None,None,None) + + for line in inf: + line=line.strip() + if line.startswith('#EXTINF:'): + # pull length and title from #EXTINF line + length,title=line.split('#EXTINF:')[1].split(',',1) + song=track(length,title,None) + elif (len(line) != 0): + # pull song path from all other, non-blank lines + song.path=line + playlist.append(song) + + # reset the song variable so it doesn't use the same EXTINF more than once + song=track(None,None,None) + + inf.close() + + return playlist + +# for now, just pull the track info and print it onscreen +# get the M3U file path from the first command line argument +def main(): + m3ufile=sys.argv[1] + playlist = parseM3U(m3ufile) + for track in playlist: + print (track.title, track.length, track.path) + +if __name__ == '__main__': + main() + diff --git a/plugins/modules/PlaylistGenerator.py b/plugins/modules/PlaylistGenerator.py new file mode 100644 index 0000000..e5402b2 --- /dev/null +++ b/plugins/modules/PlaylistGenerator.py @@ -0,0 +1,60 @@ +''' +Playlist Generator +This module can generate .m3u playlists with tv guide +and groups +''' +import re +import urllib2 + +class PlaylistGenerator(object): + + m3uheader = \ + '#EXTM3U url-tvg="http://www.teleguide.info/download/new3/jtv.zip"\n' + m3uemptyheader = '#EXTM3U\n' + m3uchanneltemplate = \ + '#EXTINF:-1 group-title="%s" tvg-name="%s" tvg-logo="%s",%s\n%s\n' + + def __init__(self): + self.itemlist = list() + + def addItem(self, itemdict): + ''' + Adds item to the list + itemdict is a dictionary with the following fields: + name - item name + url - item URL + tvg - item JTV name (optional) + group - item playlist group (optional) + logo - item logo file name (optional) + ''' + self.itemlist.append(itemdict) + + @staticmethod + def _generatem3uline(item): + ''' + Generates EXTINF line with url + ''' + return PlaylistGenerator.m3uchanneltemplate % ( + item.get('group', ''), item.get('tvg', ''), item.get('logo', ''), + item.get('name'), item.get('url')) + + def exportm3u(self, hostport, add_ts=False, empty_header=False, archive=False): + ''' + Exports m3u playlist + ''' + if not empty_header: + itemlist = PlaylistGenerator.m3uheader + else: + itemlist = PlaylistGenerator.m3uemptyheader + if add_ts: + # Adding ts:// after http:// for some players + hostport = 'ts://' + hostport + + for item in self.itemlist: + item['tvg'] = item.get('tvg', '') if item.get('tvg') else \ + item.get('name').replace(' ', '_') + # For .acelive and .torrent + item['url'] = 'http://' + hostport + '/get/'+item['url'] + itemlist += PlaylistGenerator._generatem3uline(item) + + return itemlist diff --git a/plugins/modules/PluginInterface.py b/plugins/modules/PluginInterface.py new file mode 100644 index 0000000..29438d8 --- /dev/null +++ b/plugins/modules/PluginInterface.py @@ -0,0 +1,19 @@ +''' +Plugin interface. +Interhit your plugins from this class. + +Your plugin name should end with _plugin.py, e.g. example_plugin.py +Your class name should match plugin name and be capitalized, e.g. Example +Do not use dots in filename or class name. + +See helloworld_plugin_.py for the basic plugin example. +''' + + +class VPProxyPlugin(object): + + def __init__(self, AceConfig, AceStuff): + pass + + def handle(self, connection): + raise NotImplementedError diff --git a/plugins/modules/__init__.py b/plugins/modules/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/plugins/modules/ipaddr.py b/plugins/modules/ipaddr.py new file mode 100644 index 0000000..0c85143 --- /dev/null +++ b/plugins/modules/ipaddr.py @@ -0,0 +1,1865 @@ +#!/usr/bin/python +# +# Copyright 2007 Google Inc. +# Licensed to PSF under a Contributor Agreement. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. See the License for the specific language governing +# permissions and limitations under the License. + +"""A fast, lightweight IPv4/IPv6 manipulation library in Python. + +This library is used to create/poke/manipulate IPv4 and IPv6 addresses +and networks. + +""" + +__version__ = '2.1.11' + +import struct + +IPV4LENGTH = 32 +IPV6LENGTH = 128 + + +class AddressValueError(ValueError): + """A Value Error related to the address.""" + + +class NetmaskValueError(ValueError): + """A Value Error related to the netmask.""" + + +def IPAddress(address, version=None): + """Take an IP string/int and return an object of the correct type. + + Args: + address: A string or integer, the IP address. Either IPv4 or + IPv6 addresses may be supplied; integers less than 2**32 will + be considered to be IPv4 by default. + version: An Integer, 4 or 6. If set, don't try to automatically + determine what the IP address type is. important for things + like IPAddress(1), which could be IPv4, '0.0.0.1', or IPv6, + '::1'. + + Returns: + An IPv4Address or IPv6Address object. + + Raises: + ValueError: if the string passed isn't either a v4 or a v6 + address. + + """ + if version: + if version == 4: + return IPv4Address(address) + elif version == 6: + return IPv6Address(address) + + try: + return IPv4Address(address) + except (AddressValueError, NetmaskValueError): + pass + + try: + return IPv6Address(address) + except (AddressValueError, NetmaskValueError): + pass + + raise ValueError('%r does not appear to be an IPv4 or IPv6 address' % + address) + + +def IPNetwork(address, version=None, strict=False): + """Take an IP string/int and return an object of the correct type. + + Args: + address: A string or integer, the IP address. Either IPv4 or + IPv6 addresses may be supplied; integers less than 2**32 will + be considered to be IPv4 by default. + version: An Integer, if set, don't try to automatically + determine what the IP address type is. important for things + like IPNetwork(1), which could be IPv4, '0.0.0.1/32', or IPv6, + '::1/128'. + + Returns: + An IPv4Network or IPv6Network object. + + Raises: + ValueError: if the string passed isn't either a v4 or a v6 + address. Or if a strict network was requested and a strict + network wasn't given. + + """ + if version: + if version == 4: + return IPv4Network(address, strict) + elif version == 6: + return IPv6Network(address, strict) + + try: + return IPv4Network(address, strict) + except (AddressValueError, NetmaskValueError): + pass + + try: + return IPv6Network(address, strict) + except (AddressValueError, NetmaskValueError): + pass + + raise ValueError('%r does not appear to be an IPv4 or IPv6 network' % + address) + + +def v4_int_to_packed(address): + """The binary representation of this address. + + Args: + address: An integer representation of an IPv4 IP address. + + Returns: + The binary representation of this address. + + Raises: + ValueError: If the integer is too large to be an IPv4 IP + address. + """ + if address > _BaseV4._ALL_ONES: + raise ValueError('Address too large for IPv4') + return Bytes(struct.pack('!I', address)) + + +def v6_int_to_packed(address): + """The binary representation of this address. + + Args: + address: An integer representation of an IPv6 IP address. + + Returns: + The binary representation of this address. + """ + return Bytes(struct.pack('!QQ', address >> 64, address & (2**64 - 1))) + + +def _find_address_range(addresses): + """Find a sequence of addresses. + + Args: + addresses: a list of IPv4 or IPv6 addresses. + + Returns: + A tuple containing the first and last IP addresses in the sequence. + + """ + first = last = addresses[0] + for ip in addresses[1:]: + if ip._ip == last._ip + 1: + last = ip + else: + break + return (first, last) + +def _get_prefix_length(number1, number2, bits): + """Get the number of leading bits that are same for two numbers. + + Args: + number1: an integer. + number2: another integer. + bits: the maximum number of bits to compare. + + Returns: + The number of leading bits that are the same for two numbers. + + """ + for i in range(bits): + if number1 >> i == number2 >> i: + return bits - i + return 0 + +def _count_righthand_zero_bits(number, bits): + """Count the number of zero bits on the right hand side. + + Args: + number: an integer. + bits: maximum number of bits to count. + + Returns: + The number of zero bits on the right hand side of the number. + + """ + if number == 0: + return bits + for i in range(bits): + if (number >> i) % 2: + return i + +def summarize_address_range(first, last): + """Summarize a network range given the first and last IP addresses. + + Example: + >>> summarize_address_range(IPv4Address('1.1.1.0'), + IPv4Address('1.1.1.130')) + [IPv4Network('1.1.1.0/25'), IPv4Network('1.1.1.128/31'), + IPv4Network('1.1.1.130/32')] + + Args: + first: the first IPv4Address or IPv6Address in the range. + last: the last IPv4Address or IPv6Address in the range. + + Returns: + The address range collapsed to a list of IPv4Network's or + IPv6Network's. + + Raise: + TypeError: + If the first and last objects are not IP addresses. + If the first and last objects are not the same version. + ValueError: + If the last object is not greater than the first. + If the version is not 4 or 6. + + """ + if not (isinstance(first, _BaseIP) and isinstance(last, _BaseIP)): + raise TypeError('first and last must be IP addresses, not networks') + if first.version != last.version: + raise TypeError("%s and %s are not of the same version" % ( + str(first), str(last))) + if first > last: + raise ValueError('last IP address must be greater than first') + + networks = [] + + if first.version == 4: + ip = IPv4Network + elif first.version == 6: + ip = IPv6Network + else: + raise ValueError('unknown IP version') + + ip_bits = first._max_prefixlen + first_int = first._ip + last_int = last._ip + while first_int <= last_int: + nbits = _count_righthand_zero_bits(first_int, ip_bits) + current = None + while nbits >= 0: + addend = 2**nbits - 1 + current = first_int + addend + nbits -= 1 + if current <= last_int: + break + prefix = _get_prefix_length(first_int, current, ip_bits) + net = ip('%s/%d' % (str(first), prefix)) + networks.append(net) + if current == ip._ALL_ONES: + break + first_int = current + 1 + first = IPAddress(first_int, version=first._version) + return networks + +def _collapse_address_list_recursive(addresses): + """Loops through the addresses, collapsing concurrent netblocks. + + Example: + + ip1 = IPv4Network('1.1.0.0/24') + ip2 = IPv4Network('1.1.1.0/24') + ip3 = IPv4Network('1.1.2.0/24') + ip4 = IPv4Network('1.1.3.0/24') + ip5 = IPv4Network('1.1.4.0/24') + ip6 = IPv4Network('1.1.0.1/22') + + _collapse_address_list_recursive([ip1, ip2, ip3, ip4, ip5, ip6]) -> + [IPv4Network('1.1.0.0/22'), IPv4Network('1.1.4.0/24')] + + This shouldn't be called directly; it is called via + collapse_address_list([]). + + Args: + addresses: A list of IPv4Network's or IPv6Network's + + Returns: + A list of IPv4Network's or IPv6Network's depending on what we were + passed. + + """ + ret_array = [] + optimized = False + + for cur_addr in addresses: + if not ret_array: + ret_array.append(cur_addr) + continue + if cur_addr in ret_array[-1]: + optimized = True + elif cur_addr == ret_array[-1].supernet().subnet()[1]: + ret_array.append(ret_array.pop().supernet()) + optimized = True + else: + ret_array.append(cur_addr) + + if optimized: + return _collapse_address_list_recursive(ret_array) + + return ret_array + + +def collapse_address_list(addresses): + """Collapse a list of IP objects. + + Example: + collapse_address_list([IPv4('1.1.0.0/24'), IPv4('1.1.1.0/24')]) -> + [IPv4('1.1.0.0/23')] + + Args: + addresses: A list of IPv4Network or IPv6Network objects. + + Returns: + A list of IPv4Network or IPv6Network objects depending on what we + were passed. + + Raises: + TypeError: If passed a list of mixed version objects. + + """ + i = 0 + addrs = [] + ips = [] + nets = [] + + # split IP addresses and networks + for ip in addresses: + if isinstance(ip, _BaseIP): + if ips and ips[-1]._version != ip._version: + raise TypeError("%s and %s are not of the same version" % ( + str(ip), str(ips[-1]))) + ips.append(ip) + elif ip._prefixlen == ip._max_prefixlen: + if ips and ips[-1]._version != ip._version: + raise TypeError("%s and %s are not of the same version" % ( + str(ip), str(ips[-1]))) + ips.append(ip.ip) + else: + if nets and nets[-1]._version != ip._version: + raise TypeError("%s and %s are not of the same version" % ( + str(ip), str(nets[-1]))) + nets.append(ip) + + # sort and dedup + ips = sorted(set(ips)) + nets = sorted(set(nets)) + + while i < len(ips): + (first, last) = _find_address_range(ips[i:]) + i = ips.index(last) + 1 + addrs.extend(summarize_address_range(first, last)) + + return _collapse_address_list_recursive(sorted( + addrs + nets, key=_BaseNet._get_networks_key)) + +# backwards compatibility +CollapseAddrList = collapse_address_list + +# We need to distinguish between the string and packed-bytes representations +# of an IP address. For example, b'0::1' is the IPv4 address 48.58.58.49, +# while '0::1' is an IPv6 address. +# +# In Python 3, the native 'bytes' type already provides this functionality, +# so we use it directly. For earlier implementations where bytes is not a +# distinct type, we create a subclass of str to serve as a tag. +# +# Usage example (Python 2): +# ip = ipaddr.IPAddress(ipaddr.Bytes('xxxx')) +# +# Usage example (Python 3): +# ip = ipaddr.IPAddress(b'xxxx') +try: + if bytes is str: + raise TypeError("bytes is not a distinct type") + Bytes = bytes +except (NameError, TypeError): + class Bytes(str): + def __repr__(self): + return 'Bytes(%s)' % str.__repr__(self) + +def get_mixed_type_key(obj): + """Return a key suitable for sorting between networks and addresses. + + Address and Network objects are not sortable by default; they're + fundamentally different so the expression + + IPv4Address('1.1.1.1') <= IPv4Network('1.1.1.1/24') + + doesn't make any sense. There are some times however, where you may wish + to have ipaddr sort these for you anyway. If you need to do this, you + can use this function as the key= argument to sorted(). + + Args: + obj: either a Network or Address object. + Returns: + appropriate key. + + """ + if isinstance(obj, _BaseNet): + return obj._get_networks_key() + elif isinstance(obj, _BaseIP): + return obj._get_address_key() + return NotImplemented + +class _IPAddrBase(object): + + """The mother class.""" + + def __index__(self): + return self._ip + + def __int__(self): + return self._ip + + def __hex__(self): + return hex(self._ip) + + @property + def exploded(self): + """Return the longhand version of the IP address as a string.""" + return self._explode_shorthand_ip_string() + + @property + def compressed(self): + """Return the shorthand version of the IP address as a string.""" + return str(self) + + +class _BaseIP(_IPAddrBase): + + """A generic IP object. + + This IP class contains the version independent methods which are + used by single IP addresses. + + """ + + def __eq__(self, other): + try: + return (self._ip == other._ip + and self._version == other._version) + except AttributeError: + return NotImplemented + + def __ne__(self, other): + eq = self.__eq__(other) + if eq is NotImplemented: + return NotImplemented + return not eq + + def __le__(self, other): + gt = self.__gt__(other) + if gt is NotImplemented: + return NotImplemented + return not gt + + def __ge__(self, other): + lt = self.__lt__(other) + if lt is NotImplemented: + return NotImplemented + return not lt + + def __lt__(self, other): + if self._version != other._version: + raise TypeError('%s and %s are not of the same version' % ( + str(self), str(other))) + if not isinstance(other, _BaseIP): + raise TypeError('%s and %s are not of the same type' % ( + str(self), str(other))) + if self._ip != other._ip: + return self._ip < other._ip + return False + + def __gt__(self, other): + if self._version != other._version: + raise TypeError('%s and %s are not of the same version' % ( + str(self), str(other))) + if not isinstance(other, _BaseIP): + raise TypeError('%s and %s are not of the same type' % ( + str(self), str(other))) + if self._ip != other._ip: + return self._ip > other._ip + return False + + # Shorthand for Integer addition and subtraction. This is not + # meant to ever support addition/subtraction of addresses. + def __add__(self, other): + if not isinstance(other, int): + return NotImplemented + return IPAddress(int(self) + other, version=self._version) + + def __sub__(self, other): + if not isinstance(other, int): + return NotImplemented + return IPAddress(int(self) - other, version=self._version) + + def __repr__(self): + return '%s(%r)' % (self.__class__.__name__, str(self)) + + def __str__(self): + return '%s' % self._string_from_ip_int(self._ip) + + def __hash__(self): + return hash(hex(long(self._ip))) + + def _get_address_key(self): + return (self._version, self) + + @property + def version(self): + raise NotImplementedError('BaseIP has no version') + + +class _BaseNet(_IPAddrBase): + + """A generic IP object. + + This IP class contains the version independent methods which are + used by networks. + + """ + + def __init__(self, address): + self._cache = {} + + def __repr__(self): + return '%s(%r)' % (self.__class__.__name__, str(self)) + + def iterhosts(self): + """Generate Iterator over usable hosts in a network. + + This is like __iter__ except it doesn't return the network + or broadcast addresses. + + """ + cur = int(self.network) + 1 + bcast = int(self.broadcast) - 1 + while cur <= bcast: + cur += 1 + yield IPAddress(cur - 1, version=self._version) + + def __iter__(self): + cur = int(self.network) + bcast = int(self.broadcast) + while cur <= bcast: + cur += 1 + yield IPAddress(cur - 1, version=self._version) + + def __getitem__(self, n): + network = int(self.network) + broadcast = int(self.broadcast) + if n >= 0: + if network + n > broadcast: + raise IndexError + return IPAddress(network + n, version=self._version) + else: + n += 1 + if broadcast + n < network: + raise IndexError + return IPAddress(broadcast + n, version=self._version) + + def __lt__(self, other): + if self._version != other._version: + raise TypeError('%s and %s are not of the same version' % ( + str(self), str(other))) + if not isinstance(other, _BaseNet): + raise TypeError('%s and %s are not of the same type' % ( + str(self), str(other))) + if self.network != other.network: + return self.network < other.network + if self.netmask != other.netmask: + return self.netmask < other.netmask + return False + + def __gt__(self, other): + if self._version != other._version: + raise TypeError('%s and %s are not of the same version' % ( + str(self), str(other))) + if not isinstance(other, _BaseNet): + raise TypeError('%s and %s are not of the same type' % ( + str(self), str(other))) + if self.network != other.network: + return self.network > other.network + if self.netmask != other.netmask: + return self.netmask > other.netmask + return False + + def __le__(self, other): + gt = self.__gt__(other) + if gt is NotImplemented: + return NotImplemented + return not gt + + def __ge__(self, other): + lt = self.__lt__(other) + if lt is NotImplemented: + return NotImplemented + return not lt + + def __eq__(self, other): + try: + return (self._version == other._version + and self.network == other.network + and int(self.netmask) == int(other.netmask)) + except AttributeError: + if isinstance(other, _BaseIP): + return (self._version == other._version + and self._ip == other._ip) + + def __ne__(self, other): + eq = self.__eq__(other) + if eq is NotImplemented: + return NotImplemented + return not eq + + def __str__(self): + return '%s/%s' % (str(self.ip), + str(self._prefixlen)) + + def __hash__(self): + return hash(int(self.network) ^ int(self.netmask)) + + def __contains__(self, other): + # always false if one is v4 and the other is v6. + if self._version != other._version: + return False + # dealing with another network. + if isinstance(other, _BaseNet): + return (self.network <= other.network and + self.broadcast >= other.broadcast) + # dealing with another address + else: + return (int(self.network) <= int(other._ip) <= + int(self.broadcast)) + + def overlaps(self, other): + """Tell if self is partly contained in other.""" + return self.network in other or self.broadcast in other or ( + other.network in self or other.broadcast in self) + + @property + def network(self): + x = self._cache.get('network') + if x is None: + x = IPAddress(self._ip & int(self.netmask), version=self._version) + self._cache['network'] = x + return x + + @property + def broadcast(self): + x = self._cache.get('broadcast') + if x is None: + x = IPAddress(self._ip | int(self.hostmask), version=self._version) + self._cache['broadcast'] = x + return x + + @property + def hostmask(self): + x = self._cache.get('hostmask') + if x is None: + x = IPAddress(int(self.netmask) ^ self._ALL_ONES, + version=self._version) + self._cache['hostmask'] = x + return x + + @property + def with_prefixlen(self): + return '%s/%d' % (str(self.ip), self._prefixlen) + + @property + def with_netmask(self): + return '%s/%s' % (str(self.ip), str(self.netmask)) + + @property + def with_hostmask(self): + return '%s/%s' % (str(self.ip), str(self.hostmask)) + + @property + def numhosts(self): + """Number of hosts in the current subnet.""" + return int(self.broadcast) - int(self.network) + 1 + + @property + def version(self): + raise NotImplementedError('BaseNet has no version') + + @property + def prefixlen(self): + return self._prefixlen + + def address_exclude(self, other): + """Remove an address from a larger block. + + For example: + + addr1 = IPNetwork('10.1.1.0/24') + addr2 = IPNetwork('10.1.1.0/26') + addr1.address_exclude(addr2) = + [IPNetwork('10.1.1.64/26'), IPNetwork('10.1.1.128/25')] + + or IPv6: + + addr1 = IPNetwork('::1/32') + addr2 = IPNetwork('::1/128') + addr1.address_exclude(addr2) = [IPNetwork('::0/128'), + IPNetwork('::2/127'), + IPNetwork('::4/126'), + IPNetwork('::8/125'), + ... + IPNetwork('0:0:8000::/33')] + + Args: + other: An IPvXNetwork object of the same type. + + Returns: + A sorted list of IPvXNetwork objects addresses which is self + minus other. + + Raises: + TypeError: If self and other are of difffering address + versions, or if other is not a network object. + ValueError: If other is not completely contained by self. + + """ + if not self._version == other._version: + raise TypeError("%s and %s are not of the same version" % ( + str(self), str(other))) + + if not isinstance(other, _BaseNet): + raise TypeError("%s is not a network object" % str(other)) + + if other not in self: + raise ValueError('%s not contained in %s' % (str(other), + str(self))) + if other == self: + return [] + + ret_addrs = [] + + # Make sure we're comparing the network of other. + other = IPNetwork('%s/%s' % (str(other.network), str(other.prefixlen)), + version=other._version) + + s1, s2 = self.subnet() + while s1 != other and s2 != other: + if other in s1: + ret_addrs.append(s2) + s1, s2 = s1.subnet() + elif other in s2: + ret_addrs.append(s1) + s1, s2 = s2.subnet() + else: + # If we got here, there's a bug somewhere. + assert True == False, ('Error performing exclusion: ' + 's1: %s s2: %s other: %s' % + (str(s1), str(s2), str(other))) + if s1 == other: + ret_addrs.append(s2) + elif s2 == other: + ret_addrs.append(s1) + else: + # If we got here, there's a bug somewhere. + assert True == False, ('Error performing exclusion: ' + 's1: %s s2: %s other: %s' % + (str(s1), str(s2), str(other))) + + return sorted(ret_addrs, key=_BaseNet._get_networks_key) + + def compare_networks(self, other): + """Compare two IP objects. + + This is only concerned about the comparison of the integer + representation of the network addresses. This means that the + host bits aren't considered at all in this method. If you want + to compare host bits, you can easily enough do a + 'HostA._ip < HostB._ip' + + Args: + other: An IP object. + + Returns: + If the IP versions of self and other are the same, returns: + + -1 if self < other: + eg: IPv4('1.1.1.0/24') < IPv4('1.1.2.0/24') + IPv6('1080::200C:417A') < IPv6('1080::200B:417B') + 0 if self == other + eg: IPv4('1.1.1.1/24') == IPv4('1.1.1.2/24') + IPv6('1080::200C:417A/96') == IPv6('1080::200C:417B/96') + 1 if self > other + eg: IPv4('1.1.1.0/24') > IPv4('1.1.0.0/24') + IPv6('1080::1:200C:417A/112') > + IPv6('1080::0:200C:417A/112') + + If the IP versions of self and other are different, returns: + + -1 if self._version < other._version + eg: IPv4('10.0.0.1/24') < IPv6('::1/128') + 1 if self._version > other._version + eg: IPv6('::1/128') > IPv4('255.255.255.0/24') + + """ + if self._version < other._version: + return -1 + if self._version > other._version: + return 1 + # self._version == other._version below here: + if self.network < other.network: + return -1 + if self.network > other.network: + return 1 + # self.network == other.network below here: + if self.netmask < other.netmask: + return -1 + if self.netmask > other.netmask: + return 1 + # self.network == other.network and self.netmask == other.netmask + return 0 + + def _get_networks_key(self): + """Network-only key function. + + Returns an object that identifies this address' network and + netmask. This function is a suitable "key" argument for sorted() + and list.sort(). + + """ + return (self._version, self.network, self.netmask) + + def _ip_int_from_prefix(self, prefixlen): + """Turn the prefix length into a bitwise netmask. + + Args: + prefixlen: An integer, the prefix length. + + Returns: + An integer. + + """ + return self._ALL_ONES ^ (self._ALL_ONES >> prefixlen) + + def _prefix_from_ip_int(self, ip_int): + """Return prefix length from a bitwise netmask. + + Args: + ip_int: An integer, the netmask in expanded bitwise format. + + Returns: + An integer, the prefix length. + + Raises: + NetmaskValueError: If the input is not a valid netmask. + + """ + prefixlen = self._max_prefixlen + while prefixlen: + if ip_int & 1: + break + ip_int >>= 1 + prefixlen -= 1 + + if ip_int == (1 << prefixlen) - 1: + return prefixlen + else: + raise NetmaskValueError('Bit pattern does not match /1*0*/') + + def _prefix_from_prefix_string(self, prefixlen_str): + """Turn a prefix length string into an integer. + + Args: + prefixlen_str: A decimal string containing the prefix length. + + Returns: + The prefix length as an integer. + + Raises: + NetmaskValueError: If the input is malformed or out of range. + + """ + try: + if not _BaseV4._DECIMAL_DIGITS.issuperset(prefixlen_str): + raise ValueError + prefixlen = int(prefixlen_str) + if not (0 <= prefixlen <= self._max_prefixlen): + raise ValueError + except ValueError: + raise NetmaskValueError('%s is not a valid prefix length' % + prefixlen_str) + return prefixlen + + def _prefix_from_ip_string(self, ip_str): + """Turn a netmask/hostmask string into a prefix length. + + Args: + ip_str: A netmask or hostmask, formatted as an IP address. + + Returns: + The prefix length as an integer. + + Raises: + NetmaskValueError: If the input is not a netmask or hostmask. + + """ + # Parse the netmask/hostmask like an IP address. + try: + ip_int = self._ip_int_from_string(ip_str) + except AddressValueError: + raise NetmaskValueError('%s is not a valid netmask' % ip_str) + + # Try matching a netmask (this would be /1*0*/ as a bitwise regexp). + # Note that the two ambiguous cases (all-ones and all-zeroes) are + # treated as netmasks. + try: + return self._prefix_from_ip_int(ip_int) + except NetmaskValueError: + pass + + # Invert the bits, and try matching a /0+1+/ hostmask instead. + ip_int ^= self._ALL_ONES + try: + return self._prefix_from_ip_int(ip_int) + except NetmaskValueError: + raise NetmaskValueError('%s is not a valid netmask' % ip_str) + + def iter_subnets(self, prefixlen_diff=1, new_prefix=None): + """The subnets which join to make the current subnet. + + In the case that self contains only one IP + (self._prefixlen == 32 for IPv4 or self._prefixlen == 128 + for IPv6), return a list with just ourself. + + Args: + prefixlen_diff: An integer, the amount the prefix length + should be increased by. This should not be set if + new_prefix is also set. + new_prefix: The desired new prefix length. This must be a + larger number (smaller prefix) than the existing prefix. + This should not be set if prefixlen_diff is also set. + + Returns: + An iterator of IPv(4|6) objects. + + Raises: + ValueError: The prefixlen_diff is too small or too large. + OR + prefixlen_diff and new_prefix are both set or new_prefix + is a smaller number than the current prefix (smaller + number means a larger network) + + """ + if self._prefixlen == self._max_prefixlen: + yield self + return + + if new_prefix is not None: + if new_prefix < self._prefixlen: + raise ValueError('new prefix must be longer') + if prefixlen_diff != 1: + raise ValueError('cannot set prefixlen_diff and new_prefix') + prefixlen_diff = new_prefix - self._prefixlen + + if prefixlen_diff < 0: + raise ValueError('prefix length diff must be > 0') + new_prefixlen = self._prefixlen + prefixlen_diff + + if new_prefixlen > self._max_prefixlen: + raise ValueError( + 'prefix length diff %d is invalid for netblock %s' % ( + new_prefixlen, str(self))) + + first = IPNetwork('%s/%s' % (str(self.network), + str(self._prefixlen + prefixlen_diff)), + version=self._version) + + yield first + current = first + while True: + broadcast = current.broadcast + if broadcast == self.broadcast: + return + new_addr = IPAddress(int(broadcast) + 1, version=self._version) + current = IPNetwork('%s/%s' % (str(new_addr), str(new_prefixlen)), + version=self._version) + + yield current + + def masked(self): + """Return the network object with the host bits masked out.""" + return IPNetwork('%s/%d' % (self.network, self._prefixlen), + version=self._version) + + def subnet(self, prefixlen_diff=1, new_prefix=None): + """Return a list of subnets, rather than an iterator.""" + return list(self.iter_subnets(prefixlen_diff, new_prefix)) + + def supernet(self, prefixlen_diff=1, new_prefix=None): + """The supernet containing the current network. + + Args: + prefixlen_diff: An integer, the amount the prefix length of + the network should be decreased by. For example, given a + /24 network and a prefixlen_diff of 3, a supernet with a + /21 netmask is returned. + + Returns: + An IPv4 network object. + + Raises: + ValueError: If self.prefixlen - prefixlen_diff < 0. I.e., you have a + negative prefix length. + OR + If prefixlen_diff and new_prefix are both set or new_prefix is a + larger number than the current prefix (larger number means a + smaller network) + + """ + if self._prefixlen == 0: + return self + + if new_prefix is not None: + if new_prefix > self._prefixlen: + raise ValueError('new prefix must be shorter') + if prefixlen_diff != 1: + raise ValueError('cannot set prefixlen_diff and new_prefix') + prefixlen_diff = self._prefixlen - new_prefix + + + if self.prefixlen - prefixlen_diff < 0: + raise ValueError( + 'current prefixlen is %d, cannot have a prefixlen_diff of %d' % + (self.prefixlen, prefixlen_diff)) + return IPNetwork('%s/%s' % (str(self.network), + str(self.prefixlen - prefixlen_diff)), + version=self._version) + + # backwards compatibility + Subnet = subnet + Supernet = supernet + AddressExclude = address_exclude + CompareNetworks = compare_networks + Contains = __contains__ + + +class _BaseV4(object): + + """Base IPv4 object. + + The following methods are used by IPv4 objects in both single IP + addresses and networks. + + """ + + # Equivalent to 255.255.255.255 or 32 bits of 1's. + _ALL_ONES = (2**IPV4LENGTH) - 1 + _DECIMAL_DIGITS = frozenset('0123456789') + + def __init__(self, address): + self._version = 4 + self._max_prefixlen = IPV4LENGTH + + def _explode_shorthand_ip_string(self): + return str(self) + + def _ip_int_from_string(self, ip_str): + """Turn the given IP string into an integer for comparison. + + Args: + ip_str: A string, the IP ip_str. + + Returns: + The IP ip_str as an integer. + + Raises: + AddressValueError: if ip_str isn't a valid IPv4 Address. + + """ + octets = ip_str.split('.') + if len(octets) != 4: + raise AddressValueError(ip_str) + + packed_ip = 0 + for oc in octets: + try: + packed_ip = (packed_ip << 8) | self._parse_octet(oc) + except ValueError: + raise AddressValueError(ip_str) + return packed_ip + + def _parse_octet(self, octet_str): + """Convert a decimal octet into an integer. + + Args: + octet_str: A string, the number to parse. + + Returns: + The octet as an integer. + + Raises: + ValueError: if the octet isn't strictly a decimal from [0..255]. + + """ + # Whitelist the characters, since int() allows a lot of bizarre stuff. + if not self._DECIMAL_DIGITS.issuperset(octet_str): + raise ValueError + octet_int = int(octet_str, 10) + # Disallow leading zeroes, because no clear standard exists on + # whether these should be interpreted as decimal or octal. + if octet_int > 255 or (octet_str[0] == '0' and len(octet_str) > 1): + raise ValueError + return octet_int + + def _string_from_ip_int(self, ip_int): + """Turns a 32-bit integer into dotted decimal notation. + + Args: + ip_int: An integer, the IP address. + + Returns: + The IP address as a string in dotted decimal notation. + + """ + octets = [] + for _ in xrange(4): + octets.insert(0, str(ip_int & 0xFF)) + ip_int >>= 8 + return '.'.join(octets) + + @property + def max_prefixlen(self): + return self._max_prefixlen + + @property + def packed(self): + """The binary representation of this address.""" + return v4_int_to_packed(self._ip) + + @property + def version(self): + return self._version + + @property + def is_reserved(self): + """Test if the address is otherwise IETF reserved. + + Returns: + A boolean, True if the address is within the + reserved IPv4 Network range. + + """ + return self in IPv4Network('240.0.0.0/4') + + @property + def is_private(self): + """Test if this address is allocated for private networks. + + Returns: + A boolean, True if the address is reserved per RFC 1918. + + """ + return (self in IPv4Network('10.0.0.0/8') or + self in IPv4Network('172.16.0.0/12') or + self in IPv4Network('192.168.0.0/16')) + + @property + def is_multicast(self): + """Test if the address is reserved for multicast use. + + Returns: + A boolean, True if the address is multicast. + See RFC 3171 for details. + + """ + return self in IPv4Network('224.0.0.0/4') + + @property + def is_unspecified(self): + """Test if the address is unspecified. + + Returns: + A boolean, True if this is the unspecified address as defined in + RFC 5735 3. + + """ + return self in IPv4Network('0.0.0.0') + + @property + def is_loopback(self): + """Test if the address is a loopback address. + + Returns: + A boolean, True if the address is a loopback per RFC 3330. + + """ + return self in IPv4Network('127.0.0.0/8') + + @property + def is_link_local(self): + """Test if the address is reserved for link-local. + + Returns: + A boolean, True if the address is link-local per RFC 3927. + + """ + return self in IPv4Network('169.254.0.0/16') + + +class IPv4Address(_BaseV4, _BaseIP): + + """Represent and manipulate single IPv4 Addresses.""" + + def __init__(self, address): + + """ + Args: + address: A string or integer representing the IP + '192.168.1.1' + + Additionally, an integer can be passed, so + IPv4Address('192.168.1.1') == IPv4Address(3232235777). + or, more generally + IPv4Address(int(IPv4Address('192.168.1.1'))) == + IPv4Address('192.168.1.1') + + Raises: + AddressValueError: If ipaddr isn't a valid IPv4 address. + + """ + _BaseV4.__init__(self, address) + + # Efficient constructor from integer. + if isinstance(address, (int, long)): + self._ip = address + if address < 0 or address > self._ALL_ONES: + raise AddressValueError(address) + return + + # Constructing from a packed address + if isinstance(address, Bytes): + try: + self._ip, = struct.unpack('!I', address) + except struct.error: + raise AddressValueError(address) # Wrong length. + return + + # Assume input argument to be string or any object representation + # which converts into a formatted IP string. + addr_str = str(address) + self._ip = self._ip_int_from_string(addr_str) + + +class IPv4Network(_BaseV4, _BaseNet): + + """This class represents and manipulates 32-bit IPv4 networks. + + Attributes: [examples for IPv4Network('1.2.3.4/27')] + ._ip: 16909060 + .ip: IPv4Address('1.2.3.4') + .network: IPv4Address('1.2.3.0') + .hostmask: IPv4Address('0.0.0.31') + .broadcast: IPv4Address('1.2.3.31') + .netmask: IPv4Address('255.255.255.224') + .prefixlen: 27 + + """ + + def __init__(self, address, strict=False): + """Instantiate a new IPv4 network object. + + Args: + address: A string or integer representing the IP [& network]. + '192.168.1.1/24' + '192.168.1.1/255.255.255.0' + '192.168.1.1/0.0.0.255' + are all functionally the same in IPv4. Similarly, + '192.168.1.1' + '192.168.1.1/255.255.255.255' + '192.168.1.1/32' + are also functionaly equivalent. That is to say, failing to + provide a subnetmask will create an object with a mask of /32. + + If the mask (portion after the / in the argument) is given in + dotted quad form, it is treated as a netmask if it starts with a + non-zero field (e.g. /255.0.0.0 == /8) and as a hostmask if it + starts with a zero field (e.g. 0.255.255.255 == /8), with the + single exception of an all-zero mask which is treated as a + netmask == /0. If no mask is given, a default of /32 is used. + + Additionally, an integer can be passed, so + IPv4Network('192.168.1.1') == IPv4Network(3232235777). + or, more generally + IPv4Network(int(IPv4Network('192.168.1.1'))) == + IPv4Network('192.168.1.1') + + strict: A boolean. If true, ensure that we have been passed + A true network address, eg, 192.168.1.0/24 and not an + IP address on a network, eg, 192.168.1.1/24. + + Raises: + AddressValueError: If ipaddr isn't a valid IPv4 address. + NetmaskValueError: If the netmask isn't valid for + an IPv4 address. + ValueError: If strict was True and a network address was not + supplied. + + """ + _BaseNet.__init__(self, address) + _BaseV4.__init__(self, address) + + # Constructing from an integer or packed bytes. + if isinstance(address, (int, long, Bytes)): + self.ip = IPv4Address(address) + self._ip = self.ip._ip + self._prefixlen = self._max_prefixlen + self.netmask = IPv4Address(self._ALL_ONES) + return + + # Assume input argument to be string or any object representation + # which converts into a formatted IP prefix string. + addr = str(address).split('/') + + if len(addr) > 2: + raise AddressValueError(address) + + self._ip = self._ip_int_from_string(addr[0]) + self.ip = IPv4Address(self._ip) + + if len(addr) == 2: + try: + # Check for a netmask in prefix length form. + self._prefixlen = self._prefix_from_prefix_string(addr[1]) + except NetmaskValueError: + # Check for a netmask or hostmask in dotted-quad form. + # This may raise NetmaskValueError. + self._prefixlen = self._prefix_from_ip_string(addr[1]) + else: + self._prefixlen = self._max_prefixlen + + self.netmask = IPv4Address(self._ip_int_from_prefix(self._prefixlen)) + + if strict: + if self.ip != self.network: + raise ValueError('%s has host bits set' % + self.ip) + if self._prefixlen == (self._max_prefixlen - 1): + self.iterhosts = self.__iter__ + + # backwards compatibility + IsRFC1918 = lambda self: self.is_private + IsMulticast = lambda self: self.is_multicast + IsLoopback = lambda self: self.is_loopback + IsLinkLocal = lambda self: self.is_link_local + + +class _BaseV6(object): + + """Base IPv6 object. + + The following methods are used by IPv6 objects in both single IP + addresses and networks. + + """ + + _ALL_ONES = (2**IPV6LENGTH) - 1 + _HEXTET_COUNT = 8 + _HEX_DIGITS = frozenset('0123456789ABCDEFabcdef') + + def __init__(self, address): + self._version = 6 + self._max_prefixlen = IPV6LENGTH + + def _ip_int_from_string(self, ip_str): + """Turn an IPv6 ip_str into an integer. + + Args: + ip_str: A string, the IPv6 ip_str. + + Returns: + A long, the IPv6 ip_str. + + Raises: + AddressValueError: if ip_str isn't a valid IPv6 Address. + + """ + parts = ip_str.split(':') + + # An IPv6 address needs at least 2 colons (3 parts). + if len(parts) < 3: + raise AddressValueError(ip_str) + + # If the address has an IPv4-style suffix, convert it to hexadecimal. + if '.' in parts[-1]: + ipv4_int = IPv4Address(parts.pop())._ip + parts.append('%x' % ((ipv4_int >> 16) & 0xFFFF)) + parts.append('%x' % (ipv4_int & 0xFFFF)) + + # An IPv6 address can't have more than 8 colons (9 parts). + if len(parts) > self._HEXTET_COUNT + 1: + raise AddressValueError(ip_str) + + # Disregarding the endpoints, find '::' with nothing in between. + # This indicates that a run of zeroes has been skipped. + try: + skip_index, = ( + [i for i in xrange(1, len(parts) - 1) if not parts[i]] or + [None]) + except ValueError: + # Can't have more than one '::' + raise AddressValueError(ip_str) + + # parts_hi is the number of parts to copy from above/before the '::' + # parts_lo is the number of parts to copy from below/after the '::' + if skip_index is not None: + # If we found a '::', then check if it also covers the endpoints. + parts_hi = skip_index + parts_lo = len(parts) - skip_index - 1 + if not parts[0]: + parts_hi -= 1 + if parts_hi: + raise AddressValueError(ip_str) # ^: requires ^:: + if not parts[-1]: + parts_lo -= 1 + if parts_lo: + raise AddressValueError(ip_str) # :$ requires ::$ + parts_skipped = self._HEXTET_COUNT - (parts_hi + parts_lo) + if parts_skipped < 1: + raise AddressValueError(ip_str) + else: + # Otherwise, allocate the entire address to parts_hi. The endpoints + # could still be empty, but _parse_hextet() will check for that. + if len(parts) != self._HEXTET_COUNT: + raise AddressValueError(ip_str) + parts_hi = len(parts) + parts_lo = 0 + parts_skipped = 0 + + try: + # Now, parse the hextets into a 128-bit integer. + ip_int = 0L + for i in xrange(parts_hi): + ip_int <<= 16 + ip_int |= self._parse_hextet(parts[i]) + ip_int <<= 16 * parts_skipped + for i in xrange(-parts_lo, 0): + ip_int <<= 16 + ip_int |= self._parse_hextet(parts[i]) + return ip_int + except ValueError: + raise AddressValueError(ip_str) + + def _parse_hextet(self, hextet_str): + """Convert an IPv6 hextet string into an integer. + + Args: + hextet_str: A string, the number to parse. + + Returns: + The hextet as an integer. + + Raises: + ValueError: if the input isn't strictly a hex number from [0..FFFF]. + + """ + # Whitelist the characters, since int() allows a lot of bizarre stuff. + if not self._HEX_DIGITS.issuperset(hextet_str): + raise ValueError + if len(hextet_str) > 4: + raise ValueError + hextet_int = int(hextet_str, 16) + if hextet_int > 0xFFFF: + raise ValueError + return hextet_int + + def _compress_hextets(self, hextets): + """Compresses a list of hextets. + + Compresses a list of strings, replacing the longest continuous + sequence of "0" in the list with "" and adding empty strings at + the beginning or at the end of the string such that subsequently + calling ":".join(hextets) will produce the compressed version of + the IPv6 address. + + Args: + hextets: A list of strings, the hextets to compress. + + Returns: + A list of strings. + + """ + best_doublecolon_start = -1 + best_doublecolon_len = 0 + doublecolon_start = -1 + doublecolon_len = 0 + for index in range(len(hextets)): + if hextets[index] == '0': + doublecolon_len += 1 + if doublecolon_start == -1: + # Start of a sequence of zeros. + doublecolon_start = index + if doublecolon_len > best_doublecolon_len: + # This is the longest sequence of zeros so far. + best_doublecolon_len = doublecolon_len + best_doublecolon_start = doublecolon_start + else: + doublecolon_len = 0 + doublecolon_start = -1 + + if best_doublecolon_len > 1: + best_doublecolon_end = (best_doublecolon_start + + best_doublecolon_len) + # For zeros at the end of the address. + if best_doublecolon_end == len(hextets): + hextets += [''] + hextets[best_doublecolon_start:best_doublecolon_end] = [''] + # For zeros at the beginning of the address. + if best_doublecolon_start == 0: + hextets = [''] + hextets + + return hextets + + def _string_from_ip_int(self, ip_int=None): + """Turns a 128-bit integer into hexadecimal notation. + + Args: + ip_int: An integer, the IP address. + + Returns: + A string, the hexadecimal representation of the address. + + Raises: + ValueError: The address is bigger than 128 bits of all ones. + + """ + if not ip_int and ip_int != 0: + ip_int = int(self._ip) + + if ip_int > self._ALL_ONES: + raise ValueError('IPv6 address is too large') + + hex_str = '%032x' % ip_int + hextets = [] + for x in range(0, 32, 4): + hextets.append('%x' % int(hex_str[x:x+4], 16)) + + hextets = self._compress_hextets(hextets) + return ':'.join(hextets) + + def _explode_shorthand_ip_string(self): + """Expand a shortened IPv6 address. + + Args: + ip_str: A string, the IPv6 address. + + Returns: + A string, the expanded IPv6 address. + + """ + if isinstance(self, _BaseNet): + ip_str = str(self.ip) + else: + ip_str = str(self) + + ip_int = self._ip_int_from_string(ip_str) + parts = [] + for i in xrange(self._HEXTET_COUNT): + parts.append('%04x' % (ip_int & 0xFFFF)) + ip_int >>= 16 + parts.reverse() + if isinstance(self, _BaseNet): + return '%s/%d' % (':'.join(parts), self.prefixlen) + return ':'.join(parts) + + @property + def max_prefixlen(self): + return self._max_prefixlen + + @property + def packed(self): + """The binary representation of this address.""" + return v6_int_to_packed(self._ip) + + @property + def version(self): + return self._version + + @property + def is_multicast(self): + """Test if the address is reserved for multicast use. + + Returns: + A boolean, True if the address is a multicast address. + See RFC 2373 2.7 for details. + + """ + return self in IPv6Network('ff00::/8') + + @property + def is_reserved(self): + """Test if the address is otherwise IETF reserved. + + Returns: + A boolean, True if the address is within one of the + reserved IPv6 Network ranges. + + """ + return (self in IPv6Network('::/8') or + self in IPv6Network('100::/8') or + self in IPv6Network('200::/7') or + self in IPv6Network('400::/6') or + self in IPv6Network('800::/5') or + self in IPv6Network('1000::/4') or + self in IPv6Network('4000::/3') or + self in IPv6Network('6000::/3') or + self in IPv6Network('8000::/3') or + self in IPv6Network('A000::/3') or + self in IPv6Network('C000::/3') or + self in IPv6Network('E000::/4') or + self in IPv6Network('F000::/5') or + self in IPv6Network('F800::/6') or + self in IPv6Network('FE00::/9')) + + @property + def is_unspecified(self): + """Test if the address is unspecified. + + Returns: + A boolean, True if this is the unspecified address as defined in + RFC 2373 2.5.2. + + """ + return self._ip == 0 and getattr(self, '_prefixlen', 128) == 128 + + @property + def is_loopback(self): + """Test if the address is a loopback address. + + Returns: + A boolean, True if the address is a loopback address as defined in + RFC 2373 2.5.3. + + """ + return self._ip == 1 and getattr(self, '_prefixlen', 128) == 128 + + @property + def is_link_local(self): + """Test if the address is reserved for link-local. + + Returns: + A boolean, True if the address is reserved per RFC 4291. + + """ + return self in IPv6Network('fe80::/10') + + @property + def is_site_local(self): + """Test if the address is reserved for site-local. + + Note that the site-local address space has been deprecated by RFC 3879. + Use is_private to test if this address is in the space of unique local + addresses as defined by RFC 4193. + + Returns: + A boolean, True if the address is reserved per RFC 3513 2.5.6. + + """ + return self in IPv6Network('fec0::/10') + + @property + def is_private(self): + """Test if this address is allocated for private networks. + + Returns: + A boolean, True if the address is reserved per RFC 4193. + + """ + return self in IPv6Network('fc00::/7') + + @property + def ipv4_mapped(self): + """Return the IPv4 mapped address. + + Returns: + If the IPv6 address is a v4 mapped address, return the + IPv4 mapped address. Return None otherwise. + + """ + if (self._ip >> 32) != 0xFFFF: + return None + return IPv4Address(self._ip & 0xFFFFFFFF) + + @property + def teredo(self): + """Tuple of embedded teredo IPs. + + Returns: + Tuple of the (server, client) IPs or None if the address + doesn't appear to be a teredo address (doesn't start with + 2001::/32) + + """ + if (self._ip >> 96) != 0x20010000: + return None + return (IPv4Address((self._ip >> 64) & 0xFFFFFFFF), + IPv4Address(~self._ip & 0xFFFFFFFF)) + + @property + def sixtofour(self): + """Return the IPv4 6to4 embedded address. + + Returns: + The IPv4 6to4-embedded address if present or None if the + address doesn't appear to contain a 6to4 embedded address. + + """ + if (self._ip >> 112) != 0x2002: + return None + return IPv4Address((self._ip >> 80) & 0xFFFFFFFF) + + +class IPv6Address(_BaseV6, _BaseIP): + + """Represent and manipulate single IPv6 Addresses. + """ + + def __init__(self, address): + """Instantiate a new IPv6 address object. + + Args: + address: A string or integer representing the IP + + Additionally, an integer can be passed, so + IPv6Address('2001:4860::') == + IPv6Address(42541956101370907050197289607612071936L). + or, more generally + IPv6Address(IPv6Address('2001:4860::')._ip) == + IPv6Address('2001:4860::') + + Raises: + AddressValueError: If address isn't a valid IPv6 address. + + """ + _BaseV6.__init__(self, address) + + # Efficient constructor from integer. + if isinstance(address, (int, long)): + self._ip = address + if address < 0 or address > self._ALL_ONES: + raise AddressValueError(address) + return + + # Constructing from a packed address + if isinstance(address, Bytes): + try: + hi, lo = struct.unpack('!QQ', address) + except struct.error: + raise AddressValueError(address) # Wrong length. + self._ip = (hi << 64) | lo + return + + # Assume input argument to be string or any object representation + # which converts into a formatted IP string. + addr_str = str(address) + if not addr_str: + raise AddressValueError('') + + self._ip = self._ip_int_from_string(addr_str) + + +class IPv6Network(_BaseV6, _BaseNet): + + """This class represents and manipulates 128-bit IPv6 networks. + + Attributes: [examples for IPv6('2001:658:22A:CAFE:200::1/64')] + .ip: IPv6Address('2001:658:22a:cafe:200::1') + .network: IPv6Address('2001:658:22a:cafe::') + .hostmask: IPv6Address('::ffff:ffff:ffff:ffff') + .broadcast: IPv6Address('2001:658:22a:cafe:ffff:ffff:ffff:ffff') + .netmask: IPv6Address('ffff:ffff:ffff:ffff::') + .prefixlen: 64 + + """ + + + def __init__(self, address, strict=False): + """Instantiate a new IPv6 Network object. + + Args: + address: A string or integer representing the IPv6 network or the IP + and prefix/netmask. + '2001:4860::/128' + '2001:4860:0000:0000:0000:0000:0000:0000/128' + '2001:4860::' + are all functionally the same in IPv6. That is to say, + failing to provide a subnetmask will create an object with + a mask of /128. + + Additionally, an integer can be passed, so + IPv6Network('2001:4860::') == + IPv6Network(42541956101370907050197289607612071936L). + or, more generally + IPv6Network(IPv6Network('2001:4860::')._ip) == + IPv6Network('2001:4860::') + + strict: A boolean. If true, ensure that we have been passed + A true network address, eg, 192.168.1.0/24 and not an + IP address on a network, eg, 192.168.1.1/24. + + Raises: + AddressValueError: If address isn't a valid IPv6 address. + NetmaskValueError: If the netmask isn't valid for + an IPv6 address. + ValueError: If strict was True and a network address was not + supplied. + + """ + _BaseNet.__init__(self, address) + _BaseV6.__init__(self, address) + + # Constructing from an integer or packed bytes. + if isinstance(address, (int, long, Bytes)): + self.ip = IPv6Address(address) + self._ip = self.ip._ip + self._prefixlen = self._max_prefixlen + self.netmask = IPv6Address(self._ALL_ONES) + return + + # Assume input argument to be string or any object representation + # which converts into a formatted IP prefix string. + addr = str(address).split('/') + + if len(addr) > 2: + raise AddressValueError(address) + + self._ip = self._ip_int_from_string(addr[0]) + self.ip = IPv6Address(self._ip) + + if len(addr) == 2: + # This may raise NetmaskValueError + self._prefixlen = self._prefix_from_prefix_string(addr[1]) + else: + self._prefixlen = self._max_prefixlen + + self.netmask = IPv6Address(self._ip_int_from_prefix(self._prefixlen)) + + if strict: + if self.ip != self.network: + raise ValueError('%s has host bits set' % + self.ip) + if self._prefixlen == (self._max_prefixlen - 1): + self.iterhosts = self.__iter__ + + @property + def with_netmask(self): + return self.with_prefixlen diff --git a/plugins/stat_plugin.py b/plugins/stat_plugin.py new file mode 100644 index 0000000..1cf9b5e --- /dev/null +++ b/plugins/stat_plugin.py @@ -0,0 +1,27 @@ +''' +Simple statistics plugin + +To use it, go to http://127.0.0.1:8000/stat +''' +from modules.PluginInterface import VPProxyPlugin + + +class Stat(VPProxyPlugin): + handlers = ('stat', ) + + def __init__(self, VPConfig, VPStuff): + self.config = VPConfig + self.stuff = VPStuff + + def handle(self, connection): + connection.send_response(200) + connection.send_header('Content-type', 'text/html') + connection.end_headers() + connection.wfile.write( + '

Connected clients: ' + str(self.stuff.clientcounter.total) + '

') + connection.wfile.write( + '
Concurrent connections limit: ' + str(self.config.maxconns) + '
') + for i in self.stuff.clientcounter.clients: + connection.wfile.write(str(i) + ' : ' + str(self.stuff.clientcounter.clients[i][0]) + ' ' + + str(self.stuff.clientcounter.clients[i][1]) + '
') + connection.wfile.write('') diff --git a/vlcclient/__init__.py b/vlcclient/__init__.py new file mode 100644 index 0000000..d633819 --- /dev/null +++ b/vlcclient/__init__.py @@ -0,0 +1 @@ +from vlcclient import * diff --git a/vlcclient/vlcclient.py b/vlcclient/vlcclient.py new file mode 100644 index 0000000..ebe83f7 --- /dev/null +++ b/vlcclient/vlcclient.py @@ -0,0 +1,224 @@ +''' +Minimal VLC VLM client for AceProxy. Client class. +''' + +import gevent +import gevent.event +import gevent.coros +import telnetlib +import logging +from vlcmessages import * + + +class VlcException(Exception): + + ''' + Exception from VlcClient + ''' + pass + + +class VlcClient(object): + + ''' + VLC Client class + ''' + + def __init__( + self, host='127.0.0.1', port=4212, password='admin', connect_timeout=5, + result_timeout=5, out_port=8081): + # Receive buffer + self._recvbuffer = None + # Output port + self._out_port = out_port + # VLC socket + self._socket = None + # Result timeout + self._resulttimeout = result_timeout + # Shutting down flag + self._shuttingDown = gevent.event.Event() + # Authentication done event + self._auth = gevent.event.AsyncResult() + # Request lock + self._resultlock = gevent.coros.RLock() + # Request result + self._result = gevent.event.AsyncResult() + # VLC version string + self._vlcver = None + # Saving password + self._password = password + + # Logger + logger = logging.getLogger('VlcClient_init') + + # Making connection + try: + self._socket = telnetlib.Telnet(host, port, connect_timeout) + logger.debug("Successfully connected with VLC socket!") + except Exception as e: + raise VlcException( + "Socket creation error! VLC is not running? ERROR: " + repr(e)) + + # Spawning recvData greenlet + gevent.spawn(self._recvData) + gevent.sleep() + + # Waiting for authentication event + try: + if self._auth.get(timeout=self._resulttimeout) == False: + errmsg = "Authentication error" + logger.error(errmsg) + raise VlcException(errmsg) + except gevent.Timeout: + errmsg = "Authentication timeout" + logger.error(errmsg) + raise VlcException(errmsg) + + def __del__(self): + # Destructor just calls destroy() method + self.destroy() + + def destroy(self): + # Logger + logger = logging.getLogger("VlcClient_destroy") + + if self._shuttingDown.isSet(): + # Already in the middle of destroying + return + + # If socket is still alive (connected) + if self._socket: + try: + logger.debug("Destroying VlcClient...") + self._write(VlcMessage.request.SHUTDOWN) + # Set shuttingDown flag for recvData + self._shuttingDown.set() + except: + # Ignore exceptions on destroy + pass + + def _write(self, message): + # Return if in the middle of destroying + if self._shuttingDown.isSet(): + return + + try: + # Write message + print 'VLC command:',message + self._socket.write(message + "\r\n") + except EOFError as e: + raise VlcException("Vlc Write error! ERROR: " + repr(e)) + + def _broadcast(self, brtype, stream_name, input=None, muxer='ts', pre_access=''): + if self._shuttingDown.isSet(): + return + + # Start/stop broadcast with VLC + # Logger + if brtype == True: + broadcast = 'startBroadcast' + else: + broadcast = 'stopBroadcast' + + logger = logging.getLogger("VlcClient_" + broadcast) + # Clear AsyncResult + self._result = gevent.event.AsyncResult() + # Get lock + self._resultlock.acquire() + # Write message to VLC socket + if brtype == True: + self._write(VlcMessage.request.startBroadcast( + stream_name, input, self._out_port, muxer, pre_access)) + else: + self._write(VlcMessage.request.stopBroadcast(stream_name)) + + try: + gevent.sleep() + result = self._result.get(timeout=self._resulttimeout) + if result == False: + logger.error(broadcast + " error") + raise VlcException(broadcast + " error") + except gevent.Timeout: + logger.error(broadcast + " result timeout") + raise VlcException(broadcast + " result timeout") + finally: + self._resultlock.release() + + if brtype == True: + logger.debug("Broadcast started") + else: + logger.debug("Broadcast stopped") + + def startBroadcast(self, stream_name, input, muxer='ts', pre_access=''): + return self._broadcast(True, stream_name, input, muxer, pre_access) + + def stopBroadcast(self, stream_name): + return self._broadcast(False, stream_name) + + def pauseBroadcast(self, stream_name): + return self._write(VlcMessage.request.pauseBroadcast(stream_name)) + + def playBroadcast(self, stream_name): + return self._write(VlcMessage.request.playBroadcast(stream_name)) + + def _recvData(self): + # Logger + logger = logging.getLogger("VlcClient_recvData") + + while True: + gevent.sleep() + try: + self._recvbuffer = self._socket.read_until("\n") + # Stripping "> " from VLC + self._recvbuffer = self._recvbuffer.lstrip("> ") + except: + # If something happened during read, abandon reader + if not self._shuttingDown.isSet(): + logger.error("Exception at socket read") + self._shuttingDown.set() + return + + # Parsing everything only if the string is not empty + if self._recvbuffer: + if not self._vlcver: + # First line (VLC version) + self._vlcver = self._recvbuffer.strip() + # Send password here since PASSWORD doesn't have \n + self._write(self._password) + + elif self._recvbuffer.startswith(VlcMessage.response.SHUTDOWN): + # Exit from this loop + logger.debug("Got SHUTDOWN from VLC") + return + + elif self._recvbuffer.startswith(VlcMessage.response.WRONGPASS): + # Wrong password + logger.error("Wrong VLC password!") + self._auth.set(False) + return + + elif self._recvbuffer.startswith(VlcMessage.response.AUTHOK): + # Authentication OK + logger.info("Authentication successful") + self._auth.set(True) + + elif VlcMessage.response.BROADCASTEXISTS in self._recvbuffer: + # Broadcast already exists + logger.error("Broadcast already exists!") + self._result.set(False) + + elif VlcMessage.response.STOPERR in self._recvbuffer: + # Media unknown (stopping non-existent stream) + logger.error("Broadcast does not exist!") + self._result.set(False) + + # Do not move this before error handlers! + elif self._recvbuffer.startswith(VlcMessage.response.STARTOK): + # Broadcast started + logger.debug("Broadcast started") + self._result.set(True) + + elif self._recvbuffer.startswith(VlcMessage.response.STOPOK): + # Broadcast stopped + logger.debug("Broadcast stopped") + self._result.set(True) diff --git a/vlcclient/vlcmessages.py b/vlcclient/vlcmessages.py new file mode 100644 index 0000000..10de03d --- /dev/null +++ b/vlcclient/vlcmessages.py @@ -0,0 +1,38 @@ +''' +Minimal VLC client for AceProxy. Messages class. +''' + + +class VlcMessage(object): + + class request(object): + SHUTDOWN = 'shutdown' + + @staticmethod + def startBroadcast(stream_name, input, out_port, muxer='ts', pre_access=''): + return 'new "' + stream_name + '" broadcast input "' + input + '" output ' + (pre_access + ':' if pre_access else '#') + \ + 'http{mux=' + muxer + ',dst=:' + \ + str(out_port) + '/' + stream_name + '} option sout-keep option sout-all enabled' + \ + "\r\n" + 'control "' + stream_name + '" play' + + @staticmethod + def stopBroadcast(stream_name): + return 'del "' + stream_name + '"' + + @staticmethod + def pauseBroadcast(stream_name): + return 'control "' + stream_name + '" pause' + + @staticmethod + def playBroadcast(stream_name): + return 'control "' + stream_name + '" play' + + class response(object): + WRONGPASS = 'Wrong password' + AUTHOK = 'Welcome, Master' + BROADCASTEXISTS = 'Name already in use' + SYNTAXERR = 'Wrong command syntax' + STARTOK = 'new' + STOPOK = 'del' + STOPERR = 'media unknown' + SHUTDOWN = 'Bye-bye!' diff --git a/vpconfig.py b/vpconfig.py new file mode 100644 index 0000000..ca11dd5 --- /dev/null +++ b/vpconfig.py @@ -0,0 +1,102 @@ +''' +VPProxy configuration script +Edit this file. +''' + +import logging + +class VPConfig(): + + # Message level (DEBUG, INFO, WARNING, ERROR, CRITICAL) + debug = logging.DEBUG + # HTTP Server host + httphost = '0.0.0.0' + # HTTP Server port + httpport = 8001 + # If started as root, drop privileges to this user. + # Leave empty to disable. + vpproxyuser = 'aceproxy' + # Enable firewall + firewall = False + # Firewall mode. True for blackilst, False for whitelist + firewallblacklistmode = False + # Network ranges. Please don't forget about comma in the end + # of every range, especially if there is only one. + firewallnetranges = ( + '127.0.0.1', + '192.168.0.0/16', + '10.8.0.0/16', + ) + # Maximum concurrent connections (video clients) + maxconns = 20 + # Logging to a file + loggingtoafile = False + # Path for logs, default is current directory. For example '/tmp/' + logpath = '' + # + # ---------------------------------------------------- + # VLC configuration + # ---------------------------------------------------- + # + vlcuse = True + # Spawn VLC automaticaly + vlcspawn = True + # VLC cmd line (use `--file-logging --logfile=filepath` to write log) + vlccmd = "vlc -I telnet --clock-jitter -1 --network-caching -1 --sout-mux-caching 2000 --telnet-password admin --telnet-port 4212" + # VLC spawn timeout + # Adjust this if you get error 'Cannot spawn VLC!' + vlcspawntimeout = 4 + # VLC host + vlchost = '127.0.0.1' + # VLC telnet interface port + vlcport = 4212 + # VLC streaming port (you shouldn't set it in VLC itself) + vlcoutport = 8099 + # VLC telnet interface password + vlcpass = 'admin' + # Pre-access (HTTP) VLC parameters + # You can add transcode options here + # Something like #transcode{acodec=mpga,ab=128,channels=2,samplerate=44100} + vlcpreaccess = '' + # VLC muxer. You probably want one of these streamable muxers: + # ts, asf, flv, ogg, mkv + # You can use ffmpeg muxers too, if your VLC is built with it + # ffmpeg{mux=NAME} (i.e. ffmpeg{mux=mpegts}) + # VLC's ts muxer sometimes can work badly, but that's the best choice for + # now. + vlcmux = 'ts' + # Force ffmpeg INPUT demuxer in VLC. Sometimes can help. + vlcforceffmpeg = False + # Stream start delay for dumb players (in seconds) + # !!! + # PLEASE set this to 0 if you use VLC + # !!! + videodelay = 0 + # Stream send delay after PAUSE/RESUME commands (works only if option + # above is enabled) + # !!! + # PLEASE set this to 0 if you use VLC + # !!! + videopausedelay = 0 + # Seek back feature. + # Seeks stream back for specified amount of seconds. + # Set it to 30 or so. + videoseekback = 5 + # Delay before closing connection when client disconnects + # In seconds. + videodestroydelay = 5 + # Pre-buffering timeout. In seconds. + videotimeout = 30 + # + # Some video players (mostly STBs and Smart TVs) can generate dummy requests + # to detect MIME-type or something before playing. + # We send them 200 OK and do nothing. + # We add their User-Agents here + fakeuas = ('Mozilla/5.0 IMC plugin Macintosh', ) + # + # Some video players have very short timeout and can disconnect from the proxy + # before the headers sent. + # We send them 200 OK and MPEG MIME-type right after connection has been initiated + fakeheaderuas = ('HLS Client/2.0 (compatible; LG NetCast.TV-2012)', + 'Mozilla/5.0 (DirectFB; Linux armv7l) AppleWebKit/534.26+ (KHTML, like Gecko) Version/5.0 Safari/534.26+ LG Browser/5.00.00(+mouse+3D+SCREEN+TUNER; LGE; 42LM670T-ZA; 04.41.03; 0x00000001;); LG NetCast.TV-2012 0' + ) diff --git a/vphttp.py b/vphttp.py new file mode 100644 index 0000000..9046563 --- /dev/null +++ b/vphttp.py @@ -0,0 +1,529 @@ +#!/usr/bin/env python2 +# -*- coding: utf-8 -*- +''' +VPProxy: HTTP/HLS Stream to HTTP Multiplexing Proxy + +Based on AceProxy (https://github.com/ValdikSS/AceProxy) design +''' +import traceback +import gevent +import gevent.monkey +# Monkeypatching and all the stuff + +gevent.monkey.patch_all() +import glob +import os +import signal +import sys +import logging +import psutil +import BaseHTTPServer +import SocketServer +from socket import error as SocketException +from socket import SHUT_RDWR +import urllib2 +import hashlib +import vpconfig +from vpconfig import VPConfig +import vlcclient +import plugins.modules.ipaddr as ipaddr +from clientcounter import ClientCounter +from plugins.modules.PluginInterface import VPProxyPlugin +try: + import pwd + import grp +except ImportError: + pass + + + +class HTTPHandler(BaseHTTPServer.BaseHTTPRequestHandler): + + requestlist = [] + + def handle_one_request(self): + ''' + Add request to requestlist, handle request and remove from the list + ''' + HTTPHandler.requestlist.append(self) + BaseHTTPServer.BaseHTTPRequestHandler.handle_one_request(self) + HTTPHandler.requestlist.remove(self) + + def closeConnection(self): + ''' + Disconnecting client + ''' + if self.clientconnected: + self.clientconnected = False + try: + self.wfile.close() + self.rfile.close() + self.connection.shutdown(SHUT_RDWR) + except: + pass + + def dieWithError(self, errorcode=500): + ''' + Close connection with error + ''' + logging.warning("Dying with error") + if self.clientconnected: + self.send_error(errorcode) + self.end_headers() + self.closeConnection() + + def proxyReadWrite(self): + ''' + Read video stream and send it to client + ''' + logger = logging.getLogger('http_proxyReadWrite') + logger.debug("Started") + + self.vlcstate = True + self.streamstate = True + + try: + while True: + + if not self.clientconnected: + logger.debug("Client is not connected, terminating") + break + + data = self.video.read(4096) + if data and self.clientconnected: + self.wfile.write(data) + else: + logger.warning("Video connection closed") + break + + except SocketException: + # Video connection dropped + logger.warning("Video connection dropped") + finally: + self.video.close() + self.closeConnection() + + def hangDetector(self): + ''' + Detect client disconnection while in the middle of something + or just normal connection close. + ''' + logger = logging.getLogger('http_hangDetector') + try: + while True: + if not self.rfile.read(): + break + except: + pass + finally: + self.clientconnected = False + logger.debug("Client disconnected") + try: + self.requestgreenlet.kill() + except: + pass + finally: + gevent.sleep() + return + + def do_HEAD(self): + return self.do_GET(headers_only=True) + + def do_GET(self, headers_only=False): + ''' + GET request handler + ''' + logger = logging.getLogger('http_HTTPHandler') + self.clientconnected = True + # Don't wait videodestroydelay if error happened + self.errorhappened = True + # Headers sent flag for fake headers UAs + self.headerssent = False + # Current greenlet + self.requestgreenlet = gevent.getcurrent() + # Connected client IP address + self.clientip = self.request.getpeername()[0] + + if VPConfig.firewall: + # If firewall enabled + self.clientinrange = any(map(lambda i: ipaddr.IPAddress(self.clientip) \ + in ipaddr.IPNetwork(i), VPConfig.firewallnetranges)) + + if (VPConfig.firewallblacklistmode and self.clientinrange) or \ + (not VPConfig.firewallblacklistmode and not self.clientinrange): + logger.info('Dropping connection from ' + self.clientip + ' due to ' + \ + 'firewall rules') + self.dieWithError(403) # 403 Forbidden + return + + logger.info("Accepted connection from " + self.clientip + " path " + self.path) + + try: + self.splittedpath = self.path.split('/') + self.reqtype = self.splittedpath[1].lower() + # If first parameter is 'pid' or 'torrent' or it should be handled + # by plugin + if not (self.reqtype=='get' or self.reqtype in VPStuff.pluginshandlers): + self.dieWithError(400) # 400 Bad Request + return + except IndexError: + self.dieWithError(400) # 400 Bad Request + return + + # Handle request with plugin handler + if self.reqtype in VPStuff.pluginshandlers: + try: + VPStuff.pluginshandlers.get(self.reqtype).handle(self) + except Exception as e: + logger.error('Plugin exception: ' + repr(e)) + logger.error(traceback.format_exc()) + self.dieWithError() + finally: + self.closeConnection() + return + self.handleRequest(headers_only) + + def handleRequest(self, headers_only): + + # Limit concurrent connections + if 0 < VPConfig.maxconns <= VPStuff.clientcounter.total: + logger.debug("Maximum connections reached, can't serve this") + self.dieWithError(503) # 503 Service Unavailable + return + + # Pretend to work fine with Fake UAs or HEAD request. + useragent = self.headers.get('User-Agent') + fakeua = useragent and useragent in VPConfig.fakeuas + if headers_only or fakeua: + if fakeua: + logger.debug("Got fake UA: " + self.headers.get('User-Agent')) + # Return 200 and exit + self.send_response(200) + self.send_header("Content-Type", "video/mpeg") + self.end_headers() + self.closeConnection() + return + + self.path_unquoted = urllib2.unquote('/'.join(self.splittedpath[2:])) + # Make list with parameters + self.params = list() + for i in xrange(3, 8): + try: + self.params.append(int(self.splittedpath[i])) + except (IndexError, ValueError): + self.params.append('0') + + # Adding client to clientcounter + clients = VPStuff.clientcounter.add(self.path_unquoted, self.clientip) + # If we are the one client, but sucessfully got vp instance from clientcounter, + # then somebody is waiting in the videodestroydelay state + + # Check if we are first client + if VPStuff.clientcounter.get(self.path_unquoted)==1: + logger.debug("First client, should create VLC session") + shouldcreatevp = True + else: + logger.debug("Can reuse existing session") + shouldcreatevp = False + + self.vlcid = hashlib.md5(self.path_unquoted).hexdigest() + + # Send fake headers if this User-Agent is in fakeheaderuas tuple + if fakeua: + logger.debug( + "Sending fake headers for " + useragent) + self.send_response(200) + self.send_header("Content-Type", "video/mpeg") + self.end_headers() + # Do not send real headers at all + self.headerssent = True + + try: + self.hanggreenlet = gevent.spawn(self.hangDetector) + logger.debug("hangDetector spawned") + gevent.sleep() + + # Initializing VPClient + + # Getting URL + self.errorhappened = False + + print shouldcreatevp + if shouldcreatevp: + logger.debug("Got url " + self.path_unquoted) + # Force ffmpeg demuxing if set in config + if VPConfig.vlcforceffmpeg: + self.vlcprefix = 'http/ffmpeg://' + else: + self.vlcprefix = '' + + VPStuff.vlcclient.startBroadcast( + self.vlcid, self.vlcprefix + self.path_unquoted, VPConfig.vlcmux, VPConfig.vlcpreaccess) + # Sleep a bit, because sometimes VLC doesn't open port in + # time + gevent.sleep(0.5) + + # Building new VLC url + self.url = 'http://' + VPConfig.vlchost + \ + ':' + str(VPConfig.vlcoutport) + '/' + self.vlcid + logger.debug("VLC url " + self.url) + + # Sending client headers to videostream + self.video = urllib2.Request(self.url) + for key in self.headers.dict: + self.video.add_header(key, self.headers.dict[key]) + + self.video = urllib2.urlopen(self.video) + + # Sending videostream headers to client + if not self.headerssent: + self.send_response(self.video.getcode()) + if self.video.info().dict.has_key('connection'): + del self.video.info().dict['connection'] + if self.video.info().dict.has_key('server'): + del self.video.info().dict['server'] + if self.video.info().dict.has_key('transfer-encoding'): + del self.video.info().dict['transfer-encoding'] + if self.video.info().dict.has_key('keep-alive'): + del self.video.info().dict['keep-alive'] + + for key in self.video.info().dict: + self.send_header(key, self.video.info().dict[key]) + # End headers. Next goes video data + self.end_headers() + logger.debug("Headers sent") + + # Run proxyReadWrite + self.proxyReadWrite() + + # Waiting until hangDetector is joined + self.hanggreenlet.join() + logger.debug("Request handler finished") + + except (vpclient.VPException, vlcclient.VlcException, urllib2.URLError) as e: + logger.error("Exception: " + repr(e)) + self.errorhappened = True + self.dieWithError() + except gevent.GreenletExit: + # hangDetector told us about client disconnection + pass + except Exception: + # Unknown exception + logger.error(traceback.format_exc()) + self.errorhappened = True + raise + self.dieWithError() + finally: + logger.debug("END REQUEST") + VPStuff.clientcounter.delete(self.path_unquoted, self.clientip) + if not VPStuff.clientcounter.get(self.path_unquoted): + try: + logger.debug("That was the last client, destroying VPClient") + VPStuff.vlcclient.stopBroadcast(self.vlcid) + except: + pass + self.vp.destroy() + + +class HTTPServer(SocketServer.ThreadingMixIn, BaseHTTPServer.HTTPServer): + + def handle_error(self, request, client_address): + # Do not print HTTP tracebacks + pass + + +class VPStuff(object): + ''' + Inter-class interaction class + ''' + vlcclient=None + +# taken from http://stackoverflow.com/questions/2699907/dropping-root-permissions-in-python +def drop_privileges(uid_name, gid_name='nogroup'): + + # Get the uid/gid from the name + running_uid = pwd.getpwnam(uid_name).pw_uid + running_uid_home = pwd.getpwnam(uid_name).pw_dir + running_gid = grp.getgrnam(gid_name).gr_gid + + # Remove group privileges + os.setgroups([]) + + # Try setting the new uid/gid + os.setgid(running_gid) + os.setuid(running_uid) + + # Ensure a very conservative umask + old_umask = os.umask(077) + + if os.getuid() == running_uid and os.getgid() == running_gid: + # could be useful + os.environ['HOME'] = running_uid_home + return True + return False + +logging.basicConfig( + filename=VPConfig.logpath + 'vphttp.log' if VPConfig.loggingtoafile else None, + format='%(asctime)s %(levelname)s %(name)s: %(message)s', datefmt='%d.%m.%Y %H:%M:%S', level=VPConfig.debug) +logger = logging.getLogger('INIT') + +# Loading plugins +# Trying to change dir (would fail in freezed state) +try: + os.chdir(os.path.dirname(os.path.realpath(__file__))) +except: + pass +# Creating dict of handlers +VPStuff.pluginshandlers = dict() +# And a list with plugin instances +VPStuff.pluginlist = list() +pluginsmatch = glob.glob('plugins/*_plugin.py') +sys.path.insert(0, 'plugins') +pluginslist = [os.path.splitext(os.path.basename(x))[0] for x in pluginsmatch] +for i in pluginslist: + plugin = __import__(i) + plugname = i.split('_')[0].capitalize() + try: + plugininstance = getattr(plugin, plugname)(VPConfig, VPStuff) + except Exception as e: + logger.error("Cannot load plugin " + plugname + ": " + repr(e)) + continue + logger.debug('Plugin loaded: ' + plugname) + for j in plugininstance.handlers: + VPStuff.pluginshandlers[j] = plugininstance + VPStuff.pluginlist.append(plugininstance) + +# Check whether we can bind to the defined port safely +if os.getuid() != 0 and VPConfig.httpport <= 1024: + logger.error("Cannot bind to port " + str(VPConfig.httpport) + " without root privileges") + sys.exit(1) + +server = HTTPServer((VPConfig.httphost, VPConfig.httpport), HTTPHandler) +logger = logging.getLogger('HTTP') + +# Dropping root privileges if needed +if VPConfig.vpproxyuser and os.getuid() == 0: + if drop_privileges(VPConfig.vpproxyuser): + logger.info("Dropped privileges to user " + VPConfig.vpproxyuser) + else: + logger.error("Cannot drop privileges to user " + VPConfig.vpproxyuser) + sys.exit(1) + +# Creating ClientCounter +VPStuff.clientcounter = ClientCounter() + +DEVNULL = open(os.devnull, 'wb') + +# Spawning procedures +def spawnVLC(cmd, delay = 0): + try: + VPStuff.vlc = psutil.Popen(cmd, stdout=DEVNULL, stderr=DEVNULL) + gevent.sleep(delay) + return True + except: + return False + +def connectVLC(): + try: + VPStuff.vlcclient = vlcclient.VlcClient( + host=VPConfig.vlchost, port=VPConfig.vlcport, password=VPConfig.vlcpass, + out_port=VPConfig.vlcoutport) + return True + except vlcclient.VlcException as e: + print repr(e) + return False + +def isRunning(process): + if psutil.version_info[0] >= 2: + if process.is_running() and process.status() != psutil.STATUS_ZOMBIE: + return True + else: # for older versions of psutil + if process.is_running() and process.status != psutil.STATUS_ZOMBIE: + return True + return False + +def findProcess(name): + for proc in psutil.process_iter(): + try: + pinfo = proc.as_dict(attrs=['pid', 'name']) + if pinfo['name'] == name: + return pinfo['pid'] + except psutil.AccessDenied: + # System process + pass + except psutil.NoSuchProcess: + # Process terminated + pass + return None + +def clean_proc(): + # Trying to close all spawned processes gracefully + if isRunning(VPStuff.vlc): + if VPStuff.vlcclient: + VPStuff.vlcclient.destroy() + gevent.sleep(1) + if isRunning(VPStuff.vlc): + # or not :) + VPStuff.vlc.kill() + +# This is what we call to stop the server completely +def shutdown(signum = 0, frame = 0): + logger.info("Stopping server...") + # Closing all client connections + for connection in server.RequestHandlerClass.requestlist: + try: + # Set errorhappened to prevent waiting for videodestroydelay + connection.errorhappened = True + connection.closeConnection() + except: + logger.warning("Cannot kill a connection!") + clean_proc() + server.server_close() + sys.exit() + +def _reloadconfig(signum=None, frame=None): + ''' + Reload configuration file. + SIGHUP handler. + ''' + global VPConfig + + logger = logging.getLogger('reloadconfig') + reload(vpconfig) + from vpconfig import VPConfig + logger.info('Config reloaded') + +# setting signal handlers +try: + gevent.signal(signal.SIGHUP, _reloadconfig) + gevent.signal(signal.SIGTERM, shutdown) +except AttributeError: + pass + +name = 'vlc' +VPStuff.vlcProc = VPConfig.vlccmd.split() +if spawnVLC(VPStuff.vlcProc, VPConfig.vlcspawntimeout) and connectVLC(): + logger.info("VLC spawned with pid " + str(VPStuff.vlc.pid)) +else: + logger.error('Cannot spawn or connect to VLC!') + clean_proc() + sys.exit(1) + +try: + logger.info("Using gevent %s" % gevent.__version__) + logger.info("Using psutil %s" % psutil.__version__) + logger.info("Using VLC %s" % VPStuff.vlcclient._vlcver) + logger.info("Server started.") + while True: + if not isRunning(VPStuff.vlc): + del VPStuff.vlc + if spawnVLC(VPStuff.vlcProc, VPConfig.vlcspawntimeout) and connectVLC(): + logger.info("VLC died, respawned it with pid " + str(VPStuff.vlc.pid)) + else: + logger.error("Cannot spawn VLC!") + clean_proc() + sys.exit(1) + # Return to our server tasks + server.handle_request() +except (KeyboardInterrupt, SystemExit): + shutdown() -- 2.34.1