    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

    use std::collections::HashSet;
    use std::fmt::{self, Debug, Formatter};
    use std::path::{Path, PathBuf};
    use std::task::Poll;

    use crate::core::source::MaybePackage;
    use crate::core::{Dependency, Package, PackageId, QueryKind, Source, SourceId, Summary};
    use crate::ops;
    use crate::util::{internal, CargoResult, Config};
    use anyhow::Context as _;
    use cargo_util::paths;
    use filetime::FileTime;
    use ignore::gitignore::GitignoreBuilder;
    use log::{trace, warn};
    use walkdir::WalkDir;

    /// A source represents one or multiple packages gathering from a given root
    /// path on the filesystem.
    ///
    /// It's the cornerstone of every other source --- other implementations
    /// eventually need to call `PathSource` to read local packages somewhere on
    /// the filesystem.
    ///
    /// It also provides convenient methods like [`PathSource::list_files`] to
    /// list all files in a package, given its ability to walk the filesystem.
    pub struct PathSource<'cfg> {
        /// The unique identifier of this source.
        source_id: SourceId,
        /// The root path of this source.
        path: PathBuf,
        /// Whether this source has updated all package informations it may contain.
        updated: bool,
        /// Packages that this sources has discovered.
        packages: Vec<Package>,
        /// Whether this source should discover nested packages recursively.
        /// See [`PathSource::new_recursive`] for more.
        recursive: bool,
        config: &'cfg Config,
    }

    impl<'cfg> PathSource<'cfg> {
        /// Invoked with an absolute path to a directory that contains a `Cargo.toml`.
        ///
        /// This source will only return the package at precisely the `path`
        /// specified, and it will be an error if there's not a package at `path`.
        pub fn new(path: &Path, source_id: SourceId, config: &'cfg Config) -> PathSource<'cfg> {
            PathSource {
                source_id,
                path: path.to_path_buf(),
                updated: false,
                packages: Vec::new(),
                config,
                recursive: false,
            }
        }

        /// Creates a new source which is walked recursively to discover packages.
        ///
        /// This is similar to the [`PathSource::new`] method except that instead
        /// of requiring a valid package to be present at `root` the folder is
        /// walked entirely to crawl for packages.
        ///
        /// Note that this should be used with care and likely shouldn't be chosen
        /// by default!
        pub fn new_recursive(root: &Path, id: SourceId, config: &'cfg Config) -> PathSource<'cfg> {
            PathSource {
                recursive: true,
                ..PathSource::new(root, id, config)
            }
        }

        /// Preloads a package for this source. The source is assumed that it has
        /// yet loaded any other packages.
        pub fn preload_with(&mut self, pkg: Package) {
            assert!(!self.updated);
            assert!(!self.recursive);
            assert!(self.packages.is_empty());
            self.updated = true;
            self.packages.push(pkg);
        }

        /// Gets the package on the root path.
        pub fn root_package(&mut self) -> CargoResult<Package> {
            trace!("root_package; source={:?}", self);

            self.update()?;

            match self.packages.iter().find(|p| p.root() == &*self.path) {
                Some(pkg) => Ok(pkg.clone()),
                None => Err(internal(format!(
                    "no package found in source {:?}",
                    self.path
                ))),
            }
        }

        /// Returns the packages discovered by this source. It may walk the
        /// filesystem if package informations haven't yet updated.
        pub fn read_packages(&self) -> CargoResult<Vec<Package>> {
            if self.updated {
                Ok(self.packages.clone())
            } else if self.recursive {
                ops::read_packages(&self.path, self.source_id, self.config)
            } else {
                let path = self.path.join("Cargo.toml");
                let (pkg, _) = ops::read_package(&path, self.source_id, self.config)?;
                Ok(vec![pkg])
            }
        }

        /// List all files relevant to building this package inside this source.
        ///
        /// This function will use the appropriate methods to determine the
        /// set of files underneath this source's directory which are relevant for
        /// building `pkg`.
        ///
        /// The basic assumption of this method is that all files in the directory
        /// are relevant for building this package, but it also contains logic to
        /// use other methods like `.gitignore`, `package.include`, or
        /// `package.exclude` to filter the list of files.
        pub fn list_files(&self, pkg: &Package) -> CargoResult<Vec<PathBuf>> {
            self._list_files(pkg).with_context(|| {
                format!(
                    "failed to determine list of files in {}",
                    pkg.root().display()
                )
            })
        }

        /// See [`PathSource::list_files`].
        fn _list_files(&self, pkg: &Package) -> CargoResult<Vec<PathBuf>> {
            let root = pkg.root();
            let no_include_option = pkg.manifest().include().is_empty();
            let git_repo = if no_include_option {
                self.discover_git_repo(root)?
            } else {
                None
            };

            let mut exclude_builder = GitignoreBuilder::new(root);
            if no_include_option && git_repo.is_none() {
                // no include option and not git repo discovered (see rust-lang/cargo#7183).
                exclude_builder.add_line(None, ".*")?;
            }
            for rule in pkg.manifest().exclude() {
                exclude_builder.add_line(None, rule)?;
            }
            let ignore_exclude = exclude_builder.build()?;

            let mut include_builder = GitignoreBuilder::new(root);
            for rule in pkg.manifest().include() {
                include_builder.add_line(None, rule)?;
            }
            let ignore_include = include_builder.build()?;

            let ignore_should_package = |relative_path: &Path, is_dir: bool| {
                // "Include" and "exclude" options are mutually exclusive.
                if no_include_option {
                    !ignore_exclude
                        .matched_path_or_any_parents(relative_path, is_dir)
                        .is_ignore()
                } else {
                    if is_dir {
                        // Generally, include directives don't list every
                        // directory (nor should they!). Just skip all directory
                        // checks, and only check files.
                        return true;
                    }
                    ignore_include
                        .matched_path_or_any_parents(relative_path, /* is_dir */ false)
                        .is_ignore()
                }
            };

            let filter = |path: &Path, is_dir: bool| {
                let relative_path = match path.strip_prefix(root) {
                    Ok(p) => p,
                    Err(_) => return false,
                };

                let rel = relative_path.as_os_str();
                if rel == "Cargo.lock" {
                    return pkg.include_lockfile();
                } else if rel == "Cargo.toml" {
                    return true;
                }

                ignore_should_package(relative_path, is_dir)
            };

            // Attempt Git-prepopulate only if no `include` (see rust-lang/cargo#4135).
            if no_include_option {
                if let Some(repo) = git_repo {
                    return self.list_files_git(pkg, &repo, &filter);
                }
            }
            self.list_files_walk(pkg, &filter)
        }

        /// Returns `Some(git2::Repository)` if found sibling `Cargo.toml` and `.git`
        /// directory; otherwise, caller should fall back on full file list.
        fn discover_git_repo(&self, root: &Path) -> CargoResult<Option<git2::Repository>> {
            let repo = match git2::Repository::discover(root) {
                Ok(repo) => repo,
                Err(e) => {
                    log::debug!(
                        "could not discover git repo at or above {}: {}",
                        root.display(),
                        e
                    );
                    return Ok(None);
                }
            };
            let index = repo
                .index()
                .with_context(|| format!("failed to open git index at {}", repo.path().display()))?;
            let repo_root = repo.workdir().ok_or_else(|| {
                anyhow::format_err!(
                    "did not expect repo at {} to be bare",
                    repo.path().display()
                )
            })?;
            let repo_relative_path = match paths::strip_prefix_canonical(root, repo_root) {
                Ok(p) => p,
                Err(e) => {
                    log::warn!(
                        "cannot determine if path `{:?}` is in git repo `{:?}`: {:?}",
                        root,
                        repo_root,
                        e
                    );
                    return Ok(None);
                }
            };
            let manifest_path = repo_relative_path.join("Cargo.toml");
            if index.get_path(&manifest_path, 0).is_some() {
                return Ok(Some(repo));
            }
            // Package Cargo.toml is not in git, don't use git to guide our selection.
            Ok(None)
        }

        /// Lists files relevant to building this package inside this source by
        /// consulting both Git index (tracked) or status (untracked) under
        /// a given Git repository.
        ///
        /// This looks into Git submodules as well.
        fn list_files_git(
            &self,
            pkg: &Package,
            repo: &git2::Repository,
            filter: &dyn Fn(&Path, bool) -> bool,
        ) -> CargoResult<Vec<PathBuf>> {
            warn!("list_files_git {}", pkg.package_id());
            let index = repo.index()?;
            let root = repo
                .workdir()
                .ok_or_else(|| anyhow::format_err!("can't list files on a bare repository"))?;
            let pkg_path = pkg.root();

            let mut ret = Vec::<PathBuf>::new();

            // We use information from the Git repository to guide us in traversing
            // its tree. The primary purpose of this is to take advantage of the
            // `.gitignore` and auto-ignore files that don't matter.
            //
            // Here we're also careful to look at both tracked and untracked files as
            // the untracked files are often part of a build and may become relevant
            // as part of a future commit.
            let index_files = index.iter().map(|entry| {
                use libgit2_sys::{GIT_FILEMODE_COMMIT, GIT_FILEMODE_LINK};
                // ``is_dir`` is an optimization to avoid calling
                // ``fs::metadata`` on every file.
                let is_dir = if entry.mode == GIT_FILEMODE_LINK as u32 {
                    // Let the code below figure out if this symbolic link points
                    // to a directory or not.
                    None
                } else {
                    Some(entry.mode == GIT_FILEMODE_COMMIT as u32)
                };
                (join(root, &entry.path), is_dir)
            });
            let mut opts = git2::StatusOptions::new();
            opts.include_untracked(true);
            if let Ok(suffix) = pkg_path.strip_prefix(root) {
                opts.pathspec(suffix);
            }
            let statuses = repo.statuses(Some(&mut opts))?;
            let mut skip_paths = HashSet::new();
            let untracked: Vec<_> = statuses
                .iter()
                .filter_map(|entry| {
                    match entry.status() {
                        // Don't include Cargo.lock if it is untracked. Packaging will
                        // generate a new one as needed.
                        git2::Status::WT_NEW if entry.path() != Some("Cargo.lock") => {
                            Some(Ok((join(root, entry.path_bytes()), None)))
                        }
                        git2::Status::WT_DELETED => {
                            let path = match join(root, entry.path_bytes()) {
                                Ok(p) => p,
                                Err(e) => return Some(Err(e)),
                            };
                            skip_paths.insert(path);
                            None
                        }
                        _ => None,
                    }
                })
                .collect::<CargoResult<_>>()?;

            let mut subpackages_found = Vec::new();

            for (file_path, is_dir) in index_files.chain(untracked) {
                let file_path = file_path?;
                if skip_paths.contains(&file_path) {
                    continue;
                }

                // Filter out files blatantly outside this package. This is helped a
                // bit above via the `pathspec` function call, but we need to filter
                // the entries in the index as well.
                if !file_path.starts_with(pkg_path) {
                    continue;
                }

                match file_path.file_name().and_then(|s| s.to_str()) {
                    // The `target` directory is never included.
                    Some("target") => continue,

                    // Keep track of all sub-packages found and also strip out all
                    // matches we've found so far. Note, though, that if we find
                    // our own `Cargo.toml`, we keep going.
                    Some("Cargo.toml") => {
                        let path = file_path.parent().unwrap();
                        if path != pkg_path {
                            warn!("subpackage found: {}", path.display());
                            ret.retain(|p| !p.starts_with(path));
                            subpackages_found.push(path.to_path_buf());
                            continue;
                        }
                    }

                    _ => {}
                }

                // If this file is part of any other sub-package we've found so far,
                // skip it.
                if subpackages_found.iter().any(|p| file_path.starts_with(p)) {
                    continue;
                }

                // `is_dir` is None for symlinks. The `unwrap` checks if the
                // symlink points to a directory.
                let is_dir = is_dir.unwrap_or_else(|| file_path.is_dir());
                if is_dir {
                    warn!("  found submodule {}", file_path.display());
                    let rel = file_path.strip_prefix(root)?;
                    let rel = rel.to_str().ok_or_else(|| {
                        anyhow::format_err!("invalid utf-8 filename: {}", rel.display())
                    })?;
                    // Git submodules are currently only named through `/` path
                    // separators, explicitly not `\` which windows uses. Who knew?
                    let rel = rel.replace(r"\", "/");
                    match repo.find_submodule(&rel).and_then(|s| s.open()) {
                        Ok(repo) => {
                            let files = self.list_files_git(pkg, &repo, filter)?;
                            ret.extend(files.into_iter());
                        }
                        Err(..) => {
                            self.walk(&file_path, &mut ret, false, filter)?;
                        }
                    }
                } else if filter(&file_path, is_dir) {
                    assert!(!is_dir);
                    // We found a file!
                    warn!("  found {}", file_path.display());
                    ret.push(file_path);
                }
            }
            return Ok(ret);

            #[cfg(unix)]
            fn join(path: &Path, data: &[u8]) -> CargoResult<PathBuf> {
                use std::ffi::OsStr;
                use std::os::unix::prelude::*;
                Ok(path.join(<OsStr as OsStrExt>::from_bytes(data)))
            }
            #[cfg(windows)]
            fn join(path: &Path, data: &[u8]) -> CargoResult<PathBuf> {
                use std::str;
                match str::from_utf8(data) {
                    Ok(s) => Ok(path.join(s)),
                    Err(e) => Err(anyhow::format_err!(
                        "cannot process path in git with a non utf8 filename: {}\n{:?}",
                        e,
                        data
                    )),
                }
            }
        }

        /// Lists files relevant to building this package inside this source by
        /// walking the filesystem from the package root path.
        ///
        /// This is a fallback for [`PathSource::list_files_git`] when the package
        /// is not tracked under a Git repository.
        fn list_files_walk(
            &self,
            pkg: &Package,
            filter: &dyn Fn(&Path, bool) -> bool,
        ) -> CargoResult<Vec<PathBuf>> {
            let mut ret = Vec::new();
            self.walk(pkg.root(), &mut ret, true, filter)?;
            Ok(ret)
        }

        /// Helper recursive function for [`PathSource::list_files_walk`].
        fn walk(
            &self,
            path: &Path,
            ret: &mut Vec<PathBuf>,
            is_root: bool,
            filter: &dyn Fn(&Path, bool) -> bool,
        ) -> CargoResult<()> {
            let walkdir = WalkDir::new(path)
                .follow_links(true)
                .into_iter()
                .filter_entry(|entry| {
                    let path = entry.path();
                    let at_root = is_root && entry.depth() == 0;
                    let is_dir = entry.file_type().is_dir();

                    if !at_root && !filter(path, is_dir) {
                        return false;
                    }

                    if !is_dir {
                        return true;
                    }

                    // Don't recurse into any sub-packages that we have.
                    if !at_root && path.join("Cargo.toml").exists() {
                        return false;
                    }

                    // Skip root Cargo artifacts.
                    if is_root
                        && entry.depth() == 1
                        && path.file_name().and_then(|s| s.to_str()) == Some("target")
                    {
                        return false;
                    }

                    true
                });
            for entry in walkdir {
                match entry {
                    Ok(entry) => {
                        if !entry.file_type().is_dir() {
                            ret.push(entry.into_path());
                        }
                    }
                    Err(err) if err.loop_ancestor().is_some() => {
                        self.config.shell().warn(err)?;
                    }
                    Err(err) => match err.path() {
                        // If an error occurs with a path, filter it again.
                        // If it is excluded, Just ignore it in this case.
                        // See issue rust-lang/cargo#10917
                        Some(path) if !filter(path, path.is_dir()) => {}
                        // Otherwise, simply recover from it.
                        // Don't worry about error skipping here, the callers would
                        // still hit the IO error if they do access it thereafter.
                        Some(path) => ret.push(path.to_path_buf()),
                        None => return Err(err.into()),
                    },
                }
            }

            Ok(())
        }

        /// Gets the last modified file in a package.
        pub fn last_modified_file(&self, pkg: &Package) -> CargoResult<(FileTime, PathBuf)> {
            if !self.updated {
                return Err(internal(format!(
                    "BUG: source `{:?}` was not updated",
                    self.path
                )));
            }

            let mut max = FileTime::zero();
            let mut max_path = PathBuf::new();
            for file in self.list_files(pkg).with_context(|| {
                format!(
                    "failed to determine the most recently modified file in {}",
                    pkg.root().display()
                )
            })? {
                // An `fs::stat` error here is either because path is a
                // broken symlink, a permissions error, or a race
                // condition where this path was `rm`-ed -- either way,
                // we can ignore the error and treat the path's `mtime`
                // as `0`.
                let mtime = paths::mtime(&file).unwrap_or_else(|_| FileTime::zero());
                if mtime > max {
                    max = mtime;
                    max_path = file;
                }
            }
            trace!("last modified file {}: {}", self.path.display(), max);
            Ok((max, max_path))
        }

        /// Returns the root path of this source.
        pub fn path(&self) -> &Path {
            &self.path
        }

        /// Discovers packages inside this source if it hasn't yet done.
        pub fn update(&mut self) -> CargoResult<()> {
            if !self.updated {
                let packages = self.read_packages()?;
                self.packages.extend(packages.into_iter());
                self.updated = true;
            }

            Ok(())
        }
    }

    impl<'cfg> Debug for PathSource<'cfg> {
        fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
            write!(f, "the paths source")
        }
    }

    impl<'cfg> Source for PathSource<'cfg> {
        fn query(
            &mut self,
            dep: &Dependency,
            kind: QueryKind,
            f: &mut dyn FnMut(Summary),
        ) -> Poll<CargoResult<()>> {
            self.update()?;
            for s in self.packages.iter().map(|p| p.summary()) {
                let matched = match kind {
                    QueryKind::Exact => dep.matches(s),
                    QueryKind::Fuzzy => true,
                };
                if matched {
                    f(s.clone())
                }
            }
            Poll::Ready(Ok(()))
        }

        fn supports_checksums(&self) -> bool {
            false
        }

        fn requires_precise(&self) -> bool {
            false
        }

        fn source_id(&self) -> SourceId {
            self.source_id
        }

        fn download(&mut self, id: PackageId) -> CargoResult<MaybePackage> {
            trace!("getting packages; id={}", id);
            self.update()?;
            let pkg = self.packages.iter().find(|pkg| pkg.package_id() == id);
            pkg.cloned()
                .map(MaybePackage::Ready)
                .ok_or_else(|| internal(format!("failed to find {} in path source", id)))
        }

        fn finish_download(&mut self, _id: PackageId, _data: Vec<u8>) -> CargoResult<Package> {
            panic!("no download should have started")
        }

        fn fingerprint(&self, pkg: &Package) -> CargoResult<String> {
            let (max, max_path) = self.last_modified_file(pkg)?;
            // Note that we try to strip the prefix of this package to get a
            // relative path to ensure that the fingerprint remains consistent
            // across entire project directory renames.
            let max_path = max_path.strip_prefix(&self.path).unwrap_or(&max_path);
            Ok(format!("{} ({})", max, max_path.display()))
        }

        fn describe(&self) -> String {
            match self.source_id.url().to_file_path() {
                Ok(path) => path.display().to_string(),
                Err(_) => self.source_id.to_string(),
            }
        }

        fn add_to_yanked_whitelist(&mut self, _pkgs: &[PackageId]) {}

        fn is_yanked(&mut self, _pkg: PackageId) -> Poll<CargoResult<bool>> {
            Poll::Ready(Ok(false))
        }

        fn block_until_ready(&mut self) -> CargoResult<()> {
            self.update()
        }

        fn invalidate_cache(&mut self) {
            // Path source has no local cache.
        }

        fn set_quiet(&mut self, _quiet: bool) {
            // Path source does not display status
        }
    }