Google drive downloader

gdrive-downloader is a collection of shell scripts runnable on all POSIX compatible shells ( sh / ksh / dash / bash / zsh / etc ).

It can be used to to download files or folders from google gdrive.

• Minimal
• Authentication support ( not required for public files/folders ).
• Download gdrive files and folders
  • Download subfolders
• Resume Interrupted downloads
• Parallel downloading
• Pretty logging
• Easy to install and update
  • Self update
  • Auto update
  • Can be per-user and invoked per-shell, hence no root access required or global install.

Table of Contents

• Compatibility
  • Linux or MacOS
  • Android
  • iOS
  • Windows
• Installing and Updating
  • Native Dependencies
  • Installation
    • Basic Method
    • Advanced Method
    • Migrate from old version
  • Updation
• Usage
  • Download Script Custom Flags
  • Enable Drive API
  • Oauth Authentication
  • Retrieve Api key
  • Progress Bar
  • Multiple Inputs
  • Resuming Interrupted Downloads
• Uninstall
• How it works
• Reporting Issues
• Contributing
• License

Compatibility

As this is a collection of shell scripts, there aren't many dependencies. See Native Dependencies after this section for explicitly required program list.

Linux or MacOS

For Linux or MacOS, you hopefully don't need to configure anything extra, it should work by default.

Android

Install Termux.

Then, pkg install curl and done.

It's fully tested for all usecases of this script.

iOS

Install iSH

While it has not been officially tested, but should work given the description of the app. Report if you got it working by creating an issue.

Windows

Use Windows Subsystem

Again, it has not been officially tested on windows, there shouldn't be anything preventing it from working. Report if you got it working by creating an issue.

Installing and Updating

Native Dependencies

This repo contains two types of scripts, posix compatible and bash compatible.

These programs are required in both bash and posix scripts.

If BASH is not available or BASH is available but version is less tham 4.x, then below programs are also required:

Installation

You can install the script by automatic installation script provided in the repository.

Default values set by automatic installation script, which are changeable:

Repo: Akianonymus/gdrive-downloader

Command name: gdl

Installation path: $HOME/.gdrive-downloader

Source value: master

Shell file: .bashrc or .zshrc or .profile

For custom command name, repo, shell file, etc, see advanced installation method.

Now, for automatic install script, there are two ways:

Basic Method

To install gdrive-downloader in your system, you can run the below command:

curl -Ls --compressed https://drivedl.cf | sh -s

alternatively, you can use the original github url instead of https://drivedl.cf

curl -Ls --compressed  https://github.com/Akianonymus/gdrive-downloader/raw/master/install.sh | sh -s

and done.

Advanced Method

This section provides information on how to utilise the install.sh script for custom usescases.

These are the flags that are available in the install.sh script:

curl -Ls --compressed https://drivedl.cf | sh -s -- -r username/reponame -p somepath -s shell_file -c command_name -b branch_name

Updation

If you have followed the automatic method to install the script, then you can automatically update the script.

There are three methods:

1. Automatic updates

   By default, script checks for update after 3 days. Use -t / --time flag of install.sh to modify the interval.

   An update log is saved in "${HOME}/.gdrive-downloader/update.log".

2. Use the script itself to update the script.

   gdl -u or gdl --update

   This will update the script where it is installed.

   If you use the this flag without actually installing the script,

   e.g just by sh gdl.sh -u then it will install the script or update if already installed.

3. Run the installation script again.

   Yes, just run the installation script again as we did in install section, and voila, it's done.

Note: Above methods always obey the values set by user in advanced installation, e.g if you have installed the script with different repo, say myrepo/gdrive-downloader, then the update will be also fetched from the same repo.

Usage

After installation, no more configuration is needed for public files/folders.

But sometimes, downloading files from shared drive ( team drives ) errors. To tackle this, use --key flag and bypass that error. In case it still errors out, give your own api key as argument.

To get your own api key, go to Retrieve API key section.

Note: Even after specifying api key, don't recklessly download a file over and over, it will lead to 24 hr ip ban.

To handle the issue ( more of a abuse ) in above note, use oauth authentication.

Other scenario where oauth authentication is needed would be for downloading private files/folders. Go to Oauth Authentication section for more info.

gdl gdrive_id/gdrive_url

Script supports argument as gdrive_url, or a gdrive_id, given those should be publicly available.

Now, we have covered the basics, move on to the next section for extra features and usage, like skipping sub folders, parallel downloads, etc.

Download Script Custom Flags

These are the custom flags that are currently implemented:

