summaryrefslogtreecommitdiffstats
path: root/install/tools/ipactl
blob: 4ce26069c7891cc7200a848d9d97204612beee6b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
#!/usr/bin/python
# Authors: Simo Sorce <ssorce@redhat.com>
#
# Copyright (C) 2008-2010  Red Hat
# see file 'COPYING' for use and warranty information
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

import sys
try:
    import os
    from ipaserver.install import service
    from ipapython import sysrestore
    from ipapython import config
    from ipalib import api, errors
    import logging
    import ldap
    import ldap.sasl
    import socket
except ImportError:
    print >> sys.stderr, """\
There was a problem importing one of the required Python modules. The
error was:

    %s
""" % sys.exc_value
    sys.exit(1)

SASL_EXTERNAL = ldap.sasl.sasl({}, 'EXTERNAL')

class IpactlError(StandardError):
    def __init__(self, msg = '', rval = 1):
        self.msg = msg
        self.rval = rval

    def __str__(self):
        return self.msg

def check_IPA_configuration():
    if not sysrestore.FileStore('/var/lib/ipa/sysrestore').has_files():
        # LSB status code 6: program is not configured
        raise IpactlError("IPA is not configured " +
                          "(see man pages of ipa-server-install for help)", 6)

def parse_options():
    usage = "%prog start|stop|restart|status\n"
    parser = config.IPAOptionParser(usage=usage,
                                    formatter=config.IPAFormatter())

    parser.add_option("-d", "--debug", action="store_true", dest="debug",
                      help="Display debugging information")

    options, args = parser.parse_args()
    safe_options = parser.get_safe_opts(options)

    return safe_options, options, args

def emit_err(err):
    sys.stderr.write(err + '\n')

def get_config():
    base = "cn=%s,cn=masters,cn=ipa,cn=etc,%s" % (socket.gethostname(),
                                                  api.env.basedn)
    srcfilter = '(ipaConfigString=enabledService)'
    attrs = ['cn', 'ipaConfigString']

    try:
        con = ldap.initialize(api.env.ldap_uri)
        con.sasl_interactive_bind_s('', SASL_EXTERNAL)
        res = con.search_st(base,
                            ldap.SCOPE_SUBTREE,
                            filterstr=srcfilter,
                            attrlist=attrs,
                            timeout=10)
    except ldap.SERVER_DOWN, e:
        # LSB status code 3: program is not running
        raise IpactlError("Failed to get list of services to probe status:\n" +
                          "Directory Server is stopped", 3)
    except Exception, e:
        raise IpactlError("Unknown error when retrieving list of services from LDAP: " + str(e))

    svc_list = []

    for entry in res:
        name = entry[1]['cn'][0]
        for p in entry[1]['ipaConfigString']:
            if p.startswith('startOrder '):
                order = p.split()[1]
        svc_list.append((order, name))

    return svc_list

def ipa_start():
    try:
        print "Starting Directory Service"
        service.start('dirsrv', capture_output=False)
    except Exception, e:
        raise IpactlError("Failed to start Directory Service: " + str(e))

    svc_list = []
    try:
        svc_list = get_config()
    except Exception, e:
        emit_err("Failed to read data from Directory Service: " + str(e))
        emit_err("Shutting down")
        try:
            service.stop('dirsrv', capture_output=False)
        except:
            pass
        if isinstance(e, IpactlError):
            # do not display any other error message
            raise IpactlError(None, e.rval)
        else:
            raise IpactlError(None)

    if len(svc_list) == 0:
        # no service to stop
        return

    for (order, svc) in sorted(svc_list):
        svc_name = service.SERVICE_LIST[svc][0]
        try:
            print "Starting %s Service" % svc
            service.start(svc_name, capture_output=False)
        except:
            emit_err("Failed to start %s Service" % svc)
            emit_err("Shutting down")
            for (order, svc) in sorted(svc_list):
                svc_name = service.SERVICE_LIST[svc][0]
                try:
                    service.stop(svc_name, capture_output=False)
                except:
                    pass
            try:
                service.stop('dirsrv', capture_output=False)
            except:
                pass
            raise IpactlError("Aborting ipactl")

