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
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
// Copyright 2019 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under The General Public License (GPL), version 3.
// Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed
// under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. Please review the Licences for the specific language governing
// permissions and limitations relating to use of the SAFE Network Software.

use super::constants::{
    CONTENT_ADDED_SIGN, CONTENT_DELETED_SIGN, CONTENT_ERROR_SIGN, CONTENT_UPDATED_SIGN,
    FAKE_RDF_PREDICATE_CREATED, FAKE_RDF_PREDICATE_LINK, FAKE_RDF_PREDICATE_MODIFIED,
    FAKE_RDF_PREDICATE_SIZE, FAKE_RDF_PREDICATE_TYPE,
};
use super::helpers::{gen_timestamp_nanos, gen_timestamp_secs};
use super::xorurl::{SafeContentType, SafeDataType};
use super::{Error, ResultReturn, Safe, SafeApp, XorUrl, XorUrlEncoder};
use log::{debug, info, warn};
use mime_guess;
use relative_path::RelativePath;
use std::collections::BTreeMap;
use std::fs;
use std::path::Path;
use walkdir::{DirEntry, WalkDir};

// Each FileItem contains file metadata and the link to the file's ImmutableData XOR-URL
pub type FileItem = BTreeMap<String, String>;

// To use for mapping files names (with path in a flattened hierarchy) to FileItems
pub type FilesMap = BTreeMap<String, FileItem>;

// List of files uploaded with details if they were added, updated or deleted from FilesContainer
pub type ProcessedFiles = BTreeMap<String, (String, String)>;

// Type tag to use for the FilesContainer stored on AppendOnlyData
const FILES_CONTAINER_TYPE_TAG: u64 = 1_100;

const ERROR_MSG_NO_FILES_CONTAINER_FOUND: &str = "No FilesContainer found at this address";

const MAX_RECURSIVE_DEPTH: usize = 10_000;

#[allow(dead_code)]
impl Safe {
    /// # Create a FilesContainer.
    ///
    /// ## Example
    ///
    /// ```rust
    /// # use safe_api::Safe;
    /// # let mut safe = Safe::new("base32z");
    /// # safe.connect("", Some("fake-credentials")).unwrap();
    /// let (xorurl, _processed_files, _files_map) = safe.files_container_create("testdata", None, true, false).unwrap();
    /// assert!(xorurl.contains("safe://"))
    /// ```
    pub fn files_container_create(
        &mut self,
        location: &str,
        dest: Option<&str>,
        recursive: bool,
        dry_run: bool,
    ) -> ResultReturn<(XorUrl, ProcessedFiles, FilesMap)> {
        // TODO: Enable source for funds / ownership
        // Warn about ownership?

        // Let's upload the files and generate the list of local files paths
        let processed_files = file_system_dir_walk(self, location, recursive, !dry_run)?;

        // The FilesContainer is created as a AppendOnlyData with a single entry containing the
        // timestamp as the entry's key, and the serialised FilesMap as the entry's value
        // TODO: use RDF format
        let files_map = files_map_create(&processed_files, location, dest)?;

        let xorurl = if dry_run {
            "".to_string()
        } else {
            let serialised_files_map = serde_json::to_string(&files_map).map_err(|err| {
                Error::Unexpected(format!(
                    "Couldn't serialise the FilesMap generated: {:?}",
                    err
                ))
            })?;

            let now = gen_timestamp_nanos();
            let files_container_data = vec![(
                now.into_bytes().to_vec(),
                serialised_files_map.as_bytes().to_vec(),
            )];

            // Store the FilesContainer in a Published AppendOnlyData
            let xorname = self.safe_app.put_seq_append_only_data(
                files_container_data,
                None,
                FILES_CONTAINER_TYPE_TAG,
                None,
            )?;

            XorUrlEncoder::encode(
                xorname,
                FILES_CONTAINER_TYPE_TAG,
                SafeDataType::PublishedSeqAppendOnlyData,
                SafeContentType::FilesContainer,
                None,
                None,
                None,
                &self.xorurl_base,
            )?
        };

        Ok((xorurl, processed_files, files_map))
    }

    /// # Fetch an existing FilesContainer.
    ///
    /// ## Example
    ///
    /// ```rust
    /// # use safe_api::Safe;
    /// # let mut safe = Safe::new("base32z");
    /// # safe.connect("", Some("fake-credentials")).unwrap();
    /// let (xorurl, _processed_files, _files_map) = safe.files_container_create("testdata", None, true, false).unwrap();
    /// let (version, files_map) = safe.files_container_get(&xorurl).unwrap();
    /// println!("FilesContainer fetched is at version: {}", version);
    /// println!("FilesMap of fetched version is: {:?}", files_map);
    /// ```
    pub fn files_container_get(&self, url: &str) -> ResultReturn<(u64, FilesMap)> {
        debug!("Getting files container from: {:?}", url);
        let (xorurl_encoder, _) = self.parse_and_resolve_url(url)?;

        // Check if the URL specifies a specific version of the content or simply the latest available
        let data = xorurl_encoder.content_version().map_or_else(
            || {
                self.safe_app.get_latest_seq_append_only_data(
                    xorurl_encoder.xorname(),
                    FILES_CONTAINER_TYPE_TAG,
                )
            },
            |content_version| {
                let (key, value) = self
                    .safe_app
                    .get_seq_append_only_data(
                        xorurl_encoder.xorname(),
                        FILES_CONTAINER_TYPE_TAG,
                        content_version,
                    )
                    .map_err(|_| {
                        Error::VersionNotFound(format!(
                            "Version '{}' is invalid for FilesContainer found at \"{}\"",
                            content_version, url,
                        ))
                    })?;
                Ok((content_version, (key, value)))
            },
        );

        match data {
            Ok((version, (_key, value))) => {
                debug!("Files map retrieved.... v{:?}", &version);
                // TODO: use RDF format and deserialise it
                let files_map = serde_json::from_str(&String::from_utf8_lossy(&value.as_slice()))
                    .map_err(|err| {
                    Error::ContentError(format!(
                        "Couldn't deserialise the FilesMap stored in the FilesContainer: {:?}",
                        err
                    ))
                })?;
                Ok((version, files_map))
            }
            Err(Error::EmptyContent(_)) => {
                warn!("FilesContainer found at \"{:?}\" was empty", url);
                Ok((0, FilesMap::default()))
            }
            Err(Error::ContentNotFound(_)) => Err(Error::ContentNotFound(
                ERROR_MSG_NO_FILES_CONTAINER_FOUND.to_string(),
            )),
            Err(Error::VersionNotFound(msg)) => Err(Error::VersionNotFound(msg)),
            Err(err) => Err(Error::NetDataError(format!(
                "Failed to get current version: {}",
                err
            ))),
        }
    }

    /// # Sync up local folder with the content on a FilesContainer.
    ///
    /// ## Example
    ///
    /// ```rust
    /// # use safe_api::Safe;
    /// # let mut safe = Safe::new("base32z");
    /// # safe.connect("", Some("fake-credentials")).unwrap();
    /// let (xorurl, _processed_files, _files_map) = safe.files_container_create("testdata", None, true, false).unwrap();
    /// let (version, new_processed_files, new_files_map) = safe.files_container_sync("testdata", &xorurl, true, false, false, false).unwrap();
    /// println!("FilesContainer synced up is at version: {}", version);
    /// println!("The local files that were synced up are: {:?}", new_processed_files);
    /// println!("The FilesMap of the updated FilesContainer now is: {:?}", new_files_map);
    /// ```
    pub fn files_container_sync(
        &mut self,
        location: &str,
        url: &str,
        recursive: bool,
        delete: bool,
        update_nrs: bool,
        dry_run: bool,
    ) -> ResultReturn<(u64, ProcessedFiles, FilesMap)> {
        if delete && !recursive {
            return Err(Error::InvalidInput(
                "'delete' is not allowed if --recursive is not set".to_string(),
            ));
        }

        let xorurl_encoder = Safe::parse_url(url)?;
        if xorurl_encoder.content_version().is_some() {
            return Err(Error::InvalidInput(format!(
                "The target URL cannot cannot contain a version: {}",
                url
            )));
        };

        // If NRS name shall be updated then the URL has to be an NRS-URL
        if update_nrs && xorurl_encoder.content_type() != SafeContentType::NrsMapContainer {
            return Err(Error::InvalidInput(
                "'update-nrs' is not allowed since the URL provided is not an NRS URL".to_string(),
            ));
        }

        let (mut xorurl_encoder, is_nrs_resolved) = self.parse_and_resolve_url(url)?;

        // If the FilesContainer URL was resolved from an NRS name we need to remove
        // the version from it so we can fetch latest version of it for sync-ing
        if is_nrs_resolved {
            xorurl_encoder.set_content_version(None);
        }

        let (current_version, current_files_map): (u64, FilesMap) =
            self.files_container_get(&xorurl_encoder.to_string()?)?;

        // Let's generate the list of local files paths, without uploading any new file yet
        let processed_files = file_system_dir_walk(self, location, recursive, false)?;

        let dest_path = Some(xorurl_encoder.path());
        let (processed_files, new_files_map, success_count): (ProcessedFiles, FilesMap, u64) =
            files_map_sync(
                self,
                current_files_map,
                location,
                processed_files,
                dest_path,
                delete,
                !dry_run,
                false,
                true,
            )?;

        let version = self.append_version_to_nrs_map_container(
            success_count,
            current_version,
            &new_files_map,
            url,
            xorurl_encoder,
            dry_run,
            update_nrs,
        )?;

        Ok((version, processed_files, new_files_map))
    }

