Merge pull request #44 from BirkbeckCTP/bepress_books

Bepress books

Author: mauromsl

forms.py

@@ -44,7 +44,7 @@ class BookForm(forms.ModelForm):
 
     class Meta:
         model = models.Book
-        exclude = ('',)
+        exclude = ('keywords', 'publisher_notes')
         widgets = {
             'description': SummernoteWidget(),
             'date_published': DateInput(),

hooks.py

@@ -0,0 +1,11 @@
+from django.core.urlresolvers import reverse
+from django.template.loader import render_to_string
+
+from utils.function_cache import cache
+
+
+@cache(600)
+def nav_hook(context):
+    return '<li><a href="{url}"><i class="fa fa-book"></i> Books</a></li>'.format(
+        url=reverse('books_admin')
+    )

migrations/0019_auto_20220725_1704.py

@@ -0,0 +1,128 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.29 on 2022-07-25 17:04
+from __future__ import unicode_literals
+
+import core.model_utils
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('submission', '0069_delete_blank_keywords'),
+        ('books', '0018_auto_20210813_1527'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='KeywordBook',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('order', models.PositiveIntegerField(default=1)),
+            ],
+            options={
+                'ordering': ['order'],
+            },
+        ),
+        migrations.CreateModel(
+            name='KeywordChapter',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('order', models.PositiveIntegerField(default=1)),
+            ],
+            options={
+                'ordering': ['order'],
+            },
+        ),
+        migrations.CreateModel(
+            name='PublisherNote',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('note', models.TextField(blank=True, null=True)),
+            ],
+        ),
+        migrations.AddField(
+            model_name='book',
+            name='date_embargo',
+            field=models.DateField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='chapter',
+            name='date_embargo',
+            field=models.DateField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='chapter',
+            name='date_published',
+            field=models.DateField(blank=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name='chapter',
+            name='number',
+            field=models.CharField(blank=True, help_text='The chapter number eg. 7 or VII', max_length=64, null=True),
+        ),
+        migrations.AddField(
+            model_name='keywordchapter',
+            name='chapter',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='books.Chapter'),
+        ),
+        migrations.AddField(
+            model_name='keywordchapter',
+            name='keyword',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='submission.Keyword'),
+        ),
+        migrations.AddField(
+            model_name='keywordbook',
+            name='book',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='books.Book'),
+        ),
+        migrations.AddField(
+            model_name='keywordbook',
+            name='keyword',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='submission.Keyword'),
+        ),
+        migrations.AddField(
+            model_name='book',
+            name='keywords',
+            field=core.model_utils.M2MOrderedThroughField(blank=True, null=True, through='books.KeywordBook', to='submission.Keyword'),
+        ),
+        migrations.AddField(
+            model_name='book',
+            name='publisher_notes',
+            field=models.ManyToManyField(blank=True, help_text='Free-text public publisher notes regarding this book', null=True, related_name='book', to='books.PublisherNote'),
+        ),
+        migrations.AddField(
+            model_name='chapter',
+            name='keywords',
+            field=core.model_utils.M2MOrderedThroughField(blank=True, null=True, through='books.KeywordChapter', to='submission.Keyword'),
+        ),
+        migrations.AddField(
+            model_name='chapter',
+            name='publisher_notes',
+            field=models.ManyToManyField(blank=True, help_text='Free-text public publisher notes regarding this book', null=True, related_name='chapter', to='books.PublisherNote'),
+        ),
+        migrations.AlterUniqueTogether(
+            name='keywordchapter',
+            unique_together=set([('keyword', 'chapter')]),
+        ),
+        migrations.AlterUniqueTogether(
+            name='keywordbook',
+            unique_together=set([('keyword', 'book')]),
+        ),
+        migrations.AlterField(
+            model_name='book',
+            name='description',
+            field=models.TextField(blank=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name='book',
+            name='pages',
+            field=models.PositiveIntegerField(blank=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name='chapter',
+            name='pages',
+            field=models.PositiveIntegerField(blank=True, null=True),
+        ),
+    ]

migrations/0020_auto_20220823_0931.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.29 on 2022-08-23 09:31
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('books', '0019_auto_20220725_1704'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='book',
+            name='custom_how_to_cite',
+            field=models.TextField(blank=True, help_text="Custom 'how to cite' text. To be used only if the block generated by Janeway is not suitable.", null=True),
+        ),
+        migrations.AddField(
+            model_name='chapter',
+            name='custom_how_to_cite',
+            field=models.TextField(blank=True, help_text="Custom 'how to cite' text. To be used only if the block generated by Janeway is not suitable.", null=True),
+        ),
+    ]

models.py

@@ -14,11 +14,12 @@
 from django.utils import timezone
 from django.core.exceptions import ValidationError
 
+from core import models as core_models
+from core.file_system import JanewayFileSystemStorage
+from core.model_utils import M2MOrderedThroughField
 from metrics.logic import get_iso_country_code
 from utils.shared import get_ip_address
-from core import models as core_models
 from plugins.books import files
-from core.file_system import JanewayFileSystemStorage
 
 
 fs = JanewayFileSystemStorage()
@@ -42,7 +43,7 @@ class BookSetting(models.Model):
 
     def save(self, *args, **kwargs):
         if not self.pk and BookSetting.objects.exists():
-            raise ValidationError('There is can be only one BookSetting instance')
+            raise ValidationError('There can be only one BookSetting instance')
         return super(BookSetting, self).save(*args, **kwargs)
 
 
@@ -87,11 +88,15 @@ class Book(models.Model):
         null=True,
         on_delete=models.SET_NULL,
     )
