Pocket+ recipe for Calibre

[mag_dex]

Hi all,

I modified the original plugin plugin (https://github.com/tbunnyman/ReadItLater-Calibre-Plugin) to get an e-book including:

• The latest (more or less as the original version of the plugin)
• your content organized by tags!

Get it from https://github.com/m4rx9/Pocket-Calibre-Plugin

Now:



Before:



Have fun! I hope it will be useful for others as well.

Please, write what you think! :-)

I just love this version of the plugin.

Marcin

[mitra]

@mag_dex :

I tried your Pocket+ recipe. It is not working for me.

Could you please look into it.

I hope i am not the only one to face such error.

Spoiler:

#!/usr/bin/python

"""
Pocket Calibre Recipe v1.4.1
"""
from calibre import strftime
from calibre.web.feeds.news import BasicNewsRecipe
from string import Template
import json
import operator
import re
import tempfile
import urllib
import urllib2


__license__ = 'GPL v3'
__copyright__ = '''
2010, Darko Miletic <darko.miletic at gmail.com>
2011, Przemyslaw Kryger <pkryger at gmail.com>
2012-2013, tBunnyMan <Wag That Tail At Me dot com>
2015 Marcin Magnus <mag_dex at o2 pl>
'''

class Pocket(BasicNewsRecipe):
title = 'Pocket+'
__author__ = 'Darko Miletic, Przemyslaw Kryger, Keith Callenberg, tBunnyMan, Marcin Magnus'
description = '''Personalized news feeds. Go to getpocket.com to setup up
your news. This version displays pages of articles from
oldest to newest, with max & minimum counts, and marks
articles read after downloading.

Modified version of the plugin to get (1) The latest (more or less as the original version of the plugin) (2) and your content organized by tags! See for more https://github.com/m4rx9/ReadItLater-Calibre-Plugin

'''
publisher = 'getpocket.com'
category = 'news, custom'

# Settings people change
max_articles_per_feed = 30
minimum_articles = 1
mark_as_read_after_dl = True # Set this to False for testing
sort_method = 'newest' # MUST be either 'oldest' or 'newest'
# To filter by tag this needs to be a single tag in quotes; IE 'calibre'
only_pull_tag = None
tags = ['','phylosophy', 'cas9', 'dnazyme', 'rna', 'lncrna', 'db', 'osx', 'kindle'] # define your own tags, '' gives "The latest"!

# You don't want to change anything under
no_stylesheets = True
use_embedded_content = False
needs_subscription = True
articles_are_obfuscated = True
apikey = '19eg0e47pbT32z4793Tf021k99Afl889'
index_url = u'https://getpocket.com'
read_api_url = index_url + u'/v3/get'
modify_api_url = index_url + u'/v3/send'
legacy_login_url = index_url + u'/l' # We use this to cheat oAuth
articles = []

encoding = 'utf8'

def get_browser(self, *args, **kwargs):
"""
We need to pretend to be a recent version of safari for the mac to
prevent User-Agent checks Pocket api requires username and password so
fail loudly if it's missing from the config.
"""
br = BasicNewsRecipe.get_browser(self,
user_agent='Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_4; \
en-us) AppleWebKit/533.19.4 (KHTML, like Gecko) \
Version/5.0.3 Safari/533.19.4')
if self.username is not None and self.password is not None:
br.open(self.legacy_login_url)
br.select_form(nr=0)
br['feed_id'] = self.username
br['password'] = self.password
br.submit()
else:
self.user_error("This Recipe requires authentication")
return br

def get_auth_uri(self):
"""Quick function to return the authentication part of the url"""
uri = ""
uri = u'{0}&apikey={1!s}'.format(uri, self.apikey)
if self.username is None or self.password is None:
self.user_error("Username or password is blank.")
else:
uri = u'{0}&username={1!s}'.format(uri, self.username)
uri = u'{0}&password={1!s}'.format(uri, self.password)
return uri

def get_pull_articles_uri(self, tag):
"""Get articles based on tag.
"""
uri = ""
uri = u'{0}&state={1}'.format(uri, u'all')#unread')
uri = u'{0}&contentType={1}'.format(uri, u'article')
uri = u'{0}&sort={1}'.format(uri, self.sort_method)
uri = u'{0}&tag={1}'.format(uri, tag)
uri = u'{0}&count={1!s}'.format(uri, self.max_articles_per_feed)
return uri

def parse_index(self):
"""Parse an index based on self.tags. '' tag is called "The latest"""
tags = self.tags
articles_tags = []
for tag in tags:
self.articles = []
pocket_feed = []
fetch_url = u"{0}?{1}{2}".format(
self.read_api_url,
self.get_auth_uri(),
self.get_pull_articles_uri(tag)
)
try:
request = urllib2.Request(fetch_url)
response = urllib2.urlopen(request)
pocket_feed = json.load(response)['list']
except urllib2.HTTPError as e:
self.log.exception("Pocket returned an error: {0}".format(e.info()))
return []
except urllib2.URLError as e:
self.log.exception("Unable to connect to getpocket.com's api: {0}\nurl: {1}".format(e, fetch_url))
return []