    /// # Add a file, either a local path or a published file, on an existing FilesContainer.
    ///
    /// ## Example
    ///
    /// ```rust
    /// # use safe_api::Safe;
    /// # let mut safe = Safe::new("base32z");
    /// # safe.connect("", Some("fake-credentials")).unwrap();
    /// let (xorurl, _processed_files, _files_map) = safe.files_container_create("testdata", None, true, false).unwrap();
    /// let new_file_name = format!("{}/new_name_test.md", xorurl);
    /// let (version, new_processed_files, new_files_map) = safe.files_container_add("testdata/test.md", &new_file_name, false, false, false).unwrap();
    /// println!("FilesContainer is now at version: {}", version);
    /// println!("The local files that were synced up are: {:?}", new_processed_files);
    /// println!("The FilesMap of the updated FilesContainer now is: {:?}", new_files_map);
    /// ```
    pub fn files_container_add(
        &mut self,
        source_file: &str,
        url: &str,
        force: bool,
        update_nrs: bool,
        dry_run: bool,
    ) -> ResultReturn<(u64, ProcessedFiles, FilesMap)> {
        let (xorurl_encoder, current_version, current_files_map) =
            validate_files_add_params(self, source_file, url, update_nrs)?;

        let dest_path = xorurl_encoder.path();

        // Let's act according to if it's a local file path or a safe:// location
        let (processed_files, new_files_map, success_count) = if source_file.starts_with("safe://")
        {
            files_map_add_link(self, current_files_map, source_file, dest_path, force)?
        } else {
            // Let's generate the list of local files paths, without uploading any new file yet
            let processed_files = file_system_single_file(self, source_file, false)?;

            files_map_sync(
                self,
                current_files_map,
                source_file,
                processed_files,
                Some(dest_path),
                false,
                !dry_run,
                force,
                false,
            )?
        };

        let version = self.append_version_to_nrs_map_container(
            success_count,
            current_version,
            &new_files_map,
            url,
            xorurl_encoder,
            dry_run,
            update_nrs,
        )?;

        Ok((version, processed_files, new_files_map))
    }

    /// # Add a file, from raw bytes, on an existing FilesContainer.
    ///
    /// ## Example
    ///
    /// ```rust
    /// # use safe_api::Safe;
    /// # let mut safe = Safe::new("base32z");
    /// # safe.connect("", Some("fake-credentials")).unwrap();
    /// let (xorurl, _processed_files, _files_map) = safe.files_container_create("testdata", None, true, false).unwrap();
    /// let new_file_name = format!("{}/new_name_test.md", xorurl);
    /// let (version, new_processed_files, new_files_map) = safe.files_container_add_from_raw(b"0123456789", &new_file_name, false, false, false).unwrap();
    /// println!("FilesContainer is now at version: {}", version);
    /// println!("The local files that were synced up are: {:?}", new_processed_files);
    /// println!("The FilesMap of the updated FilesContainer now is: {:?}", new_files_map);
    /// ```
    pub fn files_container_add_from_raw(
        &mut self,
        data: &[u8],
        url: &str,
        force: bool,
        update_nrs: bool,
        dry_run: bool,
    ) -> ResultReturn<(u64, ProcessedFiles, FilesMap)> {
        let (xorurl_encoder, current_version, current_files_map) =
            validate_files_add_params(self, "", url, update_nrs)?;

        let dest_path = xorurl_encoder.path();
        let new_file_xorurl = self.files_put_published_immutable(data, None)?;

        // Let's act according to if it's a local file path or a safe:// location
        let (processed_files, new_files_map, success_count) =
            files_map_add_link(self, current_files_map, &new_file_xorurl, dest_path, force)?;
        let version = self.append_version_to_nrs_map_container(
            success_count,
            current_version,
            &new_files_map,
            url,
            xorurl_encoder,
            dry_run,
            update_nrs,
        )?;

        Ok((version, processed_files, new_files_map))
    }

    // Private helper function to append new version of the FilesMap to the NRS Container
    #[allow(clippy::too_many_arguments)]
    fn append_version_to_nrs_map_container(
        &mut self,
        success_count: u64,
        current_version: u64,
        new_files_map: &FilesMap,
        url: &str,
        mut xorurl_encoder: XorUrlEncoder,
        dry_run: bool,
        update_nrs: bool,
    ) -> ResultReturn<u64> {
        let version = if success_count == 0 {
            current_version
        } else if dry_run {
            current_version + 1
        } else {
            // The FilesContainer is updated by adding an entry containing the timestamp as the
            // entry's key, and the serialised new version of the FilesMap as the entry's value
            let serialised_files_map = serde_json::to_string(new_files_map).map_err(|err| {
                Error::Unexpected(format!(
                    "Couldn't serialise the FilesMap generated: {:?}",
                    err
                ))
            })?;

            let now = gen_timestamp_nanos();
            let files_container_data = vec![(
                now.into_bytes().to_vec(),
                serialised_files_map.as_bytes().to_vec(),
            )];

            let xorname = xorurl_encoder.xorname();
            let type_tag = xorurl_encoder.type_tag();
            let new_version = self.safe_app.append_seq_append_only_data(
                files_container_data,
                current_version + 1,
                xorname,
                type_tag,
            )?;

            if update_nrs {
                // We need to update the link in the NRS container as well,
                // to link it to the new new_version of the FilesContainer we just generated
                xorurl_encoder.set_content_version(Some(new_version));
                let new_link_for_nrs = xorurl_encoder.to_string()?;
                let _ = self.nrs_map_container_add(url, &new_link_for_nrs, false, true, false)?;
            }

            new_version
        };

        Ok(version)
    }

    /// # Put Published ImmutableData
    /// Put data blobs onto the network.
    ///
    /// ## Example
    /// ```
    /// # use safe_api::Safe;
    /// # let mut safe = Safe::new("base32z");
    /// # safe.connect("", Some("fake-credentials")).unwrap();
    /// let data = b"Something super good";
    /// let xorurl = safe.files_put_published_immutable(data, Some("text/plain")).unwrap();
    /// # let received_data = safe.files_get_published_immutable(&xorurl).unwrap();
    /// # assert_eq!(received_data, data);
    /// ```
    pub fn files_put_published_immutable(
        &mut self,
        data: &[u8],
        media_type: Option<&str>,
    ) -> ResultReturn<XorUrl> {
        let content_type = media_type.map_or_else(
            || Ok(SafeContentType::Raw),
            |media_type_str| {
                if XorUrlEncoder::is_media_type_supported(media_type_str) {
                    Ok(SafeContentType::MediaType(media_type_str.to_string()))
                } else {
                    Err(Error::InvalidMediaType(format!(
                        "Media-type '{}' not supported. You can pass 'None' as the 'media_type' for this content to be treated as raw",
                        media_type_str
                    )))
                }
            },
        )?;

        // TODO: do we want ownership from other PKs yet?
        let xorname = self.safe_app.files_put_published_immutable(&data)?;

        XorUrlEncoder::encode(
            xorname,
            0,
            SafeDataType::PublishedImmutableData,
            content_type,
            None,
            None,
            None,
            &self.xorurl_base,
        )
    }

    /// # Get Published ImmutableData
    /// Put data blobs onto the network.
    ///
    /// ## Example
    /// ```
    /// # use safe_api::Safe;
    /// # let mut safe = Safe::new("base32z");
    /// # safe.connect("", Some("fake-credentials")).unwrap();
    /// # let data = b"Something super good";
    /// let xorurl = safe.files_put_published_immutable(data, None).unwrap();
    /// let received_data = safe.files_get_published_immutable(&xorurl).unwrap();
    /// # assert_eq!(received_data, data);
    /// ```
    pub fn files_get_published_immutable(&self, url: &str) -> ResultReturn<Vec<u8>> {
        // TODO: do we want ownership from other PKs yet?
        let (xorurl_encoder, _) = self.parse_and_resolve_url(url)?;
        self.safe_app
            .files_get_published_immutable(xorurl_encoder.xorname())
    }
}

// Helper functions

