instagram.py

"""Instagram API code and datastore model classes.

Example post ID and links:

* id: 595990791004231349 or 595990791004231349_247678460 (suffix is user id)
* Permalink: http://instagram.com/p/hFYnd7Nha1/
* API URL: https://api.instagram.com/v1/media/595990791004231349
* Local handler path: /post/instagram/212038/595990791004231349

Example comment ID and links:

* id: 595996024371549506
  No direct API URL or permalink, as far as I can tell. :/
* API URL for all comments on that picture:
  https://api.instagram.com/v1/media/595990791004231349_247678460/comments
* Local handler path:
  /comment/instagram/212038/595990791004231349_247678460/595996024371549506
"""
from __future__ import unicode_literals

from future import standard_library
standard_library.install_aliases()
import datetime
import logging
import urllib.parse

import appengine_config
from granary import instagram as gr_instagram
from granary import microformats2
from granary import source as gr_source
from oauth_dropins import indieauth
# InstagramAuth entities are loaded here
from oauth_dropins import instagram as oauth_instagram
from oauth_dropins.webutil.handlers import TemplateHandler
from oauth_dropins.webutil.util import json_dumps, json_loads
import webapp2

from models import Source
import util


class Instagram(Source):
  """An Instagram account.

  The key name is the username. Instagram usernames may have ASCII letters (case
  insensitive), numbers, periods, and underscores:
  https://stackoverflow.com/questions/15470180
  """
  GR_CLASS = gr_instagram.Instagram
  OAUTH_START_HANDLER = oauth_instagram.StartHandler
  SHORT_NAME = 'instagram'
  FAST_POLL = datetime.timedelta(minutes=120)
  RATE_LIMITED_POLL = Source.SLOW_POLL
  RATE_LIMIT_HTTP_CODES = ('401', '429', '503')
  DISABLE_HTTP_CODES = ()
  CAN_PUBLISH = False
  URL_CANONICALIZER = util.UrlCanonicalizer(
    domain=GR_CLASS.DOMAIN,
    subdomain='www',
    approve=r'https://www.instagram.com/p/[^/?]+/$',
    trailing_slash=True,
    headers=util.REQUEST_HEADERS)
    # no reject regexp; non-private Instagram post URLs just 404

  @staticmethod
  def new(handler, auth_entity=None, actor=None, **kwargs):
    """Creates and returns an :class:`Instagram` for the logged in user.

    Args:
      handler: the current :class:`webapp2.RequestHandler`
      auth_entity: :class:`oauth_dropins.instagram.InstagramAuth`
    """
    user = json_loads(auth_entity.user_json)
    user['actor'] = actor
    auth_entity.user_json = json_dumps(user)
    auth_entity.put()

    username = actor['username']
    if not kwargs.get('features'):
      kwargs['features'] = ['listen']
    return Instagram(id=username,
                     auth_entity=auth_entity.key,
                     name=actor.get('displayName'),
                     picture=actor.get('image', {}).get('url'),
                     url=gr_instagram.Instagram.user_url(username),
                     **kwargs)

  def silo_url(self):
    """Returns the Instagram account URL, e.g. https://instagram.com/foo."""
    return self.url

  def user_tag_id(self):
    """Returns the tag URI for this source, e.g. 'tag:instagram.com:123456'."""
    user = json_loads(self.auth_entity.get().user_json)
    return (user.get('actor', {}).get('id') or
            self.gr_source.tag_uri(user.get('id') or self.key.id()))

  def label_name(self):
    """Returns the username."""
    return self.key.id()

  @classmethod
  def button_html(cls, feature, **kwargs):
    return super(cls, cls).button_html(feature, form_method='get', **kwargs)

  def get_activities_response(self, *args, **kwargs):
    """Set user_id because scraping requires it."""
    kwargs.setdefault('group_id', gr_source.SELF)
    kwargs.setdefault('user_id', self.key.id())
    return self.gr_source.get_activities_response(*args, **kwargs)


class StartHandler(TemplateHandler, util.Handler):
  """Serves the "Enter your username" form page."""

  def template_file(self):
    return 'indieauth.html'

  def post(self):
    ia_start = util.oauth_starter(indieauth.StartHandler).to('/instagram/callback')(
      self.request, self.response)

    try:
      self.redirect(ia_start.redirect_url(me=util.get_required_param(self, 'user_url')))
    except Exception as e:
      if util.is_connection_failure(e) or util.interpret_http_exception(e)[0]:
        self.messages.add("Couldn't fetch your web site: %s" % e)
        return self.redirect('/')
      raise


class CallbackHandler(indieauth.CallbackHandler, util.Handler):
  def finish(self, auth_entity, state=None):
    if auth_entity:
      user_json = json_loads(auth_entity.user_json)

      # find instagram profile URL
      urls = user_json.get('rel-me', [])
      logging.info('rel-mes: %s', urls)
      for url in util.trim_nulls(urls):
        if util.domain_from_link(url) == gr_instagram.Instagram.DOMAIN:
          username = urllib.parse.urlparse(url).path.strip('/')
          break
      else:
        self.messages.add(
          'No Instagram profile found. Please <a href="https://indieauth.com/setup">add an Instagram rel-me link</a>, then try again.')
        return self.redirect('/')

      # check that instagram profile links to web site
      try:
        actor = gr_instagram.Instagram(scrape=True).get_actor(
          username, ignore_rate_limit=True)
      except Exception as e:
        code, _ = util.interpret_http_exception(e)
        if code in Instagram.RATE_LIMIT_HTTP_CODES:
          self.messages.add(
            '<a href="https://github.com/snarfed/bridgy/issues/665#issuecomment-524977427">Apologies, Instagram is temporarily blocking us.</a> Please try again later!')
          return self.redirect('/')
        else:
          raise

      if not actor:
        self.messages.add("Couldn't find Instagram user '%s'. Please check your site's rel-me link and your Instagram account." % username)
        return self.redirect('/')

      canonicalize = util.UrlCanonicalizer(redirects=False)
      website = canonicalize(auth_entity.key.id())
      urls = [canonicalize(u) for u in microformats2.object_urls(actor)]
      logging.info('Looking for %s in %s', website, urls)
      if website not in urls:
        self.messages.add("Please add %s to your Instagram profile's website or bio field and try again." % website)
        return self.redirect('/')

      # check that the instagram account is public
      if not gr_source.Source.is_public(actor):
        self.messages.add('Your Instagram account is private. Bridgy only supports public accounts.')
        return self.redirect('/')

    self.maybe_add_or_delete_source(Instagram, auth_entity, state, actor=actor)


application = webapp2.WSGIApplication([
    ('/instagram/start', StartHandler),
    ('/instagram/indieauth', indieauth.StartHandler.to('/instagram/callback')),
    ('/instagram/callback', CallbackHandler),
], debug=appengine_config.DEBUG)