chg: [retro hunt] add hunted objects status: viewed, done, rejected (fp)

Author: Terrtia

bin/lib/Tracker.py

@@ -2,7 +2,6 @@
 # -*-coding:UTF-8 -*
 import json
 import os
-import logging
 import logging.config
 import re
 import sys
@@ -1827,6 +1826,12 @@ def get_meta(self, options=set()):
             meta['nb_match'] = self.get_nb_match()
         if 'nb_objs' in options:
             meta['nb_objs'] = self.get_nb_objs()
+        if 'objs_stats' in options:
+            if 'nb_objs' in meta:
+                total = meta['nb_objs']
+            else:
+                total = None
+            meta['objs_stats'] = self.get_objs_stats(total=total)
         if 'org' in options:
             meta['org'] = self.get_org()
             if 'org_name' in options:
@@ -1912,6 +1917,12 @@ def get_nb_objs(self):
                 objs[obj_type] = nb
         return objs
 
+    def get_nb_total_objs(self):
+        nb = 0
+        for obj_type in get_objects_retro_hunted():
+            nb += self.get_nb_objs_by_type(obj_type)
+        return nb
+
     def get_objs(self):
         objs = []
         for obj_type in get_objects_retro_hunted():
@@ -1920,20 +1931,102 @@ def get_objs(self):
                 objs.append((obj_type, subtype, obj_id))
         return objs
 
+    def is_retro_hunted_obj(self, obj_gid):
+        return r_tracker.sismember(f'obj:retro_hunts:{obj_gid}', self.uuid)
+
     def add(self, obj_type, subtype, obj_id):
         # match by object type:
         r_tracker.sadd(f'retro_hunt:objs:{self.uuid}:{obj_type}', f'{subtype}:{obj_id}')
         # MAP object -> retro hunt
         r_tracker.sadd(f'obj:retro_hunts:{obj_type}:{subtype}:{obj_id}', self.uuid)
         self._incr_nb_match()
 
-    def remove(self, obj_type, subtype, obj_id):
+    def remove(self, obj_gid):
+        obj_type, subtype, obj_id = obj_gid.split(':', 2)
         # match by object type:
         r_tracker.srem(f'retro_hunt:objs:{self.uuid}:{obj_type}', f'{subtype}:{obj_id}')
         # MAP object -> retro hunt
-        r_tracker.srem(f'obj:retro_hunts:{obj_type}:{subtype}:{obj_id}', self.uuid)
+        r_tracker.srem(f'obj:retro_hunts:{obj_gid}', self.uuid)
+        # obj status
+        self.delete_obj_status(obj_gid)
         self._decr_nb_match()
 
+    def get_nb_objs_read(self):
+        return r_tracker.scard(f'retro_hunt:objs:read:{self.uuid}')
+
+    def get_objs_done(self):
+        return r_tracker.smembers(f'retro_hunt:objs:done:{self.uuid}')
+
+    def get_nb_objs_done(self):
+        return r_tracker.scard(f'retro_hunt:objs:done:{self.uuid}')
+
+    def get_objs_rejected(self):
+        return r_tracker.smembers(f'retro_hunt:objs:fp:{self.uuid}')
+
+    def get_nb_objs_rejected(self):
+        return r_tracker.scard(f'retro_hunt:objs:fp:{self.uuid}')
+
+    def get_objs_stats(self, total=None):
+        done = self.get_nb_objs_done()
+        fp = self.get_nb_objs_rejected()
+        read = self.get_nb_objs_read()
+        if total:
+            nb = 0
+            for nb_obj in total:
+                nb += total[nb_obj]
+        else:
+            nb = self.get_nb_total_objs()
+        unread = nb - done - fp - read
+        return {'done': done, 'fp': fp, 'read': read, 'unread': unread}
+
+    def is_obj_read(self, obj_gid):
+        return r_tracker.sismember(f'retro_hunt:objs:read:{self.uuid}', obj_gid)
+
+    def is_obj_done(self, obj_gid):
+        return r_tracker.sismember(f'retro_hunt:objs:done:{self.uuid}', obj_gid)
+
+    def is_obj_rejected(self, obj_gid):
+        return r_tracker.sismember(f'retro_hunt:objs:fp:{self.uuid}', obj_gid)
+
+    def get_obj_status(self, obj_gid):
+        if self.is_obj_read(obj_gid):
+            return 'read'
+        elif self.is_obj_done(obj_gid):
+            return 'done'
+        elif self.is_obj_rejected(obj_gid):
+            return 'rejected'
+        else:
+            return 'unread'
+
+    def obj_read(self, obj_gid):
+        self.obj_undone(obj_gid)
+        self.obj_unreject(obj_gid)
+        r_tracker.sadd(f'retro_hunt:objs:read:{self.uuid}', obj_gid)
+
+    def obj_unread(self, obj_gid):
+        r_tracker.srem(f'retro_hunt:objs:read:{self.uuid}', obj_gid)
+
+    def obj_done(self, obj_gid):
+        self.obj_unread(obj_gid)
+        self.obj_unreject(obj_gid)
+        r_tracker.sadd(f'retro_hunt:objs:done:{self.uuid}', obj_gid)
+
+    def obj_undone(self, obj_gid):
+        r_tracker.srem(f'retro_hunt:objs:done:{self.uuid}', obj_gid)
+
+    def obj_reject(self, obj_gid):
+        self.obj_unread(obj_gid)
+        self.obj_undone(obj_gid)
+        r_tracker.sadd(f'retro_hunt:objs:fp:{self.uuid}', obj_gid)
+
+    def obj_unreject(self, obj_gid):
+        r_tracker.srem(f'retro_hunt:objs:fp:{self.uuid}', obj_gid)
+
+    def delete_obj_status(self, obj_gid):
+        self.obj_unread(obj_gid)
+        self.obj_undone(obj_gid)
+        self.obj_unreject(obj_gid)
+
     def create(self, org_uuid, user_id, level, name, rule, description=None, filters=[], mails=[], tags=[], timeout=30, state='pending'):
         if self.exists():
             raise Exception('Error: Retro Hunt Task already exists')
