models

type BasicModel struct {
	//
	// 默认作为主键
	// 自动增长的ID
	//
	//
	ID uint `gorm:"PRIMARY_KEY;AUTO_INCREMENT" json:"id"`
	//
	// 创建时间
	CreatedAt time.Time `json:"create_at"`
	//
	// 更新时间
	UpdatedAt time.Time `json:"update_at"`
	//
	// 逻辑删除时间
	DeletedAt *time.Time `sql:"index" json:"delete_at"`
}

type BasicRemoveableModel struct {
	//
	// 默认作为主键
	// 自动增长的ID
	//
	//
	ID uint `gorm:"PRIMARY_KEY;AUTO_INCREMENT" json:"id"`
	//
	// 创建时间
	CreatedAt time.Time `json:"create_at"`
	//
	// 更新时间
	UpdatedAt time.Time `json:"update_at"`
}

type Comment struct {
	BasicRemoveableModel
	// 对应用户的id
	// 查询时将直接根据用户ID查询
	UID int `gorm:"TYPE:int(25);NOT NULL;" json:"-"`
	//
	// 数据存储时 MomentID，CommentID，NewsID 仅选择其一
	//
	// 关联的momentID
	//
	MomentID int `gorm:"TYPE:int;DEFAULT:NULL;" json:"moment_id"`
	//
	// 关联的资讯ID
	//
	NewsID int `gorm:"TYPE:int;DEFAULT:NULL;" json:"news_id"`
	//
	// 关联的资讯ID
	//
	CommentID int `gorm:"TYPE:int;DEFAULT:NULL;" json:"comment_id"`
	//
	// content 评论的内容
	//
	Content string `gorm:"TYPE:varchar(255);DEFAULT:NULL;" json:"content"`
	//
	// 用户个人资料外联表模型
	UsersProfiles UsersProfiles `gorm:"FOREIGNKEY:uid;AssociationForeignKey:uid;association_autoupdate:false;" json:"profile"`
}

type Config struct {
	BasicRemoveableModel

	//
	// configration item name
	//
	Name string `gorm:"TYPE:varchar(255);DEFAULT:NULL;" json:"name"`
	//
	// configration item value
	//
	Value string `gorm:"TYPE:varchar(255);DEFAULT:NULL;" json:"value"`
}

type Contact struct {
	BasicRemoveableModel
	// who create this filed
	UID int `gorm:"TYPE:int(25);NOT NULL;" json:"uid"` //
	// relate a user with this contact filed
	FriendUID int `gorm:"TYPE:int(25);NOT NULL;" json:"friend_uid"` //
	// comment a target contact user name as user wanted
	Comment string `gorm:"TYPE:varchar(30);NOT NULL;" json:"comment"`
	// Black means this is a blocked user contact filed
	Black int `gorm:"TYPE:int(25);DEFAULT:0;" json:"black"`
	// 用户个人资料外联表模型
	UsersProfiles UsersProfiles `gorm:"FOREIGNKEY:FriendUID;AssociationForeignKey:id;association_autoupdate:false;" json:"profile"`
}

type FeedBack struct {
	BasicModel
	//
	// UID 是反馈用户的UID
	// 由于可以匿名反馈，所以用户的UID可以不填写
	UID int `gorm:"TYPE:int(25);DEFAULT:0;" json:"uid"`

	//
	// 反馈的内容
	//
	Comment string `gorm:"TYPE:varchar(255);DEFAULT:NULL;" json:"comment"`

	//
	// 当前的状态
	//
	Status int `gorm:"type:int(25);DEFAULT: 0" json:"status"` /** 0 未处理 1 已处理 */
	//
	// 进行处理的时间
	// 也就是工作人员确定已经给用户反馈的时间
	ProcessDate string `gorm:"TYPE:datetime;DEFAULT:NULL;" json:"process_date"`
}

type Media struct {
	BasicModel
	// UID is users id
	// MEDIA的文件将从MEDIA_FILES关联查询
	//
	// 用户id
	//
	UID int `gorm:"TYPE:int(25);NOT NULL" json:"-"`

	// MeidaFiles is media files information
	//
	// 关联查询媒体
	// 从mediaFiles查询
	MeidaFiles *[]MediaFiles `gorm:"FOREIGNKEY:media_id;AssociationForeignKey:id;association_autoupdate:false;" json:"media_files"`
}

