�
Ϫ�f�- � �t � d Z ddlmZmZmZ ddlmZ ddlmZ ddl m
Z
ddl m Z ddl
mZ G d� d e� Z ee
e� G d
� d � � Z G d � d
e� Z ee� G d� d� � Z G d� de� Z ee� G d� de� � Z G d� de� Z ee� G d� d� � Zd d�Zd d�Zg d�Zy) aa
Service architecture for Twisted.
Services are arranged in a hierarchy. At the leafs of the hierarchy,
the services which actually interact with the outside world are started.
Services can be named or anonymous -- usually, they will be named if
there is need to access them through the hierarchy (from a parent or
a sibling).
Maintainer: Moshe Zadka
� )� Attribute� Interface� implementer)�defer)�sob)�IPlugin)�
components)�namedAnyc �F � e Zd ZdZ ed� Z ed� Z ed� Zd� Zy)�
IServiceMakerz�
An object which can be used to construct services in a flexible
way.
This interface should most often be implemented along with
L{twisted.plugin.IPlugin}, and will most often be used by the
'twistd' command.
zA short string naming this Twisted plugin, for example 'web' or 'pencil'. This name will be used as the subcommand of 'twistd'.zLA brief summary of the features provided by this Twisted application plugin.zcA C{twisted.python.usage.Options} subclass defining the configuration options for this application.c � � y)a
Create and return an object providing
L{twisted.application.service.IService}.
@param options: A mapping (typically a C{dict} or
L{twisted.python.usage.Options} instance) of configuration
options to desired configuration values.
N� )�optionss �=/usr/lib/python3/dist-packages/twisted/application/service.py� makeServicezIServiceMaker.makeService4 � � � N) �__name__�
__module__� __qualname__�__doc__r �tapname� descriptionr r r r r r r s@ � �� � J��G�
� &��K�
� 6��G�
r r c �6 � e Zd ZdZd� Zed� � Zed� � Zy)� ServiceMakerzO
Utility class to simplify the definition of L{IServiceMaker} plugins.
c �< � || _ || _ || _ || _ y �N)�name�moduler r )�selfr r r r s r �__init__zServiceMaker.__init__E s � ��� � �� �&��� �� r c �@ � t | j � j S r )r
r �Options�r s r r zServiceMaker.optionsK s � ��� � �$�,�,�,r c �@ � t | j � j S r )r
r r r$ s r r zServiceMaker.makeServiceO s � ��� � �$�0�0�0r N)r r r r r! �propertyr r r r r r r ? s4 � �� � �-� �-� �1� �1r r c �d � e Zd ZdZ ed� Z ed� Z ed� Zd� Zd� Z d� Z
d� Z d � Z d
� Z
y ) �IServicezS
A service.
Run start-up and shut-down code at the appropriate times.
z5A C{str} which is the name of the service or C{None}.z<A C{boolean} which indicates whether the service is running.z8An C{IServiceCollection} which is the parent or C{None}.c � � y)z�
Set the name of the service.
@type name: C{str}
@raise RuntimeError: Raised if the service already has a parent.
Nr �r s r �setNamezIService.setNamea r r c � � y)ax
Set the parent of the service. This method is responsible for setting
the C{parent} attribute on this service (the child service).
@type parent: L{IServiceCollection}
@raise RuntimeError: Raised if the service already has a parent
or if the service has a name and the parent already has a child
by that name.
Nr )�parents r �setServiceParentzIService.setServiceParenti r r c � � y)a�
Use this API to remove an L{IService} from an L{IServiceCollection}.
This method is used symmetrically with L{setServiceParent} in that it
sets the C{parent} attribute on the child.
@rtype: L{Deferred<defer.Deferred>}
@return: a L{Deferred<defer.Deferred>} which is triggered when the
service has finished shutting down. If shutting down is immediate,
a value can be returned (usually, L{None}).
Nr r r r �disownServiceParentz IService.disownServiceParentt r r c � � y)z$
Start the service.
Nr r r r � startServicezIService.startService� r r c � � y)a"
Stop the service.
@rtype: L{Deferred<defer.Deferred>}
@return: a L{Deferred<defer.Deferred>} which is triggered when the
service has finished shutting down. If shutting down is immediate,
a value can be returned (usually, L{None}).
Nr r r r � stopServicezIService.stopService� r r c � � y)z�
Do preparation work for starting the service.
Here things which should be done before changing directory,
root or shedding privileges are done.
Nr r r r �privilegedStartServicez IService.privilegedStartService� r r N)r r r r r r �runningr- r+ r. r0 r2 r4 r6 r r r r( r( T sH � �� �L� M�D��V�W�G�
�Q�
R�F� � � � �
� r r( c �F � e Zd ZdZdZdZdZd� Zd� Zd� Z d� Z
d� Z d � Z d
� Z
y) �Servicez�
Base class for services.
Most services should inherit from this class. It handles the
book-keeping responsibilities of starting and stopping, as well
as not serializing this book-keeping information.
r Nc �H � | j j � }d|v r|d= |S )Nr7 )�__dict__�copy)r �dicts r � __getstate__zService.__getstate__� s( � ��}�}�!�!�#�� �� ��Y��� r c �@ � | j � t d� �|| _ y )Nz%cannot change name when parent exists)r- � RuntimeErrorr �r r s r r+ zService.setName� s � � �;�;� "� � F�G� G��� r c � � | j �| j � t ||� }|| _ | j j | � y r )r- r0 �IServiceCollection�
addService)r r- s r r. zService.setServiceParent� s= � � �;�;� "� � $� $� &�#�F�F�3�� �� � � � � � �t�$r c �J � | j j | � }d | _ |S r )r- �
removeService)r �ds r r0 zService.disownServiceParent� s" � � �K�K� %� %�d� +���� ��r c � � y r r r$ s r r6 z Service.privilegedStartService� s � � r c � � d| _ y )N� �r7 r$ s r r2 zService.startService� � � ��� r c � � d| _ y )Nr rK r$ s r r4 zService.stopService� rL r )r r r r r7 r r- r> r+ r. r0 r6 r2 r4 r r r r9 r9 � s; � �� �G� �D�
�F�� �
%��
��r r9 c �( � e Zd ZdZd� Zd� Zd� Zd� Zy)rC z�
Collection of services.
Contain several services, and manage their start-up/shut-down.
Services can be accessed by name if they have a name, and it
is always possible to iterate over them.
c � � y)z�
Get the child service with a given name.
@type name: C{str}
@rtype: L{IService}
@raise KeyError: Raised if the service has no child with the
given name.
Nr r* s r �getServiceNamedz"IServiceCollection.getServiceNamed� r r c � � y)z:
Get an iterator over all child services.
Nr r r r �__iter__zIServiceCollection.__iter__� r r c � � y)a
Add a child service.
Only implementations of L{IService.setServiceParent} should use this
method.
@type service: L{IService}
@raise RuntimeError: Raised if the service has a child with
the given name.
Nr ��services r rD z IServiceCollection.addService� r r c � � y)a�
Remove a child service.
Only implementations of L{IService.disownServiceParent} should
use this method.
@type service: L{IService}
@raise ValueError: Raised if the given service is not a child.
@rtype: L{Deferred<defer.Deferred>}
@return: a L{Deferred<defer.Deferred>} which is triggered when the
service has finished shutting down. If shutting down is immediate,
a value can be returned (usually, L{None}).
Nr rT s r rF z IServiceCollection.removeService� r r N)r r r r rP rR rD rF r r r rC rC � s � �� � �
�
r rC c �@ � e Zd ZdZd� Zd� Zd� Zd� Zd� Zd� Z d� Z
d � Z y
) � MultiServicea
Straightforward Service Container.
Hold a collection of services, and manage them in a simplistic
way. No service will wait for another, but this object itself
will not finish shutting down until all of its child services
will finish.
c �. � g | _ i | _ d | _ y r )�services�
namedServicesr- r$ s r r! zMultiService.__init__ s � ���
� ����� r c �\ � t j | � | D ] }|j � � y r )r9 r6 �r rU s r r6 z#MultiService.privilegedStartService s+ � ��&�&�t�,�� -�G� � *� *� ,� -r c �\ � t j | � | D ] }|j � � y r )r9 r2 r] s r r2 zMultiService.startService s+ � �� � �T�"�� #�G� � � � "� #r c � � t j | � g }t | � }|j � |D ]0 }|j t j |j � � �2 t j |� S r )r9 r4 �list�reverse�appendr �
maybeDeferred� DeferredList)r �lrZ rU s r r4 zMultiService.stopService sg � ����D�!� ����:������ � ?�G�
�H�H�U�(�(��)<�)<�=� >� ?��!�!�!�$�$r c � � | j | S r )r[ rA s r rP z MultiService.getServiceNamed s � ��!�!�$�'�'r c �, � t | j � S r )�iterrZ r$ s r rR zMultiService.__iter__" s � ��D�M�M�"�"r c �> � |j �I|j | j v rt d|j z � �|| j |j < | j j |� | j
r!|j
� |j � y y )Nz,cannot have two services with same name '%s')r r[ r@ rZ rb r7 r6 r2 r] s r rD zMultiService.addService% s� � � �<�<� #��|�|�t� 1� 1�1�"�E�� � �T�� � 07�D� � �w�|�|� ,� �
�
� � �W�%� �<�<� � *� *� ,� � � � "� r c � � |j r| j |j = | j j |� | j r|j � S y r )r r[ rZ �remover7 r4 r] s r rF zMultiService.removeService2 sH � � �<�<��"�"�7�<�<�0� �
�
� � �W�%� �<�<� �&�&�(� (�r N) r r r r r! r6 r2 r4 rP rR rD rF r r r rX rX � s/ � ���
-�
#�
%�(�#� #� r rX c �@ � e Zd ZdZ ed� Z ed� Z ed� Zy)�IProcessza
Process running parameters.
Represents parameters for how processes should be run.
zv
A C{str} giving the name the process should have in ps (or L{None}
to leave the name alone).
z{
An C{int} giving the user id as which the process should run (or
L{None} to leave the UID alone).
z|
An C{int} giving the group id as which the process should run (or
L{None} to leave the GID alone).
N)r r r r r � processName�uid�gidr r r rm rm > s: � �� � ��K� � � �C� � � �Cr rm c � � e Zd ZdZdZdd�Zy)�Processz�
Process running parameters.
Sets up uid/gid in the constructor, and has a default
of L{None} as C{processName}.
Nc � � || _ || _ y)a=
Set uid and gid.
@param uid: The user ID as whom to execute the process. If
this is L{None}, no attempt will be made to change the UID.
@param gid: The group ID as whom to execute the process. If
this is L{None}, no attempt will be made to change the GID.
N)ro rp )r ro rp s r r! zProcess.__init__f s � � �����r �NN)r r r r rn r! r r r rr rr [ s � �� �K� r rr Nc �� � t j � }t � t ||� t j
|| � g}|D ] }|j
|d�� � t |� j | � |S )a
Return a compound class.
Return an object supporting the L{IService}, L{IServiceCollection},
L{IProcess} and L{sob.IPersistable} interfaces, with the given
parameters. Always access the return value by explicit casting to
one of the interfaces.
rJ )� ignoreClass) r �
ComponentizedrX rr r �
Persistent� addComponentr( r+ )r ro rp �ret�availableComponents�comps r � Applicationr} t sm � � �
"�
"�
$�C�'�>�7�3��+<�c�n�n�S�RV�>W�X��#� .�� ����1��-�.� �S�M���$� � �Jr c �l � |dk( rt j | d� }|S t j | |� }|S )a`
Load Application from a given file.
The serialization format it was saved in should be given as
C{kind}, and is one of C{pickle}, C{source}, C{xml} or C{python}. If
C{passphrase} is given, the application was encrypted with the
given passphrase.
@type filename: C{str}
@type kind: C{str}
@type passphrase: C{str}
�python� application)r �loadValueFromFile�load)�filename�kind�
passphraser� s r �loadApplicationr� � s> � � �x���+�+�H�m�D� � �� �h�h�x��.� � �r ) r r( r9 rC rX rm rr r} r� rt r )r �zope.interfacer r r �twisted.internetr �twisted.persistedr �twisted.pluginr �twisted.pythonr �twisted.python.reflectr
r r r( r9 rC rX rm rr r} r� �__all__r r r �<module>r� s� ��
� =� <� "� !� "� %� +�! �I� ! �H
�W�m�$�1� 1� %�1�(B �y� B �J
�X��+� +� �+�\1 �� 1 �h
�
� �>�7� >� !�>�B�y� �:
�X��� � ��0�$�(
�r |