o bt@sddlZddlZddlZddlZddlZddlmZddlmZddl m Z e dej vZ gZgZGdddeZGd d d eZeZGd d d eZGd ddeZGdddeZGdddeZGdddeZGdddeZdS)N)log)XMLAPI)xmlutilVIRTINST_TEST_SUITEc@s<eZdZdZdZdZdZdZdZdZ dZ ddZ dd Z dS) XMLManualActionz[ Helper class for tracking and performing the user requested manual XML action rNcCs|ddd}|jr||jtjS|jr||jtjS|j}|jr#|j}ndt|vr/td|| dd\}}||tj |S)NcSs |||fSN)xavr r ./usr/share/virt-manager/virtinst/xmlbuilder.py_ret, z+XMLManualAction._process_args.._ret=z4%s: Setting xpath must be in the form of XPATH=VALUErr ) xpath_deleter ACTION_DELETE xpath_create ACTION_CREATE xpath_set xpath_valuestr Exceptionrsplit ACTION_SET)selfrxpathvalr r r _process_args+s  zXMLManualAction._process_argscCsx|js|js|js|jsdS|\}}}|dr||}||jkr'd}n ||jkr/d}n|p2d}|j ||dS)N.FT) rrrrr startswithmake_abs_xpathrrxmlapiset_xpath_content)rxmlstateractionvaluesetvalr r rperform?s"    zXMLManualAction.perform) __name__ __module__ __qualname____doc__rrrrrrrr r*r r r rrs rc@s8eZdZdZddZddZddZdd Zd d Zd S) _XMLPropertyCachezn Cache lookup tables mapping classes to their associated XMLProperty and XMLChildProperty classes cCsi|_i|_dSr ) _name_to_prop _prop_to_namerr r r__init__Xs z_XMLPropertyCache.__init__cCst|d|j}||jvr;i}tt|ddD]}|jD]\}}t||r4|||<||j |<q"q||j|<|j|S)N-) rr+r0reversedtypemro__dict__items isinstancer1)rcls checkclass cachenameretckeyrr r r_get_prop_cache\s     z!_XMLPropertyCache._get_prop_cachecC||jtSr )rB __class__ XMLPropertyrinstr r r get_xml_propshz_XMLPropertyCache.get_xml_propscCrCr )rBrDXMLChildPropertyrFr r rget_child_propskrIz!_XMLPropertyCache.get_child_propscCs |j|Sr )r1)rpropinstr r r get_prop_namenrz_XMLPropertyCache.get_prop_nameN) r+r,r-r.r3rBrHrKrMr r r rr/Ss  r/c@s*eZdZdZd ddZddZddZd S) _XMLChildListz Little wrapper for a list containing XMLChildProperty output. This is just to insert a dynamically created add_new() function which instantiates and appends a new child object TcCs4t|||_||_||_|D]}||qdSr )listr3 _childclass _xmlbuilder_is_xmlappend)r childclasscopylist xmlbuilderis_xmlir r rr3{s  z_XMLChildList.__init__cCsd}|jr |jjf}|j|S)z> Instantiate a new child object and return it r )rRrQconnrP)rargsr r rnews  z_XMLChildList.newcCs,|}|jr|j||S|||S)zJ Instantiate a new child object, append it, and return it )r[rRrQ add_childrS)robjr r radd_news   z_XMLChildList.add_newN)T)r+r,r-r.r3r[r^r r r rrNus   rNc@s eZdZddZeddZdS)_XMLPropertyBasecCsd|_tj|||ddS)N)fgetfset) _propnamepropertyr3)rr`rar r rr3sz_XMLPropertyBase.__init__cCs|js t||_|jS)z The variable name associated with this XMLProperty. So with a definition like foo = XMLProperty("./@bar") and this will return "foo". )rb _PropCacherMr2r r rpropnames z_XMLPropertyBase.propnameN)r+r,r-r3rcrer r r rr_sr_c@sbeZdZdZdddZddZdd Zd d Zd d ZddZ ddZ ddZ ddZ ddZ dS)rJaz Property that points to a class used for parsing a subsection of of the parent XML. For example when we deligate parsing /domain/cpu/feature of the /domain/cpu class. @child_class: XMLBuilder class this property is tracking. So for guest.devices.disk this is DeviceDisk @relative_xpath: Relative location where the class is rooted compared to its xmlbuilder root path. So if xmlbuilder is ./foo and we want to track ./foo/bar/baz instances, set relative_xpath=./bar @is_single: If True, this represents an XML node that is only expected to appear once, like r!FcCs&||_||_||_t||jddSr ) child_class is_singlerelative_xpathr_r3_fget)rrfrhrgr r rr3szXMLChildProperty.__init__cCdt|jt|fS)Nz)rrfidr2r r r__repr__zXMLChildProperty.__repr__cCs*|j|jvr|jsg|j|j<|j|jSr )re _propstorergrrVr r r_gets  zXMLChildProperty._getcCs$|jr||St|j|||Sr )rgrprNrfror r rris  zXMLChildProperty._fgetcCs>|jr ||dS||ddD]}||qdSr )rgrpclear remove_childrrVr]r r rrqs  zXMLChildProperty.clearcCs||||dSr )rpinsert)rrVnewobjidxr r rrtrmzXMLChildProperty.insertcC|||dSr )rprS)rrVrur r rrSzXMLChildProperty.appendcCrwr )rpremoversr r rryrxzXMLChildProperty.removecCs||j|j<dSr rnrersr r rsetzXMLChildProperty.setcCs|jd|jS)N/)rhXML_NAME)rrQr]r r rget_prop_xpathr|zXMLChildProperty.get_prop_xpathN)r!F)r+r,r-r.r3rlrprirqrtrSryr{rr r r rrJs  rJc@sjeZdZ  dddZddZddZdd Zd d Zd d ZddZ ddZ ddZ ddZ ddZ dS)rEFcCs||_|js td||_||_||_||_||_tdd|j|j|j|jfD}|dkr4tdd|_ t r>t |t ||j|jdS)a7 Set a XMLBuilder class property that maps to a value in an XML document, indicated by the passed xpath. For example, for a the definition may look like: name = XMLProperty("./name") When building XML from scratch (virt-install), 'name' works similar to a regular class property(). When parsing and editing existing guest XML, we use the xpath value to get/set the value in the parsed XML document. :param xpath: xpath string which maps to the associated property in a typical XML document :param name: Just a string to print for debugging, only needed if xpath isn't specified. :param is_bool: Whether this is a boolean property in the XML :param is_int: Whether this is an integer property in the XML :param is_yesno: Whether this is a yes/no property in the XML :param is_onoff: Whether this is an on/off property in the XML :param do_abspath: If True, run os.path.abspath on the passed value z"XMLProperty: xpath must be passed.cSsg|]}tt|qSr )intbool).0rXr r r z(XMLProperty.__init__..rz$Conflict property converter options.FN)_xpathrDevError_is_bool_is_int _is_yesno _is_onoff _do_abspathsum _is_tracked _trackprops _allpropsrSr_r3gettersetter)rris_boolis_intis_yesnois_onoff do_abspath conflictsr r rr3s&   zXMLProperty.__init__cCrj)Nz)rrrkr2r r rrlrmzXMLProperty.__repr__c Cs|jrt|S|jrA|durAzi}dt|vrd|d<t|fi|}W|Sty@}ztd||}WYd}~|Sd}~ww|jrX|dkrLd}|S|dkrTd}|S|}|S|j ro|d krcd}|S|d krkd}|S|}|S|}|S) N0xbasez%Error converting XML value to int: %syesTnoFonoff) rrrrr ValueErrorrdebugrr)rr intkwargsr?er r r_convert_get_valuesF    zXMLProperty._convert_get_valuecCs|jr|durtj|}|S|jr"|durd}|S|dur d}|S|jr5|dur-d}|S|dur3d}|S|jrP|durPi}dt|vrHd|d <t|fi|}|S) NTrFrrrrrr) rospathabspathrrrrr)rrrr r r_convert_set_value=s.    zXMLProperty._convert_set_valuecCs&|j}|j|vr ||j=|||j<dS)z This stores the value in XMLBuilder._propstore dict as propname->value. This saves us from having to explicitly track every variable. Nrz)rrVr propstorer r r _nonxml_fsetQs zXMLProperty._nonxml_fsetcCs|j|jdS)zb The flip side to nonxml_fset, fetch the value from XMLBuilder._propstore N)rngetreror r r _nonxml_fget]szXMLProperty._nonxml_fgetcCs$|j}|j|vr||ddSdSr )rnrer)rrVrr r rrqds zXMLProperty.clearcCsFtr |js t|d|_|j|jvr||}n||}||S)ao Fetch value at user request. If we are parsing existing XML and the user hasn't done a 'set' yet, return the value from the XML, otherwise return the value from propstore If this is a built from scratch object, we never pull from XML since it's known to the empty, and we may want to return a 'default' value T) rr _seenpropsrSrernr_get_xmlr)rrVrr r rros     zXMLProperty.gettercCs |j|j}|jj||jS)zJ Actually fetch the associated value from the backing XML ) _xmlstater#rr$get_xpath_contentr)rrVrr r rrszXMLProperty._get_xmlcCs4tr |js t|d|_||}|||dS)z Set the value at user request. This just stores the value in propstore. Setting the actual XML is only done at get_xml time. TN)rrrrSrr)rrVrr)r r rrs   zXMLProperty.settercCs"|j|j}|jj||dS)zC Actually set the passed value in the XML document N)rr#rr$r%)rrVr)rr r r_set_xmlszXMLProperty._set_xmlN)FFFFF)r+r,r-r3rlrrrrrqrrrrr r r rrEs 0   rEc@sDeZdZddZddZddZddZd d Zd d Zd dZ dS) _XMLStatecCsz||_d|_d|jvr|jdd}d|tj|f|_|p d|_|o'|p)d|_d|_| o3| |_ | ||dS)N:rz xmlns:%s='%s') _root_name _namespacesplitr NAMESPACES_relative_object_xpath abs_xpath _parent_xpathr$is_buildparse)r root_nameparsexmlparentxmlstaterelative_object_xpathnsr r rr3s   z_XMLState.__init__cCs|r|jp|j|_|j|_dS|sd|j|jf}n|jr0d|vr0|d|jd|j|j}zt||_WntyEtd|w|jsW|j |j dddSdS)Nz<%s%s/>xmlns Base for all classes which build or parse domain XML NFcCst||dSr )rregister_namespace)nsnameurir r rrszXMLBuilder.register_namespacecCsLdg}|s ttd||D]}||vrqtd|||d}t|dS)N z#A name must be specified for the %szD%(objecttype)s name '%(name)s' can not contain '%(char)s' character.) objecttypenamechar)r_) name_labelrforbidr@msgr r rvalidate_generic_names z XMLBuilder.validate_generic_namecCst||_|jr|ddd}ddd|D}t|_t|j ||||_ | | t tg|dd|_dS) z Initialize state :param conn: VirtinstConnection to validate device against :param parsexml: Optional XML string to parse The rest of the parameters are for internal use only asciiignorercSsg|] }|tjvr|qSr )string printable)rr@r r rr sz'XMLBuilder.__init__..F)rWN)rY _XML_SANITIZEencodedecodejoin collections OrderedDictrnrr~r_validate_xmlbuilder_initial_child_parserNr xml_actions)rrYrrrr r rr3s   zXMLBuilder.__init__cCs|jjd}t|j|drdS|}|}|jD]}||vr+||vr+td|qg}|D]}|j |vrAtd|j | |j q2t |j|ddS)N_xmlbuilder_validatedFz'key '%s' must be xml prop or child propz'can't register duplicate child_class=%sT) rDr+getattr_all_xml_props_all_child_props_XML_PROP_ORDERrrvaluesrfrSsetattr)rcachekeyxmlprops childpropsrA childclasses childpropr r rr,s*    zXMLBuilder._validate_xmlbuildercCst|D]G}|j}|||}|jr&||j|j|d}|||q|jj |j |}t |D]}d|d}||j|j||d}| ||q5qdS)N)rr[%d]r)rOrrrfrrgrYrr{r$countr#rangerS)rxmlproprf prop_pathr] nodecountrvidxstrr r rrCs,     zXMLBuilder._initial_child_parsecCs"d|jjdd|jt|fS)Nz <%s %s %s>r!r5)rDr+rr~rkr2r r rrlZs zXMLBuilder.__repr__cCs|jj}|jjr |}||||jd}|s|S|d}| ds9| dr9| dd|}| dsB|d7}|S)z1 Return XML string of the object r!r5rrr ) rr$rcopy_api_add_parse_bitsget_xmlr#rstrip splitlinesr"rendswith)rr$r?lastliner r rrcs  zXMLBuilder.get_xmlcCst|}|t|7}|D]}||qttd|j }|s+|r7|jj |j dS|jj |j dS)z Wipe out all properties of the object :param leave_stub: if True, don't unlink the top stub node, see virtinst/cli usage for an explanation z ^.*\[\d+\]$N) rOrrrrqrrematchrrr$ node_clearnode_force_remove)r leave_stubpropspropis_childr r rrqys zXMLBuilder.clearcCsdS)z] Validate any set values and raise an exception if there's a problem Nr r2r r rvalidateszXMLBuilder.validatecCs|}dS)z5 Encode any default values if needed Nr )rguestrr r r set_defaultsszXMLBuilder.set_defaultscCs |jS)z Return the location of the object in the XML document. This is basically the absolute xpath, but the value returned should be treated as opaque, it's just for cross XML comparisons. Used in virt-manager code )rrr2r r r get_xml_ids zXMLBuilder.get_xml_idcCs4|j}d|vr dSt|dddddS)z This is basically the offset parsed out of the object's xpath, minus 1. So if this is the fifth in a , ret=4. If this is the only in a domain, ret=0. [rr])rrrrstriprr r r get_xml_idxs zXMLBuilder.get_xml_idxcC t|S)zQ Return a list of all XMLProperty instances that this class has. )rdrHr2r r rr zXMLBuilder._all_xml_propscCr)zV Return a list of all XMLChildProperty instances that this class has. )rdrKr2r r rrrzXMLBuilder._all_child_propscCsN|}d}t|D]}|jrq ||jur|}nq |s%td||S)Nz-Didn't find child property for child_class=%s)rrOrrgrfrr)rrfrr?rr r r_find_child_props zXMLBuilder._find_child_propr5cCsZ|j||dkr|j||D]}tt||gD] }||jqqdS)z= Change the object hierarchy's cached xpaths r5N) rrrrrlistifyr _set_xpathsr)r parent_xpathrrepr r rrs   zXMLBuilder._set_xpathscCsi}|D]>\}}tt||D]1}d}|js4|j}||vr&d||<||d7<d||}|||}||j ||qqdS)z Walk the list of child properties and make sure their xpaths point at their particular element. Needs to be called whenever child objects are added or removed rrrrN) rr:rrrrgrDrrrr)r typecountrerr]r class_typerr r r_set_child_xpathss    zXMLBuilder._set_child_xpathscOsJ|jj|i||D]}tt||gD] }|d|jqq dS)zR Set new backing XML objects in ourselves and all our child props N)rrrrrr_parse_with_children)rrZkwargsrerr r rrs  zXMLBuilder._parse_with_childrencCs||j}|}|dur|||n||||||jjsG|j ddd}d|j d}|jj t ||d||d|jdS)z Insert the passed XMLBuilder object into our XML document. The object needs to have an associated mapping via XMLChildProperty Nr}rrrr)rrDrrSrtrrrrrrr$ node_add_xmltextwrapindentr)rr]rvrxml use_xpathr!r r rr\s zXMLBuilder.add_childcCs\||j}||||j}|}|dd||d|jj || dS)zw Remove the passed XMLBuilder object from our XML document, but ensure its data isn't altered. N) rrDryrrrrrr$rr)rr]rrr"r r rrrs      zXMLBuilder.remove_childcCsn|jjs%|}d|d}t||d}|jj ||dS| }| ||j ||ddS)a6 Replace the origobj child with the newobj. For is_build, this replaces the objects, but for !is_build this only replaces the XML and keeps the object references in place. This is hacky and it's fixable but at time or writing it doesn't matter for our usecases. rr}r)rvN) rrrrr r!rrr$node_replace_xmlrrrr\)rorigobjrurr!r"origidxr r r replace_childs zXMLBuilder.replace_childcCst||rdS||jvS)zL Return True if the property name has never had a value set F)rrn)rrer r r_prop_is_unset1s  zXMLBuilder._prop_is_unsetcCsD|j}|jj}z||j_|W||j_||_S||j_||_w)zf Callback that adds the implicitly tracked XML properties to the backing xml. )rncopyrr$_do_add_parse_bits)rr$ origpropstoreorigapir r rr>s zXMLBuilder._add_parse_bitscs|}|fdd|jD}t|jD]}||vr)|||d|q|vr3|d|qtt D] }||vrG| |q<|D](}||vr\|| ||j|qJ|vrrt t||D] }||jjqhqJ|jD]}||jqvdS)Ncsg|]}|vr|qSr r )rrrr rrRrz1XMLBuilder._do_add_parse_bits..r)rrrnr6rryrtsortedrOkeysrSrrrrrrr$rr*)rrdo_orderrAr] manualactionr r-rr*Ls0    zXMLBuilder._do_add_parse_bits)NNN)F)r5r ) r+r,r-r.rr~r staticmethodrrr3rrrlrrqr r rrrrrrrrr\rrr'r(rr*r r r rrsB         r)rrrrr loggerrr$rrrrenvironrrrobjectrr/rdrOrNrcr_rJrErrr r r rs*   6#9<I