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

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

# Copyright 2008-2015 Luc Saffre 

# License: BSD (see file COPYING for details) 

 

"""Database models for `lino.modlib.contacts`. 

 

- The :class:`Partner` model (and its two subclasses 

  :class:`Person` and :class:`Company`) 

 

- A :class:`CompanyType` model can be used to classify companies. 

 

- The :class:`Role` and :class:`RoleType` models store "who is who" 

  information. 

 

  TODO: rename :class:`Role` to "Contact", :class:`RoleType` to "Role" 

  and field `Contact.type` to `role`.  Move Partner, Person and 

  Company into a separate plugin "partners". 

 

.. autosummary:: 

 

""" 

 

 

from __future__ import unicode_literals 

from builtins import str 

from builtins import object 

 

import logging 

logger = logging.getLogger(__name__) 

 

 

from django.db import models 

from django.core.exceptions import ValidationError 

from django.conf import settings 

 

from lino.api import dd, _, pgettext 

from lino import mixins 

 

from lino.utils import join_words 

from lino.utils import join_elems 

 

from lino.modlib.countries.mixins import AddressLocation 

 

from lino.utils.xmlgen.html import E 

from lino.utils.addressable import Addressable 

 

 

from .mixins import ContactRelated, PartnerDocument, OldCompanyContact 

from .roles import ContactsUser, ContactsStaff 

 

from lino.mixins.human import name2kw, Human, Born 

 

 

PARTNER_NUMBERS_START_AT = 100  # used for generating demo data and tests 

 

 

@dd.python_2_unicode_compatible 

class Partner(mixins.Polymorphic, AddressLocation, Addressable): 

    """A Partner is any physical or moral person for which you want to 

    keep contact data (address, phone numbers, ...). 

 

    A :class:`Partner` can act as the recipient of a sales invoice, as 

    the sender of an incoming purchases invoice, ... 

 

    A Partner has at least a name and usually also an "official" address. 

 

    Predefined subclasses of Partners are :class:`Person` for physical 

    persons and :class:`Company` for companies, organisations and any 

    kind of non-formal Partners. 

 

    .. attribute:: name 

 

        The full name of this partner. Used for alphabetic 

        sorting. Subclasses may hide this field and fill it 

        automatically, e.g. saving a :class:`Person` will 

        automatically set her `name` field to "last_name, first_name". 

 

    .. attribute:: email 

 

        The primary email address. 

 

    """ 

    preferred_foreignkey_width = 20 

    # preferred width for ForeignKey fields to a Partner 

 

    class Meta(object): 

        app_label = 'contacts'  # avoid RemovedInDjango19Warning 

        abstract = dd.is_abstract_model(__name__, 'Partner') 

        verbose_name = _("Partner") 

        verbose_name_plural = _("Partners") 

 

    name = models.CharField(max_length=200, verbose_name=_('Name')) 

 

    language = dd.LanguageField() 

 

    email = models.EmailField(_('E-Mail'), blank=True)  # ,null=True) 

    url = models.URLField(_('URL'), blank=True) 

    phone = models.CharField(_('Phone'), max_length=200, blank=True) 

    gsm = models.CharField(_('GSM'), max_length=200, blank=True) 

    fax = models.CharField(_('Fax'), max_length=200, blank=True) 

 

    remarks = models.TextField(_("Remarks"), blank=True)  # ,null=True) 

 

    quick_search_fields = "name" 

 

    # print_labels = dd.PrintLabelsAction() 

 

    def on_create(self, ar): 

        self.language = ar.get_user().language 

        if not self.country: 

            sc = settings.SITE.site_config 

            if sc.site_company: 

                self.country = sc.site_company.country 

        super(Partner, self).on_create(ar) 

 

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

        if self.id is None: 

            sc = settings.SITE.site_config 

            if sc.next_partner_id is not None: 

                try: 

                    self.__class__.objects.get(id=sc.next_partner_id) 

                    raise ValidationError( 

                        "Cannot create partner with id={0}. " 

                        "Check your next_partner_id in SiteConfig!".format( 

                            sc.next_partner_id)) 

                except self.__class__.DoesNotExist: 

                    self.id = sc.next_partner_id 

                    sc.next_partner_id += 1 

                    sc.save() 

        #~ logger.info("20120327 Partner.save(%s,%s)",args,kw) 

        super(Partner, self).save(*args, **kw) 

 

    def __str__(self): 

        #~ return self.name 

        return self.get_full_name() 

 

    def address_person_lines(self): 

        #~ yield self.name 

        yield self.get_full_name() 

 

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

        """\ 

Returns a one-line string representing this Partner. 

The default returns simply the `name` field, ignoring any parameters, 

but e.g. :class:`Human` overrides this. 

        """ 

        return self.name 

    full_name = property(get_full_name) 

 

    @dd.displayfield(_("Name")) 

    def name_column(self, request): 

        #~ return join_words(self.last_name.upper(),self.first_name) 

        return str(self) 

 

    def get_partner_instance(self): 

        return self  # compatibility with lino.modlib.partners 

 

    @dd.displayfield() 

    def overview(self, ar): 

        return E.div(*self.get_overview_elems(ar)) 

 

    def get_overview_elems(self, ar): 

        elems = [] 

        if ar is None: 

            return elems 

        buttons = self.get_mti_buttons(ar) 

        # buttons = join_elems(buttons, ', ') 

        elems.append(E.p(str(_("See as ")), *buttons, 

                         style="font-size:8px;text-align:right;padding:3pt;")) 

        elems += self.get_name_elems(ar) 

        elems.append(E.br()) 

        elems += join_elems(list(self.address_location_lines()), sep=E.br) 

        elems = [ 

            E.div(*elems, 

                  style="font-size:18px;font-weigth:bold;" 

                  "vertical-align:bottom;text-align:middle")] 

        return elems 

 

    def get_name_elems(self, ar): 

        return [E.b(self.name)] 

 

    def get_print_language(self): 

        return self.language 

 

 

