#!/usr/bin/env python # ============================================================================== # Copyright and license info is available in the LICENSE file included with # the Server Deployment Package (SDP), and also available online: # https://swarm.workshop.perforce.com/projects/perforce-software-sdp/view/main/LICENSE # ------------------------------------------------------------------------------ """ This script will email users that their accounts haven't been accessed in the number of weeks defined in the weeks variable, and warn them that it will be deleted in one week if they do not use it. """ from __future__ import print_function import os import re import smtplib import sys import time import traceback import accessdates import sdputils if len(sys.argv) > 1: # see params above SDP_INSTANCE = str(sys.argv) else: SDP_INSTANCE = '1' utils = sdputils.SDPUtils(SDP_INSTANCE) config = utils.config p4 = utils.p4 utils.login() weeks = int(config.get('weeks')) weeks1warn = int(config.get('weeks1warn')) weeks2warn = int(config.get('weeks2warn')) administrator = config.get('administrator') complain_from = config.get('complain_from') cc_admin = (config.get('cc_admin')) mailhost = config.get('mailhost') repeat = int(config.get('repeat')) sleeptime = int(config.get('sleeptime')) message = """ Your Perforce account hasn't been used in the last %s weeks. It will be deleted in one week unless you log into Perforce before that time. Thanks for your cooperation, The Perforce Admin Team """ def complain(mailport, complaint): ''' Send a plaintive message to the human looking after this script if we have any difficulties. If no email address for such a human is given, send the complaint to stderr. ''' complaint = complaint + '\n' if administrator: mailport.sendmail(complain_from, [administrator], 'Subject: Perforce User Account Deletion Review Daemon Problem\n\n' + complaint) else: sys.stderr.write(complaint) def mailit(mailport, sender, recipient, message): ''' Try to mail message from sender to the user using SMTP object mailport. complain() if there are any problems. ''' recipients =  recipients.append(recipient) if cc_admin: recipients.append(cc_admin) try: failed = mailport.sendmail(sender, recipients, message) except: exc_type, exc_value, exc_tb = sys.exc_info() failed = traceback.format_exception(exc_type, exc_value, exc_tb) if failed: complain(mailport, 'The following errors occurred:\n\n' + \ repr(failed) + \ '\n\nwhile trying to email from\n' \ + repr(sender) + '\nto ' \ + repr(recipient) + '\nwith body\n\n' + message) def warnusers(weeks, mailport): accessdates.createlist("users", "user", weeks) userlist = open("users.txt", "r") for user in userlist.readlines(): user = user.rstrip() os.system('%s user -o "%s" > user.txt' % (p4, user)) userfile = open("user.txt", "r") for userline in userfile.readlines(): m2 = re.search("^Email:\s(.*)\s", userline) if m2: email = m2.group(1) userfile.close() subject = "Subject: User: %s scheduled for deletion." % user messagebody = 'From: ' + administrator + '\n' + \ 'To: ' + email + '\n' + subject + '\n' + (message % weeks) mailit(mailport, administrator, email, messagebody) userlist.close() if (os.path.isfile("users.txt")): os.remove("users.txt") if (os.path.isfile("user.txt")): os.remove("user.txt") def loop_body(mailhost): # Note: there's a try: wrapped around everything so that the program won't # halt. Unfortunately, as a result you don't get the full traceback. # If you're debugging this script, remove the special exception handlers # to get the real traceback, or figure out how to get a real traceback, # by importing the traceback module and defining a file object that # will take the output of traceback.print_exc(file=mailfileobject) # and mail it (see the example in cgi.py) try: mailport = smtplib.SMTP(mailhost) except: sys.stderr.write('Unable to connect to SMTP host "' + mailhost \ + '"!\nWill try again in ' + repr(sleeptime) \ + ' seconds.\n') else: try: warnusers(weeks, mailport) except: exc_type, exc_value, exc_tb = sys.exc_info() complain(mailport, 'Client Deletion Warning Review daemon problem:\n\n%s' % \ traceback.format_exception(exc_type, exc_value, exc_tb)) try: mailport.quit() except: sys.stderr.write('Error while doing SMTP quit command (ignore).\n') def main(): while (repeat): loop_body(mailhost) time.sleep(sleeptime) else: loop_body(mailhost) ############################################################################### # main if __name__ == '__main__': main()
This is Tom's change:
Introduced new 'Unsupported' directory to clarify that some files
in the SDP are not officially supported. These files are samples for
illustration, to provide examples, or are deprecated but not yet
ready for removal from the package.
The Maintenance and many SDP triggers have been moved under here,
along with other SDP scripts and triggers.
Added comments to p4_vars indicating that it should not be edited
directly. Added reference to an optional site_global_vars file that,
if it exists, will be sourced to provide global user settings
without needing to edit p4_vars.
As an exception to the refactoring, the totalusers.py Maintenance
script will be moved to indicate that it is supported.
Removed settings to support long-sunset P4Web from supported structure.
Structure under new .../Unsupported folder is:
Samples/bin Sample scripts.
Samples/triggers Sample trigger scripts.
Samples/triggers/tests Sample trigger script tests.
Samples/broker Sample broker filter scripts.
Deprecated/triggers Deprecated triggers.
To Do in a subsequent change: Make corresponding doc changes.
This supercedes review-24715.
Bringing over recent bug fixes and code clean up from Rusty Jackson's local branch.
Adds an edge maintenance script to unload clients on edge servers.
Automated setting up maintenance.cfg from mkdirs.cfg settings.
Cleaned up sdputils.py - It had a logic bug, and fixed all scripts based on changes.
== Merge Details ==
Merge strategy: All the fixes to Maintenance scripts were brought in, but not the changes to active them in crontab that would enable them.
Rusty's original change had crontab changes to call maintenance scripts, and also calls to 'p4 unlock -x' as a workround to p4d bugs related to orphanged locks on edge servers. Those bugs are already fixed. Also, adding anything new to cron requires a test suite addition and doc updates. So changes to the template.crontab.combined were ignored. However, a new file was added to the Maintenace folder, sample_cron_entries.txt, to make it easy for folks to see those changes.
Rusty's original change had mkdirs.sh changes to generate maintenance.cfg. This change was enhanced during the merge. Rather than overwriting maintenance.cfg (potentially blowing away configuration for other instances), a new section for the new instance is appended to maintenance.cfg when 'mkdirs.sh <instance>' is run.
Future considerations: Before adding anything from Maintenance to cron, we need to do the following:
* Have mkdirs.sh install the Maintenance folder to the as-deployed structure under /p4/common, i.e. to /p4/common/maintenance, for HMS management compliance.
* Add tests and docs for each script called (directly or indirectly).
Routine merge down to dev from main using:
p4 merge -b perforce_software-sdp-dev
Routine merge to dev from main using:
p4 merge -b perforce_software-sdp-dev
Normalized P4INSTANCE to SDP_INSTANCE to get Unix/Windows
implementations in sync.
1. Things that interact with SDP in both Unix and Windows
environments shoudn't have to account for this obscure
SDP difference between Unix and Windows. (I came across
this doing CBD work).
2. The Windows and Unix scripts have different variable
names for defining the same concept, the SDP instance.
Unix uses P4INSTANCE, while Windows uses SDP_INSTANCE.
3. This instance tag, a data set identifier, is an SDP concept.
I prefer the SDP_INSTANCE name over P4INSTANCE, so I prpose
to normalize to SDP_INSTANCE.
4. The P4INSTANCE name makes it look like a setting that might be
recognized by the p4d itself, which it is not. (There are other
such things such as P4SERVER that could perhaps be renamed as
a separate task; but I'm not sure we want to totally disallow
the P4 prefix for variable names. It looks too right to be wrong
in same cases, like P4BIN and P4DBIN. That's a discussion for
another day, outside the scope of this task).
* Fixed a bug in the Windows 2013.3 upgrade script that
was referencing undefined P4INSTANCE, as the Windows
environment defined only SDP_INSTANCE.
* Had P4INSTANCE been removed completely, this change would
likely cause trouble for users doing updates for existing
SDP installations. So, though it involves slight technical debt,
I opted to keep a redundant definition of P4INSTANCE
in p4_vars.template, with comments indicating SDP_INSTANCE should be
used in favor of P4INSTANCE, with a warning that P4INSTANCE
may go away in a future release. This should avoid unnecessary
* In mkdirs.sh, the varialbe name was INSTANCE rather than
SDP_INSTANCE. I changed that as well. That required manual
change rather than sub/replace to avoid corrupting other similar
varialbe names (e.g. MASTERINSTANCE).
This is a trivial change technically (a substitute/replace, plus
tweaks in p4_vars.template), but impacts many files.
Updated to use /usr/bin/env python
Added workshop header.
Changed cfg to config.
|#2||11464||russell_jackson||Current maintenance scripts.|
|#2||10464||russell_jackson||Corrected typos and added import sys.|
|#1||10148||tom_tyler||Promoted the Perforce Server Deployment Package to The Workshop.|