Fixes #2337 - Show captions of image in media details (conflicts fixed) (#2933)

* Api call

* added captions

* final commit

* some minor changes

* sigular

* test for captions

* mock fetchCaptionbyFileName

* corrected method name

* * used ? instead of !! (unsafe call on nullable)
* updated unit test for fetchCaptionByFilename()

app/src/main/java/fr/free/nrw/commons/Media.java

@@ -47,6 +47,7 @@ public class Media implements Parcelable {
     protected String filename;
     protected String description; // monolingual description on input...
     protected String discussion;
+    protected String caption;
     protected long dataLength;
     protected Date dateCreated;
     protected @Nullable Date dateUploaded;
@@ -240,6 +241,22 @@ public class Media implements Parcelable {
         return imageUrl;
     }
 
+    /**
+     * Sets the Caption of the file.
+     * @param caption
+     */
+    public void setCaption(String caption) {
+        this.caption = caption;
+    }
+
+    /**
+     * Gets the file Caption as a string.
+     * @return file Caption as a string
+     */
+    public String getCaption() {
+        return caption;
+    }
+
     /**
      * Gets the name of the file.
      * @return file name as a string

app/src/main/java/fr/free/nrw/commons/MediaDataExtractor.java

@@ -1,5 +1,9 @@
 package fr.free.nrw.commons;
 
+import android.util.Log;
+
+import java.io.IOException;
+
 import javax.inject.Inject;
 import javax.inject.Singleton;
 
@@ -20,16 +24,18 @@ public class MediaDataExtractor {
     private final MediaWikiApi mediaWikiApi;
     private final OkHttpJsonApiClient okHttpJsonApiClient;
 
+
     @Inject
     public MediaDataExtractor(MediaWikiApi mwApi,
                               OkHttpJsonApiClient okHttpJsonApiClient) {
         this.okHttpJsonApiClient = okHttpJsonApiClient;
         this.mediaWikiApi = mwApi;
+
     }
 
     /**
      * Simplified method to extract all details required to show media details.
-     * It fetches media object, deletion status and talk page for the filename
+     * It fetches media object, deletion status, talk page and caption for the filename
      * @param filename for which the details are to be fetched
      * @return full Media object with all details including deletion status and talk page
      */
@@ -37,8 +43,11 @@ public class MediaDataExtractor {
         Single<Media> mediaSingle = getMediaFromFileName(filename);
         Single<Boolean> pageExistsSingle = mediaWikiApi.pageExists("Commons:Deletion_requests/" + filename);
         Single<String> discussionSingle = getDiscussion(filename);
-        return Single.zip(mediaSingle, pageExistsSingle, discussionSingle, (media, deletionStatus, discussion) -> {
+        Single<String> captionSingle = getCaption(filename);
+
+        return Single.zip(mediaSingle, pageExistsSingle, discussionSingle, captionSingle, (media, deletionStatus, discussion, caption) -> {
             media.setDiscussion(discussion);
+            media.setCaption(caption);
             if (deletionStatus) {
                 media.setRequestedDeletion();
             }
@@ -68,5 +77,19 @@ public class MediaDataExtractor {
                     Timber.e(throwable, "Error occurred while fetching discussion");
                     return "";
                 });
+
+    }
+
+    /**
+     * Fetch caption from the MediaWiki API
+     * @param filename the filename we will return the caption for
+     * @return a single with caption string (an empty string if no caption)
+     */
+    private Single<String> getCaption(String filename)  {
+        return mediaWikiApi.fetchCaptionByFilename(filename)
+                .onErrorReturn(throwable -> {
+                    Timber.e(throwable, "Error occurred while fetching caption");
+                    return "";
+                });
     }
 }

app/src/main/java/fr/free/nrw/commons/media/MediaDetailFragment.java

@@ -101,6 +101,8 @@ public class MediaDetailFragment extends CommonsDaggerSupportFragment {
     SimpleDraweeView image;
     @BindView(R.id.mediaDetailSpacer)
     MediaDetailSpacer spacer;
+    @BindView(R.id.mediaDetailCaption)
+    TextView mediaCaption;
     @BindView(R.id.mediaDetailTitle)
     TextView title;
     @BindView(R.id.mediaDetailDesc)
@@ -315,6 +317,7 @@ public class MediaDetailFragment extends CommonsDaggerSupportFragment {
         coordinates.setText(prettyCoordinates(media));
         uploadedDate.setText(prettyUploadedDate(media));
         mediaDiscussion.setText(prettyDiscussion(media));
+        mediaCaption.setText(prettyCaption(media));
 
         categoryNames.clear();
         categoryNames.addAll(media.getCategories());
@@ -516,6 +519,16 @@ public class MediaDetailFragment extends CommonsDaggerSupportFragment {
             return desc;
         }
     }
+
+    private String prettyCaption(Media media) {
+        String caption = media.getCaption().trim();
+        if (caption.equals("")) {
+            return getString(R.string.detail_caption_empty);
+        } else {
+            return caption;
+        }
+    }
+
     private String prettyDiscussion(Media media) {
         String disc = media.getDiscussion().trim();
         if (disc.equals("")) {

app/src/main/java/fr/free/nrw/commons/mwapi/ApacheHttpClientMediaWikiApi.java

@@ -3,6 +3,7 @@ package fr.free.nrw.commons.mwapi;
 import android.content.Context;
 import android.net.Uri;
 import android.text.TextUtils;
+import android.util.Log;
 
 import com.google.gson.Gson;
 
@@ -303,6 +304,26 @@ public class ApacheHttpClientMediaWikiApi implements MediaWikiApi {
                 .getString("/api/flow-parsoid-utils/@content"));
     }
 
+    /**
+     * fetches the Caption of the file with a given name.
+     * @param filename title of the file
+     * @return a single with media caption
+     */
+    @Override
+    public Single<String> fetchCaptionByFilename(String filename) {
+        return Single.fromCallable(() -> {
+            CustomApiResult apiResult = api.action("wbgetentities")
+                    .param("sites", "commonswiki")
+                    .param("titles", filename)
+                    .param("props", "labels")
+                    .param("format", "xml")
+                    .param("languages", Locale.getDefault().getLanguage())
+                    .param("languagefallback", "1")
+                    .get();
+            return apiResult.getString("/api/entities/entity/labels/label/@value");
+        });
+    }
+
     @Override
     @NonNull
     public Single<MediaResult> fetchMediaByFilename(String filename) {

app/src/main/java/fr/free/nrw/commons/mwapi/MediaWikiApi.java

@@ -66,6 +66,8 @@ public interface MediaWikiApi {
 
     Single<String> parseWikicode(String source);
 
+    Single<String> fetchCaptionByFilename(String filename);
+
     @NonNull
     Single<MediaResult> fetchMediaByFilename(String filename);