← Back to branch summary

~blamar/+junk/openstack-api-arrrg

« back to all changes in this revision

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