Merge branch 'develop' into sphinx-depend-sphinx-rtd-theme

Author: lmarini

CHANGELOG.md

@@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Changed
 - Added sphinx-rtd-theme==0.5.2 as a dependency to Sphinx requirements.txt since it is not a hard dependency anymore.
 
+### Added
+- Log an event each time that a user archives or unarchives a file.
+
 ## 1.16.0 - 2021-03-31
 
 ### Fixed

app/api/Files.scala

@@ -1856,9 +1856,11 @@ class Files @Inject()(
   }
 
   def archive(id: UUID) = PermissionAction(Permission.ArchiveFile, Some(ResourceRef(ResourceRef.file, id))) { implicit request =>
+    implicit val user = request.user
     files.get(id) match {
       case Some(file) => {
         files.setStatus(id, FileStatus.ARCHIVED)
+        sinkService.logFileArchiveEvent(file, user)
         Ok(toJson(Map("status" -> "success")))
       }
       case None => {
@@ -1869,9 +1871,11 @@ class Files @Inject()(
   }
 
   def unarchive(id: UUID) = PermissionAction(Permission.ArchiveFile, Some(ResourceRef(ResourceRef.file, id))) { implicit request =>
+    implicit val user = request.user
     files.get(id) match {
       case Some(file) => {
         files.setStatus(id, FileStatus.PROCESSED)
+        sinkService.logFileUnarchiveEvent(file, user)
         Ok(toJson(Map("status" -> "success")))
       }
       case None => {

app/services/EventSinkService.scala

@@ -261,6 +261,34 @@ class EventSinkService {
       "size" -> (dataset.files.length + dataset.folders.length)
     ))
   }
+
+  def logFileArchiveEvent(file: File, archiver: Option[User]) = {
+    logEvent(Json.obj(
+      "category" -> "archive",
+      "type" -> "file",
+      "resource_id" -> file.id,
+      "resource_name" -> file.filename,
+      "author_id" -> file.author.id,
+      "author_name" -> file.author.fullName,
+      "user_id" -> archiver.get.id,
+      "user_name" -> archiver.get.getMiniUser.fullName,
+      "size" -> file.length
+    ))
+  }
+
+  def logFileUnarchiveEvent(file: File, unarchiver: Option[User]) = {
+    logEvent(Json.obj(
+      "category" -> "unarchive",
+      "type" -> "file",
+      "resource_id" -> file.id,
+      "resource_name" -> file.filename,
+      "author_id" -> file.author.id,
+      "author_name" -> file.author.fullName,
+      "user_id" -> unarchiver.get.id,
+      "user_name" -> unarchiver.get.getMiniUser.fullName,
+      "size" -> file.length
+    ))
+  }
 }
 
 //case class EventSinkMessage(created: Long, category: String, metadata: JsValue)

doc/src/sphinx/Pipfile.lock

@@ -1,28 +1,28 @@
+-i https://pypi.org/simple/
 alabaster==0.7.12
-Babel==2.8.0
-certifi==2020.6.20
-chardet==3.0.4
+babel==2.9.0
+certifi==2020.12.5
+chardet==4.0.0
 commonmark==0.9.1
 docutils==0.16
 idna==2.10
 imagesize==1.2.0
-Jinja2==2.11.2
-MarkupSafe==1.1.1
-packaging==20.4
-Pygments==2.6.1
+jinja2==2.11.3
+markupsafe==1.1.1
+packaging==20.9
+pygments==2.8.1
 pyparsing==2.4.7
-pytz==2020.1
+pytz==2021.1
 recommonmark==0.6.0
-requests==2.24.0
-six==1.15.0
-snowballstemmer==2.0.0
-Sphinx==3.1.2
+requests==2.25.1
+snowballstemmer==2.1.0
 sphinx-rtd-theme==0.5.0
+sphinx==3.1.2
 sphinxcontrib-applehelp==1.0.2
 sphinxcontrib-devhelp==1.0.2
 sphinxcontrib-htmlhelp==1.0.3
 sphinxcontrib-jsmath==1.0.1
 sphinxcontrib-qthelp==1.0.3
 sphinxcontrib-serializinghtml==1.1.4
-urllib3==1.25.9
 sphinx-rtd-theme==0.5.2
+urllib3==1.26.4