tippero/tipbot.py

493 lines
18 KiB
Python
Raw Permalink Normal View History

2014-12-09 10:00:19 +00:00
#!/bin/python
#
# Cryptonote tipbot
# Copyright 2014,2015 moneromooo
# Inspired by "Simple Python IRC bot" by berend
#
2014-12-23 10:47:56 +00:00
# The Cryptonote tipbot is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as published
# by the Free Software Foundation; either version 2, or (at your option)
# any later version.
#
2014-12-09 10:00:19 +00:00
import sys
import os
2014-12-09 10:00:19 +00:00
import socket
import select
import random
2014-12-09 10:00:19 +00:00
import redis
import hashlib
import json
import httplib
import time
import string
import importlib
import re
import tipbot.coinspecs as coinspecs
import tipbot.config as config
from tipbot.log import log_error, log_warn, log_info, log_log
2015-01-13 12:28:05 +00:00
from tipbot.link import *
from tipbot.user import *
from tipbot.group import *
from tipbot.utils import *
from tipbot.redisdb import *
2014-12-31 10:30:07 +00:00
from tipbot.command_manager import *
2015-01-17 13:19:50 +00:00
disabled = False
selected_coin = None
modulenames = []
start_networks = []
argc = 1
while argc < len(sys.argv):
arg = sys.argv[argc]
if arg == "-c" or arg == "--coin":
if argc+1 == len(sys.argv):
log_error('Usage: tipbot.py [-h|--help] [-m|--module modulename]* -c|--coin <coinname>')
exit(1)
argc = argc+1
selected_coin = sys.argv[argc]
try:
log_info('Importing %s coin setup' % selected_coin)
if not selected_coin in coinspecs.coinspecs:
log_error('Unknown coin: %s' % selected_coin)
exit(1)
for field in coinspecs.coinspecs[selected_coin]:
setattr(coinspecs, field, coinspecs.coinspecs[selected_coin][field])
except Exception,e:
log_error('Failed to load coin setup for %s: %s' % (selected_coin, str(e)))
exit(1)
elif arg == "-m" or arg == "--module":
if argc+1 == len(sys.argv):
log_error('Usage: tipbot.py [-m|--module modulename]* -c|--coin <coinname>')
exit(1)
argc = argc+1
arg = sys.argv[argc]
if not arg in modulenames:
modulenames.append(arg)
elif arg == "-n" or arg == "--network":
if argc+1 == len(sys.argv):
log_error('Usage: tipbot.py [-m|--module modulename]* -c|--coin <coinname>')
exit(1)
argc = argc+1
arg = sys.argv[argc]
if re.match('[^:]+:.+',arg):
parts=arg.split(':',1)
if not parts[1] in modulenames:
modulenames.append(parts[1])
start_networks.append({'name':parts[0],'type':parts[1]})
else:
if not arg in modulenames:
modulenames.append(arg)
start_networks.append({'type':arg})
elif arg == "-h" or arg == "--help":
log_info('Usage: tipbot.py [-m|--module modulename]* -c|--coin <coinname>')
exit(0)
else:
log_error('Usage: tipbot.py [-m|--module modulename]* -c|--coin <coinname>')
exit(1)
argc = argc + 1
2014-12-09 10:00:19 +00:00
if not selected_coin:
log_error('Coin setup needs to be specified with -c. See --help')
exit(1)
sys.path.append(os.path.join('tipbot','modules'))
for modulename in modulenames:
2015-01-13 12:28:05 +00:00
if modulename in sys.modules:
log_error('A %s module already exists' % modulename)
exit(1)
log_info('Importing %s module' % modulename)
try:
__import__(modulename)
except Exception,e:
log_error('Failed to load module "%s": %s' % (modulename, str(e)))
exit(1)
2014-12-09 10:00:19 +00:00
2015-01-13 12:28:05 +00:00
def GetBalance(link,cmd):
nick=link.user.nick
if link.group and nick.startswith('blackbab'):
link.send_private("Stop spamming the public channel")
return
2014-12-09 10:00:19 +00:00
try:
balance,confirming = RetrieveBalance(link)
2014-12-09 10:00:19 +00:00
sbalance = AmountToString(balance)
if balance < coinspecs.atomic_units:
2015-01-13 23:32:11 +00:00
if balance == 0:
msg="%s's balance is %s" % (nick, sbalance)
2015-01-13 23:32:11 +00:00
else:
msg="%s's balance is %s (%.16g %s)" % (nick, sbalance, float(balance) / coinspecs.atomic_units, coinspecs.name)
else:
msg="%s's balance is %s" % (nick, sbalance)
if confirming > 0:
msg = msg + " (%s awaiting confirmation)" % (AmountToString(confirming))
link.send(msg)
2014-12-09 10:00:19 +00:00
except Exception, e:
log_error('GetBalance: exception: %s' % str(e))
2015-01-13 12:28:05 +00:00
link.send("An error has occured")
2014-12-09 10:00:19 +00:00
2015-01-13 12:28:05 +00:00
def AddBalance(link,cmd):
nick=link.user.nick
2015-01-10 13:53:22 +00:00
if GetParam(cmd,2):
anick = GetParam(cmd,1)
amount = GetParam(cmd,2)
else:
anick = nick
amount = GetParam(cmd,1)
if not amount:
2015-01-13 12:28:05 +00:00
link.send('usage: !addbalance [<nick>] <amount>')
2015-01-10 13:53:22 +00:00
return
try:
units = StringToUnits(amount)
2015-01-10 13:53:22 +00:00
except Exception,e:
2015-01-13 12:28:05 +00:00
log_error('AddBalance: error converting amount: %s' % str(e))
link.send('usage: !addbalance [<nick>] <amount>')
2015-01-10 13:53:22 +00:00
return
2015-01-13 12:28:05 +00:00
if anick.find(':') == -1:
network=link.network
log_info('No network found in %s, using %s from command originator' % (anick,network.name))
aidentity=Link(network,User(network,anick)).identity()
else:
aidentity=anick
account = GetAccount(aidentity)
2015-01-13 12:28:05 +00:00
log_info("AddBalance: Adding %s to %s's balance" % (AmountToString(units),aidentity))
2014-12-09 10:00:19 +00:00
try:
balance = redis_hincrby("balances",account,units)
2014-12-09 10:00:19 +00:00
except Exception, e:
log_error('AddBalance: exception: %s' % str(e))
2015-01-13 12:28:05 +00:00
link.send( "An error has occured")
2015-01-20 19:28:46 +00:00
return
2015-01-13 12:28:05 +00:00
link.send("%s's balance is now %s" % (aidentity,AmountToString(balance)))
2014-12-09 10:00:19 +00:00
2015-02-06 19:36:58 +00:00
def LinkAccount(link,cmd):
linked_identity=GetParam(cmd,1)
if linked_identity == None:
link.send('usage: !link_account [<network>:]<username>')
return
try:
linked_identity=IdentityFromString(link,linked_identity)
except Exception,e:
link.send('%s is invalid' % linked_identity)
return
2015-02-06 19:36:58 +00:00
ok,reason=LinkCore(link,linked_identity)
if not ok:
link.send('An error occured')
return
if reason=='same-identity':
link.send('An account is already implicitly linked to itself')
elif reason=='already' or reason=='ok':
link.send('%s now needs to link to %s too' % (linked_identity,link.identity()))
elif reason=='same-account':
link.send('%s and %s are already linked' % (link.identity(),linked_identity))
elif reason=='linked':
link.send('Accounts linked')
def LinkingAccounts(link,cmd):
link.send_private('If you have several accounts with %s, you can link them together' % config.tipbot_name)
link.send_private('This will merge those accounts\' balances, so you can use your balance')
link.send_private('from any of these accounts. Similarly, payments made to any of your accounts')
link.send_private('will be available to all accounts. In order to link accounts A and B,')
link.send_private('both need to link to the other account: A to B, and B to A')
link.send_private('When logged in as A, use the command: !link_account B')
link.send_private('When logged in as B, use the command: !link_account A')
link.send_private('When both are done, the accounts will be linked, and you will be able to use')
link.send_private('any account interchangeably. If the accounts are on different networks')
link.send_private('(eg, IRC and Reddit), the user names need to be prefixed with the network\'s')
link.send_private('name (freenode: for Freenode IRC, reddit: for Reddit), like this:')
link.send_private(' !link_account reddit:myredditname (do that on Freenode)')
link.send_private(' !link_account freenode:myircnick (do that on Reddit)')
2015-02-06 19:36:58 +00:00
link.send_private('Linking accounts is irreversible, so make sure you only link to accounts')
link.send_private('under your control')
2015-01-13 12:28:05 +00:00
def ScanWho(link,cmd):
link.network.update_users_list(link.group.name if link.group else None)
2015-01-13 12:28:05 +00:00
def GetHeight(link,cmd):
log_info('GetHeight: %s wants to know block height' % str(link))
2014-12-09 10:00:19 +00:00
try:
2014-12-28 10:27:31 +00:00
j = SendDaemonHTMLCommand("getheight")
2014-12-09 10:00:19 +00:00
except Exception,e:
log_error('GetHeight: error: %s' % str(e))
2015-01-13 12:28:05 +00:00
link.send("An error has occured")
2014-12-09 10:00:19 +00:00
return
log_log('GetHeight: Got reply: %s' % str(j))
2014-12-09 10:00:19 +00:00
if not "height" in j:
log_error('GetHeight: Cannot see height in here')
2015-01-13 12:28:05 +00:00
link.send("Height not found")
2014-12-09 10:00:19 +00:00
return
height=j["height"]
log_info('GetHeight: height is %s' % str(height))
2015-01-13 12:28:05 +00:00
link.send("Height: %s" % str(height))
2014-12-09 10:00:19 +00:00
2015-01-13 12:28:05 +00:00
def GetTipbotBalance(link,cmd):
log_info('%s wants to know the tipbot balance' % str(link))
2014-12-09 10:00:19 +00:00
try:
balance, unlocked_balance = RetrieveTipbotBalance()
2014-12-09 10:00:19 +00:00
except Exception,e:
2015-01-13 12:28:05 +00:00
link.send("An error has occured")
2014-12-09 10:00:19 +00:00
return
pending = long(balance)-long(unlocked_balance)
if pending == 0:
log_info("GetTipbotBalance: Tipbot balance: %s" % AmountToString(balance))
2015-01-13 12:28:05 +00:00
link.send("Tipbot balance: %s" % AmountToString(balance))
2014-12-09 10:00:19 +00:00
else:
log_info("GetTipbotBalance: Tipbot balance: %s (%s pending)" % (AmountToString(unlocked_balance), AmountToString(pending)))
2015-01-13 12:28:05 +00:00
link.send("Tipbot balance: %s (%s pending)" % (AmountToString(unlocked_balance), AmountToString(pending)))
2014-12-09 10:00:19 +00:00
2015-01-13 12:28:05 +00:00
def DumpUsers(link,cmd):
for network in networks:
network.dump_users()
2015-01-13 12:28:05 +00:00
def Help(link,cmd):
module = GetParam(cmd,1)
if module:
2015-01-13 12:28:05 +00:00
RunModuleHelpFunction(module,link)
return
2015-01-20 17:18:15 +00:00
link.send_private("See available commands with !commands or !commands <modulename>")
link.send_private("Available modules: %s" % ", ".join(GetModuleNameList(IsAdmin(link))))
link.send_private("Get help on a particular module with !help <modulename>")
if coinspecs.web_wallet_url:
2015-01-20 17:18:15 +00:00
link.send_private("No %s address ? You can use %s" % (coinspecs.name, coinspecs.web_wallet_url))
2015-01-13 12:28:05 +00:00
def Info(link,cmd):
2015-01-20 17:18:15 +00:00
link.send_private("Info for %s:" % config.tipbot_name)
2019-04-05 15:15:36 +00:00
link.send_private("Copyright 2014,2015 moneromooo - https://github.com/tippero/tippero")
2015-01-20 17:18:15 +00:00
link.send_private("Type !help, or !commands for a list of commands")
link.send_private("NO WARRANTY, YOU MAY LOSE YOUR COINS")
link.send_private("By sending your %s to %s, you are giving up their control" % (coinspecs.name, config.tipbot_name))
link.send_private("to whoever runs the tipbot. Any tip you make/receive using %s" % config.tipbot_name)
link.send_private("is obviously not anonymous. %s's wallet may end up corrupt, or be" % config.tipbot_name)
link.send_private("stolen, the server compromised, etc. While I hope this won't be the case,")
link.send_private("I will not offer any warranty whatsoever for the use of %s or the" % config.tipbot_name)
link.send_private("return of any %s. Use at your own risk." % coinspecs.name)
link.send_private("That being said, I hope you enjoy using it :)")
2014-12-09 10:00:19 +00:00
def InitScanBlockHeight():
try:
scan_block_height = redis_get("scan_block_height")
scan_block_height = long(scan_block_height)
except Exception,e:
try:
redis_set("scan_block_height",0)
except Exception,e:
log_error('Failed to initialize scan_block_height: %s' % str(e))
2015-01-13 12:28:05 +00:00
def ShowActivity(link,cmd):
anick=GetParam(cmd,1)
achan=GetParam(cmd,2)
if not anick or not achan:
link.send('usage: !show_activity <nick> <chan>')
return
if anick.find(':') == -1:
network = link.network
2014-12-26 16:57:03 +00:00
else:
2015-01-13 12:28:05 +00:00
parts=anick.split(':')
network_name=parts[0]
anick=parts[1]
network = GetNetworkByName(network_name)
if network:
last_activity = network.get_last_active_time(anick,achan)
if last_activity:
link.send("%s was active in %s %f seconds ago" % (anick,achan,now-last_activity))
else:
link.send("%s was never active in %s" % (anick,achan))
else:
link.send("%s is not a valid network" % network)
2014-12-26 16:57:03 +00:00
2015-01-13 12:28:05 +00:00
def SendToLink(link,msg):
link.send(msg)
2015-01-13 12:28:05 +00:00
def IsRegistered(link,cmd):
RunRegisteredCommand(link,SendToLink,"You are registered",SendToLink,"You are not registered")
2015-02-02 22:14:39 +00:00
def Load(link,cmd):
modulename=GetParam(cmd,1)
if not modulename:
link.send("Usage: load <modulename>")
return
if modulename=="builtin":
link.send("Cannot load builtin module")
return
if modulename in sys.modules:
link.send("There is already a %s module" % modulename)
return
log_info('Loading %s module' % modulename)
try:
__import__(modulename)
link.send('%s loaded' % modulename)
except Exception,e:
log_error('Failed to load module "%s": %s' % (modulename, str(e)))
link.send('An error occured')
def Unload(link,cmd):
modulename=GetParam(cmd,1)
if not modulename:
link.send("Usage: unload <modulename>")
return
if modulename=="builtin":
link.send("Cannot unload builtin module")
return
if not modulename in sys.modules:
link.send("%s is not a dynamic module" % modulename)
return
log_info('Unloading %s module' % modulename)
UnregisterModule(modulename)
try:
del sys.modules[modulename]
link.send('%s unloaded' % modulename)
except Exception,e:
log_error('Failed to unload module "%s": %s' % (modulename, str(e)))
link.send('An error occured')
2015-01-13 12:28:05 +00:00
def Reload(link,cmd):
2015-01-01 10:06:09 +00:00
modulename=GetParam(cmd,1)
if not modulename:
2015-01-13 12:28:05 +00:00
link.send("Usage: reload <modulename>")
2015-01-01 10:06:09 +00:00
return
if modulename=="builtin":
2015-01-13 12:28:05 +00:00
link.send("Cannot reload builtin module")
return
if not modulename in sys.modules:
link.send("%s is not a dynamic module" % modulename)
2015-01-01 10:06:09 +00:00
return
log_info('Unloading %s module' % modulename)
UnregisterModule(modulename)
2015-01-01 10:06:09 +00:00
log_info('Reloading %s module' % modulename)
try:
reload(sys.modules[modulename])
2015-01-13 12:28:05 +00:00
link.send('%s reloaded' % modulename)
2015-01-01 10:06:09 +00:00
except Exception,e:
log_error('Failed to load module "%s": %s' % (modulename, str(e)))
2015-01-13 12:28:05 +00:00
link.send('An error occured')
2015-01-01 10:06:09 +00:00
2015-01-13 12:28:05 +00:00
def Disable(link,cmd):
2015-01-17 13:19:50 +00:00
global disabled
disabled = True
2015-01-13 12:28:05 +00:00
link.send('%s disabled, will require restart' % config.tipbot_name)
2015-01-17 13:19:50 +00:00
def OnIdle():
2015-01-17 13:19:50 +00:00
if disabled:
return
RunIdleFunctions()
2015-01-13 12:28:05 +00:00
def Quit(link,cmd):
global networks
msg = ""
for w in cmd[1:]:
msg = msg + " " + w
for network in networks:
log_info('Quitting %s network' % network.name)
network.quit()
networks = []
def OnIdentified(link, identified):
2015-01-17 13:19:50 +00:00
if disabled:
2015-01-13 12:28:05 +00:00
log_info('Ignoring identified notification for %s while disabled' % str(link.identity()))
2015-01-17 13:19:50 +00:00
return
2015-01-13 12:28:05 +00:00
RunNextCommand(link, identified)
def OnEventProxy(event,*args,**kwargs):
log_info('Got event %s, args %s' % (event, str(kwargs)))
if disabled:
log_info('Ignoring event while disabled')
return
link=kwargs['link'] if 'link' in kwargs else None
if link:
link.batch_send_start()
try:
OnEvent(event,*args,**kwargs)
except Exception,e:
log_error('Exception handling event %s: %s' % (str(event),str(e)))
if link:
link.batch_send_done()
def RegisterCommands():
RegisterCommand({'module': 'builtin', 'name': 'help', 'parms': '[module]', 'function': Help, 'help': "Displays help about %s" % config.tipbot_name})
RegisterCommand({'module': 'builtin', 'name': 'commands', 'parms': '[module]', 'function': Commands, 'help': "Displays list of commands"})
RegisterCommand({'module': 'builtin', 'name': 'isregistered', 'function': IsRegistered, 'help': "show whether you are currently registered with freenode"})
RegisterCommand({'module': 'builtin', 'name': 'balance', 'function': GetBalance, 'registered': True, 'help': "show your current balance"})
2015-02-06 19:36:58 +00:00
RegisterCommand({'module': 'builtin', 'name': 'link_account', 'function': LinkAccount, 'registered': True, 'help': "Link your account to another - see !linking_accounts"})
RegisterCommand({'module': 'builtin', 'name': 'linking_accounts', 'function': LinkingAccounts, 'registered': True, 'help': "Help about linking accounts"})
RegisterCommand({'module': 'builtin', 'name': 'info', 'function': Info, 'help': "infornmation about %s" % config.tipbot_name})
RegisterCommand({'module': 'builtin', 'name': 'height', 'function': GetHeight, 'admin': True, 'help': "Get current blockchain height"})
RegisterCommand({'module': 'builtin', 'name': 'tipbot_balance', 'function': GetTipbotBalance, 'admin': True, 'help': "Get current blockchain height"})
2015-01-10 13:53:22 +00:00
RegisterCommand({'module': 'builtin', 'name': 'addbalance', 'parms': '<nick> <amount>', 'function': AddBalance, 'admin': True, 'help': "Add balance to your account"})
RegisterCommand({'module': 'builtin', 'name': 'scanwho', 'function': ScanWho, 'admin': True, 'help': "Refresh users list in a channel"})
RegisterCommand({'module': 'builtin', 'name': 'dump_users', 'function': DumpUsers, 'admin': True, 'help': "Dump users table to log"})
RegisterCommand({'module': 'builtin', 'name': 'show_activity', 'function': ShowActivity, 'admin': True, 'help': "Show time since a user was last active"})
2015-02-02 22:14:39 +00:00
RegisterCommand({'module': 'builtin', 'name': 'load', 'function': Load, 'admin': True, 'help': "Load a module"})
RegisterCommand({'module': 'builtin', 'name': 'unload', 'function': Unload, 'admin': True, 'help': "Unload a module"})
2015-01-01 10:06:09 +00:00
RegisterCommand({'module': 'builtin', 'name': 'reload', 'function': Reload, 'admin': True, 'help': "Reload a module"})
2015-01-17 13:19:50 +00:00
RegisterCommand({'module': 'builtin', 'name': 'disable', 'function': Disable, 'admin': True, 'help': "Disable %s"%config.tipbot_name})
2015-01-13 12:28:05 +00:00
RegisterCommand({'module': 'builtin', 'name': 'quit', 'function': Quit, 'admin': True, 'help': "Quit"})
2015-01-13 12:28:05 +00:00
def OnCommandProxy(link,cmd):
2015-01-17 13:19:50 +00:00
if disabled:
2015-01-13 12:28:05 +00:00
log_info('Ignoring command from %s while disabled: %s' % (str(link.identity()),str(cmd)))
2015-01-17 13:19:50 +00:00
return
2015-01-13 12:28:05 +00:00
link.batch_send_start()
try:
OnCommand(link,cmd,RunAdminCommand,RunRegisteredCommand)
except Exception,e:
log_error('Exception running command %s: %s' % (str(cmd),str(e)))
link.batch_send_done()
def lower_nick(s,net):
news = ""
start_idx = s.find(net)
if start_idx >= 0:
start_idx += len(net)
news = s[:start_idx]
while start_idx < len(s) and s[start_idx] != ':':
news = news + s[start_idx].lower()
start_idx += 1
news = news + s[start_idx:]
else:
news = s
return news
def MigrateRedis():
pass
2015-01-13 12:28:05 +00:00
RegisterCommands()
redisdb = connect_to_redis(config.redis_host,config.redis_port)
MigrateRedis()
InitScanBlockHeight()
2014-12-09 10:00:19 +00:00
2015-01-13 12:28:05 +00:00
# TODO: make this be created when the module is loaded
for network_setup in start_networks:
network_type=network_setup['type']
if 'name' in network_setup:
network_name=network_setup['name']
log_info('Starting "%s" %s network' % (network_name, network_type))
else:
network_name=network_type
log_info('Starting %s network' % network_type)
name=network_name or network_type
try:
network=registered_networks[network_type](name=name)
network.set_callbacks(OnCommandProxy,OnIdentified,OnEventProxy)
if network.connect():
AddNetwork(network)
except Exception,e:
log_error('Error starting %s network: %s' % (name,str(e)))
exit(1)
2015-01-13 12:28:05 +00:00
while len(networks)>0:
for network in networks:
network.update()
OnIdle()
2015-01-10 13:53:42 +00:00
log_info('saving redis')
redisdb.bgsave()
2015-01-10 13:53:42 +00:00
log_info('exiting')