D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
lib
/
python2.7
/
site-packages
/
ansible
/
plugins
/
callback
/
Filename :
osx_say.py
back
Copy
# (c) 2012, Michael DeHaan, <michael.dehaan@gmail.com> # (c) 2017 Ansible Project # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # Make coding more python3-ish from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' callback: say type: notification requirements: - whitelisting in configuration - the '/usr/bin/say' command line program (standard on macOS) or 'espeak' command line program short_description: notify using software speech synthesizer version_added: historical description: - This plugin will use the 'say' or 'espeak' program to "speak" about play events. notes: - In 2.8, this callback has been renamed from C(osx_say) into M(say). ''' import distutils.spawn import platform import subprocess import os from ansible.plugins.callback import CallbackBase class CallbackModule(CallbackBase): """ makes Ansible much more exciting. """ CALLBACK_VERSION = 2.0 CALLBACK_TYPE = 'notification' CALLBACK_NAME = 'say' CALLBACK_NEEDS_WHITELIST = True def __init__(self): super(CallbackModule, self).__init__() self.FAILED_VOICE = None self.REGULAR_VOICE = None self.HAPPY_VOICE = None self.LASER_VOICE = None self.synthesizer = distutils.spawn.find_executable('say') if not self.synthesizer: self.synthesizer = distutils.spawn.find_executable('espeak') if self.synthesizer: self.FAILED_VOICE = 'klatt' self.HAPPY_VOICE = 'f5' self.LASER_VOICE = 'whisper' elif platform.system() != 'Darwin': # 'say' binary available, it might be GNUstep tool which doesn't support 'voice' parameter self._display.warning("'say' executable found but system is '%s': ignoring voice parameter" % platform.system()) else: self.FAILED_VOICE = 'Zarvox' self.REGULAR_VOICE = 'Trinoids' self.HAPPY_VOICE = 'Cellos' self.LASER_VOICE = 'Princess' # plugin disable itself if say is not present # ansible will not call any callback if disabled is set to True if not self.synthesizer: self.disabled = True self._display.warning("Unable to find either 'say' or 'espeak' executable, plugin %s disabled" % os.path.basename(__file__)) def say(self, msg, voice): cmd = [self.synthesizer, msg] if voice: cmd.extend(('-v', voice)) subprocess.call(cmd) def runner_on_failed(self, host, res, ignore_errors=False): self.say("Failure on host %s" % host, self.FAILED_VOICE) def runner_on_ok(self, host, res): self.say("pew", self.LASER_VOICE) def runner_on_skipped(self, host, item=None): self.say("pew", self.LASER_VOICE) def runner_on_unreachable(self, host, res): self.say("Failure on host %s" % host, self.FAILED_VOICE) def runner_on_async_ok(self, host, res, jid): self.say("pew", self.LASER_VOICE) def runner_on_async_failed(self, host, res, jid): self.say("Failure on host %s" % host, self.FAILED_VOICE) def playbook_on_start(self): self.say("Running Playbook", self.REGULAR_VOICE) def playbook_on_notify(self, host, handler): self.say("pew", self.LASER_VOICE) def playbook_on_task_start(self, name, is_conditional): if not is_conditional: self.say("Starting task: %s" % name, self.REGULAR_VOICE) else: self.say("Notifying task: %s" % name, self.REGULAR_VOICE) def playbook_on_setup(self): self.say("Gathering facts", self.REGULAR_VOICE) def playbook_on_play_start(self, name): self.say("Starting play: %s" % name, self.HAPPY_VOICE) def playbook_on_stats(self, stats): self.say("Play complete", self.HAPPY_VOICE)