udata 9.0.1.dev29716__py2.py3-none-any.whl → 9.0.1.dev29760__py2.py3-none-any.whl

udata/api/__init__.py

@@ -334,6 +334,7 @@ def init_app(app):
     import udata.core.organization.apiv2  # noqa
     import udata.core.followers.api  # noqa
     import udata.core.jobs.api  # noqa
+    import udata.core.reports.api  # noqa
     import udata.core.site.api  # noqa
     import udata.core.tags.api  # noqa
     import udata.core.topic.api  # noqa

udata/api_fields.py

@@ -38,6 +38,9 @@ def convert_db_to_field(key, field, info = {}):
         constructor = restx_fields.String
         params['min_length'] = field.min_length
         params['max_length'] = field.max_length
+        params['enum'] = field.choices
+    elif isinstance(field, mongo_fields.ObjectIdField):
+        constructor = restx_fields.String
     elif isinstance(field, mongo_fields.FloatField):
         constructor = restx_fields.Float
         params['min'] = field.min # TODO min_value?

udata/core/reports/api.py

@@ -0,0 +1,43 @@
+from flask import request
+from flask_login import current_user
+import mongoengine
+
+from udata.api import api, API, fields
+from udata.api_fields import patch
+from .models import Report
+from .constants import reports_reasons_translations
+
+ns = api.namespace('reports', 'User reported objects related operations (beta)')
+
+@ns.route('/', endpoint='reports')
+class ReportsAPI(API):
+    @api.doc('list_reports')
+    @api.expect(Report.__index_parser__)
+    @api.marshal_with(Report.__page_fields__)
+    def get(self):
+        query = Report.objects
+
+        return Report.apply_sort_filters_and_pagination(query)
+
+    @api.secure
+    @api.doc('create_report', responses={400: 'Validation error'})
+    @api.expect(Report.__write_fields__)
+    @api.marshal_with(Report.__read_fields__, code=201)
+    def post(self):
+        report = patch(Report(), request)
+        report.by = current_user._get_current_object()
+
+        try:
+            report.save()
+        except mongoengine.errors.ValidationError as e:
+            api.abort(400, e.message)
+
+        return report, 201
+    
+
+@ns.route('/reasons/', endpoint='reports_reasons')
+class ReportsReasonsAPI(API):
+    @api.doc('list_reports_reasons')
+    @ns.response(200, "dictionnary of available reasons associated with their labels", fields.Raw)
+    def get(self):
+        return reports_reasons_translations()

udata/core/reports/constants.py

@@ -0,0 +1,28 @@
+
+from udata.core.dataset.models import Dataset
+from udata.i18n import lazy_gettext as _
+
+
+REASON_SPAM = 'spam'
+REASON_PERSONAL_DATA = 'personal_data'
+REASON_EXPLICIT_CONTENT = 'explicit_content'
+REASON_ILLEGAL_CONTENT = 'illegal_content'
+REASON_SECURITY = 'security'
+REASON_OTHERS = 'others'
+
+def reports_reasons_translations():
+    '''
+    This is a function to avoid creating the dict with a wrong lang
+    at the start of the app.
+    '''
+    return {
+        REASON_SPAM: _('Spam'),
+        REASON_PERSONAL_DATA: _('Personal data'),
+        REASON_EXPLICIT_CONTENT: _('Explicit content'),
+        REASON_ILLEGAL_CONTENT: _('Illegal content'),
+        REASON_SECURITY: _('Security'),
+        REASON_OTHERS: _('Others'),
+    }
+
+REPORT_REASONS_CHOICES = [key for key, _ in reports_reasons_translations().items()]
+REPORTABLE_MODELS = [Dataset]

udata/core/reports/models.py

@@ -0,0 +1,57 @@
+from datetime import datetime
+from mongoengine import signals, NULLIFY
+
+from udata.api_fields import field, generate_fields
+from udata.core.dataset.models import Dataset
+from udata.core.user.models import User
+from udata.mongo import db
+from udata.core.user.api_fields import user_ref_fields
+
+from .constants import REPORT_REASONS_CHOICES, REPORTABLE_MODELS
+
+@generate_fields()
+class Report(db.Document):
+    by = field(
+        db.ReferenceField(User, reverse_delete_rule=NULLIFY),
+        nested_fields=user_ref_fields,
+        description="Only set if a user was connected when reporting an element.",
+        readonly=True,
+        allow_null=True,
+    )
+
+    object_type = field(
+        db.StringField(choices=[m.__name__ for m in REPORTABLE_MODELS])
+    )
+    object_id = field(
+        db.ObjectIdField()
+    )
+    object_deleted_at = field(
+        db.DateTimeField(),
+        allow_null=True,
+        readonly=True,
+    )
+
+    reason = field(
+        db.StringField(choices=REPORT_REASONS_CHOICES, required=True),
+    )
+    message = field(
+        db.StringField(),
+    )
+
+    reported_at = field(
+        db.DateTimeField(default=datetime.utcnow, required=True),
+        readonly=True,
+    )
+
+    @classmethod
+    def mark_as_deleted_soft_delete(cls, sender, document, **kwargs):
+        if document.deleted:
+            Report.objects(object_type=sender.__name__, object_id=document.id, object_deleted_at=None).update(object_deleted_at=datetime.utcnow)
+    
+    def mark_as_deleted_hard_delete(cls, document, **kwargs):
+        Report.objects(object_type=document.__class__.__name__, object_id=document.id, object_deleted_at=None).update(object_deleted_at=datetime.utcnow)
+
+
+for model in REPORTABLE_MODELS:
+    signals.post_save.connect(Report.mark_as_deleted_soft_delete, sender=model)
+    signals.post_delete.connect(Report.mark_as_deleted_hard_delete, sender=model)

udata/models/__init__.py

@@ -21,6 +21,7 @@ from udata.core.post.models import *  # noqa
 from udata.core.jobs.models import *  # noqa
 from udata.core.tags.models import *  # noqa
 from udata.core.spam.models import *  # noqa
+from udata.core.reports.models import *  # noqa
 
 from udata.features.transfer.models import *  # noqa
 from udata.features.territories.models import *  # noqa