vmm: comparison VirtualMailManager/domain.py

equal deleted inserted replaced

-:1f9ea5658627
+:5806fb74130b
 class Domain(object):
 """Class to manage e-mail domains."""
 __slots__ = ('_directory', '_gid', '_name', '_qlimit', '_services',
-'_transport', '_dbh', '_new')
+'_transport', '_note', '_dbh', '_new')
 def __init__(self, dbh, domainname):
 """Creates a new Domain instance.
 Loads all relevant data from the database, if the domain could be
 self._gid = 0
 self._qlimit = None
 self._services = None
 self._transport = None
 self._directory = None
+self._note = None
 self._new = True
 self._load()
 def _load(self):
 """Load information from the database and checks if the domain name
 Raises a DomainError if Domain._name isn't the primary name of the
 domain.
 """
 dbc = self._dbh.cursor()
-dbc.execute('SELECT dd.gid, qid, ssid, tid, domaindir, is_primary '
+dbc.execute('SELECT dd.gid, qid, ssid, tid, domaindir, is_primary, '
+'note '
 'FROM domain_data dd, domain_name dn WHERE domainname = '
 '%s AND dn.gid = dd.gid', (self._name,))
 result = dbc.fetchone()
 dbc.close()
 if result:
 self._name, DOMAIN_ALIAS_EXISTS)
 self._gid, self._directory = result[0], result[4]
 self._qlimit = QuotaLimit(self._dbh, qid=result[1])
 self._services = ServiceSet(self._dbh, ssid=result[2])
 self._transport = Transport(self._dbh, tid=result[3])
+self._note = result[6]
 self._new = False
 def _set_gid(self):
 """Sets the ID of the domain - if not set yet."""
 assert self._gid == 0
 NO_SUCH_DOMAIN)
 elif not must_exist and not self._new:
 raise DomErr(_(u"The domain '%s' already exists.") % self._name,
 DOMAIN_EXISTS)
-def _update_tables(self, column, value, force=False):
+def _update_tables(self, column, value):
+"""Update table columns in the domain_data table."""
+dbc = self._dbh.cursor()
+dbc.execute('UPDATE domain_data SET %s = %%s WHERE gid = %%s' % column,
+(value, self._gid))
+if dbc.rowcount > 0:
+self._dbh.commit()
+dbc.close()
+def _update_tables_ref(self, column, value, force=False):
 """Update various columns in the domain_data table. When *force* is
 `True`, the corresponding column in the users table will be reset to
 NULL.
 Arguments:
 `force` : bool
 reset existing users. Default: `False`
 """
 if column not in ('qid', 'ssid', 'tid'):
 raise ValueError('Unknown column: %r' % column)
-dbc = self._dbh.cursor()
+self._update_tables(column, value)
-dbc.execute('UPDATE domain_data SET %s = %%s WHERE gid = %%s' % column,
-(value, self._gid))
-if dbc.rowcount > 0:
-self._dbh.commit()
 if force:
+dbc = self._dbh.cursor()
 dbc.execute('UPDATE users SET %s = NULL WHERE gid = %%s' % column,
 (self._gid,))
 if dbc.rowcount > 0:
 self._dbh.commit()
 dbc.close()
 @property
 def gid(self):
 """The GID of the Domain."""
 return self._gid
 @property
 def transport(self):
 """The Domain's transport."""
 return self._transport
+@property
+def note(self):
+"""The Domain's note."""
+return self._note
 def set_directory(self, basedir):
 """Set the path value of the Domain's directory, inside *basedir*.
 Argument:
 """
 self._chk_state(False)
 assert isinstance(transport, Transport)
 self._transport = transport
+def set_note(self, note):
+"""Set the domain's (optional) note.
+Argument:
+`note` : basestring or None
+The note, or None to remove
+"""
+self._chk_state(False)
+assert note is None or isinstance(note, basestring)
+self._note = note
 def save(self):
 """Stores the new domain in the database."""
 self._chk_state(False)
 assert all((self._directory, self._qlimit, self._services,
 self._transport))
 dbc = self._dbh.cursor()
-dbc.execute('INSERT INTO domain_data (gid, qid, ssid, tid, domaindir) '
+dbc.execute('INSERT INTO domain_data (gid, qid, ssid, tid, domaindir, '
-'VALUES (%s, %s, %s, %s, %s)', (self._gid,
+'note) '
+'VALUES (%s, %s, %s, %s, %s, %s)', (self._gid,
 self._qlimit.qid, self._services.ssid, self._transport.tid,
-self._directory))
+self._directory, self._note))
 dbc.execute('INSERT INTO domain_name (domainname, gid, is_primary) '
 'VALUES (%s, %s, TRUE)', (self._name, self._gid))
 self._dbh.commit()
 dbc.close()
 self._new = False
 u'Dovecot >= v1.1.2.'), VMM_ERROR)
 self._chk_state()
 assert isinstance(quotalimit, QuotaLimit)
 if not force and quotalimit == self._qlimit:
 return
-self._update_tables('qid', quotalimit.qid, force)
+self._update_tables_ref('qid', quotalimit.qid, force)
 self._qlimit = quotalimit
 def update_serviceset(self, serviceset, force=False):
 """Assign a different set of services to the Domain,
 """
 self._chk_state()
 assert isinstance(serviceset, ServiceSet)
 if not force and serviceset == self._services:
 return
-self._update_tables('ssid', serviceset.ssid, force)
+self._update_tables_ref('ssid', serviceset.ssid, force)
 self._services = serviceset
 def update_transport(self, transport, force=False):
 """Sets a new transport for the Domain.
 """
 self._chk_state()
 assert isinstance(transport, Transport)
 if not force and transport == self._transport:
 return
-self._update_tables('tid', transport.tid, force)
+self._update_tables_ref('tid', transport.tid, force)
 self._transport = transport
+def update_note(self, note):
+"""Sets a new note for the Domain.
+Arguments:
+`transport` : basestring or None
+the new note
+"""
+self._chk_state()
+assert note is None or isinstance(note, basestring)
+if note == self._note:
+return
+self._update_tables('note', note)
+self._note = note
 def get_info(self):
 """Returns a dictionary with information about the domain."""
 self._chk_state()
 dbc = self._dbh.cursor()
 if services:
 services.sort()
 else:
 services.append('None')
 info['active services'] = ' '.join(services)
+info['note'] = self._note
 return info
 def get_accounts(self):
 """Returns a list with all accounts of the domain."""
 self._chk_state()

branch	v0.6.x
changeset 539	5806fb74130b
parent 534	6a27c7529cd7
child 568	14abdd04ddf5