Merge pull request #1861 from albertgasset/MOBILE-2978

MOBILE-2978 forum: Private reply

scripts/langindex.json

@@ -499,7 +499,9 @@
   "addon.mod_forum.modulenameplural": "forum",
   "addon.mod_forum.numdiscussions": "local_moodlemobileapp",
   "addon.mod_forum.numreplies": "local_moodlemobileapp",
+  "addon.mod_forum.postisprivatereply": "forum",
   "addon.mod_forum.posttoforum": "forum",
+  "addon.mod_forum.privatereply": "forum",
   "addon.mod_forum.re": "forum",
   "addon.mod_forum.refreshdiscussions": "local_moodlemobileapp",
   "addon.mod_forum.refreshposts": "local_moodlemobileapp",

src/addon/mod/forum/components/post/addon-mod-forum-post.html

@@ -13,6 +13,9 @@
     </ion-item>
 </ion-card-header>
 <ion-card-content padding-top>
+    <div padding-bottom *ngIf="post.isprivatereply">
+        <ion-note>{{ 'addon.mod_forum.postisprivatereply' | translate }}</ion-note>
+    </div>
     <core-format-text [component]="component" [componentId]="componentId" [text]="post.message"></core-format-text>
     <div no-lines>
         <ng-container *ngFor="let attachment of post.attachments">
@@ -25,7 +28,7 @@
 </ion-card-content>
 <core-rating-rate *ngIf="forum && ratingInfo" [ratingInfo]="ratingInfo" contextLevel="module" [instanceId]="componentId" [itemId]="post.id" [itemSetId]="discussionId" [courseId]="courseId" [aggregateMethod]="forum.assessed" [scaleId]="forum.scale" [userId]="post.userid" (onUpdate)="ratingUpdated()"></core-rating-rate>
 <core-rating-aggregate *ngIf="forum && ratingInfo" [ratingInfo]="ratingInfo" contextLevel="module" [instanceId]="componentId" [itemId]="post.id" [courseId]="courseId" [aggregateMethod]="forum.assessed" [scaleId]="forum.scale"></core-rating-aggregate>
-<ion-item no-padding text-end *ngIf="post.id && post.canreply" class="addon-forum-reply-button">
+<ion-item no-padding text-end *ngIf="post.id && post.canreply && !post.isprivatereply" class="addon-forum-reply-button">
     <button ion-button icon-left clear small (click)="showReply()" [attr.aria-controls]="'addon-forum-reply-edit-form-' + uniqueId" [attr.aria-expanded]="replyData.replyingTo === post.id">
         <ion-icon name="undo"></ion-icon> {{ 'addon.mod_forum.reply' | translate }}
     </button>
@@ -45,6 +48,10 @@
         <core-rich-text-editor item-content [control]="messageControl" (contentChanged)="onMessageChange($event)" [placeholder]="'addon.mod_forum.message' | translate" [name]="'mod_forum_reply_' + post.id" [component]="component" [componentId]="componentId"></core-rich-text-editor>
     </ion-item>
     <core-attachments *ngIf="forum.id && forum.maxattachments > 0" [files]="replyData.files" [maxSize]="forum.maxbytes" [maxSubmissions]="forum.maxattachments" [component]="component" [componentId]="forum.cmid" [allowOffline]="true"></core-attachments>
+    <ion-item text-wrap *ngIf="accessInfo.canpostprivatereply">
+        <ion-label>{{ 'addon.mod_forum.privatereply' | translate }}</ion-label>
+        <ion-checkbox item-end [(ngModel)]="replyData.isprivatereply"></ion-checkbox>
+    </ion-item>
     <ion-grid>
         <ion-row>
             <ion-col>

src/addon/mod/forum/components/post/post.ts

