OpenTracks/MyTracks/src/com/google/android/apps/mytracks/SearchActivity.java

/*
 * Copyright 2011 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;

import static com.google.android.apps.mytracks.Constants.TAG;

import com.google.android.apps.mytracks.content.MyTracksProviderUtils;
import com.google.android.apps.mytracks.content.SearchEngine;
import com.google.android.apps.mytracks.content.SearchEngine.ScoredResult;
import com.google.android.apps.mytracks.content.SearchEngine.SearchQuery;
import com.google.android.apps.mytracks.content.SearchEngineProvider;
import com.google.android.apps.mytracks.content.Track;
import com.google.android.apps.mytracks.content.TracksColumns;
import com.google.android.apps.mytracks.content.Waypoint;
import com.google.android.apps.mytracks.content.WaypointsColumns;
import com.google.android.apps.mytracks.stats.TripStatistics;
import com.google.android.apps.mytracks.util.StringUtils;
import com.google.android.maps.mytracks.R;

import android.app.ListActivity;
import android.app.SearchManager;
import android.content.ContentUris;
import android.content.Context;
import android.content.Intent;
import android.content.SharedPreferences;
import android.location.Location;
import android.location.LocationManager;
import android.net.Uri;
import android.os.Bundle;
import android.provider.SearchRecentSuggestions;
import android.util.Log;
import android.view.View;
import android.widget.ListView;
import android.widget.SimpleAdapter;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.SortedSet;

/**
 * Activity to search for tracks or waypoints.
 *
 * @author Rodrigo Damazio
 */
public class SearchActivity extends ListActivity {

  private static final String ICON_FIELD = "icon";
  private static final String NAME_FIELD = "name";
  private static final String DESCRIPTION_FIELD = "description";
  private static final String CATEGORY_FIELD = "category";
  private static final String TIME_FIELD = "time";
  private static final String STATS_FIELD = "stats";
  private static final String TRACK_ID_FIELD = "trackId";
  private static final String WAYPOINT_ID_FIELD = "waypointId";

  private static final String EXTRA_CURRENT_TRACK_ID = "trackId";

  private static final boolean LOG_SCORES = true;

  private MyTracksProviderUtils providerUtils;
  private SearchEngine engine;
  private LocationManager locationManager;
  private SharedPreferences preferences;

  private SearchRecentSuggestions suggestions;

  private boolean metricUnits;

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    providerUtils = MyTracksProviderUtils.Factory.get(this);
    engine = new SearchEngine(providerUtils);
    suggestions = SearchEngineProvider.newHelper(this);
    locationManager = (LocationManager) getSystemService(LOCATION_SERVICE);
    preferences = getSharedPreferences(Constants.SETTINGS_NAME, Context.MODE_PRIVATE);

    setContentView(R.layout.search_list);

