Android Open Source - Race2GED2 Class Data Updater

From Project

Back to project page Race2GED2.
License

The source code is released under:
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Def...
If you think the Android project Race2GED2 listed in this page is inappropriate, such as containing malicious code/tools or violating the copyright, please email info at java2s dot com, thanks.
Java Source Code

/*
 * Copyright 2014 Regional Adult Education Program of Lee, Scott, Wise, and Norton Public Schools
 *// www  .  ja  va 2 s  .  c  o m
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

package edu.mecc.race2ged.helpers;

import android.app.Activity;
import android.content.Context;
import android.os.AsyncTask;
import android.util.Log;
import android.view.View;
import android.widget.TextView;
import java.io.BufferedReader;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import edu.mecc.race2ged.GEDApplication;
import edu.mecc.race2ged.R;

/**
 * ClassDataUpdater provides methods for retrieving, storing, and managing Class Schedule data retrieved
 * from www.race2ged.org
 *
 * @author Bryan Smith
 */
public class ClassDataUpdater extends AsyncTask<Integer, Integer, Boolean> {

    public static String dataRead = "Done updating...";
    public static String dataGet = "Downloading Updates: ";
    public static String dataError = "Error checking for updates!";
    public static String dataParse = "Checking for updates...";

    private String version = "0";
    private Activity activity = null;
    private Integer progressViewID = null;
    private View progressView = null;
    private Context context = null;

    /**
     * Creates a new asynchronous task. This constructor must be invoked on the UI thread.
     */
    public ClassDataUpdater(Activity activity,Integer progressViewId) {
        super();
        if (activity != null) {
            this.activity = activity;
            this.progressViewID = progressViewId;
            if (activity.findViewById(progressViewID) != null)
                progressView = activity.findViewById(progressViewID);
            this.context = activity.getApplicationContext();
        }
    }

    /**
     * Runs on the UI thread before {@link #doInBackground}.
     *
     * @see #onPostExecute
     * @see #doInBackground
     */
    @Override
    protected void onPreExecute() {
        Log.d(this.getClass().getSimpleName(), "Begin checking for updates.");
        if (progressView != null && progressView instanceof TextView){
            ((TextView)progressView).setText(dataParse);
        }
    }

    /**
     * Checks settings to determine if updates will be checked. If so, retrieve
     * the version number from the server, and if newer than the local version,
     * download the updated class schedule. The specified parameters are the parameters
     * passed to {@link #execute} by the caller of this task.
     * <p/>
     * This method can call {@link #publishProgress} to publish updates
     * on the UI thread.
     *
     * @param params The parameters of the task.
     * @return Returns true if updates were downloaded. False otherwise.
     * @see #onPreExecute()
     * @see #onPostExecute
     * @see #publishProgress
     */
    @Override
    protected Boolean doInBackground(Integer... params) {
        if (canUpdate()) {
            try {
                int value = retrieveRemoteVersion(params[0]);
                if (value > GEDApplication.getSettingsHelper().getClassDataVersion()) {
                    Log.d(this.getClass().getSimpleName(),
                            "Remote Class Schedule Data is newer. Checking for remote file.");
                    try { return updateClassData(); } catch (IOException e) {e.printStackTrace();}
                } else if (value != -1) {
                    Log.d(this.getClass().getSimpleName(),
                            "Remote Class Schedule Data is not newer. No need to download.");
                }
            } catch (IOException e) {
                Log.e(this.getClass().getSimpleName(), "Error retrieving class data version from server. | " + e.getMessage());
            }
        }
        return false;
    }

    /**
     * <p>Sets the stored class data version to the new version that was just downloaded. </p>
     * <p>This method won't be invoked if the task was cancelled.</p>
     *
     * @param aBoolean The result of the operation computed by {@link #doInBackground}.
     * @see #onPreExecute
     * @see #doInBackground
     * @see #onCancelled(Object)
     */
    @Override
    protected void onPostExecute(Boolean aBoolean) {
        super.onPostExecute(aBoolean);
        if (aBoolean) {
            GEDApplication.getSettingsHelper().savePreference(SettingsHelper.CLASS_DATA_VERSION, version);
            Log.d(this.getClass().getSimpleName(),
                    "File Downloaded. Local Class Schedule Data Version is now: " + version);
            if (progressView != null && progressView instanceof TextView){
                ((TextView)progressView).setText(dataRead);
            }
        } else {
            if (progressView != null && progressView instanceof TextView){
                ((TextView)progressView).setText(dataError);
            }
        }
    }

