[0] | 1 | # -*- coding: utf-8 -*-
|
---|
| 2 |
|
---|
[11] | 3 | """
|
---|
[16] | 4 | The mailjam project - models.py
|
---|
[11] | 5 |
|
---|
| 6 | This file is released under the BSD license, see LICENSE for
|
---|
| 7 | more information.
|
---|
| 8 |
|
---|
| 9 | Francisco de Borja Lopez Rio - <borja@codigo23.net>
|
---|
| 10 | Soluciones Informaticas Codigo23 S.L.U. - http://codigo23.net
|
---|
| 11 | """
|
---|
| 12 |
|
---|
[0] | 13 | import os
|
---|
| 14 | from tools import validate_email_address
|
---|
[2] | 15 | from storage import JsonStorage as Storage
|
---|
[0] | 16 | import config
|
---|
| 17 |
|
---|
| 18 | class Member():
|
---|
| 19 |
|
---|
| 20 | """
|
---|
| 21 | Class that defines a mailing list member
|
---|
| 22 | """
|
---|
| 23 |
|
---|
| 24 | def __init__(self, address):
|
---|
| 25 | self.address = self._validate_address(address)
|
---|
| 26 |
|
---|
| 27 | def __repr__(self):
|
---|
| 28 | return "<Member '%s'>" % self.address
|
---|
| 29 |
|
---|
| 30 | def __str__(self):
|
---|
| 31 | return self.address
|
---|
| 32 |
|
---|
| 33 | def _validate_address(self, address):
|
---|
| 34 | if not validate_email_address(address):
|
---|
[23] | 35 | raise ValueError(str(address) + ' is not a valid email address')
|
---|
[0] | 36 | return address
|
---|
| 37 |
|
---|
| 38 |
|
---|
| 39 | class MailingList():
|
---|
| 40 |
|
---|
| 41 | """
|
---|
| 42 | Class that defines a mailing list
|
---|
| 43 | """
|
---|
| 44 |
|
---|
[10] | 45 | def __init__(self, name, address, members={}, configfile=None):
|
---|
| 46 | self.configfile = configfile
|
---|
| 47 | self.storage_config = config.get_config_parameters('storage',
|
---|
| 48 | configfile)
|
---|
| 49 | self.archive_config = config.get_config_parameters('archive',
|
---|
| 50 | configfile)
|
---|
| 51 | self.mailing_config = config.get_config_parameters('mailing_lists',
|
---|
| 52 | configfile)
|
---|
[0] | 53 | self.name = name
|
---|
| 54 | self.address = address
|
---|
| 55 | self.members = members
|
---|
[4] | 56 |
|
---|
[0] | 57 | def __repr__(self):
|
---|
| 58 | return "<MailingList '%s'>" % self.address
|
---|
| 59 |
|
---|
| 60 | def __str__(self):
|
---|
| 61 | return self.address
|
---|
| 62 |
|
---|
[2] | 63 | def _validate_member_object(self, member=None):
|
---|
[0] | 64 | if not isinstance(member, Member):
|
---|
[23] | 65 | raise TypeError(str(member) + ' is not a valid Member instance')
|
---|
[0] | 66 | return member
|
---|
| 67 |
|
---|
[2] | 68 | def _validate_member(self, member=None):
|
---|
[0] | 69 | member = self._validate_member_object(member)
|
---|
| 70 | return member.address in self.members_addresses()
|
---|
| 71 |
|
---|
[2] | 72 | def _validate_member_by_address(self, address=None):
|
---|
[0] | 73 | if not validate_email_address(address):
|
---|
[23] | 74 | raise ValueError(str(address) + ' is not a valid email address')
|
---|
[0] | 75 | return address in self.members_addresses()
|
---|
[5] | 76 |
|
---|
| 77 | @property
|
---|
| 78 | def storage(self):
|
---|
[10] | 79 | return Storage(os.path.join(self.storage_config['path'], self.address))
|
---|
[5] | 80 |
|
---|
| 81 | @property
|
---|
| 82 | def archive(self):
|
---|
[10] | 83 | return Storage(os.path.join(self.archive_config['path'], self.address))
|
---|
[5] | 84 |
|
---|
[0] | 85 | def members_addresses(self):
|
---|
| 86 | return self.members.keys()
|
---|
| 87 |
|
---|
| 88 | def add_member(self, member):
|
---|
| 89 | member = self._validate_member_object(member)
|
---|
| 90 | if self._validate_member(member):
|
---|
| 91 | return False
|
---|
| 92 | self.members[member.address] = member
|
---|
| 93 | return True
|
---|
| 94 |
|
---|
[2] | 95 | def add_member_by_address(self, address=None):
|
---|
[0] | 96 | if self._validate_member_by_address(address):
|
---|
| 97 | return False
|
---|
| 98 | member = Member(address)
|
---|
| 99 | self.members[address] = member
|
---|
[1] | 100 | return True
|
---|
[0] | 101 |
|
---|
[2] | 102 | def delete_member(self, member=None):
|
---|
[0] | 103 | member = self._validate_member_object(member)
|
---|
| 104 | if not self._validate_member(member):
|
---|
| 105 | return False
|
---|
| 106 | del self.members[member.address]
|
---|
| 107 | return True
|
---|
| 108 |
|
---|
[5] | 109 | def info(self):
|
---|
| 110 | """
|
---|
[16] | 111 | Returns a dict we can use to add this mailing list to a mailjam
|
---|
[5] | 112 | instance
|
---|
| 113 | """
|
---|
| 114 | # FIXME: This code could be replaced with something that
|
---|
| 115 | # automagically generates the dict from the instance attributes
|
---|
| 116 | return {'name': self.name, 'address': self.address,
|
---|
[10] | 117 | 'members': self.members, 'configfile': self.configfile}
|
---|
[5] | 118 |
|
---|
[0] | 119 | def load(self):
|
---|
| 120 | if self.storage.exists():
|
---|
| 121 | data = self.storage.read()
|
---|
| 122 | self.name = data.name
|
---|
| 123 | self.address = data.address
|
---|
| 124 | self.members = data.members
|
---|
[2] | 125 | return True
|
---|
| 126 | return False
|
---|
[0] | 127 |
|
---|
| 128 | def save(self):
|
---|
| 129 | self.storage.write(self)
|
---|