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

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

# Copyright 2009-2015 Luc Saffre 

# License: BSD (see file COPYING for details) 

""" 

Defines :class:`HtmlRenderer` and :class:`TextRenderer`. 

""" 

 

from __future__ import unicode_literals 

from __future__ import print_function 

# import six 

# str = six.text_type 

from builtins import str 

from past.builtins import basestring 

from builtins import object 

 

import logging 

logger = logging.getLogger(__name__) 

 

from cgi import escape 

from atelier import rstgen 

 

from django.conf import settings 

from django.utils.encoding import force_text 

 

from django.utils.translation import ugettext as _ 

from django.utils.translation import get_language 

 

 

from lino.utils.html2rst import RstTable 

from lino.utils import isiterable 

from lino.utils.xmlgen.html import E 

from lino.core import constants 

from lino.core.menus import Menu, MenuItem 

# from lino.utils.xmlgen.html import _html2rst as html2rst 

# from lino.utils.xmlgen.html import html2rst 

 

from . import elems 

 

if False: 

    from lino.utils.jscompressor import JSCompressor 

    jscompress = JSCompressor().compress 

else: 

    def jscompress(s): 

        return s 

 

 

def add_user_language(kw, ar): 

    if len(settings.SITE.languages) == 1: 

        return 

    u = ar.get_user() 

    lang = get_language() 

    #~ print 2013115, [li.django_code for li in settings.SITE.languages], settings.SITE.get_default_language(), lang, u.language 

    if u and u.language and lang != u.language: 

        kw.setdefault(constants.URL_PARAM_USER_LANGUAGE, lang) 

    #~ elif lang != settings.SITE.DEFAULT_LANGUAGE.django_code: 

    elif lang != settings.SITE.get_default_language(): 

        kw.setdefault(constants.URL_PARAM_USER_LANGUAGE, lang) 

 

 

    #~ if len(settings.SITE.languages) > 1: 

      #~ 

        #~ ul = rqdata.get(constants.URL_PARAM_USER_LANGUAGE,None) 

        #~ if ul: 

            #~ translation.activate(ul) 

            #~ request.LANGUAGE_CODE = translation.get_language() 

 

 

class NOT_GIVEN(object): 

    pass 

 

 

class Renderer(object): 

    """ 

    See :doc:`/dev/rendering`. 

    """ 

 

    can_auth = False 

    is_interactive = False 

    # not_implemented_js = "alert('Not implemented')" 

    not_implemented_js = None 

 

    def ar2js(self, ar, obj, **status): 

        """Return the Javascript code which would run this `ar` on the 

        client. 

 

        """ 

        return self.not_implemented_js 

 

 