    /**
     * Runs on the UI thread after {@link #publishProgress} is invoked.
     * The specified values are the values passed to {@link #publishProgress}.
     *
     * @param values The values indicating progress.
     * @see #publishProgress
     * @see #doInBackground
     */
    @Override
    protected void onProgressUpdate(Integer... values) {
        if (progressView != null && progressView instanceof TextView){
            ((TextView)progressView).setText(dataGet+values[0]+"%");
        }
    }

    /**
     * Retrieves the JSON Class data from the web server.
     * @throws IOException
     */
    private boolean updateClassData() throws IOException{
        URL url = new URL("http://race2ged.org/wp-content/themes/adulted/ClassSchedule.json");
        boolean value = false;
        InputStream input = null;
        FileOutputStream output = null;
        HttpURLConnection conn = (HttpURLConnection) url.openConnection();
        conn.setReadTimeout(10000 /* milliseconds */);
        conn.setConnectTimeout(15000 /* milliseconds */);
        conn.setRequestMethod("GET");
        conn.setDoInput(true);
        // Starts the query
        conn.connect();
        int responseCode = conn.getResponseCode();
        if (responseCode==200) {
            Log.d(this.getClass().getSimpleName(), "Data file found on server. Proceeding with download.");
            try {
                String outputName = context.getString(R.string.class_data_file_name);
                input = conn.getInputStream();
                output = context.openFileOutput(outputName, Context.MODE_PRIVATE);

                int total_size = conn.getContentLength();

                int read;
                byte[] data = new byte[1024];
                int curSize = 1024;
                int perc=0;
                while ((read = input.read(data)) != -1) {
                    output.write(data, 0, read);
                    perc=((curSize / total_size) * 100);
                    publishProgress((perc)>100?100:perc);
                    curSize+=1024;
                }

                value = true;
            } finally {
                if (output != null)
                    output.close();
                if (input != null)
                    input.close();
            }
            return value;
        }
        Log.d(this.getClass().getSimpleName(), "Data file could not be found on server. Server may be down?");
        return false;
    }

    /**
     * Retrieves the current version of the class data on the web server
     * @param region The number for the region to get the version of.
     * @return
     */
    private int retrieveRemoteVersion(int region) throws IOException {
        URL url = new URL("http://race2ged.org/wp-content/themes/adulted/getClassScheduleVersion.php?region="+region);
        InputStream input = null;
        HttpURLConnection conn = (HttpURLConnection) url.openConnection();
        conn.setReadTimeout(10000 /* milliseconds */);
        conn.setConnectTimeout(15000 /* milliseconds */);
        conn.setRequestMethod("GET");
        conn.setDoInput(true);
        // Starts the query
        conn.connect();
        int responseCode = conn.getResponseCode();
        if (responseCode==200) {
            try {
                Log.d(this.getClass().getSimpleName(), "Server contacted successfully.");
                input = conn.getInputStream();
                BufferedReader buffer = new BufferedReader(new InputStreamReader(input));
                String s;
                String response = "";
                while ((s = buffer.readLine()) != null) {
                    response += s;
                }
                version = response.trim();
                Log.d(this.getClass().getSimpleName(), "Remote Class Schedule Version for Region: " +
                        region + " is: " + version + " (Local is: " + GEDApplication.getSettingsHelper().getClassDataVersion() + " )");
                return Integer.parseInt(response.trim());
            } finally {
                if (input != null)
                    input.close();
            }
        }
        Log.d(this.getClass().getSimpleName(), "Server could not be contacted.");
        return -1;
    }

    /**
     * Determine if we can check for updates or not.
     * @return
     */
    public Boolean canUpdate() {
        if ( GEDApplication.getSettingsHelper().getCheckForUpdates()) {
            Log.d(this.getClass().getSimpleName(),context.getString(R.string.checking_for_class_updates));
            int connection = Utils.getNetworkStatus(context);
            if (connection != Utils.NO_CONNECTION) {
                if ( GEDApplication.getSettingsHelper().getCheckOnWifiOnly()) {
                    if (connection == Utils.WIFI) {
                        Log.d(this.getClass().getSimpleName(),"Retrieving via WIFI-Only");
                        return true;
                    } else {
                        Log.d(this.getClass().getSimpleName(), context.getString(R.string.error_no_wifi));
                        return false;
                    }
                } else {
                    if (connection == Utils.WIFI){
                        Log.d(this.getClass().getSimpleName(), "Retrieving via WIFI");
                    }
                    if (connection == Utils.MOBILE_DATA) {
                        Log.d(this.getClass().getSimpleName(), "Retrieving via Mobile Data");
                    }
                    return true;
                }
            } else {
                Log.d(this.getClass().getSimpleName(),context.getString(R.string.error_no_connection));
                return false;
            }
        }
        return false;
    }
}
Java Source Code List
