github.com/qri-io/qri@v0.10.1-0.20220104210721-c771715036cb/config/profile.go

package config

import (
	"fmt"
	"time"

	"github.com/qri-io/jsonschema"
	"github.com/qri-io/qri/dsref"
)

// ProfilePod is serializable plain-old-data that configures a qri profile
type ProfilePod struct {
	ID       string `json:"id"`
	PrivKey  string `json:"privkey,omitempty"`
	KeyID    string `json:"keyid"`
	Peername string `json:"peername"`
	// Created timestamp
	Created time.Time `json:"created"`
	// Updated timestamp
	Updated time.Time `json:"updated"`
	// specifies weather this is a user or an organization
	Type string `json:"type"`
	// user's email address
	Email string `json:"email"`
	// user name field. could be first[space]last, but not strictly enforced
	Name string `json:"name"`
	// user-filled description of self
	Description string `json:"description"`
	// url this user wants the world to click
	HomeURL string `json:"homeurl"`
	// color this user likes to use as their theme color
	Color string `json:"color"`
	// Thumb path for user's thumbnail
	Thumb string `json:"thumb"`
	// Profile photo
	Photo string `json:"photo"`
	// Poster photo for users's profile page
	Poster string `json:"poster"`
	// Twitter is a peer's twitter handle
	Twitter string `json:"twitter"`
	// Online indicates if the user is currently connected to the qri network
	// Should not serialize to config.yaml
	Online bool `json:"online,omitempty"`
	// PeerIDs maps this profile to peer Identifiers in the form /[network]/peerID example:
	// /ipfs/QmSyDX5LYTiwQi861F5NAwdHrrnd1iRGsoEvCyzQMUyZ4W
	// where QmSy... is a peer identifier on the IPFS peer-to-peer network
	// Should not serialize to config.yaml
	PeerIDs []string `json:"peerIDs,omitempty"`
	// NetworkAddrs keeps a list of locations for this profile on the network as multiaddr strings
	// Should not serialize to config.yaml
	NetworkAddrs []string `json:"networkAddrs,omitempty"`
}

// SetArbitrary is an interface implementation of base/fill/struct in order to safely
// consume config files that have definitions beyond those specified in the struct.
// This simply ignores all additional fields at read time.
func (p *ProfilePod) SetArbitrary(key string, val interface{}) error {
	return nil
}

// DefaultProfile gives a new default profile configuration
func DefaultProfile() *ProfilePod {
	now := time.Now()
	return &ProfilePod{
		Created: now,
		Updated: now,
		Type:    "peer",
	}
}

// Validate validates all fields of profile returning all errors found.
func (p ProfilePod) Validate() error {
	if err := dsref.EnsureValidUsername(p.Peername); err != nil {
		return err
	}

	schema := jsonschema.Must(`{
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Profile",
    "description": "Profile of a qri peer",
    "type": "object",
    "properties": {
      "id": {
        "description": "Unique identifier for a peername",
        "type": "string"
      },
      "privkey": {
        "description": "Private key associated with this peerid",
        "type": "string"
      },
      "peername": {
        "description": "Handle name for this peer on qri",
        "type": "string",
        "not": {
          "enum": [
            "me",
            "status",
            "at",
            "add",
            "history",
            "remove",
            "export",
            "profile",
            "list",
            "peers",
            "connections",
            "save",
            "connect"
          ]
        }
      },
      "created": {
        "description": "Datetime the profile was created",
        "type": "string",
        "format": "date-time"
      },
      "updated": {
        "description": "Datetime the profile was last updated",
        "type": "string",
        "format": "date-time"
      },
      "type": {
        "description": "The type of peer this profile represents",
        "type": "string",
        "enum": [
          "peer",
          "organization"
        ]
      },
      "email": {
        "description": "Email associated with this peer",
        "type": "string",
        "anyOf": [
          {
            "maxLength": 255,
            "format": "email"
          },
          {
            "maxLength": 0
          }
        ]
      },
      "name": {
        "description": "Name of peer",
        "type": "string",
        "maxLength": 255
      },
      "description": {
        "description": "Description or bio of peer",
        "type": "string",
        "maxLength": 255
      },
      "homeUrl": {
        "description": "URL associated with this peer",
        "type": "string",
        "anyOf": [
          {
            "maxLength": 255,
            "format": "uri"
          },
          {
            "maxLength": 0
          }
        ]
      },
      "color": {
        "description": "Color scheme peer prefers viewing qri on webapp",
        "type": "string",
        "anyOf": [
          {
            "enum": [
              "default"
            ]
          },
          {
            "maxLength": 0
          }
        ]
      },
      "thumb": {
        "description": "Location of thumbnail of peer's profile picture, an ipfs hash",
        "type": "string"
      },
      "photo": {
        "description": "Location of peer's profile picture, an ipfs hash",
        "type": "string"
      },
      "poster": {
        "description": "Location of a peer's profile poster, an ipfs hash",
        "type": "string"
      },
      "twitter": {
        "description": "Twitter handle associated with peer",
        "type": "string",
        "maxLength": 15
      }
    },
    "required": [
      "id",
      "created",
      "updated",
      "type",
      "peername",
      "privkey"
    ]
  }`)
	return validate(schema, &p)
}

// Copy makes a deep copy of the ProfilePod struct
func (p *ProfilePod) Copy() *ProfilePod {
	res := &ProfilePod{
		ID:          p.ID,
		KeyID:       p.KeyID,
		PrivKey:     p.PrivKey,
		Peername:    p.Peername,
		Created:     p.Created,
		Updated:     p.Updated,
		Type:        p.Type,
		Email:       p.Email,
		Name:        p.Name,
		Description: p.Description,
		HomeURL:     p.HomeURL,
		Color:       p.Color,
		Thumb:       p.Thumb,
		Photo:       p.Photo,
		Poster:      p.Poster,
		Twitter:     p.Twitter,
	}
	if p.PeerIDs != nil {
		res.PeerIDs = make([]string, len(p.PeerIDs))
		copy(res.PeerIDs, p.PeerIDs)
	}

	return res
}

// SetField assigns to the name field of the Profile.
// TODO: Replace this with a generic package.
func (p *ProfilePod) SetField(field, value string) error {
	if field == "id" {
		p.ID = value
	} else if field == "privkey" {
		return fmt.Errorf("Cannot set profile.privkey, read-only")
	} else if field == "peername" {
		p.Peername = value
	} else if field == "created" {
		return fmt.Errorf("Cannot set profile.created, read-only")
	} else if field == "updated" {
		return fmt.Errorf("Cannot set profile.updated, read-only")
	} else if field == "type" {
		p.Type = value
	} else if field == "email" {
		p.Email = value
	} else if field == "name" {
		p.Name = value
	} else if field == "description" {
		p.Description = value
	} else if field == "homeurl" {
		p.HomeURL = value
	} else if field == "color" {
		p.Color = value
	} else if field == "thumb" {
		p.Thumb = value
	} else if field == "photo" {
		return fmt.Errorf("Not implemented: set profile.photo")
	} else if field == "poster" {
		p.Poster = value
	} else if field == "twitter" {
		p.Twitter = value
	} else {
		return fmt.Errorf("Unknown profile field: %s", value)
	}
	return nil
}