3
vh_r @ sD d dl mZmZmZ d dlZd dlZd dlZd dlZd dlZd dl Z d dl
m Z m Z m
Z
mZmZ d dlmZ dZejjedZejjedZdZejjedZd Zd
Zd Z d Z ed ed
e de d iZ eee e gZ dZ ej!e"Z#dd Z$G dd de%Z&G dd de%Z'G dd de%Z(ej)ddddd d d gZ*d%d d!Z+d&d#d$Z,dS )' )print_functiondivisionabsolute_importN) system_exit
create_dir create_file make_utf8write_to_file_utf8)ugettextz/etc/rhsm/syspurposezsyspurpose.jsonzvalid_fields.jsonz/var/lib/rhsm/cacheroleaddonsservice_level_agreementusageZaddOnsZ serviceLevelZ unsupportedc C s` d| kr\d| d kr2| d d | d d< | d d= d| d kr\| d d | d d< | d d= | S )z
Try to solve conflicts in keys
- Server returns key "roles", but it should be "role"
- Server returns key "support_level", but service_level_agreement is used in syspurpose.json
:return: modified dictionary
systemPurposeAttributesZrolesr Z
support_levelr
)datar r /usr/lib/python3.6/files.pypost_process_received_data? s
r c @ sb e Zd ZdZdddZdd Zdd Zd d
Zd d Zd
d Z dd Z
dddZ e dddZ
dS )SyspurposeStorez9
Represents and maintains a json syspurpose file
Fc C s || _ i | _|| _d S )N)pathcontentsraise_on_error)selfr r r r r __init__V s zSyspurposeStore.__init__c C s y.t j| jddd}tj|| _dS Q R X W n tk
rh tjj| jrdt tj
t dj | j dS t
k
r } zj|jtjkr| j rt tjt dj | j |jtjkr| j rtjd j | j|d
dS | jr|W Y dd}~X nX dS ) aN
Opens & reads the contents of the store's file based on the 'path' provided to the constructor,
and stores them on this object. If the user doesn't have access rights to the file, the program exits.
:return: False if the contents of the file were empty, or the file doesn't exist; otherwise, nothing.
rzutf-8)encodingTNz )r r7 r8 Zorgr r r set s
zSyspurposeStore.setNc
C sH |s8t j| jddd}t|| j |j W dQ R X n t|| j dS )zE
Write the current contents to the file at self.path
wzutf-8)r N)r r r r r flush)r fpr- r r r write s
zSyspurposeStore.writec C s0 | ||d}t j|t js$|j n|j |S )aL
Read the file represented by path. If the file does not exist it is created.
:param path: The path on the file system to read, should be a json file
:param raise_on_error: When it is set to True, then exceptions are raised as expected.
:return: new SyspurposeStore with the contents read in
)r )r# accessW_OKr1 r/ )clsr r Z new_storer r r read s
zSyspurposeStore.read)F)N)F)__name__
__module__ __qualname____doc__r r/ r1 r: r< r; r@ rD classmethodrH r r r r r Q s
r c @ s e Zd ZdZdd ZdS )
SyncResultza
A container class for the results of a sync operation performed by a SyncedStore class.
c C s || _ || _|| _|| _d S )N)resultremote_changed
local_changedcached_changed)r rO rP rQ rR r r r r s zSyncResult.__init__N)rI rJ rK rL r r r r r rN s rN c @ s e Zd ZdZeZeZd2ddZdd Z dd Z
d
d Z d d
Z dd Z
d3ddZdd Zdd Zdd Zdd Zdd Zd d Zd d Zd d! Zd"d# Zd$d% Zd&d' Zd(d) Zd*d+ Ze d,d- Z e d.d/ Z d0d1 Z dS )4 SyncedStorezz
Stores values in a local file backed by a cache which is then synced with another source
of the same values.
NFc C sx || _ | jjdd | _| j| _| j| _d| _| j | _ d| _
| j | _ d| _
|| _|| _|dkrn| j | _nd| _dS )a8
Initialization of SyncedStore
:param uep: object representing connection to candlepin server
:param on_changed: optional callback method called, during three-way merge
:param consumer_uuid: UUID of consumer
:param use_valid_fields: if valid fields are considered
/ NFT)uepPATHsplitfilenamer
CACHE_PATH
cache_pathZ
local_fileget_local_contentslocal_contentsZ
cache_fileget_cached_contentscache_contentschanged
on_changed
consumer_uuidget_valid_fields valid_fields)r rW rb rc Zuse_valid_fieldsr r r r s
zSyncedStore.__init__c C s | S )Nr )r r r r __enter__ s zSyncedStore.__enter__c C s | j d S )N)finish)r exc_typeZexc_valZexc_tbr r r __exit__ s zSyncedStore.__exit__c C s | j r| j dS )z{
When local content was changed, then try to synchronize local content with remote server
:return:
N)ra sync)r r r r rg " s zSyncedStore.finishc s t jd y*| jr2| jjd r2t jd | j S W n6 tk
rj } zt jdj|d | j S d}~X nX | j }| j }| j }| j
|||d fdd D }t | kp| j | j
|| j }t jd
d | _|S ) z
Try to synchronize local content with remote server
:return: instance of SyncResult holding result of synchronization
z(Attempting to sync syspurpose content...
syspurposez9Server does not support syspurpose, syncing only locally.zDFailed to detect whether the server has syspurpose capability: {err})errN)localremotebasec s i | ]} | r | |qS r r ).0r7 )rO r r
D s z$SyncedStore.sync..z#Successfully synced system purpose.F)r, debugrW has_capability_sync_local_only Exceptionr' get_remote_contentsr] r_ mergerN
update_remote update_local update_cachera )r rl Zremote_contentsr^ Zcached_contentsZ local_resultZ sync_resultr )rO r rj * s2
zSyncedStore.syncc C s | j | j }t| jd|dS )NF)ry r] rN r^ )r Z
local_updatedr r r rt T s z SyncedStore._sync_local_onlyc C s t |||| jd}|S )z
Do three-way merge
:param local: dictionary with local values (syspyrpose.json)
:param remote: dictionary with values from server
:param base:
:return:
)rm ro rn on_change)three_way_mergerb )r rm rn ro rO r r r rw X s
zSyncedStore.mergec
C sb y t jtj| jddd| _W n< tjtt fk
rZ t
j d| j | j i i | _Y nX | jS )zl
Try to load local content from file
:return: dictionary with system purpose values
r zutf-8)r z+Unable to read local system purpose at "%s")
r r! r r r r^ r# r r" IOErrorr, rr ry )r r r r r] h s
z SyncedStore.get_local_contentsc C s | j dks| jdkr"tjd i S | j jds LOCAL_TO_REMOTE)r ZconsumerrO attrr8 r r r rv u s
z SyncedStore.get_remote_contentsc
C sl y(t jtj| jddd| _tjd W n< tt j
t fk
rd tjd| j i | _| j
i Y nX | jS )zy
Try to load cached server response from the file
:return: dictionary with system purpose values
r zutf-8)r z-Successfully read cached syspurpose contents.z2Unable to read cached syspurpose contents at '%s'.)r r! r r r\ r` r, rr r" r# r r} r rz )r r r r r_ s z SyncedStore.get_cached_contentsc C s || _ | j dS )z
Rewrite local content with new data and write data to file syspurpose.json
:param data: new dictionary with local data
:return: None
N)r^ _write_local)r r r r r ry s zSyncedStore.update_localc C s | j | j| j dS )zD
Write local data to the file
:return: None
N) _update_filer r^ )r r r r r s zSyncedStore._write_localc C s || _ | j d S )N)r` _write_cache)r r r r r rz s zSyncedStore.update_cachec C s | j | j| j dS )z;
Write cache to file
:return: None
N)r r\ r` )r r r r r s zSyncedStore._write_cachec C s| | j d ks| jd kr"tjd dS |jt}| j j| j|jtpBd|d k rN|ng |jtp\d|jt phdd tjd dS )NzmFailed to update remote syspurpose on the server: no available connection, or the consumer is not registered.Fr= )r r Z
service_levelr z5Successfully updated remote syspurpose on the server.T)
rW rc r, rr r> ADDONSZupdateConsumerROLE
SERVICE_LEVELUSAGE)r r r r r r rx s
zSyncedStore.update_remotec C s | j dk r|| j krf|| j | krttdj||d x`| j | D ] }t|dkrDtd| qDW n4ttdj|d x | j j D ]}td| qW dS )z
Check validity of provided key and value of it is included in valid fields
:param key: provided key
:param value: provided value
:return: None
NzaWarning: Provided value "{val}" is not included in the list of valid values for attribute {attr}:)valr r z - %szHWarning: Provided key "{key}" is not included in the list of valid keys:)r7 )re printr& r' lenkeys)r r7 r8 Z valid_valueZ valid_keyr r r _check_key_value_validity s
z%SyncedStore._check_key_value_validityc C s t |}t |}y| j| }|dk r r? ra r, rr r )r r7 r8 r r r r; , s
zSyncedStore.unsetc C s t |}t |}t | jj|d}|| j|< ||ks<|dkrb| j|| d| _tjd||f n
tjd ||kpz|dk| _| jdkr| j | jS )z
Set a key (syspurpose parameter) to value
:param key: The parameter of the syspurpose file to set
:type key: str
:param value: The value to set that parameter to
:return: Whether any change was made
NTz Setting value '%s' to key '%s'.z#NOT Setting value '%s' to key '%s'.)r r^ r> r ra r, rr r )r r7 r8 r9 r r r r@ I s
zSyncedStore.setc C sh t jj| sdtjd| yt j| ddd W n4 tk
rb } ztjd| |f W Y dd}~X nX dS )zr
Try to create missing directory
:param dir_path: path to directory
:return: None
z Trying to create directory: %si T)modeexist_okz)Unable to create directory: %s, error: %sN)r# r isdirr, rr makedirsru Zwarning)Zdir_pathrl r r r _create_missing_dirg s z SyncedStore._create_missing_dirc C s | j t | j t ytj|ddd}W n. tk
rV } z|jdkrF W Y dd}~X n*X t|| |j |j t
j d| t
j d| dS )a
Write the contents of data to file in the first mode we can (effectively to create or update
the file)
:param path: The string path to the file location we should update
:param data: The data to write to the file
:return: None
zw+zutf-8)r Nz/Successfully updated syspurpose values at '%s'.z+Failed to update syspurpose values at '%s'.) r USER_SYSPURPOSE_DIR CACHE_DIRr r r( r) r rB closer, rr )rG r r r- r. r r r r v s
zSyncedStore._update_filec C s d}| j dk r| jdk r| j j| j}d|kr|d }y| j j|}W n0 tk
rv } ztjd| W Y dd}~X nX d|krt|}|d }|S )z
Try to get valid fields from server using current owner (organization)
:return: Dictionary with valid fields
Nr7 z*Unable to get valid fields from server: %sr )rW rc ZgetOwnerZ getOwnerSyspurposeValidFieldsru r, rr r )r re Z
current_ownerZ owner_keyZresponserl r r r rd s z SyncedStore.get_valid_fields)NNF)NNN)!rI rJ rK rL USER_SYSPURPOSErX CACHED_SYSPURPOSEr[ r rf ri rg rj rt rw r] rv r_ ry r rz r rx r r: r< r; r@ staticmethodr rM r rd r r r r rS s4
*
+" rS
DiffChanger7 previous_value new_valuesourcein_base in_resultrn c C s t jd i }| pi } |p i }|p$i }|dkr4|}n|dkrB| }ntd|dkrZdd }t| j t|j B t|j B }x(|D ] }t|| |dd} t|||d d}
| p|
o|
tk} d
} | |
kr| d krt jd | |} ||kr|| ||< nv|
d kr,t jd
| d} ||krn|| ||< nB| s<|
tkrn| d krTt jd| d} || krn| | ||< | r|j|}
t|| |
|j|||k||kd}|| qW |S )a
Performs a three-way merge on the local and remote dictionaries with a given base.
:param local: The dictionary of the current local values
:param base: The dictionary with the values we've last seen
:param remote: The dictionary with "their" values
:param on_conflict: Either "remote" or "local" or None. If "remote", the remote changes
will win any conflict. If "local", the local changes will win any
conflict. If anything else, an error will be thrown.
:param on_change: This is an optional function which will be given each change as it is
detected.
:return: The dictionary of values as merged between the three provided dictionaries.
z Attempting a three-way merge...rn rm zAkeyword argument "on_conflict" must be either "remote" or "local"Nc S s | S )Nr )Zchanger r r s z!three_way_merge..)ro otherr7 r serverro TzLThree way merge conflict: both local and remote values changed for key '%s'.z7Three way merge: remote value was changed for key '%s'.z6Three way merge: local value was changed for key '%s'.)r7 r r r r r ) r, rr r" r@ r detect_changed UNSUPPORTEDr> r )rm ro rn Z on_conflictr{ rO winnerZall_keysr7 rQ rP ra r originalZdiffr r r r| sT
$
r| r c C s | pi } |pi }||kr$|dkr$t S | j|}|j|}||krP|dkrPt|S t|tkrxt|tkrxt|t|kS |dkr|dkr|dkrdS ||kS )aX
Detect the type of change that has occurred between base and other for a given key.
:param base: The dictionary of values we are starting with
:param other: The dictionary of now current values
:param key: The key that we are interested in knowing how it changed
:param source: An optional string which indicates where the "other" values came from. Used to
make decisions which are one sided. (i.e. only applicable for changes from the
server side).
:return: True if there was a change, false if there was no change
:rtype: bool
rm r Nr= F)r r> booltyper3 sorted)ro r r7 r Zbase_valZ other_valr r r r s
r )rn N)r )-Z
__future__r r r collectionsZloggingr r# r) r Zsyspurpose.utilsr r r r r Zsyspurpose.i18nr
r& r r joinr Z VALID_FIELDSr r r r r r r r~ r Z getLoggerrI r, r objectr rN rS
namedtupler r| r r r r r sJ
1
B