3
\�mea; � @ sJ d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlZd dlZd dl Z d dl
m
Z
d dlm Z d dl m
Z
d dlmZmZ d dlmZ eje�ZG dd� de�ZG d d
� d
e jd �ZG d d
� d
e�ZG dd� de�ZG dd� de�Z G dd� de�Z e
eeee e f Z e� Z e j de� e j de� e j de � e j de � dS )� N)�datetime)�Event)�Union)�
url_helper�util)� DictRegistryc @ s e Zd ZdS )�ReportExceptionN)�__name__�
__module__� __qualname__� r r � /usr/lib/python3.6/handlers.pyr s r c @ s& e Zd ZdZejdd� �Zdd� ZdS )�ReportingHandlerz�Base class for report handlers.
Implement :meth:`~publish_event` for controlling what
the handler does with an event.
c C s dS )zPublish an event.Nr )�self�eventr r r
�
publish_event" s z ReportingHandler.publish_eventc C s dS )z0Ensure ReportingHandler has published all eventsNr )r r r r
�flush& s zReportingHandler.flushN)r r
r �__doc__�abc�abstractmethodr r r r r r
r s r )� metaclassc s* e Zd ZdZd� fdd� Zdd� Z� ZS )�
LogHandlerzBPublishes events to the cloud-init log at the ``DEBUG`` log level.�DEBUGc sb t t| �j� t|t�rn>|}ytt|j� �}W n& tk
rV t j
d|� tj }Y nX || _ d S )Nz invalid level '%s', using WARN)
�superr �__init__�
isinstance�int�getattr�logging�upper� Exception�LOG�warningZWARN�level)r r# Z input_level)� __class__r r
r - s
zLogHandler.__init__c C s2 t jdjdd|j|jg��}|j| j|j� � d S )N�.� cloudinitZ reporting)r � getLogger�join�
event_type�name�logr# � as_string)r r Zloggerr r r
r : s zLogHandler.publish_event)r )r r
r r r r �
__classcell__r r )r$ r
r * s
r c @ s e Zd ZdZdd� ZdS )� PrintHandlerz Print the event as a string.c C s t |j� � d S )N)�printr, )r r r r r
r D s zPrintHandler.publish_eventN)r r
r r r r r r r
r. A s r. c s6 e Zd Zd
� fdd� Zdd� Zdd� Zdd � Z� ZS ) �WebHookHandlerNc s� t t| �j� t||||g�r:tj||||d�}|j| _ntj| _|| _|| _|| _ t
j � | _ t
� | _tj� | _tj| jd�| _d| j_| jj� d S )N)� consumer_key� token_key� token_secret�consumer_secret)�targetT)r r0 r �anyr ZOauthUrlHelper�readurl�endpoint�timeout�retriesr Zfetch_ssl_details� ssl_detailsr �flush_requested�queue�Queue� threading�Thread�process_requestsZevent_processor�daemon�start) r r8 r1 r2 r3 r4 r9 r: Z oauth_helper)r$ r r
r I s$
zWebHookHandler.__init__c C s� d}x�| j j� rJ|dkrJtjd� x"| jj� sD| jj� | jj� q$W d}| jjdd�}zty2| j |d |d |d |d |d d d
� d}W n< t
k
r� } z tjd |d |� |d7 }W Y d d }~X nX W d | jj� X qW d S ) Nr � zNMultiple consecutive failures in WebHookHandler. Cancelling all queued events.T)�block� � � F)�datar9 r: r; Z log_req_respz0Failed posting event: %s. This was caused by: %s) r< Zis_setr! r" r= �emptyZ
get_nowait� task_done�getr7 r )r Zconsecutive_failed�args�er r r
rA j s4
z WebHookHandler.process_requestsc C s@ |j � }tjd| j|� | jj| jtj|�| j| j | j
f� d S )Nz Queuing POST to %s, data: %s) Zas_dictr! �debugr8 r= �put�json�dumpsr9 r: r; )r r Z
event_datar r r
r � s z WebHookHandler.publish_eventc C s, | j j� tjd� | jj� | j j� d S )Nz(WebHookHandler flushing remaining events)r< �setr! rO r= r( �clear)r r r r
r � s
zWebHookHandler.flush)NNNNNN)r r
r r rA r r r- r r )r$ r
r0 H s &r0 c s� e Zd ZdZdZdZdZee ZdZdZ dZ
dZ d+Z d Z
d Ze
d
f� fdd� Zedd� �Zdd� Zdd� Zdd� Zdd� Zdd� Zd d � Zd d � Zeed
d �d!d"�Zd#d$� Zd%d&� Z d'd(� Z d)d*� Z � Z S ),�HyperVKvpReportingHandlera,
Reports events to a Hyper-V host using Key-Value-Pair exchange protocol
and can be used to obtain high level diagnostic information from the host.
To use this facility, the KVP user-space daemon (hv_kvp_daemon) has to be
running. It reads the kvp_file when the host requests the guest to
enumerate the KVP's.
This reporter collates all events for a module (origin|name) in a single
json string in the dictionary.
For more information, see
https://technet.microsoft.com/en-us/library/dn798287.aspx#Linux%20guests
i i i Z
CLOUD_INIT�msg�resultZmsg_i�,�:z/var/lib/hyperv/.kvp_pool_1FNc sr t t| �j� || _tj| j� || _tj� | _| j � | _
dj | j | j
�| _
tj| jd�| _d| j_| jj� d S )Nz{0}|{1})r5 T)r rU r �_kvp_file_path�_truncate_guest_pool_file� _event_typesr= r> �q�_get_incarnation_noZincarnation_no�format� EVENT_PREFIX�event_key_prefixr? r@ �_publish_event_routineZpublish_threadrB rC )r Z
kvp_file_pathZ event_types)r$ r r
r � s
z"HyperVKvpReportingHandler.__init__c C s� | j r
dS tj� ttj� � }zby*tjj|�|k rHt|d�� W dQ R X W n2 t t
fk
r| } zt j d|� W Y dd}~X nX W dd| _ X dS )a
Truncate the pool file if it has not been truncated since boot.
This should be done exactly once for the file indicated by
KVP_POOL_FILE_GUEST constant above. This method takes a filename
so that we can use an arbitrary file during unit testing.
Since KVP is a best-effort telemetry channel we only attempt to
truncate the file once and only if the file has not been modified
since boot. Additional truncation can lead to loss of existing
KVPs.
N�wz$failed to truncate kvp pool file, %sT)
� _already_truncated_pool_file�time�floatr �uptime�os�path�getmtime�open�OSError�IOErrorr! r" )�clsZkvp_fileZ boot_timerN r r r
r[ � s "z3HyperVKvpReportingHandler._truncate_guest_pool_filec C sB t j� }yttj� t|� �S tk
r< tjd|� dS X dS )z�
use the time passed as the incarnation number.
the incarnation number is the number which are used to
distinguish the old data stored in kvp and the new data.
z"uptime '%s' not in correct format.r N)r rg r re rf �
ValueErrorr! r" )r Z
uptime_strr r r
r^ � s z-HyperVKvpReportingHandler._get_incarnation_noc
c s~ t | jd��h}tj|tj� |j|� |j| j�}x.t|�| jkr`| j |�}|V |j| j�}q4W tj|tj
� W dQ R X dS )z-iterate the kvp file from the current offset.�rbN) rk rZ �fcntl�flock�LOCK_EX�seek�read�HV_KVP_RECORD_SIZE�len�_decode_kvp_item�LOCK_UN)r �offset�f� record_dataZkvp_itemr r r
�
_iterate_kvps� s
z'HyperVKvpReportingHandler._iterate_kvpsc C s dj | j|j|jtj� �S )z�
the event key format is:
CLOUD_INIT|<incarnation number>|<event_type>|<event_name>|<uuid>
[|subevent_index]
z{0}|{1}|{2}|{3})r_ ra r) r* �uuidZuuid4)r r r r r
�
_event_key s z$HyperVKvpReportingHandler._event_keyc C s* t jd| j| jf |jd�|jd��}|S )Nz%ds%dszutf-8)�struct�pack� HV_KVP_EXCHANGE_MAX_KEY_SIZE� HV_KVP_EXCHANGE_MAX_VALUE_SIZE�encode)r �key�valuerI r r r
�_encode_kvp_item s z*HyperVKvpReportingHandler._encode_kvp_itemc C sd t |�}|| jkr$tdj|| j���|d| j� jd�jd�}|| j| j� jd�jd�}||d�S )Nz$record_data len not correct {0} {1}.r zutf-8� )r� r� )rw rv r r_ r� �decode�strip)r r| Zrecord_data_len�k�vr r r
rx ! s
z*HyperVKvpReportingHandler._decode_kvp_itemc
C sX t | jd��B}tj|tj� x|D ]}|j|� q"W |j� tj|tj� W d Q R X d S )NZab)rk rZ rq rr rs �writer ry )r r| r{ rI r r r
�_append_kvp_item8 s
z*HyperVKvpReportingHandler._append_kvp_itemc C s� || j = tj|�}|dt|�d � }d}g }d| j d }x�||| j< d|| j < tj|| jd�}| jt|� d } |j|dj| j |d | � d ��}
d
j||�} |j | j
| |
�� |d7 }|| d � }t|�dkr>P q>W |S ) NrF r �"z":""� )�
separators� z"{key}":"{desc}")r� Zdescz{}|{}) �MSG_KEYrQ rR rw � DESC_IDX_KEY�JSON_SEPARATORS�HV_KVP_AZURE_MAX_VALUE_SIZE�replacer_ �appendr� ) r r� � meta_data� descriptionZ des_in_json�iZ result_arrayZmessage_place_holderZdata_without_descZ
room_for_descr� Zsubkeyr r r
� _break_down@ s.
z%HyperVKvpReportingHandler._break_down)r� r� �returnc C sh t |�| jkr |d| jd � }| j||�g}y| j|� W n& ttfk
rb tjd||� Y nX dS )zJWrite KVP key-value.
Values will be truncated as needed.
r rF z failed posting kvp=%s value=%sN)rw r� r� r� rl rm r! r" )r r� r� rI r r r
� write_key^ s z#HyperVKvpReportingHandler.write_keyc C s� | j |�}|j|jtj|j�j� d d�}t|| j�rB|j || j< |j
|| j < t j
|| jd�}t|�| jkr|| j|||j
�S | j||�}|gS dS )z�
encode the event into kvp data bytes.
if the event content reaches the maximum length of kvp value.
then it would be cut to multiple slices.
�Z)r* �typeZts)r� N)r r* r) r ZutcfromtimestampZ timestampZ isoformat�hasattr�
RESULT_KEYrW r� r� rQ rR r� rw r� r� r� )r r r� r� r� rI r r r
�
_encode_eventm s
z'HyperVKvpReportingHandler._encode_eventc C s� x�d}y�| j jdd�}|d7 }g }xP|d k rr|| j|�7 }y| j jdd�}|d7 }W q$ tjk
rn d }Y q$X q$W zFy| j|� W n2 ttfk
r� } ztj d|� W Y d d }~X nX W d xt
|�D ]}| j j � q�W X W q t k
r� d S X qW d S )Nr T)rE rF Fz failed posting events to kvp, %s)
r] rL r� r= ZEmptyr� rl rm r! r" �rangerK �EOFError)r Zitems_from_queuer Z encoded_datarN �_r r r
rb � s*
"z0HyperVKvpReportingHandler._publish_event_routinec C s$ | j s|j| j kr | jj|� d S )N)r\ r) r] rP )r r r r r
r � s z'HyperVKvpReportingHandler.publish_eventc C s t jd� | jj� d S )Nz0HyperVReportingHandler flushing remaining events)r! rO r] r( )r r r r
r � s
z HyperVKvpReportingHandler.flush)rX rY ) r r
r r r� r� r� rv r` r� r� r� r� ZKVP_POOL_FILE_GUESTrd r � classmethodr[ r^ r} r r� rx r� r� �strr� r� rb r r r- r r )r$ r
rU � s4
rU r+ r/ ZwebhookZhyperv)!r rq rQ r rh r= r� r? re r~ r r Ztypingr r& r r Zcloudinit.registryr r' r r! r r �ABCMetar r r. r0 rU Z HandlerTypeZavailable_handlersZ
register_itemr r r r
�<module> sD
`