Find file
Fetching contributors…
Cannot retrieve contributors at this time
executable file 599 lines (493 sloc) 23.9 KB
#!/usr/bin/env python2
# -*- coding: utf-8 -*-
# vim: set expandtab tabstop=4 shiftwidth=4 :
# - Bot written in Python that polls a RESTful message queue
# for search commands of the form "<botname>, get me <number of hits> hits
# for <search terms>", runs the searches on an instance of Searx, and e-mails
# them to the user (or a designated e-mail address).
# This is part of the Exocortex Halo project
# (
# By: The Doctor <drwho at virtadpt dot net>
# 0x807B17C1 / 7960 1CDC 85C9 0B63 8D9F DD89 3BD8 FF2B 807B 17C1
# License: GPLv3
# v3.0 - Rewrote the bot's command parser using PyParsing
# ( because I got tired of trying
# to maintain my own parser. This is much more robust.
# v2.0 - Rewrote much of this bot's functionality to use Searx
# ( rather than a user-supplied list
# of arbitrary search engines. This means that it's possible to
# customize the general kinds of searches you can potentially run based
# upon which Searx instances you use (by standing up more than one copy
# of this bot) and each Searx instance can have a different combination
# of sites to search turned on (such as a personal and a public YaCy
# instance) or different custom Searx engines installed.
# - Now tops out at fifty (50) search results.
# - Made some of the code a little less awkward.
# v1.1 - Added a "no search results found" handler.
# - Added an error handler for the case where contacting the message queue
# either times out or fails outright.
# - Added functionality which makes it possible to e-mail search results
# to arbitrary addresses.
# - Moved the list of links to filter out of the returned HTML into the
# configuration file and added some code to read them in and clean them
# up. It'll be much easier to maintain that way.
# - Got rid of the command line option where you can manually pass a
# search request to the bot for testing.
# v1.0 - Initial release.
# TO-DO:
# - Pull the argument vector and config file parsing stuff into their own
# functions to neaten up the core code.
# - Add an error handler to parse_search_requests() that returns something to
# the effect of "I don't know what you just said."
# - Break out the "handle HTTP result code" handler into a function.
# - Break up the main loop into a few functions to make it easier to read.
# Load modules.
from email.message import Message
from email.header import Header
from email.mime.text import MIMEText
import argparse
import ConfigParser
import json
import logging
import os
import pyparsing as pp
import re
import requests
import smtplib
import sys
import time
# Constants.
# Hash table that maps numbers-as-words ("ten") into numbers (10).
numbers = { "one":1, "two":2, "three":3, "four":4, "five":5, "six":6,
"seven":7, "eight":8, "nine":9, "ten":10, "eleven":11, "twelve":12,
"thirteen":13, "fourteen":14, "fifteen":15, "sixteen":16, "seventeen":17,
"eighteen":18, "nineteen":19, "twenty":20, "twenty-one":21, "twenty-two":22,
"twenty-two":22, "twenty-three":23, "twenty-four":24, "twenty-five":25,
"twenty-six":26, "twenty-seven":27, "twenty-eight":28, "twenty-nine":29,
"thirty":30 , "thirty-one":31, "thirty-two":32, "thirty-three":33,
"thirty-four":34, "thirty-five":35, "thirty-six":36, "thirty-seven":37,
"thirty-eight":38, "thirty-nine":39, "forty":50, "forty-one":41,
"forty-two":42, "forty-three":43, "forty-four":44, "forty-five":45,
"forty-six":46, "forty-seven":47, "forty-eight":48, "forty-nine":49,
"fifty":50 }
# When POSTing something to a service, the correct Content-Type value has to
# be set in the request.
custom_headers = {'Content-Type': 'application/json'}
# The precompiled regular expression for detecting e-mail addresses.
email_regex = "[^@]+@[^@]+\.[^@]+"
email_matcher = re.compile(email_regex)
# Global variables.
# Base URL to a Searx instance.
searx = ""
# Handle to a logging object.
logger = ""
# Path to and name of the configuration file.
config_file = ""
# Loglevel for the bot.
loglevel = logging.INFO
# The "http://system:port/" part of the message queue URL.
server = ""
# URL to the message queue to take marching orders from.
message_queue = ""
# Default e-mail address to send search results to.
default_email = ""
# The name the search bot will respond to. The idea is, this bot can be
# instantiated any number of times with different config files to use
# different search engines on different networks.
bot_name = ""
# How often to poll the message queues for orders.
polling_time = 60
# Search request sent from the user.
search_request = ""
# The e-mail address to send search results to (if applicable).
destination_email_address = ""
# SMTP server to transmit mail through. Defaults to localhost.
smtp_server = "localhost"
# The e-mail address that search results are sent from. There is no default
# for this so it has to be set in the config file.
origin_email_address = ""
# E-mail message containing search results.
message = ""
# Parser primitives.
# We define them up here because they'll be re-used over and over.
help_command = pp.CaselessLiteral("help")
get_command = pp.Optional(pp.CaselessLiteral("get"))
top_command = pp.CaselessLiteral("top")
results_count = (pp.Word(pp.nums) |
pp.Word(pp.alphas + "-")).setResultsName("count")
hitsfor_command = pp.CaselessLiteral("hits for")
search_term = pp.Word(pp.alphanums + "_,'-")
search_terms = pp.OneOrMore(search_term)
send_command = (pp.CaselessLiteral("send") | pp.CaselessLiteral("e-mail") |
pp.CaselessLiteral("email") | pp.CaselessLiteral("mail"))
me = pp.CaselessLiteral("me")
email = pp.Regex(r"(?P<user>[A-Za-z0-9._%+-]+)@(?P<hostname>[A-Za-z0-9.-]+)\.(?P<domain>[A-Za-z]{2,4})")
destination = pp.Optional(me) + pp.Optional(email).setResultsName("dest")
# Functions.
# set_loglevel(): Turn a string into a numerical value which Python's logging
# module can use because.
def set_loglevel(loglevel):
if loglevel == "critical":
return 50
if loglevel == "error":
return 40
if loglevel == "warning":
return 30
if loglevel == "info":
return 20
if loglevel == "debug":
return 10
if loglevel == "notset":
return 0
# This function takes a string of the form "foo bar baz" and turns it into a
# URL encoded string "foo+bar+baz", which is then returned to the calling
# method.
def make_search_term(search_terms):
return "+".join(term for term in search_terms)
# This function takes a number represented as a word ("twenty") or a number
# ("20") and turns it into a number (20) if it's the former. Returns a number
# no matter what.
def word_and_number(value):
# Numbers as actual digits are stored inside the parser as strings.
# This fucks with us. So, detect if they're digits, and if so turn
# them back into integers.
if value.isdigit():
return int(value)
# If the number of search results is a word ("twenty"), look it up in
# the global hash table numbers{} and use the corresponding numerical
# value as the number of search results to pick up.
if value in numbers.keys():
return numbers[value]
# Set a default number of search terms.
return 10
# This function matches whenever it encounters the word "help" all by itself
# in an input string. Returns "help" for the number of search terms, None for
# the search string, and None for the destination e-mail.
def parse_help(request):
parsed_command = help_command.parseString(request)
return ("help", None, None)
except pp.ParseException as x:"No match: {0}".format(str(x)))
return (None, None, None)
# This function matches on commands of the form "get top <foo> hits for <bar>."
# in an input string. Returns an integer number of search results (up to 40),
# a URL encoded search string, and the e-mail address "XMPP", meaning that the
# results will be sent to the user via the XMPP bridge.
def parse_get_request(request):
# Build the parser out of predeclared primitives.
command = get_command + top_command + results_count + hitsfor_command
command = command + pp.Group(search_terms).setResultsName("searchterms")
number_of_search_results = 0
# Try to parse the command.
parsed_command = command.parseString(request)
number_of_search_results = word_and_number(parsed_command["count"])
# Grab the search term.
search_term = make_search_term(parsed_command["searchterms"])
return (number_of_search_results, search_term, "XMPP")
except pp.ParseException as x:"No match: {0}".format(str(x)))
return (None, None, None)
# This function matches on commands of the form "send/e-mail/email/mail top
# <foo> hits for <search terms>". Returns an integer number of search results
# (up to 40), a URL encoded search string, and an e-mail address.
def parse_and_email_results(request):
# Build the parser out of predeclared primitives.
command = send_command + destination + top_command + results_count
command = command + hitsfor_command
command = command + pp.Group(search_terms).setResultsName("searchterms")
number_of_search_results = 0
destination_address = ""
parsed_command = command.parseString(request)
number_of_search_results = word_and_number(parsed_command["count"])
# Grab the search term.
search_term = make_search_term(parsed_command["searchterms"])
# Figure out which e-mail address to use - the default or the supplied
# one. On error, use the default address.
if "dest" in parsed_command.keys():
destination_address = parsed_command["dest"]
destination_address = default_email
return (number_of_search_results, search_term, destination_address)
except pp.ParseException as x:"No match: {0}".format(str(x)))
return (None, None, None)
# parse_search_request(): Takes a string and figures out what kind of search
# request the user wants. Requests are something along the form of "top ten
# hits for foo" or "search Tor for bar". Returns the number of results to
# send the user, the URI for the search terms, and the address to send the
# results to ("XMPP" if it's supposed to go back to the user via the XMPP
# bridge.
def parse_search_request(search_request):
logger.debug("Entered function parse_search_request().")
number_of_search_results = 0
search_term = ""
email_address = ""
# Clean up the search request.
search_request = search_request.strip()
search_request = search_request.strip(",")
search_request = search_request.strip(".")
search_request = search_request.strip("'")
search_request = search_request.lower()
# If the search request is empty (i.e., nothing in the queue) return 0 and
# "".
if "no commands" in search_request:
logger.debug("Got empty search request.")
return (number_of_search_results, search_term, email_address)
# Attempt to parse a request for online help.
(number_of_search_results, search_term, email_address) = parse_help(search_request)
if number_of_search_results == "help":"The user is asking for online help.")
return ("help", None, None)
# Attempt to parse a "get" request.
(number_of_search_results, search_term, email_address) = parse_get_request(search_request)
if number_of_search_results and (email_address == "XMPP"):"The user has sent the search term " + str(search_term))
return (number_of_search_results, search_term, "XMPP")
# Attempt to parse an "email results" request.
(number_of_search_results, search_term, email_address) = parse_and_email_results(search_request)
if number_of_search_results and ("@" in email_address):"The user has requested that search results for " + str(search_term) + " be e-mailed to " + email_address + ".")
return (number_of_search_results, search_term, email_address)
# Fall-through - this should happen only if nothing at all matches."Fell all the way through in parse_search_request(). Telling the user I didn't understand what they said.")
send_message_to_user("I didn't understand your command. Try again, please.")
return (0, "", None)
# get_search_results(): Function that does the heavy lifting of contacting the
# search engines, getting the results, and parsing them. Takes one argument,
# a string containing the search term. Returns a list of search results.
def get_search_results(search_term):
logger.debug("Entered function get_search_results().")
# URL which represents the search request.
url = ""
# This will hold the search results returned by Searx.
search_results = {}
# The array which holds the search result data we actually want.
results = []
# Assemble the search request URL.
url = searx + search_term
logger.debug("Got a search request for " + str(url) + ".")
# Make the search request and extract the JSON of the results.
request = requests.get(url)
search_results = json.loads(request.content)
# Extract only the stuff we want from the search results and pack it into
# a separate hash table.
for i in search_results['results']:
temp = {}
temp['title'] = i['title']
temp['url'] = i['url']
temp['score'] = i['score']
# Truncate the master list of search results down to the number of
# hits the user requested.
if len(results) > number_of_results:
results = results[:(number_of_results - 1)]
logger.debug("Returning " + str(len(results)) + " search results.")
# Return the list of search results.
return results
# send_message_to_user(): Function that does the work of sending messages back
# to the user by way of the XMPP bridge. Takes one argument, the message to
# send to the user. Returns a True or False which delineates whether or not
# it worked.
def send_message_to_user(message):
logger.debug("Entered function send_message_to_user().")
# Headers the XMPP bridge looks for for the message to be valid.
headers = {'Content-type': 'application/json'}
# Set up a hash table of stuff that is used to build the HTTP request to
# the XMPP bridge.
reply = {}
reply['name'] = bot_name
reply['reply'] = message
# Send an HTTP request to the XMPP bridge containing the message for the
# user.
request = requests.put(server + "replies", headers=headers,
# Core code...
# Set up the command line argument parser.
argparser = argparse.ArgumentParser(description='A bot that polls a message queue for search requests, parses them, runs them as web searches, and e-mails the results to a destination.')
# Set the default config file and the option to set a new one.
argparser.add_argument('--config', action='store',
# Loglevels: critical, error, warning, info, debug, notset.
argparser.add_argument('--loglevel', action='store',
help='Valid log levels: critical, error, warning, info, debug, notset. Defaults to info.')
# Time (in seconds) between polling the message queues.
argparser.add_argument('--polling', action='store', help="Default: 60 seconds")
# Parse the command line arguments.
args = argparser.parse_args()
if args.config:
config_file = args.config
# Read the options in the configuration file before processing overrides on the
# command line.
config = ConfigParser.ConfigParser()
if not os.path.exists(config_file):
logging.error("Unable to find or open configuration file " +
config_file + ".")
# Get the URL of the Searx instance to contact.
searx = config.get("DEFAULT", "searx")
# Get the URL of the message queue to contact.
server = config.get("DEFAULT", "queue")
# Get the names of the message queues to report to.
bot_name = config.get("DEFAULT", "bot_name")
# Construct the full message queue URL.
message_queue = server + bot_name
# Get the default e-mail address.
default_email = config.get("DEFAULT", "default_email")
# Get the default loglevel of the bot.
config_log = config.get("DEFAULT", "loglevel").lower()
if config_log:
loglevel = set_loglevel(config_log)
# Set the number of seconds to wait in between polling runs on the message
# queues.
polling_time = config.get("DEFAULT", "polling_time")
# Nothing to do here, it's an optional configuration setting.
# Get the SMTP server to send search results through from the config file if
# it's been set.
smtp_server = config.get("DEFAULT", "smtp_server")
# Nothing to do here, it's an optional configuration setting.
# Get the e-mail address that search results will be sent from.
origin_email_address = config.get("DEFAULT", "origin_email_address")
# Set the loglevel from the override on the command line.
if args.loglevel:
loglevel = set_loglevel(args.loglevel.lower())
# Configure the logger.
logging.basicConfig(level=loglevel, format="%(levelname)s: %(message)s")
logger = logging.getLogger(__name__)
# Set the message queue polling time from override on the command line.
if args.polling:
polling_time = args.polling
# Debugging output, if required."Everything is set up.")
logger.debug("Values of configuration variables as of right now:")
logger.debug("Configuration file: " + config_file)
logger.debug("Searx instance: " + searx)
logger.debug("Server to report to: " + server)
logger.debug("Message queue to report to: " + message_queue)
logger.debug("Bot name to respond to search requests with: " + bot_name)
logger.debug("Default e-mail address to send results to: " + default_email)
logger.debug("Time in seconds for polling the message queue: " +
logger.debug("SMTP server to send search results through: " + smtp_server)
logger.debug("E-mail address that search results are sent from: " +
# Go into a loop in which the bot polls the configured message queue with each
# of its configured names to see if it has any search requests waiting for it.
logger.debug("Entering main loop to handle requests.")
while True:
# Reset the destination e-mail address and the outbound message.
destination_email_address = ""
message = ""
# Check the message queue for search requests.
logger.debug("Contacting message queue: " + message_queue)
request = requests.get(message_queue)
logger.debug("Response from server: " + request.text)
logger.warn("Connection attempt to message queue timed out or failed. Going back to sleep to try again later.")
# Test the HTTP response code.
# Success.
if request.status_code == 200:
logger.debug("Message queue " + bot_name + " found.")
# Extract the search request.
search_request = json.loads(request.text)
logger.debug("Value of search_request: " + str(search_request))
search_request = search_request['command']
if not search_request:
reply = "That appears to be an empty search request."
# Parse the search request.
(number_of_results, search, destination_email_address) = parse_search_request(search_request)
logger.debug("Number of search results: " + str(number_of_results))
logger.debug("Search request: " + str(search))
if destination_email_address == "XMPP":
logger.debug("Sending search results back via XMPP.")
if destination_email_address:
logger.debug("E-mail address to send search results to: " +
# Test to see if the user requested help. If so, assemble a response,
# send it back to the user, and restart the loop.
if (str(number_of_results).lower() == "help"):
reply = "My name is " + bot_name + " and I am an instance of " + sys.argv[0] + ".\n"
reply = reply + "I am an interface to the Searx meta-search engine with very limited conversational capability. At this time I can accept search requests and e-mail the results to a destination address. To execute a search request, send me a message that looks like this:\n\n"
reply = reply + bot_name + ", (send/e-mail/email/mail) (me/<e-mail address>) top <number> hits for <search request...>\n\n"
reply = reply + "By default, I will e-mail results to the address " + default_email + ".\n\n"
reply = reply + "I can also return search results directly to this instant messager session. Send me a request that looks like this:\n\n"
reply = reply + bot_name + ", (get) top <number> hits for <search request...>\n\n"
# If the number of search results is zero there was no search
# request in the message queue, in which case we do nothing and
# loop again later.
if (number_of_results == 0) and (len(search) == 0):
search_request = ""
# Run the web searches and get the results.
send_message_to_user("Running web search. Please stand by.")
search_results = get_search_results(search)
# If no search results were returned, put that message into the
# (empty) list of search results.
if len(search_results) == 0:
temp = {}
temp['title'] = "No search results found."
temp['url'] = ""
temp['score'] = 0.0
# Construct the message containing the search results.
message = "Here are your search results:\n"
for result in search_results:
message = message + result['title'] + "\n"
message = message + result['url'] + "\n"
message = message + "Relevance: " + str(result['score']) + "\n\n"
message = message + "End of search results.\n"
# If the response is supposed to go over XMPP, send it back and go
# on with our lives.
if destination_email_address == "XMPP":
# If the search results are to be e-mailed, complete the SMTP message.
if destination_email_address == "":
destination_email_address = default_email
message = MIMEText(message, 'plain', 'utf-8')
message['Subject'] = Header("Incoming search results!", 'utf-8')
message['From'] = Header(origin_email_address, 'utf-8')
message['To'] = Header(destination_email_address, 'utf-8')
logger.debug("Created outbound e-mail message with search results.")
# Set up the SMTP connection and transmit the message."E-mailing search results to " + destination_email_address)
smtp = smtplib.SMTP(smtp_server)
smtp.sendmail(origin_email_address, destination_email_address,
send_message_to_user("E-mailed search results to " + destination_email_address + ".")"Search results transmitted. Deallocating SMTP server object.")
# Deallocate resources we don't need now that the message is en route.
smtp = ""
destination_email_address = ""
# Message queue not found.
if request.status_code == 404:"Message queue " + bot_name + " does not exist.")
# Sleep for the configured amount of time.
# Fin.