# To-do

* use `<detail>` elements for supporter page hidden sections, rather than complex jQuery - or consider Alpine.js

* replace `internalNavigate` with inline flexbox layout

* migrate to Django 4.2

* add deployment script that runs migrations and collects static files

* add tests for main pages returning 200

* switch to `path` in URLconfs

* review `apache2` directory - may be unused

* standardise settings to replace `settings.py` and `djangocommonsettings.py`

  with `settings/prod.py` and move `SECRET_KEY` to an environment variable

# Done

# You should have received a copy of the GNU Affero General Public License

# along with this program in a file in the toplevel directory called

# "AGPLv3".  If not, see <http://www.gnu.org/licenses/>.

#

from django.contrib import admin

from .models import Cast, CastTag

class CastTagAdmin(admin.ModelAdmin):

    prepopulated_fields = {'slug': ('label',)}

admin.site.register(CastTag, CastTagAdmin)

class CastAdmin(admin.ModelAdmin):

    list_display = ('pub_date', 'title')

    list_filter = ['pub_date']

    date_hierarchy = 'pub_date'

    search_fields = ['title', 'summary', 'body']

    prepopulated_fields = {'slug': ("title",)}

    filter_horizontal = ('tags',)

admin.site.register(Cast, CastAdmin)

#

# This program is distributed in the hope that it will be useful, but

# WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero

# General Public License for more details.

#

# You should have received a copy of the GNU Affero General Public License

# along with this program in a file in the toplevel directory called

# "AGPLv3".  If not, see <http://www.gnu.org/licenses/>.

#

from datetime import datetime

from django.contrib.sites.shortcuts import get_current_site

from django.contrib.syndication.views import Feed, add_domain

from django.shortcuts import render

from django.utils.feedgenerator import Rss201rev2Feed

from .models import Cast

# FIXME: Settings here should not be hard-coded for given casts, but

# should instead have settings from the main screen.

class CastFeedBase(Feed):

    def copyright_holder(self): return "Bradley M. Kuhn, Karen M. Sandler"

                if hasattr(getattr(item, attr), 'year'):

                    year = getattr(getattr(item, attr), 'year')

                    break

        return 'Copyright (C) %d, %s.  %s' % (year, self.copyright_holder(), self.license_no_html())

    def item_extra_kwargs(self, item):

        year = 2008

        for attr in ('pub_date', 'date_created', 'date_last_modified'):

            if hasattr(item, attr):

                if hasattr(getattr(item, attr), 'year'):

                    year = getattr(getattr(item, attr), 'year')

                    break

def for_podcast_feed_extra_kwargs(self, obj):

def for_podcast_item_extra_kwargs(self, item):

def podcast_helper_add_root_elements(self, handler):

                            + ' (' + self.feed['managingEditorNames'] + ')')

    handler.startElement('image', {})

    handler.addQuickElement('url', self.feed['rssImage']['url'])

    handler.addQuickElement('title', self.feed['author_name'])

    handler.addQuickElement('link', self.feed['link'])

    handler.addQuickElement('width', self.feed['rssImage']['width'])

    handler.addQuickElement('height', self.feed['rssImage']['height'])

    handler.endElement('image')

    handler.addQuickElement('webMaster', self.feed['webMaster'])

#    handler.addQuickElement('dc:creator', self.feed['dcCreator'])

    handler.addQuickElement('itunes:explicit', self.feed['iTunesExplicit'])

    handler.addQuickElement('itunes:block', self.feed['iTunesBlock'])

    handler.addQuickElement('generator', 'http://www.faif.us/code')

    handler.addQuickElement('media:thumbnail', '' , { 'url' : self.feed['rssImage']['url'] })

    handler.addQuickElement('itunes:image', '' , { 'href' : self.feed['iTunesImage']['url']})

#    handler.addQuickElement('itunes:link', '', { 'href' : self.feed['iTunesImage']['url'],

