MOBILE-2325 badges: Add link handlers

src/addon/badges/badges.module.ts

@@ -15,6 +15,9 @@
 import { NgModule } from '@angular/core';
 import { AddonBadgesProvider } from './providers/badges';
 import { AddonBadgesUserHandler } from './providers/user-handler';
+import { AddonBadgesMyBadgesLinkHandler } from './providers/mybadges-link-handler';
+import { AddonBadgesBadgeLinkHandler } from './providers/badge-link-handler';
+import { CoreContentLinksDelegate } from '../../core/contentlinks/providers/delegate';
 import { CoreUserDelegate } from '../../core/user/providers/user-delegate';
 
 @NgModule({
@@ -24,11 +27,18 @@ import { CoreUserDelegate } from '../../core/user/providers/user-delegate';
     ],
     providers: [
         AddonBadgesProvider,
-        AddonBadgesUserHandler
+        AddonBadgesUserHandler,
+        AddonBadgesMyBadgesLinkHandler,
+        AddonBadgesBadgeLinkHandler
     ]
 })
 export class AddonBadgesModule {
-    constructor(userDelegate: CoreUserDelegate, userHandler: AddonBadgesUserHandler) {
+    constructor(userDelegate: CoreUserDelegate, userHandler: AddonBadgesUserHandler,
+        contentLinksDelegate: CoreContentLinksDelegate, myBadgesLinkHandler: AddonBadgesMyBadgesLinkHandler,
+        badgeLinkHandler: AddonBadgesBadgeLinkHandler) {
+
         userDelegate.registerHandler(userHandler);
+        contentLinksDelegate.registerHandler(myBadgesLinkHandler);
+        contentLinksDelegate.registerHandler(badgeLinkHandler);
     }
 }

src/addon/badges/providers/badge-link-handler.ts

@@ -0,0 +1,67 @@
+// (C) Copyright 2015 Martin Dougiamas
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import { Injectable } from '@angular/core';
+import { CoreContentLinksHandlerBase } from '../../../core/contentlinks/classes/base-handler';
+import { CoreContentLinksAction } from '../../../core/contentlinks/providers/delegate';
+import { CoreLoginHelperProvider } from '../../../core/login/providers/helper';
+import { AddonBadgesProvider } from './badges';
+
+/**
+ * Handler to treat links to user participants page.
+ */
+@Injectable()
+export class AddonBadgesBadgeLinkHandler extends CoreContentLinksHandlerBase {
+    name = 'AddonBadgesBadgeLinkHandler';
+    pattern = /\/badges\/badge\.php.*([\?\&]hash=)/;
+
+    constructor(private badgesProvider: AddonBadgesProvider, private loginHelper: CoreLoginHelperProvider) {
+        super();
+    }
+
+    /**
+     * Get the list of actions for a link (url).
+     *
+     * @param {string[]} siteIds List of sites the URL belongs to.
+     * @param {string} url The URL to treat.
+     * @param {any} params The params of the URL. E.g. 'mysite.com?id=1' -> {id: 1}
+     * @param {number} [courseId] Course ID related to the URL. Optional but recommended.
+     * @return {CoreContentLinksAction[]|Promise<CoreContentLinksAction[]>} List of (or promise resolved with list of) actions.
+     */
+    getActions(siteIds: string[], url: string, params: any, courseId?: number):
+            CoreContentLinksAction[] | Promise<CoreContentLinksAction[]> {
+
+        return [{
+            action: (siteId, navCtrl?): void => {
+                // Always use redirect to make it the new history root (to avoid "loops" in history).
+                this.loginHelper.redirect('AddonBadgesIssuedBadgePage', {courseId: 0, badgeHash: params.hash}, siteId);
+            }
+        }];
+    }
+
+    /**
+     * Check if the handler is enabled for a certain site (site + user) and a URL.
+     * If not defined, defaults to true.
+     *
+     * @param {string} siteId The site ID.
+     * @param {string} url The URL to treat.
+     * @param {any} params The params of the URL. E.g. 'mysite.com?id=1' -> {id: 1}
+     * @param {number} [courseId] Course ID related to the URL. Optional but recommended.
+     * @return {boolean|Promise<boolean>} Whether the handler is enabled for the URL and site.
+     */
+    isEnabled(siteId: string, url: string, params: any, courseId?: number): boolean | Promise<boolean> {
+
+        return this.badgesProvider.isPluginEnabled(siteId);
+    }
+}

src/addon/badges/providers/mybadges-link-handler.ts

@@ -0,0 +1,68 @@
+// (C) Copyright 2015 Martin Dougiamas
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import { Injectable } from '@angular/core';
+import { CoreContentLinksHandlerBase } from '../../../core/contentlinks/classes/base-handler';
+import { CoreContentLinksAction } from '../../../core/contentlinks/providers/delegate';
+import { CoreLoginHelperProvider } from '../../../core/login/providers/helper';
+import { AddonBadgesProvider } from './badges';
+
+/**
+ * Handler to treat links to user participants page.
+ */
+@Injectable()
+export class AddonBadgesMyBadgesLinkHandler extends CoreContentLinksHandlerBase {
+    name = 'AddonBadgesMyBadgesLinkHandler';
+    featureName = '$mmUserDelegate_mmaBadges';
+    pattern = /\/badges\/mybadges\.php/;
+
+    constructor(private badgesProvider: AddonBadgesProvider, private loginHelper: CoreLoginHelperProvider) {
+        super();
+    }
+
+    /**
+     * Get the list of actions for a link (url).
+     *
+     * @param {string[]} siteIds List of sites the URL belongs to.
+     * @param {string} url The URL to treat.
+     * @param {any} params The params of the URL. E.g. 'mysite.com?id=1' -> {id: 1}
+     * @param {number} [courseId] Course ID related to the URL. Optional but recommended.
+     * @return {CoreContentLinksAction[]|Promise<CoreContentLinksAction[]>} List of (or promise resolved with list of) actions.
+     */
+    getActions(siteIds: string[], url: string, params: any, courseId?: number):
+            CoreContentLinksAction[] | Promise<CoreContentLinksAction[]> {
+
+        return [{
+            action: (siteId, navCtrl?): void => {
+                // Always use redirect to make it the new history root (to avoid "loops" in history).
+                this.loginHelper.redirect('AddonBadgesUserBadgesPage', {}, siteId);
+            }
+        }];
+    }
+
+    /**
+     * Check if the handler is enabled for a certain site (site + user) and a URL.
+     * If not defined, defaults to true.
+     *
+     * @param {string} siteId The site ID.
+     * @param {string} url The URL to treat.
+     * @param {any} params The params of the URL. E.g. 'mysite.com?id=1' -> {id: 1}
+     * @param {number} [courseId] Course ID related to the URL. Optional but recommended.
+     * @return {boolean|Promise<boolean>} Whether the handler is enabled for the URL and site.
+     */
+    isEnabled(siteId: string, url: string, params: any, courseId?: number): boolean | Promise<boolean> {
+
+        return this.badgesProvider.isPluginEnabled(siteId);
+    }
+}