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

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

1001

1002

1003

1004

1005

1006

1007

1008

1009

1010

1011

1012

1013

1014

1015

1016

1017

1018

1019

1020

1021

1022

1023

1024

1025

1026

1027

1028

1029

1030

1031

1032

1033

1034

1035

1036

1037

1038

1039

1040

1041

1042

1043

1044

1045

1046

1047

1048

1049

1050

1051

1052

1053

1054

1055

1056

1057

1058

1059

1060

1061

1062

1063

1064

1065

1066

1067

1068

1069

1070

1071

1072

1073

1074

1075

1076

1077

1078

1079

1080

1081

1082

1083

1084

1085

1086

1087

1088

1089

1090

1091

1092

1093

1094

1095

1096

1097

1098

1099

1100

1101

1102

1103

1104

1105

1106

1107

1108

1109

1110

1111

1112

1113

1114

1115

1116

1117

1118

1119

1120

1121

1122

1123

1124

1125

1126

1127

1128

1129

1130

1131

# Copyright 2009-2016 Luc Saffre 

# License: BSD (see file COPYING for details) 

"""Defines the "store" and its "fields" . 

 

During startup, Lino instantiates a "store" and its "fields" (aka 

"atomizers") for every table.  These were used originally for dealing 

with Sencha ExtJS GridPanels and FormPanels, but the concept turned 

out useful for other features. 

 

Some usages specific to Sencha ExtJS: 

 

- for generating the JS code of the GridPanel definition 

- for generating an "atomized" JSON representation when 

  rendering data for that GridPanel 

- for parsing the JSON sent by GridPanel and FormPanel 

 

Other usages: 

 

- remote fields (:class:`lino.core.fields.RemoteField`) 

 

- render tables as text 

  (:meth:`lino.core.renderer.TextRenderer.show_table` and 

  :meth:`lino.core.tablerequest.TableRequest.row2text`) 

 

""" 

 

from __future__ import unicode_literals 

# import six 

# str = six.text_type 

from builtins import str 

from builtins import object 

 

import logging 

logger = logging.getLogger(__name__) 

 

import datetime 

 

from django.conf import settings 

from django.db import models 

from django.core import exceptions 

from django.utils.translation import ugettext_lazy as _ 

from django.utils.encoding import force_text 

from lino import AFTER17 

 

from lino.utils.jsgen import py2js 

from lino.utils.quantities import parse_decimal 

from lino.core.utils import getrqdata 

 

from lino.core import constants 

 

from lino.core import fields 

from lino.core import actions 

from lino.core import frames 

from lino.utils import choosers 

from lino.utils import curry 

from lino.utils import iif 

from lino.utils.format_date import fds 

from lino.core.requests import PhantomRow 

from lino.utils import IncompleteDate 

 

 

class StoreField(object): 

 

    """Base class for the fields of a :class:`Store`. 

 

    .. attribute:: field 

 

        The database field (a subclass of 

        `django.db.models.fields.Field`) 

     

    .. attribute:: options 

 

        A `dict` with options to be used by :meth:`as_js`. 

     

 

    Note: `value_from_object` and `full_value_from_object` are 

    similar, but for ForeignKeyStoreField and GenericForeignKeyField 

    one returns the primary key while the other returns the full 

    instance. 

 

    """ 

 

    form2obj_default = None 

    "because checkboxes are not submitted when they are off" 

 

    list_values_count = 1 

    "Necessary to compute :attr:`Store.pk_index`." 

 

    def __init__(self, field, name, **options): 

        self.field = field 

        self.name = name 

        self.options = options 

 

    def as_js(self, name): 

        """ 

        Return a Javascript string which defines this atomizer as an 

        object. This is used by :mod:`lino.modlib.extjs.ext_renderer`. 

        and in case of virtual remote fields they use the 

        virtual field's delegate as_js method but with their own name. 

 

        """ 

        self.options.update(name=name) 

        return py2js(self.options) 

 

    def __repr__(self): 

        return "%s '%s'" % (self.__class__.__name__, self.name) 

 

    def column_names(self): 

        #~ if not self.options.has_key('name'): 

            #~ raise Exception("20130719 %s has no option 'name'" % self) 

        #~ yield self.options['name'] 

        yield self.name 

 

    def value_from_object(self, obj, ar): 

        """ 

         

        """ 

        return self.full_value_from_object(obj, ar) 

 

    def full_value_from_object(self, obj, ar): 

        return self.field.value_from_object(obj) 

 

    def value2list(self, ar, v, l, row): 

        return l.append(v) 

 

    def value2dict(self, v, d, row): 

        d[self.name] = v 

 

    #~ def value2odt(self,ar,v,tc,**params): 

        #~ """ 

        #~ Add the necessary :term:`odfpy` element(s) to the containing element `tc`. 

        #~ """ 

        #~ params.update(text=force_text(v)) 

        #~ tc.addElement(odf.text.P(**params)) 

 

    def parse_form_value(self, v, obj): 

        #~ if v == '' and not self.field.empty_strings_allowed: 

            #~ return None 

        return self.field.to_python(v) 

 

    def extract_form_data(self, post_data): 

        #~ logger.info("20130128 StoreField.extract_form_data %s",self.name) 

        return post_data.get(self.name, None) 

 

    def form2obj(self, ar, instance, post_data, is_new): 

        """ 

        Test cases: 

        - setting a CharField to '' 

        - sales.Invoice.number may be blank 

        """ 

        v = self.extract_form_data(post_data) 

        #~ logger.info("20130128 %s.form2obj() %s = %r",self.__class__.__name__,self.name,v) 

        if v is None: 

            # means that the field wasn't part of the submitted form. don't 

            # touch it. 

            return 

        if v == '': 

            #~ print 20130125, self.field.empty_strings_allowed, self.field.name, self.form2obj_default 

            if self.field.empty_strings_allowed: 

                v = self.parse_form_value(v, instance) 

 

                # If a field has been posted with empty string, we 

                # don't want it to get the field's default value! 

                # Otherwise checkboxes with default value True can 

                # never be unset! 

 

                # Charfields have empty_strings_allowed (e.g. id field 

                # may be empty) but don't do this for other cases. 

            else: 

                v = self.form2obj_default 

        else: 

            v = self.parse_form_value(v, instance) 

        if not is_new and self.field.primary_key and instance.pk is not None: 

            if instance.pk == v: 

                return 

            raise exceptions.ValidationError({ 

                self.field.name: _( 

                    "Existing primary key value %r " 

                    "may not be modified.") % instance.pk}) 

 

        return self.set_value_in_object(ar, instance, v) 

 

    def set_value_in_object(self, ar, instance, v): 

        old_value = self.value_from_object(instance, ar.request) 

        #~ old_value = getattr(instance,self.field.attname) 

        if old_value != v: 

            setattr(instance, self.name, v) 

            return True 

 

    def format_value(self, ar, v): 

        """ 

        Return a plain textual representation as a unicode string 

        of the given value `v`.   Note that `v` might be `None`. 

        """ 

        return force_text(v) 

 

 

