pjdesc.txt

何使用session，这是官方网站
https://www.npmjs.com/package/express-session

这里我采用的session存储方式就是mysql，session的配置在app.js中，需要按照需要修改。采用插件express-mysql-session。

说明：url是累加的注意！@xxx表示请求方式。
说明：return 页面请使用ejs渲染。
说明：return消息请使用json传递一个{}object。
注意：
	不管哪个路由，没有登陆都直接转到一个错误页面
	所有页面都要登陆才能访问，除了登陆和注册
总共x 个页面
/register目录下
/@get
	Param 无
return页面register.ejs
		注意需要用户未登录才能访问
	Ejs 无
/reg@post 注：为了防止看不懂，这里的url就是/register/reg
	Param 用户名：username
		   密码：password
		   邮箱：alipay_address
		   类型: 三种：o, p, b,叫 usertype

	Return 状态：status： 1：成功/0：失败
			错误信息：msg
	注意：密码请加密存储。
			用户名注意查重。

/login目录下
/@get
	Param 无
	return 页面 login.ejs
	Ejs 无

/login@post
	param 用户名：username
			密码：password
	Return 状态：status： 1：成功/0：失败
			错误信息：msg

/homepage目录下
/@get?userID = 123
	Param userID
	Return 页面 homepage.ejs
		注意这个是用户的个人主页，任何登陆的人都可以访问。
	Ejs 个人信息：pdata={
					个人主页:phomepage
					推特:twitter
					简介:abstract
				}
		投稿作品：contribute_painting[{
			url: //图片地址
			paintingID: // 图片ID
		},...] //这里虽然传几个都可以，但是只传三个就好。
		用户名称：username
		关注的人：following[{
			header: // 头像地址
			userID: //用户ID
			username
		},...] // 只传三个
		关注的人数：following_num


		收藏的画：collect_painting[{
			url: //图片地址
			paintingID: // 图片ID
		},...]// 只传三个
		Tag：tag [], 字符串
		用户头像：user_header：url
		用户ID：userID
		用户类型: type

		下面三个暂且不要
		// 粉丝？不存在的
		// 朋友：friend{
			header: //头像地址
			name: //好友名字
			id: //好友id
		}
		// 朋友人数：friendNum

/config@get
	Param 无
	Return 页面 config.ejs
		这是用户个人设置页面，按照session来显示
	Ejs config
		用户名称：username
		用户头像：user_header：url
		支付宝账号：alipay：
		个人信息：user_info={项目名称：值}
		用户ID：userID
		冻结的钱: frozen_money
		可用的钱: current_money
		推特: twitter
		个人主页: phomepage
		个人简介: abstract

	not checked! 两个钱 和个人信息

/configUpload@post
	Param newname(新的用户名), newAlipay, 以后还要加用户的详细信息
	Return 状态：status： 1：成功/0：失败
			错误信息：msg
		用于为登陆用户添加关注，将userID添加给登陆用户

/passwordUpload@post
	Param oldPassword 旧密码，newPassword 新密码
	Return 状态：status： 1：成功/0：失败
			错误信息：msg
		用于为登陆用户添加密码

/following@get？userID
	Param userID
	Return 页面 following.ejs

		用于显示用户的关注用户
		在这里实现删除功能

	Ejs 用户名称：username
		用户头像：user_header：url
		用户ID：userID // 注意这里的userID就是get的参数那个ID
		关注的人：following 头像+名称+id，需要详细讨论。
		following=[{
			header: url 头像图片地址
			username: 用户名称
			userID: 用户ID
		},...]
		关注的人数：following_num
		是否是session对应的用户(即session中的userID和该页面的userID是否相同): isSelf: boolean
		true: 是自己
		false： 不是自己


/addfollowing@get?userID 注：这边的userID是被关注的人的ID
	Param userID
	Return 状态：status： 1：成功/0：失败
			错误信息：msg
		用于为登陆用户添加关注，将userID添加给登陆用户

---checked 5.21

/delfollowing@get?userID
	Param userID
	Return 状态：status： 1：成功/0：失败
			错误信息：msg
		用于为登陆用户删除关注，将userID删除给登陆用户