@@ -44,6 +44,7 @@ export class AddonModForumPostComponent implements OnInit, OnDestroy {
     @Input() originalData: any; // Object with the original post data. Usually shared between posts.
     @Input() trackPosts: boolean; // True if post is being tracked.
     @Input() forum: any; // The forum the post belongs to. Required for attachments and offline posts.
+    @Input() accessInfo: any; // Forum access information.
     @Input() defaultSubject: string; // Default subject to set to new posts.
     @Input() ratingInfo?: CoreRatingInfo; // Rating info item.
     @Output() onPostChange: EventEmitter<void>; // Event emitted when a reply is posted or modified.
@@ -95,9 +96,11 @@ export class AddonModForumPostComponent implements OnInit, OnDestroy {
      * @param {boolean} [isEditing] True it's an offline reply beeing edited, false otherwise.
      * @param {string} [subject] Subject of the reply.
      * @param {string} [message] Message of the reply.
+     * @param {boolean} [isPrivate] True if it's private reply.
      * @param {any[]} [files] Reply attachments.
      */
-    protected setReplyData(replyingTo?: number, isEditing?: boolean, subject?: string, message?: string, files?: any[]): void {
+    protected setReplyData(replyingTo?: number, isEditing?: boolean, subject?: string, message?: string, files?: any[],
+            isPrivate?: boolean): void {
         // Delete the local files from the tmp folder if any.
         this.uploaderProvider.clearTmpFiles(this.replyData.files);
 
@@ -106,6 +109,7 @@ export class AddonModForumPostComponent implements OnInit, OnDestroy {
         this.replyData.subject = subject || this.defaultSubject || '';
         this.replyData.message = message || null;
         this.replyData.files = files || [];
+        this.replyData.isprivatereply = !!isPrivate;
 
         // Update rich text editor.
         this.messageControl.setValue(this.replyData.message);
@@ -114,6 +118,7 @@ export class AddonModForumPostComponent implements OnInit, OnDestroy {
         this.originalData.subject = this.replyData.subject;
         this.originalData.message = this.replyData.message;
         this.originalData.files = this.replyData.files.slice();
+        this.originalData.isprivatereply = this.replyData.isprivatereply;
     }
 
     /**
@@ -163,7 +168,8 @@ export class AddonModForumPostComponent implements OnInit, OnDestroy {
             this.syncId = this.forumSync.getDiscussionSyncId(this.discussionId);
             this.syncProvider.blockOperation(AddonModForumProvider.COMPONENT, this.syncId);
 
-            this.setReplyData(this.post.parent, true, this.post.subject, this.post.message, this.post.attachments);
+            this.setReplyData(this.post.parent, true, this.post.subject, this.post.message, this.post.attachments,
+                    this.post.isprivatereply);
         }).catch(() => {
             // Cancelled.
         });
@@ -206,6 +212,11 @@ export class AddonModForumPostComponent implements OnInit, OnDestroy {
         // Add some HTML to the message if needed.
         message = this.textUtils.formatHtmlLines(message);
 
+        // Set private option if checked.
+        if (this.replyData.isprivatereply) {
+            options.private = true;
+        }
+
         // Upload attachments first if any.
         if (files.length) {
             promise = this.forumHelper.uploadOrStoreReplyFiles(this.forum.id, replyingTo, files, false).catch((error) => {

src/addon/mod/forum/lang/en.json

@@ -24,7 +24,9 @@
     "modulenameplural": "Forums",
     "numdiscussions": "{{numdiscussions}} discussions",
     "numreplies": "{{numreplies}} replies",
+    "postisprivatereply": "This post was made privately and is not visible to all users.",
     "posttoforum": "Post to forum",
+    "privatereply": "Reply privately",
     "re": "Re:",
     "refreshdiscussions": "Refresh discussions",
     "refreshposts": "Refresh posts",

src/addon/mod/forum/pages/discussion/discussion.html

@@ -31,13 +31,13 @@
         </ion-card>
 
         <ion-card *ngIf="discussion" margin-bottom class="highlight">
-            <addon-mod-forum-post [post]="discussion" [courseId]="courseId" [discussionId]="discussionId" [component]="component" [componentId]="cmId" [replyData]="replyData" [originalData]="originalData" [defaultSubject]="defaultSubject" [forum]="forum" [trackPosts]="trackPosts" [ratingInfo]="ratingInfo" (onPostChange)="postListChanged()"></addon-mod-forum-post>
+            <addon-mod-forum-post [post]="discussion" [courseId]="courseId" [discussionId]="discussionId" [component]="component" [componentId]="cmId" [replyData]="replyData" [originalData]="originalData" [defaultSubject]="defaultSubject" [forum]="forum" [accessInfo]="accessInfo" [trackPosts]="trackPosts" [ratingInfo]="ratingInfo" (onPostChange)="postListChanged()"></addon-mod-forum-post>
         </ion-card>
 
         <ion-card *ngIf="sort != 'nested'">
             <ng-container *ngFor="let post of posts; first as first">
                 <ion-item-divider *ngIf="!first"></ion-item-divider>
-                <addon-mod-forum-post [post]="post" [courseId]="courseId" [discussionId]="discussionId" [component]="component" [componentId]="cmId" [replyData]="replyData" [originalData]="originalData" [defaultSubject]="defaultSubject" [forum]="forum" [trackPosts]="trackPosts" [ratingInfo]="ratingInfo" (onPostChange)="postListChanged()"></addon-mod-forum-post>
+                <addon-mod-forum-post [post]="post" [courseId]="courseId" [discussionId]="discussionId" [component]="component" [componentId]="cmId" [replyData]="replyData" [originalData]="originalData" [defaultSubject]="defaultSubject" [forum]="forum" [accessInfo]="accessInfo" [trackPosts]="trackPosts" [ratingInfo]="ratingInfo" (onPostChange)="postListChanged()"></addon-mod-forum-post>
             </ng-container>
         </ion-card>
 
@@ -49,7 +49,7 @@
 
         <ng-template #nestedPosts let-post="post">
             <ion-card>
-                <addon-mod-forum-post [post]="post" [courseId]="courseId" [discussionId]="discussionId" [component]="component" [componentId]="cmId" [replyData]="replyData" [originalData]="originalData" [defaultSubject]="defaultSubject" [forum]="forum" [trackPosts]="trackPosts" [ratingInfo]="ratingInfo" (onPostChange)="postListChanged()"></addon-mod-forum-post>
+                <addon-mod-forum-post [post]="post" [courseId]="courseId" [discussionId]="discussionId" [component]="component" [componentId]="cmId" [replyData]="replyData" [originalData]="originalData" [defaultSubject]="defaultSubject" [forum]="forum" [accessInfo]="accessInfo" [trackPosts]="trackPosts" [ratingInfo]="ratingInfo" (onPostChange)="postListChanged()"></addon-mod-forum-post>
             </ion-card>
             <div padding-left *ngIf="post.children.length && post.children[0].subject">
                 <ng-container *ngFor="let child of post.children">

src/addon/mod/forum/pages/discussion/discussion.ts

@@ -47,6 +47,7 @@ export class AddonModForumDiscussionPage implements OnDestroy {
     courseId: number;
     discussionId: number;
     forum: any;
+    accessInfo: any;
     discussion: any;
     posts: any[];
     discussionLoaded = false;
@@ -63,11 +64,13 @@ export class AddonModForumDiscussionPage implements OnDestroy {
         subject: '',
         message: null, // Null means empty or just white space.
         files: [],
+        isprivatereply: false,
     };
     originalData = {
         subject: null, // Null means original data is not set.
         message: null, // Null means empty or just white space.
         files: [],
+        isprivatereply: false,
     };
     refreshIcon = 'spinner';
     syncIcon = 'spinner';
@@ -318,9 +321,14 @@ export class AddonModForumDiscussionPage implements OnDestroy {
                 this.forumId = forum.id;
                 this.cmId = forum.cmid;
                 this.forum = forum;
+            }).then(() => {
+                return this.forumProvider.getAccessInformation(this.forum.id).then((accessInfo) => {
+                    this.accessInfo = accessInfo;
+                });
             }).catch(() => {
                 // Ignore errors.
                 this.forum = {};
+                this.accessInfo = {};
             });
         }).then(() => {
             return this.ratingOffline.hasRatings('mod_forum', 'post', 'module', this.cmId, this.discussionId).then((hasRatings) => {
@@ -420,7 +428,12 @@ export class AddonModForumDiscussionPage implements OnDestroy {
         this.refreshIcon = 'spinner';
         this.syncIcon = 'spinner';
 
-        return this.forumProvider.invalidateDiscussionPosts(this.discussionId).catch(() => {
+        const promises = [
+            this.forumProvider.invalidateDiscussionPosts(this.discussionId),
+            this.forumProvider.invalidateAccessInformation(this.forumId)
+        ];
+
+        return this.utils.allPromises(promises).catch(() => {
             // Ignore errors.
         }).then(() => {
             return this.fetchPosts(sync, showErrors);

src/addon/mod/forum/providers/forum.ts

@@ -79,6 +79,16 @@ export class AddonModForumProvider {
         return this.ROOT_CACHE_KEY + 'forum:' + courseId;
     }
 
+    /**
+     * Get cache key for forum access information WS calls.
+     *
+     * @param  {number} forumId Forum ID.
+     * @return {string}         Cache key.
+     */
+    protected getAccessInformationCacheKey(forumId: number): string {
+        return this.ROOT_CACHE_KEY + 'accessInformation:' + forumId;
+    }
+
     /**
      * Get cache key for forum discussion posts WS calls.
      *
@@ -365,6 +375,34 @@ export class AddonModForumProvider {
         });
     }
 
+    /**
+     * Get access information for a given forum.
+     *
+     * @param  {number}  forumId      Forum ID.
+     * @param  {boolean} [forceCache] True to always get the value from cache. false otherwise.
+     * @param  {string}  [siteId]     Site ID. If not defined, current site.
+     * @return {Promise<any>} Object with access information.
+     * @since 3.7
+     */
+    getAccessInformation(forumId: number, forceCache?: boolean, siteId?: string): Promise<any> {
+        return this.sitesProvider.getSite(siteId).then((site) => {
+            if (!site.wsAvailable('mod_forum_get_forum_access_information')) {
+                // Access information not available for 3.6 or older sites.
+                return Promise.resolve({});
+            }
+
+            const params = {
+                forumid: forumId
+            };
+            const preSets = {
+                cacheKey: this.getAccessInformationCacheKey(forumId),
+                omitExpires: forceCache
+            };
+
+            return site.read('mod_forum_get_forum_access_information', params, preSets);
+        });
+    }
+
     /**
      * Get forum discussion posts.
      *
@@ -537,6 +575,7 @@ export class AddonModForumProvider {
                 promises.push(this.invalidateForumData(courseId));
                 promises.push(this.invalidateDiscussionsList(forum.id));
                 promises.push(this.invalidateCanAddDiscussion(forum.id));
+                promises.push(this.invalidateAccessInformation(forum.id));
 
                 response.discussions.forEach((discussion) => {
                     promises.push(this.invalidateDiscussionPosts(discussion.discussion));
@@ -547,6 +586,19 @@ export class AddonModForumProvider {
         });
     }
 
+    /**
+     * Invalidates access information.
+     *
+     * @param  {number} forumId  Forum ID.
+     * @param  {string} [siteId] Site ID. If not defined, current site.
+     * @return {Promise<any>}    Promise resolved when the data is invalidated.
+     */
+    invalidateAccessInformation(forumId: number, siteId?: string): Promise<any> {
+        return this.sitesProvider.getSite(siteId).then((site) => {
+            return site.invalidateWsCacheForKey(this.getAccessInformationCacheKey(forumId));
+        });
+    }
+
     /**
      * Invalidates forum discussion posts.
      *

src/addon/mod/forum/providers/helper.ts

@@ -54,7 +54,8 @@ export class AddonModForumHelperProvider {
                 postread: false,
                 subject: offlineReply.subject,
                 totalscore: 0,
-                userid: offlineReply.userid
+                userid: offlineReply.userid,
+                isprivatereply: offlineReply.options && offlineReply.options.private
             },
             promises = [];
 
@@ -164,6 +165,10 @@ export class AddonModForumHelperProvider {
             return true;
         }
 
+        if (post.isprivatereply != original.isprivatereply) {
+            return true;
+        }
+
         return this.uploaderProvider.areFileListDifferent(post.files, original.files);
     }
 

src/addon/mod/forum/providers/prefetch-handler.ts

@@ -185,8 +185,10 @@ export class AddonModForumPrefetchHandler extends CoreCourseActivityPrefetchHand
     protected prefetchForum(module: any, courseId: number, single: boolean, siteId: string): Promise<any> {
         // Get the forum data.
         return this.forumProvider.getForum(courseId, module.id).then((forum) => {
+            const promises = [];
+
             // Prefetch the posts.
-            return this.getPostsForPrefetch(forum).then((posts) => {
+            promises.push(this.getPostsForPrefetch(forum).then((posts) => {
                 const promises = [];
 
                 // Prefetch user profiles.
@@ -203,7 +205,12 @@ export class AddonModForumPrefetchHandler extends CoreCourseActivityPrefetchHand
                 promises.push(this.prefetchGroupsInfo(forum, courseId, forum.cancreatediscussions));
 
                 return Promise.all(promises);
-            });
+            }));
+
+            // Prefetch access information.
+            promises.push(this.forumProvider.getAccessInformation(forum.id));
+
+            return Promise.all(promises);
         });
     }
 

src/assets/lang/en.json

@@ -499,7 +499,9 @@
     "addon.mod_forum.modulenameplural": "Forums",
     "addon.mod_forum.numdiscussions": "{{numdiscussions}} discussions",
     "addon.mod_forum.numreplies": "{{numreplies}} replies",
+    "addon.mod_forum.postisprivatereply": "This post was made privately and is not visible to all users.",
     "addon.mod_forum.posttoforum": "Post to forum",
+    "addon.mod_forum.privatereply": "Reply privately",
     "addon.mod_forum.re": "Re:",
     "addon.mod_forum.refreshdiscussions": "Refresh discussions",
     "addon.mod_forum.refreshposts": "Refresh posts",