community.general/lib/ansible/plugins/shell/csh.py

# Copyright (c) 2014, Chris Church <chris@ninemoreminutes.com>
# Copyright (c) 2017 Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type

from ansible.plugins.shell import ShellBase

DOCUMENTATION = '''
    name: csh
    plugin_type: shell
    version_added: ""
    short_description: C shell (/bin/csh)
    description:
      - When you have no other option than to use csh
    extends_documentation_fragment:
      - shell_common
'''


class ShellModule(ShellBase):

    # Common shell filenames that this plugin handles
    COMPATIBLE_SHELLS = frozenset(('csh', 'tcsh'))
    # Family of shells this has.  Must match the filename without extension
    SHELL_FAMILY = 'csh'

    # How to end lines in a python script one-liner
    _SHELL_EMBEDDED_PY_EOL = '\\\n'
    _SHELL_REDIRECT_ALLNULL = '>& /dev/null'
    _SHELL_AND = '&&'
    _SHELL_OR = '||'
    _SHELL_SUB_LEFT = '"`'
    _SHELL_SUB_RIGHT = '`"'
    _SHELL_GROUP_LEFT = '('
    _SHELL_GROUP_RIGHT = ')'

    def env_prefix(self, **kwargs):
        return 'env %s' % super(ShellModule, self).env_prefix(**kwargs)
Temporary (#31677) * allow shells to have per host options, remote_tmp added language to shell removed module lang setting from general as plugins have it now use get to avoid bad powershell plugin more resilient tmp discovery, fall back to `pwd` add shell to docs fixed options for when frags are only options added shell set ops in t_e and fixed option frags normalize tmp dir usag4e - pass tmpdir/tmp/temp options as env var to commands, making it default for tempfile - adjusted ansiballz tmpdir - default local tempfile usage to the configured local tmp - set env temp in action add options to powershell shift temporary to internal envvar/params ensure tempdir is set if we pass var ensure basic and url use expected tempdir ensure localhost uses local tmp give /var/tmp priority, less perms issues more consistent tempfile mgmt for ansiballz made async_dir configurable better action handling, allow for finally rm tmp fixed tmp issue and no more tempdir in ballz hostvarize world readable and admin users always set shell tempdir added comment to discourage use of exception/flow control * Mostly revert expand_user as it's not quite working. This was an additional feature anyhow. Kept the use of pwd as a fallback but moved it to a second ssh connection. This is not optimal but getting that to work in a single ssh connection was part of the problem holding this up. (cherry picked from commit 395b714120522f15e4c90a346f5e8e8d79213aca) * fixed script and other action plugins ensure tmpdir deletion allow for connections that don't support new options (legacy, 3rd party) fixed tests 2018-01-16 05:15:04 +00:00			`# Copyright (c) 2014, Chris Church <chris@ninemoreminutes.com>`
			`# Copyright (c) 2017 Ansible Project`
			`# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)`
Import futures including print 2015-04-13 20:28:01 +00:00			`from __future__ import (absolute_import, division, print_function)`
			`__metaclass__ = type`
Give all v2 tests the python3 compat boilerplate 2014-10-15 23:25:48 +00:00
moved to base class for shell plugins fish now sets env vars correctly fish checksum now works fixed and cleaned up imports fixed typo 2016-02-05 05:39:09 +00:00			`from ansible.plugins.shell import ShellBase`
Give all v2 tests the python3 compat boilerplate 2014-10-15 23:25:48 +00:00
Temporary (#31677) * allow shells to have per host options, remote_tmp added language to shell removed module lang setting from general as plugins have it now use get to avoid bad powershell plugin more resilient tmp discovery, fall back to `pwd` add shell to docs fixed options for when frags are only options added shell set ops in t_e and fixed option frags normalize tmp dir usag4e - pass tmpdir/tmp/temp options as env var to commands, making it default for tempfile - adjusted ansiballz tmpdir - default local tempfile usage to the configured local tmp - set env temp in action add options to powershell shift temporary to internal envvar/params ensure tempdir is set if we pass var ensure basic and url use expected tempdir ensure localhost uses local tmp give /var/tmp priority, less perms issues more consistent tempfile mgmt for ansiballz made async_dir configurable better action handling, allow for finally rm tmp fixed tmp issue and no more tempdir in ballz hostvarize world readable and admin users always set shell tempdir added comment to discourage use of exception/flow control * Mostly revert expand_user as it's not quite working. This was an additional feature anyhow. Kept the use of pwd as a fallback but moved it to a second ssh connection. This is not optimal but getting that to work in a single ssh connection was part of the problem holding this up. (cherry picked from commit 395b714120522f15e4c90a346f5e8e8d79213aca) * fixed script and other action plugins ensure tmpdir deletion allow for connections that don't support new options (legacy, 3rd party) fixed tests 2018-01-16 05:15:04 +00:00			`DOCUMENTATION = '''`
			`name: csh`
			`plugin_type: shell`
			`version_added: ""`
			`short_description: C shell (/bin/csh)`
			`description:`
			`- When you have no other option than to use csh`
			`extends_documentation_fragment:`
			`- shell_common`
			`'''`

Collated PEP8 fixes (#25293) - Make PEP8 compliant 2017-06-02 11:14:11 +00:00
moved to base class for shell plugins fish now sets env vars correctly fish checksum now works fixed and cleaned up imports fixed typo 2016-02-05 05:39:09 +00:00			`class ShellModule(ShellBase):`
Creating playbook executor and dependent classes 2014-11-14 22:14:08 +00:00
Establish sh as the default shell plugin. This is a fix for one of the problems pointed out in #14176 2016-02-02 19:46:09 +00:00			`# Common shell filenames that this plugin handles`
			`COMPATIBLE_SHELLS = frozenset(('csh', 'tcsh'))`
			`# Family of shells this has. Must match the filename without extension`
			`SHELL_FAMILY = 'csh'`

Port changes from #10372 fixing checksumming on csh and backslashes in filenames to v2 2015-03-03 00:08:08 +00:00			`# How to end lines in a python script one-liner`
			`_SHELL_EMBEDDED_PY_EOL = '\\\n'`
fix issues with csh redirection 2015-08-30 21:48:09 +00:00			`_SHELL_REDIRECT_ALLNULL = '>& /dev/null'`
moved to base class for shell plugins fish now sets env vars correctly fish checksum now works fixed and cleaned up imports fixed typo 2016-02-05 05:39:09 +00:00			`_SHELL_AND = '&&'`
			`_SHELL_OR = '\|\|'`
changed shell delimiters for csh fixes #13459 2015-12-12 21:10:18 +00:00			_SHELL_SUB_LEFT = '"`'
			_SHELL_SUB_RIGHT = '`"'
moved to base class for shell plugins fish now sets env vars correctly fish checksum now works fixed and cleaned up imports fixed typo 2016-02-05 05:39:09 +00:00			`_SHELL_GROUP_LEFT = '('`
			`_SHELL_GROUP_RIGHT = ')'`
Port changes from #10372 fixing checksumming on csh and backslashes in filenames to v2 2015-03-03 00:08:08 +00:00
Creating playbook executor and dependent classes 2014-11-14 22:14:08 +00:00			`def env_prefix(self, **kwargs):`
			`return 'env %s' % super(ShellModule, self).env_prefix(**kwargs)`