Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

# -*- coding: UTF-8 -*- 

# Copyright 2009-2016 Luc Saffre 

# License: BSD (see file COPYING for details) 

 

"""Defines the `TableRequest` class. 

 

""" 

from __future__ import division 

from __future__ import print_function 

from future import standard_library 

standard_library.install_aliases() 

# from builtins import str 

from past.utils import old_div 

import six 

 

import logging 

logger = logging.getLogger(__name__) 

 

from types import GeneratorType 

import sys 

from io import StringIO 

import json 

 

from django.db import models 

from django.conf import settings 

from django.db.models.query import QuerySet 

from django.core.exceptions import ObjectDoesNotExist, SuspiciousOperation 

 

from lino.core.utils import obj2str 

from lino.core.utils import format_request 

from lino.core.store import get_atomizer 

from lino.core import constants 

from lino.utils.xmlgen import html as xghtml 

from lino.utils.xmlgen.html import E 

from lino.utils import jsgen 

from lino.core.utils import getrqdata 

 

from .requests import ActionRequest 

 

WARNINGS_LOGGED = dict() 

 

 

def column_header(col): 

        #~ if col.label: 

            #~ return join_elems(col.label.split('\n'),sep=E.br) 

        #~ return [unicode(col.name)] 

    return six.text_type(col.label or col.name) 

 

 

