commons-app#3780 Create media using a combination of Entities & MwQueryResult (commons-app#3786)

* commons-app#3468 Switch from RvRenderer to AdapterDelegates - replace SearchDepictionsRenderer

* commons-app#3468 Switch from RvRenderer to AdapterDelegates - replace UploadCategoryDepictionsRenderer

* commons-app#3468 Switch from RvRenderer to AdapterDelegates - update BaseAdapter to be easier to use

* commons-app#3468 Switch from RvRenderer to AdapterDelegates - replace SearchImagesRenderer

* commons-app#3468 Switch from RvRenderer to AdapterDelegates - replace SearchCategoriesRenderer

* commons-app#3468 Switch from RvRenderer to AdapterDelegates - replace NotificationRenderer

* commons-app#3468 Switch from RvRenderer to AdapterDelegates - replace UploadDepictsRenderer

* commons-app#3468 Switch from RvRenderer to AdapterDelegates - replace PlaceRenderer

* commons-app#3756 Convert SearchDepictionsFragment to use Pagination - convert SearchDepictionsFragment

* commons-app#3756 Convert SearchDepictionsFragment to use Pagination - fix presenter unit tests now that view is not nullable - fix Category prefix imports

* commons-app#3756 Convert SearchDepictionsFragment to use Pagination - test DataSource related classes

* commons-app#3756 Convert SearchDepictionsFragment to use Pagination - reset rx scheduler - ignore failing test

* commons-app#3760 Convert SearchCategoriesFragment to use Pagination - extract functionality of pagination to base classes - add category pagination

* commons-app#3772 Convert SearchImagesFragment to use Pagination  - convert SearchImagesFragment - tidy up showing the empty view - make search fragments show snackbar with appropriate text

* commons-app#3772 Convert SearchImagesFragment to use Pagination  - allow viewpager to load more data

* commons-app#3760 remove test that got re-added by merge

* commons-app#3760 remove duplicate dependency

* commons-app#3772 fix compilation

* commons-app#3780 Create media using a combination of Entities & MwQueryResult - construct media with an entity - move fields from media down to contribution - move dynamic fields outside of media - remove unused constructors - remove all unnecessary fetching of captions/descriptions - bump database version

* commons-app#3808 Construct media objects that depict an item id correctly - use generator to construct media for DepictedImages

* commons-app#3780 Create media using a combination of Entities & MwQueryResult - update wikicode to align with expected behaviour

* commons-app#3780 Create media using a combination of Entities & MwQueryResult - replace old site of thumbnail title with most relevant caption

Author: macgills

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

@@ -1,119 +1,51 @@
 package fr.free.nrw.commons
 
 import androidx.core.text.HtmlCompat
-import fr.free.nrw.commons.depictions.Media.DepictedImagesFragment
-import fr.free.nrw.commons.media.Depictions
+import fr.free.nrw.commons.depictions.Media.DepictedImagesFragment.PAGE_ID_PREFIX
+import fr.free.nrw.commons.media.IdAndCaptions
 import fr.free.nrw.commons.media.MediaClient
 import io.reactivex.Single