/collect@get？userID
	Param userID
	Return 页面 collect.ejs
		用于显示用户收藏的画

	在这里实现删除功能
	Ejs 用户名称：username
		用户头像：user_header：url
		用户ID：userID
		收藏图片：collect 头像+名称+id，需要详细讨论。
		collect=[{
			url: url 图片地址
			name: 图片名称
			paintingID: 图片ID
		},...]
		收藏图片数量：collect_num
		是否是session对应的用户(即session中的userID和该页面的userID是否相同): isSelf: boolean
		true: 是自己
		false： 不是自己

/addcollect@get?paintingID
	Param paintingID
	Return 状态：status： 1：成功/0：失败
			错误信息：msg
		用于为登陆用户增加收藏的画，将paintingID添加给用户

/delcollect@get?paintingID
	Param paintingID
	Return 状态：status： 1：成功/0：失败
			错误信息：msg
		用于为登陆用户删除收藏的画，将paintingID删除给登陆用户

/contribute@get？userID
	Param userID
	Return 页面 contribute.ejs
	显示用户提交的画
	在这里实现删除功能
	Ejs 用户名称：username
		用户头像：user_header：url
		用户ID：userID
		提交的画:contribute
		contribute=[{
			url: url 图片地址
			name: 图片名称
			paintingID: 图片ID
		},...]
		提交的画数：contribute_num
		是否是session对应的用户(即session中的userID和该页面的userID是否相同): isSelf: boolean
		true: 是自己
		false： 不是自己

/addcontribute@get?paintingID
	Param no
	Return addcontribute.ejs
	显示上传页面
	ejs 用户名称：username
		用户头像：user_header：url
		用户ID：userID


/delcontribute@get?paintingID
	Param paintingID
	Return 状态：status： 1：成功/0：失败
			错误信息：msg
		用于为登陆用户删除投稿的画，注意权限判断


/charge@post?
	Param money
	Return 1:成功 0:失败
	not checked! 等待数据库实现

/quit@get
	退出当前用户登陆状态，销毁session


用户设置的修改，分开还是统一修改？（按照数据库的写法来）统一或者分开都需要实现post接口，请你补全 ： 见config 和 configupload
用户设置上传，访问

/illust页面下
/@get？paintingID
	Param paintingID
	Return 页面 illust.ejs
		用户画的展示页面
		注意：每次访问时画的浏览量+1
	Ejs 用户名称：username
		用户头像：user_header：url
		用户ID：userID
		画链接：url
		画名称：painting_name
		画tag：tag#可能需要加一个能不能删除的flag
		时间：time
		分辨率：resolution
		赞数：ratedCount
		浏览数：viewCount
		画ID: paintingID

/delTag@post
	Param paintingID, tag
	Return 状态：status： 1：成功/0：失败
			错误信息：msg
		用于删除tag

/addTag@post
	param paintingID, tag
	Return 状态：status： 1：成功/0：失败
			错误信息：msg
		用于添加tag
	多个字会一样一个？不知为何。。

/upvote@post
	param paintingID
	Return 状态：status： 1：成功/0：失败
			错误信息：msg
			用于为一幅画点赞，已经建立相应的数据库
			需要检查是否能重复投票

/trade页面下
/@get
	Param 无 # 利用这里的参数可以用来做排序和搜索

	Return页面 trade.ejs
		招标系统的主页面

	Ejs
		用户名称：username
		用户头像：user_header：url
		用户ID：userID
		是否可以招标：buyerflag
		招标项目： trade
		{
			buyer:发起人,
			buyername: 发起人名字,
			price:价格,
			ddl:deadline,
			state:状态,
			tradeID: ID
		}
		**以上这些简称brief trade**


/initTrade@get
	Param
	显示发起交易页面
	Return页面 initTrade.ejs
		用于发起招标

	Ejs 用户名称：username
		用户头像：user_header：url
		用户ID：userID

/initTrade@post
	Param
			发起人 : buyer //不提供，由sessionID确定
			发起时间 : start_time //不提供，系统生成
			简介：abstract
			价格：price
			Tag：tag
			Ddl：deadline
			状态：state //不提供，系统生成


	Return页面 {status : 1成功0失败}

