"""
netboot target, version 1
"""
# NOTE: That^^ docstring has influence catalyst-spec(5) man page generation.

import os

from catalyst import log
from catalyst.support import (CatalystError, normpath,
	cmd, list_bashify, file_locate)

from catalyst.base.stagebase import StageBase


class netboot(StageBase):
	"""
	Builder class for a netboot build.
	"""
	def __init__(self,spec,addlargs):
		self.valid_values = [
			"netboot/kernel/sources",
			"netboot/kernel/config",
			"netboot/kernel/prebuilt",

			"netboot/busybox_config",

			"netboot/extra_files",
			"netboot/packages"
		]
		self.required_values=[]

		try:
			# XXX: This code does nothing because the for loop below is disabled.
			if "netboot/packages" in addlargs:
				if isinstance(addlargs['netboot/packages'], str):
					_loopy = [addlargs["netboot/packages"]]
				else:
					_loopy = addlargs["netboot/packages"]

		#	for x in loopy:
		#		self.required_values.append("netboot/packages/"+x+"/files")
		except:
			raise CatalystError("configuration error in netboot/packages.")

		StageBase.__init__(self,spec,addlargs)
		if "netboot/busybox_config" in addlargs:
			file_locate(self.settings, ["netboot/busybox_config"])

		# Custom Kernel Tarball --- use that instead ...

		# unless the user wants specific CFLAGS/CXXFLAGS, let's use -Os

		for envvar in "CFLAGS", "CXXFLAGS":
			if envvar not in os.environ and envvar not in addlargs:
				self.settings[envvar] = "-Os -pipe"

	def set_root_path(self):
		# ROOT= variable for emerges
		self.settings["root_path"]=normpath("/tmp/image")
		log.info('netboot root path is %s', self.settings['root_path'])

#	def build_packages(self):
#		# build packages
#		if "netboot/packages" in self.settings:
#			mypack=list_bashify(self.settings["netboot/packages"])
#		try:
#			cmd(self.settings["controller_file"]+" packages "+mypack,env=self.env)
#		except CatalystError:
#			self.unbind()
#			raise CatalystError("netboot build aborting due to error.",
#					print_traceback=True)

	def build_busybox(self):
		# build busybox
		if "netboot/busybox_config" in self.settings:
			mycmd = self.settings["netboot/busybox_config"]
		else:
			mycmd = ""
		try:
			cmd(self.settings["controller_file"]+" busybox "+ mycmd,env=self.env)
		except CatalystError:
			self.unbind()
			raise CatalystError("netboot build aborting due to error.",
				print_traceback=True)

	def copy_files_to_image(self):
		# create image
		myfiles=[]
		if "netboot/packages" in self.settings:
			if isinstance(self.settings['netboot/packages'], str):
				loopy=[self.settings["netboot/packages"]]
			else:
				loopy=self.settings["netboot/packages"]

		for x in loopy:
			if "netboot/packages/"+x+"/files" in self.settings:
				if isinstance(type(self.settings['netboot/packages/'+x+'/files']), str):
					myfiles.extend(self.settings["netboot/packages/"+x+"/files"])
				else:
					myfiles.append(self.settings["netboot/packages/"+x+"/files"])

		if "netboot/extra_files" in self.settings:
			if isinstance(self.settings['netboot/extra_files'], list):
				myfiles.extend(self.settings["netboot/extra_files"])
			else:
				myfiles.append(self.settings["netboot/extra_files"])

		try:
			cmd(self.settings["controller_file"]+\
				" image " + list_bashify(myfiles),env=self.env)
		except CatalystError:
			self.unbind()
			raise CatalystError("netboot build aborting due to error.",
				print_traceback=True)

	def create_netboot_files(self):
		# finish it all up
		try:
			cmd(self.settings["controller_file"]+" finish",env=self.env)
		except CatalystError:
			self.unbind()
			raise CatalystError("netboot build aborting due to error.",
				print_traceback=True)
		# end
		log.notice('netboot: build finished !')

	def set_action_sequence(self):
		self.settings["action_sequence"]=["unpack","unpack_snapshot",
			"config_profile_link","setup_confdir","bind","chroot_setup",\
			"setup_environment","build_packages","build_busybox",\
			"build_kernel","copy_files_to_image",\
			"clean","create_netboot_files","unbind","clear_autoresume"]