(Perl) SharePoint -- Download Newer Files

See more SharePoint Examples

Demonstrates how to download all files from a SharePoint folder that are newer than the local files.

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

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

# -------------------------------------------------------------------------
# The following comments apply to SharePoint Windows classic authentication.
# -------------------------------------------------------------------------
# For example, imagine our SharePoint endpoint is https://xyzoffice.mycompany.com/
# The SHAREPOINT_NTLM_DOMAIN would be "mycompany.com"
# The SHAREPOINT_HTTPS_DOMAIN would be "xyzoffice.mycompany.com"
# Also, the SHAREPOINT_USERNAME would be just the name, not a full email address.
# for example, "chilkat" instead of "chilkat@mycompany.com"

$http = chilkat::CkHttp->new();

# If SharePoint Windows classic authentication is used, then set the 
# Login, Password, LoginDomain, and NtlmAuth properties.
$http->put_Login("SHAREPOINT_USERNAME");
$http->put_Password("SHAREPOINT_PASSWORD");
$http->put_LoginDomain("SHAREPOINT_NTLM_DOMAIN");
$http->put_NtlmAuth(1);

# -------------------------------------------------------------------------
# The more common case is to use SharePoint Online authentication (via the SPOIDCRL cookie).
# If so, do not set Login, Password, LoginDomain, and NtlmAuth, and instead
# establish the cookie as shown at SharePoint Online Authentication
# -------------------------------------------------------------------------

# First we'll download a list of all the files in the /Documents folder.
# This provides the names and last-modified date/times of the files located
# on the SharePoint server.
$http->put_Accept("application/json;odata=verbose");
$http->put_AcceptCharset("utf-8");

$sbJson = chilkat::CkStringBuilder->new();
$success = $http->QuickGetSb("https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Documents')/Files",$sbJson);
if ($success != 1) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

# Before proceeding, make sure the local directory where we'll be downloading files exists.
$fac = chilkat::CkFileAccess->new();
$fac->DirEnsureExists("qa_output/sharepoint/Documents");

# OK.. load the JSON and iterate over each file
$json = chilkat::CkJsonObject->new();
$json->LoadSb($sbJson);

$numFiles = $json->SizeOfArray("d.results");
print "Number of Files in the SharePoint /Documents folder = " . $numFiles . "\r\n";

$lastModRemote = chilkat::CkDateTime->new();

$localPath = chilkat::CkStringBuilder->new();
$fileUrl = chilkat::CkStringBuilder->new();

$i = 0;
while ($i < $numFiles) {
    $json->put_I($i);

    $filename = $json->stringOf("d.results[i].Name");
    $sLastModified = $json->stringOf("d.results[i].TimeLastModified");

    print ($i + 1) . ": " . $filename . " (" . $sLastModified . ")" . "\r\n";

    $lastModRemote->SetFromTimestamp($sLastModified);

    $bDownload = 0;
    # Check to see if the local file exists.  If not, then download.
    $localPath->SetString("qa_output/sharepoint/Documents/");
    $localPath->Append($filename);
    if ($fac->FileExists($localPath->getAsString()) != 1) {
        print "This file does not exist locally." . "\r\n";
        $bDownload = 1;
    }
    else {
        # Get the local file's date time and compare with the remote file date/time.
        # lastModLocal is a CkDateTime
        $lastModLocal = $fac->GetLastModified($localPath->getAsString());
        if ($fac->get_LastMethodSuccess() == 1) {
            # Get the difference in seconds between the local and remote last-modified times.
            # if the return value is negative, then the caller's time is 
            # older than the argument.  (in this case, a negative return value means
            # the local file is older than the remote file.

            # Note: The DiffSeconds method was found to be missing in the Chilkat .NET build
            # (and possibly in other builds). It will be present in the v9.5.0.67 release and later.
            $numSeconds = $lastModLocal->DiffSeconds($lastModRemote);
            if ($numSeconds < 0) {
                print "The local file is older than the remote file." . "\r\n";
                $bDownload = 1;
            }

        }
        else {
            print "Unable to get the local file's last-modified date/time." . "\r\n";
            print $fac->lastErrorText() . "\r\n";
        }

    }

    if ($bDownload == 1) {
        $fileUrl->SetString("https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Documents')/Files('");
        $fileUrl->Append($filename);
        $fileUrl->Append("')/$value");

        print "Downloading " . $filename . "\r\n";

        $success = $http->Download($fileUrl->getAsString(),$localPath->getAsString());
        if ($success != 1) {
            print $http->lastErrorText() . "\r\n";
            exit;
        }

        # Set the local file's last-modified date/time to that of the server's.
        $fac->SetLastModified($localPath->getAsString(),$lastModRemote);

    }

    $i = $i + 1;
}

print "All finished." . "\r\n";