    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

    //! Interacts with the registry [publish API][1].
    //!
    //! [1]: https://doc.rust-lang.org/nightly/cargo/reference/registry-web-api.html#publish

    use std::collections::BTreeMap;
    use std::collections::BTreeSet;
    use std::collections::HashSet;
    use std::fs::File;
    use std::time::Duration;

    use anyhow::bail;
    use anyhow::Context as _;
    use cargo_credential::Operation;
    use cargo_credential::Secret;
    use cargo_util::paths;
    use crates_io::NewCrate;
    use crates_io::NewCrateDependency;
    use crates_io::Registry;

    use crate::core::dependency::DepKind;
    use crate::core::manifest::ManifestMetadata;
    use crate::core::resolver::CliFeatures;
    use crate::core::Dependency;
    use crate::core::FeatureValue;
    use crate::core::Package;
    use crate::core::PackageIdSpecQuery;
    use crate::core::SourceId;
    use crate::core::Workspace;
    use crate::ops;
    use crate::ops::PackageOpts;
    use crate::ops::Packages;
    use crate::sources::source::QueryKind;
    use crate::sources::SourceConfigMap;
    use crate::sources::CRATES_IO_REGISTRY;
    use crate::util::auth;
    use crate::util::cache_lock::CacheLockMode;
    use crate::util::context::JobsConfig;
    use crate::util::interning::InternedString;
    use crate::util::Progress;
    use crate::util::ProgressStyle;
    use crate::CargoResult;
    use crate::GlobalContext;

    use super::super::check_dep_has_version;
    use super::RegistryOrIndex;

    pub struct PublishOpts<'gctx> {
        pub gctx: &'gctx GlobalContext,
        pub token: Option<Secret<String>>,
        pub reg_or_index: Option<RegistryOrIndex>,
        pub verify: bool,
        pub allow_dirty: bool,
        pub jobs: Option<JobsConfig>,
        pub keep_going: bool,
        pub to_publish: ops::Packages,
        pub targets: Vec<String>,
        pub dry_run: bool,
        pub cli_features: CliFeatures,
    }

    pub fn publish(ws: &Workspace<'_>, opts: &PublishOpts<'_>) -> CargoResult<()> {
        let specs = opts.to_publish.to_package_id_specs(ws)?;
        if specs.len() > 1 {
            bail!("the `-p` argument must be specified to select a single package to publish")
        }
        if Packages::Default == opts.to_publish && ws.is_virtual() {
            bail!("the `-p` argument must be specified in the root of a virtual workspace")
        }
        let member_ids = ws.members().map(|p| p.package_id());
        // Check that the spec matches exactly one member.
        specs[0].query(member_ids)?;
        let mut pkgs = ws.members_with_features(&specs, &opts.cli_features)?;
        // In `members_with_features_old`, it will add "current" package (determined by the cwd)
        // So we need filter
        pkgs = pkgs
            .into_iter()
            .filter(|(m, _)| specs.iter().any(|spec| spec.matches(m.package_id())))
            .collect();
        // Double check. It is safe theoretically, unless logic has updated.
        assert_eq!(pkgs.len(), 1);

        let (pkg, cli_features) = pkgs.pop().unwrap();

        let mut publish_registry = match opts.reg_or_index.as_ref() {
            Some(RegistryOrIndex::Registry(registry)) => Some(registry.clone()),
            _ => None,
        };
        if let Some(ref allowed_registries) = *pkg.publish() {
            if publish_registry.is_none() && allowed_registries.len() == 1 {
                // If there is only one allowed registry, push to that one directly,
                // even though there is no registry specified in the command.
                let default_registry = &allowed_registries[0];
                if default_registry != CRATES_IO_REGISTRY {
                    // Don't change the registry for crates.io and don't warn the user.
                    // crates.io will be defaulted even without this.
                    opts.gctx.shell().note(&format!(
                        "found `{}` as only allowed registry. Publishing to it automatically.",
                        default_registry
                    ))?;
                    publish_registry = Some(default_registry.clone());
                }
            }

            let reg_name = publish_registry
                .clone()
                .unwrap_or_else(|| CRATES_IO_REGISTRY.to_string());
            if allowed_registries.is_empty() {
                bail!(
                    "`{}` cannot be published.\n\
                     `package.publish` must be set to `true` or a non-empty list in Cargo.toml to publish.",
                    pkg.name(),
                );
            } else if !allowed_registries.contains(&reg_name) {
                bail!(
                    "`{}` cannot be published.\n\
                     The registry `{}` is not listed in the `package.publish` value in Cargo.toml.",
                    pkg.name(),
                    reg_name
                );
            }
        }
        // This is only used to confirm that we can create a token before we build the package.
        // This causes the credential provider to be called an extra time, but keeps the same order of errors.
        let ver = pkg.version().to_string();
        let operation = Operation::Read;

        let reg_or_index = match opts.reg_or_index.clone() {
            Some(RegistryOrIndex::Registry(_)) | None => {
                publish_registry.map(RegistryOrIndex::Registry)
            }
            val => val,
        };
        let (mut registry, reg_ids) = super::registry(
            opts.gctx,
            opts.token.as_ref().map(Secret::as_deref),
            reg_or_index.as_ref(),
            true,
            Some(operation).filter(|_| !opts.dry_run),
        )?;
        verify_dependencies(pkg, &registry, reg_ids.original)?;

        // Prepare a tarball, with a non-suppressible warning if metadata
        // is missing since this is being put online.
        let tarball = ops::package_one(
            ws,
            pkg,
            &PackageOpts {
                gctx: opts.gctx,
                verify: opts.verify,
                list: false,
                check_metadata: true,
                allow_dirty: opts.allow_dirty,
                to_package: Packages::Default,
                targets: opts.targets.clone(),
                jobs: opts.jobs.clone(),
                keep_going: opts.keep_going,
                cli_features,
            },
        )?
        .unwrap();

        if !opts.dry_run {
            let hash = cargo_util::Sha256::new()
                .update_file(tarball.file())?
                .finish_hex();
            let operation = Operation::Publish {
                name: pkg.name().as_str(),
                vers: &ver,
                cksum: &hash,
            };
            registry.set_token(Some(auth::auth_token(
                &opts.gctx,
                &reg_ids.original,
                None,
                operation,
                vec![],
                false,
            )?));
        }

        opts.gctx
            .shell()
            .status("Uploading", pkg.package_id().to_string())?;
        transmit(
            opts.gctx,
            pkg,
            tarball.file(),
            &mut registry,
            reg_ids.original,
            opts.dry_run,
        )?;
        if !opts.dry_run {
            const DEFAULT_TIMEOUT: u64 = 60;
            let timeout = if opts.gctx.cli_unstable().publish_timeout {
                let timeout: Option<u64> = opts.gctx.get("publish.timeout")?;
                timeout.unwrap_or(DEFAULT_TIMEOUT)
            } else {
                DEFAULT_TIMEOUT
            };
            if 0 < timeout {
                let timeout = Duration::from_secs(timeout);
                wait_for_publish(opts.gctx, reg_ids.original, pkg, timeout)?;
            }
        }

        Ok(())
    }

    fn wait_for_publish(
        gctx: &GlobalContext,
        registry_src: SourceId,
        pkg: &Package,
        timeout: Duration,
    ) -> CargoResult<()> {
        let version_req = format!("={}", pkg.version());
        let mut source = SourceConfigMap::empty(gctx)?.load(registry_src, &HashSet::new())?;
        // Disable the source's built-in progress bars. Repeatedly showing a bunch
        // of independent progress bars can be a little confusing. There is an
        // overall progress bar managed here.
        source.set_quiet(true);
        let source_description = source.source_id().to_string();
        let query = Dependency::parse(pkg.name(), Some(&version_req), registry_src)?;

        let now = std::time::Instant::now();
        let sleep_time = Duration::from_secs(1);
        let max = timeout.as_secs() as usize;
        // Short does not include the registry name.
        let short_pkg_description = format!("{} v{}", pkg.name(), pkg.version());
        gctx.shell().status(
            "Uploaded",
            format!("{short_pkg_description} to {source_description}"),
        )?;
        gctx.shell().note(format!(
            "waiting for `{short_pkg_description}` to be available at {source_description}.\n\
            You may press ctrl-c to skip waiting; the crate should be available shortly."
        ))?;
        let mut progress = Progress::with_style("Waiting", ProgressStyle::Ratio, gctx);
        progress.tick_now(0, max, "")?;
        let is_available = loop {
            {
                let _lock = gctx.acquire_package_cache_lock(CacheLockMode::DownloadExclusive)?;
                // Force re-fetching the source
                //
                // As pulling from a git source is expensive, we track when we've done it within the
                // process to only do it once, but we are one of the rare cases that needs to do it
                // multiple times
                gctx.updated_sources().remove(&source.replaced_source_id());
                source.invalidate_cache();
                let summaries = loop {
                    // Exact to avoid returning all for path/git
                    match source.query_vec(&query, QueryKind::Exact) {
                        std::task::Poll::Ready(res) => {
                            break res?;
                        }
                        std::task::Poll::Pending => source.block_until_ready()?,
                    }
                };
                if !summaries.is_empty() {
                    break true;
                }
            }

            let elapsed = now.elapsed();
            if timeout < elapsed {
                gctx.shell().warn(format!(
                    "timed out waiting for `{short_pkg_description}` to be available in {source_description}",
                ))?;
                gctx.shell().note(
                    "the registry may have a backlog that is delaying making the \
                    crate available. The crate should be available soon.",
                )?;
                break false;
            }

            progress.tick_now(elapsed.as_secs() as usize, max, "")?;
            std::thread::sleep(sleep_time);
        };
        if is_available {
            gctx.shell().status(
                "Published",
                format!("{short_pkg_description} at {source_description}"),
            )?;
        }

        Ok(())
    }

    fn verify_dependencies(
        pkg: &Package,
        registry: &Registry,
        registry_src: SourceId,
    ) -> CargoResult<()> {
        for dep in pkg.dependencies().iter() {
            if check_dep_has_version(dep, true)? {
                continue;
            }
            // TomlManifest::prepare_for_publish will rewrite the dependency
            // to be just the `version` field.
            if dep.source_id() != registry_src {
                if !dep.source_id().is_registry() {
                    // Consider making SourceId::kind a public type that we can
                    // exhaustively match on. Using match can help ensure that
                    // every kind is properly handled.
                    panic!("unexpected source kind for dependency {:?}", dep);
                }
                // Block requests to send to crates.io with alt-registry deps.
                // This extra hostname check is mostly to assist with testing,
                // but also prevents someone using `--index` to specify
                // something that points to crates.io.
                if registry_src.is_crates_io() || registry.host_is_crates_io() {
                    bail!("crates cannot be published to crates.io with dependencies sourced from other\n\
                           registries. `{}` needs to be published to crates.io before publishing this crate.\n\
                           (crate `{}` is pulled from {})",
                          dep.package_name(),
                          dep.package_name(),
                          dep.source_id());
                }
            }
        }
        Ok(())
    }

    fn transmit(
        gctx: &GlobalContext,
        pkg: &Package,
        tarball: &File,
        registry: &mut Registry,
        registry_id: SourceId,
        dry_run: bool,
    ) -> CargoResult<()> {
        let deps = pkg
            .dependencies()
            .iter()
            .filter(|dep| {
                // Skip dev-dependency without version.
                dep.is_transitive() || dep.specified_req()
            })
            .map(|dep| {
                // If the dependency is from a different registry, then include the
                // registry in the dependency.
                let dep_registry_id = match dep.registry_id() {
                    Some(id) => id,
                    None => SourceId::crates_io(gctx)?,
                };
                // In the index and Web API, None means "from the same registry"
                // whereas in Cargo.toml, it means "from crates.io".
                let dep_registry = if dep_registry_id != registry_id {
                    Some(dep_registry_id.url().to_string())
                } else {
                    None
                };

                Ok(NewCrateDependency {
                    optional: dep.is_optional(),
                    default_features: dep.uses_default_features(),
                    name: dep.package_name().to_string(),
                    features: dep.features().iter().map(|s| s.to_string()).collect(),
                    version_req: dep.version_req().to_string(),
                    target: dep.platform().map(|s| s.to_string()),
                    kind: match dep.kind() {
                        DepKind::Normal => "normal",
                        DepKind::Build => "build",
                        DepKind::Development => "dev",
                    }
                    .to_string(),
                    registry: dep_registry,
                    explicit_name_in_toml: dep.explicit_name_in_toml().map(|s| s.to_string()),
                    artifact: dep.artifact().map(|artifact| {
                        artifact
                            .kinds()
                            .iter()
                            .map(|x| x.as_str().into_owned())
                            .collect()
                    }),
                    bindep_target: dep.artifact().and_then(|artifact| {
                        artifact.target().map(|target| target.as_str().to_owned())
                    }),
                    lib: dep.artifact().map_or(false, |artifact| artifact.is_lib()),
                })
            })
            .collect::<CargoResult<Vec<NewCrateDependency>>>()?;
        let manifest = pkg.manifest();
        let ManifestMetadata {
            ref authors,
            ref description,
            ref homepage,
            ref documentation,
            ref keywords,
            ref readme,
            ref repository,
            ref license,
            ref license_file,
            ref categories,
            ref badges,
            ref links,
            ref rust_version,
        } = *manifest.metadata();
        let rust_version = rust_version.as_ref().map(ToString::to_string);
        let readme_content = readme
            .as_ref()
            .map(|readme| {
                paths::read(&pkg.root().join(readme))
                    .with_context(|| format!("failed to read `readme` file for package `{}`", pkg))
            })
            .transpose()?;
        if let Some(ref file) = *license_file {
            if !pkg.root().join(file).exists() {
                bail!("the license file `{}` does not exist", file)
            }
        }

        // Do not upload if performing a dry run
        if dry_run {
            gctx.shell().warn("aborting upload due to dry run")?;
            return Ok(());
        }

        let deps_set = deps
            .iter()
            .map(|dep| dep.name.clone())
            .collect::<BTreeSet<String>>();

        let string_features = match manifest.resolved_toml().features() {
            Some(features) => features
                .iter()
                .map(|(feat, values)| {
                    (
                        feat.to_string(),
                        values
                            .iter()
                            .filter(|fv| {
                                let feature_value = FeatureValue::new(InternedString::new(fv));
                                match feature_value {
                                    FeatureValue::Dep { dep_name }
                                    | FeatureValue::DepFeature { dep_name, .. } => {
                                        deps_set.contains(&dep_name.to_string())
                                    }
                                    _ => true,
                                }
                            })
                            .map(|fv| fv.to_string())
                            .collect(),
                    )
                })
                .collect::<BTreeMap<String, Vec<String>>>(),
            None => BTreeMap::new(),
        };

        let warnings = registry
            .publish(
                &NewCrate {
                    name: pkg.name().to_string(),
                    vers: pkg.version().to_string(),
                    deps,
                    features: string_features,
                    authors: authors.clone(),
                    description: description.clone(),
                    homepage: homepage.clone(),
                    documentation: documentation.clone(),
                    keywords: keywords.clone(),
                    categories: categories.clone(),
                    readme: readme_content,
                    readme_file: readme.clone(),
                    repository: repository.clone(),
                    license: license.clone(),
                    license_file: license_file.clone(),
                    badges: badges.clone(),
                    links: links.clone(),
                    rust_version,
                },
                tarball,
            )
            .with_context(|| format!("failed to publish to registry at {}", registry.host()))?;

        if !warnings.invalid_categories.is_empty() {
            let msg = format!(
                "the following are not valid category slugs and were \
                 ignored: {}. Please see https://crates.io/category_slugs \
                 for the list of all category slugs. \
                 ",
                warnings.invalid_categories.join(", ")
            );
            gctx.shell().warn(&msg)?;
        }

        if !warnings.invalid_badges.is_empty() {
            let msg = format!(
                "the following are not valid badges and were ignored: {}. \
                 Either the badge type specified is unknown or a required \
                 attribute is missing. Please see \
                 https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata \
                 for valid badge types and their required attributes.",
                warnings.invalid_badges.join(", ")
            );
            gctx.shell().warn(&msg)?;
        }

        if !warnings.other.is_empty() {
            for msg in warnings.other {
                gctx.shell().warn(&msg)?;
            }
        }

        Ok(())
    }