typepadapp/admin.py

# Copyright (c) 2009-2010 Six Apart Ltd.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
#   this list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
#   this list of conditions and the following disclaimer in the documentation
#   and/or other materials provided with the distribution.
#
# * Neither the name of Six Apart Ltd. nor the names of its contributors may
#   be used to endorse or promote products derived from this software without
#   specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.

from django.contrib import admin
from django.contrib import messages
from django.db import transaction

from typepadapp.models.auth import Token
from typepadapp.models.feedsub import Subscription

import random
from string import ascii_letters, digits

from django.conf import settings
from urlparse import urlparse, urlunsplit
from django.core.urlresolvers import reverse

import urllib
from oauth import oauth

import typepad

from pprint import pprint as pp

import logging
log = logging.getLogger(__name__)

from django.contrib.sites.models import Site

def init_typepad():
    ###
    # setup for pushing to typepad
    for setting in ('OAUTH_CONSUMER_KEY', 'OAUTH_CONSUMER_SECRET', 'OAUTH_GENERAL_PURPOSE_KEY',
                    'OAUTH_GENERAL_PURPOSE_SECRET'):
        if not hasattr(settings, setting):
            raise Exception("Cannot initialize connection to Typepad: %s setting is required" % setting)
    
    ###
    # setup endpoint
    try:
        typepad.client.endpoint = settings.BACKEND_URL
    except AttributeError:
        typepad.client.endpoint = 'https://api.typepad.com'

    ###
    # apply any TYPEPAD_COOKIES declared
    try:
        typepad.client.cookies.update(settings.TYPEPAD_COOKIES)
    except AttributeError:
        pass


