Sindbad~EG File Manager
3
x?ag.7 � @ s� d Z ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ dd lm Z dd
l
m Z m Z dd l
m
Z
mZ dd lZdd lZdd lZdd
lmZ dd lZdd lZG dd� dee�ZG dd� de�Zd S )z�
Configuration - VDO manager configuration file handling
$Id: //eng/vdo-releases/aluminum/src/python/vdo/vdomgmnt/Configuration.py#6 $
� )�absolute_import)�division)�print_function)�unicode_literals� )�
ArgumentError)�StateExitStatus)�
VDOService)�Command�
runCommand)�FileLock�
YAMLObjectN)�ST_MTIMEc s( e Zd ZdZ� fdd�Zdd� Z� ZS )�BadConfigurationFileErrorzwException raised to indicate an error in processing the
configuration file, such as a parse error or missing data.
c s t t| �j||� || _d S )N)�superr �__init__�_msg)�self�msg�args�kwargs)� __class__� �#/usr/lib/python3.6/Configuration.pyr 3 s z"BadConfigurationFileError.__init__c C s | j S )N)r )r r r r �__str__8 s z!BadConfigurationFileError.__str__)�__name__�
__module__� __qualname__�__doc__r r �
__classcell__r r )r r r + s r c s0 e Zd ZdZejd�ZdgZi ZdZ dZ
dZ e dd� �Z
d:d d
�Zd d � Zed
d� �Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd � Ze d d � �Zed d � �Ze� fd!d"��Z� fd#d$�Z e� fd%d&��Z � fd'd(�Z d;� fd*d+� Z d,d-� Z d.d/� Z!d0d1� Z"d2d3� Z#d4d5� Z$d6d7� Z%e d8d9� �Z&� Z'S )<�
Configurationz Configuration of VDO volumes.zvdo.vdomgmnt.Configurationi z /var/lock/vdo-config-singletonsz!ConfigurationFc C sJ d}t | jd��0}| jj|�}|dkr<t|dd�}|| j|< W dQ R X |S )aR Allocates, as necessary, and returns a modifiable, singleton
Configuration instance for the specified filepath. Separate entities can
thus share one in memory copy of the configuration file allowing for
encapsulation of per-entity manipulation of the configuration.
Args:
filepath (str): path to config file
Nzr+F)�readonly)r �
singletonLock�modifiableSingltons�getr )�cls�filepath�config�fr r r �modifiableSingletonI s
z!Configuration.modifiableSingletonc C sB | j � | jjdj|�� | r.| j|�r.dS || j|< d| _dS )at Adds or replaces a VDOService object in the configuration.
Generates an assertion error if this object is read-only.
Arguments:
name -- name of the VDOService
vdo -- the VDOService to add or replace
replace -- if True, any existing VDOService will be replaced
Returns: False if the VDOService exists and replace is False,
True otherwise
z!Adding vdo "{0}" to configurationFT)�_assertCanModify�log�debug�format�haveVdo�_vdos�_dirty)r �name�vdo�replacer r r �addVdo\ s
zConfiguration.addVdoc C s" t j| j| d�dd�}|jdd�S )zIReturns the configuration's YAML representation to present to users.
)�filenamer' F)�default_flow_stylez!!python/unicode � )�yaml�dumpr& r3 )r �sr r r �
asYAMLForUserp s zConfiguration.asYAMLForUserc C s | j S )z0Returns the file path of the configuration file.)� _filename)r r r r r& z s zConfiguration.filepathc C s | j S )z#Retrieves a list of all known VDOs.)r/ )r r r r �
getAllVdos� s zConfiguration.getAllVdosc C s> d}y| j | }W n& tk
r8 ttd�j|���Y nX |S )zRetrieves a VDO by name.NzVDO volume {0} not found)r/ �KeyErrorr �_r- )r r1 r2 r r r �getVdo� s zConfiguration.getVdoc C s
|| j kS )z0Returns True if we have a VDO with a given name.)r/ )r r1 r r r r. � s zConfiguration.haveVdoc C s< t jj|�}x*| jD ] }|t jj| j| j�krdS qW dS )z�Returns a boolean indicating if the configuration contains a VDO using
the specified device.
Both the specified device and the device from the vdos present in the
configuration are fully resolved for the check.
TF)�os�path�realpathr/ �device)r rD r2 r r r �isDeviceConfigured� s
z Configuration.isDeviceConfiguredc C s> | j r
dS | js | jjd� dS | jjdj| j�� | j� rH| j� dS tj d| idd�}t
j � r�t t
d�� t |� d| _dS | jd }tjj|�r�tj|� t|d ��n}|jd
� |jtj� |jd jt
d ��� |jtj� |jd
� |jtj� |j|� |j� tj|� W dQ R X tj|| j� | j� d| _dS )
a\ Writes out the Configuration if necessary.
If the Configuration is read-only or has not been modified, this
method will silently return. If Command.noRunMode is True, any
new Configuration will be printed to stdout instead of the file.
This method will generate an assertion failure if the configuration
file is not open.
Nz&Configuration is clean, not persistingz Writing configuration to {0}r' F)r6 z New configuration (not written):z.new�wzD####################################################################z# {0}z>THIS FILE IS MACHINE GENERATED. DO NOT EDIT THIS FILE BY HAND.)� _readonlyr0 r+ r, r- r& �_empty� _removeFiler8 r9 r
� noRunMode�printr? rA rB �exists�remove�open�write�linesep�flush�fsync�rename�_fsyncDirectory)r r: ZnewFile�fhr r r �persist� sD
zConfiguration.persistc C s | j � | j|= d| _dS )zRemoves a VDO by name.TN)r* r/ r0 )r r1 r r r � removeVdo� s zConfiguration.removeVdoc C s� i }d}y t j| j�}| j|td�< W n@ tk
rf } z$|jtjkrF� td�|td�< W Y dd}~X nX |dkr�td�|td�< n tjdtj |t
��|td�< |S )zAReturns a dictionary representing the status of this object.
NZFilezdoes not existz
not availablez
Last modifiedz%Y-%m-%d %H:%M:%S) rA �statr& r? �OSError�errno�ENOENT�timeZstrftimeZ localtimer )r �status�st�exr r r r] � s "zConfiguration.statusc C s | d�S )Nz/dev/YAMLInstancer )r% r r r �_yamlMakeInstance� s z Configuration._yamlMakeInstancec C s ddgS )N�version�vdosr )r r r r �_yamlAttributeKeys� s z Configuration._yamlAttributeKeysc s$ t t| �j}| j|d< | j|d< |S )Nra rb )r r � _yamlData�_schemaVersionr/ )r �data)r r r rd s
zConfiguration._yamlDatac s( t t| �j|� |d | _|d | _d S )Nra rb )r r �_yamlSetAttributesra rb )r Z
attributes)r r r rg
s
z Configuration._yamlSetAttributesc s t t| �j}|jddg� |S )Nra rb )r r � _yamlSpeciallyHandledAttributes�extend)r Zspecials)r r r rh s z-Configuration._yamlSpeciallyHandledAttributesc sD t t| �j|� |j| _|j| _x | jD ]}| j| j| � q(W d S )N)r r �_yamlUpdateFromInstancera re rb r/ Z setConfig)r �instancer2 )r r r rj s
z%Configuration._yamlUpdateFromInstanceTc s� t t| �j� i | _tjj|�| _|| _d| _ || _
d| _ | j sN| j
� d| _ | j
rxtjj| j� rxttd�j| j���|r�dnd}y@tjj|�r�tjj|�dkr�t||��}| j|� W dQ R X W n. tk
r� } ztt|���W Y dd}~X nX dS ) a Construct a Configuration.
Args:
filename (str): The path to the XML configuration file
Kwargs:
readonly (bool): If True, the configuration is read-only.
mustExist (bool): If True, the configuration file must exist.
Raises:
ArgumentError
Fi Tz&Configuration file {0} does not exist.�rza+r N)r r r r/ rA rB �abspathr< rG r0 Z
_mustExistre �yaml_has_unicode_ctorsZ_fix_constructorsrL r& r r? r- �getsizerN �_read�IOError�str)r r5 r! Z mustExist�moderU r )r r r r s*
zConfiguration.__init__c C s dj t| �j| j�S )Nz{0}({1}))r- �typer r& )r r r r r D s zConfiguration.__str__c C s dS )z<Asserts that mutative operations are allowed on this object.Nr )r r r r r* J s z Configuration._assertCanModifyc C s t | j�dkS )z,Returns True if this configuration is empty.r )�lenr/ )r r r r rH O s zConfiguration._emptyc C sT t jj| j�}tj� r&td|g� dS t j|t j�}zt j |� W dt j
|� X dS )zIOpen and issue an fsync on the directory containing the config file.
rR N) rA rB �dirnamer& r
rJ r rN �O_RDONLYrR �close)r rv �fdr r r rT T s z Configuration._fsyncDirectoryc & C s | j jdj| j�� y|jdd� tj|�}W n$ tjjk
rR t t
d���Y nX y |d }W n^ t k
r� t t
d���Y n@ t k
r� } z$| j jdj|�� t t
d���W Y dd}~X nX y| j
|� W nB t k
�r } z$| j jdj|�� t t
d���W Y dd}~X nX d| _dS ) z%Reads in a Configuration from a file.z Reading configuration from {0}r z Not a valid configuration filer' z9Not a valid configuration file (missing 'config' section)z#Not a valid configuration file: {0}NF)r+ r, r- r& �seekr8 Z safe_load�scannerZ ScannerErrorr r? r> � Exceptionrj r0 )r rU Zconfr' r_ r r r rp b s( zConfiguration._readc C s| t j� rtd| jg� dS tjj| j�r<tj| j� | j� y&t | j
d��}t j | j= W dQ R X W n t
k
rv Y nX dS )zfDeletes the current configuration file.
In noRun mode, pretend that we're doing an rm of the file.ZrmNzr+)r
rJ r r& rA rB rL rM rT r r" r r# r> )r r( r r r rI � s zConfiguration._removeFilec C s" || j kr ttd�j|d���dS )z�Checks a configuration file schema version string against the list
of supported schemas.
Args:
ver (str): the schema version string to check
Raises:
BadConfigurationFileError: version not supported.
z,Configuration file version {v} not supported)�vN)�supportedSchemaVersionsr r? r- )r% Zverr r r �_validateVersion� s
z Configuration._validateVersion)F)TF)(r r r r �loggingZ getLoggerr+ r~ r# r" Zyaml_tagrn � classmethodr) r4 r; �propertyr& r= r@ r. rE rV rW r] r` rc rd rg rh rj r r r* rH rT rp rI r r r r )r r r < s@
6 $ r )r Z
__future__r r r r r7 r r r Z vdo.utilsr
r r r
rZ r� rA rX r r\ r8 r| r r r r r r �<module> s"
Sindbad File Manager Version 1.0, Coded By Sindbad EG ~ The Terrorists