Add the ability to view the system logs in the superuser endpoint

endpoints/api/superuser.py

@@ -1,9 +1,10 @@
 import string
 import logging
 import json
+import os
 
 from random import SystemRandom
-from app import app
+from app import app, avatar
 from flask import request
 
 from endpoints.api import (ApiResource, nickname, resource, validate_json_request, request_error,
@@ -22,6 +23,57 @@ import features
 
 logger = logging.getLogger(__name__)
 
+LOGS_PATH = "/var/log/%s/current"
+SERVICES_PATH = "conf/init/"
+
+def get_immediate_subdirectories(directory):
+  return [name for name in os.listdir(directory) if os.path.isdir(os.path.join(directory, name))]
+
+
+@resource('/v1/superuser/systemlogs/<service>')
+@internal_only
+@show_if(features.SUPER_USERS)
+class SuperUserGetLogsForService(ApiResource):
+  """ Resource for fetching the kinds of system logs in the system. """
+  @nickname('getSystemLogs')
+  def get(self, service):
+    """ Returns the logs for the specific service. """
+    if SuperUserPermission().can():
+      services = get_immediate_subdirectories(SERVICES_PATH)
+      if not service in services:
+        abort(404)
+
+      try:
+        with open(LOGS_PATH % service, 'r') as f:
+          logs = f.read()
+      except Exception as ex:
+        logger.exception('Cannot read logs')
+        abort(400)
+
+      return {
+        'logs': logs
+      }
+
+    abort(403)
+
+
+@resource('/v1/superuser/systemlogs/')
+@internal_only
+@show_if(features.SUPER_USERS)
+class SuperUserSystemLogServices(ApiResource):
+  """ Resource for fetching the kinds of system logs in the system. """
+  @nickname('listSystemLogServices')
+  def get(self):
+    """ List the system logs for the current system. """
+    if SuperUserPermission().can():
+      return {
+        'services': get_immediate_subdirectories(SERVICES_PATH)
+      }
+
+    abort(403)
+
+
+
 @resource('/v1/superuser/logs')
 @internal_only
 @show_if(features.SUPER_USERS)
@@ -33,7 +85,7 @@ class SuperUserLogs(ApiResource):
   @query_param('endtime', 'Latest time to which to get logs. (%m/%d/%Y %Z)', type=str)
   @query_param('performer', 'Username for which to filter logs.', type=str)
   def get(self, args):
-    """ List the logs for the current system. """
+    """ List the usage logs for the current system. """
     if SuperUserPermission().can():
       performer_name = args['performer']
       start_time = args['starttime']
@@ -49,6 +101,7 @@ def user_view(user):
     'username': user.username,
     'email': user.email,
     'verified': user.verified,
+    'avatar': avatar.compute_hash(user.email, name=user.username),
     'super_user': user.username in app.config['SUPER_USERS']
   }