a YOc4@s~ddlmZz ddlZWney.dZYn0GdddZGdddeZGdddZGd d d ZGd d d eZdS) )ValidationErrorNc@seZdZdZddZeddZeddZedd Zed d Z ed d Z eddZ eddZ eddZ eddZeddZddZddZdS)Versionzt Object version interface - extend to support different types of django object versioning solutions cCs ||_dS)z Argument(s): - version: version object instance, for example django reversion Version object N)versionselfrrO/var/www/html/gsl.tools/lib/python3.9/site-packages/django_handleref/version.py__init__s zVersion.__init__cCs tdS)z> Should return version date (datetime object) NNotImplementedErrorrrrrdatesz Version.datecCs tdS)zz Should return user (django User object) that commited the version or None if no such user exists Nr r rrruser#sz Version.usercCs tdS)z] Should return the internal version id (primary key in the database) Nr r rrrid+sz Version.idcCs tdS)zg Should return comment (str) for the version or None if no such comment exists Nr r rrrcomment3szVersion.commentcCs tdS)z Should return a dict of the object snapshot store in this version, with field names mapping to field values Nr r rrrdata;sz Version.datacCs tdS)zp Should return `data` in list form with (field, value) tuples as items, sorted by field Nr r rrr data_sortedDszVersion.data_sortedcCs tdS)zg Should return the django model class of the object snapshotted by the version Nr r rrrmodelLsz Version.modelcCs tdS)z Should return a Version instance holding the previous version neighbour of this version If no previous version exists return an empty Version instance Nr r rrrpreviousTs zVersion.previouscCs tdS)z Should return a Version instance holding the next version neighbour of this version if no next version exists return an empty Version instance Nr r rrrnext_s z Version.nextc Csi}|D]X}||j}|D]>\}}||vr8i||<d|i}|||||j|iq qt|}t|ddd}|S)a Compiles and return a changes summary of multiple Version objects. Argument(s): - versions(list): list of Version instances Returns: - list: a list of (field, dict) tuples where the dict will be mapping version ids to a dict containing changes made to the field by the version. Check `Diff` class for further information rcSs|dSNrrirrrz)Version.changes_summary..key)changesritemsupdaterlistsorted) rversionsrrZ_changesfielddiffZ_diffZ changes_listrrrchanges_summaryjs   zVersion.changes_summarycCs t||jS)z Return a `Diff` instance for this version and a previous version Argument(s): - previous(Version) Returns(s): - Diff )Diffr)rrrrrrszVersion.changescCs"||}|durdSt|S)z Return a list of changed fields between this version and a previous version Argument(s): - previous(Version) Returns: - list(str) N)rr!keys)rrrrrrchanged_fieldss zVersion.changed_fieldsN)__name__ __module__ __qualname____doc__r propertyr rrrrrrrr classmethodr%rr(rrrrr s0           rcseZdZdZfddZeddZeddZedd Zed d Z ed d Z eddZ eddZ eddZ eddZZS)ReversionVersionz1 Version abtraction for django-reversion cs,t|trtjjjj|d}t|dS)z Argument(s): - Version(int|reversion.models.Version): can be either a reversion version instance or the id of one )rN) isinstanceint reversionmodelsrobjectsgetsuperr r __class__rrr s zReversionVersion.__init__cCs |jjjS)zE Returns: - datetime: date of revision )rrevisionZ date_createdr rrrr szReversionVersion.datecCs |jjjS)zw Returns: - User: user that authored revision - None: if no such user exists )rr9rr rrrrs zReversionVersion.usercCs |jjjS)zz Returns: - str: comment stored with revision - None: if no such comment exists )rr9rr rrrrs zReversionVersion.commentcCs|jjS)zB Returns: - int:version instance id )rrr rrrrszReversionVersion.idcCs|jjS)z< Returns: - dict: object data )rZ field_dictr rrrrszReversionVersion.datacCs|jjS)zy Returns: - model: django model for the object snapshotted by this version )r_modelr rrrrs zReversionVersion.modelcCs6g}|jD]\}}|||fqt|dddS)zn Returns: - list: list of (field, value) tuples for object data cSs|dSrrrrrrrrz.ReversionVersion.data_sorted..r)rrappendr!)rrr#valuerrrrs zReversionVersion.data_sortedcCs\t|dr|jStjjj|jj d}|D](}|j |jj kr.| ||_|jSq.dS)z Returns: - Version: previous version - if no previous version exists the Version instance will be empty _previousz-idN) hasattrr=r2r3rr4Zget_for_objectrobjectorder_byrr8)rr"rrrrrs    zReversionVersion.previouscCsRt|dr|jStjjjj|jj|jj |jj d}| d}| | |_|jS)z Returns: - Version: next version - if no next version exists the Version instance will be empty _next)content_type_id object_idZid__gtr)r>rAr2r3rr4filterrrBrCrr@r8first)rZqsetrrrr+s   zReversionVersion.next)r)r*r+r,r r-r rrrrrrrr __classcell__rrr7rr/s(         r/c@s4eZdZdZgdZddZeddZddZd S) r&z0 Describes changes between two versions )rcreatedupdatedcCs||_||_dS)z Argument(s): - version_a(Version): older version - version_b(Version): newer version N) version_a version_b)rrIrJrrrr Os z Diff.__init__cCs|jr |jsdS|jjr |jjs$dS|jj}|jj}i}|D]f\}}||jvrTq@||}||krhq@t|ts|t|t r||d||<q@| || |d||<q@|S)a Compile and return a dict describing changes between the two versions tracked in this diff Returns: - dict: dict mapping field names to a dict describing changed made to the field { field_name: { "old": old_value, "changed": changed_value, }, ... } N)oldchanged) rIrJrrrdiff_ignore_fieldsr5r0strr1 format_value)rZdata_aZdata_br$r#Zvalue_bZvalue_arrrr\s&    z Diff.changescCs|S)Nr)rr<rrrrOszDiff.format_valueN) r)r*r+r,rMr r-rrOrrrrr&As   4r&c@s0eZdZdZddZddZddZdd Zd S) Reverterz- Allows to revert / rollback changes cKsR|D]4\}}t|||j||dkr|||j|q||dS)aQ Revert a set of fields Argument(s): - instance(model instance): instance of django model to be reverted - field_versions(dict): dict mapping field names to version object Raises: - ValidationError: if any of the fields fail validation statusN)rsetattrrvalidate_status_change full_cleansave)rinstancefield_versionskwargsr#rrrr revert_fieldss zReverter.revert_fieldscKsR|jD]2\}}|dvrq |dkr0|||t|||q ||dS)a4 Rollback to a specific version Argument(s): - instance(model instance): instance of django model to be reverted - version(Version): version to roll back to Raises: - ValidationError: if any of the fields fail validation )rGrHrrQN)rrrSrRrTrU)rrVrrXr#r<rrrrollbacks zReverter.rollbackc CsZ|jjD]H}|jr |jsq zt||j}WntyDYq Yn0||||q dS)a9 Validate a status value change - this will make sure an object cannot be undeleted if a parent relationship is still flagged as deleted Argument(s): - instance(model instance): instance of django model to be reverted - status(str) N) r8_metaZ get_fieldsZ is_relationZ many_to_onegetattrname Exceptionvalidate_parent_status)rrVrQr#ZrelationrrrrSs   zReverter.validate_status_changecCs6t|dsdS|jdkr2|dkr2tdd|idS)NZ HandleRefZdeletedZnon_field_errorsztParent object {} is currently flagged as deleted.This object may not be undeleted while the parent is still deleted.)r>rQrformat)rrVparentrQrrrr_s zReverter.validate_parent_statusN)r)r*r+r,rYrZrSr_rrrrrPs rPcs0eZdZdZdfdd Zdfdd ZZS) ReversionReverterz3 Reverter abstraction for django-reversion Ncs|t`|rt|dd|D}tt|}tdd|t ||Wdn1sn0YdS)a Revert a set of fields Argument(s): - instance(model instance): instance of django model to be reverted - field_versions(dict): dict mapping field names to version pk Keyword Argument(s): - user(User): user that authored the revision Raises: - ValidationError: if any of the fields fail validation cSsg|]}d|jdqS)z{}r)r`r).0rrrr sz3ReversionReverter.revert_fields..z%reverted some fields via versions: {}z, N) r2create_revisionset_uservaluesr set set_commentr`joinr6rY)rrVrWrZ version_idsr7rrrYs   zReversionReverter.revert_fieldscs^tB|rt|td|jdt||Wdn1sP0YdS)a Rollback to a specific version Argument(s): - instance(model instance): instance of django model to be reverted - version(Version): version to roll back to Keyword Argument(s): - user(User): user that authored the revision Raises: - ValidationError: if any of the fields fail validation zrollback to version {}rN)r2rerfrir`rr6rZ)rrVrrr7rrrZs  zReversionReverter.rollback)N)N)r)r*r+r,rYrZrFrrr7rrbs#rb) Zdjango.core.exceptionsrr2 ImportErrorrr/r&rPrbrrrrs    *T`