Add support for flash messages to navbar template.

Add extra instance view support to CRUD viewsets.
Add starting_month to FeedCategory.
Update RSS feed day number calculation to take starting month and days
required into account.
Make import_from_excel management command atomic.
Add import from excel view to feed category.

base/templates/layouts/navbar.html

 </nav>
 
 <div class="container">
+  {% block messages %}
+    {% for message in messages %}
+      <div class="alert alert-dismissable{% if message.tags %} alert-{{ message.tags }}{% endif %}" role="alert">
+        <button type="button" class="close" data-dismiss="alert" aria-label="Close"><span aria-hidden="true">&times;</span></button>
+        {{ message }}
+      </div>
+    {% endfor %}
+  {% endblock %}
   {% block container_content %}{% endblock %}
 </div>
 {% endblock body_content %}

crud/viewsets.py

     instance_breadcrumb_text = u"{0}"
     instance_breadcrumb_view_type = DETAIL_VIEW_TYPE
 
+    extra_instance_views = []
+
     lookup_field = 'pk'
     lookup_url_kwarg = 'pk'
     lookup_url_kwarg_pattern = r'\d+'
 
         self.base_view_mixin = None
         self.views = {}
+        self.instance_view_types = set(INSTANCE_VIEW_TYPES)
+        self.extra_instance_view_types = set()
 
         self.exclude_views = set(self.exclude_views)
         if self.is_list_view_nested:
         self.generate_detail_view()
         self.generate_update_view()
         self.generate_delete_view()
+        self.generate_extra_instance_views()
 
         self.is_view_enabled = {view_type: view is not None for view_type, view in self.views.items()}
 
 
     def get_view_url_kwargs(self, view_type, view, instance=None):
         kwargs = {name: view.kwargs[name] for name in self.view_url_kwarg_names}
-        if view_type in INSTANCE_VIEW_TYPES:
+        if view_type in self.instance_view_types:
             if isinstance(instance, dict):
                 kwargs[self.lookup_url_kwarg] = instance.get(self.lookup_field)
             else:
         if not self.is_list_view_nested and self.is_view_enabled[LIST_VIEW_TYPE]:
             breadcrumbs.append(self.get_list_view_breadcrumb(view, GET, instance))
 
