Implement the Chat Custom Emojis API #1787

src/GamCommands.txt

@@ -1,4 +1,4 @@
-This document describes the GAM command line syntax in modified BNF, see https://en.wikipedia.org/wiki/Backus-Naur_Form
+his document describes the GAM command line syntax in modified BNF, see https://en.wikipedia.org/wiki/Backus-Naur_Form
 Skip the History section and start reading at Introduction.
 
 Items on the command line are space separated, when an actual space character is required, it will be indicated by <Space>.
@@ -380,6 +380,8 @@ If an item contains spaces, it should be surrounded by ".
         domain:<DomainName>|domain|default
 <CalendarItem> ::= <EmailAddress>
 <ChannelCustomerID> ::= <String>
+<ChatEmojiName> ::= :<String>:
+<ChatEmoji> ::= emojiname <ChatEmojiName> | customemojis/<String>
 <ChatMember> ::= spaces/<String>/members/<String>
 <ChatMessage> ::= spaces/<String>/messages/<String>
 <ChatSpace> ::= spaces/<String> | space <String> | space spaces/<String>
@@ -664,6 +666,7 @@ If an item contains spaces, it should be surrounded by ".
         (gdoc|ghtml <UserGoogleDoc>)|
         (gcsdoc|gcshtml <StorageBucketObjectName>)
 <YouTubeChannelID> ::= <String>
+
 ## Lists of basic items
 
 <APIScopeURLList> ::= "<APIScopeURL>(,<APIScopeURL>)*"
@@ -6436,6 +6439,22 @@ gam <UserTypeEntity> print chatevents [todrive <ToDriveAttribute>*]
         filter <String>
         [formatjson [quotechar <Character>]]
 
+<ChatEmojiName> ::= :[0-9a-z_-]+:
+<ChatEmoji> ::= emojiname <ChatEmojiName> | customemojis/<String>
+
+gam <UserTypeEntity> create chatemoji <ChatEmojiName>
+         ([drivedir|(sourcefolder <FilePath>)] [filename <FileNamePattern>])
+        [formatjson]
+gam <UserTypeEntity> delete chatemoji <ChatEmoji>
+gam <UserTypeEntity> info chatemoji <ChatEmoji>
+        [formatjson]
+gam <UserTypeEntity> show chatemojis
+        [showcreatedby any|me|others]
+        [formatjson]
+gam <UserTypeEntity> print chatemojis [todrive <ToDriveAttribute>*]
+        [showcreatedby any|me|others]
+        [formatjson [quotechar <Character>]]
+
 # Users - Drive
 
 <DriveFileOrderByFieldName> ::=
@@ -7204,7 +7223,8 @@ gam <UserTypeEntity> show filesharecounts
         owners|
         parents|
         size|
-        trashed
+        trashed|
+        webviewlink
 <FileTreeFieldNameList> ::= "<FileTreeFieldName>(,<FileTreeFieldName>)*"
 
 gam <UserTypeEntity> print filetree [todrive <ToDriveAttribute>*]

src/GamUpdate.txt

@@ -1,6 +1,20 @@
+7.10.00
+
+Added commands to manage/display Chat Custom Emojis.
+
+* See: https://github.com/GAM-team/GAM/wiki/Users-Chat#manage-chat-emojis
+* See: https://github.com/GAM-team/GAM/wiki/Users-Chat#display-chat-emojis
+
+Updated `gam <UserItem> print|show chatspaces|chatmembers asadmin` to display
+the spaces in ascending display name order.
+
+7.09.07
+
+Added `webviewlink` to `<FileTreeFieldName>` for use in `gam <UserTypeEntity> print|show filetree`.
+
 7.09.06
 
-Upddated `gam print|show shareddrives', `gam print|show shareddriveacls', `gam print shareddriveorganizers`
+Upddated `gam print|show shareddrives`, `gam print|show shareddriveacls`, `gam print shareddriveorganizers`
 to display the Shared Drives in ascending name order; the API returns them in an unidentifiable order.
 
 7.09.05

src/gam/__init__.py

