mirror of
https://github.com/RubyMetric/chsrc
synced 2026-02-27 01:21:21 +08:00
553 lines
13 KiB
C
553 lines
13 KiB
C
/** ------------------------------------------------------------
|
||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||
* -------------------------------------------------------------
|
||
* File Name : chef.c
|
||
* File Authors : @ccmywish
|
||
* Contributors : @BingChunMoLi
|
||
* Created On : <2025-08-09>
|
||
* Last Modified : <2026-02-24>
|
||
*
|
||
* chef DSL: for chefs (recipe makers) to define a target
|
||
* ------------------------------------------------------------*/
|
||
|
||
#pragma once
|
||
|
||
void
|
||
chef_debug_target (Target_t *target)
|
||
{
|
||
#ifdef XY_DEBUG
|
||
if (!target)
|
||
{
|
||
chsrc_debug2 ("target", "Target is NULL");
|
||
return;
|
||
}
|
||
|
||
say ("DEBUG Target Information:");
|
||
printf (" Aliases: %s\n", target->aliases);
|
||
|
||
printf (" Get Function: %p\n", target->getfn);
|
||
printf (" Set Function: %p\n", target->setfn);
|
||
printf (" Reset Function: %p\n", target->resetfn);
|
||
printf (" Prelude Function: %p\n", target->preludefn);
|
||
|
||
printf (" Inited?: %d\n", target->inited);
|
||
|
||
printf (" Sources: %p\n", target->sources);
|
||
printf (" Sources Count: %d\n", target->sources_n);
|
||
|
||
printf (" Chef: %p\n", target->chef);
|
||
printf (" Cooks: %p\n", target->cooks);
|
||
printf (" Cooks Count: %d\n", target->cooks_n);
|
||
printf (" Sauciers: %p\n", target->sauciers);
|
||
printf (" Sauciers Count: %d\n", target->sauciers_n);
|
||
#endif
|
||
}
|
||
|
||
|
||
void
|
||
chef_debug_contributor (Contributor_t *contributor)
|
||
{
|
||
#ifdef XY_DEBUG
|
||
if (!contributor)
|
||
{
|
||
chsrc_debug2 ("contrib", "Contributor is NULL");
|
||
return;
|
||
}
|
||
|
||
say ("DEBUG Contributor Information:");
|
||
printf (" ID: %s\n", contributor->id);
|
||
printf (" Name: %s\n", contributor->name);
|
||
printf (" Email: %s\n", contributor->email);
|
||
printf (" DisplayName: %s\n", contributor->display_name);
|
||
#endif
|
||
}
|
||
|
||
|
||
/**
|
||
* @brief 登记所有贡献者
|
||
*
|
||
* @param id 贡献者 ID，这个ID最好是GitHub用户名，但也可以不是，只需要在 chsrc 内部进行区分即可
|
||
* @param display_name 如果没有提供该参数，则使用 name
|
||
*/
|
||
void
|
||
chef_register_contributor (char *id, char *name, char *email, char *display_name)
|
||
{
|
||
if (!id || !name || !email)
|
||
xy_unreached();
|
||
|
||
Contributor_t *contributor = xy_malloc0 (sizeof (Contributor_t));
|
||
contributor->id = xy_strdup (id);
|
||
contributor->name = xy_strdup (name);
|
||
contributor->email = xy_strdup (email);
|
||
|
||
if (!display_name)
|
||
contributor->display_name = xy_strdup (name);
|
||
else
|
||
contributor->display_name = xy_strdup (display_name);
|
||
|
||
xy_map_set (ProgStore.contributors, id, contributor);
|
||
}
|
||
|
||
|
||
/**
|
||
* @brief 修改 Provider 的测速地址
|
||
*
|
||
* @note 这个修改的是全局 Provider 里的信息。往往用来设置 UpstreamProvider
|
||
*/
|
||
void
|
||
chef_set_provider_smURL (SourceProvider_t *provider, char *url)
|
||
{
|
||
provider->psmi.skip = NotSkip;
|
||
provider->psmi.url = xy_strdup (url);
|
||
chsrc_debug ("m", xy_strcat (4, "recipe 重新为 ", provider->code, "(镜像站信息本身) 设置测速链接: ", url));
|
||
}
|
||
|
||
|
||
/**
|
||
* @brief 修改 Provider 的测速精度
|
||
*
|
||
* @note 这个修改的是全局 Provider 里的信息。往往用来设置 UpstreamProvider
|
||
*/
|
||
void
|
||
chef_set_provider_sm_accuracy (SourceProvider_t *provider, bool accuracy)
|
||
{
|
||
provider->psmi.accurate = accuracy;
|
||
chsrc_debug ("m", xy_strcat (4, "recipe 重新为 ", provider->code, "(镜像站信息本身) 设置测速精度: ", accuracy ? "精准" : "粗略"));
|
||
}
|
||
|
||
|
||
/**
|
||
* @brief 修改 或 补充 某个镜像站的换源链接，即修改 Source_t.url
|
||
*
|
||
* @example 见 os_ubuntu_resetsrc() 中对非 x86_64 架构源地址的修改
|
||
*/
|
||
void
|
||
chef_set_repoURL (Target_t *target, SourceProvider_t *provider, char *url)
|
||
{
|
||
xy_cant_be_null (target);
|
||
xy_cant_be_null (provider);
|
||
xy_cant_be_null (url);
|
||
|
||
for (int i=0; i < target->sources_n; i++)
|
||
{
|
||
Source_t *src = &target->sources[i];
|
||
SourceProvider_t *p = src->provider;
|
||
if (p == provider)
|
||
{
|
||
src->url = xy_strdup (url);
|
||
return;
|
||
}
|
||
}
|
||
|
||
xy_unreached();
|
||
}
|
||
|
||
|
||
/**
|
||
* @brief 提供一个函数，这个函数基于 "换源链接" 和用户提供的数据来构造和填充精准测速链接
|
||
*/
|
||
void
|
||
chef_set_smURL_with_func (
|
||
Target_t *target,
|
||
SourceProvider_t *provider,
|
||
char *(*func)(const char *url, const char *user_data),
|
||
char *user_data)
|
||
{
|
||
xy_cant_be_null (target);
|
||
xy_cant_be_null (provider);
|
||
xy_cant_be_null (func);
|
||
|
||
for (int i=0; i < target->sources_n; i++)
|
||
{
|
||
Source_t *src = &target->sources[i];
|
||
SourceProvider_t *p = src->provider;
|
||
if (p == provider)
|
||
{
|
||
if (src->url)
|
||
{
|
||
src->speed_measure_url = func (src->url, user_data);
|
||
return;
|
||
}
|
||
else
|
||
{
|
||
chsrc_panic ("该函数基于已有的换源链接来生成测速链接，但该源的换源链接为空");
|
||
}
|
||
}
|
||
}
|
||
|
||
xy_unreached();
|
||
}
|
||
|
||
|
||
/**
|
||
* @brief 给 "换源链接" 增加一个后缀来构造和填充专用测速链接
|
||
*/
|
||
void
|
||
chef_set_smURL_with_postfix (Target_t *target, SourceProvider_t *provider, char *postfix)
|
||
{
|
||
chef_set_smURL_with_func (target, provider, xy_2strcat, postfix);
|
||
}
|
||
|
||
|
||
/**
|
||
* @internal 该函数仅用于实现 chef_set_smURL()
|
||
*/
|
||
char *
|
||
_chef_strdup_2nd_argument (const char *DUMMY, const char *str)
|
||
{
|
||
return xy_strdup (str);
|
||
}
|
||
|
||
/**
|
||
* @breif 设置 或 修改 某个镜像站的 *精准*测速链接，即修改 Source_t.speed_measure_url
|
||
*/
|
||
void
|
||
chef_set_smURL (Target_t *target, SourceProvider_t *provider, char *url)
|
||
{
|
||
chef_set_smURL_with_func (target, provider, _chef_strdup_2nd_argument, url);
|
||
}
|
||
|
||
|
||
/**
|
||
* @brief 针对每一个剩下的还未设置专用测速链接的源，对其 "换源链接" 使用函数 `func` 来生成专用测速链接
|
||
*/
|
||
void
|
||
chef_set_rest_smURL_with_func (
|
||
Target_t *target,
|
||
char *(*func)(const char *url, const char *user_data),
|
||
char *user_data)
|
||
{
|
||
xy_cant_be_null (target);
|
||
|
||
Source_t *sources = target->sources;
|
||
int n = target->sources_n;
|
||
|
||
for (int i=0; i<n; i++)
|
||
{
|
||
Source_t *src = &sources[i];
|
||
ProviderType_t type = src->provider->type;
|
||
if (src->url)
|
||
{
|
||
/* 为空时才修改 或者里面是脏数据 */
|
||
if (NULL==src->speed_measure_url || !hp_is_url (src->speed_measure_url))
|
||
{
|
||
src->speed_measure_url = func (src->url, user_data);
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
|
||
/**
|
||
* @brief 针对每一个剩下的还未设置专用测速链接的源，对其 "换源链接" 增加一个后缀来生成专用测速链接
|
||
*/
|
||
void
|
||
chef_set_rest_smURL_with_postfix (Target_t *target, char *postfix)
|
||
{
|
||
chef_set_rest_smURL_with_func (target, xy_2strcat, postfix);
|
||
}
|
||
|
||
|
||
/**
|
||
* @note 用于: 组中的 item target 在 standalone 模式时正确填充源信息
|
||
*/
|
||
void
|
||
chef_use_other_target_sources (Target_t *this, Target_t *other)
|
||
{
|
||
if (!other->inited)
|
||
{
|
||
if (other->preludefn)
|
||
other->preludefn();
|
||
else
|
||
{
|
||
chef_debug_target (other);
|
||
chsrc_panic ("`other` 未定义 _prelude() !");
|
||
}
|
||
}
|
||
|
||
this->sources = other->sources;
|
||
this->sources_n = other->sources_n;
|
||
}
|
||
|
||
|
||
void
|
||
chef_allow_english (Target_t *target)
|
||
{
|
||
xy_cant_be_null (target);
|
||
target->can_english = true;
|
||
}
|
||
|
||
void
|
||
chef_deny_english (Target_t *target)
|
||
{
|
||
xy_cant_be_null (target);
|
||
target->can_english = false;
|
||
}
|
||
|
||
|
||
/**
|
||
* @brief 设置该 target 的作用域能力
|
||
*/
|
||
void
|
||
chef_set_scope_cap (Target_t *target, Scope_t scope, ScopeCapability_t cap)
|
||
{
|
||
xy_cant_be_null (target);
|
||
|
||
/* 我们在这里固定好索引的位置，而不是直接用 enum 的值，防止以后顺序或者新增枚举值 */
|
||
if (scope == ProjectScope)
|
||
{
|
||
target->scope_caps[ScopeCap_Slot_Project] = cap;
|
||
}
|
||
else if (scope == UserScope)
|
||
{
|
||
target->scope_caps[ScopeCap_Slot_User] = cap;
|
||
}
|
||
else if (scope == SystemScope)
|
||
{
|
||
target->scope_caps[ScopeCap_Slot_System] = cap;
|
||
}
|
||
else
|
||
{
|
||
chsrc_panic ("无效的 scope 参数");
|
||
}
|
||
}
|
||
|
||
|
||
/**
|
||
* @brief 设置该 target 的默认作用域
|
||
*
|
||
* @note 该函数必须在 chef_set_scope_cap() 之后调用，以确保默认作用域的能力已经被明确了
|
||
*/
|
||
void
|
||
chef_set_default_scope (Target_t *target, Scope_t scope)
|
||
{
|
||
xy_cant_be_null (target);
|
||
target->default_scope = scope;
|
||
|
||
ScopeCapability_t cap = ScopeCap_Unknown;
|
||
|
||
if (scope == ProjectScope)
|
||
cap = target->scope_caps[ScopeCap_Slot_Project];
|
||
else if (scope == UserScope)
|
||
cap = target->scope_caps[ScopeCap_Slot_User];
|
||
else if (scope == SystemScope)
|
||
cap = target->scope_caps[ScopeCap_Slot_System];
|
||
|
||
/* 防止 chef 们写错 */
|
||
if (cap != ScopeCap_Able_And_Implemented)
|
||
{
|
||
chsrc_panic ("该作用域未被明确支持，无法设置为默认作用域");
|
||
}
|
||
}
|
||
|
||
|
||
/**
|
||
* @brief 由于操作系统相关的 target 换源都是系统级，所以 scope 都是固定的，我们提供此快捷函数来设置
|
||
*/
|
||
void
|
||
chef_set_os_scope (Target_t *target)
|
||
{
|
||
xy_cant_be_null (target);
|
||
|
||
chef_set_scope_cap (target, ProjectScope, ScopeCap_Unable);
|
||
chef_set_scope_cap (target, UserScope, ScopeCap_Unable);
|
||
chef_set_scope_cap (target, SystemScope, ScopeCap_Able_And_Implemented);
|
||
|
||
chef_set_default_scope (target, SystemScope);
|
||
}
|
||
|
||
|
||
void
|
||
chef_allow_local_mode (Target_t *target, Capability_t cap, const char *explain_zh, const char *explain_en)
|
||
{
|
||
xy_cant_be_null (target);
|
||
|
||
target->cap_local = cap;
|
||
|
||
if (cap == FullyCan)
|
||
{
|
||
target->cap_local_explain = xy_strdup (CHINESE ? "完全支持项目级换源" : "Supports project-level source switching");
|
||
return;
|
||
}
|
||
|
||
if (cap == CanNot)
|
||
{
|
||
target->cap_local_explain = xy_strdup (CHINESE ? "无法进行项目级换源" : "Unable to perform project-level source switching");
|
||
return;
|
||
}
|
||
|
||
target->cap_local_explain = xy_strdup (CHINESE ? explain_zh : explain_en);
|
||
}
|
||
|
||
|
||
void
|
||
chef_allow_user_define (Target_t *target)
|
||
{
|
||
xy_cant_be_null (target);
|
||
|
||
target->can_user_define = true;
|
||
target->can_user_define_explain = NULL;
|
||
}
|
||
|
||
void
|
||
chef_deny_user_define (Target_t *target)
|
||
{
|
||
xy_cant_be_null (target);
|
||
|
||
target->can_user_define = false;
|
||
|
||
char *reason = CHINESE ? "URL将会根据内部实现重写,因此不能自定义"
|
||
: "The URL will be rewritten based on internal implementation, so it cannot be customized";
|
||
target->can_user_define_explain = reason;
|
||
}
|
||
|
||
|
||
void
|
||
chef_set_note (Target_t *target, const char *note_zh, const char *note_en)
|
||
{
|
||
xy_cant_be_null (target);
|
||
|
||
const char *msg = CHINESE ? note_zh : note_en;
|
||
|
||
if (msg)
|
||
target->note = xy_strdup (msg);
|
||
}
|
||
|
||
|
||
|
||
/**
|
||
* @brief 验证该 `id` 所指的贡献者确有其人
|
||
*/
|
||
Contributor_t *
|
||
chef_verify_contributor (const char *id)
|
||
{
|
||
xy_cant_be_null (id);
|
||
|
||
Contributor_t *c = xy_map_get (ProgStore.contributors, id);
|
||
if (!c)
|
||
{
|
||
char error[256];
|
||
snprintf (error, sizeof (error), "贡献者 %s 不存在, 是否写错？或请在 chsrc-main.c 中登记该贡献者", id);
|
||
chsrc_panic (error);
|
||
}
|
||
return c;
|
||
}
|
||
|
||
|
||
/**
|
||
* @brief 设置 Chef (recipe 负责人)
|
||
*/
|
||
void
|
||
chef_set_chef (Target_t *target, const char *id)
|
||
{
|
||
xy_cant_be_null (target);
|
||
|
||
/* Chef 可为空 */
|
||
if (!id)
|
||
{
|
||
target->chef = NULL;
|
||
return;
|
||
}
|
||
|
||
Contributor_t *c = chef_verify_contributor (id);
|
||
target->chef = c;
|
||
}
|
||
|
||
|
||
/**
|
||
* @brief 设置 Cooks (recipe 核心作者)
|
||
*/
|
||
void
|
||
chef_set_cooks (Target_t *target, size_t count, ...)
|
||
{
|
||
xy_cant_be_null (target);
|
||
|
||
if (count == 0)
|
||
{
|
||
chsrc_panic ("recipe 一定至少有1位作者(cooks)");
|
||
return;
|
||
}
|
||
|
||
va_list args;
|
||
va_start (args, count);
|
||
|
||
target->cooks = xy_malloc0 (count * sizeof (Contributor_t*));
|
||
target->cooks_n = count;
|
||
|
||
for (size_t i = 0; i < count; i++)
|
||
{
|
||
char *id = va_arg (args, char*);
|
||
target->cooks[i] = chef_verify_contributor (id);
|
||
}
|
||
|
||
va_end (args);
|
||
}
|
||
|
||
void
|
||
chef_set_sauciers (Target_t *target, uint32_t count, ...)
|
||
{
|
||
xy_cant_be_null (target);
|
||
|
||
if (count == 0)
|
||
{
|
||
target->sauciers = NULL;
|
||
target->sauciers_n = 0;
|
||
return;
|
||
}
|
||
|
||
va_list args;
|
||
va_start (args, count);
|
||
|
||
target->sauciers = xy_malloc0 (count * sizeof (Contributor_t*));
|
||
target->sauciers_n = count;
|
||
|
||
for (uint32_t i = 0; i < count; i++)
|
||
{
|
||
char *id = va_arg (args, char*);
|
||
target->sauciers[i] = chef_verify_contributor (id);
|
||
}
|
||
}
|
||
|
||
|
||
|
||
void
|
||
chef_set_created_on (Target_t *target, char *date)
|
||
{
|
||
xy_cant_be_null (target);
|
||
xy_cant_be_null (date);
|
||
|
||
target->created_on = xy_strdup (date);
|
||
}
|
||
|
||
|
||
void
|
||
chef_set_last_updated (Target_t *target, char *date)
|
||
{
|
||
xy_cant_be_null (target);
|
||
xy_cant_be_null (date);
|
||
|
||
target->last_updated = xy_strdup (date);
|
||
}
|
||
|
||
|
||
void
|
||
chef_set_sources_last_updated (Target_t *target, char *date)
|
||
{
|
||
xy_cant_be_null (target);
|
||
xy_cant_be_null (date);
|
||
|
||
target->sources_last_updated = xy_strdup (date);
|
||
}
|
||
|
||
|
||
/**
|
||
* @note 某些 target 需要修改 User-Agent
|
||
* 由于单独测速 (chsrc measure) 的时候也需要进行此项修改，
|
||
* 所以该函数不能仅仅放在 _setsrc() 里，而是应当放在 _prelude() 里
|
||
*/
|
||
void
|
||
chef_set_user_agent (char *user_agent)
|
||
{
|
||
ProgStatus.user_agent = user_agent;
|
||
}
|