KmlTrackWriter.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.io.file.exporter;

import com.google.android.apps.mytracks.content.DescriptionGenerator;
import com.google.android.apps.mytracks.content.DescriptionGeneratorImpl;
import com.google.android.apps.mytracks.content.MyTracksLocation;
import com.google.android.apps.mytracks.content.MyTracksProviderUtils;
import com.google.android.apps.mytracks.content.Sensor;
import com.google.android.apps.mytracks.content.Sensor.SensorData;
import com.google.android.apps.mytracks.content.Sensor.SensorDataSet;
import com.google.android.apps.mytracks.content.Track;
import com.google.android.apps.mytracks.content.Waypoint;
import com.google.android.apps.mytracks.content.Waypoint.WaypointType;
import com.google.android.apps.mytracks.io.file.TrackFileFormat;
import com.google.android.apps.mytracks.util.GoogleEarthUtils;
import com.google.android.apps.mytracks.util.StringUtils;
import com.google.android.maps.mytracks.R;
import com.google.common.annotations.VisibleForTesting;

import android.content.Context;
import android.database.Cursor;
import android.location.Location;
import android.net.Uri;

import java.io.File;
import java.io.OutputStream;
import java.io.PrintWriter;
import java.util.ArrayList;

/**
 * Write track as KML to a file.
 * 
 * @author Leif Hendrik Wilden
 */
public class KmlTrackWriter implements TrackWriter {

  private static final String WAYPOINT_STYLE = "waypoint";
  private static final String STATISTICS_STYLE = "statistics";
  private static final String START_STYLE = "start";
  private static final String END_STYLE = "end";
  private static final String TRACK_STYLE = "track";
  private static final String SCHEMA_ID = "schema";
  private static final String CADENCE = "cadence";
  private static final String HEART_RATE = "heart_rate";
  private static final String POWER = "power";

  private static final String
      WAYPOINT_ICON = "http://maps.google.com/mapfiles/kml/pushpin/blue-pushpin.png";
  private static final String
      STATISTICS_ICON = "http://maps.google.com/mapfiles/kml/pushpin/ylw-pushpin.png";
  private static final String
      START_ICON = "http://maps.google.com/mapfiles/kml/paddle/grn-circle.png";
  private static final String
      END_ICON = "http://maps.google.com/mapfiles/kml/paddle/red-circle.png";
  private static final String
      TRACK_ICON = "http://earth.google.com/images/kml-icons/track-directional/track-0.png";

  private final Context context;
  private final boolean multiple;
  private final boolean playTrack;
  private final DescriptionGenerator descriptionGenerator;  
  private final MyTracksProviderUtils myTracksProviderUtils;

  private PrintWriter printWriter;
  private ArrayList<Integer> powerList = new ArrayList<Integer>();
  private ArrayList<Integer> cadenceList = new ArrayList<Integer>();
  private ArrayList<Integer> heartRateList = new ArrayList<Integer>();
  private boolean hasPower;
  private boolean hasCadence;
  private boolean hasHeartRate;

  public KmlTrackWriter(Context context, boolean multiple, boolean playTrack) {
    this(context, multiple, playTrack, new DescriptionGeneratorImpl(context));
  }

  @VisibleForTesting
  KmlTrackWriter(Context context, boolean multiple, boolean playTrack,
      DescriptionGenerator descriptionGenerator) {
    this.context = context;
    this.multiple = multiple;
    this.playTrack = playTrack;
    this.descriptionGenerator = descriptionGenerator;
    this.myTracksProviderUtils = MyTracksProviderUtils.Factory.get(context);
  }

  @Override
  public String getExtension() {
    return TrackFileFormat.KML.getExtension();
  }

  @Override
  public void prepare(OutputStream outputStream) {
    this.printWriter = new PrintWriter(outputStream);
  }

  @Override
  public void close() {
    if (printWriter != null) {
      printWriter.flush();
      printWriter = null;
    }
  }