@@ -25,7 +25,7 @@ https://github.com/GAM-team/GAM/wiki
 """
 
 __author__ = 'GAM Team <google-apps-manager@googlegroups.com>'
-__version__ = '7.09.06'
+__version__ = '7.10.00'
 __license__ = 'Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0)'
 
 #pylint: disable=wrong-import-position
@@ -22786,7 +22786,7 @@ def _processPeopleContactPhotos(users, function):
         if function == 'GetContactPhoto' and not os.path.isdir(targetFolder):
           os.makedirs(targetFolder)
       elif myarg == 'filename':
-        filenamePattern = getString(Cmd.OB_PHOTO_FILENAME_PATTERN)
+        filenamePattern = getString(Cmd.OB_FILE_NAME_PATTERN)
       else:
         unknownArgumentExit()
     subForContactId = filenamePattern.find('#contactid#') != -1
@@ -25990,6 +25990,8 @@ def _printChatItem(user, citem, parent, entityType, csvPF, FJQC, addCSVData=None
   if entityType == Ent.CHAT_SPACE:
     _cleanChatSpace(citem)
     baserow = {'User': user} if user is not None else {}
+  elif entityType == Ent.CHAT_EMOJI:
+    baserow = {'User': user, 'name': citem['name'], 'emojiName': citem['emojiName']}
   else:
     if user is not None:
       baserow = {'User': user, 'space.name': parent['name'], 'space.displayName': parent['displayName']}
@@ -26009,6 +26011,190 @@ def _printChatItem(user, citem, parent, entityType, csvPF, FJQC, addCSVData=None
                 'JSON': json.dumps(cleanJSON(citem, timeObjects=CHAT_TIME_OBJECTS), ensure_ascii=False, sort_keys=True)})
     csvPF.WriteRowNoFilter(row)
 
+def _getValidateEmojiName():
+  name = getString(Cmd.OB_CHAT_EMOJI_NAME)
+  if re.match(r'^:[0-9a-z_-]+:$', name):
+    return name
+  Cmd.Backup()
+  usageErrorExit(Msg.INVALID_EMOJI_NAME.format(name))
+
+# gam <UserTypeEntity> create chatemoji <ChatEmojiName>
+#	 ([drivedir|(sourcefolder <FilePath>)] [filename <FileNamePattern>])
+#	[formatjson]
+def createChatEmoji(users):
+  FJQC = FormatJSONQuoteChar()
+  name = _getValidateEmojiName()
+  body = {'emojiName': name, 'payload': {'filename': '', 'fileContent': ''}}
+  sourceFolder = os.getcwd()
+  filenamePattern = '#email#.jpg'
+  while Cmd.ArgumentsRemaining():
+    myarg = getArgument()
+    if myarg == 'drivedir':
+      sourceFolder = GC.Values[GC.DRIVE_DIR]
+    elif myarg == 'sourcefolder':
+      sourceFolder = os.path.expanduser(getString(Cmd.OB_FILE_PATH))
+      if not os.path.isdir(sourceFolder):
+        entityDoesNotExistExit(Ent.DIRECTORY, sourceFolder)
+    elif myarg == 'filename':
+      filenamePattern = getString(Cmd.OB_FILE_NAME_PATTERN)
+    else:
+      FJQC.GetFormatJSON(myarg)
+  i, count, users = getEntityArgument(users)
+  for user in users:
+    i += 1
+    user, chat, kvList = buildChatServiceObject(API.CHAT_CUSTOM_EMOJIS, user, i, count, [Ent.CHAT_EMOJI, name])
+    if not chat:
+      continue
+    user, userName, _ = splitEmailAddressOrUID(user)
+    filename = _substituteForUser(filenamePattern, user, userName)
+    if sourceFolder is not None:
+      filename = os.path.join(sourceFolder, filename)
+    filename = os.path.expanduser(filename)
+    try:
+      with open(filename, 'rb') as f:
+        image_data = f.read()
+    except (OSError, IOError) as e:
+      entityActionFailedWarning([Ent.USER, user, Ent.CHAT_EMOJI, filename], str(e), i, count)
+      continue
+    body['payload'] = {'filename': os.path.basename(filename),
+                       'fileContent':base64.urlsafe_b64encode(image_data).decode(UTF8)}
+    try:
+      emoji = callGAPI(chat.customEmojis(), 'create',
+                       throwReasons=[GAPI.ALREADY_EXISTS, GAPI.INVALID_ARGUMENT, GAPI.PERMISSION_DENIED, GAPI.FAILED_PRECONDITION],
+                       body=body)
+      _showChatItem(emoji, Ent.CHAT_EMOJI, FJQC, i, count)
+    except (GAPI.alreadyExists, GAPI.invalidArgument, GAPI.permissionDenied) as e:
+      exitIfChatNotConfigured(chat, kvList, str(e), i, count)
+    except GAPI.failedPrecondition:
+      userChatServiceNotEnabledWarning(user, i, count)
+
+def getEmojiName(myarg):
+  if myarg == 'emojiname':
+    name = _getValidateEmojiName()
+    return 'customEmojis/'+name
+  _, chatEmoji = Cmd.Previous().split('/', 1)
+  return 'customEmojis/'+chatEmoji
+
+# gam <UserTypeEntity> delete chatemoji <ChatEmoji>
+def deleteChatEmoji(users):
+  name = None
+  while Cmd.ArgumentsRemaining():
+    myarg = getArgument()
+    if myarg == 'emojiname':
+      name = getEmojiName(myarg)
+    elif myarg.startswith('customemojis/'):
+      name = getEmojiName(myarg)
+    else:
+      unknownArgumentExit()
+  if not name:
+    missingArgumentExit('ChatEmoji')
+  i, count, users = getEntityArgument(users)
+  for user in users:
+    i += 1
+    user, chat, kvList = buildChatServiceObject(API.CHAT_CUSTOM_EMOJIS, user, i, count, [Ent.CHAT_EMOJI, name])
+    if not chat:
+      continue
+    try:
+      callGAPI(chat.customEmojis(), 'delete',
+               throwReasons=[GAPI.NOT_FOUND, GAPI.INVALID_ARGUMENT, GAPI.PERMISSION_DENIED, GAPI.FAILED_PRECONDITION],
+               name=name)
+      entityActionPerformed(kvList, i, count)
+    except (GAPI.notFound, GAPI.invalidArgument, GAPI.permissionDenied) as e:
+      exitIfChatNotConfigured(chat, kvList, str(e), i, count)
+    except GAPI.failedPrecondition:
+      userChatServiceNotEnabledWarning(user, i, count)
+
+# gam <UserTypeEntity> info chatemoji <ChatEmoji>
+#	[formatjson]
+def infoChatEmoji(users):
+  FJQC = FormatJSONQuoteChar()
+  name = None
+  while Cmd.ArgumentsRemaining():
+    myarg = getArgument()
+    if myarg == 'emojiname':
+      name = getEmojiName(myarg)
+    elif myarg.startswith('customemojis/'):
+      name = getEmojiName(myarg)
+    else:
+      FJQC.GetFormatJSON(myarg)
+  if not name:
+    missingArgumentExit('ChatEmoji')
+  i, count, users = getEntityArgument(users)
+  for user in users:
+    i += 1
+    user, chat, kvList = buildChatServiceObject(API.CHAT_CUSTOM_EMOJIS, user, i, count, [Ent.CHAT_EMOJI, name])
+    if not chat:
+      continue
+    try:
+      emoji = callGAPI(chat.customEmojis(), 'get',
+                       throwReasons=[GAPI.NOT_FOUND, GAPI.INVALID_ARGUMENT, GAPI.PERMISSION_DENIED, GAPI.FAILED_PRECONDITION],
+                       name=name)
+      if not FJQC.formatJSON:
+        entityPerformAction(kvList, i, count)
+      _showChatItem(emoji, Ent.CHAT_EMOJI, FJQC, i, count)
+    except (GAPI.notFound, GAPI.invalidArgument, GAPI.permissionDenied) as e:
+      exitIfChatNotConfigured(chat, kvList, str(e), i, count)
+    except GAPI.failedPrecondition:
+      userChatServiceNotEnabledWarning(user, i, count)
+
+CHAT_EMOJI_SHOW_CREATED_BY_CHOICE_MAP = {
+  'any': None,
+  'me': 'creator("users/me")',
+  'others': 'NOT creator("users/me")'
+  }
+
+# gam <UserTypeEntity> show chatemojis
+#	[showcreatedby any|me|others]
+#	[formatjson]
+# gam <UserTypeEntity> print chatemojis [todrive <ToDriveAttribute>*]
+#	[showcreatedby any|me|others]
+#	[formatjson [quotechar <Character>]]
+def printShowChatEmojis(users):
+  csvPF = CSVPrintFile(['User', 'name', 'emojiName'])  if Act.csvFormat() else None
+  FJQC = FormatJSONQuoteChar(csvPF)
+  pfilter = CHAT_EMOJI_SHOW_CREATED_BY_CHOICE_MAP['me']
+  while Cmd.ArgumentsRemaining():
+    myarg = getArgument()
+    if csvPF and myarg == 'todrive':
+      csvPF.GetTodriveParameters()
+    elif myarg =='showcreatedby':
+      pfilter = getChoice(CHAT_EMOJI_SHOW_CREATED_BY_CHOICE_MAP, mapChoice=True)
+    else:
+      FJQC.GetFormatJSONQuoteChar(myarg, True)
+  i, count, users = getEntityArgument(users)
+  for user in users:
+    i += 1
+    user, chat, kvList = buildChatServiceObject(API.CHAT_CUSTOM_EMOJIS, user, i, count, [Ent.CHAT_EMOJI, None])
+    if not chat:
+      continue
+    try:
+      emojis = callGAPIpages(chat.customEmojis(), 'list', 'customEmojis',
+                             pageMessage=_getChatPageMessage(Ent.CHAT_EMOJI, user, i, count, pfilter),
+                             throwReasons=[GAPI.NOT_FOUND, GAPI.INVALID_ARGUMENT, GAPI.PERMISSION_DENIED],
+                             retryReasons=GAPI.SERVICE_NOT_AVAILABLE_RETRY_REASONS,
+                             pageSize=CHAT_PAGE_SIZE, filter=pfilter)
+    except (GAPI.notFound, GAPI.invalidArgument, GAPI.permissionDenied) as e:
+      exitIfChatNotConfigured(chat, kvList, str(e), i, count)
+      continue
+    except GAPI.failedPrecondition:
+      userChatServiceNotEnabledWarning(user, i, count)
+      break
+    if not csvPF:
+      jcount = len(emojis)
+      if not FJQC.formatJSON:
+        entityPerformActionNumItems(kvList, jcount, Ent.CHAT_EMOJI, i, count)
+      Ind.Increment()
+      j = 0
+      for emoji in sorted(emojis, key=lambda k: k['emojiName']):
+        j += 1
+        _showChatItem(emoji, Ent.CHAT_EMOJI, FJQC, j, jcount)
+      Ind.Decrement()
+    else:
+      for emoji in sorted(emojis, key=lambda k: k['emojiName']):
+        _printChatItem(user, emoji, '', Ent.CHAT_EMOJI, csvPF, FJQC)
+  if csvPF:
+    csvPF.writeCSVfile('Chat Custom Emojis')
+
 # gam setup chat
 def doSetupChat():
   checkForExtraneousArguments()
@@ -26472,6 +26658,9 @@ def printShowChatSpaces(users):
     substituteQueryTimes(queries, queryTimes)
     pfilter = kwargsCS['query'] = queries[0]
     kwargsCS['useAdminAccess'] = True
+    sortName = 'displayName'
+  else:
+    sortName = 'name'
   for user in users:
     i += 1
     user, chat, kvList = buildChatServiceObject(api, user, i, count, None, useAdminAccess)
@@ -26499,12 +26688,12 @@ def printShowChatSpaces(users):
         entityPerformActionNumItems(kvList, jcount, Ent.CHAT_SPACE, i, count)
       Ind.Increment()
       j = 0
-      for space in spaces:
+      for space in sorted(spaces, key=lambda k: k[sortName]):
         j += 1
         _showChatItem(space, Ent.CHAT_SPACE, FJQC, j, jcount)
       Ind.Decrement()
     else:
-      for space in spaces:
+      for space in sorted(spaces, key=lambda k: k[sortName]):
         _printChatItem(user, space, None, Ent.CHAT_SPACE, csvPF, FJQC)
   if csvPF:
     csvPF.writeCSVfile('Chat Spaces')
@@ -27139,6 +27328,9 @@ def printShowChatMembers(users):
   i, count, users = getEntityArgument(users)
   if useAdminAccess:
     _chkChatAdminAccess(count)
+    sortName = 'displayName'
+  else:
+    sortName = 'name'
   for user in users:
     i += 1
     user, chat, kvList = buildChatServiceObject(api, user, i, count, [Ent.CHAT_SPACE, None], useAdminAccess)
@@ -27161,7 +27353,7 @@ def printShowChatMembers(users):
                                  retryReasons=GAPI.SERVICE_NOT_AVAILABLE_RETRY_REASONS,
                                  fields="nextPageToken,spaces(name,displayName,spaceType,membershipCount)", pageSize=CHAT_PAGE_SIZE,
                                  **kwargsCS)
-          for space in spaces:
+          for space in sorted(spaces, key=lambda k: k[sortName]):
             if space['spaceType'] == 'SPACE' and 'membershipCount' in space:
               parentList.append({'name': space['name'], 'displayName': space.get('displayName', 'None')})
         except (GAPI.notFound, GAPI.invalidArgument, GAPI.internalError,
@@ -27178,7 +27370,7 @@ def printShowChatMembers(users):
                                  retryReasons=GAPI.SERVICE_NOT_AVAILABLE_RETRY_REASONS,
                                  fields="nextPageToken,spaces(name,displayName,spaceType,membershipCount)", pageSize=CHAT_PAGE_SIZE,
                                  **kwargsCS)
-          for space in spaces:
+          for space in sorted(spaces, key=lambda k: k[sortName]):
 #            if 'membershipCount' in space:
 #              parentList.append({'name': space['name'], 'displayName': space.get('displayName', 'None')})
             parentList.append({'name': space['name'], 'displayName': space.get('displayName', 'None')})
@@ -57618,9 +57810,10 @@ FILETREE_FIELDS_CHOICE_MAP = {
   'parents': 'parents',
   'size': 'size',
   'trashed': 'trashed',
+  'webviewlink': 'webViewLink',
   }
 
-FILETREE_FIELDS_PRINT_ORDER = ['id', 'parents', 'owners', 'mimeType', 'size', 'explicitlyTrashed', 'trashed']
+FILETREE_FIELDS_PRINT_ORDER = ['id', 'parents', 'owners', 'mimeType', 'size', 'explicitlyTrashed', 'trashed', 'webViewLink']
 
 # gam <UserTypeEntity> print filetree [todrive <ToDriveAttribute>*]
 #	[select <DriveFileEntity> [selectsubquery <QueryDriveFile>] [depth <Number>]]
@@ -57785,7 +57978,7 @@ def printShowFileTree(users):
     else:
       unknownArgumentExit()
   fieldsList = ['driveId', 'id', 'name', 'parents', 'mimeType', 'ownedByMe', 'owners(emailAddress)',
-                'shared', sizeField, 'explicitlyTrashed', 'trashed']
+                'shared', sizeField, 'explicitlyTrashed', 'trashed', 'webViewLink']
   if csvPF:
     if not GC.Values[GC.DRIVE_V3_NATIVE_NAMES]:
       fileNameTitle = 'title'
@@ -67870,7 +68063,7 @@ def updatePhoto(users):
   baseFileIdEntity = drive = owner = None
   sourceFolder = os.getcwd()
   if Cmd.NumArgumentsRemaining() == 1:
-    filenamePattern = getString(Cmd.OB_PHOTO_FILENAME_PATTERN)
+    filenamePattern = getString(Cmd.OB_FILE_NAME_PATTERN)
   else:
     filenamePattern = '#email#.jpg'
     while Cmd.ArgumentsRemaining():
@@ -67882,7 +68075,7 @@ def updatePhoto(users):
         if not os.path.isdir(sourceFolder):
           entityDoesNotExistExit(Ent.DIRECTORY, sourceFolder)
       elif myarg == 'filename':
-        filenamePattern = getString(Cmd.OB_PHOTO_FILENAME_PATTERN)
+        filenamePattern = getString(Cmd.OB_FILE_NAME_PATTERN)
       elif myarg == 'gphoto':
         owner, drive = buildGAPIServiceObject(API.DRIVE3, getEmailAddress())
         if not drive:
@@ -67983,7 +68176,7 @@ def getPhoto(users, profileMode):
       if not os.path.isdir(targetFolder):
         os.makedirs(targetFolder)
     elif myarg == 'filename':
-      filenamePattern = getString(Cmd.OB_PHOTO_FILENAME_PATTERN)
+      filenamePattern = getString(Cmd.OB_FILE_NAME_PATTERN)
     elif myarg == 'nofile':
       writeFileData = False
     elif myarg == 'noshow':
@@ -76982,6 +77175,7 @@ USER_ADD_CREATE_FUNCTIONS = {
   Cmd.ARG_CALENDAR:		addCreateCalendars,
   Cmd.ARG_GROUP:		addUserToGroups,
   Cmd.ARG_CALENDARACL:		createCalendarACLs,
+  Cmd.ARG_CHATEMOJI:		createChatEmoji,
   Cmd.ARG_CHATMEMBER:		createChatMember,
   Cmd.ARG_CHATMESSAGE:		createChatMessage,
   Cmd.ARG_CHATSPACE:		createChatSpace,
@@ -77098,6 +77292,7 @@ USER_COMMANDS_WITH_OBJECTS = {
       Cmd.ARG_BACKUPCODE:	deleteBackupCodes,
       Cmd.ARG_CALENDAR:		deleteCalendars,
       Cmd.ARG_CALENDARACL:	deleteCalendarACLs,
+      Cmd.ARG_CHATEMOJI:	deleteChatEmoji,
       Cmd.ARG_CHATMEMBER:	deleteUpdateChatMember,
       Cmd.ARG_CHATMESSAGE:	deleteChatMessage,
       Cmd.ARG_CHATSPACE:	deleteChatSpace,
@@ -77202,6 +77397,7 @@ USER_COMMANDS_WITH_OBJECTS = {
     (Act.INFO,
      {Cmd.ARG_CALENDAR:		infoCalendars,
       Cmd.ARG_CALENDARACL:	infoCalendarACLs,
+      Cmd.ARG_CHATEMOJI:	infoChatEmoji,
       Cmd.ARG_CHATEVENT:	infoChatEvent,
       Cmd.ARG_CHATMEMBER:	infoChatMember,
       Cmd.ARG_CHATMESSAGE:	infoChatMessage,
@@ -77274,6 +77470,7 @@ USER_COMMANDS_WITH_OBJECTS = {
       Cmd.ARG_CALENDAR:		printShowCalendars,
       Cmd.ARG_CALENDARACL:	printShowCalendarACLs,
       Cmd.ARG_CALSETTINGS:	printShowCalSettings,
+      Cmd.ARG_CHATEMOJI:	printShowChatEmojis,
       Cmd.ARG_CHATEVENT:	printShowChatEvents,
       Cmd.ARG_CHATMEMBER:	printShowChatMembers,
       Cmd.ARG_CHATMESSAGE:	printShowChatMessages,
@@ -77381,6 +77578,7 @@ USER_COMMANDS_WITH_OBJECTS = {
       Cmd.ARG_CALENDAR:		printShowCalendars,
       Cmd.ARG_CALENDARACL:	printShowCalendarACLs,
       Cmd.ARG_CALSETTINGS:	printShowCalSettings,
+      Cmd.ARG_CHATEMOJI:	printShowChatEmojis,
       Cmd.ARG_CHATEVENT:	printShowChatEvents,
       Cmd.ARG_CHATMEMBER:	printShowChatMembers,
       Cmd.ARG_CHATMESSAGE:	printShowChatMessages,
@@ -77597,6 +77795,7 @@ USER_COMMANDS_OBJ_ALIASES = {
   Cmd.ARG_CLASSIFICATIONLABELPERMISSION:	Cmd.ARG_DRIVELABELPERMISSION,
   Cmd.ARG_CLASSIFICATIONLABELPERMISSIONS:	Cmd.ARG_DRIVELABELPERMISSION,
   Cmd.ARG_CLASSROOMINVITATIONS:	Cmd.ARG_CLASSROOMINVITATION,
+  Cmd.ARG_CHATEMOJIS:		Cmd.ARG_CHATEMOJI,
   Cmd.ARG_CHATEVENTS:		Cmd.ARG_CHATEVENT,
   Cmd.ARG_CHATMEMBERS:		Cmd.ARG_CHATMEMBER,
   Cmd.ARG_CHATMESSAGES:		Cmd.ARG_CHATMESSAGE,

src/gam/gamlib/glapi.py

@@ -26,6 +26,7 @@ ANALYTICS_ADMIN = 'analyticsadmin'
 CALENDAR = 'calendar'
 CBCM = 'cbcm'
 CHAT = 'chat'
+CHAT_CUSTOM_EMOJIS = 'chatcustomemojis'
 CHAT_EVENTS = 'chatevents'
 CHAT_MEMBERSHIPS = 'chatmemberships'
 CHAT_MEMBERSHIPS_ADMIN = 'chatmembershipsadmin'
@@ -210,6 +211,7 @@ _INFO = {
   CALENDAR: {'name': 'Calendar API', 'version': 'v3', 'v2discovery': True, 'mappedAPI': 'calendar-json'},
   CBCM: {'name': 'Chrome Browser Cloud Management API', 'version': 'v1.1beta1', 'v2discovery': True, 'localjson': True},
   CHAT: {'name': 'Chat API', 'version': 'v1', 'v2discovery': True},
+  CHAT_CUSTOM_EMOJIS: {'name': 'Chat API - Custom Emojis', 'version': 'v1', 'v2discovery': True, 'mappedAPI': CHAT},
   CHAT_EVENTS: {'name': 'Chat API - Events', 'version': 'v1', 'v2discovery': True, 'mappedAPI': CHAT},
   CHAT_MEMBERSHIPS: {'name': 'Chat API - Memberships', 'version': 'v1', 'v2discovery': True, 'mappedAPI': CHAT},
   CHAT_MEMBERSHIPS_ADMIN: {'name': 'Chat API - Memberships Admin', 'version': 'v1', 'v2discovery': True, 'mappedAPI': CHAT},
@@ -544,6 +546,10 @@ _SVCACCT_SCOPES = [
    'api': CALENDAR,
    'subscopes': READONLY,
    'scope': 'https://www.googleapis.com/auth/calendar'},
+  {'name': 'Chat API - Custom Emojis',
+   'api': CHAT_CUSTOM_EMOJIS,
+   'subscopes': READONLY,
+   'scope': 'https://www.googleapis.com/auth/chat.customemojis'},
   {'name': 'Chat API - Memberships',
    'api': CHAT_MEMBERSHIPS,
    'subscopes': READONLY,

src/gam/gamlib/glclargs.py

@@ -461,6 +461,8 @@ class GamCLArgs():
   ARG_CHANNELSKU = 'channelsku'
   ARG_CHANNELSKUS = 'channelskus'
   ARG_CHAT = 'chat'
+  ARG_CHATEMOJI = 'chatemoji'
+  ARG_CHATEMOJIS = 'chatemojis'
   ARG_CHATEVENT = 'chatevent'
   ARG_CHATEVENTS = 'chatevents'
   ARG_CHATMEMBER = 'chatmember'
@@ -843,6 +845,8 @@ class GamCLArgs():
   OB_CHARACTER = 'Character'
   OB_CHAR_SET = 'CharacterSet'
   OG_CHAT_ATTACHMENT = 'ChatAttachment'
+  OB_CHAT_EMOJI = 'ChatEmoji'
+  OB_CHAT_EMOJI_NAME = 'ChatEmojiName'
   OB_CHAT_EVENT = 'ChatEvent'
   OB_CHAT_MEMBER = 'ChatMember'
   OB_CHAT_MESSAGE = 'ChatMessage'
@@ -930,6 +934,7 @@ class GamCLArgs():
   OB_FILE_NAME = 'FileName'
   OB_FILE_NAME_FIELD_NAME = OB_FILE_NAME+'(:'+OB_FIELD_NAME+')+'
   OB_FILE_NAME_OR_URL = 'FileName|URL'
+  OB_FILE_NAME_PATTERN = 'FileNamePattern'
   OB_FILE_PATH = 'FilePath'
   OB_FILTER_ID_ENTITY = 'FilterIDEntity'
   OB_FORMAT_LIST = 'FormatList'
@@ -975,7 +980,6 @@ class GamCLArgs():
   OB_PERMISSION_ID_LIST = 'PermissionIDList'
   OB_PERMISSION_ROLE_LIST = 'PermissionRoleList'
   OB_PERMISSION_TYPE_LIST = 'PermissionTypeList'
-  OB_PHOTO_FILENAME_PATTERN = 'FilenameNamePattern'
   OB_PRINTER_ID = 'PrinterID'
   OB_PRIVILEGE_LIST = 'PrivilegeList'
   OB_PRODUCT_ID = 'ProductID'

src/gam/gamlib/glentity.py

@@ -86,6 +86,7 @@ class GamEntity():
   CHANNEL_SKU = 'chsk'
   CHAT_BOT = 'chbo'
   CHAT_ADMIN = 'chad'
+  CHAT_EMOJI = 'chem'
   CHAT_EVENT = 'chev'
   CHAT_MANAGER_USER = 'chgu'
   CHAT_MEMBER = 'chme'
@@ -436,6 +437,7 @@ class GamEntity():
     CHANNEL_SKU: ['Channel SKUs', 'Channel SKU'],
     CHAT_BOT: ['Chat BOTs', 'Chat BOT'],
     CHAT_ADMIN: ['Chat Admins', 'Chat Admin'],
+    CHAT_EMOJI: ['Chat Emojis', 'Chat Emoji'],
     CHAT_EVENT: ['Chat Events', 'Chat Event'],
     CHAT_MANAGER_USER: ['Chat User Managers', 'Chat User Manager'],
     CHAT_MESSAGE: ['Chat Messages', 'Chat Message'],

src/gam/gamlib/glmsgs.py

@@ -309,6 +309,7 @@ INVALID_ALIAS = 'Invalid Alias'
 INVALID_ATTENDEE_CHANGE = 'Invalid attendee change "{0}"'
 INVALID_CHARSET = 'Invalid charset "{0}"'
 INVALID_DATE_TIME_RANGE = '{0} {1} must be greater than/equal to {2} {3}'
+INVALID_EMOJI_NAME = '{0} does not match pattern :[0-9a-z_-]:'
 INVALID_ENTITY = 'Invalid {0}, {1}'
 INVALID_EVENT_TIMERANGE = '{0} {1} must be less than {2}'
 INVALID_FILE_SELECTION_WITH_ADMIN_ACCESS = 'Invalid file selection with adminaccess|asadmin'

wiki/Basic-Items.md

@@ -96,7 +96,7 @@
         banana|basil|blueberry|flamingo|graphite|grape|
         lavender|peacock|sage|tangerine|tomato
 <FileFormat> ::=
-        csv|doc|dot|docx|dotx|epub|html|jpeg|jpg|mht|odp|ods|odt|
+        csv|doc|dot|docx|dotx|epub|html|jpeg|jpg|json|mht|odp|ods|odt|
         pdf|png|ppt|pot|potx|pptx|rtf|svg|tsv|txt|xls|xlt|xlsx|xltx|zip|
         ms|microsoft|openoffice|
 <LabelColorHex> ::=
@@ -278,6 +278,8 @@
         domain:<DomainName>|domain|default
 <CalendarItem> ::= <EmailAddress>
 <ChannelCustomerID> ::= <String>
+<ChatEmojiName> ::= :[0-9a-z_-]+:
+<ChatEmoji> ::= emojiname <ChatEmojiName> | customemojis/<String>
 <ChatMember> ::= spaces/<String>/members/<String>
 <ChatMessage> ::= spaces/<String>/messages/<String>
 <ChatSpace> ::= spaces/<String> | space <String> | space spaces/<String>

wiki/GamUpdates.md

@@ -10,6 +10,25 @@ Add the `-s` option to the end of the above commands to suppress creating the `g
 
 See [Downloads-Installs-GAM7](https://github.com/GAM-team/GAM/wiki/Downloads-Installs) for Windows or other options, including manual installation
 
+### 7.10.00
+
+Added commands to manage/display Chat Custom Emojis.
+
+* See: https://github.com/GAM-team/GAM/wiki/Users-Chat#manage-chat-emojis
+* See: https://github.com/GAM-team/GAM/wiki/Users-Chat#display-chat-emojis
+
+Updated `gam <UserItem> print|show chatspaces|chatmembers asadmin` to display
+the spaces in ascending display name order.
+
+### 7.09.07
+
+Added `webviewlink` to `<FileTreeFieldName>` for use in `gam <UserTypeEntity> print|show filetree`.
+
+### 7.09.06
+
+Upddated `gam print|show shareddrives`, `gam print|show shareddriveacls`, `gam print shareddriveorganizers`
+to display the Shared Drives in ascending name order; the API returns them in an unidentifiable order.
+
 ### 7.09.05
 
 Improved output of `gam info|show chromeschemas [std]` to more accurately display the schemas.

wiki/How-to-Upgrade-Legacy-GAM-to-GAM7.md

@@ -251,7 +251,7 @@ writes the credentials into the file oauth2.txt.
 admin@server:/Users/admin$ rm -f /Users/admin/GAMConfig/oauth2.txt
 admin@server:/Users/admin$ gam version
 WARNING: Config File: /Users/admin/GAMConfig/gam.cfg, Section: DEFAULT, Item: oauth2_txt, Value: /Users/admin/GAMConfig/oauth2.txt, Not Found
-GAM 7.09.05 - https://github.com/GAM-team/GAM - pyinstaller
+GAM 7.10.00 - https://github.com/GAM-team/GAM - pyinstaller
 GAM Team <google-apps-manager@googlegroups.com>
 Python 3.13.5 64-bit final
 MacOS Sequoia 15.5 x86_64
@@ -989,7 +989,7 @@ writes the credentials into the file oauth2.txt.
 C:\>del C:\GAMConfig\oauth2.txt
 C:\>gam version
 WARNING: Config File: C:\GAMConfig\gam.cfg, Section: DEFAULT, Item: oauth2_txt, Value: C:\GAMConfig\oauth2.txt, Not Found
-GAM 7.09.05 - https://github.com/GAM-team/GAM - pythonsource
+GAM 7.10.00 - https://github.com/GAM-team/GAM - pythonsource
 GAM Team <google-apps-manager@googlegroups.com>
 Python 3.13.5 64-bit final
 Windows-10-10.0.17134 AMD64

wiki/Licenses.md

@@ -11,7 +11,7 @@
 - [Synchronize licenses](#synchronize-licenses)
 
 ## API documentation
-* [License Manager API](https://developers.google.com/admin-sdk/licensing/rest/v1/licenseAssignments)
+* [License Manager API](https://developers.google.com/workspace/admin/licensing/reference/rest/v1/licenseAssignments)
 
 ## License Products and SKUs
 * [Product and SKU IDs](https://developers.google.com/admin-sdk/licensing/v1/how-tos/products)

wiki/Users-Chat.md

@@ -12,6 +12,8 @@
 - [Manage Chat Messages](#manage-chat-messages)
 - [Display Chat Messages](#display-chat-messages)
 - [Display Chat Events](#display-chat-events)
+- [Manage Chat Emojis](#manage-chat-emojis)
+- [Display Chat Emojis](#display-chat-emojis)
 - [Bulk Operations](#bulk-operations)
 
 ## Introduction
@@ -19,6 +21,7 @@ To use these commands you must update your service account authorization.
 ```
 gam user user@domain.com update serviceaccount
 
+[*]  3)  Chat API - Custom Emojis (supports readonly)
 [*]  4)  Chat API - Memberships (supports readonly)
 [*]  5)  Chat API - Memberships Admin (supports readonly)
 [*]  6)  Chat API - Messages (supports readonly)
@@ -51,10 +54,12 @@ Google requires that you have a Chat Bot configured in order to use the Chat API
 ## API documentation
 * [Overview](https://developers.google.com/workspace/chat/overview)
 * [Chat API](https://developers.google.com/workspace/chat/api/reference/rest)
+* [Chat API - Custom Emojis](https://developers.google.com/workspace/chat/api/reference/rest/v1/customEmojis)
 * [Chat API - Members](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members/list)
 * [Chat API - Messages](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/list)
 * [Chat API - Events](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents/list)
 * [Apps in Google Chat](https://support.google.com/chat/answer/7655820)
+* [Manage customemoji permissions](https://support.google.com/a/answer/12850085)
 * [Manage Spaces in Admin Console](https://support.google.com/a/answer/13369245)
 * [Predefined permission settings](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.FIELDS.predefined_permission_settings)
 
@@ -83,6 +88,8 @@ Google requires that you have a Chat Bot configured in order to use the Chat API
          (gdoc <UserGoogleDoc>)|
          (gcsdoc <StorageBucketObjectName>))
 
+<ChatEmojiName> ::= :[0-9a-z_-]+:
+<ChatEmoji> ::= emojiname <ChatEmojiName> | customemojis/<String>
 <ChatEvent> ::= spaces/<String>/spaceEvents/<String>
 <ChatMember> ::= spaces/<String>/members/<String>
 <ChatMemberList> ::= "<ChatMember>(,<ChatMember>)*"
@@ -896,6 +903,75 @@ filter 'start_time=\"2024-03-15T11:30:00-04:00\" AND event_types:\"google.worksp
 filter 'start_time=\"2024-03-15T11:30:00+00:00\" AND end_time=\"2024-03-3100:00:00+00:00\" AND event_types:\"google.workspace.chat.message.v1.created\"'
 ```
 
+## Manage Chat Emojis
+
+### Create a Chat Emoji
+```
+gam <UserTypeEntity> create chatemoji <ChatEmojiName>
+         ([drivedir|(sourcefolder <FilePath>)] [filename <FileNamePattern>])
+        [formatjson]
+```
+Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores.
+Hyphens and underscores should be used to separate words and cannot be used consecutively.
+
+By default, the emoji file will be uploaded from the current working directory.
+* `drivedir` - The emoji file will be uploaded from the directory specified by `drive_dir` in gam.cfg
+* `sourcefolder <FilePath>` - The emoji file will be uploaded from `<FilePath>`
+
+Specify the emoji file name; the following substitutions will be made:
+* `#email#` and `#user#` will be replaced by the user's full email address
+* `#username#` will be replaced by the local part of the user's email address
+
+### Delete a Chat Emoji
+Deletes the given Chat emoji.
+
+```
+gam <UserTypeEntity> delete chatemoji <Chatemoji>
+```
+
+## Display Chat Emojis
+### Display a specific Chat emoji
+
+```
+gam <UserTypeEntity> info chatemoji <Chatemoji>
+        [formatjson]
+```
+By default, Gam displays the information as an indented list of keys and values.
+* `formatjson` - Display the fields in JSON format.
+
+### Display information about all chat emojis
+```
+gam <UserTypeEntity> show chatemojis
+        [showcreatedby any|me|others]
+        [formatjson]
+```
+Select emojis to display:
+* `showcreatedby any` - Display all emojis regardless of creator
+* `showcreatedby ` - Display all emojis created by the user; this is the default
+* `showcreatedby others` - Display all emojis not created by the user
+
+By default, Gam displays the information as an indented list of keys and values.
+* `formatjson` - Display the fields in JSON format.
+
+```
+gam <UserTypeEntity> print chatemojis [todrive <ToDriveAttribute>*]
+        [showcreatedby any|me|others]
+        [formatjson [quotechar <Character>]]
+```
+Select emojis to display:
+* `showcreatedby any` - Display all emojis regardless of creator
+* `showcreatedby ` - Display all emojis created by the user; this is the default
+* `showcreatedby others` - Display all emojis not created by the user
+
+By default, Gam displays the information as columns of fields; the following option causes the output to be in JSON format,
+* `formatjson` - Display the fields in JSON format.
+
+By default, when writing CSV files, Gam uses a quote character of double quote `"`. The quote character is used to enclose columns that contain
+the quote character itself, the column delimiter (comma by default) and new-line characters. Any quote characters within the column are doubled.
+When using the `formatjson` option, double quotes are used extensively in the data resulting in hard to read/process output.
+The `quotechar <Character>` option allows you to choose an alternate quote character, single quote for instance, that makes for readable/processable output.
+`quotechar` defaults to `gam.cfg/csv_output_quote_char`. When uploading CSV files to Google, double quote `"` should be used.
+
 ## Bulk Operations
 ### Display information about all chat spaces for a collection of users
 ```

wiki/Users-Drive-Files-Display.md

@@ -968,7 +968,8 @@ Display a list of file/folder names indented to show structure.
         owners|
         parents|
         size|
-        trashed
+        trashed|
+        webviewlink
 <FileTreeFieldNameList> ::= "<FileTreeFieldName>(,<FileTreeFieldName>)*"
 
 gam <UserTypeEntity> print filetree [todrive <ToDriveAttribute>*]

wiki/Version-and-Help.md

@@ -3,7 +3,7 @@
 Print the current version of Gam with details
 ```
 gam version
-GAM 7.09.05 - https://github.com/GAM-team/GAM - pyinstaller
+GAM 7.10.00 - https://github.com/GAM-team/GAM - pyinstaller
 GAM Team <google-apps-manager@googlegroups.com>
 Python 3.13.5 64-bit final
 MacOS Sequoia 15.5 x86_64
@@ -15,7 +15,7 @@ Time: 2023-06-02T21:10:00-07:00
 Print the current version of Gam with details and time offset information
 ```
 gam version timeoffset
-GAM 7.09.05 - https://github.com/GAM-team/GAM - pyinstaller
+GAM 7.10.00 - https://github.com/GAM-team/GAM - pyinstaller
 GAM Team <google-apps-manager@googlegroups.com>
 Python 3.13.5 64-bit final
 MacOS Sequoia 15.5 x86_64
@@ -27,7 +27,7 @@ Your system time differs from www.googleapis.com by less than 1 second
 Print the current version of Gam with extended details and SSL information
 ```
 gam version extended
-GAM 7.09.05 - https://github.com/GAM-team/GAM - pyinstaller
+GAM 7.10.00 - https://github.com/GAM-team/GAM - pyinstaller
 GAM Team <google-apps-manager@googlegroups.com>
 Python 3.13.5 64-bit final
 MacOS Sequoia 15.5 x86_64
@@ -64,7 +64,7 @@ MacOS High Sierra 10.13.6 x86_64
 Path: /Users/Admin/bin/gam7
 Version Check:
   Current: 5.35.08
-   Latest: 7.09.05
+   Latest: 7.10.00
 echo $?
 1
 ```
@@ -72,7 +72,7 @@ echo $?
 Print the current version number without details
 ```
 gam version simple
-7.09.05
+7.10.00
 ```
 In Linux/MacOS you can do:
 ```
@@ -82,7 +82,7 @@ echo $VER
 Print the current version of Gam and address of this Wiki
 ```
 gam help
-GAM 7.09.05 - https://github.com/GAM-team/GAM
+GAM 7.10.00 - https://github.com/GAM-team/GAM
 GAM Team <google-apps-manager@googlegroups.com>
 Python 3.13.5 64-bit final
 MacOS Sequoia 15.5 x86_64