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 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057
|
#include "common.h"
#include "utils.h"
#include "filetransfer.h"
#include "globbing.h"
static void ft_del(GS_LIST_ITEM *li);
static void free_get_li(GS_LIST_ITEM *li);
static void ft_done(GS_FT *ft);
static void qerr_add(GS_FT *ft, uint32_t id, uint8_t code, const char *str);
static void qerr_add_printf(GS_FT *ft, uint32_t id, uint8_t code, const char *fmt, ...);
static void mk_stats_ft(GS_FT *ft);
static void mk_stats_file(GS_FT *ft, uint32_t id, struct _gs_ft_file *f, const char *fname, int err);
static mode_t GS_fperm2mode(uint32_t u);
static uint32_t GS_mode2fperm(mode_t m);
static void update_stats(GS_FT *ft, struct _gs_ft_file *f, size_t sz);
static void init_xfer_stats(GS_FT *ft, struct _gs_ft_file *f, int64_t sz);
static const char *str_dotslash(const char *src);
static const char *str_stripslash(const char *src);
static int mkdirpm(const char *dir, mode_t mode, uint32_t mtime);
static void dir_restore_mtime(const char *path, struct timespec *mtime);
static void dir_save_mtime(const char *path, struct timespec *mtime);
static void set_mode_mtime(const char *path, mode_t mode, uint32_t mtime);
static void call_status_cb(GS_FT *ft, const char *fname, uint8_t code, const char *err_str);
static void status_report_error(GS_FT *ft, const char *name, uint8_t code);
static uint8_t errno2code(int eno /*errno*/, uint8_t default_code);
#if 0
0 FIXME: must make sure that server cant request transfer from client!
- test when file becomes unavaialble after it was added.
- Sym Link
- max buffer size 64 macro somewhere needed
- queue up all 'put' requests and send as 1 large message or loop around write() while we can.
- What do we do if a pathname/filename does not fit into wbuf? Filename can be rather long (like 4k?)
and larger than channel buffer
(add files until it does not fit. Return to caller the ID that failed and let caller decide
if he likes to remove that ID from our list or just let caller try again until it fits...)
is there a limt?
- fnmatch for receiving files (hehe. yes please).
STOP HERE:
- Test '/usr/./share/' downloads etc
- deal with server sending /etc/hosts or ../../ shit (strchr?)
- do a HUGE get download.
- do a HUGE put upload
TEST CASES:
1. pathname + filename 4096 long
#2. dest file not writeable
#3. re-start transmission
4. same file in command line
#5. src file can not be opened or read error.
#6. write to symlink - as per unix (follow symlinks)
#7. zero file size
#8. retain timestamp
#endif
void
GS_FT_init(GS_FT *ft, gsft_cb_stats_t func_stats, gsft_cb_status_t func_status, pid_t pid, void *arg, int is_server)
{
memset(ft, 0, sizeof *ft);
if (is_server == 0)
{
// CLIENT
// PUT (upload) - Client side
GS_LIST_init(&ft->fqueue, 0);
GS_LIST_init(&ft->fputs, 0);
GS_LIST_init(&ft->faccepted, 0);
GS_LIST_init(&ft->fcompleted, 0);
// GET (download) - Client side
GS_LIST_init(&ft->plistreq, 0);
GS_LIST_init(&ft->plistreq_waiting, 0);
GS_LIST_init(&ft->flist, 0);
GS_LIST_init(&ft->fdl_waiting, 0);
} else {
// SERVER
// PUT (upload) - Server Side
GS_LIST_init(&ft->fadded, 0);
GS_LIST_init(&ft->freceiving, 0);
// GET (download) - Server side
GS_LIST_init(&ft->flistreply, 0);
GS_LIST_init(&ft->fdl, 0);
}
GS_LIST_init(&ft->qerrs, 0);
ft->pid = pid;
ft->func_arg = arg;
ft->func_stats = func_stats;
ft->func_status = func_status;
ft->is_server = is_server;
}
#ifdef SELFTESTS
static const char **g_filesv;
static int g_filesc;
static const char *g_true_fname;
// For test 8.9: Server is a bad actor and sends ../../0wned.dat etc as list-reply for any request.
void
GS_FT_init_tests(const char **argv)
{
g_filesv = argv;
g_filesc = 0;
}
#endif
static struct _gs_ft_file *
file_new(const char *fname, const char *fn_local, const char *fn_relative, int64_t fz_local, int64_t fz_remote, uint32_t mtime, uint32_t fperm)
{
struct _gs_ft_file *f;
f = calloc(1, sizeof *f);
f->mode = fperm;
f->mtime = mtime;
f->fz_local = fz_local;
f->fz_remote = fz_remote;
if (fn_relative != NULL)
f->fn_relative = strdup(fn_relative);
if (fn_local != NULL)
{
// CLIENT
f->fn_local = strdup(fn_local); // absolute file name
} else {
// SERVER (put & get)
f->fn_local = strdup(fname);
}
f->name = strdup(fname);
return f;
}
// SERVER. put & get
static int
gs_ft_add_file(GS_FT *ft, GS_LIST *gsl, uint32_t id, const char *fname, uint32_t mtime, uint32_t fperm, int64_t fz_remote, uint8_t flags)
{
struct stat res;
int ret;
int64_t fz = 0;
// First: Directory struture.
if (flags & GS_FT_FL_ISDIR)
{
// mkdirpm() will remove any ordinary file that is in its way
if (mkdirpm(fname, GS_fperm2mode(fperm), mtime) != 0)
{
DEBUGF_R("mkdir(%s): %s\n", fname, strerror(errno));
qerr_add(ft, id, GS_FT_ERR_PERM, NULL);
return -GS_FT_ERR_PERM;
}
// HERE: Directory (not file). Return immediately.
return 0;
}
// HERE: Remote is sending an ordinary FILE (not directory)
ret = stat(fname, &res);
if (ret != 0)
{
if (errno != ENOENT)
{
DEBUGF_R("Permission Denied: %s\n", fname);
qerr_add(ft, id, GS_FT_ERR_PERM, NULL);
return -GS_FT_ERR_PERM; // Exists but stat() failed
}
DEBUGF_R("Not found: %s\n", fname);
} else {
// FILE exists
if (!S_ISREG(res.st_mode))
{
DEBUGF_R("WARN: %s not a regular file\n", fname);
qerr_add(ft, id, GS_FT_ERR_BADF, NULL);
return -GS_FT_ERR_BADF; // Not a regular file
}
if (S_ISDIR(res.st_mode))
{
// Remote wants to send file but directory is in the way
DEBUGF_R("WARN: Directory is in the way: %s\n", fname);
qerr_add(ft, id, GS_FT_ERR_PERM, NULL);
return -GS_FT_ERR_PERM;
}
fz = res.st_size;
}
// HERE: File (not directory)
struct _gs_ft_file *f;
f = file_new(fname, NULL, fname, fz, fz_remote, mtime, GS_fperm2mode(fperm));
f->li = GS_LIST_add(gsl, NULL, f, id);
ft->is_want_write = 1;
return 0;
}
/*
* SERVER, PUT (upload)
* Return < 0 on error.
* Return 0 otherwise.
*/
int
GS_FT_add_file(GS_FT *ft, uint32_t id, const char *fname, size_t len, int64_t fsize, uint32_t mtime, uint32_t fperm, uint8_t flags)
{
if (fname[len] != '\0')
return -1; // protocol error. Not 0 terminated.
// FIXME: sanitize file name
DEBUGF_Y("#%u ADD-FILE - size %"PRIu64", fperm 0%o, '%s' mtime=%d flags=0x%02x (n_items=%d)\n", id, fsize, fperm, fname, mtime, flags, ft->fadded.n_items);
char fn_local[4096];
char *wdir = GS_getpidwd(ft->pid);
snprintf(fn_local, sizeof fn_local, "%s/%s", wdir, fname);
XFREE(wdir);
return gs_ft_add_file(ft, &ft->fadded, id, fn_local, mtime, fperm, fsize /*remote size*/, flags);
}
/*
* SERVER, GET (download)
* Client requested this file. Add to list of files that need to be send to peer.
* Server (if idle) will send a get_switch message and start transmitting data.
*/
int
GS_FT_dl_add_file(GS_FT *ft, uint32_t id, const char *fname, size_t len, int64_t fz_remote)
{
if (fname[len] != '\0')
return -1; // protocol error. Not 0 terminated.
DEBUGF_Y("#%u DL-ADD-FILE - '%s' fz_remote=%"PRId64"\n", id, fname, fz_remote);
#ifdef SELFTESTS
// Test [8.9]
if (g_true_fname != NULL)
{
fname = g_true_fname;
DEBUGF_B("TESTING: Fake filename. Using data from %s\n", fname);
}
#endif
struct stat res;
int ret;
ret = stat(fname, &res);
if (ret != 0)
{
DEBUGF_R("NOT FOUND: %s\n", fname);
qerr_add_printf(ft, id, GS_FT_ERR_NOENT, "Not found: %s", fname);
return -1;
}
if (!S_ISREG(res.st_mode))
{
DEBUGF_R("WARN2: %s not a regular file\n", fname);
return -2;
}
return gs_ft_add_file(ft, &ft->fdl, id, fname, res.st_mtime, res.st_mode, fz_remote, 0 /*flags, unused*/);
}
/*
* CLIENT, Get (download) - receiving a file list from server
* Add a single file (that exists on server) to the list that the client may request for download.
*/
int
GS_FT_list_add(GS_FT *ft, uint32_t globbing_id, const char *fname, size_t len, int64_t fz_remote, uint32_t mtime, uint32_t fperm, uint8_t flags)
{
struct _gs_ft_list_pattern *p = NULL;
int ret;
if (fname[len] != '\0')
return -1;
DEBUGF_Y("G#%u LISTREPLY - fperm 0%o, '%s'\n", globbing_id, fperm, fname);
// Check if returned file matches what we asked for. This stops the server
// from sending files that we did not request.
GS_LIST_ITEM *li = GS_LIST_by_id(&ft->plistreq_waiting, globbing_id);
if (li == NULL)
{
DEBUGF_R("Oops. Received G#%u but no file requested? (listreq_waiting=%d)\n", globbing_id, ft->plistreq_waiting.n_items);
return -1;
}
p = (struct _gs_ft_list_pattern *)li->data;
char fn_local[4096];
const char *fn_relative;
fn_relative = str_dotslash(fname);
if (fn_relative == NULL)
{
fn_relative = str_stripslash(fname);
}
snprintf(fn_local, sizeof fn_local, "%s/%s", p->wdir, fn_relative);
#if 0
// DISABLED check. Not possible with wordexp() support.
if (fnmatch(p->pattern, fn_local, 0) != 0)
{
DEBUGF_R("filename does not match request (%s != %s)\n", fname, p->pattern);
// goto done; // FIXME: C 'foo/*' would return 'bar/x.txt' but should return 'foo/bar/x.txt'
}
#endif
// Sanity-check for '..' and deny if server sends reply containing '..'
if (strstr(fn_local, "..") != NULL)
{
DEBUGF_R("Bad file name (%s)...\n", fn_local);
goto done;
}
if (flags & GS_FT_FL_ISDIR)
{
DEBUGF_C("Directory: %s\n", fn_local);
// mkdirpm() will remove any ordinary file that is in its way
if (mkdirpm(fn_local, GS_fperm2mode(fperm), mtime) != 0)
{
DEBUGF_R("mkdir(%s): %s\n", fn_local, strerror(errno));
}
goto done;
}
struct stat res;
ret = stat(fn_local, &res);
int64_t fz_local = 0;
if (ret == 0)
{
if (res.st_size == fz_remote)
{
DEBUGF_R("File of equal size already exists (%s)\n", fn_local);
mk_stats_file(ft, -1, NULL, fn_relative, 0 /*success*/);
goto done;
}
if (res.st_size < fz_remote)
fz_local = res.st_size;
}
struct _gs_ft_file *f;
f = file_new(fname, fn_local, fn_relative, fz_local, fz_remote, mtime, GS_fperm2mode(fperm));
f->li = GS_LIST_add(&ft->flist, NULL, f, ft->g_id);
ft->g_id += 1;
// Update global stats
init_xfer_stats(ft, f, f->fz_remote - f->fz_local);
ft->n_files_waiting += 1;
ft->is_want_write = 1;
ret = 0;
done:
if (flags & GS_FT_LISTREPLY_FL_LAST)
{
DEBUGF_G("Last file for this globbing id. Free'ing get-list\n");
free_get_li(li);
// Scenario: All requested files got skipped (already exist).
// - no get request (for file data) outstanding.
// Trigger that GS_FT_packet() is called to return GS_FT_TYPE_DONE (all files transferred)
if ((ft->n_files_waiting == 0) && (ft->plistreq_waiting.n_items == 0))
ft->is_want_write = 1;
}
return 0;
}
struct _mperm
{
mode_t mode;
uint32_t perm;
};
struct _mperm x_mperm[] = {
{S_ISUID, 04000},
{S_ISGID, 02000},
{S_ISVTX, 01000},
{S_IRUSR, 00400},
{S_IWUSR, 00200},
{S_IXUSR, 00100},
{S_IRGRP, 00040},
{S_IWGRP, 00020},
{S_IXGRP, 00010},
{S_IROTH, 00004},
{S_IWOTH, 00002},
{S_IXOTH, 00001}
};
// Host to network byte order for st_mode file permission
static uint32_t
GS_mode2fperm(mode_t m)
{
uint32_t u = 0;
int n;
m &= ~S_IFMT;
for (n = 0; n < sizeof x_mperm / sizeof *x_mperm; n++)
{
if (m & x_mperm[n].mode)
u |= x_mperm[n].perm;
}
// DEBUGF_B("mode2fperm 0%o\n", u);
return u;
}
// Network to host byte order for st_mode file permission
static mode_t
GS_fperm2mode(uint32_t u)
{
mode_t m = 0;
int n;
// DEBUGF_B("fperm2mode 0%o\n", u);
for (n = 0; n < sizeof x_mperm / sizeof *x_mperm; n++)
{
if (u & x_mperm[n].perm)
m |= x_mperm[n].mode;
}
return m;
}
// strip all '/' from beginning of string.
static const char *
str_stripslash(const char *src)
{
while (*src == '/')
src++;
return src;
}
// Find '/./' in string
// "/foo/./bar/test1.txt" -> "bar/test1.txt"
// "/foo/bar/./test1.txt" -> "test1.txt"
// "/foo/bar/test1.txt" -> NULL
// "test1.txt" -> NULL
static const char *
str_dotslash(const char *src)
{
char *token;
token = strstr(src, "/./");
if (token == NULL)
return NULL;
src = token + 3; // skip '/./'
src = str_stripslash(src);
return src;
}
// Takes a <dir>/./<dir2>/<filename> construct and returns <dir2>/<filename> part.
// Space is allocated to hold the new string. Caller must call free() to free it.
static char *
dotslash_filename(const char *src)
{
char *dst = NULL;
/*
* Consider these possibilities (examples)
* /tmp/foo/bar/hosts
* /./tmp/foo/bar/hosts
* /tmp/foo/./bar/./hosts
* /tmp/./foo/bar/hosts
* hosts
* foo/bar/host
*/
// Find token after last occurance of '/./'
const char *str;
str = str_dotslash(src);
// str contains everything after '/./' or fname if '/./' not found.
if (str == NULL)
{
// HERE: No '/./'. Use basename (file only, no directory part)
char *s = strdup(src); // basename() might modify str
dst = strdup(basename(s));
free(s);
} else {
// Scenario: put 'foo/'' will turn into 'foo/./'' which will call
// GS_FT_put(foo/.//bar/file.txt) which must end up with 'bar/file.txt'
// and not with '/bar/file.txt'
str = str_stripslash(str);
dst = strdup(str);
}
return dst;
}
// CLIENT, put (upload)
// SERVER, get (download), after globbing.
static int
add_file_to_list(GS_FT *ft, GS_LIST *gsl, const char *fname, uint32_t globbing_id, int is_server)
{
// SERVER, get: Even if it does not exist then we still need to add it to the LISTREPLY list
// Client will request it and only then will we send an error.
// This can happen when client requests "foo[123].notexist[233].da*" and globbing
// fails.
// CLIENT: Immediatly return.
int ret;
int is_notfound = 0;
struct stat res;
ret = stat(fname, &res);
if (ret != 0)
{
DEBUGF_R("%s NOT FOUND\n", fname);
if (is_server == 0)
{
char *name = dotslash_filename(fname);
status_report_error(ft, name, GS_FT_ERR_NOENT);
XFREE(name);
return -1;
}
is_notfound = 1; // Server, get (download)
}
struct _gs_ft_file *f;
f = calloc(1, sizeof *f);
f->globbing_id = globbing_id;
if (is_server == 1)
{
// Server, GET (download).
#ifdef SELFTESTS
const char *ff = fname;
if ((g_filesv != NULL) && (g_filesv[g_filesc] != NULL))
{
ff = g_filesv[g_filesc];
g_filesc++;
if (g_filesv[g_filesc] == NULL)
g_filesc = 0;
g_true_fname = strdup(fname);
}
f->name = strdup(ff);
#else
f->name = strdup(fname);
#endif
} else {
// Client, PUT (upload).
f->name = dotslash_filename(fname);
f->fn_relative = strdup(f->name);
}
DEBUGF_Y("#%u name = %s\n", ft->g_id, f->name);
f->li = GS_LIST_add(gsl, NULL, f, ft->g_id);
ft->g_id += 1;
// stat() failed.
if (is_notfound)
{
DEBUGF_R("stat(%s): %s\n", fname, strerror(errno));
return -1;
}
// Get absolute and real path as CWD may change before
// upload starts.
char *realfname = malloc(GS_PATH_MAX); // solaris10 does not support realpath(ptr, NULL);
if (realpath(fname, realfname) == NULL)
{
XFREE(realfname);
return -3;
}
f->fn_local = realfname;
f->fz_local = res.st_size;
f->mode = res.st_mode;
f->mtime = res.st_mtime;
return 0;
}
/*
* CLIENT: Add this file (not directory) to queue.
*/
static int
gs_ft_put(GS_FT *ft, const char *fname)
{
int ret;
ret = add_file_to_list(ft, &ft->fqueue, fname, 0 /*unused*/, 0 /*is_client*/);
if (ret != 0)
return ret;
ft->n_files_waiting += 1;
return 0;
}
// CLIENT
static void
glob_cb_client(GS_GL *res)
{
GS_FT *ft = (GS_FT *)res->arg_ptr;
gs_ft_put(ft, res->name);
}
// CLIENT
int
GS_FT_put(GS_FT *ft, const char *pattern)
{
int n_found;
n_found = GS_GLOBBING(glob_cb_client, pattern, -1, ft, 0);
if (n_found <= 0)
{
// Globbing error
DEBUGF_R("NOT FOUND: %s\n", pattern);
char buf[128];
snprintf(buf, sizeof buf, "%s: %s", GS_FT_strerror(GS_FT_ERR_INVAL), pattern);
call_status_cb(ft, pattern, GS_FT_ERR_INVAL, buf);
return -1;
}
return 0;
}
// SERVER: Add a single file
static int
get_add_file(GS_FT *ft, const char *fname, uint32_t globbing_id)
{
int ret;
DEBUGF_G("Adding %s\n", fname);
// Retrieve all info for the file.
ret = add_file_to_list(ft, &ft->flistreply, fname, globbing_id, 1 /*is_server*/);
if (ret != 0)
{
return ret;
}
return 0;
}
// SERVER
static void
glob_cb(GS_GL *res)
{
GS_FT *ft = (GS_FT *)res->arg_ptr;
DEBUGF_Y("G#%u \n", res->globbing_id);
get_add_file(ft, res->name, res->globbing_id);
}
// SERVER: Generate file list based on globbing pattern sent by client.
int
GS_FT_list_add_files(GS_FT *ft, uint32_t globbing_id, const char *pattern, size_t len)
{
int ret;
int cwd_fd;
if (pattern[len] != '\0')
return -1; // protocol error. Not 0-terminated.
DEBUGF_Y("G#%u GET-ADD-FILE: %s\n", globbing_id, pattern);
cwd_fd = open(".", O_RDONLY);
if (cwd_fd < 0)
DEBUGF_R("open(.): %s\n", strerror(errno));
char *ptr = GS_getpidwd(ft->pid);
ret = chdir(ptr); // Temporarily change CWD for globbing to work.
if (ret != 0)
{
DEBUGF_R("chdir(%s): %s\n", ptr, strerror(errno));
qerr_add_printf(ft, globbing_id, errno2code(errno, GS_FT_ERR_NOENT), "chdir(%s): %s\n", ptr, strerror(errno));
goto done;
}
ret = GS_GLOBBING(glob_cb, pattern, globbing_id, ft, 0);
if (ret <= 0)
{
DEBUGF_R("NOT FOUND: %s\n", pattern);
qerr_add_printf(ft, globbing_id, GS_FT_ERR_NOENT, "Not found: %s", pattern);
}
done:
if (cwd_fd >= 0)
{
// Change back to original CWD.
if (fchdir(cwd_fd) == 0) {} // ignore results
close(cwd_fd);
}
XFREE(ptr);
ft->is_want_write = 1;
return ret;
}
/*
* CLIENT: Add a get-requst to the listrequest queue.
*/
int
GS_FT_get(GS_FT *ft, const char *pattern)
{
struct _gs_ft_list_pattern *p;
p = calloc(1, sizeof *p);
p->pattern = strdup(pattern);
p->wdir = getcwdx();
p->globbing_id = ft->g_id;
GS_LIST_add(&ft->plistreq, NULL, p, ft->g_id);
ft->g_id += 1;
return 0;
}
// Add an error message to (outgoing) queue.
static void
qerr_add(GS_FT *ft, uint32_t id, uint8_t code, const char *str)
{
struct _gs_ft_qerr *qerr;
qerr = calloc(1, sizeof *qerr);
qerr->id = id;
qerr->code = code;
qerr->str = NULL;
if (str != NULL)
qerr->str = strdup(str);
// Must add in sequence of occurance (add_count)
GS_LIST_add(&ft->qerrs, NULL, qerr, ft->qerrs.add_count);
ft->is_want_write = 1;
}
static void
qerr_add_printf(GS_FT *ft, uint32_t id, uint8_t code, const char *fmt, ...)
{
va_list ap;
char buf[128];
va_start(ap, fmt);
vsnprintf(buf, sizeof buf, fmt, ap);
va_end(ap);
qerr_add(ft, id, code, buf);
}
// Send status to peer (error-msg) and free the file structure.
static void
send_status_and_del(GS_FT *ft, GS_LIST_ITEM *li, uint32_t code, const char *str)
{
qerr_add(ft, li->id, code, str);
ft_del(li);
}
// Error while receiving data (called from GS_FT_switch() or GS_FT_data()
// Stop peer sending any further data for this id.
static void
do_recv_error(GS_FT *ft, GS_LIST_ITEM *li, uint32_t code, const char *str)
{
struct _gs_ft_file *f = (struct _gs_ft_file *)li->data;
if (ft->is_server == 0)
mk_stats_file(ft, li->id, f, NULL, 1 /*err*/);
send_status_and_del(ft, li, code, str);
}
// No more data to be send.
// Called by 'sending' party (either from mk_switch() or mk_xfer_data()
// when all data has been send.
// CLIENT: wait for COMPLETE error
// SERVER: Close immediately.
static void
sending_complete(GS_FT *ft, struct _gs_ft_file **active, GS_LIST *fcompleted)
{
struct _gs_ft_file *f = *active;
if (ft->is_server == 0)
{
XASSERT(fcompleted != NULL, "Client has no complete-queue??\n");
XFCLOSE(f->fp);
GS_LIST_move(fcompleted, f->li);
} else {
// SERVER
XASSERT(fcompleted == NULL, "Server has a complete-queue??\n");
ft_del(f->li);
}
*active = NULL;
}
// Expecting no more data. Called on receiving side
// Called by receiving party (from GS_FT_switch() or GS_FT_data())
// CLIENT: output stats, set time
static void
receiving_complete(GS_FT *ft, struct _gs_ft_file *f)
{
char *s = strdup(f->fn_local);
char *dn = dirname(s);
if (ft->is_server == 0)
{
// CLIENT (get, download: All data received)
mk_stats_file(ft, f->li->id, f, NULL, 0 /*err*/);
XFCLOSE(f->fp); // Must close before setting mtime
set_mode_mtime(f->fn_local, f->mode, f->mtime);
dir_restore_mtime(dn, &f->dir_mtime);
ft_done(ft);
ft_del(f->li);
// Trigger that GS_FT_packet() is called to return GS_FT_TYPE_DONE (all files transferred)
if ((ft->n_files_waiting == 0) && (ft->plistreq_waiting.n_items == 0))
ft->is_want_write = 1;
} else {
// SERVER (put, upload: all data received)
XFCLOSE(f->fp);
set_mode_mtime(f->fn_local, f->mode, f->mtime);
dir_restore_mtime(dn, &f->dir_mtime);
// close FP, free file, return COMPLETE message to client.
send_status_and_del(ft, f->li, GS_FT_ERR_COMPLETED, NULL);
}
XFREE(s);
}
static void
qerr_free(struct _gs_ft_qerr *qerr)
{
XFREE(qerr->str);
XFREE(qerr);
}
// SERVER & CLIENT
void
GS_FT_data(GS_FT *ft, const void *data, size_t len)
{
struct _gs_ft_file *f;
struct _gs_ft_file **active;
size_t sz;
if (ft->is_server)
active = &ft->active_put_file;
else
active = &ft->active_dl_file;
f = *active;
if (f == NULL)
{
DEBUGF_R("Receiving data but no active receiving file (len=%zu)\n", len);
HEXDUMP(data, MIN(len, 16));
return;
}
XASSERT(f->fp != NULL, "fp is NULL\n");
if (f->fz_local + len > f->fz_remote)
{
DEBUGF_R("More data than we want (%"PRIu64")! (fz_local=%"PRIu64", len == %zu, fz_remote = %"PRIu64"\n", f->fz_local + len - f->fz_remote, f->fz_local, len, f->fz_remote);
HEXDUMP((uint8_t *)data + (f->fz_remote - f->fz_local), (size_t)(f->fz_local + len - f->fz_remote));
len = f->fz_remote - f->fz_local; // truncating
}
sz = fwrite(data, 1, len, f->fp);
f->fz_local += sz;
if (sz != len)
{
do_recv_error(ft, f->li, GS_FT_ERR_BADF, NULL);
*active = NULL;
return;
}
if (ft->is_server == 0)
{
// CLIENT, get (download);
update_stats(ft, f, sz);
DEBUGF_W("xfer %"PRId64"/%"PRId64"\n", ft->stats.xfer_amount, ft->stats.xfer_amount_scheduled);
}
if (f->fz_local < f->fz_remote)
return; // still data missing...
DEBUGF_B("All data received (%"PRIu64" of %"PRIu64")\n", f->fz_local, f->fz_remote);
receiving_complete(ft, f);
*active = NULL;
}
// CLIENT
static void
init_xfer_stats(GS_FT *ft, struct _gs_ft_file *f, int64_t sz)
{
if (sz <= 0)
return;
f->xfer_amount_scheduled = sz;
ft->stats.xfer_amount_scheduled += f->xfer_amount_scheduled;
DEBUGF_W("Xfer Bytes Scheduled: %"PRId64", (added=%"PRId64")\n", ft->stats.xfer_amount_scheduled, f->xfer_amount_scheduled);
}
// CLIENT, put (upload)
void
GS_FT_accept(GS_FT *ft, uint32_t id, int64_t fz_remote)
{
GS_LIST_ITEM *li;
DEBUGF("#%u acc fz_remote = %"PRId64"\n", id, fz_remote);
li = GS_LIST_by_id(&ft->fputs, id);
if (li == NULL)
{
DEBUGF_R("Unknown file id %u\n", id);
return; // actually a protocol error....
}
GS_LIST_move(&ft->faccepted, li);
struct _gs_ft_file *f = (struct _gs_ft_file *)li->data;
f->fz_remote = fz_remote;
// Update global stats
init_xfer_stats(ft, f, f->fz_local - f->fz_remote);
ft->is_want_write = 1;
}
static void
set_mode_mtime(const char *path, mode_t mode, uint32_t mtime)
{
chmod(path, mode & ~S_IFMT);
struct timeval t[] = {{mtime, 0}, {mtime, 0}};
if (mtime != 0)
utimes(path, t);
}
// unlink any file in our way and create directory.
static int
mkdir_agressive(const char *path, mode_t mode, uint32_t mtime)
{
struct stat res;
if (stat(path, &res) == 0)
{
if (S_ISDIR(res.st_mode))
return 0; // Diretory already exists. return.
// Remove any other file or link.
DEBUGF_R("unlink(%s)\n", path);
unlink(path);
}
struct timespec ts;
char *s = strdup(path);
char *parent_dir = dirname(s);
dir_save_mtime(parent_dir, &ts);
if (mkdir(path, 0755 /*use chmod() to bypass umask-value*/) != 0)
{
DEBUGF_R("mkdir(%s) failed: %s\n", path, strerror(errno));
XFREE(s);
return -1;
}
set_mode_mtime(path, mode, mtime); // bypass umask-value
dir_restore_mtime(parent_dir, &ts);
XFREE(s);
return 0;
}
/*
* Create all directories recursively. Remove any file that is in our way.
*
* /tmp/foo/bar/test.dat would create /tmp/foo/bar/test.dat [directory]
* /tmp/foo/bar/test.dat/ would create /tmp/foo/bar/test.dat/
* ///// would return success ('/' always exists)
*/
static int
mkdirpm(const char *path, mode_t mode, uint32_t mtime)
{
int rv = 0;
struct stat res;
char *f = NULL;
// DEBUGF("mkdirpm(%s)\n", path);
// Return 0 if directory already exist
if (stat(path, &res) == 0)
{
if (S_ISDIR(res.st_mode))
{
// HERE: Directory exists.
if (mode == 0)
{
// HERE: Not allowed to overwrite permissions
// if (access(path, W_OK) != 0)
goto done; // Done have access
} else {
set_mode_mtime(path, mode, mtime);
}
// DEBUGF_W("%s already exists\n", f);
goto done;
}
}
// Directory does not exist. Use default permission to create it.
if (mode == 0)
mode = 0755;
f = strdup(path);
// If parent directory exist then only create last directory.
char *parent = dirname(f);
if ((parent != NULL) && (stat(parent, &res) == 0))
{
if (S_ISDIR(res.st_mode))
{
// HERE: Parent directory exists.
// DEBUGF_W("1-mkdir(%s)\n", path);
if (mkdir_agressive(path, mode, mtime) != 0)
rv = -1;
goto done;
}
}
XFREE(f); // dirname() may have modified it
f = strdup(path);
// HERE: Neither directory nor parent directory exist. Start from
// the left and create entire hirachy....
// No need to check '/' which always exists.
char *ptr = f;
while (*ptr == '/')
ptr++;
// Remove '/' from the right (tmp/foo///// -> tmp/foo)
char *end = ptr + strlen(ptr);
while (end > ptr)
{
end--;
if (*end != '/')
break;
*end = '\0';
}
// Empty string.
if (ptr == end)
goto done;
// HERE: Create all directory starting from left
// '/tmp' -> '/tmp/foo' -> '/tmp/foo/bar' -> ...
// and set mode for last directory.
mode_t new_mode = 0755;
while (1)
{
ptr = index(ptr, '/');
if (ptr != NULL)
*ptr = '\0';
else
new_mode = mode; // last part of directory
// DEBUGF_W("2-mkdir(%s, 0%o)\n", f, new_mode);
if (mkdir_agressive(f, new_mode, mtime) != 0)
{
rv = -1;
goto done;
}
if (ptr == NULL)
break;
*ptr = '/';
ptr += 1;
}
done:
XFREE(f);
return rv;
}
static void
dir_save_mtime(const char *path, struct timespec *mtime)
{
struct stat res;
memset(mtime, 0, sizeof *mtime);
if (stat(path, &res) != 0)
return;
#ifdef __APPLE__
*mtime = res.st_mtimespec;
#else
*mtime = res.st_mtim;
#endif
// DEBUGF_W("SAVE Dir-TimeStamp %lu.%lu %s\n", mtime->tv_sec, mtime->tv_nsec, path);
}
static void
dir_restore_mtime(const char *path, struct timespec *mtime)
{
// DEBUGF_W("RESTORE Dir-TimeStamp %lu %s\n", mtime->tv_sec, path);
if (mtime->tv_sec == 0)
return;
struct timeval t[] = {{mtime->tv_sec, mtime->tv_nsec / 1000}, {mtime->tv_sec, mtime->tv_nsec / 1000}};
utimes(path, t);
}
// SWITCH message received.
static void
gs_ft_switch(GS_FT *ft, uint32_t id, int64_t fz_remote, struct _gs_ft_file **active, GS_LIST *fsource)
{
GS_LIST_ITEM *li;
li = GS_LIST_by_id(fsource, id);
if (li == NULL)
{
DEBUGF_R("Unknown file id %u\n", id);
return; // actually a protocol error....
}
// Switch from active receiving file to new file
struct _gs_ft_file *new = (struct _gs_ft_file *)li->data;
DEBUGF_W("Switching to id %u '%s' (got %"PRId64", want %"PRId64")\n", id, new->name, new->fz_local, new->fz_remote);
if ((*active != NULL) && (*active != new))
{
fclose((*active)->fp);
}
*active = NULL;
// Server: Existing file is larger. Overwrite.
if (new->fz_local > new->fz_remote)
{
DEBUGF_W("File larger. Overwritting...\n");
XASSERT(fz_remote == 0, "fz_remote not 0 but server's file is larger\n");
new->fz_local = 0;
fz_remote = 0;
}
if ((new->fz_remote == new->fz_local) && (new->fz_local != 0))
{
receiving_complete(ft, new);
return;
}
if (fz_remote == 0)
{
DEBUGF_G("New file (%s) %s\n", new->fn_local, new->name);
char *ptr = new->fn_local;
// mkdir(): Remove leading './///' in './////foo/bar' (when globbing './')
if (*ptr == '.')
{
ptr++;
while (*ptr == '/')
ptr++;
}
char *dir = strdup(ptr); // direname() may modify dir
// ptr points to an internal buffer. strdup() it because mkdirpm() calls dirname() as well
// and would overwrite this structure..
ptr = strdup(dirname(dir));
dir_save_mtime(ptr, &new->dir_mtime);
// put(test1k.dat) must not modify the permission of parent directory.
mkdirpm(ptr, 0 /*do not update permission on existing directory*/, 0 /*do not update mtime*/);
XFREE(dir);
XFREE(ptr);
new->fp = fopen(new->fn_local, "w");
} else {
// Check fsize of local file.
DEBUGF_G("Appending to file\n");
struct stat res;
if (stat(new->fn_local, &res) != 0)
goto err;
if (res.st_size != new->fz_local)
{
// Size changed
do_recv_error(ft, new->li, GS_FT_ERR_BADFSIZE, NULL);
return;
}
new->fp = fopen(new->fn_local, "a");
}
if (new->fp == NULL)
{
DEBUGF("fopen(%s) failed: %s\n", new->fn_local, strerror(errno));
goto err;
}
if (new->fz_remote == 0)
{
// Zero File Size
DEBUGF("ZERO sized file received\n");
receiving_complete(ft, new);
return;
}
*active = new;
return;
err:
do_recv_error(ft, new->li, GS_FT_ERR_PERM, NULL);
}
void
GS_FT_switch(GS_FT *ft, uint32_t id, int64_t offset)
{
if (ft->is_server)
{
// Client is uploading (client send SWITCH command)
gs_ft_switch(ft, id, offset, &ft->active_put_file, &ft->freceiving);
} else {
// Client is downloading (server sent SWITCH command)
gs_ft_switch(ft, id, offset, &ft->active_dl_file, &ft->fdl_waiting);
}
}
static void
file_free(struct _gs_ft_file *f)
{
if (f == NULL)
return;
XFREE(f->name);
XFREE(f->fn_local);
XFREE(f->fn_relative);
XFREE(f);
}
// Reduce counter of outstanding files/errors.
static void
ft_done(GS_FT *ft)
{
if (ft->is_server != 0)
{
// SERVER
DEBUGF_R("WARN: DOES NOT HAPPEN\n");
return;
}
// Only client does requests. Server only answers. Thus only client keeps
// track of number of outstanding requests:
if (ft->n_files_waiting > 0)
ft->n_files_waiting -= 1;
else
DEBUGF_R("Oops, n_files_waiting == %d\n", ft->n_files_waiting);
}
/*
* Remove file from queue.
*/
static void
ft_del(GS_LIST_ITEM *li)
{
struct _gs_ft_file *f = (struct _gs_ft_file *)li->data;
// on client this should be closed already but on server this might
// still be open.
if (f->fp != NULL)
XFCLOSE(f->fp);
file_free(f);
GS_LIST_del(li);
}
// Human readable bps string
static void
mk_bps(char *str, size_t sz, uint64_t duration, uint64_t amount, int err, int is_zero)
{
if (err != 0)
{
snprintf(str, sz, "ERROR");
return;
}
if (is_zero)
{
snprintf(str, sz, "zero size");
return;
}
if (duration > 0)
GS_format_bps(str, sz, (amount * 1000000 / duration), "/s");
else
snprintf(str, sz, "SKIPPED");
}
// Generate stats per file and call call-back.
static void
mk_stats_file(GS_FT *ft, uint32_t id, struct _gs_ft_file *f, const char *name, int err)
{
struct _gs_ft_stats_file s;
memset(&s, 0, sizeof s);
s.id = id;
if (name != NULL)
{
s.fname = name;
} else if (f != NULL) {
s.fname = str_dotslash(f->name);
if (s.fname == NULL)
s.fname = f->name;
}
if (f != NULL)
{
// Check if this file had zero size
if ((f->fz_remote == 0) && (f->fz_local == 0))
s.is_zero = 1;
s.xfer_amount = f->xfer_amount;
if (f->usec_start > f->usec_end)
f->usec_end = GS_usec();
if (f->usec_suspend_start != 0)
{
DEBUGF_R("Oops, Reporting stats on a suspended file\n");
f->usec_suspend_duration += (GS_usec() - f->usec_suspend_start);
}
DEBUGF_W("err=%d end=%"PRIu64", start=%"PRIu64", suspend=%"PRIu64"\n", err, f->usec_end, f->usec_start, f->usec_suspend_duration);
s.xfer_duration = (f->usec_end - f->usec_start) - f->usec_suspend_duration;
}
mk_bps(s.speed_str, sizeof s.speed_str, s.xfer_duration, s.xfer_amount, err, s.is_zero);
// Global stats for all files
ft->stats.xfer_duration += s.xfer_duration;
if (err == 0)
ft->stats.n_files_success += 1;
else {
ft->stats.n_files_error += 1;
// Encountered an error. Reduce the 'scheduled' amount by what
// we could not transfer.
if (f != NULL)
{
int64_t diff = MAX(0, f->xfer_amount_scheduled - f->xfer_amount);
int64_t allx = MAX(0, ft->stats.xfer_amount_scheduled - diff);
ft->stats.xfer_amount_scheduled = allx;
}
}
mk_stats_ft(ft);
// Call call-back (but not if it is an error)
if ((ft->func_stats != NULL) && (err == 0))
(*ft->func_stats)(&s, ft->func_arg);
}
// Generate total stats
static void
mk_stats_ft(GS_FT *ft)
{
GS_FT_stats *st = &ft->stats;
mk_bps(st->speed_str, sizeof st->speed_str, st->xfer_duration, st->xfer_amount, st->n_files_success==0?1:0, 0 /*is_zero*/);
}
void
GS_FT_stats_reset(GS_FT *ft)
{
memset(&ft->stats, 0, sizeof ft->stats);
}
// Report error to caller
static void
call_status_cb(GS_FT *ft, const char *fname, uint8_t code, const char *err_str)
{
if (ft->func_status == NULL)
return;
char buf[128];
if (err_str == NULL)
{
// Create error string if none provided
snprintf(buf, sizeof buf, "%s: %s", GS_FT_strerror(code), fname);
err_str = buf;
}
struct _gs_ft_status s;
memset(&s, 0, sizeof s);
s.fname = fname;
s.code = code;
s.err_str = err_str;
(*ft->func_status)(ft, &s, ft->func_arg);
}
/*
* Error received from Server or Client.
* Remove and free item.
*/
void
GS_FT_status(GS_FT *ft, uint32_t id, uint8_t code, const char *err_str, size_t len)
{
GS_LIST_ITEM *li;
int err = 1;
struct _gs_ft_file *f = NULL;
struct _gs_ft_list_pattern *lp = NULL;
if (err_str[len] != '\0')
return; // protocol error. Not 0 terminated.
DEBUGF_R("#%u STATUS: code=%u [%s](remote says='%s')\n", id, code, GS_FT_strerror(code), err_str);
// There can not be an error in fqueue or plistreq or flist as those are
// local lists. Here we only care about lists that send a request
// to the server and are waiting for a reply.
// li can be one of two structures only:
// _gs_ft_file or gs_ft_list_pattern
li = GS_LIST_by_id(&ft->faccepted, id); // CLIENT
if (li == NULL)
{
li = GS_LIST_by_id(&ft->fcompleted, id); // CLIENT
if (li == NULL)
{
li = GS_LIST_by_id(&ft->fputs, id); // CLIENT
if (li == NULL)
{
li = GS_LIST_by_id(&ft->fdl_waiting, id); // CLIENT (get)
if (li == NULL)
{
// This 'li' does not hold a _gs_ft_file structure and thus
// must not generate stats or try to free a _gs_ft_file when it is not.
li = GS_LIST_by_id(&ft->plistreq_waiting, id); // CLIENT (get)
if (li == NULL)
{
li = GS_LIST_by_id(&ft->fadded, id); // SERVER (put)
if (li == NULL)
{
li = GS_LIST_by_id(&ft->freceiving, id); // SERVER (put)
if (li == NULL)
{
DEBUGF_R("id %u not found\n", id);
return; // not found
}
}
} else {
lp = (struct _gs_ft_list_pattern *)li->data;
}
}
}
} else {
// HERE: Client was waiting for "COMPLETED" message from server.
// Was waiting for 'complete' signal. No error if 'complete' is a success.
if (code == GS_FT_ERR_COMPLETED)
err = 0;
}
}
const char *name;
if (lp == NULL)
{
// A *f file (not a globbing pattern)
f = (struct _gs_ft_file *)li->data;
name = str_dotslash(f->name);
if (name == NULL)
name = f->name;
DEBUGF_R("FILE: %s\n", name);
} else {
name = lp->pattern;
}
if (ft->is_server == 0)
{
// CLIENT
// Report (error-)status to caller
// Dont trust 'err_str' from remote. Passing 'null' will make sure we generate our own.
call_status_cb(ft, name, code, NULL /*err_str*/);
if (f != NULL)
{
// Report stats to caller. Tread ERR_COMPLETED not as an error.
mk_stats_file(ft, id, f, name, err);
}
}
if (f != NULL)
{
if (li->data == ft->active_put_file)
ft->active_put_file = NULL;
if (ft->is_server == 0)
ft_done(ft);
ft_del(li); // SERVER & CLIENT
} else {
// From a PATTERN request (LISTREQ, Client, get, download).
// File structure is not available.
// Or SERVER list
GS_LIST_del(li);
}
DEBUGF("WAITING: %d %d\n", ft->n_files_waiting, ft->plistreq_waiting.n_items);
if (ft->is_server == 0)
{
// CLIENT
// Trigger caller to call GS_FT_packet() so that caller gets the GS_FT_DONE return
// value to then output (and reset) the stats. This can happen when a zero-sized file
// is transferred.
if ((ft->n_files_waiting == 0) && (ft->plistreq_waiting.n_items == 0))
ft->is_want_write = 1;
}
}
/*
* Make an error packet. Return length.
*/
static size_t
mk_error(void *dst, size_t len, uint32_t id, uint8_t code, const char *str)
{
size_t sz;
struct _gs_ft_error err;
memset(&err, 0, sizeof err);
err.id = htonl(id);
err.code = code;
memcpy(dst, &err, sizeof err);
sz = 1;
struct _gs_ft_error *p = (struct _gs_ft_error *)dst;
if ((str != NULL) && (strlen(str) > 0))
{
sz = MIN(len - sizeof err, strlen(str) + 1);
memcpy(p->str, str, sz - 1);
}
p->str[sz - 1] = '\0';
return sizeof err + sz;
}
static uint8_t
errno2code(int eno /*errno*/, uint8_t default_code)
{
DEBUGF_Y("errno = %d\n", eno);
switch (eno)
{
case EACCES:
case EPERM:
return GS_FT_ERR_PERM;
case ENOENT:
case EFAULT:
return GS_FT_ERR_NOENT;
case EBADF:
return GS_FT_ERR_BADF;
case EINVAL:
return GS_FT_ERR_INVAL;
}
return default_code;
}
const char *
GS_FT_strerror(uint8_t code)
{
switch (code)
{
case GS_FT_ERR_PERM:
return "Permission denied";
case GS_FT_ERR_NOENT:
return "Not found";
case GS_FT_ERR_BADFSIZE:
return "Bad file size";
case GS_FT_ERR_BADF:
return "Bad file descriptor";
case GS_FT_ERR_NODATA:
return "No Data";
case GS_FT_ERR_INVAL:
return "Bad Value";
case GS_FT_ERR_COMPLETED:
return "Completed";
}
return "UNKNOWN";
}
// CLIENT: Create error string and report to caller (via callback)
static void
status_report_error(GS_FT *ft, const char *name, uint8_t code)
{
char buf[128];
DEBUGF_B("fn-rel: %s\n", name);
snprintf(buf, sizeof buf, "%s: %s", GS_FT_strerror(code), name);
call_status_cb(ft, name, code, buf);
}
/*
* Make an error packet. Remove errornous file from queue
*/
static size_t
ft_mk_error(GS_FT *ft, struct _gs_ft_file *f, void *dst, size_t len, int *pkt_type, GS_LIST_ITEM *li, uint8_t code, const char *str, int is_report_local)
{
size_t sz;
// On CLIENT side report this error to caller:
if ((ft->is_server == 0) && (is_report_local))
{
// CLIENT
status_report_error(ft, f->fn_relative, code);
}
*pkt_type = GS_FT_TYPE_ERROR;
sz = mk_error(dst, len, li->id, code, str);
ft_done(ft);
ft_del(li);
return sz;
}
static void
update_stats(GS_FT *ft, struct _gs_ft_file *f, size_t sz)
{
// -----BEGIN Log statistics-----
if (f->usec_start == 0)
{
f->usec_start = GS_usec();
}
if (f->usec_suspend_start != 0)
{
f->usec_suspend_duration += (GS_usec() - f->usec_suspend_start);
f->usec_suspend_start = 0;
}
f->xfer_amount += sz;
ft->stats.xfer_amount += sz;
// -----END Log statistics-----
}
static size_t
mk_xfer_data(GS_FT *ft, struct _gs_ft_file **active, GS_LIST *fcompleted, int *pkt_type, void *dst, size_t len)
{
struct _gs_ft_file *f = *active;
size_t sz;
*pkt_type = GS_FT_TYPE_DATA;
sz = fread(dst, 1, len, f->fp);
if (sz <= 0)
{
*active = NULL;
return ft_mk_error(ft, f, dst, len, pkt_type, f->li, errno2code(errno, GS_FT_ERR_BADF), NULL, 1);
}
f->fz_remote += sz;
if (ft->is_server == 0)
{
update_stats(ft, f, sz);
// DEBUGF_W("xfer %"PRId64"/%"PRId64"\n", ft->stats.xfer_amount, ft->stats.xfer_amount_scheduled);
}
if (f->fz_remote >= f->fz_local)
{
// Immediatley close f->fp to free file descriptor.
sending_complete(ft, active, fcompleted);
}
return sz;
}
static size_t
mk_switch(GS_FT *ft, struct _gs_ft_file **active, GS_LIST *fsource, GS_LIST *fcompleted, int *pkt_type, void *dst, size_t len)
{
GS_LIST_ITEM *li;
struct _gs_ft_file *f;
int ret;
XASSERT(active != NULL, "active file is NULL\n");
li = GS_LIST_next(fsource, NULL);
f = (struct _gs_ft_file *)li->data;
f->fp = fopen(f->fn_local, "r");
if (f->fp == NULL)
{
DEBUGF("fopen(%s): %s\n", f->fn_local, strerror(errno));
return ft_mk_error(ft, f, dst, len, pkt_type, li, errno2code(errno, GS_FT_ERR_PERM), NULL, 1);
}
ret = fseek(f->fp, 0, SEEK_END);
if (ret != 0)
return ft_mk_error(ft, f, dst, len, pkt_type, li, errno2code(errno, GS_FT_ERR_BADF), NULL, 1);
f->fz_local = ftell(f->fp);
// Peer already has this file.
// Overwrite if remote size is smaller _or_ larger.
if ((f->fz_local == f->fz_remote) && (f->fz_local != 0))
{
DEBUGF("#%u Skipping %s (already on peer)\n", (unsigned int)f->li->id, f->name);
if (ft->is_server == 0)
mk_stats_file(ft, li->id, f, NULL, 0 /*success*/);
return ft_mk_error(ft, f, dst, len, pkt_type, li, GS_FT_ERR_NODATA, NULL, 0 /* do not report locally */);
}
// Remote size is larger. Overwrite from beginning.
if (f->fz_local < f->fz_remote)
f->fz_remote = 0;
// Remote size is smaller. Restart transmission.
ret = fseek(f->fp, f->fz_remote, SEEK_SET);
if (ret != 0)
return ft_mk_error(ft, f, dst, len, pkt_type, li, errno2code(errno, GS_FT_ERR_BADF), NULL, 1);
struct _gs_ft_switch sw;
memset(&sw, 0, sizeof sw);
sw.id = htonl(li->id);
sw.offset = htonll(f->fz_remote);
memcpy(dst, &sw, sizeof sw);
DEBUGF_W("#%"PRIu64" Switch to %s (fz_local=%"PRIu64", fz_remote=%"PRIu64")\n", li->id, f->name, f->fz_local, f->fz_remote);
// Handle zero size files
*active = f;
if (f->fz_local == 0)
{
// For SERVER (get, download) the fcompleted is NULL
sending_complete(ft, active, fcompleted);
}
*pkt_type = GS_FT_TYPE_SWITCH;
return sizeof sw;
}
/*
* Create a data packet (from job/queue that need attention).
* Return the length.
* Return 0 if no data needs to be written or an error occured.
* check pkt_type to for packet code that needs to be written.
*
* Set TYPE to SWITCH or DATA depending on the type of packet created.
* Set to DONE when done and NONE when nothing is to be done.
*/
size_t
GS_FT_packet(GS_FT *ft, void *dst, size_t len, int *pkt_type)
{
struct _gs_ft_file *f;
size_t sz;
// DEBUGF("GS_FT_packet() %d, accepted %d, len %zu\n", ft->fputs.n_items, ft->faccepted.n_items, len);
*pkt_type = GS_FT_TYPE_NONE;
if (len < GS_FT_MIN_BUF_SIZE)
{
DEBUGF_R("Does this ever happen?\n");
return 0;
}
// Check if any queue'd errors needs sending.
// Server & Client
if (ft->qerrs.n_items > 0)
{
GS_LIST_ITEM *li = NULL;
li = GS_LIST_next(&ft->qerrs, NULL);
struct _gs_ft_qerr *qerr = (struct _gs_ft_qerr *)li->data;
sz = mk_error(dst, len, qerr->id, qerr->code, qerr->str);
*pkt_type = GS_FT_TYPE_ERROR;
qerr_free(qerr);
GS_LIST_del(li);
return sz;
}
// Check if any files in the queue that need to be 'put'
// on offer to the remote side (and then awaiting 'accept').
// Client
if (ft->fqueue.n_items > 0)
{
DEBUGF("%d items in queue (waiting for put to be send)\n", ft->fqueue.n_items);
GS_LIST_ITEM *li = NULL;
li = GS_LIST_next(&ft->fqueue, NULL);
f = (struct _gs_ft_file *)li->data;
struct _gs_ft_put put;
struct _gs_ft_put *p = (struct _gs_ft_put *)dst;
memset(&put, 0, sizeof put);
put.fperm = htonl(GS_mode2fperm(f->mode));
put.id = htonl(li->id);
put.mtime = htonl(f->mtime);
if (S_ISDIR(f->mode))
put.flags |= GS_FT_FL_ISDIR;
else
put.fsize = htonll(f->fz_local);
memcpy(dst, &put, sizeof put);
sz = MIN(len - sizeof put, strlen(f->name) + 1);
// DEBUGF("name len %zu + hdr %zu\n", n, sizeof *hdr);
memcpy(p->name, f->name, sz - 1);
p->name[sz - 1] = '\0';
if (S_ISDIR(f->mode))
{
ft_done(ft);
ft_del(li);
} else {
GS_LIST_move(&ft->fputs, li);
}
*pkt_type = GS_FT_TYPE_PUT;
return sizeof put + sz;
}
// Client
if (ft->plistreq.n_items > 0)
{
GS_LIST_ITEM *li = NULL;
li = GS_LIST_next(&ft->plistreq, NULL);
struct _gs_ft_list_pattern *p = li->data;
DEBUGF("%d LIST-REQ '%s' in queue (LIST-REQ to be send) [Using glob-id=%d]\n", ft->plistreq.n_items, p->pattern, p->globbing_id);
struct _gs_ft_list_request list_req;
struct _gs_ft_list_request *lr = (struct _gs_ft_list_request *)dst;
memset(&list_req, 0, sizeof list_req);
list_req.globbing_id = htonl(p->globbing_id);
memcpy(dst, &list_req, sizeof list_req);
sz = MIN(len - sizeof list_req, strlen(p->pattern) + 1);
memcpy(lr->pattern, p->pattern, sz - 1);
lr->pattern[sz - 1] = '\0';
GS_LIST_move(&ft->plistreq_waiting, li);
*pkt_type = GS_FT_TYPE_LISTREQUEST;
return sizeof list_req + sz;
}
// Server
if (ft->flistreply.n_items > 0)
{
// FIXME: do stats here on the list of files?! No need to keep this all in memory.
DEBUGF("%d LIST-REPLY in queue (LIST-REPLY to be send)\n", ft->flistreply.n_items);
GS_LIST_ITEM *li = NULL;
li = GS_LIST_next(&ft->flistreply, NULL);
f = (struct _gs_ft_file *)li->data;
struct _gs_ft_list_reply list_reply;
struct _gs_ft_list_reply *lr = (struct _gs_ft_list_reply *)dst;
memset(&list_reply, 0, sizeof list_reply);
list_reply.fperm = htonl(GS_mode2fperm(f->mode));
list_reply.globbing_id = htonl(f->globbing_id);
list_reply.fsize = htonll(f->fz_local);
list_reply.mtime = htonl(f->mtime);
if (S_ISDIR(f->mode))
list_reply.flags |= GS_FT_FL_ISDIR;
// Check if this is the last entry for this globbing-id
GS_LIST_ITEM *nli = GS_LIST_next(&ft->flistreply, li);
if ((nli == NULL) || (f->globbing_id != ((struct _gs_ft_file *)nli->data)->globbing_id))
{
DEBUGF_C("Last entry for this globbing G#%u\n", f->globbing_id);
list_reply.flags |= GS_FT_LISTREPLY_FL_LAST;
}
memcpy(dst, &list_reply, sizeof list_reply);
sz = MIN(len - sizeof list_reply, strlen(f->name) + 1);
memcpy(lr->name, f->name, sz - 1);
lr->name[sz - 1] = '\0';
file_free(f);
GS_LIST_del(li);
*pkt_type = GS_FT_TYPE_LISTREPLY;
return sizeof list_reply + sz;
}
// Client, download
if (ft->flist.n_items > 0)
{
DEBUGF("%d files in list. Download them...\n", ft->flist.n_items);
GS_LIST_ITEM *li;
li = GS_LIST_next(&ft->flist, NULL);
f = (struct _gs_ft_file *)li->data;
struct _gs_ft_dl dl;
struct _gs_ft_dl *d = (struct _gs_ft_dl *)dst;
memset(&dl, 0, sizeof dl);
dl.id = htonl(li->id);
dl.offset = htonll(f->fz_local);
memcpy(dst, &dl, sizeof dl);
sz = MIN(len - sizeof dl, strlen(f->name) + 1);
memcpy(d->name, f->name, sz - 1);
d->name[sz - 1] = '\0';
GS_LIST_move(&ft->fdl_waiting, li);
*pkt_type = GS_FT_TYPE_DL;
return sizeof dl + sz;
}
// Server, PUT (upload), make accept message
if (ft->fadded.n_items > 0)
{
GS_LIST_ITEM *li = NULL;
li = GS_LIST_next(&ft->fadded, NULL);
f = (struct _gs_ft_file *)li->data;
struct _gs_ft_accept acc;
memset(&acc, 0, sizeof acc);
acc.id = htonl(li->id);
acc.offset_dst = htonll(f->fz_local);
memcpy(dst, &acc, sizeof acc);
// HERE: Server. Inform client that we accepted.
GS_LIST_move(&ft->freceiving, li);
*pkt_type = GS_FT_TYPE_ACCEPT;
return sizeof acc;
}
// Server - get (download to client)
if (ft->fdl.n_items > 0)
{
if (ft->active_dl_file == NULL)
{
DEBUGF("S Files to send: %d\n", ft->fdl.n_items);
return mk_switch(ft, &ft->active_dl_file, &ft->fdl, NULL, pkt_type, dst, len);
}
if (ft->is_paused_data)
{
DEBUGF_W("IS-PAUSED-DATA==1. Not sending file data....\n");
return 0;
}
return mk_xfer_data(ft, &ft->active_dl_file, NULL, pkt_type, dst, len);
}
// Client
if (ft->faccepted.n_items > 0)
{
if (ft->active_put_file == NULL)
{
DEBUGF("C Files to send: %d\n", ft->faccepted.n_items);
return mk_switch(ft, &ft->active_put_file, &ft->faccepted, &ft->fcompleted, pkt_type, dst, len);
}
if (ft->is_paused_data)
{
DEBUGF_W("IS-PAUSED-DATA==1. Not sending file data....\n");
return 0;
}
return mk_xfer_data(ft, &ft->active_put_file, &ft->fcompleted, pkt_type, dst, len);
}
if (ft->is_server == 0)
{
// CLIENT
#ifdef DEBUG
static int old_waiting;
static int old_pl_waiting;
if ((ft->n_files_waiting != old_waiting) || (ft->plistreq_waiting.n_items != old_pl_waiting))
{
DEBUGF_R("n_files_waiting=%d, plist.n_items=%d\n", ft->n_files_waiting, ft->plistreq_waiting.n_items);
old_waiting = ft->n_files_waiting;
old_pl_waiting = ft->plistreq_waiting.n_items;
}
#endif
if ((ft->n_files_waiting == 0) && (ft->plistreq_waiting.n_items == 0))
{
ft->is_want_write = 0;
*pkt_type = GS_FT_TYPE_DONE;
return 0;
}
}
if (*pkt_type == GS_FT_TYPE_NONE)
ft->is_want_write = 0;
return 0;
}
static void
free_gsl(GS_LIST *gsl)
{
GS_LIST_ITEM *li;
while ((li = GS_LIST_next(gsl, NULL)) != NULL)
{
struct _gs_ft_file *f = (struct _gs_ft_file *)li->data;
file_free(f);
GS_LIST_del(li);
}
}
static void
free_get_li(GS_LIST_ITEM *li)
{
struct _gs_ft_list_pattern *p = (struct _gs_ft_list_pattern *)li->data;
XFREE(p->pattern);
XFREE(p->wdir);
GS_LIST_del(li);
}
static void
free_get_gsl(GS_LIST *gsl)
{
GS_LIST_ITEM *li;
while ((li = GS_LIST_next(gsl, NULL)) != NULL)
{
free_get_li(li);
}
}
void
GS_FT_free(GS_FT *ft)
{
free_gsl(&ft->fqueue);
free_gsl(&ft->fputs);
free_gsl(&ft->faccepted);
free_gsl(&ft->fcompleted);
free_gsl(&ft->fadded);
free_gsl(&ft->freceiving);
free_get_gsl(&ft->plistreq);
free_get_gsl(&ft->plistreq_waiting);
free_gsl(&ft->flist);
free_gsl(&ft->fdl_waiting);
// GS_LIST_del_all(&ft->flistreply, 1 /*deep*/); FIXME: why is thsi deep and not free_gsl????
free_gsl(&ft->flistreply);
free_gsl(&ft->fdl);
GS_LIST_ITEM *li;
while ((li = GS_LIST_next(&ft->qerrs, NULL)) != NULL)
{
qerr_free((struct _gs_ft_qerr *)li->data);
GS_LIST_del(li);
}
ft->active_put_file = NULL;
ft->active_dl_file = NULL;
}
void
GS_FT_pause_data(GS_FT *ft)
{
ft->is_paused_data = 1;
}
void
GS_FT_unpause_data(GS_FT *ft)
{
ft->is_paused_data = 0;
}
|