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

"""Django page CMS ``models``.""" 

 

from pages.utils import get_placeholders, normalize_url 

from pages.managers import PageManager, ContentManager 

from pages.managers import PageAliasManager 

from pages import settings 

 

from datetime import datetime 

from django.db import models 

from django.contrib.auth.models import User 

from django.utils.translation import ugettext_lazy as _ 

from django.utils.safestring import mark_safe 

from django.core.cache import cache 

from django.core.urlresolvers import reverse 

from django.contrib.sites.models import Site 

 

import mptt 

 

PAGE_CONTENT_DICT_KEY = ContentManager.PAGE_CONTENT_DICT_KEY 

 

 

class Page(models.Model): 

    """ 

    This model contain the status, dates, author, template. 

    The real content of the page can be found in the 

    :class:`Content <pages.models.Content>` model. 

 

    .. attribute:: creation_date 

       When the page has been created. 

 

    .. attribute:: publication_date 

       When the page should be visible. 

 

    .. attribute:: publication_end_date 

       When the publication of this page end. 

 

    .. attribute:: last_modification_date 

       Last time this page has been modified. 

 

    .. attribute:: status 

       The current status of the page. Could be DRAFT, PUBLISHED, 

       EXPIRED or HIDDEN. You should the property :attr:`calculated_status` if 

       you want that the dates are taken in account. 

 

    .. attribute:: template 

       A string containing the name of the template file for this page. 

    """ 

 

    # some class constants to refer to, e.g. Page.DRAFT 

    DRAFT = 0 

    PUBLISHED = 1 

    EXPIRED = 2 

    HIDDEN = 3 

    STATUSES = ( 

        (PUBLISHED, _('Published')), 

        (HIDDEN, _('Hidden')), 

        (DRAFT, _('Draft')), 

    ) 

 

    PAGE_LANGUAGES_KEY = "page_%d_languages" 

    PAGE_URL_KEY = "page_%d_language_%s_url" 

    PAGE_BROKEN_LINK_KEY = "page_broken_link_%s" 

 

    author = models.ForeignKey(User, verbose_name=_('author')) 

 

    parent = models.ForeignKey('self', null=True, blank=True, 

            related_name='children', verbose_name=_('parent')) 

    creation_date = models.DateTimeField(_('creation date'), editable=False, 

            default=datetime.now) 

    publication_date = models.DateTimeField(_('publication date'), 

            null=True, blank=True, help_text=_('''When the page should go 

            live. Status must be "Published" for page to go live.''')) 

    publication_end_date = models.DateTimeField(_('publication end date'), 

            null=True, blank=True, help_text=_('''When to expire the page. 

            Leave empty to never expire.''')) 

 

    last_modification_date = models.DateTimeField(_('last modification date')) 

 

    status = models.IntegerField(_('status'), choices=STATUSES, default=DRAFT) 

    template = models.CharField(_('template'), max_length=100, null=True, 

            blank=True) 

 

    delegate_to = models.CharField(_('delegate to'), max_length=100, null=True, 

            blank=True) 

 

    freeze_date = models.DateTimeField(_('freeze date'), 

            null=True, blank=True, help_text=_('''Don't publish any content 

            after this date.''')) 

 

    if settings.PAGE_USE_SITE_ID: 

        sites = models.ManyToManyField(Site, default=[settings.SITE_ID], 

                help_text=_('The site(s) the page is accessible at.'), 

                verbose_name=_('sites')) 

 

    redirect_to_url = models.CharField(max_length=200, null=True, blank=True) 

 

    redirect_to = models.ForeignKey('self', null=True, blank=True, 

            related_name='redirected_pages') 

 

    # Managers 

    objects = PageManager() 

 

    if settings.PAGE_TAGGING: 

        from tagging import fields 

        tags = fields.TagField(null=True) 

 

    # per instance cache 

    _languages = None 

    _complete_slug = None 

    _content_dict = None 

 

    class Meta: 

        """Make sure the default page ordering is correct.""" 

        ordering = ['tree_id', 'lft'] 

        get_latest_by = "publication_date" 

        verbose_name = _('page') 

        verbose_name_plural = _('pages') 

        permissions = settings.PAGE_EXTRA_PERMISSIONS 

 

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

        """Override the default ``save`` method.""" 

        if not self.status: 

            self.status = self.DRAFT 

        # Published pages should always have a publication date 

        if self.publication_date is None and self.status == self.PUBLISHED: 

            self.publication_date = datetime.now() 

        # Drafts should not, unless they have been set to the future 

        if self.status == self.DRAFT: 

            if settings.PAGE_SHOW_START_DATE: 

                if (self.publication_date and 

                        self.publication_date <= datetime.now()): 

                    self.publication_date = None 

            else: 

                self.publication_date = None 

        self.last_modification_date = datetime.now() 

        # let's assume there is no more broken links after a save 

        cache.delete(self.PAGE_BROKEN_LINK_KEY % self.id) 

        super(Page, self).save(*args, **kwargs) 

        # fix sites many-to-many link when the're hidden from the form 

        if settings.PAGE_HIDE_SITES and self.sites.count() == 0: 

            self.sites.add(Site.objects.get(pk=settings.SITE_ID)) 

 

    def _get_calculated_status(self): 

        """Get the calculated status of the page based on 

        :attr:`Page.publication_date`, 

        :attr:`Page.publication_end_date`, 

        and :attr:`Page.status`.""" 

        if settings.PAGE_SHOW_START_DATE and self.publication_date: 

            if self.publication_date > datetime.now(): 

                return self.DRAFT 

 

        if settings.PAGE_SHOW_END_DATE and self.publication_end_date: 

            if self.publication_end_date < datetime.now(): 

                return self.EXPIRED 

 

        return self.status 

    calculated_status = property(_get_calculated_status) 

 

    def get_children_for_frontend(self): 

        """Return a :class:`QuerySet` of published children page""" 

        return Page.objects.filter_published(self.get_children()) 

 

    def get_date_ordered_children_for_frontend(self): 

        """Return a :class:`QuerySet` of published children page ordered 

        by publication date.""" 

        return self.get_children_for_frontend().order_by('-publication_date') 

 

    def invalidate(self): 

        """Invalidate cached data for this page.""" 

 

        cache.delete(self.PAGE_LANGUAGES_KEY % (self.id)) 

        self._languages = None 

        self._complete_slug = None 

        self._content_dict = dict() 

 

        p_names = [p.name for p in get_placeholders(self.get_template())] 

        if 'slug' not in p_names: 

            p_names.append('slug') 

        if 'title' not in p_names: 

            p_names.append('title') 

        # delete content cache, frozen or not 

        for name in p_names: 

            # frozen 

            cache.delete(PAGE_CONTENT_DICT_KEY % 

                (self.id, name, 1)) 

            # not frozen 

            cache.delete(PAGE_CONTENT_DICT_KEY % 

                (self.id, name, 0)) 

 

        for lang in settings.PAGE_LANGUAGES: 

            cache.delete(self.PAGE_URL_KEY % (self.id, lang[0])) 

        cache.delete(self.PAGE_URL_KEY % (self.id, "None")) 

 

 

    def get_languages(self): 

        """ 

        Return a list of all used languages for this page. 

        """ 

        if self._languages: 

            return self._languages 

        self._languages = cache.get(self.PAGE_LANGUAGES_KEY % (self.id)) 

        if self._languages: 

            return self._languages 

 

        languages = [c['language'] for 

                            c in Content.objects.filter(page=self, 

                            type="slug").values('language')] 

        languages = list(set(languages)) # remove duplicates 

        languages.sort() 

        cache.set(self.PAGE_LANGUAGES_KEY % (self.id), languages) 

        self._languages = languages 

        return languages 

 

    def is_first_root(self): 

        """Return ``True`` if the page is the first root page.""" 

        if self.parent: 

            return False 

        return Page.objects.root()[0].id == self.id 

 

    def get_url_path(self, language=None): 

        """Return the URL's path component. Add the language prefix if 

        ``PAGE_USE_LANGUAGE_PREFIX`` setting is set to ``True``. 

 

        :param language: the wanted url language. 

        """ 

        url = reverse('pages-root') 

        if settings.PAGE_USE_LANGUAGE_PREFIX: 

            url += str(language) + '/' 

        return url + self.get_complete_slug(language) 

 

    def get_absolute_url(self, language=None): 

        """Alias for `get_url_path`. 

 

        This method is only there for backward compatibility and will be 

        removed in a near futur. 

 

        :param language: the wanted url language. 

        """ 

        return self.get_url_path(language=language) 

 

    def get_complete_slug(self, language=None): 

        """Return the complete slug of this page by concatenating 

        all parent's slugs. 

 

        :param language: the wanted slug language.""" 

        if self._complete_slug: 

            return self._complete_slug 

        self._complete_slug = cache.get(self.PAGE_URL_KEY % 

            (self.id, language)) 

        if self._complete_slug: 

            return self._complete_slug 

        if settings.PAGE_HIDE_ROOT_SLUG and self.is_first_root(): 

            url = '' 

        else: 

            url = u'%s' % self.slug(language) 

        for ancestor in self.get_ancestors(ascending=True): 

            url = ancestor.slug(language) + u'/' + url 

 

        cache.set(self.PAGE_URL_KEY % (self.id, language), url) 

        self._complete_slug = url 

        return url 

 

    def get_url(self, language=None): 

        """Alias for `get_complete_slug`. 

 

        This method is only there for backward compatibility and will be 

        removed in a near futur. 

 

        :param language: the wanted url language. 

        """ 

        return self.get_complete_slug(language=language) 

 

    def slug(self, language=None, fallback=True): 

        """ 

        Return the slug of the page depending on the given language. 

 

        :param language: wanted language, if not defined default is used. 

        :param fallback: if ``True``, the slug will also be searched in other \ 

        languages. 

        """ 

 

        slug = self.get_content(language, 'slug', language_fallback=fallback) 

 

        return slug 

 

    def title(self, language=None, fallback=True): 

        """ 

        Return the title of the page depending on the given language. 

 

        :param language: wanted language, if not defined default is used. 

        :param fallback: if ``True``, the slug will also be searched in \ 

        other languages. 

        """ 

        if not language: 

            language = settings.PAGE_DEFAULT_LANGUAGE 

 

        return self.get_content(language, 'title', language_fallback=fallback) 

 

    def get_content(self, language, ctype, language_fallback=False): 

        """Shortcut method for retrieving a piece of page content 

 

        :param language: wanted language, if not defined default is used. 

        :param ctype: the type of content. 

        :param fallback: if ``True``, the content will also be searched in \ 

        other languages. 

        """ 

        return Content.objects.get_content(self, language, ctype, 

            language_fallback) 

 

    def expose_content(self): 

        """Return all the current content of this page into a `string`. 

 

        This is used by the haystack framework to build the search index.""" 

        placeholders = get_placeholders(self.get_template()) 

        exposed_content = [] 

        for lang in self.get_languages(): 

            for p_name in [p.name for p in placeholders]: 

                content = self.get_content(lang, p_name, False) 

                if content: 

                    exposed_content.append(content) 

        return u"\r\n".join(exposed_content) 

 

    def get_template(self): 

        """ 

        Get the :attr:`template <Page.template>` of this page if 

        defined or the closer parent's one if defined 

        or :attr:`pages.settings.PAGE_DEFAULT_TEMPLATE` otherwise. 

        """ 

        if self.template: 

            return self.template 

 

        template = None 

        for p in self.get_ancestors(ascending=True): 

            if p.template: 

                template = p.template 

                break 

 

        if not template: 

            template = settings.PAGE_DEFAULT_TEMPLATE 

 

        return template 

 

    def get_template_name(self): 

        """ 

        Get the template name of this page if defined or if a closer 

        parent has a defined template or 

        :data:`pages.settings.PAGE_DEFAULT_TEMPLATE otherwise. 

        """ 

        template = self.get_template() 

        page_templates = settings.get_page_templates() 

        for t in page_templates: 

            if t[0] == template: 

                return t[1] 

        return template 

 

    def has_broken_link(self): 

        """ 

        Return ``True`` if the page have broken links to other pages 

        into the content. 

        """ 

        return cache.get(self.PAGE_BROKEN_LINK_KEY % self.id) 

 

    def valid_targets(self): 

        """Return a :class:`QuerySet` of valid targets for moving a page 

        into the tree. 

 

        :param perms: the level of permission of the concerned user. 

        """ 

        exclude_list = [self.id] 

        for p in self.get_descendants(): 

            exclude_list.append(p.id) 

        return Page.objects.exclude(id__in=exclude_list) 

 

    def slug_with_level(self, language=None): 

        """Display the slug of the page prepended with insecable 

        spaces equal to the level of page in the hierarchy.""" 

        level = '' 

        if self.level: 

            for n in range(0, self.level): 

                level += '&nbsp;&nbsp;&nbsp;' 

        return mark_safe(level + self.slug(language)) 

 

    def margin_level(self): 

        """Used in the admin menu to create the left margin.""" 

        return self.level * 2 

 

    def __unicode__(self): 

        """Representation of the page, saved or not.""" 

        if self.id: 

            slug = self.slug() 

            if slug: 

                return slug 

            return "Page %d" % self.id 

        return "Page without id" 

 

