itkdb-gtk 0.0.3__py3-none-any.whl → 0.20.1__py3-none-any.whl

itkdb_gtk/{sendShipments.py → CreateShipments.py}

@@ -5,31 +5,33 @@ Items can be added via a QR reader.
 """
 import pathlib
 import sys
+import re
 
 try:
-    import dbGtkUtils
-    import ITkDBlogin
-    import ITkDButils
-except ModuleNotFoundError:
-    from itkdb_gtk import dbGtkUtils, ITkDBlogin, ITkDButils
+    import itkdb_gtk
+
+except ImportError:
+    from pathlib import Path
+    cwd = Path(__file__).parent.parent
+    sys.path.append(cwd.as_posix())
+
+from itkdb_gtk import dbGtkUtils, ITkDBlogin, ITkDButils, QRScanner
 
 import gi
-import serial
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, Gio, GLib
+from gi.repository import Gtk, Gio
 
 # Check if Gtk can be open
 gtk_runs, gtk_args = Gtk.init_check()
 
 
-class SendShipments(dbGtkUtils.ITkDBWindow):
+class CreateShipments(dbGtkUtils.ITkDBWindow):
     """Create a shipment from input."""
 
-    def __init__(self, session):
+    def __init__(self, session, help_link=None):
         """Initialization.
 
         Args:
