    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

    use std::collections::{BTreeSet, HashMap};
    use std::fs::{self, File};
    use std::io::prelude::*;
    use std::io::SeekFrom;
    use std::path::{Path, PathBuf};
    use std::rc::Rc;
    use std::sync::Arc;
    use std::task::Poll;

    use crate::core::compiler::{BuildConfig, CompileMode, DefaultExecutor, Executor};
    use crate::core::resolver::CliFeatures;
    use crate::core::{registry::PackageRegistry, resolver::HasDevUnits};
    use crate::core::{Feature, Shell, Verbosity, Workspace};
    use crate::core::{Package, PackageId, PackageSet, Resolve, SourceId};
    use crate::sources::PathSource;
    use crate::util::errors::CargoResult;
    use crate::util::toml::TomlManifest;
    use crate::util::{self, human_readable_bytes, restricted_names, Config, FileLock};
    use crate::{drop_println, ops};
    use anyhow::Context as _;
    use cargo_util::paths;
    use flate2::read::GzDecoder;
    use flate2::{Compression, GzBuilder};
    use log::debug;
    use serde::Serialize;
    use tar::{Archive, Builder, EntryType, Header, HeaderMode};

    pub struct PackageOpts<'cfg> {
        pub config: &'cfg Config,
        pub list: bool,
        pub check_metadata: bool,
        pub allow_dirty: bool,
        pub verify: bool,
        pub jobs: Option<i32>,
        pub keep_going: bool,
        pub to_package: ops::Packages,
        pub targets: Vec<String>,
        pub cli_features: CliFeatures,
    }

    const ORIGINAL_MANIFEST_FILE: &str = "Cargo.toml.orig";
    const VCS_INFO_FILE: &str = ".cargo_vcs_info.json";

    struct ArchiveFile {
        /// The relative path in the archive (not including the top-level package
        /// name directory).
        rel_path: PathBuf,
        /// String variant of `rel_path`, for convenience.
        rel_str: String,
        /// The contents to add to the archive.
        contents: FileContents,
    }

    enum FileContents {
        /// Absolute path to the file on disk to add to the archive.
        OnDisk(PathBuf),
        /// Generates a file.
        Generated(GeneratedFile),
    }

    enum GeneratedFile {
        /// Generates `Cargo.toml` by rewriting the original.
        Manifest,
        /// Generates `Cargo.lock` in some cases (like if there is a binary).
        Lockfile,
        /// Adds a `.cargo_vcs_info.json` file if in a (clean) git repo.
        VcsInfo(VcsInfo),
    }

    #[derive(Serialize)]
    struct VcsInfo {
        git: GitVcsInfo,
        /// Path to the package within repo (empty string if root). / not \
        path_in_vcs: String,
    }

    #[derive(Serialize)]
    struct GitVcsInfo {
        sha1: String,
    }

    pub fn package_one(
        ws: &Workspace<'_>,
        pkg: &Package,
        opts: &PackageOpts<'_>,
    ) -> CargoResult<Option<FileLock>> {
        let config = ws.config();
        let mut src = PathSource::new(pkg.root(), pkg.package_id().source_id(), config);
        src.update()?;

        if opts.check_metadata {
            check_metadata(pkg, config)?;
        }

        if !pkg.manifest().exclude().is_empty() && !pkg.manifest().include().is_empty() {
            config.shell().warn(
                "both package.include and package.exclude are specified; \
                 the exclude list will be ignored",
            )?;
        }
        let src_files = src.list_files(pkg)?;

        // Check (git) repository state, getting the current commit hash if not
        // dirty.
        let vcs_info = if !opts.allow_dirty {
            // This will error if a dirty repo is found.
            check_repo_state(pkg, &src_files, config)?
        } else {
            None
        };

        let ar_files = build_ar_list(ws, pkg, src_files, vcs_info)?;

        let filecount = ar_files.len();

        if opts.list {
            for ar_file in ar_files {
                drop_println!(config, "{}", ar_file.rel_str);
            }

            return Ok(None);
        }

        // Check that the package dependencies are safe to deploy.
        for dep in pkg.dependencies() {
            super::check_dep_has_version(dep, false)?;
        }

        let filename = format!("{}-{}.crate", pkg.name(), pkg.version());
        let dir = ws.target_dir().join("package");
        let mut dst = {
            let tmp = format!(".{}", filename);
            dir.open_rw(&tmp, config, "package scratch space")?
        };

        // Package up and test a temporary tarball and only move it to the final
        // location if it actually passes all our tests. Any previously existing
        // tarball can be assumed as corrupt or invalid, so we just blow it away if
        // it exists.
        config
            .shell()
            .status("Packaging", pkg.package_id().to_string())?;
        dst.file().set_len(0)?;
        let uncompressed_size = tar(ws, pkg, ar_files, dst.file(), &filename)
            .with_context(|| "failed to prepare local package for uploading")?;
        if opts.verify {
            dst.seek(SeekFrom::Start(0))?;
            run_verify(ws, pkg, &dst, opts).with_context(|| "failed to verify package tarball")?
        }

        dst.seek(SeekFrom::Start(0))?;
        let src_path = dst.path();
        let dst_path = dst.parent().join(&filename);
        fs::rename(&src_path, &dst_path)
            .with_context(|| "failed to move temporary tarball into final location")?;

        let dst_metadata = dst
            .file()
            .metadata()
            .with_context(|| format!("could not learn metadata for: `{}`", dst_path.display()))?;
        let compressed_size = dst_metadata.len();

        let uncompressed = human_readable_bytes(uncompressed_size);
        let compressed = human_readable_bytes(compressed_size);

        let message = format!(
            "{} files, {:.1}{} ({:.1}{} compressed)",
            filecount, uncompressed.0, uncompressed.1, compressed.0, compressed.1,
        );
        // It doesn't really matter if this fails.
        drop(config.shell().status("Packaged", message));

        return Ok(Some(dst));
    }

    pub fn package(ws: &Workspace<'_>, opts: &PackageOpts<'_>) -> CargoResult<Option<Vec<FileLock>>> {
        let pkgs = ws.members_with_features(
            &opts.to_package.to_package_id_specs(ws)?,
            &opts.cli_features,
        )?;

        let mut dsts = Vec::with_capacity(pkgs.len());

        if ws.root().join("Cargo.lock").exists() {
            // Make sure the Cargo.lock is up-to-date and valid.
            let _ = ops::resolve_ws(ws)?;
            // If Cargo.lock does not exist, it will be generated by `build_lock`
            // below, and will be validated during the verification step.
        }

        for (pkg, cli_features) in pkgs {
            let result = package_one(
                ws,
                pkg,
                &PackageOpts {
                    config: opts.config,
                    list: opts.list,
                    check_metadata: opts.check_metadata,
                    allow_dirty: opts.allow_dirty,
                    verify: opts.verify,
                    jobs: opts.jobs,
                    keep_going: opts.keep_going,
                    to_package: ops::Packages::Default,
                    targets: opts.targets.clone(),
                    cli_features: cli_features,
                },
            )?;

            if !opts.list {
                dsts.push(result.unwrap());
            }
        }

        if opts.list {
            // We're just listing, so there's no file output
            Ok(None)
        } else {
            Ok(Some(dsts))
        }
    }

    /// Builds list of files to archive.
    fn build_ar_list(
        ws: &Workspace<'_>,
        pkg: &Package,
        src_files: Vec<PathBuf>,
        vcs_info: Option<VcsInfo>,
    ) -> CargoResult<Vec<ArchiveFile>> {
        let mut result = Vec::new();
        let root = pkg.root();
        for src_file in src_files {
            let rel_path = src_file.strip_prefix(&root)?.to_path_buf();
            check_filename(&rel_path, &mut ws.config().shell())?;
            let rel_str = rel_path
                .to_str()
                .ok_or_else(|| {
                    anyhow::format_err!("non-utf8 path in source directory: {}", rel_path.display())
                })?
                .to_string();
            match rel_str.as_ref() {
                "Cargo.toml" => {
                    result.push(ArchiveFile {
                        rel_path: PathBuf::from(ORIGINAL_MANIFEST_FILE),
                        rel_str: ORIGINAL_MANIFEST_FILE.to_string(),
                        contents: FileContents::OnDisk(src_file),
                    });
                    result.push(ArchiveFile {
                        rel_path,
                        rel_str,
                        contents: FileContents::Generated(GeneratedFile::Manifest),
                    });
                }
                "Cargo.lock" => continue,
                VCS_INFO_FILE | ORIGINAL_MANIFEST_FILE => anyhow::bail!(
                    "invalid inclusion of reserved file name {} in package source",
                    rel_str
                ),
                _ => {
                    result.push(ArchiveFile {
                        rel_path,
                        rel_str,
                        contents: FileContents::OnDisk(src_file),
                    });
                }
            }
        }
        if pkg.include_lockfile() {
            result.push(ArchiveFile {
                rel_path: PathBuf::from("Cargo.lock"),
                rel_str: "Cargo.lock".to_string(),
                contents: FileContents::Generated(GeneratedFile::Lockfile),
            });
        }
        if let Some(vcs_info) = vcs_info {
            result.push(ArchiveFile {
                rel_path: PathBuf::from(VCS_INFO_FILE),
                rel_str: VCS_INFO_FILE.to_string(),
                contents: FileContents::Generated(GeneratedFile::VcsInfo(vcs_info)),
            });
        }
        if let Some(license_file) = &pkg.manifest().metadata().license_file {
            let license_path = Path::new(license_file);
            let abs_file_path = paths::normalize_path(&pkg.root().join(license_path));
            if abs_file_path.exists() {
                check_for_file_and_add(
                    "license-file",
                    license_path,
                    abs_file_path,
                    pkg,
                    &mut result,
                    ws,
                )?;
            } else {
                let rel_msg = if license_path.is_absolute() {
                    "".to_string()
                } else {
                    format!(" (relative to `{}`)", pkg.root().display())
                };
                ws.config().shell().warn(&format!(
                    "license-file `{}` does not appear to exist{}.\n\
                    Please update the license-file setting in the manifest at `{}`\n\
                    This may become a hard error in the future.",
                    license_path.display(),
                    rel_msg,
                    pkg.manifest_path().display()
                ))?;
            }
        }
        if let Some(readme) = &pkg.manifest().metadata().readme {
            let readme_path = Path::new(readme);
            let abs_file_path = paths::normalize_path(&pkg.root().join(readme_path));
            if abs_file_path.exists() {
                check_for_file_and_add("readme", readme_path, abs_file_path, pkg, &mut result, ws)?;
            }
        }
        result.sort_unstable_by(|a, b| a.rel_path.cmp(&b.rel_path));

        Ok(result)
    }

    fn check_for_file_and_add(
        label: &str,
        file_path: &Path,
        abs_file_path: PathBuf,
        pkg: &Package,
        result: &mut Vec<ArchiveFile>,
        ws: &Workspace<'_>,
    ) -> CargoResult<()> {
        match abs_file_path.strip_prefix(&pkg.root()) {
            Ok(rel_file_path) => {
                if !result.iter().any(|ar| ar.rel_path == rel_file_path) {
                    result.push(ArchiveFile {
                        rel_path: rel_file_path.to_path_buf(),
                        rel_str: rel_file_path
                            .to_str()
                            .expect("everything was utf8")
                            .to_string(),
                        contents: FileContents::OnDisk(abs_file_path),
                    })
                }
            }
            Err(_) => {
                // The file exists somewhere outside of the package.
                let file_name = file_path.file_name().unwrap();
                if result
                    .iter()
                    .any(|ar| ar.rel_path.file_name().unwrap() == file_name)
                {
                    ws.config().shell().warn(&format!(
                        "{} `{}` appears to be a path outside of the package, \
                                but there is already a file named `{}` in the root of the package. \
                                The archived crate will contain the copy in the root of the package. \
                                Update the {} to point to the path relative \
                                to the root of the package to remove this warning.",
                        label,
                        file_path.display(),
                        file_name.to_str().unwrap(),
                        label,
                    ))?;
                } else {
                    result.push(ArchiveFile {
                        rel_path: PathBuf::from(file_name),
                        rel_str: file_name.to_str().unwrap().to_string(),
                        contents: FileContents::OnDisk(abs_file_path),
                    })
                }
            }
        }
        Ok(())
    }

    /// Construct `Cargo.lock` for the package to be published.
    fn build_lock(ws: &Workspace<'_>, orig_pkg: &Package) -> CargoResult<String> {
        let config = ws.config();
        let orig_resolve = ops::load_pkg_lockfile(ws)?;

        // Convert Package -> TomlManifest -> Manifest -> Package
        let toml_manifest = Rc::new(
            orig_pkg
                .manifest()
                .original()
                .prepare_for_publish(ws, orig_pkg.root())?,
        );
        let package_root = orig_pkg.root();
        let source_id = orig_pkg.package_id().source_id();
        let (manifest, _nested_paths) =
            TomlManifest::to_real_manifest(&toml_manifest, source_id, package_root, config)?;
        let new_pkg = Package::new(manifest, orig_pkg.manifest_path());

        // Regenerate Cargo.lock using the old one as a guide.
        let tmp_ws = Workspace::ephemeral(new_pkg, ws.config(), None, true)?;
        let mut tmp_reg = PackageRegistry::new(ws.config())?;
        let mut new_resolve = ops::resolve_with_previous(
            &mut tmp_reg,
            &tmp_ws,
            &CliFeatures::new_all(true),
            HasDevUnits::Yes,
            orig_resolve.as_ref(),
            None,
            &[],
            true,
        )?;
        let pkg_set = ops::get_resolved_packages(&new_resolve, tmp_reg)?;

        if let Some(orig_resolve) = orig_resolve {
            compare_resolve(config, tmp_ws.current()?, &orig_resolve, &new_resolve)?;
        }
        check_yanked(
            config,
            &pkg_set,
            &new_resolve,
            "consider updating to a version that is not yanked",
        )?;

        ops::resolve_to_string(&tmp_ws, &mut new_resolve)
    }

    // Checks that the package has some piece of metadata that a human can
    // use to tell what the package is about.
    fn check_metadata(pkg: &Package, config: &Config) -> CargoResult<()> {
        let md = pkg.manifest().metadata();

        let mut missing = vec![];

        macro_rules! lacking {
            ($( $($field: ident)||* ),*) => {{
                $(
                    if $(md.$field.as_ref().map_or(true, |s| s.is_empty()))&&* {
                        $(missing.push(stringify!($field).replace("_", "-"));)*
                    }
                )*
            }}
        }
        lacking!(
            description,
            license || license_file,
            documentation || homepage || repository
        );

        if !missing.is_empty() {
            let mut things = missing[..missing.len() - 1].join(", ");
            // `things` will be empty if and only if its length is 1 (i.e., the only case
            // to have no `or`).
            if !things.is_empty() {
                things.push_str(" or ");
            }
            things.push_str(missing.last().unwrap());

            config.shell().warn(&format!(
                "manifest has no {things}.\n\
                 See https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata for more info.",
                things = things
            ))?
        }

        Ok(())
    }

    /// Checks if the package source is in a *git* DVCS repository. If *git*, and
    /// the source is *dirty* (e.g., has uncommitted changes) then `bail!` with an
    /// informative message. Otherwise return the sha1 hash of the current *HEAD*
    /// commit, or `None` if no repo is found.
    fn check_repo_state(
        p: &Package,
        src_files: &[PathBuf],
        config: &Config,
    ) -> CargoResult<Option<VcsInfo>> {
        if let Ok(repo) = git2::Repository::discover(p.root()) {
            if let Some(workdir) = repo.workdir() {
                debug!("found a git repo at {:?}", workdir);
                let path = p.manifest_path();
                let path = path.strip_prefix(workdir).unwrap_or(path);
                if let Ok(status) = repo.status_file(path) {
                    if (status & git2::Status::IGNORED).is_empty() {
                        debug!(
                            "found (git) Cargo.toml at {:?} in workdir {:?}",
                            path, workdir
                        );
                        let path_in_vcs = path
                            .parent()
                            .and_then(|p| p.to_str())
                            .unwrap_or("")
                            .replace("\\", "/");
                        return Ok(Some(VcsInfo {
                            git: git(p, src_files, &repo)?,
                            path_in_vcs,
                        }));
                    }
                }
                config.shell().verbose(|shell| {
                    shell.warn(format!(
                        "No (git) Cargo.toml found at `{}` in workdir `{}`",
                        path.display(),
                        workdir.display()
                    ))
                })?;
            }
        } else {
            config.shell().verbose(|shell| {
                shell.warn(format!("No (git) VCS found for `{}`", p.root().display()))
            })?;
        }

        // No VCS with a checked in `Cargo.toml` found, so we don't know if the
        // directory is dirty or not, thus we have to assume that it's clean.
        return Ok(None);

        fn git(p: &Package, src_files: &[PathBuf], repo: &git2::Repository) -> CargoResult<GitVcsInfo> {
            // This is a collection of any dirty or untracked files. This covers:
            // - new/modified/deleted/renamed/type change (index or worktree)
            // - untracked files (which are "new" worktree files)
            // - ignored (in case the user has an `include` directive that
            //   conflicts with .gitignore).
            let mut dirty_files = Vec::new();
            collect_statuses(repo, &mut dirty_files)?;
            // Include each submodule so that the error message can provide
            // specifically *which* files in a submodule are modified.
            status_submodules(repo, &mut dirty_files)?;

            // Find the intersection of dirty in git, and the src_files that would
            // be packaged. This is a lazy n^2 check, but seems fine with
            // thousands of files.
            let dirty_src_files: Vec<String> = src_files
                .iter()
                .filter(|src_file| dirty_files.iter().any(|path| src_file.starts_with(path)))
                .map(|path| {
                    path.strip_prefix(p.root())
                        .unwrap_or(path)
                        .display()
                        .to_string()
                })
                .collect();
            if dirty_src_files.is_empty() {
                let rev_obj = repo.revparse_single("HEAD")?;
                Ok(GitVcsInfo {
                    sha1: rev_obj.id().to_string(),
                })
            } else {
                anyhow::bail!(
                    "{} files in the working directory contain changes that were \
                     not yet committed into git:\n\n{}\n\n\
                     to proceed despite this and include the uncommitted changes, pass the `--allow-dirty` flag",
                    dirty_src_files.len(),
                    dirty_src_files.join("\n")
                )
            }
        }

        // Helper to collect dirty statuses for a single repo.
        fn collect_statuses(
            repo: &git2::Repository,
            dirty_files: &mut Vec<PathBuf>,
        ) -> CargoResult<()> {
            let mut status_opts = git2::StatusOptions::new();
            // Exclude submodules, as they are being handled manually by recursing
            // into each one so that details about specific files can be
            // retrieved.
            status_opts
                .exclude_submodules(true)
                .include_ignored(true)
                .include_untracked(true);
            let repo_statuses = repo.statuses(Some(&mut status_opts)).with_context(|| {
                format!(
                    "failed to retrieve git status from repo {}",
                    repo.path().display()
                )
            })?;
            let workdir = repo.workdir().unwrap();
            let this_dirty = repo_statuses.iter().filter_map(|entry| {
                let path = entry.path().expect("valid utf-8 path");
                if path.ends_with("Cargo.lock") && entry.status() == git2::Status::IGNORED {
                    // It is OK to include Cargo.lock even if it is ignored.
                    return None;
                }
                // Use an absolute path, so that comparing paths is easier
                // (particularly with submodules).
                Some(workdir.join(path))
            });
            dirty_files.extend(this_dirty);
            Ok(())
        }

        // Helper to collect dirty statuses while recursing into submodules.
        fn status_submodules(
            repo: &git2::Repository,
            dirty_files: &mut Vec<PathBuf>,
        ) -> CargoResult<()> {
            for submodule in repo.submodules()? {
                // Ignore submodules that don't open, they are probably not initialized.
                // If its files are required, then the verification step should fail.
                if let Ok(sub_repo) = submodule.open() {
                    status_submodules(&sub_repo, dirty_files)?;
                    collect_statuses(&sub_repo, dirty_files)?;
                }
            }
            Ok(())
        }
    }

    /// Compresses and packages a list of [`ArchiveFile`]s and writes into the given file.
    ///
    /// Returns the uncompressed size of the contents of the new archive file.
    fn tar(
        ws: &Workspace<'_>,
        pkg: &Package,
        ar_files: Vec<ArchiveFile>,
        dst: &File,
        filename: &str,
    ) -> CargoResult<u64> {
        // Prepare the encoder and its header.
        let filename = Path::new(filename);
        let encoder = GzBuilder::new()
            .filename(paths::path2bytes(filename)?)
            .write(dst, Compression::best());

        // Put all package files into a compressed archive.
        let mut ar = Builder::new(encoder);
        let config = ws.config();

        let base_name = format!("{}-{}", pkg.name(), pkg.version());
        let base_path = Path::new(&base_name);

        let mut uncompressed_size = 0;
        for ar_file in ar_files {
            let ArchiveFile {
                rel_path,
                rel_str,
                contents,
            } = ar_file;
            let ar_path = base_path.join(&rel_path);
            config
                .shell()
                .verbose(|shell| shell.status("Archiving", &rel_str))?;
            let mut header = Header::new_gnu();
            match contents {
                FileContents::OnDisk(disk_path) => {
                    let mut file = File::open(&disk_path).with_context(|| {
                        format!("failed to open for archiving: `{}`", disk_path.display())
                    })?;
                    let metadata = file.metadata().with_context(|| {
                        format!("could not learn metadata for: `{}`", disk_path.display())
                    })?;
                    header.set_metadata_in_mode(&metadata, HeaderMode::Deterministic);
                    header.set_cksum();
                    ar.append_data(&mut header, &ar_path, &mut file)
                        .with_context(|| {
                            format!("could not archive source file `{}`", disk_path.display())
                        })?;
                    uncompressed_size += metadata.len() as u64;
                }
                FileContents::Generated(generated_kind) => {
                    let contents = match generated_kind {
                        GeneratedFile::Manifest => pkg.to_registry_toml(ws)?,
                        GeneratedFile::Lockfile => build_lock(ws, pkg)?,
                        GeneratedFile::VcsInfo(ref s) => serde_json::to_string_pretty(s)?,
                    };
                    header.set_entry_type(EntryType::file());
                    header.set_mode(0o644);
                    header.set_size(contents.len() as u64);
                    // use something nonzero to avoid rust-lang/cargo#9512
                    header.set_mtime(1);
                    header.set_cksum();
                    ar.append_data(&mut header, &ar_path, contents.as_bytes())
                        .with_context(|| format!("could not archive source file `{}`", rel_str))?;
                    uncompressed_size += contents.len() as u64;
                }
            }
        }

        let encoder = ar.into_inner()?;
        encoder.finish()?;
        Ok(uncompressed_size)
    }

    /// Generate warnings when packaging Cargo.lock, and the resolve have changed.
    fn compare_resolve(
        config: &Config,
        current_pkg: &Package,
        orig_resolve: &Resolve,
        new_resolve: &Resolve,
    ) -> CargoResult<()> {
        if config.shell().verbosity() != Verbosity::Verbose {
            return Ok(());
        }
        let new_set: BTreeSet<PackageId> = new_resolve.iter().collect();
        let orig_set: BTreeSet<PackageId> = orig_resolve.iter().collect();
        let added = new_set.difference(&orig_set);
        // Removed entries are ignored, this is used to quickly find hints for why
        // an entry changed.
        let removed: Vec<&PackageId> = orig_set.difference(&new_set).collect();
        for pkg_id in added {
            if pkg_id.name() == current_pkg.name() && pkg_id.version() == current_pkg.version() {
                // Skip the package that is being created, since its SourceId
                // (directory) changes.
                continue;
            }
            // Check for candidates where the source has changed (such as [patch]
            // or a dependency with multiple sources like path/version).
            let removed_candidates: Vec<&PackageId> = removed
                .iter()
                .filter(|orig_pkg_id| {
                    orig_pkg_id.name() == pkg_id.name() && orig_pkg_id.version() == pkg_id.version()
                })
                .cloned()
                .collect();
            let extra = match removed_candidates.len() {
                0 => {
                    // This can happen if the original was out of date.
                    let previous_versions: Vec<&PackageId> = removed
                        .iter()
                        .filter(|orig_pkg_id| orig_pkg_id.name() == pkg_id.name())
                        .cloned()
                        .collect();
                    match previous_versions.len() {
                        0 => String::new(),
                        1 => format!(
                            ", previous version was `{}`",
                            previous_versions[0].version()
                        ),
                        _ => format!(
                            ", previous versions were: {}",
                            previous_versions
                                .iter()
                                .map(|pkg_id| format!("`{}`", pkg_id.version()))
                                .collect::<Vec<_>>()
                                .join(", ")
                        ),
                    }
                }
                1 => {
                    // This can happen for multi-sourced dependencies like
                    // `{path="...", version="..."}` or `[patch]` replacement.
                    // `[replace]` is not captured in Cargo.lock.
                    format!(
                        ", was originally sourced from `{}`",
                        removed_candidates[0].source_id()
                    )
                }
                _ => {
                    // I don't know if there is a way to actually trigger this,
                    // but handle it just in case.
                    let comma_list = removed_candidates
                        .iter()
                        .map(|pkg_id| format!("`{}`", pkg_id.source_id()))
                        .collect::<Vec<_>>()
                        .join(", ");
                    format!(
                        ", was originally sourced from one of these sources: {}",
                        comma_list
                    )
                }
            };
            let msg = format!(
                "package `{}` added to the packaged Cargo.lock file{}",
                pkg_id, extra
            );
            config.shell().note(msg)?;
        }
        Ok(())
    }

    pub fn check_yanked(
        config: &Config,
        pkg_set: &PackageSet<'_>,
        resolve: &Resolve,
        hint: &str,
    ) -> CargoResult<()> {
        // Checking the yanked status involves taking a look at the registry and
        // maybe updating files, so be sure to lock it here.
        let _lock = config.acquire_package_cache_lock()?;

        let mut sources = pkg_set.sources_mut();
        let mut pending: Vec<PackageId> = resolve.iter().collect();
        let mut results = Vec::new();
        for (_id, source) in sources.sources_mut() {
            source.invalidate_cache();
        }
        while !pending.is_empty() {
            pending.retain(|pkg_id| {
                if let Some(source) = sources.get_mut(pkg_id.source_id()) {
                    match source.is_yanked(*pkg_id) {
                        Poll::Ready(result) => results.push((*pkg_id, result)),
                        Poll::Pending => return true,
                    }
                }
                false
            });
            for (_id, source) in sources.sources_mut() {
                source.block_until_ready()?;
            }
        }

        for (pkg_id, is_yanked) in results {
            if is_yanked? {
                config.shell().warn(format!(
                    "package `{}` in Cargo.lock is yanked in registry `{}`, {}",
                    pkg_id,
                    pkg_id.source_id().display_registry_name(),
                    hint
                ))?;
            }
        }
        Ok(())
    }

    fn run_verify(
        ws: &Workspace<'_>,
        pkg: &Package,
        tar: &FileLock,
        opts: &PackageOpts<'_>,
    ) -> CargoResult<()> {
        let config = ws.config();

        config.shell().status("Verifying", pkg)?;

        let f = GzDecoder::new(tar.file());
        let dst = tar
            .parent()
            .join(&format!("{}-{}", pkg.name(), pkg.version()));
        if dst.exists() {
            paths::remove_dir_all(&dst)?;
        }
        let mut archive = Archive::new(f);
        // We don't need to set the Modified Time, as it's not relevant to verification
        // and it errors on filesystems that don't support setting a modified timestamp
        archive.set_preserve_mtime(false);
        archive.unpack(dst.parent().unwrap())?;

        // Manufacture an ephemeral workspace to ensure that even if the top-level
        // package has a workspace we can still build our new crate.
        let id = SourceId::for_path(&dst)?;
        let mut src = PathSource::new(&dst, id, ws.config());
        let new_pkg = src.root_package()?;
        let pkg_fingerprint = hash_all(&dst)?;
        let ws = Workspace::ephemeral(new_pkg, config, None, true)?;

        let rustc_args = if pkg
            .manifest()
            .unstable_features()
            .require(Feature::public_dependency())
            .is_ok()
        {
            // FIXME: Turn this on at some point in the future
            //Some(vec!["-D exported_private_dependencies".to_string()])
            Some(vec![])
        } else {
            None
        };

        let exec: Arc<dyn Executor> = Arc::new(DefaultExecutor);
        ops::compile_with_exec(
            &ws,
            &ops::CompileOptions {
                build_config: BuildConfig::new(
                    config,
                    opts.jobs,
                    opts.keep_going,
                    &opts.targets,
                    CompileMode::Build,
                )?,
                cli_features: opts.cli_features.clone(),
                spec: ops::Packages::Packages(Vec::new()),
                filter: ops::CompileFilter::Default {
                    required_features_filterable: true,
                },
                target_rustdoc_args: None,
                target_rustc_args: rustc_args,
                target_rustc_crate_types: None,
                rustdoc_document_private_items: false,
                honor_rust_version: true,
            },
            &exec,
        )?;

        // Check that `build.rs` didn't modify any files in the `src` directory.
        let ws_fingerprint = hash_all(&dst)?;
        if pkg_fingerprint != ws_fingerprint {
            let changes = report_hash_difference(&pkg_fingerprint, &ws_fingerprint);
            anyhow::bail!(
                "Source directory was modified by build.rs during cargo publish. \
                 Build scripts should not modify anything outside of OUT_DIR.\n\
                 {}\n\n\
                 To proceed despite this, pass the `--no-verify` flag.",
                changes
            )
        }

        Ok(())
    }

    fn hash_all(path: &Path) -> CargoResult<HashMap<PathBuf, u64>> {
        fn wrap(path: &Path) -> CargoResult<HashMap<PathBuf, u64>> {
            let mut result = HashMap::new();
            let walker = walkdir::WalkDir::new(path).into_iter();
            for entry in walker.filter_entry(|e| !(e.depth() == 1 && e.file_name() == "target")) {
                let entry = entry?;
                let file_type = entry.file_type();
                if file_type.is_file() {
                    let file = File::open(entry.path())?;
                    let hash = util::hex::hash_u64_file(&file)?;
                    result.insert(entry.path().to_path_buf(), hash);
                } else if file_type.is_symlink() {
                    let hash = util::hex::hash_u64(&fs::read_link(entry.path())?);
                    result.insert(entry.path().to_path_buf(), hash);
                } else if file_type.is_dir() {
                    let hash = util::hex::hash_u64(&());
                    result.insert(entry.path().to_path_buf(), hash);
                }
            }
            Ok(result)
        }
        let result = wrap(path).with_context(|| format!("failed to verify output at {:?}", path))?;
        Ok(result)
    }

    fn report_hash_difference(orig: &HashMap<PathBuf, u64>, after: &HashMap<PathBuf, u64>) -> String {
        let mut changed = Vec::new();
        let mut removed = Vec::new();
        for (key, value) in orig {
            match after.get(key) {
                Some(after_value) => {
                    if value != after_value {
                        changed.push(key.to_string_lossy());
                    }
                }
                None => removed.push(key.to_string_lossy()),
            }
        }
        let mut added: Vec<_> = after
            .keys()
            .filter(|key| !orig.contains_key(*key))
            .map(|key| key.to_string_lossy())
            .collect();
        let mut result = Vec::new();
        if !changed.is_empty() {
            changed.sort_unstable();
            result.push(format!("Changed: {}", changed.join("\n\t")));
        }
        if !added.is_empty() {
            added.sort_unstable();
            result.push(format!("Added: {}", added.join("\n\t")));
        }
        if !removed.is_empty() {
            removed.sort_unstable();
            result.push(format!("Removed: {}", removed.join("\n\t")));
        }
        assert!(!result.is_empty(), "unexpected empty change detection");
        result.join("\n")
    }

    // It can often be the case that files of a particular name on one platform
    // can't actually be created on another platform. For example files with colons
    // in the name are allowed on Unix but not on Windows.
    //
    // To help out in situations like this, issue about weird filenames when
    // packaging as a "heads up" that something may not work on other platforms.
    fn check_filename(file: &Path, shell: &mut Shell) -> CargoResult<()> {
        let name = match file.file_name() {
            Some(name) => name,
            None => return Ok(()),
        };
        let name = match name.to_str() {
            Some(name) => name,
            None => anyhow::bail!(
                "path does not have a unicode filename which may not unpack \
                 on all platforms: {}",
                file.display()
            ),
        };
        let bad_chars = ['/', '\\', '<', '>', ':', '"', '|', '?', '*'];
        if let Some(c) = bad_chars.iter().find(|c| name.contains(**c)) {
            anyhow::bail!(
                "cannot package a filename with a special character `{}`: {}",
                c,
                file.display()
            )
        }
        if restricted_names::is_windows_reserved_path(file) {
            shell.warn(format!(
                "file {} is a reserved Windows filename, \
                    it will not work on Windows platforms",
                file.display()
            ))?;
        }
        Ok(())
    }