class RelatedMixin(object): 

    """Common methods for :class:`ForeignKeyStoreField` and 

    :class:`OneToOneField`. 

 

    """ 

    def get_rel_to(self, obj): 

        #~ if self.field.rel is None: 

            #~ return None 

        return self.field.rel.model 

 

    def full_value_from_object(self, obj, ar): 

        # here we don't want the pk (stored in field's attname) 

        # but the full object this field refers to 

        relto_model = self.get_rel_to(obj) 

        if not relto_model: 

            #~ logger.warning("%s get_rel_to returned None",self.field) 

            return None 

        try: 

            return getattr(obj, self.name) 

        except relto_model.DoesNotExist: 

            return None 

 

 

class ComboStoreField(StoreField): 

    """An atomizer for all kinds of fields which use a ComboBox.""" 

    list_values_count = 2 

 

    def as_js(self, name): 

        s = StoreField.as_js(self, name) 

        #~ s += "," + repr(self.field.name+constants.CHOICES_HIDDEN_SUFFIX) 

        s += ", '%s'" % (name + constants.CHOICES_HIDDEN_SUFFIX) 

        return s 

 

    def column_names(self): 

        #~ yield self.options['name'] 

        #~ yield self.options['name'] + constants.CHOICES_HIDDEN_SUFFIX 

        yield self.name 

        yield self.name + constants.CHOICES_HIDDEN_SUFFIX 

 

    def extract_form_data(self, post_data): 

        #~ logger.info("20130128 ComboStoreField.extract_form_data %s",self.name) 

        return post_data.get(self.name + constants.CHOICES_HIDDEN_SUFFIX, None) 

 

    #~ def obj2list(self,request,obj): 

    def value2list(self, ar, v, l, row): 

        value, text = self.get_value_text(v, row) 

        l += [text, value] 

 

    #~ def obj2dict(self,request,obj,d): 

    def value2dict(self, v, d, row): 

        value, text = self.get_value_text(v, row) 

        d[self.name] = text 

        d[self.name + constants.CHOICES_HIDDEN_SUFFIX] = value 

 

    def get_value_text(self, v, obj): 

        #~ v = self.full_value_from_object(None,obj) 

        if v is None or v == '': 

            return (None, None) 

        if obj is not None: 

            ch = obj.__class__.get_chooser_for_field(self.field.name) 

            if ch is not None: 

                return (v, ch.get_text_for_value(v, obj)) 

        for i in self.field.choices: 

            if i[0] == v: 

                # return (v, i[1].encode('utf8')) 

                return (v, i[1]) 

        return (v, _("%r (invalid choice)") % v) 

 

 

