/** * Validate XML package definition file. * * @param string $info Filename of the package archive or of the * package definition file * @param array $errors Array that will contain the errors * @param array $warnings Array that will contain the warnings * @param string $dir_prefix (optional) directory where source files * may be found, or empty if they are not available * @access public * @return boolean */ function validatePackageInfo($info, &$errors, &$warnings, $dir_prefix = '') { if (PEAR::isError($info = $this->infoFromAny($info))) { return $this->raiseError($info); } if (!is_array($info)) { return false; } $errors = array(); $warnings = array(); if (!isset($info['package'])) { $errors[] = 'missing package name'; } elseif (!$this->validPackageName($info['package'])) { $errors[] = 'invalid package name'; } $this->_packageName = $pn = $info['package']; if (empty($info['summary'])) { $errors[] = 'missing summary'; } elseif (strpos(trim($info['summary']), "\n") !== false) { $warnings[] = 'summary should be on a single line'; } if (empty($info['description'])) { $errors[] = 'missing description'; } if (empty($info['release_license'])) { $errors[] = 'missing license'; } if (!isset($info['version'])) { $errors[] = 'missing version'; } elseif (!$this->validPackageVersion($info['version'])) { $errors[] = 'invalid package version'; } if (empty($info['release_state'])) { $errors[] = 'missing release state'; } elseif (!in_array($info['release_state'], PEAR_Common::getReleaseStates())) { $errors[] = "invalid release state `{$info['release_state']}', should be one of: " . implode(' ', PEAR_Common::getReleaseStates()); } if (empty($info['release_date'])) { $errors[] = 'missing release date'; } elseif (!preg_match('/^\\d{4}-\\d\\d-\\d\\d$/', $info['release_date'])) { $errors[] = "invalid release date `{$info['release_date']}', format is YYYY-MM-DD"; } if (empty($info['release_notes'])) { $errors[] = "missing release notes"; } if (empty($info['maintainers'])) { $errors[] = 'no maintainer(s)'; } else { $i = 1; foreach ($info['maintainers'] as $m) { if (empty($m['handle'])) { $errors[] = "maintainer {$i}: missing handle"; } if (empty($m['role'])) { $errors[] = "maintainer {$i}: missing role"; } elseif (!in_array($m['role'], PEAR_Common::getUserRoles())) { $errors[] = "maintainer {$i}: invalid role `{$m['role']}', should be one of: " . implode(' ', PEAR_Common::getUserRoles()); } if (empty($m['name'])) { $errors[] = "maintainer {$i}: missing name"; } if (empty($m['email'])) { $errors[] = "maintainer {$i}: missing email"; } $i++; } } if (!empty($info['deps'])) { $i = 1; foreach ($info['deps'] as $d) { if (empty($d['type'])) { $errors[] = "dependency {$i}: missing type"; } elseif (!in_array($d['type'], PEAR_Common::getDependencyTypes())) { $errors[] = "dependency {$i}: invalid type, should be one of: " . implode(' ', PEAR_Common::getDependencyTypes()); } if (empty($d['rel'])) { $errors[] = "dependency {$i}: missing relation"; } elseif (!in_array($d['rel'], PEAR_Common::getDependencyRelations())) { $errors[] = "dependency {$i}: invalid relation, should be one of: " . implode(' ', PEAR_Common::getDependencyRelations()); } if (!empty($d['optional'])) { if (!in_array($d['optional'], array('yes', 'no'))) { $errors[] = "dependency {$i}: invalid relation optional attribute, should be one of: yes no"; } } if ($d['rel'] != 'has' && empty($d['version'])) { $warnings[] = "dependency {$i}: missing version"; } elseif ($d['rel'] == 'has' && !empty($d['version'])) { $warnings[] = "dependency {$i}: version ignored for `has' dependencies"; } if ($d['type'] == 'php' && !empty($d['name'])) { $warnings[] = "dependency {$i}: name ignored for php type dependencies"; } elseif ($d['type'] != 'php' && empty($d['name'])) { $errors[] = "dependency {$i}: missing name"; } $i++; } } if (!empty($info['configure_options'])) { $i = 1; foreach ($info['configure_options'] as $c) { if (empty($c['name'])) { $errors[] = "configure option {$i}: missing name"; } if (empty($c['prompt'])) { $errors[] = "configure option {$i}: missing prompt"; } $i++; } } if (empty($info['filelist'])) { $errors[] = 'no files'; } else { foreach ($info['filelist'] as $file => $fa) { if (empty($fa['role'])) { $errors[] = "file {$file}: missing role"; continue; } elseif (!in_array($fa['role'], PEAR_Common::getFileRoles())) { $errors[] = "file {$file}: invalid role, should be one of: " . implode(' ', PEAR_Common::getFileRoles()); } if ($fa['role'] == 'php' && $dir_prefix) { $this->log(1, "Analyzing {$file}"); $srcinfo = $this->analyzeSourceCode($dir_prefix . DIRECTORY_SEPARATOR . $file); if ($srcinfo) { $this->buildProvidesArray($srcinfo); } } // (ssb) Any checks we can do for baseinstalldir? // (cox) Perhaps checks that either the target dir and // baseInstall doesn't cointain "../../" } } $this->_packageName = $pn = $info['package']; $pnl = strlen($pn); foreach ((array) $this->pkginfo['provides'] as $key => $what) { if (isset($what['explicit'])) { // skip conformance checks if the provides entry is // specified in the package.xml file continue; } extract($what); if ($type == 'class') { if (!strncasecmp($name, $pn, $pnl)) { continue; } $warnings[] = "in {$file}: class \"{$name}\" not prefixed with package name \"{$pn}\""; } elseif ($type == 'function') { if (strstr($name, '::') || !strncasecmp($name, $pn, $pnl)) { continue; } $warnings[] = "in {$file}: function \"{$name}\" not prefixed with package name \"{$pn}\""; } } return true; }