@@ -1976,6 +2069,10 @@ def delete_objs(self):
                 r_tracker.srem(f'retro_hunt:objs:{self.uuid}:{obj_type}', f'{subtype}:{obj_id}')
                 # MAP object -> retro hunt
                 r_tracker.srem(f'obj:retro_hunts:{obj_type}:{subtype}:{obj_id}', self.uuid)
+        # objs status
+        r_tracker.delete(f'retro_hunts:objs:read:{self.uuid}')
+        r_tracker.delete(f'retro_hunts:objs:done:{self.uuid}')
+        r_tracker.delete(f'retro_hunts:objs:fp:{self.uuid}')
 
     def delete(self):
         if self.is_running() and self.get_state() not in ['completed', 'paused']:
@@ -2092,13 +2189,13 @@ def get_retro_hunt_metas(trackers_uuid):
 def is_obj_retro_hunted(obj_type, subtype, obj_id):
     return r_tracker.exists(f'obj:retro_hunts:{obj_type}:{subtype}:{obj_id}')
 
-def get_obj_retro_hunts(obj_type, subtype, obj_id):
-    return r_tracker.smembers(f'obj:retro_hunts:{obj_type}:{subtype}:{obj_id}')
+def get_obj_retro_hunts(obj_gid):
+    return r_tracker.smembers(f'obj:retro_hunts:{obj_gid}')
 
-def delete_obj_retro_hunts(obj_type, subtype, obj_id):
-    for retro_uuid in get_obj_retro_hunts(obj_type, subtype, obj_id):
+def delete_obj_retro_hunts(obj_gid):
+    for retro_uuid in get_obj_retro_hunts(obj_gid):
         retro_hunt = RetroHunt(retro_uuid)
-        retro_hunt.remove(obj_type, subtype, obj_id)
+        retro_hunt.remove(obj_gid)
 
 ####  ACL  ####
 
@@ -2153,7 +2250,7 @@ def api_validate_rule_to_add(rule, rule_type):
     if rule_type == 'yara_custom':
         valid_yara_rule, error = is_valid_yara_rule(rule)
         if not valid_yara_rule:
-            return {"status": "error", "reason": f"Invalid Yara Rule: {e}"}, 400
+            return {"status": "error", "reason": f"Invalid Yara Rule: {error}"}, 400
     elif rule_type == 'yara_default':
         if not is_valid_default_yara_rule(rule):
             return {"status": "error", "reason": "The Yara Rule doesn't exist"}, 400
@@ -2256,6 +2353,61 @@ def api_delete_retro_hunt_task(user_org, user_id, user_role, task_uuid):
     else:
         return retro_hunt.delete(), 200
 
