NAME Alien::Build - Build external dependencies for use in CPAN VERSION version 0.03 SYNOPSIS my $build = Alien::Build->load('./alienfile'); $build->load_requires('configure'); $build->set_prefix('/usr/local'); $build->set_stage('/foo/mystage'); # needs to be absolute $build->load_requires($build->install_type); $build->download; $build->build; # files are now in /foo/mystage, it is your job (or # ExtUtils::MakeMaker, Module::Build, etc) to copy # those files into /usr/local DESCRIPTION NOTE: This is still experimental, and documentation is currently highly incomplete. This module provides tools for building external (non-CPAN) dependencies for CPAN. It is mainly designed to be used at install time of a CPAN client, and work closely with Alien::Base which is used at runtime. Note that you will usually not usually create a Alien::Build instance directly, but rather be using a thin installer layer, such as Alien::Build::MM (for use with ExtUtils::MakeMaker). One of the goals of this project is to remain installer agnostic. CONSTRUCTOR new my $build = Alien::Build->new; This creates a new empty instance of Alien::Build. Normally you will want to use load below to create an instance of Alien::Build from an alienfile recipe. PROPERTIES There are three main properties for Alien::Build. There are a number of properties documented here with a specific usage. Note that these properties may need to be serialized into something primitive like JSON that does not support: regular expressions, code references of blessed objects. If you are writing a plugin (Alien::Build::Plugin) you should use a prefix like "plugin_name" (where name is the name of your plugin) so that it does not interfere with other plugin or future versions of Alien::Build. For example, if you were writing Alien::Build::Plugin::Fetch::NewProtocol, please use the prefix plugin_fetch_newprotocol: sub init { my($self, $meta) = @_; $meta->prop( plugin_fetch_newprotocol_foo => 'some value' ); $meta->register_hook( some_hook => sub { my($build) = @_; $build->install_prop->{plugin_fetch_newprotocol_bar => 'some other value' ); $build->runtime_prop->{plugin_fetch_newprotocol_baz => 'and another value' ); } ); } If you are writing a alienfile recipe please use the prefix my_: use alienfile; meta_prop->{my_foo} = 'some value'; probe sub { my($build) = @_; $build->install_prop->{my_bar} = 'some other value'; $build->install_prop->{my_baz} = 'and another value'; }; Any property may be used from a command: probe [ 'some command %{alien.meta.plugin_fetch_newprotocol_foo}' ]; probe [ 'some command %{alien.install.plugin_fetch_newprotocol_bar}' ]; probe [ 'some command %{alien.runtime.plugin_fetch_newprotocol_baz}' ]; probe [ 'some command %{alien.meta.my_foo}' ]; probe [ 'some command %{alien.install.my_bar}' ]; probe [ 'some command %{alien.runtime.my_baz}' ]; meta_prop my $href = $build->meta_prop; my $href = Alien::Build->meta_prop; Meta properties have to do with the recipe itself, and not any particular instance that probes or builds that recipe. Meta properties can be changed from within an alienfile using the meta_prop directive, or from a plugin from its init method (though should NOT be modified from any hooks registered within that init method). This is not strictly enforced, but if you do not follow this rule your recipe will likely be broken. destdir Use the DESTDIR environment variable to stage your install before copying the files into blib. This is the preferred method of installing libraries because it improves reliability. This technique is supported by autoconf and others. install_prop my $href = $build->install_prop; Install properties are used during the install phase (either under share or system install). They are remembered for the entire install phase, but not kept around during the runtime phase. Thus they cannot be accessed from your Alien::Base based module. root The build root directory. This will be an absolute path. It is the absolute form of ./_alien by default. prefix The install time prefix. Under a destdir install this is the same as the runtime or final install location. Under a non-destdir install this is the stage directory (usually the appropriate share directory under blib). autoconf_prefix The prefix as understood by autoconf. This is only different on Windows Where MSYS is used and paths like C:/foo are represented as /C/foo which are understood by the MSYS tools, but not by Perl. You should only use this if you are using Alien::Build::Plugin::Autoconf in your alienfile. stage The stage directory where files will be copied. This is usually the root of the blib share directory. runtime_prop my $href = $build->runtime_prop; Runtime properties are used during the install and runtime phases (either under share or system install). This should include anything that you will need to know to use the library or tool during runtime, and shouldn't include anything that is no longer relevant once the install process is complete. cflags The compiler flags cflags_static The static compiler flags command The command name for tools where the name my differ from platform to platform. For example, the GNU version of make is usually make in Linux and gmake on FreeBSD. libs The library flags libs_static The static library flags version The version of the library or tool prefix The final install root. This is usually they share directory. install_type The install type. Is one of: system For when the library or tool is provided by the operating system, can be detected by Alien::Build, and is considered satisfactory by the alienfile recipe. share For when a system install is not possible, the library source will be downloaded from the internet or retrieved in another appropriate fashion and built. METHODS load my $build = Alien::Build->load($alienfile); This creates an Alien::Build instance with the given alienfile recipe. checkpoint $build->checkpoint; Save any install or runtime properties so that they can be reloaded on a subsequent run. This is useful if your build needs to be done in multiple stages from a Makefile, such as with ExtUtils::MakeMaker. resume my $build = Alien::Build->resume($alienfile, $root); Load a checkpointed Alien::Build instance. You will need the original alienfile and the build root (usually _alien). root my $dir = $build->root; This is just a shortcut for: my $root = $build->install_prop->{root}; Except that it will be created if it does not already exist. install_type my $type = $build->install_type; This will return the install type. (See the like named install property above for details). This method will call probe if it has not already been called. set_prefix $build->set_prefix($prefix); Set the final (unstaged) prefix. This is normally only called by Alien::Build::MM and similar modules. It is not intended for use from plugins or from an alienfile. set_stage $build->set_stage($dir); Sets the stage directory. This is normally only called by Alien::Build::MM and similar modules. It is not intended for use from plugins or from an alienfile. requires my $hash = $build->requires($phase); Returns a hash reference of the modules required for the given phase. Phases include: configure These modules must already be available when the alienfile is read. any These modules are used during either a system or share install. share These modules are used during the build phase of a share install. system These modules are used during the build phase of a system install. load_requires $build->load_requires($phase); This loads the appropriate modules for the given phase (see requires above for a description of the phases). probe my $install_type = $build->probe; Attempts to determine if the operating system has the library or tool already installed. If so, then the string system will be returned and a system install will be performed. If not, then the string share will be installed and the tool or library will be downloaded and built from source. If the environment variable ALIEN_INSTALL_TYPE is set, then that will force a specific type of install. If the detection logic cannot accommodate the install type requested then it will fail with an exception. download $build->download; Download the source, usually as a tarball, usually from the internet. Under a system install this does not do anything. fetch my $res = $build->fetch; my $res = $build->fetch($url); Fetch a resource using the fetch hook. Returns the same hash structure described below in the hook documentation. decode my $decoded_res = $build->decode($res); Decode the HTML or file listing returned by fetch. Returns the same hash structure described below in the hook documentation. prefer my $sorted_res = $build->prefer($res); Filter and sort candidates. The preferred candidate will be returned first in the list. The worst candidate will be returned last. Returns the same hash structure described below in the hook documentation. extract my $dir = $build->extract; my $dir = $build->extract($archive); Extracts the given archive into a fresh directory. This is normally called internally to Alien::Build, and for normal usage is not needed from a plugin or alienfile. build $build->build; Run the build step. It is expected that probe and download have already been performed. What it actually does depends on the type of install: share The source is extracted, and built as determined by the alienfile recipe. If there is a gather_share that will be executed last. system The gather_system hook will be executed. meta my $meta = Alien::Build->meta; my $meta = $build->meta; Returns the meta object for your Alien::Build class or instance. The meta object is a way to manipulate the recipe, and so any changes to the meta object should be made before the probe, download or build steps. HOOKS probe hook $meta->register_hook( probe => sub { my($build) = @_; return 'system' if ...; # system install return 'share'; # otherwise }); $meta->register_hook( probe => [ $command ] ); This hook should return the string system if the operating system provides the library or tool. It should return share otherwise. You can also use a command that returns true when the tool or library is available. For example for use with pkg-config: $meta->register_hook( probe => [ '%{pkgconf} --exists libfoo' ] ); Or if you needed a minimum version: $meta->register_hook( probe => [ '%{pkgconf} --atleast-version=1.00 libfoo' ] ); Note that this hook SHOULD NOT gather system properties, such as cflags, libs, versions, etc, because the probe hook will be skipped in the even the environment variable ALIEN_INSTALL_TYPE is set. The detection of these properties should instead be done by the gather_system hook, below. gather_system hook $meta->register_hook( gather_system => sub { my($build) = @_; $build->runtime_prop->{cflags} = ...; $build->runtime_prop->{libs} = ...; $build->runtime_prop->{version} = ...; }); This hook is called for a system install to determine the properties necessary for using the library or tool. These properties should be stored in the runtime_prop hash as shown above. Typical properties that are needed for libraries are cflags and libs. If at all possible you should also try to determine the version of the library or tool. download hook $meta->register_hook( download => sub { my($build) = @_; ... }); This hook is used to download from the internet the source. Either as an archive (like tar, zip, etc), or as a directory of files (git clone, etc). When the hook is called, the current working directory will be a new empty directory, so you can save the download to the current directory. If you store a single file in the directory, Alien::Build will assume that it is an archive, which will be processed by the extract hook below. If you store multiple files, Alien::Build will assume the current directory is the source root. If no files are stored at all, an exception with an appropriate diagnostic will be thrown. Note: If you register this hook, then the fetch, decode and prefer hooks will NOT be called. fetch hook package Alien::Build::Plugin::MyPlugin; use strict; use warnings; use Alien::Build::Plugin; use Carp (); has '+url' => sub { Carp::croak "url is required property" }; sub init { my($self, $meta) = @_; $meta->register_hook( fetch => sub { my($build, $url) = @_; ... } } 1; Used to fetch a resource. The first time it will be called without an argument, so the configuration used to find the resource should be specified by the plugin's properties. On subsequent calls the first argument will be a URL. Normally the first fetch will be to either a file or a directory listing. If it is a file then the content should be returned as a hash reference with the following keys: # content of file stored in Perl return { type => 'file', filename => $filename, content => $content, }; # content of file stored in the filesystem return { type => 'file', filename => $filename, path => $path, # full file system path to file }; If the URL points to a directory listing you should return it as either a hash reference containing a list of files: return { type => 'list', list => [ # filename: each filename should be just the # filename portion, no path or url. # url: each url should be the complete url # needed to fetch the file. { filename => $filename1, url => $url1 }, { filename => $filename2, url => $url2 }, ] }; or if the listing is in HTML format as a hash reference containing the HTML information: return { type => 'html', charset => $charset, # optional base => $base, # the base URL: used for computing relative URLs content => $content, # the HTML content }; or a directory listing (usually produced by ftp servers) as a hash reference: return { type => 'dir_listing', base => $base, content => $content, }; decode hook sub init { my($self, $meta) = @_; $meta->register_hook( decode => sub { my($build, $res) = @_; ... } } This hook takes a response hash reference from the fetch hook above with a type of html or dir_listing and converts it into a response hash reference of type list. In short it takes an HTML or FTP file listing response from a fetch hook and converts it into a list of filenames and links that can be used by the prefer hook to choose the correct file to download. See fetch for the specification of the input and response hash references. prefer hook sub init { my($self, $meta) = @_; $meta->register_hook( prefer => sub { my($build, $res) = @_; return { type => 'list', list => [sort @{ $res->{list} }], }; } } This hook sorts candidates from a listing generated from either the fetch or decode hooks. It should return a new list hash reference with the candidates sorted from best to worst. It may also remove candidates that are totally unacceptable. extract hook $meta->register_hook( extract => sub { my($build, $archive) = @_; ... }); patch hook $meta->register_hook( patch => sub { my($build) = @_; ... }); This hook is completely optional. If registered, it will be triggered after extraction and before build. It allows you to apply any patches or make any modifications to the source if they are necessary. build hook $meta->register_hook( build => sub { my($build) = @_; ... }); gather_share hook $meta->register_hook( register_hook => sub { my($build) = @_; ... }); META METHODS prop my $href = $build->meta->prop; my $href = Alien::Build->meta->prop; Meta properties. This is the same as calling meta_prop on the class or Alien::Build instance. filename my $filename = $build->meta->filename; my $filename = Alien::Build->meta->filename; add_requires $build->meta->add_requires($phase, $module => $version, ...); Alien::Build->meta->add_requires($phase, $module => $version, ...); interpolator my $interpolator = $build->meta->interpolator; my $interpolator = Alien::Build->interpolator; has_hook my $bool = $build->meta->has_hook($name); my $bool = Alien::Build->has_hook($name); register_hook $build->meta->register_hook($name, $instructions); Alien::Build->meta->register_hook($name, $instructions); default_hook $build->meta->default_hook($name, $instructions); Alien::Build->meta->default_hook($name, $instructions); around_hook $build->meta->around_hook($hook, $code); Alien::Build->meta->around_hook($name, $code); CONTRIBUTING Thank you for considering to contribute to my open source project! If you have a small patch please consider just submitting it. Doing so through the project GitHub is probably the best way: https://github.com/plicease/Alien-Build/issues If you have a more invasive enhancement or bugfix to contribute, please take the time to review these guidelines. In general it is good idea to work closely with the Alien::Build developers, and the best way to contact them is on the #native IRC channel on irc.perl.org. History Joel Berger wrote the original Alien::Base. This distribution included the runtime code Alien::Base and an installer class Alien::Base::ModuleBuild. The significant thing about Alien::Base was that it provided tools to make it relatively easy for people to roll their own Alien distributions. Over time, the Perl5-Alien (github organization) or "Alien::Base team" has taken over development of Alien::Base with myself (Graham Ollis) being responsible for integration and releases. Joel Berger is still involved in the project. Since the original development of Alien::Base, Module::Build, on which Alien::Base::ModuleBuild is based, has been removed from the core of Perl. It seemed worthwhile to write a replacement installer that works with ExtUtils::MakeMaker which IS still bundled with the Perl core. Because this is a significant undertaking it is my intention to integrate the many lessons learned by Joel Berger, myself and the "Alien::Base team" as possible. If the interface seems good then it is because I've stolen the ideas from some pretty good places. Philosophy avoid dependencies One of the challenges with Alien development is that you are by the nature of the problem, trying to make everyone happy. Developers working out of CPAN just want stuff to work, and some build environments can be hostile in terms of tool availability, so for reliability you end up pulling a lot of dependencies. On the other hand, operating system vendors who are building Perl modules usually want to use the system version of a library so that they do not have to patch libraries in multiple places. Such vendors have to package any extra dependencies and having to do so for packages that the don't even use makes them understandably unhappy. As general policy the Alien::Build core should have as few dependencies as possible, and should only pull extra dependencies if they are needed. Where dependencies cannot be avoidable, popular and reliable CPAN modules, which are already available as packages in the major Linux vendors (Debian, Red Hat) should be preferred. As such Alien::Build is hyper aggressive at using dynamic prerequisites. interface agnostic One of the challenges with Alien::Buil::ModuleBuild was that Module::Build was pulled from the core. In addition, there is a degree of hostility toward Module::Build in some corners of the Perl community. I agree with Joel Berger's rationale for choosing Module::Build at the time, as I believe its interface more easily lends itself to building Alien distributions. That said, an important feature of Alien::Build is that it is installer agnostic. Although it is initially designed to work with ExtUtils::MakeMaker, it has been designed from the ground up to work with any installer (Perl, or otherwise). As an extension of this, although Alien::Build may have external CPAN dependencies, they should not be exposed to developers USING Alien::Build. As an example, Path::Tiny is used heavily internally because it does what File::Spec does, plus the things that it doesn't, and uses forward slashes on Windows (backslashes are the "correct separator on windows, but actually using them tends to break everything). However, there aren't any interfaces in Alien::Build that will return a Path::Tiny object (or if there are, then this is a bug). This means that if we ever need to port Alien::Build to a platform that doesn't support Path::Tiny (such as VMS), then it may require some work to Alien::Build itself, modules that USE Alien::Build shouldn't need to be modified. plugable The actual logic that probes the system, downloads source and builds it should be as pluggable as possible. One of the challenges with Alien::Build::ModuleBuild was that it was designed to work well with software that works with autoconf and pkg-config. While you can build with other tools, you have to know a bit of how the installer logic works, and which hooks need to be tweaked. Alien::Build has plugins for autoconf, pkgconf (successor of pkg-config), vanilla Makefiles, and CMake. If your build system doesn't have a plugin, then all you have to do is write one! Plugins that prove their worth may be merged into the Alien::Build core. Plugins that after a while feel like maybe not such a good idea may be removed from the core, or even from CPAN itself. In addition, Alien::Build has a special type of plugin, called a negotiator which picks the best plugin for the particular environment that it is running in. This way, as development of the negotiator and plugins develop over time modules that use Alien::Build will benefit, without having to change the way they interface with Alien::Build ACKNOWLEDGEMENT I would like to that Joel Berger for getting things running in the first place. Also important to thank other members of the "Alien::Base team": Zaki Mughal (SIVOAIS) Ed J (ETJ, mohawk) Also kind thanks to all of the developers who have contributed to Alien::Base over the years: https://metacpan.org/pod/Alien::Base#CONTRIBUTORS SEE ALSO alienfile, Alien::Build::MM, Alien::Build::Plugin, Alien::Base, Alien AUTHOR Graham Ollis COPYRIGHT AND LICENSE This software is copyright (c) 2017 by Graham Ollis. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.