type MediaFiles struct {
	BasicModel
	//
	// MEDIA的文件将从MEDIA_FILES关联查询
	//
	// 用户id
	//
	UID int `gorm:"TYPE:int(25);NOT NULL" json:"uid"`
	//
	// MEDIA关联ID
	// 默认不能为空
	//
	MediaID int `gorm:"TYPE:int(25);NOT NULL" json:"media_id"`
	//
	// Header
	// 文件头
	//
	ContentType string `gorm:"TYPE:varchar(255);DEFAULT:NULL;" json:"content_type"`
	//
	// Size
	// 文件大小
	//
	Size int64 `gorm:"TYPE:int;DEFAULT:NULL;" json:"size"`
	//
	// Comment
	// 备注文件
	//
	Comment string `gorm:"TYPE:varchar(255);DEFAULT:NULL;" json:"comment"`
	//
	// file path(key)
	// file path not contants protocol and host
	// path should be same as oss storage key
	//
	Key string `gorm:"TYPE:varchar(255);DEFAULT:NULL;" json:"key"`
}

type Moment struct {
	BasicModel
	//
	// 用户id
	//
	UID int `gorm:"TYPE:int;NOT NULL" json:"-"`
	//
	// 类型
	// 类型指的是动态类型
	// 用户的动态分为 0 公开的，1私有的，2指定的，默认为0 即Public
	//
	Type int `gorm:"TYPE:int(2);DEFAULT:0;" json:"type"`
	//
	// 文字信息
	// 文字信息最长不得超过280个
	// 活在280个字节的世界里挺好
	//
	Context string `gorm:"TYPE:text(280);DEFAULT:NULL;" json:"context"`
	//
	// 关联媒体
	// 媒体ID会在查询的时候一并查询出来
	// 通常媒体信息可能为图片，视频，等，具体根据媒体模型判定
	//
	MediaID int `gorm:"TYPE:int;DEFAULT:null;" json:"media_id"`
	//
	//
	// 发送的地理位置(可选)
	// 为经纬度合集 正确格式：41.40338，2.17403
	// 其他格式都不能入库，这个在控制器数据入库的时候会进行过滤检查
	// 默认为NULL
	//
	LocationDegrees string `gorm:"TYPE:varchar(255);DEFAULT:NULL;" json:"location_degree"`
	//
	// 地理位置Text(即定位位置的名称，仅当前位置，而非完整的精确的 国省市 例如： 北京奥利匹克体育中心)
	//
	LocationText string `gorm:"TYPE:varchar(255);DEFAULT:NULL;" json:"location_text"`
	//
	// 关联的momentID
	//
	MomentID int `gorm:"TYPE:int;DEFAULT:NULL;" json:"momentID"`
	//
	// Views 动态查看次数
	//
	Views int `gorm:"TYPE:int;DEFAULT:0;" json:"views"` //当用户拉取动态详情，第一页时，对views进行计次更新
	//
	//
	// 用户个人资料外联表模型
	//
	UsersProfiles UsersProfiles `gorm:"FOREIGNKEY:uid;AssociationForeignKey:uid;association_autoupdate:false;" json:"profile"`
}

type News struct {
	BasicModel

	// add by user
	AddBy int `gorm:"TYPE:int(25);NOT NULL" json:"-"`

	// category Id, should nerver be null
	// news will not be publish if category id equals null
	CategoryID int `gorm:"TYPE:int(25);" json:"category_id"`

	// title
	Title string `gorm:"TYPE:varchar(25);DEFAULT:''" json:"title"` // news title

	// content
	Content string `gorm:"TYPE:text;DEFAULT:NULL;" json:"content"`

	// sourceUri
	// news from which website
	SourceURI string `gorm:"TYPE:varchar(255);DEFAULT:NULL;" json:"source_uri"`

	// author
	// original author information
	Author string `gorm:"TYPE:varchar(255);DEFAULT:NULL;" json:"author"`

	// mark this news could support any comment
	// if equals 0, all comments will not be saved and display
	CommentAvailable string `gorm:"TYPE:int(25);DEFAULT:'1'" json:"comment_available"` // news title

	// news will be expired at
	// default is null, this filed can be null
	ExpireAt string `gorm:"TYPE:datetime;DEFAULT:NULL;" json:"expire_at"`
}

type NewsCates struct {
	BasicRemoveableModel

	// 对应用户的id
	// 查询时将直接根据用户ID查询
	// 该分类添加的用户
	AddBy int `gorm:"TYPE:int(25);NOT NULL" json:"-"`

	// parent category Id
	// null means this category is first level category
	ParentID int `gorm:"TYPE:int(25);DEFAULT:'0'" json:"parent_id"`

	// category name
	Name string `gorm:"TYPE:varchar(25);DEFAULT:'';UNIQUE" json:"name"`

	// category theme color
	ThemeColor string `gorm:"TYPE:varchar(25);DEFAULT:'default'" json:"theme-color"`

	// when status equals 1, this category will be available, 2 should hide and forbid to add any news
	Status int `gorm:"TYPE:int(25);NOT NULL;DEFAULT:'1'" json:"status"`
}

