Add GPX support

build.gradle

@@ -69,6 +69,9 @@ dependencies {
     compile "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
     compile "com.corundumstudio.socketio:netty-socketio:1.7.7"
 
+    compile group: 'org.jdom', name: 'jdom', version: '2.0.0'
+
+
     compile 'org.springframework.boot:spring-boot-starter'
     compile 'org.springframework.boot:spring-boot-starter-web'
     compile 'org.springframework.boot:spring-boot-starter-undertow'

config.properties.template

@@ -230,6 +230,11 @@ export=
 # Initial map size (S2 tiles) to fetch (max. 9: ~3*3km area)
 initial_map_size=9
 
+# GPX file to be added on the bot's start
+gpx_file=
+# Number of times the bot must repeat this GPX file
+gpx_repeat=-1
+
 # For artificial pauses/rests
 # Chance to wait randomly at a pokestop in %, recommended about 10 or less, default disabled
 wait_chance=0.0

json-template.json

@@ -77,6 +77,8 @@
   "evolveTimeDelay" : 300,
   "export" : "",
   "guiPortSocket" : 8001,
+  "gpxFile": "",
+  "gpxRepeat": -1,
   "initialMapSize" : 9,
   "waitChance" : 0.0,
   "waitTimeMin" : 0,

src/main/kotlin/ink/abb/pogo/scraper/Bot.kt

@@ -114,10 +114,13 @@ class Bot(val api: PokemonGo, val settings: Settings) {
         val evolve = EvolvePokemon()
         val hatchEggs = HatchEggs()
         val export = Export()
+        val readGpx = ReadGpx()
 
         if (settings.export.length > 0)
             task(export)
 
+        task(readGpx)
+
         task(keepalive)
         Log.normal("Getting initial pokestops...")
 

src/main/kotlin/ink/abb/pogo/scraper/Context.kt

@@ -12,6 +12,7 @@ import com.google.common.util.concurrent.AtomicDouble
 import com.google.maps.GeoApiContext
 import com.pokegoapi.api.PokemonGo
 import com.pokegoapi.api.player.PlayerProfile
+import com.pokegoapi.google.common.geometry.S2LatLng
 import ink.abb.pogo.scraper.gui.SocketServer
 import java.time.LocalDateTime
 import java.util.concurrent.atomic.AtomicBoolean
@@ -45,5 +46,7 @@ data class Context(
 
         val pauseWalking: AtomicBoolean = AtomicBoolean(false),
 
+        val coordinatesToGoTo: MutableList<S2LatLng> = mutableListOf<S2LatLng>()
+
         val geoApiContext: GeoApiContext?
 )

src/main/kotlin/ink/abb/pogo/scraper/Settings.kt

@@ -137,6 +137,10 @@ class SettingsParser(val properties: Properties) {
 
                 guiPortSocket = getPropertyIfSet("Port where the socketserver should listen", "gui_port_socket", defaults.guiPortSocket, String::toInt),
 
+                gpxFile = getPropertyIfSet("GPX file that the bot will follow", "gpx_file", defaults.gpxFile, String::toString),
+
+                gpxRepeat = getPropertyIfSet("Number of time that the GPX file will be repeated", "gpx_repeat", defaults.gpxRepeat, String::toInt),
+
                 restApiPassword = getPropertyIfSet("REST API password for the bot", "rest_api_password", defaults.restApiPassword, String::toString),
 
                 initialMapSize = getPropertyIfSet("Initial map size (S2 tiles) to fetch", "initial_map_size", defaults.initialMapSize, String::toInt),
@@ -289,6 +293,9 @@ data class Settings(
 
         var initialMapSize: Int = 9,
 
+        var gpxFile: String = "",
+        var gpxRepeat: Int = -1,
+
         val version: String = Settings.version,
 
         val waitChance: Double = 0.0,

src/main/kotlin/ink/abb/pogo/scraper/gui/SocketServer.kt

@@ -29,7 +29,6 @@ class SocketServer {
     private var ctx: Context? = null
     private var server: SocketIOServer? = null
 
-    val coordinatesToGoTo = mutableListOf<S2LatLng>()
 
     fun start(ctx: Context, port: Int) {
         val config = Configuration()

src/main/kotlin/ink/abb/pogo/scraper/tasks/ReadGpx.kt

@@ -0,0 +1,47 @@
+package ink.abb.pogo.scraper.tasks
+
+import com.pokegoapi.google.common.geometry.S2LatLng
+import ink.abb.pogo.scraper.Bot
+import ink.abb.pogo.scraper.Context
+import ink.abb.pogo.scraper.Settings
+import ink.abb.pogo.scraper.Task
+import ink.abb.pogo.scraper.util.Log
+import org.jdom2.Document
+
+import org.jdom2.input.SAXBuilder
+import java.io.File
+
+/**
+ * Created by Peyphour on 8/11/16.
+ */
+
+class ReadGpx : Task {
+    override fun run(bot: Bot, ctx: Context, settings: Settings) {
+
+        var builder: SAXBuilder = SAXBuilder()
+        var document: Document
+        try {
+            document = builder.build(File(settings.gpxFile))
+        } catch(e: Exception) {
+            // Invalid file or no file specified : Expected behaviour
+            return
+        }
+
+        val coords = document.rootElement.getChild("trk", document.rootElement.namespace)
+                        .getChild("trkseg", document.rootElement.namespace)
+
+        var i: Int = settings.gpxRepeat
+
+        Log.green("GPX plugin : reading file " + settings.gpxFile + " with $i repeats")
+
+        // gpxRepeat == 0 or -1 : No coordinates will be added
+        while(i > 0) {
+            for (element in coords.children)
+                ctx.coordinatesToGoTo.add(S2LatLng.fromRadians(
+                        element.getAttribute("lat").doubleValue,
+                        element.getAttribute("lon").doubleValue
+                ))
+            i--
+        }
+    }
+}

src/main/kotlin/ink/abb/pogo/scraper/tasks/Walk.kt

@@ -30,12 +30,13 @@ class Walk(val sortedPokestops: List<Pokestop>, val lootTimeouts: Map<String, Lo
         if (!ctx.walking.compareAndSet(false, true)) {
             return
         }
-
+        
         if (ctx.server.coordinatesToGoTo.size > 0) {
             val coordinates = ctx.server.coordinatesToGoTo.first()
             ctx.server.coordinatesToGoTo.removeAt(0)
+            Log.normal("Using supplied coordinate, number of remaining points : " + ctx.coordinatesToGoTo.size)
             Log.normal("Walking to ${coordinates.latDegrees()}, ${coordinates.lngDegrees()}")
-
+            
             walk(bot, ctx, settings, coordinates, settings.speed, true, null)
         } else {
             val nearestUnused: List<Pokestop> = sortedPokestops.filter {