bot.py

from optparse import AmbiguousOptionError
import speech_recognition as sr
import pyttsx3

import pywhatkit
from AppKit import *

import requests
import geocoder

import pyjokes
import datetime

import smtplib
from email.message import EmailMessage

import wikipedia
from bs4 import *

import csv

from helper import configs
from helper import emails, utilities


### BOT CLASS MODULE ###
class Bot:
    def __init__(self):
        ### GET BOT NAME
        self.__bot_name = configs["BOT_NAME"]

        ### INITIALIZE THE BOT
        self.__ear = sr.Recognizer()
        self.__engine = pyttsx3.init()
        voice = self.__engine.getProperty('voice')
        self.__engine.setProperty('voice', voice.replace("Alex", "samantha"))
        self.__engine.setProperty('rate', 170.0) # set to so-called perfect rate (168 - 170)

        # LOAD ALL DATA FROM FILES
        self.__utilities = utilities if len(utilities) > 0 else ""
        self.__emails = emails if len(emails) > 0 else {}

    # Brief description of bot
    def __str__(self):
        return f"Hello. This is {self.bot_name.upper()}, your virtual assistant."
    
    # Getter method for emails
    @property
    def emails(self):
        return self.__emails
    
    # Getter method for utilities
    @property
    def utilities(self):
        return self.__utilities
    
    # Getter method for bot name
    @property
    def bot_name(self):
        return self.__bot_name

    # Text-to-speech
    def say(self, text):
        self.__engine.say(text)
        self.__engine.runAndWait()
    
    # Get input
    def get_audio_input(self):
        try:
            with sr.Microphone() as stream:
                print('...On listening...')
                # seconds of non-speaking audio before 
                # a phrase is considered complete
                self.__ear.pause_threshold = 0.5
                src = self.__ear.listen(stream)
                cmd = self.__ear.recognize_google(src)

                return cmd.lower() if cmd != '' and cmd != None else ''

        except sr.UnknownValueError:
            raise sr.UnknownValueError('*** ERROR: Could not get audio input')
    
    # Get a list of available utilities
    def get_utilities(self):
        print("__GET UTILITIES__")
        self.say(f"Available utilities are {self.utilities}") if self.utilities != "" else self.say("Sorry, no utilities available")
    
    # Play music based on user's preferences
    def play_music(self):
            print("__STREAMING MUSIC__")
            print("> Please say the name of the song you want to play <")

            song = self.get_audio_input()
            song = song.upper()

            self.say(f"Playing {song} on Youtube")
            print(f"> Current song: {song}")
            pywhatkit.playonyt(song, use_api=True)
    
    # Get data for current weather in specific location
    def get_weather(self, cmd):
        print("__GET WEATHER__")
        # If location is specified, return data for that location
        if 'in' in cmd:
            loc = cmd.split(' ')[-1]
            url = f"https://api.openweathermap.org/data/2.5/weather?q={loc}&appid={configs['WEATHER_API_KEY']}&units=metric"
        # Otherwise, get the location based on location of machine running
        else:
            loc = geocoder.ip('me') 
            url = f"https://api.openweathermap.org/data/2.5/weather?lat={loc.latlng[0]}&lon={loc.latlng[1]}&appid={configs['WEATHER_API_KEY']}&units=metric"

        response = requests.get(url)
        response = response.json()

        self.say(f'Currently, in {response["name"]}, it is {response["main"]["temp"]:.1f} degrees Celcius, with {response["weather"][0]["description"]}.')
    
    # Get jokes
    def get_joke(self):
        print("__GET JOKES__")
        self.say(pyjokes.get_joke())
    
    # Get current time
    def get_time(self):
        print("__GET CURRENT TIME__")
        time = datetime.datetime.now().strftime("%I:%M %p")
        self.say(f"Right now, it is {time}")
    
    # Get today's date
    def get_date(self):
        print("__GET CURRENT DATE__")
        date = datetime.datetime.now().strftime("%B %d, %Y")
        self.say(f"Today's date is {date}")
    
    # Send email
    def send_email(self):
        print("__SEND EMAIL__")

        print("...Getting email information...")
        self.say("Who is the recipient?")
        recipient = self.get_audio_input()

        if recipient not in self.emails:
            self.say("Recipient not found. Do you wish to add to contact list?")
            option = self.get_audio_input()
            while option != "no":
                if option == "yes":
                    print('>> Redirecting to "add email contact" utility...')
                    self.add_email_contact()
                    self.say("Okay. Let's continue sending the email...")
                    break

                self.say("Sorry. Please say YES or NO.")
                option = self.get_audio_input()
            
            if option == "no":
                self.say(">> Operation aborted: User chose to not add new contact, therefore cannot send the email")
                return
            
        self.say("What is the email subject?")
        subject = self.get_audio_input()
        self.say("What is the message?")
        message = self.get_audio_input()

        # Initialize an SMTP client
        server = smtplib.SMTP(configs["EMAIL_DOMAIN"], configs["EMAIL_PORT"])
        server.starttls()
        # Make sure to toggle ON 'Less Secure App Access' before login
        server.login(configs["EMAIL_USER"], configs["EMAIL_PWD"])

        # Initialize email object
        email = EmailMessage()
        email["From"] = configs["EMAIL_USER"]
        email["To"] = self.emails[recipient] 
        email["Subject"] = subject
        email.set_content(message)
        
        # Send email
        self.say("Do you want to send this email?")
        option = self.get_audio_input()
        while option != "no":
            if option == "yes":
                server.send_message(email)
                print(f"Sending email to {self.emails[recipient]}...")
                self.say("Email sent!")
                break
        
            self.say("Sorry. Please say YES or NO.")
            option = self.get_audio_input()
            
        if option == "no":
            self.say(">> Operation aborted: User chose to not send email")

    # Add email contact
    def add_email_contact(self):
        print("__ADD EMAIL CONTACT__")

        name = ""
        email = ""
        for field in ["name", "email"]:
            # counter for number of times the user is asked to input the value by voice (default to 2 times max)
            # after 2 times, ask the user the type in the value
            num_times = 0 

            self.say(f"What's the {field} of the contact? Please spell it out!")
            user_input = self.get_audio_input()

            while True:
                if field == "email":
                    user_input = user_input.replace(" ", "").replace("at","@")
                print(f"> {field.upper()}: {user_input}")

                self.say(f'Is the displayed {field} correct?')
                option = self.get_audio_input()

                if option == "yes":
                    break

                if option == "no" and num_times < 2:
                    self.say(f"My mistake...What's the {field} of the contact? Please spell it out!")
                    user_input = self.get_audio_input()

                if option != "yes" and option != "no" and num_times < 2:
                    self.say("Sorry. Please say YES or NO.")
            
                num_times += 1
                if num_times > 2:
                    self.say(f"Sorry, I couldn't get the {field} right. Please enter it.")
                    # user_input = input(f"Enter the contact's {field}: ")
                    break

            if field == "name":
                name = user_input
            else:
                email = user_input

        # Write new contact to file or edit existing contact
        self.say("Please look at the email contact information displayed on the screen.")
        print("----- EMAIL CONTACT -----")
        print(f"Name: {name:>10}")
        print(f"Email: {email:>10}")

        self.say("Do you want to save this contact?")
        num_times = 0
        while True:
            option = self.get_audio_input()
            
            if option == "no": 
                self.say("Saving new contact aborted.")
                print(">>> Operation aborted: User chose not to save the contact")
                break

            if option == "yes":
                if name not in self.emails:
                    self.emails[name] = email
                    print(f"Adding new contact...")
                    self.say("Email contact saved!")
                    break

                elif self.emails[name] != email:
                    self.say("This contact name has already been registered. Do you want to overwrite this contact with the new email?")

                    while True:
                        option = self.get_audio_input()
                        if option == "no":
                            self.say("Overwritting email contact aborted.")
                            print(">>> Operation aborted: User chose not to overwrite this contact")
                            break

                        if option == "yes":
                            self.emails[name] = email
                            print(f"Overwriting existing contact...")
                            self.say("Email contact overwritten.")
                            break

                    break # break the outer loop regardless of the option in the above inner loop

                else:
                    self.say("Contact already exists with the provided email")
                    print(">>> Operation aborted: Contact already exists with the provided email")
                    break

            if option != "yes" and option != "no":
                self.say("Sorry. Please say YES or NO.")

            num_times += 1
            if num_times == 2:
                self.say("Sorry, I couldn't save the contact. Please try again later.")
                break
        
    # wiki search
    def wiki_search(self, search_term):
        try:
            response = wikipedia.summary(search_term, sentences = 2)
            self.say(f"According to wikipedia: {response}")

        # Throw error if search term is not specific enough
        except wikipedia.exceptions.DisambiguationError:
            suggests = wikipedia.search(search_term, results = 2)
            self.say(f"Sorry, did you mean {suggests[1]}?")
            option = self.get_audio_input()

            if option == "yes":
                response = wikipedia.summary(suggests[1], sentences = 2)
                self.say(f"According to wikipedia: {response}")
                return
            
            self.say("Sorry, please be more specific with what your search. Please try again later.")

    # Shutdown tasks to operate
    def shutdown_tasks(self):
        print(">> RUNNING BACKGROUND TASKS BEFORE SHUTDOWN <<")

        # OVERWRITE EXISTING EMAIL FILE WITH NEW VALUES
        try:
            with open(configs["FILE_EMAILS"], "w") as email_file:
                fieldnames = ['name', 'email']
                writer = csv.DictWriter(email_file, delimiter = ",", fieldnames = fieldnames)

                writer.writeheader()
                for name, email in self.emails.items():
                    writer.writerow({'name': name, 'email': email})

        except:
            print("*** ERROR: Unable to write emails to file")
        
        print("Background tasks completed...")


if __name__ == '__main__':
    bot = Bot()
    print(bot.emails)
    # print(bot.utilities)
    # print(bot)
    # bot.wiki_search("Donald Trump")