-        if view_type in INSTANCE_VIEW_TYPES:
+        if view_type in self.instance_view_types:
             breadcrumbs += [{
                 'text': self.get_instance_breadcrumb_text(view, instance),
                 'url': self.get_view_url(self.instance_breadcrumb_view_type, view, GET, instance)
             class BaseViewMixin(object):
                 viewset = self
                 view_type = None
-                final_breadcrumb = None
                 pk_url_kwarg = viewset.lookup_url_kwarg
 
                 def get_queryset(self):
                     return self.viewset.get_queryset(self)
 
-                def get_view_title(self):
-                    raise NotImplementedError
+                # Derived classes must inherit or define
+                # def get_view_title(self)
 
                 def get_cached_object(self, viewset=None):
                     return self.cached_objects[self.viewset if viewset is None else viewset]
                     viewset = self.viewset
 
                     breadcrumbs = viewset.get_breadcrumbs(self.view_type, self, self.request.GET)
-                    if self.final_breadcrumb is not None:
+                    final_breadcrumb = getattr(self, 'final_breadcrumb', None)
+                    if final_breadcrumb is not None:
                         breadcrumbs.append(
                             {
-                                'text': self.final_breadcrumb,
+                                'text': final_breadcrumb,
                                 # Includes the query string.
                                 'url': self.request.get_full_path()
                             }
                     context['is_view_enabled'] = viewset.is_view_enabled
                     context['actions'] = []
 
-                    if (self.view_type != LIST_VIEW_TYPE) and (viewset.is_list_view_nested or viewset.is_view_enabled[LIST_VIEW_TYPE]):
+                    if (self.view_type in viewset.extra_instance_view_types):
+                        back_url = viewset.get_view_url(self.viewset.instance_breadcrumb_view_type, self, self.request.GET, self.get_object())
+                    elif ((self.view_type != LIST_VIEW_TYPE) and (viewset.is_list_view_nested or viewset.is_view_enabled[LIST_VIEW_TYPE])):
+                        back_url = viewset.get_view_url(LIST_VIEW_TYPE, self, self.request.GET)
+                    else:
+                        back_url = None
+
+                    if back_url is not None:
                         context['actions'].append(
                             [
                                 {
                                     'type': 'button',
                                     'text': viewset.get_back_button_text(),
-                                    'url': viewset.get_view_url(LIST_VIEW_TYPE, self, self.request.GET),
+                                    'url': back_url,
                                     'button_class': viewset.get_back_button_class()
                                 }
                             ]
                             {
                                 'type': 'button',
                                 'id': 'id_edit_button',
-                                'url': viewset.get_view_url(UPDATE_VIEW_TYPE, self, self.request.GET, self.get_cached_object()),
+                                'url': viewset.get_view_url(UPDATE_VIEW_TYPE, self, self.request.GET, self.get_object()),
                                 'text': edit_button_text,
                                 'button_class': viewset.get_edit_button_class()
                             }
                             {
                                 'type': 'button',
                                 'id': 'id_delete_button',
-                                'url': viewset.get_view_url(DELETE_VIEW_TYPE, self, self.request.GET, self.get_cached_object()),
+                                'url': viewset.get_view_url(DELETE_VIEW_TYPE, self, self.request.GET, self.get_object()),
                                 'text': delete_button_text,
                                 'button_class': viewset.get_delete_button_class()
                             }
                         )
 
                 if action_group:
-                    context['actions'].append(action_group)
+                    # HACK: Insert after the back button and before any other
+                    # action groups.
+                    context['actions'].insert(min(1, len(context['actions'])), action_group)
 
                 context['nested_list_views'] = []
                 if self.viewset.nested_list_views:
                             [
                                 {
                                     'type': 'button',
-                                    'url': viewset.get_view_url(DELETE_VIEW_TYPE, self, self.request.GET, self.get_cached_object()),
+                                    'url': viewset.get_view_url(DELETE_VIEW_TYPE, self, self.request.GET, self.get_object()),
                                     'text': delete_button_text,
                                     'button_class': viewset.get_delete_button_class()
                                 }
 
         self.views[DELETE_VIEW_TYPE] = self.get_decorated_view(DeleteView)
 
+    def generate_extra_instance_views(self):
+        for instance_view in self.extra_instance_views:
+            my_view_type = instance_view['view_type']
+            if self.is_view_generated(my_view_type):
+                continue
+
+            class InstanceView(self.get_base_view_mixin(), instance_view['view_class']):
+                viewset = self
+                view_type = my_view_type
+
+                def dispatch(self, request, *args, **kwargs):
+                    self.populate_object_cache(self.viewset.get_object(self))
+                    return super(InstanceView, self).dispatch(request, *args, **kwargs)
+
+                def get_context_data(self, *args, **kwargs):
+                    context = super(InstanceView, self).get_context_data(*args, **kwargs)
+                    context['object'] = self.get_object()
+                    return context
+
+            self.views[my_view_type] = self.get_decorated_view(InstanceView)
+            self.instance_view_types.add(my_view_type)
+            self.extra_instance_view_types.add(my_view_type)
+
     @classmethod
     def urls(cls):
         viewset = cls()
         append_pattern(lookup_regex + 'update/$', UPDATE_VIEW_TYPE)
         append_pattern(lookup_regex + 'delete/$', DELETE_VIEW_TYPE)
 
+        for instance_view in viewset.extra_instance_views:
+            view_type = instance_view['view_type']
+            patterns.append(url(lookup_regex + instance_view['regex'], viewset.views[view_type], name=view_type))
+
         if not patterns:
             # If a viewset functions only as a nested list view then it will
             # not define any views of its own. We need at least one view URL

feed_content/management/commands/import_from_excel.py

 from django.core.management.base import BaseCommand, CommandError
+from django.db import transaction
 import xlrd
 from ... import models
 from pick import pick
     if index == 0:
         return
 
-    models.FeedItem.objects.filter(feed_category=category).delete()
-    for feed_item in feed_items:
-        models.FeedItem.objects.create(
-            feed_category=category,
-            day_number=feed_item['day'],
-            message_text=feed_item['message_text']
-        )
+    with transaction.atomic():
+        models.FeedItem.objects.filter(feed_category=category).delete()
+        for feed_item in feed_items:
+            models.FeedItem.objects.create(
+                feed_category=category,
+                day_number=feed_item['day'],
+                message_text=feed_item['message_text']
+            )
 
 class Command(BaseCommand):
     help = 'Imports feed items from an Excel spreedsheet.'

feed_content/migrations/0003_feedcategory_starting_month.py

+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.1 on 2017-06-02 14:44
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('feed_content', '0002_feedcategory_days_required'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='feedcategory',
+            name='starting_month',
+            field=models.PositiveIntegerField(choices=[(1, 'Jan'), (2, 'Feb'), (3, 'Mar'), (4, 'Apr'), (5, 'May'), (6, 'Jun'), (7, 'Jul'), (8, 'Aug'), (9, 'Sep'), (10, 'Oct'), (11, 'Nov'), (12, 'Dec')], default=1),
+        ),
+    ]

feed_content/models.py

     name = models.CharField(max_length=50, unique=True)
     description = models.CharField(max_length=255, blank=True)
     days_required = models.PositiveIntegerField(default=366)
+    starting_month = models.PositiveIntegerField(
+        default=1,
+        choices=(
+            (1, 'January'),
+            (2, 'February'),
+            (3, 'March'),
+            (4, 'April'),
+            (5, 'May'),
+            (6, 'June'),
+            (7, 'July'),
+            (8, 'August'),
+            (9, 'September'),
+            (10, 'October'),
+            (11, 'November'),
+            (12, 'December')
+        )
+    )
 
     class Meta:
         verbose_name = 'Category'

feed_content/templates/feed_content/feed_category_detail_view.html

   <div class="col-xs-10">{{ object.description }}</div>
 </div>
 <div class="row">
+  <div class="col-xs-2"><label>Starting Month</label></div>
+  <div class="col-xs-10">{{ object.get_starting_month_display }}</div>
+</div>
+<div class="row">
   <div class="col-xs-2"><label>Days Required</label></div>
   <div class="col-xs-10">{{ object.days_required }}</div>
 </div>

feed_content/templates/feed_content/feed_category_import_excel.html

+{% extends "crud/base.html" %}
+
+{% block cdn_js %}
+{{ block.super }}
+<script src="https://cdnjs.cloudflare.com/ajax/libs/xlsx/0.10.3/xlsx.full.min.js"></script>
+{% endblock %}
+
+{% block crud_view_css %}
+{{ block.super }}
+<style>
+  .sheet-required {
+    display: none;
+  }
+  #import_form {
+    display: none;
+  }
+</style>
+{% endblock %}
+
+{% block crud_view_content %}
+{{ block.super }}
+<div class="row">
+  <div class="col-xs-2"><label>Select workbook</label></div>
+  <div class="col-xs-10"><input type="file" id="file_input"></div>
+</div>
+<div class="row sheet-required">
+  <div class="col-xs-2"><label>Select worksheet</label></div>
+  <div class="col-xs-10"><select id="sheet_name_input"></select></div>
+</div>
+<div class="sheet-required">
+  <br>
+  <div id="sheet_status"></div>
+
+  <button type="button" class="btn btn-primary" id="import_button" data-toggle="modal" data-target="#confirm_import_modal">Import</button>
+
+  <h2><span class="sheet-name"></span> <span class="glyphicon glyphicon-arrow-right"></span> {{ object.name }}</h2>
+
+  <div id="sheet_contents"></div>
+
+  <div class="modal modal-fade" id="confirm_import_modal" tabindex="-1" role="dialog" aria-labelled-by="confirm_import_modal_title">
+    <div class="modal-dialog" role="document">
+      <div class="modal-content">
+        <div class="modal-header">
+          <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
+          <h4 class="modal-title" id="confirm_import_modal_title">Confirm import</h4>
+        </div>
+        <div class="modal-body">
+          <div class="container-responsive">
+            <div class="row">
+              <div class="col-md-4"><label>Source file</label></div>
+              <div class="col-md-8"><span class="workbook-name"></span></div>
+            </div>
+            <div class="row">
+              <div class="col-md-4"><label>Worksheet</label></div>
+              <div class="col-md-8"><span class="sheet-name"></span></div>
+            </div>
+            <div class="row">
+              <div class="col-md-4"><label>Destination category</label></div>
+              <div class="col-md-8">{{ object.name }}</div>
+            </div>
+            <div class="row">
+              <div class="col-md-4"><label>Number of days</label></div>
+              <div class="col-md-8"><span class="num-messages"></span></div>
+            </div>
+            <br>
+            <div class="alert alert-danger">
+              <strong>WARNING:</strong> All existing messages in the category will be removed and replaced with the imported messages.
+            </div>
+          </div>
+        </div>
+        <div class="modal-footer">
+          <button type="button" class="btn btn-primary" id="confirm_import_button">Confirm import</button>
+          <button type="button" class="btn btn-danger" data-dismiss="modal">Cancel</button>
+        </div>
+      </div>
+    </div>
+  </div>
+
+  <form action="" method="POST" id="import_form">
+    {% csrf_token %}
+    <input type="hidden" name="messages_json" id="messages_json">
+  </form>
+</div>
+{% endblock %}
+
+{% block crud_view_js %}
+{{ block.super }}
+<script>
+  'use strict';
+
+  var workbook = null;
+  var messages_to_import = null;
+
+  function set_status_error(message_html) {
+    messages_to_import = null;
+    $('#sheet_status').attr('class', 'alert alert-danger').html(message_html);
+    $('#import_button').prop('disabled', true);
+  }
+
+  function set_status_success(message_html) {
+    $('#sheet_status').attr('class', 'alert alert-success').html(message_html);
+    $('#import_button').prop('disabled', false);
+  }
+
+  function reset_workbook() {
+    workbook = null;
+    messages_to_import = null;
+    $('.sheet-required').hide();
+    $('.workbook-name').text('');
+    $('.sheet-name').text('');
+    $('.num-messages').text('');
+  }
+
+  function workbook_changed() {
+    try {
+      var sheet_name_input = $('#sheet_name_input');
+      sheet_name_input.empty();
+      workbook.SheetNames.forEach(function(name, index) {
+        sheet_name_input.append($('<option/>').val(index).text(name));
+      });
+      $('#sheet_name_input').change();
+      $('.sheet-required').show();
+    }
+    catch (err) {
+      reset_workbook();
+      alert("Error reading worksheet names: " + err);
+    }
+  }
+
+  function sheet_changed(index) {
+    try {
+      var sheet_name = workbook.SheetNames[index];
+      var sheet = workbook.Sheets[sheet_name];
+      $('.sheet-name').text(sheet_name);
+      $('#sheet_contents').html(XLSX.utils.sheet_to_html(sheet));
+      $('#sheet_contents table').addClass('table table-bordered table-striped table-hover');
+      var sheet_range = XLSX.utils.decode_range(sheet['!ref']);
+      var start_row = null;
+      var start_col = null;
+      var max_row = Math.min(sheet_range.e.r, sheet_range.s.r + 19);
+      for (var row = sheet_range.s.r; row <= max_row; row++) {
+        for (var col = sheet_range.s.c; col <= sheet_range.e.c; col++) {
+          var cell = sheet[XLSX.utils.encode_cell({r: row, c: col})];
+          if ((cell != null) && (cell.t == 's') && (cell.v.trim().toLowerCase() == 'day')) {
+            start_row = row + 1;
+            start_col = col;
+            break;
+          }
+        }
+      }
+      if (start_row == null) {
+        set_status_error('The worksheet does not contain a <strong>Day</strong> column in the first 20 rows.<br>Please select a different worksheet.');
+      }
+      else if (start_row > sheet_range.e.r) {
+        set_status_error('The <strong>Day</strong> column does not contain any data.');
+      }
+      else if (start_col >= sheet_range.e.c) {
+        set_status_error('There is no message text column to the right of the <strong>Day</strong> column.');
+      }
+      else {
+        var expected_day = 1;
+        var end_row = null;
+        var messages = [];
+        for (var row = start_row; row <= sheet_range.e.r; row++) {
+          var cell_address = XLSX.utils.encode_cell({r: row, c: start_col});
+          var cell = sheet[cell_address];
+          if ((cell == null) || (cell.t != 'n')) {
+            break;
+          }
+          var day = cell.v;
+          if (day != expected_day) {
+            set_status_error('Found day ' + day + ' instead of ' + expected_day + ' in cell ' + cell_address + '.');
+            return;
+          }
+
+          cell_address = XLSX.utils.encode_cell({r: row, c: start_col + 1});
+          cell = sheet[cell_address];
+          var message_text = (cell != null) && (cell.t == 's') ? cell.v.trim() : '';
+          if (message_text == '') {
+            set_status_error('No message text found for day ' + day + ' in cell ' + cell_address);
+            return;
+          }
+
+          messages.push({day: day, message_text: message_text});
+          expected_day++;
+          end_row = row;
+        }
+
+        if (end_row < sheet_range.e.r) {
+          var cell_address = XLSX.utils.encode_cell({r: end_row + 1, c: start_col});
+          var cell = sheet[cell_address];
+          if (cell != null) {
+            set_status_error('Found a non-numerical value "' + cell.v + '" in the day column in cell ' + cell_address + '.');
+            return;
+          }
+        }
+
+        messages_to_import = messages;
+        set_status_success('<p>Ready to import <strong>' + messages.length + '</strong> messages.</p><p><strong>WARNING:</strong> All existing messages in the category will be removed and replaced with the imported messages.</p><p>Click the <strong>Import</strong> button to continue.</p>');
+        $('.num-messages').text(messages.length);
+      }
+    }
+    catch (err) {
+      reset_workbook();
+      alert("Error reading worksheet: " + err);
+    }
+  }
+
+  function submit_imported_messages() {
+    if (messages_to_import == null) {
+      alert('There are no messages to import.');
+      return;
+    }
+    $('#messages_json').val(JSON.stringify(messages_to_import));
+    $('#import_form').submit();
+  }
+
+  $('#file_input').change(function(e) {
+    var file = this.files[0];
+    if (file) {
+      $('.workbook-name').text(file.name);
+      var reader = new FileReader();
+      reader.readAsBinaryString(file);
+      reader.onload = function(e) {
+        try {
+          workbook = XLSX.read(e.target.result, {type: 'binary'});
+          workbook_changed();
+        }
+        catch (err) {
+          reset_workbook();
+          alert("Error loading workbook: " + err);
+        }
+      };
+      reader.onerror = function(e) {
+        reset_workbook();
+        alert("Error reading file");
+      };
+    }
+  });
+
+  $('#sheet_name_input').change(function() {
+    sheet_changed($(this).val());
+  });
+
+  $('#confirm_import_button').click(function() {
+    submit_imported_messages();
+  });
+</script>
+{% endblock %}

feed_content/views.py

 # -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
-from django.shortcuts import render
+from django.shortcuts import render, redirect
+from django.views.generic import TemplateView
+from django.contrib import messages as flash_messages
+from django.db import transaction
+from . import models
+import json
 
-# Create your views here.
+#import logging
+#logger = logging.getLogger('console')
+
+class FeedCategoryImportExcelView(TemplateView):
+    template_name = 'feed_content/feed_category_import_excel.html'
+    final_breadcrumb = 'Import'
+
+    def get_view_title(self):
+        return 'Import {0} from Excel'.format(self.get_object().name)
+
+    def post(self, request, *args, **kwargs):
+        try:
+            viewset = self.viewset
+            category = self.get_object()
+
+            messages_json = request.POST.get('messages_json', '').strip()
+            if messages_json == '':
+                raise RuntimeError('No import data was specified.')
+
+            messages = json.loads(messages_json)
+            messages_to_import = []
+            expected_day = 1
+            for message in messages:
+                day = int(message['day'])
+                message_text = message['message_text'].strip()
+                if day != expected_day:
+                    raise RuntimeError('Expected day {0} but got day {1}.'.format(expected_day, day))
+                if message_text == '':
+                    raise RuntimeError('Message for day {0} is blank.'.format(day))
+                messages_to_import.append({'day': day, 'message_text': message_text})
+                expected_day += 1
+
+            if not messages_to_import:
+                raise RuntimeError('No import data was specified.')
+
+            with transaction.atomic():
+                models.FeedItem.objects.filter(feed_category=category).delete()
+                for message in messages_to_import:
+                    models.FeedItem.objects.create(
+                        feed_category=category,
+                        day_number=message['day'],
+                        message_text=message['message_text']
+                    )
+
+            flash_messages.add_message(request, flash_messages.SUCCESS, 'Import succeeded.');
+
+        except Exception as e:
+            flash_messages.add_message(request, flash_messages.ERROR, 'IMPORT FAILED: {0}'.format(e.message))
+
+        return redirect(viewset.get_view_url(viewset.instance_breadcrumb_view_type, self, request.GET, self.get_object()))

feed_content/viewsets.py

 from django.shortcuts import reverse
 from django.utils.text import mark_safe
 import django_filters
-from . import models
+from . import models, views
 
 class FeedCategoryFilterSet(django_filters.FilterSet):
     search_expr = django_filters.CharFilter(label='Search', method='filter_search_expr')
     delete = CrudLinkColumn('delete', text='', verbose_name='', orderable=False, attrs={'a': {'class': 'btn btn-danger btn-xs glyphicon glyphicon-remove', 'role': 'button'}})
 
     class Meta(BaseTable.Meta):
-        fields = ('name', 'description', 'rss_url', 'days_required', 'status', 'delete')
+        fields = ('name', 'description', 'rss_url', 'starting_month', 'days_required', 'status', 'delete')
         order_by = ('name',)
 
     def render_rss_url(self, value, bound_column):
 
     class Meta:
         model = models.FeedCategory
-        fields = ('name', 'description', 'days_required')
+        fields = ('name', 'description', 'starting_month', 'days_required')
 
 class FeedCategoryViewset(BaseViewset):
     lookup_url_kwarg = 'feed_category_id'
     detail_view_title = 'Category'
     detail_view_template_name = 'feed_content/feed_category_detail_view.html'
 
+    extra_instance_views = [
+        {
+            'view_type': 'import_excel',
+            'regex': r'import_excel/$',
+            'view_class': views.FeedCategoryImportExcelView
+        }
+    ]
+
     def get_queryset(self, view):
         return models.FeedCategory.objects.all()
 
+    def add_context_data(self, view, context):
+        super(FeedCategoryViewset, self).add_context_data(view, context)
+        if view.view_type == 'detail':
+            context['actions'].append(
+                [
+                    {
+                        'type': 'button',
+                        'text': 'Import from Excel',
+                        'url': self.get_view_url('import_excel', view, view.request.GET, view.get_object()),
+                        'button_class': 'btn-default'
+                    }
+                ]
+            )
 
 class FeedItemFilterSet(django_filters.FilterSet):
     day_number = django_filters.NumberFilter(label='Day')

rss/feeds.py

 
     def items(self, obj):
         now = datetime.now()
-        day_of_year = now.timetuple().tm_yday
+        now_tuple = now.timetuple()
+        starting_date = datetime(now_tuple.tm_year if now_tuple.tm_mon >= obj.starting_month else now_tuple.tm_year - 1, obj.starting_month, 1)
+        day_number = ((now - starting_date).days + 1) % obj.days_required
 
         try:
-            feed_item = FeedItem.objects.get(feed_category=obj, day_number=day_of_year)
+            feed_item = FeedItem.objects.get(feed_category=obj, day_number=day_number)
         except FeedItem.DoesNotExist:
             feed_item = None
 

sms_feed/settings.py

 """
 
 import os
+from django.contrib.messages import constants as messages
 
 
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
     }
 }
 
+MESSAGE_TAGS = {
+    messages.ERROR: 'danger'
+}
+
 from settings_local import *