if len(pocket_feed) < self.minimum_articles: # for pocket_feed
#self.mark_as_read_after_dl = False
self.log.exception("Tag has no articles: {0}".format(tag))
else:
for pocket_article in pocket_feed.iteritems():

self.articles.append({
'item_id': pocket_article[0],
'title': pocket_article[1]['resolved_title'],
'date': pocket_article[1]['time_updated'],
'url': u'{0}/a/read/{1}'.format(self.index_url, pocket_article[0]),
'real_url': pocket_article[1]['resolved_url'],
'description': pocket_article[1]['excerpt'],
'sort': pocket_article[1]['sort_id'],
})
if tag == '':
tag = "The latest"
self.articles = sorted(self.articles, key=operator.itemgetter('sort'))
articles_tags.append([tag, self.articles])
return articles_tags

def get_textview(self, url):
"""
Since Pocket's v3 API they removed access to textview. They also
redesigned their page to make it much harder to scrape their textview.
We need to pull the article, retrieve the formcheck id, then use it
to querty for the json version
This function will break when pocket hates us
"""
ajax_url = self.index_url + u'/a/x/getArticle.php'
soup = self.index_to_soup(url)
fc_tag = soup.find('script', text=re.compile("formCheck"))
fc_id = re.search(r"formCheck = \'([\d\w]+)\';", fc_tag).group(1)
article_id = url.split("/")[-1]
data = urllib.urlencode({'itemId': article_id, 'formCheck': fc_id})
try:
response = self.browser.open(ajax_url, data)
except urllib2.HTTPError as e:
self.log.exception("unable to get textview {0}".format(e.info()))
raise e
return json.load(response)['article']

def get_obfuscated_article(self, url):
"""
Our get_textview returns parsed json so prettify it to something well
parsed by calibre.
"""
article = self.get_textview(url)
template = Template('<h2>$title</h2>\
$img\
<div class="body">$body</div>')
try:
image = '<img src="{0}" \>'.format(article['images']['1']['src'])
except:
image = ''
with tempfile.NamedTemporaryFile(delete=False) as tf:
tf.write(template.safe_substitute(
title=article['title'],
img=image,
body=article['article'],
))
return tf.name

def mark_as_read(self, mark_list):
actions_list = []
for article_id in mark_list:
actions_list.append({
'action': 'archive',
'item_id': article_id
})
mark_read_url = u'{0}?actions={1}{2}'.format(
self.modify_api_url,
json.dumps(actions_list, separators=(',', ':')),
self.get_auth_uri()
)
try:
request = urllib2.Request(mark_read_url)
urllib2.urlopen(request)
except urllib2.HTTPError as e:
self.log.exception('Pocket returned an error while archiving articles: {0}'.format(e))
return []
except urllib2.URLError as e:
self.log.exception("Unable to connect to getpocket.com's modify api: {0}".format(e))
return []

def cleanup(self):
if self.mark_as_read_after_dl:
self.mark_as_read([x['item_id'] for x in self.articles])
else:
pass

def default_cover(self, cover_file):
"""
Create a generic cover for recipes that don't have a cover
This override adds time to the cover
"""
try:
from calibre.ebooks import calibre_cover
title = self.title if isinstance(self.title, unicode) else \
self.title.decode('utf-8', 'replace')
title = '#' + self.only_pull_tag
date = strftime(self.timefmt)
time = strftime('%I:%M %p')
img_data = calibre_cover(title, date, time)
cover_file.write(img_data)
cover_file.flush()
except:
self.log.exception('Failed to generate default cover')
return False
return True

def user_error(self, error_message):
if hasattr(self, 'abort_recipe_processing'):
self.abort_recipe_processing(error_message)
else:
self.log.exception(error_message)
raise RuntimeError(error_message)

# vim:ft=python tabstop=8 expandtab shiftwidth=4 softtabstop=4

[mitra]

Oh I am sorry. I keyed in a wrong key in password. My mistake.

It works fine for me.

Thank You @mag_dex

[mag_dex]

You're welcome! I hope this plugin is useful also for others.

If you have any ideas how to improve it, let me know!

Marcin

[Ray Cassani]

Hi Marcin,
Thanks for the plugin.
Is it normal to have the title of the Document downloaded as Pocket + [Mon, 05 Dec 2016]? It'd be great to have the title that appears in Pocket

[price]

Sometimes the articles are not achieved successfully after downloading. Some of them are achieved but others not. Especially when there are a large number of feeds.