-import io.reactivex.functions.Function5
 import timber.log.Timber
 import javax.inject.Inject
 import javax.inject.Singleton
 
 /**
  * Fetch additional media data from the network that we don't store locally.
  *
- * This includes things like category lists and multilingual descriptions,
- * which are not intrinsic to the media and may change due to editing.
+ *
+ * This includes things like category lists and multilingual descriptions, which are not intrinsic
+ * to the media and may change due to editing.
  */
 @Singleton
 class MediaDataExtractor @Inject constructor(private val mediaClient: MediaClient) {
 
-    /**
-     * Simplified method to extract all details required to show media details.
-     * It fetches media object, deletion status, talk page and captions 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
-     */
-    fun fetchMediaDetails(filename: String, pageId: String?): Single<Media> {
-        return Single.zip(
-            getMediaFromFileName(filename),
-            mediaClient.checkPageExistsUsingTitle("Commons:Deletion_requests/$filename"),
-            getDiscussion(filename),
-            if (pageId != null)
-                getCaption(DepictedImagesFragment.PAGE_ID_PREFIX + pageId)
-            else Single.just(MediaClient.NO_CAPTION),
-            getDepictions(filename),
-            Function5 { media: Media, deletionStatus: Boolean, discussion: String, caption: String, depictions: Depictions ->
-                combineToMedia(
-                    media,
-                    deletionStatus,
-                    discussion,
-                    caption,
-                    depictions
-                )
+    fun fetchDepictionIdsAndLabels(media: Media) =
+        mediaClient.getEntities(media.depictionIds)
+            .map {
+                it.entities()
+                    .mapValues { entry -> entry.value.labels().mapValues { it.value.value() } }
             }
-        )
-    }
+            .map { it.map { (key, value) -> IdAndCaptions(key, value) } }
+            .onErrorReturn { emptyList() }
 
-    private fun combineToMedia(
-        media: Media,
-        deletionStatus: Boolean,
-        discussion: String,
-        caption: String,
-        depictions: Depictions
-    ): Media {
-        media.discussion = discussion
-        media.caption = caption
-        media.depictions = depictions
-        if (deletionStatus) {
-            media.isRequestedDeletion = true
-        }
-        return media
-    }
+    fun checkDeletionRequestExists(media: Media) =
+        mediaClient.checkPageExistsUsingTitle("Commons:Deletion_requests/" + media.filename)
 
-    /**
-     * Obtains captions using filename
-     * @param wikibaseIdentifier
-     *
-     * @return caption for the image in user's locale
-     * Ex: "a nice painting" (english locale) and "No Caption" in case the caption is not available for the image
-     */
-    private fun getCaption(wikibaseIdentifier: String): Single<String> {
-        return mediaClient.getCaptionByWikibaseIdentifier(wikibaseIdentifier)
-    }
-
-    /**
-     * Fetch depictions from the MediaWiki API
-     * @param filename the filename we will return the caption for
-     * @return Depictions
-     */
-    private fun getDepictions(filename: String): Single<Depictions> {
-        return mediaClient.getDepictions(filename)
-            .doOnError { throwable: Throwable? ->
-                Timber.e(
-                    throwable,
-                    "error while fetching depictions"
-                )
+    fun fetchDiscussion(media: Media) =
+        mediaClient.getPageHtml(media.filename.replace("File", "File talk"))
+            .map { HtmlCompat.fromHtml(it, HtmlCompat.FROM_HTML_MODE_LEGACY).toString() }
+            .onErrorReturn {
+                Timber.d("Error occurred while fetching discussion")
+                ""
             }
-    }
 
-    /**
-     * Method can be used to fetch media for a given filename
-     * @param filename Eg. File:Test.jpg
-     * @return return data rich Media object
-     */
-    fun getMediaFromFileName(filename: String?): Single<Media> {
-        return mediaClient.getMedia(filename)
-    }
+    fun refresh(media: Media): Single<Media> {
+        return Single.ambArray(
+            mediaClient.getMediaById(PAGE_ID_PREFIX + media.pageId)
+                .onErrorResumeNext { Single.never() },
+            mediaClient.getMedia(media.filename)
+                .onErrorResumeNext { Single.never() }
+        )
 
-    /**
-     * Fetch talk page from the MediaWiki API
-     * @param filename
-     * @return
-     */
-    private fun getDiscussion(filename: String): Single<String> {
-        return mediaClient.getPageHtml(filename.replace("File", "File talk"))
-            .map { discussion: String? ->
-                HtmlCompat.fromHtml(
-                    discussion!!,
-                    HtmlCompat.FROM_HTML_MODE_LEGACY
-                ).toString()
-            }
-            .onErrorReturn { throwable: Throwable? ->
-                Timber.e(throwable, "Error occurred while fetching discussion")
-                ""
-            }
     }
-
 }

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

@@ -2,7 +2,6 @@
 
 import static android.view.View.GONE;
 import static android.view.View.VISIBLE;
-import static fr.free.nrw.commons.depictions.Media.DepictedImagesFragment.PAGE_ID_PREFIX;
 
 import android.annotation.SuppressLint;
 import android.os.Bundle;
@@ -253,37 +252,6 @@ private void handleSuccess(List<Media> collection) {
         progressBar.setVisibility(GONE);
         isLoading = false;
         statusTextView.setVisibility(GONE);
-        for (Media m : collection) {
-            final String pageId = m.getPageId();
-            if (pageId != null) {
-                replaceTitlesWithCaptions(PAGE_ID_PREFIX + pageId, mediaSize++);
-            }
-        }
-    }
-
-    /**
-     * fetch captions for the image using filename and replace title of on the image thumbnail(if captions are available)
-     * else show filename
-     */
-    public void replaceTitlesWithCaptions(String wikibaseIdentifier, int i) {
-        compositeDisposable.add(mediaClient.getCaptionByWikibaseIdentifier(wikibaseIdentifier)
-                .subscribeOn(Schedulers.io())
-                .observeOn(AndroidSchedulers.mainThread())
-                .subscribe(subscriber -> {
-                    handleLabelforImage(subscriber, i);
-                }));
-
-    }
-
-    /**
-     * If caption is available for the image, then modify grid adapter
-     * to show captions
-     */
-    private void handleLabelforImage(String s, int position) {
-        if (!s.trim().equals(getString(R.string.detail_caption_empty))) {
-            gridAdapter.getItem(position).setThumbnailTitle(s);
-            gridAdapter.notifyDataSetChanged();
-        }
     }
 
     /**

app/src/main/java/fr/free/nrw/commons/category/CategoryImagesListFragment.java

@@ -88,7 +88,7 @@ public View getView(int position, View convertView, ViewGroup parent) {
         SimpleDraweeView imageView = convertView.findViewById(R.id.categoryImageView);
         TextView fileName = convertView.findViewById(R.id.categoryImageTitle);
         TextView author = convertView.findViewById(R.id.categoryImageAuthor);
-        fileName.setText(item.getThumbnailTitle());
+        fileName.setText(item.getMostRelevantCaption());
         setAuthorView(item, author);
         imageView.setImageURI(item.getThumbUrl());
         return convertView;

app/src/main/java/fr/free/nrw/commons/category/GridViewAdapter.java

@@ -1,17 +1,18 @@
 package fr.free.nrw.commons.contributions;
 
+import android.net.Uri;
 import android.os.Parcel;
+import androidx.annotation.Nullable;
 import androidx.room.Entity;
 import fr.free.nrw.commons.Media;
 import fr.free.nrw.commons.auth.SessionManager;
-import fr.free.nrw.commons.upload.UploadMediaDetail;
 import fr.free.nrw.commons.upload.UploadItem;
+import fr.free.nrw.commons.upload.UploadMediaDetail;
 import fr.free.nrw.commons.upload.WikidataPlace;
 import fr.free.nrw.commons.upload.structure.depictions.DepictedItem;
 import java.util.ArrayList;
-import java.util.HashMap;
+import java.util.Date;
 import java.util.List;
-import java.util.Map;
 import java.util.Objects;
 
 @Entity(tableName = "contribution")
@@ -34,24 +35,23 @@ public class Contribution extends Media {
      */
     private List<DepictedItem> depictedItems = new ArrayList<>();
     private String mimeType;
-    /**
-     * This hasmap stores the list of multilingual captions, where key of the HashMap is the language
-     * and value is the caption in the corresponding language Ex: key = "en", value: "<caption in
-     * short in English>" key = "de" , value: "<caption in german>"
-     */
-    private HashMap<String, String> captions = new HashMap<>();
+    @Nullable
+    private Uri localUri;
+    private long dataLength;
+    private Date dateCreated;
 
     public Contribution() {
     }
 
     public Contribution(final UploadItem item, final SessionManager sessionManager,
         final List<DepictedItem> depictedItems, final List<String> categories) {
-        super(item.getMediaUri(),
+        super(
             item.getFileName(),
-            UploadMediaDetail.formatList(item.getUploadMediaDetails()),
+            UploadMediaDetail.formatCaptions(item.getUploadMediaDetails()),
+            UploadMediaDetail.formatDescriptions(item.getUploadMediaDetails()),
             sessionManager.getAuthorName(),
             categories);
-        captions = new HashMap<>(UploadMediaDetail.formatCaptions(item.getUploadMediaDetails()));
+        localUri = item.getMediaUri();
         decimalCoords = item.getGpsCoords().getDecimalCoords();
         dateCreatedSource = "";
         this.depictedItems = depictedItems;
@@ -117,24 +117,6 @@ public void setMimeType(final String mimeType) {
         this.mimeType = mimeType;
     }
 
-    /**
-     * Captions are a feature part of Structured data. They are meant to store short, multilingual
-     * descriptions about files This is a replacement of the previously used titles for images (titles
-     * were not multilingual) Also now captions replace the previous convention of using title for
-     * filename
-     * <p>
-     * key of the HashMap is the language and value is the caption in the corresponding language
-     * <p>
-     * returns list of captions stored in hashmap
-     */
-    public HashMap<String, String> getCaptions() {
-        return captions;
-    }
-
-    public void setCaptions(HashMap<String, String> captions) {
-        this.captions = captions;
-    }
-
     @Override
     public int describeContents() {
         return 0;
@@ -147,7 +129,6 @@ public void writeToParcel(final Parcel dest, final int flags) {
         dest.writeLong(transferred);
         dest.writeString(decimalCoords);
         dest.writeString(dateCreatedSource);
-        dest.writeSerializable(captions);
     }
 
     /**
@@ -156,13 +137,7 @@ public void writeToParcel(final Parcel dest, final int flags) {
      * @param state
      */
     public Contribution(Media media, int state) {
-        super(media.getPageId(),
-            media.getLocalUri(), media.getThumbUrl(), media.getImageUrl(), media.getFilename(),
-            media.getDescription(),
-            media.getDiscussion(),
-            media.getDataLength(), media.getDateCreated(), media.getDateUploaded(),
-            media.getLicense(), media.getLicenseUrl(), media.getCreator(), media.getCategories(),
-            media.isRequestedDeletion(), media.getCoordinates());
+        super(media);
         this.state = state;
     }
 
@@ -172,7 +147,6 @@ protected Contribution(final Parcel in) {
         transferred = in.readLong();
         decimalCoords = in.readString();
         dateCreatedSource = in.readString();
-        captions = (HashMap<String, String>) in.readSerializable();
     }
 
     public static final Creator<Contribution> CREATOR = new Creator<Contribution>() {
@@ -187,34 +161,60 @@ public Contribution[] newArray(final int size) {
         }
     };
 
-    /**
-     * Equals implementation of Contributions that compares all parameters for checking equality
-     */
+    @Nullable
+    public Uri getLocalUri() {
+        return localUri;
+    }
+
+    public void setLocalUri(@Nullable Uri localUri) {
+        this.localUri = localUri;
+    }
+
+    public long getDataLength() {
+        return dataLength;
+    }
+
+    public void setDataLength(long dataLength) {
+        this.dataLength = dataLength;
+    }
+
+    public Date getDateCreated() {
+        return dateCreated;
+    }
+
+    public void setDateCreated(Date dateCreated) {
+        this.dateCreated = dateCreated;
+    }
+
     @Override
     public boolean equals(final Object o) {
         if (this == o) {
             return true;
         }
-        if (!(o instanceof Contribution)) {
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        if (!super.equals(o)) {
             return false;
         }
         final Contribution that = (Contribution) o;
-        return getState() == that.getState() && getTransferred() == that.getTransferred() && Objects
-            .equals(getDecimalCoords(), that.getDecimalCoords()) && Objects
-            .equals(getDateCreatedSource(), that.getDateCreatedSource()) && Objects
-            .equals(getWikidataPlace(), that.getWikidataPlace()) && Objects
-            .equals(getDepictedItems(), that.getDepictedItems()) && Objects
-            .equals(getMimeType(), that.getMimeType()) && Objects
-            .equals(getCaptions(), that.getCaptions());
+        return state == that.state &&
+            transferred == that.transferred &&
+            dataLength == that.dataLength &&
+            Objects.equals(decimalCoords, that.decimalCoords) &&
+            Objects.equals(dateCreatedSource, that.dateCreatedSource) &&
+            Objects.equals(wikidataPlace, that.wikidataPlace) &&
+            Objects.equals(depictedItems, that.depictedItems) &&
+            Objects.equals(mimeType, that.mimeType) &&
+            Objects.equals(localUri, that.localUri) &&
+            Objects.equals(dateCreated, that.dateCreated);
     }
 
-    /**
-     * Hash code implementation of contributions that considers all parameters for calculating hash.
-     */
     @Override
     public int hashCode() {
         return Objects
-            .hash(getState(), getTransferred(), getDecimalCoords(), getDateCreatedSource(),
-                getWikidataPlace(), getDepictedItems(), getMimeType(), getCaptions());
+            .hash(super.hashCode(), state, transferred, decimalCoords, dateCreatedSource,
+                wikidataPlace,
+                depictedItems, mimeType, localUri, dataLength, dateCreated);
     }
 }