htsworkflow/frontend/inventory/views.py

   1 from htsworkflow.frontend.samples.changelist import HTSChangeList
   2 from htsworkflow.frontend.inventory.models import Item, LongTermStorage, ItemType
   3 from htsworkflow.frontend.inventory.admin import ItemAdmin, ItemTypeAdmin
   4 from htsworkflow.frontend.inventory.bcmagic import item_search
   5 from htsworkflow.frontend.bcmagic.plugin import register_search_plugin
   6 from htsworkflow.frontend.experiments.models import FlowCell
   7 from htsworkflow.frontend.bcmagic.forms import BarcodeMagicForm
   8 from htsworkflow.frontend.bcmagic.utils import print_zpl_socket
   9
  10 from django.conf import settings
  11 from django.contrib.auth.decorators import login_required
  12 from django.core.exceptions import ObjectDoesNotExist
  13 from django.http import HttpResponse, HttpResponseRedirect
  14 from django.shortcuts import render_to_response
  15 from django.template import RequestContext, Template
  16 from django.template.loader import get_template
  17
  18 register_search_plugin('Inventory Item', item_search)
  19
  20 try:
  21     import json
  22 except ImportError as e:
  23     import simplejson as json
  24
  25 INVENTORY_CONTEXT_DEFAULTS = {
  26     'app_name': 'Inventory Tracker',
  27     'bcmagic': BarcodeMagicForm()
  28 }
  29
  30 def __flowcell_rundate_sort(x, y):
  31     """
  32     Sort by rundate
  33     """
  34     if x.run_date > y.run_date:
  35         return 1
  36     elif x.run_date == y.run_date:
  37         return 0
  38     else:
  39         return -1
  40
  41 def __expand_longtermstorage_context(context, item):
  42     """
  43     Expand information for LongTermStorage
  44     """
  45     flowcell_list = []
  46     flowcell_id_list = []
  47     library_id_list = []
  48
  49     for lts in item.longtermstorage_set.all():
  50         flowcell_list.append(lts.flowcell)
  51         flowcell_id_list.append(lts.flowcell.flowcell_id)
  52         library_id_list.extend([ lib.id for lib in lts.libraries.all() ])
  53
  54     flowcell_list.sort(__flowcell_rundate_sort)
  55     context['oldest_rundate'] = flowcell_list[0].run_date
  56     context['latest_rundate'] = flowcell_list[-1].run_date
  57
  58     context['flowcell_id_list'] = flowcell_id_list
  59     context['library_id_list_1_to_20'] = library_id_list[0:20]
  60     context['library_id_list_21_to_40'] = library_id_list[20:40]
  61     context['library_id_list_41_to_60'] = library_id_list[40:60]
  62     context['library_id_list_61_to_80'] = library_id_list[60:80]
  63
  64
  65 EXPAND_CONTEXT = {
  66     'Hard Drive': __expand_longtermstorage_context
  67 }
  68
  69 #INVENTORY_ITEM_PRINT_DEFAULTS = {
  70 #    'Hard Drive': 'inventory/hard_drive_shell.zpl',
  71 #    'default': 'inventory/default.zpl',
  72 #    'host': settings.BCPRINTER_PRINTER1_HOST
  73 #}
  74
  75 def getPrinterTemplateByType(item_type):
  76     """
  77     returns template to use given item_type
  78     """
  79     assert item_type.printertemplate_set.count() < 2
  80
  81     # Get the template for item_type
  82     if item_type.printertemplate_set.count() > 0:
  83         printer_template = item_type.printertemplate_set.all()[0]
  84         return printer_template
  85     # Get default
  86     else:
  87         try:
  88             printer_template = PrinterTemplate.objects.get(default=True)
  89         except ObjectDoesNotExist:
  90             msg = "No template for item type (%s) and no default template found" % (item_type.name)
  91             raise ValueError(msg)
  92
  93         return printer_template
  94
  95
  96 @login_required
  97 def data_items(request):
  98     """
  99     Returns items in json format
 100     """
 101     item_list = Item.objects.all()
 102     d = { 'results': len(item_list) }
 103     rows = []
 104
 105     for item in item_list:
 106         item_d = {}
 107         item_d['uuid'] = item.uuid
 108         item_d['barcode_id'] = item.barcode_id
 109         item_d['model_id'] = item.item_info.model_id
 110         item_d['part_number'] = item.item_info.part_number
 111         item_d['lot_number'] = item.item_info.lot_number
 112         item_d['vendor'] = item.item_info.vendor.name
 113         item_d['creation_date'] = item.creation_date.strftime('%Y-%m-%d %H:%M:%S')
 114         item_d['modified_date'] = item.modified_date.strftime('%Y-%m-%d %H:%M:%S')
 115         item_d['location'] = item.location.name
 116
 117         # Item status if exists
 118         if item.status is None:
 119             item_d['status'] = ''
 120         else:
 121             item_d['status'] = item.status.name
 122
 123         # Stored flowcells on device
 124         if item.longtermstorage_set.count() > 0:
 125             item_d['flowcells'] = ','.join([ lts.flowcell.flowcell_id for lts in item.longtermstorage_set.all() ])
 126         else:
 127             item_d['flowcells'] = ''
 128
 129         item_d['type'] = item.item_type.name
 130         rows.append(item_d)
 131
 132     d['rows'] = rows
 133
 134     return HttpResponse(json.dumps(d), content_type="application/javascript")
 135
 136 @login_required
 137 def all_index(request):
 138     """
 139     Inventory Index View
 140     """
 141     # build changelist
 142     item_changelist = HTSChangeList(request, Item,
 143         list_filter=[],
 144         search_fields=[],
 145         list_per_page=200,
 146         model_admin=ItemAdmin(Item, None)
 147     )
 148
 149     context_dict = {
 150         'item_changelist': item_changelist,
 151         'page_name': 'Inventory Index'
 152     }
 153     context_dict.update(INVENTORY_CONTEXT_DEFAULTS)
 154
 155     return render_to_response('inventory/inventory_all_index.html',
 156                               context_dict,
 157                               context_instance=RequestContext(request))
 158
 159 @login_required
 160 def index(request):
 161     """
 162     Inventory Index View
 163     """
 164     # build changelist
 165     item_changelist = HTSChangeList(request, ItemType,
 166         list_filter=[],
 167         search_fields=['name', 'description'],
 168         list_per_page=50,
 169         model_admin=ItemTypeAdmin(ItemType, None)
 170     )
 171
 172     context_dict = {
 173         'item_changelist': item_changelist,
 174         'page_name': 'Inventory Index'
 175     }
 176     context_dict.update(INVENTORY_CONTEXT_DEFAULTS)
 177     return render_to_response('inventory/inventory_index.html',
 178                               context_dict,
 179                               context_instance=RequestContext(request))
 180
 181 @login_required
 182 def itemtype_index(request, name):
 183     """
 184     Inventory Index View
 185     """
 186
 187     name = name.replace('%20', ' ')
 188
 189     itemtype = ItemType.objects.get(name=name)
 190
 191     # build changelist
 192     item_changelist = HTSChangeList(request, Item,
 193         list_filter=[],
 194         search_fields=[],
 195         list_per_page=200,
 196         model_admin=ItemAdmin(Item, None)
 197     )
 198
 199     context_dict = {
 200         'item_changelist': item_changelist,
 201         'page_name': 'Inventory Index'
 202     }
 203     context_dict.update(INVENTORY_CONTEXT_DEFAULTS)
 204
 205     return render_to_response('inventory/inventory_itemtype_index.html',
 206                               context_dict,
 207                               context_instance=RequestContext(request))
 208
 209
 210 @login_required
 211 def item_summary_by_barcode(request, barcode_id, msg=''):
 212     """
 213     Display a summary for an item by barcode
 214     """
 215     try:
 216         item = Item.objects.get(barcode_id=barcode_id)
 217     except ObjectDoesNotExist as e:
 218         item = None
 219
 220     return item_summary_by_uuid(request, None, msg, item)
 221
 222
 223 @login_required
 224 def item_summary_by_uuid(request, uuid, msg='', item=None):
 225     """
 226     Display a summary for an item
 227     """
 228     # Use item instead of looking it up if it is passed.
 229     if item is None:
 230         try:
 231             item = Item.objects.get(uuid=uuid)
 232         except ObjectDoesNotExist as e:
 233             item = None
 234
 235     context_dict = {
 236         'page_name': 'Item Summary',
 237         'item': item,
 238         'uuid': uuid,
 239         'msg': msg
 240     }
 241     context_dict.update(INVENTORY_CONTEXT_DEFAULTS)
 242
 243     return render_to_response('inventory/inventory_summary.html',
 244                               context_dict,
 245                               context_instance=RequestContext(request))
 246
 247
 248
 249
 250
 251
 252 def __expand_context(context, item):
 253     """
 254     If EXPAND_CONTEXT dictionary has item.item_type.name function registered, use it to expand context
 255     """
 256     if item.item_type.name in EXPAND_CONTEXT:
 257         expand_func = EXPAND_CONTEXT[item.item_type.name]
 258         expand_func(context, item)
 259
 260 def _item_print(item, request):
 261     """
 262     Prints an item given a type of item label to print
 263     """
 264     #FIXME: Hard coding this for now... need to abstract later.
 265     context = {'item': item}
 266     __expand_context(context, item)
 267
 268     # Print using barcode_id
 269     if not item.force_use_uuid and (item.barcode_id is None or len(item.barcode_id.strip())):
 270         context['use_uuid'] = False
 271         msg = 'Printing item with barcode id: %s' % (item.barcode_id)
 272     # Print using uuid
 273     else:
 274         context['use_uuid'] = True
 275         msg = 'Printing item with UUID: %s' % (item.uuid)
 276
 277     printer_template = getPrinterTemplateByType(item.item_type)
 278
 279     c = RequestContext(request, context)
 280     t = Template(printer_template.template)
 281     print_zpl_socket(t.render(c), host=printer_template.printer.ip_address)
 282
 283     return msg
 284
 285 @login_required
 286 def item_print(request, uuid):
 287     """
 288     Print a label for a given item
 289     """
 290     try:
 291         item = Item.objects.get(uuid=uuid)
 292     except ObjectDoesNotExist as e:
 293         item = None
 294         msg = "Item with UUID %s does not exist" % (uuid)
 295
 296     if item is not None:
 297         msg = _item_print(item, request)
 298
 299     return item_summary_by_uuid(request, uuid, msg)
 300
 301
 302 def link_flowcell_and_device(request, flowcell, serial):
 303     """
 304     Updates database records of a flowcell being archived on a device with a particular serial #
 305     """
 306     assert flowcell is not None
 307     assert serial is not None
 308
 309     LTS_UPDATED = False
 310     SD_UPDATED = False
 311     LIBRARY_UPDATED = False
 312
 313     ###########################################
 314     # Retrieve Storage Device
 315     try:
 316         sd = Item.objects.get(barcode_id=serial)
 317     except ObjectDoesNotExist as e:
 318         msg = "Item with barcode_id of %s not found." % (serial)
 319         raise ObjectDoesNotExist(msg)
 320
 321     ###########################################
 322     # Retrieve FlowCell
 323     try:
 324         fc = FlowCell.objects.get(flowcell_id__startswith=flowcell)
 325     except ObjectDoesNotExist as e:
 326         msg = "FlowCell with flowcell_id of %s not found." % (flowcell)
 327         raise ObjectDoesNotExist(msg)
 328
 329     ###########################################
 330     # Retrieve or create LongTermStorage Object
 331     count = fc.longtermstorage_set.count()
 332     lts = None
 333     if count > 1:
 334         msg = "There really should only be one longtermstorage object per flowcell"
 335         raise ValueError(msg)
 336     elif count == 1:
 337         # lts already attached to flowcell
 338         lts = fc.longtermstorage_set.all()[0]
 339     else:
 340         lts = LongTermStorage()
 341         # Attach flowcell
 342         lts.flowcell = fc
 343         # Need a primary keey before linking to storage devices
 344         lts.save()
 345         LTS_UPDATED = True
 346
 347
 348     ############################################
 349     # Link Storage to Flowcell
 350
 351     # Add a link to this storage device if it is not already linked.
 352     if sd not in lts.storage_devices.all():
 353         lts.storage_devices.add(sd)
 354         SD_UPDATED = True
 355
 356     ###########################################
 357     # Add Library Links to LTS
 358
 359     for lane in fc.lane_set.all():
 360         if lane.library not in lts.libraries.all():
 361             lts.libraries.add(lane.library)
 362             LIBRARY_UPDATED = True
 363
 364     # Save Changes
 365     lts.save()
 366
 367     msg = ['Success:']
 368     if LTS_UPDATED or SD_UPDATED or LIBRARY_UPDATED:
 369         msg.append('  LongTermStorage (LTS) Created: %s' % (LTS_UPDATED))
 370         msg.append('   Storage Device Linked to LTS: %s' % (SD_UPDATED))
 371         msg.append('       Libraries updated in LTS: %s' % (LIBRARY_UPDATED))
 372     else:
 373         msg.append('  No Updates Needed.')
 374
 375     return HttpResponse('\n'.join(msg))