class SubscriptionAdmin(admin.ModelAdmin):

    model = Subscription
    list_display = ('name', 'feeds_list', 'filters_list','url_id', 'verified')
    search_fields = ['name','feeds','filters','verify_token']
    fieldsets = (
            (None, {
                'fields': ('name', 'feeds', 'filters')
            }),
            ('Advanced options', {
                'classes': ('collapse',),
                'fields': ('url_id', 'secret', 'verified', 'verify_token')
            }),
        )
    
    def feeds_list(self, obj):
        return ', '.join(obj.feeds.split('\n'))
    feeds_list.short_description = 'Feeds'

    def filters_list(self, obj):
        return ', '.join(obj.filters.split('\n'))
    filters_list.short_description = 'Filters'

    def save_model(self, request, obj, form, change):
        log.info('handle create/change subscription')
        
        
        if change:
            orig_obj = Subscription.objects.get(id = obj.id)
            orig_feeds = orig_obj.feeds
            log.debug('orig_feeds: %s' % orig_feeds)
            orig_filters = orig_obj.filters
            log.debug('orig_filters: %s' % orig_filters)
        
        init_typepad()
                
        ###
        # Setup for OAuth authentication
        consumer = oauth.OAuthConsumer(settings.OAUTH_CONSUMER_KEY, settings.OAUTH_CONSUMER_SECRET)
        token = oauth.OAuthToken(settings.OAUTH_GENERAL_PURPOSE_KEY, settings.OAUTH_GENERAL_PURPOSE_SECRET)
        backend = urlparse(typepad.client.endpoint)

        typepad.client.add_credentials(consumer, token, domain=backend[1])
                
        feed_idents = set(obj.feeds.split("\n"))
        if len(feed_idents) == 0:
            raise Exception("At least one feed URL parameter is required")
        
        filter_list = str(obj.filters).split("\n") or []

        current_site = Site.objects.get_current()
        domain = current_site.domain
        if domain == 'example.com':
            raise Exception("Your Django 'sites' have not been configured")
        
        secret=None
        #secret = ''.join(random.choice(ascii_letters+digits) for x in xrange(0,20))
        #obj.secret = secret
        
        # generate a verification token
        verify_token = ''.join(random.choice(ascii_letters+digits) for x in xrange(0,20))
        obj.verify_token = verify_token

        obj.save()
        transaction.commit()
                
        if (not change):
            log.info('WILL: create subscription in typepad')
            # new object
            # save to typepad
            try:
                callback_path = reverse('typepadapp.views.feedsub.callback', kwargs={'sub_id': str(obj.id)})
                callback_url = urlunsplit(('http', domain, callback_path, '', ''))
                
                application = typepad.Application.get_by_id(settings.APPLICATION_ID)
                
                resp = application.create_external_feed_subscription(
                    callback_url=callback_url,
                    feed_idents=feed_idents,
                    filter_rules=filter_list,
                    secret=secret,
                    verify_token=verify_token)
            except Exception, exc:
                resp = None
                messages.add_message(request, messages.ERROR, exc)
                log.exception(exc)

            if resp:
                # Meanwhile TypePad hit our callback, so reload the object to
                # preserve the new "verified" value.
                s = Subscription.objects.get(verify_token=verify_token)
                s.url_id = resp.subscription.url_id
                s.save()
                log.info("Created subscription %s (%s)." % (s.name, s.url_id))
                messages.add_message(request, messages.INFO, "Created remote subscription %s (%s)" % (s.name, s.url_id))
            else:
                # obj.delete()
                messages.add_message(request, messages.ERROR, "Subscription failed!")
                logging.getLogger(__name__).warning("Subscription failed.")
        else:
            log.info('WILL: update subscription in typepad')
            
            # collect data for sync to typepad
            orig_feeds = set(str(orig_feeds).rstrip().split("\n"))
            log.debug("orig feeds: %s" % orig_feeds)
            
            new_feeds = set(str(obj.feeds).rstrip().split("\n"))
            log.debug("new feeds: %s" % new_feeds)
                        
            try:
                typepad.client.batch_request()
                sub = typepad.ExternalFeedSubscription.get_by_url_id(obj.url_id)
                log.debug(sub)
                typepad.client.complete_batch()
                
                # in new_feeds but not in old_feeds -- add it
                add_feeds = new_feeds.difference(orig_feeds)
                log.info('add_feeds: %s' % ",".join(list(add_feeds)))
                if len(add_feeds):
                    log.info('Adding feeds: %s' % ",".join(list(add_feeds)))
                    sub.add_feeds(feed_idents=list(add_feeds))
                
                # in orig_feeds but not new_feeds -- remove it
                remove_feeds = orig_feeds.difference(new_feeds)
                log.info('remove_feeds: %s' % ",".join(list(remove_feeds)))
                if len(remove_feeds):
                    log.info('Removing feeds: %s' % ",".join(list(remove_feeds)))
                    sub.remove_feeds(feed_idents=list(remove_feeds))
                
                # in new_filters but not in old_filters -- add it
                if orig_filters != obj.filters:
                    log.info('Updating filters: %s' % obj.filters)
                    sub.update_filters(filter_rules=obj.filters)                

                callback_path = reverse('typepadapp.views.feedsub.callback', kwargs={'sub_id': str(obj.id)})
                callback_url = urlunsplit(('http', domain, callback_path, '', ''))

                verify_token = ''.join(random.choice(ascii_letters+digits) for x in xrange(0,20))
                obj.verify_token = verify_token
                obj.verified = False
                obj.save()
                transaction.commit()

                sub.update_notification_settings(callback_url=callback_url, verify_token=verify_token)
                print "Assigned new callback URL: %s" % callback_url
                
            except Exception, exc:
                messages.add_message(request, messages.ERROR, exc)
                messages.add_message(request, messages.ERROR, "Subscription update failed!")
                log.exception(exc)
                logging.warning("Subscription failed.")            

# django.db.models.signals.pre_delete
def delete_subscription(**kwargs):
    log.info('WILL: delete subscription')

    obj=kwargs['instance']
    url_id = obj.url_id
    
    init_typepad()
    
    if (url_id):
        ###
        # Setup for OAuth authentication
        consumer = oauth.OAuthConsumer(settings.OAUTH_CONSUMER_KEY, settings.OAUTH_CONSUMER_SECRET)
        token = oauth.OAuthToken(settings.OAUTH_GENERAL_PURPOSE_KEY, settings.OAUTH_GENERAL_PURPOSE_SECRET)
        backend = urlparse(typepad.client.endpoint)

        typepad.client.add_credentials(consumer, token, domain=backend[1])
        
        typepad.client.batch_request()
        try:
            subscription = typepad.ExternalFeedSubscription.get_by_url_id(url_id).delete()
            log.info("Subscription deleted from Typepad")
        except typepad.ExternalFeedSubscription.NotFound:
            log.error("Could not find subscription with URL_ID: %s to delete" % url_id)
        typepad.client.complete_batch()
            
admin.site.register(Subscription, SubscriptionAdmin)
admin.site.register(Token)

from django.db.models.signals import pre_delete
#pre_delete.connect(delete_subscription, sender=Subscription)

try:
    from typepadapp.models.auth import UserForTypePadUser
except ImportError:
    pass
else:
    admin.site.register(UserForTypePadUser)