// Make sure the input params are valid for a files_container_add operation
fn validate_files_add_params(
    safe: &mut Safe,
    source_file: &str,
    url: &str,
    update_nrs: bool,
) -> ResultReturn<(XorUrlEncoder, u64, FilesMap)> {
    let xorurl_encoder = Safe::parse_url(url)?;
    if xorurl_encoder.content_version().is_some() {
        return Err(Error::InvalidInput(format!(
            "The target URL cannot cannot contain a version: {}",
            url
        )));
    };

    // If NRS name shall be updated then the URL has to be an NRS-URL
    if update_nrs && xorurl_encoder.content_type() != SafeContentType::NrsMapContainer {
        return Err(Error::InvalidInput(
            "'update-nrs' is not allowed since the URL provided is not an NRS URL".to_string(),
        ));
    }

    let (mut xorurl_encoder, is_nrs_resolved) = safe.parse_and_resolve_url(url)?;

    // If the FilesContainer URL was resolved from an NRS name we need to remove
    // the version from it so we can fetch latest version of it for sync-ing
    if is_nrs_resolved {
        xorurl_encoder.set_content_version(None);
    }

    let (current_version, current_files_map): (u64, FilesMap) =
        safe.files_container_get(&xorurl_encoder.to_string()?)?;

    let dest_path = xorurl_encoder.path().to_string();

    // Let's act according to if it's a local file path or a safe:// location
    if source_file.starts_with("safe://") {
        let source_xorurl_encoder = Safe::parse_url(source_file)?;
        if source_xorurl_encoder.data_type() != SafeDataType::PublishedImmutableData {
            return Err(Error::InvalidInput(format!(
                "The source URL should target a file ('{}'), but the URL provided targets a '{}'",
                SafeDataType::PublishedImmutableData,
                source_xorurl_encoder.content_type()
            )));
        }

        if dest_path.is_empty() {
            return Err(Error::InvalidInput(
                "The destination URL should include a target file path since we are adding a link"
                    .to_string(),
            ));
        }
    }
    Ok((xorurl_encoder, current_version, current_files_map))
}

// Simply change Windows style path separator into `/`
fn normalise_path_separator(from: &str) -> String {
    str::replace(&from, "\\", "/").to_string()
}

// From the location path and the destination path chosen by the user, calculate
// the destination path considering ending '/' in both the  location and dest path
fn get_base_paths(location: &str, dest_path: Option<&str>) -> ResultReturn<(String, String)> {
    // Let's normalise the path to use '/' (instead of '\' as on Windows)
    let location_base_path = if location == "." {
        "./".to_string()
    } else {
        normalise_path_separator(location)
    };

    let new_dest_path = match dest_path {
        Some(path) => {
            if path.is_empty() {
                "/".to_string()
            } else {
                path.to_string()
            }
        }
        None => "/".to_string(),
    };

    // Let's first check if it ends with '/'
    let dest_base_path = if new_dest_path.ends_with('/') {
        if location_base_path.ends_with('/') {
            new_dest_path
        } else {
            // Location is a folder, then append it to dest path
            let parts_vec: Vec<&str> = location_base_path.split('/').collect();
            let dir_name = parts_vec[parts_vec.len() - 1];
            format!("{}{}", new_dest_path, dir_name)
        }
    } else {
        // Then just append an ending '/'
        format!("{}/", new_dest_path)
    };

    Ok((location_base_path, dest_base_path))
}

// Generate a FileItem for a file which can then be added to a FilesMap
// This is now a pseudo-RDF but will eventually be converted to be an RDF graph
fn gen_new_file_item(
    safe: &mut Safe,
    file_path: &Path,
    file_type: &str,
    file_size: &str,
    file_created: Option<&str>,
    link: Option<&str>,
) -> Result<FileItem, String> {
    let now = gen_timestamp_secs();
    let mut file_item = FileItem::new();
    let xorurl = match link {
        None => upload_file_to_net(safe, file_path)?,
        Some(link) => link.to_string(),
    };
    file_item.insert(FAKE_RDF_PREDICATE_LINK.to_string(), xorurl);
    file_item.insert(FAKE_RDF_PREDICATE_TYPE.to_string(), file_type.to_string());
    file_item.insert(FAKE_RDF_PREDICATE_SIZE.to_string(), file_size.to_string());
    file_item.insert(FAKE_RDF_PREDICATE_MODIFIED.to_string(), now.clone());
    let created = file_created.unwrap_or_else(|| &now);
    file_item.insert(FAKE_RDF_PREDICATE_CREATED.to_string(), created.to_string());

    Ok(file_item)
}

// Helper function to add or update a FileItem in a FilesMap
#[allow(clippy::too_many_arguments)]
fn add_or_update_file_item(
    safe: &mut Safe,
    file_name: &str,
    file_name_for_map: &str,
    file_path: &Path,
    file_type: &str,
    file_size: &str,
    file_created: Option<&str>,
    file_link: Option<&str>,
    name_exists: bool,
    files_map: &mut FilesMap,
    processed_files: &mut ProcessedFiles,
) -> bool {
    // We need to add a new FileItem, let's generate the FileItem first
    match gen_new_file_item(
        safe,
        file_path,
        file_type,
        file_size,
        file_created,
        file_link,
    ) {
        Ok(new_file_item) => {
            let content_added_sign = if name_exists {
                CONTENT_UPDATED_SIGN.to_string()
            } else {
                CONTENT_ADDED_SIGN.to_string()
            };

            debug!("New FileItem item: {:?}", new_file_item);
            debug!("New FileItem item inserted as {:?}", file_name);
            files_map.insert(file_name_for_map.to_string(), new_file_item.clone());
            processed_files.insert(
                file_name.to_string(),
                (
                    content_added_sign,
                    new_file_item[FAKE_RDF_PREDICATE_LINK].clone(),
                ),
            );

            true
        }
        Err(err) => {
            processed_files.insert(
                file_name.to_string(),
                (CONTENT_ERROR_SIGN.to_string(), format!("<{}>", err)),
            );
            info!(
                "Skipping file \"{}\": {:?}",
                file_link.unwrap_or_else(|| ""),
                err
            );

            false
        }
    }
}

// From the provided list of local files paths, find the local changes made in comparison with the
// target FilesContainer, uploading new files as necessary, and creating a new FilesMap with file's
// metadata and their corresponding links, as well as generating the report of processed files
#[allow(clippy::too_many_arguments)]
fn files_map_sync(
    safe: &mut Safe,
    mut current_files_map: FilesMap,
    location: &str,
    new_content: ProcessedFiles,
    dest_path: Option<&str>,
    delete: bool,
    upload_files: bool,
    force: bool,
    compare_file_content: bool,
) -> ResultReturn<(ProcessedFiles, FilesMap, u64)> {
    let (location_base_path, dest_base_path) = get_base_paths(location, dest_path)?;
    let mut updated_files_map = FilesMap::new();
    let mut processed_files = ProcessedFiles::new();
    let mut success_count = 0;

    for (local_file_name, _) in new_content
        .iter()
        .filter(|(_, (change, _))| change != CONTENT_ERROR_SIGN)
    {
        let file_path = Path::new(&local_file_name);
        let (metadata, file_type) = get_metadata(&file_path)?;
        let file_size = metadata.len().to_string();

        let file_name = RelativePath::new(
            &local_file_name
                .to_string()
                .replace(&location_base_path, &dest_base_path),
        )
        .normalize();
        // Above normalize removes initial slash, and uses '\' if it's on Windows
        let normalised_file_name = format!("/{}", normalise_path_separator(file_name.as_str()));

        // Let's update FileItem if there is a change or it doesn't exist in current_files_map
        let link = if upload_files { None } else { Some("") };
        match current_files_map.get(&normalised_file_name) {
            None => {
                // We need to add a new FileItem
                if add_or_update_file_item(
                    safe,
                    &local_file_name,
                    &normalised_file_name,
                    &file_path,
                    &file_type,
                    &file_size,
                    None,
                    link,
                    false,
                    &mut updated_files_map,
                    &mut processed_files,
                ) {
                    success_count += 1;
                }
            }
            Some(file_item) => {
                if force
                    || (compare_file_content
                        && (file_item[FAKE_RDF_PREDICATE_SIZE] != file_size
                            || file_item[FAKE_RDF_PREDICATE_TYPE] != file_type))
                {
                    // We need to update the current FileItem
                    if add_or_update_file_item(
                        safe,
                        &local_file_name,
                        &normalised_file_name,
                        &file_path,
                        &file_type,
                        &file_size,
                        Some(&file_item[FAKE_RDF_PREDICATE_CREATED]),
                        link,
                        true,
                        &mut updated_files_map,
                        &mut processed_files,
                    ) {
                        success_count += 1;
                    }
                } else {
                    // No need to update FileItem just copy the existing one
                    updated_files_map.insert(normalised_file_name.to_string(), file_item.clone());

                    if !force && !compare_file_content {
                        processed_files.insert(
                            local_file_name.to_string(),
                            (
                                CONTENT_ERROR_SIGN.to_string(),
                                format!(
                                    "File named \"{}\" already exists on target. Use the 'force' flag to replace it",
                                    normalised_file_name
                                ),
                            ),
                        );
                        info!("Skipping file \"{}\" since a file with name \"{}\" already exists on target. You can use the 'force' flag to replace the existing file with the new one", local_file_name, normalised_file_name);
                    }
                }

                // let's now remove it from the current list so we now it has been processed
                current_files_map.remove(&normalised_file_name);
            }
        }
    }

    // Finally, unless 'delete' was set keep the files that are currently
    // in FilesContainer but not in source location
    current_files_map.iter().for_each(|(file_name, file_item)| {
        if !delete {
            updated_files_map.insert(file_name.to_string(), file_item.clone());
        } else {
            processed_files.insert(
                file_name.to_string(),
                (
                    CONTENT_DELETED_SIGN.to_string(),
                    file_item[FAKE_RDF_PREDICATE_LINK].clone(),
                ),
            );
            success_count += 1;
        }
    });

    Ok((processed_files, updated_files_map, success_count))
}

