deployphp / deployer

contrib/cloudflare.php

<?php
/*
### Installing

Add to your _deploy.php_

```php
require 'contrib/cloudflare.php';
```

### Configuration

- `cloudflare` – array with configuration for cloudflare
    - `service_key` – Cloudflare Service Key. If this is not provided, use api_key and email.
    - `api_key` – Cloudflare API key generated on the "My Account" page.
    - `email` – Cloudflare Email address associated with your account.
    - `domain` – The domain you want to clear

### Usage

Since the website should be built and some load is likely about to be applied to your server, this should be one of,
if not the, last tasks before cleanup

*/
namespace Deployer;

desc('Clearing Cloudflare Cache');
task('deploy:cloudflare', function () {

    $config = get('cloudflare', []);

    // validate config and set headers
    if (!empty($config['service_key'])) {
        $headers = [
            'X-Auth-User-Service-Key' => $config['service_key']
        ];
    } elseif (!empty($config['email']) && !empty($config['api_key'])) {
        $headers = [
            'X-Auth-Key'   => $config['api_key'],
            'X-Auth-Email' => $config['email']
        ];
    } else {
        throw new \RuntimeException("Set a service key or email / api key");
    }

    $headers['Content-Type'] = 'application/json';

    if (empty($config['domain'])) {
        throw new \RuntimeException("Set a domain");
    }

    $makeRequest = function ($url, $opts = []) use ($headers) {
        $ch = curl_init("https://api.cloudflare.com/client/v4/$url");

        $parsedHeaders = [];
        foreach($headers as $key => $value){
            $parsedHeaders[] = "$key: $value";
        }

        curl_setopt_array($ch, [

It seems like $ch can also be of type false; however, parameter $ch of curl_setopt_array() does only seem to accept resource, maybe add an additional type check?

            CURLOPT_HTTPHEADER     => $parsedHeaders,
            CURLOPT_RETURNTRANSFER => true
        ]);

        curl_setopt_array($ch, $opts);

        $res = curl_exec($ch);

It seems like $ch can also be of type false; however, parameter $ch of curl_exec() does only seem to accept resource, maybe add an additional type check?

        if (curl_errno($ch)) {

It seems like $ch can also be of type false; however, parameter $ch of curl_errno() does only seem to accept resource, maybe add an additional type check?

            throw new \RuntimeException("Error making curl request (result: $res)");
        }

        curl_close($ch);

It seems like $ch can also be of type false; however, parameter $ch of curl_close() does only seem to accept resource, maybe add an additional type check?

        return $res;
    };

    // get the mysterious zone id from Cloud Flare
    $zones = json_decode($makeRequest(
        "zones?name={$config['domain']}"
    ), true);

    if (empty($zones['success']) || !empty($zones['errors'])) {
        throw new \RuntimeException("Problem with zone data");
    } else {
        $zoneId = current($zones['result'])['id'];
    }

    // make purge request
    $makeRequest(
        "zones/$zoneId/purge_cache",
        [
            CURLOPT_CUSTOMREQUEST => 'DELETE',
            CURLOPT_POSTFIELDS    => json_encode(
                [
                    'purge_everything' => true
                ]
            ),
        ]
    );
});