summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCarlos Tadeu Panato Junior <ctadeu@gmail.com>2017-05-10 12:44:18 +0200
committerGeorge Goldberg <george@gberg.me>2017-05-10 11:44:18 +0100
commit16581ae431ffeae97db18eb8672232505a7ce3c0 (patch)
treeb87317febf6f2ee4588fa3c8b48ed7a1cf81c048
parentb9f4ced52b65d147b57d7028f6df4935a6aea8f9 (diff)
downloadchat-16581ae431ffeae97db18eb8672232505a7ce3c0.tar.gz
chat-16581ae431ffeae97db18eb8672232505a7ce3c0.tar.bz2
chat-16581ae431ffeae97db18eb8672232505a7ce3c0.zip
implement open graph metadata for apiV4 (#6343)
Diffstat
-rw-r--r--api4/api.go5
-rw-r--r--api4/openGraph.go56
-rw-r--r--api4/openGraph_test.go73
-rw-r--r--i18n/en.json4
-rw-r--r--model/client4.go19
5 files changed, 157 insertions, 0 deletions
diff --git a/api4/api.go b/api4/api.go
index e75d1bf45..4ed636593 100644
--- a/api4/api.go
+++ b/api4/api.go
@@ -69,6 +69,8 @@ type Routes struct {
OAuthApps *mux.Router // 'api/v4/oauth/apps'
OAuthApp *mux.Router // 'api/v4/oauth/apps/{app_id:[A-Za-z0-9]+}'
+ OpenGraph *mux.Router // 'api/v4/opengraph'
+
SAML *mux.Router // 'api/v4/saml'
Compliance *mux.Router // 'api/v4/compliance'
Cluster *mux.Router // 'api/v4/cluster'
@@ -174,6 +176,8 @@ func InitApi(full bool) {
BaseRoutes.Webrtc = BaseRoutes.ApiRoot.PathPrefix("/webrtc").Subrouter()
+ BaseRoutes.OpenGraph = BaseRoutes.ApiRoot.PathPrefix("/opengraph").Subrouter()
+
InitUser()
InitTeam()
InitChannel()
@@ -194,6 +198,7 @@ func InitApi(full bool) {
InitOAuth()
InitReaction()
InitWebrtc()
+ InitOpenGraph()
app.Srv.Router.Handle("/api/v4/{anything:.*}", http.HandlerFunc(Handle404))
diff --git a/api4/openGraph.go b/api4/openGraph.go
new file mode 100644
index 000000000..e9e998474
--- /dev/null
+++ b/api4/openGraph.go
@@ -0,0 +1,56 @@
+// Copyright (c) 2017-present Mattermost, Inc. All Rights Reserved.
+// See License.txt for license information.
+
+package api4
+
+import (
+ "net/http"
+
+ l4g "github.com/alecthomas/log4go"
+ "github.com/mattermost/platform/app"
+ "github.com/mattermost/platform/model"
+ "github.com/mattermost/platform/utils"
+)
+
+const OPEN_GRAPH_METADATA_CACHE_SIZE = 10000
+
+var openGraphDataCache = utils.NewLru(OPEN_GRAPH_METADATA_CACHE_SIZE)
+
+func InitOpenGraph() {
+ l4g.Debug(utils.T("api.opengraph.init.debug"))
+
+ BaseRoutes.OpenGraph.Handle("", ApiSessionRequired(getOpenGraphMetadata)).Methods("POST")
+}
+
+func getOpenGraphMetadata(c *Context, w http.ResponseWriter, r *http.Request) {
+ if !*utils.Cfg.ServiceSettings.EnableLinkPreviews {
+ c.Err = model.NewAppError("getOpenGraphMetadata", "api.post.link_preview_disabled.app_error", nil, "", http.StatusNotImplemented)
+ return
+ }
+
+ props := model.StringInterfaceFromJson(r.Body)
+
+ url := ""
+ ok := false
+ if url, ok = props["url"].(string); len(url) == 0 || !ok {
+ c.SetInvalidParam("url")
+ return
+ }
+
+ ogJSONGeneric, ok := openGraphDataCache.Get(url)
+ if ok {
+ w.Write(ogJSONGeneric.([]byte))
+ return
+ }
+
+ og := app.GetOpenGraphMetadata(url)
+
+ ogJSON, err := og.ToJSON()
+ openGraphDataCache.AddWithExpiresInSecs(props["url"], ogJSON, 3600) // Cache would expire after 1 hour
+ if err != nil {
+ w.Write([]byte(`{"url": ""}`))
+ return
+ }
+
+ w.Write(ogJSON)
+}
diff --git a/api4/openGraph_test.go b/api4/openGraph_test.go
new file mode 100644
index 000000000..958abf604
--- /dev/null
+++ b/api4/openGraph_test.go
@@ -0,0 +1,73 @@
+// Copyright (c) 2017-present Mattermost, Inc. All Rights Reserved.
+// See License.txt for license information.
+
+package api4
+
+import (
+ "fmt"
+ "net/http"
+ "net/http/httptest"
+ "strings"
+
+ "testing"
+
+ "github.com/mattermost/platform/utils"
+)
+
+func TestGetOpenGraphMetadata(t *testing.T) {
+ th := Setup().InitBasic()
+ Client := th.Client
+
+ enableLinkPreviews := *utils.Cfg.ServiceSettings.EnableLinkPreviews
+ defer func() {
+ *utils.Cfg.ServiceSettings.EnableLinkPreviews = enableLinkPreviews
+ }()
+ *utils.Cfg.ServiceSettings.EnableLinkPreviews = true
+
+ ogDataCacheMissCount := 0
+
+ ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ ogDataCacheMissCount++
+
+ if r.URL.Path == "/og-data/" {
+ fmt.Fprintln(w, `
+ <html><head><meta property="og:type" content="article" />
+ <meta property="og:title" content="Test Title" />
+ <meta property="og:url" content="http://example.com/" />
+ </head><body></body></html>
+ `)
+ } else if r.URL.Path == "/no-og-data/" {
+ fmt.Fprintln(w, `<html><head></head><body></body></html>`)
+ }
+ }))
+
+ for _, data := range [](map[string]interface{}){
+ {"path": "/og-data/", "title": "Test Title", "cacheMissCount": 1},
+ {"path": "/no-og-data/", "title": "", "cacheMissCount": 2},
+
+ // Data should be cached for following
+ {"path": "/og-data/", "title": "Test Title", "cacheMissCount": 2},
+ {"path": "/no-og-data/", "title": "", "cacheMissCount": 2},
+ } {
+
+ openGraph, resp := Client.OpenGraph(ts.URL + data["path"].(string))
+ CheckNoError(t, resp)
+ if strings.Compare(openGraph["title"], data["title"].(string)) != 0 {
+ t.Fatal(fmt.Sprintf(
+ "OG data title mismatch for path \"%s\". Expected title: \"%s\". Actual title: \"%s\"",
+ data["path"].(string), data["title"].(string), openGraph["title"],
+ ))
+ }
+
+ if ogDataCacheMissCount != data["cacheMissCount"].(int) {
+ t.Fatal(fmt.Sprintf(
+ "Cache miss count didn't match. Expected value %d. Actual value %d.",
+ data["cacheMissCount"].(int), ogDataCacheMissCount,
+ ))
+ }
+ }
+
+ *utils.Cfg.ServiceSettings.EnableLinkPreviews = false
+ _, resp := Client.OpenGraph(ts.URL + "/og-data/")
+ CheckNotImplementedStatus(t, resp)
+}
diff --git a/i18n/en.json b/i18n/en.json
index 3aaabc686..e43e3fdd2 100644
--- a/i18n/en.json
+++ b/i18n/en.json
@@ -1700,6 +1700,10 @@
"translation": "Initializing reactions api routes"
},
{
+ "id": "api.opengraph.init.debug",
+ "translation": "Initializing open graph protocol api routes"
+ },
+ {
"id": "api.reaction.list_reactions.mismatched_channel_id.app_error",
"translation": "Failed to get reactions because channel ID does not match post ID in the URL"
},
diff --git a/model/client4.go b/model/client4.go
index 7e0cd1acf..91c5b2b5f 100644
--- a/model/client4.go
+++ b/model/client4.go
@@ -250,6 +250,10 @@ func (c *Client4) GetOAuthAppRoute(appId string) string {
return fmt.Sprintf("/oauth/apps/%v", appId)
}
+func (c *Client4) GetOpenGraphRoute() string {
+ return fmt.Sprintf("/opengraph")
+}
+
func (c *Client4) DoApiGet(url string, etag string) (*http.Response, *AppError) {
return c.DoApiRequest(http.MethodGet, c.ApiUrl+url, "", etag)
}
@@ -2575,3 +2579,18 @@ func (c *Client4) DeleteReaction(reaction *Reaction) (bool, *Response) {
return CheckStatusOK(r), BuildResponse(r)
}
}
+
+// Open Graph Metadata Section
+
+// OpenGraph return the open graph metadata for a particular url if the site have the metadata
+func (c *Client4) OpenGraph(url string) (map[string]string, *Response) {
+ requestBody := make(map[string]string)
+ requestBody["url"] = url
+
+ if r, err := c.DoApiPost(c.GetOpenGraphRoute(), MapToJson(requestBody)); err != nil {
+ return nil, &Response{StatusCode: r.StatusCode, Error: err}
+ } else {
+ defer closeBody(r)
+ return MapFromJson(r.Body), BuildResponse(r)
+ }
+}
generated by cgit v1.2.3-1-g7c22 (git 2.25.1) at 2024-05-20 22:11:08 +0000