class PartnerDetail(dd.DetailLayout): 

 

    main = """ 

    address_box:60 contact_box:30 overview 

    bottom_box 

    """ 

 

    address_box = dd.Panel(""" 

    name_box 

    country region city zip_code:10 

    addr1 

    street_prefix street:25 street_no street_box 

    addr2 

    """, label=_("Address")) 

 

    contact_box = dd.Panel(""" 

    info_box 

    email:40 

    url 

    phone 

    gsm fax 

    """, label=_("Contact")) 

 

    bottom_box = """ 

    remarks 

    """ 

 

    name_box = "name" 

    info_box = "id language" 

 

 

class Partners(dd.Table): 

    required_roles = dd.required(ContactsUser) 

    model = 'contacts.Partner' 

    column_names = "name email * id" 

    order_by = ['name', 'id'] 

    detail_layout = PartnerDetail() 

    insert_layout = """ 

    name 

    language email 

    """ 

 

    @classmethod 

    def get_queryset(self, ar): 

        return self.model.objects.select_related('country', 'city') 

 

 

#~ class AllPartners(Partners): 

 

    #~ @classmethod 

    #~ def get_actor_label(self): 

        #~ return _("All %s") % self.model._meta.verbose_name_plural 

 

class PartnersByCity(Partners): 

    master_key = 'city' 

    order_by = 'street street_no street_box addr2'.split() 

    column_names = "street street_no street_box addr2 name language *" 

 

 

class PartnersByCountry(Partners): 

    master_key = 'country' 

    column_names = "city street street_no name language *" 

    order_by = "city street street_no".split() 

 

 

class Person(Human, Born, Partner): 

    """ 

    A physical person and an individual human being. 

    See also :ref:`lino.tutorial.human`. 

 

    """ 

    class Meta(object): 

        app_label = 'contacts' 

        abstract = dd.is_abstract_model(__name__, 'Person') 

        verbose_name = _("Person") 

        verbose_name_plural = _("Persons") 

        ordering = ['last_name', 'first_name'] 

 

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

        """Set the `name` field of this person.  This field is visible in the 

        Partner's detail but not in the Person's detail and serves for 

        sorting when selecting a Partner.  It also serves for quick 

        search on Persons. 

 

        """ 

        name = join_words(self.last_name, self.first_name) 

        if name: 

            self.name = name 

        else: 

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

                setattr(self, k, v) 

            # self.last_name = self.name 

        super(Person, self).full_clean(*args, **kw) 

 

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

        "Deserves more documentation." 

        # if self.title: 

        #     yield join_words(self.get_salutation(), self.title) 

        #     kw.update(salutation=False) 

        yield self.get_full_name(*args, **kw) 

 

    def get_name_elems(self, ar): 

        elems = [self.get_salutation(nominative=True), ' ', 

                 self.title, E.br()] 

        elems += [self.first_name, ' ', E.b(self.last_name)] 

        return elems 

 

 

