init.py
No OneTemporary
Actions

Authored By

Unknown

Size

44 KB

Referenced Files

None

Subscribers

None

init.py
View Options

	# -- coding: utf-8 --
	# Copyright 2010-2013 Kolab Systems AG (http://www.kolabsys.com)
	#
	# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
	#
	# 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 3 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, see <http://www.gnu.org/licenses/>.
	#
	from six import string_types

	import logging
	import re
	import time
	import socket
	import sys

	try:
	from urlparse import urlparse
	except ImportError:
	from urllib.parse import urlparse

	import pykolab
	from pykolab import utils
	from pykolab.translate import _

	log = pykolab.getLogger('pykolab.imap')
	conf = pykolab.getConf()


	class IMAP(object):
	def __init__(self):
	# Pool of named IMAP connections, by hostname
	self._imap = {}

	# Place holder for the current IMAP connection
	self.imap = None

	def cleanup_acls(self, aci_subject):
	log.info(
	_("Cleaning up ACL entries for %s across all folders") % (
	aci_subject
	)
	)

	lm_suffix = ""
	if len(aci_subject.split('@')) > 1:
	lm_suffix = "@%s" % (aci_subject.split('@')[1])

	shared_folders = self.imap.lm("shared/*%s" % (lm_suffix))

	user_folders = self.imap.lm("user/*%s" % (lm_suffix))

	# For all folders (shared and user), ...
	folders = user_folders + shared_folders

	log.debug(_("Iterating over %d folders") % (len(folders)), level=5)

	# ... loop through them and ...
	for folder in folders:
	try:
	# ... list the ACL entries
	acls = self.imap.lam(folder)

	# For each ACL entry, see if we think it is a current, valid
	# entry
	for acl_entry in acls:
	# If the key 'acl_entry' does not exist in the dictionary
	# of valid ACL entries, this ACL entry has got to go.
	if acl_entry == aci_subject:
	# Set the ACL to '' (effectively deleting the ACL
	# entry)
	log.debug(
	_(
	"Removing acl %r for subject %r from folder %r"
	) % (
	acls[acl_entry],
	acl_entry,
	folder
	),
	level=8
	)

	self.set_acl(folder, acl_entry, '')

	except Exception as errmsg:
	log.error(
	_("Failed to read/set ACL on folder %s: %r") % (
	folder,
	errmsg
	)
	)

	def connect(self, uri=None, server=None, domain=None, login=True):
	"""
	Connect to the appropriate IMAP backend.

	Supply a domain (name space) configured in the configuration file
	as a section, with a setting 'imap_uri' to connect to a domain
	specific IMAP server, or specify an URI to connect to that
	particular IMAP server (in that order).

	Routines sitting behind this will take into account Cyrus IMAP
	Murder capabilities, brokering actions to take place against the
	correct server (such as a 'xfer' which needs to happen against the
	source backend).
	"""

	# TODO: We are currently compatible with one IMAP backend technology per
	# deployment.
	backend = conf.get('kolab', 'imap_backend')

	if domain is not None:
	self.domain = domain
	if conf.has_section(domain) and conf.has_option(domain, 'imap_backend'):
	backend = conf.get(domain, 'imap_backend')

	if uri is None:
	if conf.has_section(domain) and conf.has_option(domain, 'imap_uri'):
	uri = conf.get(domain, 'imap_uri')
	else:
	self.domain = None

	scheme = None
	hostname = None
	port = None

	if uri is None:
	uri = conf.get(backend, 'uri')

	result = urlparse(uri)

	if hasattr(result, 'netloc'):
	scheme = result.scheme
	if len(result.netloc.split(':')) > 1:
	hostname = result.netloc.split(':')[0]
	port = result.netloc.split(':')[1]
	else:
	hostname = result.netloc

	elif hasattr(result, 'hostname'):
	hostname = result.hostname
	else:
	scheme = uri.split(':')[0]
	(hostname, port) = uri.split('/')[2].split(':')

	if server is not None:
	hostname = server

	if scheme is None or scheme == "":
	scheme = 'imaps'

	if port is None:
	if scheme == "imaps":
	port = 993
	elif scheme == "imap":
	port = 143
	else:
	port = 993

	uri = '%s://%s:%s' % (scheme, hostname, port)

	# Get the credentials
	admin_login = conf.get(backend, 'admin_login')
	admin_password = conf.get(backend, 'admin_password')

	if admin_password is None or admin_password == '':
	log.error(_("No administrator password is available."))

	if hostname not in self._imap:
	if backend == 'cyrus-imap':
	from . import cyrus
	self._imap[hostname] = cyrus.Cyrus(uri)
	# Actually connect
	if login:
	log.debug(_("Logging on to Cyrus IMAP server %s") % (hostname), level=8)
	self._imap[hostname].login(admin_login, admin_password)
	self._imap[hostname].logged_in = True

	elif backend == 'dovecot':
	from . import dovecot
	self._imap[hostname] = dovecot.Dovecot(uri)
	# Actually connect
	if login:
	log.debug(_("Logging on to Dovecot IMAP server %s") % (hostname), level=8)
	self._imap[hostname].login(admin_login, admin_password)
	self._imap[hostname].logged_in = True

	else:
	import imaplib
	self._imap[hostname] = imaplib.IMAP4(hostname, port)
	# Actually connect
	if login:
	log.debug(_("Logging on to generic IMAP server %s") % (hostname), level=8)
	self._imap[hostname].login(admin_login, admin_password)
	self._imap[hostname].logged_in = True

	else:
	if not login:
	self.disconnect(hostname)
	self.connect(uri=uri, login=False)
	elif login and not hasattr(self._imap[hostname], 'logged_in'):
	self.disconnect(hostname)
	self.connect(uri=uri)
	else:
	try:
	if hasattr(self._imap[hostname], 'm'):
	self._imap[hostname].m.noop()
	elif hasattr(self._imap[hostname], 'noop') \
	and callable(self._imap[hostname].noop):

	self._imap[hostname].noop()

	log.debug(
	_("Reusing existing IMAP server connection to %s") % (hostname),
	level=8
	)

	except Exception:
	log.debug(_("Reconnecting to IMAP server %s") % (hostname), level=8)
	self.disconnect(hostname)
	self.connect()

	# Set the newly created technology specific IMAP library as the current
	# IMAP connection to be used.
	self.imap = self._imap[hostname]

	if hasattr(self.imap, 'm') and hasattr(self.imap.m, 'sock'):
	self._set_socket_keepalive(self.imap.m.sock)
	elif hasattr(self.imap, 'sock'):
	self._set_socket_keepalive(self.imap.sock)

	def disconnect(self, server=None):
	if server is None:
	# No server specified, but make sure self.imap is None anyways
	if hasattr(self, 'imap'):
	del self.imap

	# Empty out self._imap as well
	for key in list(self._imap):
	del self._imap[key]

	else:
	if server in self._imap:
	del self._imap[server]
	else:
	log.warning(
	_("Called imap.disconnect() on a server that we had no connection to.")
	)

	def create_folder(self, folder_path, server=None, partition=None):
	folder_path = self.folder_utf7(folder_path)

	if server is not None:
	self.connect(server=server)

	try:
	self._imap[server].cm(folder_path, partition=partition)
	return True
	except Exception as excpt:
	log.error(
	_("Could not create folder %r on server %r: %r") % (folder_path, server, excpt)
	)

	else:
	try:
	self.imap.cm(folder_path, partition=partition)
	return True
	except Exception as excpt:
	log.error(_("Could not create folder %r: %r") % (folder_path, excpt))
	return False

	def __getattr__(self, name):
	if hasattr(self.imap, name):
	return getattr(self.imap, name)

	if hasattr(self.imap, 'm'):
	if hasattr(self.imap.m, name):
	return getattr(self.imap.m, name)

	raise AttributeError(_("%r has no attribute %s") % (self, name))

	def append(self, folder, message):
	return self.imap.m.append(self.folder_utf7(folder), None, None, message)

	def folder_utf7(self, folder):
	from pykolab import imap_utf7
	return imap_utf7.encode(folder)

	def folder_utf8(self, folder):
	from pykolab import imap_utf7
	return imap_utf7.decode(folder)

	def folder_quote(self, folder):
	return u'"' + str(folder).strip('"') + '"'

	def get_metadata(self, folder):
	"""
	Obtain all metadata entries on a folder
	"""
	metadata = {}

	_metadata = self.imap.getannotation(self.folder_utf7(folder), '*')

	for (k, v) in _metadata.items():
	metadata[self.folder_utf8(k)] = v

	return metadata

	def get_separator(self):
	if not hasattr(self, 'imap') or self.imap is None:
	self.connect()

	if hasattr(self.imap, 'separator'):
	return self.imap.separator
	elif hasattr(self.imap, 'm') and hasattr(self.imap.m, 'separator'):
	return self.imap.m.separator
	else:
	return '/'

	def imap_murder(self):
	if hasattr(self.imap, 'murder') and self.imap.murder:
	return True
	else:
	return False

	def namespaces(self):
	"""
	Obtain the namespaces.

	Returns a tuple of:

	(str(personal) [, str(other users) [, list(shared)]])
	"""

	_personal = None
	_other_users = None
	_shared = None

	(_response, _namespaces) = self.imap.m.namespace()

	if len(_namespaces) == 1:
	_namespaces = _namespaces[0]

	_namespaces = re.split(r"\)\)\s\(\(", _namespaces)

	if len(_namespaces) >= 3:
	_shared = []
	_shared.append(' '.join(_namespaces[2].replace('((', '').replace('))', '').split()[:-1]).replace('"', ''))

	if len(_namespaces) >= 2:
	_other_users = ' '.join(_namespaces[1].replace('((', '').replace('))', '').split()[:-1]).replace('"', '')

	if len(_namespaces) >= 1:
	_personal = _namespaces[0].replace('((', '').replace('))', '').split()[0].replace('"', '')

	return (_personal, _other_users, _shared)

	def set_acl(self, folder, identifier, acl):
	"""
	Set an ACL entry on a folder.
	"""
	_acl = ''

	short_rights = {
	'all': 'lrsedntxakcpiw',
	'append': 'wip',
	'full': 'lrswipkxtecdn',
	'read': 'lrs',
	'read-only': 'lrs',
	'read-write': 'lrswitedn',
	'post': 'p',
	'semi-full': 'lrswit',
	'write': 'lrswite',
	}

	if acl in short_rights:
	acl = short_rights[acl]
	else:
	for char in acl:
	if char in "-+":
	continue

	if not char in short_rights['all']:
	log.error(_("Invalid access identifier %r for subject %r") % (acl, identifier))
	return False

	# Special treatment for '-' and '+' characters
	if '+' in acl or '-' in acl:
	acl_map = {
	'set': '',
	'subtract': '',
	'add': ''
	}

	mode = 'set'
	for char in acl:
	if char == '-':
	mode = 'subtract'
	continue
	if char == '+':
	mode = 'add'
	continue

	acl_map[mode] += char

	current_acls = self.imap.lam(self.folder_utf7(folder))
	for current_acl in current_acls:
	if current_acl == identifier:
	_acl = current_acls[current_acl]
	break

	_acl = _acl + acl_map['set'] + acl_map['add']

	_acl = [x for x in _acl.split() if x not in acl_map['subtract'].split()]
	acl = ''.join(list(set(_acl)))

	try:
	self.imap.sam(self.folder_utf7(folder), identifier, acl)
	except Exception as errmsg:
	log.error(
	_("Could not set ACL for %s on folder %s: %r") % (
	identifier,
	folder,
	errmsg
	)
	)

	def del_acl(self, folder, identifier):
	try:
	self.imap.dam(self.folder_utf7(folder), identifier)
	except Exception as errmsg:
	log.error(
	_("Could not delete ACL for %s on folder %s: %r") % (
	identifier,
	folder,
	errmsg
	)
	)

	def set_metadata(self, folder, metadata_path, metadata_value, shared=True):
	"""
	Set a metadata entry on a folder
	"""

	if metadata_path.startswith('/shared/'):
	shared = True
	metadata_path = metadata_path.replace('/shared/', '/')
	elif metadata_path.startswith('/private/'):
	shared = False
	metadata_path = metadata_path.replace('/private/', '/')

	self.imap._setannotation(self.folder_utf7(folder), metadata_path, metadata_value, shared)

	def shared_folder_create(self, folder_path, server=None):
	"""
	Create a shared folder.
	"""

	folder_name = "shared%s%s" % (self.get_separator(), folder_path)

	# Correct folder_path being supplied with "shared/shared/" for example
	if folder_name.startswith("shared%s" % (self.get_separator()) * 2):
	folder_name = folder_name[7:]

	log.info(_("Creating new shared folder %s") % (folder_name))
	self.create_folder(folder_name, server)

	def shared_folder_exists(self, folder_path):
	"""
	Check if a shared mailbox exists.
	"""
	folder_name = 'shared%s%s' % (self.get_separator(), folder_path)

	# Correct folder_path being supplied with "shared/shared/" for example
	if folder_name.startswith("shared%s" % (self.get_separator()) * 2):
	folder_name = folder_name[7:]

	return self.has_folder(folder_name)

	def shared_folder_rename(self, old, new):
	if not self.has_folder(old):
	log.error("Shared Folder rename error: Folder %s does not exist" % (old))
	return

	if self.has_folder(new):
	log.error("Shared Folder rename error: Folder %s already exists" % (new))
	return

	self.imap._rename(old, new)

	def shared_folder_set_type(self, folder_path, folder_type):
	folder_name = 'shared%s%s' % (self.get_separator(), folder_path)

	# Correct folder_path being supplied with "shared/shared/" for example
	if folder_name.startswith("shared%s" % (self.get_separator()) * 2):
	folder_name = folder_name[7:]

	self.set_metadata(folder_name, '/shared/vendor/kolab/folder-type', folder_type)

	def shared_mailbox_create(self, mailbox_base_name, server=None):
	"""
	Create a shared folder.
	"""
	self.connect()

	folder_name = "shared%s%s" % (self.get_separator(), mailbox_base_name)

	# Correct folder_path being supplied with "shared/shared/" for example
	if folder_name.startswith("shared%s" % (self.get_separator()) * 2):
	folder_name = folder_name[7:]

	log.info(_("Creating new shared folder %s") %(mailbox_base_name))
	self.create_folder(folder_name, server)

	def shared_mailbox_exists(self, mailbox_base_name):
	"""
	Check if a shared mailbox exists.
	"""
	self.connect()

	folder_name = "shared%s%s" % (self.get_separator(), mailbox_base_name)

	# Correct folder_path being supplied with "shared/shared/" for example
	if folder_name.startswith("shared%s" % (self.get_separator()) * 2):
	folder_name = folder_name[7:]

	return self.has_folder(folder_name)

	def user_mailbox_create(self, mailbox_base_name, server=None):
	"""
	Create a user mailbox.

	Returns the full path to the new mailbox folder.
	"""
	# TODO: Whether or not to lowercase the mailbox name is really up to the
	# IMAP server setting username_tolower (normalize_uid, lmtp_downcase_rcpt).

	self.connect()

	if not mailbox_base_name == mailbox_base_name.lower():
	log.warning(_("Downcasing mailbox name %r") % (mailbox_base_name))
	mailbox_base_name = mailbox_base_name.lower()

	folder_name = "user%s%s" % (self.get_separator(), mailbox_base_name)
	log.info(_("Creating new mailbox for user %s") %(mailbox_base_name))

	success = self._create_folder_waiting(folder_name, server)

	if not success:
	log.error(_("Could not create the mailbox for user %s, aborting." % (mailbox_base_name)))
	return False

	_additional_folders = None

	if not hasattr(self, 'domain'):
	self.domain = None

	if self.domain is None and len(mailbox_base_name.split('@')) > 1:
	self.domain = mailbox_base_name.split('@')[1]

	if not self.domain is None:
	if conf.has_option(self.domain, "autocreate_folders"):
	_additional_folders = conf.get_raw(
	self.domain,
	"autocreate_folders"
	)

	else:
	from pykolab.auth import Auth
	auth = Auth()
	auth.connect()

	domains = auth.list_domains(self.domain)

	auth.disconnect()

	if len(domains) > 0:
	if self.domain in domains:
	primary = domains[self.domain]

	if conf.has_option(primary, "autocreate_folders"):
	_additional_folders = conf.get_raw(
	primary,
	"autocreate_folders"
	)

	if _additional_folders is None:
	if conf.has_option('kolab', "autocreate_folders"):
	_additional_folders = conf.get_raw(
	'kolab',
	"autocreate_folders"
	)

	additional_folders = conf.plugins.exec_hook(
	"create_user_folders",
	kw={
	'folder': folder_name,
	'additional_folders': _additional_folders
	}
	)

	if additional_folders is not None:
	self.user_mailbox_create_additional_folders(
	mailbox_base_name,
	additional_folders
	)

	if not self.domain is None:
	if conf.has_option(self.domain, "sieve_mgmt"):
	sieve_mgmt_enabled = conf.get(self.domain, 'sieve_mgmt')
	if utils.true_or_false(sieve_mgmt_enabled):
	conf.plugins.exec_hook(
	'sieve_mgmt_refresh',
	kw={
	'user': mailbox_base_name
	}
	)

	return folder_name

	def user_mailbox_create_additional_folders(self, user, additional_folders):
	log.debug(
	_("Creating additional folders for user %s") % (user),
	level=8
	)

	backend = conf.get('kolab', 'imap_backend')

	admin_login = conf.get(backend, 'admin_login')
	admin_password = conf.get(backend, 'admin_password')

	folder = 'user%s%s' % (self.get_separator(), user)

	if self.imap_murder():
	server = self.user_mailbox_server(folder)
	else:
	server = None

	success = False
	last_log = time.time()
	while not success:
	try:
	self.disconnect()
	self.connect(login=False, server=server)
	self.login_plain(admin_login, admin_password, user)
	(personal, other, shared) = self.namespaces()
	success = True
	except Exception as errmsg:
	if time.time() - last_log > 5 and self.imap_murder():
	log.debug(_("Waiting for the Cyrus murder to settle... %r") % (errmsg))
	last_log = time.time()

	if conf.debuglevel > 8:
	import traceback
	traceback.print_exc()

	time.sleep(0.5)

	for additional_folder in additional_folders:
	_add_folder = {}

	folder_name = additional_folder

	if not folder_name.startswith(personal):
	log.error(_("Correcting additional folder name from %r to %r") % (folder_name, "%s%s" % (personal, folder_name)))
	folder_name = "%s%s" % (personal, folder_name)


	success = self._create_folder_waiting(folder_name)

	if not success:
	log.warning(_("Failed to create folder: %s") % (folder_name))
	continue

	if "annotations" in additional_folders[additional_folder]:
	for annotation in additional_folders[additional_folder]["annotations"]:
	self.set_metadata(
	folder_name,
	"%s" % (annotation),
	"%s" % (additional_folders[additional_folder]["annotations"][annotation])
	)

	if "acls" in additional_folders[additional_folder]:
	for acl in additional_folders[additional_folder]["acls"]:
	self.set_acl(
	folder_name,
	"%s" % (acl),
	"%s" % (additional_folders[additional_folder]["acls"][acl])
	)

	if len(user.split('@')) > 1:
	localpart = user.split('@')[0]
	domain = user.split('@')[1]
	domain_suffix = "@%s" % (domain)
	else:
	localpart = user
	domain = None
	domain_suffix = ""

	if domain is not None:
	if conf.has_section(domain) and conf.has_option(domain, 'imap_backend'):
	backend = conf.get(domain, 'imap_backend')

	if conf.has_section(domain) and conf.has_option(domain, 'imap_uri'):
	uri = conf.get(domain, 'imap_uri')
	else:
	uri = None

	log.debug(_("Subscribing user to the additional folders"), level=8)

	_tests = []

	# Subscribe only to personal folders
	(personal, other, shared) = self.namespaces()

	if other is not None:
	_tests.append(other)

	if shared is not None:
	for _shared in shared:
	_tests.append(_shared)

	log.debug(_("Using the following tests for folder subscriptions:"), level=8)
	for _test in _tests:
	log.debug(_(" %r") % (_test), level=8)

	for _folder in self.lm():
	log.debug(_("Folder %s") % (_folder), level=8)

	_subscribe = True

	for _test in _tests:
	if not _subscribe:
	continue

	if _folder.startswith(_test):
	_subscribe = False

	if _subscribe:
	log.debug(_("Subscribing %s to folder %s") % (user, _folder), level=8)
	try:
	self.subscribe(_folder)
	except Exception as errmsg:
	log.error(_("Subscribing %s to folder %s failed: %r") % (user, _folder, errmsg))

	self.logout()
	self.connect(domain=self.domain)

	for additional_folder in additional_folders:
	if additional_folder.startswith(personal) and not personal == '':
	folder_name = additional_folder.replace(personal, '')
	else:
	folder_name = additional_folder

	folder_name = "user%s%s%s%s%s" % (
	self.get_separator(),
	localpart,
	self.get_separator(),
	folder_name,
	domain_suffix
	)

	if "quota" in additional_folders[additional_folder]:
	try:
	self.imap.sq(
	folder_name,
	additional_folders[additional_folder]['quota']
	)
	except Exception as errmsg:
	log.error(_("Could not set quota on %s") % (additional_folder))

	if "partition" in additional_folders[additional_folder]:
	partition = additional_folders[additional_folder]["partition"]
	try:
	self.imap._rename(folder_name, folder_name, partition)
	except:
	log.error(_("Could not rename %s to reside on partition %s") % (folder_name, partition))

	def _create_folder_waiting(self, folder_name, server=None):
	"""
	Create a folder and wait to make sure it exists
	"""

	created = False

	try:
	max_tries = 10
	while not created and max_tries > 0:
	created = self.create_folder(folder_name, server)
	if not created:
	self.disconnect()
	max_tries -= 1
	time.sleep(1)
	self.connect()

	# In a Cyrus IMAP Murder topology, wait for the murder to have settled
	if created and self.imap_murder():
	success = False
	last_log = time.time()
	reconnect_counter = 0
	while not success:
	success = self.has_folder(folder_name)
	if not success:
	if time.time() - last_log > 5:
	reconnect_counter += 1
	log.info(_("Waiting for the Cyrus IMAP Murder to settle..."))
	if reconnect_counter == 6:
	log.warning(_("Waited for 15 seconds, going to reconnect"))
	reconnect_counter = 0
	self.disconnect()
	self.connect()

	last_log = time.time()

	time.sleep(0.5)
	except:
	if conf.debuglevel > 8:
	import traceback
	traceback.print_exc()

	return created

	def user_mailbox_delete(self, mailbox_base_name):
	"""
	Delete a user mailbox.
	"""
	self.connect()

	folder = "user%s%s" %(self.get_separator(), mailbox_base_name)
	self.delete_mailfolder(folder)
	self.cleanup_acls(mailbox_base_name)

	def user_mailbox_exists(self, mailbox_base_name):
	"""
	Check if a user mailbox exists.
	"""
	self.connect()

	if not mailbox_base_name == mailbox_base_name.lower():
	log.warning(_("Downcasing mailbox name %r") % (mailbox_base_name))
	mailbox_base_name = mailbox_base_name.lower()

	return self.has_folder('user%s%s' %(self.get_separator(), mailbox_base_name))

	def user_mailbox_quota(self, mailbox_quota):
	pass

	def user_mailbox_rename(self, old_name, new_name, partition=None):
	self.connect()

	old_name = "user%s%s" % (self.get_separator(), old_name)
	new_name = "user%s%s" % (self.get_separator(), new_name)

	if old_name == new_name and partition is None:
	return

	if not self.has_folder(old_name):
	log.error(_("INBOX folder to rename (%s) does not exist") % (old_name))

	if not self.has_folder(new_name) or not partition is None:
	log.info(_("Renaming INBOX from %s to %s") % (old_name, new_name))
	try:
	self.imap.rename(old_name, new_name, partition)
	except:
	log.error(_("Could not rename INBOX folder %s to %s") % (old_name, new_name))
	else:
	log.warning(_("Moving INBOX folder %s won't succeed as target folder %s already exists") % (old_name, new_name))

	def user_mailbox_server(self, mailbox):
	server = self.imap.find_mailfolder_server(mailbox.lower()).lower()
	log.debug(_("Server for mailbox %r is %r") % (mailbox, server), level=8)
	return server

	def has_folder(self, folder):
	"""
	Check if the environment has a folder named folder.
	"""
	folders = self.imap.lm(self.folder_utf7(folder))
	log.debug(_("Looking for folder '%s', we found folders: %r") % (folder, [self.folder_utf8(x) for x in folders]), level=8)
	# Greater then one, this folder may have subfolders.
	if len(folders) > 0:
	return True
	else:
	return False

	def _set_socket_keepalive(self, sock):
	sock.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)

	with open('/proc/sys/net/ipv4/tcp_keepalive_time', 'r') as f:
	sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, (int)(f.read()))

	with open('/proc/sys/net/ipv4/tcp_keepalive_intvl', 'r') as f:
	sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, (int)(f.read()))

	with open('/proc/sys/net/ipv4/tcp_keepalive_probes', 'r') as f:
	sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPCNT, (int)(f.read()))

	def _set_kolab_mailfolder_acls(self, acls, folder=None, update=False):
	# special case, folder has no ACLs assigned and update was requested,
	# remove all existing ACL entries
	if update is True and isinstance(acls, list) and len(acls) == 0:
	acls = self.list_acls(folder)
	for subject in acls:
	log.debug(
	_("Removing ACL rights %s for subject %s on folder " + \
	"%s") % (acls[subject], subject, folder), level=8)
	self.set_acl(folder, subject, '')

	return

	if isinstance(acls, string_types):
	acls = [ acls ]

	old_acls = None

	for acl in acls:
	acl = eval("%s" % (acl))
	subject = acl[0]
	rights = acl[1]
	if len(acl) == 3:
	epoch = acl[2]
	else:
	epoch = (int)(time.time()) + 3600

	# update mode, check existing entries
	if update is True:
	if old_acls is None:
	old_acls = self.list_acls(folder)
	for old_subject in old_acls:
	old_acls[old_subject] = old_acls[old_subject]

	if subject in old_acls:
	old_acls[subject] = None

	if epoch > (int)(time.time()):
	log.debug(
	_("Setting ACL rights %s for subject %s on folder " + \
	"%s") % (rights, subject, folder), level=8)

	self.set_acl(
	folder,
	"%s" % (subject),
	"%s" % (rights)
	)

	else:
	log.debug(
	_("Removing ACL rights %s for subject %s on folder " + \
	"%s") % (rights, subject, folder), level=8)

	self.set_acl(
	folder,
	"%s" % (subject),
	""
	)

	# update mode, unset removed ACL entries
	if old_acls is not None:
	for subject in old_acls:
	if old_acls[subject] is not None:
	log.debug(
	_("Removing ACL rights %s for subject %s on folder " + \
	"%s") % (old_acls[subject], subject, folder), level=8)
	self.set_acl(folder, subject, '')

	pass

	""" Blah functions """

	def move_user_folders(self, users=[], domain=None):
	for user in users:
	if type(user) == dict:
	if 'old_mail' in user:
	inbox = "user/%s" % (user['mail'])
	old_inbox = "user/%s" % (user['old_mail'])

	if self.has_folder(old_inbox):
	log.debug(_("Found old INBOX folder %s") % (old_inbox), level=8)

	if not self.has_folder(inbox):
	log.info(_("Renaming INBOX from %s to %s") % (old_inbox, inbox))
	self.imap.rename(old_inbox, inbox)
	self.inbox_folders.append(inbox)
	else:
	log.warning(_("Moving INBOX folder %s won't succeed as target folder %s already exists") % (old_inbox, inbox))
	else:
	log.debug(_("Did not find old folder user/%s to rename") % (user['old_mail']), level=8)
	else:
	log.debug(_("Value for user is not a dictionary"), level=8)

	def set_quota(self, folder, quota):
	i = 0
	while i < 10:
	try:
	self.imap._setquota(folder, quota)
	i = 10
	except:
	self.disconnect()
	self.connect()
	i += 1

	def set_user_folder_quota(self, users=[], primary_domain=None, secondary_domain=[], folders=[]):
	"""

	Sets the quota in IMAP using the authentication and authorization
	database 'quota' attribute for the users listed in parameter 'users'
	"""
	if conf.has_option(primary_domain, 'quota_attribute'):
	_quota_attr = conf.get(primary_domain, 'quota_attribute')
	else:
	auth_mechanism = conf.get('kolab', 'auth_mechanism')
	_quota_attr = conf.get(auth_mechanism, 'quota_attribute')

	_inbox_folder_attr = conf.get('cyrus-sasl', 'result_attribute')

	default_quota = auth.domain_default_quota(primary_domain)

	if default_quota == "" or default_quota is None:
	default_quota = 0

	if len(users) == 0:
	users = auth.list_users(primary_domain)

	for user in users:
	quota = None

	if type(user) == dict:
	if _quota_attr in user:
	if type(user[_quota_attr]) == list:
	quota = user[_quota_attr].pop(0)
	elif type(user[_quota_attr]) == str:
	quota = user[_quota_attr]
	else:
	_quota = auth.get_user_attribute(primary_domain, user, _quota_attr)
	if _quota is None:
	quota = 0
	else:
	quota = _quota

	if _inbox_folder_attr not in user:
	continue
	else:
	if type(user[_inbox_folder_attr]) == list:
	folder = "user/%s" % user[_inbox_folder_attr].pop(0)
	elif type(user[_inbox_folder_attr]) == str:
	folder = "user/%s" % user[_inbox_folder_attr]
	elif type(user) == str:
	quota = auth.get_user_attribute(user, _quota_attr)
	folder = "user/%s" % (user)

	folder = folder.lower()

	try:
	(used, current_quota) = self.imap.lq(folder)
	except:
	# TODO: Go in fact correct the quota.
	log.warning(_("Cannot get current IMAP quota for folder %s") % (folder))
	used = 0
	current_quota = 0

	new_quota = conf.plugins.exec_hook("set_user_folder_quota", kw={
	'used': used,
	'current_quota': current_quota,
	'new_quota': (int)(quota),
	'default_quota': (int)(default_quota),
	'user': user
	}
	)

	log.debug(_("Quota for %s currently is %s") % (folder, current_quota), level=7)

	if new_quota is None:
	continue

	if not int(new_quota) == int(quota):
	log.info(_("Adjusting authentication database quota for folder %s to %d") % (folder, int(new_quota)))
	quota = int(new_quota)
	auth.set_user_attribute(primary_domain, user, _quota_attr, new_quota)

	if not int(current_quota) == int(quota):
	log.info(_("Correcting quota for %s to %s (currently %s)") % (folder, quota, current_quota))
	self.imap._setquota(folder, quota)

	def set_user_mailhost(self, users=[], primary_domain=None, secondary_domain=[], folders=[]):
	if conf.has_option(primary_domain, 'mailserver_attribute'):
	_mailserver_attr = conf.get(primary_domain, 'mailserver_attribute')
	else:
	auth_mechanism = conf.get('kolab', 'auth_mechanism')
	_mailserver_attr = conf.get(auth_mechanism, 'mailserver_attribute')

	_inbox_folder_attr = conf.get('cyrus-sasl', 'result_attribute')

	if len(users) == 0:
	users = auth.list_users(primary_domain)

	for user in users:
	mailhost = None

	if type(user) == dict:
	if _mailserver_attr in user:
	if type(user[_mailserver_attr]) == list:
	_mailserver = user[_mailserver_attr].pop(0)
	elif type(user[_mailserver_attr]) == str:
	_mailserver = user[_mailserver_attr]
	else:
	_mailserver = auth.get_user_attribute(primary_domain, user, _mailserver_attr)

	if _inbox_folder_attr not in user:
	continue
	else:
	if type(user[_inbox_folder_attr]) == list:
	folder = "user/%s" % user[_inbox_folder_attr].pop(0)
	elif type(user[_inbox_folder_attr]) == str:
	folder = "user/%s" % user[_inbox_folder_attr]

	elif type(user) == str:
	_mailserver = auth.get_user_attribute(user, _mailserver_attr)
	folder = "user/%s" % (user)

	folder = folder.lower()

	_current_mailserver = self.imap.find_mailfolder_server(folder)

	if _mailserver is not None:
	# TODO:
	if not _current_mailserver == _mailserver:
	self.imap._xfer(folder, _current_mailserver, _mailserver)
	else:
	auth.set_user_attribute(primary_domain, user, _mailserver_attr, _current_mailserver)

	def parse_mailfolder(self, mailfolder):
	return self.imap.parse_mailfolder(mailfolder)

	def expunge_user_folders(self, inbox_folders=None):
	"""
	Delete folders that have no equivalent user qualifier in the list
	of users passed to this function, ...

	TODO: Explain the domain parameter, and actually get it to work
	properly. This also relates to threading for multi-domain
	deployments.

	Parameters:

	users
	A list of users. Can be a list of user qualifiers, e.g.
	[ 'user1', 'user2' ] or a list of user attribute
	dictionaries, e.g. [ { 'user1': { 'attr': 'value' } } ]

	primary_domain, secondary_domains
	"""
	if inbox_folders is None:
	inbox_folders = []

	folders = self.list_user_folders()

	for folder in folders:
	log.debug(_("Checking folder: %s") % (folder), level=1)
	try:
	if inbox_folders.index(folder) > -1:
	continue
	else:
	log.info(_("Folder has no corresponding user (1): %s") % (folder))
	self.delete_mailfolder("user/%s" % (folder))
	except:
	log.info(_("Folder has no corresponding user (2): %s") % (folder))
	try:
	self.delete_mailfolder("user/%s" % (folder))
	except:
	pass

	def delete_mailfolder(self, mailfolder_path):
	"""
	Deletes a mail folder described by mailfolder_path.
	"""

	mbox_parts = self.parse_mailfolder(mailfolder_path)

	if mbox_parts is None:
	# We got user identifier only
	log.error(_("Please don't give us just a user identifier"))
	return

	log.info(_("Deleting folder %s") % (mailfolder_path))

	self.imap.dm(self.folder_utf7(mailfolder_path))

	def get_quota(self, mailfolder_path):
	try:
	return self.lq(self.folder_utf7(mailfolder_path))
	except:
	return

	def get_quota_root(self, mailfolder_path):
	return self.lqr(self.folder_utf7(mailfolder_path))

	def list_acls(self, folder):
	"""
	List the ACL entries on a folder
	"""
	return self.imap.lam(self.folder_utf7(folder))

	def list_folders(self, pattern):
	return [self.folder_utf8(x) for x in self.lm(self.folder_utf7(pattern))]

	def list_user_folders(self, primary_domain=None, secondary_domains=[]):
	"""
	List the INBOX folders in the IMAP backend. Returns a list of unique
	base folder names.
	"""
	_folders = self.imap.lm("user/%")
	# TODO: Replace the .* below with a regex representing acceptable DNS
	# domain names.
	domain_re = ".*\.?%s$"

	acceptable_domain_name_res = []

	if primary_domain is not None:
	for domain in [ primary_domain ] + secondary_domains:
	acceptable_domain_name_res.append(domain_re % (domain))

	folders = []

	for folder in _folders:
	folder_name = None
	if len(folder.split('@')) > 1:
	# TODO: acceptable domain name spaces
	#acceptable = False
	#for domain_name_re in acceptable_domain_name_res:
	#prog = re.compile(domain_name_re)
	#if prog.match(folder.split('@')[1]):
	#print "Acceptable indeed"
	#acceptable = True
	#if not acceptable:
	#print "%s is not acceptable against %s yet using %s" % (folder.split('@')[1], folder, domain_name_re)

	#if acceptable:
	#folder_name = "%s@%s" % (folder.split(self.separator)[1].split('@')[0], folder.split('@')[1])

	folder_name = "%s@%s" % (folder.split(self.get_separator())[1].split('@')[0], folder.split('@')[1])
	else:
	folder_name = "%s" % (folder.split(self.get_separator())[1])

	if folder_name is not None:
	if not folder_name in folders:
	folders.append(folder_name)

	return folders

	def lm(self, args, *kw):
	return self.imap.lm(args, *kw)

	def lq(self, args, *kw):
	return self.imap.lq(args, *kw)

	def lqr(self, args, *kw):
	try:
	return self.imap.lqr(args, *kw)
	except:
	return (None, None, None)

	def undelete_mailfolder(self, args, *kw):
	self.imap.undelete_mailfolder(args, *kw)

File Metadata

Mime Type: text/x-script.python
Expires: Mon, Apr 6, 12:17 AM (1 w, 3 d ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 18831682
Default Alt Text: __init__.py (44 KB)

__init__.pyNo OneTemporaryActions

__init__.pyView Options

File Metadata

Event Timeline

init.py
No OneTemporary
Actions

init.py
View Options