path: root/class.portage.ebuild.php

<?

	/**
	 * Notes on the standard
	 *
	 * =foo-bar/baz_2-1.2.3_alpha0
	 *
	 * Package names (baz_2), if they end in a number, will never stop on that
	 * number with a dash (-2 vs _2).  So, you can always infer that the
	 * version will start with the first dash and integer. (-1.2.3..)
	 */

	class PortageEbuild {
	
		// Versioning
		private $version;
		private $_alpha;
		private $_beta;
		private $_pre;
		private $_rc;
		private $_p;
		
		private $atom;
		private $slot;
		
		// Ebuild Variables
		// P = package (vim)
		// V = version + suffix (6.3_beta3)
		// R = revision (r1)
		
		// PV
		private $p;		// Package name and version (excluding revision, if any), for example vim-6.3_beta3.
		// PVR
		private $pf;	// Full package name, ${PN}-${PVR}, for example vim-6.3_beta3-r1.
		// P
		private $pn;	// Package name, for example vim.
		// R
		private $pr;	// Package revision, or 0 if no revision exists.
		// V
		/** Confirmed, this includes any suffices (beta, alpha, rc, etc.) */
		private $pv;	// Package version (excluding revision, if any), for example 6.3_beta3.
		// VR
		private $pvr;	// Package version and revision (if any), for example 6.3_beta3, 6.3_beta3-r1.
		
		// File properties
		private $filename;
		private $source;
		
		private $category;
		
		private $arr_metadata;
		private $arr_metadata_keys;
		private $arr_versions;
		public $arr_components;
		private $has_version;
		
		// File mtimes
		private $portage_mtime;
		private $changelog_mtime;
		private $metadata_mtime;
		private $cache_mtime;
		
		function __construct($str) {
		
			global $hits;
			$hits['ebuild']++;
		
			$this->atom = trim($str);
			$this->arr_suffix = array('alpha', 'beta', 'rc', 'pre', 'p');
			$this->portage = '/usr/portage';
			$this->cache = $this->portage.'/metadata/cache';
			
			$this->has_version = $this->hasVersion();
			
			$this->filename = $this->portage."/".$this->getCategory()."/".$this->getPackageName()."/".$this->getFullPackageName().".ebuild";
			
			$this->filename_cache = $this->cache."/".$this->getCategory()."/".$this->getFullPackageName();
			
			if(file_exists($this->filename_cache))
				$this->cache_mtime = filemtime($this->filename_cache);
		
		
			$this->arr_metadata_keys = array('depend', 'rdepend', 'slot', 'src_uri', 'restrict', 'homepage', 'license', 'description', 'keywords', 'inherited', 'iuse', 'cdepend', 'pdepend', 'provide', 'eapi', 'properties', 'defined_phases');
			
			
			
			// Run this first to check if it has a version or not
// 			$this->getPackageName();
			
		}
		
		public function __get($var) {
		
			if(is_null($this->$var)) {
			
				if(in_array($var, $this->arr_metadata_keys)) {
				
					if(is_null($this->arr_metadata))
						$this->arr_metadata = $this->metadata();
					return $this->arr_metadata[$var];
				}
			
				switch($var) {
				
					// Suffixes
					case 'version':
					case '_alpha':
					case '_beta':
					case '_pre':
					case '_rc':
					case '_p':
						return $this->getSuffix($var);
					
					// 'r' is the only one that could
					// get a bit confusing, since there's so many
					// other ways to get these.
					// 'pr' is the correct way, since portage
					// has a stored variable for it.
					case 'pr':
					case 'r':
					case '_r':
					case 'revision':
						return $this->getSuffix('pr');
						break;
						
					// Other
					case 'category':
						return $this->getCategory();
						break;
					
					case 'slot':
						return $this->getSlot();
						break;
					
					// Ebuild Variables
					case 'p':
						return $this->getPackageNameAndVersionMinusRevision();
						break;
					
					case 'pn':
					case 'package':
						return $this->getPackageName();
						break;
						
					case 'pf':
						return $this->getFullPackageName();
						break;
						
					case 'pv':
						return $this->getPackageVersionMinusRevision();
						break;
						
					case 'pvr':
						return $this->getPackageVersionAndRevision();
						break;
						
					case 'portage_mtime':
						return $this->getMtime();
						break;
					
					case 'filename':
						return $this->filename;
						break;
						
					case 'source':
						return $this->source = file_get_contents($this->filename);
						break;
				
				}
			
			}
		
			return $this->$var;
		}
		
		/**
		 * Gather information about the ebuild
		 * from the metadata cache
		 *
		 * Line item reference:
		 * 
		 * 0. DEPEND
		 * 1. RDEPEND
		 * 2. SLOT
		 * 3. SRC_URI
		 * 4. RESTRICT
		 * 5. HOMEPAGE
		 * 6. LICENSE
		 * 7. DESCRIPTION
		 * 8. KEYWORDS
		 * 9. INHERITED (eclasses)
		 * 10. IUSE
		 * 11. CDEPEND (always empty)
		 * 12. PDEPEND
		 * 13. PROVIDE
		 * 14. EAPI
		 * 15. PROPERTIES
		 * 16. DEFINED_PHASES (functions called)
		 * 17. - 21. unused
		 *
		 */
		function metadata() {
		
			if(!is_null($this->arr_metadata))
				return $this->arr_metadata;
				
			if(!file_exists($this->filename) || !file_exists($this->filename_cache))
				return array();
			
			$file = file($this->filename_cache, FILE_IGNORE_NEW_LINES);
			
			// Kill off the empty lines
			$arr = array_slice($file, 0, 17, true);
			
			$arr = array_combine($this->arr_metadata_keys, $arr);
			
			return $arr;
		
		}

		
		function getCategory() {
			
			$var = 'category';
			
			$arr = explode("/", $this->atom);
			
			if(!count($arr) || count($arr) == 1)
				$this->$var = null;
			else {
				
				// Old code from another class, for reference
// 				$atom = preg_replace('/^!?[><]?=?~?/', '', $atom);
// 				$tmp = explode('/', $atom);
			
				$str = current($arr);
// 				$str = preg_replace("/[^a-z_-]/", "", $str);
				$this->$var = $str;
			}
			
			return $this->$var;
			
		}
		
		function getFullPackageName() {
		
			$var = 'pf';
			
			if($this->has_version)
				return $this->$var = $this->getPackageName()."-".$this->getPackageVersionAndRevision();
			else
				return "";
		
		}
		
		function getMajorVersion() {
			$this->getComponents();
			$arr = explode(".", $this->version);
			return $arr[0];
		}
		
		function getMinorVersion() {
			$this->getComponents();
			$arr = explode(".", $this->version);
			return $arr[1];
		}
		
		function getPackageName() {
		
// 			$var = 'pn';
// 			
// 			$str = $this->stripCategory();
// 			$str = $this->stripSlot($str);
// 			
// 			// Will only return the package name	
//  			$pattern = '/\-\d+((\.?\d+)+)?([A-Za-z]+)?((_(alpha|beta|pre|rc|p)\d*)+)?(\-r\d+)?(\:.+)?$/';
//  			$arr = preg_split($pattern, $str);
//  			
//  			// Check to see if it has a version or not (p.mask)
//  			if(count($arr) == 1)
//  				$this->has_version = false;
//  			
// 			$this->$var = $arr[0];
// 			
// 			return $this->$var;


			return $this->pn;
		
		}
		
		function getPackageNameAndVersionMinusRevision() {
		
			$arr = $this->getComponents();
		
			return $this->p = $this->getPackageName."-".$arr['pv'];
		}
		
		function getPackageVersionMinusRevision() {
		
			$var = 'pv';
		
			if(!$this->has_version)
				return $this->$var = "";
		
			$arr = $this->getComponents();
			
 			$str = $arr['version'];
 			
 			foreach($this->arr_suffix as $tmp) {
 			
 				if(!is_null($arr[$tmp])) {
 				
 					// Can't use empty, since it will break on
 					// _suffix0
 					if(strlen($arr[$tmp]) == 0)
 						$str .= "_$tmp";
 					else
 						$str .= "_$tmp".$arr[$tmp];
 				}
 			}
			
			return $this->$var = $str;
			
		}
		
		function getPackageVersionAndRevision() {
		
			$var = 'pvr';
		
			if(!$this->has_version)
				return $this->$var = "";
		
 			$arr = $this->getComponents();
 			
 			$str = $this->getPackageVersionMinusRevision();
 			
 			if($arr['r'])
 				$str .= "-r".$arr['r'];
 			return $this->$var = $str;
		}
		
		function getSlot() {
			
			$var = 'slot';
			
			if(strpos($this->atom, ':') > 0) {
				$str = end(explode(':', $this->atom));
			}
			else
				$str = 0;
			
			$this->$var = $str;
			
			return $this->$var;
			
		}
		
		// This could really use a better name.
		function getSuffix($var) {
		
			if(in_array($var, array('_alpha', '_beta', '_pre', '_rc', '_p', 'pr', 'version'))) {
				$arr = $this->getComponents();
				if($var[0] == "_")
					$str = str_replace("_", "", $var);
				return $this->$var = $arr[$str];
			}
		
		}
		
		/**
		 * Simplified way to get specific version information
		 */
		function getComponents() {
		
			$arr_components = array();
		
			if(count($this->arr_components)) {
				return $this->arr_components;
			}
			
			if(!$this->has_version)
				return array('version' => '', 'pv' => '');
			
			$str = $this->stripPackage($str);
			
			$arr = explode("-", $str);
			
			// We might be done at this point, depending on
			// the details of the atom passed in.
			if(!count($arr))
				return $this->arr_components = $arr_components;
			
 			$arr_components['pv'] = array_shift($arr);
			
			// Have the exploded one first so the version is the first value
 			$arr = array_merge(explode("_", $arr_components['pv']), $arr);
			
			// This format of the version isn't used in portage anywhere,
			// but it could be useful for package.masks or something
			// similar.  It's basically the version without any of the
			// suffices.  (vim-6.3_beta3 => 6.3)
			$arr_components['version'] = $this->version = array_shift($arr);
			
			// See if we have more
			if(count($arr)) {
			
				foreach($arr as $str) {
				
					// Each value is returned as a trimmed string *if* it
					// can find that there is a suffix version of it.  The
					// reason for this is because there are three possible
					// outcomes: the value is not set (null), it is set, but
					// there is no number (empty string), or it has a value
					// (integer).
				
					if(substr($str, 0, 5) == "alpha")
						$arr_components['alpha'] = $this->_alpha = trim(substr($str, 5));
					elseif(substr($str, 0, 4) == "beta")
						$arr_components['beta'] = $this->_beta = trim(substr($str, 4));
					elseif(substr($str, 0, 3) == "pre")
						$arr_components['pre'] = $this->_pre = trim(substr($str, 3));
					elseif(substr($str, 0, 2) == "rc")
						$arr_components['rc'] = $this->_rc = trim(substr($str, 2));
					// Shouldn't need the extra checks for pre/rc since the
					// whole thing is going to look at each string once, and
					// in order .. but weirder things have happened.  More
					// checks never hurt.
					elseif($str[0] == "p" && !(substr($str, 0, 3) == "pre"))
						$arr_components['p'] = $this->_p = trim(substr($str, 1));
					elseif($str[0] == "r" && !(substr($str, 0, 2) == "rc"))
						$arr_components['r'] = $this->pr = trim(substr($str, 1));
				
				}
			}
			
			return $this->arr_components = $arr_components;
			
		}
		
		function hasVersion() {
		
			$str = $this->stripCategory();
			$str = $this->stripSlot($str);
			
			// This pattern makes ONE grand assumption:
			// That a version that has both digits and letters (see ([A-Za-z])? ) that there is
			// ONLY one letter (fex: openssl-0.9a).  This lets us catch the pn properly of
			// atoms like font-adobe-100dpi, where it would normally think 100dpi = version.
 			$pattern = '/\-\d+((\.?\d+)+)?([A-Za-z])?((_(alpha|beta|pre|rc|p)\d*)+)?(\-r\d+)?(\:.+)?([.+])?$/';
 			$arr = preg_split($pattern, $str);
 			
 			$this->pn = $arr[0];
 			
 			// Check to see if it has a version or not (p.mask)
 			if(count($arr) == 1) {
 				$this->version = "";
 				$this->pf = "";
 				$this->pv = "";
 				$this->pvr = "";
 				return false;
 			} else
 				return true;
 			
		}
		
		function stripCategory() {
			
			if(strpos($this->atom, '/') > 0) {
				$arr = explode("/", $this->atom);
				
				if(count($arr) > 1) {
					$str = $arr[1];
				}
				
				return $str;
			} else {
				return $this->atom;
			}
		}
		
		function stripPackage($str) {
			
			$str = $this->stripCategory();
			$str = $this->stripSlot($str);
			$str = str_replace($this->getPackageName()."-", "", $str);
			return $str;
			
		}
 		
		function stripSlot($str) {
		
			if(!is_null($this->getSlot())) {
				$str = str_replace(":".$this->getSlot(), "", $str);
			} else
				$str =& $this->atom;
			
			return $str;
		
 		}
 		
 		function getMtime() {
 			
 			if(file_exists($this->filename))
 				return filemtime($this->filename);
 			else
 				return null;
 			
 		}
 		
	}

?>