123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116 |
- """
- """
-
- # Created on 2016.07.10
- #
- # Author: Giovanni Cannata
- #
- # Copyright 2016 - 2018 Giovanni Cannata
- #
- # This file is part of ldap3.
- #
- # ldap3 is free software: you can redistribute it and/or modify
- # it under the terms of the GNU Lesser General Public License as published
- # by the Free Software Foundation, either version 3 of the License, or
- # (at your option) any later version.
- #
- # ldap3 is distributed in the hope that it will be useful,
- # but WITHOUT ANY WARRANTY; without even the implied warranty of
- # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- # GNU Lesser General Public License for more details.
- #
- # You should have received a copy of the GNU Lesser General Public License
- # along with ldap3 in the COPYING and COPYING.LESSER files.
- # If not, see <http://www.gnu.org/licenses/>.
-
- try:
- from queue import Queue
- except ImportError: # Python 2
- # noinspection PyUnresolvedReferences
- from Queue import Queue
-
- from io import StringIO
- from os import linesep
-
- from ..protocol.rfc2849 import decode_persistent_search_control
- from ..strategy.asynchronous import AsyncStrategy
- from ..core.exceptions import LDAPLDIFError
- from ..utils.conv import prepare_for_stream
- from ..protocol.rfc2849 import persistent_search_response_to_ldif, add_ldif_header
-
-
- # noinspection PyProtectedMember
- class AsyncStreamStrategy(AsyncStrategy):
- """
- This strategy is asynchronous. It streams responses in a generator as they appear in the self._responses container
- """
- def __init__(self, ldap_connection):
- AsyncStrategy.__init__(self, ldap_connection)
- self.can_stream = True
- self.line_separator = linesep
- self.all_base64 = False
- self.stream = None
- self.order = dict()
- self._header_added = False
- self.persistent_search_message_id = None
- self.streaming = False
- self.callback = None
- self.events = Queue()
- del self._requests # remove _requests dict from Async Strategy
-
- def _start_listen(self):
- AsyncStrategy._start_listen(self)
- if self.streaming:
- if not self.stream or (isinstance(self.stream, StringIO) and self.stream.closed):
- self.set_stream(StringIO())
-
- def _stop_listen(self):
- AsyncStrategy._stop_listen(self)
- if self.streaming:
- self.stream.close()
-
- def accumulate_stream(self, message_id, change):
- if message_id == self.persistent_search_message_id:
- with self.async_lock:
- self._responses[message_id] = []
- if self.streaming:
- if not self._header_added and self.stream.tell() == 0:
- header = add_ldif_header(['-'])[0]
- self.stream.write(prepare_for_stream(header + self.line_separator + self.line_separator))
-
- ldif_lines = persistent_search_response_to_ldif(change)
- if self.stream and ldif_lines and not self.connection.closed:
- fragment = self.line_separator.join(ldif_lines)
- if not self._header_added and self.stream.tell() == 0:
- self._header_added = True
- header = add_ldif_header(['-'])[0]
- self.stream.write(prepare_for_stream(header + self.line_separator + self.line_separator))
- self.stream.write(prepare_for_stream(fragment + self.line_separator + self.line_separator))
- else: # strategy is not streaming, events are added to a queue
- notification = decode_persistent_search_control(change)
- if notification:
- change.update(notification)
- del change['controls']['2.16.840.1.113730.3.4.7']
- if not self.callback:
- self.events.put(change)
- else:
- self.callback(change)
-
- def get_stream(self):
- if self.streaming:
- return self.stream
- return None
-
- def set_stream(self, value):
- error = False
- try:
- if not value.writable():
- error = True
- except (ValueError, AttributeError):
- error = True
-
- if error:
- raise LDAPLDIFError('stream must be writable')
-
- self.stream = value
- self.streaming = True
|