class TableRequest(ActionRequest): 

    """A specialized :class:`ActionRequest 

    <lino.core.requests.ActionRequest>` whose actor is a :class:`table 

    <lino.core.tables.AbstractTable>`. 

 

    """ 

 

    master = None 

 

    extra = None 

    title = None 

    filter = None 

    # known_values = None 

 

    limit = None 

    offset = None 

 

    _data_iterator = None 

    _sliced_data_iterator = None 

 

    def execute(self): 

        """This will actually call the :meth:`get_data_iterator` and run the 

        database query. 

 

        Automatically called when either :attr:`data_iterator` 

        or :attr:`sliced_data_iterator` is accesed. 

 

        """ 

        try: 

            self._data_iterator = self.get_data_iterator() 

        except Warning as e: 

            #~ logger.info("20130809 Warning %s",e) 

            self.no_data_text = six.text_type(e) 

            self._data_iterator = [] 

        except Exception as e: 

            if not settings.SITE.catch_layout_exceptions: 

                raise 

            # Report this exception. But since such errors may occur 

            # rather often and since exception loggers usually send an 

            # email to the local system admin, make sure to log each 

            # exception only once. 

            self.no_data_text = six.text_type(e) 

            w = WARNINGS_LOGGED.get(six.text_type(e)) 

            if w is None: 

                WARNINGS_LOGGED[six.text_type(e)] = True 

                raise 

                # logger.exception(e) 

            self._data_iterator = [] 

 

        if isinstance(self._data_iterator, GeneratorType): 

            # print 20150718, self._data_iterator 

            self._data_iterator = tuple(self._data_iterator) 

        self._sliced_data_iterator = self._data_iterator 

        if False:  # self.actor.start_at_bottom: 

            if self.offset is not None: 

                assert self.limit is not None 

                num = self.get_total_count() 

                max_pages = int(old_div(num, self.limit)) 

                page = old_div(self.offset, self.limit) 

                page = max_pages - page 

                offset = self.limit * page 

                # offset = max_offset - self.offset 

                self._sliced_data_iterator = self._sliced_data_iterator[ 

                    offset:] 

                self._sliced_data_iterator = self._sliced_data_iterator[ 

                    :self.limit] 

        else: 

            if self.offset is not None: 

                offset = self.offset 

                if offset == -1: 

                    assert self.limit is not None 

                    num = self.get_total_count() 

                    page_num = int(old_div(num, self.limit)) 

                    offset = self.limit * page_num 

                self._sliced_data_iterator = self._sliced_data_iterator[ 

                    offset:] 

            if self.limit is not None: 

                self._sliced_data_iterator = self._sliced_data_iterator[ 

                    :self.limit] 

 

    def must_execute(self): 

        return self._data_iterator is None 

 

    def get_data_iterator_property(self): 

        if self._data_iterator is None: 

            self.execute() 

        return self._data_iterator 

 

    def get_sliced_data_iterator_property(self): 

        if self._sliced_data_iterator is None: 

            self.execute() 

        return self._sliced_data_iterator 

 

    data_iterator = property(get_data_iterator_property) 

    sliced_data_iterator = property(get_sliced_data_iterator_property) 

 

    def get_data_iterator(self): 

        if self.actor.get_data_rows is not None: 

            l = [] 

            for row in self.actor.get_data_rows(self): 

                group = self.actor.group_from_row(row) 

                group.process_row(l, row) 

            return l 

        #~ logger.info("20120914 tables.get_data_iterator %s",self) 

        #~ logger.info("20120914 tables.get_data_iterator %s",self.actor) 

        return self.actor.get_request_queryset(self) 

 

    def get_total_count(self): 

        """ 

        Calling `len()` on a QuerySet would execute the whole SELECT. 

        See `/blog/2012/0124` 

        """ 

        di = self.data_iterator 

        if isinstance(di, QuerySet): 

            return di.count() 

        #~ if di is None: 

            #~ raise Exception("data_iterator is None: %s" % self) 

        if False: 

            return len(di) 

        else: 

            try: 

                return len(di) 

            except TypeError: 

                raise TypeError("{0} has no length".format(di)) 

 

    def __iter__(self): 

        return self.data_iterator.__iter__() 

 

    def __getitem__(self, i): 

        return self.data_iterator.__getitem__(i) 

 

    def parse_req(self, request, rqdata, **kw): 

        """Parse the incoming HttpRequest and translate it into keyword 

        arguments to be used by :meth:`setup`. 

 

        The `mt` url param is parsed only when needed. Usually it is 

        not needed because the `master_class` is constant and known 

        per actor. But there are exceptions: 

 

        - `master` is `ContentType` 

 

        - `master` is some abstract model 

 

        - `master` is not a subclass of Model, e.g. 

          :class:`lino.modlib.polls.models.AnswersByResponse`, a 

          virtual table which defines :meth:`get_row_by_pk 

          <lino.core.actors.Actor.get_row_by_pk>`. 

 

        """ 

        #~ logger.info("20120723 %s.parse_req()",self.actor) 

        #~ rh = self.ah 

        master = kw.get('master', self.actor.master) 

        if master is not None: 

 

            if not isinstance(master, type): 

                raise Exception("20150216 not a type: %r" % master) 

            if settings.SITE.is_installed('contenttypes'): 

                from django.contrib.contenttypes.models import ContentType 

                if issubclass(master, models.Model) and ( 

                        master is ContentType or master._meta.abstract): 

                    mt = rqdata.get(constants.URL_PARAM_MASTER_TYPE) 

                    try: 

                        master = kw['master'] = ContentType.objects.get( 

                            pk=mt).model_class() 

                    except ContentType.DoesNotExist: 

                        pass 

                        # master is None 

 

            if 'master_instance' not in kw: 

                pk = rqdata.get(constants.URL_PARAM_MASTER_PK, None) 

                #~ print '20100406a', self.actor,URL_PARAM_MASTER_PK,"=",pk 

                #~ if pk in ('', '-99999'): 

                if pk == '': 

                    pk = None 

                if pk is None: 

                    kw['master_instance'] = None 

                else: 

                    mi = self.actor.get_master_instance(self, master, pk) 

                    if mi is None: 

                        raise ObjectDoesNotExist( 

                            "Invalid master key {0} for {1}".format( 

                                pk, self.actor)) 

                    kw['master_instance'] = mi 

 

                # ~ print '20100212', self #, kw['master_instance'] 

        #~ print '20100406b', self.actor,kw 

 

        if settings.SITE.use_filterRow: 

            exclude = dict() 

            for f in self.ah.store.fields: 

                if f.field: 

                    filterOption = rqdata.get( 

                        'filter[%s_filterOption]' % f.field.name) 

                    if filterOption == 'empty': 

                        kw[f.field.name + "__isnull"] = True 

                    elif filterOption == 'notempty': 

                        kw[f.field.name + "__isnull"] = False 

                    else: 

                        filterValue = rqdata.get('filter[%s]' % f.field.name) 

                        if filterValue: 

                            if not filterOption: 

                                filterOption = 'contains' 

                            if filterOption == 'contains': 

                                kw[f.field.name + "__icontains"] = filterValue 

                            elif filterOption == 'doesnotcontain': 

                                exclude[f.field.name + 

                                        "__icontains"] = filterValue 

                            else: 

                                print("unknown filterOption %r" % filterOption) 

            if len(exclude): 

                kw.update(exclude=exclude) 

 

        if settings.SITE.use_gridfilters: 

            filter = rqdata.get(constants.URL_PARAM_GRIDFILTER, None) 

            if filter is not None: 

                filter = json.loads(filter) 

                kw['gridfilters'] = [constants.dict2kw(flt) for flt in filter] 

 

        kw = ActionRequest.parse_req(self, request, rqdata, **kw) 

        #~ raise Exception("20120121 %s.parse_req(%s)" % (self,kw)) 

 

        #~ kw.update(self.report.known_values) 

        #~ for fieldname, default in self.report.known_values.items(): 

            #~ v = request.REQUEST.get(fieldname,None) 

            #~ if v is not None: 

                #~ kw[fieldname] = v 

 

        quick_search = rqdata.get(constants.URL_PARAM_FILTER, None) 

        if quick_search: 

            kw.update(quick_search=quick_search) 

 

        sort = rqdata.get(constants.URL_PARAM_SORT, None) 

        if sort: 

            sort_dir = rqdata.get(constants.URL_PARAM_SORTDIR, 'ASC') 

            if sort_dir == 'DESC': 

                sort = '-' + sort 

            kw.update(order_by=[sort]) 

 

        try: 

            offset = rqdata.get(constants.URL_PARAM_START, None) 

            if offset: 

                kw.update(offset=int(offset)) 

            limit = rqdata.get( 

                constants.URL_PARAM_LIMIT, self.actor.preview_limit) 

            if limit: 

                kw.update(limit=int(limit)) 

        except ValueError: 

            # Example: invalid literal for int() with base 10: 

            # 'fdpkvcnrfdybhur' 

            raise SuspiciousOperation("Invalid value for limit or offset") 

 

        return self.actor.parse_req(request, rqdata, **kw) 

 

    def setup(self, 

              quick_search=None, 

              order_by=None, 

              offset=None, limit=None, 

              master=None, 

              title=None, 

              master_id=None, 

              filter=None, 

              gridfilters=None, 

              exclude=None, 

              extra=None, 

              **kw): 

 

        self.quick_search = quick_search 

        self.order_by = order_by 

 

        #~ logger.info("20120519 %s.setup()",self) 

        self.filter = filter 

        self.gridfilters = gridfilters 

        self.exclude = exclude or self.actor.exclude 

        self.extra = extra 

 

        if master is None: 

            master = self.actor.master 

            # master might still be None 

        self.master = master 

 

        if title is not None: 

            self.title = title 

 

        if master_id is not None: 

            raise Exception("20150218 deprecated?") 

            # assert master_instance is None 

            # master_instance = self.master.objects.get(pk=master_id) 

 

        # Table.page_length is not a default value for ReportRequest.limit 

        # For example CSVReportRequest wants all rows. 

        self.page_length = self.actor.page_length 

 

        #~ logger.info("20120121 %s.setup() done",self) 

 

        ActionRequest.setup(self, **kw) 

 

        # 20120519 : outbox.MyOutbox had no phantom record when called 

        # from menu.  When called by permalink it had. Because 

        # get_create_kw was called before Actor.setup_request() which 

        # sets the master_instance. 

 

        self.actor.setup_request(self) 

 

        self.create_kw = self.actor.get_create_kw(self) 

 

        if offset is not None: 

            self.offset = offset 

 

        if limit is not None: 

            self.limit = limit 

 

    def to_rst(self, *args, **kw): 

        """Returns a string representing this table request in 

        reStructuredText markup. 

 

        """ 

        stdout = sys.stdout 

        sys.stdout = StringIO() 

        self.table2rst(*args, **kw) 

        rv = sys.stdout.getvalue() 

        sys.stdout = stdout 

        return rv 

 

    def table2rst(self, *args, **kwargs): 

        """Print a reStructuredText representation of this table request to 

        stdout. 

 

        """ 

        settings.SITE.kernel.text_renderer.show_table(self, *args, **kwargs) 

 

    def table2xhtml(self, header_level=None, **kw): 

        """ 

        Return an HTML representation of this table request. 

        """ 

        t = xghtml.Table() 

        self.dump2html(t, self.sliced_data_iterator, **kw) 

        e = t.as_element() 

        # print "20150822 table2xhtml", E.tostring(e) 

        if header_level is not None: 

            return E.div(E.h2(self.actor.label), e) 

        return e 

 

    def dump2html(self, tble, data_iterator, column_names=None): 

        """ 

        Render this table into an existing 

        :class:`lino.utils.xmlgen.html.Table` instance. 

 

        """ 

        ar = self 

        tble.attrib.update(self.tableattrs) 

        tble.attrib.setdefault('name', self.bound_action.full_name()) 

 

        grid = ar.ah.list_layout.main 

        columns = grid.columns 

        fields, headers, cellwidths = ar.get_field_info(column_names) 

        columns = fields 

        #~ print 20130330, cellwidths 

 

        headers = [ 

            x for x in grid.headers2html( 

                self, columns, headers, **self.cellattrs)] 

        sums = [fld.zero for fld in columns] 

        #~ hr = tble.add_header_row(*headers,**self.cellattrs) 

        if cellwidths: 

            for i, td in enumerate(headers): 

                td.attrib.update(width=six.text_type(cellwidths[i])) 

        tble.head.append(xghtml.E.tr(*headers)) 

        #~ print 20120623, ar.actor 

        recno = 0 

        for obj in data_iterator: 

            cells = ar.row2html(recno, columns, obj, sums, **self.cellattrs) 

            if cells is not None: 

                recno += 1 

                #~ ar.actor.apply_row_format(tr,recno) 

                tble.body.append(xghtml.E.tr(*cells)) 

 

        if recno == 0: 

            tble.clear() 

            tble.body.append(ar.no_data_text) 

 

        if not ar.actor.hide_sums: 

            has_sum = False 

            for i in sums: 

                if i: 

                    has_sum = True 

                    break 

            if has_sum: 

                cells = ar.sums2html(columns, sums, **self.cellattrs) 

                tble.body.append(xghtml.E.tr(*cells)) 

 

    def get_field_info(ar, column_names=None): 

        """Return a tuple `(fields, headers, widths)` which expresses which 

        columns, headers and widths the user wants for this 

        request. If `self` has web request info, checks for GET 

        parameters cn, cw and ch (coming from the grid widget). Also 

        apply the tables's :meth:`override_column_headers 

        <lino.core.actors.Actor.override_column_headers>` method. 

 

        """ 

        def getit(): 

 

            if ar.request is None: 

                columns = None 

            else: 

                data = getrqdata(ar.request) 

                columns = [ 

                    six.text_type(x) for x in 

                    data.getlist(constants.URL_PARAM_COLUMNS)] 

            if columns: 

                all_widths = data.getlist(constants.URL_PARAM_WIDTHS) 

                hiddens = [(x == 'true') for x in data.getlist( 

                    constants.URL_PARAM_HIDDENS)] 

                fields = [] 

                widths = [] 

                ah = ar.actor.get_handle() 

                for i, cn in enumerate(columns): 

                    col = None 

                    for e in ah.list_layout.main.columns: 

                        if e.name == cn: 

                            col = e 

                            break 

                    if col is None: 

                        raise Exception("No column named %r in %s" % 

                                        (cn, ar.ah.list_layout.main.columns)) 

                    if not hiddens[i]: 

                        fields.append(col) 

                        widths.append(int(all_widths[i])) 

            else: 

                if column_names: 

                    from lino.core.layouts import ColumnsLayout 

                    ll = ColumnsLayout(column_names, datasource=ar.actor) 

                    lh = ll.get_layout_handle(settings.SITE.kernel.default_ui) 

                    columns = lh.main.columns 

                    columns = [e for e in columns if not e.hidden] 

                else: 

                    ah = ar.actor.get_request_handle(ar) 

                    columns = ah.list_layout.main.columns 

 

                # render them so that babelfields in hidden_languages 

                # get hidden: 

                for e in columns: 

                    e.value = e.ext_options() 

                # 

                columns = [e for e in columns if not 

                           e.value.get('hidden', False)] 

 

                columns = [e for e in columns if not e.hidden] 

 

                widths = ["%d" % (col.width or col.preferred_width) 

                          for col in columns] 

                #~ 20130415 widths = ["%d%%" % (col.width or col.preferred_width) for col in columns] 

                #~ fields = [col.field._lino_atomizer for col in columns] 

                fields = columns 

 

            headers = [column_header(col) for col in fields] 

 

            oh = ar.actor.override_column_headers(ar) 

            if oh: 

                for i, e in enumerate(columns): 

                    header = oh.get(e.name, None) 

                    if header is not None: 

                        headers[i] = header 

                #~ print 20120507, oh, headers 

 

            return fields, headers, widths 

 

        u = ar.get_user() 

        if u is None: 

            return getit() 

        else: 

            return jsgen.with_user_profile(u.profile, getit) 

 

    def row2html(self, recno, columns, row, sums, **cellattrs): 

        has_numeric_value = False 

        cells = [] 

        for i, col in enumerate(columns): 

            v = col.field._lino_atomizer.full_value_from_object(row, self) 

            if v is None: 

                td = E.td(**cellattrs) 

            else: 

                nv = col.value2num(v) 

                if nv != 0: 

                    sums[i] += nv 

                    has_numeric_value = True 

                td = col.value2html(self, v, **cellattrs) 

            col.apply_cell_format(td) 

            self.actor.apply_cell_format(self, row, col, recno, td) 

            cells.append(td) 

        if self.actor.hide_zero_rows and not has_numeric_value: 

            return None 

        return cells 

 

    def row2text(self, fields, row, sums): 

        """Render the given `row` into a line of text, using the given list of 

        `fields` and collecting sums into `sums`. 

 

        """ 

        for i, fld in enumerate(fields): 

            if fld.field is not None: 

                sf = get_atomizer(row.__class__, fld.field, fld.field.name) 

                if False: 

                    try: 

                        getter = sf.full_value_from_object 

                        v = getter(row, self) 

                    except Exception as e: 

                        raise Exception("20150218 %s: %s" % (sf, e)) 

                        # was used to find bug 20130422: 

                        yield "%s:\n%s" % (fld.field, e) 

                        continue 

                else: 

                    getter = sf.full_value_from_object 

                    v = getter(row, self) 

 

                if v is None: 

                    yield '' 

                else: 

                    sums[i] += fld.value2num(v) 

                    # # In case you want the field name in error message: 

                    # try: 

                    #     sums[i] += fld.value2num(v) 

                    # except Exception as e: 

                    #     raise e.__class__("%s %s" % (fld.field, e)) 

                    yield fld.format_value(self, v) 

 

    def sums2html(self, columns, sums, **cellattrs): 

        return [fld.sum2html(self, sums, i, **cellattrs) 

                for i, fld in enumerate(columns)] 

 

    def get_title(self): 

        if self.title is not None: 

            return self.title 

        return self.actor.get_title(self) 

 

    def get_status(self, **kw): 

        """Extends :meth:`lino.core.requests.ActorRequest.get_status`. 

 

        """ 

        kw = ActionRequest.get_status(self, **kw) 

        bp = kw['base_params'] 

        if self.quick_search: 

            bp[constants.URL_PARAM_FILTER] = self.quick_search 

 

        if self.order_by: 

            sort = self.order_by[0] 

            if sort.startswith('-'): 

                sort = sort[1:] 

                bp[constants.URL_PARAM_SORTDIR] = 'DESC' 

            bp[constants.URL_PARAM_SORT] = sort 

 

        if self.known_values: 

            for k, v in list(self.known_values.items()): 

                if self.actor.known_values.get(k, None) != v: 

                    bp[k] = v 

        if self.master_instance is not None: 

            if isinstance(self.master_instance, models.Model): 

                bp[constants.URL_PARAM_MASTER_PK] = self.master_instance.pk 

                if settings.SITE.is_installed('contenttypes'): 

                    from django.contrib.contenttypes.models import ContentType 

                    mt = ContentType.objects.get_for_model( 

                        self.master_instance.__class__).pk 

                    bp[constants.URL_PARAM_MASTER_TYPE] = mt 

                # else: 

                #     logger.warning("20141205 %s %s", 

                #                    self.master_instance, 

                #                    ContentType) 

            else:  # if self.master is None: 

                bp[constants.URL_PARAM_MASTER_PK] = self.master_instance 

 

        return kw 

 

    def __repr__(self): 

        kw = dict() 

        if self.master_instance is not None: 

            kw.update(master_instance=obj2str(self.master_instance)) 

        if self.filter is not None: 

            kw.update(filter=repr(self.filter)) 

        if self.known_values: 

            kw.update(known_values=self.known_values) 

        if self.requesting_panel: 

            kw.update(requesting_panel=self.requesting_panel) 

        u = self.get_user() 

        if u is not None: 

            kw.update(user=u.username) 

        if False:  # self.request: 

            kw.update(request=format_request(self.request)) 

        return "<%s %s(%s)>" % ( 

            self.__class__.__name__, self.bound_action.full_name(), kw)