"""core CubicWeb schema necessary for bootstrapping the actual instance's schema

:organization: Logilab

:copyright: 2001-2010 LOGILAB S.A. (Paris, FRANCE), license is LGPL v2.

:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr

:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses

"""

__docformat__ = "restructuredtext en"

_ = unicode

from yams.buildobjs import (EntityType, RelationType, SubjectRelation,

                            ObjectRelation, RichString, String, Boolean, Int)

from cubicweb.schema import RQLConstraint

from cubicweb.schemas import META_ETYPE_PERMS, META_RTYPE_PERMS

# not restricted since as "is" is handled as other relations, guests need

# access to this

class CWEType(EntityType):

    """define an entity type, used to build the instance schema"""

    __permissions__ = META_ETYPE_PERMS

    name = String(required=True, indexed=True, internationalizable=True,

                  unique=True, maxsize=64)

    description = RichString(internationalizable=True,

                             description=_('semantic description of this entity type'))

    # necessary to filter using RQL

    final = Boolean(description=_('automatic'))

class CWRType(EntityType):

    """define a relation type, used to build the instance schema"""

    __permissions__ = META_ETYPE_PERMS

    name = String(required=True, indexed=True, internationalizable=True,

                  unique=True, maxsize=64)

    description = RichString(internationalizable=True,

                             description=_('semantic description of this relation type'))

    symetric = Boolean(description=_('is this relation equivalent in both direction ?'))

    inlined = Boolean(description=_('is this relation physically inlined? you should know what you\'re doing if you are changing this!'))

    fulltext_container = String(description=_('if full text content of subject/object entity '

                                              'should be added to other side entity (the container).'),

                                vocabulary=('', _('subject'), _('object')),

                                maxsize=8, default=None)

    final = Boolean(description=_('automatic'))

class CWAttribute(EntityType):

    """define a final relation: link a final relation type from a non final

    entity to a final entity type.

    used to build the instance schema

    """

    __permissions__ = META_ETYPE_PERMS

    relation_type = SubjectRelation('CWRType', cardinality='1*',

                                    constraints=[RQLConstraint('O final TRUE')],

                                    composite='object')

    from_entity = SubjectRelation('CWEType', cardinality='1*',

                                  constraints=[RQLConstraint('O final FALSE')],

                                  composite='object')

    to_entity = SubjectRelation('CWEType', cardinality='1*',

                                constraints=[RQLConstraint('O final TRUE')],

                                composite='object')

    constrained_by = SubjectRelation('CWConstraint', cardinality='*1', composite='subject')

    cardinality = String(maxsize=2, internationalizable=True,

                         vocabulary=[_('?1'), _('11')],

                         description=_('subject/object cardinality'))

    ordernum = Int(description=('control subject entity\'s relations order'), default=0)

    indexed = Boolean(description=_('create an index for quick search on this attribute'))

    fulltextindexed = Boolean(description=_('index this attribute\'s value in the plain text index'))

    internationalizable = Boolean(description=_('is this attribute\'s value translatable'))

    defaultval = String(maxsize=256)

    description = RichString(internationalizable=True,

                             description=_('semantic description of this attribute'))

CARDINALITY_VOCAB = [_('?*'), _('1*'), _('+*'), _('**'),

                     _('?+'), _('1+'), _('++'), _('*+'),

                     _('?1'), _('11'), _('+1'), _('*1'),

                     _('??'), _('1?'), _('+?'), _('*?')]

class CWRelation(EntityType):

    """define a non final relation: link a non final relation type from a non

    final entity to a non final entity type.

    used to build the instance schema

    """

    __permissions__ = META_ETYPE_PERMS

    relation_type = SubjectRelation('CWRType', cardinality='1*',

                                    constraints=[RQLConstraint('O final FALSE')],

                                    composite='object')

    from_entity = SubjectRelation('CWEType', cardinality='1*',

                                  constraints=[RQLConstraint('O final FALSE')],

                                  composite='object')

    to_entity = SubjectRelation('CWEType', cardinality='1*',

                                constraints=[RQLConstraint('O final FALSE')],

                                composite='object')

    constrained_by = SubjectRelation('CWConstraint', cardinality='*1', composite='subject')

    cardinality = String(maxsize=2, internationalizable=True,

                         vocabulary=CARDINALITY_VOCAB,

                         description=_('subject/object cardinality'))

    ordernum = Int(description=_('control subject entity\'s relations order'),

                   default=0)

    composite = String(description=_('is the subject/object entity of the relation '

                                     'composed of the other ? This implies that when '

                                     'the composite is deleted, composants are also '

                                     'deleted.'),

                       vocabulary=('', _('subject'), _('object')),

                       maxsize=8, default=None)

    description = RichString(internationalizable=True,

                             description=_('semantic description of this relation'))

# not restricted since it has to be read when checking allowed transitions

