refactored bot into MVC structure

Author: raymondcheung

Images/chat/text/done.png

@@ -0,0 +1,18 @@
+class ErrorHandler(Exception):
+    #custom Exception parent class to handle errors
+    
+    def __init__(self, message):
+        ERRORHANDLERAPP = settings["ERRORHANDLERAPP"]
+        self._errormsg = message
+        ErrorHandlerApp = App(ERRORHANDLERAPP)
+        if not ErrorHandlerApp.window():
+            App.open(ERRORHANDLERAPP); wait(2)
+        ErrorHandlerApp.focus(); wait(1)
+        self.__openRecord()
+        self.__writeRecord()
+        ErrorHandlerApp.close()
+    def __openRecord(self):
+        #this will be different depending on the application
+        pass
+    def __writeRecord(self):
+        type(self._errormsg + "\n")

bot.sikuli/bot.html

@@ -0,0 +1,144 @@
+exec(open("c:/users/darkray16/desktop/my dropbox/mtgo bot/ini.py", "rb").read())
+
+import sys
+sys.path.append("c:/users/darkray16/desktop/my dropbox/mtgo bot/model")
+sys.path.append("c:/users/darkray16/desktop/my dropbox/mtgo bot/controller")
+sys.path.append("c:/users/darkray16/desktop/my dropbox/mtgo bot/view")
+import ErrorHandler
+import Session
+
+import ITrade
+import ISell
+import IBuy
+import ISignIn
+import IClassified
+import IChat
+
+class MainController(object):
+    #this class will control and instanciate all the other classes
+    #it will contain the logic and manipulate all the data
+    #and pass data between the classes it owns
+    
+    __single = None
+    
+    def __init__(self):
+        
+        self.Itrade = ITrade.ITrade()
+        self.Isell = ISell.ISell()
+        self.Ibuy = IBuy.IBuy()
+        self.Isignin = ISignIn.ISignIn()
+        self.Iclassified = IClassified.IClassified()
+        self.Ichat = IChat.IChat()
+        self.selling_greeting = """Entering selling mode.  When you are finished taking products, please type the word \"DONE\" in all lowercase"""
+        self.buying_greeting = """Entering buying mode.  I will search your collection for products to buy.  Please wait..."""
+        
+        #make controller object a singleton class.  only one instance should be run at a time
+        if MainController.__single:
+            raise ErrorHandler.ErrorHandler("Controller class cannot be instantiated more than once")
+        MainController.__single = self
+        
+        #run the controllers startup method on instanciation
+        self.mode = settings["DEFAULTMODE"]
+        
+    def startup(self):
+        #log into Magic Online
+        self.interface._define_region()
+        if (self.Isigninlog_in()):
+            print("logged in")
+            #run maintanence and inventory check
+            self.maintenance_mode()
+            #once everything is clear and ready, start selling
+            self.Iclassified.set_posting()
+            if(self.mode == "default"):
+                self.default_mode()
+            elif(self.mode == "buy"):
+                self.buy_mode()
+            elif(self.mode == "maintenance"):
+                self.maintenance_mode()
+            else:
+                raise ErrorHandler("Default mode not set in bot settings")
+                
+    def trade_mode(self, mode=None):
+        """if you wish to set the bot to only sell or buy, then set param mode to
+        "sell" or "buy" to force the bot mode"""
+        
+        #puts the bot into sell mode, will wait for trade request
+        if(self.Itrade.start_wait("incoming_request")):
+            #minimize the chat window to the side
+            if(self.Itrade.accept_trade()):
+                self.Ichat.minimize_chat_window()
+                  
+                ## DEBUG: onChange method is not working correctly, ##
+                #signals that the customer is taking something and the transaction will be a sale
+                #wait(2)
+                #self.Itrade.giving_window_region.onChange(self.set_mode("sell"))
+                if not mode:
+                    mode="buy"
+                
+                self.set_mode(mode=mode)
+                #open a session to record data to
+                session = Session.Session()
+                
+                
+                #enter selling mode
+                if self.get_mode() == "sell":
+                    self.Ichat.type_msg(self.selling_greeting)
+                    self.Isell.set_windows()
+                    products_sold = self.Isell.complete_sale()
+                    
+                    receipt = None
+                    if products_sold:
+                        receipt = {"sold":{}, "bought":{}}
+                        for product in products_sold:
+                            receipt["sold"][product["name"]] = product["quantity"]
+                    
+                #enter buying mode
+                elif self.get_mode() == "buy":
+                    self.Ichat.type_msg(self.buying_greeting)
+                    self.Ibuy.set_windows()
+                    #take packs from the customer
+                    products_bought = self.Ibuy.complete_purchase()
+                    
+                    receipt = None
+                    if products_bought:
+                        receipt = {"sold":{}, "bought":{}}
+                        for product in products_bought:
+                            receipt["bought"][product["name"]] = product["quantity"]
+                    
+                
+                if receipt is not None:
+                    session.set_transaction(receipt)
+                    session.set_time(datetime.now())
+                    session.record()
+                    del(session)
+                else:
+                    #record trade failure
+                    pass
+                    
+        #check if bot is part of a bot network before trying to transfer items
+        if(self.settings["NETWORK"]):
+        
+            self.transfer_mode()
+        
+        self.trade_mode()
+        
+    def transfer_mode(self):
+        #puts the bot into transfer mode, will check inventory and transfer items to other bots
+        #check if bot is part of network
+        if(BotSetting.getSetting("NETWORK")):
+            pass
+            
+    def maintenance_mode(self):
+        #puts the bot maintanence mode to check inventory
+        pass
+        
+    def set_mode(self, mode):
+        #set the bot mode to sell or buy
+        self.status = mode
+        
+    def get_mode(self):
+        #get the current mode
+        if self.status:
+            return self.status
+        else:
+            raise ErrorHandler("Current Mode Uknown")

