element." } web::xhtml::fragment search-description { "<xhtml>", "Package search page description. If specified, it is displayed before the search form on the first page only. The value is treated as an XHTML5 fragment." } }; class advanced_search: package_db, search, page, repository_url, package_version_metadata, handler { }; class package_details: package, package_db, search, page, repository_url, package_version_metadata, handler { }; class package_version_details: package, package_db, build, build_db, page, repository_url, package_version_metadata, handler { dir_path bindist-root { "<dir>", "The root directory where the uploaded binary distribution packages are saved to under the following directory hierarchy: \ [<tenant>/]<distribution>/<os-release>/<project>/<package>/<version>/<package-config> \ The package configuration directory symlinks that match these paths are mapped to web URLs based on the \cb{bindist-url} value and displayed on the package version details page. If this option is specified, then \cb{bindist-url} must be specified as well." } string bindist-url { "<url>", "The root URL of the directory specified with the \cb{bindist-root} option. This option must be specified if \cb{bindist-root} is specified." } }; class repository_details: package_db, page, repository_url, handler { }; class build_task: build, build_db, build_upload, build_email_notification, handler { size_t build-task-request-max-size = 102400 { "<bytes>", "The maximum size of the build task request manifest accepted. Note that the HTTP POST request body is cached to retry database transactions in the face of recoverable failures (deadlock, loss of connection, etc). The default is 100K." } size_t build-result-timeout = 10800 { "<seconds>", "Time to wait before considering the expected task result lost. Must be specified in seconds. The default is 3 hours." } vector<pair<std::regex, string>> build-interactive-login { "</regex/replacement/>", "Regular expressions for transforming the interactive build login information, for example, into the actual command that can be used by the user. The regular expressions are matched against the \"<agent>\ <interactive-login>\" string containing the respective task request manifest values. The first matching expression is used for the transformation. If no expression matches, then the task request is considered invalid, unless no expressions are specified. Repeat this option to specify multiple expressions." } build_order build-package-order = build_order::stable { "<order>", "Order in which packages are considered for build. The valid <order> values are \cb{stable} and \cb{random}. If not specified, then \cb{stable} is assumed. Note that interactive builds are always preferred." } }; class build_result: build, build_db, build_email_notification, handler { size_t build-result-request-max-size = 15728640 { "<bytes>", "The maximum size of the build result manifest accepted. Note that the HTTP POST request body is cached to retry database transactions in the face of recoverable failures (deadlock, loss of connection, etc). The default is 15M." } }; class build_log: build, build_db, repository_url, handler { }; class build_force: build, build_db, handler { }; class builds: build, build_db, page, repository_url, handler { uint16_t build-page-entries = 20 { "<num>", "Number of builds per page. The default is 20." } uint16_t build-pages = 5 { "<num>", "Number of pages in navigation (pager). The default is 5." } }; class build_configs: build, page, repository_url, handler { uint16_t build-config-page-entries = 20 { "<num>", "Number of build configurations per page. The default is 20." } uint16_t build-config-pages = 5 { "<num>", "Number of pages in navigation (pager). The default is 5." } }; class submit: page, repository_email, repository_url, handler { dir_path submit-data { "<dir>", "The directory to save final submission data to. If unspecified, the package submission functionality will be disabled. If specified, then \cb{submit-temp} must be specified as well. See \l{brep The \cb{build2} Repository Interface Manual} for more information on package submission. Note that the directory path must be absolute and the directory itself must exist and have read, write, and execute permissions granted to the user that runs the web server." } dir_path submit-temp { "<dir>", "The directory to save temporary submission data to. Must be specified if the package submission functionality is enabled. Note that this directory must be on the same filesystem and satisfy the same requirements as \cb{submit-data}. It is also the user's responsibility to clean it up after an unclean web server shutdown." } size_t submit-max-size = 10485760 { "<bytes>", "The maximum size of the submission data accepted. Note that currently the entire submission request is read into memory. The default is 10M." } path submit-form { "<file>", "The package submission form fragment. If specified, then its contents are treated as an XHTML5 fragment that is inserted into the <body> element of the submission page. If unspecified, then no submission page will be displayed. Note that the file path must be absolute." } string submit-email { "<email>", "The package submission email. If specified, the submission request and result manifests will be sent to this address. See \l{brep The \cb{build2} Repository Interface Manual} for more information." } path submit-handler { "<path>", "The handler program to be executed on package submission. The handler is executed as part of the HTTP request and is passed additional arguments that can be specified with \cb{submit-handler-argument} followed by the absolute path to the submission directory. See \l{brep The \cb{build2} Repository Interface Manual} for more information. Note that the program path must be absolute." } strings submit-handler-argument { "<arg>", "Additional arguments to be passed to the submission handler program (see \cb{submit-handler} for details). Repeat this option to specify multiple arguments." } size_t submit-handler-timeout { "<seconds>", "The submission handler program timeout in seconds. If specified and the handler does not exit in the allotted time, then it is killed and its termination is treated as abnormal." } }; class ci_start: repository_email { dir_path ci-data { "<dir>", "The directory to save CI request data to. If unspecified, the package CI functionality will be disabled. See \l{brep The \cb{build2} Repository Interface Manual} for more information on package CI. Note that the directory path must be absolute and the directory itself must exist and have read, write, and execute permissions granted to the user that runs the web server." } string ci-email { "<email>", "The package CI email. If specified, the CI request and result manifests will be sent to this address. See \l{brep The \cb{build2} Repository Interface Manual} for more information." } path ci-handler { "<path>", "The handler program to be executed on CI request. The handler is executed as part of the HTTP request and is passed additional arguments that can be specified with \cb{ci-handler-argument} followed by the absolute path to the CI request directory. See \l{brep The \cb{build2} Repository Interface Manual} for more information. Note that the program path must be absolute." } strings ci-handler-argument { "<arg>", "Additional arguments to be passed to the CI handler program (see \cb{ci-handler} for details). Repeat this option to specify multiple arguments." } size_t ci-handler-timeout { "<seconds>", "The CI handler program timeout in seconds. If specified and the handler does not exit in the allotted time, then it is killed and its termination is treated as abnormal." } }; class ci: ci_start, build, build_db, page, repository_url, handler { // Classic CI-specific options. // path ci-form { "<file>", "The package CI form fragment. If specified, then its contents are treated as an XHTML5 fragment that is inserted into the <body> element of the CI page. If unspecified, then no CI page will be displayed. Note that the file path must be absolute." } }; class ci_cancel: build, build_db, handler { }; class ci_github: ci_start, ci_cancel, repository_url { // GitHub CI-specific options. // size_t ci-github-app-id { "<id>", "The GitHub App ID. Found in the app's settings on GitHub." } string ci-github-app-webhook-secret { "<secret>", "The GitHub App's configured webhook secret. If not set, then the GitHub CI service is disabled." } path ci-github-app-private-key { "<path>", "The private key used during GitHub API authentication. Created in the GitHub App's settings." } uint16_t ci-github-jwt-validity-period = 600 { "<seconds>", "The number of seconds a JWT (authentication token) should be valid for. The maximum allowed by GitHub is 10 minutes." } }; class upload: build, build_db, build_upload, repository_email, handler { }; class repository_root: repository_url, handler { string root-global-view = "packages" { "<service>", "The default view to display for the global repository root. The <service> argument is one of the supported services (\cb{packages}, \cb{builds}, \cb{submit}, \cb{ci}, etc). The default service is packages." } string root-tenant-view = "packages" { "<service>", "The default view to display for the tenant repository root. The <service> argument is one of the supported services (\cb{packages}, \cb{builds}, \cb{submit}, \cb{ci}, etc). The default service is packages." } }; } // Web handler HTTP request parameters. // // Use parameters long names in the C++ code, short aliases (if present) in // HTTP URL. // namespace params { class packages { // Display package search result list starting from this page. // uint16_t page | p; // Package search criteria. // // Note that the packages parameter is renamed to '_' by the root // handler (see the request_proxy class for details). // string q | _; }; class advanced_search { // Display advanced package search result list starting from this page. // uint16_t page | p; // Advanced package search filter options. // // Package name wildcard. An empty value is treated the same way as *. // // Note that the advanced-search parameter is renamed to '_' by the root // handler (see the request_proxy class for details). // string name | _; // Package version. If empty or *, then no version constraint is applied. // Otherwise the package version must match the value exactly. // string version | pv; // Package project wildcard. An empty value is treated the same way as *. // string project | pr; // Package repositories. If *, then no repository constraint is applied. // Otherwise the package repository canonical name must match the value // exactly. // string repository | rp = "*"; // Package version reviews. If *, then no reviews-related constraint is // applied. Otherwise the value is supposed to be the one of the // following statuses: reviewed and unreviewed. // string reviews | rv = "*"; }; class package_details { // Display package version search result list starting from this page. // uint16_t page | p; // Package version search criteria. // string query | q; // Page form. // page_form form | f = page_form::brief; }; class package_version_details { // Page form. // page_form form | f = page_form::brief; }; class repository_details { // No parameters so far. // }; class build_task { // Only consider packages from repositories with these canonical names // (note: including pkg: type). // vector<string> repository | r; // Only consider tenants with this interactive build mode. // bbot::interactive_mode interactive = bbot::interactive_mode::both; }; class build_result { // No parameters so far. // }; class build_log { // No parameters so far. // }; // All parameters are non-optional. // class build_force { // Package name. // string package | pn; // Package version. May not be url-encoded, in which case the plus // character is considered literally (rather than as the encoded space // character). In other words, after url-decoding the space character is // treated the same way as the plus character. // // @@ Make it of the version type? Maybe after it get moved to // libbpkg/types.hxx or at least the second use case appear. // string version | pv; // Package build target. // string target | tg; // Target build configuration. // string target_config | tc; // Package build configuration. // string package_config | pc; // Toolchain name. // string toolchain_name | tn; // Toolchain version. May not be url-encoded (see above). // string toolchain_version | tv; // Package rebuild reason. Must not be empty. // string reason; }; class builds { // Display packages build configurations list starting from this page. // uint16_t page | p; // Package builds query filter options. // // Package name wildcard. An empty value is treated the same way as *. // // We used to generate URLs like: // // https://cppget.org/?builds&pn=bbot // // This looked a bit verbose, so now we produce URLs like: // // https://cppget.org/?builds=bbot // // Note that the builds parameter is renamed to '_' by the root handler // (see the request_proxy class for details). // string name | _; // Package version. If empty or *, then no version constraint is applied. // Otherwise the build package version must match the value exactly. // string version | pv; // Package build toolchain in the <name>-<version> form. If *, then no // toolchain constraint is applied. Otherwise the build toolchain name // and version must match the value exactly. // string toolchain | th = "*"; // Package build target wildcard. An empty value is treated the same way // as *. // string target | tg; // Package build target configuration name wildcard. An empty value is // treated the same way as *. // string target_config | tc; // Package build package configuration name wildcard. An empty value is // treated the same way as *. // string package_config | pc; // Package build result. If *, then no build result constraint is // applied. Otherwise the value is supposed to be the one of the // following (ordered) statuses: pending, building, success, warning, // error, abort, abnormal. The first 3 statuses are checked for equality, // the rest - for being greater or equal. // string result | rs = "*"; }; class build_configs { // By default, display all build configurations except those which // belong to the 'hidden' class. // // Note that the build-configs parameter is renamed to '_' by the root // handler (see the request_proxy class for details). // string class_name | _; // Display build configurations list starting from this page. // uint16_t page | p; }; // Parameters, except simulate, must either be all present (actual // submission) or absent (submission form request). // // Note also that besides these parameters there can be others. We don't // recognize their semantics and just save them to the submission request // manifest. // class submit { // Package archive file name. Must be <input type="file"/>. // // Note that it can potentially be not just a name but a file path and // in the client's form (e.g., Windows). // string archive; // Package archive file SHA256 checksum. // string sha256sum; // Submission simulation outcome. // string simulate; }; // Parameters, except simulate, must either be all present (actual CI // request) or absent (CI form request). // // Note also that besides these parameters there can be others. We don't // recognize their semantics and just save them to the CI request // manifest. // class ci { // Package repository location. // // Note that the ci parameter is renamed to '_' by the root handler (see // the request_proxy class for details). // bpkg::repository_location repository | _; // Package names/versions. // strings package; // Overrides file name. Must be <input type="file"/>. // // Note that we don't really need this name and only check if this // parameter is specified to detect presence of the upload. // string overrides; // Interactive build execution breakpoint. // string interactive; // Submission simulation outcome. // string simulate; }; // All parameters are non-optional. // class ci_cancel { // CI task tenant id. // // Note that the ci-cancel parameter is renamed to '_' by the root // handler (see the request_proxy class for details). // string id | _; // CI task canceling reason. Must not be empty. // string reason; }; // Parameters other than challenge must be all present. // // Note also that besides these parameters there can be others. We don't // recognize their semantics and just save them to the upload request // manifest. // class upload { // Upload type. // // Note that the upload parameter is renamed to '_' by the root handler // (see the request_proxy class for details). // string type | _; // Session id as returned by brep in the task response. // string session; // Answer to the private key challenge as posed by brep in the task // response. It must be present only if the challenge value was present // in the task response. // string challenge; // Upload instance name. // string instance; // Package archive file name. Must be <input type="file"/>. // // Note that it can potentially be not just a name but a file path. // string archive; // Package archive file SHA256 checksum. // string sha256sum; }; } }

// file : mod/options.cli -*- C++ -*- // license : MIT; see accompanying LICENSE file include ; include ; include ; // repository_location include ; // interactive_mode include ; include ; include ; namespace brep { // Web handler configuration options. // namespace options { // Option groups. // class repository_email { string email { "", "Repository email. This email is used for the \cb{From:} header in emails send by \cb{brep} (for example, build failure notifications)." } }; class repository_url { string host { "", "Repository host. It specifies the scheme and the host address (but not the root path; see \cb{root} below) that will be used whenever \cb{brep} needs to construct an absolute URL to one of its locations (for example, a link to a build log that is being send via email)." } dir_path root = "/" { "", "Repository root. That is, this is the part of the URL between the host name and the start of the repository. For example, root value '\cb{/pkg}' means the repository URL is \cb{http://example.org/pkg/}. Specify '\cb{/}' to use the web server root (\cb{http://example.org/})." } }; class build_email_notification: repository_email, repository_url { std::map build-toolchain-email { "=", "Enable or disable package build notification emails. The valid values are \cb{none}, \cb{latest}, and \cb{all}. If \cb{all} is specified for a toolchain name, then emails are sent according to the \cb{build-*email} package manifest values when all versions of a package are built with this toolchain. If \cb{latest} is specified, then for this toolchain name the emails are only sent for the latest version of a package. If \cb{none} is specified, then no emails are sent for this toolchain name. By default the \cb{latest} mode is assumed. Repeat this option to enable/disable emails for multiple toolchains. See \l{bpkg#manifest-package Package Manifest} for details on \cb{build-*email} values." } }; class handler { string tenant-name = "tenant" { "", "Name to call the tenant values on web pages. If not specified, then \cb{tenant} is used." } uint16_t verbosity = 0 { "", "Trace verbosity level. Level 0 disables tracing, which is also the default." } }; class openssl_options { path openssl = "openssl" { "", "The openssl program to be used for crypto operations. You can also specify additional options that should be passed to the openssl program with \cb{openssl-option}. If the openssl program is not explicitly specified, then \cb{brep} will use \cb{openssl} by default." } strings openssl-option { "", "Additional option to be passed to the openssl program (see \cb{openssl} for details). Repeat this option to specify multiple openssl options." } strings openssl-envvar { "[=value]", "Environment variable to be set (=) or unset (just ) for the openssl program (see \cb{openssl} for details). Repeat this option to specify multiple openssl variables. Note that unspecified variables are inherited from the web server process. You need to at least set the \cb{RANDFILE} environment variable to change the default location of the openssl program seed file and maybe also the \cb{OPENSSL_CONF} variable if you would like to use a custom openssl configuration file." } }; class package_db { string package-db-user { "", "Package database login user name. If not specified, then operating system (login) name is used. See also \cb{package-db-role}." } string package-db-role = "brep" { "", "Package database execution user name. If not empty then the login user will be switched (with \cb{SET ROLE}) to this user prior to executing any statements. If not specified, then \cb{brep} is used." } string package-db-password { "", "Package database password. If not specified, then login without password is expected to work." } string package-db-name = "brep_package" { "", "Package database name. If not specified, then \cb{brep_package} is used by default." } string package-db-host { "", "Package database host name, address, or socket. If not specified, then connect to \cb{localhost} using the operating system-default mechanism (Unix-domain socket, etc)." } uint16_t package-db-port = 0 { "", "Package database port number. If not specified, the default port is used." } size_t package-db-max-connections = 5 { "", "The maximum number of concurrent package database connections per web server process. If 0, then no limitation is applied. The default is 5." } size_t package-db-retry = 10 { "", "The maximum number of times to retry package database transactions in the face of recoverable failures (deadlock, loss of connection, etc). The default is 10." } }; class build: openssl_options { path build-config { "", "Build configuration file. If not specified, then the package building functionality will be disabled. If specified, then the build database must be configured (see \cb{build-db-*}). The \cb{brep} instance needs to be restarted after modifying for the changes to take effect." } dir_path build-bot-agent-keys { "", "Directory containing build bot agent public keys. If specified, then \cb{brep} will perform agent authentication and will reject build results from unauthenticated ones. If not specified, then build results are accepted from all agents (which will be a security risk if the \cb{brep} instance is publicly accessible). The directory is expected to contain one PEM-encoded public key per file with the \cb{.pem} extension. All other files and subdirectories are ignored. The \cb{brep} instance needs to be restarted after adding new key files for the changes to take effect." } size_t build-forced-rebuild-timeout = 600 { "", "Time to wait before considering a package for a forced rebuild. Must be specified in seconds. Default is 10 minutes." } size_t build-soft-rebuild-timeout = 86400 { "", "Time to wait before considering a package for a soft rebuild (only to be performed if the build environment or any of the package dependencies have changed). Must be specified in seconds. The special zero value disables soft rebuilds. Default is 24 hours" } size_t build-alt-soft-rebuild-timeout { "", "Alternative package soft rebuild timeout to use instead of the soft rebuild timeout (see \cb{build-soft-rebuild-timeout} for details) during the time interval specified with the \cb{build-alt-soft-rebuild-start} and \cb{build-alt-soft-rebuild-stop} options. Must be specified in seconds. Default is the time interval length plus \c{(\b{build-soft-rebuild-timeout} - 24h)} if soft rebuild timeout is greater than 24 hours (thus the rebuild is only triggered within the last 24 hours of the \cb{build-soft-rebuild-timeout} expiration)." } duration build-alt-soft-rebuild-start { ":", "The start time of the alternative package soft rebuild timeout (see \cb{build-alt-soft-rebuild-timeout} for details). Must be specified as a time of day in the local timezone. The \cb{build-alt-soft-rebuild-start} and \cb{build-alt-soft-rebuild-stop} options must be either both specified or absent. If unspecified, then no alternative rebuild timeout will be used." } duration build-alt-soft-rebuild-stop { ":", "The end time of the alternative package soft rebuild timeout (see \cb{build-alt-soft-rebuild-timeout} for details). Must be specified as a time of day in the local timezone. If it is less than the \cb{build-alt-soft-rebuild-start} option value, then the time interval extends through midnight. The \cb{build-alt-soft-rebuild-start} and \cb{build-alt-soft-rebuild-stop} options must be either both specified or absent. If unspecified, then no alternative rebuild timeout will be used." } size_t build-hard-rebuild-timeout = 604800 { "", "Time to wait before considering a package for a hard rebuild (to be performed unconditionally). Must be specified in seconds. The special zero value disables hard rebuilds. Default is 7 days." } size_t build-alt-hard-rebuild-timeout { "", "Alternative package hard rebuild timeout. The semantics is the same as for the \cb{build-alt-soft-rebuild-timeout} option but for the \cb{build-hard-rebuild-timeout} option." } duration build-alt-hard-rebuild-start { ":", "The start time of the alternative package hard rebuild timeout (see \cb{build-alt-hard-rebuild-timeout} for details). The semantics is the same as for the \cb{build-alt-soft-rebuild-start} option but for the \cb{build-hard-rebuild-timeout} option." } duration build-alt-hard-rebuild-stop { ":", "The end time of the alternative package hard rebuild timeout (see \cb{build-alt-hard-rebuild-timeout} for details). The semantics is the same as for the \cb{build-alt-soft-rebuild-stop} option but for the \cb{build-hard-rebuild-timeout} option." } size_t build-queued-timeout = 30 { "", "Time to wait before assuming the \cb{queued} notifications are delivered for package CI requests submitted via third-party services (GitHub, etc). During this time a package is not considered for a build. Must be specified in seconds. Default is 30 seconds." } }; class build_db { string build-db-user { "", "Build database login user name. If not specified, then operating system (login) name is used. See also \cb{build-db-role}." } string build-db-role = "brep" { "", "Build database execution user name. If not empty then the login user will be switched (with \cb{SET ROLE}) to this user prior to executing any statements. If not specified, then \cb{brep} is used." } string build-db-password { "", "Build database password. If not specified, then login without password is expected to work." } string build-db-name = "brep_build" { "", "Build database name. If not specified, then \cb{brep_build} is used by default." } string build-db-host { "", "Build database host name, address, or socket. If not specified, then connect to \cb{localhost} using the operating system-default mechanism (Unix-domain socket, etc)." } uint16_t build-db-port = 0 { "", "Build database port number. If not specified, the default port is used." } size_t build-db-max-connections = 5 { "", "The maximum number of concurrent build database connections per web server process. If 0, then no limitation is applied. The default is 5." } size_t build-db-retry = 10 { "", "The maximum number of times to retry build database transactions in the face of recoverable failures (deadlock, loss of connection, etc). The default is 10." } }; class build_upload { std::map upload-data { "=", "The directory to save upload data to for the specified upload type. If unspecified, the build artifacts upload functionality will be disabled for this type. See \l{brep The \cb{build2} Repository Interface Manual} for more information on build artifacts upload. Note that the directory path must be absolute and the directory itself must exist and have read, write, and execute permissions granted to the user that runs the web server." } std::map upload-max-size { "=", "The maximum size of the upload data accepted for the specified upload type. Note that currently the entire upload request is read into memory. The default is 10M." } std::map upload-email { "=", "The build artifacts upload email. If specified, the upload request and result manifests will be sent to this address. See \l{brep The \cb{build2} Repository Interface Manual} for more information." } std::map upload-handler { "=", "The handler program to be executed on build artifacts upload of the specified type. The handler is executed as part of the HTTP request and is passed additional arguments that can be specified with \cb{upload-handler-argument} followed by the absolute path to the upload directory (\cb{upload-data}). See \l{brep The \cb{build2} Repository Interface Manual} for more information. Note that the program path must be absolute." } std::multimap upload-handler-argument { "=", "Additional arguments to be passed to the upload handler program for the specified upload type (see \cb{upload-handler} for details). Repeat this option to specify multiple arguments." } std::map upload-handler-timeout { "=", "The upload handler program timeout in seconds for the specified upload type. If specified and the handler does not exit in the allotted time, then it is killed and its termination is treated as abnormal." } std::multimap upload-toolchain-exclude { "=", "Disable upload of the specified type for the specified toolchain name. Repeat this option to disable uploads for multiple toolchains." } std::multimap upload-repository-exclude { "=", "Disable upload of the specified type for packages from the repository with the specified canonical name. Repeat this option to disable uploads for multiple repositories." } }; class package_version_metadata { string reviews-url { "", "The base URL for the reviews manifest files. If this option is specified, then the review information is displayed on the package version details page. The complete URL is formed by adding the following path to the base: \ ///reviews.manifest \ Note that no separator is added between the base and this path." } }; class page { web::xhtml::fragment logo { "", "Web page logo. It is displayed in the page header aligned to the left edge. The value is treated as an XHTML5 fragment." } vector menu { "", "Web page menu. Each entry is displayed in the page header in the order specified and aligned to the right edge. A link target that starts with '\cb{/}' or contains '\cb{:}' is used as is. Otherwise, it is prefixed with the repository web interface root." } }; class search { uint16_t search-page-entries = 20 { "", "Number of packages per page. The default is 20." } uint16_t search-pages = 5 { "", "Number of pages in navigation (pager). The default is 5." } }; class package { uint16_t package-description = 500 { "", "Number of package description characters to display in brief pages. The default is 500 (~ 80 characters * 6 lines)." } uint16_t package-changes = 5000 { "", "Number of package changes characters to display in brief pages. The default is 5000 (~ 80 chars x 60 lines)." } }; // Handler options. // class packages: search, package_db, page, repository_url, handler { string search-title = "Packages" { "", "Package search page title. It is placed inside XHTML5 element." } web::xhtml::fragment search-description { "<xhtml>", "Package search page description. If specified, it is displayed before the search form on the first page only. The value is treated as an XHTML5 fragment." } }; class advanced_search: package_db, search, page, repository_url, package_version_metadata, handler { }; class package_details: package, package_db, search, page, repository_url, package_version_metadata, handler { }; class package_version_details: package, package_db, build, build_db, page, repository_url, package_version_metadata, handler { dir_path bindist-root { "<dir>", "The root directory where the uploaded binary distribution packages are saved to under the following directory hierarchy: \ [<tenant>/]<distribution>/<os-release>/<project>/<package>/<version>/<package-config> \ The package configuration directory symlinks that match these paths are mapped to web URLs based on the \cb{bindist-url} value and displayed on the package version details page. If this option is specified, then \cb{bindist-url} must be specified as well." } string bindist-url { "<url>", "The root URL of the directory specified with the \cb{bindist-root} option. This option must be specified if \cb{bindist-root} is specified." } }; class repository_details: package_db, page, repository_url, handler { }; class build_task: build, build_db, build_upload, build_email_notification, handler { size_t build-task-request-max-size = 102400 { "<bytes>", "The maximum size of the build task request manifest accepted. Note that the HTTP POST request body is cached to retry database transactions in the face of recoverable failures (deadlock, loss of connection, etc). The default is 100K." } size_t build-result-timeout = 10800 { "<seconds>", "Time to wait before considering the expected task result lost. Must be specified in seconds. The default is 3 hours." } vector<pair<std::regex, string>> build-interactive-login { "</regex/replacement/>", "Regular expressions for transforming the interactive build login information, for example, into the actual command that can be used by the user. The regular expressions are matched against the \"<agent>\ <interactive-login>\" string containing the respective task request manifest values. The first matching expression is used for the transformation. If no expression matches, then the task request is considered invalid, unless no expressions are specified. Repeat this option to specify multiple expressions." } build_order build-package-order = build_order::stable { "<order>", "Order in which packages are considered for build. The valid <order> values are \cb{stable} and \cb{random}. If not specified, then \cb{stable} is assumed. Note that interactive builds are always preferred." } }; class build_result: build, build_db, build_email_notification, handler { size_t build-result-request-max-size = 15728640 { "<bytes>", "The maximum size of the build result manifest accepted. Note that the HTTP POST request body is cached to retry database transactions in the face of recoverable failures (deadlock, loss of connection, etc). The default is 15M." } }; class build_log: build, build_db, repository_url, handler { }; class build_force: build, build_db, handler { }; class builds: build, build_db, page, repository_url, handler { uint16_t build-page-entries = 20 { "<num>", "Number of builds per page. The default is 20." } uint16_t build-pages = 5 { "<num>", "Number of pages in navigation (pager). The default is 5." } }; class build_configs: build, page, repository_url, handler { uint16_t build-config-page-entries = 20 { "<num>", "Number of build configurations per page. The default is 20." } uint16_t build-config-pages = 5 { "<num>", "Number of pages in navigation (pager). The default is 5." } }; class submit: page, repository_email, repository_url, handler { dir_path submit-data { "<dir>", "The directory to save final submission data to. If unspecified, the package submission functionality will be disabled. If specified, then \cb{submit-temp} must be specified as well. See \l{brep The \cb{build2} Repository Interface Manual} for more information on package submission. Note that the directory path must be absolute and the directory itself must exist and have read, write, and execute permissions granted to the user that runs the web server." } dir_path submit-temp { "<dir>", "The directory to save temporary submission data to. Must be specified if the package submission functionality is enabled. Note that this directory must be on the same filesystem and satisfy the same requirements as \cb{submit-data}. It is also the user's responsibility to clean it up after an unclean web server shutdown." } size_t submit-max-size = 10485760 { "<bytes>", "The maximum size of the submission data accepted. Note that currently the entire submission request is read into memory. The default is 10M." } path submit-form { "<file>", "The package submission form fragment. If specified, then its contents are treated as an XHTML5 fragment that is inserted into the <body> element of the submission page. If unspecified, then no submission page will be displayed. Note that the file path must be absolute." } string submit-email { "<email>", "The package submission email. If specified, the submission request and result manifests will be sent to this address. See \l{brep The \cb{build2} Repository Interface Manual} for more information." } path submit-handler { "<path>", "The handler program to be executed on package submission. The handler is executed as part of the HTTP request and is passed additional arguments that can be specified with \cb{submit-handler-argument} followed by the absolute path to the submission directory. See \l{brep The \cb{build2} Repository Interface Manual} for more information. Note that the program path must be absolute." } strings submit-handler-argument { "<arg>", "Additional arguments to be passed to the submission handler program (see \cb{submit-handler} for details). Repeat this option to specify multiple arguments." } size_t submit-handler-timeout { "<seconds>", "The submission handler program timeout in seconds. If specified and the handler does not exit in the allotted time, then it is killed and its termination is treated as abnormal." } }; class ci_start: repository_email { dir_path ci-data { "<dir>", "The directory to save CI request data to. If unspecified, the package CI functionality will be disabled. See \l{brep The \cb{build2} Repository Interface Manual} for more information on package CI. Note that the directory path must be absolute and the directory itself must exist and have read, write, and execute permissions granted to the user that runs the web server." } string ci-email { "<email>", "The package CI email. If specified, the CI request and result manifests will be sent to this address. See \l{brep The \cb{build2} Repository Interface Manual} for more information." } path ci-handler { "<path>", "The handler program to be executed on CI request. The handler is executed as part of the HTTP request and is passed additional arguments that can be specified with \cb{ci-handler-argument} followed by the absolute path to the CI request directory. See \l{brep The \cb{build2} Repository Interface Manual} for more information. Note that the program path must be absolute." } strings ci-handler-argument { "<arg>", "Additional arguments to be passed to the CI handler program (see \cb{ci-handler} for details). Repeat this option to specify multiple arguments." } size_t ci-handler-timeout { "<seconds>", "The CI handler program timeout in seconds. If specified and the handler does not exit in the allotted time, then it is killed and its termination is treated as abnormal." } }; class ci: ci_start, build, build_db, page, repository_url, handler { // Classic CI-specific options. // path ci-form { "<file>", "The package CI form fragment. If specified, then its contents are treated as an XHTML5 fragment that is inserted into the <body> element of the CI page. If unspecified, then no CI page will be displayed. Note that the file path must be absolute." } }; class ci_cancel: build, build_db, handler { }; class ci_github: ci_start, ci_cancel, repository_url { // GitHub CI-specific options. // size_t ci-github-app-id { "<id>", "The GitHub App ID. Found in the app's settings on GitHub." } string ci-github-app-webhook-secret { "<secret>", "The GitHub App's configured webhook secret. If not set, then the GitHub CI service is disabled." } path ci-github-app-private-key { "<path>", "The private key used during GitHub API authentication. Created in the GitHub App's settings." } uint16_t ci-github-jwt-validity-period = 600 { "<seconds>", "The number of seconds a JWT (authentication token) should be valid for. The maximum allowed by GitHub is 10 minutes." } }; class upload: build, build_db, build_upload, repository_email, handler { }; class repository_root: repository_url, handler { string root-global-view = "packages" { "<service>", "The default view to display for the global repository root. The <service> argument is one of the supported services (\cb{packages}, \cb{builds}, \cb{submit}, \cb{ci}, etc). The default service is packages." } string root-tenant-view = "packages" { "<service>", "The default view to display for the tenant repository root. The <service> argument is one of the supported services (\cb{packages}, \cb{builds}, \cb{submit}, \cb{ci}, etc). The default service is packages." } }; } // Web handler HTTP request parameters. // // Use parameters long names in the C++ code, short aliases (if present) in // HTTP URL. // namespace params { class packages { // Display package search result list starting from this page. // uint16_t page | p; // Package search criteria. // // Note that the packages parameter is renamed to '_' by the root // handler (see the request_proxy class for details). // string q | _; }; class advanced_search { // Display advanced package search result list starting from this page. // uint16_t page | p; // Advanced package search filter options. // // Package name wildcard. An empty value is treated the same way as *. // // Note that the advanced-search parameter is renamed to '_' by the root // handler (see the request_proxy class for details). // string name | _; // Package version. If empty or *, then no version constraint is applied. // Otherwise the package version must match the value exactly. // string version | pv; // Package project wildcard. An empty value is treated the same way as *. // string project | pr; // Package repositories. If *, then no repository constraint is applied. // Otherwise the package repository canonical name must match the value // exactly. // string repository | rp = "*"; // Package version reviews. If *, then no reviews-related constraint is // applied. Otherwise the value is supposed to be the one of the // following statuses: reviewed and unreviewed. // string reviews | rv = "*"; }; class package_details { // Display package version search result list starting from this page. // uint16_t page | p; // Package version search criteria. // string query | q; // Page form. // page_form form | f = page_form::brief; }; class package_version_details { // Page form. // page_form form | f = page_form::brief; }; class repository_details { // No parameters so far. // }; class build_task { // Only consider packages from repositories with these canonical names // (note: including pkg: type). // vector<string> repository | r; // Only consider tenants with this interactive build mode. // bbot::interactive_mode interactive = bbot::interactive_mode::both; }; class build_result { // No parameters so far. // }; class build_log { // No parameters so far. // }; // All parameters are non-optional. // class build_force { // Package name. // string package | pn; // Package version. May not be url-encoded, in which case the plus // character is considered literally (rather than as the encoded space // character). In other words, after url-decoding the space character is // treated the same way as the plus character. // // @@ Make it of the version type? Maybe after it get moved to // libbpkg/types.hxx or at least the second use case appear. // string version | pv; // Package build target. // string target | tg; // Target build configuration. // string target_config | tc; // Package build configuration. // string package_config | pc; // Toolchain name. // string toolchain_name | tn; // Toolchain version. May not be url-encoded (see above). // string toolchain_version | tv; // Package rebuild reason. Must not be empty. // string reason; }; class builds { // Display packages build configurations list starting from this page. // uint16_t page | p; // Package builds query filter options. // // Package name wildcard. An empty value is treated the same way as *. // // We used to generate URLs like: // // https://cppget.org/?builds&pn=bbot // // This looked a bit verbose, so now we produce URLs like: // // https://cppget.org/?builds=bbot // // Note that the builds parameter is renamed to '_' by the root handler // (see the request_proxy class for details). // string name | _; // Package version. If empty or *, then no version constraint is applied. // Otherwise the build package version must match the value exactly. // string version | pv; // Package build toolchain in the <name>-<version> form. If *, then no // toolchain constraint is applied. Otherwise the build toolchain name // and version must match the value exactly. // string toolchain | th = "*"; // Package build target wildcard. An empty value is treated the same way // as *. // string target | tg; // Package build target configuration name wildcard. An empty value is // treated the same way as *. // string target_config | tc; // Package build package configuration name wildcard. An empty value is // treated the same way as *. // string package_config | pc; // Package build result. If *, then no build result constraint is // applied. Otherwise the value is supposed to be the one of the // following (ordered) statuses: pending, building, success, warning, // error, abort, abnormal. The first 3 statuses are checked for equality, // the rest - for being greater or equal. // string result | rs = "*"; }; class build_configs { // By default, display all build configurations except those which // belong to the 'hidden' class. // // Note that the build-configs parameter is renamed to '_' by the root // handler (see the request_proxy class for details). // string class_name | _; // Display build configurations list starting from this page. // uint16_t page | p; }; // Parameters, except simulate, must either be all present (actual // submission) or absent (submission form request). // // Note also that besides these parameters there can be others. We don't // recognize their semantics and just save them to the submission request // manifest. // class submit { // Package archive file name. Must be <input type="file"/>. // // Note that it can potentially be not just a name but a file path and // in the client's form (e.g., Windows). // string archive; // Package archive file SHA256 checksum. // string sha256sum; // Submission simulation outcome. // string simulate; }; // Parameters, except simulate, must either be all present (actual CI // request) or absent (CI form request). // // Note also that besides these parameters there can be others. We don't // recognize their semantics and just save them to the CI request // manifest. // class ci { // Package repository location. // // Note that the ci parameter is renamed to '_' by the root handler (see // the request_proxy class for details). // bpkg::repository_location repository | _; // Package names/versions. // strings package; // Overrides file name. Must be <input type="file"/>. // // Note that we don't really need this name and only check if this // parameter is specified to detect presence of the upload. // string overrides; // Interactive build execution breakpoint. // string interactive; // Submission simulation outcome. // string simulate; }; // All parameters are non-optional. // class ci_cancel { // CI task tenant id. // // Note that the ci-cancel parameter is renamed to '_' by the root // handler (see the request_proxy class for details). // string id | _; // CI task canceling reason. Must not be empty. // string reason; }; // Parameters other than challenge must be all present. // // Note also that besides these parameters there can be others. We don't // recognize their semantics and just save them to the upload request // manifest. // class upload { // Upload type. // // Note that the upload parameter is renamed to '_' by the root handler // (see the request_proxy class for details). // string type | _; // Session id as returned by brep in the task response. // string session; // Answer to the private key challenge as posed by brep in the task // response. It must be present only if the challenge value was present // in the task response. // string challenge; // Upload instance name. // string instance; // Package archive file name. Must be <input type="file"/>. // // Note that it can potentially be not just a name but a file path. // string archive; // Package archive file SHA256 checksum. // string sha256sum; }; } }