summaryrefslogtreecommitdiffstats
path: root/ipalib/plugins/example.py
blob: caf963d2a815cedeaecbd1a25b7046dda5095218 (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
# Authors:
#   Jason Gerard DeRose <jderose@redhat.com>
#
# Copyright (C) 2008  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; version 2 only
#
# 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, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

"""
Some example plugins.
"""


from ipalib import public
from ipalib.api import api


# Hypothetical functional commands (not associated with any object):
class krbtest(public.cmd):
    def get_doc(self, _):
        return _('test your Kerberos ticket')
api.register(krbtest)

class discover(public.cmd):
    def get_doc(self, _):
        return _('discover IPA servers on network')
api.register(discover)


# Register some methods for the 'user' object:
class user_add(public.mthd):
    def get_doc(self, _):
        return _('add new user')
api.register(user_add)

class user_del(public.mthd):
    def get_doc(self, _):
        return _('delete existing user')
api.register(user_del)

class user_mod(public.mthd):
    def get_doc(self, _):
        return _('edit existing user')
api.register(user_mod)

class user_find(public.mthd):
    def get_doc(self, _):
        return _('search for users')
api.register(user_find)


# Register some properties for the 'user' object:
class user_givenname(public.prop):
    def get_doc(self, _):
        return _('user first name')
api.register(user_givenname)

class user_sn(public.prop):
    def get_doc(self, _):
        return _('user last name')
api.register(user_sn)

class user_login(public.prop):
    def get_doc(self, _):
        return _('user login')
    def default(self, **kw):
        givenname = kw.get('givenname', None)
        sn = kw.get('sn', None)
        if givenname is None or sn is None:
            return None
        return ('%s%s' % (givenname[0], sn)).lower()
api.register(user_login)

class user_initials(public.prop):
    def get_doc(self, _):
        return _('user initials')
    def default(self, **kw):
        givenname = kw.get('givenname', None)
        sn = kw.get('sn', None)
        if givenname is None or sn is None:
            return None
        return '%s%s' % (givenname[0], sn[0])
api.register(user_initials)


# Register some methods for the 'group' object:
class group_add(public.mthd):
    def get_doc(self, _):
        return _('add new group')
api.register(group_add)

class group_del(public.mthd):
    def get_doc(self, _):
        return _('delete existing group')
api.register(group_del)

class group_mod(public.mthd):
    def get_doc(self, _):
        return _('edit existing group')
api.register(group_mod)

class group_find(public.mthd):
    def get_doc(self, _):
        return _('search for groups')
api.register(group_find)


# Register some methods for the 'service' object
class service_add(public.mthd):
    def get_doc(self, _):
        return _('add new service')
api.register(service_add)

class service_del(public.mthd):
    def get_doc(self, _):
        return _('delete existing service')
api.register(service_del)

class service_mod(public.mthd):
    def get_doc(self, _):
        return _('edit existing service')
api.register(service_mod)

class service_find(public.mthd):
    def get_doc(self, _):
        return _('search for services')
api.register(service_find)


# And to emphasis that the registration order doesn't matter,
# we'll register the objects last:
class group(public.obj):
    def get_doc(self, _):
        return _('')
api.register(group)

class service(public.obj):
    def get_doc(self, _):
        return _('')
api.register(service)

class user(public.obj):
    def get_doc(self, _):
        return _('')
api.register(user)