-    description = models.TextField()
-    pages = models.PositiveIntegerField()
+    description = models.TextField(null=True, blank=True)
+    pages = models.PositiveIntegerField(null=True, blank=True)
 
     is_edited_volume = models.BooleanField(default=False)
     is_open_access = models.BooleanField(default=True)
+    date_embargo = models.DateField(
+        blank=True,
+        null=True,
+    )
     date_published = models.DateField(
         blank=True,
         null=True,
@@ -126,14 +131,37 @@ class Book(models.Model):
         help_text="Add copyright and/or license information here.",
     )
 
+    keywords = M2MOrderedThroughField(
+        'submission.Keyword',
+        blank=True, null=True, through='books.KeywordBook',
+    )
+    publisher_notes = models.ManyToManyField(
+        'books.PublisherNote',
+        null=True,
+        blank=True,
+        related_name="book",
+        help_text='Free-text public publisher notes regarding this book',
+    )
+
+    custom_how_to_cite = models.TextField(
+        blank=True, null=True,
+        help_text="Custom 'how to cite' text. To be used only if the block"
+            " generated by Janeway is not suitable.",
+    )
+
+
     def __str__(self):
         return self.title
 
+    @property
     def citation(self):
-        return "{authors} {year}. <em>{title}</em>".format(
-            authors=self.contributors_citation(),
-            year=self.date_published.year,
-            title=self.full_title(),
+        return (
+            self.custom_how_to_cite
+            or "{authors} {year}. <em>{title}</em>".format(
+                authors=self.contributors_citation(),
+                year=self.date_published.year,
+                title=self.full_title(),
+            )
         )
 
     def contributors_citation(self):
@@ -367,18 +395,27 @@ class Chapter(models.Model):
         max_length=255,
     )
     description = models.TextField()
-    pages = models.PositiveIntegerField()
+    pages = models.PositiveIntegerField(blank=True, null=True)
     doi = models.CharField(
         max_length=200,
         blank=True,
         null=True,
         verbose_name='DOI',
         help_text='10.xxx/1234',
     )
-    number = models.PositiveIntegerField(
+    number = models.CharField(
+        blank=True,
+        null=True,
+        max_length=64,
+        help_text='The chapter number eg. 7 or VII',
+    )
+    date_embargo = models.DateField(
+        blank=True,
+        null=True,
+    )
+    date_published = models.DateField(
         blank=True,
         null=True,
-        help_text='The chapter number eg. 1',
     )
     sequence = models.PositiveIntegerField(
         help_text='The order in which the chapters should appear.',
@@ -397,6 +434,24 @@ class Chapter(models.Model):
         help_text="Add copyright and/or license information here. "
                   "If left blank will display book version of this field.",
     )
+    keywords = M2MOrderedThroughField(
+        'submission.Keyword',
+        blank=True, null=True, through='books.KeywordChapter',
+    )
+    publisher_notes = models.ManyToManyField(
+        'books.PublisherNote',
+        null=True,
+        blank=True,
+        related_name="chapter",
+        help_text='Free-text public publisher notes regarding this book',
+    )
+
+    custom_how_to_cite = models.TextField(
+        blank=True, null=True,
+        help_text="Custom 'how to cite' text. To be used only if the block"
+            " generated by Janeway is not suitable.",
+    )
+
 
     class Meta:
         ordering = ('sequence', 'number',)
@@ -445,3 +500,76 @@ def add_book_access(self, request, access_type='download'):
                     country=country,
                     identifier=identifier,
                 )
+
+
+    @property
+    def citation(self):
+        return (
+            self.custom_how_to_cite
+            or "{authors} {year}. <em>{title}</em>. In {book}".format(
+                authors=self.contributors_citation(),
+                year=self.date_published.year,
+                title=self.title,
+                book=self.book.citation,
+            )
+        )
+
+    def contributors_citation(self):
+        contributors = self.contributors.all()
+
+        if contributors.count() == 1:
+            return '{contributor} '.format(
+                contributor=contributors[0].citation_name()
+            )
+        elif contributors.count() == 2:
+            return '{contributor_one} & {contributor_two} '.format(
+                contributor_one=contributors[0].citation_name(),
+                contributor_two=contributors[1].citation_name(),
+            )
+        else:
+            return '{contributor} et al. '.format(contributor=contributors[0])
+
+
+class KeywordBook(models.Model):
+    keyword = models.ForeignKey(
+        "submission.Keyword",
+        on_delete=models.CASCADE,
+    )
+    book = models.ForeignKey("books.Book")
+    order = models.PositiveIntegerField(default=1)
+
+    class Meta:
+        ordering = ["order"]
+        unique_together = ('keyword', 'book')
+
+    def __str__(self):
+        return self.keyword.word
+
+    def __repr__(self):
+        return "KeywordBook(%s, %d)" % (self.keyword.word, self.book.id)
+
+
+class KeywordChapter(models.Model):
+    keyword = models.ForeignKey(
+        "submission.Keyword",
+        on_delete=models.CASCADE,
+    )
+    chapter = models.ForeignKey(
+        "books.Chapter",
+        on_delete=models.CASCADE,
+    )
+    order = models.PositiveIntegerField(default=1)
+
+    class Meta:
+        ordering = ["order"]
+        unique_together = ('keyword', 'chapter')
+
+    def __str__(self):
+        return self.keyword.word
+
+    def __repr__(self):
+        return "KeywordChapter(%s, %d)" % (self.keyword.word, self.chapter.id)
+
+
+class PublisherNote(models.Model):
+    note = models.TextField(blank=True, null=True)