Current File : //usr/lib/python2.7/site-packages/salt/modules/postfix.pyo
�
���^c @@ sD d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z d d l
Z d d l m Z e j
d � Z e j e � Z d Z d Z d � Z e d � Z e d
� Z d d d d d
d e e d � Z d � Z e d � Z e d � Z e d � Z e d � Z d � Z d � Z d � Z d � Z! d � Z" d S( u�
Support for Postfix
This module is currently little more than a config file viewer and editor. It
is able to read the master.cf file (which is one style) and files in the style
of main.cf (which is a different style, that is used in multiple postfix
configuration files).
The design of this module is such that when files are edited, a minimum of
changes are made to them. Each file should look as if it has been edited by
hand; order, comments and whitespace are all preserved.
i ( t absolute_importt print_functiont unicode_literalsN( t sixu ^\su /etc/postfix/main.cfu /etc/postfix/master.cfc C@ s# t j j j d � r t St d f S( u6
Only load the module if Postfix is installed
u postfixu; postfix execution module not loaded: postfix not installed.( t saltt utilst patht whicht Truet False( ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/postfix.pyt __virtual__$ s c C@ sH t j j j | d � �" } t j j j | j � � } Wd QXg } i } x� | j � D]� } | j � s} | j � j d � r� | j
| � qU n | j � j � } i | d d 6| d d 6| d d 6| d
d 6| d d
6| d d 6| d d 6d j | d � d 6} d j
| d | d � } | j
| � | | | <qU W| | f S( u
Parse the master.cf file. This file is essentially a whitespace-delimited
columnar file. The columns are: service, type, private (yes), unpriv (yes),
chroot (yes), wakeup (never), maxproc (100), command + args.
This function parses out the columns, leaving empty lines and comments
intact. Where the value doesn't detract from the default, a dash (-) will
be used.
Returns a dict of the active config lines, and a list of the entire file,
in order. These compliment each other.
u rNu #i u servicei u conn_typei u privatei u unprivi u chrooti u wakeupi u maxprocu i u commandu {0} {1}( R R t filest fopent stringutilst
to_unicodet readt
splitlinest stript
startswitht appendt splitt joint format( R t fh_t full_conft conf_listt conf_dictt linet compst conf_linet dict_key( ( s8 /usr/lib/python2.7/site-packages/salt/modules/postfix.pyt
_parse_master- s,
!"
c C@ s t | � \ } } | S( u|
Return a dict of active config values. This does not include comments,
spacing or order.
The data returned from this function should not be used for direct
modification of the main.cf file; other functions are available for that.
CLI Examples:
salt <minion> postfix.show_master
salt <minion> postfix.show_master path=/path/to/master.cf
( R ( R R R ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/postfix.pyt show_masterW s
u yu nu 100u c
C@ s� t | � \ }
} g } d j | | � }
t | | | | | | | | � } xp | D]h } t | t � r� | d | k r� | d | k r� | j | � q� | j t | � � qR | j | � qR W|
|
k r� | j | � n | r� t | | � n d j | � S( u�
Set a single config value in the master.cf file. If the value does not
already exist, it will be appended to the end.
Because of shell parsing issues, '-' cannot be set as a value, as is normal
in the master.cf file; either 'y', 'n' or a number should be used when
calling this function from the command line. If the value used matches the
default, it will internally be converted to a '-'. Calling this function
from the Python API is not affected by this limitation
The settings and their default values, in order, are: service (required),
conn_type (required), private (y), unpriv (y), chroot (y), wakeup (n),
maxproc (100), command (required).
By default, this function will write out the changes to the master.cf file,
and then returns the full contents of the file. By setting the
``write_conf`` option to ``False``, it will skip writing the file.
CLI Example:
salt <minion> postfix.set_master smtp inet n y n n 100 smtpd
u {0} {1}u serviceu conn_typeu
( R R t _format_mastert
isinstancet dictR t _write_confR ( t servicet conn_typet privatet unprivt chroott wakeupt maxproct commandt
write_confR R R t new_confR t new_lineR ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/postfix.pyt
set_masterh s.
c C@ s� | d k r d } n | d k r* d } n | d k r? d } n | d k rT d } n t j | � } | d k rx d } n d j | | | | | | | | � } | S( ua
Format the given values into the style of line normally used in the
master.cf file.
u yu -u nu 100u4 {0:9s} {1:5s} {2:7s} {3:7s} {4:7s} {5:7s} {6:7s} {7}( R t text_typeR ( R% R& R' R( R) R* R+ R, R ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/postfix.pyR! � s* c C@ sq t j j j | d � �" } t j j j | j � � } Wd QXg } x� | j � D]� } | j � st | j | � qO n t
j t | � r� | s� | j | � qO n t
| d t j � s� d | d <n d j | d | g � | d <qO | j | � qO Wi } xk | D]c } | j � sq n | j d � r-q n | j d � } d j | d � j � | | d j � <q W| | f S(
u�
Parse files in the style of main.cf. This is not just a "name = value" file;
there are other rules:
* Comments start with #
* Any whitespace at the beginning of a line denotes that that line is a
continuation from the previous line.
* The whitespace rule applies to comments.
* Keys defined in the file may be referred to as variables further down in
the file.
u rNi����u u
u #u =i i ( R R R R R
R R R R R t ret matcht SWWSR" R t string_typesR R R ( R R R R R t pairsR ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/postfix.pyt _parse_main� s0 !
+c C@ s t | � \ } } | S( u�
Return a dict of active config values. This does not include comments,
spacing or order. Bear in mind that order is functionally important in the
main.cf file, since keys can be referred to as variables. This means that
the data returned from this function should not be used for direct
modification of the main.cf file; other functions are available for that.
CLI Examples:
salt <minion> postfix.show_main
salt <minion> postfix.show_main path=/path/to/main.cf
( R7 ( R R6 R ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/postfix.pyt show_main s
c C@ s� t | � \ } } g } t j d j t j | � � � } | | k r� xk | D]A } t j | | � r� | j d j | | � � qL | j | � qL Wn | j d j | | � � | } t | | � | S( u�
Set a single config value in the main.cf file. If the value does not already
exist, it will be appended to the end.
CLI Example:
salt <minion> postfix.set_main mailq_path /usr/bin/mailq
u
^{0}([\s=]|$)u {0} = {1}( R7 R2 t compileR t escapeR3 R R$ ( t keyt valueR R6 R R. t key_line_matchR ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/postfix.pyt set_main s !
c C@ s� t j j j | d � �o } xe | D]] } t j j j | � } t | t � re | j d j | � � n
| j | � | j d � q" WWd QXd S( u'
Write out configuration file.
u wu u
N(
R R R R R
t to_strR" R# t writeR ( t confR R R ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/postfix.pyR$ 7 s
c C@ s? d } t d | � j � } g } t j d � } t j d � } x� | D]� } t j d | � re qG n t j | | � r� t j | | � } | j d � } | j d � } | j d � } | j d � }
qG t j | | � r� t j | | � } | j d
� } qG | sG | j i | d 6| d 6| d 6|
d 6| d
6� qG qG W| S( u{
Show contents of the mail queue
CLI Example:
.. code-block:: bash
salt '*' postfix.show_queue
u mailqu cmd.runut (?P<queue_id>^[A-Z0-9]+)\s+(?P<size>\d+)\s(?P<timestamp>\w{3}\s\w{3}\s\d{1,2}\s\d{2}\:\d{2}\:\d{2})\s+(?P<sender>.+)u ^\s+(?P<recipient>.+)u ^[-|postqueue:|Mail]u queue_idu sizeu timestampu senderu recipient( t __salt__R R2 R9 R3 t groupR ( t cmdt outt queuet
queue_patternt recipient_patternR t mt queue_idt sizet timestampt sendert recipient( ( s8 /usr/lib/python2.7/site-packages/salt/modules/postfix.pyt
show_queueE s(
7c C@ s. i d d 6t d 6} | s* t j d � n | d k s� t � } d } x' | D] } | d | k rL | } qL qL W| s� d j | � | d <t | d <| Sn d j | � } t d | � } | d
d k r� | d k r� d | d <q*d
j | � | d <n3 | d k rd | d <n d j | | d � | d <| S( u�
Delete message(s) from the mail queue
CLI Example:
.. code-block:: bash
salt '*' postfix.delete 5C33CA0DEA
salt '*' postfix.delete ALL
u u messageu resultu Require argument queue_idu ALLu queue_idu No message in queue with ID {0}u postsuper -d {0}u cmd.run_allu retcodei u! Successfully removed all messagesu. Successfully removed message with queue id {0}u Unable to removed all messagesu/ Unable to remove message with queue id {0}: {1}u stderrN( R t logt errorRO t NoneR R RB ( RJ t retRF t _messaget itemRD t result( ( s8 /usr/lib/python2.7/site-packages/salt/modules/postfix.pyt deleteh s0
c C@ s. i d d 6t d 6} | s* t j d � n | d k s� t � } d } x' | D] } | d | k rL | } qL qL W| s� d j | � | d <t | d <| Sn d j | � } t d | � } | d
d k r� | d k r� d | d <q*d
j | � | d <n3 | d k rd | d <n d j | | d � | d <| S( u�
Put message(s) on hold from the mail queue
CLI Example:
.. code-block:: bash
salt '*' postfix.hold 5C33CA0DEA
salt '*' postfix.hold ALL
u u messageu resultu Require argument queue_idu ALLu queue_idu No message in queue with ID {0}u postsuper -h {0}u cmd.run_allu retcodei u( Successfully placed all messages on holdu5 Successfully placed message on hold with queue id {0}u$ Unable to place all messages on holdu6 Unable to place message on hold with queue id {0}: {1}u stderrN( R RP RQ RO RR R R RB ( RJ RS RF RT RU RD RV ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/postfix.pyt hold� s0
c C@ s. i d d 6t d 6} | s* t j d � n | d k s� t � } d } x' | D] } | d | k rL | } qL qL W| s� d j | � | d <t | d <| Sn d j | � } t d | � } | d
d k r� | d k r� d | d <q*d
j | � | d <n3 | d k rd | d <n d j | | d � | d <| S( u�
Set held message(s) in the mail queue to unheld
CLI Example:
.. code-block:: bash
salt '*' postfix.unhold 5C33CA0DEA
salt '*' postfix.unhold ALL
u u messageu resultu Require argument queue_idu ALLu queue_idu No message in queue with ID {0}u postsuper -H {0}u cmd.run_allu retcodei u& Successfully set all message as unheldu4 Successfully set message as unheld with queue id {0}u$ Unable to set all message as unheld.u6 Unable to set message as unheld with queue id {0}: {1}u stderrN( R RP RQ RO RR R R RB ( RJ RS RF RT RU RD RV ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/postfix.pyt unhold� s0
c C@ s. i d d 6t d 6} | s* t j d � n | d k s� t � } d } x' | D] } | d | k rL | } qL qL W| s� d j | � | d <t | d <| Sn d j | � } t d | � } | d
d k r� | d k r� d | d <q*d
j | � | d <n3 | d k rd | d <n d j | | d � | d <| S( u�
Requeue message(s) in the mail queue
CLI Example:
.. code-block:: bash
salt '*' postfix.requeue 5C33CA0DEA
salt '*' postfix.requeue ALL
u u messageu resultu Required argument queue_idu ALLu queue_idu No message in queue with ID {0}u postsuper -r {0}u cmd.run_allu retcodei u" Successfully requeued all messagesu/ Successfully requeued message with queue id {0}u Unable to requeue all messagesu0 Unable to requeue message with queue id {0}: {1}u stderrN( R RP RQ RO RR R R RB ( RJ RS RF RT RU RD RV ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/postfix.pyt requeue� s0
(# t __doc__t
__future__R R R R2 t loggingt salt.utils.filesR t salt.utils.patht salt.utils.stringutilst salt.extR R9 R4 t getLoggert __name__RP t MAIN_CFt MASTER_CFR
R R R R0 R! R7 R8 R> R$ RO RW RX RY RZ ( ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/postfix.pyt <module>
s@ * ; / 0 # 1 1 1
Mini Shell