add comments (#237)

* activities package

* activities package

* activities package

* activities package

* activities package

* comments until call

* comments

* add comments to wallet package

* comments

* comments

* comments

* add comments to wallet package

Co-authored-by: Paul Nadal <[email protected]>

Author: jules20022000

.gitignore

@@ -14,4 +14,4 @@ firestore.rules
 firestore.indexes.json
 firebase.json
 storage.rules
-
+upload-keystore.jks

app/src/main/java/ch/epfl/sweng/hostme/account/Profile.java

@@ -9,7 +9,6 @@ public class Profile {
     private String school;
 
     public Profile() {
-
     }
 
     public Profile(String firstName, String lastName, String email, String gender, String school) {
@@ -21,38 +20,74 @@ public Profile(String firstName, String lastName, String email, String gender, S
     }
 
 
+    /**
+     * get the first name of the user
+     * @return first name
+     */
     public String getFirstName() {
         return firstName;
     }
 
+    /**
+     * set the first name of the user
+     * @param firstName to be set
+     */
     public void setFirstName(String firstName) {
         this.firstName = firstName;
     }
 
+    /**
+     * get the last name of the user
+     * @return last name
+     */
     public String getLastName() {
         return lastName;
     }
 
+    /**
+     * set the last name of the user
+     * @param lastName to be set
+     */
     public void setLastName(String lastName) {
         this.lastName = lastName;
     }
 
+    /**
+     * get the gender of the user
+     * @return gender
+     */
     public String getGender() {
         return gender;
     }
 
+    /**
+     * set the gender of the user
+     * @param gender to be set
+     */
     public void setGender(String gender) {
         this.gender = gender;
     }
 
+    /**
+     * get the email of the user
+     * @return email
+     */
     public String getEmail() {
         return email;
     }
 
+    /**
+     * set the email of the user
+     * @param email to be set
+     */
     public void setEmail(String email) {
         this.email = email;
     }
 
+    /**
+     * get the school of the user
+     * @return school
+     */
     public String getSchool() {
         return school;
     }

app/src/main/java/ch/epfl/sweng/hostme/activities/CallActivity.java

@@ -98,10 +98,17 @@ protected void onCreate(@Nullable Bundle savedInstanceState) {
         checkPermissionsAndInitEngine();
     }
 
+    /**
+     * switch the front or back camera
+     */
     private void onSwitchCamera() {
         this.mRtcEngine.switchCamera();
     }
 
+    /**
+     * Check that the permissions are enabled otherwise ask to the user
+     * Init agora if permissions are enabled
+     */
     private void checkPermissionsAndInitEngine() {
         ArrayList<String> permissions = new ArrayList<>();
         permissions.add(Manifest.permission.RECORD_AUDIO);
@@ -119,13 +126,20 @@ private void checkPermissionsAndInitEngine() {
         }
     }
 
+    /**
+     * Send a notification to the called user and update the database such that
+     * the callee has access to the room name
+     */
     private void sendNotification() {
         FcmNotificationsSender sender = new FcmNotificationsSender(this.user.getToken(), NOTIFICATION_TITLE,
                 NOTIFICATION_BODY, getApplicationContext(), CallActivity.this);
         sender.sendNotifications();
         reference.document(this.user.getId()).update(ROOM_NAME, currUserID);
     }
 
+    /**
+     * Join the channel corresponding to the room name in the db
+     */
     private void joinChannel() {
         reference.document(Auth.getUid()).get().addOnSuccessListener(res -> {
             if (res.exists()) {
@@ -151,6 +165,10 @@ public void onRequestPermissionsResult(int requestCode, @NonNull String[] permis
         }
     }
 
+    /**
+     * Create the agora engine and
+     * If the user is the caller join the channel and send notif otherwise just join the channel
+     */
     private void initAgoraEngine() {
         try {
             this.mRtcEngine = RtcEngine.create(getApplicationContext(), getString(R.string.agora_app_id), mRtcEventHandler);
@@ -165,6 +183,9 @@ private void initAgoraEngine() {
         }
     }
 
+    /**
+     * Initialize basics of the RTC engine (video, audio...)
+     */
     private void setupSession() {
         this.mRtcEngine.setChannelProfile(io.agora.rtc.Constants.CHANNEL_PROFILE_COMMUNICATION);
         this.mRtcEngine.enableVideo();
@@ -174,6 +195,10 @@ private void setupSession() {
                 VideoEncoderConfiguration.ORIENTATION_MODE.ORIENTATION_MODE_FIXED_PORTRAIT));
     }
 
+    /**
+     * Set up the video of the local user and all the layout that
+     * follows from that
+     */
     private void setupLocalVideoFeed() {
         this.mRtcEngine.setChannelProfile(CHANNEL_PROFILE_LIVE_BROADCASTING);
         this.mRtcEngine.enableVideo();
@@ -190,6 +215,12 @@ private void setupLocalVideoFeed() {
         this.mRtcEngine.setupLocalVideo(new VideoCanvas(videoSurface, VideoCanvas.RENDER_MODE_FIT, 0));
     }
 
+    /**
+     * Set up the video of the remote user and all the layout that
+     * follows from that
+     *
+     * @param uid of the user who joined the call
+     */
     private void setupRemoteVideoStream(int uid) {
         FrameLayout videoContainer = findViewById(R.id.bg_video_container);
         SurfaceView videoSurface = RtcEngine.CreateRendererView(getBaseContext());
@@ -198,26 +229,45 @@ private void setupRemoteVideoStream(int uid) {
         this.mRtcEngine.setRemoteSubscribeFallbackOption(io.agora.rtc.Constants.STREAM_FALLBACK_OPTION_AUDIO_ONLY);
     }
 
+    /**
+     * CHange the layout if the remote user change his camera from selfie to field
+     * or from field to selfie
+     *
+     * @param state selfie or field mode
+     */
     private void onRemoteUserVideoToggle(int state) {
         FrameLayout videoContainer = findViewById(R.id.bg_video_container);
         SurfaceView videoSurface = (SurfaceView) videoContainer.getChildAt(0);
         videoSurface.setVisibility(state == 0 ? View.GONE : View.VISIBLE);
     }
 
+    /**
+     * init token, set room name and local video when user joined
+     * channel
+     */
     private void onJoinChannelClicked() {
         String channelName = currUserID;
         initToken(channelName);
         this.mRtcEngine.joinChannel(this.result, channelName, null, 0);
         setupLocalVideoFeed();
     }
 
+    /**
+     * Init the token for the channel with the corresponding channel name
+     *
+     * @param channelName of the caller (his user id)
+     */
     private void initToken(String channelName) {
         RtcTokenBuilder token = new RtcTokenBuilder();
         int timestamp = (int) (System.currentTimeMillis() / 1000 + expirationTimeInSeconds);
         this.result = token.buildTokenWithUid(getString(R.string.agora_app_id), getString(R.string.agora_certificate),
                 channelName, 0, RtcTokenBuilder.Role.Role_Publisher, timestamp);
     }
 
+    /**
+     * leave the channel with the RTC engine, remove video, update the room name
+     * to null in the database and return to the menu
+     */
     private void onLeaveChannelClicked() {
         this.mRtcEngine.leaveChannel();
         removeVideo(R.id.floating_video_container);
@@ -229,18 +279,35 @@ private void onLeaveChannelClicked() {
         finish();
     }
 
+    /**
+     * Remove the video
+     *
+     * @param containerID corresponding id the container
+     */
     private void removeVideo(int containerID) {
         FrameLayout videoContainer = findViewById(containerID);
         videoContainer.setVisibility(View.GONE);
         videoContainer.removeAllViews();
     }
 
+    /**
+     * Mute the local audio stream when the local user clicks on the
+     * microphone button
+     *
+     * @param view id of the button element
+     */
     private void onAudioMuteClicked(View view) {
         ImageView btn = (ImageView) view;
         changeButtonState(btn, R.drawable.btn_mute, R.drawable.btn_unmute);
         this.mRtcEngine.muteLocalAudioStream(btn.isSelected());
     }
 
+    /**
+     * Stop the local video stream when the local user clicks on the
+     * microphone button and adapt the corresponding layout
+     *
+     * @param view id of the video element
+     */
     private void onVideoMuteClicked(View view) {
         ImageView btn = (ImageView) view;
         changeButtonState(btn, R.drawable.video_toggle_active_btn, R.drawable.video_toggle_btn);
@@ -252,6 +319,14 @@ private void onVideoMuteClicked(View view) {
         videoSurface.setVisibility(btn.isSelected() ? View.GONE : View.VISIBLE);
     }
 
+    /**
+     * CHange the button state depending on the previous buttton
+     * state
+     *
+     * @param btn      correspond ID of the button
+     * @param active   drawable of the active button
+     * @param inactive drawable of the inactive button
+     */
     private void changeButtonState(ImageView btn, int active, int inactive) {
         if (btn.isSelected()) {
             btn.setSelected(false);

app/src/main/java/ch/epfl/sweng/hostme/activities/ChangePwdAccountActivity.java

@@ -18,7 +18,6 @@
 import ch.epfl.sweng.hostme.database.Auth;
 
 public class ChangePwdAccountActivity extends AppCompatActivity {
-
     private static final String MODIFICATION_SUCCEED = "Password successfully modified";
     private static final String MODIFICATION_FAILED = "Password modification failed";
     private static final String AUTH_FAILED = "Authentication failed";
@@ -58,8 +57,9 @@ private void changePasswordDB(String oldPassword, String newPassword) {
         AuthCredential credential = EmailAuthProvider.getCredential(Objects.requireNonNull(email), oldPassword);
 
         user.reauthenticate(credential).addOnSuccessListener(result -> user.updatePassword(newPassword).addOnSuccessListener(result2 -> {
-            Toast.makeText(this, MODIFICATION_SUCCEED, Toast.LENGTH_SHORT).show();
-            this.getFragmentManager().popBackStack();
-        }).addOnFailureListener(error2 -> Toast.makeText(this, MODIFICATION_FAILED, Toast.LENGTH_SHORT).show())).addOnFailureListener(error -> Toast.makeText(this, AUTH_FAILED, Toast.LENGTH_SHORT).show());
+                    Toast.makeText(this, MODIFICATION_SUCCEED, Toast.LENGTH_SHORT).show();
+                    this.getFragmentManager().popBackStack();
+                }).addOnFailureListener(error2 -> Toast.makeText(this, MODIFICATION_FAILED, Toast.LENGTH_SHORT).show()))
+                .addOnFailureListener(error -> Toast.makeText(this, AUTH_FAILED, Toast.LENGTH_SHORT).show());
     }
 }

app/src/main/java/ch/epfl/sweng/hostme/activities/ChangePwdHomeActivity.java

@@ -49,7 +49,7 @@ protected void onCreate(Bundle savedInstanceState) {
     }
 
     /**
-     * Send email to change password
+     * Send email to the user to change password
      */
     private void sendMail(String mailText) {
         Auth.resetEmail(mailText)