/usr/lib/mailman/Mailman/Archiver/Archiver.py is in mailman 1:2.1.14-3.
This file is owned by root:list, with mode 0o644.
The actual contents of the file can be viewed below.
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 | # Copyright (C) 1998-2003 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.
"""Mixin class for putting new messages in the right place for archival.
Public archives are separated from private ones. An external archival
mechanism (eg, pipermail) should be pointed to the right places, to do the
archival.
"""
import os
import errno
import traceback
import re
from cStringIO import StringIO
from Mailman import mm_cfg
from Mailman import Mailbox
from Mailman import Utils
from Mailman import Site
from Mailman.SafeDict import SafeDict
from Mailman.Logging.Syslog import syslog
from Mailman.i18n import _
try:
True, False
except NameError:
True = 1
False = 0
def makelink(old, new):
try:
os.symlink(old, new)
except OSError, e:
if e.errno <> errno.EEXIST:
raise
def breaklink(link):
try:
os.unlink(link)
except OSError, e:
if e.errno <> errno.ENOENT:
raise
class Archiver:
#
# Interface to Pipermail. HyperArch.py uses this method to get the
# archive directory for the mailing list
#
def InitVars(self):
# Configurable
self.archive = mm_cfg.DEFAULT_ARCHIVE
# 0=public, 1=private:
self.archive_private = mm_cfg.DEFAULT_ARCHIVE_PRIVATE
self.archive_volume_frequency = \
mm_cfg.DEFAULT_ARCHIVE_VOLUME_FREQUENCY
# The archive file structure by default is:
#
# archives/
# private/
# listname.mbox/
# listname.mbox
# listname/
# lots-of-pipermail-stuff
# public/
# listname.mbox@ -> ../private/listname.mbox
# listname@ -> ../private/listname
#
# IOW, the mbox and pipermail archives are always stored in the
# private archive for the list. This is safe because archives/private
# is always set to o-rx. Public archives have a symlink to get around
# the private directory, pointing directly to the private/listname
# which has o+rx permissions. Private archives do not have the
# symbolic links.
omask = os.umask(0)
try:
try:
os.mkdir(self.archive_dir()+'.mbox', 02775)
except OSError, e:
if e.errno <> errno.EEXIST: raise
# We also create an empty pipermail archive directory into
# which we'll drop an empty index.html file into. This is so
# that lists that have not yet received a posting have
# /something/ as their index.html, and don't just get a 404.
try:
os.mkdir(self.archive_dir(), 02775)
except OSError, e:
if e.errno <> errno.EEXIST: raise
# See if there's an index.html file there already and if not,
# write in the empty archive notice.
indexfile = os.path.join(self.archive_dir(), 'index.html')
fp = None
try:
fp = open(indexfile)
except IOError, e:
if e.errno <> errno.ENOENT: raise
omask = os.umask(002)
try:
fp = open(indexfile, 'w')
finally:
os.umask(omask)
fp.write(Utils.maketext(
'emptyarchive.html',
{'listname': self.real_name,
'listinfo': self.GetScriptURL('listinfo', absolute=1),
}, mlist=self))
if fp:
fp.close()
finally:
os.umask(omask)
def archive_dir(self):
return Site.get_archpath(self.internal_name())
def ArchiveFileName(self):
"""The mbox name where messages are left for archive construction."""
return os.path.join(self.archive_dir() + '.mbox',
self.internal_name() + '.mbox')
def GetBaseArchiveURL(self):
url = self.GetScriptURL('private', absolute=1) + '/'
if self.archive_private:
return url
else:
hostname = re.match('[^:]*://([^/]*)/.*', url).group(1)\
or mm_cfg.DEFAULT_URL_HOST
url = mm_cfg.PUBLIC_ARCHIVE_URL % {
'listname': self.internal_name(),
'hostname': hostname
}
return url
def __archive_file(self, afn):
"""Open (creating, if necessary) the named archive file."""
omask = os.umask(002)
try:
return Mailbox.Mailbox(open(afn, 'a+'))
finally:
os.umask(omask)
#
# old ArchiveMail function, retained under a new name
# for optional archiving to an mbox
#
def __archive_to_mbox(self, post):
"""Retain a text copy of the message in an mbox file."""
try:
afn = self.ArchiveFileName()
mbox = self.__archive_file(afn)
mbox.AppendMessage(post)
mbox.fp.close()
except IOError, msg:
syslog('error', 'Archive file access failure:\n\t%s %s', afn, msg)
raise
def ExternalArchive(self, ar, txt):
d = SafeDict({'listname': self.internal_name(),
'hostname': self.host_name,
})
cmd = ar % d
extarch = os.popen(cmd, 'w')
extarch.write(txt)
status = extarch.close()
if status:
syslog('error', 'external archiver non-zero exit status: %d\n',
(status & 0xff00) >> 8)
#
# archiving in real time this is called from list.post(msg)
#
def ArchiveMail(self, msg):
"""Store postings in mbox and/or pipermail archive, depending."""
# Fork so archival errors won't disrupt normal list delivery
if mm_cfg.ARCHIVE_TO_MBOX == -1:
return
#
# We don't need an extra archiver lock here because we know the list
# itself must be locked.
if mm_cfg.ARCHIVE_TO_MBOX in (1, 2):
self.__archive_to_mbox(msg)
if mm_cfg.ARCHIVE_TO_MBOX == 1:
# Archive to mbox only.
return
txt = str(msg)
# should we use the internal or external archiver?
private_p = self.archive_private
if mm_cfg.PUBLIC_EXTERNAL_ARCHIVER and not private_p:
self.ExternalArchive(mm_cfg.PUBLIC_EXTERNAL_ARCHIVER, txt)
elif mm_cfg.PRIVATE_EXTERNAL_ARCHIVER and private_p:
self.ExternalArchive(mm_cfg.PRIVATE_EXTERNAL_ARCHIVER, txt)
else:
# use the internal archiver
f = StringIO(txt)
import HyperArch
h = HyperArch.HyperArchive(self)
h.processUnixMailbox(f)
h.close()
f.close()
#
# called from MailList.MailList.Save()
#
def CheckHTMLArchiveDir(self):
# We need to make sure that the archive directory has the right perms
# for public vs private. If it doesn't exist, or some weird
# permissions errors prevent us from stating the directory, it's
# pointless to try to fix the perms, so we just return -scott
if mm_cfg.ARCHIVE_TO_MBOX == -1:
# Archiving is completely disabled, don't require the skeleton.
return
pubdir = Site.get_archpath(self.internal_name(), public=True)
privdir = self.archive_dir()
pubmbox = pubdir + '.mbox'
privmbox = privdir + '.mbox'
if self.archive_private:
breaklink(pubdir)
breaklink(pubmbox)
else:
# BAW: privdir or privmbox could be nonexistant. We'd get an
# OSError, ENOENT which should be caught and reported properly.
makelink(privdir, pubdir)
# Only make this link if the site has enabled public mbox files
if mm_cfg.PUBLIC_MBOX:
makelink(privmbox, pubmbox)
|