matrix_shop_bot/db.py

   1 import logging
   2 import os
   3 from datetime import datetime as dt
   4 from decimal import Decimal
   5 from typing import List
   6
   7 from sqlmodel import Field, Session, SQLModel, create_engine, select, text, Relationship
   8
   9 from sqlite3 import IntegrityError
  10
  11 MODULE='shop'
  12
  13 DATE_FORMAT = '%Y-%m-%d'
  14
  15 def today():
  16     return dt.now().strftime(DATE_FORMAT)
  17
  18
  19 logger = logging.getLogger(__name__)
  20 logging.basicConfig(filename=f'{MODULE}.log', encoding='utf-8', level=logging.DEBUG)
  21
  22 class ItemStoreLink(SQLModel, table=True):
  23     item_id: int | None = Field(default=None, foreign_key="item.id", primary_key=True)
  24     store_id: int | None = Field(default=None, foreign_key="store.id", primary_key=True)
  25
  26
  27 class Item(SQLModel, table=True):
  28     id: int | None = Field(default=None, primary_key=True)
  29     name: str = Field(default=None, unique=True)
  30     price: Decimal | None = Field(decimal_places=2)
  31     stores: list["Store"] = Relationship(back_populates="shopping_list", link_model=ItemStoreLink)
  32     purchase_date: dt | None = Field(default=None)
  33     def __str__(self):
  34         return f'{self.name} (#{self.id})'
  35
  36 class PreferStore(SQLModel, table=True):
  37     store_id: int | None = Field(default=None, foreign_key="store.id", primary_key=True)
  38
  39 class Store(SQLModel, table=True):
  40     id: int | None = Field(default=None, primary_key=True)
  41     name: str = Field(default=None, unique=True)
  42     shopping_list: list["Item"] = Relationship(back_populates="stores", link_model=ItemStoreLink)
  43     # purchase_history: list["PurchaseRecord"] = Relationship(back_populates="store")
  44     def __str__(self):
  45         return f'{self.name} (#{self.id})'
  46
  47 # May get used later...
  48 #class PurchaseRecord(SQLModel, table=True):
  49 #    id: int | None = Field(default=None, primary_key=True)
  50 #    name: str = Field(default=None, unique=True)
  51 #    price: Decimal | None = Field(decimal_places=2)
  52 #    store: Store = Relationship(back_populates="purchase_history")
  53 #    purchase_date: dt | None = Field(default=None)
  54
  55 def _get_with_id(cls, item_id):
  56     return select(cls).where(cls.id == item_id)
  57
  58
  59 class Data():
  60     def __init__(self, db_file=None):
  61         if not db_file:
  62             db_file = os.path.join(os.environ.get('MATRIX_DATA_DIR', ''), f'{MODULE}.db')
  63
  64         self.file = db_file
  65         self.engine = self.get_engine()
  66         self.last_store_id = None
  67
  68     def _set_pref_store_id(self, store_id):
  69         with Session(self.engine) as session:
  70             prefs = session.exec(select(PreferStore)).all()
  71             for pref in prefs:
  72                 session.delete(pref)
  73             pref = PreferStore()
  74             pref.store_id = store_id
  75             session.add(pref)
  76             session.commit()
  77
  78     def _get_pref_store_id(self):
  79         with Session(self.engine) as session:
  80             pref = session.exec(select(PreferStore)).one()
  81             return pref.store_id
  82
  83     def _add_with_name(self, cls, name):
  84         item_id = -1
  85         try:
  86             with Session(self.engine) as session:
  87                 new = cls(name=name)
  88                 session.add(new)
  89                 session.commit()
  90                 item_id = new.id
  91         except:
  92             # duplicate add
  93             # recover by returning the item_id
  94             item = session.exec(select(Item).where(Item.name == name)).first()
  95             item_id = item.id
  96
  97         return item_id
  98
  99     def add_store(self, name):
 100         store_id = self._add_with_name(Store, name)
 101         self._set_pref_store_id(store_id)
 102         return store_id
 103
 104     def add_item(self, name):
 105         names = name.split(',')
 106         for name in names:
 107             item_id = self._add_with_name(Item, name.strip())
 108             store_id = self._get_pref_store_id()
 109             self.assign_store(item_id, store_id)
 110         return item_id
 111
 112     def assign_last_store(self, item_id):
 113         store_id = self._get_pref_store_id()
 114         self.assign_store(item_id, store_id)
 115         return store_id
 116
 117     def assign_store(self, item_id, store_id):
 118         self._set_pref_store_id(store_id)
 119
 120         with Session(self.engine) as session:
 121             store = session.exec(_get_with_id(Store, store_id)).first()
 122             item = session.exec(_get_with_id(Item, item_id)).first()
 123             try:
 124                 item.stores.append(store)
 125                 session.commit()
 126             except:
 127                 pass # Already assigned
 128         return ['Success']
 129
 130
 131     def purchase_items(self, item_ids):
 132         results = []
 133         with Session(self.engine) as session:
 134             for item_id in item_ids.split(' '):
 135                 item = session.exec(_get_with_id(Item, item_id)).first()
 136                 if item:
 137                     item.purchase_date = dt.today()
 138                 results.append(str(item))
 139             session.commit()
 140         return results
 141
 142     def purchase_item(self, item_id):
 143         with Session(self.engine) as session:
 144             item = session.exec(_get_with_id(Item, item_id)).first()
 145             item.purchase_date = dt.today()
 146             session.commit()
 147         return ['Success']
 148
 149     def clear_list(self, store_id, clear_all=False):
 150         with Session(self.engine) as session:
 151             store = session.exec(_get_with_id(Store, store_id)).first()
 152             for item in store.shopping_list:
 153                 if clear_all or item.purchase_date:
 154                     session.delete(item)
 155             session.commit()
 156
 157     def get_stores(self):
 158         with Session(self.engine) as session:
 159             cmd = select(Store)
 160             return session.exec(cmd).all()
 161
 162     def get_unsorted_list(self):
 163
 164         results = []
 165         with Session(self.engine) as session:
 166             cmd = select(Item).where(Item.stores == None)
 167             items = session.exec(cmd).all()
 168
 169             if not items:
 170                 return [f'No unsorted items!']
 171             return items
 172
 173
 174     def get_shopping_list_for_store(self, store_id) -> List[str]:
 175         self._set_pref_store_id(store_id)
 176         return self.get_shopping_list(store_id)
 177
 178     def get_last_shopping_list(self) -> List[str]:
 179         store_id = self._get_pref_store_id()
 180         return self.get_shopping_list(store_id)
 181
 182     def get_shopping_list(self, store_id) -> List[str]:
 183         results = []
 184         with Session(self.engine) as session:
 185             cmd = select(Store).where(Store.id == store_id)
 186             store = session.exec(cmd).first()
 187             if not store:
 188                 return [f'Store {store_id} not found.']
 189
 190             results.append(f' ## {store.name}')
 191
 192             items = store.shopping_list
 193             if not items:
 194                 results.append(f'-- Nothing to shop for at {store.name} --')
 195             else:
 196                 for item in items:
 197                     if(item.purchase_date):
 198                         results.append(f' - [x] {item}')
 199                     else:
 200                         results.append(f' - [ ] {item}')
 201         return results
 202
 203     def remove_item(self, item_id):
 204         with Session(self.engine) as session:
 205             item = session.exec(_get_with_id(Item, item_id)).first()
 206             session.delete(item)
 207             session.commit()
 208
 209     def remove_store(self, store_id):
 210         with Session(self.engine) as session:
 211             store = session.exec(_get_with_id(Store, store_id)).first()
 212             session.delete(store)
 213             session.commit()
 214
 215     def get_engine(self):
 216         return create_engine(f"sqlite:///{self.file}")
 217
 218     def setup(self):
 219         SQLModel.metadata.create_all(self.engine)
 220         return 'Success'
 221
 222
 223
 224