  @Override
  public void writeHeader(Track[] tracks) {
    if (printWriter != null) {
      printWriter.println("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
      printWriter.println("<kml xmlns=\"http://www.opengis.net/kml/2.2\"");
      printWriter.println("xmlns:gx=\"http://www.google.com/kml/ext/2.2\"");
      printWriter.println("xmlns:atom=\"http://www.w3.org/2005/Atom\">");
      printWriter.println("<Document>");
      printWriter.println("<open>1</open>");
      printWriter.println("<visibility>1</visibility>");
      Track track = tracks[0];
      printWriter.println("<name>" + StringUtils.formatCData(track.getName()) + "</name>");
      printWriter.println("<atom:author><atom:name>"
          + StringUtils.formatCData(context.getString(R.string.send_google_by_my_tracks, "", ""))
          + "</atom:name></atom:author>");
      writeTrackStyle();
      writePlacemarkerStyle(START_STYLE, START_ICON, 32, 1);
      writePlacemarkerStyle(END_STYLE, END_ICON, 32, 1);
      writePlacemarkerStyle(STATISTICS_STYLE, STATISTICS_ICON, 20, 2);
      writePlacemarkerStyle(WAYPOINT_STYLE, WAYPOINT_ICON, 20, 2);
      printWriter.println("<Schema id=\"" + SCHEMA_ID + "\">");
      writeSensorStyle(POWER, context.getString(R.string.description_sensor_power));
      writeSensorStyle(CADENCE, context.getString(R.string.description_sensor_cadence));
      writeSensorStyle(HEART_RATE, context.getString(R.string.description_sensor_heart_rate));
      printWriter.println("</Schema>");
    }
  }

  @Override
  public void writeFooter() {
    if (printWriter != null) {
      printWriter.println("</Document>");
      printWriter.println("</kml>");
    }
  }

  @Override
  public void writeBeginWaypoints(Track track) {
    if (printWriter != null) {
      printWriter.println("<Folder><name>"
          + StringUtils.formatCData(context.getString(R.string.track_markers, track.getName()))
          + "</name>");
      printWriter.println("<open>1</open>");
    }
  }

  @Override
  public void writeEndWaypoints() {
    if (printWriter != null) {
      printWriter.println("</Folder>");
    }
  }

  @Override
  public void writeWaypoint(Waypoint waypoint) {
    if (printWriter != null) {
      String styleName = waypoint.getType() == WaypointType.STATISTICS ? STATISTICS_STYLE
          : WAYPOINT_STYLE;
      String photoUrl = waypoint.getPhotoUrl();
      if (photoUrl != null && !photoUrl.equals("")) {
        float heading = getHeading(waypoint.getTrackId(), waypoint.getLocation());
        writePhotoOverlay(waypoint.getName(), waypoint.getCategory(), waypoint.getDescription(),
            styleName, waypoint.getLocation(), photoUrl, heading);
      } else {
        writePlacemark(waypoint.getName(), waypoint.getCategory(), waypoint.getDescription(),
            styleName, waypoint.getLocation());
      }
    }
  }

  @Override
  public void writeBeginTracks() {
    if (printWriter != null && multiple) {
      printWriter.println("<Folder id=\"" + GoogleEarthUtils.TOUR_FEATURE_ID_VALUE + "\">");
      printWriter.println("<name>" + context.getString(R.string.generic_tracks) + "</name>");
      printWriter.println("<open>1</open>");
    }
  }

  @Override
  public void writeEndTracks() {
    if (printWriter != null && multiple) {
      printWriter.println("</Folder>");
    }
  }
  
  @Override
  public void writeBeginTrack(Track track, Location startLocation) {
    if (printWriter != null) {
      String name = context.getString(R.string.marker_label_start, track.getName());
      writePlacemark(name, "", "", START_STYLE, startLocation);
      if (multiple) {
        // No need to add TOUR_FEATURE_ID_VALUE
        printWriter.println("<Placemark>");
      } else {
        printWriter.println("<Placemark id=\"" + GoogleEarthUtils.TOUR_FEATURE_ID_VALUE + "\">");
      }
      printWriter.println("<name>" + StringUtils.formatCData(track.getName()) + "</name>");
      printWriter.println(
          "<description>" + StringUtils.formatCData(track.getDescription()) + "</description>");
      printWriter.println("<styleUrl>#" + TRACK_STYLE + "</styleUrl>");
      writeCategory(track.getCategory());
      printWriter.println("<gx:MultiTrack>");
      printWriter.println("<altitudeMode>absolute</altitudeMode>");
      printWriter.println("<gx:interpolate>1</gx:interpolate>");
    }
  }

  @Override
  public void writeEndTrack(Track track, Location endLocation) {
    if (printWriter != null) {
      printWriter.println("</gx:MultiTrack>");
      printWriter.println("</Placemark>");
      String name = context.getString(R.string.marker_label_end, track.getName());
      String description = descriptionGenerator.generateTrackDescription(track, null, null, false);
      writePlacemark(name, "", description, END_STYLE, endLocation);
    }
  }

  @Override
  public void writeOpenSegment() {
    if (printWriter != null) {
      printWriter.println("<gx:Track>");
      hasPower = false;
      hasCadence = false;
      hasHeartRate = false;
      powerList.clear();
      cadenceList.clear();
      heartRateList.clear();
    }
  }

  @Override
  public void writeCloseSegment() {
    if (printWriter != null) {
      printWriter.println("<ExtendedData>");
      printWriter.println("<SchemaData schemaUrl=\"#" + SCHEMA_ID + "\">");
      if (hasPower) {
        writeSensorData(powerList, POWER);
      }
      if (hasCadence) {
        writeSensorData(cadenceList, CADENCE);
      }
      if (hasHeartRate) {
        writeSensorData(heartRateList, HEART_RATE);
      }
      printWriter.println("</SchemaData>");
      printWriter.println("</ExtendedData>");
      printWriter.println("</gx:Track>");
    }
  }

  @Override
  public void writeLocation(Location location) {
    if (printWriter != null) {
      printWriter.println(
          "<when>" + StringUtils.formatDateTimeIso8601(location.getTime()) + "</when>");
      printWriter.println("<gx:coord>" + getCoordinates(location, " ") + "</gx:coord>");
      if (location instanceof MyTracksLocation) {
        SensorDataSet sensorDataSet = ((MyTracksLocation) location).getSensorDataSet();
        int power = -1;
        int cadence = -1;
        int heartRate = -1;

        if (sensorDataSet != null) {
          if (sensorDataSet.hasPower()) {
            SensorData sensorData = sensorDataSet.getPower();
            if (sensorData.hasValue() && sensorData.getState() == Sensor.SensorState.SENDING) {
              hasPower = true;
              power = sensorData.getValue();
            }
          }
          if (sensorDataSet.hasCadence()) {
            SensorData sensorData = sensorDataSet.getCadence();
            if (sensorData.hasValue() && sensorData.getState() == Sensor.SensorState.SENDING) {
              hasCadence = true;
              cadence = sensorData.getValue();
            }
          }
          if (sensorDataSet.hasHeartRate()) {
            SensorData sensorData = sensorDataSet.getHeartRate();
            if (sensorData.hasValue() && sensorData.getState() == Sensor.SensorState.SENDING) {
              hasHeartRate = true;
              heartRate = sensorData.getValue();
            }
          }
        }
        powerList.add(power);
        cadenceList.add(cadence);
        heartRateList.add(heartRate);
      }
    }
  }

  /**
   * Writes the sensor data.
   * 
   * @param list a list of sensor data
   * @param name the name of the sensor data
   */
  private void writeSensorData(ArrayList<Integer> list, String name) {
    printWriter.println("<gx:SimpleArrayData name=\"" + name + "\">");
    for (int i = 0; i < list.size(); i++) {
      printWriter.println("<gx:value>" + list.get(i) + "</gx:value>");
    }
    printWriter.println("</gx:SimpleArrayData>");
  }

  /**
   * Writes a placemark.
   * 
   * @param name the name
   * @param category the category
   * @param description the description
   * @param styleName the style name
   * @param location the location
   */
  private void writePlacemark(
      String name, String category, String description, String styleName, Location location) {
    if (location != null) {
      printWriter.println("<Placemark>");
      printWriter.println("<name>" + StringUtils.formatCData(name) + "</name>");
      printWriter.println(
          "<description>" + StringUtils.formatCData(description) + "</description>");
      printWriter.println("<TimeStamp><when>"
          + StringUtils.formatDateTimeIso8601(location.getTime()) + "</when></TimeStamp>");
      printWriter.println("<styleUrl>#" + styleName + "</styleUrl>");
      writeCategory(category);
      printWriter.println("<Point>");
      printWriter.println("<coordinates>" + getCoordinates(location, ",") + "</coordinates>");
      printWriter.println("</Point>");
      printWriter.println("</Placemark>");
    }
  }
  
  /**
   * Writes a photo overlay.
   * 
   * @param name the name
   * @param category the category
   * @param description the description
   * @param styleName the style name
   * @param location the location
   * @param photoUrl the photo url
   * @param heading the heading
   */
  private void writePhotoOverlay(String name, String category, String description, String styleName,
      Location location, String photoUrl, float heading) {
    if (location != null) {
      printWriter.println("<PhotoOverlay>");
      printWriter.println("<name>" + StringUtils.formatCData(name) + "</name>");
      printWriter.println(
          "<description>" + StringUtils.formatCData(description) + "</description>");
      printWriter.print("<Camera>");
      printWriter.print("<longitude>" + location.getLongitude() + "</longitude>");
      printWriter.print("<latitude>" + location.getLatitude() + "</latitude>");
      printWriter.print("<altitude>20</altitude>");
      printWriter.print("<heading>" + heading + "</heading>");
      printWriter.print("<tilt>90</tilt>");
      printWriter.println("</Camera>");
      printWriter.println("<TimeStamp><when>"
          + StringUtils.formatDateTimeIso8601(location.getTime()) + "</when></TimeStamp>");
      printWriter.println("<styleUrl>#" + styleName + "</styleUrl>");
      writeCategory(category);
      if (playTrack) {
        printWriter.println("<Icon><href>" + Uri.decode(photoUrl) + "</href></Icon>"); 
      } else {
        Uri uri = Uri.parse(photoUrl);
        printWriter.println("<Icon><href>" + KmzTrackExporter.KMZ_IMAGES_DIR + File.separatorChar
            + uri.getLastPathSegment() + "</href></Icon>");        
      }
      
      printWriter.print("<ViewVolume>");
      printWriter.print("<near>10</near>");
      printWriter.print("<leftFov>-60</leftFov>");
      printWriter.print("<rightFov>60</rightFov>");
      printWriter.print("<bottomFov>-45</bottomFov>");
      printWriter.print("<topFov>45</topFov>");
      printWriter.println("</ViewVolume>");
      printWriter.println("<Point>");
      printWriter.println("<coordinates>" + getCoordinates(location, ",") + "</coordinates>");
      printWriter.println("</Point>");
      printWriter.println("</PhotoOverlay>");
    }
  }

  /**
   * Gets the heading to a location.
   * 
   * @param trackId the track id containing the location
   * @param location the location
   */
  private float getHeading(long trackId, Location location) {
    long trackPointId = myTracksProviderUtils.getTrackPointId(trackId, location);
    if (trackPointId == -1L) {
      return location.getBearing();
    }
    Cursor cursor = null;
    Location viewLocation;
    try {
      cursor = myTracksProviderUtils.getTrackPointCursor(trackId, trackPointId, 10, true);
      if (cursor == null || cursor.getCount() == 0) {
        return location.getBearing();
      }
      cursor.moveToPosition(cursor.getCount() - 1);
      viewLocation = myTracksProviderUtils.createTrackPoint(cursor);
    } finally {
      if (cursor != null) {
        cursor.close();
      }
    }  
    return viewLocation.bearingTo(location);
  }
  
  private String getCoordinates(Location location, String separator) {
    StringBuffer buffer = new StringBuffer();
    buffer.append(location.getLongitude() + separator + location.getLatitude());
    if (location.hasAltitude()) {
      buffer.append(separator + location.getAltitude());
    }
    return buffer.toString();    
  }

  /**
   * Writes the category.
   * 
   * @param category the category
   */
  private void writeCategory(String category) {
    if (category == null || category.equals("")) {
      return;
    }
    printWriter.println("<ExtendedData>");
    printWriter.println(
        "<Data name=\"type\"><value>" + StringUtils.formatCData(category) + "</value></Data>");
    printWriter.println("</ExtendedData>");
  }

  /**
   * Writes the track style.
   */
  private void writeTrackStyle() {
    printWriter.println("<Style id=\"" + TRACK_STYLE + "\">");
    printWriter.println("<LineStyle><color>7f0000ff</color><width>4</width></LineStyle>");
    printWriter.println("<IconStyle>");
    printWriter.println("<scale>1.3</scale>");
    printWriter.println("<Icon><href>" + TRACK_ICON + "</href></Icon>");
    printWriter.println("</IconStyle>");
    printWriter.println("</Style>");
  }

  /**
   * Writes a placemarker style.
   * 
   * @param name the name of the style
   * @param url the url of the style icon
   * @param x the x position of the hotspot
   * @param y the y position of the hotspot
   */
  private void writePlacemarkerStyle(String name, String url, int x, int y) {
    printWriter.println("<Style id=\"" + name + "\"><IconStyle>");
    printWriter.println("<scale>1.3</scale>");
    printWriter.println("<Icon><href>" + url + "</href></Icon>");
    printWriter.println(
        "<hotSpot x=\"" + x + "\" y=\"" + y + "\" xunits=\"pixels\" yunits=\"pixels\"/>");
    printWriter.println("</IconStyle></Style>");
  }

  /**
   * Writes a sensor style.
   * 
   * @param name the name of the sesnor
   * @param displayName the sensor display name
   */
  private void writeSensorStyle(String name, String displayName) {
    printWriter.println("<gx:SimpleArrayField name=\"" + name + "\" type=\"int\">");
    printWriter.println("<displayName>" + StringUtils.formatCData(displayName) + "</displayName>");
    printWriter.println("</gx:SimpleArrayField>");
  }
}