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 * @version CVS: $Id: 10.php 313023 2011-07-06 19:17:11Z dufuz $
13 * @link http://pear.php.net/package/PEAR
14 * @since File available since Release 1.4.0a12
18 * For downloading REST xml/txt files
20 require_once 'PEAR/REST.php';
27 * @author Greg Beaver <cellog@php.net>
28 * @copyright 1997-2009 The Authors
29 * @license http://opensource.org/licenses/bsd-license.php New BSD License
30 * @version Release: 1.9.4
31 * @link http://pear.php.net/package/PEAR
32 * @since Class available since Release 1.4.0a12
40 function PEAR_REST_10($config, $options = array())
42 $this->_rest = &new PEAR_REST($config, $options);
46 * Retrieve information about a remote package to be downloaded from a REST server
48 * @param string $base The uri to prepend to all REST calls
49 * @param array $packageinfo an array of format:
52 * 'package' => 'packagename',
53 * 'channel' => 'channelname',
54 * ['state' => 'alpha' (or valid state),]
56 * ['version' => '1.whatever']
58 * @param string $prefstate Current preferred_state config variable value
59 * @param bool $installed the installed version of this package to compare against
60 * @return array|false|PEAR_Error see {@link _returnDownloadURL()}
62 function getDownloadURL($base, $packageinfo, $prefstate, $installed, $channel = false)
64 $states = $this->betterStates($prefstate, true);
66 return PEAR::raiseError('"' . $prefstate . '" is not a valid state');
69 $channel = $packageinfo['channel'];
70 $package = $packageinfo['package'];
71 $state = isset($packageinfo['state']) ? $packageinfo['state'] : null;
72 $version = isset($packageinfo['version']) ? $packageinfo['version'] : null;
73 $restFile = $base . 'r/' . strtolower($package) . '/allreleases.xml';
75 $info = $this->_rest->retrieveData($restFile, false, false, $channel);
76 if (PEAR::isError($info)) {
77 return PEAR::raiseError('No releases available for package "' .
78 $channel . '/' . $package . '"');
81 if (!isset($info['r'])) {
85 $release = $found = false;
86 if (!is_array($info['r']) || !isset($info['r'][0])) {
87 $info['r'] = array($info['r']);
90 foreach ($info['r'] as $release) {
91 if (!isset($this->_rest->_options['force']) && ($installed &&
92 version_compare($release['v'], $installed, '<'))) {
97 // try our preferred state first
98 if ($release['s'] == $state) {
102 // see if there is something newer and more stable
104 if (in_array($release['s'], $this->betterStates($state), true)) {
108 } elseif (isset($version)) {
109 if ($release['v'] == $version) {
114 if (in_array($release['s'], $states)) {
121 return $this->_returnDownloadURL($base, $package, $release, $info, $found, false, $channel);
124 function getDepDownloadURL($base, $xsdversion, $dependency, $deppackage,
125 $prefstate = 'stable', $installed = false, $channel = false)
127 $states = $this->betterStates($prefstate, true);
129 return PEAR::raiseError('"' . $prefstate . '" is not a valid state');
132 $channel = $dependency['channel'];
133 $package = $dependency['name'];
134 $state = isset($dependency['state']) ? $dependency['state'] : null;
135 $version = isset($dependency['version']) ? $dependency['version'] : null;
136 $restFile = $base . 'r/' . strtolower($package) . '/allreleases.xml';
138 $info = $this->_rest->retrieveData($restFile, false, false, $channel);
139 if (PEAR::isError($info)) {
140 return PEAR::raiseError('Package "' . $deppackage['channel'] . '/' . $deppackage['package']
141 . '" dependency "' . $channel . '/' . $package . '" has no releases');
144 if (!is_array($info) || !isset($info['r'])) {
149 $min = $max = $recommended = false;
150 if ($xsdversion == '1.0') {
151 switch ($dependency['rel']) {
153 $min = $dependency['version'];
156 $min = $dependency['version'];
157 $exclude = array($dependency['version']);
160 $recommended = $dependency['version'];
163 $max = $dependency['version'];
164 $exclude = array($dependency['version']);
167 $max = $dependency['version'];
170 $exclude = array($dependency['version']);
174 $min = isset($dependency['min']) ? $dependency['min'] : false;
175 $max = isset($dependency['max']) ? $dependency['max'] : false;
176 $recommended = isset($dependency['recommended']) ?
177 $dependency['recommended'] : false;
178 if (isset($dependency['exclude'])) {
179 if (!isset($dependency['exclude'][0])) {
180 $exclude = array($dependency['exclude']);
184 $release = $found = false;
185 if (!is_array($info['r']) || !isset($info['r'][0])) {
186 $info['r'] = array($info['r']);
188 foreach ($info['r'] as $release) {
189 if (!isset($this->_rest->_options['force']) && ($installed &&
190 version_compare($release['v'], $installed, '<'))) {
193 if (in_array($release['v'], $exclude)) { // skip excluded versions
196 // allow newer releases to say "I'm OK with the dependent package"
197 if ($xsdversion == '2.0' && isset($release['co'])) {
198 if (!is_array($release['co']) || !isset($release['co'][0])) {
199 $release['co'] = array($release['co']);
201 foreach ($release['co'] as $entry) {
202 if (isset($entry['x']) && !is_array($entry['x'])) {
203 $entry['x'] = array($entry['x']);
204 } elseif (!isset($entry['x'])) {
205 $entry['x'] = array();
207 if ($entry['c'] == $deppackage['channel'] &&
208 strtolower($entry['p']) == strtolower($deppackage['package']) &&
209 version_compare($deppackage['version'], $entry['min'], '>=') &&
210 version_compare($deppackage['version'], $entry['max'], '<=') &&
211 !in_array($release['v'], $entry['x'])) {
212 $recommended = $release['v'];
218 if ($release['v'] != $recommended) { // if we want a specific
219 // version, then skip all others
222 if (!in_array($release['s'], $states)) {
223 // the stability is too low, but we must return the
224 // recommended version if possible
225 return $this->_returnDownloadURL($base, $package, $release, $info, true, false, $channel);
229 if ($min && version_compare($release['v'], $min, 'lt')) { // skip too old versions
232 if ($max && version_compare($release['v'], $max, 'gt')) { // skip too new versions
235 if ($installed && version_compare($release['v'], $installed, '<')) {
238 if (in_array($release['s'], $states)) { // if in the preferred state...
239 $found = true; // ... then use it
243 return $this->_returnDownloadURL($base, $package, $release, $info, $found, false, $channel);
247 * Take raw data and return the array needed for processing a download URL
249 * @param string $base REST base uri
250 * @param string $package Package name
251 * @param array $release an array of format array('v' => version, 's' => state)
252 * describing the release to download
253 * @param array $info list of all releases as defined by allreleases.xml
254 * @param bool|null $found determines whether the release was found or this is the next
255 * best alternative. If null, then versions were skipped because
257 * @return array|PEAR_Error
260 function _returnDownloadURL($base, $package, $release, $info, $found, $phpversion = false, $channel = false)
263 $release = $info['r'][0];
266 $packageLower = strtolower($package);
267 $pinfo = $this->_rest->retrieveCacheFirst($base . 'p/' . $packageLower . '/' .
268 'info.xml', false, false, $channel);
269 if (PEAR::isError($pinfo)) {
270 return PEAR::raiseError('Package "' . $package .
271 '" does not have REST info xml available');
274 $releaseinfo = $this->_rest->retrieveCacheFirst($base . 'r/' . $packageLower . '/' .
275 $release['v'] . '.xml', false, false, $channel);
276 if (PEAR::isError($releaseinfo)) {
277 return PEAR::raiseError('Package "' . $package . '" Version "' . $release['v'] .
278 '" does not have REST xml available');
281 $packagexml = $this->_rest->retrieveCacheFirst($base . 'r/' . $packageLower . '/' .
282 'deps.' . $release['v'] . '.txt', false, true, $channel);
283 if (PEAR::isError($packagexml)) {
284 return PEAR::raiseError('Package "' . $package . '" Version "' . $release['v'] .
285 '" does not have REST dependency information available');
288 $packagexml = unserialize($packagexml);
290 $packagexml = array();
293 $allinfo = $this->_rest->retrieveData($base . 'r/' . $packageLower .
294 '/allreleases.xml', false, false, $channel);
295 if (PEAR::isError($allinfo)) {
299 if (!is_array($allinfo['r']) || !isset($allinfo['r'][0])) {
300 $allinfo['r'] = array($allinfo['r']);
304 foreach ($allinfo['r'] as $release) {
305 if ($release['v'] != $releaseinfo['v']) {
309 if (!isset($release['co'])) {
313 $compatible = array();
314 if (!is_array($release['co']) || !isset($release['co'][0])) {
315 $release['co'] = array($release['co']);
318 foreach ($release['co'] as $entry) {
320 $comp['name'] = $entry['p'];
321 $comp['channel'] = $entry['c'];
322 $comp['min'] = $entry['min'];
323 $comp['max'] = $entry['max'];
324 if (isset($entry['x']) && !is_array($entry['x'])) {
325 $comp['exclude'] = $entry['x'];
328 $compatible[] = $comp;
331 if (count($compatible) == 1) {
332 $compatible = $compatible[0];
339 if (isset($pinfo['dc']) && isset($pinfo['dp'])) {
340 if (is_array($pinfo['dp'])) {
341 $deprecated = array('channel' => (string) $pinfo['dc'],
342 'package' => trim($pinfo['dp']['_content']));
344 $deprecated = array('channel' => (string) $pinfo['dc'],
345 'package' => trim($pinfo['dp']));
350 'version' => $releaseinfo['v'],
351 'info' => $packagexml,
352 'package' => $releaseinfo['p']['_content'],
353 'stability' => $releaseinfo['st'],
354 'compatible' => $compatible,
355 'deprecated' => $deprecated,
359 $return['url'] = $releaseinfo['g'];
363 $return['php'] = $phpversion;
367 function listPackages($base, $channel = false)
369 $packagelist = $this->_rest->retrieveData($base . 'p/packages.xml', false, false, $channel);
370 if (PEAR::isError($packagelist)) {
374 if (!is_array($packagelist) || !isset($packagelist['p'])) {
378 if (!is_array($packagelist['p'])) {
379 $packagelist['p'] = array($packagelist['p']);
382 return $packagelist['p'];
386 * List all categories of a REST server
388 * @param string $base base URL of the server
389 * @return array of categorynames
391 function listCategories($base, $channel = false)
393 $categories = array();
395 // c/categories.xml does not exist;
396 // check for every package its category manually
397 // This is SLOOOWWWW : ///
398 $packagelist = $this->_rest->retrieveData($base . 'p/packages.xml', false, false, $channel);
399 if (PEAR::isError($packagelist)) {
403 if (!is_array($packagelist) || !isset($packagelist['p'])) {
408 if (!is_array($packagelist['p'])) {
409 $packagelist['p'] = array($packagelist['p']);
412 PEAR::pushErrorHandling(PEAR_ERROR_RETURN);
413 foreach ($packagelist['p'] as $package) {
414 $inf = $this->_rest->retrieveData($base . 'p/' . strtolower($package) . '/info.xml', false, false, $channel);
415 if (PEAR::isError($inf)) {
416 PEAR::popErrorHandling();
419 $cat = $inf['ca']['_content'];
420 if (!isset($categories[$cat])) {
421 $categories[$cat] = $inf['ca'];
425 return array_values($categories);
429 * List a category of a REST server
431 * @param string $base base URL of the server
432 * @param string $category name of the category
433 * @param boolean $info also download full package info
434 * @return array of packagenames
436 function listCategory($base, $category, $info = false, $channel = false)
438 // gives '404 Not Found' error when category doesn't exist
439 $packagelist = $this->_rest->retrieveData($base.'c/'.urlencode($category).'/packages.xml', false, false, $channel);
440 if (PEAR::isError($packagelist)) {
444 if (!is_array($packagelist) || !isset($packagelist['p'])) {
448 if (!is_array($packagelist['p']) ||
449 !isset($packagelist['p'][0])) { // only 1 pkg
450 $packagelist = array($packagelist['p']);
452 $packagelist = $packagelist['p'];
456 // get individual package info
457 PEAR::pushErrorHandling(PEAR_ERROR_RETURN);
458 foreach ($packagelist as $i => $packageitem) {
459 $url = sprintf('%s'.'r/%s/latest.txt',
461 strtolower($packageitem['_content']));
462 $version = $this->_rest->retrieveData($url, false, false, $channel);
463 if (PEAR::isError($version)) {
466 $url = sprintf('%s'.'r/%s/%s.xml',
468 strtolower($packageitem['_content']),
470 $info = $this->_rest->retrieveData($url, false, false, $channel);
471 if (PEAR::isError($info)) {
474 $packagelist[$i]['info'] = $info;
476 PEAR::popErrorHandling();
483 function listAll($base, $dostable, $basic = true, $searchpackage = false, $searchsummary = false, $channel = false)
485 $packagelist = $this->_rest->retrieveData($base . 'p/packages.xml', false, false, $channel);
486 if (PEAR::isError($packagelist)) {
489 if ($this->_rest->config->get('verbose') > 0) {
490 $ui = &PEAR_Frontend::singleton();
491 $ui->log('Retrieving data...0%', true);
494 if (!is_array($packagelist) || !isset($packagelist['p'])) {
497 if (!is_array($packagelist['p'])) {
498 $packagelist['p'] = array($packagelist['p']);
501 // only search-packagename = quicksearch !
502 if ($searchpackage && (!$searchsummary || empty($searchpackage))) {
503 $newpackagelist = array();
504 foreach ($packagelist['p'] as $package) {
505 if (!empty($searchpackage) && stristr($package, $searchpackage) !== false) {
506 $newpackagelist[] = $package;
509 $packagelist['p'] = $newpackagelist;
511 PEAR::pushErrorHandling(PEAR_ERROR_RETURN);
513 foreach ($packagelist['p'] as $progress => $package) {
514 if ($this->_rest->config->get('verbose') > 0) {
515 if ($progress / count($packagelist['p']) >= $next) {
517 $ui->log('50%', false);
519 $ui->log('.', false);
525 if ($basic) { // remote-list command
527 $latest = $this->_rest->retrieveData($base . 'r/' . strtolower($package) .
528 '/stable.txt', false, false, $channel);
530 $latest = $this->_rest->retrieveData($base . 'r/' . strtolower($package) .
531 '/latest.txt', false, false, $channel);
533 if (PEAR::isError($latest)) {
536 $info = array('stable' => $latest);
537 } else { // list-all command
538 $inf = $this->_rest->retrieveData($base . 'p/' . strtolower($package) . '/info.xml', false, false, $channel);
539 if (PEAR::isError($inf)) {
540 PEAR::popErrorHandling();
543 if ($searchpackage) {
544 $found = (!empty($searchpackage) && stristr($package, $searchpackage) !== false);
545 if (!$found && !(isset($searchsummary) && !empty($searchsummary)
546 && (stristr($inf['s'], $searchsummary) !== false
547 || stristr($inf['d'], $searchsummary) !== false)))
552 $releases = $this->_rest->retrieveData($base . 'r/' . strtolower($package) .
553 '/allreleases.xml', false, false, $channel);
554 if (PEAR::isError($releases)) {
557 if (!isset($releases['r'][0])) {
558 $releases['r'] = array($releases['r']);
564 foreach ($releases['r'] as $release) {
565 if (!isset($latest)) {
566 if ($dostable && $release['s'] == 'stable') {
567 $latest = $release['v'];
571 $latest = $release['v'];
572 $state = $release['s'];
575 if (!isset($stable) && $release['s'] == 'stable') {
576 $stable = $release['v'];
577 if (!isset($unstable)) {
581 if (!isset($unstable) && $release['s'] != 'stable') {
582 $latest = $unstable = $release['v'];
583 $state = $release['s'];
585 if (isset($latest) && !isset($state)) {
586 $state = $release['s'];
588 if (isset($latest) && isset($stable) && isset($unstable)) {
593 if (!isset($unstable)) {
596 if (isset($stable)) {
597 $latest = $unstable = $stable;
602 if (!isset($latest)) {
606 $d = $this->_rest->retrieveCacheFirst($base . 'r/' . strtolower($package) . '/deps.' .
607 $latest . '.txt', false, false, $channel);
608 if (!PEAR::isError($d)) {
609 $d = unserialize($d);
611 if (isset($d['required'])) {
612 if (!class_exists('PEAR_PackageFile_v2')) {
613 require_once 'PEAR/PackageFile/v2.php';
616 $pf = new PEAR_PackageFile_v2;
619 $tdeps = $pf->getDeps();
623 foreach ($tdeps as $dep) {
624 if ($dep['type'] !== 'pkg') {
632 if (!isset($stable)) {
635 if (!$searchpackage) {
636 $info = array('stable' => $latest, 'summary' => $inf['s'], 'description' =>
637 $inf['d'], 'deps' => $deps, 'category' => $inf['ca']['_content'],
638 'unstable' => $unstable, 'state' => $state);
640 $info = array('stable' => $stable, 'summary' => $inf['s'], 'description' =>
641 $inf['d'], 'deps' => $deps, 'category' => $inf['ca']['_content'],
642 'unstable' => $unstable, 'state' => $state);
645 $ret[$package] = $info;
647 PEAR::popErrorHandling();
651 function listLatestUpgrades($base, $pref_state, $installed, $channel, &$reg)
653 $packagelist = $this->_rest->retrieveData($base . 'p/packages.xml', false, false, $channel);
654 if (PEAR::isError($packagelist)) {
659 if (!is_array($packagelist) || !isset($packagelist['p'])) {
663 if (!is_array($packagelist['p'])) {
664 $packagelist['p'] = array($packagelist['p']);
667 foreach ($packagelist['p'] as $package) {
668 if (!isset($installed[strtolower($package)])) {
672 $inst_version = $reg->packageInfo($package, 'version', $channel);
673 $inst_state = $reg->packageInfo($package, 'release_state', $channel);
674 PEAR::pushErrorHandling(PEAR_ERROR_RETURN);
675 $info = $this->_rest->retrieveData($base . 'r/' . strtolower($package) .
676 '/allreleases.xml', false, false, $channel);
677 PEAR::popErrorHandling();
678 if (PEAR::isError($info)) {
679 continue; // no remote releases
682 if (!isset($info['r'])) {
686 $release = $found = false;
687 if (!is_array($info['r']) || !isset($info['r'][0])) {
688 $info['r'] = array($info['r']);
691 // $info['r'] is sorted by version number
692 usort($info['r'], array($this, '_sortReleasesByVersionNumber'));
693 foreach ($info['r'] as $release) {
694 if ($inst_version && version_compare($release['v'], $inst_version, '<=')) {
695 // not newer than the one installed
699 // new version > installed version
701 // every state is a good state
705 $new_state = $release['s'];
706 // if new state >= installed state: go
707 if (in_array($new_state, $this->betterStates($inst_state, true))) {
711 // only allow to lower the state of package,
712 // if new state >= preferred state: go
713 if (in_array($new_state, $this->betterStates($pref_state, true))) {
725 $relinfo = $this->_rest->retrieveCacheFirst($base . 'r/' . strtolower($package) . '/' .
726 $release['v'] . '.xml', false, false, $channel);
727 if (PEAR::isError($relinfo)) {
731 $ret[$package] = array(
732 'version' => $release['v'],
733 'state' => $release['s'],
734 'filesize' => $relinfo['f'],
741 function packageInfo($base, $package, $channel = false)
743 PEAR::pushErrorHandling(PEAR_ERROR_RETURN);
744 $pinfo = $this->_rest->retrieveData($base . 'p/' . strtolower($package) . '/info.xml', false, false, $channel);
745 if (PEAR::isError($pinfo)) {
746 PEAR::popErrorHandling();
747 return PEAR::raiseError('Unknown package: "' . $package . '" in channel "' . $channel . '"' . "\n". 'Debug: ' .
748 $pinfo->getMessage());
752 $allreleases = $this->_rest->retrieveData($base . 'r/' . strtolower($package) .
753 '/allreleases.xml', false, false, $channel);
754 if (!PEAR::isError($allreleases)) {
755 if (!class_exists('PEAR_PackageFile_v2')) {
756 require_once 'PEAR/PackageFile/v2.php';
759 if (!is_array($allreleases['r']) || !isset($allreleases['r'][0])) {
760 $allreleases['r'] = array($allreleases['r']);
763 $pf = new PEAR_PackageFile_v2;
764 foreach ($allreleases['r'] as $release) {
765 $ds = $this->_rest->retrieveCacheFirst($base . 'r/' . strtolower($package) . '/deps.' .
766 $release['v'] . '.txt', false, false, $channel);
767 if (PEAR::isError($ds)) {
771 if (!isset($latest)) {
772 $latest = $release['v'];
775 $pf->setDeps(unserialize($ds));
776 $ds = $pf->getDeps();
777 $info = $this->_rest->retrieveCacheFirst($base . 'r/' . strtolower($package)
778 . '/' . $release['v'] . '.xml', false, false, $channel);
780 if (PEAR::isError($info)) {
784 $releases[$release['v']] = array(
785 'doneby' => $info['m'],
786 'license' => $info['l'],
787 'summary' => $info['s'],
788 'description' => $info['d'],
789 'releasedate' => $info['da'],
790 'releasenotes' => $info['n'],
791 'state' => $release['s'],
792 'deps' => $ds ? $ds : array(),
799 PEAR::popErrorHandling();
800 if (isset($pinfo['dc']) && isset($pinfo['dp'])) {
801 if (is_array($pinfo['dp'])) {
802 $deprecated = array('channel' => (string) $pinfo['dc'],
803 'package' => trim($pinfo['dp']['_content']));
805 $deprecated = array('channel' => (string) $pinfo['dc'],
806 'package' => trim($pinfo['dp']));
812 if (!isset($latest)) {
817 'name' => $pinfo['n'],
818 'channel' => $pinfo['c'],
819 'category' => $pinfo['ca']['_content'],
821 'license' => $pinfo['l'],
822 'summary' => $pinfo['s'],
823 'description' => $pinfo['d'],
824 'releases' => $releases,
825 'deprecated' => $deprecated,
830 * Return an array containing all of the states that are more stable than
831 * or equal to the passed in state
833 * @param string Release state
834 * @param boolean Determines whether to include $state in the list
835 * @return false|array False if $state is not a valid release state
837 function betterStates($state, $include = false)
839 static $states = array('snapshot', 'devel', 'alpha', 'beta', 'stable');
840 $i = array_search($state, $states);
849 return array_slice($states, $i + 1);
853 * Sort releases by version number
857 function _sortReleasesByVersionNumber($a, $b)
859 if (version_compare($a['v'], $b['v'], '=')) {
863 if (version_compare($a['v'], $b['v'], '>')) {
867 if (version_compare($a['v'], $b['v'], '<')) {