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

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

# This file is part of Buildbot.  Buildbot 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. 

# 

# 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., 51 

# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 

# 

# Copyright Buildbot Team Members 

 

 

from twisted.web import html 

import urllib, time 

from twisted.python import log 

from twisted.internet import defer 

from buildbot import interfaces 

from buildbot.status.web.base import HtmlResource, BuildLineMixin, \ 

    path_to_build, path_to_slave, path_to_builder, path_to_change, \ 

    path_to_root, ICurrentBox, build_get_class, \ 

    map_branches, path_to_authzfail, ActionResource, \ 

    getRequestCharset 

from buildbot.schedulers.forcesched import ForceScheduler 

from buildbot.schedulers.forcesched import InheritBuildParameter 

from buildbot.schedulers.forcesched import ValidationError 

from buildbot.status.web.build import BuildsResource, StatusResourceBuild 

from buildbot import util 

 

class ForceAllBuildsActionResource(ActionResource): 

 

    def __init__(self, status, selectedOrAll): 

        self.status = status 

        self.selectedOrAll = selectedOrAll 

        self.action = "forceAllBuilds" 

 

    @defer.inlineCallbacks 

    def performAction(self, req): 

        authz = self.getAuthz(req) 

        res = yield authz.actionAllowed('forceAllBuilds', req) 

 

        if not res: 

            defer.returnValue(path_to_authzfail(req)) 

            return 

 

        builders = None 

        if self.selectedOrAll == 'all': 

            builders = self.status.getBuilderNames() 

        elif self.selectedOrAll == 'selected': 

            builders = [b for b in req.args.get("selected", []) if b] 

 

        for bname in builders: 

            builder_status = self.status.getBuilder(bname) 

            ar = ForceBuildActionResource(builder_status) 

            d = ar.performAction(req) 

            d.addErrback(log.err, "(ignored) while trying to force build") 

        # back to the welcome page 

        defer.returnValue(path_to_root(req)) 

 

class StopAllBuildsActionResource(ActionResource): 

 

    def __init__(self, status, selectedOrAll): 

        self.status = status 

        self.selectedOrAll = selectedOrAll 

        self.action = "stopAllBuilds" 

 

    @defer.inlineCallbacks 

    def performAction(self, req): 

        authz = self.getAuthz(req) 

        res = yield authz.actionAllowed('stopAllBuilds', req) 

        if not res: 

            defer.returnValue(path_to_authzfail(req)) 

            return 

 

        builders = None 

        if self.selectedOrAll == 'all': 

            builders = self.status.getBuilderNames() 

        elif self.selectedOrAll == 'selected': 

            builders = [b for b in req.args.get("selected", []) if b] 

 

        for bname in builders: 

            builder_status = self.status.getBuilder(bname) 

            (state, current_builds) = builder_status.getState() 

            if state != "building": 

                continue 

            for b in current_builds: 

                build_status = builder_status.getBuild(b.number) 

                if not build_status: 

                    continue 

                build = StatusResourceBuild(build_status) 

                build.stop(req, auth_ok=True) 

 

        # go back to the welcome page 

        defer.returnValue(path_to_root(req)) 

 

class PingBuilderActionResource(ActionResource): 

 

    def __init__(self, builder_status): 

        self.builder_status = builder_status 

        self.action = "pingBuilder" 

 

    @defer.inlineCallbacks 

    def performAction(self, req): 

        log.msg("web ping of builder '%s'" % self.builder_status.getName()) 

        res = yield self.getAuthz(req).actionAllowed('pingBuilder', req, 

                                                    self.builder_status) 

        if not res: 

            log.msg("..but not authorized") 

            defer.returnValue(path_to_authzfail(req)) 

            return 

 

        c = interfaces.IControl(self.getBuildmaster(req)) 

        bc = c.getBuilder(self.builder_status.getName()) 

        bc.ping() 

        # send the user back to the builder page 

        defer.returnValue(path_to_builder(req, self.builder_status)) 

 

