← Back to branch summary

~justin-fathomdb/nova/justinsb-openstack-api-volumes

« back to all changes in this revision

Viewing changes to vendor/Twisted-10.0.0/doc/core/howto/tutorial/listings/finger/finger19b.tac

  • Committer: Jesse Andrews
  • Date: 2010-05-28 06:05:26 UTC
  • Revision ID: git-v1:bf6e6e718cdc7488e2da87b21e258ccc065fe499
initial commit

Show diffs side-by-side

added added

removed removed

Lines of Context:
vendor/Twisted-10.0.0/doc/core/howto/tutorial/listings/finger/finger19b.tac
 
1
# Do everything properly, and componentize
 
2
from twisted.application import internet, service
 
3
from twisted.internet import protocol, reactor, defer, utils
 
4
from twisted.words.protocols import irc
 
5
from twisted.protocols import basic
 
6
from twisted.python import components
 
7
from twisted.web import resource, server, static, xmlrpc
 
8
from zope.interface import Interface, implements
 
9
import cgi
 
10
import pwd
 
11
 
 
12
class IFingerService(Interface):
 
13
 
 
14
    def getUser(user):
 
15
        """Return a deferred returning a string"""
 
16
 
 
17
    def getUsers():
 
18
        """Return a deferred returning a list of strings"""
 
19
 
 
20
class IFingerSetterService(Interface):
 
21
 
 
22
    def setUser(user, status):
 
23
        """Set the user's status to something"""
 
24
 
 
25
class IFingerSetterService(Interface):
 
26
 
 
27
    def setUser(user, status):
 
28
        """Set the user's status to something"""
 
29
 
 
30
def catchError(err):
 
31
    return "Internal error in server"
 
32
 
 
33
class FingerProtocol(basic.LineReceiver):
 
34
 
 
35
    def lineReceived(self, user):
 
36
        d = self.factory.getUser(user)
 
37
        d.addErrback(catchError)
 
38
        def writeValue(value):
 
39
            self.transport.write(value+'\r\n')
 
40
            self.transport.loseConnection()
 
41
        d.addCallback(writeValue)
 
42
 
 
43
 
 
44
class IFingerFactory(Interface):
 
45
 
 
46
    def getUser(user):
 
47
        """Return a deferred returning a string"""
 
48
 
 
49
    def buildProtocol(addr):
 
50
        """Return a protocol returning a string"""
 
51
 
 
52
 
 
53
class FingerFactoryFromService(protocol.ServerFactory):
 
54
 
 
55
    implements(IFingerFactory)
 
56
 
 
57
    protocol = FingerProtocol
 
58
 
 
59
    def __init__(self, service):
 
60
        self.service = service
 
61
 
 
62
    def getUser(self, user):
 
63
        return self.service.getUser(user)
 
64
 
 
65
components.registerAdapter(FingerFactoryFromService,
 
66
                           IFingerService,
 
67
                           IFingerFactory)
 
68
 
 
69
class FingerSetterProtocol(basic.LineReceiver):
 
70
 
 
71
    def connectionMade(self):
 
72
        self.lines = []
 
73
 
 
74
    def lineReceived(self, line):
 
75
        self.lines.append(line)
 
76
 
 
77
    def connectionLost(self, reason):
 
78
        if len(self.lines) == 2:
 
79
            self.factory.setUser(*self.lines)
 
80
 
 
81
 
 
82
class IFingerSetterFactory(Interface):
 
83
 
 
84
    def setUser(user, status):
 
85
        """Return a deferred returning a string"""
 
86
 
 
87
    def buildProtocol(addr):
 
88
        """Return a protocol returning a string"""
 
89
 
 
90
 
 
91
class FingerSetterFactoryFromService(protocol.ServerFactory):
 
92
 
 
93
    implements(IFingerSetterFactory)
 
94
 
 
95
    protocol = FingerSetterProtocol
 
96
 
 
97
    def __init__(self, service):
 
98
        self.service = service
 
99
 
 
100
    def setUser(self, user, status):
 
101
        self.service.setUser(user, status)
 
102
 
 
103
 
 
104
components.registerAdapter(FingerSetterFactoryFromService,
 
105
                           IFingerSetterService,
 
106
                           IFingerSetterFactory)
 
107
 
 
108
class IRCReplyBot(irc.IRCClient):
 
109
 
 
110
    def connectionMade(self):
 
111
        self.nickname = self.factory.nickname
 
112
        irc.IRCClient.connectionMade(self)
 
113
 
 
114
    def privmsg(self, user, channel, msg):
 
115
        user = user.split('!')[0]
 
116
        if self.nickname.lower() == channel.lower():
 
117
            d = self.factory.getUser(msg)
 
118
            d.addErrback(catchError)
 
119
            d.addCallback(lambda m: "Status of %s: %s" % (msg, m))
 
120
            d.addCallback(lambda m: self.msg(user, m))
 
121
 
 
122
 
 
123
class IIRCClientFactory(Interface):
 
