MOBILE-1554 utils: Implement $mmUtil#openOnlineFile

Author: dpalou

www/core/lib/filepool.js

@@ -176,7 +176,6 @@ angular.module('mm.core')
     $log = $log.getInstance('$mmFilepool');
 
     var self = {},
-        extensionRegex = new RegExp('^[a-z0-9]+$'),
         tokenRegex = new RegExp('(\\?|&)token=([A-Za-z0-9]+)'),
         queueState,
         urlAttributes = [
@@ -1238,7 +1237,7 @@ angular.module('mm.core')
         // part of the file name. Also, we need the mimetype to open the file with web intents. The easiest way to
         // provide such information is to keep the extension in the file ID. Developers should not care about it,
         // but as we are using the file ID in the file path, devs and system can guess it.
-        candidate = self._guessExtensionFromUrl(url);
+        candidate = $mmText.guessExtensionFromUrl(url);
         if (candidate && candidate !== 'php') {
             extension = '.' + candidate;
         }
@@ -1274,7 +1273,7 @@ angular.module('mm.core')
             // web intents. The easiest way to provide such information is to keep the extension
             // in the file ID. Developers should not care about it, but as we are using the
             // file ID in the file path, devs and system can guess it.
-            candidate = self._guessExtensionFromUrl(url);
+            candidate = $mmText.guessExtensionFromUrl(url);
             if (candidate && candidate !== 'php') {
                 extension = '.' + candidate;
             }
@@ -1701,33 +1700,6 @@ angular.module('mm.core')
         return self._getFileUrlByUrl(siteId, fileUrl, 'url', component, componentId, timemodified, checkSize);
     };
 
-    /**
-     * Guess the extension of a file from its URL.
-     *
-     * This is very weak and unreliable.
-     *
-     * @module mm.core
-     * @ngdoc method
-     * @name $mmFilepool#_guessExtensionFromUrl
-     * @param {String} fileUrl The file URL.
-     * @return {String} The lowercased extension without the dot, or undefined.
-     * @protected
-     */
-    self._guessExtensionFromUrl = function(fileUrl) {
-        var split = fileUrl.split('.'),
-            candidate,
-            extension;
-
-        if (split.length > 1) {
-            candidate = split.pop().toLowerCase();
-            if (extensionRegex.test(candidate)) {
-                extension = candidate;
-            }
-        }
-
-        return extension;
-    };
-
     /**
      * Guess the filename of a file from its URL.
      *

www/core/lib/text.js

@@ -23,7 +23,8 @@ angular.module('mm.core')
  */
 .factory('$mmText', function($q, $mmLang, $translate) {
 
-    var self = {};
+    var self = {},
+        extensionRegex = new RegExp('^[a-z0-9]+$');
 
     /**
      * Convert size in bytes into human readable format
@@ -322,5 +323,31 @@ angular.module('mm.core')
         return filename;
     };
 
+    /**
+     * Guess the extension of a file from its URL.
+     *
+     * This is very weak and unreliable.
+     *
+     * @module mm.core
+     * @ngdoc method
+     * @name $mmText#guessExtensionFromUrl
+     * @param {String} fileUrl The file URL.
+     * @return {String}        The lowercased extension without the dot, or undefined.
+     */
+    self.guessExtensionFromUrl = function(fileUrl) {
+        var split = fileUrl.split('.'),
+            candidate,
+            extension;
+
+        if (split.length > 1) {
+            candidate = split.pop().toLowerCase();
+            if (extensionRegex.test(candidate)) {
+                extension = candidate;
+            }
+        }
+
+        return extension;
+    };
+
     return self;
 });

www/core/lib/util.js

@@ -66,7 +66,7 @@ angular.module('mm.core')
     };
 
     this.$get = function($ionicLoading, $ionicPopup, $injector, $translate, $http, $log, $q, $mmLang, $mmFS, $timeout, $mmApp,
-                $mmText, mmCoreWifiDownloadThreshold, mmCoreDownloadThreshold, $ionicScrollDelegate, $cordovaInAppBrowser) {
+                $mmText, mmCoreWifiDownloadThreshold, mmCoreDownloadThreshold, $ionicScrollDelegate, $mmWS, $cordovaInAppBrowser) {
 
         $log = $log.getInstance('$mmUtil');
 
@@ -270,7 +270,7 @@ angular.module('mm.core')
          *
          * node-webkit: Using the default application configured.
          * Android: Using the WebIntent plugin.
-         * iOs: Using the window.open method.
+         * iOs: Using handleDocumentWithURL.
          *
          * @module mm.core
          * @ngdoc method
@@ -423,6 +423,79 @@ angular.module('mm.core')
             $cordovaInAppBrowser.close();
         };
 