class PersonDetail(PartnerDetail): 

 

    name_box = "last_name first_name:15 gender title:10" 

    info_box = "id:5 language:10" 

    bottom_box = "remarks contacts.RolesByPerson" 

 

 

class Persons(Partners): 

    """ 

    List of all Persons. 

    """ 

    required_roles = dd.required(ContactsUser) 

    model = "contacts.Person" 

    order_by = ["last_name", "first_name", "id"] 

    column_names = ( 

        "name_column:20 address_column email " 

        "phone:10 gsm:10 id language:10 *") 

    detail_layout = PersonDetail() 

 

    insert_layout = """ 

    first_name last_name 

    gender language 

    """ 

 

 

class CompanyType(mixins.BabelNamed): 

    """A type of organization. Used by :attr:`Company.type` field. 

 

    """ 

    class Meta(object): 

        app_label = 'contacts'  # avoid RemovedInDjango19Warning 

        abstract = dd.is_abstract_model(__name__, 'CompanyType') 

        verbose_name = _("Organization type") 

        verbose_name_plural = _("Organization types") 

 

    abbr = dd.BabelCharField(_("Abbreviation"), max_length=30, blank=True) 

 

 

class CompanyTypes(dd.Table): 

    required_roles = dd.required(ContactsStaff) 

    model = 'contacts.CompanyType' 

    column_names = 'name *' 

    #~ label = _("Company types") 

 

 

class Company(Partner): 

    """An organisation.  The internal name is "Company" for historical 

    reasons and because that's easier to type. 

 

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

 

  .. attribute:: type 

     

    Pointer to the :class:`CompanyType`. 

 

    """ 

    class Meta(object): 

        abstract = dd.is_abstract_model(__name__, 'Company') 

        app_label = 'contacts' 

        verbose_name = _("Organization") 

        verbose_name_plural = _("Organizations") 

 

    prefix = models.CharField( 

        _("Name prefix"), max_length=200, blank=True) 

 

    type = models.ForeignKey('contacts.CompanyType', blank=True, null=True) 

 

    def get_full_name(self, salutation=True, **salutation_options): 

        """Deserves more documentation.""" 

        #~ print '20120729 Company.get_full_name`' 

        if self.type: 

            return join_words(self.prefix, self.type.abbr, self.name) 

        return join_words(self.prefix, self.name) 

    full_name = property(get_full_name) 

 

    def get_name_elems(self, ar): 

        elems = [] 

        if self.prefix: 

            elems += [self.prefix, ' '] 

        elems += [E.b(self.name)] 

        return elems 

 

 

class CompanyDetail(PartnerDetail): 

 

    bottom_box = """ 

    remarks contacts.RolesByCompany 

    """ 

 

    name_box = "prefix:10 name type:30" 

 

 

class Companies(Partners): 

    required_roles = dd.required(ContactsUser) 

    model = "contacts.Company" 

    order_by = ["name"] 

    column_names = ( 

        "name_column:20 address_column email " 

        "phone:10 gsm:10 id language:10 *") 

    detail_layout = CompanyDetail() 

    insert_layout = """ 

    name 

    language:20 email:40 

    type id 

    """ 

 

#~ class List(Partner): 

    #~ pass 

 

#~ class Lists(Partners): 

    #~ model = List 

    #~ order_by = ["name"] 

    #~ detail_layout = """ 

    #~ id name 

    #~ language email 

    #~ MembersByList 

    #~ """ 

    #~ insert_layout = dd.FormLayout(""" 

    #~ name 

    #~ language email 

    #~ """,window_size=(40,'auto')) 

 

 

# class ContactType(mixins.BabelNamed): 

class RoleType(mixins.BabelNamed): 

 

    """A :class:`RoleType` is "what a given :class:`Person` can be for a 

    given :class:`Company`". 

 

    TODO: rename "RoleType" to "Function" or "ContactType". 

     

    RoleType,name is used at "in seiner Eigenschaft als ..."  in 

    document templates for contracts. 

 

    """ 

    class Meta(object): 

        app_label = 'contacts'  # avoid RemovedInDjango19Warning 

        abstract = dd.is_abstract_model(__name__, 'RoleType') 

        verbose_name = _("Function") 

        verbose_name_plural = _("Functions") 

 

 

