mirror of
https://github.com/GAM-team/GAM.git
synced 2026-07-05 05:11:35 +00:00
Phase 1b: Eliminate remaining _getMain() calls
This commit is contained in:
Jay Lee
@@ -1621,4 +1621,14 @@ def getHTTPError(responses, http_status, reason, message):
|
||||
return responses[reason]
|
||||
return formatHTTPError(http_status, reason, message)
|
||||
|
||||
def substituteQueryTimes(queries, queryTimes):
|
||||
if queryTimes:
|
||||
for i, query in enumerate(queries):
|
||||
if query is not None:
|
||||
for queryTimeName, queryTimeValue in queryTimes.items():
|
||||
query = query.replace(f'#{queryTimeName}#', queryTimeValue)
|
||||
queries[i] = query
|
||||
|
||||
def _getFilterDateTime():
|
||||
filterDate = getYYYYMMDD(returnDateTime=True)
|
||||
return (filterDate, filterDate.replace(tzinfo='UTC'))
|
||||
|
||||
@@ -1556,3 +1556,133 @@ def checkUserSuspended(cd, user, entityType=None, i=0, count=0):
|
||||
GAPI.badRequest, GAPI.backendError, GAPI.systemError):
|
||||
_getMain().entityUnknownWarning(entityType, user, i, count)
|
||||
return None
|
||||
|
||||
def _getCustomerId():
|
||||
customerId = GC.Values[GC.CUSTOMER_ID]
|
||||
if customerId != GC.MY_CUSTOMER and customerId[0] != 'C':
|
||||
customerId = 'C' + customerId
|
||||
return customerId
|
||||
|
||||
def _getCustomerIdNoC():
|
||||
customerId = GC.Values[GC.CUSTOMER_ID]
|
||||
if customerId[0] == 'C':
|
||||
return customerId[1:]
|
||||
return customerId
|
||||
|
||||
def _getCustomersCustomerIdNoC():
|
||||
customerId = GC.Values[GC.CUSTOMER_ID]
|
||||
if customerId.startswith('C'):
|
||||
customerId = customerId[1:]
|
||||
return f'customers/{customerId}'
|
||||
|
||||
def _getCustomersCustomerIdWithC():
|
||||
customerId = GC.Values[GC.CUSTOMER_ID]
|
||||
if customerId != GC.MY_CUSTOMER and customerId[0] != 'C':
|
||||
customerId = 'C' + customerId
|
||||
return f'customers/{customerId}'
|
||||
|
||||
def _getDomainList(cd, customer, fields):
|
||||
from gam.util.access import accessErrorExit, ClientAPIAccessDeniedExit
|
||||
try:
|
||||
return _getMain().callGAPIitems(cd.domains(), 'list', 'domains',
|
||||
throwReasons=[GAPI.BAD_REQUEST, GAPI.NOT_FOUND,
|
||||
GAPI.FORBIDDEN, GAPI.PERMISSION_DENIED],
|
||||
customer=customer, fields=fields)
|
||||
except (GAPI.badRequest, GAPI.notFound):
|
||||
accessErrorExit(cd)
|
||||
except (GAPI.forbidden, GAPI.permissionDenied) as e:
|
||||
ClientAPIAccessDeniedExit(str(e))
|
||||
|
||||
def setTrueCustomerId(cd=None, forceUpdate=False):
|
||||
from gam.util.access import ClientAPIAccessDeniedExit
|
||||
if GC.Values[GC.CUSTOMER_ID] == GC.MY_CUSTOMER or forceUpdate:
|
||||
if not cd:
|
||||
cd = _getMain().buildGAPIObject(API.DIRECTORY)
|
||||
try:
|
||||
customerInfo = _getMain().callGAPI(cd.customers(), 'get',
|
||||
throwReasons=[GAPI.BAD_REQUEST, GAPI.INVALID_INPUT, GAPI.RESOURCE_NOT_FOUND,
|
||||
GAPI.FORBIDDEN, GAPI.PERMISSION_DENIED],
|
||||
customerKey=GC.MY_CUSTOMER,
|
||||
fields='id')
|
||||
GC.Values[GC.CUSTOMER_ID] = customerInfo['id']
|
||||
except (GAPI.badRequest, GAPI.invalidInput, GAPI.resourceNotFound):
|
||||
pass
|
||||
except (GAPI.forbidden, GAPI.permissionDenied) as e:
|
||||
ClientAPIAccessDeniedExit(str(e))
|
||||
|
||||
PRINT_PRIVILEGES_FIELDS = ['serviceId', 'serviceName', 'privilegeName', 'isOuScopable', 'childPrivileges']
|
||||
|
||||
# Drive MIME type constants (moved from cmd/userservices.py)
|
||||
APPLICATION_VND_GOOGLE_APPS = 'application/vnd.google-apps.'
|
||||
MIMETYPE_GA_DOCUMENT = f'{APPLICATION_VND_GOOGLE_APPS}document'
|
||||
MIMETYPE_GA_FOLDER = f'{APPLICATION_VND_GOOGLE_APPS}folder'
|
||||
MIMETYPE_GA_FORM = f'{APPLICATION_VND_GOOGLE_APPS}form'
|
||||
MIMETYPE_GA_PRESENTATION = f'{APPLICATION_VND_GOOGLE_APPS}presentation'
|
||||
MIMETYPE_GA_SHORTCUT = f'{APPLICATION_VND_GOOGLE_APPS}shortcut'
|
||||
MIMETYPE_GA_SPREADSHEET = f'{APPLICATION_VND_GOOGLE_APPS}spreadsheet'
|
||||
MIMETYPE_GA_3P_SHORTCUT = f'{APPLICATION_VND_GOOGLE_APPS}drive-sdk'
|
||||
ME_IN_OWNERS = "'me' in owners"
|
||||
ME_IN_OWNERS_AND = ME_IN_OWNERS + " and "
|
||||
NOT_ME_IN_OWNERS = "not " + ME_IN_OWNERS
|
||||
NOT_ME_IN_OWNERS_AND = NOT_ME_IN_OWNERS + " and "
|
||||
|
||||
def _getEntityMimeType(fileEntry):
|
||||
Ent = _getMain().Ent
|
||||
if fileEntry['mimeType'] == MIMETYPE_GA_FOLDER:
|
||||
return Ent.DRIVE_FOLDER
|
||||
if fileEntry['mimeType'].startswith(MIMETYPE_GA_3P_SHORTCUT):
|
||||
return Ent.DRIVE_3PSHORTCUT
|
||||
if fileEntry['mimeType'] != MIMETYPE_GA_SHORTCUT:
|
||||
return Ent.DRIVE_FILE
|
||||
if 'shortcutDetails' not in fileEntry or 'targetMimeType' not in fileEntry['shortcutDetails']:
|
||||
return Ent.DRIVE_SHORTCUT
|
||||
return Ent.DRIVE_FOLDER_SHORTCUT if fileEntry['shortcutDetails']['targetMimeType'] == MIMETYPE_GA_FOLDER else Ent.DRIVE_FILE_SHORTCUT
|
||||
|
||||
def _getTargetEntityMimeType(fileEntry):
|
||||
Ent = _getMain().Ent
|
||||
return Ent.DRIVE_FOLDER if fileEntry['shortcutDetails']['targetMimeType'] == MIMETYPE_GA_FOLDER else Ent.DRIVE_FILE
|
||||
|
||||
QUERY_SHORTCUTS_MAP = {
|
||||
'allfiles': f"mimeType != '{MIMETYPE_GA_FOLDER}'",
|
||||
'allfolders': f"mimeType = '{MIMETYPE_GA_FOLDER}'",
|
||||
'allforms': f"mimeType = '{MIMETYPE_GA_FORM}'",
|
||||
'allgooglefiles': f"mimeType != '{MIMETYPE_GA_FOLDER}' and mimeType contains 'vnd.google'",
|
||||
'allnongooglefiles': "not mimeType contains 'vnd.google'",
|
||||
'allshortcuts': f"mimeType = '{MIMETYPE_GA_SHORTCUT}'",
|
||||
'all3pshortcuts': f"mimeType = '{MIMETYPE_GA_3P_SHORTCUT}'",
|
||||
'allitems': 'allitems',
|
||||
'mycommentableitems': ME_IN_OWNERS_AND+f"(mimeType = '{MIMETYPE_GA_DOCUMENT}' or mimeType = '{MIMETYPE_GA_SPREADSHEET}' or mimeType = '{MIMETYPE_GA_PRESENTATION}')",
|
||||
'mydocs': ME_IN_OWNERS_AND+f"mimeType = '{MIMETYPE_GA_DOCUMENT}'",
|
||||
'myfiles': ME_IN_OWNERS_AND+f"mimeType != '{MIMETYPE_GA_FOLDER}'",
|
||||
'myfolders': ME_IN_OWNERS_AND+f"mimeType = '{MIMETYPE_GA_FOLDER}'",
|
||||
'myforms': ME_IN_OWNERS_AND+f"mimeType = '{MIMETYPE_GA_FORM}'",
|
||||
'mygooglefiles': ME_IN_OWNERS_AND+f"mimeType != '{MIMETYPE_GA_FOLDER}' and mimeType contains 'vnd.google'",
|
||||
'mynongooglefiles': ME_IN_OWNERS_AND+"not mimeType contains 'vnd.google'",
|
||||
'mypresentations': ME_IN_OWNERS_AND+f"mimeType = '{MIMETYPE_GA_PRESENTATION}'",
|
||||
'mypublishableitems': ME_IN_OWNERS_AND+f"(mimeType = '{MIMETYPE_GA_DOCUMENT}' or mimeType = '{MIMETYPE_GA_SPREADSHEET}' or mimeType = '{MIMETYPE_GA_FORM}' or mimeType = '{MIMETYPE_GA_PRESENTATION}')",
|
||||
'mysheets': ME_IN_OWNERS_AND+f"mimeType = '{MIMETYPE_GA_SPREADSHEET}'",
|
||||
'myshortcuts': ME_IN_OWNERS_AND+f"mimeType = '{MIMETYPE_GA_SHORTCUT}'",
|
||||
'myslides': ME_IN_OWNERS_AND+f"mimeType = '{MIMETYPE_GA_PRESENTATION}'",
|
||||
'my3pshortcuts': ME_IN_OWNERS_AND+f"mimeType = '{MIMETYPE_GA_3P_SHORTCUT}'",
|
||||
'myitems': ME_IN_OWNERS,
|
||||
'mytopfiles': ME_IN_OWNERS_AND+f"mimeType != '{MIMETYPE_GA_FOLDER}' and 'root' in parents",
|
||||
'mytopfolders': ME_IN_OWNERS_AND+f"mimeType = '{MIMETYPE_GA_FOLDER}' and 'root' in parents",
|
||||
'mytopitems': ME_IN_OWNERS_AND+"'root' in parents",
|
||||
'othersfiles': NOT_ME_IN_OWNERS_AND+f"mimeType != '{MIMETYPE_GA_FOLDER}'",
|
||||
'othersfolders': NOT_ME_IN_OWNERS_AND+f"mimeType = '{MIMETYPE_GA_FOLDER}'",
|
||||
'othersforms': NOT_ME_IN_OWNERS_AND+f"mimeType = '{MIMETYPE_GA_FORM}'",
|
||||
'othersgooglefiles': NOT_ME_IN_OWNERS_AND+f"mimeType != '{MIMETYPE_GA_FOLDER}' and mimeType contains 'vnd.google'",
|
||||
'othersnongooglefiles': NOT_ME_IN_OWNERS_AND+"not mimeType contains 'vnd.google'",
|
||||
'othersshortcuts': NOT_ME_IN_OWNERS_AND+f"mimeType = '{MIMETYPE_GA_SHORTCUT}'",
|
||||
'others3pshortcuts': NOT_ME_IN_OWNERS_AND+f"mimeType = '{MIMETYPE_GA_3P_SHORTCUT}'",
|
||||
'othersitems': NOT_ME_IN_OWNERS,
|
||||
'writablefiles': f"'me' in writers and mimeType != '{MIMETYPE_GA_FOLDER}'",
|
||||
}
|
||||
SHAREDDRIVE_QUERY_SHORTCUTS_MAP = {
|
||||
'allfiles': f"mimeType != '{MIMETYPE_GA_FOLDER}'",
|
||||
'allfolders': f"mimeType = '{MIMETYPE_GA_FOLDER}'",
|
||||
'allgooglefiles': f"mimeType != '{MIMETYPE_GA_FOLDER}' and mimeType contains 'vnd.google'",
|
||||
'allnongooglefiles': "not mimeType contains 'vnd.google'",
|
||||
'allitems': 'allitems',
|
||||
}
|
||||
|
||||
|
||||
628
src/gam/util/tags.py
Normal file
628
src/gam/util/tags.py
Normal file
@@ -0,0 +1,628 @@
|
||||
"""Tag replacement, user substitution, and email notification utilities.
|
||||
|
||||
Extracted from gam/cmd/send_email.py to eliminate circular imports.
|
||||
"""
|
||||
|
||||
import re
|
||||
|
||||
from gamlib import glapi as API
|
||||
from gamlib import glclargs
|
||||
from gamlib import glentity
|
||||
from gamlib import glgapi as GAPI
|
||||
from gamlib import glglobals as GM
|
||||
from gamlib import glmsgs as Msg
|
||||
from gam.util.access import entityUnknownWarning
|
||||
from gam.util.api import buildGAPIObject, callGAPI
|
||||
from gam.util.args import (
|
||||
FALSE,
|
||||
TRUE,
|
||||
TRUE_FALSE,
|
||||
checkArgumentPresent,
|
||||
getREPatternSubstitution,
|
||||
getString,
|
||||
normalizeEmailAddressOrUID,
|
||||
splitEmailAddress,
|
||||
)
|
||||
from gam.util.email import send_email
|
||||
from gam.util.entity import getEntityToModify, getNormalizedEmailAddressEntity
|
||||
from gam.util.errors import (
|
||||
invalidArgumentExit,
|
||||
invalidChoiceExit,
|
||||
usageErrorExit,
|
||||
)
|
||||
|
||||
Ent = glentity.GamEntity()
|
||||
Cmd = glclargs.GamCLArgs()
|
||||
|
||||
|
||||
def _substituteForUser(field, user, userName):
|
||||
if field.find('#') == -1:
|
||||
return field
|
||||
return field.replace('#user#', user).replace('#email#', user).replace('#username#', userName)
|
||||
|
||||
# Tag utilities
|
||||
TAG_ADDRESS_ARGUMENT_TO_FIELD_MAP = {
|
||||
'country': 'country',
|
||||
'countrycode': 'countryCode',
|
||||
'customtype': 'customType',
|
||||
'extendedaddress': 'extendedAddress',
|
||||
'formatted': 'formatted',
|
||||
'locality': 'locality',
|
||||
'pobox': 'poBox',
|
||||
'postalcode': 'postalCode',
|
||||
'primary': 'primary',
|
||||
'region': 'region',
|
||||
'streetaddress': 'streetAddress',
|
||||
'type': 'type',
|
||||
}
|
||||
|
||||
TAG_EMAIL_ARGUMENT_TO_FIELD_MAP = {
|
||||
'domain': 'domain',
|
||||
'primaryemail': 'primaryEmail',
|
||||
'username': 'username',
|
||||
}
|
||||
|
||||
TAG_EXTERNALID_ARGUMENT_TO_FIELD_MAP = {
|
||||
'customtype': 'customType',
|
||||
'type': 'type',
|
||||
'value': 'value',
|
||||
}
|
||||
|
||||
TAG_GENDER_ARGUMENT_TO_FIELD_MAP = {
|
||||
'addressmeas': 'addressMeAs',
|
||||
'customgender': 'customGender',
|
||||
'type': 'type',
|
||||
}
|
||||
|
||||
TAG_IM_ARGUMENT_TO_FIELD_MAP = {
|
||||
'customprotocol': 'customProtocol',
|
||||
'customtype': 'customType',
|
||||
'im': 'im',
|
||||
'protocol': 'protocol',
|
||||
'primary': 'primary',
|
||||
'type': 'type',
|
||||
}
|
||||
|
||||
TAG_KEYWORD_ARGUMENT_TO_FIELD_MAP = {
|
||||
'customtype': 'customType',
|
||||
'type': 'type',
|
||||
'value': 'value',
|
||||
}
|
||||
|
||||
TAG_LOCATION_ARGUMENT_TO_FIELD_MAP = {
|
||||
'area': 'area',
|
||||
'buildingid': 'buildingId',
|
||||
'buildingname': 'buildingName',
|
||||
'customtype': 'customType',
|
||||
'deskcode': 'deskCode',
|
||||
'floorname': 'floorName',
|
||||
'floorsection': 'floorSection',
|
||||
'type': 'type',
|
||||
}
|
||||
|
||||
TAG_NAME_ARGUMENT_TO_FIELD_MAP = {
|
||||
'familyname': 'familyName',
|
||||
'fullname': 'fullName',
|
||||
'givenname': 'givenName',
|
||||
}
|
||||
|
||||
TAG_ORGANIZATION_ARGUMENT_TO_FIELD_MAP = {
|
||||
'costcenter': 'costCenter',
|
||||
'costcentre': 'costCenter',
|
||||
'customtype': 'customType',
|
||||
'department': 'department',
|
||||
'description': 'description',
|
||||
'domain': 'domain',
|
||||
'fulltimeequivalent': 'fullTimeEquivalent',
|
||||
'location': 'location',
|
||||
'name': 'name',
|
||||
'primary': 'primary',
|
||||
'symbol': 'symbol',
|
||||
'title': 'title',
|
||||
'type': 'type',
|
||||
}
|
||||
|
||||
TAG_OTHEREMAIL_ARGUMENT_TO_FIELD_MAP = {
|
||||
'address': 'address',
|
||||
'customtype': 'customType',
|
||||
'primary': 'primary',
|
||||
'type': 'type',
|
||||
}
|
||||
|
||||
TAG_PHONE_ARGUMENT_TO_FIELD_MAP = {
|
||||
'customtype': 'customType',
|
||||
'primary': 'primary',
|
||||
'type': 'type',
|
||||
'value': 'value',
|
||||
}
|
||||
|
||||
TAG_POSIXACCOUNT_ARGUMENT_TO_FIELD_MAP = {
|
||||
'accountid': 'accountId',
|
||||
'gecos': 'gecos',
|
||||
'gid': 'gid',
|
||||
'homedirectory': 'homeDirectory',
|
||||
'operatingsystemtype': 'operatingSystemType',
|
||||
'primary': 'primary',
|
||||
'shell': 'shell',
|
||||
'systemid': 'systemId',
|
||||
'uid': 'uid',
|
||||
'username': 'username',
|
||||
}
|
||||
|
||||
TAG_RELATION_ARGUMENT_TO_FIELD_MAP = {
|
||||
'customtype': 'customType',
|
||||
'type': 'type',
|
||||
'value': 'value',
|
||||
}
|
||||
|
||||
TAG_SSHPUBLICKEY_ARGUMENT_TO_FIELD_MAP = {
|
||||
'expirationtimeusec': 'expirationTimeUsec',
|
||||
'fingerprint': 'fingerprint',
|
||||
'key': 'key',
|
||||
}
|
||||
|
||||
TAG_WEBSITE_ARGUMENT_TO_FIELD_MAP = {
|
||||
'customtype': 'customType',
|
||||
'primary': 'primary',
|
||||
'type': 'type',
|
||||
'value': 'value',
|
||||
}
|
||||
|
||||
TAG_FIELD_SUBFIELD_CHOICE_MAP = {
|
||||
'address': ('addresses', TAG_ADDRESS_ARGUMENT_TO_FIELD_MAP),
|
||||
'addresses': ('addresses', TAG_ADDRESS_ARGUMENT_TO_FIELD_MAP),
|
||||
'email': ('primaryEmail', TAG_EMAIL_ARGUMENT_TO_FIELD_MAP),
|
||||
'externalid': ('externalIds', TAG_EXTERNALID_ARGUMENT_TO_FIELD_MAP),
|
||||
'externalids': ('externalIds', TAG_EXTERNALID_ARGUMENT_TO_FIELD_MAP),
|
||||
'gender': ('gender', TAG_GENDER_ARGUMENT_TO_FIELD_MAP),
|
||||
'im': ('ims', TAG_IM_ARGUMENT_TO_FIELD_MAP),
|
||||
'ims': ('ims', TAG_IM_ARGUMENT_TO_FIELD_MAP),
|
||||
'keyword': ('keywords', TAG_KEYWORD_ARGUMENT_TO_FIELD_MAP),
|
||||
'keywords': ('keywords', TAG_KEYWORD_ARGUMENT_TO_FIELD_MAP),
|
||||
'location': ('locations', TAG_LOCATION_ARGUMENT_TO_FIELD_MAP),
|
||||
'locations': ('locations', TAG_LOCATION_ARGUMENT_TO_FIELD_MAP),
|
||||
'name': ('name', TAG_NAME_ARGUMENT_TO_FIELD_MAP),
|
||||
'organization': ('organizations', TAG_ORGANIZATION_ARGUMENT_TO_FIELD_MAP),
|
||||
'organizations': ('organizations', TAG_ORGANIZATION_ARGUMENT_TO_FIELD_MAP),
|
||||
'organisation': ('organizations', TAG_ORGANIZATION_ARGUMENT_TO_FIELD_MAP),
|
||||
'organisations': ('organizations', TAG_ORGANIZATION_ARGUMENT_TO_FIELD_MAP),
|
||||
'otheremail': ('emails', TAG_OTHEREMAIL_ARGUMENT_TO_FIELD_MAP),
|
||||
'otheremails': ('emails', TAG_OTHEREMAIL_ARGUMENT_TO_FIELD_MAP),
|
||||
'phone': ('phones', TAG_PHONE_ARGUMENT_TO_FIELD_MAP),
|
||||
'phones': ('phones', TAG_PHONE_ARGUMENT_TO_FIELD_MAP),
|
||||
'photourl': ('thumbnailPhotoUrl', {'': 'thumbnailPhotoUrl'}),
|
||||
'posix': ('posixAccounts', TAG_POSIXACCOUNT_ARGUMENT_TO_FIELD_MAP),
|
||||
'posixaccounts': ('posixAccounts', TAG_POSIXACCOUNT_ARGUMENT_TO_FIELD_MAP),
|
||||
'relation': ('relations', TAG_RELATION_ARGUMENT_TO_FIELD_MAP),
|
||||
'relations': ('relations', TAG_RELATION_ARGUMENT_TO_FIELD_MAP),
|
||||
'sshkeys': ('sshPublicKeys', TAG_SSHPUBLICKEY_ARGUMENT_TO_FIELD_MAP),
|
||||
'sshpublickeys': ('sshPublicKeys', TAG_SSHPUBLICKEY_ARGUMENT_TO_FIELD_MAP),
|
||||
'website': ('websites', TAG_WEBSITE_ARGUMENT_TO_FIELD_MAP),
|
||||
'websites': ('websites', TAG_WEBSITE_ARGUMENT_TO_FIELD_MAP),
|
||||
}
|
||||
|
||||
def _initTagReplacements():
|
||||
return {'cd': None, 'tags': {}, 'subs': False,
|
||||
'fieldsSet': set(), 'fields': '',
|
||||
'schemasSet': set(), 'customFieldMask': None}
|
||||
|
||||
def _getTagReplacement(myarg, tagReplacements, allowSubs):
|
||||
from gam.cmd.resources import _makeBuildingIdNameMap
|
||||
if myarg == 'replace':
|
||||
trregex = None
|
||||
elif myarg == 'replaceregex':
|
||||
trregex = getREPatternSubstitution(re.IGNORECASE)
|
||||
else:
|
||||
return False
|
||||
matchTag = getString(Cmd.OB_TAG)
|
||||
matchReplacement = getString(Cmd.OB_STRING, minLen=0)
|
||||
if matchReplacement.startswith('field:'):
|
||||
if not allowSubs:
|
||||
usageErrorExit(Msg.USER_SUBS_NOT_ALLOWED_TAG_REPLACEMENT)
|
||||
tagReplacements['subs'] = True
|
||||
field = matchReplacement[6:].strip().lower()
|
||||
if field.find('.') != -1:
|
||||
args = field.split('.', 3)
|
||||
field = args[0]
|
||||
subfield = args[1]
|
||||
if len(args) == 2:
|
||||
matchfield = matchvalue = ''
|
||||
elif len(args) == 4:
|
||||
matchfield = args[2]
|
||||
matchvalue = args[3]
|
||||
if matchfield == 'primary':
|
||||
matchvalue = matchvalue.lower()
|
||||
if matchvalue == TRUE:
|
||||
matchvalue = True
|
||||
elif matchvalue == FALSE:
|
||||
matchvalue = ''
|
||||
else:
|
||||
invalidChoiceExit(matchvalue, TRUE_FALSE, True)
|
||||
else:
|
||||
Cmd.Backup()
|
||||
usageErrorExit(Msg.INVALID_TAG_SPECIFICATION)
|
||||
elif field == 'photourl':
|
||||
subfield = matchfield = matchvalue = ''
|
||||
else:
|
||||
field = ''
|
||||
if not field or field not in TAG_FIELD_SUBFIELD_CHOICE_MAP:
|
||||
invalidChoiceExit(field, TAG_FIELD_SUBFIELD_CHOICE_MAP, True)
|
||||
field, subfieldsChoiceMap = TAG_FIELD_SUBFIELD_CHOICE_MAP[field]
|
||||
if subfield not in subfieldsChoiceMap:
|
||||
invalidChoiceExit(subfield, subfieldsChoiceMap, True)
|
||||
subfield = subfieldsChoiceMap[subfield]
|
||||
if matchfield:
|
||||
if matchfield not in subfieldsChoiceMap:
|
||||
invalidChoiceExit(matchfield, subfieldsChoiceMap, True)
|
||||
matchfield = subfieldsChoiceMap[matchfield]
|
||||
tagReplacements['fieldsSet'].add(field)
|
||||
tagReplacements['fields'] = ','.join(tagReplacements['fieldsSet'])
|
||||
tagReplacements['tags'][matchTag] = {'field': field, 'subfield': subfield,
|
||||
'matchfield': matchfield, 'matchvalue': matchvalue, 'value': '',
|
||||
'trregex': trregex}
|
||||
if field == 'locations' and subfield == 'buildingName':
|
||||
_makeBuildingIdNameMap()
|
||||
elif matchReplacement.startswith('schema:'):
|
||||
if not allowSubs:
|
||||
usageErrorExit(Msg.USER_SUBS_NOT_ALLOWED_TAG_REPLACEMENT)
|
||||
tagReplacements['subs'] = True
|
||||
matchReplacement = matchReplacement[7:].strip()
|
||||
if matchReplacement.find('.') != -1:
|
||||
schemaName, schemaField = matchReplacement.split('.', 1)
|
||||
else:
|
||||
schemaName = ''
|
||||
if not schemaName or not schemaField:
|
||||
invalidArgumentExit(Cmd.OB_SCHEMA_NAME_FIELD_NAME)
|
||||
tagReplacements['fieldsSet'].add('customSchemas')
|
||||
tagReplacements['fields'] = ','.join(tagReplacements['fieldsSet'])
|
||||
tagReplacements['schemasSet'].add(schemaName)
|
||||
tagReplacements['customFieldMask'] = ','.join(tagReplacements['schemasSet'])
|
||||
tagReplacements['tags'][matchTag] = {'schema': schemaName, 'schemafield': schemaField, 'value': '',
|
||||
'trregex': trregex}
|
||||
elif ((matchReplacement.find('#') >= 0) and
|
||||
(matchReplacement.find('#user#') >= 0) or (matchReplacement.find('#email#') >= 0) or (matchReplacement.find('#username#') >= 0)):
|
||||
if not allowSubs:
|
||||
usageErrorExit(Msg.USER_SUBS_NOT_ALLOWED_TAG_REPLACEMENT)
|
||||
tagReplacements['subs'] = True
|
||||
tagReplacements['tags'][matchTag] = {'template': matchReplacement, 'value': '',
|
||||
'trregex': trregex}
|
||||
else:
|
||||
if trregex is None:
|
||||
tagReplacements['tags'][matchTag] = {'value': matchReplacement}
|
||||
else:
|
||||
tagReplacements['tags'][matchTag] = {'value': re.sub(trregex[0], trregex[1], matchReplacement)}
|
||||
return True
|
||||
|
||||
def _getTagReplacementFieldValues(user, i, count, tagReplacements, results=None):
|
||||
if results is None:
|
||||
if tagReplacements['fields'] and tagReplacements['fields'] != 'primaryEmail':
|
||||
if not tagReplacements['cd']:
|
||||
tagReplacements['cd'] = buildGAPIObject(API.DIRECTORY)
|
||||
try:
|
||||
results = callGAPI(tagReplacements['cd'].users(), 'get',
|
||||
throwReasons=GAPI.USER_GET_THROW_REASONS,
|
||||
userKey=user, projection='custom', customFieldMask=tagReplacements['customFieldMask'], fields=tagReplacements['fields'])
|
||||
except (GAPI.userNotFound, GAPI.domainNotFound, GAPI.domainCannotUseApis, GAPI.forbidden, GAPI.badRequest, GAPI.backendError, GAPI.systemError):
|
||||
entityUnknownWarning(Ent.USER, user, i, count)
|
||||
return
|
||||
else:
|
||||
results = {'primaryEmail': user}
|
||||
userName, domain = splitEmailAddress(user)
|
||||
for tag in tagReplacements['tags'].values():
|
||||
if tag.get('field'):
|
||||
field = tag['field']
|
||||
if field == 'primaryEmail':
|
||||
subfield = tag['subfield']
|
||||
if subfield == 'username':
|
||||
tag['value'] = userName
|
||||
elif subfield == 'domain':
|
||||
tag['value'] = domain
|
||||
else:
|
||||
tag['value'] = user
|
||||
else:
|
||||
if field in ['addresses', 'emails', 'ims', 'organizations', 'phones', 'posixAccounts', 'websites']:
|
||||
items = results.get(field, [])
|
||||
if not tag['matchfield']:
|
||||
for data in items:
|
||||
if data.get('primary'):
|
||||
break
|
||||
else:
|
||||
if items:
|
||||
data = items[0]
|
||||
else:
|
||||
data = {}
|
||||
else:
|
||||
for data in items:
|
||||
if data.get(tag['matchfield'], '') == tag['matchvalue']:
|
||||
break
|
||||
else:
|
||||
data = {}
|
||||
elif field in ['externalIds', 'relations', 'sshPublicKeys']:
|
||||
items = results.get(field, [])
|
||||
if not tag['matchfield']:
|
||||
if items:
|
||||
data = items[0]
|
||||
else:
|
||||
data = {}
|
||||
else:
|
||||
for data in items:
|
||||
if data.get(tag['matchfield'], '') == tag['matchvalue']:
|
||||
break
|
||||
else:
|
||||
data = {}
|
||||
elif field in ['keywords', 'locations']:
|
||||
items = results.get(field, [])
|
||||
if not tag['matchfield']:
|
||||
if items:
|
||||
data = items[0]
|
||||
data['buildingName'] = GM.Globals[GM.MAP_BUILDING_ID_TO_NAME].get(data.get('buildingId', ''), '')
|
||||
else:
|
||||
data = {}
|
||||
else:
|
||||
for data in items:
|
||||
if data.get(tag['matchfield'], '') == tag['matchvalue']:
|
||||
break
|
||||
else:
|
||||
data = {}
|
||||
elif field == 'thumbnailPhotoUrl':
|
||||
data = results
|
||||
else:
|
||||
data = results.get(field, {})
|
||||
tag['value'] = str(data.get(tag['subfield'], ''))
|
||||
elif tag.get('schema'):
|
||||
tag['value'] = str(results.get('customSchemas', {}).get(tag['schema'], {}).get(tag['schemafield'], ''))
|
||||
elif tag.get('template'):
|
||||
tag['value'] = _substituteForUser(tag['template'], user, userName)
|
||||
trregex = tag.get('trregex', None)
|
||||
if trregex is not None:
|
||||
tag['value'] = re.sub(trregex[0], trregex[1], tag['value'])
|
||||
|
||||
RTL_PATTERN = re.compile(r'(?s){RTL}.*?{/RTL}')
|
||||
RT_PATTERN = re.compile(r'(?s){RT}.*?{/RT}')
|
||||
TAG_REPLACE_PATTERN = re.compile(r'{(.+?)}')
|
||||
RT_MARKERS = {'RT', '/RT', 'RTL', '/RTL'}
|
||||
PC_PATTERN = re.compile(r'(?s){PC}.*?{/PC}')
|
||||
UC_PATTERN = re.compile(r'(?s){UC}.*?{/UC}')
|
||||
LC_PATTERN = re.compile(r'(?s){LC}.*?{/LC}')
|
||||
CASE_MARKERS = {'PC', '/PC', 'UC', '/UC', 'LC', '/LC'}
|
||||
SKIP_PATTERNS = [re.compile(r'<head>.*?</head>', flags=re.IGNORECASE),
|
||||
re.compile(r'<script>.*?</script>', flags=re.IGNORECASE)]
|
||||
|
||||
def _processTagReplacements(tagReplacements, message):
|
||||
def pcase(trstring):
|
||||
new = ''
|
||||
# state = True: Upshift 1st letter found
|
||||
# state = False: Downshift subsequent letters
|
||||
state = True
|
||||
for c in trstring:
|
||||
if state:
|
||||
if c.isalpha():
|
||||
new += c.upper()
|
||||
state = False
|
||||
else:
|
||||
new += c
|
||||
else:
|
||||
if c.isalpha():
|
||||
new += c.lower()
|
||||
else:
|
||||
state = True
|
||||
new += c
|
||||
return new
|
||||
|
||||
def ucase(trstring):
|
||||
return trstring.upper()
|
||||
|
||||
def lcase(trstring):
|
||||
return trstring.lower()
|
||||
|
||||
def _processCase(message, casePattern, caseFunc):
|
||||
# Find all {xC}.*?{/xC} sequences
|
||||
pos = 0
|
||||
while True:
|
||||
match = casePattern.search(message, pos)
|
||||
if not match:
|
||||
return message
|
||||
start, end = match.span()
|
||||
for skipArea in skipAreas:
|
||||
if start >= skipArea[0] and end <= skipArea[1]:
|
||||
break
|
||||
else:
|
||||
message = message[:start]+caseFunc(message[start+4:end-5])+message[end:]
|
||||
pos = end
|
||||
|
||||
# Identify areas of message to avoid replacements
|
||||
skipAreas = []
|
||||
for pattern in SKIP_PATTERNS:
|
||||
pos = 0
|
||||
while True:
|
||||
match = pattern.search(message, pos)
|
||||
if not match:
|
||||
break
|
||||
skipAreas.append(match.span())
|
||||
pos = match.end()
|
||||
skipTags = set()
|
||||
# Find all {tag}, note replacement value and starting location; note tags in skipAreas
|
||||
tagFields = []
|
||||
tagSubs = {}
|
||||
pos = 0
|
||||
while True:
|
||||
match = TAG_REPLACE_PATTERN.search(message, pos)
|
||||
if not match:
|
||||
break
|
||||
start, end = match.span()
|
||||
tag = match.group(1)
|
||||
if tag in CASE_MARKERS:
|
||||
pass
|
||||
elif tag not in RT_MARKERS:
|
||||
for skipArea in skipAreas:
|
||||
if start >= skipArea[0] and end <= skipArea[1]:
|
||||
skipTags.add(tag)
|
||||
break
|
||||
else:
|
||||
tagSubs.setdefault(tag, tagReplacements['tags'].get(tag, {'value': ''})['value'])
|
||||
tagFields.append((tagSubs[tag], start))
|
||||
pos = end
|
||||
# Find all {RT}.*?{/RT} sequences
|
||||
# If any non-empty {tag} replacement value falls between them, then mark {RT} and {/RT} to be stripped
|
||||
# Otherwise, mark the entire {RT}.*?{/RT} sequence to be stripped
|
||||
rtStrips = []
|
||||
pos = 0
|
||||
while True:
|
||||
match = RT_PATTERN.search(message, pos)
|
||||
if not match:
|
||||
break
|
||||
start, end = match.span()
|
||||
stripEntireRT = True
|
||||
hasTags = False
|
||||
for tagField in tagFields:
|
||||
if tagField[1] >= end:
|
||||
break
|
||||
if tagField[1] >= start:
|
||||
hasTags = True
|
||||
if tagField[0]:
|
||||
rtStrips.append((False, start, start+4))
|
||||
rtStrips.append((False, end-5, end))
|
||||
stripEntireRT = False
|
||||
break
|
||||
if stripEntireRT:
|
||||
if hasTags or start+4 == end-5:
|
||||
rtStrips.append((True, start, end))
|
||||
else:
|
||||
rtStrips.append((False, start, start+4))
|
||||
rtStrips.append((False, end-5, end))
|
||||
pos = end
|
||||
# Find all {RTL}.*?{/RTL} sequences
|
||||
# If any non-empty {RT}...{tag}... {/RT} falls between them, then mark {RTL} and {/RTL} to be stripped
|
||||
# Otherwise, mark the entire {RTL}.*{/RTL} sequence to be stripped
|
||||
rtlStrips = []
|
||||
pos = 0
|
||||
while True:
|
||||
match = RTL_PATTERN.search(message, pos)
|
||||
if not match:
|
||||
break
|
||||
start, end = match.span()
|
||||
stripEntireRTL = True
|
||||
hasTags = False
|
||||
for tagField in tagFields:
|
||||
if tagField[1] >= end:
|
||||
break
|
||||
if tagField[1] >= start:
|
||||
hasTags = True
|
||||
if tagField[0]:
|
||||
rtlStrips.append((False, start, start+5, end-6, end))
|
||||
stripEntireRTL = False
|
||||
break
|
||||
if stripEntireRTL:
|
||||
for rtStrip in rtStrips:
|
||||
if rtStrip[1] >= end:
|
||||
break
|
||||
if rtStrip[1] >= start:
|
||||
hasTags = True
|
||||
if not rtStrip[0]:
|
||||
rtlStrips.append((False, start, start+5, end-6, end))
|
||||
stripEntireRTL = False
|
||||
break
|
||||
if stripEntireRTL:
|
||||
if hasTags or start+5 == end-6:
|
||||
rtlStrips.append((True, start, end))
|
||||
else:
|
||||
rtlStrips.append((False, start, start+5, end-6, end))
|
||||
pos = end
|
||||
if rtlStrips:
|
||||
allStrips = []
|
||||
i = 0
|
||||
l = len(rtStrips)
|
||||
for rtlStrip in rtlStrips:
|
||||
while i < l and rtStrips[i][1] < rtlStrip[1]:
|
||||
allStrips.append(rtStrips[i])
|
||||
i += 1
|
||||
allStrips.append((False, rtlStrip[1], rtlStrip[2]))
|
||||
if not rtlStrip[0]:
|
||||
while i < l and rtStrips[i][1] < rtlStrip[3]:
|
||||
allStrips.append(rtStrips[i])
|
||||
i += 1
|
||||
allStrips.append((False, rtlStrip[3], rtlStrip[4]))
|
||||
else:
|
||||
while i < l and rtStrips[i][1] < rtlStrip[2]:
|
||||
i += 1
|
||||
while i < l:
|
||||
allStrips.append(rtStrips[i])
|
||||
i += 1
|
||||
else:
|
||||
allStrips = rtStrips
|
||||
# Strip {RTL} {/RTL}, {RT} {/RT}, {RTL}.*?{/RTL}, {RT}.*?{/RT} sequences
|
||||
for rtStrip in allStrips[::-1]:
|
||||
message = message[:rtStrip[1]]+message[rtStrip[2]:]
|
||||
# Strip {RTL} {/RTL}, {RT} {/RT}, {RTL}.*?{/RTL}, {RT}.*?{/RT} sequences
|
||||
# Make {tag} replacements; ignore tags in skipAreas
|
||||
pos = 0
|
||||
while True:
|
||||
match = TAG_REPLACE_PATTERN.search(message, pos)
|
||||
if not match:
|
||||
break
|
||||
start, end = match.span()
|
||||
tag = match.group(1)
|
||||
if tag in CASE_MARKERS:
|
||||
pos = end
|
||||
elif tag not in RT_MARKERS:
|
||||
if tag not in skipTags:
|
||||
message = re.sub(match.group(0), tagSubs[tag], message)
|
||||
pos = start+1
|
||||
else:
|
||||
pos = end
|
||||
else:
|
||||
# Replace invalid RT tags with ERROR(RT)
|
||||
message = re.sub(match.group(0), f'ERROR({tag})', message)
|
||||
pos = start+1
|
||||
# Process case changes
|
||||
message = _processCase(message, PC_PATTERN, pcase)
|
||||
message = _processCase(message, UC_PATTERN, ucase)
|
||||
message = _processCase(message, LC_PATTERN, lcase)
|
||||
return message
|
||||
|
||||
def sendCreateUpdateUserNotification(body, basenotify, tagReplacements, i=0, count=0, msgFrom=None, createMessage=True):
|
||||
def _makeSubstitutions(field):
|
||||
notify[field] = _substituteForUser(notify[field], body['primaryEmail'], userName)
|
||||
notify[field] = notify[field].replace('#domain#', domain)
|
||||
notify[field] = notify[field].replace('#givenname#', body['name'].get('givenName', ''))
|
||||
notify[field] = notify[field].replace('#familyname#', body['name'].get('familyName', ''))
|
||||
|
||||
def _makePasswordSubstitutions(field, html):
|
||||
if not html:
|
||||
notify[field] = notify[field].replace('#password#', notify['password'])
|
||||
else:
|
||||
notify[field] = notify[field].replace('#password#', notify['password'].replace('&', '&').replace('<', '<').replace('>', '>'))
|
||||
|
||||
userName, domain = splitEmailAddress(body['primaryEmail'])
|
||||
notify = basenotify.copy()
|
||||
if not notify['subject']:
|
||||
notify['subject'] = Msg.CREATE_USER_NOTIFY_SUBJECT if createMessage else Msg.UPDATE_USER_PASSWORD_CHANGE_NOTIFY_SUBJECT
|
||||
_makeSubstitutions('subject')
|
||||
if not notify['message']:
|
||||
notify['message'] = Msg.CREATE_USER_NOTIFY_MESSAGE if createMessage else Msg.UPDATE_USER_PASSWORD_CHANGE_NOTIFY_MESSAGE
|
||||
elif notify['html']:
|
||||
notify['message'] = notify['message'].replace('\\r', '').replace('\\\\n', '<br/>')
|
||||
else:
|
||||
notify['message'] = notify['message'].replace('\\r', '').replace('\\\\n', '\n')
|
||||
_makeSubstitutions('message')
|
||||
if tagReplacements['subs']:
|
||||
_getTagReplacementFieldValues(body['primaryEmail'], i, count, tagReplacements, body if createMessage else None)
|
||||
notify['subject'] = _processTagReplacements(tagReplacements, notify['subject'])
|
||||
notify['message'] = _processTagReplacements(tagReplacements, notify['message'])
|
||||
_makePasswordSubstitutions('subject', False)
|
||||
_makePasswordSubstitutions('message', notify['html'])
|
||||
if 'from' in notify:
|
||||
msgFrom = notify['from']
|
||||
msgReplyTo = notify.get('replyto', None)
|
||||
mailBox = notify.get('mailbox', None)
|
||||
for recipient in notify['recipients']:
|
||||
send_email(notify['subject'], notify['message'], recipient, i, count,
|
||||
msgFrom=msgFrom, msgReplyTo=msgReplyTo, html=notify['html'], charset=notify['charset'], mailBox=mailBox)
|
||||
|
||||
def getRecipients():
|
||||
if checkArgumentPresent('select'):
|
||||
_, recipients = getEntityToModify(defaultEntityType=Cmd.ENTITY_USERS)
|
||||
return [normalizeEmailAddressOrUID(emailAddress, noUid=True, noLower=True) for emailAddress in recipients]
|
||||
return getNormalizedEmailAddressEntity(shlexSplit=True, noLower=True)
|
||||
|
||||
ADDRESS_FIELDS_PRINT_ORDER = ['contactName', 'organizationName', 'addressLine1', 'addressLine2', 'addressLine3', 'locality', 'region', 'postalCode', 'countryCode']
|
||||
Reference in New Issue
Block a user