gam7 7.22.0__py3-none-any.whl → 7.22.4__py3-none-any.whl

gam/__init__.py

@@ -25,7 +25,7 @@ https://github.com/GAM-team/GAM/wiki
 """
 
 __author__ = 'GAM Team <google-apps-manager@googlegroups.com>'
-__version__ = '7.22.00'
+__version__ = '7.22.04'
 __license__ = 'Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0)'
 
 #pylint: disable=wrong-import-position
@@ -18989,10 +18989,10 @@ def doPrintAliases():
       pass
     elif myarg == 'select':
       _, users = getEntityToModify(defaultEntityType=Cmd.ENTITY_USERS)
-    elif myarg in SUSPENDED_ARGUMENTS:
-      isSuspended = _getIsSuspended(myarg)
-    elif myarg in ARCHIVED_ARGUMENTS:
-      isArchived = _getIsArchived(myarg)
+    elif myarg == 'issuspended':
+      isSuspended = getBoolean()
+    elif myarg == 'isarchived':
+      isArchived = getBoolean()
     elif myarg in {'user','users'}:
       users.extend(convertEntityToList(getString(Cmd.OB_EMAIL_ADDRESS_LIST, minLen=0)))
     elif myarg in {'group', 'groups'}:
@@ -41654,7 +41654,7 @@ def convertQueryNameToID(v, nameOrId, matterId, matterNameId):
       query = callGAPI(v.matters().savedQueries(), 'get',
                        throwReasons=[GAPI.NOT_FOUND, GAPI.BAD_REQUEST, GAPI.FORBIDDEN, GAPI.INVALID_ARGUMENT],
                        matterId=matterId, savedQueryId=cg.group(1))
-      return (query['savedQueryId'], query['displayName'], formatVaultNameId(query['savedQueryId'], query['displayName']))
+      return (query['savedQueryId'], query['displayName'], formatVaultNameId(query['savedQueryId'], query['displayName']), query['query'])
     except (GAPI.notFound, GAPI.badRequest):
       entityDoesNotHaveItemExit([Ent.VAULT_MATTER, matterNameId, Ent.VAULT_QUERY, nameOrId])
     except (GAPI.forbidden, GAPI.invalidArgument) as e:
@@ -41663,12 +41663,12 @@ def convertQueryNameToID(v, nameOrId, matterId, matterNameId):
   try:
     queries = callGAPIpages(v.matters().savedQueries(), 'list', 'savedQueries',
                             throwReasons=[GAPI.FORBIDDEN, GAPI.INVALID_ARGUMENT],
-                            matterId=matterId, fields='savedQueries(savedQueryId,displayName),nextPageToken')
+                            matterId=matterId, fields='savedQueries(savedQueryId,displayName,query),nextPageToken')
   except (GAPI.forbidden, GAPI.invalidArgument) as e:
     ClientAPIAccessDeniedExit(str(e))
   for query in queries:
     if query['displayName'].lower() == nameOrIdlower:
-      return (query['savedQueryId'], query['displayName'], formatVaultNameId(query['savedQueryId'], query['displayName']))
+      return (query['savedQueryId'], query['displayName'], formatVaultNameId(query['savedQueryId'], query['displayName']), query['query'])
   entityDoesNotHaveItemExit([Ent.VAULT_MATTER, matterNameId, Ent.VAULT_QUERY, nameOrId])
 
 def getMatterItem(v, state=None):
@@ -41896,7 +41896,8 @@ def _buildVaultQuery(myarg, query, corpusArgumentMap):
     query.setdefault('mailOptions', {})['clientSideEncryptedOption'] = getChoice(VAULT_CSE_OPTION_MAP, mapChoice=True)
 # voice
   elif myarg == 'covereddata':
-    query['voiceOptions'] = {'coveredData': getChoice(VAULT_VOICE_COVERED_DATA_MAP, mapChoice=True)}
+    query.setdefault('voiceOptions', {'coveredData': []})
+    query['voiceOptions']['coveredData'].append(getChoice(VAULT_VOICE_COVERED_DATA_MAP, mapChoice=True))
 
 def _validateVaultQuery(body, corpusArgumentMap):
   if 'corpus' not in body['query']:
@@ -41957,7 +41958,8 @@ def doCreateVaultExport():
     elif myarg == 'includeaccessinfo':
       body['exportOptions'].setdefault('driveOptions', {})['includeAccessInfo'] = getBoolean()
     elif myarg == 'covereddata':
-      body['exportOptions'].setdefault('voiceOptions', {})['coveredData'] = getChoice(VAULT_VOICE_COVERED_DATA_MAP, mapChoice=True)
+      body['exportOptions'].setdefault('voiceOptions', {'coveredData': []})
+      body['exportOptions']['voiceOptions']['coveredData'].append(getChoice(VAULT_VOICE_COVERED_DATA_MAP, mapChoice=True))
     elif myarg == 'showdetails':
       showDetails = True
       returnIdOnly = False
@@ -42459,6 +42461,34 @@ def _showVaultHold(matterNameId, hold, cd, FJQC, k=0, kcount=0):
   showJSON(None, hold, timeObjects=VAULT_HOLD_TIME_OBJECTS)
   Ind.Decrement()
 
+def _useVaultQuery(v, matterId, matterNameId, body):
+  _, _, _, query = convertQueryNameToID(v, getString(Cmd.OB_QUERY_ITEM), matterId, matterNameId)
+  body['corpus'] = query['corpus']
+  method = query.get('method')
+  if method == 'ACCOUNT':
+    body['accounts'] = []
+    for email in query['accountInfo']['emails']:
+      body['accounts'].append({'email': email})
+  elif method == 'ORG_UNIT':
+    body['orgUnit'] = {'orgUnitId': query['orgUnitInfo']['orgUnitId']}
+  queryType = VAULT_CORPUS_QUERY_MAP[query['corpus']]
+  if queryType is None:
+    return
+  body['query'] = {queryType: {}}
+  if query['corpus'] == 'DRIVE':
+    body['query'][queryType]['includeSharedDriveFiles'] = query['driveOptions'].get('includeSharedDrives', False)
+  elif query['corpus'] in {'GROUPS', 'MAIL'}:
+    if query.get('terms'):
+      body['query'][queryType]['terms'] = query['terms']
+    if query.get('startTime'):
+      body['query'][queryType]['startTime'] = query['startTime']
+    if query.get('endTime'):
+      body['query'][queryType]['endTime'] = query['endTime']
+  elif query['corpus'] == 'HANGOUTS_CHAT':
+    body['query'][queryType]['includeRooms'] = query['hangoutsChatOptions'].get('includeRooms', False)
+  elif query['corpus'] == 'VOICE':
+    body['query'][queryType]['coveredData'] = query['voiceOptions']['coveredData']
+
 def _getHoldQueryParameters(myarg, queryParameters):
   if myarg == 'query':
     queryParameters['queryLocation'] = Cmd.Location()
@@ -42474,7 +42504,8 @@ def _getHoldQueryParameters(myarg, queryParameters):
   elif myarg in {'includeshareddrives', 'includeteamdrives'}:
     queryParameters['includeSharedDriveFiles'] = getBoolean()
   elif myarg == 'covereddata':
-    queryParameters['coveredData'] = getChoice(VAULT_VOICE_COVERED_DATA_MAP, mapChoice=True)
+    queryParameters.setdefault('coveredData', [])
+    queryParameters['coveredData'].append(getChoice(VAULT_VOICE_COVERED_DATA_MAP, mapChoice=True))
   else:
     return False
   return True
@@ -42509,7 +42540,11 @@ def _setHoldQuery(body, queryParameters):
     if queryParameters.get('coveredData'):
       body['query'][queryType]['coveredData'] = queryParameters['coveredData']
 
-# gam create vaulthold|hold matter <MatterItem> [name <String>] corpus calendar|drive|mail|groups|hangouts_chat|voice
+# gam create vaulthold|hold matter <MatterItem> [name <String>]
+#	vaultquery <QueryItem>
+#	[showdetails|returnidonly]
+# gam create vaulthold|hold matter <MatterItem> [name <String>]
+#	corpus calendar|drive|mail|groups|hangouts_chat|voice
 #	[(accounts|groups|users <EmailItemList>) | (orgunit|org|ou <OrgUnit>)]
 #	[query <QueryVaultCorpus>]
 #	[terms <String>] [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>]
@@ -42523,13 +42558,16 @@ def doCreateVaultHold():
   matterId = None
   accounts = []
   queryParameters = {}
-  returnIdOnly = showDetails = False
+  returnIdOnly = showDetails = usedVaultQuery  = False
   while Cmd.ArgumentsRemaining():
     myarg = getArgument()
     if myarg == 'matter':
       matterId, matterNameId = getMatterItem(v)
     elif myarg == 'name':
       body['name'] = getString(Cmd.OB_STRING)
+    elif matterId is not None and myarg == 'vaultquery':
+      _useVaultQuery(v, matterId, matterNameId, body)
+      usedVaultQuery = True
     elif myarg == 'corpus':
       body['corpus'] = getChoice(VAULT_CORPUS_ARGUMENT_MAP, mapChoice=True)
     elif myarg in {'accounts', 'users', 'groups'}:
@@ -42553,7 +42591,8 @@ def doCreateVaultHold():
     missingArgumentExit(f'corpus {"|".join(VAULT_CORPUS_ARGUMENT_MAP)}')
   if 'name' not in body:
     body['name'] = f'GAM {body["corpus"]} Hold - {ISOformatTimeStamp(todaysTime())}'
-  _setHoldQuery(body, queryParameters)
+  if not usedVaultQuery:
+    _setHoldQuery(body, queryParameters)
   if accounts:
     body['accounts'] = []
     cd = buildGAPIObject(API.DIRECTORY)
@@ -43006,7 +43045,7 @@ def doInfoVaultQuery():
   v = buildGAPIObject(API.VAULT)
   if not Cmd.ArgumentIsAhead('matter'):
     matterId, matterNameId = getMatterItem(v)
-    queryId, queryName, queryNameId = convertQueryNameToID(v, getString(Cmd.OB_QUERY_ITEM), matterId, matterNameId)
+    queryId, queryName, queryNameId, _ = convertQueryNameToID(v, getString(Cmd.OB_QUERY_ITEM), matterId, matterNameId)
   else:
     queryName = getString(Cmd.OB_QUERY_ITEM)
   cd = drive = None
@@ -43016,7 +43055,7 @@ def doInfoVaultQuery():
     myarg = getArgument()
     if myarg == 'matter':
       matterId, matterNameId = getMatterItem(v)
-      queryId, queryName, queryNameId = convertQueryNameToID(v, queryName, matterId, matterNameId)
+      queryId, queryName, queryNameId, _ = convertQueryNameToID(v, queryName, matterId, matterNameId)
     elif myarg == 'shownames':
       cd = buildGAPIObject(API.DIRECTORY)
       _, drive = buildGAPIServiceObject(API.DRIVE3, _getAdminEmail())
@@ -45754,71 +45793,81 @@ def doPrintUsers(entityList=None):
       csvPF.WriteRowNoFilter(row)
 
   def _printUser(userEntity, i, count):
-    if isSuspended is None or isSuspended == userEntity.get('suspended', isSuspended):
-      if showValidColumn:
-        userEntity[showValidColumn] = True
-      userEmail = userEntity['primaryEmail']
-      if printOptions['emailParts']:
-        if userEmail.find('@') != -1:
-          userEntity['primaryEmailLocal'], userEntity['primaryEmailDomain'] = splitEmailAddress(userEmail)
-      if 'languages' in userEntity and not FJQC.formatJSON:
-        userEntity['languages'] = _formatLanguagesList(userEntity.pop('languages'), delimiter)
-      for location in userEntity.get('locations', []):
-        location['buildingName'] = _getBuildingNameById(cd, location.get('buildingId', ''))
-      if quotePlusPhoneNumbers:
-        for phone in userEntity.get('phones', []):
-          phoneNumber = phone.get('value', '')
-          if phoneNumber.startswith('+'):
-            phone['value'] = "'"+phoneNumber
-      if schemaParms['selectedSchemaFields']:
-        _filterSchemaFields(userEntity, schemaParms)
-      if printOptions['getGroupFeed']:
-        printGettingAllEntityItemsForWhom(Ent.GROUP_MEMBERSHIP, userEmail, i, count)
-        try:
-          groups = callGAPIpages(cd.groups(), 'list', 'groups',
-                                 pageMessage=getPageMessageForWhom(),
-                                 throwReasons=GAPI.GROUP_LIST_USERKEY_THROW_REASONS,
-                                 retryReasons=GAPI.SERVICE_NOT_AVAILABLE_RETRY_REASONS,
-                                 userKey=userEmail, orderBy='email', fields='nextPageToken,groups(email)')
-          numGroups = len(groups)
-          if not printOptions['groupsInColumns']:
-            userEntity['GroupsCount'] = numGroups
-            userEntity['Groups'] = delimiter.join([groupname['email'] for groupname in groups])
-          else:
-            if numGroups > printOptions['maxGroups']:
-              printOptions['maxGroups'] = numGroups
-            userEntity['Groups'] = numGroups
-            for j, group in enumerate(groups):
-              userEntity[f'Groups{GC.Values[GC.CSV_OUTPUT_SUBFIELD_DELIMITER]}{j}'] = group['email']
-        except (GAPI.invalidMember, GAPI.invalidInput):
-          badRequestWarning(Ent.GROUP, Ent.MEMBER, userEmail)
-        except (GAPI.resourceNotFound, GAPI.domainNotFound, GAPI.forbidden, GAPI.badRequest):
-          accessErrorExit(cd)
-      if aliasMatchPattern and 'aliases' in userEntity:
-        userEntity['aliases'] = [alias for alias in userEntity['aliases'] if aliasMatchPattern.match(alias)]
-      if printOptions['getLicenseFeed'] or printOptions['getLicenseFeedByUser']:
-        if printOptions['getLicenseFeed']:
-          u_licenses = licenses.get(userEmail.lower(), [])
+    if (isSuspended is None and isArchived is None):
+      showUser = True
+    elif (isSuspended is not None and isArchived is None):
+      showUser = isSuspended == userEntity.get('suspended', isSuspended)
+    elif (isSuspended is None and isArchived is not  None):
+      showUser = isArchived == userEntity.get('archived', isArchived)
+    else:
+      showUser = ((isSuspended == userEntity.get('suspended', isSuspended)) or
+                  (isArchived == userEntity.get('archived', isArchived)))
+    if not showUser:
+      return
+    if showValidColumn:
+      userEntity[showValidColumn] = True
+    userEmail = userEntity['primaryEmail']
+    if printOptions['emailParts']:
+      if userEmail.find('@') != -1:
+        userEntity['primaryEmailLocal'], userEntity['primaryEmailDomain'] = splitEmailAddress(userEmail)
+    if 'languages' in userEntity and not FJQC.formatJSON:
+      userEntity['languages'] = _formatLanguagesList(userEntity.pop('languages'), delimiter)
+    for location in userEntity.get('locations', []):
+      location['buildingName'] = _getBuildingNameById(cd, location.get('buildingId', ''))
+    if quotePlusPhoneNumbers:
+      for phone in userEntity.get('phones', []):
+        phoneNumber = phone.get('value', '')
+        if phoneNumber.startswith('+'):
+          phone['value'] = "'"+phoneNumber
+    if schemaParms['selectedSchemaFields']:
+      _filterSchemaFields(userEntity, schemaParms)
+    if printOptions['getGroupFeed']:
+      printGettingAllEntityItemsForWhom(Ent.GROUP_MEMBERSHIP, userEmail, i, count)
+      try:
+        groups = callGAPIpages(cd.groups(), 'list', 'groups',
+                               pageMessage=getPageMessageForWhom(),
+                               throwReasons=GAPI.GROUP_LIST_USERKEY_THROW_REASONS,
+                               retryReasons=GAPI.SERVICE_NOT_AVAILABLE_RETRY_REASONS,
+                               userKey=userEmail, orderBy='email', fields='nextPageToken,groups(email)')
+        numGroups = len(groups)
+        if not printOptions['groupsInColumns']:
+          userEntity['GroupsCount'] = numGroups
+          userEntity['Groups'] = delimiter.join([groupname['email'] for groupname in groups])
         else:
-          u_licenses = getUserLicenses(lic, userEntity, skus)
-        if not oneLicensePerRow:
-          userEntity['LicensesCount'] = len(u_licenses)
-          if u_licenses:
-            userEntity['Licenses'] = delimiter.join(u_licenses)
-            userEntity['LicensesDisplay'] = delimiter.join([SKU.skuIdToDisplayName(skuId) for skuId in u_licenses])
+          if numGroups > printOptions['maxGroups']:
+            printOptions['maxGroups'] = numGroups
+          userEntity['Groups'] = numGroups
+          for j, group in enumerate(groups):
+            userEntity[f'Groups{GC.Values[GC.CSV_OUTPUT_SUBFIELD_DELIMITER]}{j}'] = group['email']
+      except (GAPI.invalidMember, GAPI.invalidInput):
+        badRequestWarning(Ent.GROUP, Ent.MEMBER, userEmail)
+      except (GAPI.resourceNotFound, GAPI.domainNotFound, GAPI.forbidden, GAPI.badRequest):
+        accessErrorExit(cd)
+    if aliasMatchPattern and 'aliases' in userEntity:
+      userEntity['aliases'] = [alias for alias in userEntity['aliases'] if aliasMatchPattern.match(alias)]
+    if printOptions['getLicenseFeed'] or printOptions['getLicenseFeedByUser']:
+      if printOptions['getLicenseFeed']:
+        u_licenses = licenses.get(userEmail.lower(), [])
       else:
-        u_licenses = []
+        u_licenses = getUserLicenses(lic, userEntity, skus)
       if not oneLicensePerRow:
-        _writeUserEntity(userEntity)
-      else:
+        userEntity['LicensesCount'] = len(u_licenses)
         if u_licenses:
-          for skuId in u_licenses:
-            userEntity['License'] = skuId
-            userEntity['LicenseDisplay'] = SKU.skuIdToDisplayName(skuId)
-            _writeUserEntity(userEntity)
-        else:
-          userEntity['License'] = userEntity['LicenseDisplay'] = ''
+          userEntity['Licenses'] = delimiter.join(u_licenses)
+          userEntity['LicensesDisplay'] = delimiter.join([SKU.skuIdToDisplayName(skuId) for skuId in u_licenses])
+    else:
+      u_licenses = []
+    if not oneLicensePerRow:
+      _writeUserEntity(userEntity)
+    else:
+      if u_licenses:
+        for skuId in u_licenses:
+          userEntity['License'] = skuId
+          userEntity['LicenseDisplay'] = SKU.skuIdToDisplayName(skuId)
           _writeUserEntity(userEntity)
+      else:
+        userEntity['License'] = userEntity['LicenseDisplay'] = ''
+        _writeUserEntity(userEntity)
 
   def _updateDomainCounts(emailAddress):
     nonlocal domainCounts
@@ -45911,10 +45960,10 @@ def doPrintUsers(entityList=None):
       showDeleted = True
     elif entityList is None and myarg == 'select':
       _, entityList = getEntityToModify(defaultEntityType=Cmd.ENTITY_USERS)
-    elif myarg in SUSPENDED_ARGUMENTS:
-      isSuspended = _getIsSuspended(myarg)
-    elif myarg in ARCHIVED_ARGUMENTS:
-      isArchived = _getIsArchived(myarg)
+    elif myarg == 'issuspended':
+      isSuspended = getBoolean()
+    elif myarg == 'isarchived':
+      isArchived = getBoolean()
     elif myarg == 'orderby':
       orderBy, sortOrder = getOrderBySortOrder(USERS_ORDERBY_CHOICE_MAP)
     elif myarg == 'userview':
@@ -46092,6 +46141,8 @@ def doPrintUsers(entityList=None):
 # If no individual fields were specified (allfields, basic, full) or individual fields other than primaryEmail were specified, look up each user
     if isSuspended is not None and fieldsList:
       fieldsList.append('suspended')
+    if isArchived is not None and fieldsList:
+      fieldsList.append('archived')
     if projectionSet or len(set(fieldsList)) > 1 or showValidColumn:
       jcount = len(entityList)
       fields = getFieldsFromFieldsList(fieldsList)

{gam7-7.22.0.dist-info → gam7-7.22.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gam7
-Version: 7.22.0
+Version: 7.22.4
 Summary: CLI tool to manage Google Workspace
 Project-URL: Homepage, https://github.com/GAM-team/GAM
 Project-URL: Issues, https://github.com/GAM-team/GAM/issues
@@ -27,10 +27,11 @@ Requires-Dist: google-api-python-client>=2.167.0
 Requires-Dist: google-auth-httplib2>=0.2.0
 Requires-Dist: google-auth-oauthlib>=1.2.2
 Requires-Dist: google-auth>=2.39.0
-Requires-Dist: httplib2>=0.22.0
+Requires-Dist: httplib2>=0.31.0
 Requires-Dist: lxml>=5.4.0
 Requires-Dist: passlib>=1.7.4
 Requires-Dist: pathvalidate>=3.2.3
+Requires-Dist: pysocks>=1.7.1
 Provides-Extra: yubikey
 Requires-Dist: yubikey-manager>=5.6.1; extra == 'yubikey'
 Description-Content-Type: text/markdown

{gam7-7.22.0.dist-info → gam7-7.22.4.dist-info}/RECORD

@@ -1,4 +1,4 @@
-gam/__init__.py,sha256=JOwhPE0Xq0Ioh8DBjlEVojQWFlTKNpddmyF9ZB-FTEs,3609967
+gam/__init__.py,sha256=2bPGrpvBvJlhIm2RB--NdcPovJV1lruV2KngQgPiPVE,3612155
 gam/__main__.py,sha256=amz0-959ph6zkZKqjaar4n60yho-T37w6qWI36qx0CA,1049
 gam/cacerts.pem,sha256=DUsVo2XlFYwfkhe3gnxa-Km4Z4noz74hSApXwTT-nQE,44344
 gam/cbcm-v1.1beta1.json,sha256=xO5XloCQQULmPbFBx5bckdqmbLFQ7sJ2TImhE1ysDIY,19439
@@ -47,8 +47,8 @@ gam/gdata/apps/audit/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrK
 gam/gdata/apps/audit/service.py,sha256=Z1eueThcNeVUMWP1DRWc_DGHrJCiJI8W_xj6L-cqu-Q,9658
 gam/gdata/apps/contacts/__init__.py,sha256=Um6zgIkiahZns7yAEuC3pxHSMD8iciZ_EoynSLoYPfU,30463
 gam/gdata/apps/contacts/service.py,sha256=5lNb-Ii1Gyek6ePFji3kyoYtCBc8CuJTwagx2BL2o14,15684
-gam7-7.22.0.dist-info/METADATA,sha256=z_37Cb6exy_yuXCcfCGlAsqsgNmu5pXKoA_pefGgKYs,3062
-gam7-7.22.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-gam7-7.22.0.dist-info/entry_points.txt,sha256=HVUM5J7dA8YwvJfG30jiLefR19ExMs387TWugWd9sf4,42
-gam7-7.22.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-gam7-7.22.0.dist-info/RECORD,,
+gam7-7.22.4.dist-info/METADATA,sha256=gr6AsDjt7Td27C_dEL3sBhO6U7uzVJLnT_-eHCVjeOw,3092
+gam7-7.22.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+gam7-7.22.4.dist-info/entry_points.txt,sha256=HVUM5J7dA8YwvJfG30jiLefR19ExMs387TWugWd9sf4,42
+gam7-7.22.4.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+gam7-7.22.4.dist-info/RECORD,,