class RoleTypes(dd.Table): 

    required_roles = dd.required(ContactsStaff) 

    model = 'contacts.RoleType' 

 

 

@dd.python_2_unicode_compatible 

class Role(dd.Model, Addressable): 

 

    """A Contact (historical model name :class:`Role`) is a 

    :class:`Person` who has a given role (:class:`ContactType`) in a 

    given :class:`Company`. 

     

    """ 

 

    class Meta(object): 

        app_label = 'contacts'  # avoid RemovedInDjango19Warning 

        abstract = dd.is_abstract_model(__name__, 'Role') 

        verbose_name = _("Contact Person") 

        verbose_name_plural = _("Contact Persons") 

 

    type = models.ForeignKey( 

        'contacts.RoleType', 

        blank=True, null=True, 

        verbose_name=_("Contact Role")) 

    person = models.ForeignKey( 

        "contacts.Person", related_name='rolesbyperson') 

    company = models.ForeignKey( 

        "contacts.Company", related_name='rolesbycompany') 

 

    def __str__(self): 

        if self.person_id is None: 

            return super(Role, self).__str__() 

        if self.type is None: 

            return str(self.person) 

        return u"%s (%s)" % (self.person, self.type) 

 

    def address_person_lines(self): 

        if self.company: 

            for ln in self.company.address_person_lines(): 

                yield ln 

        for ln in self.person.address_person_lines(): 

            yield ln 

 

    def address_location_lines(self): 

        if self.company_id: 

            return self.company.address_location_lines() 

        if self.person_id: 

            return self.person.address_location_lines() 

        return super(Role, self).__str__() 

 

    def get_print_language(self): 

        if self.company_id: 

            return self.company.language 

        if self.person_id: 

            return self.person.language 

        return super(Role, self).get_print_language() 

 

 

class Roles(dd.Table): 

    required_roles = dd.required(ContactsStaff) 

    model = 'contacts.Role' 

 

 

class RolesByCompany(Roles): 

    required_roles = dd.required(ContactsUser) 

    auto_fit_column_widths = True 

    #~ required_user_level = None 

    label = _("Contact persons") 

    master_key = 'company' 

    column_names = 'person type *' 

    hidden_columns = 'id' 

 

 

class RolesByPerson(Roles): 

    required_roles = dd.required(ContactsUser) 

    #~ required_user_level = None 

    label = _("Contact for") 

    master_key = 'person' 

    column_names = 'company type *' 

    auto_fit_column_widths = True 

    hidden_columns = 'id' 

 

dd.inject_field( 

    'system.SiteConfig', 

    'next_partner_id', 

    models.IntegerField( 

        default=PARTNER_NUMBERS_START_AT, 

        blank=True, null=True, 

        verbose_name=_("Next partner id"), 

        help_text=_("The next automatic id for any new partner."))) 

 

dd.inject_field( 

    'system.SiteConfig', 

    'site_company', 

    models.ForeignKey( 

        "contacts.Company", 

        blank=True, null=True, 

        verbose_name=_("Site owner"), 

        related_name='site_company_sites', 

        help_text=_("""The organisation who runs this site. 

        This is used e.g. as sender in documents. 

        Or, newly created partners inherit the country of the site owner. 

        """))) 

 

 

def site_setup(site): 

 

    site.modules.countries.Places.set_detail_layout(""" 

    name country 

    type parent zip_code id 

    PlacesByPlace 

    contacts.PartnersByCity 

    """) 

 

 

@dd.receiver(dd.pre_analyze) 

def company_model_alias(sender, **kw): 

    """ 

    prepare ticket #72 which will rename Company to Organisation 

    """ 

    sender.modules.contacts.Organisation = sender.modules.contacts.Company 

 

 

@dd.receiver(dd.post_analyze) 

def company_tables_alias(sender, **kw): 

    """ 

    prepare ticket #72 which will rename Company to Organisation 

    """ 

    sender.modules.contacts.Organisations = sender.modules.contacts.Companies 

 

 

def PartnerField(**kw): 

    return models.ForeignKey(Partner, **kw)