path: root/geneticone/backend/flags.py

#
# File: geneticone/backend/flags.py
# This file is part of the Genetic/One-Project, a graphical portage-frontend.
#
# Copyright (C) 2006 Necoro d.M.
# This is free software.  You may redistribute copies of it under the terms of
# the GNU General Public License version 2.
# There is NO WARRANTY, to the extent permitted by law.
#
# Written by Necoro d.M. <necoro@necoro.net>

import os
import os.path
from subprocess import Popen, PIPE # needed for grep

from geneticone.helper import *
from portage_helper import split_package_name
import package

import portage
from portage_util import unique_array

CONFIG = {
		"usefile" : "geneticone",
		"maskfile" : "geneticone",
		"testingfile" : "geneticone",
		"usePerVersion" : True,
		"maskPerVersion" : True,
		"testingPerVersion" : True
		}

### GENERAL PART ###

def grep (pkg, path):
	"""Grep runs "egrep" on a given path and looks for occurences of a given package.
	@param pkg: the package
	@type pkg: string (cpv) or L{backend.Package}-object
	@param path: path to look in
	@type path: string
	
	@returns: occurences of pkg in the format: "file:line-no:complete_line_found"
	@rtype: string"""

	if not isinstance(pkg, package.Package):
		pkg = package.Package(pkg) # assume it is a cpv or a gentoolkit.Package

	command = "egrep -x -n -r -H '^[<>!=~]{0,2}%s(-[0-9].*)?[[:space:]]?.*$' %s" # %s is replaced in the next line ;)
	return Popen((command % (pkg.get_cp(), path)), shell = True, stdout = PIPE).communicate()[0].splitlines()

def get_data(pkg, path):
	"""This splits up the data of L{grep} and builds tuples in the format (file,line,criterion,list_of_flags).
	@param pkg: package to find
	@type pkg: string (cpv) or L{backend.Package}-object
	@param path: path to look in
	@type path: string
	
	@returns: a list of tuples in the form (file,line,criterion,list_of_flags)
	@rtype: list"""
	
	flags = []

	# do grep
	list = grep(pkg, path)
	
	for i in range(len(list)):
		file, line, fl = tuple(list[i].split(":")) # get file, line and flag-list
		fl = fl.split()
		crit = fl[0]
		fl = fl[1:]
		# stop after first comment
		for i in range(len(fl)):
			if fl[i][0] == "#": # comment - stop here
				fl = fl[:i]
				break
		flags.append((file,line,crit,fl))

	return flags

def set_config (cfg):
	"""This function sets the CONFIG-variable for the whole module. Use this instead of modifying L{CONFIG} directly.
	@param cfg: a dictionary with at least all the keys of the CONFIG-var
	@type cfg: dict
	@raises KeyError: if a keyword is missing in the new cfg"""

	for i in CONFIG.keys():
		if not i in cfg:
			raise KeyError, "Missing keyword in config: "+i

	for i in CONFIG:
		CONFIG[i] = cfg[i]

def generate_path (cpv, exp):
	"""Generates the correct path out of given wildcards. 
	These wildcards can be:
		- $(cat) : category
		- $(cat-1): first part of the category (e.g. "app")
		- $(cat-2): second part of the category
		- $(pkg) : name of the package
	
	@param cpv: the cpv of the current package
	@type cpv: string (cat/pkg-ver)
	@param exp: the expression to render the path from
	@type exp: string
	@returns: rendered path
	@rtype string"""

	cat, pkg, ver, rev = split_package_name(cpv)
	
	if exp.find("$(") != -1:
		exp = exp.replace("$(cat)",cat).\
				replace("$(pkg)",pkg).\
				replace("$(cat-1)",cat.split("-")[0]).\
				replace("$(cat-2)",cat.split("-")[1])
	return exp

### USE FLAG PART ###
USE_PATH = os.path.join(portage.USER_CONFIG_PATH,"package.use")
USE_PATH_IS_DIR = os.path.isdir(USE_PATH)
useFlags = {} # useFlags in the file
newUseFlags = {} # useFlags as we want them to be: format: cpv -> [(file, line, useflag, (true if removed from list / false if added))]

def invert_use_flag (flag):
	"""Invertes a flag.

		>>> invert_use_flag("foo")
		-foo
		>>> invert_use_flag("-bar")
		bar

	@param flag: the flag
	@type flag: string
	@returns: inverted flag
	@rtype: string
	"""
	if flag[0] == "-":
		return flag[1:]
	else:
		return "-"+flag