#                                                 'type' : self.feed['iTunesImage']['type']})

    handler.addQuickElement("media:category", self.feed['category']['name'],

    else:

        for cc in self.feed['category']['subcats']:

        handler.endElement("itunes:category")

    handler.addQuickElement("media:keywords", self.feed['keywords'].replace(" ", ","))

    handler.startElement("itunes:owner", {})

    handler.addQuickElement("itunes:email", self.feed['author_email'])

    handler.addQuickElement("itunes:name", self.feed['author_name'])

    handler.endElement("itunes:owner")

    handler.addQuickElement("itunes:summary", self.feed['description'])

    handler.addQuickElement("itunes:subtitle", self.feed['iTunesSubtitle'])

    handler.addQuickElement("itunes:author", self.feed['iTunesAuthor'])

    years = {}

    for ii in self.items: years[ii['year']] = 1

    copyrightString = ""

    ll = years.keys()

    sorted(ll)

    for yy in ll: copyrightString += "%d, " % yy 

    copyrightString += "%s.  %s" % (self.feed['copyrightHolder'], self.feed['copyrightLicense'])

    handler.addQuickElement('copyright', copyrightString)

    handler.addQuickElement('media:copyright', "Copyright (C) " + copyrightString)

def podcast_helper_add_item_elements(self, handler, item):

    handler.addQuickElement("itunes:explicit", self.feed['iTunesExplicit'])

    handler.addQuickElement("itunes:block", self.feed['iTunesBlock'])

    handler.addQuickElement("itunes:keywords", self.feed['keywords'])

#    handler.addQuickElement('dc:creator', self.feed['dcCreator'])

    handler.addQuickElement("itunes:author", item['author_name'])

    handler.addQuickElement("itunes:duration", item['duration'])

    if 'enclosure' in item:

# http://www.feedforall.com/itune-tutorial-tags.htm

# http://www.feedforall.com/mediarss.htm

class iTunesFeedType(Rss201rev2Feed):

    def root_attributes(self):

        attrs = super().root_attributes()

        attrs['xmlns:itunes'] = 'http://www.itunes.com/dtds/podcast-1.0.dtd'

        attrs['xmlns:atom'] = 'http://www.w3.org/2005/Atom'

        attrs['xmlns:media'] = 'http://search.yahoo.com/mrss/'

#        attrs['xmlns:dc'] = "http://purl.org/dc/elements/1.1/"

        return attrs

        return item.get_absolute_url()

    def item_author_email(self, obj):

        return "oggcast@faif.us"

    def item_author_name(self, obj):

        return "Software Freedom Conservancy"

    def item_author_link(self, obj):

        return "http://faif.us"

    def item_categories(self, item):

    def copyright_holder(self): return "Software Freedom Conservancy"

    def license_no_html(self): return "Licensed under a Creative Commons Attribution-Share Alike 3.0 USA License."

    def feed_extra_kwargs(self, obj):

        return for_podcast_feed_extra_kwargs(self, obj)

    def item_extra_kwargs(self, item):

        return for_podcast_item_extra_kwargs(self, item)

# GUEST NAME GOES HERE!!!

#<itunes:author>

#     If applicable, at the item level, this tag can contain information

#     about the person(s) featured on a specific episode.

class Mp3CastFeed(CastFeed):

    def item_enclosure_mime_type(self): return "audio/mpeg"

    def item_enclosure_url(self, item):

        return add_domain(self.current_site.domain, item.mp3_path, self.is_secure)

    def item_enclosure_length(self, item):

        return item.mp3_length

class OggCastFeed(CastFeed):

    def item_enclosure_mime_type(self): return "audio/ogg"

    def item_enclosure_url(self, item):

        return add_domain(self.current_site.domain, item.ogg_path, self.is_secure)

    def item_enclosure_length(self, item):

        return item.ogg_length

feed_dict = {

    'cast-ogg': OggCastFeed,

    'cast-mp3': Mp3CastFeed,

}

# make each feed know its canonical url

for k, v in feed_dict.items():

    v.get_absolute_url = '/feeds/%s/' % k

def view(request):

    """Listing of all available feeds

    """

    feeds = feed_dict.values()

    return render(request, "feeds.html", {'feeds': feeds})

# version 3 of the License, or (at your option) any later version of the

# AGPL published by the FSF.

#

# This program is distributed in the hope that it will be useful, but

# WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero

# General Public License for more details.

#

# You should have received a copy of the GNU Affero General Public License

# along with this program in a file in the toplevel directory called

# "AGPLv3".  If not, see <http://www.gnu.org/licenses/>.

from django.shortcuts import render

from .models import Cast

def view(request):

    """Cast front page view

    Performs all object queries necessary to render the front page.

    """

    cast = Cast.objects.all().filter(pub_date__lte=datetime.now())[:3]

        return super().get_queryset().filter(pub_date__year__gte=2024)

class Cast(models.Model):

    """Cast"""

    title = models.CharField(max_length=200)

    slug = models.SlugField(unique=True)

    summary = models.TextField(help_text="Use raw HTML.  This summary is not included at the beginning of the body when the entry is displayed.  It used only for the material on the front page.")

    body = models.TextField(help_text="Use raw HTML.  Include the full body of any show notes or other information about this episode.  It will be labelled on the site as Show Notes.  It is included on the detail entry, and in the description data on the cast RSS feed.")

    pub_date = models.DateTimeField()

    tags = models.ManyToManyField(CastTag, blank=True)

    ogg_length = models.IntegerField(blank=False, help_text="size in bytes of ogg file")

    mp3_length = models.IntegerField(blank=False, help_text="size in bytes of mp3 file")

    duration = models.CharField(max_length=8, blank=False, help_text="length in hh:mm:ss of mp3 file")

    date_created = models.DateTimeField(auto_now_add=True)

    date_last_modified = models.DateTimeField(auto_now=True)

    objects = CastManager()

    class Meta:

        db_table = 'casts_entries'  # legacy

        verbose_name_plural = 'casts'

        ordering = ('-pub_date',)

from datetime import datetime, timedelta

from django import template

register = template.Library()

@register.filter

def date_within_past_days(value, arg):

    # question: does datetime.now() do a syscall each time is it called?

    return value > (datetime.now() - timedelta(days=int(arg)))

# version 3 of the License, or (at your option) any later version of the

# AGPL published by the FSF.

#

# This program is distributed in the hope that it will be useful, but

# WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero

# General Public License for more details.

#

# You should have received a copy of the GNU Affero General Public License

# along with this program in a file in the toplevel directory called

# "AGPLv3".  If not, see <http://www.gnu.org/licenses/>.

from django.conf import settings

from django.views.generic.dates import (

    DateDetailView,

    DayArchiveView,

    MonthArchiveView,

    YearArchiveView,

)

from . import frontpage

from .models import Cast, CastTag

from .views import custom_index, query

app_name = 'podjango'

extra_context = {}

info_dict = {

    'queryset': Cast.objects.all(),

    'date_field': 'pub_date',

    'extra_context': extra_context,

    'template_name': 'podjango/cast/cast_detail.html',

}

    url(r'^(?P<year>\d{4})/$', YearArchiveView.as_view(**info_dict), name='year-archive'),

    url(r'^all/$', custom_index, dict(info_dict, paginate_by=20), name='cast'),

    url(r'^query/$', query, name='query'),

    url(r'^feeds/ogg/$', OggCastFeed(), name='feed-ogg'),

    url(r'^feeds/mp3/$', Mp3CastFeed(), name='feed-mp3'),

    url(r'^feeds/$', view, name='feeds'),

]