class ForceBuildActionResource(ActionResource): 

 

    def __init__(self, builder_status): 

        self.builder_status = builder_status 

        self.action = "forceBuild" 

 

    @defer.inlineCallbacks 

    def performAction(self, req): 

        # check if this is allowed 

        res = yield self.getAuthz(req).actionAllowed(self.action, req, 

                                             self.builder_status) 

        if not res: 

            log.msg("..but not authorized") 

            defer.returnValue(path_to_authzfail(req)) 

            return 

 

        master = self.getBuildmaster(req) 

        owner = self.getAuthz(req).getUsernameFull(req) 

        schedulername = req.args.get("forcescheduler", ["<unknown>"])[0] 

        if schedulername == "<unknown>": 

            defer.returnValue((path_to_builder(req, self.builder_status), 

                               "forcescheduler arg not found")) 

            return 

 

        args = req.args.copy() 

 

        # decode all of the args 

        encoding = getRequestCharset(req) 

        for name, argl in args.iteritems(): 

            args[name] = [ arg.decode(encoding) for arg in argl ] 

 

        # damn html's ungeneric checkbox implementation... 

        for cb in args.get("checkbox", []): 

            args[cb] = True 

 

        builder_name = self.builder_status.getName() 

 

        for sch in master.allSchedulers(): 

            if schedulername == sch.name: 

                try: 

                    yield sch.force(owner, builder_name, **args) 

                    msg = "" 

                except ValidationError, e: 

                    msg = html.escape(e.message.encode('ascii','ignore')) 

                break 

 

        # send the user back to the builder page 

        defer.returnValue((path_to_builder(req, self.builder_status), msg)) 

 

 

def buildForceContext(cxt, req, master, buildername=None): 

    force_schedulers = {} 

    default_props = {} 

    for sch in master.allSchedulers(): 

        if isinstance(sch, ForceScheduler) and (buildername is None or(buildername in sch.builderNames)): 

            force_schedulers[sch.name] = sch 

            for p in sch.all_fields: 

                pname = "%s.%s"%(sch.name, p.name) 

                default = p.default 

                if isinstance(p, InheritBuildParameter): 

                    # yes, I know, its bad to overwrite the parameter attribute, 

                    # but I dont have any other simple way of doing this atm. 

                    p.choices = p.compatible_builds(master.status, buildername) 

                    if p.choices: 

                        default = p.choices[0] 

                default = req.args.get(pname, [default])[0] 

                if p.type=="bool": 

                    default_props[pname] = default and "checked" or "" 

                else: 

                    # filter out unicode chars, and html stuff 

                    if type(default)==unicode: 

                        default = html.escape(default.encode('utf-8','ignore')) 

                    default_props[pname] = default 

    cxt['force_schedulers'] = force_schedulers 

    cxt['default_props'] = default_props 

 

# /builders/$builder 