class RQLExpression(EntityType):

    """define a rql expression used to define __permissions__"""

    __permissions__ = META_ETYPE_PERMS

    exprtype = String(required=True, vocabulary=['ERQLExpression', 'RRQLExpression'])

    mainvars = String(maxsize=8,

                      description=_('name of the main variables which should be '

                                    'used in the selection if necessary (comma '

                                    'separated)'))

    expression = String(required=True,

                        description=_('restriction part of a rql query. '

                                      'For entity rql expression, X and U are '

                                      'predefined respectivly to the current object and to '

                                      'the request user. For relation rql expression, '

                                      'S, O and U are predefined respectivly to the current '

                                      'relation\'subject, object and to '

                                      'the request user. '))

    read_permission = ObjectRelation(('CWEType', 'CWAttribute', 'CWRelation'), cardinality='*?', composite='subject',

                                      description=_('rql expression allowing to read entities/relations of this type'))

    add_permission = ObjectRelation(('CWEType', 'CWAttribute', 'CWRelation'), cardinality='*?', composite='subject',

                                     description=_('rql expression allowing to add entities/relations of this type'))

    delete_permission = ObjectRelation(('CWEType', 'CWAttribute', 'CWRelation'), cardinality='*?', composite='subject',

                                        description=_('rql expression allowing to delete entities/relations of this type'))

    update_permission = ObjectRelation('CWEType', cardinality='*?', composite='subject',

                                        description=_('rql expression allowing to update entities of this type'))

class CWConstraint(EntityType):

    """define a schema constraint"""

    __permissions__ = META_ETYPE_PERMS

    cstrtype = SubjectRelation('CWConstraintType', cardinality='1*')

    value = String(description=_('depends on the constraint type'))

class CWConstraintType(EntityType):

    """define a schema constraint type"""

    __permissions__ = META_ETYPE_PERMS

    name = String(required=True, indexed=True, internationalizable=True,

                  unique=True, maxsize=64)

# not restricted since it has to be read when checking allowed transitions

class CWGroup(EntityType):

    """define a CubicWeb users group"""

    __permissions__ = META_ETYPE_PERMS

    name = String(required=True, indexed=True, internationalizable=True,

                  unique=True, maxsize=64)

    read_permission = ObjectRelation(('CWEType', 'CWAttribute', 'CWRelation'), cardinality='**',

                                      description=_('groups allowed to read entities/relations of this type'))

    add_permission = ObjectRelation(('CWEType', 'CWAttribute', 'CWRelation'),

                                     description=_('groups allowed to add entities/relations of this type'))

    delete_permission = ObjectRelation(('CWEType', 'CWAttribute', 'CWRelation'),

                                        description=_('groups allowed to delete entities/relations of this type'))

    update_permission = ObjectRelation('CWEType',

                                        description=_('groups allowed to update entities of this type'))

class CWProperty(EntityType):

    """used for cubicweb configuration. Once a property has been created you

    can't change the key.

    """

    __permissions__ = {

        'read':   ('managers', 'users', 'guests'),

        'add':    ('managers', 'users',),

        'update': ('managers', 'owners',),

        'delete': ('managers', 'owners',),

        }

    # key is a reserved word for mysql

    pkey = String(required=True, internationalizable=True, maxsize=256,

                  description=_('defines what\'s the property is applied for. '

                                'You must select this first to be able to set '

                                'value'))

    value = String(internationalizable=True, maxsize=256)

class relation_type(RelationType):

    """link a relation definition to its relation type"""

    __permissions__ = META_RTYPE_PERMS

    inlined = True

class from_entity(RelationType):

    """link a relation definition to its subject entity type"""

    __permissions__ = META_RTYPE_PERMS

    inlined = True

class to_entity(RelationType):

    """link a relation definition to its object entity type"""

    __permissions__ = META_RTYPE_PERMS

    inlined = True

class constrained_by(RelationType):

    """constraints applying on this relation"""

    __permissions__ = META_RTYPE_PERMS

class cstrtype(RelationType):

    """constraint factory"""

    __permissions__ = META_RTYPE_PERMS

    inlined = True

class read_permission(RelationType):

    """core relation giving to a group the permission to read an entity or

    relation type

    """

    __permissions__ = META_RTYPE_PERMS

class add_permission(RelationType):

    """core relation giving to a group the permission to add an entity or

    relation type

    """

    __permissions__ = META_RTYPE_PERMS

class delete_permission(RelationType):

    """core relation giving to a group the permission to delete an entity or

    relation type

    """

    __permissions__ = META_RTYPE_PERMS

class update_permission(RelationType):

    """core relation giving to a group the permission to update an entity type

    """

    __permissions__ = META_RTYPE_PERMS

class is_(RelationType):

    """core relation indicating the type of an entity

    """

    name = 'is'

    # don't explicitly set composite here, this is handled anyway

    #composite = 'object'

    __permissions__ = {

        'read':   ('managers', 'users', 'guests'),

        'add':    (),

        'delete': (),

        }

    cardinality = '1*'

    subject = '*'

    object = 'CWEType'

class is_instance_of(RelationType):

    """core relation indicating the types (including specialized types)

    of an entity

    """

    # don't explicitly set composite here, this is handled anyway

    #composite = 'object'

    __permissions__ = {

        'read':   ('managers', 'users', 'guests'),

        'add':    (),

        'delete': (),

        }

    cardinality = '+*'

    subject = '*'

    object = 'CWEType'

class specializes(RelationType):

    name = 'specializes'

    __permissions__ = {

        'read':   ('managers', 'users', 'guests'),

        'add':    ('managers',),

        'delete': ('managers',),

        }

    cardinality = '?*'

    subject = 'CWEType'

    object = 'CWEType'