bot.sikuli/bot.py

@@ -0,0 +1,2 @@
+from MainController import *
+from ErrorHandler import *

code.py

@@ -0,0 +1,18 @@
+from sikuli.Sikuli import *
+
+#this object will hold all global settings for the application
+settings = {"ERRORHANDLERAPP":"Notepad", "LOGIN_WAIT":45, "PASSWORD":"nancy214", "BOTUSERNAME":"rcdark16", "BOTPASSWORD":"Esther", "FORCEMODE":"", "NETWORK":False, "DEFAULTMODE":"sell"}
+
+#default is 1
+Settings.MoveMouseDelay = 0.2
+#default is False, don't show visual guide to actions
+setShowActions(False)
+#default is 2.0(2 seconds delay on show actions)
+Settings.SlowMotionDelay = 1.5
+#set this lower if cpu usage is too high
+Settings.WaitScanRate = 6
+#must be 0.8 to 1, in order to maintain accuracy, MAY NOT affect pixel matching operations besides find()
+Settings.MinSimilarity = 0.9
+#min pixel change to trigger onChange
+Settings.ObserveMinChangedPixels = 200
+#all find operations which don't use other regions should use this one

controller/ErrorHandler$py.class

@@ -1,8 +1,21 @@
+import sys
+sys.path.append("c:/users/darkray16/desktop/my dropbox/mtgo bot/model")
+import ProductPriceModel
 
 class CardPricesDAL(object):
     #DAL layer for pricelist for buying and selling single cards
-    
     def __init__(self):
-        price_model = ProductPriceModel()
-        self.pack_buy = price_model.get_prices("cards_buy")
-        self.pack_sell = price_model.get_prices("cards_sell")
+        price_model = ProductPriceModel.ProductPriceModel()
+        self.buy = price_model.get_prices("cards_buy")
+        self.sell = price_model.get_prices("cards_sell")
+       
+    #set prices is to be done in gui bot settings prior to transaction
+    def set_buy_price(self, name, price):
+        self.buy[name.upper()] = price
+    def set_sell_price(self, name, price):
+        self.sell[name.upper()] = price
+        
+    def get_buy_price(self, name):
+        return self.buy[name.upper()]
+    def get_sell_price(self, name):
+        return self.sell[name.upper()]

controller/ErrorHandler.py

@@ -0,0 +1,11 @@
+import sys
+sys.path.append("c:/users/darkray16/desktop/my dropbox/mtgo bot/model")
+from List import *
+
+class CardsList(List):
+    # is list of cards wanted and cards for sale
+    def __init__(self):
+        super(CardsList, self).__init__()
+        
+    def add_card_to_have(self, cardname, amount):
+        self._have[cardname] = amount

controller/MainController$py.class

@@ -0,0 +1,32 @@
+import sikuli.Sikuli
+
+class DataStorage(object):
+    #object that will handle exporting transaction history
+    #you must have the program that you want to send the transaction to, open
+    #methods of storage being considered, xml, excel, mysql
+    
+    def __init__(self, program):
+        """ program parameter is the format to write the file in, e.g. Notepad, or Excel"""
+        self._program = program
+        
+    def write(self, transaction):
+        record_app = App("Notepad")
+        if not record_app.window():
+            App.open("Notepad"); wait(1)
+        record_app.focus()
+        type(self.convert_trans_to_string(transaction))
+        wait(0.5)
+        App.focus("Magic Online")
+        
+    def convert_trans_to_string(self, transaction):
+        """takes the transaction variable created in Session class and converts it to string"""
+        #note, repr will not work because it doesn't remove curly brackets and colons
+        record_list = []
+        for mode, trans in transaction.iteritems():
+            record_list.append(str("mode: " + mode + "  "))
+            for product,quantity in trans.iteritems():
+                record_list.append(str(product + ":"))
+                record_list.append(str(quantity) + " ")
+            
+        record_string = "".join(record_list) + "\n"
+        return record_string

controller/MainController.py

@@ -0,0 +1,11 @@
+class List(object):
+    #parent class for cards and packs wanted classes
+    def __init__(self):
+        #change to private variables later
+        self._wanted = {}
+        self._have = {}
+        
+    def get_wanted(self):
+        return self._wanted
+    def get_have(self):
+        return self._have

