1 from __future__ import absolute_import, print_function, unicode_literals
3 from django.conf import settings
4 from django.contrib.auth.decorators import login_required
5 from django.core.exceptions import ObjectDoesNotExist
6 from django.http import HttpResponse, HttpResponseRedirect
7 from django.shortcuts import render
8 from django.template import RequestContext, Template
9 from django.template.loader import get_template
11 from samples.changelist import HTSChangeList
12 from .models import Item, LongTermStorage, ItemType
13 from .admin import ItemAdmin, ItemTypeAdmin
14 from .bcmagic import item_search
15 from experiments.models import FlowCell
16 from bcmagic.plugin import register_search_plugin
17 from bcmagic.forms import BarcodeMagicForm
18 from bcmagic.utils import print_zpl_socket
20 register_search_plugin('Inventory Item', item_search)
24 INVENTORY_CONTEXT_DEFAULTS = {
25 'app_name': 'Inventory Tracker',
26 'bcmagic': BarcodeMagicForm()
29 def __flowcell_rundate_sort(x, y):
33 if x.run_date > y.run_date:
35 elif x.run_date == y.run_date:
40 def __expand_longtermstorage_context(context, item):
42 Expand information for LongTermStorage
48 for lts in item.longtermstorage_set.all():
49 flowcell_list.append(lts.flowcell)
50 flowcell_id_list.append(lts.flowcell.flowcell_id)
51 library_id_list.extend([ lib.id for lib in lts.libraries.all() ])
53 flowcell_list.sort(__flowcell_rundate_sort)
54 context['oldest_rundate'] = flowcell_list[0].run_date
55 context['latest_rundate'] = flowcell_list[-1].run_date
57 context['flowcell_id_list'] = flowcell_id_list
58 context['library_id_list_1_to_20'] = library_id_list[0:20]
59 context['library_id_list_21_to_40'] = library_id_list[20:40]
60 context['library_id_list_41_to_60'] = library_id_list[40:60]
61 context['library_id_list_61_to_80'] = library_id_list[60:80]
65 'Hard Drive': __expand_longtermstorage_context
68 #INVENTORY_ITEM_PRINT_DEFAULTS = {
69 # 'Hard Drive': 'inventory/hard_drive_shell.zpl',
70 # 'default': 'inventory/default.zpl',
71 # 'host': settings.BCPRINTER_PRINTER1_HOST
74 def getPrinterTemplateByType(item_type):
76 returns template to use given item_type
78 assert item_type.printertemplate_set.count() < 2
80 # Get the template for item_type
81 if item_type.printertemplate_set.count() > 0:
82 printer_template = item_type.printertemplate_set.all()[0]
83 return printer_template
87 printer_template = PrinterTemplate.objects.get(default=True)
88 except ObjectDoesNotExist:
89 msg = "No template for item type (%s) and no default template found" % (item_type.name)
92 return printer_template
96 def data_items(request):
98 Returns items in json format
100 item_list = Item.objects.all()
101 d = { 'results': len(item_list) }
104 for item in item_list:
106 item_d['uuid'] = item.uuid
107 item_d['barcode_id'] = item.barcode_id
108 item_d['model_id'] = item.item_info.model_id
109 item_d['part_number'] = item.item_info.part_number
110 item_d['lot_number'] = item.item_info.lot_number
111 item_d['vendor'] = item.item_info.vendor.name
112 item_d['creation_date'] = item.creation_date.strftime('%Y-%m-%d %H:%M:%S')
113 item_d['modified_date'] = item.modified_date.strftime('%Y-%m-%d %H:%M:%S')
114 item_d['location'] = item.location.name
116 # Item status if exists
117 if item.status is None:
118 item_d['status'] = ''
120 item_d['status'] = item.status.name
122 # Stored flowcells on device
123 if item.longtermstorage_set.count() > 0:
124 item_d['flowcells'] = ','.join([ lts.flowcell.flowcell_id for lts in item.longtermstorage_set.all() ])
126 item_d['flowcells'] = ''
128 item_d['type'] = item.item_type.name
133 return HttpResponse(json.dumps(d), content_type="application/javascript")
136 def all_index(request):
141 item_changelist = HTSChangeList(request, Item,
145 model_admin=ItemAdmin(Item, None)
149 'item_changelist': item_changelist,
150 'page_name': 'Inventory Index'
152 context_dict.update(INVENTORY_CONTEXT_DEFAULTS)
154 return render(request,
155 'inventory/inventory_all_index.html',
164 item_changelist = HTSChangeList(request, ItemType,
166 search_fields=['name', 'description'],
168 model_admin=ItemTypeAdmin(ItemType, None)
172 'item_changelist': item_changelist,
173 'page_name': 'Inventory Index'
175 context_dict.update(INVENTORY_CONTEXT_DEFAULTS)
176 return render(request,
177 'inventory/inventory_index.html',
181 def itemtype_index(request, name):
186 name = name.replace('%20', ' ')
188 itemtype = ItemType.objects.get(name=name)
191 item_changelist = HTSChangeList(request, Item,
195 model_admin=ItemAdmin(Item, None)
199 'item_changelist': item_changelist,
200 'page_name': 'Inventory Index'
202 context_dict.update(INVENTORY_CONTEXT_DEFAULTS)
204 return render(request,
205 'inventory/inventory_itemtype_index.html',
210 def item_summary_by_barcode(request, barcode_id, msg=''):
212 Display a summary for an item by barcode
215 item = Item.objects.get(barcode_id=barcode_id)
216 except ObjectDoesNotExist as e:
219 return item_summary_by_uuid(request, None, msg, item)
223 def item_summary_by_uuid(request, uuid, msg='', item=None):
225 Display a summary for an item
227 # Use item instead of looking it up if it is passed.
230 item = Item.objects.get(uuid=uuid)
231 except ObjectDoesNotExist as e:
235 'page_name': 'Item Summary',
240 context_dict.update(INVENTORY_CONTEXT_DEFAULTS)
242 return render(request,
243 'inventory/inventory_summary.html',
247 def __expand_context(context, item):
249 If EXPAND_CONTEXT dictionary has item.item_type.name function registered, use it to expand context
251 if item.item_type.name in EXPAND_CONTEXT:
252 expand_func = EXPAND_CONTEXT[item.item_type.name]
253 expand_func(context, item)
255 def _item_print(item, request):
257 Prints an item given a type of item label to print
259 #FIXME: Hard coding this for now... need to abstract later.
260 context = {'item': item}
261 __expand_context(context, item)
263 # Print using barcode_id
264 if not item.force_use_uuid and (item.barcode_id is None or len(item.barcode_id.strip())):
265 context['use_uuid'] = False
266 msg = 'Printing item with barcode id: %s' % (item.barcode_id)
269 context['use_uuid'] = True
270 msg = 'Printing item with UUID: %s' % (item.uuid)
272 printer_template = getPrinterTemplateByType(item.item_type)
274 c = RequestContext(request, context)
275 t = Template(printer_template.template)
276 print_zpl_socket(t.render(c), host=printer_template.printer.ip_address)
281 def item_print(request, uuid):
283 Print a label for a given item
286 item = Item.objects.get(uuid=uuid)
287 except ObjectDoesNotExist as e:
289 msg = "Item with UUID %s does not exist" % (uuid)
292 msg = _item_print(item, request)
294 return item_summary_by_uuid(request, uuid, msg)
297 def link_flowcell_and_device(request, flowcell, serial):
299 Updates database records of a flowcell being archived on a device with a particular serial #
301 assert flowcell is not None
302 assert serial is not None
306 LIBRARY_UPDATED = False
308 ###########################################
309 # Retrieve Storage Device
311 sd = Item.objects.get(barcode_id=serial)
312 except ObjectDoesNotExist as e:
313 msg = "Item with barcode_id of %s not found." % (serial)
314 raise ObjectDoesNotExist(msg)
316 ###########################################
319 fc = FlowCell.objects.get(flowcell_id__startswith=flowcell)
320 except ObjectDoesNotExist as e:
321 msg = "FlowCell with flowcell_id of %s not found." % (flowcell)
322 raise ObjectDoesNotExist(msg)
324 ###########################################
325 # Retrieve or create LongTermStorage Object
326 count = fc.longtermstorage_set.count()
329 msg = "There really should only be one longtermstorage object per flowcell"
330 raise ValueError(msg)
332 # lts already attached to flowcell
333 lts = fc.longtermstorage_set.all()[0]
335 lts = LongTermStorage()
338 # Need a primary keey before linking to storage devices
343 ############################################
344 # Link Storage to Flowcell
346 # Add a link to this storage device if it is not already linked.
347 if sd not in lts.storage_devices.all():
348 lts.storage_devices.add(sd)
351 ###########################################
352 # Add Library Links to LTS
354 for lane in fc.lane_set.all():
355 if lane.library not in lts.libraries.all():
356 lts.libraries.add(lane.library)
357 LIBRARY_UPDATED = True
363 if LTS_UPDATED or SD_UPDATED or LIBRARY_UPDATED:
364 msg.append(' LongTermStorage (LTS) Created: %s' % (LTS_UPDATED))
365 msg.append(' Storage Device Linked to LTS: %s' % (SD_UPDATED))
366 msg.append(' Libraries updated in LTS: %s' % (LIBRARY_UPDATED))
368 msg.append(' No Updates Needed.')
370 return HttpResponse('\n'.join(msg))