MOBILE-1987 filepool: Notify file deleted, outdated and downloading

Author: dpalou

upgrade.txt

@@ -23,6 +23,7 @@ information provided here is intended especially for developers.
  * A new field has been added to config.json: privacypolicy.
  * String identifiers mm.core.elementseparator and mm.core.fieldvalueseparator have been renamed to:
    mm.core.listsep and mm.core.labelsep
+ * Filepool now also throws file events (getFileEventNameByUrl) when files are deleted, outdated or start downloading. It passes an 'action' property to identify the exact action.
 
 === 3.2 ===
 

www/core/directives/file.js

@@ -204,7 +204,7 @@ angular.module('mm.core')
                 $mmFilepool.getFileEventNameByUrl(siteId, fileUrl).then(function(eventName) {
                     observer = $mmEvents.on(eventName, function(data) {
                         getState(scope, siteId, fileUrl, timeModified, alwaysDownload);
-                        if (!data.success) {
+                        if (data.action == 'download' && !data.success) {
                             $mmUtil.showErrorModal('mm.core.errordownloading', true);
                         }
                     });

www/core/lib/filepool.js

@@ -431,6 +431,7 @@ angular.module('mm.core')
                     }).then(function() {
                         // Check if the queue is running.
                         self.checkQueueProcessing();
+                        self._notifyFileDownloading(siteId, fileId);
                         return self._getQueuePromise(siteId, fileId);
                     });
                 }
@@ -803,6 +804,8 @@ angular.module('mm.core')
             addExtension = typeof filePath == "undefined",
             pathPromise = filePath ? filePath : self._getFilePath(siteId, fileId, extension);
 
+        self._notifyFileDownloading(siteId, fileId);
+
         return $q.when(pathPromise).then(function(filePath) {
             if (poolFileObject && poolFileObject.fileId !== fileId) {
                 $log.error('Invalid object to update passed');
@@ -2055,6 +2058,19 @@ angular.module('mm.core')
         return fileObject.stale || revision > fileObject.revision || timemodified > fileObject.timemodified;
     };
 
+    /**
+     * Notify a file has been deleted.
+     *
+     * @module mm.core
+     * @ngdoc method
+     * @name $mmFilepool#_notifyFileDeleted
+     * @param {String} siteId The site ID.
+     * @param {String} fileId The file ID.
+     */
+    self._notifyFileDeleted = function(siteId, fileId) {
+        $mmEvents.trigger(self._getFileEventName(siteId, fileId), {action: 'deleted'});
+    };
+
     /**
      * Notify a file has been downloaded.
      *
@@ -2065,7 +2081,7 @@ angular.module('mm.core')
      * @param {String} fileId The file ID.
      */
     self._notifyFileDownloaded = function(siteId, fileId) {
-        $mmEvents.trigger(self._getFileEventName(siteId, fileId), {success: true});
+        $mmEvents.trigger(self._getFileEventName(siteId, fileId), {action: 'download', success: true});
     };
 
     /**
@@ -2078,7 +2094,33 @@ angular.module('mm.core')
      * @param {String} fileId The file ID.
      */
     self._notifyFileDownloadError = function(siteId, fileId) {
-        $mmEvents.trigger(self._getFileEventName(siteId, fileId), {success: false});
+        $mmEvents.trigger(self._getFileEventName(siteId, fileId), {action: 'download', success: false});
+    };
+
+    /**
+     * Notify a file starts being downloaded or added to queue.
+     *
+     * @module mm.core
+     * @ngdoc method
+     * @name $mmFilepool#_notifyFileDownloading
+     * @param {String} siteId The site ID.
+     * @param {String} fileId The file ID.
+     */
+    self._notifyFileDownloading = function(siteId, fileId) {
+        $mmEvents.trigger(self._getFileEventName(siteId, fileId), {action: 'downloading'});
+    };
+
+    /**
+     * Notify a file has been outdated.
+     *
+     * @module mm.core
+     * @ngdoc method
+     * @name $mmFilepool#_notifyFileOutdated
+     * @param {String} siteId The site ID.
+     * @param {String} fileId The file ID.
+     */
+    self._notifyFileOutdated = function(siteId, fileId) {
+        $mmEvents.trigger(self._getFileEventName(siteId, fileId), {action: 'outdated'});
     };
 
     /**
@@ -2352,7 +2394,9 @@ angular.module('mm.core')
                     }));
                 }
 
-                return $q.all(promises);
+                return $q.all(promises).then(function() {
+                    self._notifyFileDeleted(siteId, fileId);
+                });
             });
         });
     };