~ntt-pf-lab/nova/monkey_patch_notification

<?xml version="1.0" encoding="utf-8"?><!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'><html lang="en" xmlns="http://www.w3.org/1999/xhtml">

<head>

<title>Twisted Documentation: The Evolution of Finger: using a single factory for

multiple protocols</title>

</head>

<h1 class="title">The Evolution of Finger: using a single factory for

multiple protocols</h1>

<div class="toc"><ol><li><a href="#auto0">Introduction</a></li><li><a href="#auto1">Support HTTPS</a></li></ol></div>

<h2>Introduction<a name="auto0"/></h2>

This is the eighth part of the Twisted tutorial <a href="index.html" shape="rect">Twisted from Scratch, or The Evolution of Finger</a>.

In this part, we add HTTPS support to our web frontend, showing how to have a

single factory listen on multiple ports. More information on using SSL in

Twisted can be found in the <a href="../ssl.html" shape="rect">SSL howto</a>.

<h2>Support HTTPS<a name="auto1"/></h2>

All we need to do to code an HTTPS site is just write a context factory (in

this case, which loads the certificate from a certain file) and then use the

twisted.application.internet.SSLServer method. Note that one factory (in this

case, a site) can listen on multiple ports with multiple protocols.

<div class="py-listing"><pre> 1

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

100

131

101

132

102

133

103

134

104

135

105

136

106

137

107

138

108

139

109

140

110

141

111

142

112

143

113

144

114

145

115

146

116

147

117

148

118

149

119

150

120

151

121

152

122

153

123

154

124

155

125

156

126

157

127

158

128

159

129

160

130

161

131

162

132

163

133

164

134

165

135

166

136

167

137

168

138

169

139

170

140

171

141

172

142

173

143

174

144

175

145

176

146

177

147

178

148

179

149

180

150

181

151

182

152

183

153

184

154

185

155

186

156

187

157

188

158

189

159

190

160

191

161

192

162

193

163

194

164

195

165

196

166

197

167

198

168

199

169

200

170

201

171

202

172

203

173

204

174

205

175

206

176

207

177

208

178

209

179

210

180

211

181

212

182

213

183

214

184

215

185

216

186

217

187

218

188

219

189

220

190

221

191

222

192

223

193

224

194

225

195

226

196

227

197

228

198

229

199

230

200

231

201

232

202

233

203

234

204

235

205

236

206

237

207

238

208

239

209

240

210

241

211

242

212

243

213

244

214

245

215

246

216

247

217

248

218

249

219

250

220

251

221

252

222

253

223

254

224

255

225

256

226

257

227

258

228

259

229

260

230

261

231

262

232

263

233

264

234

265

235

266

236

267

237

268

238

269

239

270

240

271

241

272

242

273

243

274

244

275

245

276

246

277

247

278

248

279

249

280

250

281

251

282

252

283

253

284

254

285

255

286

256

287

257

288

258

289

259

290

260

291

261

292

262

293

263

294

264

295

265

296

266

297

267

298

268

299

269

300

270

301

271

302

272

303

273

304

274

305

275

306

276

307

277

308

278

309

279

310

280

311

281

312

282

313

283

314

284

315

285

316

286

317

287

318

288

319

289

320

290

321

291

322

292

323

293

324

294

325

295

326

296

327

297

328

# Do everything properly, and componentize

329

from twisted.application import internet, service

330

from twisted.internet import protocol, reactor, defer

331

from twisted.words.protocols import irc

332

from twisted.protocols import basic

333

from twisted.python import components

334

from twisted.web import resource, server, static, xmlrpc, microdom

335

from twisted.spread import pb

336

from zope.interface import Interface, implements

337

from OpenSSL import SSL

338

import cgi

339

340

class IFingerService(Interface):

341

342

def getUser(user):

343

"""Return a deferred returning a string"""

344

345

def getUsers():

346

"""Return a deferred returning a list of strings"""

347

348

class IFingerSetterService(Interface):

349

