Delphi DLL 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 DLL

var
success: Boolean;
http: HCkHttp;
sbJson: HCkStringBuilder;
fac: HCkFileAccess;
json: HCkJsonObject;
numFiles: Integer;
lastModRemote: HCkDateTime;
lastModLocal: HCkDateTime;
localPath: HCkStringBuilder;
fileUrl: HCkStringBuilder;
i: Integer;
filename: PWideChar;
sLastModified: PWideChar;
bDownload: Boolean;
numSeconds: Integer;

begin
success := False;

//  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 := CkHttp_Create();

//  If SharePoint Windows classic authentication is used, then set the 
//  Login, Password, LoginDomain, and NtlmAuth properties.
CkHttp_putLogin(http,'SHAREPOINT_USERNAME');
CkHttp_putPassword(http,'SHAREPOINT_PASSWORD');
CkHttp_putLoginDomain(http,'SHAREPOINT_NTLM_DOMAIN');
CkHttp_putNtlmAuth(http,True);

//  -------------------------------------------------------------------------
//  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.
CkHttp_putAccept(http,'application/json;odata=verbose');
CkHttp_putAcceptCharset(http,'utf-8');

sbJson := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl(''/Documents'')/Files',sbJson);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

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

//  OK.. load the JSON and iterate over each file
json := CkJsonObject_Create();
CkJsonObject_LoadSb(json,sbJson);

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

lastModRemote := CkDateTime_Create();
lastModLocal := CkDateTime_Create();

localPath := CkStringBuilder_Create();
fileUrl := CkStringBuilder_Create();

i := 0;
while i < numFiles do
  begin
    CkJsonObject_putI(json,i);

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

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

    CkDateTime_SetFromTimestamp(lastModRemote,sLastModified);

    bDownload := False;
    //  Check to see if the local file exists.  If not, then download.
    CkStringBuilder_SetString(localPath,'qa_output/sharepoint/Documents/');
    CkStringBuilder_Append(localPath,filename);
    if (CkFileAccess_FileExists(fac,CkStringBuilder__getAsString(localPath)) <> True) then
      begin
        Memo1.Lines.Add('This file does not exist locally.');
        bDownload := True;
      end
    else
      begin
        //  Get the local file's date time and compare with the remote file date/time.
        CkDateTime_SetFromTimestamp(lastModLocal,CkFileAccess__getFileTimeStr(fac,CkStringBuilder__getAsString(localPath),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 := CkDateTime_DiffSeconds(lastModLocal,lastModRemote);
        if (numSeconds < 0) then
          begin
            Memo1.Lines.Add('The local file is older than the remote file.');
            bDownload := True;
          end;
      end;

    if (bDownload = True) then
      begin
        CkStringBuilder_SetString(fileUrl,'https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl(''/Documents'')/Files(''');
        CkStringBuilder_Append(fileUrl,filename);
        CkStringBuilder_Append(fileUrl,''')/$value');

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

        success := CkHttp_Download(http,CkStringBuilder__getAsString(fileUrl),CkStringBuilder__getAsString(localPath));
        if (success = False) then
          begin
            Memo1.Lines.Add(CkHttp__lastErrorText(http));
            Exit;
          end;

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

      end;

    i := i + 1;
  end;

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

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbJson);
CkFileAccess_Dispose(fac);
CkJsonObject_Dispose(json);
CkDateTime_Dispose(lastModRemote);
CkDateTime_Dispose(lastModLocal);
CkStringBuilder_Dispose(localPath);
CkStringBuilder_Dispose(fileUrl);