# -*- coding: utf-8 -*- ############################################################################## # # Copyright (c) 2010 Nexedi SA and Contributors. All Rights Reserved. # Ćukasz Nowak <luke@nexedi.com> # Romain Courteaud <romain@nexedi.com> # # WARNING: This program as such is intended to be used by professional # programmers who take the whole responsibility of assessing all potential # consequences resulting from its eventual inadequacies and bugs # End users who are looking for a ready-to-use solution with commercial # guarantees and support are strongly advised to contract a Free Software # Service Company # # This program is Free Software; you can redistribute it and/or # modify it under the terms of the GNU General Public License # as published by the Free Software Foundation; either version 2 # of the License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. # ############################################################################## from AccessControl import ClassSecurityInfo from AccessControl import Unauthorized from AccessControl.SecurityManagement import newSecurityManager from OFS.Traversable import NotFound from Products.DCWorkflow.DCWorkflow import ValidationFailed from Products.ERP5Security.ERP5UserManager import SUPER_USER from Products.ERP5Type.Globals import InitializeClass from Products.ERP5Type.Tool.BaseTool import BaseTool from Products.ERP5Type.UnrestrictedMethod import UnrestrictedMethod from lxml import etree from slapos.slap.slap import Computer from slapos.slap.slap import ComputerPartition as SlapComputerPartition from slapos.slap.slap import SoftwareInstance from slapos.slap.slap import SoftwareRelease from zLOG import LOG, INFO import xml_marshaller class SoftwareInstanceNotReady(Exception): pass def convertToREST(function): """ Wrap the method to create a log entry for each invocation to the zope logger """ def wrapper(self, *args, **kwd): """ Log the call, and the result of the call """ self._loginAsSuperUser() try: retval = function(self, *args, **kwd) except ValueError, log: LOG('SlapTool', INFO, 'Converting ValueError to NotFound, real error:', error=True) raise NotFound(log) except SoftwareInstanceNotReady, log: self.REQUEST.response.setStatus(408) return self.REQUEST.response except ValidationFailed: LOG('SlapTool', INFO, 'Converting ValidationFailed to ValidationFailed, real error:', error=True) raise ValidationFailed self.REQUEST.response.setHeader('Content-Type', 'text/xml') return '%s' % retval wrapper.__doc__ = function.__doc__ return wrapper class SlapTool(BaseTool): """SlapTool""" # TODO: # * catch and convert exceptions to HTTP codes (be restful) id = 'portal_slap' meta_type = 'ERP5 Slap Tool' portal_type = 'Slap Tool' security = ClassSecurityInfo() allowed_types = () #################################################### # Public GET methods #################################################### security.declarePublic('getComputerInformation') def getComputerInformation(self, computer_id): """Returns marshalled XML of all needed information for computer Includes Software Releases, which may contain Software Instances. Reuses slap library for easy marshalling. """ computer_document = self._getComputerDocument(computer_id) self.REQUEST.response.setHeader('Content-Type', 'text/xml') self._loginAsSuperUser() slap_computer = Computer(computer_id) slap_computer._software_release_list = \ self._getSoftwareReleaseValueListForComputer(computer_document) slap_computer._computer_partition_list = [] for computer_partition_document in computer_document.contentValues( portal_type="Computer Partition"): slap_computer._computer_partition_list.append( self._convertToSlapPartition(computer_partition_document, computer_id)) for slave_partition_document in computer_partition_document\ .contentValues(portal_type='Slave Partition'): slap_computer._computer_partition_list.append( self._convertToSlapPartition(slave_partition_document, computer_id)) return xml_marshaller.xml_marshaller.dumps(slap_computer) #################################################### # Public POST methods #################################################### security.declarePublic('setComputerPartitionParameterDict') def setComputerPartitionConnectionXml(self, computer_id, computer_partition_id, connection_xml): """ Set instance parameter informations on the slagrid server """ return self._setComputerPartitionConnectionXml(computer_id, computer_partition_id, connection_xml) security.declarePublic('buildingSoftwareRelease') def buildingSoftwareRelease(self, url, computer_id): """ Reports that Software Release is being build """ return self._buildingSoftwareRelease(url, computer_id) security.declarePublic('availableSoftwareRelease') def availableSoftwareRelease(self, url, computer_id): """ Reports that Software Release is available """ return self._availableSoftwareRelease(url, computer_id) security.declarePublic('softwareReleaseError') def softwareReleaseError(self, url, computer_id, error_log): """ Add an error for a software Release workflow """ return self._softwareReleaseError(url, computer_id, error_log) security.declarePublic('buildingComputerPartition') def buildingComputerPartition(self, computer_id, computer_partition_id): """ Reports that Computer Partition is being build """ return self._buildingComputerPartition(computer_id, computer_partition_id) security.declarePublic('availableComputerPartition') def availableComputerPartition(self, computer_id, computer_partition_id): """ Reports that Computer Partition is available """ return self._availableComputerPartition(computer_id, computer_partition_id) security.declarePublic('softwareInstanceError') def softwareInstanceError(self, computer_id, computer_partition_id, error_log): """ Add an error for the software Instance Workflow """ return self._softwareInstanceError(computer_id, computer_partition_id, error_log) security.declarePublic('startedComputerPartition') def startedComputerPartition(self, computer_id, computer_partition_id): """ Reports that Computer Partition is started """ return self._startedComputerPartition(computer_id, computer_partition_id) security.declarePublic('stoppedComputerPartition') def stoppedComputerPartition(self, computer_id, computer_partition_id): """ Reports that Computer Partition is stopped """ return self._stoppedComputerPartition(computer_id, computer_partition_id) security.declarePublic('destroyedComputerPartition') def destroyedComputerPartition(self, computer_id, computer_partition_id): """ Reports that Computer Partition is destroyed """ return self._destroyedComputerPartition(computer_id, computer_partition_id) security.declarePublic('requestComputerPartition') def requestComputerPartition(self, computer_id, computer_partition_id, software_release, software_type, partition_reference, shared_xml, partition_parameter_xml, filter_xml): """ Asynchronously requests creation of computer partition for assigned parameters Returns XML representation of partition with HTTP code 200 OK In case if this request is still being processed data contain "Computer Partition is being processed" and HTTP code is 408 Request Timeout In any other case returns not important data and HTTP code is 403 Forbidden """ return self._requestComputerPartition(computer_id, computer_partition_id, software_release, software_type, partition_reference, shared_xml, partition_parameter_xml, filter_xml) security.declarePublic('useComputer') def useComputer(self, computer_id, use_string): """Entry point to reporting usage of a computer.""" computer_document = self._getComputerDocument(computer_id) # easy way to start to store usage messages sent by client in related Web # Page text_content... self._reportComputerUsage(computer_document, use_string) return 'Content properly posted.' security.declarePublic('loadComputerConfigurationFromXML') def loadComputerConfigurationFromXML(self, xml): "Load the given xml as configuration for the computer object" self._loginAsSuperUser() computer_dict = xml_marshaller.xml_marshaller.loads(xml) computer = self._getComputerDocument(computer_dict['reference']) computer.Computer_loadComputerPartitionsFromDictionnary(computer_dict) return 'Content properly posted.' security.declarePublic('useComputerPartition') def useComputerPartition(self, computer_id, computer_partition_id, use_string): """Warning : deprecated method.""" computer_document = self._getComputerDocument(computer_id) computer_partition_document = self._getComputerPartitionDocument( computer_document.getReference(), computer_partition_id) # easy way to start to store usage messages sent by client in related Web # Page text_content... self._reportUsage(computer_partition_document, use_string) return """Content properly posted. WARNING : this method is deprecated. Please use useComputer.""" security.declarePublic('registerComputerPartition') def registerComputerPartition(self, computer_reference, computer_partition_reference): """ Registers connected representation of computer partition and returns Computer Partition class object """ # Try to get the computer partition to raise an exception if it doesn't # exist self._getComputerPartitionDocument( computer_reference, computer_partition_reference) return xml_marshaller.xml_marshaller.dumps( SlapComputerPartition(computer_reference, computer_partition_reference)) #################################################### # Internal methods #################################################### def _instanceXmlToDict(self, xml): result_dict = {} if xml is not None and xml != '': tree = etree.fromstring(xml.encode('utf-8')) for element in tree.iter(tag=etree.Element): if element.tag == 'parameter': key = element.get('id') value = result_dict.get(key, None) if value is not None: value = value + ' ' + element.text else: value = element.text result_dict[key] = value return result_dict def _getModificationStatusForSlave(self, computer_partition_document): for slave in computer_partition_document.contentValues( portal_type='Slave Partition'): if slave.getSlapState() == 'busy': slap_partition = self._getSlapPartitionByPackingList(slave) if slap_partition._need_modification == 1: return 1 return 0 def _getSlapPartitionByPackingList(self, computer_partition_document): computer = computer_partition_document portal = self.getPortalObject() portal_preferences = portal.portal_preferences while computer.getPortalType() != 'Computer': computer = computer.getParentValue() computer_id = computer.getReference() slap_partition = SlapComputerPartition(computer_id, computer_partition_document.getReference()) slap_partition._software_release_document = None slap_partition._requested_state = 'destroyed' slap_partition._need_modification = 0 movement = self._getSalePackingListLineForComputerPartition( computer_partition_document) if movement is not None: software_release_document = \ movement.getAggregateValue(portal_type='Software Release') slap_partition._software_release_document = SoftwareRelease( software_release=software_release_document.getUrlString(), computer_guid=computer_id) parameter_dict = self._getSalePackingListLineAsSoftwareInstance( movement) # software instance has to define an xml parameter slap_partition._parameter_dict = self._instanceXmlToDict( parameter_dict.pop('xml')) slap_partition._connection_dict = self._instanceXmlToDict( parameter_dict.pop('connection_xml')) slap_partition._parameter_dict.update(parameter_dict) # Apply state and buildout run conditions if movement.getResource() == \ portal_preferences.getPreferredInstanceSetupResource(): if movement.getSimulationState() in ('confirmed', 'started',): slap_partition._requested_state = 'stopped' slap_partition._need_modification = 1 elif movement.getSimulationState() == 'stopped': slap_partition._requested_state = 'stopped' elif movement.getSimulationState() == 'delivered': pass else: raise NotImplementedError, "Unexpected state %s" % \ movement.getSimulationState() elif movement.getResource() == \ portal_preferences.getPreferredInstanceHostingResource(): if movement.getSimulationState() == 'confirmed': slap_partition._requested_state = 'started' slap_partition._need_modification = 1 elif movement.getSimulationState() == 'started': slap_partition._requested_state = 'started' elif movement.getSimulationState() == 'stopped': slap_partition._requested_state = 'stopped' slap_partition._need_modification = 1 elif movement.getSimulationState() == 'delivered': slap_partition._requested_state = 'stopped' else: raise NotImplementedError, "Unexpected state %s" % \ movement.getSimulationState() elif movement.getResource() == \ portal_preferences.getPreferredInstanceCleanupResource(): if movement.getSimulationState() in ('confirmed', 'started', 'stopped'): slap_partition._need_modification = 1 else: raise NotImplementedError, "Unexpected resource%s" % \ movement.getResource() return slap_partition def _convertToSlapPartition(self, computer_partition_document, computer_id): slap_partition = self._getSlapPartitionByPackingList( computer_partition_document) if computer_partition_document.getPortalType() == 'Slave Partition': slap_partition._need_modification = 0 elif computer_partition_document.getQuantity() > 0 and \ slap_partition._need_modification == 0: slap_partition._need_modification = self._getModificationStatusForSlave( computer_partition_document) return slap_partition @convertToREST def _buildingSoftwareRelease(self, url, computer_id): """ Reports that Software Release is being build """ computer_document = self._getComputerDocument(computer_id) computer_document.startSoftwareReleaseInstallation(software_release_url=url) @convertToREST def _availableSoftwareRelease(self, url, computer_id): """ Reports that Software Release is available """ computer_document = self._getComputerDocument(computer_id) computer_document.stopSoftwareReleaseInstallation(software_release_url=url) @convertToREST def _softwareReleaseError(self, url, computer_id, error_log): """ Add an error for a software Release workflow """ computer_document = self._getComputerDocument(computer_id) computer_document.reportSoftwareReleaseInstallationError( comment=error_log, software_release_url=url) @convertToREST def _buildingComputerPartition(self, computer_id, computer_partition_id): """ Reports that Computer Partition is being build """ return self._getSoftwareInstanceForComputerPartition( computer_id, computer_partition_id).startComputerPartitionInstallation() @convertToREST def _availableComputerPartition(self, computer_id, computer_partition_id): """ Reports that Computer Partition is available """ return self._getSoftwareInstanceForComputerPartition( computer_id, computer_partition_id).stopComputerPartitionInstallation() @convertToREST def _softwareInstanceError(self, computer_id, computer_partition_id, error_log): """ Add an error for the software Instance Workflow """ return self._getSoftwareInstanceForComputerPartition( computer_id, computer_partition_id).reportComputerPartitionError( comment=error_log) @convertToREST def _startedComputerPartition(self, computer_id, computer_partition_id): """ Reports that Computer Partition is started """ return self._getSoftwareInstanceForComputerPartition( computer_id, computer_partition_id).startComputerPartition() @convertToREST def _stoppedComputerPartition(self, computer_id, computer_partition_id): """ Reports that Computer Partition is stopped """ return self._getSoftwareInstanceForComputerPartition( computer_id, computer_partition_id).stopComputerPartition() @convertToREST def _destroyedComputerPartition(self, computer_id, computer_partition_id): """ Reports that Computer Partition is destroyed """ software_instance = self._getSoftwareInstanceForComputerPartition( computer_id, computer_partition_id) return software_instance.destroyComputerPartition() @convertToREST def _setComputerPartitionConnectionXml(self, computer_id, computer_partition_id, connection_xml): """ Sets Computer Partition connection Xml """ software_instance = self._getSoftwareInstanceForComputerPartition( computer_id, computer_partition_id) partition_parameter_kw = xml_marshaller.xml_marshaller.loads( connection_xml) instance = etree.Element('instance') for parameter_id, parameter_value in partition_parameter_kw.iteritems(): # cast everything to string parameter_value = str(parameter_value) etree.SubElement(instance, "parameter", attrib={'id':parameter_id}).text = parameter_value connection_xml = etree.tostring(instance, pretty_print=True, xml_declaration=True, encoding='utf-8') software_instance.edit( connection_xml=connection_xml, ) @convertToREST def _requestComputerPartition(self, computer_id, computer_partition_id, software_release, software_type, partition_reference, shared_xml, partition_parameter_xml, filter_xml): """ Asynchronously requests creation of computer partition for assigned parameters Returns XML representation of partition with HTTP code 200 OK In case if this request is still being processed data contain "Computer Partition is being processed" and HTTP code is 408 Request Timeout In any other case returns not important data and HTTP code is 403 Forbidden """ shared = xml_marshaller.xml_marshaller.loads(shared_xml) partition_parameter_kw = xml_marshaller.xml_marshaller.loads( partition_parameter_xml) filter_kw = xml_marshaller.xml_marshaller.loads(filter_xml) instance = etree.Element('instance') for parameter_id, parameter_value in partition_parameter_kw.iteritems(): # cast everything to string parameter_value = str(parameter_value) etree.SubElement(instance, "parameter", attrib={'id':parameter_id}).text = parameter_value instance_xml = etree.tostring(instance, pretty_print=True, xml_declaration=True, encoding='utf-8') software_instance_document = self._getSoftwareInstanceForComputerPartition( computer_id, computer_partition_id) software_instance_document.requestSoftwareInstance( software_release=software_release, software_type=software_type, partition_reference=partition_reference, shared=shared, instance_xml=instance_xml, filter_kw=filter_kw) # Get requested software instance requested_software_instance = software_instance_document.portal_catalog.\ getResultValue( portal_type="Software Instance", reference=partition_reference, title=software_type, predecessor_related_uid=software_instance_document.getUid(),) if requested_software_instance is None: raise SoftwareInstanceNotReady else: movement = self._getSalePackingListLineForComputerPartition( requested_software_instance) software_instance = SoftwareInstance( **self._getSalePackingListLineAsSoftwareInstance( movement)) return xml_marshaller.xml_marshaller.dumps(software_instance) #################################################### # Internals methods #################################################### def _loginAsSuperUser(self): """Inovking python scripts requiers any user, UnrestrictedMethod is not enough""" # XXX-Luke: Workaround of security issues. As soon as security will be # defined there will be no reason to reuse system user. newSecurityManager(None, self.getPortalObject().acl_users.getUserById( SUPER_USER)) @UnrestrictedMethod def _getDocument(self, **kwargs): # No need to get all results if an error is raised when at least 2 objects # are found l = self.getPortalObject().portal_catalog(limit=2, **kwargs) if len(l) != 1: raise NotFound, "No document found with parameters: %s" % kwargs else: return l[0].getObject() def _getComputerDocument(self, computer_reference): """ Get the validated computer with this reference. """ return self._getDocument( portal_type='Computer', # XXX Hardcoded validation state validation_state="validated", reference=computer_reference) def _getComputerPartitionDocument(self, computer_reference, computer_partition_reference): """ Get the computer partition defined in an available computer """ # Related key might be nice computer = self._getComputerDocument(computer_reference) try: return self._getDocument(portal_type='Computer Partition', reference=computer_partition_reference, parent_uid=computer.getUid()) except NotFound: return self._getDocument(portal_type='Slave Partition', reference=computer_partition_reference, grand_parent_uid=computer.getUid()) @UnrestrictedMethod def _getUsageReportServiceDocument(self): self._loginAsSuperUser() service_document = self.Base_getUsageReportServiceDocument() if service_document is not None: return service_document raise Unauthorized @UnrestrictedMethod def _getSoftwareInstanceForComputerPartition(self, computer_id, computer_partition_id): self._loginAsSuperUser() computer_partition_document = self._getComputerPartitionDocument( computer_id, computer_partition_id) packing_list_line = self._getSalePackingListLineForComputerPartition( computer_partition_document) if packing_list_line is None: raise NotFound, "No software instance found for: %s - %s" % (computer_id, computer_partition_id) else: software_instance = packing_list_line.getAggregateValue( portal_type="Software Instance") if software_instance is None: raise NotFound, "No software instance found for: %s - %s" % (computer_id, computer_partition_id) else: return software_instance @UnrestrictedMethod def _getSalePackingListLineAsSoftwareInstance(self, sale_packing_list_line): self._loginAsSuperUser() merged_dict = sale_packing_list_line.\ SalePackinListLine_asSoftwareInstnaceComputerPartitionMergedDict() if merged_dict is None: LOG('SlapTool._getSalePackingListLineAsSoftwareInstance', INFO, '%s returned no information' % sale_packing_list_line.getRelativeUrl()) raise Unauthorized return merged_dict @UnrestrictedMethod def _getSoftwareReleaseValueListForComputer(self, computer_document): """Returns list of Software Releases documentsfor computer""" portal = self.getPortalObject() self._loginAsSuperUser() state_list = [] state_list.extend(portal.getPortalReservedInventoryStateList()) state_list.extend(portal.getPortalTransitInventoryStateList()) software_release_list = [] computer_reference = computer_document.getReference() for software_release_url_string in computer_document\ .Computer_getSoftwareReleaseUrlStringList(state_list): software_release_response = SoftwareRelease( software_release=software_release_url_string, computer_guid=computer_reference) software_release_list.append(software_release_response) return software_release_list @UnrestrictedMethod def _getSalePackingListLineForComputerPartition(self, computer_partition_document): """ Return latest meaningfull sale packing list related to a computer partition document """ portal = self.getPortalObject() portal_preferences = portal.portal_preferences service_uid_list = [] self._loginAsSuperUser() for service_relative_url in \ (portal_preferences.getPreferredInstanceSetupResource(), portal_preferences.getPreferredInstanceHostingResource(), portal_preferences.getPreferredInstanceCleanupResource(), ): service = portal.restrictedTraverse(service_relative_url) service_uid_list.append(service.getUid()) # Get associated software release state_list = [] state_list.extend(portal.getPortalCurrentInventoryStateList()) state_list.extend(portal.getPortalReservedInventoryStateList()) state_list.extend(portal.getPortalTransitInventoryStateList()) # Use getTrackingList catalog_result = portal.portal_catalog( portal_type='Sale Packing List Line', simulation_state=state_list, aggregate_relative_url=computer_partition_document.getRelativeUrl(), default_resource_uid=service_uid_list, sort_on=(('movement.start_date', 'DESC'),), limit=1, ) if len(catalog_result): return catalog_result[0].getObject() else: return None @UnrestrictedMethod def _reportComputerUsage(self, computer, usage): """Stores usage report of a computer.""" self._loginAsSuperUser() usage_report_portal_type = 'Usage Report' usage_report_module = \ self.getPortalObject().getDefaultModule(usage_report_portal_type) sale_packing_list_portal_type = 'Sale Packing List' sale_packing_list_module = \ self.getPortalObject().getDefaultModule(sale_packing_list_portal_type) sale_packing_list_line_portal_type = 'Sale Packing List Line' software_release_portal_type = 'Software Release' hosting_subscription_portal_type = 'Hosting Subscription' software_instance_portal_type = 'Software Instance' # We get the whole computer usage in one time # We unmarshall it, then we create a single packing list, # each line is a computer partition unmarshalled_usage = xml_marshaller.xml_marshaller.loads(usage) # Creates the Packing List usage_report_sale_packing_list_document = \ sale_packing_list_module.newContent( portal_type = sale_packing_list_portal_type, ) usage_report_sale_packing_list_document.confirm() usage_report_sale_packing_list_document.start() # Adds a new SPL line for each Computer Partition for computer_partition_usage in unmarshalled_usage.computer_partition_usage_list: #Get good packing list line for a computer_partition computer_partition_document = self.\ _getComputerPartitionDocument( computer.getReference(), computer_partition_usage.getId() ) instance_setup_sale_packing_line = \ self._getDocument( portal_type='Sale Packing List Line', simulation_state='stopped', aggregate_relative_url=computer_partition_document\ .getRelativeUrl(), resource_relative_url=self.portal_preferences\ .getPreferredInstanceSetupResource() ) # Fetching documents software_release_document = \ self.getPortalObject().restrictedTraverse( instance_setup_sale_packing_line.getAggregateList( portal_type=software_release_portal_type )[0] ) hosting_subscription_document = \ self.getPortalObject().restrictedTraverse( instance_setup_sale_packing_line.getAggregateList( portal_type=hosting_subscription_portal_type )[0] ) software_instance_document = \ self.getPortalObject().restrictedTraverse( instance_setup_sale_packing_line.getAggregateList( portal_type=software_instance_portal_type )[0] ) # Creates the usage document usage_report_document = usage_report_module.newContent( portal_type = usage_report_portal_type, text_content = computer_partition_usage.usage, causality_value = computer_partition_document ) usage_report_document.validate() # Creates the line usage_report_sale_packing_list_document.newContent( portal_type = sale_packing_list_line_portal_type, # We assume that "Usage Report" is an existing service document resource_value = self._getUsageReportServiceDocument(), aggregate_value_list = [usage_report_document, \ computer_partition_document, software_release_document, \ hosting_subscription_document, software_instance_document ] ) @UnrestrictedMethod def _reportUsage(self, computer_partition, usage): """Warning : deprecated method.""" portal_type = 'Usage Report' module = self.getPortalObject().getDefaultModule(portal_type) usage_report = module.newContent( portal_type=portal_type, text_content=usage, causality_value=computer_partition ) usage_report.validate() InitializeClass(SlapTool)