GitHub/tinode-chat
1
0
Fork 0
mirror of https://github.com/tinode/chat.git synced 2026-05-07 20:12:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

clean up removal of conferencing

Browse Source
This commit is contained in:
or-else
2025-02-14 18:12:28 +03:00
parent 2a8c865b9f
commit 8095093acd
8 changed files with 47 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/API.md
+25 -18
View File
@@ -28,13 +28,13 @@
- [Peer to Peer Topics](#peer-to-peer-topics)
- [Group Topics](#group-topics)
- [sys Topic](#sys-topic)
- [Auxiliary data](#auxiliary-data)
- [Using Server-Issued Message IDs](#using-server-issued-message-ids)
- [User Agent and Presence Notifications](#user-agent-and-presence-notifications)
- [Trusted, Public, and Private Fields](#trusted-public-and-private-fields)
- [Trusted, Public, Private, Auxiliary Fields](#trusted-public-private-auxiliary-fields)
- [Trusted](#trusted)
- [Public](#public)
- [Private](#private)
- [Auxiliary](#auxiliary)
- [Format of Content](#format-of-content)
- [Out-of-Band Handling of Large Files](#out-of-band-handling-of-large-files)
- [Uploading](#uploading)
@@ -432,14 +432,6 @@ A `channel` topic is different from the non-channel group topic in the following
The `sys` topic serves as an always available channel of communication with the system administrators. A normal non-root user cannot subscribe to `sys` but can publish to it without subscription. Existing clients use this channel to report abuse by sending a Drafty-formatted `{pub}` message with the report as JSON attachment. A root user can subscribe to `sys` topic. Once subscribed, the root user will receive messages sent to `sys` topic by other users.
### Auxiliary data
Topics have `aux` field which represents arbitrary auxiliary data stored as a set of key-value pairs. The `aux` is writable by topic admins and readable by all topic subscribers.
The following fields are currently defined:
* `pins`: array of integer message IDs to pin to the top of the message list.
## Using Server-Issued Message IDs
Tinode provides basic support for client-side caching of `{data}` messages in the form of server-issued sequential message IDs. The client may request the last message id from the topic by issuing a `{get what="desc"}` message. If the returned ID is greater than the ID of the latest received message, the client knows that the topic has unread messages and their count. The client may fetch these messages using `{get what="data"}` message. The client may also paginate history retrieval by using message IDs.
@@ -454,13 +446,22 @@ A user is reported as being online when one or more of user's sessions are attac
An empty `ua=""` _user agent_ is not reported. I.e. if user attaches to `me` with non-empty _user agent_ then does so with an empty one, the change is not reported. An empty _user agent_ may be disallowed in the future.
## Trusted, Public, and Private Fields
## Trusted, Public, Private, Auxiliary Fields
Topics and subscriptions have `trusted`, `public`, and `private` fields. Generally, the fields are application-defined. The server does not enforce any particular structure of these fields except for `fnd` topic. At the same time, client software should use the same format for interoperability reasons. The following sections describe the format of these fields as they are implemented by all official clients.
Topics have `trusted`, `public`, `aux` fields, subscriptions have `private` fields. The primary difference between these fields is in access control:
* `trusted`: writable by `ROOT` users, readable by anyone.
* `public`: writable by the `owner` or the user, readable by anyone.
* `aux`: writable by topic administrators, readable by subscribers.
* `private`: readable and writable only by the user who created the subscription.
Generally, the fields are application-defined. The server does not enforce any particular structure of these fields except for `fnd` topic. At the same time, client software should use the same format for interoperability reasons. The following sections describe the format of these fields as they are implemented by all official clients.
Although it's not yet enforced, if a third-party application defines custom keys, the key names should start with an `x-` followed by the application's fully qualified domain name, e.g. `x-example.com-value: "abc"`. The fields should contain primitive types only, i.e. `string`, `boolean`, `number`, or `null`.
### Trusted
The format of the optional `trusted` field in group and peer to peer topics is a set of key-value pairs; `fnd` and `sys` topics do not have the `trusted`. The field is writable by ROOT users, readable by anyone who has access to the topic or user. The following optional keys are currently defined:
The format of the optional `trusted` field in group and peer to peer topics is a set of key-value pairs; `fnd` and `sys` topics do not have the `trusted`. The field is writable by `ROOT` users, readable by anyone who has access to the topic or user. The following optional keys are currently defined:
```js
trusted: {
verified: true, // boolean, an indicator of a verified/trustworthy user or topic.
@@ -472,8 +473,7 @@ trusted: {
### Public
The format of the `public` field in group, peer to peer, systems topics is expected to be [theCard](./thecard.md). The field is writable by
by the user for users, the topic owner for topics. The field is readable by anyone who has access to topic or user.
The format of the `public` field in group, peer to peer, systems topics is expected to be [theCard](./thecard.md). The field is writable by by the user for users, the topic owner for topics. The field is readable by anyone who has access to topic or user.
The `fnd` topic expects `public` to be a string representing a [search query](#query-language)).
@@ -485,15 +485,22 @@ private: {
comment: "some comment", // string, optional user comment about a topic or a peer user
arch: true, // boolean, indicator that the topic is archived by the user, i.e.
// should not be shown in the UI with other non-archived topics.
label: "starred", // string, label which UI may use for topic display or sorting.
accepted: "JRWS" // string, 'given' mode accepted by the user.
}
```
Although it's not yet enforced, custom fields should start with an `x-` followed by the application name, e.g. `x-myapp-value: "abc"`. The fields should contain primitive types only, i.e. `string`, `boolean`, `number`, or `null`.
The `fnd` topic expects `private` to be a string representing a [search query](#query-language)).
### Auxiliary
The format of the `aux` field is a set of key-value pairs. The `aux` is writable by topic admins and readable by all topic subscribers. The following keys are currently defined:
```js
aux: {
pins: [1001, 23456] // array of integer message IDs to pin to the top of the message list.
}
```
## Format of Content
Format of `content` field in `{pub}` and `{data}` is application-defined and as such the server does not enforce any particular structure of the field. At the same time, client software should use the same format for interoperability reasons. Currently the following two types of `content` are supported:
server/db/mongodb/adapter.go
+5 -6
View File
@@ -41,7 +41,7 @@ const (
defaultHost = "localhost:27017"
defaultDatabase = "tinode"
adpVersion = 115
adpVersion = 114
adapterName = "mongodb"
defaultMaxResults = 1024
@@ -532,9 +532,8 @@ func (a *adapter) UpgradeDb() error {
}
if a.version == 113 {
// Version 114: topics.aux added (never released to public).
// Version 115: fileuploads.etag added.
if err := bumpVersion(a, 115); err != nil {
// Version 114: topics.aux added, fileuploads.etag added..
if err := bumpVersion(a, 114); err != nil {
return err
}
}
@@ -2749,8 +2748,8 @@ func (a *adapter) isDbInitialized() bool {
return true
}
// GetTestAdapter returns an adapter object. It's required for running tests.
func GetTestAdapter() *adapter {
// TestingGetAdapter returns an adapter object. Useful for running tests.
func TestingGetAdapter() *adapter {
return &adapter{}
}
server/db/mongodb/tests/mongo_test.go
+1 -1
View File
@@ -1205,7 +1205,7 @@ func initConnectionToDb() {
func init() {
logs.Init(os.Stderr, "stdFlags")
adp = backend.GetTestAdapter()
adp = backend.TestingGetAdapter()
conffile := flag.String("config", "./test.conf", "config of the database connection")
if file, err := os.Open(*conffile); err != nil {
server/db/mysql/adapter.go
+2 -10
View File
@@ -44,7 +44,7 @@ const (
defaultDSN = "root:@tcp(localhost:3306)/tinode?parseTime=true"
defaultDatabase = "tinode"
adpVersion = 115
adpVersion = 114
adapterName = "mysql"
@@ -784,19 +784,11 @@ func (a *adapter) UpgradeDb() error {
return err
}
if err := bumpVersion(a, 114); err != nil {
return err
}
}
if a.version == 114 {
// Perform database upgrade from version 114 to version 115.
if _, err := a.db.Exec("ALTER TABLE fileuploads ADD etag VARCHAR(128) AFTER size"); err != nil {
return err
}
if err := bumpVersion(a, 115); err != nil {
if err := bumpVersion(a, 114); err != nil {
return err
}
}
server/db/postgres/adapter.go
+2 -10
View File
@@ -46,7 +46,7 @@ type adapter struct {
}
const (
adpVersion = 115
adpVersion = 114
adapterName = "postgres"
defaultMaxResults = 1024
@@ -635,19 +635,11 @@ func (a *adapter) UpgradeDb() error {
return err
}
if err := bumpVersion(a, 114); err != nil {
return err
}
}
if a.version == 114 {
// Perform database upgrade from version 114 to version 115.
if _, err := a.db.Exec(ctx, "ALTER TABLE fileuploads ADD COLUMN etag VARCHAR(128)"); err != nil {
return err
}
if err := bumpVersion(a, 115); err != nil {
if err := bumpVersion(a, 114); err != nil {
return err
}
}
server/db/rethinkdb/adapter.go
+4 -5
View File
@@ -34,7 +34,7 @@ const (
defaultHost = "localhost:28015"
defaultDatabase = "tinode"
adpVersion = 115
adpVersion = 114
adapterName = "rethinkdb"
@@ -558,10 +558,9 @@ func (a *adapter) UpgradeDb() error {
}
if a.version == 113 {
// Version 114: topics.aux added (never released to public).
// Version 115: fileuploads.etag added
// Version 114: topics.aux added, fileuploads.etag added.
// Just bump the version.
if err := bumpVersion(a, 115); err != nil {
if err := bumpVersion(a, 114); err != nil {
return err
}
}
@@ -2405,7 +2404,7 @@ func (a *adapter) CredUpsert(cred *t.Credential) (bool, error) {
}
defer cursor2.Close()
if !cursor2.IsNil() {
tableCredentials.Get(cred.Id).
_, err = tableCredentials.Get(cred.Id).
Replace(rdb.Row.Without("DeletedAt").
Merge(map[string]any{
"UpdatedAt": cred.UpdatedAt,
server/hdl_files.go
+8 -10
View File
@@ -29,8 +29,6 @@ import (
"google.golang.org/grpc/peer"
)
type fileResponseWriter func(msg *ServerComMessage, err error)
// Allowed mime types for user-provided Content-type field. Must be alphabetically sorted.
// Types not in the list are converted to "application/octet-stream".
// See https://www.iana.org/assignments/media-types/media-types.xhtml
@@ -491,8 +489,6 @@ func (*grpcNodeServer) LargeFileReceive(stream pbx.Node_LargeFileReceiveServer)
return nil
}
resp := pbx.FileUpResp{Meta: &pbx.FileMeta{}}
// Check if uploads are handled elsewhere.
headers, statusCode, err := mh.Headers(http.MethodPost, nil, http.Header{}, false)
if err != nil {
@@ -503,12 +499,14 @@ func (*grpcNodeServer) LargeFileReceive(stream pbx.Node_LargeFileReceiveServer)
if statusCode != 0 {
// The handler requested to terminate further processing.
resp.Id = msgID
resp.Code = int32(statusCode)
resp.Text = http.StatusText(statusCode)
resp.RedirUrl = headers.Get("Location")
logs.Info.Println("media upload: completed with status", statusCode, "uid=", uid)
return nil
err = stream.SendAndClose(&pbx.FileUpResp{
Id: msgID,
Code: int32(statusCode),
Text: http.StatusText(statusCode),
RedirUrl: headers.Get("Location"),
})
logs.Info.Println("media upload: completed with status", statusCode, "uid=", uid, err)
return err
}
mimeType := http.DetectContentType(req.Content)
server/topic.go
-1
View File
@@ -2996,7 +2996,6 @@ func (t *Topic) replySetAux(sess *Session, asUid types.Uid, msg *ClientComMessag
return errors.New("aux update by non-admin")
}
logs.Info.Println(msg.Set.Aux, t.aux)
if aux, changed := mergeMaps(copyMap(t.aux), msg.Set.Aux); changed {
err := store.Topics.Update(t.name, map[string]any{"Aux": aux, "UpdatedAt": now})
if err == nil {