type Notification struct {
	BasicRemoveableModel

	// 通知
	// 评论1 AT2 点赞3 系统0
	Type int `gorm:"TYPE:int(25);DEFAULT:0;" json:"type"`
	//
	// 对应用户的id
	// 查询时将直接根据用户ID查询
	//
	UID int `gorm:"TYPE:int(25);DEFAULT:NULL;" json:"-"`
	//
	// 是否未读
	// 1为已读，0为未读
	//
	Unread int `gorm:"TYPE:int(25);NOT NULL;DEFAULT:1;" json:"unread"`
	//
	// 评论ID
	//
	CommentID uint `gorm:"TYPE:int;DEFAULT:NULL;" json:"comment_id"`
	//
	// 动态ID
	//
	MomentID uint `gorm:"TYPE:int;DEFAULT:NULL;" json:"moment_id"`
	//
	// 关联的资讯ID
	//
	NewsID uint `gorm:"TYPE:int;DEFAULT:NULL;" json:"news_id"`
	//
	// 描述
	// 通知描述
	//
	Description string `gorm:"TYPE:varchar(255);DEFAULT:NULL;" json:"description"`
	//
	// 关联动态
	Moment Moment `gorm:"association_jointable_foreignkey:moment_id;" json:"moment"`
	//
	// 关联资讯
	News News `gorm:"association_jointable_foreignkey:news_id;" json:"news"`
	//
	// 关联评论
	Comment Comment `gorm:"association_jointable_foreignkey:comment_id;" json:"comment"`
}

type ReportModel struct {
	BasicRemoveableModel

	// report by uid
	// reporter should login to add reports
	ReportedBy int `gorm:"TYPE:int(25);NOT NULL" json:"-"`

	// commentID
	CommentID int `gorm:"TYPE:int(25);DEFAULT:NULL" json:"comment_id"`

	// newsID
	NewsID int `gorm:"TYPE:int(25);DEFAULT:NULL" json:"news_id"`

	// newsCommentID
	NewsCommentID int `gorm:"TYPE:int(25);DEFAULT:NULL" json:"news_comment_id"`

	// newsID
	MomentID int `gorm:"TYPE:int(25);DEFAULT:NULL" json:"moment_id"`

	// report reason
	Reason string `gorm:"TYPE:text;DEFAULT:NULL;" json:"reason"`

	// 用户个人资料外联表模型
	UsersProfiles UsersProfiles `gorm:"FOREIGNKEY:uid;AssociationForeignKey:reported_by;association_autoupdate:false;" json:"profile"`
}

type ResponseModel struct {
	Code    int         `json:"code"`
	Message string      `json:"message"`
	Data    interface{} `json:"data"`
}

type SecurityPasswordModel struct {
	BasicModel
	//
	// 对应用户的id
	// 查询时将直接根据用户ID查询
	//
	UID int `gorm:"TYPE:int(25);NOT NULL;UNIQUE" json:"uid"`
	//
	// 支付密码
	// 支付密码算法 md5(md5(password).salt)
	// 默认为null
	//
	Password string `gorm:"TYPE:varchar(255);DEFAULT:NULL;" json:"-"`
	//
	// salt
	//
	Salt string `gorm:"TYPE:varchar(25);DEFAULT:NULL;" json:"-"`
	//
	// 支付密码状态
	// 该状态仅在用户交易时进行识别验证
	//
	// 通常情况下，如果账户被冻结，但是支付密码不会被冻结，因为需要为用户提供单独的资产渠道
	// 但部分用户，可能存在违规操作，为了规避风险 要做到既冻结账号，又冻结支付密码
	//
	// 1 正常
	// 2 受限制的，即不能交易，但可以通过更新后再进行交易
	// 3 永久性冻结支付密码的 无法交易 无法提取账户资产 无法更改
	//
	Status string `gorm:"TYPE:varchar(255);DEFAULT:1;" json:"status"`
}

type Thumb struct {
	BasicRemoveableModel
	// 点赞的人UID
	// 记录点赞人的UID
	ThumbBy int `gorm:"TYPE:int(25);NOT NULL;" json:"thumbBy"`
	//
	// 数据存储时 MomentID，CommentID，NewsID 仅选择其一
	//
	// 关联的momentID
	//
	MomentID int `gorm:"TYPE:int;DEFAULT:NULL;" json:"moment_id"`
	//
	// 关联的评论ID
	//
	CommentID int `gorm:"TYPE:int;DEFAULT:NULL;" json:"comment_id"`
	//
	// 关联的资讯ID
	//
	NewsID int `gorm:"TYPE:int;DEFAULT:NULL;" json:"news_id"`
	//
	// 用户个人资料外联表模型
	UsersProfiles UsersProfiles `gorm:"FOREIGNKEY:thumb_by;AssociationForeignKey:uid;association_autoupdate:false;" json:"profile"`
}

type UserRoleGroup struct{}