[Awfki]

It's failing because it doesn't have a username/pwd but I don't see anyplace to put them. What am I missing?

[criste_nicu]

I get this error: 'Pocket returned an error while archiving articles: HTTP Error 401: Unauthorized'

And I do fill out my credential.

[mag_dex]

Hi, did you fill in this form?

[mag_dex]

Originally Posted by Ray Cassani

Hi Marcin,
Thanks for the plugin.
Is it normal to have the title of the Document downloaded as Pocket + [Mon, 05 Dec 2016]? It'd be great to have the title that appears in Pocket

this is a nice idea. Right now I have no time to do it.. but I let you know if this is done :-)

[mag_dex]

Originally Posted by Ray Cassani

Hi Marcin,
Thanks for the plugin.
Is it normal to have the title of the Document downloaded as Pocket + [Mon, 05 Dec 2016]? It'd be great to have the title that appears in Pocket

DONE :-) https://github.com/mmagnus/Pocket-Plus-Calibre-Plugin

It can be switch on/off by the variable in the file:

title_with_date = True # if True Pocket+ [Tue, 02 May 2017]

[mag_dex]

I added a way to buy me a beer (via PayPal) if you're using the project :-) https://github.com/mmagnus/Pocket-Plus-Calibre-Plugin

[panweihwa]

hi! Bugs reporting.

I have tried your recipe for two days in different computers with different version of calibre (v1.48 for XP to most updated v2.85). However, similar bug happens and the calibre process terminates while fetching data all the time.

I post the error messages below. I guess the main reasons are related to the Chinese text encoded format.

The original recipe you modified from is working ok on my machine. I am hoping to use your improved version soon.

Thank you for your dedication.

----------------------------------------
Downloaded article: 倭寇，一個王朝的謊言 from https://getpocket.com/a/read/1651214851
Python function terminated unexpectedly
'utf8' codec can't decode byte 0xd6 in position 9: invalid continuation byte (Error Code: 1)
Traceback (most recent call last):
File "site.py", line 132, in main
File "site.py", line 109, in run_entry_point
File "site-packages\calibre\utils\ipc\worker.py", line 195, in main
File "site-packages\calibre\gui2\convert\gui_conversion.py", line 26, in gui_convert
File "site-packages\calibre\ebooks\conversion\plumber.py", line 1088, in run
File "site-packages\calibre\customize\conversion.py", line 245, in __call__
File "site-packages\calibre\ebooks\conversion\plugins\recipe_ input.py", line 119, in convert
File "site-packages\calibre\web\feeds\news.py", line 1019, in download
File "site-packages\calibre\web\feeds\news.py", line 1275, in build_index
File "site-packages\calibre\web\feeds\news.py", line 1419, in create_opf
UnicodeDecodeError: 'utf8' codec can't decode byte 0xd6 in position 9: invalid continuation byte

[lfzoz]

My results looks very similar to panweihwa.

I use win10 with the latest calibre 2.85.1. I have seen more errors, the most often it ends with UnicodeDecodeError: 'utf8' codec can't decode

L.

Originally Posted by panweihwa

hi! Bugs reporting.

I have tried your recipe for two days in different computers with different version of calibre (v1.48 for XP to most updated v2.85). However, similar bug happens and the calibre process terminates while fetching data all the time.

I post the error messages below. I guess the main reasons are related to the Chinese text encoded format.

The original recipe you modified from is working ok on my machine. I am hoping to use your improved version soon.

Thank you for your dedication.

----------------------------------------
Downloaded article: 倭寇，一個王朝的謊言 from https://getpocket.com/a/read/1651214851
Python function terminated unexpectedly
'utf8' codec can't decode byte 0xd6 in position 9: invalid continuation byte (Error Code: 1)
Traceback (most recent call last):
File "site.py", line 132, in main
File "site.py", line 109, in run_entry_point
File "site-packages\calibre\utils\ipc\worker.py", line 195, in main
File "site-packages\calibre\gui2\convert\gui_conversion.py", line 26, in gui_convert
File "site-packages\calibre\ebooks\conversion\plumber.py", line 1088, in run
File "site-packages\calibre\customize\conversion.py", line 245, in __call__
File "site-packages\calibre\ebooks\conversion\plugins\recipe_ input.py", line 119, in convert
File "site-packages\calibre\web\feeds\news.py", line 1019, in download
File "site-packages\calibre\web\feeds\news.py", line 1275, in build_index
File "site-packages\calibre\web\feeds\news.py", line 1419, in create_opf
UnicodeDecodeError: 'utf8' codec can't decode byte 0xd6 in position 9: invalid continuation byte

[sanon]

On Calibre's main window on right pane the title of each article is visible but the articles themselves are not there.