MOBILE-1357 grades: Add grade content link handler

Author: dpalou

www/addons/grades/main.js

@@ -17,7 +17,8 @@ angular.module('mm.addons.grades', [])
 .constant('mmaGradesPriority', 400)
 .constant('mmaGradesViewGradesPriority', 400)
 
-.config(function($stateProvider, $mmUserDelegateProvider, $mmCoursesDelegateProvider, mmaGradesPriority, mmaGradesViewGradesPriority) {
+.config(function($stateProvider, $mmUserDelegateProvider, $mmCoursesDelegateProvider, $mmContentLinksDelegateProvider,
+            mmaGradesPriority, mmaGradesViewGradesPriority) {
 
     $stateProvider
 
@@ -41,4 +42,7 @@ angular.module('mm.addons.grades', [])
 
     // Register courses content plugin.
     $mmCoursesDelegateProvider.registerNavHandler('mmaGrades', '$mmaGradesHandlers.coursesNav', mmaGradesPriority);
+
+    // Register content links handler.
+    $mmContentLinksDelegateProvider.registerLinkHandler('mmaGrades', '$mmaGradesHandlers.linksHandler');
 });

www/addons/grades/services/handlers.js

@@ -21,7 +21,7 @@ angular.module('mm.addons.grades')
  * @ngdoc service
  * @name $mmaGradesHandlers
  */
-.factory('$mmaGradesHandlers', function($mmaGrades, $state, mmCoursesAccessMethods) {
+.factory('$mmaGradesHandlers', function($mmaGrades, $state, $mmUtil, $mmContentLinksHelper, mmCoursesAccessMethods) {
 
     var self = {};
 
@@ -155,5 +155,56 @@ angular.module('mm.addons.grades')
         return self;
     };
 
+    /**
+     * Content links handler.
+     *
+     * @module mm.addons.grades
+     * @ngdoc method
+     * @name $mmaGradesHandlers#linksHandler
+     */
+    self.linksHandler = function() {
+
+        var self = {};
+
+        /**
+         * Whether or not the handler is enabled for the site.
+         *
+         * @return {Boolean}
+         */
+        self.isEnabled = function() {
+            return $mmaGrades.isPluginEnabled();
+        };
+
+        /**
+         * Get actions to perform with the link.
+         *
+         * @param {String} url URL to treat.
+         * @return {Object[]}  List of actions. See {@link $mmContentLinksDelegate#registerLinkHandler}.
+         */
+        self.getActions = function(url) {
+            // Check it's a grade URL.
+            if (url.indexOf('/grade/report/user/index.php') > -1) {
+                var params = $mmUtil.extractUrlParams(url);
+                if (typeof params.id != 'undefined') {
+                    // Return actions.
+                    return [{
+                        message: 'mm.core.view',
+                        icon: 'ion-eye',
+                        action: function(siteId) {
+                            var stateParams = {
+                                course: {id: parseInt(params.id, 10)},
+                                userid: parseInt(params.userid, 10)
+                            };
+                            $mmContentLinksHelper.goInSite('site.grades', stateParams, siteId);
+                        }
+                    }];
+                }
+            }
+            return [];
+        };
+
+        return self;
+    };
+
     return self;
 });

www/core/components/contentlinks/services/helper.js

@@ -28,6 +28,31 @@ angular.module('mm.core.contentlinks')
 
     var self = {};
 
+    /**
+     * Goes to a certain state in a certain site. If the site is current site it will perform a regular navigation,
+     * otherwise it uses the 'redirect' state to change the site.
+     *
+     * @module mm.core
+     * @ngdoc method
+     * @name $mmUtil#goToSite
+     * @param  {String} stateName   Name of the state to go.
+     * @param  {Object} stateParams Params to send to the state.
+     * @param  {String} [siteId]    Site ID. If not defined, current site.
+     * @return {Promise}            Promise resolved when the state is changed.
+     */
+    self.goInSite = function(stateName, stateParams, siteId) {
+        siteId = siteId || $mmSite.getId();
+        if (siteId == $mmSite.getId()) {
+            return $state.go(stateName, stateParams);
+        } else {
+            return $state.go('redirect', {
+                siteid: siteId,
+                state: stateName,
+                params: stateParams
+            });
+        }
+    };
+
     /**
      * Go to the view to choose a site.
      *

www/core/lib/util.js

@@ -886,6 +886,9 @@ angular.module('mm.core')
          * 7.toFixed(2) -> 7.00
          * roundToDecimals(7, 2) -> 7
          *
+         * @module mm.core
+         * @ngdoc method
+         * @name $mmUtil#roundToDecimals
          * @param  {Float}  number       Float to round.
          * @param  {Number} [decimals=2] Number of decimals. By default, 2.
          * @return {Float}               Rounded number.
@@ -899,6 +902,24 @@ angular.module('mm.core')
             return Math.round(parseFloat(number) * multiplier) / multiplier;
         };
 
+        /**
+         * Extracts the parameters from a URL and stores them in an object.
+         *
+         * @module mm.core
+         * @ngdoc method
+         * @name $mmUtil#extractUrlParams
+         * @param  {String} url URL to treat.
+         * @return {Object}     Object with the params.
+         */
+        self.extractUrlParams = function(url) {
+            var regex = /[?&]+([^=&]+)=?([^&]*)?/gi,
+                params = {};
+            url.replace(regex, function(match, key, value) {
+                params[key] = value !== undefined ? value : '';
+            });
+            return params;
+        };
+
         return self;
     };
 });