def ipa_stop():
    svc_list = []
    try:
        svc_list = get_config()
    except Exception, e:
        # ok if dirsrv died this may fail, so let's try to quickly restart it
        # and see if we can get anything. If not throw our hands up and just
        # exit
        try:
            service.start('dirsrv', capture_output=False)
            svc_list = get_config()
        except Exception, e:
            emit_err("Failed to read data from Directory Service: " + str(e))
            emit_err("Shutting down")
            try:
                # just try to stop it, do not read a result
                service.stop('dirsrv')
            finally:
                raise IpactlError(None)

    if len(svc_list) == 0:
        # no service to stop
        return

    for (order, svc) in sorted(svc_list, reverse=True):
        svc_name = service.SERVICE_LIST[svc][0]
        try:
            print "Stopping %s Service" % svc
            service.stop(svc_name, capture_output=False)
        except:
            emit_err("Failed to stop %s Service" % svc)

    try:
        print "Stopping Directory Service"
        service.stop('dirsrv', capture_output=False)
    except:
        raise IpactlError("Failed to stop Directory Service")


def ipa_restart():
    try:
        print "Restarting Directory Service"
        service.restart('dirsrv', capture_output=False)
    except Exception, e:
        raise IpactlError("Failed to restart Directory Service: " + str(e))

    svc_list = []
    try:
        svc_list = get_config()
    except Exception, e:
        emit_err("Failed to read data from Directory Service: " + str(e))
        emit_err("Shutting down")
        try:
            service.stop('dirsrv', capture_output=False)
        except:
            pass
        if isinstance(e, IpactlError):
            # do not display any other error message
            raise IpactlError(None, e.rval)
        else:
            raise IpactlError(None)

    if len(svc_list) == 0:
        # no service to stop
        return

    for (order, svc) in sorted(svc_list):
        svc_name = service.SERVICE_LIST[svc][0]
        try:
            print "Restarting %s Service" % svc
            service.restart(svc_name, capture_output=False)
        except:
            emit_err("Failed to restart %s Service" % svc)
            emit_err("Shutting down")
            for (order, svc) in sorted(svc_list):
                svc_name = service.SERVICE_LIST[svc][0]
                try:
                    service.stop(svc_name, capture_output=False)
                except:
                    pass
            try:
                service.stop('dirsrv', capture_output=False)
            except:
                pass
            raise IpactlError("Aborting ipactl")

def ipa_status():
    try:
        if service.is_running('dirsrv'):
            print "Directory Service: RUNNING"
        else:
            print "Directory Service: STOPPED"
    except:
        raise IpactlError("Failed to get Directory Service status")

    svc_list = []
    try:
        svc_list = get_config()
    except IpactlError, e:
        raise e
    except Exception, e:
        raise IpactlError("Failed to get list of services to probe status: " + str(e))

    if len(svc_list) == 0:
        return

    for (order, svc) in sorted(svc_list):
        svc_name = service.SERVICE_LIST[svc][0]
        try:
            if service.is_running(svc_name):
                print "%s Service: RUNNING" % svc
            else:
                print "%s Service: STOPPED" % svc
        except:
            emit_err("Failed to get %s Service status" % svc)

def main():
    if not os.getegid() == 0:
        # LSB status code 4: user had insufficient privilege
        raise IpactlError("You must be root to run ipactl.", 4)

    safe_options, options, args = parse_options()

    if len(args) != 1:
        # LSB status code 2: invalid or excess argument(s)
        raise IpactlError("You must specify one action", 2)
    elif args[0] != "start" and args[0] != "stop" and args[0] != "restart" and args[0] != "status":
        raise IpactlError("Unrecognized action [" + args[0] + "]", 2)

    # check if IPA is configured at all
    try:
        check_IPA_configuration()
    except IpactlError, e:
        if args[0].lower() == "status":
            # Different LSB return code for status command:
            # 4 - program or service status is unknown
            # This should differentiate uninstalled IPA from status
            # code 3 - program is not running
            e.rval = 4
            raise e
        else:
            raise e

    api.bootstrap(context='cli', debug=options.debug)
    api.finalize()

    if args[0].lower() == "start":
        ipa_start()
    elif args[0].lower() == "stop":
        ipa_stop()
    elif args[0].lower() == "restart":
        ipa_restart()
    elif args[0].lower() == "status":
        ipa_status()

try:
    if __name__ == "__main__":
        sys.exit(main())
except IpactlError, e:
    if e.msg:
        emit_err(e.msg)
    sys.exit(e.rval)
except RuntimeError, e:
    emit_err("%s" % e)
    sys.exit(1)
except SystemExit, e:
    sys.exit(e)
except KeyboardInterrupt, e:
    sys.exit(1)