def set_use_flag (pkg, flag):
	"""Sets the useflag for a given package.
	
	@param pkg: the package
	@type pkg: string (cpv) or L{backend.Package}-object
	@param flag: the flag to set
	@type flag: string"""

	global useFlags, newUseFlags

	if not isinstance(pkg, package.Package):
		pkg = package.Package(pkg) # assume cpv or gentoolkit.Package

	cpv = pkg.get_cpv()
	invFlag = invert_use_flag(flag)
	
	# if not saved in useFlags, get it by calling get_data() which calls grep()
	data = None
	if not cpv in useFlags:
		data = get_data(pkg, USE_PATH)
		useFlags[cpv] = data
	else:
		data = useFlags[cpv]

	if not cpv in newUseFlags:
		newUseFlags[cpv] = []

	debug("data: "+str(data))
	# add a useflag / delete one
	added = False
	for file, line, crit, flags in data:
		if pkg.matches(crit):
			# we have the inverted flag in the uselist/newuselist --> delete it
			if invFlag in flags or (file, line, invFlag, False) in newUseFlags[cpv] or (file, line, flag, True) in newUseFlags[cpv]:
				if added: del newUseFlags[-1] # we currently added it as an extra option - delete it
				added = True
				jumpOut = False
				for t in [(file, line, invFlag, False),(file, line, flag, True)]:
					if t in newUseFlags[cpv]:
						newUseFlags[cpv].remove(t)
						jumpOut = True
						break
				if not jumpOut:	newUseFlags[cpv].append((file, line, invFlag, True))
				break
			
			# we want to duplicate the flag --> ignore
			elif flag in flags:
				added = True # emulate adding
				break

			# add as an extra flag
			else:
				if not added: newUseFlags[cpv].append((file, line, flag, False))
				added = True
	
	# create a new line
	if not added:
		path = USE_PATH
		if USE_PATH_IS_DIR:
			path = os.path.join(USE_PATH,generate_path(cpv, CONFIG["usefile"]))
		
		try:
			newUseFlags[cpv].remove((path, -1, invFlag, False))
		except ValueError: # not in UseFlags
			newUseFlags[cpv].append((path, -1, flag, False))

	newUseFlags[cpv] = unique_array(newUseFlags[cpv])
	debug("newUseFlags: "+str(newUseFlags))

def remove_new_use_flags (cpv):
	"""Removes all new use-flags for a specific package.
	@param cpv: the package for which to remove the flags
	@type cpv: string (cpv) or L{backend.Package}-object"""
	if isinstance(cpv, package.Package):
		cpv = cpv.get_cpv()
	
	try:
		del newUseFlags[cpv]
	except KeyError:
		pass

def get_new_use_flags (cpv):
	"""Gets all the new use-flags for a specific package.
	@param cpv: the package for which to remove the flags
	@type cpv: string (cpv) or L{backend.Package}-object
	@returns: list of flags
	@rtype: list"""
	
	if isinstance(cpv, package.Package):
		cpv = cpv.get_cpv()

	list2return = []
	try:
		for file, line, flag, remove in newUseFlags[cpv]:
			if remove:
				list2return.append(invert_use_flag(flag))
			else:
				list2return.append(flag)
	except KeyError:
		pass

	return list2return

def write_use_flags ():
	"""This writes our changed useflags into the file."""
	global newUseFlags, useFlags

	def insert (flag, list):
		"""Shortcut for inserting a new flag right after the package-name."""
		list.insert(1,flag)
	
	def remove (flag, list):
		"""Removes a flag."""
		try:
			list.remove(flag)
		except ValueError: # flag is given as flag\n
			list.remove(flag+"\n")
			list.append("\n") #re-insert the newline

		# no more flags there - comment it out
		if len(list) == 1 or list[1][0] in ("#","\n"):
			list[0] = "#"+list[0]
			insert("#removed by geneticone#",list)

	file_cache = {} # cache for having to read the file only once: name->[lines]
	for cpv in newUseFlags:
		flagsToAdd = [] # this is used for collecting the flags to be inserted in a _new_ line
		for file, line, flag, delete in newUseFlags[cpv]:
			line = int(line) # it is saved as a string so far!
			
			# add new line
			if line == -1:
				flagsToAdd.append(flag)
			# change a line
			else:
				if not file in file_cache:
					# read file
					f = open(file, "r")
					lines = []
					i = 1
					while i < line: # stop at the given line
						lines.append(f.readline())
						i = i+1
					l = f.readline().split(" ")
					# delete or insert
					if delete:
						remove(flag,l)
					else:
						insert(flag,l)
					lines.append(" ".join(l))
					
					# read the rest
					lines.extend(f.readlines())
					
					file_cache[file] = lines
					f.close()
				else: # in cache
					l = file_cache[file][line-1].split(" ")
					if delete:
						remove(flag,l)
					else:
						insert(flag,l)
					file_cache[file][line-