class HtmlRenderer(Renderer): 

    row_classes_map = {} 

 

    def __init__(self, plugin): 

        self.plugin = plugin 

 

    def js2url(self, js): 

        if not js: 

            return None 

        js = escape(js) 

        # js = js.replace('"', '"') 

        return 'javascript:' + js 

 

    def href(self, url, text): 

        return E.a(text, href=url) 

 

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

        return E.tostring(self.table2story(*args, **kwargs)) 

 

    def table2story(self, ar, nosummary=False, stripped=True, **kw): 

        """Returns a HTML element representing the given action request as a 

        table. See :meth:`ar.show <lino.core.request.BaseRequest.show>`. 

 

        This silently ignores the parameter `stripped` since for HTML 

        this has no meaning. 

 

        """ 

        if ar.actor.master is not None and not nosummary: 

            if ar.actor.slave_grid_format == 'summary': 

                return ar.actor.get_slave_summary(ar.master_instance, ar) 

        return ar.table2xhtml(**kw) 

 

    def action_call(self, request, bound_action, status): 

        return None 

 

    def action_call_on_instance(self, obj, ar, ba, request_kwargs={}, **st): 

        """Return a string with Javascript code that would run the given 

        action `ba` on the given model instance `obj`. The second 

        parameter (`ar`) is the calling action request. 

 

        """ 

        return self.not_implemented_js 

 

    def request_handler(self, ar, *args, **kw): 

        """Return a string with Javascript code that would run the given 

        action request `ar`. 

 

        """ 

        return self.not_implemented_js 

 

    def href_to_request(self, sar, tar, text=None, **kw): 

        """Return a string with an URL which would run the given target 

request `tar`.""" 

        uri = self.js2url(self.request_handler(tar)) 

        return self.href_button_action( 

            tar.bound_action, uri, text or tar.get_title(), **kw) 

 

    def href_button_action( 

            self, ba, url, text=None, title=None, icon_name=NOT_GIVEN, **kw): 

        """ 

        changed 20130905 for "Must read eID card button" 

        but that caused icons to not appear in workflow_buttons. 

        """ 

        if icon_name is NOT_GIVEN: 

            icon_name = ba.action.icon_name 

        if not 'style' in kw: 

            if icon_name is None: 

                kw.update(style="text-decoration:none")  # Experimental. Added 

            else: 

                kw.update(style="vertical-align:-30%;") 

                                                 # 20150430 

        return self.href_button(url, text, title, icon_name=icon_name, **kw) 

 

    def href_button( 

            self, url, text, title=None, target=None, icon_name=None, **kw): 

        """ 

        Returns an etree object of a "button-like" ``<a href>`` tag. 

        """ 

        # logger.info('20121002 href_button %s', unicode(text)) 

        if target: 

            kw.update(target=target) 

        if title: 

            # Remember that Python 2.6 doesn't like if title is a Promise 

            kw.update(title=str(title)) 

            #~ return xghtml.E.a(text,href=url,title=title) 

        if not isinstance(text, (tuple, list)): 

            text = (text,) 

        if url is None: 

            return E.b(*text) 

 

        kw.update(href=url) 

        if icon_name is not None: 

            src = settings.SITE.build_static_url( 

                'images', 'mjames', icon_name + '.png') 

            img = E.img(src=src, alt=icon_name) 

            return E.a(img, **kw) 

        else: 

            return E.a(*text, **kw) 

 

    def quick_add_buttons(self, ar): 

        """Returns a HTML chunk that displays "quick add buttons" for the 

        given :class:`action request 

        <lino.core.dbtables.TableRequest>`: a button :guilabel:`[New]` 

        followed possibly (if the request has rows) by a 

        :guilabel:`[Show last]` and a :guilabel:`[Show all]` button. 

         

        See also :srcref:`docs/tickets/56`. 

 

        """ 

        buttons = [] 

        # btn = ar.insert_button(_("New")) 

        # if btn is not None: 

        sar = ar.actor.insert_action.request_from(ar) 

        if sar.get_permission(): 

            btn = sar.ar2button(None, _("New")) 

            buttons.append(btn) 

            buttons.append(' ') 

                #~ after_show = ar.get_status() 

        n = ar.get_total_count() 

        #~ print 20120702, [o for o in ar] 

        if n > 0: 

            obj = ar.data_iterator[n - 1] 

            st = ar.get_status() 

            st.update(record_id=obj.pk) 

            #~ a = ar.actor.get_url_action('detail_action') 

            a = ar.actor.detail_action 

            buttons.append(self.window_action_button( 

                ar.request, a, st, _("Show Last"), 

                icon_name='application_form', 

                title=_("Show the last record in a detail window"))) 

            buttons.append(' ') 

            #~ s += ' ' + self.window_action_button( 

                #~ ar.ah.actor.detail_action,after_show,_("Show Last")) 

            #~ s += ' ' + self.href_to_request(ar,"[%s]" % unicode(_("Show All"))) 

            buttons.append(self.href_to_request( 

                None, ar, 

                _("Show All"), 

                icon_name='application_view_list', 

                title=_("Show all records in a table window"))) 

        #~ return '<p>%s</p>' % s 

        return E.p(*buttons) 

 

    def pk2url(self, ar, pk, **kw): 

        return None 

 

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

        return settings.SITE.kernel.default_ui.build_plain_url(*args, **kw) 

 

    def instance_handler(self, ar, obj): 

        "Overridden by :mod:`lino.modlib.extjs.ext_renderer`" 

        return None 

 

    def obj2html(self, ar, obj, text=None, **kwargs): 

        """Return a html representation of a pointer to the given database 

        object.""" 

        if text is None: 

            text = (force_text(obj),) 

        elif isinstance(text, basestring): 

            text = (text,) 

        url = self.instance_handler(ar, obj) 

        if url is None: 

            return E.em(*text) 

        return E.a(*text, href=url, **kwargs) 

 

    def quick_upload_buttons(self, rr): 

        return '[?!]' 

 

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

        return elems.create_layout_element(*args, **kw) 

 

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

        return elems.create_layout_panel(*args, **kw) 

 

    # def insert_button(self, ar, text, known_values={}, **options): 

    #     return '[?!]' 

 

    def ar2button(self, ar, obj=None, label=None, title=None, **kw): 

        ba = ar.bound_action 

        # label = label or ba.action.label 

        label = label or ba.get_button_label() 

        status = ar.get_status() 

        js = self.ar2js(ar, obj, **status) 

        uri = self.js2url(js) 

        return self.href_button_action( 

            ba, uri, label, title or ba.action.help_text, **kw) 

 

    def row_action_button( 

            self, obj, ar, ba, label=None, title=None, request_kwargs={}, 

            **kw): 

        """ 

        Return a HTML fragment that displays a button-like link 

        which runs the bound action `ba` when clicked. 

        """ 

        label = label or ba.action.label 

        js = self.action_call_on_instance(obj, ar, ba, request_kwargs) 

        uri = self.js2url(js) 

        return self.href_button_action( 

            ba, uri, label, title or ba.action.help_text, **kw) 

 

    def row_action_button_ar( 

            self, obj, ar, label=None, title=None, request_kwargs={}, 

            **kw): 

        """ 

        Return a HTML fragment that displays a button-like link 

        which runs the action request `ar` when clicked. 

        """ 

        ba = ar.bound_action 

        label = label or ba.action.label 

        js = self.action_call_on_instance(obj, ar, ba) 

        uri = self.js2url(js) 

        return self.href_button_action( 

            ba, uri, label, title or ba.action.help_text, **kw) 

 

    def window_action_button( 

            self, request, ba, 

            after_show={}, label=None, title=None, **kw): 

        """ 

        Return a HTML chunk for a button that will execute this action. 

        """ 

        label = str(label or ba.get_button_label()) 

        url = self.js2url(self.action_call(request, ba, after_show)) 

        #~ logger.info('20121002 window_action_button %s %r',a,unicode(label)) 

        return self.href_button_action(ba, url, label, 

                                       title or ba.action.help_text, **kw) 

 

    def action_button(self, obj, ar, ba, label=None, **kw): 

        if not label: 

            label = ba.action.label 

        return "[%s]" % label 

 

    def show_story(self, ar, story, stripped=True, **kwargs): 

        """Render the given story as an HTML element. Ignore `stripped` 

        because it makes no sense in HTML. 

 

        """ 

        from lino.core.actors import Actor 

        from lino.core.tables import TableRequest 

        elems = [] 

        for item in story: 

            if E.iselement(item): 

                elems.append(item) 

            elif isinstance(item, type) and issubclass(item, Actor): 

                ar = item.default_action.request(parent=ar) 

                elems.append(self.table2story(ar, **kwargs)) 

            elif isinstance(item, TableRequest): 

                assert item.renderer is not None 

                elems.append(self.table2story(item, **kwargs)) 

            elif isiterable(item): 

                elems.append(self.show_story(ar, item, **kwargs)) 

                # for i in self.show_story(item, *args, **kwargs): 

                #     yield i 

            else: 

                raise Exception("Cannot handle %r" % item) 

        return E.div(*elems) 

 

    def obj2str(self, ar, obj, text=None, **kwargs): 

        return E.tostring(self.obj2html(ar, obj, text, **kwargs)) 

 

    def show_menu(self, ar, mnu, level=1): 

        """ 

        Render the given menu as an HTML element. 

        Used for writing test cases. 

        """ 

        if not isinstance(mnu, Menu): 

            assert isinstance(mnu, MenuItem) 

            if mnu.bound_action: 

                sr = mnu.bound_action.actor.request( 

                    action=mnu.bound_action, 

                    user=ar.user, subst_user=ar.subst_user, 

                    requesting_panel=ar.requesting_panel, 

                    renderer=self, **mnu.params) 

 

                url = sr.get_request_url() 

            else: 

                url = mnu.href 

            assert mnu.label is not None 

            if url is None: 

                return E.p()  # spacer 

            return E.li(E.a(mnu.label, href=url, tabindex="-1")) 

 

        items = [self.show_menu(ar, mi, level + 1) for mi in mnu.items] 

        #~ print 20120901, items 

        if level == 1: 

            return E.ul(*items, class_='nav navbar-nav') 

        if mnu.label is None: 

            raise Exception("%s has no label" % mnu) 

        if level == 2: 

            cl = 'dropdown' 

            menu_title = E.a( 

                str(mnu.label), E.b(' ', class_="caret"), href="#", 

                class_='dropdown-toggle', data_toggle="dropdown") 

        elif level == 3: 

            menu_title = E.a(str(mnu.label), href="#") 

            cl = 'dropdown-submenu' 

        else: 

            raise Exception("Menu with more than three levels") 

        return E.li( 

            menu_title, 

            E.ul(*items, class_='dropdown-menu'), 

            class_=cl) 

 

 