type Users struct {
	BasicModel
	// 账户类型
	// 账户类型分为 1 普通账户 2企业账户 3 组织或者机关单位
	Type int `gorm:"TYPE:int(25);DEFAULT:1;" json:"type"` // 0 personal 1 company 2 org

	// 是否为子账户
	// parent id如果指定了id，那么这个账号即属于二级账户
	// 默认为 NULL
	Parent int `gorm:"TYPE:int(25);DEFAULT:NULL;" json:"parent"`

	// 组织或者企业名称
	// 个人账户为NULL
	//
	// 不作为真实性验证的依据，仅作为用户注册时填写的依据
	// 组织名称不要输出，防止前端憨逼一样的用了这个字段，嘻嘻嘻嘻
	//
	Orgname string `gorm:"TYPE:varchar(100);DEFAULT:NULL;" json:"-"`

	// 用户名
	// 用户名是登录依据
	// 用户名唯一不重复
	// 用户名不得更新
	//
	// 请不要将个人资料中的nic与username混淆
	Username string `gorm:"TYPE:varchar(20);UNIQUE;" json:"username"`

	// 邮箱
	// 电子邮箱仅注册或者第三方授权登录时更新，不作为真实性验证依据
	//
	// 境外用户注册时，邮箱作为注册条件
	// 境外用户登录时，邮箱作为登录的条件
	// 邮箱是否可以登录，与countryCode有绑定关系
	Email string `gorm:"TYPE:varchar(100);DEFAULT:NULL;" json:"email"`

	// 手机号，境外用户注册不强制填写手机号
	Mobile string `gorm:"TYPE:varchar(25);UNIQUE;" json:"mobile"`

	// 国家代码 ISO标准
	CountryCode string `gorm:"TYPE:varchar(25);DEFAULT:'CN';" json:"country_code"` //defualt china CN

	// 语言代码 ISO标准
	Language string `gorm:"TYPE:varchar(25);DEFAULT:'zh-CN';" json:"language"` //defualt china zh-CN

	//
	// 电话区号
	// 电话区号前面不加0 如中国 86
	// 电话区号不加86
	// 电话区号不得更新，不得作为用户可以选择更新的选项
	CallingCode string `gorm:"TYPE:varchar(25);DEFAULT:86;" json:"calling_code"` // default china 86

	// 登录密码 md5 登录密码算法为md5(md5(password).salt)
	Password string `gorm:"TYPE:varchar(255);NOT NULL;" json:"-"`

	// 加盐
	Salt string `gorm:"TYPE:varchar(25);NOT NULL;" json:"-"`

	//
	// 用户组
	// 0 为管理用户
	// 1为普通用户
	// 其他根据后续自定义
	Group int `gorm:"TYPE:int(25);DEFAULT:1;" json:"group"` // 2 admin 1 normal ...

	// 账户状态
	//
	// 账户如果封禁时禁止登录操作，并强制清除jwt token强制下线
	// 1为正常
	// 2禁止
	// 3账户被系统保护
	// 4短时间冻结
	Status int `gorm:"TYPE:int(25);DEFAULT:1;" json:"status"` // 1 normal 2 ban 3 protected

	//
	//账户解禁的日期
	//
	ReverseDate time.Time `gorm:"TYPE:datetime;DEFAULT:NULL;" json:"reverse_date"` // 1 normal 2 ban 3 protected

	// 用户个人资料外联表模型
	UsersProfiles UsersProfiles `gorm:"FOREIGNKEY:UID;AssociationForeignKey:id;association_autoupdate:false;" json:"profile"`
}

type UsersProfiles struct {
	BasicModel
	// 对应用户的id
	// 查询时将直接根据用户ID查询
	UID int `gorm:"TYPE:int(25);NOT NULL;UNIQUE" json:"uid"`
	//
	// 存储头像地址
	// 默认为null
	Avatar string `gorm:"TYPE:varchar(255);DEFAULT:NULL;" json:"avatar"`
	// 昵称，与用户名不同，用户昵称可以随时修改，并且可以在库中重复
	Nic string `gorm:"TYPE:varchar(25);DEFAULT:NULL;" json:"nic"`
	// 性别 目前暂定 male，famle， other，
	// 后续需要计划增加性别列表，因为性别选项应该有更多
	Gender string `gorm:"TYPE:varchar(25);DEFAULT:'male';" json:"gender"` // male female others
	// 生日
	// 出生年月日，datetime
	Birthday string `gorm:"TYPE:datetime;DEFAULT:NULL;" json:"birthday"`
	// 个性签名
	Bio string `gorm:"TYPE:varchar(255);DEFAULT:NULL;" json:"bio"`
	// 保护我的内容
	Protected int `gorm:"TYPE:int;NOT NULL;DEFAULT:0;" json:"protected"`
}