root/trunk/LeMillReference.py

# Copyright 2006 by the LeMill Team (see AUTHORS)
#
# This file is part of LeMill.
#
# LeMill 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.
#
# LeMill 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 LeMill; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1

from AccessControl import ClassSecurityInfo
from Products.Archetypes.public import *
from Products.CMFCore.utils import getToolByName

from FieldsWidgets import TwoColumnMultiSelectionWidget, HTMLLinkWidget
from config import PROJECTNAME, MODIFY_CONTENT, VIEW
from Material import Material
from Schemata import material_schema, description,  author_schema, group_sharing


LICENSE_TYPES = (
    ('None', 'None - All Rights Reserved',),
    ('CCAL', 'Creative Commons Attribution License',),
    ('CCAND', 'Creative Commons Attribution-NoDerivs',),
    ('CCANCND', 'Creative Commons Attribution-NonCommercial-NoDerivs',),
    ('CCANC', 'Creative Commons Attribution-NonCommercial',),
    ('CCANCSA', 'Creative Commons Attribution-NonCommercial-ShareAlike',),
    ('CCAS', 'Creative Commons Attribution-ShareAlike',),
    ('GNUFDL', 'GNU Free Documentation License',),
    ('PD', 'Public Domain',),
)


lemillreference_schema = Schema((
    StringField('location',
        default = 'http://',
        copied_in_translation=True,
        accessor = 'getTechnicalLocation',
        required = True,
        searchable = True,
        widget = HTMLLinkWidget(
            label="Location",
            label_msgid='label_location_url',
            description='URL to the resource.',
            description_msgid='description_location_url',
            i18n_domain="lemill",
        ),
    ),
    StringField('author',
        copied_in_translation=True,
        searchable=True,
        widget = StringWidget(
            label = 'Author',
            label_msgid = 'label_author',
            description = 'Author of this resource',
            description_msgid = 'description_author',
            i18n_domain = 'lemill',
        ),
    ),
    StringField('license',
        copied_in_translation=True,
        vocabulary = DisplayList((LICENSE_TYPES)),
        searchable = True,
        widget = SelectionWidget(
            label = 'License',
            label_msgid = 'label_license',
            description = 'Choose appropriate license',
            description_msgid = 'description_choose_license',
            i18n_domain = 'lemill',
        ),
    ),
))


# not used
lrt = Schema((
    LinesField('learningResourceType',
        vocabulary = DisplayList((
            ("assessment", "Assessment"),
            ("broadcast", "Broadcast"),
            ("course", "Course"),
            ("drill", "Drill and practice"),
            ("educational game", "Educational game"),
            ("demonstration", "Demonstration"),
            ("experiment", "Experiment"),
            ("exploration", "Exploration"),
            ("glossary", "Glossary"),
            ("guide", "Guide"),
            #("learning asset", "Learning asset"),
            ("lesson plan", "Lesson plan"),
            ("open activity", "Open activity"),
            ("reference", "Reference"),
            ("simulation", "Simulation"),
            ("tool", "Tool"),
            ("weblog", "Weblog"),
            ("website", "Web Site"),
            ("wiki", "Wiki"),
            )),
       index = "KeywordIndex:schema",
        multivalued=True,
        copied_in_translation=True,
        widget=TwoColumnMultiSelectionWidget(
            format="checkbox",
            label="Learning resource type",
            label_msgid="label_learning_resource_type",
            description="Choose suitable resource type categories",
            description_msgid="desc_learning_resource_type",
            i18n_domain="lemill",
        ),
    ),
))


schema = material_schema + description + author_schema + group_sharing + lemillreference_schema

schema = schema.copy()
# These widgets should be hidden
toBeHidden = ['allowDiscussion', 'contributors', 'creators', 'rights', 'subject']
for x in schema.keys():
    schema[x].schemata = 'default'
    schema[x].isMetadata = False
    if x in toBeHidden:
        schema[x].widget.visible = {'view': 'invisible', 'edit':'invisible'}
schema.moveField('location', pos='top')
schema.moveField('author', after='title')
schema.moveField('description', after='author')
schema.moveField('tags', after='description')

class LeMillReference(Material):
    """ Reference to external resource """

    schema = schema
    
    meta_type = 'LeMillReference'
    archetype_name = 'LeMillReference'
    default_location = 'content/references'

    portlet = 'here/portlet_lemillreference_actions/macros/portlet'
    security = ClassSecurityInfo()
    security.declareObjectPublic()

    aliases = {
        '(Default)' : 'base_view',
        'view'      : 'base_view',
        'edit'      : 'base_edit'
    }

    def hasComplexWorkflow(self):
        """ Can have drafts or versions """
        return False

    def amIMaterial(self):
        """ references are not proper material"""
        return False

registerType(LeMillReference, PROJECTNAME)