class TestListEventTypes(unittest.TestCase):
def setUp(self):
self._db = Database(logger, True)
for each in DEFAULT_EVENTS:
self._db.create_event_type(each)
def test_list_event_types(self):
event_types = self._db.list_event_types()
all_events = []
for event in event_types:
all_events.append(event[1])
result = set(DEFAULT_EVENTS) - set(all_events)
self.assertEqual(0, len(result))
class EventLog:
def __init__(self, db=None, logger=None):
self._cache = redis.Redis()
if db:
self._db = db
else:
self._db = Database(logger)
self._logger = logger
event_types = []
for each in self.list_event_types():
event_types.append(each[1])
missing_events = set(DEFAULT_EVENTS) - set(event_types)
for new_event in missing_events:
self._db.create_event_type(new_event)
def deserialize_user_object(self, event: Event):
if event.is_analyst():
cached_user_data = self._cache.get("analyst:{0}".format(
event.user_id))
if cached_user_data:
user_data = json.dumps(cached_user_data)
new_analyst_user = AnalystUser(
user_data["user_id"], user_data["email_address"],
user_data["session_token"], user_data["full_name"],
user_data["permissions"], user_data["view_event_type_ids"])
return new_analyst_user
else:
cached_user_data = self._cache.get("django:{0}".format(
event.user_id))
if cached_user_data:
user_data = json.dumps(cached_user_data)
new_django_user = DjangoUser(
user_data["user_id"], user_data["username"],
user_data["first_name"], user_data["last_name"],
user_data["email_address"],
datetime.datetime.strptime(user_data["created"],
"%Y-%m-%dT%H:%M:%S%z"),
datetime.datetime.strptime(user_data["last_logged_in"],
"%Y-%m-%dT%H:%M:%S%z"))
return new_django_user
def get_api_key_object(self, api_key: str) -> APIKey:
try:
node_data = self._db.validate_api_key(api_key)
node = APIKey(node_data[0], api_key, node_data[1], node_data[2],
node_data[3], node_data[4], node_data[5])
if node.suspended_event:
raise APIKeySuspended
if node.next_reset is None or node.next_reset < datetime.datetime.now(
):
next_reset = datetime.datetime.now() + datetime.timedelta(
hours=1)
node.next_reset = next_reset
node.events_posted = 0
self._db.reset_quota(node.node_id, next_reset)
if node.events_posted >= node.quota:
raise APIKeyRateLimited
return node
except DatabaseException:
raise APIKeyInvalid
def list_api_keys(self) -> list:
output = []
try:
all_api_keys = self._db.list_api_keys()
except DatabaseException:
raise EventLogException
for each_api_key in all_api_keys:
new_api_key = APIKey(each_api_key[0], each_api_key[1],
each_api_key[2], each_api_key[3],
each_api_key[4], each_api_key[5],
each_api_key[6])
output.append(new_api_key)
return output
def add_event_type(self, new_event_type):
self._cache.delete("event_types")
new_event_type_id = self._db.create_event_type(new_event_type)
if new_event_type_id > 0:
return new_event_type_id
raise EventLogException
@property
def event_type_ids_as_set(self) -> set:
try:
all_event_types = self.list_event_types()
all_event_type_ids = []
for each in all_event_types:
all_event_type_ids.append(each[0])
return set(all_event_type_ids)
except EventLogException:
raise EventLogException
def list_event_types(self) -> list:
event_types_cached = self._cache.get("event_types")
if event_types_cached:
event_types = json.loads(event_types_cached)
else:
event_types = self._db.list_event_types()
self._cache.set("event_types", json.dumps(event_types))
if len(event_types) == 1 and event_types[0][0] == -1:
raise EventLogException
return event_types
def get_event_count(self,
user_id=None,
event_type_id=None,
since=None,
until=None):
return self._db.get_event_count(user_id, event_type_id, since, until)
def log_event(self,
event_data: dict,
event_type_id: int,
user_id: int = None,
node_id: int = None):
event_id = self._db.log_event(event_data, event_type_id, user_id,
node_id)
if event_id:
event_type = None
for event in self.list_event_types():
if event[0] == event_type_id:
event_type = event[1]
break
if not event_type:
raise EventLogException
new_event = Event(event_id, event_type_id, event_type, event_data,
user_id, node_id,
datetime.datetime.now().isoformat())
self._cache.set("event_id:{0}".format(event_id), str(new_event))
return new_event
raise EventLogException
def get_event(self, event_id: int) -> Event:
cached_event_data = self._cache.get("event_id:{0}".format(event_id))
new_event = None
if cached_event_data:
cached_obj = json.loads(cached_event_data)
new_event = Event(
cached_obj["event_id"], cached_obj["event_type_id"],
cached_obj["event_type"], cached_obj["event_data"],
cached_obj["node_id"], cached_obj["user_id"],
datetime.datetime.strptime(cached_obj["created"],
"%Y-%m-%dT%H:%M:%S%z"))
else:
db_event_record = self._db.get_event_data(event_id)
if db_event_record:
# event_id, event_type_id, node_id, user_id, event_data, created, event_type.event_type
new_event = Event(db_event_record[0], db_event_record[1],
db_event_record[2],
json.loads(db_event_record[4]),
db_event_record[2], db_event_record[3],
db_event_record[5])
if new_event:
return new_event
else:
raise EventLogException
def retrieve_events(self,
user_id: int = None,
since: datetime = None,
until: datetime = None,
event_type_id: int = None,
node_id: int = None,
limit: int = 100):
try:
meta_data = self._db.retrieve_events(user_id, event_type_id,
node_id, since, until, limit)
# event_id, event_type_id, node_id, user_id, created
output = []
for row in meta_data:
event_id = row[0]
cache_key = "event_id:{0}".format(event_id)
event_data = self._cache.get(cache_key)
if event_data is None:
event_data = self._db.get_event_data(event_id)
new_event = Event(event_data[0],
event_data[1], event_data[6],
json.loads(event_data[4]), event_data[3],
event_data[2], event_data[5])
self._cache.set(cache_key, str(new_event))
output.append(json.loads(str(new_event)))
else:
output.append(json.loads(event_data))
return output
except DatabaseException:
raise EventLogException
def update_quota(self, node: APIKey):
try:
self._db.update_quota(node.node_id)
except DatabaseException:
if self._logger:
self._logger.error(
"Failed to update API rate quota for node id: {0}".format(
node.node_id))
class ConsoleUserManager(ConsoleMenu):
MAIN_MENU_CHOICES = [
"List Users", "Create User", "List Permissions for User",
"Assign User Permission", "Revoke User Permission", "List Event Types",
"Reset Password", "Back to Main Menu"
]
def __init__(self, environment, user_id, session_token, use_logger=None):
self._db = Database(env=environment, logger=use_logger)
self._session_token = session_token
self._user_id = user_id
def main_menu(self):
print("User Administration Menu\n")
x = 1
choices = ConsoleUserManager.MAIN_MENU_CHOICES
for each in choices:
print("{0}.) ".format(x) + each)
x += 1
choice = self.select_item(1, len(choices) + 1)
if choice == 1:
self.list_users()
elif choice == 2:
self.create_user()
elif choice == 3:
query_user_id = int(input("List permissions for user_id: "))
self.list_permissions_for_user_id(query_user_id)
elif choice == 4:
query_user_id = int(
input("Assign view-event-id permission for user_id: "))
query_event_type_id = int(input("Event type id: "))
self.assign_permission_for_user_id(query_user_id, "view",
query_event_type_id)
elif choice == 5:
print("Not yet implemented.")
elif choice == 6:
event_types = db.list_event_types()
print("ID\tEvent Type")
for each_event in event_types:
print("{0}\t{1}".format(each_event[0], each_event[1]))
elif choice == 7:
username = input("Reset password for user with email/username: "******"New password: "******"\nPress Enter to continue")
self.main_menu()
def reset_password(self, email, new_passwd):
try:
self._db.reset_password(email, new_passwd)
print("Password successfully changed.")
except DatabaseException:
print("Database Exception: Could not change password.")
def list_users(self):
try:
user_list = self._db.list_analyst_user_info()
# user_id, email_address, full_name, last_logged_in
print("User ID\tLogin/E-mail\tFull Name\tLast Logged In\n\n")
for each_user in user_list:
print("{0}\t{1}\t{2}\t{3}".format(each_user[0], each_user[1],
each_user[2], each_user[3]))
print("\n\n")
except DatabaseException:
print("Database error.")
def create_user(self, email=None, passwd=None, name=None):
if email is None:
email = input("E-mail address: ")
if passwd is None:
passwd = input("Password: "******"Name: ")
try:
new_user = self._db.create_user(email, passwd, name, "console")
print("Created new user with ID: {0}".format(new_user[0]))
except DatabaseException:
print("Could not create a new user.")
def list_permissions_for_user_id(self, uid):
try:
user_permissions = self._db.list_permissions_for_user_id(uid)
print("ACL ID\tPermission\tEvent Type ID\tCreated\tRevoked\n")
for each_permission in user_permissions:
print("{0}\t{1}\t{2}\t{3}\t{4}".format(each_permission[0],
each_permission[2],
each_permission[1],
each_permission[6],
"NO"))
except DatabaseException:
print("Could not create a new user.")
def assign_permission_for_user_id(self,
uid,
permission,
event_type_id=None):
if permission is "view-event-type" and event_type_id:
event_type = None
all_event_types = self._db.list_event_types()
for each_event_type in all_event_types:
if each_event_type[0] == event_type_id:
event_type = each_event_type[1]
break
if event_type:
logged_event_type_id = None
for each_event_type in all_event_types:
if each_event_type[1] is "Add Permission":
logged_event_type_id = each_event_type[0]
break
try:
event_id = self._db.log_event(
{
"assigned_by": "Administrator",
"ip_addr": "console",
"event_type": event_type,
"event_type_id": event_type_id
}, logged_event_type_id, 0, uid)
new_acl_id = self._db.assign_permission_for_user_id(
uid, permission, event_id, event_type_id)
print("Assigned new permission ID {0} to user_id {1}.".
format(new_acl_id, uid))
except DatabaseException:
print("Could not assign a new permission.")
def revoke_permission_for_user_id(self, uid, permission_id):
pass
