1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
|
# -*- coding: utf-8 -*-
#
# Copyright (C) 2011-2019 by the Free Software Foundation, Inc.
#
# 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
# USA.
#
# Author: Aurelien Bompard <abompard@fedoraproject.org>
"""
Import the content of a mbox file into the database.
"""
import mailbox
import os
import re
from datetime import datetime
from email.utils import make_msgid, unquote
from email import message_from_bytes, policy
from traceback import print_exc
from math import floor
from dateutil.parser import parse as parse_date
from dateutil import tz
from django.conf import settings
from django.core.management import call_command
from django.core.management.base import BaseCommand, CommandError
from django.db import transaction, Error as DatabaseError
from django.utils.timezone import utc
from hyperkitty.lib.incoming import add_to_list, DuplicateMessage
from hyperkitty.lib.mailman import sync_with_mailman
from hyperkitty.lib.analysis import compute_thread_order_and_depth
from hyperkitty.lib.utils import get_message_id
from hyperkitty.management.utils import setup_logging
from hyperkitty.models import Email, MailingList, Thread
TEXTWRAP_RE = re.compile(r"\n\s*")
class ProgressMarker(object):
def __init__(self, verbose, stdout):
self.verbose = verbose
self.total = None
self.count = 0
self.count_imported = 0
self.spinner_seq = ('|', '/', '-', '\\')
self.stdout = stdout
def tick(self, msgid=None):
if self.total:
msg = "%d%%" % floor(100.0 * self.count / self.total)
else:
msg = self.spinner_seq[self.count % len(self.spinner_seq)]
if self.verbose:
if self.total:
self.stdout.write(
"%s (%d/%d, %s)" % (msgid, self.count, self.total, msg))
else:
self.stdout.write("%s (%d)" % (msgid, self.count))
else:
self.stdout.write("\r%s" % msg, ending='')
self.stdout.flush()
self.count += 1
def finish(self):
if self.verbose:
self.stdout.write(' %s emails read' % self.count)
self.stdout.write(' %s email added to the database'
% self.count_imported)
else:
self.stdout.write("\r", ending='')
self.stdout.flush()
class DbImporter(object):
"""
Import email messages into the HyperKitty database using its API.
"""
def __init__(self, list_address, options, stdout, stderr):
self.list_address = list_address
self.verbose = options["verbosity"] >= 2
self.since = options.get("since")
self.impacted_thread_ids = set()
self.stdout = stdout
self.stderr = stderr
def _is_too_old(self, message):
if not self.since:
return False
date = message.get("date")
if not date:
return False
try:
date = parse_date(date)
except ValueError as e:
if self.verbose:
self.stderr.write(
"Can't parse date string in message {}: {}. "
"The date string is: '{}'".format(
message["message-id"], e,
date.decode("ascii", "replace")))
return False
if date.tzinfo is None:
date = date.replace(tzinfo=utc)
try:
return date <= self.since
except ValueError:
return False
def _get_date(self, message, header):
try:
date = message.get(header)
except TypeError as e:
if self.verbose:
self.stderr.write(
"Can't get {} header in message {}: {}.".format(
header, message["message-id"], e))
return None
return date
def from_mbox(self, mbfile):
"""
Insert all the emails contained in an mbox file into the database.
:arg mbfile: a mailbox file
"""
mbox = mailbox.mbox(mbfile)
progress_marker = ProgressMarker(self.verbose, self.stdout)
if not self.since:
progress_marker.total = len(mbox)
for msg in mbox:
# FIXME: this converts mailbox.mboxMessage to
# email.message.EmailMessage
msg_raw = msg.as_bytes(unixfrom=False)
unixfrom = msg.get_from()
message = message_from_bytes(msg_raw, policy=policy.default)
# Fix missing and wierd Date: headers.
date = (self._get_date(message, "date") or
self._get_date(message, "resent-date"))
if unixfrom and not date:
date = " ".join(unixfrom.split()[1:])
if date:
try:
message.replace_header('date', date)
except KeyError:
message['Date'] = date
if self._is_too_old(message):
continue
progress_marker.tick(message["Message-Id"])
# Un-wrap the subject line if necessary
if message["subject"]:
message.replace_header(
"subject", TEXTWRAP_RE.sub(" ", message["subject"]))
if unixfrom:
message.set_unixfrom(unixfrom)
if message['message-id'] is None:
message['Message-ID'] = make_msgid('generated')
# Now insert the message
try:
with transaction.atomic():
add_to_list(self.list_address, message)
except DuplicateMessage as e:
if self.verbose:
self.stderr.write(
"Duplicate email with message-id '%s'" % e.args[0])
continue
except (LookupError, UnicodeError, ValueError) as e:
self.stderr.write("Failed adding message %s: %s"
% (message.get("Message-ID"), e))
if len(e.args) == 2:
try:
self.stderr.write(
"%s from %s about %s"
% (e.args[0], e.args[1].get("From"),
e.args[1].get("Subject")))
except UnicodeDecodeError:
pass
# Don't reraise the exception
continue
except DatabaseError:
try:
print_exc(file=self.stderr)
except UnicodeError:
pass
self.stderr.write(
"Message %s failed to import, skipping"
% unquote(message["Message-Id"]))
continue
email = Email.objects.get(
mailinglist__name=self.list_address,
message_id=get_message_id(message))
# # Commit every time to be able to rollback on error
# if not transaction.get_autocommit():
# transaction.commit()
# Store the list of impacted threads to be able to compute the
# thread_order and thread_depth values
self.impacted_thread_ids.add(email.thread_id)
progress_marker.count_imported += 1
# self.store.search_index.flush() # Now commit to the search index
progress_marker.finish()
mbox.close()
class Command(BaseCommand):
help = "Imports the specified mailbox archive"
def add_arguments(self, parser):
parser.add_argument('mbox', nargs='+')
parser.add_argument(
'--delete',
action='store_true',
dest='delete',
default=False,
help='Delete poll instead of closing it')
parser.add_argument(
'-l', '--list-address',
help="the full list address the mailbox will be imported to")
parser.add_argument(
'--no-sync-mailman',
action='store_true', default=False,
help="do not sync properties with Mailman (faster, useful "
"for batch imports)")
parser.add_argument(
'--since',
help="only import emails later than this date. Defaults to the "
"date of the newest message in the existing archive if any.")
parser.add_argument(
'--ignore-mtime',
action='store_true', default=False,
help="do not check mbox mtimes (slower)")
def _check_options(self, options):
if not options.get("list_address"):
raise CommandError(
"The list address must be given on the command-line.")
if "@" not in options["list_address"]:
raise CommandError(
"The list address must be fully-qualified, including "
"the '@' symbol and the domain name.")
if not options.get("mbox"):
raise CommandError("No mbox file selected.")
for mbfile in options["mbox"]:
if not os.path.exists(mbfile):
raise CommandError("No such file: %s" % mbfile)
options["verbosity"] = int(options.get("verbosity", "1"))
if options["since"]:
try:
options["since"] = parse_date(options["since"])
if options["since"].tzinfo is None:
options["since"] = options["since"].replace(
tzinfo=tz.tzlocal())
except ValueError as e:
raise CommandError("invalid value for '--since': %s" % e)
def handle(self, *args, **options):
self._check_options(options)
setup_logging(self, options["verbosity"])
# main
list_address = options["list_address"].lower()
# Keep autocommit on SQLite:
# https://docs.djangoproject.com/en/1.8/topics/db/transactions/#savepoints-in-sqlite
# if (settings.DATABASES["default"]["ENGINE"]
# != "django.db.backends.sqlite3":
# transaction.set_autocommit(False)
# Sync list settings with Mailman before importing messages:
if not options["no_sync_mailman"]:
mlist = MailingList.objects.get_or_create(name=list_address)[0]
mlist.update_from_mailman()
mlist.save()
settings.HYPERKITTY_BATCH_MODE = True
# Only import emails newer than the latest email in the DB
latest_email_date = Email.objects.filter(
mailinglist__name=list_address
).values("date").order_by("-date").first()
if latest_email_date and not options["since"]:
options["since"] = latest_email_date["date"]
if options["since"] and options["verbosity"] >= 2:
self.stdout.write(
"Only emails after %s will be imported" % options["since"])
importer = DbImporter(list_address, options, self.stdout, self.stderr)
# disable mailman client for now
for mbfile in options["mbox"]:
if options["verbosity"] >= 1:
self.stdout.write("Importing from mbox file %s to %s"
% (mbfile, list_address))
if not options["ignore_mtime"] and options["since"] is not None:
mtime = datetime.fromtimestamp(
os.path.getmtime(mbfile), tz.tzlocal())
if mtime <= options["since"]:
if options["verbosity"] >= 2:
self.stdout.write('Mailbox file for %s is too old'
% list_address)
continue
importer.from_mbox(mbfile)
if options["verbosity"] >= 2:
total_in_list = Email.objects.filter(
mailinglist__name=list_address).count()
self.stdout.write(' %s emails are stored into the database'
% total_in_list)
if options["verbosity"] >= 1:
self.stdout.write("Computing thread structure")
# Work on batches of thread ids to avoid creating a huge SQL request
# (it's an IN statement)
thread_ids = list(importer.impacted_thread_ids)
while thread_ids:
thread_ids_batch = thread_ids[:100]
thread_ids = thread_ids[100:]
for thread in Thread.objects.filter(id__in=thread_ids_batch):
compute_thread_order_and_depth(thread)
if not options["no_sync_mailman"]:
if options["verbosity"] >= 1:
self.stdout.write("Synchronizing properties with Mailman")
sync_with_mailman()
# if not transaction.get_autocommit():
# transaction.commit()
if options["verbosity"] >= 1:
self.stdout.write("Warming up cache")
call_command("hyperkitty_warm_up_cache", list_address)
if options["verbosity"] >= 1:
self.stdout.write(
"The full-text search index is not updated for this list. "
"It will not be updated by the 'minutely' incremental "
"update job. To update the index for this list, run the "
"'manage.py update_index_one_list {}' command."
.format(list_address)
)
|