class StatusResourceBuilder(HtmlResource, BuildLineMixin): 

    addSlash = True 

 

    def __init__(self, builder_status): 

        HtmlResource.__init__(self) 

        self.builder_status = builder_status 

 

    def getPageTitle(self, request): 

        return "Buildbot: %s" % self.builder_status.getName() 

 

    def builder(self, build, req): 

        b = {} 

 

        b['num'] = build.getNumber() 

        b['link'] = path_to_build(req, build) 

 

        when = build.getETA() 

        if when is not None: 

            b['when'] = util.formatInterval(when) 

            b['when_time'] = time.strftime("%H:%M:%S", 

                                      time.localtime(time.time() + when)) 

 

        step = build.getCurrentStep() 

        # TODO: is this necessarily the case? 

        if not step: 

            b['current_step'] = "[waiting for Lock]" 

        else: 

            if step.isWaitingForLocks(): 

                b['current_step'] = "%s [waiting for Lock]" % step.getName() 

            else: 

                b['current_step'] = step.getName() 

 

        b['stop_url'] = path_to_build(req, build) + '/stop' 

 

        return b 

 

    @defer.inlineCallbacks 

    def content(self, req, cxt): 

        b = self.builder_status 

 

        cxt['name'] = b.getName() 

        req.setHeader('Cache-Control', 'no-cache') 

        slaves = b.getSlaves() 

        connected_slaves = [s for s in slaves if s.isConnected()] 

 

        cxt['current'] = [self.builder(x, req) for x in b.getCurrentBuilds()] 

 

        cxt['pending'] = [] 

        statuses = yield b.getPendingBuildRequestStatuses() 

        for pb in statuses: 

            changes = [] 

 

            source = yield pb.getSourceStamp() 

            submitTime = yield pb.getSubmitTime() 

            bsid = yield pb.getBsid() 

 

            properties = yield \ 

                    pb.master.db.buildsets.getBuildsetProperties(bsid) 

 

            if source.changes: 

                for c in source.changes: 

                    changes.append({ 'url' : path_to_change(req, c), 

                                     'who' : c.who, 

                                     'revision' : c.revision, 

                                     'repo' : c.repository }) 

 

            cxt['pending'].append({ 

                'when': time.strftime("%b %d %H:%M:%S", 

                                      time.localtime(submitTime)), 

                'delay': util.formatInterval(util.now() - submitTime), 

                'id': pb.brid, 

                'changes' : changes, 

                'num_changes' : len(changes), 

                'properties' : properties, 

                }) 

 

        numbuilds = int(req.args.get('numbuilds', ['5'])[0]) 

        recent = cxt['recent'] = [] 

        for build in b.generateFinishedBuilds(num_builds=int(numbuilds)): 

            recent.append(self.get_line_values(req, build, False)) 

 

        sl = cxt['slaves'] = [] 

        connected_slaves = 0 

        for slave in slaves: 

            s = {} 

            sl.append(s) 

            s['link'] = path_to_slave(req, slave) 

            s['name'] = slave.getName() 

            c = s['connected'] = slave.isConnected() 

            if c: 

                s['admin'] = unicode(slave.getAdmin() or '', 'utf-8') 

                connected_slaves += 1 

        cxt['connected_slaves'] = connected_slaves 

 

        cxt['authz'] = self.getAuthz(req) 

        cxt['builder_url'] = path_to_builder(req, b) 

        buildForceContext(cxt, req, self.getBuildmaster(req), b.getName()) 

        template = req.site.buildbot_service.templates.get_template("builder.html") 

        defer.returnValue(template.render(**cxt)) 

 

    def ping(self, req): 

        return PingBuilderActionResource(self.builder_status) 

 

    def getChild(self, path, req): 

        if path == "force": 

            return ForceBuildActionResource(self.builder_status) 

        if path == "ping": 

            return self.ping(req) 

        if path == "cancelbuild": 

            return CancelChangeResource(self.builder_status) 

        if path == "stopchange": 

            return StopChangeResource(self.builder_status) 

        if path == "builds": 

            return BuildsResource(self.builder_status) 

 

        return HtmlResource.getChild(self, path, req) 

 

class CancelChangeResource(ActionResource): 

 

    def __init__(self, builder_status): 

        ActionResource.__init__(self) 

        self.builder_status = builder_status 

 

    @defer.inlineCallbacks 

    def performAction(self, req): 

        try: 

            request_id = req.args.get("id", [None])[0] 

            if request_id == "all": 

                cancel_all = True 

            else: 

                cancel_all = False 

                request_id = int(request_id) 

        except: 

            request_id = None 

 

        authz = self.getAuthz(req) 

        if request_id: 

            c = interfaces.IControl(self.getBuildmaster(req)) 

            builder_control = c.getBuilder(self.builder_status.getName()) 

 

            brcontrols = yield builder_control.getPendingBuildRequestControls() 

 

            for build_req in brcontrols: 

                if cancel_all or (build_req.brid == request_id): 

                    log.msg("Cancelling %s" % build_req) 

                    res = yield authz.actionAllowed('cancelPendingBuild', req, 

                                                                build_req) 

                    if res: 

                        build_req.cancel() 

                    else: 

                        defer.returnValue(path_to_authzfail(req)) 

                        return 

                    if not cancel_all: 

                        break 

 

        defer.returnValue(path_to_builder(req, self.builder_status)) 

 

