OpenRPG WIKI - separate login required
Cherry Py Plugin
This plugin is a very simple to use webserver so that you do not have to rely on an external webhost for your maps and mini's. To get started enable the plugin from the Plugin Control Panel then just type /cherrypy on. You you see a message in your chat window giving you the IP you will need to use to host your files. The plugin uses a folder called webfiles that is located in the myfiles directory, if the folder does not exist you will get an error message letting you know this. Just create the folder and type the command again
If you are behind a router you will need to setup the proper port forwarding and use the IP of your router insted of the IP that the plugin reports. This is unsupported though so if it does not work hopfully other users will beable to help you and or post a guide to get it working here on the WIKI.
Commands
/cherrypy on
/cherrypy off
/cherrypy status
import os
import orpg.pluginhandler
import thread
from cherrypy import cpg
import socket
class Plugin(orpg.pluginhandler.PluginHandler):
# Initialization subroutine.
#
# !self : instance of self
# !openrpg : instance of the the base openrpg control
def __init__(self, openrpg, plugindb, parent):
orpg.pluginhandler.PluginHandler.__init__(self, openrpg, plugindb, parent)
# The Following code should be edited to contain the proper information
self.name = 'CherryPy Web Server'
self.author = 'Dj Gilcrease'
self.help = 'This plugin turns OpenRPG into a Web server\n'
self.help += 'allowing you to host your map and mini files localy'
#You can set variables below here. Always set them to a blank value in this section. Use plugin_enabled
#to set their proper values.
self.isServerRunning = 'off'
self.host = 0
def plugin_enabled(self):
self.plugin_addcommand('/cherrypy', self.on_cherrypy, '[on | off | status] - This controls the CherryPy Web Server')
tmp = socket.gethostbyname_ex('')
for ip in tmp[2]:
if ip[:7] == '192.168' or ip[:3] == '10.' or ip == '127.0.0.1' or (ip[:3] == '172' and (int(ip[5:6]) >= 16 and int(ip[5:6]) <=32)) :
if not self.host:
self.chat.InfoPost("[WARNING] Cherrypy has detected you may be behind a router, This is your internal IP. For other users to properly connect, you may have to use your external IP, with port forwarding on port XXXX [80?]<br>This feature is not suported in any way.")
else:
self.host = ip
def plugin_disabled(self):
#Here you need to remove any commands you added, and anything else you want to happen when you disable the plugin
#such as closing windows created by the plugin
self.plugin_removecmd('/cherrypy')
cpg.server.stop()
self.isServerRunning = 'off'
def on_cherrypy(self, cmdargs):
args = cmdargs.split(None,-1)
if len(args) == 0 or args[0] == 'status':
self.chat.InfoPost("CherryPy Web Server is currently: " + self.isServerRunning)
self.chat.InfoPost("CherryPy Web Server address is: http://" + self.host + '/webfiles/')
elif args[0] == 'on' and self.isServerRunning == 'off':
self.webserver = thread.start_new_thread(self.startServer, (80,))
self.isServerRunning = 'on'
elif args[0] == 'off' and self.isServerRunning == 'on':
cpg.server.stop()
self.isServerRunning = 'off'
self.chat.InfoPost("CherryPy Web Server is now disabled")
def startServer(self, port):
try:
if self.host == 0:
raise Exception("Invalid IP address.<br>This error means you are behind a router or some other form of network that is giving you a Privet IP only (ie. 192.168.x.x, 10.x.x.x, 172.16 - 32.x.x)")
self.chat.InfoPost("CherryPy Web Server is now running on http://" + self.host + '/webfiles/')
cpg.server.start(configMap =
{'staticContentList': [['images', r''+orpg.dirpath.dir_struct["icon"]+''],['webfiles', r''+orpg.dirpath.dir_struct["user"]+'webfiles/']],
'socketPort': port,
'logToScreen': 0,
'logFile':orpg.dirpath.dir_struct["user"]+'webfiles/log.txt',
'sessionStorageType':'ram',
'threadPool':10,
'sessionTimeout':30,
'sessionCleanUpDelay':30})
except Exception, e:
self.chat.InfoPost("FAILED to start server!")
self.chat.InfoPost(str(e))
self.isServerRunning = 'off'