
##############################################################################
#
# Copyright (c) 2007-2008 Nexedi SA and Contributors. All Rights Reserved.
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# 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 2
# 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, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

from AccessControl import ClassSecurityInfo
from Globals import InitializeClass
from DocumentationHelper import DocumentationHelper
from Products.ERP5Type import Permissions

class ERP5SiteDocumentationHelper(DocumentationHelper):
  """
    Provides access to all documentation information
    of an ERP5 Site.
  """
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)

  _section_list = (
    dict(
      id='business_template',
      title='Business Template',
      class_name='BusinessTemplateDocumentationHelper',
    ),
  )

  security.declareProtected(Permissions.AccessContentsInformation, 'getType')
  def getType(self):
    """
    Returns the type of the documentation helper
    """
    return "ERP5 Site"

  def getBusinessTemplateValueList(self):
    bt_list = getattr(self, 'REQUEST', {}).get("business_template_list")
    return (bt for bt in self.getPortalObject().portal_templates.objectValues()
               if bt_list is None or bt.getTitle() in bt_list)

  security.declareProtected(Permissions.AccessContentsInformation, 'getBusinessTemplateItemList')
  def getBusinessTemplateItemList(self):
    """
    """
    return [(bt.getId(),
              getattr(bt, "title", ''),
              getattr(bt, "description", ''),
              getattr(bt, "version", ''),
              getattr(bt, "revision", ''))
            for bt in self.getBusinessTemplateValueList()]

  security.declareProtected(Permissions.AccessContentsInformation, 'getBusinessTemplateUriList')
  def getBusinessTemplateUriList(self):
    """
    """
    return [bt.getPath() for bt in self.getBusinessTemplateValueList()]

InitializeClass(ERP5SiteDocumentationHelper)
