Person.py 9.01 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2
##############################################################################
#
3 4 5
# Copyright (c) 2002-2005 Nexedi SARL and Contributors. All Rights Reserved.
#                         Jean-Paul Smets-Solanes <jp@nexedi.com>
#                         Kevin Deldycke <kevin_AT_nexedi_DOT_com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
#
# 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.
#
##############################################################################

30
import zope.interface
Jean-Paul Smets's avatar
Jean-Paul Smets committed
31
from AccessControl import ClassSecurityInfo
32
from Products.CMFCore.utils import getToolByName
Jean-Paul Smets's avatar
Jean-Paul Smets committed
33

34
#from Products.ERP5.Core.Node import Node
35

36
from Products.ERP5Type import Permissions, PropertySheet, interfaces
Jean-Paul Smets's avatar
Jean-Paul Smets committed
37
from Products.ERP5Type.XMLObject import XMLObject
38
from Products.ERP5.mixin.encrypted_password import EncryptedPasswordMixin
Jean-Paul Smets's avatar
Jean-Paul Smets committed
39

40 41
try:
  from Products import PluggableAuthService
42
  from Products.ERP5Security.ERP5UserManager import ERP5UserManager
43 44 45
except ImportError:
  PluggableAuthService = None

46
#class Person(Node, XMLObject):
47
class Person(EncryptedPasswordMixin, XMLObject):
Kevin Deldycke's avatar
Kevin Deldycke committed
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
    """
      An Person object holds the information about
      an person (ex. you, me, someone in the company,
      someone outside of the company, a member of the portal,
      etc.).

      Person objects can contain Coordinate objects
      (ex. Telephone, Url) as well a documents of various types.

      Person objects can be synchronized accross multiple
      sites.

      Person objects inherit from the Node base class
      (one of the 5 base classes in the ERP5 universal business model)
    """

    meta_type = 'ERP5 Person'
    portal_type = 'Person'
    add_permission = Permissions.AddPortalContent

68 69
    zope.interface.implements(interfaces.INode)

Kevin Deldycke's avatar
Kevin Deldycke committed
70 71
    # Declarative security
    security = ClassSecurityInfo()
72
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Kevin Deldycke's avatar
Kevin Deldycke committed
73 74 75 76 77 78

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
                      , PropertySheet.CategoryCore
                      , PropertySheet.DublinCore
79
                      , PropertySheet.Reference
80
                      , PropertySheet.Person
Jean-Paul Smets's avatar
Jean-Paul Smets committed
81
                      , PropertySheet.Login
82
                      , PropertySheet.Mapping
83
                      , PropertySheet.Task
84
                      )
Kevin Deldycke's avatar
Kevin Deldycke committed
85 86 87

    def _setTitle(self, value):
      """
88
        Here we see that we must define a notion
Kevin Deldycke's avatar
Kevin Deldycke committed
89 90 91 92 93
        of priority in the way fields are updated
      """
      if value != self.getTitle():
        self.title = value

94 95
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getTitle')
Kevin Deldycke's avatar
Kevin Deldycke committed
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
    def getTitle(self, **kw):
      """
        Returns the title if it exists or a combination of
        first name and last name
      """
      if self.title == '':
        name_list = []
        if self.getFirstName() not in (None, ''):
          name_list.append(self.getFirstName())
        if self.getMiddleName() not in (None, ''):
          name_list.append(self.getMiddleName())
        if self.getLastName() not in (None, ''):
          name_list.append(self.getLastName())
        return ' '.join(name_list)
      else:
        return self.title
112

113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getTranslatedTitle')
    def getTranslatedTitle(self, **kw):
      """
        Returns the title if it exists or a combination of
        first name and last name
      """
      if self.title == '':
        name_list = []
        if self.getTranslatedFirstName(**kw) not in (None, ''):
          name_list.append(self.getTranslatedFirstName(**kw))
        if self.getTranslatedMiddleName(**kw) not in (None, ''):
          name_list.append(self.getTranslatedMiddleName(**kw))
        if self.getTranslatedLastName(**kw) not in (None, ''):
          name_list.append(self.getTranslatedLastName(**kw))
        return ' '.join(name_list)
      else:
        return self.title