class ForeignKeyStoreField(RelatedMixin, ComboStoreField): 

    """An atomizer used for all ForeignKey fields.""" 

    #~ def cell_html(self,req,row): 

        #~ obj = self.full_value_from_object(req,row) 

        #~ if obj is None: 

            #~ return '' 

        #~ return req.ui.obj2html(obj) 

 

    def get_value_text(self, v, obj): 

        #~ v = self.full_value_from_object(None,obj) 

        #~ if isinstance(v,basestring): 

            #~ logger.info("20120109 %s -> %s -> %r",obj,self,v) 

        if v is None: 

            return (None, None) 

        else: 

            return (v.pk, str(v)) 

 

    def parse_form_value(self, v, obj): 

        """Convert the form field value (expected to contain a primary key) 

        into the corresponding database object. If it is an invalid 

        primary key, return None. 

 

        If this comes from a *learning* ExtJS ComboBox 

        (i.e. :attr:`can_create_choice 

        <lino.core.choosers.Chooser.can_create_choice>` is True) the 

        value will be the text entered by the user. In that case, call 

        :meth:`create_choice 

        <lino.core.choosers.Chooser.create_choice>`. 

 

        """ 

        relto_model = self.get_rel_to(obj) 

        if not relto_model: 

            #~ logger.info("20111209 get_value_text: no relto_model") 

            return 

        try: 

            return relto_model.objects.get(pk=v) 

        except ValueError: 

            pass 

        except relto_model.DoesNotExist: 

            pass 

 

        if obj is not None: 

            ch = obj.__class__.get_chooser_for_field(self.field.name) 

            if ch and ch.can_create_choice: 

                return ch.create_choice(obj, v) 

        return None 

 

 

#~ class LinkedForeignKeyField(ForeignKeyStoreField): 

 

    #~ def get_rel_to(self,obj): 

        #~ ct = self.field.get_content_type(obj) 

        #~ if ct is None: 

            #~ return None 

        #~ return ct.model_class() 

 

 

class VirtStoreField(StoreField): 

 

    def __init__(self, vf, delegate, name): 

        self.vf = vf 

        StoreField.__init__(self, vf.return_type, name) 

        self.as_js = delegate.as_js 

        self.column_names = delegate.column_names 

        self.list_values_count = delegate.list_values_count 

        self.form2obj_default = delegate.form2obj_default 

        #~ 20130130 self.value2num = delegate.value2num 

        #~ 20130130 self.value2html = delegate.value2html 

        self.value2list = delegate.value2list 

        self.value2dict = delegate.value2dict 

        self.format_value = delegate.format_value 

        #~ 20130130 self.format_sum = delegate.format_sum 

        #~ 20130130 self.sum2html = delegate.sum2html 

        #~ self.form2obj = delegate.form2obj 

        # as long as http://code.djangoproject.com/ticket/15497 is open: 

        self.parse_form_value = delegate.parse_form_value 

        self.set_value_in_object = vf.set_value_in_object 

        #~ 20130130 self.apply_cell_format = delegate.apply_cell_format 

        #~ self.value_from_object = vf.value_from_object 

 

        self.delegate = delegate 

 

    def __repr__(self): 

        return '(virtual)' + self.delegate.__class__.__name__ + ' ' + self.name 

 

    def full_value_from_object(self, obj, ar): 

        # 20150218 : added new rule that virtual fields are never 

        # computed for unsaved instances. This is because 

        # `InsertRow.get_status` otherwise generated lots of useless 

        # slave summaries which furthermore caused an endless 

        # recursion problem. See test case in 

        # :ref:`welfare.tested.pcsw`. Note that `obj` does not need to 

        # be a database object. See 

        # e.g. :doc:`/tutorials/vtables/index`. 

        if ar.bound_action.action.hide_virtual_fields: 

        # if isinstance(obj, models.Model) and not obj.pk: 

            return None 

        return self.vf.value_from_object(obj, ar) 

 

 

class RequestStoreField(StoreField): 

    """ 

    StoreField for :class:`lino.core.fields.RequestField`. 

    """ 

 

    def __init__(self, vf, delegate, name): 

        self.vf = vf 

        StoreField.__init__(self, vf.return_type, name) 

        #~ self.editable = False 

        self.as_js = delegate.as_js 

        self.column_names = delegate.column_names 

        self.list_values_count = delegate.list_values_count 

 

    def full_value_from_object(self, obj, ar): 

        return self.vf.value_from_object(obj, ar) 

 

    def value2list(self, ar, v, l, row): 

        return l.append(self.format_value(ar, v)) 

 

    def value2dict(self, v, d, row): 

        d[self.name] = self.format_value(None, v) 

        #~ d[self.options['name']] = self.format_value(ui,v) 

        #~ d[self.field.name] = v 

 

    def format_value(self, ar, v): 

        if v is None: 

            return '' 

        return str(v.get_total_count()) 

 

    #~ def sum2html(self,ar,sums,i,**cellattrs): 

        #~ cellattrs.update(align="right") 

        #~ return super(RequestStoreField,self).sum2html(ar,sums,i,**cellattrs) 

 

    #~ def value2odt(self,ar,v,tc,**params): 

        #~ params.update(text=self.format_value(ar,v)) 

        #~ tc.addElement(odf.text.P(**params)) 

 

 

class PasswordStoreField(StoreField): 

 

    def value_from_object(self, obj, request): 

        v = super(PasswordStoreField, self).value_from_object(obj, request) 

        if v: 

            return "*" * len(v) 

        return v 

 

 

