├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── src └── main │ ├── webapp │ └── WEB-INF │ │ ├── appengine-web.xml │ │ └── web.xml │ └── java │ └── app │ └── servlets │ ├── Utils.java │ └── Geocoder.java ├── .gitignore ├── gradlew.bat ├── README.md └── gradlew /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/renaudcerrato/appengine-ip-to-location/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /src/main/webapp/WEB-INF/appengine-web.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | java8 4 | true 5 | 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .classpath 2 | .project 3 | .settings 4 | eclipsebin 5 | 6 | bin 7 | gen 8 | build 9 | out 10 | lib 11 | 12 | target 13 | pom.xml.* 14 | release.properties 15 | local.properties 16 | 17 | .idea 18 | .gradle 19 | *.iml 20 | classes 21 | 22 | obj 23 | 24 | .DS_Store 25 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Wed Jan 16 09:34:38 CET 2019 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-3.5-all.zip 7 | -------------------------------------------------------------------------------- /src/main/webapp/WEB-INF/web.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | GeocoderServlet 5 | app.servlets.Geocoder 6 | 7 | 8 | GeocoderServlet 9 | /api/v1/geocoder 10 | 11 | 12 | 13 | 14 | everything 15 | /* 16 | 17 | 18 | CONFIDENTIAL 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /src/main/java/app/servlets/Utils.java: -------------------------------------------------------------------------------- 1 | package app.servlets; 2 | 3 | import javax.servlet.http.HttpServletRequest; 4 | 5 | final public class Utils { 6 | 7 | private Utils() {} 8 | 9 | public static String getClientAddr(HttpServletRequest request) { 10 | String ip = request.getHeader("X-Forwarded-For"); 11 | if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { 12 | ip = request.getHeader("Proxy-Client-IP"); 13 | } 14 | if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { 15 | ip = request.getHeader("WL-Proxy-Client-IP"); 16 | } 17 | if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { 18 | ip = request.getHeader("HTTP_CLIENT_IP"); 19 | } 20 | if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { 21 | ip = request.getHeader("HTTP_X_FORWARDED_FOR"); 22 | } 23 | if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { 24 | ip = request.getRemoteAddr(); 25 | } 26 | return ip; 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /src/main/java/app/servlets/Geocoder.java: -------------------------------------------------------------------------------- 1 | package app.servlets; 2 | 3 | 4 | import com.google.gson.JsonObject; 5 | 6 | import javax.servlet.annotation.HttpConstraint; 7 | import javax.servlet.annotation.ServletSecurity; 8 | import javax.servlet.annotation.WebServlet; 9 | import javax.servlet.http.HttpServlet; 10 | import javax.servlet.http.HttpServletRequest; 11 | import javax.servlet.http.HttpServletResponse; 12 | import java.io.IOException; 13 | import java.util.logging.Logger; 14 | 15 | public class Geocoder extends HttpServlet { 16 | 17 | private static final Logger LOGGER = Logger.getLogger(Geocoder.class.getName()); 18 | 19 | private static final String X_APP_ENGINE_COUNTRY = "X-AppEngine-Country"; 20 | private static final String X_APP_ENGINE_REGION = "X-AppEngine-Region"; 21 | private static final String X_APP_ENGINE_CITY = "X-AppEngine-City"; 22 | private static final String X_APP_ENGINE_CITY_LAT_LONG = "X-AppEngine-CityLatLong"; 23 | 24 | @Override 25 | public void doGet(HttpServletRequest request, HttpServletResponse response) 26 | throws IOException { 27 | 28 | final String country = request.getHeader(X_APP_ENGINE_COUNTRY); 29 | final String region = request.getHeader(X_APP_ENGINE_REGION); 30 | final String city = request.getHeader(X_APP_ENGINE_CITY); 31 | final String latlon = request.getHeader(X_APP_ENGINE_CITY_LAT_LONG); 32 | 33 | JsonObject json = new JsonObject(); 34 | json.addProperty("ip", Utils.getClientAddr(request)); 35 | json.addProperty("country", country); 36 | json.addProperty("city", city); 37 | json.addProperty("region", region); 38 | 39 | 40 | if(latlon != null) { 41 | final String[] loc = latlon.split(","); 42 | 43 | if(loc.length == 2) { 44 | try { 45 | double lat = Double.valueOf(loc[0]); 46 | double lon = Double.valueOf(loc[1]); 47 | json.addProperty("lat", lat); 48 | json.addProperty("long", lon); 49 | }catch(NumberFormatException e) { 50 | LOGGER.warning("unable to parse lat/long: " + latlon); 51 | } 52 | } 53 | } 54 | 55 | response.setContentType("application/json"); 56 | response.getWriter().print(json.toString()); 57 | } 58 | } -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Simple IP Address Geocoding on App-Engine 2 | 3 | Simple (and fast) Google App-Engine application to fetch the city, coordinates, region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)) and the country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)) based on caller's IP address. 4 | 5 | * [Why ?](#why) 6 | * [Usage](#usage) 7 | * [Prerequisites](#prerequisites) 8 | * [Deployment](#deployment) 9 | * [How does it work?](#how-does-it-work) 10 | * [License](#license) 11 | 12 | # Why? 13 | 14 | The primary usage is to provide your application(s) a **fallback** (or best effort) if the geolocation is unavailable. 15 | 16 | # Usage 17 | 18 | The application exposes a single endpoint that will return the caller's geolocation based on its IP address: 19 | 20 | ```bash 21 | $ curl https://.appspot.com/api/v1/geocoder 22 | { 23 | "lat": 40.714353, 24 | "long": -74.005973, 25 | "country": "US", 26 | "city": "new york", 27 | "region": "ny", 28 | "ip": "31.6.43.126", 29 | } 30 | ``` 31 | 32 | # Prerequisites # 33 | 34 | ### Create a new Project 35 | First of all, you'll need to go to your [Google Cloud console](https://console.cloud.google.com/projectselector/appengine/create?lang=java&st=true) to create a new App Engine application: 36 | 37 | ![](https://i.imgur.com/WMVMHa3.png) 38 | 39 | 40 | ### Setup the Google Cloud SDK 41 | 42 | Follow the [official documentation](https://cloud.google.com/sdk/docs/) to install the latest Google Cloud SDK. As a shorthand, you'll find below the Ubuntu/Debian instructions: 43 | 44 | 45 | ```bash 46 | $ export CLOUD_SDK_REPO="cloud-sdk-$(lsb_release -c -s)" 47 | $ echo "deb http://packages.cloud.google.com/apt $CLOUD_SDK_REPO main" | sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list 48 | $ curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key add - 49 | $ sudo apt-get update && sudo apt-get install google-cloud-sdk 50 | ``` 51 | 52 | Do not forget to install the `app-engine-java` [component](https://cloud.google.com/sdk/docs/components#external_package_managers). If you installed the Google Cloud SDK using `apt-get`, it's as simple as: 53 | 54 | ```bash 55 | $ sudo apt-get install google-cloud-sdk-app-engine-java 56 | ``` 57 | 58 | As a last step, configure the `gcloud` command line environment and select your newly created App Engine project when requested to do so: 59 | 60 | ```bash 61 | $ gcloud init 62 | $ gcloud auth application-default login 63 | ``` 64 | # Deployment 65 | 66 | Clone (or [download](https://github.com/renaudcerrato/appengine-ip-to-location/archive/master.zip)) the source code, and deploy: 67 | 68 | ```bash 69 | $ git clone https://github.com/renaudcerrato/appengine-ip-to-location.git 70 | $ cd appengine-ip-to-location 71 | $ ./gradlew appengineDeploy 72 | ``` 73 | 74 | # How does it work? 75 | 76 | The application simply forwards App Engine [geolocation headers](https://cloud.google.com/appengine/docs/standard/java/reference/request-response-headers#app_engine-specific_headers) to the caller in a JSON format. 77 | 78 | Here's the details about the headers returned: 79 | 80 | ### X-AppEngine-Country 81 | 82 | Country from which the request originated, as an ISO 3166-1 alpha-2 country code. App Engine determines this code from the client's IP address. Note that the country information is not derived from the WHOIS database; it's possible that an IP address with country information in the WHOIS database will not have country information in the X-AppEngine-Country header. **Your application should handle the special country code ZZ (unknown country)**. 83 | 84 | ### X-AppEngine-Region 85 | Name of region from which the request originated. This value only makes sense in the context of the country in X-AppEngine-Country. For example, if the country is "US" and the region is "ca", that "ca" means "California", not Canada. The complete list of valid region values is found in the ISO-3166-2 standard. 86 | 87 | ### X-AppEngine-City 88 | 89 | Name of the city from which the request originated. For example, a request from the city of Mountain View might have the header value mountain view. There is no canonical list of valid values for this header. 90 | 91 | ### X-AppEngine-CityLatLong 92 | 93 | Latitude and longitude of the city from which the request originated. This string might look like "37.386051,-122.083851" for a request from Mountain View. 94 | 95 | # License 96 | 97 | ``` 98 | Copyright 2018 Cerrato Renaud 99 | 100 | Licensed under the Apache License, Version 2.0 (the "License"); 101 | you may not use this file except in compliance with the License. 102 | You may obtain a copy of the License at 103 | 104 | http://www.apache.org/licenses/LICENSE-2.0 105 | 106 | Unless required by applicable law or agreed to in writing, software 107 | distributed under the License is distributed on an "AS IS" BASIS, 108 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 109 | See the License for the specific language governing permissions and 110 | limitations under the License. 111 | ``` 112 | 113 | 114 | 115 | 116 | 117 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn ( ) { 37 | echo "$*" 38 | } 39 | 40 | die ( ) { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save ( ) { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | --------------------------------------------------------------------------------