Delphi ActiveX Requires Chilkat v11.0.0+

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. Delphi ActiveX

var
success: Integer;
http: TChilkatHttp;
sbJson: TChilkatStringBuilder;
fac: TCkFileAccess;
json: TChilkatJsonObject;
numFiles: Integer;
lastModRemote: TCkDateTime;
lastModLocal: TCkDateTime;
localPath: TChilkatStringBuilder;
fileUrl: TChilkatStringBuilder;
i: Integer;
filename: WideString;
sLastModified: WideString;
bDownload: Integer;
numSeconds: Integer;

begin
success := 0;

//  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 := TChilkatHttp.Create(Self);

//  If SharePoint Windows classic authentication is used, then set the 
//  Login, Password, LoginDomain, and NtlmAuth properties.
http.Login := 'SHAREPOINT_USERNAME';
http.Password := 'SHAREPOINT_PASSWORD';
http.LoginDomain := 'SHAREPOINT_NTLM_DOMAIN';
http.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.Accept := 'application/json;odata=verbose';
http.AcceptCharset := 'utf-8';

sbJson := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl(''/Documents'')/Files',sbJson.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

//  Before proceeding, make sure the local directory where we'll be downloading files exists.
fac := TCkFileAccess.Create(Self);
fac.DirEnsureExists('qa_output/sharepoint/Documents');

//  OK.. load the JSON and iterate over each file
json := TChilkatJsonObject.Create(Self);
json.LoadSb(sbJson.ControlInterface);

numFiles := json.SizeOfArray('d.results');
Memo1.Lines.Add('Number of Files in the SharePoint /Documents folder = ' + IntToStr(numFiles));

lastModRemote := TCkDateTime.Create(Self);
lastModLocal := TCkDateTime.Create(Self);

localPath := TChilkatStringBuilder.Create(Self);
fileUrl := TChilkatStringBuilder.Create(Self);

i := 0;
while i < numFiles do
  begin
    json.I := i;

    filename := json.StringOf('d.results[i].Name');
    sLastModified := json.StringOf('d.results[i].TimeLastModified');

    Memo1.Lines.Add(IntToStr(i + 1) + ': ' + filename + ' (' + sLastModified + ')');

    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) then
      begin
        Memo1.Lines.Add('This file does not exist locally.');
        bDownload := 1;
      end
    else
      begin
        //  Get the local file's date time and compare with the remote file date/time.
        lastModLocal.SetFromTimestamp(fac.GetFileTimeStr(localPath.GetAsString(),0));

        //  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.ControlInterface);
        if (numSeconds < 0) then
          begin
            Memo1.Lines.Add('The local file is older than the remote file.');
            bDownload := 1;
          end;
      end;

    if (bDownload = 1) then
      begin
        fileUrl.SetString('https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl(''/Documents'')/Files(''');
        fileUrl.Append(filename);
        fileUrl.Append(''')/$value');

        Memo1.Lines.Add('Downloading ' + filename);

        success := http.Download(fileUrl.GetAsString(),localPath.GetAsString());
        if (success = 0) then
          begin
            Memo1.Lines.Add(http.LastErrorText);
            Exit;
          end;

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

      end;

    i := i + 1;
  end;

Memo1.Lines.Add('All finished.');