Documentation ¶
Overview ¶
パッケージ mizumanju は web server が行う処理。
Index ¶
- Constants
- Variables
- func CreateRecovery(r *http.Request, email string) (err error)
- func CreateTemplate() *template.Template
- func DelUser(r *http.Request, userId int32) (err error)
- func GetImage(r *http.Request, userId int32) ([]byte, error)
- func SaveImage(r *http.Request, userId int32, image string) error
- func SendInvitation(r *http.Request, toName string, toAddress string, recoveryKey string) error
- func SendRecovery(r *http.Request, toName string, toAddress string, recoveryKey string) error
- func SetDB(r *http.Request, db *sql.DB)
- func SetMailTmpl(r *http.Request, tmpl *template.Template)
- func SetSmtpConf(r *http.Request, smtpConf *SmtpConf)
- func SetSystemConf(r *http.Request, cnf *SystemConf)
- func Start(host string, port int32, dsn string, smtpHost string, smtpPort int, ...)
- func UpdatePasswordByAuthId(r *http.Request, authId string, curPasswd string, newPasswd string) (err error)
- func UpdatePasswordByRecoveryKey(r *http.Request, key string, passwd string) (err error)
- func UpdateUserStatus(r *http.Request, userId int32, status string) error
- func UpsertDisplaySetting(r *http.Request, tx *sql.Tx, userId int32, targetUserId int32, orderNo int32, ...) (err error)
- func UpsertDisplaySettings(r *http.Request, userId int32, users []User) (err error)
- type InvitationData
- type License
- type RecoveryData
- type Response
- type SmtpConf
- type SystemConf
- type User
- func Authenticate(r *http.Request, inId, inPasswd string) (User, error)
- func FindAllUsers(r *http.Request) (users []User, err error)
- func FindDisplaySettings(r *http.Request, userId int32) (users []User, err error)
- func FindUserById(r *http.Request, id int32) (u User, err error)
- func InsertUser(r *http.Request, user User) (u User, err error)
- func UpdateUser(r *http.Request, user User) (User, error)
- type UserStatus
Constants ¶
const (
// ユーザに表示する全体的なメッセージであることを表すキー
GlobalMsg = "global"
)
Variables ¶
var ( // ErrNotFound はデータがないことを表すエラー ErrNotFound error = errors.New("Data not found") ErrUnauthorized error = errors.New("Unauthorized") )
var ( // ErrBadRequest は HTTP Status Code 401 に相応しいエラー ErrBadRequest error = errors.New("Bad Request.") // ライセンス情報 Licenses = []License{ License{ Title: "User shape", Source: "http://www.flaticon.com/free-icon/user-shape_25634", Author: "Dave Gandy", AuthorURL: "http://www.flaticon.com/authors/dave-gandy", License: "CC BY 3.0", LicenseURL: "http://creativecommons.org/licenses/by/3.0/", }, } )
var ErrValidation error = errors.New("Bad Request")
ErrValidation は入力チェックエラーであることを表す
Functions ¶
func CreateRecovery ¶
CreateRecovery はパスワードリカバリキーを生成し、メールでユーザに通知する関数
func CreateTemplate ¶
CreateTemplate は Template インスタンスを作成する関数。
func SendInvitation ¶
SendInvitation は招待メールを送信する関数
func SendRecovery ¶
SendRecovery は招待メールを送信する関数
func SetMailTmpl ¶
SetMailTmpl は Template インスタンスを context に保存する関数。
func SetSmtpConf ¶
SetSmtpConf は SmtpConf インスタンスを context に保存する関数。
func SetSystemConf ¶
func SetSystemConf(r *http.Request, cnf *SystemConf)
SetSystemName はシステム名を context に保存する関数。
func Start ¶
func Start(host string, port int32, dsn string, smtpHost string, smtpPort int, startTls bool, smtpUserName string, smtpPassword string, systemName string, systemUrl string, systemMailAddress string)
starg はデータベースへの接続、テンプレート準備、ルーティングの定義、サーバ起動を行う。
func UpdatePasswordByAuthId ¶
func UpdatePasswordByAuthId(r *http.Request, authId string, curPasswd string, newPasswd string) (err error)
UpdatePasswordByAuthId はパスワードを変更する関数
func UpdatePasswordByRecoveryKey ¶
UpdatePasswordByRecoveryKey はパスワードを変更する関数
func UpdateUserStatus ¶
UpdateUserStatus はユーザステータスを更新する関数
Types ¶
type InvitationData ¶
type InvitationData struct {
SystemName, SystemURL, FromName, ToName, RecoveryURL string
}
type License ¶
type License struct { Title string `json:"title"` Source string `json:"source"` Author string `json:"author"` AuthorURL string `json:"authorURL"` License string `json:"license"` LicenseURL string `json:"licenseURL"` }
License はライセンス情報を表す構造体
type RecoveryData ¶
type RecoveryData struct {
SystemName, SystemURL, RecoveryURL string
}
type Response ¶
Response はレスポンス用の構造体
func NewResponse ¶
func NewResponse(msgs interface{}, data interface{}) *Response
NewResponse は Response 構造体を生成する関数
type User ¶
type User struct { Id int32 `json:"id"` Name string `json:"name"` VoiceChatID string `json:"voiceChatId"` Hide bool `json:"hide"` Image string `json:"image"` Role string `json:"role"` AuthId string `json:"authId"` DeleteFlag bool `json:"deleteFlag"` Email string `json:"email"` OrderNo int32 `json:"orderNo"` Created time.Time `json:"created"` }
func Authenticate ¶
Authenticate はデータベースに問い合わせ認証を行う関数。 認証成功時、該当ユーザの情報を返す。
func FindAllUsers ¶
FindAllUsers は全ユーザをデータベースから取得する関数
func FindDisplaySettings ¶
FindDisplaySettings は userId のユーザ表示設定を取得する関数。
func FindUserById ¶
FindUserById は id でユーザ情報を取得する関数
func InsertUser ¶
InsertUser はユーザ情報をデータベースに挿入し、メールで通知する関数
type UserStatus ¶
type UserStatus struct { UserId int32 `json:"userId"` Status string `json:"status"` Updated time.Time `json:"updated"` }
func FindUserStatusByUserId ¶
func FindUserStatusByUserId(r *http.Request, userId int32) (u UserStatus, err error)
FindUserStatusByUserId は userId でユーザステータスを取得する関数