• -aria | --aria-flags 'flags'

  Use aria2c to download. "-aria" doesn't take arguments.

  To give custom flags as argument, use long flag, --aria-flags. e.g: --aria-flags '-s 10 -x 10'

  Note 1: aria2c can only resume google drive downloads if -k/--key or -o/--oauth option is used, otherwise, it will use curl.

  Note 2: aria split downloading won't work in normal mode ( without -k or -o flag ) because it cannot get the remote server size. Same for any other feature which uses remote server size.

  Note 3: By above notes, conclusion is, aria is basically same as curl in normal mode, so it is recommended to be used only with --key and --oauth flag.

  ---

• -o | --oauth

  Use this flag to trigger oauth authentication.

  Note: If both --oauth and --key flag is used, --oauth flag is preferred.

  ---

• -k | --key 'custom api key' ( optional argument )

  To download with api key. If api key is not specified, then the predefined api key will be used.

  Note: In-script api key surely works, but have less qouta to use, so it is recommended to use your own private key.

  To save your api key in config file, use gdl --key default="your api key". API key will be saved in ${HOME}/.gdl.conf and will be used from now on.

  Note: If both --key and --oauth flag is used, --oauth flag is preferred.

  ---

• -c | --config 'config file path'

  Override default config file with custom config file.

  Default: ${HOME}/.gdl.conf

  ---

• -d | --directory 'foldername'

  Custom workspace folder where given input will be downloaded.

  ---

• -s | --skip-subdirs

  Skip downloading of sub folders present in case of folders.

  ---

• -p | --parallel <no_of_files_to_parallely_download>

  Download multiple files in parallel.

  Note:

  • This command is only helpful if you are downloding many files which aren't big enough to utilise your full bandwidth, using it otherwise will not speed up your download and even error sometimes,
  • 5 to 10 value is recommended. If errors with a high value, use smaller number.
  • Beaware, this isn't magic, obviously it comes at a cost of increased cpu/ram utilisation as it forks multiple bash processes to download ( google how xargs works with -P option ).

  ---

• --speed 'speed'

  Limit the download speed, supported formats: 1K and 1M.

  ---

• -R | --retry 'num of retries'

  Retry the file download if it fails, postive integer as argument. Currently only for file downloads.

  ---

• -l | --log 'log_file_name'

  Save downloaded files info to the given filename.

  ---

• -q | --quiet

  Supress the normal output, only show success/error download messages for files, and one extra line at the beginning for folder showing no. of files and sub folders.

  ---

• -V | --verbose

  Display detailed message (only for non-parallel downloads).

  ---

• --skip-internet-check

  Do not check for internet connection, recommended to use in sync jobs.

  ---

• --version | --info

  Show detailed info about script ( if script is installed system wide ).

  ---

• -u | --update

  Update the installed script in your system, if not installed, then install.

  ---

• --uninstall

  Uninstall the installed script in your system.

  ---

• -h | --help

  Display usage instructions.

  ---

• -D | --debug

  Display script command trace.

  ---

Enable Drive API

You can skip this section if you are not using oauth authentication or trying to retrieve an api key.

• Log into google developer console at google console.
• Click select project at the right side of "Google Cloud Platform" of upper left of window.

If you cannot see the project, please try to access to https://console.cloud.google.com/cloud-resource-manager.

You can also create new project at there. When you create a new project there, please click the left of "Google Cloud Platform". You can see it like 3 horizontal lines.

By this, a side bar is opened. At there, select "API & Services" -> "Library". After this, follow the below steps:

• Click "NEW PROJECT" and input the "Project Name".
• Click "CREATE" and open the created project.
• Click "Enable APIs and get credentials like keys".
• Go to "Library"
• Input "Drive API" in "Search for APIs & Services".
• Click "Google Drive API" and click "ENABLE".

Oauth Authentication

First, we need to obtain our Oauth credentials, here's how to do it:

Generating Oauth Credentials

• Follow Enable Drive API section.
• Open google console.
• Click on "Credentials".
• Click "Create credentials" and select oauth client id.
• Select Application type "Desktop app" or "other".
• Provide name for the new credentials. ( anything )
• This would provide a new Client ID and Client Secret.
• Download your credentials.json by clicking on the download button.

Now, we have obtained our credentials, move to next section to use those credentials to setup:

First Run

On first run, the script asks for all the required credentials, which we have obtained in the previous section.

Execute the script: gdl gdrive_url/gdrive_id -o

Note: -o/ --oauth flag is needed if file should be downloaded with authentication.

Now, it will ask for following credentials:

Client ID: Copy and paste from credentials.json

Client Secret: Copy and paste from credentials.json

Refresh Token: If you have previously generated a refresh token authenticated to your account, then enter it, otherwise leave blank. If you don't have refresh token, script outputs a URL on the terminal script, open that url in a web browser and tap on allow. Copy the code and paste in the terminal.