class TextRenderer(HtmlRenderer): 

    """The renderer used when rendering to .rst files and console output. 

 

    """ 

 

    user = None 

 

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

        HtmlRenderer.__init__(self,  *args, **kw) 

        self.user = None 

 

    def get_request_url(self, ar, *args, **kw): 

        return None 

 

    def menu2rst(self, ar, mnu, level=1): 

        """Used by :meth:`show_menu`.""" 

 

        if not isinstance(mnu, Menu): 

            return str(mnu.label) 

 

        has_submenus = False 

        for i in mnu.items: 

            if isinstance(i, Menu): 

                has_submenus = True 

        items = [self.menu2rst(ar, mi, level + 1) for mi in mnu.items] 

        if has_submenus: 

            s = rstgen.ul(items).strip() + '\n' 

            if mnu.label is not None: 

                s = str(mnu.label) + ' :\n\n' + s 

        else: 

            s = ', '.join(items) 

            if mnu.label is not None: 

                s = str(mnu.label) + ' : ' + s 

        return s 

 

    def show_menu(self, ar, mnu, stripped=True, level=1): 

        """ 

        Render the given menu as a reStructuredText 

        formatted bullet list. 

        Called from :meth:`lino.core.requests.BaseRequest.show_menu`. 

 

        :stripped: remove lots of blanklines which are necessary for 

                   reStructuredText but disturbing in a doctest 

                   snippet. 

 

        """ 

        s = self.menu2rst(ar, mnu, level) 

        if stripped: 

            for ln in s.splitlines(): 

                if ln.strip(): 

                    print(ln) 

        else: 

            print(s) 

 

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

        print(self.table2story(*args, **kwargs)) 

 

    def table2story(self, ar, column_names=None, header_level=None, 

                    nosummary=False, stripped=True, **kwargs): 

        """Render the given table request as reStructuredText to stdout. 

        See :meth:`ar.show <lino.core.request.BaseRequest.show>`. 

        """ 

 

        if ar.actor.master is not None and not nosummary: 

            if ar.actor.slave_grid_format == 'summary': 

                s = E.to_rst( 

                    ar.actor.get_slave_summary(ar.master_instance, ar), 

                    stripped=stripped) 

                if stripped: 

                    s = s.strip() 

                return s 

 

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

 

        sums = [fld.zero for fld in fields] 

        rows = [] 

        recno = 0 

        for row in ar.sliced_data_iterator: 

            recno += 1 

            rows.append([x for x in ar.row2text(fields, row, sums)]) 

        if len(rows) == 0: 

            s = str(ar.no_data_text) 

            if not stripped: 

                s = "\n" + s + "\n" 

            return s 

 

        if not ar.actor.hide_sums: 

            has_sum = False 

            for i in sums: 

                if i: 

                    #~ print '20120914 zero?', repr(i) 

                    has_sum = True 

                    break 

            if has_sum: 

                rows.append([x for x in ar.sums2html(fields, sums)]) 

 

        t = RstTable(headers, **kwargs) 

        s = t.to_rst(rows) 

        if header_level is not None: 

            h = rstgen.header(header_level, ar.get_title()) 

            if stripped: 

                h = h.strip() 

            s = h + "\n" + s 

            # s = E.tostring(E.h2(ar.get_title())) + s 

        return s 

 

    def show_story(self, ar, story, stripped=True, **kwargs): 

        """Render the given story as reStructuredText to stdout.""" 

        from lino.core.actors import Actor 

        from lino.core.requests import ActionRequest 

 

        for item in story: 

            if E.iselement(item): 

                print(E.to_rst(item, stripped)) 

            elif isinstance(item, type) and issubclass(item, Actor): 

                ar = item.default_action.request(parent=ar) 

                self.show_table(ar, stripped=stripped, **kwargs) 

            elif isinstance(item, ActionRequest): 

                self.show_table(item, stripped=stripped, **kwargs) 

                # print(item.table2rst(*args, **kwargs)) 

            elif isiterable(item): 

                self.show_story(ar, item, stripped, **kwargs) 

                # for i in self.show_story(ar, item, *args, **kwargs): 

                #     print(i) 

            else: 

                raise Exception("Cannot handle %r" % item) 

 

    def obj2str(self, ar, obj, text=None, **kwargs): 

        """Used by :meth:`lino.core.requests.BaseRequest.obj2str`. 

        """ 

        if text is None: 

            text = force_text(obj) 

        # return "**{0}**".format(text) 

        return settings.SITE.obj2text_template.format(text)