File: //lib64/python3.9/site-packages/syspurpose/__pycache__/files.cpython-39.opt-1.pyc
a
X�Zh�v � @ sT d Z ddlZddlZddlZddlZddlZddlZddlmZm Z ddl
m Z m Z m
Z
ddlmZ dZej�ed�Zej�ed�Zd Zej�ed�Zd
Zd Zd Zd
Zed
ededed
iZ eeeegZ dZ e� e �Z!e"e"d�dd�Z#G dd� d�Z$G dd� d�Z%G dd� d�Z&e�'dg d��Z(d$e"e"e"e)ee"d �d d �Z*d%e"e"e)e)e+d!�d"d#�Z,dS )&zW
This module contains utilities for manipulating files pertaining to system syspurpose
� N)�Callable�Union)�
create_dir� create_file�write_to_file_utf8)�ugettextz/etc/rhsm/syspurposezsyspurpose.jsonzvalid_fields.jsonz/var/lib/rhsm/cache�role�addons�service_level_agreement�usageZaddOnsZ serviceLevelZ unsupported��data�returnc C s` d| v r\d| d v r2| d d | d d< | d d= d| d v r\| 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
� )r
r r �6/usr/lib64/python3.9/site-packages/syspurpose/files.py�post_process_received_data8 s
�
r c @ s� e Zd ZdZdeedd�dd�Zdd�dd �Zed�d
d �Zeeed �d
d�Z eeed �dd�Z
eed�dd�Z eeed �dd�Z d edd�dd�Z
ed eed d�dd��ZdS ) �SyspurposeStorez9
Represents and maintains a json syspurpose file
FN)�path�raise_on_errorr c C s || _ i | _|| _d S �N)r �contentsr )�selfr r r r r �__init__Q s zSyspurposeStore.__init__�r c
C s zFt j| jddd�� }t�|�| _W d � W dS 1 s:0 Y W n� tyz tj�| j�rtt �
d� | j�� Y dS t �y } z�|j
t
jkr�| js�t �
d� | j�� W Y d}~dS |j
t
jk� r�| j� s�t �
d j | j|d
�� W Y d}~dS | j�r|�W Y d}~n
d}~0 0 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.
�r�utf-8��encodingNTzMalformed data in file {}Fz Cannot read syspurpose file {}
z#Unable to read file {file}: {error})�file�error)�io�openr �json�loadr �
ValueError�os�getsize�logr �format�OSError�errnoZEACCESr �ENOENT)r �f�er r r � read_fileV s" & zSyspurposeStore.read_filec C s( t tj�| j��p&| �� p&t| j| j�S )zw
Create the files necessary for this store
:return: True if changes were made, false otherwise
)r r& r �dirnamer/ r r �r r r r �createo s
� �zSyspurposeStore.create��key�valuer c C s� zj| j | }|dur*t|t�s*|g| j |< | j | du rBg | j |< || j | vrb| j | �|� nW dS W n" ttfy� |g| j |< Y n0 dS )�R
Add a value to a list of values specified by key. If the current value
specified by the key is scalar/non-list, it is not overridden, but
maintained in the list, along with the new value.
:param key: The name of the list
:param value: The value to append to the list
:return: None
NFT)r �
isinstance�list�append�AttributeError�KeyError�r r4 r5 Z
current_valuer r r �addz s
zSyspurposeStore.addc
C sv zV| j | }|dur2t|t�s2||kr2| �|�W S ||v rL| j | �|� nW dS W dS tttfyp Y dS 0 dS )�N
Remove a value from a list specified by key.
If the current value specified by the key is not a list, unset the value.
:param key: The name of the list parameter to manipulate
:param value: The value to attempt to remove
:return: True if the value was in the list, False if it was not
NFT)r r7 r8 �unset�remover: r; r% r< r r r r@ � s
zSyspurposeStore.remove�r4 r c C s8 |dkr"| j �|d�}d| j |< n| j �|d�}|duS )�\
Unsets a key
:param key: The key to unset
:return: boolean
r
N� )r �get�pop�r r4 r5 r r r r? � s
zSyspurposeStore.unsetc C s( | j �|d�}|| j |< ||kp&|du S )z�
Set a key (syspurpose parameter) to value
:param key: The parameter of the syspurpose file to set
:param value: The value to set that parameter to
:return: Whether any change was made
N)r rD )r r4 r5 Zexisting_valuer r r �set� s
zSyspurposeStore.set)�fpr c C s\ |sLt j| jddd��$}t|| j� |�� W d � qX1 s@0 Y n t|| j� dS )zG
Write the current contents to the file at "self.path"
�wr r N)r! r" r r r �flush)r rH r- r r r �write� s
(zSyspurposeStore.writec C s0 | ||d�}t �|t j�s$|�� n|�� |S )aK
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& �access�W_OKr2 r/ )�clsr r Z new_storer r r �read� s
zSyspurposeStore.read)F)N)F)�__name__�
__module__� __qualname__�__doc__�str�boolr r/ r2 r= r@ r? rG rK � classmethodrO r r r r r L 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 r )�result�remote_changed�
local_changed�cached_changed)r rX rY rZ r[ r r r r � s zSyncResult.__init__N)rP rQ rR rS r r r r r rW � s rW c @ s� e Zd ZdZeZeZd:ee e
dd�dd�Z d d�dd �Z dd�d
d �Z
dd�d d
�Zed�dd�Zed�dd�Zd;eeeed�dd�Zed�dd�Zed�dd�Zed�dd�Zedd�d d �Zdd�d d �Zedd�d d!�Zdd�d"d#�Zee
d�d$d%�Ze e dd&�d'd(�Z e e e
d&�d)d*�Z e e e
d&�d+d,�Z e e
d-�d.d/�Z e e e
d&�d0d1�Z e!e dd2�d3d4��Z"e#e edd5�d6d7��Z$e%edf d�d8d9�Z&dS )<� SyncedStorezz
Stores values in a local file backed by a cache which is then synced with another source
of the same values.
NF)�
on_changed�
consumer_uuid�use_valid_fieldsr c C sx || _ | j�d�d | _| j| _| j| _d| _| �� | _ d| _
| � � | _ d| _
|| _|| _|du rn| �� | _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)�uep�PATH�split�filenamer �
CACHE_PATH�
cache_pathZ
local_file�get_local_contents�local_contentsZ
cache_file�get_cached_contents�cache_contents�changedr] r^ �get_valid_fields� valid_fields)r rb r] r^ r_ r r r r � s
zSyncedStore.__init__r c C s | S r r r1 r r r � __enter__ s zSyncedStore.__enter__c C s | � � d S r )�finish)r �exc_typeZexc_valZexc_tbr r r �__exit__ s zSyncedStore.__exit__c C s | j r| �� dS )zj
When local content was changed, then try to synchronize local content with remote server
N)rl �syncr1 r r r rp s zSyncedStore.finishc
s� t �d� z*| jr2| j�d�s2t �d� | �� W S W n> tyr } z&t �dj|d�� | �� W Y d}~S d}~0 0 | �� }| �� }| � � }| j
|||d�� � fdd �� D �}t � |� kp�| � � �| �
|�| �� ��}t �d
� 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)�local�remote�basec s i | ]}� | r|� | �qS r r )�.0r4 �rX r r �
<dictcomp>1 � z$SyncedStore.sync.<locals>.<dictcomp>z#Successfully synced system purpose.F)r( �debugrb �has_capability�_sync_local_only� Exceptionr) �get_remote_contentsrh rj �mergerW �
update_remote� update_local� update_cacherl )r ru Zremote_contentsri Zcached_contentsZ local_resultZ sync_resultr rz r rs s,
�
zSyncedStore.syncc C s | � | �� �}t| jd|d�S )z�
This method synchronize try to read data from file. When it wasn't possible,
then empty dictionary is used. Finally, write the data back to this same file.
:return: Instance of SyncResult
F)r� rh rW ri )r Z
local_updatedr r r r C s z SyncedStore._sync_local_only)rv rw rx r c C s t |||| jd�}|S )z�
Do three-way merge
:param local: dictionary with local values
:param remote: dictionary with values from server
:param base: dictionary witch cached values
:return: dictionary from three-way merge
)rv rx rw � on_change)�three_way_merger] )r rv rw rx rX r r r r� M s zSyncedStore.mergec
C s` z t �tj| jddd��| _W n: tjtt fyX t
� d| j � | � i � i | _Y n0 | jS )zl
Try to load local content from file
:return: dictionary with system purpose values
r r r z+Unable to read local system purpose at "%s")
r# r$ r! r" r ri r& r r% �IOErrorr( r} r� r1 r r r rh X s
z SyncedStore.get_local_contentsc C s| | j du s| jdu r"t�d� i S | j �d�s<t�d� i S | j �| j�}i }tD ]}|�t| �}|||< qRt�d� |S )zn
Try to get remote content from server
:return: dictionary with system purpose values
NziFailed to read remote syspurpose from server: no available connection, or the consumer is not registered.rt z0Server does not support syspurpose, not syncing.z0Successfully read remote syspurpose from server.) rb r^ r( r} r~ Z getConsumer�
ATTRIBUTESrD �LOCAL_TO_REMOTE)r ZconsumerrX �attrr5 r r r r� e s �
z SyncedStore.get_remote_contentsc
C sj z(t �tj| jddd��| _t�d� W n: tt j
t fyb t�d| j � i | _| �
i � Y n0 | jS )zy
Try to load cached server response from the file
:return: dictionary with system purpose values
r r r z-Successfully read cached syspurpose contents.z2Unable to read cached syspurpose contents at '%s'.)r# r$ r! r" rg rk r( r} r% r& r r� r r� r1 r r r rj s z SyncedStore.get_cached_contentsr c C s || _ | �� 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)ri � _write_local�r r
r r r r� � s zSyncedStore.update_localc C s | � | j| j� dS )zD
Write local data to the file
:return: None
N)� _update_filer ri r1 r r r r� � s zSyncedStore._write_localc C s || _ | �� d S r )rk � _write_cacher� r r r r� � s zSyncedStore.update_cachec C s | � | j| j� dS )z;
Write cache to file
:return: None
N)r� rg rk r1 r r r r� � s zSyncedStore._write_cachec C s| | j du s| jdu r"t�d� dS |�t�}| j j| j|�t�pBd|durN|ng |�t�p\d|�t �phdd� t�d� dS )z�
Send data to candlepin server
:param data: dictionary with syspurpose values
:return: True, when it was possible to update syspurpose values. Otherwise, return False.
NzmFailed to update remote syspurpose on the server: no available connection, or the consumer is not registered.FrC )r r Z
service_levelr z5Successfully updated remote syspurpose on the server.T)
rb r^ r( r} rD �ADDONSZupdateConsumer�ROLE�
SERVICE_LEVEL�USAGE)r r
r r r r r� � s �
�
zSyncedStore.update_remoter3 c C s� | j dur�|| j v rb|| j | vr�ttd�j||d�� | j | D ] }t|�dkrBtd| � qBn0ttd�j|d�� | j �� D ]}td| � q�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:)r4 )rn �print�_r) �len�keys)r r4 r5 Z valid_valueZ valid_keyr r r �_check_key_value_validity� s(
��� ��z%SyncedStore._check_key_value_validityc C s� z�| j | }|dur*t|t�s*|g| j |< | j | du rBg | j |< || j | vrb| j | �|� n t�d||f � d| _| jW S W n" ttfy� |g| j |< Y n0 | � ||� d| _t�d||f � | jdu r�| �
� | jS )r6 Nz$Will not add value '%s' to key '%s'.FTz Adding value '%s' to key '%s'.) ri r7 r8 r9 r( r} rl r: r; r� r� r< r r r r= � s&
zSyncedStore.addc
C s� z�| j | }|dur2t|t�s2||kr2| �|�W S ||v rd| j | �|� d| _t�d||f � n d| _t�d||f � | jW S W n0 tt t
fy� t�d||f � d| _Y n0 | jdu r�| � � | jS )r> NTz"Removing value '%s' from key '%s'.Fz)Will not remove value '%s' from key '%s'.) ri r7 r8 r? r@ rl r( r} r: r; r% r� )r r4 r5 Zcurrent_valuesr r r r@ s,
���
zSyncedStore.removerA c C s� |dkr"| j �|d�}d| j |< n0|dkrD| j �|d�}g | j |< n| j �|d�}d| _t�d||f � |du| _| jdu r�| �� | jS )rB r
NrC r Tz!Unsetting value '%s' of key '%s'.)ri rD rE rl r( r} r� rF r r r r? - s
zSyncedStore.unsetc C s� | j �|d�}|| j |< ||ks(|du rN| �||� d| _t�d||f � n
t�d� ||kpf|du | _| jdu r|| �� | 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'.)ri rD r� rl r( r} r� r< r r r rG H s
zSyncedStore.set)�dir_pathr c
C sj t j�| �sft�d| � zt j| ddd� W n6 tyd } z t�d| |f � W Y d}~n
d}~0 0 dS )zr
Try to create missing directory
:param dir_path: path to directory
:return: None
z Trying to create directory: %si� T)�mode�exist_okz)Unable to create directory: %s, error: %sN)r& r �isdirr( r} �makedirsr� Zwarning)r� ru r r r �_create_missing_dirc s z SyncedStore._create_missing_dir)r r
r c
C s� | � t� | � t� ztj|ddd�}W n2 tyZ } z|jtjkrF� W Y d}~n6d}~0 0 t||� |� � |�
� t � d| � dS t � 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+r 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+ ZEEXISTr rJ �closer( r} )rN r r
r- r. r r r r� r s
zSyncedStore._update_filec
C s� d}| j dur�| jdur�| j �| j�}d|v r�|d }z| j �|�}W n2 tyx } zt�d| � W Y d}~n"d}~0 0 d|v r�t|�}|d }|S )z�
Try to get valid fields from server using current owner (organization)
:return: Dictionary with valid fields
Nr4 z*Unable to get valid fields from server: %sr )rb r^ ZgetOwnerZ getOwnerSyspurposeValidFieldsr� r( r} r )r rn Z
current_ownerZ owner_keyZresponseru r r r rm � s $z SyncedStore.get_valid_fields)NNF)NNN)'rP rQ rR rS �USER_SYSPURPOSErc �CACHED_SYSPURPOSErf r rT rU r ro rr rp rW rs r �dictr� rh r� rj r� r� r� r� r� r� r= r@ r? rG � staticmethodr� rV r� r rm r r r r r\ � s@ �� &
*$ r\ �
DiffChange)r4 �previous_value� new_value�source�in_base� in_resultrw )rv rx rw � on_conflictr� r c C s� t �d� i }| pi } |p i }|p$i }|dkr4|}n|dkrB| }ntd��|du rZdd� }t| �� �t|�� �B t|�� �B }|D �] }t|| |dd�} t|||d d�}
| p�|
o�|
tk} d
} | |
kr�| d u r�t �d | � |} ||v r�|| ||< nv|
d u �r(t �d
| � d} ||v �rj|| ||< nB| �s8|
tk�rj| d u �rPt �d| � d} || v �rj| | ||< | r�|�|�}
t|| |
|�|�||v ||v d�}||� q�|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...rw rv zAkeyword argument "on_conflict" must be either "remote" or "local"Nc S s | S r r )Zchanger r r r� � s z"three_way_merge.<locals>.on_change)rx �otherr4 r� �serverrx 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'.)r4 r� r� r� r� r� ) r( r} r% rG r� �detect_changed� UNSUPPORTEDrD r� )rv rx rw r� r� rX �winnerZall_keysr4 rZ rY rl r� �original�diffr r r r� � sb
$
�
�
r� r� )rx r� r4 r� r c C s� | pi } |pi }||vr$|dkr$t S | �|�}|�|�}||vrP|dkrPt|�S t|�tu rxt|�tu rxt|�t|�kS |dkr�|du r�|dkr�dS ||kS )aF
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
rv r� NrC F)r� rD rU �typer8 �sorted)rx r� r4 r� Zbase_valZ other_valr r r r� � s
r� )rw N)r� )-rS � collectionsZloggingr# r& r+ r! �typingr r Zsyspurpose.utilsr r r Zsubscription_manager.i18nr r� r� r �joinr� Z VALID_FIELDSr� r� r� r� r� r� r� r� r� Z getLoggerrP r( r� r r rW r\ �
namedtupler� rT r� rU r� r r r r �<module> sP
=� �
� L