fn files_map_add_link(
    safe: &mut Safe,
    mut files_map: FilesMap,
    file_link: &str,
    file_name: &str,
    force: bool,
) -> ResultReturn<(ProcessedFiles, FilesMap, u64)> {
    let mut processed_files = ProcessedFiles::new();
    let mut success_count = 0;
    match XorUrlEncoder::from_url(file_link) {
        Err(err) => {
            processed_files.insert(
                file_link.to_string(),
                (CONTENT_ERROR_SIGN.to_string(), format!("<{}>", err)),
            );
            info!("Skipping file \"{}\". {}", file_link, err);
            Ok((processed_files, files_map, success_count))
        }
        Ok(xorurl_encoder) => {
            let file_path = Path::new("");
            let file_type = match xorurl_encoder.content_type() {
                SafeContentType::MediaType(media_type) => media_type,
                other => format!("{}", other),
            };
            let file_size = ""; // unknown

            // Let's update FileItem if the link is different or it doesn't exist in the files_map
            match files_map.get(file_name) {
                Some(current_file_item) => {
                    if current_file_item[FAKE_RDF_PREDICATE_LINK] != file_link {
                        if force {
                            if add_or_update_file_item(
                                safe,
                                file_name,
                                file_name,
                                &file_path,
                                &file_type,
                                &file_size,
                                None,
                                Some(file_link),
                                true,
                                &mut files_map,
                                &mut processed_files,
                            ) {
                                success_count += 1;
                            }
                        } else {
                            processed_files.insert(file_name.to_string(), (CONTENT_ERROR_SIGN.to_string(), format!("File named \"{}\" already exists on target. Use the 'force' flag to replace it", file_name)));
                            info!("Skipping file \"{}\" since a file with name \"{}\" already exists on target. You can use the 'force' flag to replace the existing file with the new one", file_link, file_name);
                        }
                    } else {
                        processed_files.insert(
                            file_link.to_string(),
                            (
                                CONTENT_ERROR_SIGN.to_string(),
                                format!(
                                    "File named \"{}\" already exists on target with same link",
                                    file_name
                                ),
                            ),
                        );
                        info!("Skipping file \"{}\" since a file with name \"{}\" already exists on target with the same link", file_link, file_name);
                    }
                }
                None => {
                    if add_or_update_file_item(
                        safe,
                        file_name,
                        file_name,
                        &file_path,
                        &file_type,
                        &file_size,
                        None,
                        Some(file_link),
                        false,
                        &mut files_map,
                        &mut processed_files,
                    ) {
                        success_count += 1;
                    }
                }
            };

            Ok((processed_files, files_map, success_count))
        }
    }
}

// Upload a files to the Network as a Published-ImmutableData
fn upload_file_to_net(safe: &mut Safe, path: &Path) -> ResultReturn<XorUrl> {
    let data = fs::read(path).map_err(|err| {
        Error::InvalidInput(format!("Failed to read file from local location: {}", err))
    })?;

    let mime_type = mime_guess::from_path(&path);
    safe.files_put_published_immutable(&data, mime_type.first_raw())
        .or_else(|err| {
            // Let's then upload it and set media-type to be simply raw content
            if let Error::InvalidMediaType(_) = err {
                safe.files_put_published_immutable(&data, None)
            } else {
                Err(err)
            }
        })
}

// Get file metadata from local filesystem
fn get_metadata(path: &Path) -> ResultReturn<(fs::Metadata, String)> {
    let metadata = fs::metadata(path).map_err(|err| {
        Error::FilesSystemError(format!(
            "Couldn't read metadata from source path ('{}'): {}",
            path.display(),
            err
        ))
    })?;
    debug!("Metadata for location: {:?}", metadata);

    let mime_type = mime_guess::from_path(&path);
    let media_type = mime_type.first_raw().unwrap_or("Raw");
    Ok((metadata, media_type.to_string()))
}

// Walk the local filesystem starting from `location`, creating a list of files paths,
// and if requested with `upload_files` arg, upload the files to the network filling up
// the list of files with their corresponding XOR-URLs
fn file_system_dir_walk(
    safe: &mut Safe,
    location: &str,
    recursive: bool,
    upload_files: bool,
) -> ResultReturn<ProcessedFiles> {
    let file_path = Path::new(location);
    let (metadata, _) = get_metadata(&file_path)?;
    info!("Reading files from {}", file_path.display());
    if metadata.is_dir() || !recursive {
        // TODO: option to enable following symlinks and hidden files?
        // We now compare both FilesMaps to upload the missing files
        let max_depth = if recursive { MAX_RECURSIVE_DEPTH } else { 1 };
        let mut processed_files = BTreeMap::new();
        WalkDir::new(file_path)
            .follow_links(true)
            .into_iter()
            .filter_entry(|e| not_hidden_and_valid_depth(e, max_depth))
            .filter_map(|v| v.ok())
            .for_each(|child| {
                let current_file_path = child.path();
                let current_path_str = current_file_path.to_str().unwrap_or_else(|| "").to_string();
                info!("Processing {}...", current_path_str);
                let normalised_path = normalise_path_separator(&current_path_str);
                match fs::metadata(&current_file_path) {
                    Ok(metadata) => {
                        if metadata.is_dir() {
                            // Everything is in the iter. We dont need to recurse.
                            // so what do we do with dirs? decide if we want to support empty dirs also
                        } else if upload_files {
                            match upload_file_to_net(safe, &current_file_path) {
                                Ok(xorurl) => {
                                    processed_files.insert(normalised_path, (CONTENT_ADDED_SIGN.to_string(), xorurl));
                                }
                                Err(err) => {
                                    processed_files.insert(normalised_path.clone(), (CONTENT_ERROR_SIGN.to_string(), format!("<{}>", err)));
                                    info!(
                                    "Skipping file \"{}\". {}",
                                    normalised_path, err);
                                },
                            };
                        } else {
                            processed_files.insert(normalised_path.clone(), (CONTENT_ADDED_SIGN.to_string(), "".to_string()));
                        }
                    },
                    Err(err) => {
                        processed_files.insert(normalised_path.clone(), (CONTENT_ERROR_SIGN.to_string(), format!("<{}>", err)));
                        info!(
                        "Skipping file \"{}\" since no metadata could be read from local location: {:?}",
                        normalised_path, err);
                    }
                }
            });

        Ok(processed_files)
    } else {
        // Recursive only works on a dir path. Let's error as the user may be making a mistake
        // so it's better for the user to double check and either provide the correct path
        // or remove the `--recursive` from the args
        Err(Error::InvalidInput(format!(
            "'{}' is not a directory. The \"--recursive\" arg is only supported for folders.",
            location
        )))
    }
}

// Checks if a path is not a hidden file or if the depth in the dir hierarchy is under a threshold
fn not_hidden_and_valid_depth(entry: &DirEntry, max_depth: usize) -> bool {
    entry
        .file_name()
        .to_str()
        .map(|s| entry.depth() <= max_depth && (entry.depth() == 0 || !s.starts_with('.')))
        .unwrap_or(false)
}

// Read the local filesystem at `location`, creating a list of one single file's path,
// and if requested with `upload_files` arg, upload the file to the network and putting
// the obtained XOR-URL in the single file list returned
fn file_system_single_file(
    safe: &mut Safe,
    location: &str,
    upload_files: bool,
) -> ResultReturn<ProcessedFiles> {
    let file_path = Path::new(location);
    info!("Reading file {}", file_path.display());

    // We now compare both FilesMaps to upload the missing files
    let mut processed_files = BTreeMap::new();
    let normalised_path = normalise_path_separator(file_path.to_str().unwrap_or_else(|| ""));
    match fs::metadata(&file_path) {
        Ok(metadata) => {
            if metadata.is_dir() {
                Err(Error::InvalidInput(format!(
                    "'{}' is a directory, only individual files can be added. Use files sync operation for uploading folders",
                    location
                )))
            } else if upload_files {
                match upload_file_to_net(safe, &file_path) {
                    Ok(xorurl) => {
                        processed_files
                            .insert(normalised_path, (CONTENT_ADDED_SIGN.to_string(), xorurl));
                    }
                    Err(err) => {
                        processed_files.insert(
                            normalised_path.clone(),
                            (CONTENT_ERROR_SIGN.to_string(), format!("<{}>", err)),
                        );
                        info!("Skipping file \"{}\". {}", normalised_path, err);
                    }
                };
                Ok(processed_files)
            } else {
                processed_files.insert(
                    normalised_path,
                    (CONTENT_ADDED_SIGN.to_string(), "".to_string()),
                );
                Ok(processed_files)
            }
        }
        Err(err) => {
            processed_files.insert(
                normalised_path.clone(),
                (CONTENT_ERROR_SIGN.to_string(), format!("<{}>", err)),
            );
            info!(
                "Skipping file \"{}\" since no metadata could be read from local location: {:?}",
                normalised_path, err
            );

            Ok(processed_files)
        }
    }
}

