From f192758f25e99dfd62b24bddd0019c77574f4458 Mon Sep 17 00:00:00 2001
From: Ross Scroggs <taers232c@users.noreply.github.com>
Date: Wed, 20 Dec 2017 08:09:01 -0800
Subject: [PATCH] Update device file handling (#655)

Add targetfolder option to info cros; it defaults to value of GAMDRIVEDIR

Clean up download device file code

Allow print cros activity to select device files
Default remains activeTimeRanges and recentUsers
both still means activeTimeRanges and recentUsers
all means activeTimeRanges and recentUsers and deviceFiles
---
 src/GamCommands.txt | 43 ++++++++++++++++-----
 src/gam.py          | 94 +++++++++++++++++++++++++++------------------
 src/var.py          |  1 +
 3 files changed, 90 insertions(+), 48 deletions(-)

diff --git a/src/GamCommands.txt b/src/GamCommands.txt
index f5d0dca3..a6be92c2 100644
--- a/src/GamCommands.txt
+++ b/src/GamCommands.txt
@@ -788,10 +788,10 @@ gam calendar <CalendarItem> wipe
 
 gam update cros <CrOSItem> (<CrOSAttributes>+)|(action deprovision_same_model_replace|deprovision_different_model_replace|deprovision_retiring_device|disable|reenable [acknowledge_device_touch_requirement])
 gam info cros <CrOSItem> [nolists] [listlimit <Number>] [start <Date>] [end <Date>]
-	[basic|full|allfields] <CrOSFieldName>* [fields <CrOSFieldNameList>] [downloadfile latest|<Time>]
+	[basic|full|allfields] <CrOSFieldName>* [fields <CrOSFieldNameList>] [downloadfile latest|<Time>] [targetfolder <FilePath>]
 
 gam print cros [todrive] [query <QueryCrOS>] [limittoou <OrgUnitItem>]
-	[orderby <CrOSOrderByFieldName> [ascending|descending]] [nolists] [listlimit <Number>] [start <Date>] [end <Date>]
+	[orderby <CrOSOrderByFieldName> [ascending|descending]] [nolists|recentusers|timeranges|devicefiles] [listlimit <Number>] [start <Date>] [end <Date>]
 	[basic|full|allfields] <CrOSFieldName>* [fields <CrOSFieldNameList>]
 gam <CrOSTypeEntity> print
 
@@ -803,27 +803,49 @@ Prints no header row and deviceId for specified CrOS devices.
 gam print cros ... basic|full
 Prints a header row and selected fields for specified CrOS devices.
 
-The basic argument yields these column headers: deviceId,annotatedAssetId,annotatedLocation,annotatedUser,lastSync,notes,serialNumber,status
-The full argument yields all column headers including two headers, recentUsers and activeTimeRanges,
-that repeat with two/four subvalues each, yielding a large number of columns that make the output hard to process.
-The nolists argument suppresses these two headers; if you want these headers in a more manageable form use the following arguments.
+Print a header row and selected fields for specified CrOS devices; deviceId is the always the first column.
+If you specify allfields|basic|full, all other column headers are sorted.
+If you specify <CrOSFieldName>* | fields <CrOSFieldNameList>, the column headers appear in the order specified.
+gam [<CrOSTypeEntity>] print cros [todrive [<ToDriveAttributes>]] [query <QueryCrOS>]|[select <CrOSTypeEntity>] [limittoou <OrgUnitItem>]
+	[orderby <CrOSOrderByFieldName> [ascending|descending]] [nolists|recentusers|timeranges|devicefiles] [listlimit <Number>] [start <Date>] [end <Date>]
+	[basic|full|allfields] <CrOSFieldName>* [fields <CrOSFieldNameList>]
+
+The basic argument outputs these column headers: deviceId,annotatedAssetId,annotatedLocation,annotatedUser,lastSync,notes,serialNumber,status
+The allfields/full arguments output all column headers including three headers, recentUsers, activeTimeRanges and deviceFiles,
+that repeat with two/four/two subvalues each, yielding a large number of columns that make the output hard to process.
+The nolists argument suppresses these three headers; if you want these headers in a more manageable form use the following arguments.
+
 If recentusers is specified, for each recent user, the columns recentUsers.email and recentUsers.type are output on a separate row
 with all of the other headers.
+
 If timeranges is specified, for each time range entry, the columns activeTimeRanges.date, activeTimeRange.activeTime,
 activeTimeRanges.duration and activeTimeRanges.minutes are output on a separate row with all of the other headers.
+
+If devicefiles is specified, for each deviceFile, the columns deviceFiles.type and deviceFiles.createTime are output on a separate row
+with all of the other headers.
+
 The listlimit <Number> argument limits the number of repetitions to <Number>; if not specified or <Number> equals zero, there is no limit.
 The start <Date> and end <Date> arguments filter the time ranges.
 
 gam print crosactivity [todrive] [query <QueryCrOS>] [limittoou <OrgUnitItem>]
-	[recentusers] [timeranges] [both] [listlimit <Number>] [start <Date>] [end <Date>] [delimiter <Character>]
+	[recentusers] [timeranges] [both] [devicefiles] [all] [listlimit <Number>] [start <Date>] [end <Date>] [delimiter <Character>]
 
 The basic column headers are: deviceId,annotatedAssetId,annotatedLocation,serialNumber,orgUnitPath.
+
 If recentusers is specified, all of the recent users email addresses, separated by the delimiter <Character>,
 with header recentUsers.email, are output with the basic headers.
-If timeranges is specified, for each time range entry, activeTimeRanges.date and activeTimeRanges.duration and activeTimeRanges.minutes,
+
+If timeranges is specified, for each time range entry, activeTimeRanges.date and activeTimeRanges.duration and activeTimeRanges.minutes
 are output on a separate row with the basic headers.
-The default is to include both recentusers and timeranges.
-The listlimit <Number> argument limits the number of recent users and time ranges to <Number>; if not specified or <Number> equals zero, there is no limit.
+
+If devicefiles is specified, for each deviceFile, deviceFiles.type and deviceFiles.createTime
+are output on a separate row with the basic headers.
+
+The both option specifies recentusers and timeranges.
+The all option specifies recentusers, timeranges and devicefiles..
+The default is to include recentusers and timeranges.
+
+The listlimit <Number> argument limits the number of recent users, time ranges and device files to <Number>; if not specified or <Number> equals zero, there is no limit.
 The start <Date> and end <Date> arguments filter the time ranges.
 Delimiter defaults to comma.
 
@@ -865,6 +887,7 @@ gam print buildings [todrive]
 
 gam create feature <Name>
 gam update feature <Name> name <Name>
+gam delete feature <Name>
 gam print features [todrive]
 
 gam create resource <ResourceID> <Name> <ResourceAttributes>*
diff --git a/src/gam.py b/src/gam.py
index b2510d41..762bccf2 100755
--- a/src/gam.py
+++ b/src/gam.py
@@ -9239,6 +9239,7 @@ def doGetCrosInfo():
   else:
     devices = [deviceId,]
   downloadfile = None
+  targetFolder = GC_Values[GC_DRIVE_DIR]
   projection = None
   fieldsList = []
   noLists = False
@@ -9282,7 +9283,7 @@ def doGetCrosInfo():
       for field in fieldNameList.lower().replace(u',', u' ').split():
         if field in CROS_ARGUMENT_TO_PROPERTY_MAP:
           fieldsList.extend(CROS_ARGUMENT_TO_PROPERTY_MAP[field])
-          if field in CROS_ACTIVE_TIME_RANGES_ARGUMENTS+CROS_RECENT_USERS_ARGUMENTS:
+          if field in CROS_ACTIVE_TIME_RANGES_ARGUMENTS+CROS_DEVICE_FILES_ARGUMENTS+CROS_RECENT_USERS_ARGUMENTS:
             projection = u'FULL'
             noLists = False
         else:
@@ -9291,6 +9292,13 @@ def doGetCrosInfo():
       i += 2
     elif myarg == u'downloadfile':
       downloadfile = sys.argv[i+1]
+      if downloadfile.lower() == u'latest':
+        downloadfile = downloadfile.lower()
+      i += 2
+    elif myarg == u'targetfolder':
+      targetFolder = os.path.expanduser(sys.argv[i+1])
+      if not os.path.isdir(targetFolder):
+        os.makedirs(targetFolder)
       i += 2
     else:
       print u'ERROR: %s is not a valid argument for "gam info cros"' % sys.argv[i]
@@ -9338,25 +9346,22 @@ def doGetCrosInfo():
       if lenDF:
         print u'  deviceFiles'
         for deviceFile in deviceFiles[:min(lenDF, listLimit or lenDF)]:
-          print u'    %s: %s' % (deviceFile['type'], deviceFile['createTime'])
+          print u'    {0}: {1}'.format(deviceFile[u'type'], deviceFile[u'createTime'])
         if downloadfile:
-          if downloadfile.lower() == u'latest':
-            downloadfilename = u'cros-logs-%s-%s.zip' % (deviceId, deviceFiles[-1][u'createTime'])
-            downloadurl = deviceFiles[-1][u'downloadUrl']
+          if downloadfile == u'latest':
+            deviceFile = deviceFiles[-1]
           else:
-            for df in deviceFiles:
-              if df[u'createTime'] == downloadfile:
-                downloadurl = df[u'downloadUrl']
-                downloadfilename = u'cros-logs-%s-%s.zip' % (deviceId, df[u'createTime'])
+            for deviceFile in deviceFiles:
+              if deviceFile[u'createTime'] == downloadfile:
                 break
             else:
-              downloadurl = None
-          if downloadurl:
-            _, content = cd._http.request(downloadurl)
+              print u'ERROR: file {0} not available to download.'.format(downloadfile)
+              deviceFile = None
+          if deviceFile:
+            downloadfilename = os.path.join(targetFolder, u'cros-logs-{0}-{1}.zip'.format(deviceId, deviceFile[u'createTime']))
+            _, content = cd._http.request(deviceFile[u'downloadUrl'])
             writeFile(downloadfilename, content, continueOnError=True)
-            print u'Downloaded %s' % downloadfilename
-          else:
-            print u'ERROR: no such file to download.'
+            print u'Downloaded: {0}'.format(downloadfilename)
       elif downloadfile:
         print u'ERROR: no files to download.'
 
@@ -10956,8 +10961,9 @@ def doPrintCrosActivity():
   todrive = False
   titles = [u'deviceId', u'annotatedAssetId', u'annotatedLocation', u'serialNumber', u'orgUnitPath']
   csvRows = []
-  device_fields = [u'deviceId', u'annotatedAssetId', u'annotatedLocation', u'serialNumber', u'orgUnitPath']
+  fieldsList = [u'deviceId', u'annotatedAssetId', u'annotatedLocation', u'serialNumber', u'orgUnitPath']
   startDate = endDate = None
+  selectActiveTimeRanges = selectDeviceFiles = selectRecentUsers = False
   listLimit = 0
   delimiter = u','
   query = orgUnitPath = None
@@ -10974,13 +10980,19 @@ def doPrintCrosActivity():
       todrive = True
       i += 1
     elif myarg in CROS_ACTIVE_TIME_RANGES_ARGUMENTS:
-      device_fields.append(u'activeTimeRanges')
+      selectActiveTimeRanges = True
+      i += 1
+    elif myarg in CROS_DEVICE_FILES_ARGUMENTS:
+      selectDeviceFiles = True
       i += 1
     elif myarg in CROS_RECENT_USERS_ARGUMENTS:
-      device_fields.append(u'recentUsers')
+      selectRecentUsers = True
       i += 1
     elif myarg == u'both':
-      device_fields.extend([u'recentUsers', u'activeTimeRanges'])
+      selectActiveTimeRanges = selectRecentUsers = True
+      i += 1
+    elif myarg == u'all':
+      selectActiveTimeRanges = selectDeviceFiles = selectRecentUsers = True
       i += 1
     elif myarg in CROS_START_ARGUMENTS:
       startDate = datetime.datetime.strptime(sys.argv[i+1], u'%Y-%m-%d')
@@ -10997,13 +11009,18 @@ def doPrintCrosActivity():
     else:
       print u'ERROR: %s is not a valid argument for "gam print crosactivity"' % sys.argv[i]
       sys.exit(2)
-  if u'recentUsers' not in device_fields and u'activeTimeRanges' not in device_fields:
-    device_fields.extend([u'recentUsers', u'activeTimeRanges'])
-  if u'recentUsers' in device_fields:
-    titles.append(u'recentUsers.email')
-  if u'activeTimeRanges' in device_fields:
-    titles.extend([u'activeTimeRanges.date', u'activeTimeRanges.duration', u'activeTimeRanges.minutes'])
-  fields = u'chromeosdevices(%s),nextPageToken' % u','.join(device_fields)
+  if not selectActiveTimeRanges and not selectDeviceFiles and not selectRecentUsers:
+    selectActiveTimeRanges = selectRecentUsers = True
+  if selectRecentUsers:
+    fieldsList.append(u'recentUsers')
+    addTitlesToCSVfile([u'recentUsers.email',], titles)
+  if selectActiveTimeRanges:
+    fieldsList.append(u'activeTimeRanges')
+    addTitlesToCSVfile([u'activeTimeRanges.date', u'activeTimeRanges.duration', u'activeTimeRanges.minutes'], titles)
+  if selectDeviceFiles:
+    fieldsList.append(u'deviceFiles')
+    addTitlesToCSVfile([u'deviceFiles.type', u'deviceFiles.createTime'], titles)
+  fields = u'chromeosdevices(%s),nextPageToken' % u','.join(fieldsList)
   sys.stderr.write(u'Retrieving All Chrome OS Devices for organization (may take some time for large accounts)...\n')
   page_message = u'Got %%num_items%% Chrome devices...\n'
   all_cros = callGAPIpages(cd.chromeosdevices(), u'list', u'chromeosdevices', page_message=page_message,
@@ -11014,8 +11031,8 @@ def doPrintCrosActivity():
     for attrib in cros:
       if attrib not in [u'recentUsers', u'activeTimeRanges', u'deviceFiles']:
         row[attrib] = cros[attrib]
-    if u'activeTimeRanges' in cros:
-      activeTimeRanges = _filterTimeRanges(cros[u'activeTimeRanges'], startDate, endDate)
+    if selectActiveTimeRanges:
+      activeTimeRanges = _filterTimeRanges(cros.get(u'activeTimeRanges', []), startDate, endDate)
       lenATR = len(activeTimeRanges)
       for activeTimeRange in activeTimeRanges[:min(lenATR, listLimit or lenATR)]:
         new_row = row.copy()
@@ -11023,18 +11040,19 @@ def doPrintCrosActivity():
         new_row[u'activeTimeRanges.duration'] = utils.formatMilliSeconds(activeTimeRange[u'activeTime'])
         new_row[u'activeTimeRanges.minutes'] = activeTimeRange[u'activeTime']/60000
         csvRows.append(new_row)
-    if u'recentUsers' in cros:
-      recentUsers = []
-      for recentUser in cros[u'recentUsers']:
-        if u'email' in recentUser:
-          recentUsers.append(recentUser[u'email'])
-        elif recentUser[u'type'] == u'USER_TYPE_UNMANAGED':
-          recentUsers.append(u'UnmanagedUser')
-        else:
-          recentUsers.append(u'Unknown')
+    if selectRecentUsers:
+      recentUsers = cros.get(u'recentUsers', [])
       lenRU = len(recentUsers)
-      row[u'recentUsers.email'] = delimiter.join(recentUsers[:min(lenRU, listLimit or lenRU)])
+      row[u'recentUsers.email'] = delimiter.join([recent_user.get(u'email', [u'Unknown', u'UnmanagedUser'][recent_user[u'type'] == u'USER_TYPE_UNMANAGED']) for recent_user in recentUsers[:min(lenRU, listLimit or lenRU)]])
       csvRows.append(row)
+    if selectDeviceFiles:
+      devicefiles = cros.get(u'deviceFiles', [])
+      lenDF = len(devicefiles)
+      for deviceFile in devicefiles[:min(lenDF, listLimit or lenDF)]:
+        new_row = row.copy()
+        new_row[u'deviceFiles.type'] = deviceFile[u'type']
+        new_row[u'deviceFiles.createTime'] = deviceFile[u'createTime']
+        csvRows.append(new_row)
   writeCSVfile(csvRows, titles, u'CrOS Activity', todrive)
 
 def _checkTPMVulnerability(cros):
diff --git a/src/var.py b/src/var.py
index 2e96e13b..d7cc6a3c 100644
--- a/src/var.py
+++ b/src/var.py
@@ -497,6 +497,7 @@ CROS_SCALAR_PROPERTY_PRINT_ORDER = [
 
 CROS_RECENT_USERS_ARGUMENTS = [u'recentusers', u'users']
 CROS_ACTIVE_TIME_RANGES_ARGUMENTS = [u'timeranges', u'activetimeranges', u'times']
+CROS_DEVICE_FILES_ARGUMENTS = [u'devicefiles', u'files']
 CROS_START_ARGUMENTS = [u'start', u'startdate', u'oldestdate']
 CROS_END_ARGUMENTS = [u'end', u'enddate']