If everything went fine, all the required credentials have been set.

Config

After first run, the credentials are saved in config file. The config file is ${HOME}/.gdl.conf.

To use a different one temporarily, see -c / --config custom in Download Script Custom Flags.

This is the format of a config file:

CLIENT_ID="client id"
CLIENT_SECRET="client secret"
REFRESH_TOKEN="refresh token"
ACCESS_TOKEN="access token"
ACCESS_TOKEN_EXPIRY="access token expiry"

You can use a config file in multiple machines, the values that are explicitly required are CLIENT_ID, CLIENT_SECRET and REFRESH_TOKEN.

ACCESS_TOKEN and ACCESS_TOKEN_EXPIRY are automatically generated using REFRESH_TOKEN.

A pre-generated config file can be also used where interactive terminal access is not possible, like Continuous Integration, docker, jenkins, etc

Just have to print values to "${HOME}/.gdl.conf", e.g:

printf "%s\n" "CLIENT_ID=\"client id\"
CLIENT_SECRET=\"client secret\"
REFRESH_TOKEN=\"refresh token\"
" >| "${HOME}/.gdl.conf"

Note: Don't skip those backslashes before the double qoutes, it's necessary to handle spacing.

Retrieve API key

In order to use a custom api key, follow the below steps:

• Follow Enable Drive API section.
• Open google console.
• Click on "Credentials".
• Click "Create credentials" and select API key.
• Copy the API key. You can use this API key.

Progress Bar

When downloading a file, or a folder ( except parallel downloading ), script shows progress bar for ongoing download.

================[ Downloaded: 4.6 GB | Left: 44.7 GB ]=================
------------------[ Speed: 48.0 MB/s | ETA: 15m10s ]-------------------

Multiple Inputs

You can use multiple inputs without any extra hassle.

Pass arguments normally, e.g: gdl url1 url2 id2 id2

where url1 and url2 are drive urls and rest two are gdrive ids.

Resuming Interrupted Downloads

Downloads interrupted either due to bad internet connection or manual interruption, can be resumed from the same position.

You can interrupt many times you want, it will resume ( hopefully ).

It will not download again if file is already present, thus avoiding bandwidth waste.

In normal mode of downloading, when aria is used, if interrupted, then it will be resumed by curl because aria cannot detect the remote file size.

But when --key or --oauth is used, it will resume successfully with aria too.

Uninstall

If you have followed the automatic method to install the script, then you can automatically uninstall the script.

There are two methods:

1. Use the script itself to uninstall the script.

   gdl --uninstall

   This will remove the script related files and remove path change from shell file.

2. Run the installation script again with -U/--uninstall flag

   curl -Ls --compressed https://drivedl.cf | sh -s -- --uninstall
   

   Yes, just run the installation script again with the flag and voila, it's done.

Note: Above methods always obey the values set by user in advanced installation.

How it works

In this section, the mechanism of the script it explained, if one is curious how it works to download folders as it is not supported officially.

The main catch here is that the script uses gdrive api to fetch details of a given file or folder id/url. But then how it is without authentication ?

Well, it does uses the api key but i have provided it in script. I have grabbed the api key from their gdrive file page, just open a gdrive folder on browser, open console and see network requests, open one of the POST requests and there you have it.

Also, google api key have a check for referer, so we pass referer with curl as https://drive.google.com to properly use the key.

Now, next steps are simple enough:

Input Check

Main Function: _check_id

It parses the input and extract the file_id, then it does a network request to fetch name, size and mimetype of id.

If it's doesn't give http status 40*, then proceed.

In case of:

File

Main Function: _download_file

Before downloading, the script checks if file is already present. If present compare the file size to remote file size and resume the download if applicable.

Recent updates by google have the made the download links ip specific and very strict about cookies, so it can only be downloaded on the system where cookies was fetched. Earlier, cookies was only needed for a file greater than 100 MB.

But either the case, the file can be moved to a different system and the script will resume the file from same position.

Folder

Main Function: _download_folder

First, all the files and sub folder details are fetched. Details include id and mimeType.

Now, it downloads the files using _download_file function, and in case of sub-folders, _download_folder function is repeated.

Reporting Issues

Issues Status

Use the GitHub issue tracker for any bugs or feature suggestions.

Contributing

Total Contributers

Pull Requests

Submit patches to code or documentation as GitHub pull requests.

Make sure to run format_and_lint.sh and release.sh before making a new pull request.

If using a code editor, then use shfmt and shellcheck plugin instead of format_and_lint.sh

License

UNLICENSE