if settings.DEBUG:

  from django.conf.urls.static import static

  urlpatterns += static('/', document_root='podjango/static')

def all_tags_by_use_amount():

    """Returns all tags with an added 'cnt' attribute (how many times used)

    Also sorts the tags so most-used tags appear first.

    """

    # tally use amount

    retval = []

    current = None

    for obj in CastTag.objects.filter(cast__pub_date__lte=datetime.now(),

                                      cast__isnull=False).order_by('label'):

        if current is not None and obj.id == current.id:

        else:

            if current is not None:

                retval.append(current)

            current = obj

            current.cnt = 1

    if current is not None:

        retval.append(current)

    # sort and return

    retval.sort(key=lambda x: -x.cnt)

    return retval

# The functions are passed to the context uncalled so they will be

# called for each web request.  If we want to only make these database

# queries a single time when a web server process begins, call both

# functions below (i.e. make both lines below end in '()')

extra_context['all_tags'] = all_tags_by_use_amount

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero

# General Public License for more details.

#

# You should have received a copy of the GNU Affero General Public License

# along with this program in a file in the toplevel directory called

# "AGPLv3".  If not, see <http://www.gnu.org/licenses/>.

#

from datetime import datetime

from functools import reduce

from operator import or_

from django.shortcuts import get_object_or_404, render

def OR_filter(field_name, objs):

    from django.db.models import Q

    return reduce(or_,

                  [Q(**{field_name: x.id}) for x in objs])

def last_name(person):

    return person.formal_name.rpartition(' ')[2]

def custom_index(request, queryset, *args, **kwargs):

    """Cast list view that allows scrolling and also shows an index by

    year.

    """

    kwargs = kwargs.copy()

    kwargs['extra_context'] = kwargs.get('extra_context', {}).copy()

    extra_context = kwargs['extra_context']

    date_field = kwargs['date_field']

    del kwargs['date_field']

    if authors or tags:

        query_string = '&'.join(['author=%s' % a.username for a in authors]

                                + ['tag=%s' % t.slug for t in tags])

        extra_context['query_string'] = query_string

    else:

        date_list = queryset.dates(date_field, 'year')

        extra_context['date_list'] = date_list

    # TODO

    return render(request, 'podjango/cast/cast_list.html', {'object_list': queryset})

def query(request):

    """Page to query the cast based on and tags

    """

    if request.GET:

        d = request.GET.copy()

        if 'authors' in d.getlist('all'):

        if 'tags' in d.getlist('all'):

        base_url = '/cast/'

        if 'rss' in d:

            base_url = '/feeds/cast/'

        query_string = d.urlencode()

        return relative_redirect(request, '%s%s%s' % (base_url, '?' if query_string else '', query_string))

    else:

        tags = CastTag.objects.all().order_by('label')

        return render(request, 'podjango/cast/query.html', {'tags': tags})

def relative_redirect(request, path):

    from django import http

    from django.conf import settings

    host = http.get_host(request)

    if settings.FORCE_CANONICAL_HOSTNAME:

        host = settings.FORCE_CANONICAL_HOSTNAME

    url = "%s://%s%s" % (request.is_secure() and 'https' or 'http', host, path)

    return http.HttpResponseRedirect(url)