class SpecialStoreField(StoreField): 

    field = None 

    name = None 

    editable = False 

 

    def __init__(self, store): 

        self.options = dict(name=self.name) 

        self.store = store 

 

    def parse_form_value(self, v, instance): 

        pass 

 

    def form2obj(self, ar, instance, post_data, is_new): 

        pass 

        #~ raise NotImplementedError 

        #~ return instance 

 

 

class DisabledFieldsStoreField(SpecialStoreField): 

 

    """See also blog entries 20100803, 20111003, 20120901 

     

    Note some special cases: 

     

    - :attr:`lino.modlib.vat.mixins.VatDocument.total_incl` (readonly 

      virtual PriceField) must be disabled and may not get submitted. 

      ExtJS requires us to set this dynamically each time. 

 

    - JobsOverview.body (a virtual HtmlBox) or Model.workflow_buttons 

      (a displayfield) must *not* have the 'disabled' css class - 

 

    """ 

    name = 'disabled_fields' 

 

    def __init__(self, store): 

        from lino.core.gfks import GenericForeignKey 

        SpecialStoreField.__init__(self, store) 

        self.always_disabled = set() 

        for f in self.store.all_fields: 

            if f.field is not None: 

                if isinstance(f, VirtStoreField): 

                    if not f.vf.editable: 

                        if not isinstance( 

                                f.vf.return_type, fields.DisplayField): 

                            self.always_disabled.add(f.name) 

                            #~ print "20121010 always disabled:", f 

                elif not isinstance(f.field, GenericForeignKey): 

                    if not f.field.editable: 

                        self.always_disabled.add(f.name) 

 

    def full_value_from_object(self, obj, ar): 

        d = dict() 

        for name in self.store.actor.disabled_fields(obj, ar): 

            if name is not None: 

                d[name] = True 

 

        for name in self.always_disabled: 

            d[name] = True 

 

        # disable the primary key field of a saved instance. Note that 

        # pk might be set also on an unsaved instance and that 

 

        if ar.bound_action.action.disable_primary_key \ 

           and self.store.pk is not None: 

            for pk in self.store.primary_keys: 

                d[pk.attname] = True 

            # if self.store.pk.attname is None: 

            #     raise Exception('20130322b') 

            # d[self.store.pk.attname] = True 

            # # MTI children have an additional "primary key" for every 

            # # parent: 

            # pk = self.store.pk 

            # while isinstance(pk, models.OneToOneField): 

            #     if pk.rel.field_name is None: 

            #         raise Exception('20130322c') 

            #     d[pk.rel.field_name] = True 

            #     pk = None 

        return d 

 

 

class DisabledActionsStoreField(SpecialStoreField): 

 

    """ 

    """ 

    name = 'disabled_actions' 

 

    def full_value_from_object(self, obj, ar): 

        return self.store.actor.disabled_actions(ar, obj) 

 

 

#~ class RecnoStoreField(SpecialStoreField): 

    #~ name = 'recno' 

    #~ def full_value_from_object(self,request,obj): 

        #~ return 

 

class RowClassStoreField(SpecialStoreField): 

    name = 'row_class' 

 

    def full_value_from_object(self, obj, ar): 

        return ' '.join([ar.renderer.row_classes_map.get(s, '') 

                         for s in self.store.actor.get_row_classes(obj, ar)]) 

        #~ return ar.renderer.row_classes_map.get('x-grid3-row-%s' % s 

 

 

class DisableEditingStoreField(SpecialStoreField): 

 

    """ 

    A field whose value is the result of the `get_row_permission` 

    method on that row. 

    New feature since `/blog/2011/0830` 

    """ 

    name = 'disable_editing' 

 

    def full_value_from_object(self, obj, ar): 

        actor = self.store.actor 

        if actor.update_action is None: 

            #~ print 20120601, self.store.actor, "update_action is None" 

            return True  # disable editing if there's no update_action 

        v = actor.get_row_permission( 

            obj, ar, actor.get_row_state(obj), actor.update_action) 

        # if str(actor).startswith('aids.'): 

        #     logger.info("20141128 store.py %s %s value=%s", 

        #                 actor, actor.update_action, v) 

        return not v 

 

 

class BooleanStoreField(StoreField): 

    """A :class:`StoreField` for 

    `BooleanField <https://docs.djangoproject.com/en/dev/ref/models/fields/#booleanfield>`__. 

 

    """ 

 

    form2obj_default = False  # 'off' 

 

    def __init__(self, field, name, **kw): 

        kw['type'] = 'boolean' 

        StoreField.__init__(self, field, name, **kw) 

        if not field.editable: 

            def full_value_from_object(self, obj, ar): 

                #~ return self.value2html(ar,self.field.value_from_object(obj)) 

                return self.format_value(ar, self.field.value_from_object(obj)) 

            self.full_value_from_object = curry(full_value_from_object, self) 

 

    def parse_form_value(self, v, obj): 

        """ 

        Ext.ensible CalendarPanel sends boolean values as 

        """ 

        return constants.parse_boolean(v) 

 

    def format_value(self, ar, v): 

        return force_text(iif(v, _("Yes"), _("No"))) 

 

 

