1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
|
/*
* Copyright 2018, University Corporation for Atmospheric Research
* See netcdf/COPYRIGHT file for copying and redistribution conditions.
*/
#define NOOP
#undef DEBUG
#include "config.h"
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#include "netcdf.h"
#include "nclog.h"
#include "ncrc.h"
#include "ncxml.h"
#include "ncs3sdk.h"
#include "nch5s3comms.h"
#define NCTRACING
#ifdef NCTRACING
#define NCTRACE(level,fmt,...) nctrace((level),__func__,fmt,##__VA_ARGS__)
#define NCTRACEMORE(level,fmt,...) nctracemore((level),fmt,##__VA_ARGS__)
#define NCUNTRACE(e) ncuntrace(__func__,NCTHROW(e),NULL)
#define NCUNTRACEX(e,fmt,...) ncuntrace(__func__,NCTHROW(e),fmt,##__VA_ARGS__)
#define NCNILTRACE(e) ((void)NCUNTRACE(e))
#else
#define NCTRACE(level,fmt,...)
#define NCTRACEMORE(level,fmt,...)
#define NCUNTRACE(e) (e)
#define NCNILTRACE(e)
#define NCUNTRACEX(e,fmt,...) (e)
#endif
#ifdef __CYGWIN__
extern char* strdup(const char*);
#endif
#ifndef SHA256_DIGEST_LENGTH
#define SHA256_DIGEST_LENGTH 32
#endif
/* Mnemonic */
#define RECLAIM 1
#define size64 unsigned long long
typedef struct NCS3CLIENT {
char* rooturl; /* The URL (minus any fragment) for the dataset root path (excludes bucket on down) */
s3r_t* h5s3client; /* From h5s3comms */
} NCS3CLIENT;
struct Object {
NClist* checksumalgorithms; /* NClist<char*> */
char* etag;
char* key;
char* lastmodified;
struct Owner {
char* displayname;
char* id;
} owner;
char* size;
char* storageclass;
};
typedef char* CommonPrefix;
/* Hold essential info from a ListObjectsV2 response */
struct LISTOBJECTSV2 {
char* istruncated;
NClist* contents; /* NClist<struct Object*> */
char* name;
char* prefix;
char* delimiter;
char* maxkeys;
NClist* commonprefixes; /* NClist<CommonPrefix> */
char* encodingtype;
char* keycount;
char* continuationtoken;
char* nextcontinuationtoken;
char* startafter;
};
/* Forward */
static void s3client_destroy(NCS3CLIENT* s3client);
static char* makes3rooturl(NCS3INFO* info);
static int makes3fullpath(const char* pathkey, const char* bucket, const char* prefix, const char* key, NCbytes* url);
static int parse_listbucketresult(char* xml, unsigned long long xmllen, struct LISTOBJECTSV2**);
static int parse_object(ncxml_t root, NClist* objects);
static int parse_owner(ncxml_t root, struct Owner* ownerp);
static int parse_prefix(ncxml_t root, NClist* prefixes);
static int parse_checksumalgorithm(ncxml_t root, NClist* algorithms);
static struct LISTOBJECTSV2* alloclistobjectsv2(void);
static struct Object* allocobject(void);
static void reclaim_listobjectsv2(struct LISTOBJECTSV2* lo);
static void reclaim_object(struct Object* o);
static char* trim(char* s, int reclaim);
static int makes3prefix(const char* prefix, char** prefixdirp);
static int s3objectsinfo(NClist* contents, NClist* keys, NClist* lens);
static int s3commonprefixes(NClist* list, NClist* keys);
static int mergekeysets(NClist*,NClist*,NClist*);
static int rawtokeys(s3r_buf_t* response, NClist* keys, NClist* lengths, struct LISTOBJECTSV2** listv2p);
static int queryadd(NClist* query, const char* key, const char* value);
static int queryend(NClist* query, char** querystring);
static int queryinsert(NClist* list, char* ekey, char* evalue);
#define NT(x) ((x)==NULL?"null":x)
/**************************************************/
static int ncs3_initialized = 0;
static int ncs3_finalized = 0;
EXTERNL int
NC_s3sdkinitialize(void)
{
if(!ncs3_initialized) {
ncs3_initialized = 1;
ncs3_finalized = 0;
}
/* Get environment information */
NC_s3sdkenvironment();
return NC_NOERR;
}
EXTERNL int
NC_s3sdkfinalize(void)
{
if(!ncs3_finalized) {
ncs3_initialized = 0;
ncs3_finalized = 1;
}
return NC_NOERR;
}
/**************************************************/
#if 0
static void
dumps3info(NCS3INFO* s3info, const char* tag)
{
if(tag == NULL) tag = "dumps3info";
fprintf(stderr,">>> %s: s3info=%p\n",tag,s3info);
if(s3info != NULL) {
fprintf(stderr,">>> %s: s3info->host=%s\n",tag,NT(s3info->host));
fprintf(stderr,">>> %s: s3info->region=%s\n",tag,NT(s3info->region));
fprintf(stderr,">>> %s: s3info->bucket=%s\n",tag,NT(s3info->bucket));
fprintf(stderr,">>> %s: s3info->rootkey=%s\n",tag,NT(s3info->rootkey));
fprintf(stderr,">>> %s: s3info->profile=%s\n",tag,NT(s3info->profile));
}
}
static void
dumps3client(void* s3client0, const char* tag)
{
NCS3CLIENT* s3client = (NCS3CLIENT*)s3client0;
if(tag == NULL) tag = "dumps3client";
fprintf(stderr,">>> %s: s3client=%p\n",tag,s3client);
if(s3client != NULL) {
fprintf(stderr,">>> %s: s3client->rooturl=%s\n",tag,NT(s3client->rooturl));
fprintf(stderr,">>> %s: s3client->h5s3client=%p\n",tag,s3client->rooturl);
}
}
#endif
/**************************************************/
EXTERNL void*
NC_s3sdkcreateclient(NCS3INFO* info)
{
int stat = NC_NOERR;
const char* accessid = NULL;
const char* accesskey = NULL;
char* urlroot = NULL;
NCS3CLIENT* s3client = NULL;
NCTRACE(11,"info=%s",NC_s3dumps3info(info));
s3client = (NCS3CLIENT*)calloc(1,sizeof(NCS3CLIENT));
if(s3client == NULL) goto done;
if(info->profile != NULL) {
if((stat = NC_s3profilelookup(info->profile, "aws_access_key_id", &accessid))) goto done;
if((stat = NC_s3profilelookup(info->profile, "aws_secret_access_key", &accesskey))) goto done;
}
if((s3client->rooturl = makes3rooturl(info))==NULL) {stat = NC_ENOMEM; goto done;}
s3client->h5s3client = NCH5_s3comms_s3r_open(s3client->rooturl,info->svc,info->region,accessid,accesskey);
if(s3client->h5s3client == NULL) {stat = NC_ES3; goto done;}
done:
nullfree(urlroot);
if(stat && s3client) {
NC_s3sdkclose(s3client,info,0,NULL);
s3client = NULL;
}
NCNILTRACE(NC_NOERR);
return (void*)s3client;
}
EXTERNL int
NC_s3sdkbucketexists(void* s3client0, const char* bucket, int* existsp, char** errmsgp)
{
int stat = NC_NOERR;
NCS3CLIENT* s3client = (NCS3CLIENT*)s3client0;
NCbytes* url = ncbytesnew();
long httpcode = 0;
NCTRACE(11,"bucket=%s",bucket);
if(errmsgp) *errmsgp = NULL;
if((stat = makes3fullpath(s3client->rooturl,bucket,NULL,NULL,url))) goto done;
if((stat = NCH5_s3comms_s3r_head(s3client->h5s3client, ncbytescontents(url), NULL, NULL, &httpcode, NULL))) goto done;
if(existsp) {*existsp = (stat == 0 && httpcode == 200);}
done:
ncbytesfree(url);
return NCUNTRACEX(stat,"exists=%d",PTRVAL(int,existsp,-1));
}
EXTERNL int
NC_s3sdkbucketcreate(void* s3client0, const char* region, const char* bucket, char** errmsgp)
{
int stat = NC_NOERR;
NCS3CLIENT* s3client = (NCS3CLIENT*)s3client0;
NC_UNUSED(s3client);
NCTRACE(11,"region=%s bucket=%s",region,bucket);
if(errmsgp) *errmsgp = NULL;
fprintf(stderr,"create bucket: %s\n",bucket); fflush(stderr);
return NCUNTRACE(stat);
}
EXTERNL int
NC_s3sdkbucketdelete(void* s3client0, NCS3INFO* info, char** errmsgp)
{
int stat = NC_NOERR;
NCS3CLIENT* s3client = (NCS3CLIENT*)s3client0;
NC_UNUSED(s3client);
NCTRACE(11,"info=%s%s",NC_s3dumps3info(info));
if(errmsgp) *errmsgp = NULL;
fprintf(stderr,"delete bucket: %s\n",info->bucket); fflush(stderr);
return NCUNTRACE(stat);
}
/**************************************************/
/* Object API */
/*
@return NC_NOERR if key points to a content-bearing object.
@return NC_EEMPTY if object at key has no content.
@return NC_EXXX return true error
*/
EXTERNL int
NC_s3sdkinfo(void* s3client0, const char* bucket, const char* pathkey, size64_t* lenp, char** errmsgp)
{
int stat = NC_NOERR;
NCS3CLIENT* s3client = (NCS3CLIENT*)s3client0;
NCbytes* url = ncbytesnew();
long long len = -1;
NCTRACE(11,"bucket=%s pathkey=%s",bucket,pathkey);
if((stat = makes3fullpath(s3client->rooturl,bucket,pathkey,NULL,url))) goto done;
if((stat = NCH5_s3comms_s3r_getsize(s3client->h5s3client, ncbytescontents(url), &len))) goto done;
if(lenp) {*lenp = len;}
done:
ncbytesfree(url);
return NCUNTRACEX(stat,"len=%d",PTRVAL(int,lenp,-1));
}
/*
@return NC_NOERR if success
@return NC_EXXX if fail
*/
EXTERNL int
NC_s3sdkread(void* s3client0, const char* bucket, const char* pathkey, size64_t start, size64_t count, void* content, char** errmsgp)
{
int stat = NC_NOERR;
NCS3CLIENT* s3client = (NCS3CLIENT*)s3client0;
NCbytes* url = ncbytesnew();
struct s3r_buf_t data = {0,NULL};
NCTRACE(11,"bucket=%s pathkey=%s start=%llu count=%llu content=%p",bucket,pathkey,start,count,content);
if((stat = makes3fullpath(s3client->rooturl,bucket,pathkey,NULL,url))) goto done;
/* Read the data */
data.count = count;
data.content = content;
if((stat = NCH5_s3comms_s3r_read(s3client->h5s3client,ncbytescontents(url),(size_t)start,(size_t)count,&data))) goto done;
done:
ncbytesfree(url);
return NCUNTRACE(stat);
}
/*
For S3, I can see no way to do a byterange write;
so we are effectively writing the whole object
*/
EXTERNL int
NC_s3sdkwriteobject(void* s3client0, const char* bucket, const char* pathkey, size64_t count, const void* content, char** errmsgp)
{
int stat = NC_NOERR;
NCS3CLIENT* s3client = (NCS3CLIENT*)s3client0;
NCbytes* url = ncbytesnew();
s3r_buf_t data;
NCTRACE(11,"bucket=%s pathkey=%s count=%llu content=%p",bucket,pathkey,count,content);
if((stat = makes3fullpath(s3client->rooturl,bucket,pathkey,NULL,url))) goto done;
/* Write the data */
data.count = count;
data.content = (void*)content;
if((stat = NCH5_s3comms_s3r_write(s3client->h5s3client,ncbytescontents(url),&data))) goto done;
done:
ncbytesfree(url);
return NCUNTRACE(stat);
}
EXTERNL int
NC_s3sdkclose(void* s3client0, NCS3INFO* info, int deleteit, char** errmsgp)
{
int stat = NC_NOERR;
NCS3CLIENT* s3client = (NCS3CLIENT*)s3client0;
NCTRACE(11,"info=%s deleteit=%d",NC_s3dumps3info(info),deleteit);
if(deleteit) {
/* Delete the root key; ok it if does not exist */
switch (stat = NC_s3sdkdeletekey(s3client0,info->bucket,info->rootkey,errmsgp)) {
case NC_NOERR: break;
case NC_EEMPTY: case NC_ENOTFOUND: stat = NC_NOERR; break;
default: break;
}
}
s3client_destroy(s3client);
return NCUNTRACE(stat);
}
/*
Common code for getkeys and searchkeys.
Return a list of names of legal objects immediately below a specified key.
In theory, the returned list should be sorted in lexical order,
but it possible that it is not.
*/
static int
getkeys(void* s3client0, const char* bucket, const char* prefixkey0, const char* delim, size_t* nkeysp, char*** keysp, char** errmsgp)
{
int stat = NC_NOERR;
NCS3CLIENT* s3client = (NCS3CLIENT*)s3client0;
char* prefixdir = NULL;
NClist* query = NULL;
char* querystring = NULL;
NCURI* purl = NULL;
NCbytes* listurl = ncbytesnew();
NClist* allkeys = nclistnew();
struct LISTOBJECTSV2* listv2 = NULL;
int istruncated = 0;
char* continuetoken = NULL;
s3r_buf_t response = {0,NULL};
NCTRACE(11,"bucket=%s prefixkey0=%s",bucket,prefixkey0);
/* cleanup the prefix */
if((stat = makes3prefix(prefixkey0,&prefixdir))) return NCUNTRACE(stat);
do {
nclistfreeall(query);
query = nclistnew();
nullfree(querystring);
querystring = NULL;
ncbytesclear(listurl);
nullfree(response.content); response.content = NULL; response.count = 0;
/* Make sure order is sorted (after encoding) */
if((stat = queryadd(query,"list-type","2"))) goto done;
if((stat = queryadd(query,"prefix",prefixdir))) goto done;
if(delim != NULL) {
if((stat = queryadd(query,"delimiter",delim))) goto done;
}
if(istruncated && continuetoken != NULL) {
if((stat = queryadd(query,"continuation-token",continuetoken))) goto done;
}
if((stat = queryend(query,&querystring))) goto done;
/* Build the proper url; leave off prefix because it will appear in the query */
if((stat = makes3fullpath(s3client->rooturl, bucket, NULL, NULL, listurl))) goto done;
/* Append the query string */
ncbytescat(listurl,"?");
ncbytescat(listurl,querystring);
if((stat = NCH5_s3comms_s3r_getkeys(s3client->h5s3client, ncbytescontents(listurl), &response))) goto done;
if((stat = rawtokeys(&response,allkeys,NULL,&listv2))) goto done;
istruncated = (strcasecmp(listv2->istruncated,"true")==0?1:0);
nullfree(continuetoken);
continuetoken = nulldup(listv2->nextcontinuationtoken);
reclaim_listobjectsv2(listv2); listv2 = NULL;
} while(istruncated);
if(nkeysp) {*nkeysp = nclistlength(allkeys);}
if(keysp) {*keysp = nclistextract(allkeys);}
done:
nullfree(continuetoken);
reclaim_listobjectsv2(listv2);
nclistfreeall(allkeys);
nclistfreeall(query);
nullfree(querystring);
ncurifree(purl);
ncbytesfree(listurl);
nullfree(response.content);
if(prefixdir) free(prefixdir);
return NCUNTRACEX(stat,"nkeys=%u",PTRVAL(unsigned,nkeysp,0));
}
/*
Return a list of names of legal objects immediately below a specified key.
In theory, the returned list should be sorted in lexical order,
but it possible that it is not.
*/
EXTERNL int
NC_s3sdkgetkeys(void* s3client0, const char* bucket, const char* prefixkey0, size_t* nkeysp, char*** keysp, char** errmsgp)
{
NCTRACE(11,"bucket=%s prefixkey0=%s",bucket,prefixkey0);
return NCUNTRACE(getkeys(s3client0, bucket, prefixkey0, "/", nkeysp, keysp, errmsgp));
}
/*
Return a list of full keys of legal objects immediately below a specified key.
Not necessarily sorted.
Essentially same as getkeys, but with no delimiter.
*/
EXTERNL int
NC_s3sdksearch(void* s3client0, const char* bucket, const char* prefixkey0, size_t* nkeysp, char*** keysp, char** errmsgp)
{
NCTRACE(11,"bucket=%s prefixkey0=%s",bucket,prefixkey0);
return NCUNTRACE(getkeys(s3client0, bucket, prefixkey0, NULL, nkeysp, keysp, errmsgp));
}
EXTERNL int
NC_s3sdkdeletekey(void* s3client0, const char* bucket, const char* pathkey, char** errmsgp)
{
int stat = NC_NOERR;
NCS3CLIENT* s3client = (NCS3CLIENT*)s3client0;
NCbytes* url = ncbytesnew();
long httpcode = 0;
NCTRACE(11,"s3client0=%p bucket=%s pathkey=%s",s3client0,bucket,pathkey);
if((stat = makes3fullpath(s3client->rooturl,bucket,pathkey,NULL,url))) goto done;
if((stat = NCH5_s3comms_s3r_deletekey(s3client->h5s3client, ncbytescontents(url), &httpcode))) goto done;
done:
ncbytesfree(url);
return NCUNTRACE(stat);
}
/**************************************************/
/* Utilities */
/*
Convert raw getkeys response to vector of keys
*/
static int
rawtokeys(s3r_buf_t* response, NClist* allkeys, NClist* lengths, struct LISTOBJECTSV2** listv2p)
{
int stat = NC_NOERR;
struct LISTOBJECTSV2* listv2 = NULL;
NClist* realkeys = nclistnew();
NClist* commonkeys = nclistnew();
if((stat = parse_listbucketresult(response->content,response->count,&listv2))) goto done;
if(nclistlength(listv2->contents) > 0) {
if((stat = s3objectsinfo(listv2->contents,realkeys,lengths))) goto done;
}
/* Add common prefixes */
if(nclistlength(listv2->commonprefixes) > 0) {
if((stat = s3commonprefixes(listv2->commonprefixes,commonkeys))) goto done;
}
if((stat=mergekeysets(realkeys, commonkeys, allkeys))) goto done;
if(listv2p) {*listv2p = listv2; listv2 = NULL;}
done:
nclistfreeall(realkeys);
nclistfreeall(commonkeys);
reclaim_listobjectsv2(listv2);
return stat;
}
/* Create a path-format root url */
static char*
makes3rooturl(NCS3INFO* info)
{
NCbytes* buf = ncbytesnew();
char* result = NULL;
ncbytescat(buf,"https://");
ncbytescat(buf,info->host);
result = ncbytesextract(buf);
ncbytesfree(buf);
return result;
}
static int
makes3fullpath(const char* rooturl, const char* bucket, const char* prefix, const char* key, NCbytes* url)
{
int stat = NC_NOERR;
assert(url != NULL);
assert(rooturl != NULL);
ncbytescat(url,rooturl);
if(bucket) {
if(ncbyteslength(url) > 0 && ncbytesget(url,ncbyteslength(url)-1) != '/') ncbytescat(url,"/");
if(*bucket == '/') bucket++;
ncbytescat(url,bucket);
}
if(prefix) {
if(ncbyteslength(url) > 0 && ncbytesget(url,ncbyteslength(url)-1) != '/') ncbytescat(url,"/");
if(*prefix == '/') prefix++;
ncbytescat(url,prefix);
}
if(key) {
if(ncbyteslength(url) > 0 && ncbytesget(url,ncbyteslength(url)-1) != '/') ncbytescat(url,"/");
if(*key == '/') key++;
ncbytescat(url,key);
}
/* Remove any trailing '/' */
if(ncbyteslength(url) > 0 && ncbytesget(url,ncbyteslength(url)-1) == '/') ncbytessetlength(url,ncbyteslength(url)-1);
return stat;
}
/* (1) Ensure trailing '/' and (2) Strip off leading '/' */
/* Note that order of '/' handling is important; we want
"/" to be converted to "", but "/a/b/c" to be converted to "a/b/c/"
*/
static int
makes3prefix(const char* prefix, char** prefixdirp)
{
size_t plen;
char* prefixdir;
if(prefix == NULL) prefix = "";
if(*prefix == '/') prefix++; /* Remove any leading '/' */
plen = strlen(prefix);
prefixdir = (char*)malloc(plen+1+1); /* possible '/' and nul */
if(prefixdir == NULL) return NC_ENOMEM;
memcpy(prefixdir,prefix,plen+1); /* include trailing nul */
if(plen > 0)
if(prefixdir[plen-1] != '/') strlcat(prefixdir,"/",plen+1+1); /* Ensure trailing '/' */
/* else leave prefix as "" */
*prefixdirp = prefixdir; prefixdir = NULL;
return NC_NOERR;
}
/* Move keys1 concat keys2 into merge; note that merge list may not be empty. */
/* Will leave keys1 and keys2 empty */
static int
mergekeysets(NClist* keys1, NClist* keys2, NClist* merge)
{
int stat = NC_NOERR;
int i;
size_t nkeys1 = nclistlength(keys1);
size_t nkeys2 = nclistlength(keys2);
for(i=0;i<nkeys1;i++) nclistpush(merge,nclistremove(keys1,0));
for(i=0;i<nkeys2;i++) nclistpush(merge,nclistremove(keys2,0));
nclistnull(merge);
return NCTHROW(stat);
}
static void
s3client_destroy(NCS3CLIENT* s3client)
{
if(s3client) {
nullfree(s3client->rooturl);
(void)NCH5_s3comms_s3r_close(s3client->h5s3client);
free(s3client);
}
}
/**************************************************/
/* XML Response Parser(s) */
/**
Action: List objects (V2)
Response XML:
=========================
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<ListBucketResult>
<Name>string</Name>
<Prefix>string</Prefix>
<KeyCount>integer</KeyCount>
<MaxKeys>integer</MaxKeys>
<Delimiter>string</Delimiter>
<IsTruncated>boolean</IsTruncated>
<Contents>
<Key>string</Key>
<LastModified>timestamp</LastModified>
<ETag>string</ETag>
<Size>integer</Size>
<StorageClass>string</StorageClass>
<ChecksumAlgorithm>string</ChecksumAlgorithm>
<Owner>
<DisplayName>string</DisplayName>
<ID>string</ID>
</Owner>
#ifdef GOOGLES3
<Generation>string</Generation>
<MetaGeneration>string</MetaGeneration>
#endif
...
</Contents>
...
<CommonPrefixes>
<Prefix>string</Prefix>
</CommonPrefixes>
...
<EncodingType>string</EncodingType>
<ContinuationToken>string</ContinuationToken>
<NextContinuationToken>string</NextContinuationToken>
<StartAfter>string</StartAfter>
</ListBucketResult>
=========================
*/
static int
parse_listbucketresult(char* xml, unsigned long long xmllen, struct LISTOBJECTSV2** resultp)
{
int stat = NC_NOERR;
ncxml_doc_t doc = NULL;
ncxml_t x;
struct LISTOBJECTSV2* result = NULL;
#ifdef DEBUG
printf("-------------------------%s\n-------------------------\n",xml);
#endif
doc = ncxml_parse(xml,xmllen);
if(doc == NULL) {stat = NC_ES3; goto done;}
ncxml_t dom = ncxml_root(doc);
/* Verify top level element */
if(strcmp(ncxml_name(dom),"ListBucketResult")!=0) {
nclog(NCLOGERR,"Expected: <ListBucketResult> actual: <%s>",ncxml_name(dom));
stat = NC_ES3;
goto done;
}
if((result = alloclistobjectsv2())==NULL) {stat = NC_ENOMEM; goto done;}
/* Iterate next-level elements */
for(x=ncxml_child_first(dom);x != NULL;x=ncxml_child_next(x)) {
const char* elem = ncxml_name(x);
if(strcmp(elem,"IsTruncated")==0) {
result->istruncated = trim(ncxml_text(x),RECLAIM);
} else if(strcmp(elem,"Contents")==0) {
if((stat = parse_object(x,result->contents))) goto done;
} else if(strcmp(elem,"Name")==0) {
result->name = trim(ncxml_text(x),RECLAIM);
} else if(strcmp(elem,"Prefix")==0) {
result->prefix = trim(ncxml_text(x),RECLAIM);
} else if(strcmp(elem,"Delimiter")==0) {
result->delimiter = trim(ncxml_text(x),RECLAIM);
} else if(strcmp(elem,"MaxKeys")==0) {
result->maxkeys = trim(ncxml_text(x),RECLAIM);
} else if(strcmp(elem,"CommonPrefixes")==0) {
if((stat = parse_prefix(x,result->commonprefixes))) goto done;
} else if(strcmp(elem,"EncodingType")==0) {
result->encodingtype = trim(ncxml_text(x),RECLAIM);
} else if(strcmp(elem,"KeyCount")==0) {
result->keycount = trim(ncxml_text(x),RECLAIM);
} else if(strcmp(elem,"ContinuationToken")==0) {
result->continuationtoken = trim(ncxml_text(x),RECLAIM);
} else if(strcmp(elem,"NextContinuationToken")==0) {
result->nextcontinuationtoken = trim(ncxml_text(x),RECLAIM);
} else if(strcmp(elem,"StartAfter")==0) {
result->startafter = trim(ncxml_text(x),RECLAIM);
} else if(strcmp(elem,"StartAfter")==0) {
result->startafter = trim(ncxml_text(x),RECLAIM);
} else {
nclog(NCLOGERR,"Unexpected Element: <%s>",elem);
stat = NC_ES3;
goto done;
}
}
if(resultp) {*resultp = result; result = NULL;}
done:
if(result) reclaim_listobjectsv2(result);
if(doc) ncxml_free(doc);
return NCTHROW(stat);
}
static int
parse_object(ncxml_t root, NClist* objects)
{
int stat = NC_NOERR;
ncxml_t x;
struct Object* object = NULL;
/* Verify top level element */
if(strcmp(ncxml_name(root),"Contents")!=0) {
nclog(NCLOGERR,"Expected: <Contents> actual: <%s>",ncxml_name(root));
stat = NC_ES3;
goto done;
}
if((object = allocobject())==NULL) {stat = NC_ENOMEM; goto done;}
for(x=ncxml_child_first(root);x != NULL;x=ncxml_child_next(x)) {
const char* elem = ncxml_name(x);
if(strcmp(elem,"ChecksumAlgorithm")==0) {
if((stat = parse_checksumalgorithm(x,object->checksumalgorithms))) goto done;
} else if(strcmp(elem,"ETag")==0) {
object->etag = trim(ncxml_text(x),RECLAIM);
} else if(strcmp(elem,"Key")==0) {
object->key = trim(ncxml_text(x),RECLAIM);
} else if(strcmp(elem,"LastModified")==0) {
object->lastmodified = trim(ncxml_text(x),RECLAIM);
} else if(strcmp(elem,"Owner")==0) {
if((stat = parse_owner(x,&object->owner))) goto done;
} else if(strcmp(elem,"Size")==0) {
object->size = trim(ncxml_text(x),RECLAIM);
} else if(strcmp(elem,"StorageClass")==0) {
object->storageclass = trim(ncxml_text(x),RECLAIM);
} else if(strcmp(elem,"Generation")==0) {
/* Ignore */
} else if(strcmp(elem,"MetaGeneration")==0) {
/* Ignore */
} else {
nclog(NCLOGERR,"Unexpected Element: <%s>",elem);
stat = NC_ES3;
goto done;
}
}
nclistpush(objects,object);
object = NULL;
done:
if(object) reclaim_object(object);
return NCTHROW(stat);
}
static int
parse_owner(ncxml_t root, struct Owner* owner)
{
int stat = NC_NOERR;
ncxml_t x;
/* Verify top level element */
if(strcmp(ncxml_name(root),"Owner")!=0) {
nclog(NCLOGERR,"Expected: <Owner> actual: <%s>",ncxml_name(root));
stat = NC_ES3;
goto done;
}
for(x=ncxml_child_first(root);x != NULL;x=ncxml_child_next(x)) {
const char* elem = ncxml_name(x);
if(strcmp(elem,"DisplayName")==0) {
owner->displayname = trim(ncxml_text(x),RECLAIM);
} else if(strcmp(elem,"ID")==0) {
owner->id = trim(ncxml_text(x),RECLAIM);
} else {
nclog(NCLOGERR,"Unexpected Element: <%s>",elem);
stat = NC_ES3;
goto done;
}
}
done:
return NCTHROW(stat);
}
static int
parse_prefix(ncxml_t root, NClist* prefixes)
{
int stat = NC_NOERR;
ncxml_t x;
char* prefix = NULL;
/* Verify top level element */
if(strcmp(ncxml_name(root),"CommonPrefixes")!=0) {
nclog(NCLOGERR,"Expected: <CommonPrefixes> actual: <%s>",ncxml_name(root));
stat = NC_ES3;
goto done;
}
for(x=ncxml_child_first(root);x != NULL;x=ncxml_child_next(x)) {
const char* elem = ncxml_name(x);
if(strcmp(elem,"Prefix")==0) {
prefix = trim(ncxml_text(x),RECLAIM);
nclistpush(prefixes,prefix);
prefix = NULL;
} else {
nclog(NCLOGERR,"Unexpected Element: <%s>",elem);
stat = NC_ES3;
goto done;
}
}
done:
nullfree(prefix);
return NCTHROW(stat);
}
static int
parse_checksumalgorithm(ncxml_t root, NClist* algorithms)
{
int stat = NC_NOERR;
char* alg = NULL;
/* Verify top level element */
if(strcmp(ncxml_name(root),"ChecksumAlgorithm")!=0) {
nclog(NCLOGERR,"Expected: <ChecksumAlgorithm> actual: <%s>",ncxml_name(root));
stat = NC_ES3;
goto done;
}
alg = trim(ncxml_text(root),RECLAIM);
nclistpush(algorithms,alg);
alg = NULL;
done:
nullfree(alg);
return NCTHROW(stat);
}
static struct LISTOBJECTSV2*
alloclistobjectsv2(void)
{
struct LISTOBJECTSV2* lov2 = NULL;
if((lov2 = calloc(1,sizeof(struct LISTOBJECTSV2))) == NULL)
return lov2;
lov2->contents = nclistnew();
lov2->commonprefixes = nclistnew();
return lov2;
}
static struct Object*
allocobject(void)
{
struct Object* obj = NULL;
if((obj = calloc(1,sizeof(struct Object))) == NULL)
return obj;
obj->checksumalgorithms = nclistnew();
return obj;
}
static void
reclaim_listobjectsv2(struct LISTOBJECTSV2* lo)
{
int i;
if(lo == NULL) return;
nullfree(lo->istruncated);
for(i=0;i<nclistlength(lo->contents);i++)
reclaim_object((struct Object*)nclistget(lo->contents,i));
nclistfree(lo->contents);
nullfree(lo->name);
nullfree(lo->prefix);
nullfree(lo->delimiter);
nullfree(lo->maxkeys);
nclistfreeall(lo->commonprefixes);
nullfree(lo->encodingtype);
nullfree(lo->keycount);
nullfree(lo->continuationtoken);
nullfree(lo->nextcontinuationtoken);
nullfree(lo->startafter);
free(lo);
}
static void
reclaim_object(struct Object* o)
{
if(o == NULL) return;
nclistfreeall(o->checksumalgorithms);
nullfree(o->etag);
nullfree(o->key);
nullfree(o->lastmodified);
nullfree(o->owner.displayname);
nullfree(o->owner.id);
nullfree(o->size);
nullfree(o->storageclass);
free(o);
}
static char*
trim(char* s, int reclaim)
{
ptrdiff_t first=0,last=0;
const char* p;
char* t = NULL;
size_t len;
for(p=s;*p;p++) {
if(*p > ' ') {first = (p - s); break;}
}
for(p=s+(strlen(s)-1);p >= s;p--) {
if(*p > ' ') {last = (p - s); break;}
}
len = (last - first) + 1;
if((t = (char*)malloc(len+1))==NULL) return t;
memcpy(t,s+first,len);
t[len] = '\0';
if(reclaim) nullfree(s);
return t;
}
/*
Get Info about a single object from a vector
*/
static int
s3objectinfo1(const struct Object* s3_object, char** fullkeyp, uintptr_t* lenp)
{
int stat = NC_NOERR;
const char* key = NULL;
char* tmp = NULL;
unsigned long long len;
assert(fullkeyp);
key = s3_object->key;
len = strlen(key);
if((tmp = (char*)malloc(len+1+1))==NULL) {stat = NC_ENOMEM; goto done;}
tmp[0] = '\0';
if(key[0] != '/') strlcat(tmp,"/",len+1+1);
strlcat(tmp,key,len+1+1);
sscanf(s3_object->size,"%llu",&len);
if(fullkeyp) {*fullkeyp = tmp; tmp = NULL;}
if(lenp) *lenp = (size64_t)len;
done:
if(tmp) free(tmp);
return NCTHROW(stat);
}
/*
Get Info about a vector of objects; Keys are fixed up to start with a '/'
*/
static int
s3objectsinfo(NClist* contents, NClist* keys, NClist* lengths)
{
int stat = NC_NOERR;
size_t i;
char* key = NULL;
uintptr_t length = 0;
for(i=0;i<nclistlength(contents);i++) {
struct Object* s3_object = (struct Object*)nclistget(contents,i);
if((stat = s3objectinfo1(s3_object,&key,&length))) goto done;
if(keys != NULL) {nclistpush(keys,key);} else {nullfree(key);}
key = NULL;
if(lengths != NULL) nclistpush(lengths,(void*)length);
}
if(keys != NULL) nclistnull(keys);
if(lengths != NULL) nclistnull(lengths);
done:
nullfree(key); /* avoid mem leak */
return NCTHROW(stat);
}
/* Ensure each key starts with '/' */
static int
s3commonprefixes(NClist* list, NClist* keys)
{
int stat = NC_NOERR;
int i;
for (i=0;i<nclistlength(list);i++) {
char* p;
size_t len;
const char* prefix = (char*)nclistget(list,i);
len = strlen(prefix);
if((p = (char*) malloc(len+1+1))==NULL) /* for nul + leading '/' */
{stat = NC_ENOMEM; goto done;}
*p = '\0';
if(*prefix != '/') strlcat(p,"/",len+1+1);
strlcat(p,prefix,len+1+1);
nclistpush(keys,p); p = NULL;
}
done:
nclistnull(keys);
return NCTHROW(stat);
}
/* Add new key,value pair to a query; encode before insertion; keep in sorted order */
static int
queryadd(NClist* query, const char* key, const char* value)
{
int stat = NC_NOERR;
char* ekey = NULL;
char* evalue = NULL;
if(key == NULL) {stat = NC_EINVAL; goto done;}
if((stat = NCH5_s3comms_uriencode(&ekey, key, strlen(key), 1/*true*/, NULL))) goto done;
evalue = NULL;
if(value != NULL) {
if((stat = NCH5_s3comms_uriencode(&evalue, value, strlen(value), 1/*true*/, NULL))) goto done;
}
/* Insert encoded key+value keeping sorted order */
if((stat = queryinsert(query, ekey, evalue))) goto done;
ekey = NULL;
evalue = NULL;
done:
nullfree(ekey);
nullfree(evalue);
return NCTHROW(stat);
}
static int
queryend(NClist* query, char** querystring)
{
int stat = NC_NOERR;
size_t i;
NCbytes* buf = ncbytesnew(); /* accumulate final query string */
/* build the final query string */
for(i=0;i<nclistlength(query);i+=2) {
const char* key = (const char*)nclistget(query,i);
const char* value = (const char*)nclistget(query,i+1);
if(ncbyteslength(buf) > 0) ncbytescat(buf,"&");
ncbytescat(buf,key);
ncbytescat(buf,"=");
if(value != NULL)
ncbytescat(buf,value);
}
if(querystring) {*querystring = ncbytesextract(buf);}
ncbytesfree(buf);
return NCTHROW(stat);
}
/* Insert encoded key+value keeping sorted order */
static int
queryinsert(NClist* list, char* ekey, char* evalue)
{
int pos,i,stat = NC_NOERR;
for(pos=-1,i=0;i<nclistlength(list);i+=2) {
const char* key = (const char*)nclistget(list,i);
int cmp = strcmp(key,ekey);
if(cmp == 0) {stat = NC_EINVAL; goto done;} /* duplicate keys */
if(cmp > 0) {pos = i; break;} /* key > ekey => insert ekey before key */
}
if(pos < 0) pos = nclistlength(list); /* insert at end; also works if |list|==0 */
nclistinsert(list,pos,evalue);
nclistinsert(list,pos,ekey);
done:
return NCTHROW(stat);
}
|