Add Nextcloud Talk support (#1167)

Signed-off-by: Gary Kim <gary@garykim.dev>
pull/1175/head
Gary Kim 4 years ago committed by GitHub
parent 213bf349c3
commit 71a5b72aff
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -0,0 +1,114 @@
package nctalk
import (
"context"
"strconv"
"github.com/42wim/matterbridge/bridge"
"github.com/42wim/matterbridge/bridge/config"
talk "gomod.garykim.dev/nc-talk"
"gomod.garykim.dev/nc-talk/ocs"
"gomod.garykim.dev/nc-talk/room"
"gomod.garykim.dev/nc-talk/user"
)
type Btalk struct {
user *user.TalkUser
rooms []Broom
*bridge.Config
}
func New(cfg *bridge.Config) bridge.Bridger {
return &Btalk{Config: cfg}
}
type Broom struct {
room *room.TalkRoom
ctx context.Context
ctxCancel context.CancelFunc
}
func (b *Btalk) Connect() error {
b.Log.Info("Connecting")
b.user = talk.NewUser(b.GetString("Server"), b.GetString("Login"), b.GetString("Password"))
_, err := b.user.Capabilities()
if err != nil {
b.Log.Error("Cannot Connect")
return err
}
b.Log.Info("Connected")
return nil
}
func (b *Btalk) Disconnect() error {
for _, r := range b.rooms {
r.ctxCancel()
}
return nil
}
func (b *Btalk) JoinChannel(channel config.ChannelInfo) error {
newRoom := Broom{
room: talk.NewRoom(b.user, channel.Name),
}
newRoom.ctx, newRoom.ctxCancel = context.WithCancel(context.Background())
c, err := newRoom.room.ReceiveMessages(newRoom.ctx)
if err != nil {
return err
}
b.rooms = append(b.rooms, newRoom)
go func() {
for msg := range c {
// ignore messages that are one of the following
// * not a message from a user
// * from ourselves
if msg.MessageType != ocs.MessageComment || msg.ActorID == b.user.User {
continue
}
remoteMessage := config.Message{
Text: msg.Message,
Channel: newRoom.room.Token,
Username: msg.ActorDisplayName,
UserID: msg.ActorID,
Account: b.Account,
}
// It is possible for the ID to not be set on older versions of Talk so we only set it if
// the ID is not blank
if msg.ID != 0 {
remoteMessage.ID = strconv.Itoa(msg.ID)
}
b.Log.Debugf("<= Message is %#v", remoteMessage)
b.Remote <- remoteMessage
}
}()
return nil
}
func (b *Btalk) Send(msg config.Message) (string, error) {
r := b.getRoom(msg.Channel)
if r == nil {
b.Log.Errorf("Could not find room for %v", msg.Channel)
return "", nil
}
// Talk currently only supports sending normal messages
if msg.Event != "" {
return "", nil
}
sentMessage, err := r.room.SendMessage(msg.Username + msg.Text)
if err != nil {
b.Log.Errorf("Could not send message to room %v from %v: %v", msg.Channel, msg.Username, err)
return "", nil
}
return strconv.Itoa(sentMessage.ID), nil
}
func (b *Btalk) getRoom(token string) *Broom {
for _, r := range b.rooms {
if r.room.Token == token {
return &r
}
}
return nil
}

@ -0,0 +1,11 @@
// +build !nonctalk
package bridgemap
import (
btalk "github.com/42wim/matterbridge/bridge/nctalk"
)
func init() {
FullMap["nctalk"] = btalk.New
}

@ -55,6 +55,7 @@ require (
github.com/zfjagann/golang-ring v0.0.0-20190304061218-d34796e0a6c2
golang.org/x/image v0.0.0-20200430140353-33d19683fad8
golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d
gomod.garykim.dev/nc-talk v0.0.1
gopkg.in/fsnotify.v1 v1.4.7 // indirect
gopkg.in/natefinch/lumberjack.v2 v2.0.0 // indirect
gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 // indirect

@ -224,6 +224,8 @@ github.com/mitchellh/mapstructure v1.1.2 h1:fmNYVwqnSfB9mZU6OS2O6GsXM+wcskZDuKQz
github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
github.com/modern-go/reflect2 v1.0.1/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0=
github.com/monaco-io/request v1.0.3 h1:FsiIwXCCbHEyWx9A7lgg6JBTMHhHlEEsADsgAOvZ9HA=
github.com/monaco-io/request v1.0.3/go.mod h1:EmggwHktBsbJmCgwZXqy7o0H1NNsAstQBWZrFVd3xtQ=
github.com/mreiferson/go-httpclient v0.0.0-20160630210159-31f0106b4474 h1:oKIteTqeSpenyTrOVj5zkiyCaflLa8B+CD0324otT+o=
github.com/mreiferson/go-httpclient v0.0.0-20160630210159-31f0106b4474/go.mod h1:OQA4XLvDbMgS8P0CevmM4m9Q3Jq4phKUzcocxuGJ5m8=
github.com/mrexodia/wray v0.0.0-20160318003008-78a2c1f284ff h1:HLGD5/9UxxfEuO9DtP8gnTmNtMxbPyhYltfxsITel8g=
@ -448,6 +450,8 @@ golang.org/x/tools v0.0.0-20190911174233-4f2ddba30aff/go.mod h1:b+2E5dAYhXwXZwtn
golang.org/x/tools v0.0.0-20191012152004-8de300cfc20a/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.0.0-20191112195655-aa38f8e97acc/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
gomod.garykim.dev/nc-talk v0.0.1 h1:6mgjcAf5/HMkV0CFGeXVfYHG7FAUCQcGR8eg9oM6fCc=
gomod.garykim.dev/nc-talk v0.0.1/go.mod h1:0/Ksg0osAYmnWKs1OcCG+gBQ4HU1xiF1699g9B6jWZw=
google.golang.org/api v0.4.0/go.mod h1:8k5glujaEP+g9n7WNsDg8QP6cUVNI86fCNMcbazEtwE=
google.golang.org/api v0.7.0/go.mod h1:WtwebWUNSVBH/HAw79HIFXZNqEvBhG+Ra+ax0hx3E3M=
google.golang.org/api v0.8.0/go.mod h1:o4eAsZoiT+ibD93RtjEohWalFOjRDx6CVaqeizhEnKg=

@ -1383,7 +1383,22 @@ StripNick=false
#OPTIONAL (default false)
ShowTopicChange=false
###################################################################
#
# NCTalk (Nextcloud Talk)
#
###################################################################
[nctalk.bridge]
# Url of your Nextcloud server
Server = "https://cloud.youdomain.me"
# Username of the bot
Login = "talkuser"
# Password of the bot
Password = "talkuserpass"
###################################################################
#
@ -1702,7 +1717,7 @@ enable=true
# REQUIRED
account="irc.freenode"
# The channel key in each gateway is mapped to a similar group chat ID on the chat platform
# The channel key in each gateway is mapped to a similar group chat ID on the chat platform
# To find the group chat ID for different platforms, refer to the table below
#
# Platform | Identifier name | Example | Description
@ -1730,6 +1745,8 @@ enable=true
# -------------------------------------------------------------------------------------------------------------------------------------
# steam | chatid | example needed | The number in the URL when you click "enter chat room" in the browser
# -------------------------------------------------------------------------------------------------------------------------------------
# nctalk | token | xs25tz5y | The token in the URL when you are in a chat. It will be the last part of the URL.
# -------------------------------------------------------------------------------------------------------------------------------------
# telegram | chatid | -123456789 | A large negative number. see https://www.linkedin.com/pulse/telegram-bots-beginners-marco-frau
# -------------------------------------------------------------------------------------------------------------------------------------
# whatsapp | group JID | 48111222333-123455678999@g.us | A unique group JID. If you specify an empty string, bridge will list all the possibilities

@ -0,0 +1,20 @@
# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib
# Test binary, built with `go test -c`
*.test
# Output of the go coverage tool, specifically when used with LiteIDE
*.out
# Dependency directories (remove the comment below to include it)
# vendor/
.idea
.vscode
coverage.txt

@ -0,0 +1,16 @@
language: go
go:
- 1.14.x
- tip
sudo: false
before_install:
- go get -t -v ./...
script:
- go test -race -coverprofile=coverage.txt -covermode=atomic
after_success:
- bash <(curl -s https://codecov.io/bash) -t 6cf6f7ab-26e6-429c-ac44-f0ad85c1e586

@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at luxuze@agora.io. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
<https://www.contributor-covenant.org/faq>

@ -0,0 +1 @@
# CONTRIBUTING

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2020 Monaco.HappyHacking
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

@ -0,0 +1,197 @@
# Request [![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go) [![Go Report Card](https://goreportcard.com/badge/github.com/monaco-io/request)](https://goreportcard.com/report/github.com/monaco-io/request) ![Go](https://github.com/monaco-io/request/workflows/Go/badge.svg)
<img align="right" width="159px" src="https://raw.githubusercontent.com/gin-gonic/logo/master/color.png">
[![Build Status](https://travis-ci.org/monaco-io/request.svg?branch=master)](https://travis-ci.org/monaco-io/request)
[![GoDoc](https://godoc.org/github.com/monaco-io/request?status.svg)](https://pkg.go.dev/github.com/monaco-io/request?tab=doc)
[![codecov](https://codecov.io/gh/monaco-io/request/branch/master/graph/badge.svg)](https://codecov.io/gh/monaco-io/request)
[![Release](https://img.shields.io/github/release/monaco-io/request.svg?style=flat-square)](https://github.com/monaco-io/request/releases)
[![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/monaco-io/request)](https://www.tickgit.com/browse?repo=github.com/monaco-io/request)
[![License](https://img.shields.io/github/license/monaco-io/request?style=plastic)](https://github.com/monaco-io/request/blob/master/LICENSE)
<!-- [![Sourcegraph](https://sourcegraph.com/github.com/monaco-io/request/-/badge.svg)](https://sourcegraph.com/github.com/monaco-io/request?badge) -->
<!-- [![Open Source Helpers](https://www.codetriage.com/monaco-io/request/badges/users.svg)](https://www.codetriage.com/monaco-io/request) -->
<!-- [![Join the chat at https://gitter.im/monaco-io/request](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/monaco-io/request?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -->
HTTP client for golang, Inspired by [Javascript-axios](https://github.com/axios/axios) [Python-request](https://github.com/psf/requests).
If you have experience about axios or requests, you will love it.
No 3rd dependency.
## Features
- Make [http](https://golang.org) requests from Golang
- Intercept request and response
- Transform request and response data
## Installing
go mod:
```bash
go get github.com/monaco-io/request
```
## Methods
- OPTIONS
- GET
- HEAD
- POST
- PUT
- DELETE
- TRACE
- CONNECT
## Example
### GET
```go
package main
import (
"log"
"github.com/monaco-io/request"
)
func main() {
client := request.Client{
URL: "https://google.com",
Method: "GET",
Params: map[string]string{"hello": "world"},
}
resp, err := client.Do()
log.Println(resp.Code, string(resp.Data), err)
}
```
### POST
```go
package main
import (
"log"
"github.com/monaco-io/request"
)
func main() {
client := request.Client{
URL: "https://google.com",
Method: "POST",
Params: map[string]string{"hello": "world"},
Body: []byte(`{"hello": "world"}`),
}
resp, err := client.Do()
log.Println(resp.Code, string(resp.Data), err)
}
```
### Content-Type
```go
package main
import (
"log"
"github.com/monaco-io/request"
)
func main() {
client := request.Client{
URL: "https://google.com",
Method: "POST",
ContentType: request.ApplicationXWwwFormURLEncoded, // default is "application/json"
}
resp, err := client.Do()
log.Println(resp.Code, string(resp.Data), err)
}
```
### Authorization
```go
package main
import (
"log"
"github.com/monaco-io/request"
)
func main() {
client := request.Client{
URL: "https://google.com",
Method: "POST",
BasicAuth: request.BasicAuth{
Username:"user_xxx",
Password:"pwd_xxx",
}, // xxx:xxx
}
resp, err := client.Do()
log.Println(resp.Code, string(resp.Data), err)
}
```
### Timeout
```go
package main
import (
"log"
"github.com/monaco-io/request"
)
func main() {
client := request.Client{
URL: "https://google.com",
Method: "POST",
Timeout: 10, // seconds
}
resp, err := client.Do()
log.Println(resp.Code, string(resp.Data), err)
}
```
### Cookies
```go
package main
import (
"log"
"github.com/monaco-io/request"
)
func main() {
client := request.Client{
URL: "https://google.com",
Cookies:[]*http.Cookie{
{
Name: "cookie_name",
Value: "cookie_value",
},
},
}
resp, err := client.Do()
log.Println(resp.Code, string(resp.Data), err)
}
```
## License
[MIT](LICENSE)

@ -0,0 +1,59 @@
// Package request HTTP client for golang
// - Make http requests from Golang
// - Intercept request and response
// - Transform request and response data
//
// GET
//
// client := request.Client{
// URL: "https://google.com",
// Method: "GET",
// Params: map[string]string{"hello": "world"},
// }
// resp, err := client.Do()
//
// POST
//
// client := request.Client{
// URL: "https://google.com",
// Method: "POST",
// Params: map[string]string{"hello": "world"},
// Body: []byte(`{"hello": "world"}`),
// }
// resp, err := client.Do()
//
// Content-Type
//
// client := request.Client{
// URL: "https://google.com",
// Method: "POST",
// ContentType: request.ApplicationXWwwFormURLEncoded, // default is "application/json"
// }
// resp, err := client.Do()
//
// Authorization
//
// client := request.Client{
// URL: "https://google.com",
// Method: "POST",
// BasicAuth: request.BasicAuth{
// Username:"user_xxx",
// Password:"pwd_xxx",
// }, // xxx:xxx
// }
//
// resp, err := client.Do()
//
// Cookies
// client := request.Client{
// URL: "https://google.com",
// Cookies:[]*http.Cookie{
// {
// Name: "cookie_name",
// Value: "cookie_value",
// },
// },
// }
//
// resp, err := client.Do()
package request

@ -0,0 +1,3 @@
module github.com/monaco-io/request
go 1.14

@ -0,0 +1,66 @@
package request
import (
"net/http"
"time"
)
const (
// ApplicationJSON application/json
ApplicationJSON ContentType = "application/json"
// ApplicationXWwwFormURLEncoded application/x-www-form-urlencoded
ApplicationXWwwFormURLEncoded ContentType = "application/x-www-form-urlencoded"
// MultipartFormData multipart/form-data
MultipartFormData ContentType = "multipart/form-data"
)
// ContentType Content-Type
type ContentType string
// Client Method
/*
Method = "OPTIONS" ; Section 9.2
| "GET" ; Section 9.3
| "HEAD" ; Section 9.4
| "POST" ; Section 9.5
| "PUT" ; Section 9.6
| "DELETE" ; Section 9.7
| "TRACE" ; Section 9.8
| "CONNECT" ; Section 9.9
| extension-method
extension-method = token
token = 1*<any CHAR except CTLs or separators>
*/
type Client struct {
URL string
Method string
Header map[string]string
Params map[string]string
Body []byte
BasicAuth BasicAuth
Timeout time.Duration // second
ProxyURL string
ContentType ContentType
Cookies []*http.Cookie
// private
client *http.Client
req *http.Request
}
// BasicAuth Add Username:Password as Basic Auth
type BasicAuth struct {
Username string
Password string
}
// SugaredResp Sugared response with status code and body data
type SugaredResp struct {
Data []byte
Code int
// private
resp *http.Response
}

@ -0,0 +1,98 @@
package request
import (
"bytes"
"crypto/tls"
"io/ioutil"
"net/http"
"net/http/cookiejar"
"net/url"
"time"
)
// Do send http request
func (c *Client) Do() (resp SugaredResp, err error) {
defer resp.Close()
if err := c.buildRequest(); err != nil {
return resp, err
}
// send request and close on func call end
if resp.resp, err = c.client.Do(c.req); err != nil {
return resp, err
}
// read response data form resp
resp.Data, err = ioutil.ReadAll(resp.resp.Body)
resp.Code = resp.resp.StatusCode
return resp, err
}
func (c *Client) buildRequest() (err error) {
// encode requestURL.httpURL like https://google.com?hello=world&package=request
ru := requestURL{
urlString: c.URL,
parameters: c.Params,
}
if err := ru.EncodeURL(); err != nil {
return err
}
// build request
c.req, err = http.NewRequest(c.Method, ru.string(), bytes.NewReader(c.Body))
if err != nil {
return err
}
// apply Header to request
if c.Method == "POST" {
if c.ContentType == "" {
c.ContentType = ApplicationJSON
}
c.req.Header.Set("Content-Type", string(c.ContentType))
}
for k, v := range c.Header {
c.req.Header.Add(k, v)
}
// apply basic Auth of request header
if c.BasicAuth.Username != "" && c.BasicAuth.Password != "" {
c.req.SetBasicAuth(c.BasicAuth.Username, c.BasicAuth.Password)
}
c.client = &http.Client{}
// apply timeout
if c.Timeout > 0 {
c.client.Timeout = c.Timeout * time.Second
}
// apply cookies
if c.Cookies != nil {
jar, _ := cookiejar.New(nil)
jar.SetCookies(&url.URL{Scheme: ru.scheme(), Host: ru.host()}, c.Cookies)
c.client.Jar = jar
}
// apply proxy
if c.ProxyURL != "" {
if proxy, err := url.Parse(c.ProxyURL); err == nil && proxy != nil {
c.client.Transport = &http.Transport{
Proxy: http.ProxyURL(proxy),
TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
}
}
}
return err
}
// Resp do request and get original http response struct
func (c *Client) Resp() (resp *http.Response, err error) {
if err = c.buildRequest(); err != nil {
return resp, err
}
return c.client.Do(c.req)
}

@ -0,0 +1,18 @@
package request
// StatusCode get response status code
func (s *SugaredResp) StatusCode() (code int) {
return s.resp.StatusCode
}
// Status get response status code and text, like 200 ok
func (s *SugaredResp) Status() (status string) {
return s.resp.Status
}
// Close close response body
func (s *SugaredResp) Close() {
if s.resp != nil {
_ = s.resp.Body.Close()
}
}

@ -0,0 +1,36 @@
package request
import "net/url"
type requestURL struct {
httpURL *url.URL
urlString string
parameters map[string]string
}
// EncodeURL add and encoded parameters.
func (ru *requestURL) EncodeURL() (err error) {
ru.httpURL, err = url.Parse(ru.urlString)
if err != nil {
return err
}
query := ru.httpURL.Query()
for k := range ru.parameters {
query.Set(k, ru.parameters[k])
}
ru.httpURL.RawQuery = query.Encode()
return err
}
// String return example: https://www.google.com/search?a=1&b=2
func (ru requestURL) string() string {
return ru.httpURL.String()
}
func (ru requestURL) scheme() string {
return ru.httpURL.Scheme
}
func (ru requestURL) host() string {
return ru.httpURL.Host
}

@ -0,0 +1,20 @@
kind: pipeline
type: docker
name: test
steps:
- name: golangci-lint
image: golangci/golangci-lint:latest-alpine
commands:
- golangci-lint run
- name: build-test
image: golang:1.13
commands:
- go build
trigger:
branch:
- master
event:
- pull_request
- push

@ -0,0 +1,12 @@
user=gary-kim
project=go-nc-talk
add_sections={"dependencies": {"labels": ["dependencies"], "prefix": "### Dependencies"}, "Added": {"labels": ["feature"], "prefix": "### Added"}}
output=
header_label=# Go Library for Nextcloud Talk
enhancement_prefix=### Changed
deprecated_prefix=### Deprecated
removed_prefix=### Removed
security_prefix=### Security
bug_prefix=### Fixed
add_pr_wo_labels=false
issues=false

@ -0,0 +1,26 @@
# golangci-lint configuration options
linters:
enable:
- deadcode
- errcheck
- goimports
- golint
- ineffassign
- structcheck
- varcheck
- govet
- unconvert
- prealloc
- maligned
disable-all: false
issues:
# Enable some lints excluded by default
exclude-use-default: false
# Maximum issues count per one linter. Set to 0 to disable. Default is 50.
max-per-linter: 0
# Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
max-same-issues: 0

@ -0,0 +1,10 @@
# Go Library for Nextcloud Talk
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [v0.0.1](https://github.com/gary-kim/riotchat/tree/v0.0.1) - 2020-07-10
* First release

@ -0,0 +1,202 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright {yyyy} {name of copyright owner}
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

@ -0,0 +1,12 @@
# Go Library for Nextcloud Talk
[![Build Status](https://ghdrone.garykim.dev/api/badges/gary-kim/go-nc-talk/status.svg)](https://ghdrone.garykim.dev/gary-kim/go-nc-talk)
[![Godoc](https://img.shields.io/badge/godoc-gomod.garykim.dev%2Fnc--talk-informational)](https://pkg.go.dev/gomod.garykim.dev/nc-talk)
A Go library that can be used to communicate with [Nextcloud Talk](https://github.com/nextcloud/spreed) instances.
### License
Copyright © 2020 Gary Kim &lt;<gary@garykim.dev>&gt;, All Rights Reserved
Licensed under [Apache-2.0](LICENSE)

@ -0,0 +1,20 @@
// Copyright (c) 2020 Gary Kim <gary@garykim.dev>, All Rights Reserved
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package constants
const (
// BaseEndpoint is the api endpoint for Nextcloud Talk
BaseEndpoint = "/ocs/v2.php/apps/spreed/api/v1/"
)

@ -0,0 +1,5 @@
module gomod.garykim.dev/nc-talk
go 1.13
require github.com/monaco-io/request v1.0.3

@ -0,0 +1,2 @@
github.com/monaco-io/request v1.0.3 h1:FsiIwXCCbHEyWx9A7lgg6JBTMHhHlEEsADsgAOvZ9HA=
github.com/monaco-io/request v1.0.3/go.mod h1:EmggwHktBsbJmCgwZXqy7o0H1NNsAstQBWZrFVd3xtQ=

@ -0,0 +1,38 @@
// Copyright (c) 2020 Gary Kim <gary@garykim.dev>, All Rights Reserved
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package talk
import (
"gomod.garykim.dev/nc-talk/room"
"gomod.garykim.dev/nc-talk/user"
)
// NewUser returns a TalkUser instance
func NewUser(url string, username string, password string) *user.TalkUser {
return &user.TalkUser{
NextcloudURL: url,
User: username,
Pass: password,
}
}
// NewRoom returns a new TalkRoom instance
func NewRoom(tuser *user.TalkUser, token string) *room.TalkRoom {
tr := &room.TalkRoom{
User: tuser,
Token: token,
}
return tr
}

@ -0,0 +1,52 @@
// Copyright (c) 2020 Gary Kim <gary@garykim.dev>, All Rights Reserved
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package ocs
// MessageType describes what kind of message a returned Nextcloud Talk message is
type MessageType string
const (
// MessageComment is a Nextcloud Talk message that is a comment
MessageComment MessageType = "comment"
// MessageSystem is a Nextcloud Talk message that is a system
MessageSystem MessageType = "system"
// MessageCommand is a Nextcloud Talk message that is a command
MessageCommand MessageType = "command"
)
// TalkRoomMessageData describes the data part of a ocs response for a Talk room message
type TalkRoomMessageData struct {
Message string `json:"message"`
ID int `json:"id"`
ActorID string `json:"actorId"`
ActorDisplayName string `json:"actorDisplayName"`
SystemMessage string `json:"systemMessage"`
Timestamp int `json:"timestamp"`
MessageType MessageType `json:"messageType"`
}
// TalkRoomMessage describes an ocs response for a Talk room message
type TalkRoomMessage struct {
ocs
TalkRoomMessage []TalkRoomMessageData `json:"data"`
}
// TalkRoomSentResponse describes an ocs response for what is returned when a message is sent
type TalkRoomSentResponse struct {
ocs
TalkRoomMessage TalkRoomMessageData `json:"data"`
}

@ -0,0 +1,25 @@
// Copyright (c) 2020 Gary Kim <gary@garykim.dev>, All Rights Reserved
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package ocs
type ocs struct {
OCSMeta ocsMeta `json:"meta"`
}
type ocsMeta struct {
Status string `json:"status"`
StatusCode int `json:"statuscode"`
Message string `json:"message"`
}

@ -0,0 +1,150 @@
// Copyright (c) 2020 Gary Kim <gary@garykim.dev>, All Rights Reserved
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package room
import (
"context"
"encoding/json"
"errors"
"io/ioutil"
"time"
"github.com/monaco-io/request"
"gomod.garykim.dev/nc-talk/constants"
"gomod.garykim.dev/nc-talk/ocs"
"gomod.garykim.dev/nc-talk/user"
)
// TalkRoom represents a room in Nextcloud Talk
type TalkRoom struct {
User *user.TalkUser
Token string
}
// SendMessage sends a message in the Talk room
func (t *TalkRoom) SendMessage(msg string) (*ocs.TalkRoomMessageData, error) {
url := t.User.NextcloudURL + constants.BaseEndpoint + "/chat/" + t.Token
requestParams := map[string]string{
"message": msg,
}
client := t.User.RequestClient(request.Client{
URL: url,
Method: "POST",
Params: requestParams,
})
res, err := client.Do()
if err != nil {
return nil, err
}
if res.StatusCode() != 201 {
return nil, errors.New("unexpected return code")
}
var msgInfo struct {
OCS ocs.TalkRoomSentResponse `json:"ocs"`
}
err = json.Unmarshal(res.Data, &msgInfo)
return &msgInfo.OCS.TalkRoomMessage, err
}
// ReceiveMessages starts watching for new messages
func (t *TalkRoom) ReceiveMessages(ctx context.Context) (chan ocs.TalkRoomMessageData, error) {
c := make(chan ocs.TalkRoomMessageData)
url := t.User.NextcloudURL + constants.BaseEndpoint + "/chat/" + t.Token
requestParam := map[string]string{
"lookIntoFuture": "1",
"includeLastKnown": "0",
}
lastKnown := ""
client := t.User.RequestClient(request.Client{
URL: url,
Params: requestParam,
Timeout: time.Second * 60,
})
res, err := client.Resp()
if err != nil {
return nil, err
}
lastKnown = res.Header.Get("X-Chat-Last-Given")
go func() {
for {
if ctx.Err() != nil {
return
}
if lastKnown != "" {
requestParam["lastKnownMessageId"] = lastKnown
}
client := t.User.RequestClient(request.Client{
URL: url,
Params: requestParam,
Timeout: time.Second * 60,
})
res, err := client.Resp()
if err != nil {
continue
}
if res.StatusCode == 200 {
lastKnown = res.Header.Get("X-Chat-Last-Given")
var message struct {
OCS ocs.TalkRoomMessage `json:"ocs"`
}
data, err := ioutil.ReadAll(res.Body)
if err != nil {
continue
}
err = json.Unmarshal(data, &message)
if err != nil {
continue
}
for _, msg := range message.OCS.TalkRoomMessage {
c <- msg
}
}
}
}()
return c, nil
}
// TestConnection tests the connection with the Nextcloud Talk instance and returns an error if it could not connect
func (t *TalkRoom) TestConnection() error {
url := t.User.NextcloudURL + constants.BaseEndpoint + "/chat/" + t.Token
requestParam := map[string]string{
"lookIntoFuture": "0",
"includeLastKnown": "0",
}
client := t.User.RequestClient(request.Client{
URL: url,
Params: requestParam,
Timeout: time.Second * 30,
})
res, err := client.Do()
if err != nil {
return err
}
switch res.StatusCode() {
case 200:
return nil
case 304:
return nil
case 404:
return errors.New("room could not be found")
case 412:
return errors.New("room is in lobby mode but user is not a moderator")
}
return errors.New("unknown return code")
}

@ -0,0 +1,132 @@
// Copyright (c) 2020 Gary Kim <gary@garykim.dev>, All Rights Reserved
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package user
import (
"encoding/xml"
"reflect"
"github.com/monaco-io/request"
)
const (
ocsCapabilitiesEndpoint = "/ocs/v2.php/cloud/capabilities"
)
// TalkUser represents a user of Nextcloud Talk
type TalkUser struct {
User string
Pass string
NextcloudURL string
capabilities *Capabilities
}
// Capabilities describes the capabilities that the Nextcloud Talk instance is capable of. Visit https://nextcloud-talk.readthedocs.io/en/latest/capabilities/ for more info.
type Capabilities struct {
Audio bool `ocscapability:"audio"`
Video bool `ocscapability:"video"`
Chat bool `ocscapability:"chat"`
GuestSignaling bool `ocscapability:"guest-signaling"`
EmptyGroupRoom bool `ocscapability:"empty-group-room"`
GuestDisplayNames bool `ocscapability:"guest-display-names"`
MultiRoomUsers bool `ocscapability:"multi-room-users"`
ChatV2 bool `ocscapability:"chat-v2"`
Favorites bool `ocscapability:"favorites"`
LastRoomActivity bool `ocscapability:"last-room-activity"`
NoPing bool `ocscapability:"no-ping"`
SystemMessages bool `ocscapability:"system-messages"`
MentionFlag bool `ocscapability:"mention-flag"`
InCallFlags bool `ocscapability:"in-call-flags"`
InviteByMail bool `ocscapability:"invite-by-mail"`
NotificationLevels bool `ocscapability:"notification-levels"`
InviteGroupsAndMails bool `ocscapability:"invite-groups-and-mails"`
LockedOneToOneRooms bool `ocscapability:"locked-one-to-one-rooms"`
ReadOnlyRooms bool `ocscapability:"read-only-rooms"`
ChatReadMarker bool `ocscapability:"chat-read-marker"`
WebinaryLobby bool `ocscapability:"webinary-lobby"`
StartCallFlag bool `ocscapability:"start-call-flag"`
ChatReplies bool `ocscapability:"chat-replies"`
CirclesSupport bool `ocscapability:"circles-support"`
AttachmentsAllowed bool `ocscapability:"config => attachments => allowed"`
AttachmentsFolder bool `ocscapability:"config => attachments => folder"`
ConversationsCanCreate bool `ocscapability:"config => conversations => can-create"`
ForceMute bool `ocscapability:"force-mute"`
ConversationV2 bool `ocscapability:"conversation-v2"`
ChatReferenceID bool `ocscapability:"chat-reference-id"`
}
type capabilitiesRequest struct {
XMLName xml.Name `xml:"ocs"`
Capabilities []string `xml:"ocs>data>capabilities>spreed>features>element"`
}
// RequestClient returns a monaco-io that is preconfigured to make OCS API calls
func (t *TalkUser) RequestClient(client request.Client) *request.Client {
if client.Header == nil {
client.Header = make(map[string]string)
}
if client.Header["OCS-APIRequest"] == "" {
client.Header["OCS-APIRequest"] = "true"
}
if client.Header["Accept"] == "" {
client.Header["Accept"] = "application/json"
}
client.BasicAuth = request.BasicAuth{
Username: t.User,
Password: t.Pass,
}
return &client
}
// Capabilities returns an instance of Capabilities that describes what the Nextcloud Talk instance supports
func (t *TalkUser) Capabilities() (*Capabilities, error) {
if t.capabilities != nil {
return t.capabilities, nil
}
client := t.RequestClient(request.Client{
URL: ocsCapabilitiesEndpoint,
Header: map[string]string{
"Accept": "application/xml",
},
})
res, err := client.Do()
if err != nil {
return nil, err
}
capabilities := &capabilitiesRequest{}
err = xml.Unmarshal(res.Data, capabilities)
if err != nil {
return nil, err
}
tr := &Capabilities{}
c := reflect.ValueOf(tr)
for i := 0; i < c.NumField(); i++ {
field := c.Field(i)
tag := field.Type().Field(0).Tag.Get("ocscapability")
for _, capability := range capabilities.Capabilities {
if capability == tag && field.CanSet() {
field.SetBool(true)
}
}
}
t.capabilities = tr
return tr, nil
}

@ -128,6 +128,8 @@ github.com/mgutz/ansi
github.com/missdeer/golib/ic
# github.com/mitchellh/mapstructure v1.1.2
github.com/mitchellh/mapstructure
# github.com/monaco-io/request v1.0.3
github.com/monaco-io/request
# github.com/mreiferson/go-httpclient v0.0.0-20160630210159-31f0106b4474
github.com/mreiferson/go-httpclient
# github.com/mrexodia/wray v0.0.0-20160318003008-78a2c1f284ff
@ -273,6 +275,12 @@ golang.org/x/text/secure/bidirule
golang.org/x/text/transform
golang.org/x/text/unicode/bidi
golang.org/x/text/unicode/norm
# gomod.garykim.dev/nc-talk v0.0.1
gomod.garykim.dev/nc-talk
gomod.garykim.dev/nc-talk/constants
gomod.garykim.dev/nc-talk/ocs
gomod.garykim.dev/nc-talk/room
gomod.garykim.dev/nc-talk/user
# google.golang.org/appengine v1.6.1
google.golang.org/appengine/internal
google.golang.org/appengine/internal/base

Loading…
Cancel
Save