/getTrade@get？tradeID
	Param tradeID
	Return 页面 getTrade.ejs
		trade : {
			id:
			description:
			price:
			create_time:
			finish_time:
			deadline:
			status:
			buyer:
			responder: 选中人
		}
		applier : 所有候选人{
			username:
			userID:
			user_header
		}
		还需要
		respondername，responder的名字
		buyername, buyer的名字
		(对于1和2)
		需要返回sessionID对应的人是画师还是买家，围观群众是否允许进入此界面？
		围观群众只能看不能选择接单吧
		type: 0:围观群众 1:画师 2:买家
		(对于3)
		需要返回该trade是否被画师接单
		isApplied - if true 显示取消
		isResponded -if true 显示取消和投稿
		isBuyer - if true 显示已投稿的作品
		url - 作品url,没有的话是undefined
		要显示画还需要什么？

		1.用于显示一个招标的详细信息和用于接受（画师）
		2.这个页面对于买家同时用于接受候选人
		3.画师也可以在这个页面取消接单


/getTrade/uploadwork@get
	Param:tradeID
	上传交易的画，只需要上传文件，不需要简介，tag等
	Return 页面 uploadwork.ejs
	ejs 用户名称：username
		用户头像：user_header：url
		用户ID：userID
		交易ID: tradeID

	not checked : get trade url

/getTrade/selectpainter@get
	Param: painterID, tradeID
	Return 是否成功，同之前

/getTrade/applyfortrade@get
	Param: tradeID
	Return 是否成功，同之前

/tradehomepage@get
	Param: userID,即这个主页是关于谁的
	Return
		tradeHomepage.ejs
		返回：
			交易:trade （brief trade 形式 + relation）
			用户与交易的关系 relation（三种字符创：buyer,responder,applier）如果是responder就返回responder，不是再返回applier

			如果是画家，则返回他已接单的trade，trade以brief trade的形式给出
			如果是买家，则返回他所发出的trade，同上


这个页面可能还要同时做取消？
	Ejs 简介：abstract
			价格：price
			Tag：tag
			Ddl：deadline
		ID：tradeID
		创建时间：time
		状态：status
		招标候选人：需要详细讨论

/cancelTrade@get
	Param tradeID
	返回成功或失败
/completeTrade
	Param tradeID
	返回成功或失败

/search页面下
/user@get
	Param 无
	Return 页面 searchUser.ejs
		用于搜索用户，暂且只支持通过名字搜索
	Ejs 用户名称：username
		用户头像：user_header：url
		用户ID：userID

/user@post
	param username
	return 状态：status： 1：成功/0：失败
			错误信息：msg
			数据：data:[{
				header: url 头像图片地址
				username: 用户名称
				userID: 用户ID
			},...]

/painting@get
	param 无
	return 页面 searchpainting.ejs
	ejs 无

/painting@post
	Param tag
			byID
			byTopic
			byTag
			byUpvote //大于等于关系
			byPageView //大于等于关系
			以上四个如果有那么值就是用户输入，没有就是undefined
			OrderByID
			OrderByUpvote
			OrderByPageView
	Return 状态：status： 1：成功/0：失败
			错误信息：msg
			数据 painting[{
				url: //图片地址
				paintingID: // 图片ID
				name: //图片名称
				upvote: //
				pageView: //
			}

/trade@get
	param 无
	return 页面 searchtrade.ejs
	ejs 无

/trade@post
	Param
			byTag
			byDesc
	Return 状态：status： 1：成功/0：失败
			错误信息：msg
			数据
			trade
			{
			buyer:发起人,
			buyername: 发起人名字,
			price:价格,
			ddl:deadline,
			state:状态,
			tradeID: ID
			}

	not checked!
画搜索类似，其实可以两个合并？加的flag就可以，当然分开也行

/upload页面下
/header/@post
	Param 头像图片
	更换登录用户头像
	Return 状态：status： 1：成功/0：失败
			错误信息：msg

/painting/@post
	Param 用户作品
			tital 主题
	需要对权限有所判断
	Return 状态：status： 1：成功/0：失败
			错误信息：msg

/tradework/@post
	Param tradeID 用户作品
	需要对权限有所判断
	Return 状态：status： 1：成功/0：失败
			错误信息：msg

头像默认图片 /public/img/default_header.png
头像上传路径： /public/img/header
画上传路径: /public/img/painting

//TODO
可能trade要把简介分成简介和详细信息
search trade 啊啊啊啊啊