class DisplayStoreField(StoreField): 

    pass 

 

 

class GenericForeignKeyField(DisplayStoreField): 

 

    def full_value_from_object(self, obj, ar): 

        v = getattr(obj, self.name, None) 

        #~ logger.info("20130611 full_value_from_object() %s",v) 

        if v is None: 

            return '' 

        if ar is None: 

            return str(v) 

        if ar.renderer is None: 

            return str(v) 

        return ar.obj2html(v) 

 

 

class DecimalStoreField(StoreField): 

    #~ def __init__(self,field,name,**kw): 

        #~ kw['type'] = 'float' 

        #~ StoreField.__init__(self,field,name,**kw) 

 

    def parse_form_value(self, v, obj): 

        return parse_decimal(v) 

 

    #~ def value2num(self,v): 

        # ~ # print "20120426 %s value2num(%s)" % (self,v) 

        #~ return v 

 

    def format_value(self, ar, v): 

        if not v: 

            return '' 

        return settings.SITE.decfmt(v, places=self.field.decimal_places) 

 

    #~ def value2html(self,ar,v,**cellattrs): 

        #~ cellattrs.update(align="right") 

        #~ return E.td(self.format_value(ar,v),**cellattrs) 

 

 

class IntegerStoreField(StoreField): 

 

    def __init__(self, field, name, **kw): 

        kw['type'] = 'int' 

        StoreField.__init__(self, field, name, **kw) 

 

 

class AutoStoreField(StoreField): 

 

    """A :class:`StoreField` for  

    `AutoField <https://docs.djangoproject.com/en/dev/ref/models/fields/#autofield>`__ 

 

    """ 

 

    def __init__(self, field, name, **kw): 

        kw['type'] = 'int' 

        StoreField.__init__(self, field, name, **kw) 

 

    def form2obj(self, ar, obj, post_data, is_new): 

        #~ logger.info("20121022 AutoStoreField.form2obj(%r)",ar.bound_action.full_name()) 

        if isinstance(ar.bound_action.action, actions.InsertRow): 

            return super(AutoStoreField, self).form2obj( 

                ar, obj, post_data, is_new) 

 

 

class DateStoreField(StoreField): 

 

    def __init__(self, field, name, **kw): 

        kw['type'] = 'date' 

        # date_format # 'Y-m-d' 

        kw['dateFormat'] = settings.SITE.date_format_extjs 

        StoreField.__init__(self, field, name, **kw) 

 

    def parse_form_value(self, v, obj): 

        if v: 

            v = datetime.date(*settings.SITE.parse_date(v)) 

        else: 

            v = None 

        return v 

 

    def format_value(self, ar, v): 

        """Return a plain textual representation of this value as a unicode 

        string. 

 

        """ 

        return fds(v) 

 

 

class IncompleteDateStoreField(StoreField): 

 

    def parse_form_value(self, v, obj): 

        if v: 

            v = IncompleteDate(*settings.SITE.parse_date(v)) 

            #~ v = datetime.date(*settings.SITE.parse_date(v)) 

        return v 

 

 

class DateTimeStoreField(StoreField): 

 

    def parse_form_value(self, v, obj): 

        if v: 

            return settings.SITE.parse_datetime(v) 

        return None 

 

 

class TimeStoreField(StoreField): 

 

    def parse_form_value(self, v, obj): 

        if v: 

            return settings.SITE.parse_time(v) 

        return None 

 

 

class FileFieldStoreField(StoreField): 

 

    def full_value_from_object(self, obj, request): 

        ff = self.field.value_from_object(obj) 

        return ff.name 

 

 

class MethodStoreField(StoreField): 

 

    "Deprecated. See `/blog/2012/0327`." 

 

    def full_value_from_object(self, obj, request): 

        unbound_meth = self.field._return_type_for_method 

        assert unbound_meth.__code__.co_argcount >= 2, (self.name, 

                                                         unbound_meth.__code__.co_varnames) 

        #~ print self.field.name 

        return unbound_meth(obj, request) 

 

    def value_from_object(self, obj, request): 

        unbound_meth = self.field._return_type_for_method 

        assert unbound_meth.__code__.co_argcount >= 2, (self.name, 

                                                         unbound_meth.__code__.co_varnames) 

        #~ print self.field.name 

        return unbound_meth(obj, request) 

 

    #~ def obj2list(self,request,obj): 

        #~ return [self.value_from_object(request,obj)] 

 

    #~ def obj2dict(self,request,obj,d): 

        #  logger.debug('MethodStoreField.obj2dict() %s',self.field.name) 

        #~ d[self.field.name] = self.value_from_object(request,obj) 

 

    #~ def get_from_form(self,instance,post_data): 

        #~ pass 

 

    def form2obj(self, request, instance, post_data, is_new): 

        pass 

        #~ return instance 

        #raise Exception("Cannot update a virtual field") 

 