// From the provided list of local files paths and corresponding files XOR-URLs,
// create a FilesMap with file's metadata and their corresponding links
fn files_map_create(
    content: &ProcessedFiles,
    location: &str,
    dest_path: Option<&str>,
) -> ResultReturn<FilesMap> {
    let mut files_map = FilesMap::default();
    let now = gen_timestamp_secs();

    let (location_base_path, dest_base_path) = get_base_paths(location, dest_path)?;
    for (file_name, (_change, link)) in content
        .iter()
        .filter(|(_, (change, _))| change != CONTENT_ERROR_SIGN)
    {
        debug!("FileItem item name:{:?}", &file_name);
        let mut file_item = FileItem::new();
        let file_path = Path::new(&file_name);
        let (metadata, file_type) = get_metadata(&file_path)?;

        file_item.insert(FAKE_RDF_PREDICATE_LINK.to_string(), link.to_string());

        file_item.insert(FAKE_RDF_PREDICATE_TYPE.to_string(), file_type);

        let file_size = &metadata.len().to_string();
        file_item.insert(FAKE_RDF_PREDICATE_SIZE.to_string(), file_size.to_string());

        // file_item.insert("permissions", metadata.permissions().to_string());
        file_item.insert(FAKE_RDF_PREDICATE_MODIFIED.to_string(), now.clone());
        file_item.insert(FAKE_RDF_PREDICATE_CREATED.to_string(), now.clone());

        debug!("FileItem item: {:?}", file_item);
        let new_file_name = RelativePath::new(
            &file_name
                .to_string()
                .replace(&location_base_path, &dest_base_path),
        )
        .normalize();

        // Above normalize removes initial slash, and uses '\' if it's on Windows
        let final_name = format!("/{}", normalise_path_separator(new_file_name.as_str()));

        debug!("FileItem item inserted with filename {:?}", &final_name);
        files_map.insert(final_name.to_string(), file_item);
    }

    Ok(files_map)
}

// Unit Tests

#[test]
fn test_files_map_create() {
    use unwrap::unwrap;
    let mut processed_files = ProcessedFiles::new();
    processed_files.insert(
        "./testdata/test.md".to_string(),
        (
            CONTENT_ADDED_SIGN.to_string(),
            "safe://top_xorurl".to_string(),
        ),
    );
    processed_files.insert(
        "./testdata/subfolder/subexists.md".to_string(),
        (
            CONTENT_ADDED_SIGN.to_string(),
            "safe://second_xorurl".to_string(),
        ),
    );
    let files_map = unwrap!(files_map_create(&processed_files, "./testdata", Some("")));
    assert_eq!(files_map.len(), 2);
    let file_item1 = &files_map["/testdata/test.md"];
    assert_eq!(file_item1[FAKE_RDF_PREDICATE_LINK], "safe://top_xorurl");
    assert_eq!(file_item1[FAKE_RDF_PREDICATE_TYPE], "text/x-markdown");
    assert_eq!(file_item1[FAKE_RDF_PREDICATE_SIZE], "12");

    let file_item2 = &files_map["/testdata/subfolder/subexists.md"];
    assert_eq!(file_item2[FAKE_RDF_PREDICATE_LINK], "safe://second_xorurl");
    assert_eq!(file_item2[FAKE_RDF_PREDICATE_TYPE], "text/x-markdown");
    assert_eq!(file_item2[FAKE_RDF_PREDICATE_SIZE], "23");
}

#[test]
fn test_files_container_create_file() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let filename = "testdata/test.md";
    let (xorurl, processed_files, files_map) =
        unwrap!(safe.files_container_create(filename, None, false, false));

    assert!(xorurl.starts_with("safe://"));
    assert_eq!(processed_files.len(), 1);
    assert_eq!(files_map.len(), 1);
    let file_path = "/test.md";
    assert_eq!(processed_files[filename].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename].1,
        files_map[file_path][FAKE_RDF_PREDICATE_LINK]
    );
}