+def api_retro_hunt_object_status_done(data, user_org, user_id, user_role):
+    retro_uuid = data.get('uuid')
+    res = api_check_retro_hunt_acl(retro_uuid, user_org, user_id, user_role, 'edit')
+    if res:
+        return res
+    retro_hunt = RetroHunt(retro_uuid)
+    object_gid = data.get('gid')
+    if not retro_hunt.is_retro_hunted_obj(object_gid):
+        return {"status": "error", "reason": "Not Retro Hunted Object"}, 404
+    return retro_hunt.obj_done(object_gid), 200
+
+def api_retro_hunt_object_status_reject(data, user_org, user_id, user_role):
+    retro_uuid = data.get('uuid')
+    res = api_check_retro_hunt_acl(retro_uuid, user_org, user_id, user_role, 'edit')
+    if res:
+        return res
+    retro_hunt = RetroHunt(retro_uuid)
+    object_gid = data.get('gid')
+    if not retro_hunt.is_retro_hunted_obj(object_gid):
+        return {"status": "error", "reason": "Not Retro Hunted Object"}, 404
+    return retro_hunt.obj_reject(object_gid), 200
+
+def api_retro_hunt_object_status_unread(data, user_org, user_id, user_role):
+    retro_uuid = data.get('uuid')
+    res = api_check_retro_hunt_acl(retro_uuid, user_org, user_id, user_role, 'edit')
+    if res:
+        return res
+    retro_hunt = RetroHunt(retro_uuid)
+    object_gid = data.get('gid')
+    if not retro_hunt.is_retro_hunted_obj(object_gid):
+        return {"status": "error", "reason": "Not Retro Hunted Object"}, 404
+    return retro_hunt.delete_obj_status(object_gid), 200
+
+def api_retro_hunt_object_status_read(data, user_org, user_id, user_role):
+    retro_uuid = data.get('uuid')
+    res = api_check_retro_hunt_acl(retro_uuid, user_org, user_id, user_role, 'edit')
+    if res:
+        return res
+    retro_hunt = RetroHunt(retro_uuid)
+    object_gid = data.get('gid')
+    if not retro_hunt.is_retro_hunted_obj(object_gid):
+        return {"status": "error", "reason": "Not Retro Hunted Object"}, 404
+    return retro_hunt.obj_read(object_gid), 200
+
+def api_retro_hunt_remove_object(data, user_org, user_id, user_role):
+    retro_uuid = data.get('uuid')
+    res = api_check_retro_hunt_acl(retro_uuid, user_org, user_id, user_role, 'edit')
+    if res:
+        return res
+    retro_hunt = RetroHunt(retro_uuid)
+    object_gid = data.get('gid')
+    if not retro_hunt.is_retro_hunted_obj(object_gid):
+        return {"status": "error", "reason": "Not Retro Hunted Object"}, 404
+    return retro_hunt.remove(object_gid), 200
+
 ################################################################################
 ################################################################################
 ################################################################################

bin/lib/module_extractor.py

