#!/usr/bin/python ''' The MIT License (MIT) Copyright (c) 2013 winlin 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. ''' """ the api-server is a default demo server for srs to call when srs get some event, for example, when client connect to srs, srs can invoke the http api of the api-server """ import sys # reload sys model to enable the getdefaultencoding method. reload(sys) # set the default encoding to utf-8 # using exec to set the encoding, to avoid error in IDE. exec("sys.setdefaultencoding('utf-8')") assert sys.getdefaultencoding().lower() == "utf-8" import json, datetime, cherrypy # simple log functions. def trace(msg): date = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S") print "[%s][trace] %s"%(date, msg) # enable crossdomain access for js-client def enable_crossdomain(): cherrypy.response.headers["Access-Control-Allow-Origin"] = "*" cherrypy.response.headers["Access-Control-Allow-Methods"] = "GET, POST, HEAD, PUT, DELETE" # generate allow headers for crossdomain. allow_headers = ["Cache-Control", "X-Proxy-Authorization", "X-Requested-With", "Content-Type"] cherrypy.response.headers["Access-Control-Allow-Headers"] = ",".join(allow_headers) # error codes definition class Error: # ok, success, completed. success = 0 # error when parse json system_parse_json = 100 # request action invalid request_invalid_action = 200 ''' handle the clients requests: connect/disconnect vhost/app. ''' class RESTClients(object): exposed = True def GET(self): enable_crossdomain() clients = {} return json.dumps(clients) ''' for SRS hook: on_connect/on_close on_connect: when client connect to vhost/app, call the hook, the request in the POST data string is a object encode by json: { "action": "on_connect", "client_id": 1985, "ip": "192.168.1.10", "vhost": "video.test.com", "app": "live", "pageUrl": "http://www.test.com/live.html" } on_close: when client close/disconnect to vhost/app/stream, call the hook, the request in the POST data string is a object encode by json: { "action": "on_close", "client_id": 1985, "ip": "192.168.1.10", "vhost": "video.test.com", "app": "live" } if valid, the hook must return HTTP code 200(Stauts OK) and response an int value specifies the error code(0 corresponding to success): 0 ''' def POST(self): enable_crossdomain() # return the error code in str code = Error.success req = cherrypy.request.body.read() trace("post to clients, req=%s"%(req)) try: json_req = json.loads(req) except Exception, ex: code = Error.system_parse_json trace("parse the request to json failed, req=%s, ex=%s, code=%s"%(req, ex, code)) return str(code) action = json_req["action"] if action == "on_connect": code = self.__on_connect(json_req) elif action == "on_close": code = self.__on_close(json_req) else: trace("invalid request action: %s"%(json_req["action"])) code = Error.request_invalid_action return str(code) def OPTIONS(self): enable_crossdomain() def __on_connect(self, req): code = Error.success trace("srs %s: client id=%s, ip=%s, vhost=%s, app=%s, pageUrl=%s"%( req["action"], req["client_id"], req["ip"], req["vhost"], req["app"], req["pageUrl"] )) # TODO: process the on_connect event return code def __on_close(self, req): code = Error.success trace("srs %s: client id=%s, ip=%s, vhost=%s, app=%s"%( req["action"], req["client_id"], req["ip"], req["vhost"], req["app"] )) # TODO: process the on_close event return code ''' handle the streams requests: publish/unpublish stream. ''' class RESTStreams(object): exposed = True def GET(self): enable_crossdomain() streams = {} return json.dumps(streams) ''' for SRS hook: on_publish/on_unpublish on_publish: when client(encoder) publish to vhost/app/stream, call the hook, the request in the POST data string is a object encode by json: { "action": "on_publish", "client_id": 1985, "ip": "192.168.1.10", "vhost": "video.test.com", "app": "live", "stream": "livestream" } on_unpublish: when client(encoder) stop publish to vhost/app/stream, call the hook, the request in the POST data string is a object encode by json: { "action": "on_unpublish", "client_id": 1985, "ip": "192.168.1.10", "vhost": "video.test.com", "app": "live", "stream": "livestream" } if valid, the hook must return HTTP code 200(Stauts OK) and response an int value specifies the error code(0 corresponding to success): 0 ''' def POST(self): enable_crossdomain() # return the error code in str code = Error.success req = cherrypy.request.body.read() trace("post to streams, req=%s"%(req)) try: json_req = json.loads(req) except Exception, ex: code = Error.system_parse_json trace("parse the request to json failed, req=%s, ex=%s, code=%s"%(req, ex, code)) return str(code) action = json_req["action"] if action == "on_publish": code = self.__on_publish(json_req) elif action == "on_unpublish": code = self.__on_unpublish(json_req) else: trace("invalid request action: %s"%(json_req["action"])) code = Error.request_invalid_action return str(code) def OPTIONS(self): enable_crossdomain() def __on_publish(self, req): code = Error.success trace("srs %s: client id=%s, ip=%s, vhost=%s, app=%s, stream=%s"%( req["action"], req["client_id"], req["ip"], req["vhost"], req["app"], req["stream"] )) # TODO: process the on_publish event return code def __on_unpublish(self, req): code = Error.success trace("srs %s: client id=%s, ip=%s, vhost=%s, app=%s, stream=%s"%( req["action"], req["client_id"], req["ip"], req["vhost"], req["app"], req["stream"] )) # TODO: process the on_unpublish event return code ''' handle the sessions requests: client play/stop stream ''' class RESTSessions(object): exposed = True def GET(self): enable_crossdomain() sessions = {} return json.dumps(sessions) ''' for SRS hook: on_play/on_stop on_play: when client(encoder) publish to vhost/app/stream, call the hook, the request in the POST data string is a object encode by json: { "action": "on_play", "client_id": 1985, "ip": "192.168.1.10", "vhost": "video.test.com", "app": "live", "stream": "livestream" } on_stop: when client(encoder) stop publish to vhost/app/stream, call the hook, the request in the POST data string is a object encode by json: { "action": "on_stop", "client_id": 1985, "ip": "192.168.1.10", "vhost": "video.test.com", "app": "live", "stream": "livestream" } if valid, the hook must return HTTP code 200(Stauts OK) and response an int value specifies the error code(0 corresponding to success): 0 ''' def POST(self): enable_crossdomain() # return the error code in str code = Error.success req = cherrypy.request.body.read() trace("post to sessions, req=%s"%(req)) try: json_req = json.loads(req) except Exception, ex: code = Error.system_parse_json trace("parse the request to json failed, req=%s, ex=%s, code=%s"%(req, ex, code)) return str(code) action = json_req["action"] if action == "on_play": code = self.__on_play(json_req) elif action == "on_stop": code = self.__on_stop(json_req) else: trace("invalid request action: %s"%(json_req["action"])) code = Error.request_invalid_action return str(code) def OPTIONS(self): enable_crossdomain() def __on_play(self, req): code = Error.success trace("srs %s: client id=%s, ip=%s, vhost=%s, app=%s, stream=%s"%( req["action"], req["client_id"], req["ip"], req["vhost"], req["app"], req["stream"] )) # TODO: process the on_play event return code def __on_stop(self, req): code = Error.success trace("srs %s: client id=%s, ip=%s, vhost=%s, app=%s, stream=%s"%( req["action"], req["client_id"], req["ip"], req["vhost"], req["app"], req["stream"] )) # TODO: process the on_stop event return code # HTTP RESTful path. class Root(object): def __init__(self): self.api = Api() # HTTP RESTful path. class Api(object): def __init__(self): self.v1 = V1() # HTTP RESTful path. to access as: # http://127.0.0.1:8085/api/v1/clients class V1(object): def __init__(self): self.clients = RESTClients() self.streams = RESTStreams() self.sessions = RESTSessions() ''' main code start. ''' # donot support use this module as library. if __name__ != "__main__": raise Exception("embed not support") # check the user options if len(sys.argv) <= 1: print "SRS api callback server, Copyright (c) 2013 winlin" print "Usage: python %s "%(sys.argv[0]) print " port: the port to listen at." print "For example:" print " python %s 8085"%(sys.argv[0]) print "" print "See also: https://github.com/winlinvip/simple-rtmp-server" sys.exit(1) # parse port from user options. port = int(sys.argv[1]) trace("api server listen at port: %s"%(port)) # cherrypy config. conf = { 'global': { 'server.shutdown_timeout': 1, 'server.socket_host': '0.0.0.0', 'server.socket_port': port, 'tools.encode.on': True, 'tools.encode.encoding': "utf-8" }, '/': { # for cherrypy RESTful api support 'request.dispatch': cherrypy.dispatch.MethodDispatcher() } } # start cherrypy web engine trace("start cherrypy server") cherrypy.quickstart(Root(), '/', conf)