#~ class ComputedColumnField(StoreField): 

 

    #~ def value_from_object(self,ar,obj): 

        #~ m = self.field.func 

        # ~ # assert m.func_code.co_argcount >= 2, (self.field.name, m.func_code.co_varnames) 

        # ~ # print self.field.name 

        #~ return m(obj,ar)[0] 

 

    #~ def form2obj(self,request,instance,post_data,is_new): 

        #~ pass 

 

 

#~ class SlaveSummaryField(MethodStoreField): 

    #~ def obj2dict(self,request,obj,d): 

        #~ meth = getattr(obj,self.field.name) 

        # ~ #logger.debug('MethodStoreField.obj2dict() %s',self.field.name) 

        #~ d[self.field.name] = self.slave_report.() 

class OneToOneStoreField(RelatedMixin, StoreField): 

 

    def value_from_object(self, obj, request): 

        v = self.full_value_from_object(obj, request) 

        #~ try: 

            #~ v = getattr(obj,self.field.name) 

        #~ except self.field.rel.model.DoesNotExist,e: 

            #~ v = None 

        if v is None: 

            return None 

        return v.pk 

 

    #~ def obj2list(self,request,obj): 

        #~ return [self.value_from_object(request,obj)] 

 

    #~ def obj2dict(self,request,obj,d): 

        #~ d[self.field.name] = self.value_from_object(request,obj) 

 

 

def get_atomizer(model, fld, name): 

    """Return the atomizer for this database field. The atomizer is an 

    instance of a subclass of :class:`StoreField`. 

 

    """ 

    sf = getattr(fld, '_lino_atomizer', None) 

    if sf is None: 

        sf = create_atomizer(model, fld, name) 

        setattr(fld, '_lino_atomizer', sf) 

    return sf 

 

 

def create_atomizer(model, fld, name): 

    if isinstance(fld, fields.RemoteField): 

        """ 

        Hack: we create a StoreField based on the remote field, 

        then modify its behaviour. 

        """ 

        sf = create_atomizer(model, fld.field, fld.name) 

 

        def value_from_object(sf, obj, ar): 

            m = fld.func 

            return m(obj, ar) 

 

        def full_value_from_object(sf, obj, ar): 

            m = fld.func 

            v = m(obj, ar) 

            return v 

 

        sf.value_from_object = curry(value_from_object, sf) 

        sf.full_value_from_object = curry(full_value_from_object, sf) 

        return sf 

    meth = getattr(fld, '_return_type_for_method', None) 

    if meth is not None: 

        # uh, this is tricky... 

        return MethodStoreField(fld, name) 

 

    sf_class = getattr(fld, 'lino_atomizer_class', None) 

    if sf_class is not None: 

        return sf_class(fld, name) 

 

    if isinstance(fld, fields.DummyField): 

        return None 

    if isinstance(fld, fields.RequestField): 

        delegate = create_atomizer(model, fld.return_type, fld.name) 

        return RequestStoreField(fld, delegate, name) 

    if isinstance(fld, fields.VirtualField): 

        delegate = create_atomizer(model, fld.return_type, fld.name) 

        if delegate is None: 

            # e.g. VirtualField with DummyField as return_type 

            return None 

            # raise Exception("No atomizer for %s %s %s" % ( 

            #     model, fld.return_type, fld.name)) 

        return VirtStoreField(fld, delegate, name) 

    if isinstance(fld, models.FileField): 

        return FileFieldStoreField(fld, name) 

    if isinstance(fld, models.ManyToManyField): 

        return StoreField(fld, name) 

    if isinstance(fld, fields.PasswordField): 

        return PasswordStoreField(fld, name) 

    if isinstance(fld, models.OneToOneField): 

        return OneToOneStoreField(fld, name) 

 

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

        from lino.core.gfks import GenericForeignKey 

        if isinstance(fld, GenericForeignKey): 

            return GenericForeignKeyField(fld, name) 

        from lino.modlib.gfks.fields import GenericForeignKeyIdField 

        if isinstance(fld, GenericForeignKeyIdField): 

            return ComboStoreField(fld, name) 

 

    if isinstance(fld, models.ForeignKey): 

        return ForeignKeyStoreField(fld, name) 

    if isinstance(fld, models.TimeField): 

        return TimeStoreField(fld, name) 

    if isinstance(fld, models.DateTimeField): 

        return DateTimeStoreField(fld, name) 

    if isinstance(fld, fields.IncompleteDateField): 

        return IncompleteDateStoreField(fld, name) 

    if isinstance(fld, models.DateField): 

        return DateStoreField(fld, name) 

    if isinstance(fld, models.BooleanField): 

        return BooleanStoreField(fld, name) 

    if isinstance(fld, models.DecimalField): 

        return DecimalStoreField(fld, name) 

    if isinstance(fld, models.AutoField): 

        return AutoStoreField(fld, name) 

        #~ kw.update(type='int') 

    if isinstance(fld, models.SmallIntegerField): 

        return IntegerStoreField(fld, name) 

    if isinstance(fld, fields.DisplayField): 

        return DisplayStoreField(fld, name) 

    if isinstance(fld, models.IntegerField): 

        return IntegerStoreField(fld, name) 

    kw = {} 

    if choosers.uses_simple_values(model, fld): 

        return StoreField(fld, name, **kw) 

    else: 

        return ComboStoreField(fld, name, **kw) 

 

 

