diff --git a/modules/ksb/Module.pm b/modules/ksb/Module.pm index dcf14eb..1391541 100644 --- a/modules/ksb/Module.pm +++ b/modules/ksb/Module.pm @@ -1,1165 +1,1168 @@ package ksb::Module 0.20; # Class: Module # # Represents a source code module of some sort, which can be updated, built, # and installed. Includes a stringifying overload and can be sorted amongst # other ksb::Modules. use 5.014; use warnings; no if $] >= 5.018, 'warnings', 'experimental::smartmatch'; use parent qw(ksb::OptionsBase); use ksb::Debug; use ksb::Util; use ksb::Updater::Svn; use ksb::Updater::Git; use ksb::Updater::Bzr; use ksb::Updater::KDEProject; use ksb::Updater::KDEProjectMetadata; use ksb::BuildException 0.20; use ksb::BuildSystem 0.30; use ksb::BuildSystem::Autotools; use ksb::BuildSystem::QMake; use ksb::BuildSystem::Qt4; use ksb::BuildSystem::KDE4; use ksb::BuildSystem::CMakeBootstrap; use ksb::ModuleSet::Null; use Mojo::Promise; use Mojo::IOLoop; use POSIX qw(_exit :errno_h); use Storable qw(dclone thaw); use Carp 'confess'; use Scalar::Util 'blessed'; use overload '""' => 'toString', # Add stringify operator. '<=>' => 'compare', ; my $ModuleSource = 'config'; sub new { my ($class, $ctx, $name) = @_; croak_internal ("Empty ksb::Module constructed") unless $name; my $self = ksb::OptionsBase::new($class); # If building a BuildContext instead of a ksb::Module, then the context # can't have been setup yet... my $contextClass = 'ksb::BuildContext'; if ($class ne $contextClass && (!blessed($ctx) || !$ctx->isa($contextClass))) { croak_internal ("Invalid context $ctx"); } # Clone the passed-in phases so we can be different. my $phases = dclone($ctx->phases()) if $ctx; my %newOptions = ( name => $name, scm_obj => undef, build_obj => undef, phases => $phases, context => $ctx, 'module-set' => undef, ); $self->installPhasePromises() if $class eq 'ksb::Module'; # alias our options into the build context for global vis $ctx->{build_options}->{$name} = $self->{options}; @{$self}{keys %newOptions} = values %newOptions; return $self; } sub phases { my $self = shift; return $self->{phases}; } sub moduleSet { my ($self) = @_; $self->{'module-set'} //= ksb::ModuleSet::Null->new(); return $self->{'module-set'}; } sub setModuleSet { my ($self, $moduleSetName) = @_; $self->{'module-set'} = $moduleSetName; } sub setModuleSource { my ($class, $source) = @_; $ModuleSource = $source; } sub moduleSource { my $class = shift; # Should be 'config' or 'cmdline'; return $ModuleSource; } # Subroutine to retrieve a subdirectory path with tilde-expansion and # relative path handling. # The parameter is the option key (e.g. build-dir or log-dir) to read and # interpret. sub getSubdirPath { my ($self, $subdirOption) = @_; my $dir = $self->getOption($subdirOption); # If build-dir starts with a slash, it is an absolute path. return $dir if $dir =~ /^\//; # Make sure we got a valid option result. if (!$dir) { confess ("Reading option for $subdirOption gave empty \$dir!"); } # If it starts with a tilde, expand it out. if ($dir =~ /^~/) { $dir =~ s/^~/$ENV{'HOME'}/; } else { # Relative directory, tack it on to the end of $kdesrcdir. my $kdesrcdir = $self->getOption('source-dir'); $dir = "$kdesrcdir/$dir"; } return $dir; } # Method: getInstallPathComponents # # Returns the directory that a module should be installed in. # # NOTE: The return value is a hash. The key 'module' will return the final # module name, the key 'path' will return the full path to the module. The # key 'fullpath' will return their concatenation. # # For example, with $module == 'KDE/kdelibs', and no change in the dest-dir # option, you'd get something like: # # > { # > 'path' => '/home/user/kdesrc/KDE', # > 'module' => 'kdelibs', # > 'fullpath' => '/home/user/kdesrc/KDE/kdelibs' # > } # # If dest-dir were changed to e.g. extragear-multimedia, you'd get: # # > { # > 'path' => '/home/user/kdesrc', # > 'module' => 'extragear-multimedia', # > 'fullpath' => '/home/user/kdesrc/extragear-multimedia' # > } # # Parameters: # pathType - Either 'source' or 'build'. # # Returns: # hash (Not a hashref; See description). sub getInstallPathComponents { my $module = assert_isa(shift, 'ksb::Module'); my $type = shift; my $destdir = $module->destDir(); my $srcbase = $module->getSourceDir(); $srcbase = $module->getSubdirPath('build-dir') if $type eq 'build'; my $combined = "$srcbase/$destdir"; # Remove dup // $combined =~ s/\/+/\//; my @parts = split(/\//, $combined); my %result = (); $result{'module'} = pop @parts; $result{'path'} = join('/', @parts); $result{'fullpath'} = "$result{path}/$result{module}"; my $compatDestDir = $module->destDir($module->name()); my $fullCompatPath = "$srcbase/$compatDestDir"; # We used to have code here to migrate very old directory layouts. It was # removed as of about 2013-09-29. return %result; } # Do note that this returns the *base* path to the source directory, # without the module name or kde_projects stuff appended. If you want that # use subroutine fullpath(). sub getSourceDir { my $self = shift; return $self->getSubdirPath('source-dir'); } sub name { my $self = shift; return $self->{name}; } sub scm { my $self = shift; return $self->{scm_obj} if $self->{scm_obj}; # Look for specific setting of repository and svn-server. If both is # set it's a bug, if one is set, that's the type (because the user says # so...). Don't use getOption($key) as it will try to fallback to # global options. my $svn_status = $self->getOption('svn-server', 'module'); my $repository = $self->getOption('repository', 'module') // ''; my $rcfile = $self->buildContext()->rcFile(); if ($svn_status && $repository) { error (<{scm_obj} = ksb::Updater::Bzr->new($self); } # If it needs a repo it's git. Everything else is svn for now. $self->{scm_obj} //= $repository ? ksb::Updater::Git->new($self) : ksb::Updater::Svn->new($self); return $self->{scm_obj}; } sub setScmType { my ($self, $scmType) = @_; my $newType; given($scmType) { when('git') { $newType = ksb::Updater::Git->new($self); } when('proj') { $newType = ksb::Updater::KDEProject->new($self); } when('metadata') { $newType = ksb::Updater::KDEProjectMetadata->new($self); } # when('l10n') { $newType = ksb::l10nSystem->new($self); } when('svn') { $newType = ksb::Updater::Svn->new($self); } when('bzr') { $newType = ksb::Updater::Bzr->new($self); } default { $newType = undef; } } $self->{scm_obj} = $newType; } # Returns a string describing the scm platform of the given module. # Return value: 'git' or 'svn' at this point, as appropriate. sub scmType { my $self = shift; return $self->scm()->name(); } sub currentScmRevision { my $self = shift; return $self->scm()->currentRevisionInternal(); } # Returns a new build system object, given the appropriate name. # This is a sub-optimal way to fix the problem of allowing users to override # the detected build system (we could instead use introspection to figure out # available build systems at runtime). However, KISS... sub buildSystemFromName { my ($self, $name) = @_; my %buildSystemClasses = ( 'generic' => 'ksb::BuildSystem', 'qmake' => 'ksb::BuildSystem::QMake', 'cmake-bootstrap' => 'ksb::BuildSystem::CMakeBootstrap', 'kde' => 'ksb::BuildSystem::KDE4', 'qt' => 'ksb::BuildSystem::Qt4', 'autotools' => 'ksb::BuildSystem::Autotools', ); my $class = $buildSystemClasses{lc $name} // undef; return $class->new($self) if ($class); # Past here, no class found croak_runtime("Invalid build system $name requested"); } sub buildSystem { my $self = shift; if ($self->{build_obj} && $self->{build_obj}->name() ne 'generic') { return $self->{build_obj}; } if (my $userBuildSystem = $self->getOption('override-build-system')) { $self->{build_obj} = $self->buildSystemFromName($userBuildSystem); return $self->{build_obj}; } # If not set, let's guess. my $buildType; my $sourceDir = $self->fullpath('source'); if (($self->getOption('repository') =~ /gitorious\.org\/qt\//) || ($self->getOption('repository') =~ /^kde:qt$/) || (-e "$sourceDir/bin/syncqt")) { $buildType = ksb::BuildSystem::Qt4->new($self); } # This test must come before the KDE buildsystem's as cmake's own # bootstrap system also has CMakeLists.txt if (!$buildType && (-e "$sourceDir/CMakeLists.txt") && (-e "$sourceDir/bootstrap")) { $buildType = ksb::BuildSystem::CMakeBootstrap->new($self); } if (!$buildType && (-e "$sourceDir/CMakeLists.txt" || $self->getOption('#xml-full-path'))) { $buildType = ksb::BuildSystem::KDE4->new($self); } # We have to assign to an array to force glob to return all results, # otherwise it acts like a non-reentrant generator whose output depends on # how many times it's been called... if (!$buildType && (my @files = glob ("$sourceDir/*.pro"))) { $buildType = ksb::BuildSystem::QMake->new($self); } # 'configure' is a popular fall-back option even for other build # systems so ensure we check last for autotools. if (!$buildType && (-e "$sourceDir/configure" || -e "$sourceDir/autogen.sh")) { $buildType = ksb::BuildSystem::Autotools->new($self); } # Don't just assume the build system is KDE-based... $buildType //= ksb::BuildSystem->new($self); $self->{build_obj} = $buildType; return $self->{build_obj}; } # Sets the build system **object**, although you can find the build system # type afterwards (see buildSystemType). sub setBuildSystem { my ($self, $obj) = @_; assert_isa($obj, 'ksb::BuildSystem'); $self->{build_obj} = $obj; } # Current possible build system types: # KDE (i.e. cmake), Qt, l10n (KDE language buildsystem), autotools (either # configure or autogen.sh). A final possibility is 'pendingSource' which # simply means that we don't know yet. # # If the build system type is not set ('pendingSource' counts as being # set!) when this function is called then it will be autodetected if # possible, but note that not all possible types will be detected this way. # If in doubt use setBuildSystemType sub buildSystemType { my $self = shift; return $self->buildSystem()->name(); } # Creates the Mojo::Promises corresponding to each named phase. # E.g. the 'update' phase would be mapped to a sequence of subs to be executed # for the update. sub installPhasePromises { # Make our normal "self" a name unlikely to be used in a closure # below by mistake my $misnamedSelf = shift; # Each phase either maps directly to a subroutine which can # block (and whose return value will have a default handler), # or can map to an array of exactly 2 subroutines. The first # sub would be the blocking handler, the second sub is a # custom handler for the result. # Both subs are passed the module as the first param my %phaseBuilders = ( # Always runs, always first, the appropriate subsequent phase will # be linked to this one (based on --no-src, --install-only, etc.) start => sub { my $self = shift; my %pathinfo = $self->getInstallPathComponents('build'); super_mkdir($pathinfo{'path'}); return 1; }, # update => [ # See Application.pm for its custom runPhase_p # ], buildsystem => [ sub { my $self = shift; return $self->setupBuildSystem(); }, sub { my ($self, $was_successful) = @_; return Mojo::Promise->new->reject('Unable to setup build system') unless $was_successful; return $was_successful; } ], build => [ sub { # called in child process, can block my $self = shift; return $self->buildSystem()->buildInternal(); }, sub { # called in this process, with results my ($self, $was_successful) = @_; $self->setPersistentOption('last-build-rev', $self->currentScmRevision()); return 1 if $was_successful; return Mojo::Promise->new->reject('Build failed'); }, ], test => sub { my $self = shift; if ($self->getOption('run-tests')) { # TODO: Make test failure a blocker for install? $self->buildSystem()->runTestsuite(); } return 1; }, install => sub { my $self = shift; if ($self->getOption('install-after-build')) { return 0 if !$self->install(); } return 1; }, ); $misnamedSelf->{builders} = \%phaseBuilders; } # Subroutine to build this module. # Returns a promise that resolves to true (on success) or rejects with a error # string sub build { my $self = assert_isa(shift, 'ksb::Module'); my $moduleName = $self->name(); my %pathinfo = $self->getInstallPathComponents('build'); my $builddir = $pathinfo{'fullpath'}; my $buildSystem = $self->buildSystem(); return Mojo::Promise->new->reject('There is no build system to use') if ($buildSystem->name() eq 'generic' && !pretending()); # Ensure we're in a known directory before we start; some options remove # the old build directory that a previous module might have been using. super_mkdir($pathinfo{'path'}); p_chdir($pathinfo{'path'}); my $buildSystemPromise = $self->runPhase_p('buildsystem'); return $buildSystemPromise if $self->getOption('build-system-only'); # If we don't stop with the build system only, then keep extending that # promise chain to complete the build, test, and install return $buildSystemPromise->then(sub { return $self->runPhase_p('build'); })->then(sub { return $self->runPhase_p('test'); })->then(sub { return $self->runPhase_p('install'); }); } # Subroutine to setup the build system in a directory. # Returns boolean true on success, boolean false (0) on failure. sub setupBuildSystem { my $self = assert_isa(shift, 'ksb::Module'); my $moduleName = $self->name(); my $buildSystem = $self->buildSystem(); if ($buildSystem->name() eq 'generic' && !pretending()) { croak_internal('Build system determination still pending when build attempted.'); } my $refreshReason = $buildSystem->needsRefreshed(); if ($refreshReason ne "") { # Check to see if we're actually supposed to go through the # cleaning process. if (!$self->getOption('#cancel-clean') && !$buildSystem->cleanBuildSystem()) { warning ("\tUnable to clean r[$self]!"); return 0; } } if (!$buildSystem->createBuildSystem()) { error ("\tError creating r[$self]'s build system!"); return 0; } # Now we're in the checkout directory # So, switch to the build dir. # builddir is automatically set to the right value for qt p_chdir ($self->fullpath('build')); if (!$buildSystem->configureInternal()) { error ("\tUnable to configure r[$self] with " . $self->buildSystemType()); # Add undocumented ".refresh-me" file to build directory to flag # for --refresh-build for this module on next run. See also the # "needsRefreshed" subroutine. if (open my $fh, '>', '.refresh-me') { say $fh "# Build directory will be re-generated next kdesrc-build run"; say $fh "# due to failing to complete configuration on the last run"; close $fh; }; return 0; } return 1; } # Responsible for installing the module (no update, build, etc.) # Return value: Boolean flag indicating whether module installed successfully or # not. # Exceptions may be thrown for abnormal conditions (e.g. no build dir exists) sub install { my $self = assert_isa(shift, 'ksb::Module'); my $builddir = $self->fullpath('build'); my $buildSysFile = $self->buildSystem()->configuredModuleFileName(); if (!pretending() && ! -e "$builddir/$buildSysFile") { warning ("\tThe build system doesn't exist for r[$self]."); warning ("\tTherefore, we can't install it. y[:-(]."); return 0; } $self->setupEnvironment(); my @makeInstallOpts = split(' ', $self->getOption('make-install-prefix')); # We can optionally uninstall prior to installing # to weed out old unused files. if ($self->getOption('use-clean-install') && $self->getPersistentOption('last-install-rev')) { if (!$self->buildSystem()->uninstallInternal(@makeInstallOpts)) { warning ("\tUnable to uninstall r[$self] before installing the new build."); warning ("\tContinuing anyways..."); } else { $self->unsetPersistentOption('last-install-rev'); } } if (!$self->buildSystem()->installInternal(@makeInstallOpts)) { error ("\tUnable to install r[$self]!"); $self->buildContext()->markModulePhaseFailed('install', $self); return 0; } if (pretending()) { pretend ("\tWould have installed g[$self]"); return 1; } # Past this point we know we've successfully installed, for real. $self->setPersistentOption('last-install-rev', $self->currentScmRevision()); my $remove_setting = $self->getOption('remove-after-install'); # Possibly remove the srcdir and builddir after install for users with # a little bit of HD space. if($remove_setting eq 'all') { # Remove srcdir my $srcdir = $self->fullpath('source'); note ("\tRemoving b[r[$self source]."); safe_rmtree($srcdir); } if($remove_setting eq 'builddir' || $remove_setting eq 'all') { # Remove builddir note ("\tRemoving b[r[$self build directory]."); safe_rmtree($builddir); # We're likely already in the builddir, so chdir back to the root p_chdir('/'); } return 1; } # Handles uninstalling this module (or its sub-directories as given by the checkout-only # option). # # Returns boolean false on failure, boolean true otherwise. sub uninstall { my $self = assert_isa(shift, 'ksb::Module'); my $builddir = $self->fullpath('build'); my $buildSysFile = $self->buildSystem()->configuredModuleFileName(); if (!pretending() && ! -e "$builddir/$buildSysFile") { warning ("\tThe build system doesn't exist for r[$self]."); warning ("\tTherefore, we can't uninstall it."); return 0; } $self->setupEnvironment(); my @makeInstallOpts = split(' ', $self->getOption('make-install-prefix')); if (!$self->buildSystem()->uninstallInternal(@makeInstallOpts)) { error ("\tUnable to uninstall r[$self]!"); $self->buildContext()->markModulePhaseFailed('install', $self); return 0; } if (pretending()) { pretend ("\tWould have uninstalled g[$self]"); return 1; } $self->unsetPersistentOption('last-install-rev'); return 1; } sub buildContext { my $self = shift; return $self->{context}; } # Integrates 'set-env' option to the build context environment sub applyUserEnvironment { my $self = assert_isa(shift, 'ksb::Module'); my $ctx = $self->buildContext(); # Let's see if the user has set env vars to be set. # Note the global set-env must be checked separately anyways, so # we limit inheritance when searching. my $env_hash_ref = $self->getOption('set-env', 'module'); while (my ($key, $value) = each %{$env_hash_ref}) { $ctx->queueEnvironmentVariable($key, $value); } } # Establishes proper build environment in the build context. Should be run # before forking off commands for e.g. updates, builds, installs, etc. sub setupEnvironment { my $self = assert_isa(shift, 'ksb::Module'); my $ctx = $self->buildContext(); my $kdedir = $self->getOption('kdedir'); my $prefix = $self->installationPath(); # Add global set-envs and context $self->buildContext()->applyUserEnvironment(); # Avoid moving /usr up in env vars if ($kdedir ne '/usr') { my @pkg_config_dirs = ("$kdedir/lib/pkgconfig"); $ctx->prependEnvironmentValue('PKG_CONFIG_PATH', @pkg_config_dirs); my @ld_dirs = ("$kdedir/lib", $self->getOption('libpath')); $ctx->prependEnvironmentValue('LD_LIBRARY_PATH', @ld_dirs); my @path = ("$kdedir/bin", $self->getOption('binpath')); $ctx->prependEnvironmentValue('PATH', @path); } # Build system's environment injection my $buildSystem = $self->buildSystem(); $buildSystem->prepareModuleBuildEnvironment($ctx, $self, $prefix); # Read in user environment defines $self->applyUserEnvironment() unless $self == $ctx; } # Returns the path to the log directory used during this run for this # ksb::Module, based on an autogenerated unique id. The id doesn't change # once generated within a single run of the script. sub getLogDir { my ($self) = @_; return $self->buildContext()->getLogDirFor($self); } # Returns a full path that can be open()'d to write a log # file, based on the given basename (with extension). # Updates the 'latest' symlink as well, unlike getLogDir # Use when you know you're going to create a new log sub getLogPath { my ($self, $path) = @_; return $self->buildContext()->getLogPathFor($self, $path); } sub toString { my $self = shift; return $self->name(); } sub compare { my ($self, $other) = @_; return $self->name() cmp $other->name(); } # Throws an exception on error, otherwise returns number of updates known to # have occurred. Only returns 0 if we positively know from the scm that no # update occurred. sub update { my ($self, $ctx) = @_; my $module_src_dir = $self->getSourceDir(); my $kdesrc = $ctx->getSourceDir(); if ($kdesrc ne $module_src_dir && !super_mkdir($module_src_dir)) { # This module has a different source directory, ensure it exists. croak_runtime ("Unable to create separate source directory for $self at $module_src_dir"); } # Use 1 as default value to force a rebuild if we can't determine there # were truly *no* updates my $count = $self->scm()->updateInternal() // 1; # Need to help calling code figure out that 0 is an OK return value from this method. # TODO: Consistently use exceptions in runPhase-based code so this isn't needed. # TODO: Require updateInternal to set appropriate msg for scm (files, commits, etc.) return $count ? $count : '0 but true'; } # OVERRIDE # # This calls OptionsBase::setOption and performs any Module-specific # handling. sub setOption { my ($self, %options) = @_; # Ensure we don't accidentally get fed module-set options for (qw(git-repository-base use-modules ignore-modules)) { if (exists $options{$_}) { error (" r[b[*] module b[$self] should be declared as module-set to use b[$_]"); die ksb::BuildException::Config->new($_, "Option $_ can only be used in module-set"); }; } # Special case handling. if (exists $options{'filter-out-phases'}) { for my $phase (split(' ', $options{'filter-out-phases'})) { $self->phases()->filterOutPhase($phase); } delete $options{'filter-out-phases'}; } # When running in a subprocess, option changes will be forgotten unless they are fed # back to parent process, so store those in a special array also. if (exists $self->buildContext()->{'#pending'}) { # Only forward 'plain' options, just a sanity check my @keys = grep { !ref($options{$_}) } (keys %options); $self->{options}->{'#pending'} //= { }; @{$self->{options}->{'#pending'}}{@keys} = @options{@keys}; } $self->SUPER::setOption(%options); } # OVERRIDE # # This subroutine returns an option value for a given module. Some globals # can't be overridden by a module's choice (but see 2nd parameter below). # If so, the module's choice will be ignored, and a warning will be issued. # # Option names are case-sensitive! # # Some options (e.g. cmake-options, configure-flags) have the global value # and then the module's own value appended together. To get the actual # module setting you must use the level limit parameter set to 'module'. # # Likewise, some qt module options do not obey the previous proviso since # Qt options are not likely to agree nicely with generic KDE buildsystem # options. # # 1st parameter: Name of option # 2nd parameter: Level limit (optional). If not present, then the value # 'allow-inherit' is used. Options: # - allow-inherit: Module value is used if present (with exceptions), # otherwise global is used. # - module: Only module value is used (if you want only global then use the # buildContext) NOTE: This overrides global "sticky" options as well! sub getOption { my ($self, $key, $levelLimit) = @_; my $ctx = $self->buildContext(); $levelLimit //= 'allow-inherit'; # Some global options would probably make no sense applied to Qt. my @qtCopyOverrides = qw(branch configure-flags tag cxxflags); if (list_has(\@qtCopyOverrides, $key) && $self->buildSystemType() eq 'Qt') { $levelLimit = 'module'; } assert_in($levelLimit, [qw(allow-inherit module)]); # If module-only, check that first. return $self->{options}{$key} if $levelLimit eq 'module'; # Some global options always override module options. return $ctx->getOption($key) if $ctx->hasStickyOption($key); # Some options append to the global (e.g. conf flags) my @confFlags = qw(cmake-options configure-flags cxxflags); if (list_has(\@confFlags, $key) && $ctx->hasOption($key)) { return $ctx->getOption($key) . " " . ($self->{options}{$key} || ''); } # Everything else overrides the global option, unless it's simply not # set at all. return $self->{options}{$key} // $ctx->getOption($key); } # Gets persistent options set for this module. First parameter is the name # of the option to lookup. Undef is returned if the option is not set, # although even if the option is set, the value returned might be empty. # Note that ksb::BuildContext also has this function, with a slightly # different signature, which OVERRIDEs this function since Perl does not # have parameter-based method overloading. sub getPersistentOption { my ($self, $key) = @_; return $self->buildContext()->getPersistentOption($self->name(), $key); } # Sets a persistent option (i.e. survives between processes) for this module. # First parameter is the name of the persistent option. # Second parameter is its actual value. # See the warning for getPersistentOption above, it also applies for this # method vs. ksb::BuildContext::setPersistentOption sub setPersistentOption { my ($self, $key, $value) = @_; return $self->buildContext()->setPersistentOption($self->name(), $key, $value); } # Unsets a persistent option for this module. # Only parameter is the name of the option to unset. sub unsetPersistentOption { my ($self, $key) = @_; $self->buildContext()->unsetPersistentOption($self->name(), $key); } # Returns the path to the desired directory type (source or build), # including the module destination directory itself. sub fullpath { my ($self, $type) = @_; assert_in($type, [qw/build source/]); my %pathinfo = $self->getInstallPathComponents($type); return $pathinfo{'fullpath'}; } # Returns the "full kde-projects path" for the module. As should be obvious by # the description, this only works for modules with an scm type that is a # Updater::KDEProject (or its subclasses). sub fullProjectPath { my $self = shift; my $path = $self->getOption('#xml-full-path', 'module') || croak_internal("Tried to ask for full path of a module $self that doesn't have one!"); return $path; } # Returns true if this module is (or was derived from) a kde-projects module. sub isKDEProject { my $self = shift; return $self->hasOption('#xml-full-path'); } # Subroutine to return the name of the destination directory for the # checkout and build routines. Based on the dest-dir option. The return # value will be relative to the src/build dir. The user may use the # '$MODULE' or '${MODULE}' sequences, which will be replaced by the name of # the module in question. # # The first parameter is optional, but if provided will be used as the base # path to replace $MODULE entries in dest-dir. sub destDir { my $self = assert_isa(shift, 'ksb::Module'); my $destDir = $self->getOption('dest-dir'); my $basePath = ""; if ($self->getOption('ignore-kde-structure')) { $basePath = $self->name(); } else { $basePath = shift // $self->getOption('#xml-full-path'); $basePath ||= $self->name(); # Default if not provided in repo-metadata } $destDir =~ s/(\$\{MODULE})|(\$MODULE\b)/$basePath/g; return $destDir; } # Subroutine to return the installation path of a given module (the value # that is passed to the CMAKE_INSTALL_PREFIX CMake option). # It is based on the "prefix" and, if it is not set, the "kdedir" option. # The user may use '$MODULE' or '${MODULE}' in the "prefix" option to have # them replaced by the name of the module in question. sub installationPath { my $self = assert_isa(shift, 'ksb::Module'); my $path = $self->getOption('prefix'); if (!$path) { return $self->getOption('kdedir'); } my $moduleName = $self->name(); $path =~ s/(\$\{MODULE})|(\$MODULE\b)/$moduleName/g; return $path; } # Supports the subprocess handler in runPhase_p by reading messages that were # generated by the child process and sent back to us, and dispatching to # handler for real-time updates. Messages that can wait until the subprocess is # complete are handled separately. sub _readAndDispatchInProcessMessages { my ($self, $frozen_message, $monitor, $phaseName) = @_; my $linesRef = eval { thaw($frozen_message) }; croak_internal("Failed to read msg from child handler: $@") unless $linesRef; if (exists $linesRef->{message}) { $monitor->noteLogEvents("$self", $phaseName, [$linesRef->{message}]); } elsif (exists $linesRef->{progress}) { my ($x, $y) = @{$linesRef->{progress}}; $monitor->markPhaseProgress("$self", $phaseName, $x / $y) if $y > 0; } else { croak_internal("Couldn't handle message $frozen_message from child."); } } # Runs the given phase in a separate subprocess, using provided sub references. # Assumes use of promises for the provided sub references -- if launching the # subprocess fails, then a rejected promise is returned in the completion sub # reference # Returns a promise that yields the return value of the completion sub # reference. sub runPhase_p { my ($self, $phaseName, $blocking_coderef, $completion_coderef) = @_; my $phaseSubs = $self->{builders}->{$phaseName}; if (ref($phaseSubs) eq 'CODE') { $blocking_coderef //= $phaseSubs; } elsif (ref($phaseSubs) eq 'ARRAY') { ($blocking_coderef, $completion_coderef) = @{$phaseSubs}; croak_internal("Missing subs for $phaseName") unless ($blocking_coderef && $completion_coderef); } else { croak_internal("self->builders->{$phaseName} should not be set") if defined $phaseSubs; } # Default handler $completion_coderef //= sub { my ($module, $result) = (@_); return Mojo::Promise->new->reject unless $result; return $result; }; my $promise = Mojo::Promise->new; my $ctx = $self->buildContext(); pipe (my $reader, my $writer) or croak_runtime("Couldn't open pipe to subprocess for $phaseName: $!"); # Setup a pipe from child to parent so we can get updates as the phase # progresses, logs, etc. my $reactor = Mojo::IOLoop->singleton->reactor; my $monitor = $self->buildContext()->statusMonitor(); + my $reactorPromise = Mojo::Promise->new; $reactor->io($reader => sub { my ($reactor) = @_; my $buffer; if ((my $lengthRead = $reader->sysread($buffer, 8192)) == 0) { # eof $reactor->remove($reader); close $reader; + $reactorPromise->resolve; } elsif ($lengthRead > 0) { $self->_readAndDispatchInProcessMessages($buffer, $monitor, $phaseName); } else { croak_runtime("Error reading from child pipe: $!"); + $reactorPromise->reject; } }); $reactor->watch($reader, 1, 0); # watch for pipe readability only $monitor->markPhaseStart($self->name(), $phaseName); Mojo::IOLoop->subprocess( sub { # blocks, runs in separate process $SIG{INT} = sub { POSIX::_exit(EINTR); }; $0 = "kdesrc-build[$phaseName]"; # This causes setOption to record changes, and is deliberately not # within ctx->{options} $ctx->{'#pending'} = { }; $writer->autoflush(1); close $reader; # we can't use this anyways ksb::Debug::setOutputHandle($writer); $self->buildContext->resetEnvironment(); $self->setupEnvironment(); # This coderef should return a normal value (something you could # stick in a plain JSON object) my $result = $blocking_coderef->($self); my %newOptions; # Grab any newly-set options to feed back to parent my @affectedMods = grep { exists $ctx->{build_options}->{$_}->{'#pending'}; } (keys %{$ctx->{build_options}}); foreach my $affected (@affectedMods) { $newOptions{$affected} = $ctx->{build_options}->{$affected}->{'#pending'}; } return { result => $result, newOptions => \%newOptions, }; }, sub { # runs in this process once subprocess is done my ($subprocess, $err, $resultsRef) = @_; - $reactor->remove($reader); - close $reader; close $writer; # can't close it earlier because must be open at fork # Apply options that may have changed during child proc execution. if (%{$resultsRef->{newOptions}}) { while(my ($k, $v) = each %{$resultsRef->{newOptions}}) { my %modulesNewOptions = %{$v}; @{$ctx->{build_options}->{$k}}{keys %modulesNewOptions} = values %modulesNewOptions; } } if ($err) { $ctx->markModulePhaseFailed($phaseName, $self); return $promise->reject($err); } my $result = $resultsRef->{result}; if ($result) { $ctx->markModulePhaseSucceeded($phaseName, $self); } else { $ctx->markModulePhaseFailed($phaseName, $self); } - # This coderef should resolve or reject the promise, if used - $promise->resolve($completion_coderef->($self, $result)); + return $reactorPromise->then(sub { + # This coderef should resolve or reject the promise, if used + $promise->resolve($completion_coderef->($self, $result)); + }); } ); return $promise; } 1;