@@ -228,7 +228,7 @@ def get_tracker_match(user_org, user_id, obj, content, priority=None, match_uuid
 
     else:
         trackers_uuids = Tracker.get_obj_trackers(obj.type, obj.get_subtype(r_str=True), obj.id)
-        retro_hunts_uuids = Tracker.get_obj_retro_hunts(obj.type, obj.get_subtype(r_str=True), obj.id)
+        retro_hunts_uuids = Tracker.get_obj_retro_hunts(obj_gid)
 
         # check if priority is tracker or retro
         if priority:

var/www/blueprints/hunters.py

@@ -664,14 +664,19 @@ def retro_hunt_show_task():
     if res:
         return res
 
-    dict_task = retro_hunt.get_meta(options={'creator', 'date', 'description', 'level', 'org', 'org_name', 'progress', 'filters', 'nb_objs', 'tags'})
+    dict_task = retro_hunt.get_meta(options={'creator', 'date', 'description', 'level', 'org', 'org_name', 'progress', 'filters', 'nb_objs', 'objs_stats','tags'})
     rule_content = Tracker.get_yara_rule_content(dict_task['rule'])
     dict_task['filters'] = json.dumps(dict_task['filters'], indent=4)
 
+    dict_task['objs'] = []
     if objs:
-        dict_task['objs'] = ail_objects.get_objects_meta(retro_hunt.get_objs(), options={'last_full_date'}, flask_context=True)
-    else:
-        dict_task['objs'] = []
+        options = {'last_full_date', 'pdf'}
+        for ob in retro_hunt.get_objs():
+            obj_type, obj_subtype, obj_id = ob
+            obj_meta = ail_objects.get_object_meta(obj_type, obj_subtype, obj_id, options=options, flask_context=True)
+            obj_meta['gid'] = f'{obj_type}:{obj_subtype}:{obj_id}'
+            obj_meta['tracker_status'] = retro_hunt.get_obj_status(obj_meta['gid'])
+            dict_task['objs'].append(obj_meta)
 
     return render_template("show_retro_hunt.html", dict_task=dict_task,
                            rule_content=rule_content,
@@ -885,4 +890,93 @@ def retro_hunt_objects_report():
                            chats=chats, messages=messages, bootstrap_label=bootstrap_label, force_full_image=True)
 
 
+@hunters.route('/retro_hunt/object/status/done', methods=['GET'])
+@login_required
+@login_user_no_api
+def retro_hunt_object_status_done():
+    user_id = current_user.get_user_id()
+    user_org = current_user.get_org()
+    user_role = current_user.get_role()
+    retro_uuid = request.args.get('uuid')
+    object_global_id = request.args.get('gid')
+
+    res = Tracker.api_retro_hunt_object_status_done({'uuid': retro_uuid, 'gid': object_global_id}, user_org, user_id, user_role)
+    if res[1] != 200:
+        return create_json_response(res[0], res[1])
+    else:
+        if request.referrer:
+            return redirect(request.referrer)
+        else:
+            return redirect(url_for('hunters.retro_hunt_show_task', uuid=retro_uuid))
+
+@hunters.route('/retro_hunt/object/status/unread', methods=['GET'])
+@login_required
+@login_user_no_api
+def retro_hunt_object_status_unread():
+    user_id = current_user.get_user_id()
+    user_org = current_user.get_org()
+    user_role = current_user.get_role()
+    retro_uuid = request.args.get('uuid')
+    object_global_id = request.args.get('gid')
+
+    res = Tracker.api_retro_hunt_object_status_unread({'uuid': retro_uuid, 'gid': object_global_id}, user_org, user_id, user_role)
+    if res[1] != 200:
+        return create_json_response(res[0], res[1])
+    else:
+        if request.referrer:
+            return redirect(request.referrer)
+        else:
+            return redirect(url_for('hunters.retro_hunt_show_task', uuid=retro_uuid))
+
+
+@hunters.route('/retro_hunt/object/status/reject', methods=['GET'])
+@login_required
+@login_user_no_api
+def retro_hunt_object_status_reject():
+    user_id = current_user.get_user_id()
+    user_org = current_user.get_org()
+    user_role = current_user.get_role()
+    retro_uuid = request.args.get('uuid')
+    object_global_id = request.args.get('gid')
+
+    res = Tracker.api_retro_hunt_object_status_reject({'uuid': retro_uuid, 'gid': object_global_id}, user_org, user_id, user_role)
+    if res[1] != 200:
+        return create_json_response(res[0], res[1])
+    else:
+        if request.referrer:
+            return redirect(request.referrer)
+        else:
+            return redirect(url_for('hunters.retro_hunt_show_task', uuid=retro_uuid))
+
+@hunters.route('/retro_hunt/object/status/read', methods=['POST'])
+@login_required
+@login_user_no_api
+def retro_hunt_object_status_read():
+    user_id = current_user.get_user_id()
+    user_org = current_user.get_org()
+    user_role = current_user.get_role()
+    retro_uuid = request.args.get('uuid')
+    object_global_id = request.args.get('gid')
+
+    res = Tracker.api_retro_hunt_object_status_read({'uuid': retro_uuid, 'gid': object_global_id}, user_org, user_id, user_role)
+    return create_json_response(res[0], res[1])
+
+@hunters.route('/retro_hunt/object/remove', methods=['GET'])
+@login_required
+@login_user_no_api
+def retro_hunt_object_remove():
+    user_id = current_user.get_user_id()
+    user_org = current_user.get_org()
+    user_role = current_user.get_role()
+    retro_uuid = request.args.get('uuid')
+    object_global_id = request.args.get('gid')
+    res = Tracker.api_retro_hunt_remove_object({'uuid': retro_uuid, 'gid': object_global_id}, user_org, user_id, user_role)
+    if res[1] != 200:
+        return create_json_response(res[0], res[1])
+    else:
+        if request.referrer:
+            return redirect(request.referrer)
+        else:
+            return redirect(url_for('hunters.retro_hunt_show_task', uuid=retro_uuid))
+
 ##  - -  ##