9 * @author Greg Beaver <cellog@php.net>
10 * @copyright 1997-2009 The Authors
11 * @license http://opensource.org/licenses/bsd-license.php New BSD License
12 * @link http://pear.php.net/package/PEAR
13 * @since File available since Release 1.4.0a12
17 * For downloading REST xml/txt files
19 require_once 'PEAR/REST.php';
26 * @author Greg Beaver <cellog@php.net>
27 * @copyright 1997-2009 The Authors
28 * @license http://opensource.org/licenses/bsd-license.php New BSD License
29 * @version Release: 1.10.1
30 * @link http://pear.php.net/package/PEAR
31 * @since Class available since Release 1.4.0a12
39 function __construct($config, $options = array())
41 $this->_rest = new PEAR_REST($config, $options);
45 * Retrieve information about a remote package to be downloaded from a REST server
47 * @param string $base The uri to prepend to all REST calls
48 * @param array $packageinfo an array of format:
51 * 'package' => 'packagename',
52 * 'channel' => 'channelname',
53 * ['state' => 'alpha' (or valid state),]
55 * ['version' => '1.whatever']
57 * @param string $prefstate Current preferred_state config variable value
58 * @param bool $installed the installed version of this package to compare against
59 * @return array|false|PEAR_Error see {@link _returnDownloadURL()}
61 function getDownloadURL($base, $packageinfo, $prefstate, $installed, $channel = false)
63 $states = $this->betterStates($prefstate, true);
65 return PEAR::raiseError('"' . $prefstate . '" is not a valid state');
68 $channel = $packageinfo['channel'];
69 $package = $packageinfo['package'];
70 $state = isset($packageinfo['state']) ? $packageinfo['state'] : null;
71 $version = isset($packageinfo['version']) ? $packageinfo['version'] : null;
72 $restFile = $base . 'r/' . strtolower($package) . '/allreleases.xml';
74 $info = $this->_rest->retrieveData($restFile, false, false, $channel);
75 if (PEAR::isError($info)) {
76 return PEAR::raiseError('No releases available for package "' .
77 $channel . '/' . $package . '"');
80 if (!isset($info['r'])) {
84 $release = $found = false;
85 if (!is_array($info['r']) || !isset($info['r'][0])) {
86 $info['r'] = array($info['r']);
89 foreach ($info['r'] as $release) {
90 if (!isset($this->_rest->_options['force']) && ($installed &&
91 version_compare($release['v'], $installed, '<'))) {
96 // try our preferred state first
97 if ($release['s'] == $state) {
101 // see if there is something newer and more stable
103 if (in_array($release['s'], $this->betterStates($state), true)) {
107 } elseif (isset($version)) {
108 if ($release['v'] == $version) {
113 if (in_array($release['s'], $states)) {
120 return $this->_returnDownloadURL($base, $package, $release, $info, $found, false, $channel);
123 function getDepDownloadURL($base, $xsdversion, $dependency, $deppackage,
124 $prefstate = 'stable', $installed = false, $channel = false)
126 $states = $this->betterStates($prefstate, true);
128 return PEAR::raiseError('"' . $prefstate . '" is not a valid state');
131 $channel = $dependency['channel'];
132 $package = $dependency['name'];
133 $state = isset($dependency['state']) ? $dependency['state'] : null;
134 $version = isset($dependency['version']) ? $dependency['version'] : null;
135 $restFile = $base . 'r/' . strtolower($package) . '/allreleases.xml';
137 $info = $this->_rest->retrieveData($restFile, false, false, $channel);
138 if (PEAR::isError($info)) {
139 return PEAR::raiseError('Package "' . $deppackage['channel'] . '/' . $deppackage['package']
140 . '" dependency "' . $channel . '/' . $package . '" has no releases');
143 if (!is_array($info) || !isset($info['r'])) {
148 $min = $max = $recommended = false;
149 if ($xsdversion == '1.0') {
150 switch ($dependency['rel']) {
152 $min = $dependency['version'];
155 $min = $dependency['version'];
156 $exclude = array($dependency['version']);
159 $recommended = $dependency['version'];
162 $max = $dependency['version'];
163 $exclude = array($dependency['version']);
166 $max = $dependency['version'];
169 $exclude = array($dependency['version']);
173 $min = isset($dependency['min']) ? $dependency['min'] : false;
174 $max = isset($dependency['max']) ? $dependency['max'] : false;
175 $recommended = isset($dependency['recommended']) ?
176 $dependency['recommended'] : false;
177 if (isset($dependency['exclude'])) {
178 if (!isset($dependency['exclude'][0])) {
179 $exclude = array($dependency['exclude']);
183 $release = $found = false;
184 if (!is_array($info['r']) || !isset($info['r'][0])) {
185 $info['r'] = array($info['r']);
187 foreach ($info['r'] as $release) {
188 if (!isset($this->_rest->_options['force']) && ($installed &&
189 version_compare($release['v'], $installed, '<'))) {
192 if (in_array($release['v'], $exclude)) { // skip excluded versions
195 // allow newer releases to say "I'm OK with the dependent package"
196 if ($xsdversion == '2.0' && isset($release['co'])) {
197 if (!is_array($release['co']) || !isset($release['co'][0])) {
198 $release['co'] = array($release['co']);
200 foreach ($release['co'] as $entry) {
201 if (isset($entry['x']) && !is_array($entry['x'])) {
202 $entry['x'] = array($entry['x']);
203 } elseif (!isset($entry['x'])) {
204 $entry['x'] = array();
206 if ($entry['c'] == $deppackage['channel'] &&
207 strtolower($entry['p']) == strtolower($deppackage['package']) &&
208 version_compare($deppackage['version'], $entry['min'], '>=') &&
209 version_compare($deppackage['version'], $entry['max'], '<=') &&
210 !in_array($release['v'], $entry['x'])) {
211 $recommended = $release['v'];
217 if ($release['v'] != $recommended) { // if we want a specific
218 // version, then skip all others
221 if (!in_array($release['s'], $states)) {
222 // the stability is too low, but we must return the
223 // recommended version if possible
224 return $this->_returnDownloadURL($base, $package, $release, $info, true, false, $channel);
228 if ($min && version_compare($release['v'], $min, 'lt')) { // skip too old versions
231 if ($max && version_compare($release['v'], $max, 'gt')) { // skip too new versions
234 if ($installed && version_compare($release['v'], $installed, '<')) {
237 if (in_array($release['s'], $states)) { // if in the preferred state...
238 $found = true; // ... then use it
242 return $this->_returnDownloadURL($base, $package, $release, $info, $found, false, $channel);
246 * Take raw data and return the array needed for processing a download URL
248 * @param string $base REST base uri
249 * @param string $package Package name
250 * @param array $release an array of format array('v' => version, 's' => state)
251 * describing the release to download
252 * @param array $info list of all releases as defined by allreleases.xml
253 * @param bool|null $found determines whether the release was found or this is the next
254 * best alternative. If null, then versions were skipped because
256 * @return array|PEAR_Error
259 function _returnDownloadURL($base, $package, $release, $info, $found, $phpversion = false, $channel = false)
262 $release = $info['r'][0];
265 $packageLower = strtolower($package);
266 $pinfo = $this->_rest->retrieveCacheFirst($base . 'p/' . $packageLower . '/' .
267 'info.xml', false, false, $channel);
268 if (PEAR::isError($pinfo)) {
269 return PEAR::raiseError('Package "' . $package .
270 '" does not have REST info xml available');
273 $releaseinfo = $this->_rest->retrieveCacheFirst($base . 'r/' . $packageLower . '/' .
274 $release['v'] . '.xml', false, false, $channel);
275 if (PEAR::isError($releaseinfo)) {
276 return PEAR::raiseError('Package "' . $package . '" Version "' . $release['v'] .
277 '" does not have REST xml available');
280 $packagexml = $this->_rest->retrieveCacheFirst($base . 'r/' . $packageLower . '/' .
281 'deps.' . $release['v'] . '.txt', false, true, $channel);
282 if (PEAR::isError($packagexml)) {
283 return PEAR::raiseError('Package "' . $package . '" Version "' . $release['v'] .
284 '" does not have REST dependency information available');
287 $packagexml = unserialize($packagexml);
289 $packagexml = array();
292 $allinfo = $this->_rest->retrieveData($base . 'r/' . $packageLower .
293 '/allreleases.xml', false, false, $channel);
294 if (PEAR::isError($allinfo)) {
298 if (!is_array($allinfo['r']) || !isset($allinfo['r'][0])) {
299 $allinfo['r'] = array($allinfo['r']);
303 foreach ($allinfo['r'] as $release) {
304 if ($release['v'] != $releaseinfo['v']) {
308 if (!isset($release['co'])) {
312 $compatible = array();
313 if (!is_array($release['co']) || !isset($release['co'][0])) {
314 $release['co'] = array($release['co']);
317 foreach ($release['co'] as $entry) {
319 $comp['name'] = $entry['p'];
320 $comp['channel'] = $entry['c'];
321 $comp['min'] = $entry['min'];
322 $comp['max'] = $entry['max'];
323 if (isset($entry['x']) && !is_array($entry['x'])) {
324 $comp['exclude'] = $entry['x'];
327 $compatible[] = $comp;
330 if (count($compatible) == 1) {
331 $compatible = $compatible[0];
338 if (isset($pinfo['dc']) && isset($pinfo['dp'])) {
339 if (is_array($pinfo['dp'])) {
340 $deprecated = array('channel' => (string) $pinfo['dc'],
341 'package' => trim($pinfo['dp']['_content']));
343 $deprecated = array('channel' => (string) $pinfo['dc'],
344 'package' => trim($pinfo['dp']));
349 'version' => $releaseinfo['v'],
350 'info' => $packagexml,
351 'package' => $releaseinfo['p']['_content'],
352 'stability' => $releaseinfo['st'],
353 'compatible' => $compatible,
354 'deprecated' => $deprecated,
358 $return['url'] = $releaseinfo['g'];
362 $return['php'] = $phpversion;
366 function listPackages($base, $channel = false)
368 $packagelist = $this->_rest->retrieveData($base . 'p/packages.xml', false, false, $channel);
369 if (PEAR::isError($packagelist)) {
373 if (!is_array($packagelist) || !isset($packagelist['p'])) {
377 if (!is_array($packagelist['p'])) {
378 $packagelist['p'] = array($packagelist['p']);
381 return $packagelist['p'];
385 * List all categories of a REST server
387 * @param string $base base URL of the server
388 * @return array of categorynames
390 function listCategories($base, $channel = false)
392 $categories = array();
394 // c/categories.xml does not exist;
395 // check for every package its category manually
396 // This is SLOOOWWWW : ///
397 $packagelist = $this->_rest->retrieveData($base . 'p/packages.xml', false, false, $channel);
398 if (PEAR::isError($packagelist)) {
402 if (!is_array($packagelist) || !isset($packagelist['p'])) {
407 if (!is_array($packagelist['p'])) {
408 $packagelist['p'] = array($packagelist['p']);
411 PEAR::pushErrorHandling(PEAR_ERROR_RETURN);
412 foreach ($packagelist['p'] as $package) {
413 $inf = $this->_rest->retrieveData($base . 'p/' . strtolower($package) . '/info.xml', false, false, $channel);
414 if (PEAR::isError($inf)) {
415 PEAR::popErrorHandling();
418 $cat = $inf['ca']['_content'];
419 if (!isset($categories[$cat])) {
420 $categories[$cat] = $inf['ca'];
424 return array_values($categories);
428 * List a category of a REST server
430 * @param string $base base URL of the server
431 * @param string $category name of the category
432 * @param boolean $info also download full package info
433 * @return array of packagenames
435 function listCategory($base, $category, $info = false, $channel = false)
437 // gives '404 Not Found' error when category doesn't exist
438 $packagelist = $this->_rest->retrieveData($base.'c/'.urlencode($category).'/packages.xml', false, false, $channel);
439 if (PEAR::isError($packagelist)) {
443 if (!is_array($packagelist) || !isset($packagelist['p'])) {
447 if (!is_array($packagelist['p']) ||
448 !isset($packagelist['p'][0])) { // only 1 pkg
449 $packagelist = array($packagelist['p']);
451 $packagelist = $packagelist['p'];
455 // get individual package info
456 PEAR::pushErrorHandling(PEAR_ERROR_RETURN);
457 foreach ($packagelist as $i => $packageitem) {
458 $url = sprintf('%s'.'r/%s/latest.txt',
460 strtolower($packageitem['_content']));
461 $version = $this->_rest->retrieveData($url, false, false, $channel);
462 if (PEAR::isError($version)) {
465 $url = sprintf('%s'.'r/%s/%s.xml',
467 strtolower($packageitem['_content']),
469 $info = $this->_rest->retrieveData($url, false, false, $channel);
470 if (PEAR::isError($info)) {
473 $packagelist[$i]['info'] = $info;
475 PEAR::popErrorHandling();
482 function listAll($base, $dostable, $basic = true, $searchpackage = false, $searchsummary = false, $channel = false)
484 $packagelist = $this->_rest->retrieveData($base . 'p/packages.xml', false, false, $channel);
485 if (PEAR::isError($packagelist)) {
488 if ($this->_rest->config->get('verbose') > 0) {
489 $ui = &PEAR_Frontend::singleton();
490 $ui->log('Retrieving data...0%', true);
493 if (!is_array($packagelist) || !isset($packagelist['p'])) {
496 if (!is_array($packagelist['p'])) {
497 $packagelist['p'] = array($packagelist['p']);
500 // only search-packagename = quicksearch !
501 if ($searchpackage && (!$searchsummary || empty($searchpackage))) {
502 $newpackagelist = array();
503 foreach ($packagelist['p'] as $package) {
504 if (!empty($searchpackage) && stristr($package, $searchpackage) !== false) {
505 $newpackagelist[] = $package;
508 $packagelist['p'] = $newpackagelist;
510 PEAR::pushErrorHandling(PEAR_ERROR_RETURN);
512 foreach ($packagelist['p'] as $progress => $package) {
513 if ($this->_rest->config->get('verbose') > 0) {
514 if ($progress / count($packagelist['p']) >= $next) {
516 $ui->log('50%', false);
518 $ui->log('.', false);
524 if ($basic) { // remote-list command
526 $latest = $this->_rest->retrieveData($base . 'r/' . strtolower($package) .
527 '/stable.txt', false, false, $channel);
529 $latest = $this->_rest->retrieveData($base . 'r/' . strtolower($package) .
530 '/latest.txt', false, false, $channel);
532 if (PEAR::isError($latest)) {
535 $info = array('stable' => $latest);
536 } else { // list-all command
537 $inf = $this->_rest->retrieveData($base . 'p/' . strtolower($package) . '/info.xml', false, false, $channel);
538 if (PEAR::isError($inf)) {
539 PEAR::popErrorHandling();
542 if ($searchpackage) {
543 $found = (!empty($searchpackage) && stristr($package, $searchpackage) !== false);
544 if (!$found && !(isset($searchsummary) && !empty($searchsummary)
545 && (stristr($inf['s'], $searchsummary) !== false
546 || stristr($inf['d'], $searchsummary) !== false)))
551 $releases = $this->_rest->retrieveData($base . 'r/' . strtolower($package) .
552 '/allreleases.xml', false, false, $channel);
553 if (PEAR::isError($releases)) {
556 if (!isset($releases['r'][0])) {
557 $releases['r'] = array($releases['r']);
563 foreach ($releases['r'] as $release) {
564 if (!isset($latest)) {
565 if ($dostable && $release['s'] == 'stable') {
566 $latest = $release['v'];
570 $latest = $release['v'];
571 $state = $release['s'];
574 if (!isset($stable) && $release['s'] == 'stable') {
575 $stable = $release['v'];
576 if (!isset($unstable)) {
580 if (!isset($unstable) && $release['s'] != 'stable') {
581 $latest = $unstable = $release['v'];
582 $state = $release['s'];
584 if (isset($latest) && !isset($state)) {
585 $state = $release['s'];
587 if (isset($latest) && isset($stable) && isset($unstable)) {
592 if (!isset($unstable)) {
595 if (isset($stable)) {
596 $latest = $unstable = $stable;
601 if (!isset($latest)) {
605 $d = $this->_rest->retrieveCacheFirst($base . 'r/' . strtolower($package) . '/deps.' .
606 $latest . '.txt', false, false, $channel);
607 if (!PEAR::isError($d)) {
608 $d = unserialize($d);
610 if (isset($d['required'])) {
611 if (!class_exists('PEAR_PackageFile_v2')) {
612 require_once 'PEAR/PackageFile/v2.php';
615 $pf = new PEAR_PackageFile_v2;
618 $tdeps = $pf->getDeps();
622 foreach ($tdeps as $dep) {
623 if ($dep['type'] !== 'pkg') {
631 if (!isset($stable)) {
634 if (!$searchpackage) {
635 $info = array('stable' => $latest, 'summary' => $inf['s'], 'description' =>
636 $inf['d'], 'deps' => $deps, 'category' => $inf['ca']['_content'],
637 'unstable' => $unstable, 'state' => $state);
639 $info = array('stable' => $stable, 'summary' => $inf['s'], 'description' =>
640 $inf['d'], 'deps' => $deps, 'category' => $inf['ca']['_content'],
641 'unstable' => $unstable, 'state' => $state);
644 $ret[$package] = $info;
646 PEAR::popErrorHandling();
650 function listLatestUpgrades($base, $pref_state, $installed, $channel, &$reg)
652 $packagelist = $this->_rest->retrieveData($base . 'p/packages.xml', false, false, $channel);
653 if (PEAR::isError($packagelist)) {
658 if (!is_array($packagelist) || !isset($packagelist['p'])) {
662 if (!is_array($packagelist['p'])) {
663 $packagelist['p'] = array($packagelist['p']);
666 foreach ($packagelist['p'] as $package) {
667 if (!isset($installed[strtolower($package)])) {
671 $inst_version = $reg->packageInfo($package, 'version', $channel);
672 $inst_state = $reg->packageInfo($package, 'release_state', $channel);
673 PEAR::pushErrorHandling(PEAR_ERROR_RETURN);
674 $info = $this->_rest->retrieveData($base . 'r/' . strtolower($package) .
675 '/allreleases.xml', false, false, $channel);
676 PEAR::popErrorHandling();
677 if (PEAR::isError($info)) {
678 continue; // no remote releases
681 if (!isset($info['r'])) {
685 $release = $found = false;
686 if (!is_array($info['r']) || !isset($info['r'][0])) {
687 $info['r'] = array($info['r']);
690 // $info['r'] is sorted by version number
691 usort($info['r'], array($this, '_sortReleasesByVersionNumber'));
692 foreach ($info['r'] as $release) {
693 if ($inst_version && version_compare($release['v'], $inst_version, '<=')) {
694 // not newer than the one installed
698 // new version > installed version
700 // every state is a good state
704 $new_state = $release['s'];
705 // if new state >= installed state: go
706 if (in_array($new_state, $this->betterStates($inst_state, true))) {
710 // only allow to lower the state of package,
711 // if new state >= preferred state: go
712 if (in_array($new_state, $this->betterStates($pref_state, true))) {
724 $relinfo = $this->_rest->retrieveCacheFirst($base . 'r/' . strtolower($package) . '/' .
725 $release['v'] . '.xml', false, false, $channel);
726 if (PEAR::isError($relinfo)) {
730 $ret[$package] = array(
731 'version' => $release['v'],
732 'state' => $release['s'],
733 'filesize' => $relinfo['f'],
740 function packageInfo($base, $package, $channel = false)
742 PEAR::pushErrorHandling(PEAR_ERROR_RETURN);
743 $pinfo = $this->_rest->retrieveData($base . 'p/' . strtolower($package) . '/info.xml', false, false, $channel);
744 if (PEAR::isError($pinfo)) {
745 PEAR::popErrorHandling();
746 return PEAR::raiseError('Unknown package: "' . $package . '" in channel "' . $channel . '"' . "\n". 'Debug: ' .
747 $pinfo->getMessage());
751 $allreleases = $this->_rest->retrieveData($base . 'r/' . strtolower($package) .
752 '/allreleases.xml', false, false, $channel);
753 if (!PEAR::isError($allreleases)) {
754 if (!class_exists('PEAR_PackageFile_v2')) {
755 require_once 'PEAR/PackageFile/v2.php';
758 if (!is_array($allreleases['r']) || !isset($allreleases['r'][0])) {
759 $allreleases['r'] = array($allreleases['r']);
762 $pf = new PEAR_PackageFile_v2;
763 foreach ($allreleases['r'] as $release) {
764 $ds = $this->_rest->retrieveCacheFirst($base . 'r/' . strtolower($package) . '/deps.' .
765 $release['v'] . '.txt', false, false, $channel);
766 if (PEAR::isError($ds)) {
770 if (!isset($latest)) {
771 $latest = $release['v'];
774 $pf->setDeps(unserialize($ds));
775 $ds = $pf->getDeps();
776 $info = $this->_rest->retrieveCacheFirst($base . 'r/' . strtolower($package)
777 . '/' . $release['v'] . '.xml', false, false, $channel);
779 if (PEAR::isError($info)) {
783 $releases[$release['v']] = array(
784 'doneby' => $info['m'],
785 'license' => $info['l'],
786 'summary' => $info['s'],
787 'description' => $info['d'],
788 'releasedate' => $info['da'],
789 'releasenotes' => $info['n'],
790 'state' => $release['s'],
791 'deps' => $ds ? $ds : array(),
798 PEAR::popErrorHandling();
799 if (isset($pinfo['dc']) && isset($pinfo['dp'])) {
800 if (is_array($pinfo['dp'])) {
801 $deprecated = array('channel' => (string) $pinfo['dc'],
802 'package' => trim($pinfo['dp']['_content']));
804 $deprecated = array('channel' => (string) $pinfo['dc'],
805 'package' => trim($pinfo['dp']));
811 if (!isset($latest)) {
816 'name' => $pinfo['n'],
817 'channel' => $pinfo['c'],
818 'category' => $pinfo['ca']['_content'],
820 'license' => $pinfo['l'],
821 'summary' => $pinfo['s'],
822 'description' => $pinfo['d'],
823 'releases' => $releases,
824 'deprecated' => $deprecated,
829 * Return an array containing all of the states that are more stable than
830 * or equal to the passed in state
832 * @param string Release state
833 * @param boolean Determines whether to include $state in the list
834 * @return false|array False if $state is not a valid release state
836 function betterStates($state, $include = false)
838 static $states = array('snapshot', 'devel', 'alpha', 'beta', 'stable');
839 $i = array_search($state, $states);
848 return array_slice($states, $i + 1);
852 * Sort releases by version number
856 function _sortReleasesByVersionNumber($a, $b)
858 if (version_compare($a['v'], $b['v'], '=')) {
862 if (version_compare($a['v'], $b['v'], '>')) {
866 if (version_compare($a['v'], $b['v'], '<')) {