def delete(self, request, *args, **kwargs):
response = super(SnippetDeleteView,
self).delete(request, *args, **kwargs)
shop = get_shop(self.request)
cache_key = GLOBAL_SNIPPETS_CACHE_KEY.format(shop_id=shop.pk)
cache.bump_version(cache_key)
return response
def save(self, *args, **kwargs):
rv = super(Category, self).save(*args, **kwargs)
generate_multilanguage_slugs(self, self._get_slug_name)
# bump children cache
from shuup.core import cache
cache.bump_version("category_cached_children")
return rv
def save(self, *args, **kwargs):
rv = super(Category, self).save(*args, **kwargs)
generate_multilanguage_slugs(self, self._get_slug_name)
# bump children cache
from shuup.core import cache
cache.bump_version("category_cached_children")
return rv
def test_cache_api():
key = "test_prefix:123"
value = "456"
cache.set(key, value)
assert cache.get(key) == value
cache.bump_version(key)
assert cache.get(key, default="derp") == "derp" # version was bumped, so no way this is there
cache.set(key, value)
assert cache.get(key) == value
def on_user_groups_change(instance, action, model, **kwargs):
from shuup.admin.utils.permissions import USER_PERMISSIONS_CACHE_NAMESPACE
# a group has changed it's users relation through group.users.set()
# then we need to bump the entire cache
if isinstance(instance, Group):
cache.bump_version(USER_PERMISSIONS_CACHE_NAMESPACE)
# bump only the user's permission cache
elif isinstance(instance, get_user_model()):
cache.bump_version("{}:{}".format(USER_PERMISSIONS_CACHE_NAMESPACE, instance.pk))
def bump_cache_for_item(item):
"""
Bump cache for given item
Use this only for non product items. For products
and shop_products use `bump_cache_for_product` and
`bump_cache_for_shop_product` for those.
:param item: Cached object
"""
cache.bump_version(_get_namespace_for_item(item))
def bump_cache_for_item(item):
"""
Bump cache for given item
Use this only for non product items. For products
and shop_products use `bump_cache_for_product` and
`bump_cache_for_shop_product` for those.
:param item: Cached object
"""
cache.bump_version(_get_namespace_for_item(item))
def bump_cache_for_item(item):
"""
Bump cache for given item
Use this only for non product items. For products
and shop_products use `bump_cache_for_product` and
`bump_cache_for_shop_product` for those.
:param item: Cached object
"""
cache.bump_version(_get_namespace_for_item(item))
context_cache_item_bumped.send(getattr(item, "__class__", item), item=item)
def bump_cache_for_item(item):
"""
Bump cache for given item
Use this only for non product items. For products
and shop_products use `bump_cache_for_product` and
`bump_cache_for_shop_product` for those.
:param item: Cached object
"""
cache.bump_version(_get_namespace_for_item(item))
context_cache_item_bumped.send(getattr(item, "__class__", item), item=item)
def bump_cache_for_item_ids(item_ids, namespace, object_class, shop=None):
"""
Bump cache for given item ids
Use this only for non product items. For products
and shop_products use `bump_cache_for_product` and
`bump_cache_for_shop_product` for those.
:param ids: list of cached object id's
"""
for item_id in item_ids:
cache.bump_version("{}-{}".format(namespace, item_id))
def save(self, *args, **kwargs):
if not self.key:
self.key = uuid1().hex
if not self.secret:
self.secret = "{}{}".format(uuid4().hex, uuid4().hex)
if self.pk:
from shuup_api_permission.permissions import API_ACCESS_CACHE_KEY_FMT
api_access_cache_key = API_ACCESS_CACHE_KEY_FMT.format(
key=self.key)
cache.bump_version(api_access_cache_key)
super(APIAccess, self).save(*args, **kwargs)
def set_configuration(shop=None, category=None, data=None):
if category and category.pk:
configuration.set(None, _get_category_configuration_key(category), data)
elif shop:
configuration.set(shop, FACETED_DEFAULT_CONF_KEY, data)
cache.bump_version(get_theme_cache_key(shop))
# clear active keys
context_cache.bump_cache_for_item(category)
if not category:
from shuup.core.models import Category
for cat_pk in Category.objects.all().values_list("pk", flat=True):
context_cache.bump_cache_for_pk(Category, cat_pk)
def set_configuration(shop=None, category=None, data=None):
if category and category.pk:
configuration.set(None, _get_category_configuration_key(category), data)
elif shop:
configuration.set(shop, FACETED_DEFAULT_CONF_KEY, data)
cache.bump_version(get_theme_cache_key(shop))
# clear active keys
context_cache.bump_cache_for_item(category)
if not category:
from shuup.core.models import Category
for cat_pk in Category.objects.all().values_list("pk", flat=True):
context_cache.bump_cache_for_pk(Category, cat_pk)
def form_valid(self, form):
identifier = form["theme"].cleaned_data["activate"]
data = {"settings": {"stylesheet": form["theme"].cleaned_data["selected_style"]}}
theme_settings, created = ThemeSettings.objects.get_or_create(
theme_identifier=identifier, shop=get_shop(self.request)
)
if created:
theme_settings.data = data
theme_settings.save()
else:
theme_settings.update_settings(data["settings"])
set_current_theme(identifier, self.object)
cache.bump_version(get_theme_cache_key(get_shop(self.request)))
def form_valid(self, form):
identifier = form["theme"].cleaned_data["activate"]
theme = set_current_theme(identifier)
data = {
"settings": {
"stylesheet": form["theme"].cleaned_data["selected_style"]
}
}
theme_settings, created = ThemeSettings.objects.get_or_create(theme_identifier=theme.identifier)
if created:
theme_settings.data = data
else:
theme_settings.update_settings(data["settings"])
theme_settings.activate()
cache.bump_version(THEME_CACHE_KEY)
def set_current_theme(identifier):
"""
Activate a theme based on identifier.
:param identifier: Theme identifier
:type identifier: str
:return: Activated theme
:rtype: Theme
"""
cache.bump_version(THEME_CACHE_KEY)
theme = get_theme_by_identifier(identifier)
if not theme:
raise ValueError("Invalid theme identifier")
theme.set_current()
cache.set(THEME_CACHE_KEY, theme)
return theme
def form_valid(self, form):
identifier = form["theme"].cleaned_data["activate"]
theme = set_current_theme(identifier)
data = {
"settings": {
"stylesheet": form["theme"].cleaned_data["selected_style"]
}
}
theme_settings, created = ThemeSettings.objects.get_or_create(
theme_identifier=theme.identifier)
if created:
theme_settings.data = data
else:
theme_settings.update_settings(data["settings"])
theme_settings.activate()
cache.bump_version(THEME_CACHE_KEY)
def set_current_theme(identifier):
"""
Activate a theme based on identifier.
:param identifier: Theme identifier
:type identifier: str
:return: Activated theme
:rtype: Theme
"""
cache.bump_version(THEME_CACHE_KEY)
theme = get_theme_by_identifier(identifier)
if not theme:
raise ValueError("Invalid theme identifier")
theme.set_current()
cache.set(THEME_CACHE_KEY, theme)
return theme
def bump_cache_for_pk(cls, pk):
"""
Bump cache for given class and pk combination
Use this only for non product items. For products
and shop_products use `bump_cache_for_product` and
`bump_cache_for_shop_product` for those.
In case you need to use this to product or shop_product
make sure you also bump related objects like in
`bump_cache_for_shop_product`.
:param cls: Class for cached object
:param pk: pk for cached object
"""
cache.bump_version("%s-%s" % (_get_namespace_prefix(cls), pk))
def bump_cache_for_pk(cls, pk):
"""
Bump cache for given class and pk combination
Use this only for non product items. For products
and shop_products use `bump_cache_for_product` and
`bump_cache_for_shop_product` for those.
In case you need to use this to product or shop_product
make sure you also bump related objects like in
`bump_cache_for_shop_product`.
:param cls: Class for cached object
:param pk: pk for cached object
"""
cache.bump_version("%s-%s" % (_get_namespace_prefix(cls), pk))
def test_cache_api():
with override_settings(CACHES={
'default': {
'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
'LOCATION': 'test_configuration_cache',
}
}):
cache.init_cache()
key = "test_prefix:123"
value = "456"
cache.set(key, value)
assert cache.get(key) == value
cache.bump_version(key)
assert cache.get(key, default="derp") == "derp" # version was bumped, so no way this is there
cache.set(key, value)
assert cache.get(key) == value
def test_cache_api():
with override_settings(CACHES={
'default': {
'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
'LOCATION': 'test_configuration_cache',
}
}):
cache.init_cache()
key = "test_prefix:123"
value = "456"
cache.set(key, value)
assert cache.get(key) == value
cache.bump_version(key)
assert cache.get(key, default="derp") == "derp" # version was bumped, so no way this is there
cache.set(key, value)
assert cache.get(key) == value
def set_current_theme(identifier, shop):
"""
Activate a theme based on identifier.
:param identifier: Theme identifier
:type identifier: str
:param shop: Shop to fetch the theme settings
:type shop: shuup.core.models.Shop
:return: Activated theme
:rtype: Theme
"""
cache.bump_version(get_theme_cache_key(shop))
theme = get_theme_by_identifier(identifier, shop)
if not theme:
raise ValueError("Invalid theme identifier")
theme.set_current()
cache.set(get_theme_cache_key(shop), theme)
set_middleware_current_theme(theme)
return theme
def set_current_theme(identifier, shop):
"""
Activate a theme based on identifier.
:param identifier: Theme identifier
:type identifier: str
:param shop: Shop to fetch the theme settings
:type shop: shuup.core.models.Shop
:return: Activated theme
:rtype: Theme
"""
cache.bump_version(get_theme_cache_key(shop))
theme = get_theme_by_identifier(identifier, shop)
if not theme:
raise ValueError("Invalid theme identifier")
theme.set_current()
cache.set(get_theme_cache_key(shop), theme)
set_middleware_current_theme(theme)
return theme
def form_valid(self, form):
identifier = form["theme"].cleaned_data["activate"]
data = {
"settings": {
"stylesheet": form["theme"].cleaned_data["selected_style"]
}
}
theme_settings, created = ThemeSettings.objects.get_or_create(
theme_identifier=identifier,
shop=get_shop(self.request)
)
if created:
theme_settings.data = data
theme_settings.save()
else:
theme_settings.update_settings(data["settings"])
set_current_theme(identifier, self.object)
cache.bump_version(get_theme_cache_key(get_shop(self.request)))
def set(shop, key, value):
"""
Set configuration item value for a shop or globally.
If given `shop` is ``None``, the value of given `key` is set
globally for all shops. Otherwise sets a shop specific value which
overrides the global value in configuration of the specified shop.
:param shop: Shop to set value for, or None to set a global value
:type shop: shuup.core.models.Shop|None
:param key: Name of the key to set
:type key: str
:param value: Value to set. Note: Must be JSON serializable.
:type value: Any
"""
ConfigurationItem.objects.update_or_create(
shop=shop, key=key, defaults={"value": value})
if shop:
cache.set(_get_cache_key(shop), None)
else:
cache.bump_version(_SHOP_CONF_NAMESPACE)
def invalidate_context_filter_cache(sender, instance, **kwargs):
cache.bump_version(CAMPAIGNS_CACHE_NAMESPACE)
# Let's try to preserve catalog filter cache as long as possible
cache.bump_version("%s:%s" % (CATALOG_FILTER_CACHE_NAMESPACE, instance.pk))
def bump_star_rating_cache(product_id):
cache.bump_version("product_reviews_star_rating_{}".format(product_id))
def form_valid(self, form):
response = super(SnippetEditView, self).form_valid(form)
shop = get_shop(self.request)
cache_key = GLOBAL_SNIPPETS_CACHE_KEY.format(shop_id=shop.pk)
cache.bump_version(cache_key)
return response
def invalidate_context_condition_cache(sender, instance, **kwargs):
cache.bump_version(CAMPAIGNS_CACHE_NAMESPACE)
cache.bump_version(CONTEXT_CONDITION_CACHE_NAMESPACE)
def invalidate_context_condition_cache(sender, instance, **kwargs):
cache.bump_version(CAMPAIGNS_CACHE_NAMESPACE)
cache.bump_version(CONTEXT_CONDITION_CACHE_NAMESPACE)
def save_form(self, form):
super(ThemeConfigDetailView, self).save_form(form)
cache.bump_version(THEME_CACHE_KEY)
def save_form(self, form):
super(ThemeConfigDetailView, self).save_form(form)
cache.bump_version(get_theme_cache_key(get_shop(self.request)))
def bump_star_rating_cache(vendor_id):
cache.bump_version("vendor_reviews_star_rating_{}".format(vendor_id))
def save(self, *args, **kwargs):
super(Campaign, self).save(*args, **kwargs)
cache.bump_version(CAMPAIGNS_CACHE_NAMESPACE)
cache.bump_version(CONTEXT_CONDITION_CACHE_NAMESPACE)
cache.bump_version(CATALOG_FILTER_CACHE_NAMESPACE)
def bump_instance_thumbnail_cache(sender, instance, **kwargs):
cache_namespace = "thumbnail_{}_{}".format(instance.pk, instance.__class__.__name__)
cache.bump_version(cache_namespace)
def save(self, *args, **kwargs):
super(Currency, self).save(*args, **kwargs)
cache.bump_version('currency_precision')
def form_valid(self, form):
response = super(SnippetEditView, self).form_valid(form)
shop = get_shop(self.request)
cache_key = GLOBAL_SNIPPETS_CACHE_KEY.format(shop_id=shop.pk)
cache.bump_version(cache_key)
return response
def bump_internal_cache():
cache.bump_version("_ctx_cache")
def save_form(self, form):
super(ThemeConfigDetailView, self).save_form(form)
cache.bump_version(get_theme_cache_key(get_shop(self.request)))
def set_permissions_for_group(group, permissions):
group_id = (group if isinstance(group, six.integer_types) else group.pk)
configuration.set(None, _get_permission_key_for_group(group_id),
permissions)
cache.bump_version(USER_PERMISSIONS_CACHE_NAMESPACE)
def save(self, *args, **kwargs):
super(Campaign, self).save(*args, **kwargs)
cache.bump_version(CAMPAIGNS_CACHE_NAMESPACE)
cache.bump_version(CONTEXT_CONDITION_CACHE_NAMESPACE)
cache.bump_version(CATALOG_FILTER_CACHE_NAMESPACE)
def save(self, *args, **kwargs):
super(Currency, self).save(*args, **kwargs)
cache.bump_version('currency_precision')
def save_form(self, form):
super(ThemeConfigDetailView, self).save_form(form)
cache.bump_version(THEME_CACHE_KEY)
def bump_sales_unit_cache_signal(*args, **kwargs):
cache.bump_version("display_unit")
def invalidate_context_filter_cache(sender, instance, **kwargs):
cache.bump_version(CAMPAIGNS_CACHE_NAMESPACE)
# Let's try to preserve catalog filter cache as long as possible
cache.bump_version("%s:%s" % (CATALOG_FILTER_CACHE_NAMESPACE, instance.pk))
def bump_internal_cache():
cache.bump_version("_ctx_cache")
def bump_sales_unit_cache_signal(*args, **kwargs):
cache.bump_version("display_unit")
def bump_star_rating_cache(vendor_id, option_id=None):
cache.bump_version("vendor_reviews_star_rating_{}_{}".format(
vendor_id, (option_id or "")))
def bump_instance_thumbnail_cache(sender, instance, **kwargs):
cache_namespace = "thumbnail_{}_{}".format(instance.pk,
instance.__class__.__name__)
cache.bump_version(cache_namespace)
def delete(self, request, *args, **kwargs):
response = super(SnippetDeleteView, self).delete(request, *args, **kwargs)
shop = get_shop(self.request)
cache_key = GLOBAL_SNIPPETS_CACHE_KEY.format(shop_id=shop.pk)
cache.bump_version(cache_key)
return response