controller/__init__$py.class

@@ -1,8 +1,12 @@
+import sys
+sys.path.append("c:/users/darkray16/desktop/my dropbox/mtgo bot/model")
+import ProductPriceModel
+
 
 class PackPricesDAL(object):
     #DAL layer for pricelist for buying and selling packs
     def __init__(self):
-        price_model = ProductPriceModel()
+        price_model = ProductPriceModel.ProductPriceModel()
         self.buy = price_model.get_prices("packs_buy")
         self.sell = price_model.get_prices("packs_sell")
 

controller/__init__.py

@@ -0,0 +1,15 @@
+import sys
+sys.path.append("c:/users/darkray16/desktop/my dropbox/mtgo bot/model")
+from List import *
+
+class PacksList(List):
+    def __init__(self):
+        super(PacksList, self).__init__()
+        buylist = ["SOM", "ZEN", "WWK", "ME4", "M11", "ROE"]
+    
+    def get_buy_list(self):
+         #returns a prioritized list of packs wanted, starting with most wanted
+        return self._buy_list
+    
+    def add_pack_to_have(self, packname, amount):
+        self._have[packname] = amount

ini$py.class

@@ -0,0 +1,7 @@
+class Product(object):
+    #an object which holds all the information for a single product in a trade
+    def __init__(self, name, quantity, buy, sell):
+        self.__stats = {"quantity": quantity, "buy":buy, "sell":sell, "name":name}
+    
+    def __getitem__(self, index):
+        return self.__stats[index]

ini.py

@@ -1,36 +1,36 @@
-#handles reading and writing to files
+#handles reading and writing to pricelist files
 
 from sys import *
 
 class ProductPriceModel(object):
 
     def __init__(self):
 
-        self.pricelist = {}
+        self.pricelist_files = {}
         try:
-            self.pricelist["packs_buy"] = open("c:/users/darkray16/desktop/my dropbox/mtgo bot/pricelist/packs/buy.txt", "r")
+            self.pricelist_files["packs_buy"] = open("c:/users/darkray16/desktop/my dropbox/mtgo bot/pricelist/packs/buy.txt", "r")
         except IOError:
-            sys.exit("Pack buy price file not found at pricelist/packs/buy/")
+            print("Pack buy price file not found at pricelist/packs/buy/")
         try:
-            self.pricelist["packs_sell"] = open("c:/users/darkray16/desktop/my dropbox/mtgo bot/pricelist/packs/sell.txt", "r")
+            self.pricelist_files["packs_sell"] = open("c:/users/darkray16/desktop/my dropbox/mtgo bot/pricelist/packs/sell.txt", "r")
         except IOError:
-            sys.exit("Pack sell price file not found at pricelist/packs/sell/")
+            print("Pack sell price file not found at pricelist/packs/sell/")
         try:
-            self.pricelist["cards_buy"] = open("c:/users/darkray16/desktop/my dropbox/mtgo bot/pricelist/cards/buy.txt", "r")
+            self.pricelist_files["cards_buy"] = open("c:/users/darkray16/desktop/my dropbox/mtgo bot/pricelist/cards/buy.txt", "r")
         except IOError:
-            sys.exit("Card buy price file not found at pricelist/packs/buy/")
+            print("Card buy price file not found at pricelist/cards/buy/")
         try:
-            self.pricelist["cards_sell"] = open("c:/users/darkray16/desktop/my dropbox/mtgo bot/pricelist/cards/sell.txt", "r")
+            self.pricelist_files["cards_sell"] = open("c:/users/darkray16/desktop/my dropbox/mtgo bot/pricelist/cards/sell.txt", "r")
         except IOError:
-            sys.exit("Card sell price file not found at pricelist/packs/buy/")
+            print("Card sell price file not found at pricelist/cards/buy/")
 
     def get_prices(self, pricelist):
         """valid strings for pricelist = "packs_buy", "packs_sell", "cards_buy", "cards_sell" """
         #this will return a dictionary containg all the buy or sell prices for requested products
 
         pricelist_dict = {}
 
-        raw_feed = self.pricelist[pricelist]
+        raw_feed = self.pricelist_files[pricelist]
 
         while True:
             newline = raw_feed.readline()
@@ -41,7 +41,17 @@ def get_prices(self, pricelist):
                 int(single_product[1])
             except ValueError:
                 sys.exit("A non-number found as a price for " + single_product[0] + " in in response to a " + pricelist + " request")
-                
-            pricelist_dict[single_product[0]] = int(single_product[1])
+            product_name = str(single_product[0])
+            
+            #if there is no price next to the name of the product, then 
+            try:
+                product_price = int(single_product[1])
+            except IndexError:
+                pass
+            except ValueError:
+                pass
+            else:
+                pricelist_dict[product_name.upper()] = product_price
 
+        pricelist_dict["Rack"] = 15
         return pricelist_dict