-        ----
             session: ITkDB session.
 
         """
@@ -39,7 +41,8 @@ class SendShipments(dbGtkUtils.ITkDBWindow):
         self.attachment = None
         global gtk_runs
         if gtk_runs:
-            super().__init__(session=session, title="Upload AVS Data", gtk_runs=gtk_runs)
+            super().__init__(session=session, title="Create Shipment",
+                             help_link=help_link, gtk_runs=gtk_runs)
             self.init_window()
 
     def init_window(self):
@@ -48,7 +51,7 @@ class SendShipments(dbGtkUtils.ITkDBWindow):
         self.set_border_width(10)
 
         # intercept keyboard
-        self.setup_scanner()
+        self.scanner = QRScanner.QRScanner(self.get_qrcode)
 
         # Prepare HeaderBar
         self.hb.props.title = "Create Shipment"
@@ -95,8 +98,8 @@ class SendShipments(dbGtkUtils.ITkDBWindow):
         box = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL)
         self.mainBox.pack_start(box, False, False, 0)
 
-        dbGtkUtils.add_button_to_container(box, "Add Item",
-                                           "Click to add a new item.",
+        dbGtkUtils.add_button_to_container(box, "Add Items",
+                                           "Click to add a new items.\nAdd SNs separated by\n\tnew line,\n\ttab\n\tespace or\n\tcomma.",
                                            self.add_item)
 
         dbGtkUtils.add_button_to_container(box, "Remove Item",
@@ -125,8 +128,7 @@ class SendShipments(dbGtkUtils.ITkDBWindow):
         paned.add1(tree_view)
 
         # The text view
-        frame = self.create_text_view()
-        paned.add2(frame)
+        paned.add2(self.message_panel.frame)
 
         self.show_all()
 
@@ -175,53 +177,63 @@ class SendShipments(dbGtkUtils.ITkDBWindow):
 
     def add_item(self, *args):
         """Add new item."""
-        # We will get the input either from a Dialog or from the QR reder.
+        # We will get the input either from a Dialog or from the QR reader.
         # For the later we get the SN in the argument list.
         if isinstance(args[0], Gtk.Button):
-            SN = dbGtkUtils.get_a_value("Enter item SN")
-        else:
-            SN = args[0]
-
-        try:
-            # Check that the object exists and get some information about it.
-            rc = ITkDButils.get_DB_component(self.session, SN)
-            if 'inTransit' in rc and rc['inTransit']:
-                dbGtkUtils.complain("Item {} is already in transit".format(SN),
-                                    "This item is already in transit to {}".format(rc['shipmentDestination']['code']))
+            txt = dbGtkUtils.get_a_value("Enter item SN", is_tv=True)
+            if txt is None:
                 return
-            nick = rc['alternativeIdentifier']
-            id = rc['id']
-            obj = rc['componentType']['name']
-            loc = rc['currentLocation']['code']
-
-            # Check tha tthe input is not already there
-            model = self.tree.get_model()
-            iter = model.get_iter_first()
-            while iter:
-                if model.get_value(iter, 0) == SN:
-                    dbGtkUtils.complain("Duplicated item.",
-                                        "Object {} is already in the list".format(SN))
-                    return
 
-                iter = model.iter_next(iter)
+            tmp = re.split(';|,| |\n|\t', txt)
+            SNlist = [s.strip() for s in tmp if len(s.strip())>0]
+        else:
+            SNlist = [args[0]]
 
-            # Add the item in the liststore.
-            model.append([SN, nick, obj, loc, id])
+        for SN in SNlist:
+            try:
+                # Check that the object exists and get some information about it.
+                rc = ITkDButils.get_DB_component(self.session, SN)
+                if 'inTransit' in rc and rc['inTransit']:
+                    dbGtkUtils.complain("Item {} is already in transit".format(SN),
+                                        "This item is already in transit to {}".format(rc['shipmentDestination']['code']))
+                    return
 
-        except Exception:
-            dbGtkUtils.complain("Error querying DB",
-                                "object {} does not exist.".format(SN))
-            print(ITkDButils.get_db_response())
+                nick = rc['alternativeIdentifier']
+                obj_id = rc['id']
+                obj = rc['componentType']['name']
+                loc = rc['currentLocation']['code']
+                serialN = rc['serialNumber']
+                if serialN is None:
+                    serialN = obj_id
+
+                # Check tha tthe input is not already there
+                model = self.tree.get_model()
+                lv_iter = model.get_iter_first()
+                while lv_iter:
+                    if model.get_value(lv_iter, 0) == SN:
+                        dbGtkUtils.complain("Duplicated item.",
+                                            "Object {} is already in the list".format(SN))
+                        return
+
+                    lv_iter = model.iter_next(lv_iter)
+
+                # Add the item in the liststore.
+                model.append([serialN, nick, obj, loc, obj_id])
+
+            except Exception:
+                dbGtkUtils.complain("Error querying DB",
+                                    "object {} does not exist.".format(SN))
+                print(ITkDButils.get_db_response())
 
     def remove_item(self, *args):
         """Remove selected item."""
         select = self.tree.get_selection()
-        model, iter = select.get_selected()
-        if iter:
-            values = model[iter]
+        model, lv_iter = select.get_selected()
+        if lv_iter:
+            values = model[lv_iter]
             rc = dbGtkUtils.ask_for_confirmation("Remove this items ?", values[0])
             if rc:
-                model.remove(iter)
+                model.remove(lv_iter)
 
     def add_attachment_dialog(self):
         """Create the add attachment dialog."""
@@ -274,7 +286,7 @@ class SendShipments(dbGtkUtils.ITkDBWindow):
 
             T = T if len(T) else None
             D = D if len(D) else None
-            att = ITkDButils.Attachment(path, T, D)
+            att = ITkDButils.Attachment(path=path, title=T, desc=D)
             self.attachment = att
 
         dlg.hide()
@@ -288,26 +300,8 @@ class SendShipments(dbGtkUtils.ITkDBWindow):
         else:
             self.write_message("No attachment found\n")
 
-    def setup_scanner(self):
-        """Setup scanner."""
-        for fnam in ["/dev/ttyACM0", "/dev/cu.usbmodemS_N_G19F204881"]:
-            P = pathlib.Path(fnam)
-            if P.exists():
-                rdr = serial.Serial(fnam, 9600)
-                GLib.unix_fd_add_full(GLib.PRIORITY_DEFAULT, rdr.fileno(), GLib.IOCondition.IN, self.get_qrcode, rdr)
-                break
-
-    def get_qrcode(self, fd, state, reader):
+    def get_qrcode(self, txt):
         """Gets data from QR scanner."""
-        available = reader.in_waiting
-        while True:
-            delta = reader.in_waiting - available
-            if not delta:
-                break
-
-        # Get data from serial device passed in via
-        data = reader.read_until(expected='\r', size=reader.in_waiting).strip()
-        txt = data.decode('utf-8')
         self.write_message("{}\n".format(txt))
 
         # Try to add item to the list
@@ -318,16 +312,16 @@ class SendShipments(dbGtkUtils.ITkDBWindow):
     def send_items(self, *args):
         """Send items in liststore."""
         model = self.tree.get_model()
-        iter = model.get_iter_first()
+        lv_iter = model.get_iter_first()
         items = []
         senders = {}
-        while iter:
-            values = model[iter]
+        while lv_iter:
+            values = model[lv_iter]
             items.append(values[0])
             senders[values[3]] = senders.setdefault(values[3], 0) + 1
-            iter = model.iter_next(iter)
+            lv_iter = model.iter_next(lv_iter)
 
-        if len(items):
+        if len(items)>0:
             if len(senders) != 1:
                 dbGtkUtils.complain("Too many senders.",
                                     "There are objects located in differen sites:{}".format('\n'.join(senders.keys())))
@@ -354,7 +348,7 @@ class SendShipments(dbGtkUtils.ITkDBWindow):
                 self.tree.set_model(model)
                 self.comments.set_text("")
                 self.name.set_text("")
-                self.attachments = None
+                self.attachment = None
 
         else:
             self.write_message("Empty list of items when creating shipment.")
@@ -363,6 +357,8 @@ class SendShipments(dbGtkUtils.ITkDBWindow):
 def main():
     """Main entry."""
     # main entry of the program
+    HELP_LINK="https://itkdb-gtk.docs.cern.ch"
+
     dlg = ITkDBlogin.ITkDBlogin()
     client = dlg.get_client()
     if client is None:
@@ -371,7 +367,7 @@ def main():
         sys.exit()
 
     client.user_gui = dlg
-    IS = SendShipments(client)
+    IS = CreateShipments(client, help_link="{}/createShipment.html".format(HELP_LINK))
     IS.set_accept_focus(True)
     IS.present()
     IS.connect("destroy", Gtk.main_quit)

itkdb_gtk/{getShipments.py → GetShipments.py}

@@ -1,17 +1,17 @@
 #!/usr/bin/env python3
 """GEt shipments to a particular site (default is IFIC)."""
-import pathlib
 import sys
+from pathlib import Path
 
 try:
-    import dbGtkUtils
-    import ITkDBlogin
-    import ITkDButils
-except ModuleNotFoundError:
-    from itkdb_gtk import dbGtkUtils, ITkDBlogin, ITkDButils
+    import itkdb_gtk
 
+except ImportError:
+    cwd = Path(__file__).parent.parent
+    sys.path.append(cwd.as_posix())
+
+from itkdb_gtk import dbGtkUtils, ITkDBlogin, ITkDButils, QRScanner, findVTRx
 import gi
-import serial
 
 gi.require_version("Gtk", "3.0")
 from gi.repository import Gtk, Gio, GLib
@@ -23,29 +23,32 @@ gtk_runs, gtk_args = Gtk.init_check()
 class ReceiveShipments(dbGtkUtils.ITkDBWindow):
     """Find shipments related to given recipient."""
 
-    def __init__(self, session, recipient="IFIC"):
+    def __init__(self, session, recipient=None, help_link=None):
         """Initialization.
 
         Args:
