hw`:dZddlZddlZddlmZddlZddlmZddlm Z ddl m Z ddl m Z ddlmZmZ dd lmZ dd lmZd ZgdZej6dddk(r d;dZee_ ddlmZegdgegdgegdgGdde Z!Gdde Z"Gdde Z#Gdde$Z%dZ&dZ'd Z(Gd!d"e$Z)Gd#d$e$Z*Gd%d&e$Z+Gd'd(e+ejXZ-Gd)d*e+ej\Z/Gd+d,e+ej`Z1Gd-d.e$Z2Gd/d0e$Z3d1ddgdifd2Z4dr?r@rArrrErEXs1rrEceZdZdZy)rz Raised when the transition cannot be executed because the object has become stale (state has been changed since it was fetched from the database). NrFrGrrrr\srrc4eZdZdZedZdZdZdZy) Transitioncf||_||_||_||_||_||_||_yrr4sourcetargeton_error conditions permissioncustomr9r4rMrNrOrPrQrRs rr7zTransition.__init__es3     $$ rc.|jjSr)r4r>r9s rnamezTransition.namens{{###rc|jsyt|jrt|j||S|j|j|ry|j|jryy)NTF)rQcallableboolhas_perm)r9instanceusers rrZzTransition.has_permrsY doo &$78 8 ]]4??H 5 ]]4?? +rc,t|jSr)hashrVrUs r__hash__zTransition.__hash__~sDIIrct|tr||jk(St|tr|j|jk(SyNF) isinstancestrrVrJ)r9others r__eq__zTransition.__eq__s; eS !DII% % eZ (::* *rN) r>r?r@r7propertyrVrZr_rerGrrrJrJds*$$ rrJc#K|j|}|j|j}|jD]I\}}|j}|j |s$|j ||s7|j|Kyw)zZ List of transitions available in current model state with all conditions met N) get_state transitionsr<items _django_fsmhas_transitionconditions_metget_transition)r[field curr_staterirVrmetas rget_available_FIELD_transitionsrrs *J##H$6$67K'--/2j%%   z *t/B/B8Z/X%%j1 12sAB !B 4B c8|j|jS)zB List of all transitions available in current model state )get_all_transitionsr<)r[ros rget_all_FIELD_transitionsrus  $ $X%7%7 88rc#\Kt||D]}|j||s|yw)zu List of transitions available in current model state with all conditions met and user have rights on it N)rrrZ)r[r\rors r$get_available_user_FIELD_transitionsrws4 6hF   x . s",,cJeZdZdZdZdZdgdifdZdZdZdZ d Z d Z y) FSMMetaz5 Models methods transitions meta information c ||_i|_yr)rori)r9ror4s rr7zFSMMeta.__init__s rc|jj|d}||jjdd}||jjdd}|S)N*+)riget)r9rMrs rrnzFSMMeta.get_transitions\%%))&$7  ))--c48J  ))--c48JrNc ||jvrtdj|t||||||||j|<y)Nz"Duplicate transition for {0} staterL)riAssertionErrorformatrJrSs radd_transitionzFSMMeta.add_transitionsQ T%% % !E!L!LV!TU U#-!!$  rc||jvryd|jvryd|jvr|jdj|k7ryy)z_ Lookup if any transition exists from current model state using current method Tr|r}F)rirN)r9states rrlzFSMMeta.has_transitionsR D$$ $ $"" " $"" "t'7'7'<'C'Cu'Lrc|j|}|y|jyttfd|jS)z7 Check if all conditions have been met FTc|SrrG) conditionr[s rz(FSMMeta.conditions_met..s Yx-@r)rnrPallmap)r9r[rrs ` rrmzFSMMeta.conditions_metsF((/    " " *s@*BWBWXY YrcN|j|}|sy|j||Sra)rnrZ)r9r[rr\rs rr zFSMMeta.has_transition_perms+((/ &&x6 6rct|j|}|tdj||jSNzNo transition from {0})rnrrrNr9 current_staters r next_statezFSMMeta.next_states;((7  &'?'F'F}'UV V   rct|j|}|tdj||jSr)rnrrrOrs rexception_statezFSMMeta.exception_states;((7  &'?'F'F}'UV V"""r) r>r?r@rAr7rnrrlrmr rrrGrrryrys>?Cr^bkm    Z7!#rryc eZdZdZddZdZy)FSMFieldDescriptorc||_yrro)r9ros rr7zFSMFieldDescriptor.__init__s  rNc@||S|jj|Sr)rorh)r9r[types r__get__zFSMFieldDescriptor.__get__s"  Kzz##H--rc@|jjrP|jj|jvr.t dj |jj|jj |||jj||y)Nz&Direct {0} modification is not allowed)ro protectedrV__dict__r(r set_proxy set_state)r9r[r/s r__set__zFSMFieldDescriptor.__set__sr ::  DJJOOx7H7H$H !I!P!PQUQ[Q[Q`Q`!ab b Xu- Xu-rr)r>r?r@r7rrrGrrrrs. .rrcZeZdZeZfdZfdZdZdZdZ dZ dZ fdZ d Z xZS) rcH|jdd|_i|_i|_|jdd}|j dd}| | t d|4g}|D](\}}}|j ||f||j|<*||d<tt|&|i|y)NrF state_choiceschoicesz)Use one of choices or state_choices value) r5rri state_proxyr~ ValueErrorr)r6rr7) r9r:r;rrrtitle proxy_cls_refr<s rr7zFSMFieldMixin.__init__sK7 ?D9 **Y-  $)<HI I  $G/< 8+umu~.*7  ' 8!(F9  mT+T>"&..F; T4''rctjdddk\rt|j|Stjdddk\r$t|jj|Stjdddk\r&t|jdj|S|j |jS)N)rrr)r#r)r rmodel)djangoVERSIONrrrVrr9r[s rrhzFSMFieldMixin.get_state+s >>"1  *$T*228< < ^^BQ 9 ,$TYY/77A A ^^BQ : -$TYYd;CCHM M $$TYY/ /rc6||j|j<yr)rrVr9r[rs rrzFSMFieldMixin.set_stateAs',$))$rc||jvrT|j|} |jd\}}t ||}|tdj |||_yy#t$r|jj}|}YTwxYw)z Change class .NzNo model found {0})rsplitr_metarrrr<)r9r[rrrrrs rrzFSMFieldMixin.set_proxyDs D$$ $**51K )(3(9(9#(>% : i4E} !5!rhrlrrrmrr<rorsendhasattrrrrr Exceptionr) r9r[r4r:r;rq method_namerr signal_kwargsresultexcrs r change_statezFSMFieldMixin.change_stateXs!!oo x0 ""=1&BII-Yde  ""8];&JQQR]^gox~ __]3 (( ZZ# #   ,m, 2H6t6v6F%:{3!+!5!5h FY]fl!5!mJ.8M(+x4x4  1= 1  "22=AOx9x9*9 h'-0 k*$$5}5  sAE F' AF""F'c#K|j|}|jD]4\}}|j}|jjD]}|6yw)zT Returns [(source, target, name, method)] for all field transitions N)rirjrkvalues)r9 instance_clsrirVrrqs rrtz!FSMFieldMixin.get_all_transitionssd&&|4 + 1 1 3 ! D*))D"..557 !    ! !sAAc ||_tt|||fi|t ||j |j |t |dj|j tt|t |dj|j tt|t |dj|j tt|tj|jy)Nzget_all_{0}_transitionsrzget_available_{0}_transitionsz"get_available_user_{0}_transitions)base_clsr6rcontribute_to_classsetattrrVdescriptor_classrr rurrrwrconnect_collect_transitions)r9clsrVr;r<s rrz!FSMFieldMixin.contribute_to_classs  mT6sDKFKTYY 5 5d ;<.55dii@-PiquBvw 077 BMRqy}D~    0 7 7 B >d K t889rc|d}t|jsyfd}i}tj||}|D]\}}|j_|||<|j |<y)Nrctj|xstj|xrt|dxr|jj j fvxst|jj txr\|jj j j k(xr-|jj jjk(S)Nrk) inspectismethod isfunctionrrkrorVrbrcreation_counter)attrr9s ris_field_transition_methodzFFSMFieldMixin._collect_transitions..is_field_transition_methods!!$'C7+=+=d+C D-0 $$**tTYY.??"4#3#3#9#95A] ,,2277499D] ,,22CCtG\G\\ r)r,) issubclassrr getmembersrkrori) r9r:r;rrsender_transitionsrirr4s ` rrz"FSMFieldMixin._collect_transitionss}!&$--0   ((;UV #. 5 K'+F   $.4 { + 5$6 r)r>r?r@rrr7rrhrrrrtrrrBrCs@rrrs7)=&( 0,-'(3j !:"6rrc"eZdZdZfdZxZS)rz= State Machine support for Django model as CharField cP|jddtt||i|y)N max_length2) setdefaultr6rr7r8s rr7zFSMField.__init__s',+ h&77rr=rCs@rrrs88rrceZdZdZy)rzJ Same as FSMField, but stores the state value in an IntegerField. NrFrGrrrrs  rrceZdZdZdZdZy)rz0 State Machine support for Django model c4|j|jSr)rattnamers rrhzFSMKeyField.get_states  ..rcT|j||j|j<yr) to_pythonrrrs rrzFSMKeyField.set_states*...*?$,,'rN)r>r?r@rArhrrGrrrrs/@rrc(eZdZdZdZfdZxZS) FSMModelMixinzP Mixin that allows refresh_from_db for models with fsm protected fields cd}t||jj}|Dchc]}|jc}Scc}w)Nc>t|txr |jSr)rbrr)fs ris_fsm_and_protectedzEFSMModelMixin._get_protected_fsm_fields..is_fsm_and_protectedsa/?AKK ?r)filterrconcrete_fieldsr)r9rprotected_fieldsrs r_get_protected_fsm_fieldsz'FSMModelMixin._get_protected_fsm_fieldss8 @!"6 8R8RS#34a 444s>c@|jdd}|sl|j}|j}|j|}|jj Dcgc]}|j |vr |j }}||d<tt|&|i|ycc}w)Nfields) r5get_deferred_fieldsrunionrrrr6rrefresh_from_db) r9r:r;rdeferred_fieldsrskipped_fieldsrr<s rrzFSMModelMixin.refresh_from_dbsHd+"668O#==? ,223CDN)-)C)C:A.8ii:F:"x mT2DCFC :s!B)r>r?r@rArrrBrCs@rrrs5 D DrrcVeZdZdZfdZedZfdZdZfdZ fdZ xZ S)raH Protects a Model from undesirable effects caused by concurrently executed transitions, e.g. running the same transition multiple times at the same time, or running different transitions with the same SOURCE state at the same time. This behavior is achieved using an idea based on optimistic locking. No additional version field is required though; only the state field(s) is/are used for the tracking. This scheme is not that strict as true *optimistic locking* mechanism, it is however more lightweight - leveraging the specifics of FSM models. Instance of a model based on this Mixin will be prevented from saving into DB if any of its state fields (instances of FSMFieldMixin) has been changed since the object was fetched from the database. *ConcurrentTransition* exception will be raised in such cases. For guaranteed protection against such race conditions, make sure: * Your transitions do not have any side effects except for changes in the database, * You always run the save() method on the object within django.db.transaction.atomic() block. Following these recommendations, you can rely on ConcurrentTransitionMixin to cause a rollback of all the changes that have been executed in an inconsistent (out of sync) state, thus practically negating their effect. cLtt| |i||jyr)r6rr7_update_initial_stater8s rr7z"ConcurrentTransitionMixin.__init__s$ '7HH ""$rcDtd|jjS)Nc"t|tSr)rbrrs rrz8ConcurrentTransitionMixin.state_fields..s Jum$Dr)rrrrUs r state_fieldsz&ConcurrentTransitionMixin.state_fieldssDdjjFWFWXXrc0tfdj}tfd|D}ttjdi||||||} | s:j|j |jr td| S)Nc6|jjk(Srr)robase_qss rrz6ConcurrentTransitionMixin._do_update..&s )Erc3hK|])}|jj|jf+ywr)r*_ConcurrentTransitionMixin__initial_states.0ror9s r z7ConcurrentTransitionMixin._do_update..)s*iV[U]]D,A,A%--,PQis/2)rusingpk_valr update_fields forced_update)pkzOCannot save object! The state has been changed since fetched from the database!rG) rrdictr6r _do_updaterexistsr) r9rrrrr r  filter_on state_filterupdatedr<s `` rr z$ConcurrentTransitionMixin._do_update!s EtGXGXY i_hii 14C"GNN2\2'' D 7>>V>4::5AHHJ&'xy yrcLtfdjD_y)Nc3XK|]!}|j|jf#ywr)rvalue_from_objectrs rrzBConcurrentTransitionMixin._update_initial_state..@s&$sX]emmU5L5LT5R%S$ss'*)r rrrUs`rrz/ConcurrentTransitionMixin._update_initial_state?s $$saearar$s srcLtt| |i||jyr)r6rrrr8s rrz)ConcurrentTransitionMixin.refresh_from_dbBs$ '>OO ""$rcLtt| |i||jyr)r6rsaverr8s rrzConcurrentTransitionMixin.saveFs$ '3TDVD ""$r) r>r?r@rAr7rfrr rrrrBrCs@rrrs=2%YY<t%%%rrr|c*fd}|S)z Method decorator to mark allowed transitions. Set target to None if current state needs to be validated and has not changed after the function call. c bdtddc}sd}ttdt tt t fr) D]#}jj|  %n!jj  tfd}|s|SS)NTrkF)ror4cFjj|g|i|Sr)ror)r[r:r;fsm_metafuncs r _change_statez;transition..inner_transition.._change_state`s&.8>>..xOOO Or) r'ryrrblisttuplesetrkrr) rwrapper_installedrrrrPrRrorOrQrMrNs ` @rinner_transitionz$transition..inner_transitionSs&*GD-,N#8 % U48H D- 2 ftUC0 1 o  //eVXz[egmn o    + +D&&(JXbdj k t P  P!  rrG)rorMrNrOrPrQrRr"s``````` rrrKs, rcHt|ds/t|dt|d}td|jz|j}t|dt|d}|j j |}|j|xr| xs|j||S)z Returns True if model in state allows to call bound_method Set ``check_conditions`` argument to ``False`` to skip checking conditions. rkim_func__func__%s method is not transitionim_self__self__) rr' TypeErrorr>rkrorhrlrm) bound_methodcheck_conditionsr$rqr'rs rrrls < /, 7<3TU58H8HHII  # #DlIw|Z/PQGJJ((1M   } - w7G3G3v4K^K^_fhuKvwrcht|ds/t|dt|d}td|jz|j}t|dt|d}|j j |}|j|xr'|j||xr|j|||S)z_ Returns True if model in state allows to call bound_method and user have rights on it rkr$r%r&r'r() rr'r)r>rkrorhrlrmr )r*r\r$rqr'rs rr r ~s < /, 7<3TU58H8HHII  # #DlIw|Z/PQGJJ((1M M* C    7 C  $ $WmT BrceZdZgifdZy)Statectr)NotImplementedErrorr9rrrr:r;s rrhzState.get_states!!rN)r>r?r@rhrGrrr.r.s 8:2"rr.ceZdZdZgifdZy)r"c&|r||_yd|_yr)allowed_states)r9r4s rr7zRETURN_VALUE.__init__s0>nDrc|j3||jvr%tdj||j|SNz&{} is not in list of allowed states {})r4rErr1s rrhzRETURN_VALUE.get_statesB    *T000()R)Y)YZ`bfbubu)vww rNr>r?r@r7rhrGrrr"r"sI9;2rr"c eZdZddZgifdZy)r!Nc ||_||_yr)rr4)r9rstatess rr7zGET_STATE.__init__s $rc|j|g|i|}|j3||jvr%tdj||j|Sr6)rr4rEr)r9rrrr:r; result_states rrhzGET_STATE.get_states] tyy888    *4#6#66()R)Y)YZfhlh{h{)|}}rrr7rGrrr!r!s%9;2rr!r)T):rArsys functoolsrr django.dbrdjango.db.modelsrdjango.db.models.query_utilsrdjango.db.models.signalsrdjango_fsm.signalsrr r ImportErrordjango.utils.functionalr django.appsr rrdjango.db.models.loading__all__ version_infor0rsouth.modelsinspectorr1rrrErr+rJrrrurwryrr CharFieldr IntegerFieldr ForeignKeyrrrrrr r.r"r!rGrrrNs  ":3>?' 3/) BQ6! &G?=B!9 :;B!@ ABB!< =>D9D229##L 29Q#fQ#h..$u6Fu6p8}f..8 mV%8%8  @-!2!2 @DFD4I%I%X!X\egBx$&"F" 5  _?>>?3223R  s4E- E?(F- E<;E<? F FFF