Skip to content

carstentrink/gphotosync

Repository files navigation

gphotosync

An app to download pictures and videos stored in your Google Photos.

Build Status codecov Go Report Card

This app is a fork of Denis Vashchuk's project.

Table of Contents

How it works

gphotosync downloads all the content of your Google Photos library to a local directory (current directory by default, otherwise to the one specified with -lib [path] command line option. It creates year/month/ directory structure. If two files with the same filename happen to fit into the same month, the most recent one will be saved under its original filename, while the rest will have timestamp appended, so the directory structure will look something like this:

+-- 2019/
|  +-- 07/
|  |  +-- 01.jpg
|  |  +-- 02.jpg
|  |  +-- 20190704.JPG
|  +-- 05/
|  |  +-- VIDEO.MPG
|  |  +-- VIDEO-gphotosync-159b90e8a152aa00.MPG
|  |  +-- VIDEO-gphotosync-159e8e0cdc16be00.MPG
|  +-- 01/
|     +-- IMG512.JPG
+-- 2018/
|  +-- 12/
|  |  +-- IMAGE01.JPG
|  +-- 11/
|     +-- 0001.jpg
|     +-- 0004.jpg
...etc

The appended value is by default a hex representation of Unix timestamp. You can use -strategy id command line option to append Google Photo ID of the media file instead of timestamp.

Usage

If you are planning to use the app for scheduled backups (which is totally OK), please consider the following:

  • It's not a good idea to schedule these backups to run on the hour (i.e. at 3:00, 10:00, 17:00, etc.), and it's even worse to schedule them for midnight. If enough people do that, Google servers will have to process a lot of requests from all of us at the same very second; eventially Google will ban the API key. The app already has a random delay (between 0 and 60 seconds) before it starts, but you can help things more if you schedule the runs for some random minute of the hour.
  • If the limit for Google API requests per day is reached, the app will pause for a minute before retrying to request more files, then for 2 minutes, then for 4 minutes, and so on, and so on. If a lot of users use the same pre-compiled project key, the delays can get significant, so it's a good idea to use some kind of blocking so that your new backup doesn't start before the previous one is finished. Linux users are advised to use setlock in their cron jobs.

Authentification

Since Google deprecated the Out-Of-Band OAuth flow, logging in requires a trick. The app will give you a URL to open in your browser, use that URL to log into your Google account and allow the app to work with your Photos. The browser will then get redirected to a localhost address and you'll see a message saying something like "couldn't connect to 127.0.0.1:8088". This is completely normal; what you need is to copy the URL (starting with 127.0.0.1) from the browser's address bar, and paste it into the app.

You can use your own project's credentials for authentification: create a project using Photos Library API in Google Developers Console, create credentials for it (you need to create OAuth Client ID for a Web application and use arbitraty localhost address for your Authorized redirect URIs, something like http://127.0.0.1:8088, one address is enough), download JSON credentials file from ID page, rename it to .client_secret.json and put in the directory where your local photos library will be downloaded. If no .client_secret.json is found in the working directory, the credentials supplied at build time will be used.

Building the app

If you want authentification credentials compiled in, supply both client_id and client_secret from your .client_secret.json at compile time (see Authentification section for details):

go build -ldflags "-X main.googleClientId={client_id} -X main.googleClientSecret={client_secret}"

Privacy considerations

If you're using the precompiled version of the app with builtin project credentials, the activity of your copy of the app will be included in what I see in my Google Developer Console (it shows the cumulative activity such as number of requests per hour or day, median delay in serving those requests, and so on; I'm not aware of any way to see any personal or personalized data there). Other than that no one (but Google and your ISP or VPN provider, of course) has any way to have any access to your stuff or collect any data about how you are using it. Hey, you can read the source code and see for yourself what it does, and you can recompile the code yourself just to make sure!

Credits

This software includes the following software or parts thereof:

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published