124
 
 
125
    """
 
126
    @ivar nickname
 
127
    """
 
128
 
 
129
    def getUser(user):
 
130
        """Return a deferred returning a string"""
 
131
 
 
132
    def buildProtocol(addr):
 
133
        """Return a protocol"""
 
134
 
 
135
 
 
136
class IRCClientFactoryFromService(protocol.ClientFactory):
 
137
 
 
138
    implements(IIRCClientFactory)
 
139
 
 
140
    protocol = IRCReplyBot
 
141
    nickname = None
 
142
 
 
143
    def __init__(self, service):
 
144
        self.service = service
 
145
 
 
146
    def getUser(self, user):
 
147
        return self.service.getUser(user)
 
148
 
 
149
components.registerAdapter(IRCClientFactoryFromService,
 
150
                           IFingerService,
 
151
                           IIRCClientFactory)
 
152
 
 
153
class UserStatusTree(resource.Resource):
 
154
 
 
155
    implements(resource.IResource)
 
156
 
 
157
    def __init__(self, service):
 
158
        resource.Resource.__init__(self)
 
159
        self.service = service
 
160
        self.putChild('RPC2', UserStatusXR(self.service))
 
161
 
 
162
    def render_GET(self, request):
 
163
        d = self.service.getUsers()
 
164
        def formatUsers(users):
 
165
            l = ['<li><a href="%s">%s</a></li>' % (user, user)
 
166
                 for user in users]
 
167
            return '<ul>'+''.join(l)+'</ul>'
 
168
        d.addCallback(formatUsers)
 
169
        d.addCallback(request.write)
 
170
        d.addCallback(lambda _: request.finish())
 
171
        return server.NOT_DONE_YET
 
172
 
 
173
    def getChild(self, path, request):
 
174
        if path=="":
 
175
            return UserStatusTree(self.service)
 
176
        else:
 
177
            return UserStatus(path, self.service)
 
178
 
 
179
components.registerAdapter(UserStatusTree, IFingerService,
 
180
                           resource.IResource)
 
181
 
 
182
class UserStatus(resource.Resource):
 
183
 
 
184
    def __init__(self, user, service):
 
185
        resource.Resource.__init__(self)
 
186
        self.user = user
 
187
        self.service = service
 
188
 
 
189
    def render_GET(self, request):
 
190
        d = self.service.getUser(self.user)
 
191
        d.addCallback(cgi.escape)
 
192
        d.addCallback(lambda m:
 
193
                      '<h1>%s</h1>'%self.user+'<p>%s</p>'%m)
 
194
        d.addCallback(request.write)
 
195
        d.addCallback(lambda _: request.finish())
 
196
        return server.NOT_DONE_YET
 
197
 
 
198
 
 
199
class UserStatusXR(xmlrpc.XMLRPC):
 
200
 
 
201
    def __init__(self, service):
 
202
        xmlrpc.XMLRPC.__init__(self)
 
203
        self.service = service
 
204
 
 
205
    def xmlrpc_getUser(self, user):
 
206
        return self.service.getUser(user)
 
207
 
 
208
 
 
209
class FingerService(service.Service):
 
210
 
 
211
    implements(IFingerService)
 
212
 
 
213
    def __init__(self, filename):
 
214
        self.filename = filename
 
215
        self.users = {}
 
216
        self._read()
 
217
 
 
218
    def _read(self):
 
219
        self.users.clear()
 
220
        for line in file(self.filename):
 
221
            user, status = line.split(':', 1)
 
222
            user = user.strip()
 
223
            status = status.strip()
 
224
            self.users[user] = status
 
225
        self.call = reactor.callLater(30, self._read)
 
226
 
 
227
    def getUser(self, user):
 
228
        return defer.succeed(self.users.get(user, "No such user"))
 
229
 
 
230
    def getUsers(self):
 
231
        return defer.succeed(self.users.keys())
 
232
 
 
233
# Another back-end
 
234
 
 
235
class LocalFingerService(service.Service):
 
236
 
 
237
    implements(IFingerService)
 
238
 
 
239
    def getUser(self, user):
 
240
    # need a local finger daemon running for this to work
 
241
        return utils.getProcessOutput("finger", [user])
 
242
 
 
243
    def getUsers(self):
 
244
        return defer.succeed([])
 
245
 
 
246
 
 
247
application = service.Application('finger', uid=1, gid=1)
 
248
f = LocalFingerService()
 
249
serviceCollection = service.IServiceCollection(application)
 
250
internet.TCPServer(79, IFingerFactory(f)
 
251
                   ).setServiceParent(serviceCollection)
 
252
internet.TCPServer(8000, server.Site(resource.IResource(f))
 
253
                   ).setServiceParent(serviceCollection)
 
254
i = IIRCClientFactory(f)
 
255
i.nickname = 'fingerbot'
 
256
internet.TCPClient('irc.freenode.org', 6667, i
 
257
                   ).setServiceParent(serviceCollection)