diff --git a/app/src/main/java/fr/free/nrw/commons/di/NetworkingModule.java b/app/src/main/java/fr/free/nrw/commons/di/NetworkingModule.java index 495a8d01e..84fdfe53a 100644 --- a/app/src/main/java/fr/free/nrw/commons/di/NetworkingModule.java +++ b/app/src/main/java/fr/free/nrw/commons/di/NetworkingModule.java @@ -85,11 +85,13 @@ public class NetworkingModule { public OkHttpJsonApiClient provideOkHttpJsonApiClient(OkHttpClient okHttpClient, DepictsClient depictsClient, @Named("tools_forge") HttpUrl toolsForgeUrl, + @Named("test_tools_forge") HttpUrl testToolsForgeUrl, @Named("default_preferences") JsonKvStore defaultKvStore, Gson gson) { return new OkHttpJsonApiClient(okHttpClient, depictsClient, toolsForgeUrl, + testToolsForgeUrl, WIKIDATA_SPARQL_QUERY_URL, BuildConfig.WIKIMEDIA_CAMPAIGNS_URL, gson); @@ -124,6 +126,14 @@ public class NetworkingModule { return HttpUrl.parse(TOOLS_FORGE_URL); } + @Provides + @Named("test_tools_forge") + @NonNull + @SuppressWarnings("ConstantConditions") + public HttpUrl provideTestToolsForgeUrl() { + return HttpUrl.parse(TEST_TOOLS_FORGE_URL); + } + @Provides @Singleton @Named(NAMED_COMMONS_WIKI_SITE) diff --git a/app/src/main/java/fr/free/nrw/commons/mwapi/OkHttpJsonApiClient.java b/app/src/main/java/fr/free/nrw/commons/mwapi/OkHttpJsonApiClient.java index eeaba0a73..d07667b48 100644 --- a/app/src/main/java/fr/free/nrw/commons/mwapi/OkHttpJsonApiClient.java +++ b/app/src/main/java/fr/free/nrw/commons/mwapi/OkHttpJsonApiClient.java @@ -11,6 +11,7 @@ import fr.free.nrw.commons.location.LatLng; import fr.free.nrw.commons.nearby.Place; import fr.free.nrw.commons.nearby.model.NearbyResponse; import fr.free.nrw.commons.nearby.model.NearbyResultItem; +import fr.free.nrw.commons.profile.leaderboard.LeaderboardResponse; import fr.free.nrw.commons.upload.FileUtils; import fr.free.nrw.commons.upload.structure.depictions.DepictedItem; import fr.free.nrw.commons.utils.ConfigUtils; @@ -40,6 +41,7 @@ public class OkHttpJsonApiClient { private final OkHttpClient okHttpClient; private final DepictsClient depictsClient; private final HttpUrl wikiMediaToolforgeUrl; + private final HttpUrl wikiMediaTestToolforgeUrl; private final String sparqlQueryUrl; private final String campaignsUrl; private final Gson gson; @@ -49,17 +51,58 @@ public class OkHttpJsonApiClient { public OkHttpJsonApiClient(OkHttpClient okHttpClient, DepictsClient depictsClient, HttpUrl wikiMediaToolforgeUrl, + HttpUrl wikiMediaTestToolforgeUrl, String sparqlQueryUrl, String campaignsUrl, Gson gson) { this.okHttpClient = okHttpClient; this.depictsClient = depictsClient; this.wikiMediaToolforgeUrl = wikiMediaToolforgeUrl; + this.wikiMediaTestToolforgeUrl = wikiMediaTestToolforgeUrl; this.sparqlQueryUrl = sparqlQueryUrl; this.campaignsUrl = campaignsUrl; this.gson = gson; } + @NonNull + public Single getLeaderboard(String userName, String duration, String category, String limit, String offset) { + final String fetchLeaderboardUrlTemplate = wikiMediaTestToolforgeUrl + + "/leaderboard.py"; + return Single.fromCallable(() -> { + String url = String.format(Locale.ENGLISH, + fetchLeaderboardUrlTemplate, + userName, + duration, + category, + limit, + offset); + HttpUrl.Builder urlBuilder = HttpUrl.parse(url).newBuilder(); + urlBuilder.addQueryParameter("user", userName); + urlBuilder.addQueryParameter("duration", duration); + urlBuilder.addQueryParameter("category", category); + urlBuilder.addQueryParameter("limit", limit); + urlBuilder.addQueryParameter("offset", offset); + Timber.i("Url %s", urlBuilder.toString()); + Request request = new Request.Builder() + .url(urlBuilder.toString()) + .build(); + Response response = okHttpClient.newCall(request).execute(); + if (response != null && response.body() != null && response.isSuccessful()) { + String json = response.body().string(); + if (json == null) { + return null; + } + Timber.d("Response for leaderboard is %s", json); + try { + return gson.fromJson(json, LeaderboardResponse.class); + } catch (Exception e) { + return new LeaderboardResponse(); + } + } + return null; + }); + } + @NonNull public Single getUploadCount(String userName) { HttpUrl.Builder urlBuilder = wikiMediaToolforgeUrl.newBuilder(); diff --git a/app/src/main/java/fr/free/nrw/commons/profile/leaderboard/LeaderboardFragment.java b/app/src/main/java/fr/free/nrw/commons/profile/leaderboard/LeaderboardFragment.java index 76cbc51a3..e536a950a 100644 --- a/app/src/main/java/fr/free/nrw/commons/profile/leaderboard/LeaderboardFragment.java +++ b/app/src/main/java/fr/free/nrw/commons/profile/leaderboard/LeaderboardFragment.java @@ -1,18 +1,162 @@ package fr.free.nrw.commons.profile.leaderboard; +import android.accounts.Account; +import android.net.Uri; import android.os.Bundle; import android.view.LayoutInflater; import android.view.View; import android.view.ViewGroup; +import android.widget.ProgressBar; +import android.widget.TextView; +import androidx.recyclerview.widget.LinearLayoutManager; +import androidx.recyclerview.widget.RecyclerView; +import butterknife.BindView; +import butterknife.ButterKnife; +import com.facebook.drawee.view.SimpleDraweeView; import fr.free.nrw.commons.R; +import fr.free.nrw.commons.auth.SessionManager; import fr.free.nrw.commons.di.CommonsDaggerSupportFragment; +import fr.free.nrw.commons.mwapi.OkHttpJsonApiClient; +import fr.free.nrw.commons.utils.ViewUtil; +import io.reactivex.android.schedulers.AndroidSchedulers; +import io.reactivex.disposables.CompositeDisposable; +import io.reactivex.schedulers.Schedulers; +import java.util.List; +import java.util.Objects; +import javax.inject.Inject; +import timber.log.Timber; public class LeaderboardFragment extends CommonsDaggerSupportFragment { + @BindView(R.id.avatar) + SimpleDraweeView avatar; + + @BindView(R.id.username) + TextView username; + + @BindView(R.id.rank) + TextView rank; + + @BindView(R.id.count) + TextView count; + + @BindView(R.id.leaderboard_list) + RecyclerView leaderboardListRecyclerView; + + @BindView(R.id.progressBar) + ProgressBar progressBar; + + @Inject + SessionManager sessionManager; + + @Inject + OkHttpJsonApiClient okHttpJsonApiClient; + + private String avatarSourceURL = "https://upload.wikimedia.org/wikipedia/commons/thumb/0/0a/%s/1024px-%s.png"; + + private CompositeDisposable compositeDisposable = new CompositeDisposable(); + @Override public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) { View rootView = inflater.inflate(R.layout.fragment_leaderboard, container, false); + ButterKnife.bind(this, rootView); + progressBar.setVisibility(View.VISIBLE); + hideLayouts(); + setLeaderboard(); return rootView; } + /** + * To call the API to get results in form Single + * which then calls parseJson when results are fetched + */ + private void setLeaderboard() { + if (checkAccount()) { + try{ + compositeDisposable.add(okHttpJsonApiClient + .getLeaderboard(Objects.requireNonNull(sessionManager.getCurrentAccount()).name, + "all_time", "upload", null, null) + .subscribeOn(Schedulers.io()) + .observeOn(AndroidSchedulers.mainThread()) + .subscribe( + response -> { + if (response != null && response.getStatus() == 200) { + setLeaderboardUser(response); + setLeaderboardList(response.getLeaderboardList()); + } + }, + t -> { + Timber.e(t, "Fetching leaderboard statistics failed"); + onError(); + } + )); + } + catch (Exception e){ + Timber.d(e+"success"); + } + } + } + + private void setLeaderboardUser(LeaderboardResponse response) { + hideProgressBar(); + avatar.setImageURI( + Uri.parse(String.format(avatarSourceURL, response.getAvatar(), response.getAvatar()))); + username.setText(response.getUsername()); + rank.setText(String.format("%s %d", getString(R.string.rank_prefix), response.getRank())); + count.setText(String.format("%s %d", getString(R.string.count_prefix), response.getCategoryCount())); + } + + private void setLeaderboardList(List leaderboardList) { + LeaderboardListAdapter leaderboardListAdapter = new LeaderboardListAdapter(leaderboardList); + LinearLayoutManager linearLayoutManager = new LinearLayoutManager(getContext()); + leaderboardListRecyclerView.setLayoutManager(linearLayoutManager); + leaderboardListRecyclerView.setAdapter(leaderboardListAdapter); + } + + /** + * to hide progressbar + */ + private void hideProgressBar() { + if (progressBar != null) { + progressBar.setVisibility(View.GONE); + avatar.setVisibility(View.VISIBLE); + username.setVisibility(View.VISIBLE); + rank.setVisibility(View.VISIBLE); + leaderboardListRecyclerView.setVisibility(View.VISIBLE); + } + } + + /** + * used to hide the layouts while fetching results from api + */ + private void hideLayouts(){ + avatar.setVisibility(View.INVISIBLE); + username.setVisibility(View.INVISIBLE); + rank.setVisibility(View.INVISIBLE); + leaderboardListRecyclerView.setVisibility(View.INVISIBLE); + } + + /** + * check to ensure that user is logged in + * @return + */ + private boolean checkAccount(){ + Account currentAccount = sessionManager.getCurrentAccount(); + if (currentAccount == null) { + Timber.d("Current account is null"); + ViewUtil.showLongToast(getActivity(), getResources().getString(R.string.user_not_logged_in)); + sessionManager.forceLogin(getActivity()); + return false; + } + return true; + } + + /** + * Shows a generic error toast when error occurs while loading leaderboard + */ + private void onError() { + ViewUtil.showLongToast(getActivity(), getResources().getString(R.string.error_occurred)); + progressBar.setVisibility(View.GONE); + } + } diff --git a/app/src/main/java/fr/free/nrw/commons/profile/leaderboard/LeaderboardList.java b/app/src/main/java/fr/free/nrw/commons/profile/leaderboard/LeaderboardList.java new file mode 100644 index 000000000..d6b86a22b --- /dev/null +++ b/app/src/main/java/fr/free/nrw/commons/profile/leaderboard/LeaderboardList.java @@ -0,0 +1,53 @@ +package fr.free.nrw.commons.profile.leaderboard; + +import com.google.gson.annotations.Expose; +import com.google.gson.annotations.SerializedName; + +public class LeaderboardList { + + @SerializedName("username") + @Expose + private String username; + @SerializedName("category_count") + @Expose + private Integer categoryCount; + @SerializedName("avatar") + @Expose + private String avatar; + @SerializedName("rank") + @Expose + private Integer rank; + + public String getUsername() { + return username; + } + + public void setUsername(String username) { + this.username = username; + } + + public Integer getCategoryCount() { + return categoryCount; + } + + public void setCategoryCount(Integer categoryCount) { + this.categoryCount = categoryCount; + } + + public String getAvatar() { + return avatar; + } + + public void setAvatar(String avatar) { + this.avatar = avatar; + } + + public Integer getRank() { + return rank; + } + + public void setRank(Integer rank) { + this.rank = rank; + } + +} \ No newline at end of file diff --git a/app/src/main/java/fr/free/nrw/commons/profile/leaderboard/LeaderboardListAdapter.java b/app/src/main/java/fr/free/nrw/commons/profile/leaderboard/LeaderboardListAdapter.java new file mode 100644 index 000000000..4a61a1cb1 --- /dev/null +++ b/app/src/main/java/fr/free/nrw/commons/profile/leaderboard/LeaderboardListAdapter.java @@ -0,0 +1,73 @@ +package fr.free.nrw.commons.profile.leaderboard; + +import android.content.Context; +import android.net.Uri; +import android.view.LayoutInflater; +import android.view.View; +import android.view.ViewGroup; +import android.widget.TextView; +import androidx.annotation.NonNull; +import androidx.recyclerview.widget.RecyclerView; +import com.facebook.drawee.view.SimpleDraweeView; +import fr.free.nrw.commons.R; +import java.util.List; + +public class LeaderboardListAdapter extends RecyclerView.Adapter { + + private List leaderboardList; + + private String avatarSourceURL = "https://upload.wikimedia.org/wikipedia/commons/thumb/0/0a/%s/1024px-%s.png"; + + public class ListViewHolder extends RecyclerView.ViewHolder { + TextView rank; + SimpleDraweeView avatar; + TextView username; + TextView count; + + public ListViewHolder(View itemView) { + super(itemView); + this.rank = itemView.findViewById(R.id.user_rank); + this.avatar = itemView.findViewById(R.id.user_avatar); + this.username = itemView.findViewById(R.id.user_name); + this.count = itemView.findViewById(R.id.user_count); + } + + public Context getContext() { + return itemView.getContext(); + } + } + + public LeaderboardListAdapter(List leaderboardList) { + this.leaderboardList = leaderboardList; + } + + @NonNull + @Override + public LeaderboardListAdapter.ListViewHolder onCreateViewHolder(@NonNull ViewGroup parent, int viewType) { + View view = LayoutInflater.from(parent.getContext()) + .inflate(R.layout.leaderboard_list_element, parent, false); + + return new ListViewHolder(view); + } + + @Override + public void onBindViewHolder(@NonNull LeaderboardListAdapter.ListViewHolder holder, int position) { + TextView rank = holder.rank; + SimpleDraweeView avatar = holder.avatar; + TextView username = holder.username; + TextView count = holder.count; + + rank.setText(leaderboardList.get(position).getRank().toString()); + + avatar.setImageURI( + Uri.parse(String.format(avatarSourceURL, leaderboardList.get(position).getAvatar(), + leaderboardList.get(position).getAvatar()))); + username.setText(leaderboardList.get(position).getUsername()); + count.setText(leaderboardList.get(position).getCategoryCount().toString()); + } + + @Override + public int getItemCount() { + return leaderboardList.size(); + } +} diff --git a/app/src/main/java/fr/free/nrw/commons/profile/leaderboard/LeaderboardResponse.java b/app/src/main/java/fr/free/nrw/commons/profile/leaderboard/LeaderboardResponse.java new file mode 100644 index 000000000..6624ebfd0 --- /dev/null +++ b/app/src/main/java/fr/free/nrw/commons/profile/leaderboard/LeaderboardResponse.java @@ -0,0 +1,120 @@ +package fr.free.nrw.commons.profile.leaderboard; + +import java.util.List; +import com.google.gson.annotations.Expose; +import com.google.gson.annotations.SerializedName; + +public class LeaderboardResponse { + + @SerializedName("status") + @Expose + private Integer status; + @SerializedName("username") + @Expose + private String username; + @SerializedName("category_count") + @Expose + private Integer categoryCount; + @SerializedName("limit") + @Expose + private Object limit; + @SerializedName("avatar") + @Expose + private String avatar; + @SerializedName("offset") + @Expose + private Object offset; + @SerializedName("duration") + @Expose + private String duration; + @SerializedName("leaderboard_list") + @Expose + private List leaderboardList = null; + @SerializedName("category") + @Expose + private String category; + @SerializedName("rank") + @Expose + private Integer rank; + + public Integer getStatus() { + return status; + } + + public void setStatus(Integer status) { + this.status = status; + } + + public String getUsername() { + return username; + } + + public void setUsername(String username) { + this.username = username; + } + + public Integer getCategoryCount() { + return categoryCount; + } + + public void setCategoryCount(Integer categoryCount) { + this.categoryCount = categoryCount; + } + + public Object getLimit() { + return limit; + } + + public void setLimit(Object limit) { + this.limit = limit; + } + + public String getAvatar() { + return avatar; + } + + public void setAvatar(String avatar) { + this.avatar = avatar; + } + + public Object getOffset() { + return offset; + } + + public void setOffset(Object offset) { + this.offset = offset; + } + + public String getDuration() { + return duration; + } + + public void setDuration(String duration) { + this.duration = duration; + } + + public List getLeaderboardList() { + return leaderboardList; + } + + public void setLeaderboardList(List leaderboardList) { + this.leaderboardList = leaderboardList; + } + + public String getCategory() { + return category; + } + + public void setCategory(String category) { + this.category = category; + } + + public Integer getRank() { + return rank; + } + + public void setRank(Integer rank) { + this.rank = rank; + } + +} \ No newline at end of file diff --git a/app/src/main/res/layout/fragment_leaderboard.xml b/app/src/main/res/layout/fragment_leaderboard.xml index 28f5b725c..b965e83db 100644 --- a/app/src/main/res/layout/fragment_leaderboard.xml +++ b/app/src/main/res/layout/fragment_leaderboard.xml @@ -1,6 +1,110 @@ - - \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/app/src/main/res/layout/leaderboard_list_element.xml b/app/src/main/res/layout/leaderboard_list_element.xml new file mode 100644 index 000000000..d779fe32a --- /dev/null +++ b/app/src/main/res/layout/leaderboard_list_element.xml @@ -0,0 +1,55 @@ + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml index 6f2a3a0c6..64459cbf6 100644 --- a/app/src/main/res/values/strings.xml +++ b/app/src/main/res/values/strings.xml @@ -651,4 +651,9 @@ Upload your first media by tapping on the add button. Copy wikicode to clipboard Achievements Leaderboard + Rank: + Count: + Rank + User + Count