-        ----
             session: ITkDB session.
             recipient: default recipient
 
         """
-        self.recipient = recipient
         self.state = "inTransit"
         self.institute = None
         self.model = None
         self.store = None
+        self.tree = None
         self.shipments = {}
 
         global gtk_runs
         if gtk_runs:
-            super().__init__(session=session, title="Upload AVS Data",
-                             show_search="Cliick to search shipments",
-                             gtk_runs=gtk_runs)
+            super().__init__(session=session, title="Receive Shipments",
+                             show_search="Click to search shipments",
+                             gtk_runs=gtk_runs, help_link=help_link)
 
+            self.recipient = self.pdb_user["institutions"][0]["code"]
             self.init_window()
+        else:
+            pdb_user = ITkDButils.get_db_user(session)
+            self.recipient = pdb_user["institutions"][0]["code"]
 
     def init_window(self):
         """Initialize window."""
@@ -53,7 +56,7 @@ class ReceiveShipments(dbGtkUtils.ITkDBWindow):
         self.set_border_width(10)
 
         # intercept keyboard
-        self.setup_scanner()
+        self.scanner = QRScanner.QRScanner(self.get_qrcode)
 
         # Prepare HeaderBar
         self.hb.props.title = "{} shipments".format(self.recipient)
@@ -72,7 +75,7 @@ class ReceiveShipments(dbGtkUtils.ITkDBWindow):
         self.mainBox.pack_start(grid, False, True, 0)
 
         # The shipment receiver
-        receiver = self.create_institute_combo()
+        receiver = self.create_institute_combo(only_user=True)
         receiver.connect("changed", self.on_receiver)
         receiver.set_tooltip_text("Select the Institute receiving the items.")
         dbGtkUtils.set_combo_iter(receiver, self.recipient)
@@ -112,6 +115,12 @@ class ReceiveShipments(dbGtkUtils.ITkDBWindow):
         btn.connect("clicked", self.receive_items)
         grid.attach(btn, 2, 3, 1, 1)
 
+        self.check_all = Gtk.ToggleButton(label="Check A_ll", use_underline=True)
+        self.check_all.set_active(1)
+        self.check_all.set_tooltip_text("If toggled, items will need to be `received`\none by one by unchecking the  check box.")
+        grid.attach(self.check_all, 3, 3, 1, 1)
+
+
         # Add a Separator
         self.mainBox.pack_start(Gtk.Separator(orientation=Gtk.Orientation.VERTICAL), False, True, 0)
 
@@ -125,8 +134,7 @@ class ReceiveShipments(dbGtkUtils.ITkDBWindow):
         paned.add1(tree_view)
 
         # The text view
-        frame = self.create_text_view()
-        paned.add2(frame)
+        paned.add2(self.message_panel.frame)
 
         self.show_all()
 
@@ -154,55 +162,31 @@ class ReceiveShipments(dbGtkUtils.ITkDBWindow):
 
         return scrolled
 
-    def setup_scanner(self):
-        """Setup scanner."""
-        for fnam in ["/dev/ttyACM0", "/dev/cu.usbmodemS_N_G19F204881"]:
-            P = pathlib.Path(fnam)
-            if P.exists():
-                rdr = serial.Serial(fnam, 9600)
-                GLib.unix_fd_add_full(GLib.PRIORITY_DEFAULT, rdr.fileno(), GLib.IOCondition.IN, self.get_qrcode, rdr)
-                break
-
-    def get_qrcode(self, fd, state, reader):
+    def get_qrcode(self, txt):
         """Gets data from QR scanner."""
-        available = reader.in_waiting
-        while True:
-            delta = reader.in_waiting - available
-            if not delta:
-                break
-
-        # Get data from serial device passed in via
-        data = reader.read_until(expected='\r', size=reader.in_waiting).strip()
-        txt = data.decode('utf-8')
         self.write_message("{}\n".format(txt))
 
+        if findVTRx.is_vtrx(txt):
+            try:
+                txt = findVTRx.find_vtrx(self.session, txt)
+            except ValueError as e:
+                self.write_message("Error: {}\n".format(e))
+                return
+
         # search code in the list
         if self.store:
-            iter = self.store.get_iter_first()
-            while iter:
-                if (self.store.get_value(iter, 0) == txt):
-                    self.write_message("...found\n")
-                    self.store[iter][3] = False
+            lv_iter = self.store.get_iter_first()
+            while lv_iter:
+                mSN = self.store.get_value(lv_iter, 0)
+                mID = self.store.get_value(lv_iter, 5)
+                if mSN == txt or mID == txt:
+                    self.write_message("...found {}\n".format(mSN))
+                    self.store[lv_iter][3] = False
 
-                iter = self.store.iter_next(iter)
+                lv_iter = self.store.iter_next(lv_iter)
 
         return True
 
-    def get_institute_list(self):
-        """Get the institute list."""
-        sites = self.session.get("listInstitutions", json={})
-        liststore = Gtk.ListStore(str, str)
-        for site in sites:
-            self.code2inst[site['code']] = site['name']
-            self.inst2code[site['name']] = site['code']
-            liststore.append([site["code"], site["code"]])
-            liststore.append([site["name"], site["code"]])
-
-        completion = Gtk.EntryCompletion()
-        completion.set_model(liststore)
-        completion.set_text_column(0)
-        return completion
-
     def on_cell_toggled(self, widget, path):
         """A cell has been toggled."""
         model = self.tree.get_model()
@@ -223,9 +207,9 @@ class ReceiveShipments(dbGtkUtils.ITkDBWindow):
 
         # Store the model associated to this shipment.
         self.store = self.shipments[shpmnt]
-        filter = self.store.filter_new()
-        filter.set_visible_column(3)
-        self.tree.set_model(filter)
+        sfilter = self.store.filter_new()
+        sfilter.set_visible_column(3)
+        self.tree.set_model(sfilter)
 
     def on_status_changed(self, combo):
         """Status changed."""
@@ -239,30 +223,12 @@ class ReceiveShipments(dbGtkUtils.ITkDBWindow):
 
         self.state = name
 
-    def get_institute_from_combo(self, combo):
-        """Get Institute from combo."""
-        tree_iter = combo.get_active_iter()
-        if tree_iter is not None:
-            model = combo.get_model()
-            name = model[tree_iter][1]
-
-        else:
-            name = combo.get_child().get_text()
-            if name in self.inst2code:
-                name = self.inst2code[name]
-
-            elif name not in self.code2inst:
-                name = None
-
-        return name
-
     def on_receiver(self, combo):
         """Sets the recipient."""
         name = self.get_institute_from_combo(combo)
         if name:
             self.recipient = name
-            hb = self.get_titlebar()
-            hb.props.title = "{} shipments".format(self.recipient)
+            self.set_window_title("{} shipments".format(self.recipient))
 
     def on_institute(self, combo):
         """New institute chosen."""
@@ -276,12 +242,14 @@ class ReceiveShipments(dbGtkUtils.ITkDBWindow):
 
     def query_db(self, *args):
         """Query for shipments in DB."""
-        if self.institute is None or self.state == "":
+        if self.state == "":
             return
 
         payload = {
-            "code": self.recipient,
-            "status": self.state
+            "filterMap": {
+                "code": self.recipient,
+                "status": self.state
+            }
         }
         shpmts = self.session.get("listShipmentsByInstitution", json=payload)
 
@@ -290,7 +258,11 @@ class ReceiveShipments(dbGtkUtils.ITkDBWindow):
         # the tree view.
         cmb_store = Gtk.ListStore(str, str)
         for s in shpmts:
-            if s["recipient"]["code"] == self.recipient and s['sender']['code'] == self.institute:
+            valid_sender = True
+            if self.institute is not None:
+                valid_sender = s['sender']['code'] == self.institute
+
+            if s["recipient"]["code"] == self.recipient and valid_sender:
                 store = self.get_tree_view_model()
                 cmb_store.append([s['name'], s['id']])
                 items = self.session.get("listShipmentItems", json={"shipment": s["id"]})
@@ -308,35 +280,54 @@ class ReceiveShipments(dbGtkUtils.ITkDBWindow):
             self.write_message("Could not find any shipment in DB.\n")
 
         self.cmb_shipment.set_model(cmb_store)
-        self.cmb_shipment.set_entry_text_column(0)
-        self.cmb_shipment.set_active(0)
+        if len(cmb_store)>0:
+            self.cmb_shipment.set_entry_text_column(0)
+            self.cmb_shipment.set_active(0)
+        else:
+            self.cmb_shipment.set_active(-1)
+            self.cmb_shipment.get_child().set_text("")
+            self.tree.set_model(Gtk.ListStore(str, str, str, bool))
+
+    def mark_all_as_delivered(self):
+        """Mark all items in current shipment as delivered."""
+        if self.store is None:
+            return
+
+        lv_iter = self.store.get_iter_first()
+        while lv_iter:
+            val = self.store[lv_iter][3]
+            self.store[lv_iter][3] = not val
+            lv_iter = self.store.iter_next(lv_iter)
 
     def receive_items(self, *args):
         """Receive shipment items."""
         data = {}
         names = {}
+        if not self.store:
+            self.write_message("Empty list of items.\n")
+            return
+
+        if not self.check_all.get_active():
+            self.mark_all_as_delivered()
 
         # self.store is the model of the tree view
-        if self.store:
-            iter = self.store.get_iter_first()
-            while iter:
-                shpmnt = self.store.get_value(iter, 2)
-                if shpmnt not in data:
-                    data[shpmnt] = create_shipment_status(shpmnt)
-                    names[shpmnt] = self.store.get_value(iter, 4)
+        lv_iter = self.store.get_iter_first()
+        while lv_iter:
+            shpmnt = self.store.get_value(lv_iter, 2)
+            if shpmnt not in data:
+                data[shpmnt] = create_shipment_status(shpmnt)
+                names[shpmnt] = self.store.get_value(lv_iter, 4)
 
-                item = {
-                    "code": self.store[iter][5],
-                    "delivered": not self.store[iter][3]
-                }
-                data[shpmnt]["shipmentItems"].append(item)
+            item = {
+                "code": self.store[lv_iter][5],
+                "delivered": not self.store[lv_iter][3]
+            }
+            data[shpmnt]["shipmentItems"].append(item)
 
-                iter = self.store.iter_next(iter)
+            lv_iter = self.store.iter_next(lv_iter)
 
-        else:
-            self.write_message("Empty list of items.\n")
 
-        for id, S in data.items():
+        for oid, S in data.items():
             # Check that all items are there
             nlost = 0
             for item in S["shipmentItems"]:
@@ -355,7 +346,7 @@ class ReceiveShipments(dbGtkUtils.ITkDBWindow):
                     return
 
             # Open dialog to fill-in questions
-            create_check_list(S["checklist"]["questionList"], names[id])
+            create_check_list(S["checklist"]["questionList"], names[oid])
 
             # send the update to the DB
             S['status'] = "delivered"
@@ -371,10 +362,10 @@ class ReceiveShipments(dbGtkUtils.ITkDBWindow):
                 self.write_message("Could not update the shipment status.\n{}\n".foramt(rc))
 
             else:
-                self.write_message("Shipment {} received\n".format(names[id]))
+                self.write_message("Shipment {} received\n".format(names[oid]))
                 # Now remove the current shipment
-                iter = self.cmb_shipment.get_active_iter()
-                self.cmb_shipment.get_model().remove(iter)
+                lv_iter = self.cmb_shipment.get_active_iter()
+                self.cmb_shipment.get_model().remove(lv_iter)
                 self.cmb_shipment.set_active(0)
 
 
@@ -514,6 +505,8 @@ def create_shipment_status(shpmnt):
 
 def main():
     """Main entry."""
+    HELP_LINK="https://itkdb-gtk.docs.cern.ch/receiveShipments.html"
+
     dlg = ITkDBlogin.ITkDBlogin()
     client = dlg.get_client()
     if client is None:
@@ -522,7 +515,7 @@ def main():
         sys.exit()
 
     client.user_gui = dlg
-    IS = ReceiveShipments(client)
+    IS = ReceiveShipments(client, help_link=HELP_LINK)
     IS.set_accept_focus(True)
     IS.present()
     IS.connect("destroy", Gtk.main_quit)