132 133 134 135
    security.declareProtected(Permissions.AccessContentsInformation,
                              'title_or_id')
    def title_or_id(self):
      return self.getTitleOrId()
Kevin Deldycke's avatar
Kevin Deldycke committed
136

137 138 139 140 141
    security.declareProtected(Permissions.AccessContentsInformation,
                              'hasTitle')
    def hasTitle(self):
      return not not self.getTitle()

Kevin Deldycke's avatar
Kevin Deldycke committed
142 143 144 145
    def _setFirstName(self, value):
      """
        Update Title if first_name is modified
      """
146 147 148 149 150
      self._baseSetFirstName(value)
      name_list = []
      if self.getFirstName(): name_list.append(self.getFirstName())
      if self.getLastName(): name_list.append(self.getLastName())
      if name_list: self._setTitle(' '.join(name_list))
Kevin Deldycke's avatar
Kevin Deldycke committed
151 152 153 154 155

    def _setLastName(self, value):
      """
        Update Title if last_name is modified
      """
156 157 158 159 160
      self._baseSetLastName(value)
      name_list = []
      if self.getFirstName(): name_list.append(self.getFirstName())
      if self.getLastName(): name_list.append(self.getLastName())
      if name_list: self._setTitle(' '.join(name_list))
161 162 163 164 165 166 167 168

    security.declareProtected('Manage users', 'setReference')
    def setReference(self, value):
      """
        Set the user id. This method is defined explicitly, because:

        - we want to apply a different permission

169 170
        - we want to prevent duplicated user ids, but only when
          PAS _AND_ ERP5UserManager are used
171 172
      """
      if value:
173 174 175 176
        acl_users = getToolByName(self, 'acl_users')
        if PluggableAuthService is not None and isinstance(acl_users,
              PluggableAuthService.PluggableAuthService.PluggableAuthService):
          plugin_list = acl_users.plugins.listPlugins(
177 178 179
              PluggableAuthService.interfaces.plugins.IUserEnumerationPlugin)
          for plugin_name, plugin_value in plugin_list:
            if isinstance(plugin_value, ERP5UserManager):
180 181
              user_list = acl_users.searchUsers(id=value,
                                                exact_match=True)
182 183 184
              if len(user_list) > 0:
                raise RuntimeError, 'user id %s already exist' % (value,)
              break
185 186
      self._setReference(value)
      self.reindexObject()
187
      # invalid the cache for ERP5Security
188 189
      portal_caches = getToolByName(self.getPortalObject(), 'portal_caches')
      portal_caches.clearCache(cache_factory_list=('erp5_content_short', ))
190

191 192 193 194 195 196
    # Time management
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getAvailableTime')
    def getAvailableTime(self, *args, **kw):
      """
      Calculate available time for a person
197

198
      See SimulationTool.getAvailableTime
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
      """
      assignment_list = self.contentValues(portal_type='Assignment')
      calendar_uid_list = []
      for assignment in assignment_list:
        calendar_uid_list.extend(assignment.getCalendarUidList())
      kw['node'] = [self.getUid()] + calendar_uid_list

      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getAvailableTime(*args, **kw)

    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getAvailableTimeSequence')
    def getAvailableTimeSequence(self, *args, **kw):
      """
      Calculate available time for a person in a sequence
214 215
      
      See SimulationTool.getAvailableTimeSequence
216 217 218 219 220 221 222 223 224
      """
      assignment_list = self.contentValues(portal_type='Assignment')
      calendar_uid_list = []
      for assignment in assignment_list:
        calendar_uid_list.extend(assignment.getCalendarUidList())
      kw['node'] = [self.getUid()] + calendar_uid_list

      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getAvailableTimeSequence(*args, **kw)
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241

    # Notifiation API
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'notifyMessage')
    def notifyMessage(self, message):
      """
      This method can only be called with proxy roles.

      A per user preference allows for deciding how to be notified.
      - by email
      - by SMS (if meaningful)
      - daily
      - weekly
      - instantly

      notification is handled as an activity
      """