350

def setUser(user, status):

351

"""Set the user's status to something"""

352

353

def catchError(err):

354

return "Internal error in server"

355

356

class FingerProtocol(basic.LineReceiver):

357

358

def lineReceived(self, user):

359

d = self.factory.getUser(user)

360

d.addErrback(catchError)

361

def writeValue(value):

362

self.transport.write(value+'\r\n')

363

self.transport.loseConnection()

364

d.addCallback(writeValue)

365

366

367

class IFingerFactory(Interface):

368

369

def getUser(user):

370

"""Return a deferred returning a string"""

371

372

def buildProtocol(addr):

373

"""Return a protocol returning a string"""

374

375

376

class FingerFactoryFromService(protocol.ServerFactory):

377

378

implements(IFingerFactory)

379

380

protocol = FingerProtocol

381

382

def __init__(self, service):

383

self.service = service

384

385

def getUser(self, user):

386

return self.service.getUser(user)

387

388

components.registerAdapter(FingerFactoryFromService,

389

IFingerService,

390

IFingerFactory)

391

392

class FingerSetterProtocol(basic.LineReceiver):

393

394

def connectionMade(self):

395

self.lines = []

396

397

def lineReceived(self, line):

398

self.lines.append(line)

399

400

def connectionLost(self, reason):

401

if len(self.lines) == 2:

402

self.factory.setUser(*self.lines)

403

404

405

class IFingerSetterFactory(Interface):

406

407

def setUser(user, status):

408

"""Return a deferred returning a string"""

409

410

def buildProtocol(addr):

411

"""Return a protocol returning a string"""

412

413

414

class FingerSetterFactoryFromService(protocol.ServerFactory):

415

416

implements(IFingerSetterFactory)

417

418

protocol = FingerSetterProtocol

419

420

def __init__(self, service):

421

self.service = service

422

423

def setUser(self, user, status):

424

self.service.setUser(user, status)

425

426

427

components.registerAdapter(FingerSetterFactoryFromService,

428

IFingerSetterService,

429

IFingerSetterFactory)

430

431

class IRCReplyBot(irc.IRCClient):

432

433

def connectionMade(self):

434

self.nickname = self.factory.nickname

435

irc.IRCClient.connectionMade(self)

436

437

def privmsg(self, user, channel, msg):

438

user = user.split('!')[0]

439

if self.nickname.lower() == channel.lower():

440

441

d.addErrback(catchError)

442

d.addCallback(lambda m: "Status of %s: %s" % (msg, m))

443

d.addCallback(lambda m: self.msg(user, m))

444

445

446

class IIRCClientFactory(Interface):

447

448

"""

449

@ivar nickname

450

"""

451

452

def getUser(user):

453

"""Return a deferred returning a string"""

454

455

def buildProtocol(addr):

456

"""Return a protocol"""

457

458

459

class IRCClientFactoryFromService(protocol.ClientFactory):

460

461

implements(IIRCClientFactory)

462

463

protocol = IRCReplyBot

464

nickname = None

465

466

def __init__(self, service):

467

self.service = service

468

469

def getUser(self, user):

470

471

472

components.registerAdapter(IRCClientFactoryFromService,

473

IFingerService,

474

IIRCClientFactory)

475

476

class UserStatusTree(resource.Resource):

477

478

def __init__(self, service):

479

resource.Resource.__init__(self)

480

self.service=service

481

482

# add a specific child for the path "RPC2"

483

self.putChild("RPC2", UserStatusXR(self.service))

484

485

# need to do this for resources at the root of the site

486

self.putChild("", self)

487

488

def _cb_render_GET(self, users, request):

489

userOutput = ''.join(["<li><a href=\"%s\">%s</a></li>" % (user, user)

490

for user in users])

491

request.write("""

492

<html><head><title>Users</title></head><body>

493

<h1>Users</h1>

494

<ul>

495

496

</ul></body></html>""" % userOutput)

497

request.finish()

498

499

def render_GET(self, request):

