mirror of
https://gh.wpcy.net/https://github.com/Anyape/updatepulse-server.git
synced 2026-05-06 14:42:26 +08:00
341 lines
18 KiB
PHP
341 lines
18 KiB
PHP
<?php if ( ! defined( 'ABSPATH' ) ) {
|
|
exit; // Exit if accessed directly
|
|
} ?>
|
|
<div class="wrap upserv-wrap">
|
|
<?php echo $header ? wp_kses_post( $header ) : ''; ?>
|
|
<form autocomplete="off" action="" method="post">
|
|
<input type="hidden" class="vcs-values" id="upserv_vcs" name="upserv_vcs" value="<?php echo esc_attr( $options['vcs'] ); ?>">
|
|
<table class="form-table package-source switch">
|
|
<tr>
|
|
<th>
|
|
<label for="upserv_use_vcs"><?php esc_html_e( 'Enable VCS', 'updatepulse-server' ); ?></label>
|
|
</th>
|
|
<td>
|
|
<input type="checkbox" id="upserv_use_vcs" name="upserv_use_vcs" value="1" <?php checked( $options['use_vcs'], 1 ); ?>>
|
|
<p class="description">
|
|
<?php esc_html_e( 'Enables this server to download plugins, themes and generic packages from a Version Control System before delivering updates.', 'updatepulse-server' ); ?>
|
|
<br>
|
|
<?php esc_html_e( 'Supports Bitbucket, Github and Gitlab.', 'updatepulse-server' ); ?>
|
|
<br>
|
|
<?php
|
|
printf(
|
|
// translators: %s is the path where zip packages need to be uploaded
|
|
esc_html__( 'If left unchecked, zip packages need to be manually uploaded to %s.', 'updatepulse-server' ),
|
|
'<code>' . esc_html( $packages_dir ) . '</code>'
|
|
);
|
|
?>
|
|
<br>
|
|
<strong>
|
|
<?php
|
|
printf(
|
|
// translators: %s <a href="admin.php?page=upserv-page-help">initialize packages</a>
|
|
esc_html__( 'It is necessary to %s associated with a Version Control System for them to be available in UpdatePulse Server.', 'updatepulse-server' ),
|
|
'<a href="' . esc_url( admin_url( 'admin.php?page=upserv-page-help' ) ) . '">' . esc_html__( 'register packages', 'updatepulse-server' ) . '</a>'
|
|
);
|
|
?>
|
|
</strong>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<div class="vcs" id="upserv_vcs_list">
|
|
<div class="item template upserv-modal-open-handle" data-modal_id="upserv_modal_add_remote_source">
|
|
<div class="placeholder">
|
|
<span class="icon">+</span>
|
|
<div><?php esc_html_e( 'Add a VCS', 'updatepulse-server' ); ?></div>
|
|
</div>
|
|
<div class="service hidden">
|
|
<span class="github hidden"><i class="fa-brands fa-github"></i><?php esc_html_e( 'Github', 'updatepulse-server' ); ?></span>
|
|
<span class="bitbucket hidden"><i class="fa-brands fa-bitbucket"></i><?php esc_html_e( 'Bitbucket', 'updatepulse-server' ); ?></span>
|
|
<span class="gitlab hidden"><i class="fa-brands fa-gitlab"></i><?php esc_html_e( 'Gitlab', 'updatepulse-server' ); ?></span>
|
|
<span class="self-hosted-gitlab hidden"><i class="fa-brands fa-square-gitlab"></i><?php esc_html_e( 'Self-hosted', 'updatepulse-server' ); ?></span>
|
|
<span class="self-hosted-undefined hidden"><i class="fa-solid fa-question"></i><?php esc_html_e( 'Unknown', 'updatepulse-server' ); ?></span>
|
|
</div>
|
|
<div class="info hidden">
|
|
<code><i class="fa-solid fa-code"></i> <span class="identifier"></span></code>
|
|
<code><i class="fa-solid fa-code-branch"></i> <span class="branch"></span></code>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="form-container package-source hidden">
|
|
<table class="form-table form-settings">
|
|
<tr>
|
|
<th>
|
|
<label for="upserv_vcs_url"><?php esc_html_e( 'VCS URL', 'updatepulse-server' ); ?></label>
|
|
</th>
|
|
<td>
|
|
<input class="regular-text vcs-setting" type="text" id="upserv_vcs_url" data-prop="url" value=""> <button class="button remove" id="upserv_remove_vcs"><?php esc_html_e( 'Remove', 'updatepulse-server' ); ?></button>
|
|
<p class="description">
|
|
<?php esc_html_e( 'The URL of the Version Control System where packages are hosted.', 'updatepulse-server' ); ?>
|
|
<br>
|
|
<?php
|
|
printf(
|
|
// translators: %1$s is <code>https://version-control-system.tld/identifier/</code>, %2$s is <code>identifier</code>
|
|
esc_html__( 'Must follow the following pattern: %1$s where %2$s is the user or the organisation name in case of Github, is the workspace name in case of Bitbucket, and is a group in case of Gitlab or a self-hosted instance of Gitlab (no support for Gitlab subgroups).', 'updatepulse-server' ),
|
|
'<code>https://version-control-system.tld/identifier/</code>',
|
|
'<code>identifier</code>'
|
|
);
|
|
?>
|
|
<br>
|
|
<?php
|
|
printf(
|
|
// translators: %1$s is <code>https://version-control-system.tld/identifier/package-slug/</code>, %2$s is <code>identifier</code>
|
|
esc_html__( 'Each package repository URL must follow the following pattern: %1$s; the package files must be located at the root of the repository, and in the case of WordPress plugins the main plugin file must follow the pattern %2$s.', 'updatepulse-server' ),
|
|
'<code>https://version-control-system.tld/identifier/package-slug/</code>',
|
|
'<code>package-slug.php</code>',
|
|
);
|
|
?>
|
|
</p>
|
|
<input type="hidden" class="vcs-setting" id="upserv_vcs_type" data-prop="type" value="undefined">
|
|
</td>
|
|
</tr>
|
|
<tr class="self-hosted">
|
|
<th>
|
|
<label for="upserv_vcs_self_hosted"><?php esc_html_e( 'Self-hosted Gitlab', 'updatepulse-server' ); ?></label>
|
|
</th>
|
|
<td>
|
|
<input class="vcs-setting" type="checkbox" id="upserv_vcs_self_hosted_gitlab" data-prop="self_hosted" value="gitlab">
|
|
<p class="description">
|
|
<?php esc_html_e( 'Check this only if the Version Control System is a self-hosted instance of Gitlab.', 'updatepulse-server' ); ?>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
<label for="upserv_vcs_branch"><?php esc_html_e( 'Packages Branch Name', 'updatepulse-server' ); ?></label>
|
|
</th>
|
|
<td>
|
|
<input class="vcs-setting regular-text" type="text" id="upserv_vcs_branch" data-prop="branch" value="">
|
|
<p class="description">
|
|
<?php
|
|
printf(
|
|
// translators: %1$s line break, %2$s is <code>PUC_FORCE_BRANCH</code>, %3$s is <code>true</code>, %4$s is <code>wp-config.php</code>
|
|
esc_html__( 'The branch to download when getting remote packages from the Version Control System.%1$sIf the VCS supports releases or tags, they will be prioritised over the branch name (release first, then tag, then branch).%1$sTo bypass this behaviour and exclusively rely on the branch, set the %2$s constant to %3$s in %4$s.', 'updatepulse-server' ),
|
|
'<br/>',
|
|
'<code>PUC_FORCE_BRANCH</code>',
|
|
'<code>true</code>',
|
|
'<code>wp-config.php</code>'
|
|
);
|
|
?>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
<label for="upserv_vcs_credentials"><?php esc_html_e( 'VCS Credentials', 'updatepulse-server' ); ?></label>
|
|
</th>
|
|
<td>
|
|
<input class="vcs-setting regular-text secret" type="password" autocomplete="new-password" id="upserv_vcs_credentials" data-prop="credentials" value="">
|
|
<p class="description">
|
|
<?php esc_html_e( 'Credentials for non-publicly accessible repositories.', 'updatepulse-server' ); ?>
|
|
<br>
|
|
<?php
|
|
printf(
|
|
// translators: %s is <code>email@domain.com:API_TOKEN_WITH SCOPE</code>
|
|
esc_html__( 'In the case of Github and Gitlab, a Personal Access Token (PAT); in the case of Bitckucket, the Bitbucket account email and an API token with scopes formatted like %s.', 'updatepulse-server' ),
|
|
'<code>email@domain.com:API_TOKEN_WITH_SCOPE</code>'
|
|
);
|
|
?>
|
|
<br>
|
|
<strong><?php esc_html_e( 'WARNING: Keep these credentials secret, do not share them, and take care of renewing them before they expire!', 'updatepulse-server' ); ?></strong>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
<label for="upserv_vcs_filter_packages"><?php esc_html_e( 'Filter Packages', 'updatepulse-server' ); ?></label>
|
|
</th>
|
|
<td>
|
|
<input type="checkbox" id="upserv_vcs_filter_packages" data-prop="filter_packages" value="1">
|
|
<p class="description">
|
|
<?php esc_html_e( 'When checked, packages downloaded from the Version Control System are filtered to include only those explicitly associated with this server.', 'updatepulse-server' ); ?>
|
|
<br/>
|
|
<?php
|
|
printf(
|
|
// translators: %1$s is <code>updatepulse.json</code>, %2$s is <code>server</code>, %3$s is <code>https://sub.domain.tld/</code>
|
|
esc_html__( 'In this case, UpdatePulse Server downloads only packages containing a file named %1$s in the root of the repository, with the %2$s value set to %3$s.', 'updatepulse-server' ),
|
|
'<code>' . esc_html( apply_filters( 'upserv_filter_packages_flag_file', 'updatepulse.json' ) ) . '</code>',
|
|
'<code>server</code>',
|
|
'<code>' . esc_url( trailingslashit( home_url() ) ) . '</code>',
|
|
);
|
|
?>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
<label for="upserv_vcs_test"><?php esc_html_e( 'Test VCS Access', 'updatepulse-server' ); ?></label>
|
|
</th>
|
|
<td>
|
|
<input type="button" value="<?php print esc_attr_e( 'Test Now', 'updatepulse-server' ); ?>" id="upserv_vcs_test" class="button ajax-trigger" data-selector=".vcs-setting" data-action="vcs_test" data-type="none" />
|
|
<p class="description">
|
|
<?php esc_html_e( 'Send a test request to the Version Control System.', 'updatepulse-server' ); ?>
|
|
<br/>
|
|
<?php esc_html_e( 'The request checks whether the service is reachable and if the request can be authenticated.', 'updatepulse-server' ); ?>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
<label for="upserv_vcs_use_webhooks"><?php esc_html_e( 'Use Webhooks', 'updatepulse-server' ); ?></label>
|
|
</th>
|
|
<td>
|
|
<input type="checkbox" id="upserv_vcs_use_webhooks" data-prop="use_webhooks" value="1">
|
|
<p class="description">
|
|
<?php esc_html_e( 'When checked, UpdatePulse Server does not regularly poll the repositories for package version changes, but relies on the Webhook payloads sent by the Version Control System to schedule a download in case the package does not exist or if a new version is available.', 'updatepulse-server' ); ?>
|
|
<br/>
|
|
<?php
|
|
printf(
|
|
// translators: %1$s is the webhook URL, %2$s is <code>package-type</code>, %3$s is <code>plugin</code>, %4$s is <code>theme</code>, %5$s is <code>generic</code>, %6$s is <code>package-slug</code>
|
|
esc_html__( 'Webhook URL: %1$s - where %2$s is the package type ( %3$s or %4$s or %5$s ) and %6$s is the slug of the package needing updates.', 'updatepulse-server' ),
|
|
'<code>' . esc_url( home_url( '/updatepulse-server-webhook/package-type/package-slug' ) ) . '</code>',
|
|
'<code>package-type</code>',
|
|
'<code>plugin</code>',
|
|
'<code>theme</code>',
|
|
'<code>generic</code>',
|
|
'<code>package-slug</code>'
|
|
);
|
|
?>
|
|
<br>
|
|
<?php esc_html_e( 'Note that UpdatePulse Server does not rely on the content of the payload to schedule a package download, so any type of event can be used to trigger the Webhook.', 'updatepulse-server' ); ?>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="webhooks">
|
|
<th>
|
|
<label for="upserv_vcs_check_delay"><?php esc_html_e( 'Remote Download Delay', 'updatepulse-server' ); ?></label>
|
|
</th>
|
|
<td>
|
|
<input type="number" min="0" id="upserv_vcs_check_delay" data-prop="check_delay" value="">
|
|
<p class="description">
|
|
<?php esc_html_e( 'Delay in minutes after which UpdatePulse Server must poll the Version Control System for package updates when the Webhook has been called.', 'updatepulse-server' ); ?><br>
|
|
<?php esc_html_e( 'Leave at 0 to schedule a package update during the cron run happening immediately after the Webhook was called.', 'updatepulse-server' ); ?>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="webhooks">
|
|
<th>
|
|
<label for="upserv_vcs_webhook_secret"><?php esc_html_e( 'VCS Webhook Secret', 'updatepulse-server' ); ?></label>
|
|
</th>
|
|
<td>
|
|
<input class="regular-text secret" type="password" autocomplete="new-password" id="upserv_vcs_webhook_secret" data-prop="webhook_secret" value="">
|
|
<p class="description">
|
|
<?php esc_html_e( 'Preferably a random string, the secret string included in the request by the Version Control System when calling the Webhook.', 'updatepulse-server' ); ?>
|
|
<br>
|
|
<strong><?php esc_html_e( 'WARNING: Changing this value WILL invalidate ALL the existing Webhooks set up in the Version Control System.', 'updatepulse-server' ); ?></strong>
|
|
<br>
|
|
<?php esc_html_e( 'After changing this setting, make sure to update the Webhooks secrets in the Version Control System.', 'updatepulse-server' ); ?></strong>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="check-frequency">
|
|
<th>
|
|
<label for="upserv_vcs_check_frequency"><?php esc_html_e( 'Remote update check frequency', 'updatepulse-server' ); ?></label>
|
|
</th>
|
|
<td>
|
|
<select id="upserv_vcs_check_frequency" data-prop="check_frequency">
|
|
<?php foreach ( $schedules as $display => $schedule ) : ?>
|
|
<option value="<?php echo esc_attr( $schedule['slug'] ); ?>"><?php echo esc_html( $display ); ?></option>
|
|
<?php endforeach; ?>
|
|
</select>
|
|
<p class="description">
|
|
<?php esc_html_e( 'How often UpdatePulse Server must poll the Version Control System for package updates - checking too often may slow down the server (recommended "Once Daily").', 'updatepulse-server' ); ?>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table class="form-table check-frequency">
|
|
<tr>
|
|
<th>
|
|
<label for="upserv_vcs_force_remove_schedules"><?php esc_html_e( 'Clear & reschedule remote updates', 'updatepulse-server' ); ?></label>
|
|
</th>
|
|
<td>
|
|
<input type="button" value="<?php print esc_attr_e( 'Force Clear & Reschedule', 'updatepulse-server' ); ?>" id="upserv_vcs_force_remove_schedules" class="button ajax-trigger" data-action="force_clean" data-type="schedules" data-selector="#upserv_vcs_list" />
|
|
<p class="description">
|
|
<?php esc_html_e( 'Clears & Reschedules remote updates for all the packages registered with this Version Control System.', 'updatepulse-server' ); ?>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<input type="hidden" name="upserv_settings_section" value="package-source">
|
|
<?php wp_nonce_field( 'upserv_plugin_options', 'upserv_plugin_options_handler_nonce' ); ?>
|
|
<p class="submit">
|
|
<input type="submit" name="upserv_options_save" value="<?php esc_attr_e( 'Save', 'updatepulse-server' ); ?>" class="button button-primary" />
|
|
</p>
|
|
</form>
|
|
</div>
|
|
<div id="upserv_modal_add_remote_source" class='upserv-modal upserv-modal-remote-sources hidden'>
|
|
<div class='upserv-modal-content'>
|
|
<div class='upserv-modal-header'>
|
|
<span class='upserv-modal-close'>×</span>
|
|
<h2><?php esc_html_e( 'Add a Remote Source', 'updatepulse-server' ); ?><span></span></h2>
|
|
</div>
|
|
<div class='upserv-modal-body'>
|
|
<table class="form-table form-settings">
|
|
<tr>
|
|
<th>
|
|
<label for="upserv_add_vcs_url"><?php esc_html_e( 'VCS URL', 'updatepulse-server' ); ?></label>
|
|
</th>
|
|
<td>
|
|
<input class="regular-text" type="text" id="upserv_add_vcs_url" data-prop="url" value="">
|
|
<p class="description">
|
|
<?php esc_html_e( 'The URL of the Version Control System where packages are hosted.', 'updatepulse-server' ); ?>
|
|
<br>
|
|
<?php
|
|
printf(
|
|
// translators: %1$s is <code>https://version-control-system.tld/identifier/</code>, %2$s is <code>identifier</code>
|
|
esc_html__( 'Must follow the following pattern: %1$s where %2$s is the user or the organisation name in case of Github, is the workspace name in case of Bitbucket, and is a group in case of Gitlab or a self-hosted instance of Gitlab (no support for Gitlab subgroups).', 'updatepulse-server' ),
|
|
'<code>https://version-control-system.tld/identifier/</code>',
|
|
'<code>identifier</code>'
|
|
);
|
|
?>
|
|
<br>
|
|
<?php
|
|
printf(
|
|
// translators: %1$s is <code>https://version-control-system.tld/identifier/package-slug/</code>, %2$s is <code>identifier</code>
|
|
esc_html__( 'Each package repository URL must follow the following pattern: %1$s; the package files must be located at the root of the repository, and in the case of WordPress plugins the main plugin file must follow the pattern %2$s.', 'updatepulse-server' ),
|
|
'<code>https://version-control-system.tld/identifier/package-slug/</code>',
|
|
'<code>package-slug.php</code>',
|
|
);
|
|
?>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
<label for="upserv_add_vcs_branch"><?php esc_html_e( 'Packages Branch Name', 'updatepulse-server' ); ?></label>
|
|
</th>
|
|
<td>
|
|
<input class="regular-text" type="text" id="upserv_add_vcs_branch" data-prop="branch" value="">
|
|
<p class="description">
|
|
<?php
|
|
printf(
|
|
// translators: %1$s line break, %2$s is <code>PUC_FORCE_BRANCH</code>, %3$s is <code>true</code>, %4$s is <code>wp-config.php</code>
|
|
esc_html__( 'The branch to download when getting remote packages from the Version Control System.%1$sIf the VCS supports releases or tags, they will be prioritised over the branch name (release first, then tag, then branch).%1$sTo bypass this behaviour and exclusively rely on the branch, set the %2$s constant to %3$s in %4$s.', 'updatepulse-server' ),
|
|
'<br/>',
|
|
'<code>PUC_FORCE_BRANCH</code>',
|
|
'<code>true</code>',
|
|
'<code>wp-config.php</code>'
|
|
);
|
|
?>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<div class="notice notice-error error hidden invalid-url" role="alert">
|
|
<p>
|
|
<?php esc_html_e( 'The URL is invalid.', 'updatepulse-server' ); ?>
|
|
</p>
|
|
</div>
|
|
<div class="notice notice-error error hidden invalid-branch" role="alert">
|
|
<p>
|
|
<?php esc_html_e( 'The branch name is invalid.', 'updatepulse-server' ); ?>
|
|
</p>
|
|
</div>
|
|
<p>
|
|
<button class="button" id="upserv_add_vcs"><?php esc_html_e( 'Add', 'updatepulse-server' ); ?></button>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