+        /**
+         * Open an online file using platform specific method.
+         *
+         * node-webkit: Using the default application configured.
+         * Android: Using the WebIntent plugin.
+         * iOs: Using the window.open method.
+         *
+         * @module mm.core
+         * @ngdoc method
+         * @name $mmUtil#openOnlineFile
+         * @param  {String} url The URL of the file.
+         * @return {Promise}    Promise resolved when opened.
+         */
+        self.openOnlineFile = function(url) {
+            var deferred = $q.defer();
+
+            if (false) {
+                // @todo Restore node-webkit support.
+
+                // Link is the file path in the file system.
+                // We use the node-webkit shell for open the file (pdf, doc) using the default application configured in the os.
+                // var gui = require('nw.gui');
+                // gui.Shell.openItem(path);
+                deferred.resolve();
+
+            } else if (ionic.Platform.isAndroid() && window.plugins && window.plugins.webintent) {
+                // In Android we need the mimetype to open it.
+                var extension,
+                    iParams;
+
+                $mmWS.getRemoteFileMimeType(url).then(function(mimetype) {
+                    if (!mimetype) {
+                        // Couldn't retireve mimetype. Try to guess it.
+                        extension = $mmText.guessExtensionFromUrl(url);
+                        mimetype = $mmFS.getMimeType(extension);
+                    }
+
+                    iParams = {
+                        action: "android.intent.action.VIEW",
+                        url: url,
+                        type: mimetype
+                    };
+
+                    window.plugins.webintent.startActivity(
+                        iParams,
+                        function() {
+                            $log.debug('Intent launched');
+                            deferred.resolve();
+                        },
+                        function() {
+                            $log.debug('Intent launching failed.');
+                            $log.debug('action: ' + iParams.action);
+                            $log.debug('url: ' + iParams.url);
+                            $log.debug('type: ' + iParams.type);
+
+                            if (!extension || extension.indexOf('/') > -1 || extension.indexOf('\\') > -1) {
+                                // Extension not found.
+                                $mmLang.translateAndRejectDeferred(deferred, 'mm.core.erroropenfilenoextension');
+                            } else {
+                                $mmLang.translateAndRejectDeferred(deferred, 'mm.core.erroropenfilenoapp');
+                            }
+                        }
+                    );
+                });
+            } else {
+                $log.debug('Opening remote file using window.open()');
+                window.open(url, '_blank');
+                deferred.resolve();
+            }
+
+            return deferred.promise;
+        };
+
         /**
          * Displays a loading modal window.
          *

www/core/lib/ws.js

@@ -21,8 +21,8 @@ angular.module('mm.core')
  * @ngdoc service
  * @name $mmWS
  */
-.factory('$mmWS', function($http, $q, $log, $mmLang, $cordovaFileTransfer, $mmApp, $mmFS, $mmText, mmCoreSessionExpired,
-            mmCoreUserDeleted, $translate, $window, $mmUtil) {
+.factory('$mmWS', function($http, $q, $log, $mmLang, $cordovaFileTransfer, $mmApp, $mmFS, mmCoreSessionExpired,
+            mmCoreUserDeleted, $translate, $window) {
 
     $log = $log.getInstance('$mmWS');
 
@@ -216,7 +216,7 @@ angular.module('mm.core')
      * @module mm.core
      * @ngdoc method
      * @name $mmWS#getRemoteFileSize
-     * @param {Object} uri File URI.
+     * @param {Object} url File URL.
      * @return {Promise}   Promise resolved with the size or -1 if failure.
      */
     self.getRemoteFileSize = function(url) {
@@ -231,6 +231,23 @@ angular.module('mm.core')
         });
     };
 
+    /*
+     * Perform a HEAD request to get the mimetype of a remote file.
+     *
+     * @module mm.core
+     * @ngdoc method
+     * @name $mmWS#getRemoteFileMimeType
+     * @param {Object} url File URL.
+     * @return {Promise}   Promise resolved with the mimetype or '' if failure.
+     */
+    self.getRemoteFileMimeType = function(url) {
+        return $http.head(url).then(function(data) {
+            return data.headers('Content-Type') || '';
+        }).catch(function() {
+            return '';
+        });
+    };
+
     /**
      * A wrapper function for a synchronous Moodle WebService call.
      * Warning: This function should only be used if synchronous is a must. It's recommended to use $mmWS#call.
@@ -276,7 +293,7 @@ angular.module('mm.core')
         siteurl = preSets.siteurl + '/webservice/rest/server.php?moodlewsrestformat=json';
 
         // Serialize data.
-        data = $mmUtil.param(data);
+        data = serializeParams(data);
 
         // Perform sync request using XMLHttpRequest.
         xhr = new $window.XMLHttpRequest();
@@ -331,6 +348,42 @@ angular.module('mm.core')
         return data;
     };
 
+    /**
+     * Serialize an object to be used in a request.
+     *
+     * @param  {Object} obj Object to serialize.
+     * @return {String}     Serialization of the object.
+     */
+    function serializeParams(obj) {
+        var query = '', name, value, fullSubName, subName, subValue, innerObj, i;
+
+        for (name in obj) {
+            value = obj[name];
+
+            if (value instanceof Array) {
+                for (i = 0; i < value.length; ++i) {
+                    subValue = value[i];
+                    fullSubName = name + '[' + i + ']';
+                    innerObj = {};
+                    innerObj[fullSubName] = subValue;
+                    query += serializeParams(innerObj) + '&';
+                }
+            }
+            else if (value instanceof Object) {
+                for (subName in value) {
+                    subValue = value[subName];
+                    fullSubName = name + '[' + subName + ']';
+                    innerObj = {};
+                    innerObj[fullSubName] = subValue;
+                    query += serializeParams(innerObj) + '&';
+                }
+            }
+            else if (value !== undefined && value !== null) query += encodeURIComponent(name) + '=' + encodeURIComponent(value) + '&';
+        }
+
+        return query.length ? query.substr(0, query.length - 1) : query;
+    }
+
     return self;
 
 });