1002 lines
39 KiB
Python
1002 lines
39 KiB
Python
# -*- coding: utf-8; -*-
|
|
################################################################################
|
|
#
|
|
# Rattail -- Retail Software Framework
|
|
# Copyright © 2010-2018 Lance Edgar
|
|
#
|
|
# This file is part of Rattail.
|
|
#
|
|
# Rattail is free software: you can redistribute it and/or modify it under the
|
|
# terms of the GNU General Public License as published by the Free Software
|
|
# Foundation, either version 3 of the License, or (at your option) any later
|
|
# version.
|
|
#
|
|
# Rattail is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
|
# details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License along with
|
|
# Rattail. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
################################################################################
|
|
"""
|
|
Product Views
|
|
"""
|
|
|
|
from __future__ import unicode_literals, absolute_import
|
|
|
|
import re
|
|
|
|
import six
|
|
import sqlalchemy as sa
|
|
from sqlalchemy import orm
|
|
|
|
from rattail import enum, pod, sil
|
|
from rattail.db import model, api, auth, Session as RattailSession
|
|
from rattail.gpc import GPC
|
|
from rattail.threads import Thread
|
|
from rattail.exceptions import LabelPrintingError
|
|
from rattail.util import load_object, pretty_quantity
|
|
from rattail.batch import get_batch_handler
|
|
|
|
import colander
|
|
from deform import widget as dfwidget
|
|
from pyramid import httpexceptions
|
|
from webhelpers2.html import tags, HTML
|
|
|
|
from tailbone import forms, grids
|
|
from tailbone.db import Session
|
|
from tailbone.views import MasterView, AutocompleteView
|
|
from tailbone.progress import SessionProgress
|
|
from tailbone.util import raw_datetime
|
|
|
|
|
|
# TODO: For a moment I thought this was going to be necessary, but now I think
|
|
# not. Leaving it around for a bit just in case...
|
|
|
|
# class VendorAnyFilter(grids.filters.AlchemyStringFilter):
|
|
# """
|
|
# Custom filter for "vendor (any)" so we can avoid joining on that unless we
|
|
# really have to. This is because it seems to throw off the number of
|
|
# records which are showed in the result set, when this filter is included in
|
|
# the active set but no criteria is specified.
|
|
# """
|
|
|
|
# def filter(self, query, **kwargs):
|
|
# original = query
|
|
# query = super(VendorAnyFilter, self).filter(query, **kwargs)
|
|
# if query is not original:
|
|
# query = self.joiner(query)
|
|
# return query
|
|
|
|
|
|
class ProductsView(MasterView):
|
|
"""
|
|
Master view for the Product class.
|
|
"""
|
|
model_class = model.Product
|
|
supports_mobile = True
|
|
has_versions = True
|
|
|
|
labels = {
|
|
'status_code': "Status",
|
|
}
|
|
|
|
grid_columns = [
|
|
'upc',
|
|
'brand',
|
|
'description',
|
|
'size',
|
|
'department',
|
|
'vendor',
|
|
'cost',
|
|
'regular_price',
|
|
'current_price',
|
|
]
|
|
|
|
form_fields = [
|
|
'upc',
|
|
'brand',
|
|
'description',
|
|
'unit_size',
|
|
'unit_of_measure',
|
|
'size',
|
|
'packs',
|
|
'pack_size',
|
|
'unit',
|
|
'default_pack',
|
|
'case_size',
|
|
'weighed',
|
|
'department',
|
|
'subdepartment',
|
|
'category',
|
|
'family',
|
|
'report_code',
|
|
'regular_price',
|
|
'current_price',
|
|
'current_price_ends',
|
|
'deposit_link',
|
|
'tax',
|
|
'organic',
|
|
'kosher',
|
|
'vegan',
|
|
'vegetarian',
|
|
'gluten_free',
|
|
'sugar_free',
|
|
'discountable',
|
|
'special_order',
|
|
'not_for_sale',
|
|
'ingredients',
|
|
'notes',
|
|
'status_code',
|
|
'discontinued',
|
|
'deleted',
|
|
'last_sold',
|
|
'inventory_on_hand',
|
|
'inventory_on_order',
|
|
]
|
|
|
|
mobile_form_fields = form_fields
|
|
|
|
# These aliases enable the grid queries to filter products which may be
|
|
# purchased from *any* vendor, and yet sort by only the "preferred" vendor
|
|
# (since that's what shows up in the grid column).
|
|
ProductCostAny = orm.aliased(model.ProductCost)
|
|
VendorAny = orm.aliased(model.Vendor)
|
|
|
|
# same, but for prices
|
|
RegularPrice = orm.aliased(model.ProductPrice)
|
|
CurrentPrice = orm.aliased(model.ProductPrice)
|
|
|
|
def __init__(self, request):
|
|
super(ProductsView, self).__init__(request)
|
|
self.print_labels = request.rattail_config.getbool('tailbone', 'products.print_labels', default=False)
|
|
|
|
def query(self, session):
|
|
user = self.request.user
|
|
if user and user not in session:
|
|
user = session.merge(user)
|
|
|
|
query = session.query(model.Product)
|
|
# TODO: was this old `has_permission()` call here for a reason..? hope not..
|
|
# if not auth.has_permission(session, user, 'products.view_deleted'):
|
|
if not self.request.has_perm('products.view_deleted'):
|
|
query = query.filter(model.Product.deleted == False)
|
|
|
|
# TODO: This used to be a good idea I thought...but in dev it didn't
|
|
# seem to make much difference, except with a larger (50K) data set it
|
|
# totally bogged things down instead of helping...
|
|
# query = query\
|
|
# .options(orm.joinedload(model.Product.brand))\
|
|
# .options(orm.joinedload(model.Product.department))\
|
|
# .options(orm.joinedload(model.Product.subdepartment))\
|
|
# .options(orm.joinedload(model.Product.regular_price))\
|
|
# .options(orm.joinedload(model.Product.current_price))\
|
|
# .options(orm.joinedload(model.Product.vendor))
|
|
|
|
query = query.outerjoin(model.ProductInventory)
|
|
|
|
return query
|
|
|
|
def configure_grid(self, g):
|
|
super(ProductsView, self).configure_grid(g)
|
|
|
|
def join_vendor(q):
|
|
return q.outerjoin(model.ProductCost,
|
|
sa.and_(
|
|
model.ProductCost.product_uuid == model.Product.uuid,
|
|
model.ProductCost.preference == 1))\
|
|
.outerjoin(model.Vendor)
|
|
|
|
def join_vendor_any(q):
|
|
return q.outerjoin(self.ProductCostAny,
|
|
self.ProductCostAny.product_uuid == model.Product.uuid)\
|
|
.outerjoin(self.VendorAny,
|
|
self.VendorAny.uuid == self.ProductCostAny.vendor_uuid)
|
|
|
|
ProductCostCode = orm.aliased(model.ProductCost)
|
|
ProductCostCodeAny = orm.aliased(model.ProductCost)
|
|
|
|
def join_vendor_code(q):
|
|
return q.outerjoin(ProductCostCode,
|
|
sa.and_(
|
|
ProductCostCode.product_uuid == model.Product.uuid,
|
|
ProductCostCode.preference == 1))
|
|
|
|
def join_vendor_code_any(q):
|
|
return q.outerjoin(ProductCostCodeAny,
|
|
ProductCostCodeAny.product_uuid == model.Product.uuid)
|
|
|
|
g.joiners['brand'] = lambda q: q.outerjoin(model.Brand)
|
|
g.joiners['department'] = lambda q: q.outerjoin(model.Department,
|
|
model.Department.uuid == model.Product.department_uuid)
|
|
g.joiners['subdepartment'] = lambda q: q.outerjoin(model.Subdepartment,
|
|
model.Subdepartment.uuid == model.Product.subdepartment_uuid)
|
|
g.joiners['code'] = lambda q: q.outerjoin(model.ProductCode)
|
|
g.joiners['vendor'] = join_vendor
|
|
g.joiners['vendor_any'] = join_vendor_any
|
|
g.joiners['vendor_code'] = join_vendor_code
|
|
g.joiners['vendor_code_any'] = join_vendor_code_any
|
|
|
|
g.sorters['brand'] = g.make_sorter(model.Brand.name)
|
|
g.sorters['department'] = g.make_sorter(model.Department.name)
|
|
g.sorters['subdepartment'] = g.make_sorter(model.Subdepartment.name)
|
|
g.sorters['vendor'] = g.make_sorter(model.Vendor.name)
|
|
|
|
# on_hand
|
|
g.set_sorter('on_hand', model.ProductInventory.on_hand)
|
|
g.set_filter('on_hand', model.ProductInventory.on_hand)
|
|
|
|
# on_order
|
|
g.set_sorter('on_order', model.ProductInventory.on_order)
|
|
g.set_filter('on_order', model.ProductInventory.on_order)
|
|
|
|
g.filters['upc'].default_active = True
|
|
g.filters['upc'].default_verb = 'equal'
|
|
g.filters['description'].default_active = True
|
|
g.filters['description'].default_verb = 'contains'
|
|
g.filters['brand'] = g.make_filter('brand', model.Brand.name,
|
|
default_active=True, default_verb='contains')
|
|
g.filters['department'] = g.make_filter('department', model.Department.name,
|
|
default_active=True, default_verb='contains')
|
|
g.filters['subdepartment'] = g.make_filter('subdepartment', model.Subdepartment.name)
|
|
g.filters['code'] = g.make_filter('code', model.ProductCode.code)
|
|
g.filters['vendor'] = g.make_filter('vendor', model.Vendor.name)
|
|
g.filters['vendor_any'] = g.make_filter('vendor_any', self.VendorAny.name)
|
|
# factory=VendorAnyFilter, joiner=join_vendor_any)
|
|
g.filters['vendor_code'] = g.make_filter('vendor_code', ProductCostCode.code)
|
|
g.filters['vendor_code_any'] = g.make_filter('vendor_code_any', ProductCostCodeAny.code)
|
|
|
|
# category
|
|
g.set_joiner('category', lambda q: q.outerjoin(model.Category))
|
|
g.set_filter('category', model.Category.name)
|
|
|
|
# family
|
|
g.set_joiner('family', lambda q: q.outerjoin(model.Family))
|
|
g.set_filter('family', model.Family.name)
|
|
|
|
g.set_label('regular_price', "Reg. Price")
|
|
g.set_joiner('regular_price', lambda q: q.outerjoin(
|
|
self.RegularPrice, self.RegularPrice.uuid == model.Product.regular_price_uuid))
|
|
g.set_sorter('regular_price', self.RegularPrice.price)
|
|
g.set_filter('regular_price', self.RegularPrice.price, label="Regular Price")
|
|
|
|
g.set_label('current_price', "Cur. Price")
|
|
g.set_joiner('current_price', lambda q: q.outerjoin(
|
|
self.CurrentPrice, self.CurrentPrice.uuid == model.Product.current_price_uuid))
|
|
g.set_sorter('current_price', self.CurrentPrice.price)
|
|
g.set_filter('current_price', self.CurrentPrice.price, label="Current Price")
|
|
|
|
# (unit) cost
|
|
g.set_joiner('cost', lambda q: q.outerjoin(model.ProductCost,
|
|
sa.and_(
|
|
model.ProductCost.product_uuid == model.Product.uuid,
|
|
model.ProductCost.preference == 1)))
|
|
g.set_sorter('cost', model.ProductCost.unit_cost)
|
|
g.set_filter('cost', model.ProductCost.unit_cost)
|
|
g.set_renderer('cost', self.render_cost)
|
|
g.set_label('cost', "Unit Cost")
|
|
|
|
# report_code_name
|
|
g.set_joiner('report_code_name', lambda q: q.outerjoin(model.ReportCode))
|
|
g.set_filter('report_code_name', model.ReportCode.name)
|
|
|
|
g.set_sort_defaults('upc')
|
|
|
|
if self.print_labels and self.request.has_perm('products.print_labels'):
|
|
g.more_actions.append(grids.GridAction('print_label', icon='print'))
|
|
|
|
g.set_type('upc', 'gpc')
|
|
|
|
g.set_renderer('regular_price', self.render_price)
|
|
g.set_renderer('current_price', self.render_price)
|
|
g.set_renderer('on_hand', self.render_on_hand)
|
|
g.set_renderer('on_order', self.render_on_order)
|
|
|
|
g.set_link('upc')
|
|
g.set_link('item_id')
|
|
g.set_link('description')
|
|
|
|
g.set_label('upc', "UPC")
|
|
g.set_label('vendor', "Vendor (preferred)")
|
|
g.set_label('vendor_any', "Vendor (any)")
|
|
g.set_label('vendor', "Pref. Vendor")
|
|
|
|
def render_price(self, product, column):
|
|
price = product[column]
|
|
if price:
|
|
if not product.not_for_sale:
|
|
if price.price is not None and price.pack_price is not None:
|
|
if price.multiple > 1:
|
|
return HTML("$ {:0.2f} / {} ($ {:0.2f} / {})".format(
|
|
price.price, price.multiple,
|
|
price.pack_price, price.pack_multiple))
|
|
return HTML("$ {:0.2f} ($ {:0.2f} / {})".format(
|
|
price.price, price.pack_price, price.pack_multiple))
|
|
if price.price is not None:
|
|
if price.multiple > 1:
|
|
return "$ {:0.2f} / {}".format(price.price, price.multiple)
|
|
return "$ {:0.2f}".format(price.price)
|
|
if price.pack_price is not None:
|
|
return "$ {:0.2f} / {}".format(price.pack_price, price.pack_multiple)
|
|
return ""
|
|
|
|
def render_cost(self, product, column):
|
|
cost = product.cost
|
|
if not cost:
|
|
return ""
|
|
if cost.unit_cost is None:
|
|
return ""
|
|
return "${:0.2f}".format(cost.unit_cost)
|
|
|
|
def render_on_hand(self, product, column):
|
|
inventory = product.inventory
|
|
if not inventory:
|
|
return ""
|
|
return pretty_quantity(inventory.on_hand)
|
|
|
|
def render_on_order(self, product, column):
|
|
inventory = product.inventory
|
|
if not inventory:
|
|
return ""
|
|
return pretty_quantity(inventory.on_order)
|
|
|
|
def template_kwargs_index(self, **kwargs):
|
|
if self.print_labels:
|
|
kwargs['label_profiles'] = Session.query(model.LabelProfile)\
|
|
.filter(model.LabelProfile.visible == True)\
|
|
.order_by(model.LabelProfile.ordinal)\
|
|
.all()
|
|
return kwargs
|
|
|
|
|
|
def grid_extra_class(self, product, i):
|
|
classes = []
|
|
if product.not_for_sale:
|
|
classes.append('not-for-sale')
|
|
if product.deleted:
|
|
classes.append('deleted')
|
|
if classes:
|
|
return ' '.join(classes)
|
|
|
|
def get_instance(self):
|
|
key = self.request.matchdict['uuid']
|
|
product = Session.query(model.Product).get(key)
|
|
if product:
|
|
return product
|
|
price = Session.query(model.ProductPrice).get(key)
|
|
if price:
|
|
return price.product
|
|
raise httpexceptions.HTTPNotFound()
|
|
|
|
def configure_form(self, f):
|
|
super(ProductsView, self).configure_form(f)
|
|
product = f.model_instance
|
|
|
|
# upc
|
|
f.set_type('upc', 'gpc')
|
|
f.set_label('upc', "UPC")
|
|
|
|
# department
|
|
if self.creating or self.editing:
|
|
if 'department' in f.fields:
|
|
f.replace('department', 'department_uuid')
|
|
departments = self.Session.query(model.Department)\
|
|
.order_by(model.Department.number)
|
|
dept_values = [(d.uuid, "{} {}".format(d.number, d.name))
|
|
for d in departments]
|
|
require_department = False
|
|
if not require_department:
|
|
dept_values.insert(0, ('', "(none)"))
|
|
f.set_widget('department_uuid', dfwidget.SelectWidget(values=dept_values))
|
|
f.set_label('department_uuid', "Department")
|
|
else:
|
|
f.set_readonly('department')
|
|
f.set_renderer('department', self.render_department)
|
|
|
|
# subdepartment
|
|
if self.creating or self.editing:
|
|
if 'subdepartment' in f.fields:
|
|
f.replace('subdepartment', 'subdepartment_uuid')
|
|
subdepartments = self.Session.query(model.Subdepartment)\
|
|
.order_by(model.Subdepartment.number)
|
|
subdept_values = [(s.uuid, "{} {}".format(s.number, s.name))
|
|
for s in subdepartments]
|
|
require_subdepartment = False
|
|
if not require_subdepartment:
|
|
subdept_values.insert(0, ('', "(none)"))
|
|
f.set_widget('subdepartment_uuid', dfwidget.SelectWidget(values=subdept_values))
|
|
f.set_label('subdepartment_uuid', "Subdepartment")
|
|
else:
|
|
f.set_readonly('subdepartment')
|
|
f.set_renderer('subdepartment', self.render_subdepartment)
|
|
|
|
# category
|
|
if self.creating or self.editing:
|
|
if 'category' in f.fields:
|
|
f.replace('category', 'category_uuid')
|
|
categories = self.Session.query(model.Category)\
|
|
.order_by(model.Category.code)
|
|
category_values = [(c.uuid, "{} {}".format(c.code, c.name))
|
|
for c in categories]
|
|
require_category = False
|
|
if not require_category:
|
|
category_values.insert(0, ('', "(none)"))
|
|
f.set_widget('category_uuid', dfwidget.SelectWidget(values=category_values))
|
|
f.set_label('category_uuid', "Category")
|
|
else:
|
|
f.set_readonly('category')
|
|
f.set_renderer('category', self.render_category)
|
|
|
|
# family
|
|
if self.creating or self.editing:
|
|
if 'family' in f.fields:
|
|
f.replace('family', 'family_uuid')
|
|
families = self.Session.query(model.Family)\
|
|
.order_by(model.Family.name)
|
|
family_values = [(fam.uuid, fam.name) for fam in families]
|
|
require_family = False
|
|
if not require_family:
|
|
family_values.insert(0, ('', "(none)"))
|
|
f.set_widget('family_uuid', dfwidget.SelectWidget(values=family_values))
|
|
f.set_label('family_uuid', "Family")
|
|
else:
|
|
f.set_readonly('family')
|
|
# f.set_renderer('family', self.render_family)
|
|
|
|
# report_code
|
|
if self.creating or self.editing:
|
|
if 'report_code' in f.fields:
|
|
f.replace('report_code', 'report_code_uuid')
|
|
report_codes = self.Session.query(model.ReportCode)\
|
|
.order_by(model.ReportCode.code)
|
|
report_code_values = [(rc.uuid, "{} {}".format(rc.code, rc.name))
|
|
for rc in report_codes]
|
|
require_report_code = False
|
|
if not require_report_code:
|
|
report_code_values.insert(0, ('', "(none)"))
|
|
f.set_widget('report_code_uuid', dfwidget.SelectWidget(values=report_code_values))
|
|
f.set_label('report_code_uuid', "Report_Code")
|
|
else:
|
|
f.set_readonly('report_code')
|
|
# f.set_renderer('report_code', self.render_report_code)
|
|
|
|
# deposit_link
|
|
if self.creating or self.editing:
|
|
if 'deposit_link' in f.fields:
|
|
f.replace('deposit_link', 'deposit_link_uuid')
|
|
deposit_links = self.Session.query(model.DepositLink)\
|
|
.order_by(model.DepositLink.code)
|
|
deposit_link_values = [(dl.uuid, "{} {}".format(dl.code, dl.description))
|
|
for dl in deposit_links]
|
|
require_deposit_link = False
|
|
if not require_deposit_link:
|
|
deposit_link_values.insert(0, ('', "(none)"))
|
|
f.set_widget('deposit_link_uuid', dfwidget.SelectWidget(values=deposit_link_values))
|
|
f.set_label('deposit_link_uuid', "Deposit_Link")
|
|
else:
|
|
f.set_readonly('deposit_link')
|
|
# f.set_renderer('deposit_link', self.render_deposit_link)
|
|
|
|
# tax
|
|
if self.creating or self.editing:
|
|
if 'tax' in f.fields:
|
|
f.replace('tax', 'tax_uuid')
|
|
taxes = self.Session.query(model.Tax)\
|
|
.order_by(model.Tax.code)
|
|
tax_values = [(tax.uuid, "{} {}".format(tax.code, tax.description))
|
|
for tax in taxes]
|
|
require_tax = False
|
|
if not require_tax:
|
|
tax_values.insert(0, ('', "(none)"))
|
|
f.set_widget('tax_uuid', dfwidget.SelectWidget(values=tax_values))
|
|
f.set_label('tax_uuid', "Tax")
|
|
else:
|
|
f.set_readonly('tax')
|
|
# f.set_renderer('tax', self.render_tax)
|
|
|
|
# brand
|
|
if self.creating:
|
|
f.replace('brand', 'brand_uuid')
|
|
brand_display = ""
|
|
if self.request.method == 'POST':
|
|
if self.request.POST.get('brand_uuid'):
|
|
brand = self.Session.query(model.Brand).get(self.request.POST['brand_uuid'])
|
|
if brand:
|
|
brand_display = six.text_type(brand)
|
|
brands_url = self.request.route_url('brands.autocomplete')
|
|
f.set_widget('brand_uuid', forms.widgets.JQueryAutocompleteWidget(
|
|
field_display=brand_display, service_url=brands_url))
|
|
f.set_label('brand_uuid', "Brand")
|
|
|
|
# unit_size
|
|
f.set_type('unit_size', 'quantity')
|
|
|
|
# unit_of_measure
|
|
f.set_enum('unit_of_measure', self.enum.UNIT_OF_MEASURE)
|
|
f.set_label('unit_of_measure', "Unit of Measure")
|
|
|
|
# packs
|
|
if self.creating:
|
|
f.remove_field('packs')
|
|
elif self.viewing and product.packs:
|
|
f.set_renderer('packs', self.render_packs)
|
|
f.set_label('packs', "Pack Items")
|
|
else:
|
|
f.remove_field('packs')
|
|
|
|
# unit
|
|
if self.creating:
|
|
f.remove_field('unit')
|
|
elif self.viewing and product.is_pack_item():
|
|
f.set_renderer('unit', self.render_unit)
|
|
f.set_label('unit', "Unit Item")
|
|
else:
|
|
f.remove_field('unit')
|
|
|
|
# pack_size
|
|
if self.viewing and not product.is_pack_item():
|
|
f.remove_field('pack_size')
|
|
else:
|
|
f.set_type('pack_size', 'quantity')
|
|
|
|
# default_pack
|
|
if self.viewing and not product.is_pack_item():
|
|
f.remove_field('default_pack')
|
|
|
|
# regular_price
|
|
if self.creating:
|
|
f.remove_field('regular_price')
|
|
else:
|
|
f.set_readonly('regular_price')
|
|
f.set_renderer('regular_price', self.render_price)
|
|
|
|
# current_price
|
|
if self.creating:
|
|
f.remove_field('current_price')
|
|
else:
|
|
f.set_readonly('current_price')
|
|
f.set_renderer('current_price', self.render_price)
|
|
|
|
# last_sold
|
|
if self.creating:
|
|
f.remove_field('last_sold')
|
|
else:
|
|
f.set_readonly('last_sold')
|
|
|
|
# status_code
|
|
f.set_label('status_code', "Status")
|
|
|
|
# ingredients
|
|
f.set_widget('ingredients', dfwidget.TextAreaWidget(cols=80, rows=10))
|
|
|
|
# notes
|
|
f.set_widget('notes', dfwidget.TextAreaWidget(cols=80, rows=10))
|
|
|
|
# current_price_ends
|
|
if self.creating:
|
|
f.remove_field('current_price_ends')
|
|
else:
|
|
f.set_readonly('current_price_ends')
|
|
f.set_renderer('current_price_ends', self.render_current_price_ends)
|
|
|
|
# inventory_on_hand
|
|
if self.creating:
|
|
f.remove_field('inventory_on_hand')
|
|
else:
|
|
f.set_readonly('inventory_on_hand')
|
|
f.set_renderer('inventory_on_hand', self.render_inventory_on_hand)
|
|
f.set_label('inventory_on_hand', "On Hand")
|
|
|
|
# inventory_on_order
|
|
if self.creating:
|
|
f.remove_field('inventory_on_order')
|
|
else:
|
|
f.set_readonly('inventory_on_order')
|
|
f.set_renderer('inventory_on_order', self.render_inventory_on_order)
|
|
f.set_label('inventory_on_order', "On Order")
|
|
|
|
if not self.request.has_perm('products.view_deleted'):
|
|
f.remove('deleted')
|
|
|
|
def render_department(self, product, field):
|
|
department = product.department
|
|
if not department:
|
|
return ""
|
|
if department.number:
|
|
text = '({}) {}'.format(department.number, department.name)
|
|
else:
|
|
text = department.name
|
|
url = self.request.route_url('departments.view', uuid=department.uuid)
|
|
return tags.link_to(text, url)
|
|
|
|
def render_subdepartment(self, product, field):
|
|
subdepartment = product.subdepartment
|
|
if not subdepartment:
|
|
return ""
|
|
if subdepartment.number:
|
|
text = '({}) {}'.format(subdepartment.number, subdepartment.name)
|
|
else:
|
|
text = subdepartment.name
|
|
url = self.request.route_url('subdepartments.view', uuid=subdepartment.uuid)
|
|
return tags.link_to(text, url)
|
|
|
|
def render_category(self, product, field):
|
|
category = product.category
|
|
if not category:
|
|
return ""
|
|
if category.code:
|
|
text = '({}) {}'.format(category.code, category.name)
|
|
elif category.number:
|
|
text = '({}) {}'.format(category.number, category.name)
|
|
else:
|
|
text = category.name
|
|
url = self.request.route_url('categories.view', uuid=category.uuid)
|
|
return tags.link_to(text, url)
|
|
|
|
def render_packs(self, product, field):
|
|
if product.is_pack_item():
|
|
return ""
|
|
|
|
links = []
|
|
for pack in product.packs:
|
|
if pack.upc:
|
|
code = pack.upc.pretty()
|
|
elif pack.scancode:
|
|
code = pack.scancode
|
|
else:
|
|
code = pack.item_id
|
|
text = "({}) {}".format(code, pack.full_description)
|
|
url = self.get_action_url('view', pack)
|
|
links.append(tags.link_to(text, url))
|
|
|
|
items = [HTML.tag('li', c=[link]) for link in links]
|
|
return HTML.tag('ul', c=items)
|
|
|
|
def render_unit(self, product, field):
|
|
unit = product.unit
|
|
if not unit:
|
|
return ""
|
|
|
|
if unit.upc:
|
|
code = unit.upc.pretty()
|
|
elif unit.scancode:
|
|
code = unit.scancode
|
|
else:
|
|
code = unit.item_id
|
|
|
|
text = "({}) {}".format(code, unit.full_description)
|
|
url = self.get_action_url('view', unit)
|
|
return tags.link_to(text, url)
|
|
|
|
def render_current_price_ends(self, product, field):
|
|
if not product.current_price:
|
|
return ""
|
|
value = product.current_price.ends
|
|
if not value:
|
|
return ""
|
|
return raw_datetime(self.request.rattail_config, value)
|
|
|
|
def render_inventory_on_hand(self, product, field):
|
|
if not product.inventory:
|
|
return ""
|
|
value = product.inventory.on_hand
|
|
if not value:
|
|
return ""
|
|
return pretty_quantity(value)
|
|
|
|
def render_inventory_on_order(self, product, field):
|
|
if not product.inventory:
|
|
return ""
|
|
value = product.inventory.on_order
|
|
if not value:
|
|
return ""
|
|
return pretty_quantity(value)
|
|
|
|
def template_kwargs_view(self, **kwargs):
|
|
kwargs['image'] = False
|
|
product = kwargs['instance']
|
|
if product.upc:
|
|
kwargs['image_url'] = pod.get_image_url(self.rattail_config, product.upc)
|
|
kwargs['image_path'] = pod.get_image_path(self.rattail_config, product.upc)
|
|
kwargs['costs_label_preferred'] = "Pref."
|
|
kwargs['costs_label_vendor'] = "Vendor"
|
|
kwargs['costs_label_code'] = "Order Code"
|
|
kwargs['costs_label_case_size'] = "Case Size"
|
|
return kwargs
|
|
|
|
def edit(self):
|
|
# TODO: Should add some more/better hooks, so don't have to duplicate
|
|
# so much code here.
|
|
self.editing = True
|
|
instance = self.get_instance()
|
|
form = self.make_form(instance)
|
|
product_deleted = instance.deleted
|
|
if self.request.method == 'POST':
|
|
if self.validate_form(form):
|
|
self.save_edit_form(form)
|
|
self.request.session.flash("{} {} has been updated.".format(
|
|
self.get_model_title(), self.get_instance_title(instance)))
|
|
return self.redirect(self.get_action_url('view', instance))
|
|
if product_deleted:
|
|
self.request.session.flash("This product is marked as deleted.", 'error')
|
|
return self.render_to_response('edit', {'instance': instance,
|
|
'instance_title': self.get_instance_title(instance),
|
|
'form': form})
|
|
|
|
def get_version_child_classes(self):
|
|
return [
|
|
(model.ProductCode, 'product_uuid'),
|
|
(model.ProductCost, 'product_uuid'),
|
|
(model.ProductPrice, 'product_uuid'),
|
|
]
|
|
|
|
def image(self):
|
|
"""
|
|
View which renders the product's image as a response.
|
|
"""
|
|
product = self.get_instance()
|
|
if not product.image:
|
|
raise httpexceptions.HTTPNotFound()
|
|
# TODO: how to properly detect image type?
|
|
# self.request.response.content_type = six.binary_type('image/png')
|
|
self.request.response.content_type = six.binary_type('image/jpeg')
|
|
self.request.response.body = product.image.bytes
|
|
return self.request.response
|
|
|
|
def search(self):
|
|
"""
|
|
Locate a product(s) by UPC.
|
|
|
|
Eventually this should be more generic, or at least offer more fields for
|
|
search. For now it operates only on the ``Product.upc`` field.
|
|
"""
|
|
data = None
|
|
upc = self.request.GET.get('upc', '').strip()
|
|
upc = re.sub(r'\D', '', upc)
|
|
if upc:
|
|
product = api.get_product_by_upc(Session(), upc)
|
|
if not product:
|
|
# Try again, assuming caller did not include check digit.
|
|
upc = GPC(upc, calc_check_digit='upc')
|
|
product = api.get_product_by_upc(Session(), upc)
|
|
if product and (not product.deleted or self.request.has_perm('products.view_deleted')):
|
|
data = {
|
|
'uuid': product.uuid,
|
|
'upc': six.text_type(product.upc),
|
|
'upc_pretty': product.upc.pretty(),
|
|
'full_description': product.full_description,
|
|
'image_url': pod.get_image_url(self.rattail_config, product.upc),
|
|
}
|
|
uuid = self.request.GET.get('with_vendor_cost')
|
|
if uuid:
|
|
vendor = Session.query(model.Vendor).get(uuid)
|
|
if not vendor:
|
|
return {'error': "Vendor not found"}
|
|
cost = product.cost_for_vendor(vendor)
|
|
if cost:
|
|
data['cost_found'] = True
|
|
if int(cost.case_size) == cost.case_size:
|
|
data['cost_case_size'] = int(cost.case_size)
|
|
else:
|
|
data['cost_case_size'] = '{:0.4f}'.format(cost.case_size)
|
|
else:
|
|
data['cost_found'] = False
|
|
return {'product': data}
|
|
|
|
def get_supported_batches(self):
|
|
return {
|
|
'labels': 'rattail.batch.labels:LabelBatchHandler',
|
|
'pricing': 'rattail.batch.pricing:PricingBatchHandler',
|
|
}
|
|
|
|
def make_batch(self):
|
|
"""
|
|
View for making a new batch from current product grid query.
|
|
"""
|
|
supported = self.get_supported_batches()
|
|
batch_options = []
|
|
for key, spec in list(supported.items()):
|
|
handler = load_object(spec)(self.rattail_config)
|
|
handler.spec = spec
|
|
supported[key] = handler
|
|
batch_options.append((key, handler.get_model_title()))
|
|
|
|
schema = colander.SchemaNode(
|
|
colander.Mapping(),
|
|
colander.SchemaNode(colander.String(), name='batch_type', widget=dfwidget.SelectWidget(values=batch_options)),
|
|
colander.SchemaNode(colander.String(), name='description', missing=colander.null),
|
|
colander.SchemaNode(colander.String(), name='notes', missing=colander.null),
|
|
)
|
|
|
|
form = forms.Form(schema=schema, request=self.request,
|
|
cancel_url=self.get_index_url())
|
|
form.set_type('notes', 'text')
|
|
|
|
params_forms = {}
|
|
for key, handler in supported.items():
|
|
make_schema = getattr(self, 'make_batch_params_schema_{}'.format(key), None)
|
|
if make_schema:
|
|
schema = make_schema()
|
|
# must prefix node names with batch key, to guarantee unique
|
|
for node in schema:
|
|
node.param_name = node.name
|
|
node.name = '{}_{}'.format(key, node.name)
|
|
params_forms[key] = forms.Form(schema=schema, request=self.request)
|
|
|
|
if self.request.method == 'POST':
|
|
controls = self.request.POST.items()
|
|
data = form.validate(controls)
|
|
batch_key = data['batch_type']
|
|
params = {
|
|
'description': data['description'],
|
|
'notes': data['notes']}
|
|
pform = params_forms.get(batch_key)
|
|
if pform:
|
|
pdata = pform.validate(controls)
|
|
for field in pform.schema:
|
|
param_name = pform.schema[field.name].param_name
|
|
params[param_name] = pdata[field.name]
|
|
|
|
# TODO: should this be done elsewhere?
|
|
for name in params:
|
|
if params[name] is colander.null:
|
|
params[name] = None
|
|
|
|
handler = get_batch_handler(self.rattail_config, batch_key,
|
|
default=supported[batch_key].spec)
|
|
products = self.get_effective_data()
|
|
progress = SessionProgress(self.request, 'products.batch')
|
|
thread = Thread(target=self.make_batch_thread,
|
|
args=(handler, self.request.user.uuid, products, params, progress))
|
|
thread.start()
|
|
return self.render_progress(progress, {
|
|
'cancel_url': self.get_index_url(),
|
|
'cancel_msg': "Batch creation was canceled.",
|
|
})
|
|
|
|
return {
|
|
'form': form,
|
|
'dform': form.make_deform_form(), # TODO: hacky? at least is explicit..
|
|
'params_forms': params_forms,
|
|
}
|
|
|
|
def make_batch_params_schema_pricing(self):
|
|
"""
|
|
Return params schema for making a pricing batch.
|
|
"""
|
|
return colander.SchemaNode(
|
|
colander.Mapping(),
|
|
colander.SchemaNode(colander.Decimal(), name='min_diff_threshold', quant='1.00', missing=colander.null),
|
|
colander.SchemaNode(colander.Boolean(), name='calculate_for_manual'),
|
|
)
|
|
|
|
def make_batch_thread(self, handler, user_uuid, products, params, progress):
|
|
"""
|
|
Threat target for making a batch from current products query.
|
|
"""
|
|
session = RattailSession()
|
|
user = session.query(model.User).get(user_uuid)
|
|
assert user
|
|
params['created_by'] = user
|
|
batch = handler.make_batch(session, **params)
|
|
batch.products = products.with_session(session).all()
|
|
handler.populate(batch, progress=progress)
|
|
|
|
session.commit()
|
|
session.refresh(batch)
|
|
session.close()
|
|
|
|
progress.session.load()
|
|
progress.session['complete'] = True
|
|
progress.session['success_url'] = self.get_batch_view_url(batch)
|
|
progress.session['success_msg'] = 'Batch has been created: {}'.format(batch)
|
|
progress.session.save()
|
|
|
|
def get_batch_view_url(self, batch):
|
|
if batch.batch_key == 'labels':
|
|
return self.request.route_url('labels.batch.view', uuid=batch.uuid)
|
|
if batch.batch_key == 'pricing':
|
|
return self.request.route_url('batch.pricing.view', uuid=batch.uuid)
|
|
|
|
@classmethod
|
|
def defaults(cls, config):
|
|
cls._product_defaults(config)
|
|
cls._defaults(config)
|
|
|
|
@classmethod
|
|
def _product_defaults(cls, config):
|
|
route_prefix = cls.get_route_prefix()
|
|
url_prefix = cls.get_url_prefix()
|
|
template_prefix = cls.get_template_prefix()
|
|
permission_prefix = cls.get_permission_prefix()
|
|
model_title = cls.get_model_title()
|
|
|
|
# print labels
|
|
config.add_tailbone_permission('products', 'products.print_labels',
|
|
"Print labels for products")
|
|
|
|
# view deleted products
|
|
config.add_tailbone_permission('products', 'products.view_deleted',
|
|
"View products marked as deleted")
|
|
|
|
# make batch from product query
|
|
config.add_tailbone_permission(permission_prefix, '{}.make_batch'.format(permission_prefix),
|
|
"Create batch from {} query".format(model_title))
|
|
config.add_route('{}.make_batch'.format(route_prefix), '{}/make-batch'.format(url_prefix))
|
|
config.add_view(cls, attr='make_batch', route_name='{}.make_batch'.format(route_prefix),
|
|
renderer='{}/batch.mako'.format(template_prefix),
|
|
permission='{}.make_batch'.format(permission_prefix))
|
|
|
|
# search (by upc)
|
|
config.add_route('products.search', '/products/search')
|
|
config.add_view(cls, attr='search', route_name='products.search',
|
|
renderer='json', permission='products.view')
|
|
|
|
# product image
|
|
config.add_route('products.image', '/products/{uuid}/image')
|
|
config.add_view(cls, attr='image', route_name='products.image')
|
|
|
|
|
|
class ProductsAutocomplete(AutocompleteView):
|
|
"""
|
|
Autocomplete view for products.
|
|
"""
|
|
mapped_class = model.Product
|
|
fieldname = 'description'
|
|
|
|
def query(self, term):
|
|
q = Session.query(model.Product).outerjoin(model.Brand)
|
|
q = q.filter(sa.or_(
|
|
model.Brand.name.ilike('%{}%'.format(term)),
|
|
model.Product.description.ilike('%{}%'.format(term))))
|
|
if not self.request.has_perm('products.view_deleted'):
|
|
q = q.filter(model.Product.deleted == False)
|
|
q = q.order_by(model.Brand.name, model.Product.description)
|
|
q = q.options(orm.joinedload(model.Product.brand))
|
|
return q
|
|
|
|
def display(self, product):
|
|
return product.full_description
|
|
|
|
|
|
def print_labels(request):
|
|
profile = request.params.get('profile')
|
|
profile = Session.query(model.LabelProfile).get(profile) if profile else None
|
|
if not profile:
|
|
return {'error': "Label profile not found"}
|
|
|
|
product = request.params.get('product')
|
|
product = Session.query(model.Product).get(product) if product else None
|
|
if not product:
|
|
return {'error': "Product not found"}
|
|
|
|
quantity = request.params.get('quantity')
|
|
if not quantity.isdigit():
|
|
return {'error': "Quantity must be numeric"}
|
|
quantity = int(quantity)
|
|
|
|
printer = profile.get_printer(request.rattail_config)
|
|
if not printer:
|
|
return {'error': "Couldn't get printer from label profile"}
|
|
|
|
try:
|
|
printer.print_labels([(product, quantity, {})])
|
|
except Exception as error:
|
|
return {'error': six.text_type(error)}
|
|
return {}
|
|
|
|
|
|
def includeme(config):
|
|
|
|
config.add_route('products.autocomplete', '/products/autocomplete')
|
|
config.add_view(ProductsAutocomplete, route_name='products.autocomplete',
|
|
renderer='json', permission='products.list')
|
|
|
|
config.add_route('products.print_labels', '/products/labels')
|
|
config.add_view(print_labels, route_name='products.print_labels',
|
|
renderer='json', permission='products.print_labels')
|
|
|
|
ProductsView.defaults(config)
|