2 ## vim:set et ts=2 sw=2 ai:
3 # Send email reminders to users having sizable homedirs.
5 # Copyright (c) 2013 Philipp Kern <pkern@debian.org>
6 # Copyright (c) 2013 Peter Palfrader <peter@palfrader.org>
7 # Copyright (c) 2013 Luca Filipozzi <lfilipoz@debian.org>
9 # Permission is hereby granted, free of charge, to any person obtaining a copy
10 # of this software and associated documentation files (the "Software"), to deal
11 # in the Software without restriction, including without limitation the rights
12 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 # copies of the Software, and to permit persons to whom the Software is
14 # furnished to do so, subject to the following conditions:
16 # The above copyright notice and this permission notice shall be included in
17 # all copies or substantial portions of the Software.
19 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27 from __future__ import print_function
29 from collections import defaultdict
31 import email.mime.text
42 # avoid base64 encoding for utf-8
43 email.charset.add_charset('utf-8', email.charset.SHORTEST, email.charset.QP)
48 SENDMAIL_COMMAND = ['/bin/cat']
50 SENDMAIL_COMMAND = ['/usr/sbin/sendmail', '-t', '-oi']
53 RM_COMMAND = ['/bin/echo', 'Would remove']
55 RM_COMMAND = ['/bin/rm', '-rf']
58 { 'size': 10240, 'notifyafter': 5}, #, 'deleteafter': 40 },
59 { 'size': 1024, 'notifyafter': 10}, #, 'deleteafter': 50 },
60 { 'size': 100, 'notifyafter': 30}, #, 'deleteafter': 90 },
61 { 'size': 20, 'notifyafter': 90}, #, 'deleteafter': 150 },
62 { 'size': 5, 'notifyafter': 0, 'deleteafter': 450 }
64 EXCLUDED_USERNAMES = ['lost+found']
65 MAIL_FROM = 'debian-admin (via Cron) <bulk@admin.debian.org>'
66 MAIL_TO = '{username}@{hostname}.debian.org'
67 MAIL_CC = 'debian-admin (bulk sink) <bulk@admin.debian.org>'
68 MAIL_REPLYTO = 'debian-admin <dsa@debian.org>'
69 MAIL_SUBJECT = 'Please clean up ~{username} on {hostname}.debian.org'
73 Thanks for your porting effort on {hostname}!
75 Please note that, on most porterboxes, /home is quite small, so please
76 remove files that you do not need anymore.
78 For your information, you last logged into {hostname} {days_ago} days
79 ago, and your home directory there is {homedir_size} MB in size.
81 If you currently do not use {hostname}, please keep ~{username} under
84 Please assist us in freeing up space by deleting schroots, also.
88 Debian System Administration Team via Cron
90 PS: A reply is not required.
93 class Error(Exception):
96 class SendmailError(Error):
99 class LastlogTimes(dict):
100 LASTLOG_STRUCT = '=L32s256s'
103 record_size = struct.calcsize(self.LASTLOG_STRUCT)
104 with open('/var/log/lastlog', 'r') as fp:
105 uid = -1 # there is one record per uid in lastlog
106 for record in iter(lambda: fp.read(record_size), ''):
107 uid += 1 # so keep incrementing uid for each record read
108 lastlog_time, _, _ = list(struct.unpack(self.LASTLOG_STRUCT, record))
110 self[pwd.getpwuid(uid).pw_name] = lastlog_time
112 # this is a normal condition
115 class HomedirSizes(dict):
117 for direntry in glob.glob('/home/*'):
118 username = os.path.basename(direntry)
120 if username in EXCLUDED_USERNAMES:
124 pwinfo = pwd.getpwnam(username)
126 if os.path.isdir(direntry):
127 logging.warning('directory %s exists on %s but there is no %s user', direntry, platform.node(), username)
130 if pwinfo.pw_dir != direntry:
131 logging.warning('home directory for %s is not %s, but that exists. confused.', username, direntry)
134 command = ['/usr/bin/du', '-ms', pwinfo.pw_dir]
135 p = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
136 (stdout, stderr) = p.communicate()
137 if p.returncode != 0: # ignore errors from du
138 logging.info('%s failed:', ' '.join(command))
142 self[username] = int(stdout.split('\t')[0])
144 logging.error('could not convert size output from %s: %s', ' '.join(command), stdout)
147 class HomedirReminder(object):
149 self.lastlog_times = LastlogTimes()
150 self.homedir_sizes = HomedirSizes()
152 def notify(self, **kwargs):
153 msg = email.mime.text.MIMEText(MAIL_MESSAGE.format(**kwargs), _charset='UTF-8')
154 msg['From'] = MAIL_FROM.format(**kwargs)
155 msg['To'] = MAIL_TO.format(**kwargs)
157 msg['Cc'] = MAIL_CC.format(**kwargs)
158 if MAIL_REPLYTO != "":
159 msg['Reply-To'] = MAIL_REPLYTO.format(**kwargs)
160 msg['Subject'] = MAIL_SUBJECT.format(**kwargs)
161 msg['Precedence'] = "bulk"
162 msg['Auto-Submitted'] = "auto-generated by mail-big-homedirs"
163 p = subprocess.Popen(SENDMAIL_COMMAND, stdin=subprocess.PIPE)
164 p.communicate(msg.as_string())
165 logging.debug(msg.as_string())
166 if p.returncode != 0:
169 def remove(self, **kwargs):
171 pwinfo = pwd.getpwnam(kwargs.get('username'))
176 command = RM_COMMAND + [pwinfo.pw_dir]
177 p = subprocess.check_call(command)
180 current_time = time.time()
182 for username, homedir_size in self.homedir_sizes.iteritems():
184 realname = pwd.getpwnam(username).pw_gecos.decode('utf-8').split(',', 1)[0].split(',', 1)[0]
187 lastlog_time = self.lastlog_times[username]
188 days_ago = int( (current_time - lastlog_time) / 3600 / 24 )
190 'hostname': platform.node(),
191 'username': username,
192 'realname': realname,
193 'homedir_size': homedir_size,
200 if homedir_size > x['size'] and 'notifyafter' in x and days_ago >= x['notifyafter']:
202 if homedir_size > x['size'] and 'deleteafter' in x and days_ago >= x['deleteafter']:
206 self.remove(**kwargs)
208 self.notify(**kwargs)
210 if __name__ == '__main__':
211 logging.basicConfig()
212 # DEBUG for debugging, ERROR for production.
213 logging.getLogger().setLevel(logging.ERROR)
214 HomedirReminder().run()