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
|
# Copyright (C) 1998 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., 59 Temple Place - Suite 330, Boston, MA 0211-1307, 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."""
__version__ = "$Revision: 539 $"
import sys, os, string
import mm_utils, mm_mbox, mm_cfg, mm_message
## ARCHIVE_PENDING = "to-archive.mail"
## # ARCHIVE_RETAIN will be ignored, below, in our hook up with andrew's new
## # pipermail.
## ARCHIVE_RETAIN = "retained.mail"
class Archiver:
def InitVars(self):
# Configurable
self.archive = 1
# 0=public, 1=private:
self.archive_private = mm_cfg.DEFAULT_ARCHIVE_PRIVATE
## self.archive_update_frequency = \
## mm_cfg.DEFAULT_ARCHIVE_UPDATE_FREQUENCY
## self.archive_volume_frequency = \
## mm_cfg.DEFAULT_ARCHIVE_VOLUME_FREQUENCY
## self.archive_retain_text_copy = \
## mm_cfg.DEFAULT_ARCHIVE_RETAIN_TEXT_COPY
# Not configurable
self.clobber_date = 0
# Though the archive file dirs are list-specific, they are not
# settable from the web interface. If you REALLY want to redirect
# something to a different dir, you can set the member vars by
# hand, from the python interpreter!
self.public_archive_file_dir = mm_cfg.PUBLIC_ARCHIVE_FILE_DIR
self.private_archive_file_dir = mm_cfg.PRIVATE_ARCHIVE_FILE_DIR
self.archive_directory = os.path.join(mm_cfg.HTML_DIR, "archives/%s" %
self._internal_name)
def GetBaseArchiveURL(self):
if self.archive_private:
return os.path.join(mm_cfg.PRIVATE_ARCHIVE_URL,
self._internal_name + ".html")
else:
return os.path.join(mm_cfg.PUBLIC_ARCHIVE_URL,
self._internal_name + ".html")
def GetConfigInfo(self):
return [
"List traffic archival policies.",
('archive', mm_cfg.Toggle, ('No', 'Yes'), 0,
'Archive messages?'),
('archive_private', mm_cfg.Radio, ('public', 'private'), 0,
'Is archive file source for public or private archival?'),
('clobber_date', mm_cfg.Radio, ('When sent', 'When resent'), 0,
'Set date in archive to when the mail is claimed to have been '
'sent, or to the time we resend it?'),
## ('archive_update_frequency', mm_cfg.Number, 3, 0,
## "How often should new messages be incorporated? "
## "0 for no archival, 1 for daily, 2 for hourly"),
## ('archive_volume_frequency', mm_cfg.Radio, ('Yearly', 'Monthly'),
## 0,
## 'How often should a new archive volume be started?'),
## ('archive_retain_text_copy', mm_cfg.Toggle, ('No', 'Yes'),
## 0,
## 'Retain plain text copy of archive?'),
]
def UpdateArchive(self):
# This method is not being used, in favor of external archiver!
if not self.archive:
return
archive_file_name = os.path.join(self._full_path, ARCHIVE_PENDING)
archive_dir = os.path.join(self.archive_directory, 'volume_%d'
% self.volume)
# Test to make sure there are posts to archive
archive_file = open(archive_file_name, 'r')
text = string.strip(archive_file.read())
archive_file.close()
if not text:
return
mm_utils.MakeDirTree(archive_dir, 0755)
# Pipermail 0.0.2 always looks at sys.argv, and I wasn't into hacking
# it more than I had to, so here's a small hack to get around that,
# calling pipermail w/ the correct options.
real_argv = sys.argv
sys.argv = ['pipermail', '-d%s' % archive_dir, '-l%s' %
self._internal_name, '-m%s' % archive_file_name,
'-s%s' % os.path.join(archive_dir, "INDEX")]
import pipermail
sys.argv = real_argv
f = open(archive_file_name, 'w+')
f.truncate(0)
f.close()
# Internal function, don't call this.
def ArchiveMail(self, post):
"""Retain a text copy of the message in an mbox file."""
if self.clobber_date:
import time
olddate = post.getheader('date')
post.SetHeader('Date', time.ctime(time.time()))
try:
afn = self.ArchiveFileName()
mbox = self.ArchiveFile(afn)
mbox.AppendMessage(post)
mbox.fp.close()
except IOError, msg:
self.LogMsg("error", ("Archive file access failure:\n"
"\t%s %s"
% (afn, `msg[1]`)))
if self.clobber_date:
# Resurrect original date setting.
post.SetHeader('Date', olddate)
self.Save ()
def ArchiveFileName(self):
"""The mbox name where messages are left for archive construction."""
if self.archive_private:
return os.path.join(self.private_archive_file_dir,
self._internal_name)
else:
return os.path.join(self.public_archive_file_dir,
self._internal_name)
def ArchiveFile(self, afn):
"""Open (creating, if necessary) the named archive file."""
ou = os.umask(002)
try:
try:
return mm_mbox.Mailbox(open(afn, "a+"))
except IOError, msg:
raise IOError, msg
finally:
os.umask(ou)
|