Skip to content

Latest commit

 

History

History
93 lines (60 loc) · 3.92 KB

README.md

File metadata and controls

93 lines (60 loc) · 3.92 KB

Upload to Commons

Upload pictures from your Android phone/tablet to Wikimedia Commons.

Initially started by the Wikimedia Foundation, this app is now maintained by volunteers. Anyone is welcome to improve it, just choose among the open issues and send us a pull request :-)

Use Android Studio or IntelliJ

Import and Compile Commons Android App

Download Android Studio (recommended) or IntelliJ.

  1. Clone the repository.
  2. Open Android Studio/IntelliJ. Open the project: File > Open...
    or
    (From Quick Start menu): Open an existing Android Studio project
  3. Navigate to the folder in the cloned repository (named commons). Select OK.

Build Manually

Note: It is much harder to build manually. We reccomend you use Android Studio or IntelliJ IDEA, which both have gradle and all the android tools built in.

Requirements

  1. Android SDK (Level 23)
  2. Gradle

Build Instructions

  1. Set the environment variable ANDROID_HOME to be the path to your Android SDK
  2. Set the environment variable JAVA_HOME to the path to your Java SDK
  3. Run gradlew.bat assembleRelease (Windows) or ./gradlew assembleRelease (Mac / Linux) to build an unisgned apk
  4. From your Android SDK's /tools directory run adb install path/to/app.apk (Emulator) or adb -d install path/to/app.apk (USB debugging)

There are more thorough instructions on the Android Developers website

License

This software is licensed under the Apache License 2.0.

Bugs

Please report any bug on Github.

Code Structure

Key breakdowns:

Activities started within the UI:

  • ContributionsActivity (ContributionsListFragment, MediaDetailPagerFragment, MediaDetailFragment) - main "my uploads" list and detail view
  • LoginActivity - login screen when setting up an account
  • SettingsActivity - settings screen
  • AboutActivity - about screen

Activities receiving intents:

  • ShareActivity (SingleUploadFragment, CategorizationFragment) - handles receiving a file from another app, accepting a title/desc, and slating it for upload
  • MultipleShareActivity (MultipleUploadListFragment, CategorizationFragment) - handles receiving a batch of multiple files from another app, accepting a title/desc, and slating them for upload

Services:

  • WikiAccountAuthenticatorService - authentication service
  • UploadService - performs actual file uploads in background
  • ContributionsSyncService - polls for updated contributions list from server
  • ModificationsSyncService - pushes category additions up to server

Content providers:

  • ContributionsContentProvider - private storage for local copy of user's contribution list
  • ModificationsContentProvider - private storage for pending category and template modifications
  • CategoryContentProvider - private storage for recently used categories

On-Device Storage

Account credentials are encapsulated in an account provider. Currently only one Wikimedia Commons account is supported at a time. (Question: what is the actual storage for credentials?)

Preferences are stored in Android's SharedPreferences.

Information about past and pending uploads is stored in the Contributions content provider, which uses an SQLite database on the backend.

A list of recently-used categories is stored in the Categories content provider, which uses an SQLite database on the backend.

Captured files are not currently stored within the app, but are passed by content: or file: URI from other apps.

Thumbnail images are not currently cached. (?)