group_audit.py #5

  • //
  • guest/
  • perforce_software/
  • sdp/
  • main/
  • Maintenance/
  • group_audit.py
  • View
  • Commits
  • Open Download .zip Download (3 KB)
#!/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 emails the owners of each group with instructions on how to validate the membership of the groups they own.
#

import os, sys
import smtplib
from email.mime.text import MIMEText
import sdputils

if len(sys.argv) > 1:  # see params above
    SDP_INSTANCE = str(sys.argv[1])
else:
    SDP_INSTANCE = '1'

utils = sdputils.SDPUtils(SDP_INSTANCE)
config = utils.config
p4 = utils.p4
utils.login()

fromAddr = config.get('administrator')
replyToAddr = ''
mailSMTPhost = config.get('mailhost')
mailSMTPport = int(config.get('mailport'))
mailsecure = int(config.get('mailsecure'))
if mailsecure:
    mailUser = config.get('mailuser')
    mailPass = config.get('mailpass')


def email_owner(group, owner):
    message = """
  You are the owner of this group: %s

  As the owner, you are expected to audit the group membership on a quarterly basis.

  To edit/review the group membership, open a command prompt and run:

  p4 group -a %s

  Regards,
  Perforce Admin Team
  %s
  """

    for line in os.popen("p4 -ztag user -o %s" % owner):
        if line.startswith(r"... Email"):
            owner_email = line.lstrip(r"... Email ")
            break

    msg = MIMEText(message % (group, group, fromAddr))
    msg['Subject'] = "%s Group Audit Reminder" % group
    msg['From'] = fromAddr
    if (len(replyToAddr)):
        msg.add_header('reply-to', replyToAddr)
    msg['To'] = owner_email

    try:
        # print("Sending mail to: %s" % owner_email)
        s = smtplib.SMTP(mailSMTPhost, mailSMTPport)
        # Uncomment below for secure connections
        # s.starttls()
        # s.login(mailUser, mailPass)
        s.sendmail(msg['From'], msg['To'], msg.as_string())
        s.quit()
    except smtplib.SMTPException:
        print("Error: unable to send email to %s." % msg['To'])


def main():
    for group in os.popen("p4 groups").readlines():
        owners = 0
        group = group.rstrip()
        for line in os.popen("p4 -ztag group -o %s" % group):
            if line.startswith(r"... Users"):
                break
            if line.startswith(r"... Owners"):
                owners = 1
                owner = line.split()[2]
                email_owner(group, owner)
        if not owners:
            print("%s,No owner." % group)


if __name__ == "__main__":
    main()
# Change User Description Committed
#7 27331 C. Thomas Tyler Released SDP 2020.1.27325 (2021/01/29).
Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'.
#6 26161 C. Thomas Tyler Released SDP 2019.3.26159 (2019/11/06).
Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'.
#5 22685 Russell C. Jackson (Rusty) Update main with current changes from dev.
#4 16581 Robert Cowham Standardised processing and formatting.
Made python 2/3 compatible.
These need automated testing!
#3 15856 C. Thomas Tyler Replaced the big license comment block with a shortened
form referencing the LICENSE file included with the SDP
package, and also by the URL for the license file in
The Workshop.
#2 13908 C. Thomas Tyler Pushing SDP 2015.1.13906.
#1 13561 Russell C. Jackson (Rusty) New maintenence script to email a reminder to group owners to audit their groups.