(PHP ActiveX) OneDrive -- Streaming REST Download to File

Downloads the contents of a DriveItem directly to a file in the local filesystem using the Chilkat REST class.

Note: This example requires Chilkat v9.5.0.69 or greater.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$rest = new COM("Chilkat_9_5_0.Rest");

// Use your previously obtained access token here:
// See the following examples for getting an access token:
//    Get Microsoft Graph OAuth2 Access Token (Azure AD v2.0 Endpoint).
//    Get Microsoft Graph OAuth2 Access Token (Azure AD Endpoint).
//    Refresh Access Token (Azure AD v2.0 Endpoint).
//    Refresh Access Token (Azure AD Endpoint).

// First connect to graph.microsoft.com.  If there's a connectivity problem, we'll find out here.
$success = $rest->Connect('graph.microsoft.com',443,1,1);
if ($success != 1) {
    print $rest->LastErrorText . "\n";
    exit;
}

// (Make sure your token was obtained with the FilesRead or Files.ReadWrite scope.)
$oauth2 = new COM("Chilkat_9_5_0.OAuth2");
$oauth2->AccessToken = 'MICROSOFT_GRAPH_ACCESS_TOKEN';
$rest->SetAuthOAuth2($oauth2);

// Send the GET request to download the file.
$uriPath = '/v1.0/me/drive/root:/Misc/wildlife/penguins.jpg:/content';
$success = $rest->SendReqNoBody('GET',$uriPath);
if ($rest->LastMethodSuccess != 1) {
    print $rest->LastErrorText . "\n";
    exit;
}

// NOTE: This way of doing the HTTP GET (i.e. download) may be more cumbersome, but it 
// allows for finer control of handling errors.  The connection establishment, the sending of the
// request, the reading of the response header, and the reading of the response body (i.e. the file data)
// are handled by separate method calls.  If the response header indicates an error, we can read
// the response body and treat it differently than if reading the file data.

// Read the response header.
$statusCode = $rest->ReadResponseHeader();
print 'Response Status Code = ' . $statusCode . "\n";
if ($statusCode == 302) {
    // This is a redirect.  Read the response body, if any, and then follow the redirect.
    // Usually the response body will be empty for a redirect, but we need to be sure to read
    // the response body just in case it exists.
    $discard = new COM("Chilkat_9_5_0.BinData");
    $rest->ReadRespBd($discard);
    $rest->Disconnect(10);

    // For OneDrive, the redirect URL does not need authorization because the only way
    // to have obtained the direct download URL is from an authenticated request.
    // In fact, if we leave the authentication present, the GET request to the redirect URL will fail.

    // Note: The ClearAuth method is introduced in v9.5.0.69.
    $rest->ClearAuth();

    // Follow the redirect URL...
    // redirectUrl is a Chilkat_9_5_0.Url
    $redirectUrl = $rest->RedirectUrl();
    print 'Redirect Host: ' . $redirectUrl->Host . "\n";
    print 'Redirect URI Path: ' . $redirectUrl->PathWithQueryParams . "\n";

    $success = $rest->Connect($redirectUrl->Host,$redirectUrl->Port,$redirectUrl->Ssl,1);
    if ($success != 1) {
        print $rest->LastErrorText . "\n";
        exit;
    }

    // Send the request..
    $success = $rest->SendReqNoBody('GET',$redirectUrl->Path);

    if ($rest->LastMethodSuccess != 1) {
        print $rest->LastErrorText . "\n";
        exit;
    }

    $statusCode = $rest->ReadResponseHeader();
    print $rest->LastErrorText . "\n";
    print 'Redirect Response Status Code = ' . $statusCode . "\n";

}

if ($statusCode >= 300) {

    // Read the error response body.
    $sbJson = new COM("Chilkat_9_5_0.StringBuilder");
    $success = $rest->ReadRespSb($sbJson);
    if ($success != 1) {
        print $rest->LastErrorText . "\n";
        exit;
    }

    $jsonErr = new COM("Chilkat_9_5_0.JsonObject");
    $jsonErr->EmitCompact = 0;
    $jsonErr->LoadSb($sbJson);
    print $jsonErr->emit() . "\n";

    exit;
}

// Stream the response body directly to a local file.
$localPath = 'qa_output/penguins.jpg';

$stream = new COM("Chilkat_9_5_0.Stream");
$stream->SinkFile = $localPath;

$success = $rest->ReadRespBodyStream($stream,1);
if ($success != 1) {
    print $rest->LastErrorText . "\n";
    exit;
}

print 'Successfully streamed a OneDrive file to the local filesystem.' . "\n";

?>