categories.py

# -*- coding: UTF-8 -*-
# Copyright (C) 2009 Sylvain Taverne <sylvain@itaapy.com>
# Copyright (C) 2009 Hervé Cauwelier <herve@itaapy.com>
#
# This program 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.
#
# This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.

# Import from itools
from itools.core import merge_dicts
from itools.datatypes import Integer, Unicode
from itools.gettext import MSG
from itools.web import get_context
from itools.xapian import AndQuery, NotQuery, PhraseQuery
from itools.xml import xml_to_text

# Import from ikaaro
from ikaaro.forms import XHTMLBody, TextWidget, ImageSelectorWidget, RTEWidget
from ikaaro.registry import register_resource_class, register_field
from ikaaro.registry import get_register_fields

# Import from itws
from itws.views import AutomaticEditView

# Import from shop
from categories_views import Category_View, Category_BackofficeView
from categories_views import Category_Comparator, Category_BatchEdition
from categories_views import NewCategory_Form
from csv_views import Export
from datatypes import ImagePathDataType
from folder import ShopFolder
from utils import get_group_name, get_shop
from products import Product
from products.product_views import Product_NewProduct, Products_View


class Category(ShopFolder):

    class_id = 'category'
    class_title = MSG(u'Category')

    # Edit configuration
    edit_show_meta = True
    edit_schema = {'data': XHTMLBody(multilingual=True),
                   'breadcrumb_title': Unicode(multilingual=True),
                   'image_category': ImagePathDataType(multilingual=True),
                   'default_product_cover': ImagePathDataType(multilingual=True)}

    edit_widgets = [
        TextWidget('breadcrumb_title', title=MSG(u'Breadcrumb title')),
        ImageSelectorWidget('image_category',  title=MSG(u'Category image')),
        ImageSelectorWidget('default_product_cover',  title=MSG(u'Default cover for products')),
        RTEWidget('data', title=MSG(u"Description"))]


    # Views
    view = Category_View()
    browse_content = Products_View()
    view_categories = Category_BackofficeView()
    edit = AutomaticEditView()
    batch_edition = Category_BatchEdition()
    new_product = Product_NewProduct()
    new_category = NewCategory_Form()
    comparator = Category_Comparator()


    @property
    def class_views(self):
        context = get_context()
        # Back-Office
        hostname = context.uri.authority
        if hostname[:6] == 'admin.' :
            return ['browse_content', 'new_product',
                    'view_categories', 'new_category',
                    'edit']
        return ['view', 'edit']


    @classmethod
    def get_metadata_schema(cls):
        return merge_dicts(ShopFolder.get_metadata_schema(),
                           data=XHTMLBody(multilingual=True),
                           breadcrumb_title=Unicode(multilingual=True),
                           image_category=ImagePathDataType(multilingual=True),
                           default_product_cover=ImagePathDataType(multilingual=True))


    def _get_catalog_values(self):
        # Get the languages
        site_root = self.get_site_root()
        languages = site_root.get_property('website_languages')
        # Titles
        m_title = {}
        m_breadcrumb_title = {}
        for language in languages:
            value = self.get_property('title', language=language)
            if value:
                m_title[language] = value
            value = self.get_property('breadcrumb_title', language=language)
            if value:
                m_breadcrumb_title[language] = value
        # Data
        data = self.get_property('data')
        if data is not None:
            data = xml_to_text(data)
        return merge_dicts(
            super(Category, self)._get_catalog_values(),
            data=data,
            # XXX Hack to be on sitemap
            workflow_state='public',
            m_title=m_title,
            m_breadcrumb_title=m_breadcrumb_title)


    def get_document_types(self):
        return [Product, Category]

    ####################################
    # Computed fields
    ####################################
    computed_schema = {'nb_products': Integer(title=MSG(u'Nb products')),
                       'nb_categories': Integer(title=MSG(u'Nb sub categories'))}

    def get_nb_products(self, only_public=False):
        root = self.get_root()
        shop = get_shop(self)
        abspath = self.get_canonical_path()
        query = [PhraseQuery('parent_paths', str(abspath)),
                 PhraseQuery('format', shop.product_class.class_id)]
        if shop.get_property('hide_not_buyable_products') is True:
            context = get_context()
            group_name = get_group_name(shop, context)
            query.append(NotQuery(PhraseQuery('not_buyable_by_groups', group_name)))
        if only_public is True:
            query.append(PhraseQuery('workflow_state', 'public'))
        return len(root.search(AndQuery(*query)))


    def get_nb_categories(self):
        root = self.get_root()
        abspath = self.get_canonical_path()
        query = AndQuery(
            PhraseQuery('parent_paths', str(abspath)),
            PhraseQuery('format', 'category'))
        return len(root.search(query))


    @property
    def nb_products(self):
        return self.get_nb_products()


    @property
    def nb_categories(self):
        return self.get_nb_categories()

    #############################
    # Export
    #############################
    export = Export(export_resource=Product,
                    access='is_allowed_to_edit',
                    file_columns=['reference', 'state',
                                  'frontoffice_uri', 'cover_uri',
                                  'manufacturer', 'price_with_tax',
                                  'description'])



register_resource_class(Category)

# Add m_title field if it does not already exist
if 'm_title' in get_register_fields() is False:
    register_field('m_title', Unicode(is_stored=True, is_indexed=True))
register_field('m_breadcrumb_title', Unicode(is_stored=True, is_indexed=True))