/**
* Scan the directory set in $repoConfig['url']
* and create any found packages.
*/
protected function scanDir()
{
$dir = $this->repoConfig['url'];
// make sure tilde is not escaped so it can be expanded
// this allows '~/' followed by a path or just '~'
if (($tilde = substr($dir, 0, 2)) === '~/' || $tilde === '~') {
$dir = $tilde . ProcessExecutor::escape(substr($dir, strlen($tilde)));
} else {
$dir = ProcessExecutor::escape($dir);
}
// patterns specific to both plugins and themes
// 'inflating' is a line printed by unzip which indicates which internal file we are looking at
$patterns = ['inflating|Version|Description|Author|Author URI|License'];
// files within the archives to look at
$files = [];
// look for plugins?
if (isset($this->repoConfig['package-types']['wordpress-plugin']) || isset($this->repoConfig['package-types']['wordpress-muplugin'])) {
$patterns[] = 'Plugin Name|Plugin URI';
$files[] = "'*.php'";
}
// look for themes?
if (isset($this->repoConfig['package-types']['wordpress-theme'])) {
$patterns[] = 'Theme Name|Theme URI';
$files[] = "'style.css'";
}
// determine if we have a depth limit
$maxdepth = ($depth = (int) $this->repoConfig['max-depth']) > 0 ? "-maxdepth {$depth}" : '';
// assemble the command
// 1. `find` to get all zip files in the given directory
// 2. echo the filename so we can capture where the zip is
// 3. use `unzip` piped into `grep` to scan the zip for WP
// theme or plugin headers in style.css or *.php files,
// respectively, but only in the top two directories within the zip
$cmd = "find -L {$dir} {$maxdepth} -iname '*.zip' -exec echo '{}' ';' -exec sh -c " . "\"unzip -c {} '*.php' -x '*/*/*' | grep -iE '^[ ^I*]*(" . implode('|', $patterns) . ")'\" ';'";
// if this is using ssh, wrap the command in an ssh call instead
if ($this->ssh) {
$cmd = 'ssh ' . ProcessExecutor::escape($this->repoConfig['ssh']) . ' ' . ProcessExecutor::escape($cmd);
}
$process = new ProcessExecutor($this->io);
// execute the command and see if the response code indicates success
// @todo: do we need to catch any exceptions here?
if (($code = $process->execute($cmd, $output)) === 0) {
// store details about each of the files, which may be used to create a package
$files = [];
$zipFile = null;
$fileName = null;
// parse the response line-by-line to pluck out the header information
foreach ($process->splitLines($output) as $line) {
// is this a new zip file?
if (strtolower(substr($line, -4)) === '.zip') {
$zipFile = $line;
// is this a new internal file?
} else {
if (preg_match('/^\\s*inflating:\\s*(.+?)\\s*$/i', $line, $matches)) {
$fileName = $matches[1];
} else {
// parse the line for information
if (preg_match('/^[\\s*]*([^:]+):\\s*(.+?)\\s*$/i', $line, $matches)) {
// for clarity
list(, $property, $value) = $matches;
$files[$zipFile][$fileName][$property] = $value;
}
}
}
}
// take the header information and create packages!
foreach ($files as $url => $packages) {
// we will only consider zips that have one package inside
if (count($packages) === 1) {
// make sure all the keys are consistent
$headers = array_change_key_case(reset($packages), CASE_LOWER);
// file within the zip where the headers were found
$fileName = key($packages);
// the info used to create the package
$package = [];
// we have a theme!
if (!empty($headers['theme name'])) {
$package['type'] = 'wordpress-theme';
$name = Util::slugify($headers['theme name']);
$name = Util::callFilter($this->repoConfig['name-filter'], $name, $url, $fileName, $headers);
if (!empty($headers['theme uri'])) {
$package['homepage'] = $headers['theme uri'];
}
// we have a plugin!
} else {
if (!empty($headers['plugin name'])) {
$package['type'] = 'wordpress-plugin';
// use the basename of the file where the plugin headers were as the name
// this is a wordpress convention, but may not always be accurate
// @todo: what do we do about that?
$name = Util::slugify($headers['plugin name']);
$name = Util::callFilter($this->repoConfig['name-filter'], $name, $url, $fileName, $headers);
if (!empty($headers['plugin uri'])) {
$package['homepage'] = $headers['plugin uri'];
}
// does not appear to be a theme or plugin
// sometimes other files get picked up
} else {
if ($this->io->isVerbose()) {
$this->io->writeError("{$url} does not appear to contain a valid package");
}
continue;
}
}
// if the name is empty we don't use it
if (!strlen($name)) {
continue;
}
// add version
if (!empty($headers['version'])) {
$package['version'] = Util::fixVersion($headers['version'], 'dev-default');
} else {
$package['version'] = 'dev-default';
}
$package['version'] = Util::callFilter($this->repoConfig['version-filter'], $package['version'], $name, $url, $fileName, $headers);
// empty version means we don't use it
if (!strlen($package['version'])) {
continue;
}
// add author information
if (!empty($headers['author'])) {
$package['authors'][0]['name'] = $headers['author'];
if (!empty($headers['author uri'])) {
$package['authors'][0]['homepage'] = $headers['author uri'];
}
}
// add description
if (!empty($headers['description'])) {
$package['description'] = strip_tags($headers['description']);
}
// add license
if (!empty($headers['license'])) {
$package['license'] = $headers['license'];
}
// add dist information
$package['dist'] = ['url' => $this->ssh ? "ssh://{$this->repoConfig['ssh']}:{$url}" : $url, 'type' => 'zip'];
// add a new package for each vendor alias of the given type
// @todo: maybe use links instead? or in addition to?
foreach ($this->repoConfig['vendors'] as $vendor => $type) {
// match wordpress-plugin for wordpress-muplugin vendors
if ($type === $package['type'] || $type === 'wordpress-muplugin' && $package['type'] === 'wordpress-plugin') {
// this makes sure muplugins are the correct type
$package['type'] = $type;
$package['name'] = "{$vendor}/{$name}";
$packageObj = $this->loader->load($package);
Util::callFilter($this->repoConfig['package-filter'], $packageObj, $url, $fileName, $headers);
$this->addPackage($packageObj);
}
}
} else {
// if the zip contains multiple packages, we can't use it @todo - maybe make it possible?
if ($this->io->isVerbose()) {
$this->io->writeError("Cannot use file {$url} as is appears to contain multiple packages.");
}
}
}
} else {
// some sort of error - boo!
throw new \RuntimeException('Could not complete directory scan of ' . $this->repoConfig['url'] . '. ' . $process->getErrorOutput());
}
}
/**
* Query the WP plugins api for results.
* @param string $query search query
* @return mixed results or original query to fallback to provider search
*/
function search($query)
{
if ($this->io->isVerbose()) {
$this->io->write("Searching for {$query}");
}
try {
$results = $this->queryAPI('query_plugins', ['search' => $query]);
} catch (RuntimeException $e) {
if ($this->io->isVerbose()) {
$this->io->writeError($e->getMessage());
}
// fall back to the standard search method
return $query;
}
// query the api
if (!empty($results->plugins)) {
$vendor = $this->repo->getDefaultVendor();
$out = [];
foreach ($results->plugins as $plugin) {
$out[] = ['name' => "{$vendor}/{$plugin->slug}", 'description' => Util::truncate(strip_tags($plugin->short_description), 100), 'url' => $plugin->homepage];
}
return $out;
}
return $query;
}
/**
* Query the WP theme api for results.
* @param string $query search query
* @return mixed results or original query to fallback to provider search
*/
function search($query)
{
if ($this->io->isVerbose()) {
$this->io->write('Searching ' . self::apiUrl . ' for ' . $query);
}
try {
$results = $this->queryAPI('query_themes', ['search' => $query]);
} catch (RuntimeException $e) {
if ($this->io->isVerbose()) {
$this->io->writeError($e->getMessage());
}
// fall back to the standard search method
return $query;
}
if (!empty($results['themes'])) {
$out = [];
$vendor = $this->repo->getDefaultVendor();
foreach ($results['themes'] as $theme) {
// fairly confident all of the fields below will be provided for a given theme
$out[] = ['name' => "{$vendor}/{$theme['slug']}", 'description' => Util::truncate(strip_tags($theme['description']), 100), 'url' => $theme['homepage']];
}
return $out;
}
return $query;
}
/**
* Add a provider to the set; call optional name filter.
* @param string $name resolved provider name
* @param string $relPath the provider path from the repo config
* @param string $absUrl the fully qualified URL to this provider
*/
protected function addProvider($name, $relPath, $absUrl)
{
// is there a provider name filter?
$name = Util::callFilter($this->repoConfig->get('name-filter'), $name, $relPath, $absUrl);
// only add the provider if it is truthy
if ($name) {
// this provider listing is not used in solving, just for listing
// so just use the default vendor (i.e. first one we have)
$this->providerListing[] = "{$this->defaultVendor}/{$name}";
$this->providerHash[$name] = $absUrl;
}
}
