source: main/waeup.kofa/branches/0.2/src/waeup/kofa/applicants/root.py @ 15185

Last change on this file since 15185 was 8773, checked in by Henrik Bettermann, 12 years ago

Set main parameters in one buildout section.

  • Property svn:keywords set to Id
File size: 4.2 KB
Line 
1## $Id: root.py 8773 2012-06-21 05:49:59Z henrik $
2##
3## Copyright (C) 2011 Uli Fouquet & Henrik Bettermann
4## This program is free software; you can redistribute it and/or modify
5## it under the terms of the GNU General Public License as published by
6## the Free Software Foundation; either version 2 of the License, or
7## (at your option) any later version.
8##
9## This program is distributed in the hope that it will be useful,
10## but WITHOUT ANY WARRANTY; without even the implied warranty of
11## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12## GNU General Public License for more details.
13##
14## You should have received a copy of the GNU General Public License
15## along with this program; if not, write to the Free Software
16## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17##
18"""
19The root for applicants.
20"""
21import grok
22from hurry.query import Eq
23from hurry.query.interfaces import IQuery
24from zope.component import getUtility
25from zope.schema import getFields
26from waeup.kofa.interfaces import IKofaPluggable
27from waeup.kofa.applicants.interfaces import IApplicantsRoot
28from waeup.kofa.utils.logger import Logger
29from waeup.kofa.utils.helpers import attrs_to_fields
30
31class ApplicantsRoot(grok.Container, Logger):
32    """The root of applicants-related components. It contains only
33    containers for applicants.
34    """
35    grok.implements(IApplicantsRoot)
36
37    local_roles = []
38
39    #: A dictionary to hold per language translations of description string.
40    description_dict = {}
41
42    logger_name = 'waeup.kofa.${sitename}.applicants'
43    logger_filename = 'applicants.log'
44
45ApplicantsRoot = attrs_to_fields(ApplicantsRoot)
46
47class ApplicantsPlugin(grok.GlobalUtility):
48    """A KofaPlugin that creates an applicants root in portal.
49
50    This plugin should be called by a typical
51    `waeup.kofa.app.Universtiy` instance on creation time. The
52    :meth:`update` method normally can also be triggered manually over
53    the main site configuration.
54
55    Implements :class:`waeup.kofa.interfaces.IKofaPluggable`
56    """
57    grok.name('applicants')
58    grok.implements(IKofaPluggable)
59    log_prefix = 'ApplicantsPlugin'
60
61    def setup(self, site, name, logger):
62        """Create a new :class:`ApplicantsRoot` instance in `site`.
63        """
64        site['applicants'] = ApplicantsRoot()
65        logger.info(
66            '%s: Installed applicants root.' % (self.log_prefix,)
67            )
68        return
69
70    def update(self, site, name, logger):
71        """Update site wide ``applicants`` root.
72
73        If the site already contains a suitable ``applicants`` root,
74        leave it that way. If not create one and delete the old one if
75        appropriate.
76        """
77        app_folder = site.get('applicants', None)
78        site_name = getattr(site, '__name__', '<Unnamed Site>')
79        if IApplicantsRoot.providedBy(app_folder):
80            items = getFields(IApplicantsRoot).items()
81            nothing_to_do = True
82            #for i in items:
83            #    if not hasattr(app_folder,i[0]):
84            #        nothing_to_do = False
85            #        setattr(app_folder,i[0],i[1].missing_value)
86            #        logger.info(
87            #            '%s: %s added to root.' % (self.log_prefix,i[0]))
88            # can be removed after upgrading futminna
89            #if not hasattr(app_folder, 'description_dict'):
90            #    nothing_to_do = False
91            #    setattr(app_folder,'description_dict',{})
92            #    logger.info(
93            #        '%s: description_dict added to root.' % self.log_prefix)
94            if nothing_to_do:
95                logger.info(
96                    '%s: Updating site at %s: Nothing to do.' % (
97                        self.log_prefix, site_name,)
98                    )
99            return
100        elif app_folder is not None:
101            # Applicants need update. Remove old instance.
102            logger.warn(
103                '%s: Outdated applicants folder detected at site %s.'
104                'Removing it.' % (self.log_prefix, site_name)
105                    )
106            del site['applicants']
107        # Add new applicants.
108        logger.info(
109            '%s: Updating site at %s. Installing '
110            'applicants.' % (self.log_prefix, site_name,)
111            )
112        self.setup(site, name, logger)
113        return
Note: See TracBrowser for help on using the repository browser.