/ 
PGXN-API-v0.20.2
River stage zero No dependents
/ PGXN::API::Sync

Name

PGXN::API::Sync - Sync from a PGXN mirror and update the index

Synopsis

use PGXN::API::Sync;
PGXN::API::Sync->new(
    source     => $source,
    rsync_path => $rsync_path,
    verbose    => $verbose,
)->run;

Description

This module provides the implementation for pgxn_api_sync, the command-line utility for syncing to a PGXN mirror and creating the API. It syncs to the specified PGXN rsync source URL, which should be a PGXN mirror server, and then verifies and unpacks newly-uploaded distributions and hands them off to PGXN::API::Indexer to index.

Class Interface

Constructor

new

my $sync = PGXN::API::Sync->new(%params);

Creates and returns a new PGXN::API::Sync object. The supported parameters are:

rsync_path

Path to the rsync executable. Defaults to rsync, which should work find if there is an executable with that name in your path.

source

An rsync URL specifying the source from which to sync. The source should be an rsync server serving up a PGXN mirror source as created or mirrored from a PGXN Manager server.

verbose

An incremental integer specifying the level of verbosity to use during a sync. By default, PGXN::API::Sync runs in quiet mode, where only errors are emitted to STDERR.

Instance Interface

Instance Methods

run

$sync->run;

Runs the sync, rsyncing from the source mirror server, verifying and unpacking distributions, and handing them off to the indexer for indexing. This is the main method called by pgxn_api_sync to just do the job.

run_rsync

$sync->run_rsync;

rsyncs from the source mirror server. Called by run.

update_index

$sync->update_index;

Parses the log generated by the execution of run_rsync() for new distribution META.json files and passes any found off to validate_distribution() and "add_distribution" in PGXN::API::Indexer for validation, unpacking, and indexing. Called internally by run().

regex_for_uri_template

my $regex = $sync->regex_for_uri_template('download');

Returns a regular expression that will match the path to a file in the rsync logs. The regular expression is created from a named URI template as loaded from the /index.json file synced from the mirror server. Used internally to parse the paths to distribution files from the rsync logs so that they can be validated, unpacked, and indexed.

download_for

my $download = $sync->download_for($meta);

Given the metadata loaded from a mirror server META.json file, returns the path to the download file for the distribution. Used internally by validate_distribution() to find the file to validate.

validate_distribution

my $params = $sync->validate_distribution($path_to_dist_meta);

Given the path to a distribution META.json file, this method validates the digest for the download file and unpacks it. Returns parameters suitable for passing to "add_distribution" in PGXN::Indexer for indexing.

digest_for

my $digest = $sync->digest_for($zipfile);

Returns the SHA-1 hex digest for a distribution file (or any file, really). Called by validate_distribution().

unzip

$sync->unzip($download, $meta);)

Given a download file for a distribution, and the metadata loaded from the META.json describing the download, this method unpacks the download under the src/ directory under the document root. Each file will be readable by all users. This provides the browsable file interface for the API server to serve. Called internally by validate_distribution().

Instance Accessors

rsync_path

my $rsync_path = $sync->rsync_path;
$sync->rsync_path($rsync_path);

Get or set the path to the rsync executable.

source

my $source = $sync->source;
$sync->source($source);

Get or set the source rsync URL from which to sync a PGXN mirror.

verbose

my $verbose = $sync->verbose;
$sync->verbose($verbose);

Get or set an incremental verbosity. The higher the integer specified, the more verbose the sync.

log_file

my $log_file = $sync->log_file;
$sync->log_file($log_file);

Get or set the path to use for the rsync log file. This file will then be parsed by update_index for new distributions to index.

mirror_uri_templates

my $templates = $pgxn->mirror_uri_templates;

Returns a hash reference of the URI templates loaded from the index.json file in the mirror root. The keys are the names of the templates, and the values are URI::Template objects.

Author

David E. Wheeler <david.wheeler@pgexperts.com>

Copyright and License

Copyright (c) 2011-2024 David E. Wheeler.

This module is free software; you can redistribute it and/or modify it under the PostgreSQL License.

Permission to use, copy, modify, and distribute this software and its documentation for any purpose, without fee, and without a written agreement is hereby granted, provided that the above copyright notice and this paragraph and the following two paragraphs appear in all copies.

In no event shall David E. Wheeler be liable to any party for direct, indirect, special, incidental, or consequential damages, including lost profits, arising out of the use of this software and its documentation, even if David E. Wheeler has been advised of the possibility of such damage.

David E. Wheeler specifically disclaims any warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The software provided hereunder is on an "as is" basis, and David E. Wheeler has no obligations to provide maintenance, support, updates, enhancements, or modifications.