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     def purchase_item(self, item_id):
 131         with Session(self.engine) as session:
 132             item = session.exec(_get_with_id(Item, item_id)).first()
 133             item.purchase_date = dt.today()
 134             session.commit()
 135         return ['Success']
 136
 137     def clear_list(self, store_id, clear_all=False):
 138         with Session(self.engine) as session:
 139             store = session.exec(_get_with_id(Store, store_id)).first()
 140             for item in store.shopping_list:
 141                 if clear_all or item.purchase_date:
 142                     session.delete(item)
 143             session.commit()
 144
 145     def get_stores(self):
 146         with Session(self.engine) as session:
 147             cmd = select(Store)
 148             return session.exec(cmd).all()
 149
 150     def get_unsorted_list(self):
 151
 152         results = []
 153         with Session(self.engine) as session:
 154             cmd = select(Item).where(Item.stores == None)
 155             items = session.exec(cmd).all()
 156
 157             if not items:
 158                 return [f'No unsorted items!']
 159             return items
 160
 161
 162     def get_shopping_list_for_store(self, store_id) -> List[str]:
 163         self._set_pref_store_id(store_id)
 164         return self.get_shopping_list(store_id)
 165
 166     def get_last_shopping_list(self) -> List[str]:
 167         store_id = self._get_pref_store_id()
 168         return self.get_shopping_list(store_id)
 169
 170     def get_shopping_list(self, store_id) -> List[str]:
 171         results = []
 172         with Session(self.engine) as session:
 173             cmd = select(Store).where(Store.id == store_id)
 174             store = session.exec(cmd).first()
 175             if not store:
 176                 return [f'Store {store_id} not found.']
 177
 178             results.append(f' ## {store.name}')
 179
 180             items = store.shopping_list
 181             if not items:
 182                 results.append(f'-- Nothing to shop for at {store.name} --')
 183             else:
 184                 for item in items:
 185                     if(item.purchase_date):
 186                         results.append(f' - [x] {item}')
 187                     else:
 188                         results.append(f' - [ ] {item}')
 189         return results
 190
 191     def remove_item(self, item_id):
 192         with Session(self.engine) as session:
 193             item = session.exec(_get_with_id(Item, item_id)).first()
 194             session.delete(item)
 195             session.commit()
 196
 197     def remove_store(self, store_id):
 198         with Session(self.engine) as session:
 199             store = session.exec(_get_with_id(Store, store_id)).first()
 200             session.delete(store)
 201             session.commit()
 202
 203     def get_engine(self):
 204         return create_engine(f"sqlite:///{self.file}")
 205
 206     def setup(self):
 207         SQLModel.metadata.create_all(self.engine)
 208         return 'Success'
 209
 210
 211
 212