    handleIntent(getIntent());
  }

  @Override
  protected void onResume() {
    super.onResume();

    metricUnits =
        preferences.getBoolean(getString(R.string.metric_units_key), true);
  }

  @Override
  protected void onNewIntent(Intent intent) {
    setIntent(intent);
    handleIntent(intent);
  }

  private void handleIntent(Intent intent) {
    if (!Intent.ACTION_SEARCH.equals(intent.getAction())) {
      Log.e(TAG, "Got bad search intent: " + intent);
      finish();
      return;
    }

    String textQuery = intent.getStringExtra(SearchManager.QUERY);
    Location currentLocation = locationManager.getLastKnownLocation("gps");
    long currentTrackId = intent.getLongExtra(EXTRA_CURRENT_TRACK_ID, -1);
    long currentTimestamp = System.currentTimeMillis();

    final SearchQuery query =
        new SearchQuery(textQuery, currentLocation, currentTrackId, currentTimestamp);

    // Do the actual search in a separate thread.
    new Thread() {
      @Override
      public void run() {
        doSearch(query);
      }
    }.start();
  }

  private void doSearch(SearchQuery query) {
    SortedSet<ScoredResult> scoredResults = engine.search(query);

    final List<? extends Map<String, ?>> displayResults = prepareResultsforDisplay(scoredResults);

    if (LOG_SCORES) {
      Log.i(TAG, "Search scores: " + displayResults);
    }

    // Then go back to the UI thread to display them.
    runOnUiThread(new Runnable() {
      @Override
      public void run() {
        showSearchResults(displayResults);
      }
    });

    // Save the query as a suggestion for the future.
    suggestions.saveRecentQuery(query.textQuery, null);
  }

  private List<Map<String, Object>> prepareResultsforDisplay(
      Collection<ScoredResult> scoredResults) {
    ArrayList<Map<String, Object>> output = new ArrayList<Map<String, Object>>(scoredResults.size());
    for (ScoredResult result : scoredResults) {
      Map<String, Object> resultMap = new HashMap<String, Object>();
      if (result.track != null) {
        prepareTrackForDisplay(result.track, resultMap);
      } else {
        prepareWaypointForDisplay(result.waypoint, resultMap);
      }

      resultMap.put("score", result.score);

      output.add(resultMap);
    }

    return output;
  }

  private void prepareWaypointForDisplay(Waypoint waypoint, Map<String, Object> resultMap) {
    // Look up the owner track.
    // TODO: It may be more appropriate to do this as a join in the retrieval phase of the search.
    String trackName = null;
    long trackId = waypoint.getTrackId();
    if (trackId > 0) {
      Track track = providerUtils.getTrack(trackId);
      if (track != null) {
        trackName = track.getName();
      }
    }

    resultMap.put(ICON_FIELD, waypoint.getType() == Waypoint.TYPE_STATISTICS
        ? R.drawable.ylw_pushpin : R.drawable.blue_pushpin);
    resultMap.put(NAME_FIELD, waypoint.getName());
    resultMap.put(DESCRIPTION_FIELD, waypoint.getDescription());
    resultMap.put(CATEGORY_FIELD, waypoint.getCategory());
    // In the same place as we show time for tracks, show the track name for waypoints.
    resultMap.put(TIME_FIELD, getString(R.string.track_list_track_name, trackName));
    resultMap.put(STATS_FIELD, StringUtils.formatDateTime(this, waypoint.getLocation().getTime()));
    resultMap.put(TRACK_ID_FIELD, waypoint.getTrackId());
    resultMap.put(WAYPOINT_ID_FIELD, waypoint.getId());
  }

  private void prepareTrackForDisplay(Track track, Map<String, Object> resultMap) {
    TripStatistics stats = track.getStatistics();

    resultMap.put(ICON_FIELD, R.drawable.track);
    resultMap.put(NAME_FIELD, track.getName());
    resultMap.put(DESCRIPTION_FIELD, track.getDescription());
    resultMap.put(CATEGORY_FIELD, track.getCategory());
    resultMap.put(TIME_FIELD, StringUtils.formatDateTime(this, stats.getStartTime()));
    resultMap.put(STATS_FIELD, StringUtils.formatTimeDistance(
        this, stats.getTotalTime(), stats.getTotalDistance(), metricUnits));
    resultMap.put(TRACK_ID_FIELD, track.getId());
  }

  /**
   * Shows the given search results.
   * Must be run from the UI thread.
   *
   * @param data the results to show, properly ordered
   */
  private void showSearchResults(List<? extends Map<String, ?>> data) {
    SimpleAdapter adapter = new SimpleAdapter(this, data,
        // TODO: Custom view for search results.
        R.layout.mytracks_list_item,
        new String[] {
          ICON_FIELD,
          NAME_FIELD,
          DESCRIPTION_FIELD,
          CATEGORY_FIELD,
          TIME_FIELD,
          STATS_FIELD,
        },
        new int[] {
          R.id.track_list_item_icon,
          R.id.track_list_item_name,
          R.id.track_list_item_description,
          R.id.track_list_item_category,
          R.id.track_list_item_time,
          R.id.track_list_item_stats,
        });

    setListAdapter(adapter);
  }

  @Override
  protected void onListItemClick(ListView l, View v, int position, long id) {
    @SuppressWarnings("unchecked")
    Map<String, Object> clickedData = (Map<String, Object>) getListAdapter().getItem(position);

    startActivity(createViewDataIntent(clickedData));
  }

  private Intent createViewDataIntent(Map<String, Object> clickedData) {
    Intent intent = new Intent(Intent.ACTION_VIEW);
    if (clickedData.containsKey(WAYPOINT_ID_FIELD)) {
      long waypointId = (Long) clickedData.get(WAYPOINT_ID_FIELD);
      Uri uri = ContentUris.withAppendedId(WaypointsColumns.CONTENT_URI, waypointId);
      intent.setDataAndType(uri, WaypointsColumns.CONTENT_ITEMTYPE);
    } else {
      long trackId = (Long) clickedData.get(TRACK_ID_FIELD);
      Uri uri = ContentUris.withAppendedId(TracksColumns.CONTENT_URI, trackId);
      intent.setDataAndType(uri, TracksColumns.CONTENT_ITEMTYPE);
    }
    return intent;
  }
}