def slackusers(bot, event, *args):
slack_sink = bot.get_config_option('slack')
if isinstance(slack_sink, list):
for sinkConfig in slack_sink:
slackkey = sinkConfig["key"]
channel = sinkConfig["channel"]
convlist = sinkConfig["synced_conversations"]
if event.conv_id in convlist:
try:
client = SlackClient(slackkey, verify=True)
except TypeError:
client = SlackClient(slackkey)
chan_id = client.channel_name_to_id(channel)
slack_api_params = {'channel': chan_id}
info = client._make_request('channels.info', slack_api_params)
msg = "Slack channel {}: {}".format(info['channel']['name'],
info['channel']['topic']['value'])
users = {}
for uid in info['channel']['members']:
slack_api_params = {'user': uid}
user = client._make_request('users.info', slack_api_params)
if user["ok"] and user['user']:
username = user['user']['name']
realname = user['user'].get('real_name', "No real name")
users[username] = realname
msg += "\n{} members:".format(len(users))
for username, realname in sorted(users.items()):
msg += "\n {}: {}".format(username, realname)
yield from bot.coro_send_message(event.conv, msg)
class SlackResponder(object):
# Messages we understand and parse
hooks = {
"add": "^(\.add) \<\@([\w]+)\> ?(admin|superuser)?",
"del": "^(\.del) \<\@([\w]+)\>",
"hide": "^(\.hide) \<\@([\w]+)\>",
"show": "^(\.show) \<\@([\w]+)\>",
"twitter": "^(\.twitter) ([\w]+)$",
"email": "^(\.email) \<mailto\:([\w+\.-@]+)|[\w+\.-@]+\>$",
"image": "^(\.image) \<(.*)\>$",
"name": "^(\.name) (.*)$",
"balance": "^(\.balance) ([A-Za-z0-9]{25,36})$",
"rate": "^(\.rate) ([\w]+) ?(usd|USD|eur|EUR|cny|CNY|cad|CAD|rub|RUB|btc|BTC)?",
"status": "^(\.status) (.*)$",
"undo": "^\.undo",
"list": "^\.list",
"regen" : "^\.regen",
"ping": "^\.ping",
"whoami": "^\.whoami",
"help": "^\.help",
"lazy": "^\.lazy"
}
# User ability level
userLevel = {
"none": 0,
"user": 1,
"superuser": 2,
"owner": 3
}
# Url regex
urlFixer = "<(https?:\/\/[^>]+)>"
def __init__(self, connect=True):
# Lets get set up
botPass = {}
if botData.token_id:
self.client = SlackClient(botData.token_id)
if connect is True:
req = self.client._make_request('rtm.start', {})
socket_url = req['url']
self.ws = websocket.WebSocket()
self.ws.connect(socket_url)
else:
self.ws = websocket.WebSocket()
# Compile regex triggers and url regex
self.triggers = {}
for key, val in self.hooks.iteritems():
self.triggers[key] = re.compile(val)
self.urlChecker = re.compile(self.urlFixer)
# For Python 2.x
self.html_parser = HTMLParser.HTMLParser()
# For Python 3.x
# self.html_parser = html.parser.HTMLParser()
def SetupJson(self):
logger = logging.getLogger("SlackBot")
if os.path.isfile(botData.status_file):
# It exists, lets read it in.
status_in = open(botData.status_file, "r")
data = status_in.read()
status_in.close()
self.botJson = simplejson.loads(data)
else:
# Starting over
self.botJson = {
"users": {},
"updates": {},
"undo": {},
"admins": [],
"superusers": [],
"hidden": []
}
if botData.owner_id and botData.owner_id not in self.botJson['superusers']:
self.botJson['superusers'].append(botData.owner_id)
if botData.owner_id and botData.owner_id not in self.botJson['users']:
self.botJson['users'][botData.owner_id] = {}
return
def SaveJson(self):
with open(botData.status_file, 'w') as status_out:
json.dump(self.botJson, status_out)
status_out.close()
return
def Parse(self, postData):
''' Parses a (should be) matching request of the bot
: param postData: dict from the post sent to the bot from Slack
: return: String containing response for the user:
'''
logger = logging.getLogger("SlackBot")
logger.debug("User ID: " + postData['user_id'])
# Verify Token
if postData['token'] != botData.hook_token:
logger.debug("Token from Slack does not match ours, ignoring.")
return
logger.debug("Looking through hooks for a match...")
logger.debug("Got: " + str(postData['text']))
for key, val in self.triggers.iteritems():
test = self.triggers[key].match(postData['text'])
if test:
logger.debug("Got a match with: " + self.hooks[key])
return self._Process(postData, re.findall(self.triggers[key], postData['text']))
# Still here? Very unlikely
return "Huh?"
def _Process(self, postData, matchText):
logger = logging.getLogger("SlackBot")
self.SetupJson() # Needed for comparison checks
# logger.debug(json.dumps(postData, indent=4))
try:
del postData['token'], postData['trigger_word'], postData['team_id']
del postData['channel_name'], postData['user_name']
except:
pass
if postData['user_id'] == botData.owner_id:
postData['uLevel'] = self.userLevel['owner'] # 3
elif postData['user_id'] in self.botJson['superusers']:
postData['uLevel'] = self.userLevel['superuser'] # 2
elif postData['user_id'] in self.botJson['admins']:
postData['uLevel'] = self.userLevel['user'] # 1
else:
postData['uLevel'] = self.userLevel['none'] # 0
request = matchText[0]
logger.debug("Request: " + str(request))
if not isinstance(request, basestring):
if len(request) >= 2:
trigger = request[0]
argument = request[1]
logger.debug("Trigger: " + trigger)
logger.debug("Argument: " + argument)
# Third value for a user class (for .add)
if trigger == ".add":
try:
userClass = request[2]
except:
userClass = "admin"
elif trigger == ".del":
try:
if k[2].lower() in ("yes", "true", "t", "1"):
hideUser = True
else:
hideUser = False
except:
hideUser = False
elif trigger == ".rate":
try:
rateType = request[2]
except:
rateType = "usd"
forbidden = ['.status','.add','.del','.show','.hide','.name',
'.image','.email','.twitter','.undo','.regen']
if trigger in forbidden and postData['uLevel'] < 1:
return "<@" + postData['user_id'] + ">: You are not an authorised user."
# Status update?
if trigger == ".status":
return self.PostStatusUpdate(postData, argument)
# Is the owner trying to be added or deleted?
elif trigger == ".add" or trigger == ".del":
if str(argument) == str(botData.owner_id):
return "<@" + postData['user_id'] + ">: Cannot perform actions on bot owner."
if trigger == ".add":
return self.PromoteUser(postData, argument, userClass)
elif trigger == ".del": # Removes from either list
return self.DemoteUser(postData, argument, hideUser)
# Show/hide condition?
elif trigger == ".show" or trigger == ".hide":
if trigger == ".show":
return self.ShowUserPosts(postData, argument)
elif trigger == ".hide":
return self.HideUserPosts(postData, argument)
# User details?
elif trigger == ".name" or trigger == ".image" or trigger == ".email":
if trigger == ".name":
return self.UpdateUserInfo(postData, "name", argument)
elif trigger == ".email":
return self.UpdateUserInfo(postData, "email", argument)
elif trigger == ".image":
return self.UpdateUserInfo(postData, "image", argument)
elif trigger == ".balance":
return "Balance for address " + argument + ": " + str(self.GetBalance(argument)) + " SJCX"
elif trigger == ".twitter":
self.SetupJson()
self.botJson['users'][postData['user_id']]['twitter'] = argument
self.SaveJson()
return "<@" + postData['user_id'] + ">: Your twitter handle is now '" + argument + "'."
elif trigger == ".rate":
return self.GetExRate(argument, rateType)
else:
return "No response to give!"
elif request == ".list":
return self.AdminList(postData)
elif request == ".undo":
return self.UndoPost(postData)
elif request == ".regen":
return self.OutputTemplate(postData)
elif request == ".ping":
return "PONG!"
elif request == ".whoami":
return "Hello <@" + postData['user_id'] + ">, your user id is " + postData['user_id'] + "."
elif request == ".help":
return self.HelpResponse()
elif request == ".lazy":
return self.FindLazyUsers()
else:
return "No response to give!"
def HelpResponse(self):
return textwrap.dedent(
"""
Hello, I'm SlackBot. Standard commands you can use with me are:\n
.add (username) <superuser> - Authorise a user to post status updates. Include 'superuser' to
give them the power to add or remove other users from the authorised list.\n
.del (username) - Revokes status updates from a user.\n
.show (username) - Show posts from a user on the status page.\n
.hide (username) - Hide posts from a user on the status page.\n
.name (name) - Updates name shown for a user added to the bot.\n
.image (url) - Updates the image shown for a user added to the bot.\n
.email (address) - Updates name shown for a user added to the bot (not that this is shown normally).\n
.twitter (name) - Updates the twitter address for a user from the default.\n
.status (text) - Post a status update! Use whatever text you want, it will be used in the output.\n
.undo - Didn't mean to post that last status update? This will return it to what you said last.\n
.regen - Force regeneration of the status page from the template.\n
.whoami - Tells you your user_id, should you wish to change any 'settings' :)\n
.list - Lists bot users authorised to post status updates.\n
.rate (coin) (currency) - Fetches exchange rates for coins at CoinMarketCap, uses the top 100
coins they track, with USD, CAD, CNY, RUB and BTC as supported currencies.
\n
Enjoy!
"""
)
def PostStatusUpdate(self, user, text):
''' Creates a status update for a user, refreshes template.
@param user: json dict representing the user data
@param text: The status text the user wishes to post
@return: String to send back to the user
'''
self.SetupJson()
user['text'] = self.TextParser(text)
user['ts'] = user['timestamp']
del user['timestamp']
self.botJson['updates'][user['user_id']] = user
if user['user_id'] in self.botJson['undo']:
old = self.botJson['updates'][user['user_id']]
self.botJson['undo'][user['user_id']] = old # Copy before replace
self.botJson['updates'][user['user_id']] = user # Update this user with latest post
else:
self.botJson['undo'][user['user_id']] = user # Set them both to the same to start
self.botJson['updates'][user['user_id']] = user
self.SaveJson()
self.OutputTemplate(user)
return "<@" + user['user_id'] + ">: Status update accepted, template updated."
def TextParser(self, text):
''' Parses info from slack, e.g. urls '''
logger = logging.getLogger("SlackBot")
logger.debug("Looking for a URL match...'" + str(text) + "'")
# Single
for m in self.urlChecker.findall(text):
text = text.replace("<" + m + ">",
"<a href=\\\"" + m + "\\\">" +
self.html_parser.escape(m) + "</a>")
return text
def PromoteUser(self, user, subject, level):
''' Promotes a user to a higher level so they can post updates, or at
superuser level they can promote other users to update posting level.
@param user: json dict representing the user data
@param subject: The user to act on
@param level: int user level to promote to, 1=user, 2=superuser
@return: String to send back to the user.
'''
logger = logging.getLogger("SlackBot")
self.SetupJson()
logger.debug(json.dumps(user, indent=4))
response = ""
if level == "superuser":
if user['uLevel'] >= 3:
if subject in self.botJson['superusers']:
return "<@" + user['user_id'] + ">: Action not needed."
self.botJson['superusers'].append(subject)
self.SaveJson()
response += "<@" + user['user_id'] + ">: User <@" + subject + "> added to superusers.\n"
else:
return "<@" + user['user_id'] + ">: You are not authorised to add other superusers."
else:
if user['uLevel'] >= 2:
if subject in self.botJson['admins']:
return "<@" + user['user_id'] + ">: Action not needed."
self.botJson['admins'].append(subject)
self.SaveJson()
response += "<@" + user['user_id'] + ">: User <@" + subject + "> added to authorised users.\n"
else:
return "<@" + user['user_id'] + ">: You are not authorised to add other users."
newUser = {}
''' Is the rtm api token set up? If not, complain at them.'''
if not botData.token_id:
self.botJson['users'][subject] = {}
self.SaveJson()
response += "<@" + subject + ">: I cannot access Slack to get your user info so you will need to enter it manually.\n"
response += "I need your name, email and twitter details at minimum - I'll generate a gravatar address from your "
response + "email unless you specify it as below.\n"
response += "You can use the commands .name,.email and .twitter to update your details.\n"
response += "You can also use .image to force your image to a direct url if Gravatar does not work with your email.\n"
response += "Example: \".name Slack User\", \".email [email protected]\", \".image <url\", \".twitter tweeter\".\n"
return response
else:
req = self.client._make_request('users.info', {'user': subject})
logger.debug(json.dumps(req, indent=4))
newUser['name'] = req['user']['profile']['real_name']
newUser['image'] = req['user']['profile']['image_72']
newUser['email'] = req['user']['profile']['email']
newUser['twitter'] = "storjproject"
self.botJson['users'][user['user_id']] = newUser
self.SaveJson()
response += "<@" + subject + ">: I have set up your profile with what I can gather immediately from Slack.\n"
response += "If you want, you can use the commands .name,.email and .twitter to update your details.\n"
response += "You can also use .image to force your image to a direct url if Gravatar does not work with your email.\n"
response += "Example: \".name Slack User\", \".email [email protected]\", \".twitter tweeter\".\n"
return response
def DemoteUser(self, user, subject, hide):
''' Demotes a user so they won't be allowed to post updates. Optional hide posts.
Doesn't matter what level they are, they're gone.
@param user: json dict representing the user data
@param subject: The user to act upon
@param hide: Bool to hide posts by the user at the same time
@return: String to send back to the user
'''
logger = logging.getLogger("SlackBot")
self.SetupJson()
if subject in self.botJson['admins']:
logger.debug(self.botJson['admins'].index(subject))
userIndex = self.botJson['admins'].index(subject)
del self.botJson['admins'][userIndex]
if subject in self.botJson['updates']:
del self.botJson['updates'][subject]
self.SaveJson()
self.OutputTemplate(user)
return "<@" + user['user_id'] + ">: User <@" + subject + "> removed."
elif subject in self.botJson['superusers']:
logger.debug(self.botJson['superusers'].index(subject))
userIndex = self.botJson['superusers'].index(subject)
del self.botJson['superusers'][userIndex]
if subject in self.botJson['updates']:
self.botJson['updates'].remove(subject)
self.SaveJson()
self.OutputTemplate(user)
return "<@" + user['user_id'] + ">: User <@" + subject + "> removed."
else:
return "<@" + user['user_id'] + ">: Action not needed."
def HideUserPosts(self, user, subject):
''' Hide posts by a user, refreshes template without that users posts.
@param user: json dict representing the user data
@param subject: The user to act upon
@return: String to send back to the user
'''
self.SetupJson()
if user['uLevel'] >= 1:
if subject in self.botJson['hidden']:
return "<@" + user['user_id'] + ">: Action not needed."
self.botJson['hidden'].append(subject)
self.SaveJson()
self.OutputTemplate(user)
return "<@" + user['user_id'] + ">: Posts by <@" + subject + "> are now hidden.\nTemplate refreshed."
def ShowUserPosts(self, user, subject):
''' Show posts by a user, refreshes template with that users posts.
@param user: json dict representing the user data
@param subject: The user to act upon
@return: String to send back to the user
'''
self.SetupJson()
if user['uLevel'] >= 1:
if subject not in self.botJson['hidden']:
return "<@" + user['user_id'] + ">: Action not needed."
self.botJson['hidden'].remove(subject)
self.SaveJson()
self.OutputTemplate(user)
return "<@" + user['user_id'] + ">: Updates by <@" + subject + "> are now seen.\nTemplate refreshed."
def UpdateUserInfo(self, user, userValue, text):
''' Update user information so status updates work properly.
@param user: json dict representing the user data
@param userValue: The user information to update
@param text: The new value - a name, email address or image url.
@return: String to send back to the user
'''
self.SetupJson()
text = text.replace("'", "").replace("\\", "") # Bit of anti-xss
if user['user_id'] not in self.botJson['users']:
self.botJson['users'][user['user_id']] = {}
if userValue == "name":
self.botJson['users'][user['user_id']]['name'] = text
self.SaveJson()
return "<@" + user['user_id'] + ">: Your name has been updated.\nUse '.regen' to refresh the template."
elif userValue == "email":
if validate_email(text) == False:
return "<@" + user['user_id'] + ">: Invalid email address."
gravatar_url = "http://www.gravatar.com/avatar/" + hashlib.md5(text.lower()).hexdigest() + "?"
gravatar_url += urllib.urlencode({'d':"http://storj.sdo-srv.com/storjlogo.jpg", 's':"72"})
self.botJson['users'][user['user_id']]['email'] = text
self.botJson['users'][user['user_id']]['image'] = gravatar_url
self.SaveJson()
response = "<@" + user['user_id'] + ">: Your email address has been updated.\nI also updated the image url "
response += "with gravatar based on that email. If you would prefer to override that, use \".image <url>\" instead.\n"
response += "Use \".regen\" to refresh the template."
return response
elif userValue == "image":
self.botJson['users'][user['user_id']]['image'] = text
self.SaveJson()
return "<@" + user['user_id'] + ">: Your image url has been updated.\nUse '.regen' to refresh the template."
def UndoPost(self, user):
''' Undo a post a user has made.
@param user: json dict representing the user data
@return: String to send back to the user
'''
self.SetupJson()
self.botJson['updates'][user['user_id']] = self.botJson['undo'][user['user_id']]
self.SaveJson()
self.OutputTemplate(user['user_id'])
response = "<@" + user['user_id'] + ">: I have undone your last update and refreshed the template."
return response
def AdminList(self, user):
admins = []
superusers = []
self.SetupJson()
for k in self.botJson['admins']:
try:
admins.append(self.botJson['users'][k]['name'])
except:
pass
for k in self.botJson['superusers']:
try:
superusers.append(self.botJson['users'][k]['name'])
except:
pass
adminList = ", ".join(admins)
superList = ", ".join(superusers)
return "Approved posters: " + adminList + "\n Administrators: " + superList
def FindLazyUsers(self):
logger = logging.getLogger("SlackBot")
self.SetupJson()
text = ""
got_any = False
lazyUsers = {
'name': [],
'image': [],
'email': [],
'twitter': []
}
for key, val in self.botJson['users'].iteritems():
if 'name' not in self.botJson['users'][key]:
lazyUsers['name'].append(key)
logger.debug("No name for " + str(key))
if 'image' not in self.botJson['users'][key]:
lazyUsers['image'].append(key)
logger.debug("No image for " + str(key))
if 'email' not in self.botJson['users'][key]:
lazyUsers['email'].append(key)
logger.debug("No email for " + str(key))
if 'twitter' not in self.botJson['users'][key]:
lazyUsers['twitter'].append(key)
logger.debug("No name for " + str(key))
for no_info in ['name', 'image', 'email', 'twitter']:
if len(lazyUsers[no_info]) > 0:
lazy = []
text += "Users without " + no_info + " set: "
for user_id in lazyUsers[no_info]:
lazy.append("<@" + str(user_id) + ">")
text += ", ".join(lazy)
text += "\n"
got_any = True
if got_any is True:
return "Aha!\n" + text
else:
return "All users in my system have complete profiles!"
def GetBalance(self, address):
''' Fetch user sjcx balance
@param address: sjcx address
@return: balance string
'''
test = requests.get("http://api.blockscan.com/api2?module=address&action=balance&asset=SJCX&btc_address=" + address).json()
if test['status'] == "success":
return test['data'][0]['balance']
def GetExRate(self, currency, output):
if not output:
output = "usd"
logger = logging.getLogger("SlackBot")
url = "http://coinmarketcap-nexuist.rhcloud.com/api/" + currency.lower() + "/price"
logger.debug("url: " + url)
logger.debug("Currency: " + output)
test = requests.get(url).json()
if 'error' in test:
return "Error: " + test['error']
if 'e' in test[output]:
test[output] = "%.10f" % float(test[output])
return currency.upper() + "/" + output.upper() + ": " + test[output.lower()]
def OutputTemplate(self, user):
logger = logging.getLogger("SlackBot")
logger.debug(user['user_id'] + " asked for a template refresh")
self.SetupJson()
# Two stages, the first is to order the user id by timestamp, then pull in order
findLatest = {}
findPosts = {}
problems = False
twUrl = "http://twitter.com/"
for key, val in self.botJson['updates'].iteritems():
findPosts[key] = self.botJson['updates'][key]['ts']
findLatest = sorted(findPosts.items(), key=itemgetter(1), reverse=True)
tdata = []
for key, val in findLatest:
user_id = self.botJson['updates'][key]['user_id']
# Is this a hidden post?
if user_id in self.botJson['hidden']:
continue
text = str(self.botJson['updates'][key]['text'].encode("utf-8"))
text = text.replace("\"", "\\\"")
logger.debug("Text to output: " + text)
ts = self.botJson['updates'][key]['ts']
''' Reasons not to continue. We will mark a problem and skip. '''
if 'name' not in self.botJson['users'][user_id]:
problems = True
continue
if 'image' not in self.botJson['users'][user_id]:
problems = True
continue
if 'twitter' not in self.botJson['users'][user_id]:
problems = True
continue
if 'email' not in self.botJson['users'][user_id]:
problems = True
continue
logger.debug(self.botJson['users'][user_id]['name'])
tdata.append({
"text": cgi.escape(text), #self.html_parser.escape(text),
"name": self.botJson['users'][user_id]['name'],
"image": self.botJson['users'][user_id]['image'],
"twitter": twUrl + str(self.botJson['users'][user_id]['twitter']),
"email": self.botJson['users'][user_id]['email'],
"ts": datetime.datetime.fromtimestamp(float(ts)).strftime('%Y-%m-%d %H:%M:%S')
})
pt_loader = TemplateLoader(['html/'], auto_reload=True)
template = pt_loader.load('index.template')
with open(botData.output_file, 'w') as template_out:
template_out.write(template(users=tdata))
template_out.close()
if problems is True:
response = "<@" + user['user_id'] + ">: There was a problem outputting the template, but I did what I can.\n"
response += self.FindLazyUsers()
return response
else:
return "<@" + user['user_id'] + ">: I have refreshed the template."
class SlackResponder(object):
# Messages we understand and parse
hooks = {
"add": "^(\.add) \<\@([\w]+)\> ?(admin|superuser)?",
"del": "^(\.del) \<\@([\w]+)\>",
"hide": "^(\.hide) \<\@([\w]+)\>",
"show": "^(\.show) \<\@([\w]+)\>",
"twitter": "^(\.twitter) ([\w]+)$",
"email": "^(\.email) \<mailto\:([\w+\.-@]+)|[\w+\.-@]+\>$",
"image": "^(\.image) \<(.*)\>$",
"name": "^(\.name) (.*)$",
"balance": "^(\.balance) ([A-Za-z0-9]{25,36})$",
"rate":
"^(\.rate) ([\w]+) ?(usd|USD|eur|EUR|cny|CNY|cad|CAD|rub|RUB|btc|BTC)?",
"status": "^(\.status) (.*)$",
"undo": "^\.undo",
"list": "^\.list",
"regen": "^\.regen",
"ping": "^\.ping",
"whoami": "^\.whoami",
"help": "^\.help",
"lazy": "^\.lazy"
}
# User ability level
userLevel = {"none": 0, "user": 1, "superuser": 2, "owner": 3}
# Url regex
urlFixer = "<(https?:\/\/[^>]+)>"
def __init__(self, connect=True):
# Lets get set up
botPass = {}
if botData.token_id:
self.client = SlackClient(botData.token_id)
if connect is True:
req = self.client._make_request('rtm.start', {})
socket_url = req['url']
self.ws = websocket.WebSocket()
self.ws.connect(socket_url)
else:
self.ws = websocket.WebSocket()
# Compile regex triggers and url regex
self.triggers = {}
for key, val in self.hooks.iteritems():
self.triggers[key] = re.compile(val)
self.urlChecker = re.compile(self.urlFixer)
# For Python 2.x
self.html_parser = HTMLParser.HTMLParser()
# For Python 3.x
# self.html_parser = html.parser.HTMLParser()
def SetupJson(self):
logger = logging.getLogger("SlackBot")
if os.path.isfile(botData.status_file):
# It exists, lets read it in.
status_in = open(botData.status_file, "r")
data = status_in.read()
status_in.close()
self.botJson = simplejson.loads(data)
else:
# Starting over
self.botJson = {
"users": {},
"updates": {},
"undo": {},
"admins": [],
"superusers": [],
"hidden": []
}
if botData.owner_id and botData.owner_id not in self.botJson[
'superusers']:
self.botJson['superusers'].append(botData.owner_id)
if botData.owner_id and botData.owner_id not in self.botJson['users']:
self.botJson['users'][botData.owner_id] = {}
return
def SaveJson(self):
with open(botData.status_file, 'w') as status_out:
json.dump(self.botJson, status_out)
status_out.close()
return
def Parse(self, postData):
''' Parses a (should be) matching request of the bot
: param postData: dict from the post sent to the bot from Slack
: return: String containing response for the user:
'''
logger = logging.getLogger("SlackBot")
logger.debug("User ID: " + postData['user_id'])
# Verify Token
if postData['token'] != botData.hook_token:
logger.debug("Token from Slack does not match ours, ignoring.")
return
logger.debug("Looking through hooks for a match...")
logger.debug("Got: " + str(postData['text']))
for key, val in self.triggers.iteritems():
test = self.triggers[key].match(postData['text'])
if test:
logger.debug("Got a match with: " + self.hooks[key])
return self._Process(
postData, re.findall(self.triggers[key], postData['text']))
# Still here? Very unlikely
return "Huh?"
def _Process(self, postData, matchText):
logger = logging.getLogger("SlackBot")
self.SetupJson() # Needed for comparison checks
# logger.debug(json.dumps(postData, indent=4))
try:
del postData['token'], postData['trigger_word'], postData[
'team_id']
del postData['channel_name'], postData['user_name']
except:
pass
if postData['user_id'] == botData.owner_id:
postData['uLevel'] = self.userLevel['owner'] # 3
elif postData['user_id'] in self.botJson['superusers']:
postData['uLevel'] = self.userLevel['superuser'] # 2
elif postData['user_id'] in self.botJson['admins']:
postData['uLevel'] = self.userLevel['user'] # 1
else:
postData['uLevel'] = self.userLevel['none'] # 0
request = matchText[0]
logger.debug("Request: " + str(request))
if not isinstance(request, basestring):
if len(request) >= 2:
trigger = request[0]
argument = request[1]
logger.debug("Trigger: " + trigger)
logger.debug("Argument: " + argument)
# Third value for a user class (for .add)
if trigger == ".add":
try:
userClass = request[2]
except:
userClass = "admin"
elif trigger == ".del":
try:
if k[2].lower() in ("yes", "true", "t", "1"):
hideUser = True
else:
hideUser = False
except:
hideUser = False
elif trigger == ".rate":
try:
rateType = request[2]
except:
rateType = "usd"
forbidden = [
'.status', '.add', '.del', '.show', '.hide', '.name',
'.image', '.email', '.twitter', '.undo', '.regen'
]
if trigger in forbidden and postData['uLevel'] < 1:
return "<@" + postData[
'user_id'] + ">: You are not an authorised user."
# Status update?
if trigger == ".status":
return self.PostStatusUpdate(postData, argument)
# Is the owner trying to be added or deleted?
elif trigger == ".add" or trigger == ".del":
if str(argument) == str(botData.owner_id):
return "<@" + postData[
'user_id'] + ">: Cannot perform actions on bot owner."
if trigger == ".add":
return self.PromoteUser(postData, argument, userClass)
elif trigger == ".del": # Removes from either list
return self.DemoteUser(postData, argument, hideUser)
# Show/hide condition?
elif trigger == ".show" or trigger == ".hide":
if trigger == ".show":
return self.ShowUserPosts(postData, argument)
elif trigger == ".hide":
return self.HideUserPosts(postData, argument)
# User details?
elif trigger == ".name" or trigger == ".image" or trigger == ".email":
if trigger == ".name":
return self.UpdateUserInfo(postData, "name", argument)
elif trigger == ".email":
return self.UpdateUserInfo(postData, "email", argument)
elif trigger == ".image":
return self.UpdateUserInfo(postData, "image", argument)
elif trigger == ".balance":
return "Balance for address " + argument + ": " + str(
self.GetBalance(argument)) + " SJCX"
elif trigger == ".twitter":
self.SetupJson()
self.botJson['users'][
postData['user_id']]['twitter'] = argument
self.SaveJson()
return "<@" + postData[
'user_id'] + ">: Your twitter handle is now '" + argument + "'."
elif trigger == ".rate":
return self.GetExRate(argument, rateType)
else:
return "No response to give!"
elif request == ".list":
return self.AdminList(postData)
elif request == ".undo":
return self.UndoPost(postData)
elif request == ".regen":
return self.OutputTemplate(postData)
elif request == ".ping":
return "PONG!"
elif request == ".whoami":
return "Hello <@" + postData[
'user_id'] + ">, your user id is " + postData['user_id'] + "."
elif request == ".help":
return self.HelpResponse()
elif request == ".lazy":
return self.FindLazyUsers()
else:
return "No response to give!"
def HelpResponse(self):
return textwrap.dedent("""
Hello, I'm SlackBot. Standard commands you can use with me are:\n
.add (username) <superuser> - Authorise a user to post status updates. Include 'superuser' to
give them the power to add or remove other users from the authorised list.\n
.del (username) - Revokes status updates from a user.\n
.show (username) - Show posts from a user on the status page.\n
.hide (username) - Hide posts from a user on the status page.\n
.name (name) - Updates name shown for a user added to the bot.\n
.image (url) - Updates the image shown for a user added to the bot.\n
.email (address) - Updates name shown for a user added to the bot (not that this is shown normally).\n
.twitter (name) - Updates the twitter address for a user from the default.\n
.status (text) - Post a status update! Use whatever text you want, it will be used in the output.\n
.undo - Didn't mean to post that last status update? This will return it to what you said last.\n
.regen - Force regeneration of the status page from the template.\n
.whoami - Tells you your user_id, should you wish to change any 'settings' :)\n
.list - Lists bot users authorised to post status updates.\n
.rate (coin) (currency) - Fetches exchange rates for coins at CoinMarketCap, uses the top 100
coins they track, with USD, CAD, CNY, RUB and BTC as supported currencies.
\n
Enjoy!
""")
def PostStatusUpdate(self, user, text):
''' Creates a status update for a user, refreshes template.
@param user: json dict representing the user data
@param text: The status text the user wishes to post
@return: String to send back to the user
'''
self.SetupJson()
user['text'] = self.TextParser(text)
user['ts'] = user['timestamp']
del user['timestamp']
self.botJson['updates'][user['user_id']] = user
if user['user_id'] in self.botJson['undo']:
old = self.botJson['updates'][user['user_id']]
self.botJson['undo'][user['user_id']] = old # Copy before replace
self.botJson['updates'][
user['user_id']] = user # Update this user with latest post
else:
self.botJson['undo'][
user['user_id']] = user # Set them both to the same to start
self.botJson['updates'][user['user_id']] = user
self.SaveJson()
self.OutputTemplate(user)
return "<@" + user[
'user_id'] + ">: Status update accepted, template updated."
def TextParser(self, text):
''' Parses info from slack, e.g. urls '''
logger = logging.getLogger("SlackBot")
logger.debug("Looking for a URL match...'" + str(text) + "'")
# Single
for m in self.urlChecker.findall(text):
text = text.replace(
"<" + m + ">", "<a href=\\\"" + m + "\\\">" +
self.html_parser.escape(m) + "</a>")
return text
def PromoteUser(self, user, subject, level):
''' Promotes a user to a higher level so they can post updates, or at
superuser level they can promote other users to update posting level.
@param user: json dict representing the user data
@param subject: The user to act on
@param level: int user level to promote to, 1=user, 2=superuser
@return: String to send back to the user.
'''
logger = logging.getLogger("SlackBot")
self.SetupJson()
logger.debug(json.dumps(user, indent=4))
response = ""
if level == "superuser":
if user['uLevel'] >= 3:
if subject in self.botJson['superusers']:
return "<@" + user['user_id'] + ">: Action not needed."
self.botJson['superusers'].append(subject)
self.SaveJson()
response += "<@" + user[
'user_id'] + ">: User <@" + subject + "> added to superusers.\n"
else:
return "<@" + user[
'user_id'] + ">: You are not authorised to add other superusers."
else:
if user['uLevel'] >= 2:
if subject in self.botJson['admins']:
return "<@" + user['user_id'] + ">: Action not needed."
self.botJson['admins'].append(subject)
self.SaveJson()
response += "<@" + user[
'user_id'] + ">: User <@" + subject + "> added to authorised users.\n"
else:
return "<@" + user[
'user_id'] + ">: You are not authorised to add other users."
newUser = {}
''' Is the rtm api token set up? If not, complain at them.'''
if not botData.token_id:
self.botJson['users'][subject] = {}
self.SaveJson()
response += "<@" + subject + ">: I cannot access Slack to get your user info so you will need to enter it manually.\n"
response += "I need your name, email and twitter details at minimum - I'll generate a gravatar address from your "
response + "email unless you specify it as below.\n"
response += "You can use the commands .name,.email and .twitter to update your details.\n"
response += "You can also use .image to force your image to a direct url if Gravatar does not work with your email.\n"
response += "Example: \".name Slack User\", \".email [email protected]\", \".image <url\", \".twitter tweeter\".\n"
return response
else:
req = self.client._make_request('users.info', {'user': subject})
logger.debug(json.dumps(req, indent=4))
newUser['name'] = req['user']['profile']['real_name']
newUser['image'] = req['user']['profile']['image_72']
newUser['email'] = req['user']['profile']['email']
newUser['twitter'] = "storjproject"
self.botJson['users'][user['user_id']] = newUser
self.SaveJson()
response += "<@" + subject + ">: I have set up your profile with what I can gather immediately from Slack.\n"
response += "If you want, you can use the commands .name,.email and .twitter to update your details.\n"
response += "You can also use .image to force your image to a direct url if Gravatar does not work with your email.\n"
response += "Example: \".name Slack User\", \".email [email protected]\", \".twitter tweeter\".\n"
return response
def DemoteUser(self, user, subject, hide):
''' Demotes a user so they won't be allowed to post updates. Optional hide posts.
Doesn't matter what level they are, they're gone.
@param user: json dict representing the user data
@param subject: The user to act upon
@param hide: Bool to hide posts by the user at the same time
@return: String to send back to the user
'''
logger = logging.getLogger("SlackBot")
self.SetupJson()
if subject in self.botJson['admins']:
logger.debug(self.botJson['admins'].index(subject))
userIndex = self.botJson['admins'].index(subject)
del self.botJson['admins'][userIndex]
if subject in self.botJson['updates']:
del self.botJson['updates'][subject]
self.SaveJson()
self.OutputTemplate(user)
return "<@" + user[
'user_id'] + ">: User <@" + subject + "> removed."
elif subject in self.botJson['superusers']:
logger.debug(self.botJson['superusers'].index(subject))
userIndex = self.botJson['superusers'].index(subject)
del self.botJson['superusers'][userIndex]
if subject in self.botJson['updates']:
self.botJson['updates'].remove(subject)
self.SaveJson()
self.OutputTemplate(user)
return "<@" + user[
'user_id'] + ">: User <@" + subject + "> removed."
else:
return "<@" + user['user_id'] + ">: Action not needed."
def HideUserPosts(self, user, subject):
''' Hide posts by a user, refreshes template without that users posts.
@param user: json dict representing the user data
@param subject: The user to act upon
@return: String to send back to the user
'''
self.SetupJson()
if user['uLevel'] >= 1:
if subject in self.botJson['hidden']:
return "<@" + user['user_id'] + ">: Action not needed."
self.botJson['hidden'].append(subject)
self.SaveJson()
self.OutputTemplate(user)
return "<@" + user[
'user_id'] + ">: Posts by <@" + subject + "> are now hidden.\nTemplate refreshed."
def ShowUserPosts(self, user, subject):
''' Show posts by a user, refreshes template with that users posts.
@param user: json dict representing the user data
@param subject: The user to act upon
@return: String to send back to the user
'''
self.SetupJson()
if user['uLevel'] >= 1:
if subject not in self.botJson['hidden']:
return "<@" + user['user_id'] + ">: Action not needed."
self.botJson['hidden'].remove(subject)
self.SaveJson()
self.OutputTemplate(user)
return "<@" + user[
'user_id'] + ">: Updates by <@" + subject + "> are now seen.\nTemplate refreshed."
def UpdateUserInfo(self, user, userValue, text):
''' Update user information so status updates work properly.
@param user: json dict representing the user data
@param userValue: The user information to update
@param text: The new value - a name, email address or image url.
@return: String to send back to the user
'''
self.SetupJson()
text = text.replace("'", "").replace("\\", "") # Bit of anti-xss
if user['user_id'] not in self.botJson['users']:
self.botJson['users'][user['user_id']] = {}
if userValue == "name":
self.botJson['users'][user['user_id']]['name'] = text
self.SaveJson()
return "<@" + user[
'user_id'] + ">: Your name has been updated.\nUse '.regen' to refresh the template."
elif userValue == "email":
if validate_email(text) == False:
return "<@" + user['user_id'] + ">: Invalid email address."
gravatar_url = "http://www.gravatar.com/avatar/" + hashlib.md5(
text.lower()).hexdigest() + "?"
gravatar_url += urllib.urlencode({
'd': "http://storj.sdo-srv.com/storjlogo.jpg",
's': "72"
})
self.botJson['users'][user['user_id']]['email'] = text
self.botJson['users'][user['user_id']]['image'] = gravatar_url
self.SaveJson()
response = "<@" + user[
'user_id'] + ">: Your email address has been updated.\nI also updated the image url "
response += "with gravatar based on that email. If you would prefer to override that, use \".image <url>\" instead.\n"
response += "Use \".regen\" to refresh the template."
return response
elif userValue == "image":
self.botJson['users'][user['user_id']]['image'] = text
self.SaveJson()
return "<@" + user[
'user_id'] + ">: Your image url has been updated.\nUse '.regen' to refresh the template."
def UndoPost(self, user):
''' Undo a post a user has made.
@param user: json dict representing the user data
@return: String to send back to the user
'''
self.SetupJson()
self.botJson['updates'][user['user_id']] = self.botJson['undo'][
user['user_id']]
self.SaveJson()
self.OutputTemplate(user['user_id'])
response = "<@" + user[
'user_id'] + ">: I have undone your last update and refreshed the template."
return response
def AdminList(self, user):
admins = []
superusers = []
self.SetupJson()
for k in self.botJson['admins']:
try:
admins.append(self.botJson['users'][k]['name'])
except:
pass
for k in self.botJson['superusers']:
try:
superusers.append(self.botJson['users'][k]['name'])
except:
pass
adminList = ", ".join(admins)
superList = ", ".join(superusers)
return "Approved posters: " + adminList + "\n Administrators: " + superList
def FindLazyUsers(self):
logger = logging.getLogger("SlackBot")
self.SetupJson()
text = ""
got_any = False
lazyUsers = {'name': [], 'image': [], 'email': [], 'twitter': []}
for key, val in self.botJson['users'].iteritems():
if 'name' not in self.botJson['users'][key]:
lazyUsers['name'].append(key)
logger.debug("No name for " + str(key))
if 'image' not in self.botJson['users'][key]:
lazyUsers['image'].append(key)
logger.debug("No image for " + str(key))
if 'email' not in self.botJson['users'][key]:
lazyUsers['email'].append(key)
logger.debug("No email for " + str(key))
if 'twitter' not in self.botJson['users'][key]:
lazyUsers['twitter'].append(key)
logger.debug("No name for " + str(key))
for no_info in ['name', 'image', 'email', 'twitter']:
if len(lazyUsers[no_info]) > 0:
lazy = []
text += "Users without " + no_info + " set: "
for user_id in lazyUsers[no_info]:
lazy.append("<@" + str(user_id) + ">")
text += ", ".join(lazy)
text += "\n"
got_any = True
if got_any is True:
return "Aha!\n" + text
else:
return "All users in my system have complete profiles!"
def GetBalance(self, address):
''' Fetch user sjcx balance
@param address: sjcx address
@return: balance string
'''
test = requests.get(
"http://api.blockscan.com/api2?module=address&action=balance&asset=SJCX&btc_address="
+ address).json()
if test['status'] == "success":
return test['data'][0]['balance']
def GetExRate(self, currency, output):
if not output:
output = "usd"
logger = logging.getLogger("SlackBot")
url = "http://coinmarketcap-nexuist.rhcloud.com/api/" + currency.lower(
) + "/price"
logger.debug("url: " + url)
logger.debug("Currency: " + output)
test = requests.get(url).json()
if 'error' in test:
return "Error: " + test['error']
if 'e' in test[output]:
test[output] = "%.10f" % float(test[output])
return currency.upper() + "/" + output.upper() + ": " + test[
output.lower()]
def OutputTemplate(self, user):
logger = logging.getLogger("SlackBot")
logger.debug(user['user_id'] + " asked for a template refresh")
self.SetupJson()
# Two stages, the first is to order the user id by timestamp, then pull in order
findLatest = {}
findPosts = {}
problems = False
twUrl = "http://twitter.com/"
for key, val in self.botJson['updates'].iteritems():
findPosts[key] = self.botJson['updates'][key]['ts']
findLatest = sorted(findPosts.items(), key=itemgetter(1), reverse=True)
tdata = []
for key, val in findLatest:
user_id = self.botJson['updates'][key]['user_id']
# Is this a hidden post?
if user_id in self.botJson['hidden']:
continue
text = str(self.botJson['updates'][key]['text'].encode("utf-8"))
text = text.replace("\"", "\\\"")
logger.debug("Text to output: " + text)
ts = self.botJson['updates'][key]['ts']
''' Reasons not to continue. We will mark a problem and skip. '''
if 'name' not in self.botJson['users'][user_id]:
problems = True
continue
if 'image' not in self.botJson['users'][user_id]:
problems = True
continue
if 'twitter' not in self.botJson['users'][user_id]:
problems = True
continue
if 'email' not in self.botJson['users'][user_id]:
problems = True
continue
logger.debug(self.botJson['users'][user_id]['name'])
tdata.append({
"text":
cgi.escape(text), #self.html_parser.escape(text),
"name":
self.botJson['users'][user_id]['name'],
"image":
self.botJson['users'][user_id]['image'],
"twitter":
twUrl + str(self.botJson['users'][user_id]['twitter']),
"email":
self.botJson['users'][user_id]['email'],
"ts":
datetime.datetime.fromtimestamp(
float(ts)).strftime('%Y-%m-%d %H:%M:%S')
})
pt_loader = TemplateLoader(['html/'], auto_reload=True)
template = pt_loader.load('index.template')
with open(botData.output_file, 'w') as template_out:
template_out.write(template(users=tdata))
template_out.close()
if problems is True:
response = "<@" + user[
'user_id'] + ">: There was a problem outputting the template, but I did what I can.\n"
response += self.FindLazyUsers()
return response
else:
return "<@" + user['user_id'] + ">: I have refreshed the template."