500

d = self.service.getUsers()

501

d.addCallback(self._cb_render_GET, request)

502

503

# signal that the rendering is not complete

504

return server.NOT_DONE_YET

505

506

def getChild(self, path, request):

507

return UserStatus(user=path, service=self.service)

508

509

components.registerAdapter(UserStatusTree, IFingerService, resource.IResource)

510

511

class UserStatus(resource.Resource):

512

513

def __init__(self, user, service):

514

resource.Resource.__init__(self)

515

self.user = user

516

self.service = service

517

518

def _cb_render_GET(self, status, request):

519

request.write("""<html><head><title>%s</title></head>

520

521

%s

522

</body></html>""" % (self.user, self.user, status))

523

request.finish()

524

525

def render_GET(self, request):

526

d = self.service.getUser(self.user)

527

528

529

# signal that the rendering is not complete

530

return server.NOT_DONE_YET

531

532

class UserStatusXR(xmlrpc.XMLRPC):

533

534

def __init__(self, service):

535

xmlrpc.XMLRPC.__init__(self)

536

self.service = service

537

538

def xmlrpc_getUser(self, user):

539

540

541

def xmlrpc_getUsers(self):

542

return self.service.getUsers()

543

544

545

class IPerspectiveFinger(Interface):

546

547

def remote_getUser(username):

548

"""return a user's status"""

549

550

def remote_getUsers():

551

"""return a user's status"""

552

553

class PerspectiveFingerFromService(pb.Root):

554

555

implements(IPerspectiveFinger)

556

557

def __init__(self, service):

558

self.service = service

559

560

def remote_getUser(self, username):

561

562

563

def remote_getUsers(self):

564

return self.service.getUsers()

565

566

components.registerAdapter(PerspectiveFingerFromService,

567

IFingerService,

568

IPerspectiveFinger)

569

570

571

class FingerService(service.Service):

572

573

implements(IFingerService)

574

575

def __init__(self, filename):

576

self.filename = filename

577

self.users = {}

578

self._read()

579

580

def _read(self):

581

self.users.clear()

582

for line in file(self.filename):

583

user, status = line.split(':', 1)

584

user = user.strip()

585

status = status.strip()

586

self.users[user] = status

587

self.call = reactor.callLater(30, self._read)

588

589

def getUser(self, user):

590

return defer.succeed(self.users.get(user, "No such user"))

591

592

def getUsers(self):

593

594

595

596

class ServerContextFactory:

597

598

def getContext(self):

599

"""Create an SSL context.

600

601

This is a sample implementation that loads a certificate from a file

602

called 'server.pem'."""

603

ctx = SSL.Context(SSL.SSLv23_METHOD)

604

ctx.use_certificate_file('server.pem')

605

ctx.use_privatekey_file('server.pem')

606

return ctx

607

608

609

application = service.Application('finger', uid=1, gid=1)

610

f = FingerService('/etc/users')

611

serviceCollection = service.IServiceCollection(application)

612

internet.TCPServer(79, IFingerFactory(f)

613

).setServiceParent(serviceCollection)

614

site = server.Site(resource.IResource(f))

615

internet.TCPServer(8000, site

616

).setServiceParent(serviceCollection)

617

internet.SSLServer(443, site, ServerContextFactory()

618

).setServiceParent(serviceCollection)

619

i = IIRCClientFactory(f)

620

i.nickname = 'fingerbot'

621

internet.TCPClient('irc.freenode.org', 6667, i

622

).setServiceParent(serviceCollection)

623

internet.TCPServer(8889, pb.PBServerFactory(IPerspectiveFinger(f))

624

).setServiceParent(serviceCollection)

625

</pre><div class="caption">Source listing - <a href="listings/finger/finger22.py">listings/finger/finger22.py</a></div></div>

626

627

628

</div>

629

630

<a href="../index.html">Index</a>

631

Version: 10.0.0

632

</body>

633

</html>

b'\\ No newline at end of file'

Older »