#[test]
fn test_files_container_create_dry_run() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let filename = "./testdata/";
    let (xorurl, processed_files, files_map) =
        unwrap!(safe.files_container_create(filename, None, true, true));

    assert!(xorurl.is_empty());
    assert_eq!(processed_files.len(), 5);
    assert_eq!(files_map.len(), 5);

    let filename1 = "./testdata/test.md";
    assert_eq!(processed_files[filename1].0, CONTENT_ADDED_SIGN);
    assert!(processed_files[filename1].1.is_empty());
    assert_eq!(
        processed_files[filename1].1,
        files_map["/test.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename2 = "./testdata/another.md";
    assert_eq!(processed_files[filename2].0, CONTENT_ADDED_SIGN);
    assert!(processed_files[filename2].1.is_empty());
    assert_eq!(
        processed_files[filename2].1,
        files_map["/another.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename3 = "./testdata/subfolder/subexists.md";
    assert_eq!(processed_files[filename3].0, CONTENT_ADDED_SIGN);
    assert!(processed_files[filename3].1.is_empty());
    assert_eq!(
        processed_files[filename3].1,
        files_map["/subfolder/subexists.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename4 = "./testdata/noextension";
    assert_eq!(processed_files[filename4].0, CONTENT_ADDED_SIGN);
    assert!(processed_files[filename4].1.is_empty());
    assert_eq!(
        processed_files[filename4].1,
        files_map["/noextension"][FAKE_RDF_PREDICATE_LINK]
    );
}

#[test]
fn test_files_container_create_folder_without_trailing_slash() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let (xorurl, processed_files, files_map) =
        unwrap!(safe.files_container_create("testdata", None, true, false));

    assert!(xorurl.starts_with("safe://"));
    assert_eq!(processed_files.len(), 5);
    assert_eq!(files_map.len(), 5);

    let filename1 = "testdata/test.md";
    assert_eq!(processed_files[filename1].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename1].1,
        files_map["/testdata/test.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename2 = "testdata/another.md";
    assert_eq!(processed_files[filename2].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename2].1,
        files_map["/testdata/another.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename3 = "testdata/subfolder/subexists.md";
    assert_eq!(processed_files[filename3].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename3].1,
        files_map["/testdata/subfolder/subexists.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename4 = "testdata/noextension";
    assert_eq!(processed_files[filename4].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename4].1,
        files_map["/testdata/noextension"][FAKE_RDF_PREDICATE_LINK]
    );
}

#[test]
fn test_files_container_create_folder_with_trailing_slash() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let (xorurl, processed_files, files_map) =
        unwrap!(safe.files_container_create("./testdata/", None, true, false));

    assert!(xorurl.starts_with("safe://"));
    assert_eq!(processed_files.len(), 5);
    assert_eq!(files_map.len(), 5);

    let filename1 = "./testdata/test.md";
    assert_eq!(processed_files[filename1].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename1].1,
        files_map["/test.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename2 = "./testdata/another.md";
    assert_eq!(processed_files[filename2].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename2].1,
        files_map["/another.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename3 = "./testdata/subfolder/subexists.md";
    assert_eq!(processed_files[filename3].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename3].1,
        files_map["/subfolder/subexists.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename4 = "./testdata/noextension";
    assert_eq!(processed_files[filename4].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename4].1,
        files_map["/noextension"][FAKE_RDF_PREDICATE_LINK]
    );
}

#[test]
fn test_files_container_create_dest_path_without_trailing_slash() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let (xorurl, processed_files, files_map) =
        unwrap!(safe.files_container_create("./testdata", Some("/myroot"), true, false));

    assert!(xorurl.starts_with("safe://"));
    assert_eq!(processed_files.len(), 5);
    assert_eq!(files_map.len(), 5);

    let filename1 = "./testdata/test.md";
    assert_eq!(processed_files[filename1].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename1].1,
        files_map["/myroot/test.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename2 = "./testdata/another.md";
    assert_eq!(processed_files[filename2].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename2].1,
        files_map["/myroot/another.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename3 = "./testdata/subfolder/subexists.md";
    assert_eq!(processed_files[filename3].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename3].1,
        files_map["/myroot/subfolder/subexists.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename4 = "./testdata/noextension";
    assert_eq!(processed_files[filename4].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename4].1,
        files_map["/myroot/noextension"][FAKE_RDF_PREDICATE_LINK]
    );
}

#[test]
fn test_files_container_create_dest_path_with_trailing_slash() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let (xorurl, processed_files, files_map) =
        unwrap!(safe.files_container_create("./testdata", Some("/myroot/"), true, false));

    assert!(xorurl.starts_with("safe://"));
    assert_eq!(processed_files.len(), 5);
    assert_eq!(files_map.len(), 5);

    let filename1 = "./testdata/test.md";
    assert_eq!(processed_files[filename1].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename1].1,
        files_map["/myroot/testdata/test.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename2 = "./testdata/another.md";
    assert_eq!(processed_files[filename2].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename2].1,
        files_map["/myroot/testdata/another.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename3 = "./testdata/subfolder/subexists.md";
    assert_eq!(processed_files[filename3].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename3].1,
        files_map["/myroot/testdata/subfolder/subexists.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename4 = "./testdata/noextension";
    assert_eq!(processed_files[filename4].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename4].1,
        files_map["/myroot/testdata/noextension"][FAKE_RDF_PREDICATE_LINK]
    );
}

#[test]
fn test_files_container_sync() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let (xorurl, processed_files, files_map) =
        unwrap!(safe.files_container_create("./testdata/", None, true, false));

    assert_eq!(processed_files.len(), 5);
    assert_eq!(files_map.len(), 5);

    let (version, new_processed_files, new_files_map) = unwrap!(safe.files_container_sync(
        "./testdata/subfolder/",
        &xorurl,
        true,
        false,
        false,
        false
    ));

    assert_eq!(version, 1);
    assert_eq!(new_processed_files.len(), 2);
    assert_eq!(new_files_map.len(), 7);

    let filename1 = "./testdata/test.md";
    assert_eq!(processed_files[filename1].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename1].1,
        new_files_map["/test.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename2 = "./testdata/another.md";
    assert_eq!(processed_files[filename2].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename2].1,
        new_files_map["/another.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename3 = "./testdata/subfolder/subexists.md";
    assert_eq!(processed_files[filename3].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename3].1,
        new_files_map["/subfolder/subexists.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename4 = "./testdata/noextension";
    assert_eq!(processed_files[filename4].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename4].1,
        new_files_map["/noextension"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename5 = "./testdata/subfolder/subexists.md";
    assert_eq!(new_processed_files[filename5].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        new_processed_files[filename5].1,
        new_files_map["/subexists.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename6 = "./testdata/subfolder/sub2.md";
    assert_eq!(new_processed_files[filename6].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        new_processed_files[filename6].1,
        new_files_map["/sub2.md"][FAKE_RDF_PREDICATE_LINK]
    );
}

#[test]
fn test_files_container_sync_dry_run() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let (xorurl, processed_files, files_map) =
        unwrap!(safe.files_container_create("./testdata/", None, true, false));

    assert_eq!(processed_files.len(), 5);
    assert_eq!(files_map.len(), 5);

    let (version, new_processed_files, new_files_map) = unwrap!(safe.files_container_sync(
        "./testdata/subfolder/",
        &xorurl,
        true,
        false,
        false,
        true // set dry_run flag on
    ));

    assert_eq!(version, 1);
    assert_eq!(new_processed_files.len(), 2);
    assert_eq!(new_files_map.len(), 7);

    let filename1 = "./testdata/test.md";
    assert_eq!(processed_files[filename1].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename1].1,
        new_files_map["/test.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename2 = "./testdata/another.md";
    assert_eq!(processed_files[filename2].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename2].1,
        new_files_map["/another.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename3 = "./testdata/subfolder/subexists.md";
    assert_eq!(processed_files[filename3].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename3].1,
        new_files_map["/subfolder/subexists.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename4 = "./testdata/noextension";
    assert_eq!(processed_files[filename4].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename4].1,
        new_files_map["/noextension"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename5 = "./testdata/subfolder/subexists.md";
    assert_eq!(new_processed_files[filename5].0, CONTENT_ADDED_SIGN);
    assert!(new_processed_files[filename5].1.is_empty());
    assert_eq!(
        new_processed_files[filename5].1,
        new_files_map["/subexists.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename6 = "./testdata/subfolder/sub2.md";
    assert_eq!(new_processed_files[filename6].0, CONTENT_ADDED_SIGN);
    assert!(new_processed_files[filename6].1.is_empty());
    assert_eq!(
        new_processed_files[filename6].1,
        new_files_map["/sub2.md"][FAKE_RDF_PREDICATE_LINK]
    );
}

#[test]
fn test_files_container_sync_with_versioned_target() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));

    let (xorurl, _, _) = unwrap!(safe.files_container_create("./testdata/", None, true, false));

    let versioned_xorurl = format!("{}?v=5", xorurl);
    match safe.files_container_sync(
        "./testdata/subfolder/",
        &versioned_xorurl,
        false,
        false,
        true, // this flag requests the update-nrs
        false,
    ) {
        Ok(_) => panic!("Sync was unexpectdly successful"),
        Err(err) => assert_eq!(
            err,
            Error::InvalidInput(format!(
                "The target URL cannot cannot contain a version: {}",
                versioned_xorurl
            ))
        ),
    };
}

#[test]
fn test_files_container_sync_with_delete() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let (xorurl, processed_files, files_map) =
        unwrap!(safe.files_container_create("./testdata/", None, true, false));

    assert_eq!(processed_files.len(), 5);
    assert_eq!(files_map.len(), 5);

    let (version, new_processed_files, new_files_map) = unwrap!(safe.files_container_sync(
        "./testdata/subfolder/",
        &xorurl,
        true,
        true, // this sets the delete flag
        false,
        false
    ));

    assert_eq!(version, 1);
    assert_eq!(new_processed_files.len(), 7);
    assert_eq!(new_files_map.len(), 2);

    // first check all previous files were removed
    let file_path1 = "/test.md";
    assert_eq!(new_processed_files[file_path1].0, CONTENT_DELETED_SIGN);
    assert_eq!(
        new_processed_files[file_path1].1,
        files_map[file_path1][FAKE_RDF_PREDICATE_LINK]
    );

    let file_path2 = "/another.md";
    assert_eq!(new_processed_files[file_path2].0, CONTENT_DELETED_SIGN);
    assert_eq!(
        new_processed_files[file_path2].1,
        files_map[file_path2][FAKE_RDF_PREDICATE_LINK]
    );

    let file_path3 = "/subfolder/subexists.md";
    assert_eq!(new_processed_files[file_path3].0, CONTENT_DELETED_SIGN);
    assert_eq!(
        new_processed_files[file_path3].1,
        files_map[file_path3][FAKE_RDF_PREDICATE_LINK]
    );

    let file_path4 = "/noextension";
    assert_eq!(new_processed_files[file_path4].0, CONTENT_DELETED_SIGN);
    assert_eq!(
        new_processed_files[file_path4].1,
        files_map[file_path4][FAKE_RDF_PREDICATE_LINK]
    );

    // and finally check the synced file was added
    let filename5 = "./testdata/subfolder/subexists.md";
    assert_eq!(new_processed_files[filename5].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        new_processed_files[filename5].1,
        new_files_map["/subexists.md"][FAKE_RDF_PREDICATE_LINK]
    );
}

#[test]
fn test_files_container_sync_delete_without_recursive() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    match safe.files_container_sync(
        "./testdata/subfolder/",
        "some-url",
        false, // this sets the recursive flag to off
        true,  // this sets the delete flag
        false,
        false,
    ) {
        Ok(_) => panic!("Sync was unexpectdly successful"),
        Err(err) => assert_eq!(
            err,
            Error::InvalidInput("'delete' is not allowed if --recursive is not set".to_string())
        ),
    };
}

#[test]
fn test_files_container_sync_update_nrs_unversioned_link() {
    use rand::distributions::Alphanumeric;
    use rand::{thread_rng, Rng};
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let (xorurl, _, _) = unwrap!(safe.files_container_create("./testdata/", None, true, false));

    let nrsurl: String = thread_rng().sample_iter(&Alphanumeric).take(15).collect();
    let mut xorurl_encoder = unwrap!(XorUrlEncoder::from_url(&xorurl));
    xorurl_encoder.set_content_version(None);
    let unversioned_link = unwrap!(xorurl_encoder.to_string());
    match safe.nrs_map_container_create(&nrsurl, &unversioned_link, false, true, false) {
        Ok(_) => panic!("NRS create was unexpectdly successful"),
        Err(err) => assert_eq!(
            err,
            Error::InvalidInput(format!(
                "The linked content (FilesContainer) is versionable, therefore NRS requires the link to specify a version: \"{}\"",
                unversioned_link
            ))
        ),
    };
}

#[test]
fn test_files_container_sync_update_nrs_with_xorurl() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));

    let (xorurl, _, _) = unwrap!(safe.files_container_create("./testdata/", None, true, false));

    match safe.files_container_sync(
        "./testdata/subfolder/",
        &xorurl,
        false,
        false,
        true, // this flag requests the update-nrs
        false,
    ) {
        Ok(_) => panic!("Sync was unexpectdly successful"),
        Err(err) => assert_eq!(
            err,
            Error::InvalidInput(
                "'update-nrs' is not allowed since the URL provided is not an NRS URL".to_string()
            )
        ),
    };
}

#[test]
fn test_files_container_sync_update_nrs_versioned_link() {
    use rand::distributions::Alphanumeric;
    use rand::{thread_rng, Rng};
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let (xorurl, _, _) = unwrap!(safe.files_container_create("./testdata/", None, true, false));

    let nrsurl: String = thread_rng().sample_iter(&Alphanumeric).take(15).collect();

    let mut xorurl_encoder = unwrap!(XorUrlEncoder::from_url(&xorurl));
    xorurl_encoder.set_content_version(Some(0));
    let _ = unwrap!(safe.nrs_map_container_create(
        &nrsurl,
        &unwrap!(xorurl_encoder.to_string()),
        false,
        true,
        false
    ));

    let _ = unwrap!(safe.files_container_sync(
        "./testdata/subfolder/",
        &nrsurl,
        false,
        false,
        true, // this flag requests the update-nrs
        false,
    ));

    let mut xorurl_encoder = unwrap!(XorUrlEncoder::from_url(&xorurl));
    xorurl_encoder.set_content_version(Some(1));
    let (new_link, _) = unwrap!(safe.parse_and_resolve_url(&nrsurl));
    assert_eq!(
        unwrap!(new_link.to_string()),
        unwrap!(xorurl_encoder.to_string())
    );
}

#[test]
fn test_files_container_sync_target_path_without_trailing_slash() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let (xorurl, processed_files, files_map) =
        unwrap!(safe.files_container_create("./testdata/", None, true, false));

    assert_eq!(processed_files.len(), 5);
    assert_eq!(files_map.len(), 5);
    let mut xorurl_encoder = unwrap!(XorUrlEncoder::from_url(&xorurl));
    xorurl_encoder.set_path("path/when/sync");
    let (version, new_processed_files, new_files_map) = unwrap!(safe.files_container_sync(
        "./testdata/subfolder",
        &unwrap!(xorurl_encoder.to_string()),
        true,
        false,
        false,
        false
    ));

    assert_eq!(version, 1);
    assert_eq!(new_processed_files.len(), 2);
    assert_eq!(new_files_map.len(), 7);

    let filename1 = "./testdata/test.md";
    assert_eq!(processed_files[filename1].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename1].1,
        new_files_map["/test.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename2 = "./testdata/another.md";
    assert_eq!(processed_files[filename2].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename2].1,
        new_files_map["/another.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename3 = "./testdata/subfolder/subexists.md";
    assert_eq!(processed_files[filename3].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename3].1,
        new_files_map["/subfolder/subexists.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename4 = "./testdata/noextension";
    assert_eq!(processed_files[filename4].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename4].1,
        new_files_map["/noextension"][FAKE_RDF_PREDICATE_LINK]
    );

    // and finally check the synced file is there
    let filename5 = "./testdata/subfolder/subexists.md";
    assert_eq!(new_processed_files[filename5].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        new_processed_files[filename5].1,
        new_files_map["/path/when/sync/subexists.md"][FAKE_RDF_PREDICATE_LINK]
    );
}

#[test]
fn test_files_container_sync_target_path_with_trailing_slash() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let (xorurl, processed_files, files_map) =
        unwrap!(safe.files_container_create("./testdata/", None, true, false));

    assert_eq!(processed_files.len(), 5);
    assert_eq!(files_map.len(), 5);
    let mut xorurl_encoder = unwrap!(XorUrlEncoder::from_url(&xorurl));
    //let xorurl_with_path = format!("{}/path/when/sync/", xorurl);
    xorurl_encoder.set_path("/path/when/sync/");
    let (version, new_processed_files, new_files_map) = unwrap!(safe.files_container_sync(
        "./testdata/subfolder",
        &unwrap!(xorurl_encoder.to_string()),
        true,
        false,
        false,
        false,
    ));

    assert_eq!(version, 1);
    assert_eq!(new_processed_files.len(), 2);
    assert_eq!(new_files_map.len(), 7);

    let filename1 = "./testdata/test.md";
    assert_eq!(processed_files[filename1].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename1].1,
        new_files_map["/test.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename2 = "./testdata/another.md";
    assert_eq!(processed_files[filename2].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename2].1,
        new_files_map["/another.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename3 = "./testdata/subfolder/subexists.md";
    assert_eq!(processed_files[filename3].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename3].1,
        new_files_map["/subfolder/subexists.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename4 = "./testdata/noextension";
    assert_eq!(processed_files[filename4].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename4].1,
        new_files_map["/noextension"][FAKE_RDF_PREDICATE_LINK]
    );

    // and finally check the synced file is there
    let filename5 = "./testdata/subfolder/subexists.md";
    assert_eq!(new_processed_files[filename5].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        new_processed_files[filename5].1,
        new_files_map["/path/when/sync/subfolder/subexists.md"][FAKE_RDF_PREDICATE_LINK]
    );
}

#[test]
fn test_files_container_get() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let (xorurl, _processed_files, files_map) =
        unwrap!(safe.files_container_create("./testdata/", None, true, false));

    let (version, fetched_files_map) = unwrap!(safe.files_container_get(&xorurl));

    assert_eq!(version, 0);
    assert_eq!(fetched_files_map.len(), 5);
    assert_eq!(files_map.len(), fetched_files_map.len());
    assert_eq!(files_map["/test.md"], fetched_files_map["/test.md"]);
    assert_eq!(files_map["/another.md"], fetched_files_map["/another.md"]);
    assert_eq!(
        files_map["/subfolder/subexists.md"],
        fetched_files_map["/subfolder/subexists.md"]
    );
    assert_eq!(files_map["/noextension"], fetched_files_map["/noextension"]);
}

#[test]
fn test_files_container_version() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let (xorurl, _, _) = unwrap!(safe.files_container_create("./testdata/", None, true, false));

    let (version, _) = unwrap!(safe.files_container_get(&xorurl));
    assert_eq!(version, 0);

    let (version, _, _) = unwrap!(safe.files_container_sync(
        "./testdata/subfolder/",
        &xorurl,
        true,
        true, // this sets the delete flag,
        false,
        false,
    ));
    assert_eq!(version, 1);

    let mut xorurl_encoder = unwrap!(XorUrlEncoder::from_url(&xorurl));
    xorurl_encoder.set_content_version(None);
    let (version, _) = unwrap!(safe.files_container_get(&unwrap!(xorurl_encoder.to_string())));
    assert_eq!(version, 1);
}

#[test]
fn test_files_container_get_with_version() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let (xorurl, _processed_files, files_map) =
        unwrap!(safe.files_container_create("./testdata/", None, true, false));

    // let's create a new version of the files container
    let (_version, _new_processed_files, new_files_map) = unwrap!(safe.files_container_sync(
        "./testdata/subfolder/",
        &xorurl,
        true,
        true, // this sets the delete flag
        false,
        false
    ));

    // let's fetch version 0
    let mut xorurl_encoder = unwrap!(XorUrlEncoder::from_url(&xorurl));
    xorurl_encoder.set_content_version(Some(0));
    let (version, v0_files_map) =
        unwrap!(safe.files_container_get(&unwrap!(xorurl_encoder.to_string())));

    assert_eq!(version, 0);
    assert_eq!(files_map, v0_files_map);
    // let's check that one of the files in v1 is still there
    let file_path1 = "/test.md";
    assert_eq!(
        files_map[file_path1][FAKE_RDF_PREDICATE_LINK],
        v0_files_map[file_path1][FAKE_RDF_PREDICATE_LINK]
    );

    // let's fetch version 1
    xorurl_encoder.set_content_version(Some(1));
    let (version, v1_files_map) =
        unwrap!(safe.files_container_get(&unwrap!(xorurl_encoder.to_string())));

    assert_eq!(version, 1);
    assert_eq!(new_files_map, v1_files_map);
    // let's check that some of the files are no in v2 anymore
    let file_path2 = "/another.md";
    let file_path3 = "/subfolder/subexists.md";
    let file_path4 = "/noextension";
    assert!(v1_files_map.get(file_path1).is_none());
    assert!(v1_files_map.get(file_path2).is_none());
    assert!(v1_files_map.get(file_path3).is_none());
    assert!(v1_files_map.get(file_path4).is_none());

    // let's fetch version 2 (invalid)
    xorurl_encoder.set_content_version(Some(2));
    match safe.files_container_get(&unwrap!(xorurl_encoder.to_string())) {
        Ok(_) => panic!("unexpectdly retrieved verion 3 of container"),
        Err(Error::VersionNotFound(msg)) => assert_eq!(
            msg,
            format!(
                "Version '2' is invalid for FilesContainer found at \"{}\"",
                xorurl_encoder
            )
        ),
        other => panic!(format!(
            "error returned is not the expected one: {:?}",
            other
        )),
    };
}

#[test]
fn test_files_container_sync_with_nrs_url() {
    use rand::distributions::Alphanumeric;
    use rand::{thread_rng, Rng};
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let (xorurl, _, _) =
        unwrap!(safe.files_container_create("./testdata/test.md", None, false, false));

    let nrsurl: String = thread_rng().sample_iter(&Alphanumeric).take(15).collect();

    let mut xorurl_encoder = unwrap!(XorUrlEncoder::from_url(&xorurl));
    xorurl_encoder.set_content_version(Some(0));
    let _ = unwrap!(safe.nrs_map_container_create(
        &nrsurl,
        &unwrap!(xorurl_encoder.to_string()),
        false,
        true,
        false
    ));

    let _ = unwrap!(safe.files_container_sync(
        "./testdata/subfolder/",
        &xorurl,
        false,
        false,
        false,
        false,
    ));

    let _ = unwrap!(safe.files_container_sync(
        "./testdata/",
        &nrsurl,
        false,
        false,
        true, // this flag requests the update-nrs
        false,
    ));

    let (version, fetched_files_map) = unwrap!(safe.files_container_get(&xorurl));
    assert_eq!(version, 2);
    assert_eq!(fetched_files_map.len(), 5);
}

#[test]
fn test_files_container_add() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let (xorurl, processed_files, files_map) =
        unwrap!(safe.files_container_create("./testdata/subfolder/", None, false, false));
    assert_eq!(processed_files.len(), 2);
    assert_eq!(files_map.len(), 2);

    let (version, new_processed_files, new_files_map) = unwrap!(safe.files_container_add(
        "./testdata/test.md",
        &format!("{}/new_filename_test.md", xorurl),
        false,
        false,
        false,
    ));

    assert_eq!(version, 1);
    assert_eq!(new_processed_files.len(), 1);
    assert_eq!(new_files_map.len(), 3);

    let filename1 = "./testdata/subfolder/subexists.md";
    assert_eq!(processed_files[filename1].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename1].1,
        new_files_map["/subexists.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename2 = "./testdata/subfolder/sub2.md";
    assert_eq!(processed_files[filename2].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename2].1,
        new_files_map["/sub2.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename3 = "./testdata/test.md";
    assert_eq!(new_processed_files[filename3].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        new_processed_files[filename3].1,
        new_files_map["/new_filename_test.md"][FAKE_RDF_PREDICATE_LINK]
    );
}

#[test]
fn test_files_container_add_dir() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let (xorurl, processed_files, files_map) =
        unwrap!(safe.files_container_create("./testdata/subfolder/", None, false, false));
    assert_eq!(processed_files.len(), 2);
    assert_eq!(files_map.len(), 2);

    match safe.files_container_add(
        "./testdata",
        &xorurl,
        false,
        false,
        false
    ) {
        Ok(_) => panic!("unexpectdly added a folder to files container"),
        Err(Error::InvalidInput(msg)) => assert_eq!(
            msg,
            "'./testdata' is a directory, only individual files can be added. Use files sync operation for uploading folders".to_string(),
        ),
        other => panic!(format!(
            "error returned is not the expected one: {:?}",
            other
        )),
    }
}

#[test]
fn test_files_container_add_existing_name() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let (xorurl, processed_files, files_map) =
        unwrap!(safe.files_container_create("./testdata/subfolder/", None, false, false));
    assert_eq!(processed_files.len(), 2);
    assert_eq!(files_map.len(), 2);

    let (version, new_processed_files, new_files_map) = unwrap!(safe.files_container_add(
        "./testdata/test.md",
        &format!("{}/sub2.md", xorurl),
        false,
        false,
        false
    ));

    assert_eq!(version, 0);
    assert_eq!(new_processed_files.len(), 1);
    assert_eq!(new_files_map.len(), 2);
    assert_eq!(
        new_processed_files["./testdata/test.md"].1,
        "File named \"/sub2.md\" already exists on target. Use the \'force\' flag to replace it"
    );
    assert_eq!(files_map, new_files_map);

    // let's now force it
    let (version, new_processed_files, new_files_map) = unwrap!(safe.files_container_add(
        "./testdata/test.md",
        &format!("{}/sub2.md", xorurl),
        true, //force it
        false,
        false
    ));

    assert_eq!(version, 1);
    assert_eq!(new_processed_files.len(), 1);
    assert_eq!(new_files_map.len(), 2);
    assert_eq!(
        new_processed_files["./testdata/test.md"].0,
        CONTENT_UPDATED_SIGN
    );
    assert_eq!(
        new_processed_files["./testdata/test.md"].1,
        new_files_map["/sub2.md"]["link"]
    );
}

#[test]
fn test_files_container_add_a_url() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let (xorurl, processed_files, files_map) =
        unwrap!(safe.files_container_create("./testdata/subfolder/", None, false, false));
    assert_eq!(processed_files.len(), 2);
    assert_eq!(files_map.len(), 2);
    let data = b"0123456789";
    let file_xorurl = unwrap!(safe.files_put_published_immutable(data, None));
    let new_filename = "/new_filename_test.md";

    let (version, new_processed_files, new_files_map) = unwrap!(safe.files_container_add(
        &file_xorurl,
        &format!("{}{}", xorurl, new_filename),
        false,
        false,
        false
    ));

    assert_eq!(version, 1);
    assert_eq!(new_processed_files.len(), 1);
    assert_eq!(new_files_map.len(), 3);

    let filename1 = "./testdata/subfolder/subexists.md";
    assert_eq!(processed_files[filename1].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename1].1,
        new_files_map["/subexists.md"][FAKE_RDF_PREDICATE_LINK]
    );

    let filename2 = "./testdata/subfolder/sub2.md";
    assert_eq!(processed_files[filename2].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        processed_files[filename2].1,
        new_files_map["/sub2.md"][FAKE_RDF_PREDICATE_LINK]
    );

    assert_eq!(new_processed_files[new_filename].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        new_processed_files[new_filename].1,
        new_files_map[new_filename][FAKE_RDF_PREDICATE_LINK]
    );
    assert_eq!(
        new_files_map[new_filename][FAKE_RDF_PREDICATE_LINK],
        file_xorurl
    );

    // let's add another file but with the same name
    let data = b"9876543210";
    let other_file_xorurl = unwrap!(safe.files_put_published_immutable(data, None));
    let (version, new_processed_files, new_files_map) = unwrap!(safe.files_container_add(
        &other_file_xorurl,
        &format!("{}{}", xorurl, new_filename),
        true, // force to overwrite it with new link
        false,
        false
    ));

    assert_eq!(version, 2);
    assert_eq!(new_processed_files.len(), 1);
    assert_eq!(new_files_map.len(), 3);
    assert_eq!(new_processed_files[new_filename].0, CONTENT_UPDATED_SIGN);
    assert_eq!(
        new_processed_files[new_filename].1,
        new_files_map[new_filename][FAKE_RDF_PREDICATE_LINK]
    );
    assert_eq!(
        new_files_map[new_filename][FAKE_RDF_PREDICATE_LINK],
        other_file_xorurl
    );
}

#[test]
fn test_files_container_add_from_raw() {
    use unwrap::unwrap;
    let mut safe = Safe::new("base32z");
    unwrap!(safe.connect("", Some("fake-credentials")));
    let (xorurl, processed_files, files_map) =
        unwrap!(safe.files_container_create("./testdata/subfolder/", None, false, false));
    assert_eq!(processed_files.len(), 2);
    assert_eq!(files_map.len(), 2);

    let data = b"0123456789";
    let new_filename = "/new_filename_test.md";

    let (version, new_processed_files, new_files_map) = unwrap!(safe.files_container_add_from_raw(
        data,
        &format!("{}{}", xorurl, new_filename),
        false,
        false,
        false
    ));

    assert_eq!(version, 1);
    assert_eq!(new_processed_files.len(), 1);
    assert_eq!(new_files_map.len(), 3);

    assert_eq!(new_processed_files[new_filename].0, CONTENT_ADDED_SIGN);
    assert_eq!(
        new_processed_files[new_filename].1,
        new_files_map[new_filename][FAKE_RDF_PREDICATE_LINK]
    );

    // let's add another file but with the same name
    let data = b"9876543210";
    let (version, new_processed_files, new_files_map) = unwrap!(safe.files_container_add_from_raw(
        data,
        &format!("{}{}", xorurl, new_filename),
        true, // force to overwrite it with new link
        false,
        false
    ));

    assert_eq!(version, 2);
    assert_eq!(new_processed_files.len(), 1);
    assert_eq!(new_files_map.len(), 3);
    assert_eq!(new_processed_files[new_filename].0, CONTENT_UPDATED_SIGN);
    assert_eq!(
        new_processed_files[new_filename].1,
        new_files_map[new_filename][FAKE_RDF_PREDICATE_LINK]
    );
}