go/chat/msgchecker/plaintext_checker.go - master - githubmirror/client

go/chat/msgchecker/plaintext_checker.go
124 строки4 KB
Mike Maxim
pinned messages (#18963)
28 авг 2019, 23:38
28 авг 2019, 23:38534549b
package msgchecker

import (
	"errors"
	"fmt"
	"regexp"

	"github.com/keybase/client/go/protocol/chat1"
)

var validTopicNameRegex = regexp.MustCompile(`^[0-9a-zA-Z_-]+$`)

type validateTopicNameRes int

const (
	validateTopicNameResOK            validateTopicNameRes = 0
	validateTopicNameResInvalidLength validateTopicNameRes = 1
	validateTopicNameResInvalidChar   validateTopicNameRes = 2
)

func (r validateTopicNameRes) String() string {
	switch r {
	case validateTopicNameResInvalidChar:
		return "invalid characters in channel name, please use alphanumeric, underscores, or dashes"
	case validateTopicNameResInvalidLength:
		return "invalid channel name length. Must be greater than 0 and less than or equal to 20"
	case validateTopicNameResOK:
		return "OK"
	}
	return ""
}

func validateTopicName(topicName string) validateTopicNameRes {
	if len(topicName) == 0 || len(topicName) > TopicMaxLength {
		return validateTopicNameResInvalidLength
	}
	if !validTopicNameRegex.MatchString(topicName) {
		return validateTopicNameResInvalidChar
	}
	return validateTopicNameResOK
}

type MessagePlaintextLengthExceedingError struct {
	ActualLength         int
	MaxLength            int
	DescriptibleItemName string
}

func (e MessagePlaintextLengthExceedingError) Error() string {
	return fmt.Sprintf("%s of size %d bytes exceeds the maximum length of %d bytes", e.DescriptibleItemName, e.ActualLength, e.MaxLength)
}

func (e MessagePlaintextLengthExceedingError) IsImmediateFail() (chat1.OutboxErrorType, bool) {
	return chat1.OutboxErrorType_TOOLONG, true
}

func plaintextFieldLengthChecker(descriptibleItemName string, actualLength int, maxLength int) error {
	if actualLength > maxLength {
		return MessagePlaintextLengthExceedingError{
			ActualLength:         actualLength,
			MaxLength:            maxLength,
			DescriptibleItemName: descriptibleItemName,
		}
	}
	return nil
}

func checkMessagePlaintextLength(msg chat1.MessagePlaintext) error {
	mtype, err := msg.MessageBody.MessageType()
	if err != nil {
		return err
	}

	textMsgLength := getMaxTextLength(msg.ClientHeader.Conv.TopicType)
	switch mtype {
	case chat1.MessageType_ATTACHMENT,
		chat1.MessageType_DELETE,
		chat1.MessageType_NONE,
		chat1.MessageType_TLFNAME,
		chat1.MessageType_ATTACHMENTUPLOADED,
		chat1.MessageType_JOIN,
		chat1.MessageType_PIN,
		chat1.MessageType_LEAVE,
		chat1.MessageType_SYSTEM,
		chat1.MessageType_DELETEHISTORY,
		chat1.MessageType_SENDPAYMENT,
		chat1.MessageType_UNFURL:
		return nil
	case chat1.MessageType_TEXT:
		return plaintextFieldLengthChecker("message", len(msg.MessageBody.Text().Body), textMsgLength)
	case chat1.MessageType_FLIP:
		return plaintextFieldLengthChecker("flip", len(msg.MessageBody.Flip().Text), textMsgLength)
	case chat1.MessageType_EDIT:
		return plaintextFieldLengthChecker("message edit", len(msg.MessageBody.Edit().Body),
			textMsgLength)
	case chat1.MessageType_REACTION:
		return plaintextFieldLengthChecker("message reaction", len(msg.MessageBody.Reaction().Body),
			ReactionMessageMaxLength)
	case chat1.MessageType_HEADLINE:
		return plaintextFieldLengthChecker("headline", len(msg.MessageBody.Headline().Headline),
			HeadlineMaxLength)
	case chat1.MessageType_METADATA:
		if msg.ClientHeader.Conv.TopicType == chat1.TopicType_CHAT {
			topicNameRes := validateTopicName(msg.MessageBody.Metadata().ConversationTitle)
			if validateTopicNameResOK != topicNameRes {
				return errors.New(topicNameRes.String())
			}
		}
		return nil
	case chat1.MessageType_REQUESTPAYMENT:
		return plaintextFieldLengthChecker("request payment note",
			len(msg.MessageBody.Requestpayment().Note), RequestPaymentTextMaxLength)
	default:
		typ, err := msg.MessageBody.MessageType()
		if err != nil {
			return fmt.Errorf("unknown message type: %v", err)
		}
		return fmt.Errorf("unknown message type: %v", typ)
	}
}

func CheckMessagePlaintext(msg chat1.MessagePlaintext) error {
	return checkMessagePlaintextLength(msg)
}