class BaseStore(object): 

    pass 

 

 

class ParameterStore(BaseStore): 

    # instantiated in `lino.core.layouts` 

    def __init__(self, params_layout_handle, url_param): 

        self.param_fields = [] 

 

        holder = params_layout_handle.layout.get_chooser_holder() 

        for pf in params_layout_handle._store_fields: 

            sf = create_atomizer(holder, pf, pf.name) 

            if sf is not None: 

                self.param_fields.append(sf) 

 

        self.param_fields = tuple(self.param_fields) 

        self.url_param = url_param 

        self.params_layout_handle = params_layout_handle 

 

    def __str__(self): 

        return "%s of %s" % ( 

            self.__class__.__name__, self.params_layout_handle) 

 

    def pv2dict(self, pv, **d): 

        for fld in self.param_fields: 

            v = pv.get(fld.name, None) 

            fld.value2dict(v, d, None) 

        return d 

 

    def pv2list(self, ar, pv, **d):  # new since 20140930 

        l = [] 

        for fld in self.param_fields: 

            v = pv.get(fld.name, None) 

            l.append(v) 

        return l 

 

    def parse_params(self, request, **kw): 

        data = getrqdata(request) 

        pv = data.getlist(self.url_param) 

        #~ logger.info("20120221 ParameterStore.parse_params(%s) --> %s",self.url_param,pv) 

 

        def parse(sf, form_value): 

            if form_value == '' and not sf.field.empty_strings_allowed: 

                return sf.form2obj_default 

                # When a field has been posted with empty string, we 

                # don't want it to get the field's default value 

                # because otherwise checkboxes with default value True 

                # can never be unset.  charfields have 

                # empty_strings_allowed e.g. id field may be empty. 

                # But don't do this for other cases. 

            else: 

                return sf.parse_form_value(form_value, None) 

 

        if len(pv) > 0: 

            if len(self.param_fields) != len(pv): 

                raise Exception( 

                    "%s expects a list of %d values but got %d: %s" % ( 

                        self, len(self.param_fields), len(pv), pv)) 

            for i, f in enumerate(self.param_fields): 

                kw[f.field.name] = parse(f, pv[i]) 

        return kw 

 

 

