southfox/miniflux
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Add Pocket authorization flow in the user interface

Browse source
This commit is contained in:
Frédéric Guillot 2018-05-20 15:29:14 -07:00
parent 0f3f5e442f
commit 7f2fd1fdd8
18 changed files with 286 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
daemon/routes.go
View file

@ -133,6 +133,8 @@ func routes(cfg *config.Config, store *storage.Storage, feedHandler *feed.Handle
uiRouter.HandleFunc("/bookmarklet", uiController.Bookmarklet).Name("bookmarklet").Methods("GET")
uiRouter.HandleFunc("/integrations", uiController.ShowIntegrations).Name("integrations").Methods("GET")
uiRouter.HandleFunc("/integration", uiController.UpdateIntegration).Name("updateIntegration").Methods("POST")
uiRouter.HandleFunc("/integration/pocket/authorize", uiController.PocketAuthorize).Name("pocketAuthorize").Methods("GET")
uiRouter.HandleFunc("/integration/pocket/callback", uiController.PocketCallback).Name("pocketCallback").Methods("GET")
uiRouter.HandleFunc("/sessions", uiController.ShowSessions).Name("sessions").Methods("GET")
uiRouter.HandleFunc("/sessions/{sessionID}/remove", uiController.RemoveSession).Name("removeSession").Methods("POST")
uiRouter.HandleFunc("/export", uiController.Export).Name("export").Methods("GET")

5
http/context/context.go
View file

@ -78,6 +78,11 @@ func (c *Context) FlashErrorMessage() string {
return c.getContextStringValue(middleware.FlashErrorMessageContextKey)
}
// PocketRequestToken returns the Pocket Request Token if any.
func (c *Context) PocketRequestToken() string {
return c.getContextStringValue(middleware.PocketRequestTokenContextKey)
}
func (c *Context) getContextStringValue(key *middleware.ContextKey) string {
if v := c.request.Context().Value(key); v != nil {
return v.(string)

103
integration/pocket/connector.go Normal file
View file

@ -0,0 +1,103 @@
// Copyright 2018 Frédéric Guillot. All rights reserved.
// Use of this source code is governed by the Apache 2.0
// license that can be found in the LICENSE file.
package pocket
import (
"errors"
"fmt"
"io/ioutil"
"net/url"
"github.com/miniflux/miniflux/http/client"
)
// Connector manages the authorization flow with Pocket to get a personal access token.
type Connector struct {
consumerKey string
}
// RequestToken fetches a new request token from Pocket API.
func (c *Connector) RequestToken(redirectURL string) (string, error) {
type req struct {
ConsumerKey string `json:"consumer_key"`
RedirectURI string `json:"redirect_uri"`
}
clt := client.New("https://getpocket.com/v3/oauth/request")
response, err := clt.PostJSON(&req{ConsumerKey: c.consumerKey, RedirectURI: redirectURL})
if err != nil {
return "", fmt.Errorf("pocket: unable to fetch request token: %v", err)
}
if response.HasServerFailure() {
return "", fmt.Errorf("pocket: unable to fetch request token, status=%d", response.StatusCode)
}
body, err := ioutil.ReadAll(response.Body)
if err != nil {
return "", fmt.Errorf("pocket: unable to read response body: %v", err)
}
values, err := url.ParseQuery(string(body))
if err != nil {
return "", fmt.Errorf("pocket: unable to parse response: %v", err)
}
code := values.Get("code")
if code == "" {
return "", errors.New("pocket: code is empty")
}
return code, nil
}
// AccessToken fetches a new access token once the end-user authorized the application.
func (c *Connector) AccessToken(requestToken string) (string, error) {
type req struct {
ConsumerKey string `json:"consumer_key"`
Code string `json:"code"`
}
clt := client.New("https://getpocket.com/v3/oauth/authorize")
response, err := clt.PostJSON(&req{ConsumerKey: c.consumerKey, Code: requestToken})
if err != nil {
return "", fmt.Errorf("pocket: unable to fetch access token: %v", err)
}
if response.HasServerFailure() {
return "", fmt.Errorf("pocket: unable to fetch access token, status=%d", response.StatusCode)
}
body, err := ioutil.ReadAll(response.Body)
if err != nil {
return "", fmt.Errorf("pocket: unable to read response body: %v", err)
}
values, err := url.ParseQuery(string(body))
if err != nil {
return "", fmt.Errorf("pocket: unable to parse response: %v", err)
}
token := values.Get("access_token")
if token == "" {
return "", errors.New("pocket: access_token is empty")
}
return token, nil
}
// AuthorizationURL returns the authorization URL for the end-user.
func (c *Connector) AuthorizationURL(requestToken, redirectURL string) string {
return fmt.Sprintf(
"https://getpocket.com/auth/authorize?request_token=%s&redirect_uri=%s",
requestToken,
redirectURL,
)
}
// NewConnector returns a new Pocket Connector.
func NewConnector(consumerKey string) *Connector {
return &Connector{consumerKey}
}

27
integration/pocket/pocket.go
View file

@ -1,4 +1,4 @@
// Copyright 2017 Frédéric Guillot. All rights reserved.
// Copyright 2018 Frédéric Guillot. All rights reserved.
// Use of this source code is governed by the Apache 2.0
// license that can be found in the LICENSE file.
@ -16,21 +16,20 @@ type Client struct {
consumerKey string
}
// Parameters for a Pocket add call.
type Parameters struct {
AccessToken string `json:"access_token"`
ConsumerKey string `json:"consumer_key"`
Title string `json:"title,omitempty"`
URL string `json:"url,omitempty"`
}
// AddURL sends a single link to Pocket.
func (c *Client) AddURL(link, title string) error {
if c.consumerKey == "" || c.accessToken == "" {
return fmt.Errorf("pocket: missing credentials")
}
parameters := &Parameters{
type body struct {
AccessToken string `json:"access_token"`
ConsumerKey string `json:"consumer_key"`
Title string `json:"title,omitempty"`
URL string `json:"url"`
}
data := &body{
AccessToken: c.accessToken,
ConsumerKey: c.consumerKey,
Title: title,
@ -38,12 +37,16 @@ func (c *Client) AddURL(link, title string) error {
}
clt := client.New("https://getpocket.com/v3/add")
response, err := clt.PostJSON(parameters)
response, err := clt.PostJSON(data)
if err != nil {
return fmt.Errorf("pocket: unable to send url: %v", err)
}
if response.HasServerFailure() {
return fmt.Errorf("pocket: unable to send url, status=%d", response.StatusCode)
}
return err
return nil
}
// NewClient returns a new Pocket client.

13
locale/translations.go
View file

@ -1,5 +1,5 @@
// Code generated by go generate; DO NOT EDIT.
// 2018-05-20 11:35:19.498340382 -0700 PDT m=+0.010175046
// 2018-05-20 15:22:33.795349513 -0700 PDT m=+0.026820026
package locale
@ -462,7 +462,14 @@ var translations = map[string]string{
"View Comments": "Voir les commentaires",
"This file is empty": "Ce fichier est vide",
"Your external account is now dissociated!": "Votre compte externe est maintenant dissocié !",
"You must define a password otherwise you won't be able to login again.": "Vous devez définir un mot de passe sinon vous ne pourrez plus vous connecter par la suite."
"You must define a password otherwise you won't be able to login again.": "Vous devez définir un mot de passe sinon vous ne pourrez plus vous connecter par la suite.",
"Save articles to Pocket": "Sauvegarder les articles vers Pocket",
"Connect your Pocket account": "Connectez votre compte Pocket",
"Pocket Consumer Key": "« Pocket Consumer Key »",
"Pocket Access Token": "« Pocket Access Token »",
"Your Pocket account is now linked!": "Votre compte Pocket est maintenant connecté !",
"Unable to fetch access token from Pocket!": "Impossible de récupérer le jeton d'accès depuis Pocket !",
"Unable to fetch request token from Pocket!": "Impossible de récupérer le jeton d'accès depuis Pocket !"
}
`,
"nl_NL": `{
@ -1137,7 +1144,7 @@ var translations = map[string]string{
var translationsChecksums = map[string]string{
"de_DE": "791d72c96137ab03b729017bdfa27c8eed2f65912e372fcb5b2796d5099d5498",
"en_US": "6fe95384260941e8a5a3c695a655a932e0a8a6a572c1e45cb2b1ae8baa01b897",
"fr_FR": "5a954b28ac31af6fc525cb000d86c884950dac7414b695bd38a4c0aebdfe35b5",
"fr_FR": "808f1561135bb3d0f886833f00a51402113925e9086c01f71b30bcc679d9b7c2",
"nl_NL": "1a73f1dd1c4c0d2c2adc8695cdd050c2dad81c14876caed3892b44adc2491265",
"pl_PL": "da709c14ff71f3b516eec66cb2758d89c5feab1472c94b2b518f425162a9f806",
"zh_CN": "d80594c1b67d15e9f4673d3d62fe4949e8606a5fdfb741d8a8921f21dceb8cf2",

9
locale/translations/fr_FR.json
View file

@ -222,5 +222,12 @@
"View Comments": "Voir les commentaires",
"This file is empty": "Ce fichier est vide",
"Your external account is now dissociated!": "Votre compte externe est maintenant dissocié !",
"You must define a password otherwise you won't be able to login again.": "Vous devez définir un mot de passe sinon vous ne pourrez plus vous connecter par la suite."
"You must define a password otherwise you won't be able to login again.": "Vous devez définir un mot de passe sinon vous ne pourrez plus vous connecter par la suite.",
"Save articles to Pocket": "Sauvegarder les articles vers Pocket",
"Connect your Pocket account": "Connectez votre compte Pocket",
"Pocket Consumer Key": "« Pocket Consumer Key »",
"Pocket Access Token": "« Pocket Access Token »",
"Your Pocket account is now linked!": "Votre compte Pocket est maintenant connecté !",
"Unable to fetch access token from Pocket!": "Impossible de récupérer le jeton d'accès depuis Pocket !",
"Unable to fetch request token from Pocket!": "Impossible de récupérer le jeton d'accès depuis Pocket !"
}

1
middleware/app_session.go
View file

@ -55,6 +55,7 @@ func (m *Middleware) AppSession(next http.Handler) http.Handler {
ctx = context.WithValue(ctx, FlashMessageContextKey, session.Data.FlashMessage)
ctx = context.WithValue(ctx, FlashErrorMessageContextKey, session.Data.FlashErrorMessage)
ctx = context.WithValue(ctx, UserLanguageContextKey, session.Data.Language)
ctx = context.WithValue(ctx, PocketRequestTokenContextKey, session.Data.PocketRequestToken)
next.ServeHTTP(w, r.WithContext(ctx))
})
}

3
middleware/context_keys.go
View file

@ -46,4 +46,7 @@ var (
// FlashErrorMessageContextKey is the context key used to store a flash error message.
FlashErrorMessageContextKey = &ContextKey{"FlashErrorMessage"}
// PocketRequestTokenContextKey is the context key for Pocket Request Token.
PocketRequestTokenContextKey = &ContextKey{"PocketRequestToken"}
)

11
model/session.go
View file

@ -13,11 +13,12 @@ import (
// SessionData represents the data attached to the session.
type SessionData struct {
CSRF string `json:"csrf"`
OAuth2State string `json:"oauth2_state"`
FlashMessage string `json:"flash_message"`
FlashErrorMessage string `json:"flash_error_message"`
Language string `json:"language"`
CSRF string `json:"csrf"`
OAuth2State string `json:"oauth2_state"`
FlashMessage string `json:"flash_message"`
FlashErrorMessage string `json:"flash_error_message"`
Language string `json:"language"`
PocketRequestToken string `json:"pocket_request_token"`
}
func (s SessionData) String() string {

2
sql/sql.go
View file

@ -1,5 +1,5 @@
// Code generated by go generate; DO NOT EDIT.
// 2018-05-20 11:35:19.489434225 -0700 PDT m=+0.001268896
// 2018-05-20 15:22:33.771570698 -0700 PDT m=+0.003041211
package sql

2
template/common.go
View file

@ -1,5 +1,5 @@
// Code generated by go generate; DO NOT EDIT.
// 2018-05-20 11:35:19.497832269 -0700 PDT m=+0.009666945
// 2018-05-20 15:22:33.793709932 -0700 PDT m=+0.025180445
package template

30
template/html/integrations.html
View file

@ -73,6 +73,23 @@
<input type="password" name="instapaper_password" id="form-instapaper-password" value="{{ .form.InstapaperPassword }}">
</div>
<h3>Pocket</h3>
<div class="form-section">
<label>
<input type="checkbox" name="pocket_enabled" value="1" {{ if .form.PocketEnabled }}checked{{ end }}> {{ t "Save articles to Pocket" }}
</label>
<label for="form-pocket-consumer-key">{{ t "Pocket Consumer Key" }}</label>
<input type="text" name="pocket_consumer_key" id="form-pocket-consumer-key" value="{{ .form.PocketConsumerKey }}">
<label for="form-pocket-access-token">{{ t "Pocket Access Token" }}</label>
<input type="password" name="pocket_access_token" id="form-pocket-access-token" value="{{ .form.PocketAccessToken }}">
{{ if not .form.PocketAccessToken }}
<p><a href="{{ route "pocketAuthorize" }}">{{ t "Connect your Pocket account" }}</a></p>
{{ end }}
</div>
<h3>Wallabag</h3>
<div class="form-section">
<label>
@ -108,19 +125,6 @@
<input type="text" name="nunux_keeper_api_key" id="form-nunux-keeper-api-key" value="{{ .form.NunuxKeeperAPIKey }}">
</div>
<h3>Pocket</h3>
<div class="form-section">
<label>
<input type="checkbox" name="pocket_enabled" value="1" {{ if .form.PocketEnabled }}checked{{ end }}> {{ t "Save articles to Pocket" }}
</label>
<label for="form-pocket-access-token">{{ t "Pocket Access Token" }}</label>
<input type="password" name="pocket_access_token" id="form-pocket-access-token" value="{{ .form.PocketAccessToken }}">
<label for="form-pocket-consumer-key">{{ t "Pocket Consumer Key" }}</label>
<input type="text" name="pocket_consumer_key" id="form-pocket-consumer-key" value="{{ .form.PocketConsumerKey }}">
</div>
<div class="buttons">
<button type="submit" class="button button-primary" data-label-loading="{{ t "Loading..." }}">{{ t "Update" }}</button>
</div>

34
template/views.go
View file

@ -1,5 +1,5 @@
// Code generated by go generate; DO NOT EDIT.
// 2018-05-20 11:35:19.495047296 -0700 PDT m=+0.006881961
// 2018-05-20 15:22:33.785042033 -0700 PDT m=+0.016512546
package template
@ -886,6 +886,23 @@ var templateViewsMap = map[string]string{
<input type="password" name="instapaper_password" id="form-instapaper-password" value="{{ .form.InstapaperPassword }}">
</div>
<h3>Pocket</h3>
<div class="form-section">
<label>
<input type="checkbox" name="pocket_enabled" value="1" {{ if .form.PocketEnabled }}checked{{ end }}> {{ t "Save articles to Pocket" }}
</label>
<label for="form-pocket-consumer-key">{{ t "Pocket Consumer Key" }}</label>
<input type="text" name="pocket_consumer_key" id="form-pocket-consumer-key" value="{{ .form.PocketConsumerKey }}">
<label for="form-pocket-access-token">{{ t "Pocket Access Token" }}</label>
<input type="password" name="pocket_access_token" id="form-pocket-access-token" value="{{ .form.PocketAccessToken }}">
{{ if not .form.PocketAccessToken }}
<p><a href="{{ route "pocketAuthorize" }}">{{ t "Connect your Pocket account" }}</a></p>
{{ end }}
</div>
<h3>Wallabag</h3>
<div class="form-section">
<label>
@ -921,19 +938,6 @@ var templateViewsMap = map[string]string{
<input type="text" name="nunux_keeper_api_key" id="form-nunux-keeper-api-key" value="{{ .form.NunuxKeeperAPIKey }}">
</div>
<h3>Pocket</h3>
<div class="form-section">
<label>
<input type="checkbox" name="pocket_enabled" value="1" {{ if .form.PocketEnabled }}checked{{ end }}> {{ t "Save articles to Pocket" }}
</label>
<label for="form-pocket-access-token">{{ t "Pocket Access Token" }}</label>
<input type="password" name="pocket_access_token" id="form-pocket-access-token" value="{{ .form.PocketAccessToken }}">
<label for="form-pocket-consumer-key">{{ t "Pocket Consumer Key" }}</label>
<input type="text" name="pocket_consumer_key" id="form-pocket-consumer-key" value="{{ .form.PocketConsumerKey }}">
</div>
<div class="buttons">
<button type="submit" class="button button-primary" data-label-loading="{{ t "Loading..." }}">{{ t "Update" }}</button>
</div>
@ -1259,7 +1263,7 @@ var templateViewsMapChecksums = map[string]string{
"feeds": "2a5abe37968ea34a0576dbef52341645cb1fc9562e351382fbf721491da6f4fa",
"history_entries": "451f0b202f47c9db5344d3e73862f5b7afbd4323fbdba21b6087866c40f045d3",
"import": "73b5112e20bfd232bf73334544186ea419505936bc237d481517a8622901878f",
"integrations": "919b73a7dec91c2973db840eecf709de1e2e004f5a592d7e377ef1cb0926adce",
"integrations": "9b31a245d7d10e28a5682ec993b173972b3d69a86e731e8b09cf13a9ecbf6a09",
"login": "7d83c3067c02f1f6aafdd8816c7f97a4eb5a5a4bdaaaa4cc1e2fbb9c17ea65e8",
"sessions": "3fa79031dd883847eba92fbafe5f535fa3a4e1614bb610f20588b6f8fc8b3624",
"settings": "ea2505b9d0a6d6bb594dba87a92079de19baa6d494f0651693a7685489fb7de9",

87
ui/integration_pocket.go Normal file
View file

@ -0,0 +1,87 @@
// Copyright 2018 Frédéric Guillot. All rights reserved.
// Use of this source code is governed by the Apache 2.0
// license that can be found in the LICENSE file.
package ui
import (
"net/http"
"github.com/miniflux/miniflux/http/context"
"github.com/miniflux/miniflux/http/response"
"github.com/miniflux/miniflux/http/response/html"
"github.com/miniflux/miniflux/http/route"
"github.com/miniflux/miniflux/integration/pocket"
"github.com/miniflux/miniflux/logger"
"github.com/miniflux/miniflux/ui/session"
)
// PocketAuthorize redirects the end-user to Pocket website to authorize the application.
func (c *Controller) PocketAuthorize(w http.ResponseWriter, r *http.Request) {
ctx := context.New(r)
user, err := c.store.UserByID(ctx.UserID())
if err != nil {
html.ServerError(w, err)
return
}
integration, err := c.store.Integration(user.ID)
if err != nil {
html.ServerError(w, err)
return
}
sess := session.New(c.store, ctx)
connector := pocket.NewConnector(integration.PocketConsumerKey)
redirectURL := c.cfg.BaseURL() + route.Path(c.router, "pocketCallback")
requestToken, err := connector.RequestToken(redirectURL)
if err != nil {
logger.Error("[Pocket:Authorize] %v", err)
sess.NewFlashErrorMessage(c.translator.GetLanguage(ctx.UserLanguage()).Get("Unable to fetch request token from Pocket!"))
response.Redirect(w, r, route.Path(c.router, "integrations"))
return
}
sess.SetPocketRequestToken(requestToken)
response.Redirect(w, r, connector.AuthorizationURL(requestToken, redirectURL))
}
// PocketCallback saves the personal access token after the authorization step.
func (c *Controller) PocketCallback(w http.ResponseWriter, r *http.Request) {
ctx := context.New(r)
sess := session.New(c.store, ctx)
user, err := c.store.UserByID(ctx.UserID())
if err != nil {
html.ServerError(w, err)
return
}
integration, err := c.store.Integration(user.ID)
if err != nil {
html.ServerError(w, err)
return
}
connector := pocket.NewConnector(integration.PocketConsumerKey)
accessToken, err := connector.AccessToken(ctx.PocketRequestToken())
if err != nil {
logger.Error("[Pocket:Callback] %v", err)
sess.NewFlashErrorMessage(c.translator.GetLanguage(ctx.UserLanguage()).Get("Unable to fetch access token from Pocket!"))
response.Redirect(w, r, route.Path(c.router, "integrations"))
return
}
sess.SetPocketRequestToken("")
integration.PocketAccessToken = accessToken
err = c.store.UpdateIntegration(integration)
if err != nil {
html.ServerError(w, err)
return
}
sess.NewFlashMessage(c.translator.GetLanguage(ctx.UserLanguage()).Get("Your Pocket account is now linked!"))
response.Redirect(w, r, route.Path(c.router, "integrations"))
}

5
ui/session/session.go
View file

@ -56,6 +56,11 @@ func (s *Session) SetLanguage(language string) {
s.store.UpdateSessionField(s.ctx.SessionID(), "language", language)
}
// SetPocketRequestToken updates Pocket Request Token.
func (s *Session) SetPocketRequestToken(requestToken string) {
s.store.UpdateSessionField(s.ctx.SessionID(), "pocket_request_token", requestToken)
}
// New returns a new session handler.
func New(store *storage.Storage, ctx *context.Context) *Session {
return &Session{store, ctx}

2
ui/static/bin.go
View file

@ -1,5 +1,5 @@
// Code generated by go generate; DO NOT EDIT.
// 2018-05-20 11:35:19.492969127 -0700 PDT m=+0.004803782
// 2018-05-20 15:22:33.779971968 -0700 PDT m=+0.011442481
package static

2
ui/static/css.go
View file

@ -1,5 +1,5 @@
// Code generated by go generate; DO NOT EDIT.
// 2018-05-20 11:35:19.493979584 -0700 PDT m=+0.005814260
// 2018-05-20 15:22:33.782567368 -0700 PDT m=+0.014037881
package static

2
ui/static/js.go
View file

@ -1,5 +1,5 @@
// Code generated by go generate; DO NOT EDIT.
// 2018-05-20 11:35:19.494515654 -0700 PDT m=+0.006350329
// 2018-05-20 15:22:33.784038886 -0700 PDT m=+0.015509399
package static