OpenTracks/MyTracks/src/com/google/android/apps/mytracks/fragments/StatsFragment.java

/*
 * Copyright 2008 Google Inc.
 *
 * 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 com.google.android.apps.mytracks.fragments;

import com.google.android.apps.mytracks.Constants;
import com.google.android.apps.mytracks.MyTracksApplication;
import com.google.android.apps.mytracks.content.Track;
import com.google.android.apps.mytracks.content.TrackDataHub;
import com.google.android.apps.mytracks.content.TrackDataHub.ListenerDataType;
import com.google.android.apps.mytracks.content.TrackDataListener;
import com.google.android.apps.mytracks.content.Waypoint;
import com.google.android.apps.mytracks.stats.TripStatistics;
import com.google.android.apps.mytracks.util.PreferencesUtils;
import com.google.android.apps.mytracks.util.StatsUtils;
import com.google.android.maps.mytracks.R;

import android.content.Context;
import android.content.SharedPreferences;
import android.location.Location;
import android.os.Bundle;
import android.support.v4.app.Fragment;
import android.util.Log;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;

import java.util.EnumSet;

/**
 * A fragment to display track statistics to the user.
 *
 * @author Sandor Dornbush
 * @author Rodrigo Damazio
 */
public class StatsFragment extends Fragment implements TrackDataListener {

  private static final String TAG = StatsFragment.class.getSimpleName();

  private TrackDataHub trackDataHub;
  private UiUpdateThread uiUpdateThread;

  // The start time of the current track.
  private long startTime = -1L;

  private boolean metricUnits = true; 
  private boolean reportSpeed = true;
  private Location lastLocation = null;
  private TripStatistics lastTripStatistics = null;
  
  // A runnable to update the total time field.
  private final Runnable updateTotalTime = new Runnable() {
    public void run() {
      if (isRecording()) {
        StatsUtils.setTotalTimeValue(getActivity(), System.currentTimeMillis() - startTime);
      }
    }
  };

  /**
   * A thread that updates the total time field every second.
   */
  private class UiUpdateThread extends Thread {
    @Override
    public void run() {
      Log.d(TAG, "UI update thread started");
      while (PreferencesUtils.getRecordingTrackId(getActivity()) != -1L) {
        getActivity().runOnUiThread(updateTotalTime);
        try {
          Thread.sleep(1000L);
        } catch (InterruptedException e) {
          Log.d(TAG, "UI update thread caught exception", e);
          break;
        }
      }
      Log.d(TAG, "UI update thread finished");
    }
  }

  @Override
  public View onCreateView(
      LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
    return inflater.inflate(R.layout.stats, container, false);
  }

  @Override
  public void onActivityCreated(Bundle savedInstanceState) {
    super.onActivityCreated(savedInstanceState);
    SharedPreferences preferences = getActivity().getSharedPreferences(
        Constants.SETTINGS_NAME, Context.MODE_PRIVATE);
    metricUnits = preferences.getBoolean(getString(R.string.metric_units_key), true); 
    reportSpeed = preferences.getBoolean(getString(R.string.report_speed_key), true);
    updateUi();
  }

  @Override
  public void onResume() {
    super.onResume();
    resumeTrackDataHub();
  }

  @Override
  public void onPause() {
    super.onPause();
    pauseTrackDataHub();
    if (uiUpdateThread != null) {
      uiUpdateThread.interrupt();
      uiUpdateThread = null;
    }
  }

  @Override
  public void onProviderStateChange(ProviderState state) {
    if (state == ProviderState.DISABLED || state == ProviderState.NO_FIX) {
      getActivity().runOnUiThread(new Runnable() {
        @Override
        public void run() {
          lastLocation = null;
          StatsUtils.setLocationValues(getActivity(), lastLocation, metricUnits, reportSpeed);
        }
      });
    }
  }

