1fb3d529a9
- Set `bot_handler` type to `BotHandler`. - Fix mypy issues in improperly typed variables, params and returns. Fixes part of #639
81 lines
3.1 KiB
Python
81 lines
3.1 KiB
Python
import requests
|
|
import logging
|
|
from typing import Dict
|
|
from zulip_bots.lib import BotHandler
|
|
|
|
# See readme.md for instructions on running this code.
|
|
|
|
class WikipediaHandler:
|
|
'''
|
|
This plugin facilitates searching Wikipedia for a
|
|
specific key term and returns the top 3 articles from the
|
|
search. It looks for messages starting with '@mention-bot'
|
|
|
|
In this example, we write all Wikipedia searches into
|
|
the same stream that it was called from, but this code
|
|
could be adapted to write Wikipedia searches to some
|
|
kind of external issue tracker as well.
|
|
'''
|
|
|
|
META = {
|
|
'name': 'Wikipedia',
|
|
'description': 'Searches Wikipedia for a term and returns the top 3 articles.',
|
|
}
|
|
|
|
def usage(self) -> str:
|
|
return '''
|
|
This plugin will allow users to directly search
|
|
Wikipedia for a specific key term and get the top 3
|
|
articles that is returned from the search. Users
|
|
should preface searches with "@mention-bot".
|
|
@mention-bot <name of article>'''
|
|
|
|
def handle_message(self, message: Dict[str, str], bot_handler: BotHandler) -> None:
|
|
bot_response = self.get_bot_wiki_response(message, bot_handler)
|
|
bot_handler.send_reply(message, bot_response)
|
|
|
|
def get_bot_wiki_response(self, message: Dict[str, str], bot_handler: BotHandler) -> str:
|
|
'''This function returns the URLs of the requested topic.'''
|
|
|
|
help_text = 'Please enter your search term after {}'
|
|
|
|
# Checking if the link exists.
|
|
query = message['content']
|
|
if query == '':
|
|
return help_text.format(bot_handler.identity().mention)
|
|
|
|
query_wiki_url = 'https://en.wikipedia.org/w/api.php'
|
|
query_wiki_params = dict(
|
|
action='query',
|
|
list='search',
|
|
srsearch=query,
|
|
format='json'
|
|
)
|
|
try:
|
|
data = requests.get(query_wiki_url, params=query_wiki_params)
|
|
|
|
except requests.exceptions.RequestException:
|
|
logging.error('broken link')
|
|
return 'Uh-Oh ! Sorry ,couldn\'t process the request right now.:slightly_frowning_face:\n' \
|
|
'Please try again later.'
|
|
|
|
# Checking if the bot accessed the link.
|
|
if data.status_code != 200:
|
|
logging.error('Page not found.')
|
|
return 'Uh-Oh ! Sorry ,couldn\'t process the request right now.:slightly_frowning_face:\n' \
|
|
'Please try again later.'
|
|
|
|
new_content = 'For search term:' + query + '\n'
|
|
|
|
# Checking if there is content for the searched term
|
|
if len(data.json()['query']['search']) == 0:
|
|
new_content = 'I am sorry. The search term you provided is not found :slightly_frowning_face:'
|
|
else:
|
|
for i in range(min(3, len(data.json()['query']['search']))):
|
|
search_string = data.json()['query']['search'][i]['title'].replace(' ', '_')
|
|
url = 'https://en.wikipedia.org/wiki/' + search_string
|
|
new_content += str(i+1) + ':' + '[' + search_string + ']' + '(' + url.replace('"', "%22") + ')\n'
|
|
return new_content
|
|
|
|
handler_class = WikipediaHandler
|