# Don't register the Page model twice. 

try: 

    mptt.register(Page) 

except mptt.AlreadyRegistered: 

    pass 

 

 

class Content(models.Model): 

    """A block of content, tied to a :class:`Page <pages.models.Page>`, 

    for a particular language""" 

 

    # languages could have five characters : Brazilian Portuguese is pt-br 

    language = models.CharField(_('language'), max_length=5, blank=False) 

    body = models.TextField(_('body')) 

    type = models.CharField(_('type'), max_length=100, blank=False, 

        db_index=True) 

    page = models.ForeignKey(Page, verbose_name=_('page')) 

 

    creation_date = models.DateTimeField(_('creation date'), editable=False, 

        default=datetime.now) 

    objects = ContentManager() 

 

    class Meta: 

        get_latest_by = 'creation_date' 

        verbose_name = _('content') 

        verbose_name_plural = _('contents') 

 

    def __unicode__(self): 

        return "%s :: %s" % (self.page.slug(), self.body[0:15]) 

 

 

class PageAlias(models.Model): 

    """URL alias for a :class:`Page <pages.models.Page>`""" 

    page = models.ForeignKey(Page, null=True, blank=True, 

        verbose_name=_('page')) 

    url = models.CharField(max_length=255, unique=True) 

    objects = PageAliasManager() 

    class Meta: 

        verbose_name_plural = _('Aliases') 

 

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

        # normalize url 

        self.url = normalize_url(self.url) 

        super(PageAlias, self).save(*args, **kwargs) 

 

    def __unicode__(self): 

        return "%s => %s" % (self.url, self.page.get_complete_slug())