class StopChangeMixin(object): 

 

    @defer.inlineCallbacks 

    def stopChangeForBuilder(self, req, builder_status, auth_ok=False): 

        try: 

            request_change = req.args.get("change", [None])[0] 

            request_change = int(request_change) 

        except: 

            request_change = None 

 

        authz = self.getAuthz(req) 

        if request_change: 

            c = interfaces.IControl(self.getBuildmaster(req)) 

            builder_control = c.getBuilder(builder_status.getName()) 

 

            brcontrols = yield builder_control.getPendingBuildRequestControls() 

            build_controls = dict((x.brid, x) for x in brcontrols) 

 

            build_req_statuses = yield \ 

                    builder_status.getPendingBuildRequestStatuses() 

 

            for build_req in build_req_statuses: 

                ss = yield build_req.getSourceStamp() 

 

                if not ss.changes: 

                    continue 

 

                for change in ss.changes: 

                    if change.number == request_change: 

                        control = build_controls[build_req.brid] 

                        log.msg("Cancelling %s" % control) 

                        res = yield authz.actionAllowed('stopChange', req, control) 

                        if (auth_ok or res): 

                            control.cancel() 

                        else: 

                            defer.returnValue(False) 

                            return 

 

        defer.returnValue(True) 

 

 

class StopChangeResource(StopChangeMixin, ActionResource): 

 

    def __init__(self, builder_status): 

        ActionResource.__init__(self) 

        self.builder_status = builder_status 

 

    @defer.inlineCallbacks 

    def performAction(self, req): 

        """Cancel all pending builds that include a given numbered change.""" 

        success = yield self.stopChangeForBuilder(req, self.builder_status) 

 

        if not success: 

            defer.returnValue(path_to_authzfail(req)) 

        else: 

            defer.returnValue(path_to_builder(req, self.builder_status)) 

 

 

class StopChangeAllResource(StopChangeMixin, ActionResource): 

 

    def __init__(self, status): 

        ActionResource.__init__(self) 

        self.status = status 

 

    @defer.inlineCallbacks 

    def performAction(self, req): 

        """Cancel all pending builds that include a given numbered change.""" 

        authz = self.getAuthz(req) 

        res = yield authz.actionAllowed('stopChange', req) 

        if not res: 

            defer.returnValue(path_to_authzfail(req)) 

            return 

 

        for bname in self.status.getBuilderNames(): 

            builder_status = self.status.getBuilder(bname) 

            res = yield self.stopChangeForBuilder(req, builder_status, auth_ok=True) 

            if not res: 

                defer.returnValue(path_to_authzfail(req)) 

                return 

 

        defer.returnValue(path_to_root(req)) 

 

 

# /builders/_all 

class StatusResourceAllBuilders(HtmlResource, BuildLineMixin): 

 

    def __init__(self, status): 

        HtmlResource.__init__(self) 

        self.status = status 

 

    def getChild(self, path, req): 

        if path == "forceall": 

            return self.forceall(req) 

        if path == "stopall": 

            return self.stopall(req) 

        if path == "stopchangeall": 

            return StopChangeAllResource(self.status) 

 

        return HtmlResource.getChild(self, path, req) 

 

    def forceall(self, req): 

        return ForceAllBuildsActionResource(self.status, 'all') 

 

    def stopall(self, req): 

        return StopAllBuildsActionResource(self.status, 'all') 

 