  @Override
  public void onCurrentLocationChanged(final Location location) {
    if (isRecording()) {
      getActivity().runOnUiThread(new Runnable() {
        @Override
        public void run() {
          lastLocation = location;
          StatsUtils.setLocationValues(getActivity(), lastLocation, metricUnits, reportSpeed);
        }
      });
    }
  }

  @Override
  public void onCurrentHeadingChanged(double heading) {
    // We don't care.
  }

  @Override
  public void onSelectedTrackChanged(Track track, boolean isRecording) {
    if (uiUpdateThread == null && isRecording) {
      uiUpdateThread = new UiUpdateThread();
      uiUpdateThread.start();
    } else if (uiUpdateThread != null && !isRecording) {
      uiUpdateThread.interrupt();
      uiUpdateThread = null;
    }
  }

  @Override
  public void onTrackUpdated(final Track track) {
    getActivity().runOnUiThread(new Runnable() {
      @Override
      public void run() {
        if (track == null || track.getStatistics() == null) {
          lastLocation = null;
          lastTripStatistics = null;
          updateUi();
          return;
        }
        lastTripStatistics = track.getStatistics();
        
        startTime = track.getStatistics().getStartTime();
        if (!isRecording()) {
          lastLocation = null;
        }
        updateUi();
      }
    });
  }

  @Override
  public void clearTrackPoints() {
    // We don't care.
  }

  @Override
  public void onNewTrackPoint(Location loc) {
    // We don't care.
  }

  @Override
  public void onSampledOutTrackPoint(Location loc) {
    // We don't care.
  }

  @Override
  public void onSegmentSplit() {
    // We don't care.
  }

  @Override
  public void onNewTrackPointsDone() {
    // We don't care.
  }

  @Override
  public void clearWaypoints() {
    // We don't care.
  }

  @Override
  public void onNewWaypoint(Waypoint wpt) {
    // We don't care.
  }

  @Override
  public void onNewWaypointsDone() {
    // We don't care.
  }

  @Override
  public boolean onUnitsChanged(final boolean metric) {
    getActivity().runOnUiThread(new Runnable() {
      @Override
      public void run() {
        metricUnits = metric;
        updateUi();
      }
    });
    return true;
  }

  @Override
  public boolean onReportSpeedChanged(final boolean speed) {
    getActivity().runOnUiThread(new Runnable() {
      @Override
      public void run() {
        reportSpeed = speed;
        updateUi();
      }
    });
    return true;
  }

  /**
   * Resumes the trackDataHub. Needs to be synchronized because trackDataHub can
   * be accessed by multiple threads.
   */
  private synchronized void resumeTrackDataHub() {
    trackDataHub = ((MyTracksApplication) getActivity().getApplication()).getTrackDataHub();
    trackDataHub.registerTrackDataListener(this, EnumSet.of(
        ListenerDataType.SELECTED_TRACK_CHANGED,
        ListenerDataType.TRACK_UPDATES,
        ListenerDataType.LOCATION_UPDATES,
        ListenerDataType.DISPLAY_PREFERENCES));
  }

  /**
   * Pauses the trackDataHub. Needs to be synchronized because trackDataHub can
   * be accessed by multiple threads.
   */
  private synchronized void pauseTrackDataHub() {
    trackDataHub.unregisterTrackDataListener(this);
    trackDataHub = null;
  }

  /**
   * Returns true if recording. Needs to be synchronized because trackDataHub
   * can be accessed by multiple threads.
   */
  private synchronized boolean isRecording() {
    return trackDataHub != null && trackDataHub.isRecordingSelected();
  }
  
  private void updateUi() {
    StatsUtils.setSpeedLabels(getActivity(), reportSpeed, true);
    StatsUtils.setTripStatisticsValues(getActivity(), lastTripStatistics, metricUnits, reportSpeed);
    StatsUtils.setLocationValues(getActivity(), lastLocation, metricUnits, reportSpeed);
  }
}