class Store(BaseStore): 

    """A Store is the collection of StoreFields for a given actor. 

 

    """ 

 

    pk = None 

 

    def __init__(self, rh, **options): 

        self.rh = rh 

        self.actor = rh.actor 

 

        # temporary dict used by collect_fields and add_field_for 

        self.df2sf = {} 

        self.all_fields = [] 

        self.list_fields = [] 

        self.detail_fields = [] 

        self.primary_keys = set([]) 

 

        def addfield(sf): 

            self.all_fields.append(sf) 

            self.list_fields.append(sf) 

            self.detail_fields.append(sf) 

 

        if not issubclass(rh.actor, frames.Frame): 

            self.collect_fields(self.list_fields, rh.get_list_layout()) 

 

        form = rh.actor.detail_layout 

        if form: 

            dh = form.get_layout_handle(settings.SITE.kernel.default_ui) 

            self.collect_fields(self.detail_fields, dh) 

 

        form = rh.actor.insert_layout 

        if form: 

            dh = form.get_layout_handle(settings.SITE.kernel.default_ui) 

            self.collect_fields(self.detail_fields, dh) 

 

        if self.pk is not None: 

            self.pk_index = 0 

            found = False 

            for fld in self.list_fields: 

                """ 

                Django's Field.__cmp__() does:: 

                 

                  return cmp(self.creation_counter, other.creation_counter) 

                   

                which causes an exception when trying to compare a field 

                with an object of other type. 

                """ 

                if (fld.field.__class__ is self.pk.__class__) \ 

                   and fld.field == self.pk: 

                    #~ self.pk = fld.field 

                    found = True 

                    break 

                self.pk_index += fld.list_values_count 

            if not found: 

                raise Exception("Primary key %s not found in list_fields %s" % 

                                (self.pk, self.list_fields)) 

 

        del self.df2sf 

 

        #~ if not issubclass(rh.report,dbtables.Table): 

            #~ addfield(RecnoStoreField(self)) 

 

        if rh.actor.editable:  # condition added 20131017 

 

            addfield(DisabledFieldsStoreField(self)) 

 

        addfield(DisabledActionsStoreField(self)) 

 

        if rh.actor.editable: 

            addfield(DisableEditingStoreField(self)) 

 

        if rh.actor.get_row_classes is not None: 

            addfield(RowClassStoreField(self)) 

 

        # virtual fields must come last so that Store.form2obj() 

        # processes "real" fields first. 

        self.all_fields = [ 

            f for f in self.all_fields if not isinstance(f, VirtStoreField) 

        ] + [ 

            f for f in self.all_fields if isinstance(f, VirtStoreField) 

        ] 

        self.all_fields = tuple(self.all_fields) 

        self.list_fields = tuple(self.list_fields) 

        self.detail_fields = tuple(self.detail_fields) 

 

    def collect_fields(self, fields, *layouts): 

        """`fields` is a pointer to either `self.detail_fields` or 

        `self.list_fields`.  Each of these must contain a primary key 

        field. 

 

        """ 

        pk_found = False 

        for layout in layouts: 

            for df in layout._store_fields: 

                assert df is not None 

                self.add_field_for(fields, df) 

                if df.primary_key: 

                    self.primary_keys.add(df) 

                    pk_found = True 

                    if self.pk is None: 

                        self.pk = df 

 

        if self.pk is None: 

            self.pk = self.actor.get_pk_field() 

        if self.pk is not None: 

            if not pk_found: 

                self.add_field_for(fields, self.pk) 

 

    def add_field_for(self, fields, df): 

        sf = get_atomizer(self.actor, df, df.name) 

        if sf is None:  # dummy fields 

            return 

        if not sf in self.all_fields: 

            self.all_fields.append(sf) 

 

        #~ sf = self.df2sf.get(df,None) 

        #~ if sf is None: 

            #~ sf = self.create_atomizer(df,df.name) 

            #~ self.all_fields.append(sf) 

            #~ self.df2sf[df] = sf 

        fields.append(sf) 

 

    def form2obj(self, ar, form_values, instance, is_new): 

        """Store the `form_values` into the `instance` by calling 

        :meth:`form2obj` for every store field. 

 

        """ 

        disabled_fields = set(self.actor.disabled_fields(instance, ar)) 

        changed_triggers = [] 

        for f in self.all_fields: 

            if f.name not in disabled_fields: 

                try: 

                    if f.form2obj(ar, instance, form_values, is_new): 

                        m = getattr(instance, f.name + "_changed", None) 

                        if m is not None: 

                            changed_triggers.append(m) 

                except exceptions.ValidationError as e: 

                    # logger.warning("20150127 store (field %s) : %s", 

                    #                f.name, e) 

                    raise exceptions.ValidationError({f.name: e.messages}) 

                except ValueError as e: 

                    # logger.warning("20150127 store (field %s) : %s", 

                    #                f.name, e) 

                    raise exceptions.ValidationError( 

                        {f.name: _("Invalid value for this field (%s).") % e}) 

                except Exception as e: 

                    logger.warning( 

                        "Exception during Store.form2obj (field %s) : %s", 

                        f.name, e) 

                    logger.exception(e) 

                    raise 

                # logger.info("20120228 Store.form2obj %s -> %s", 

                # f, dd.obj2str(instance)) 

        for m in changed_triggers: 

            m(ar) 

 

    def column_names(self): 

        l = [] 

        for fld in self.list_fields: 

            l += fld.column_names() 

        return l 

 

    def column_index(self, name): 

        """ 

        Used to set `disabled_actions_index`. 

        Was used to write definition of Ext.ensible.cal.CalendarMappings 

        and Ext.ensible.cal.EventMappings  

        """ 

        #~ logger.info("20111214 column_names: %s",list(self.column_names())) 

        return list(self.column_names()).index(name) 

 

    def row2list(self, request, row): 

        #~ assert isinstance(request,dbtables.AbstractTableRequest) 

        #~ if not isinstance(request,dbtables.ListActionRequest): 

            #~ raise Exception() 

        #~ logger.info("20120107 Store %s row2list(%s)", self.report.model, dd.obj2str(row)) 

        l = [] 

        if isinstance(row, PhantomRow): 

            for fld in self.list_fields: 

                fld.value2list(request, None, l, row) 

        #~ elif isinstance(row,actions.VirtualRow): 

            #~ for fld in self.list_fields: 

                #~ fld.value2list(request,None,l,row) 

        else: 

            for fld in self.list_fields: 

                v = fld.full_value_from_object(row, request) 

                fld.value2list(request, v, l, row) 

        #~ logger.info("20130611 Store row2list() --> %r", l) 

        return l 

 

    def row2dict(self, ar, row, fields=None, **d): 

        #~ assert isinstance(ar,dbtables.AbstractTableRequest) 

        #~ logger.info("20111209 Store.row2dict(%s)", dd.obj2str(row)) 

        if fields is None: 

            fields = self.detail_fields 

        for fld in fields: 

            # logger.info("20140429 Store.row2dict %s", fld) 

            v = fld.full_value_from_object(row, ar) 

            fld.value2dict(v, d, row) 

            # logger.info("20140429 Store.row2dict %s -> %s", fld, v) 

        return d 

 

    #~ def row2odt(self,request,fields,row,sums): 

        #~ for i,fld in enumerate(fields): 

            #~ if fld.field is not None: 

                #~ v = fld.full_value_from_object(request,row) 

                #~ if v is None: 

                    #~ yield '' 

                #~ else: 

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

                    #~ yield fld.value2odt(request,v)