# /builders/_selected 

class StatusResourceSelectedBuilders(HtmlResource, BuildLineMixin): 

 

    def __init__(self, status): 

        HtmlResource.__init__(self) 

        self.status = status 

 

    def getChild(self, path, req): 

        if path == "forceselected": 

            return self.forceselected(req) 

        if path == "stopselected": 

            return self.stopselected(req) 

 

        return HtmlResource.getChild(self, path, req) 

 

    def forceselected(self, req): 

        return ForceAllBuildsActionResource(self.status, 'selected') 

 

    def stopselected(self, req): 

        return StopAllBuildsActionResource(self.status, 'selected') 

 

# /builders 

class BuildersResource(HtmlResource): 

    pageTitle = "Builders" 

    addSlash = True 

 

    @defer.inlineCallbacks 

    def content(self, req, cxt): 

        status = self.getStatus(req) 

        encoding = getRequestCharset(req) 

 

        builders = req.args.get("builder", status.getBuilderNames()) 

        branches = [ b.decode(encoding) 

                for b in req.args.get("branch", []) 

                if b ] 

 

        # get counts of pending builds for each builder 

        brstatus_ds = [] 

        brcounts = {} 

        def keep_count(statuses, builderName): 

            brcounts[builderName] = len(statuses) 

        for builderName in builders: 

            builder_status = status.getBuilder(builderName) 

            d = builder_status.getPendingBuildRequestStatuses() 

            d.addCallback(keep_count, builderName) 

            brstatus_ds.append(d) 

        yield defer.gatherResults(brstatus_ds) 

 

        cxt['branches'] = branches 

        bs = cxt['builders'] = [] 

 

        building = 0 

        online = 0 

        base_builders_url = path_to_root(req) + "builders/" 

        for bn in builders: 

            bld = { 'link': base_builders_url + urllib.quote(bn, safe=''), 

                    'name': bn } 

            bs.append(bld) 

 

            builder = status.getBuilder(bn) 

            builds = list(builder.generateFinishedBuilds(map_branches(branches), 

                                                         num_builds=1)) 

            if builds: 

                b = builds[0] 

                bld['build_url'] = (bld['link'] + "/builds/%d" % b.getNumber()) 

                label = None 

                all_got_revisions = b.getAllGotRevisions() 

                # If len = 1 then try if revision can be used as label. 

                if len(all_got_revisions) == 1: 

                    label = all_got_revisions[all_got_revisions.keys()[0]] 

                if not label or len(str(label)) > 20: 

                    label = "#%d" % b.getNumber() 

 

                bld['build_label'] = label 

                bld['build_text'] = " ".join(b.getText()) 

                bld['build_css_class'] = build_get_class(b) 

 

            current_box = ICurrentBox(builder).getBox(status, brcounts) 

            bld['current_box'] = current_box.td() 

 

            builder_status = builder.getState()[0] 

            if builder_status == "building": 

                building += 1 

                online += 1 

            elif builder_status != "offline": 

                online += 1 

 

        cxt['authz'] = self.getAuthz(req) 

        cxt['num_building'] = building 

        cxt['num_online'] = online 

        buildForceContext(cxt, req, self.getBuildmaster(req)) 

        template = req.site.buildbot_service.templates.get_template("builders.html") 

        defer.returnValue(template.render(**cxt)) 

 

    def getChild(self, path, req): 

        s = self.getStatus(req) 

        if path in s.getBuilderNames(): 

            builder_status = s.getBuilder(path) 

            return StatusResourceBuilder(builder_status) 

        if path == "_all": 

            return StatusResourceAllBuilders(self.getStatus(req)) 

        if path == "_selected": 

            return StatusResourceSelectedBuilders(self.getStatus(req)) 

 

        return HtmlResource.getChild(self, path, req)