├── images ├── qqgroup.jpg ├── UUIA_logo.png ├── SystemDesign.png ├── composition.png ├── hulu_qrcode.jpg ├── weneu_qrcode.jpg └── university │ ├── dongbeidaxue.png │ ├── daliankejixueyuan.jpg │ └── hubeigongyedaxue.jpg ├── UUIA-LICENSE.md ├── quiz.md ├── README.md ├── API.md └── LICENSE /images/qqgroup.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/uuia/UUIA/HEAD/images/qqgroup.jpg -------------------------------------------------------------------------------- /images/UUIA_logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/uuia/UUIA/HEAD/images/UUIA_logo.png -------------------------------------------------------------------------------- /images/SystemDesign.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/uuia/UUIA/HEAD/images/SystemDesign.png -------------------------------------------------------------------------------- /images/composition.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/uuia/UUIA/HEAD/images/composition.png -------------------------------------------------------------------------------- /images/hulu_qrcode.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/uuia/UUIA/HEAD/images/hulu_qrcode.jpg -------------------------------------------------------------------------------- /images/weneu_qrcode.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/uuia/UUIA/HEAD/images/weneu_qrcode.jpg -------------------------------------------------------------------------------- /images/university/dongbeidaxue.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/uuia/UUIA/HEAD/images/university/dongbeidaxue.png -------------------------------------------------------------------------------- /images/university/daliankejixueyuan.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/uuia/UUIA/HEAD/images/university/daliankejixueyuan.jpg -------------------------------------------------------------------------------- /images/university/hubeigongyedaxue.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/uuia/UUIA/HEAD/images/university/hubeigongyedaxue.jpg -------------------------------------------------------------------------------- /UUIA-LICENSE.md: -------------------------------------------------------------------------------- 1 | # 前言 2 | 兹我 UUIA 联盟持开源社区之基本精神,为规范 UUIA 开源社群之运作并保障所有贡献者和使用者的合法权益,特制定本协议。 3 | # 适用对象 4 | 本协议适用于基于 UUIA 开源(含脚手架项目、前端项目等)项目衍生、再发行的所有项目、所有子节点项目 和 使用了 UUIA 提供的部分开源组件的项目。 5 | # 协议内容 6 | 1. **对于使用了 UUIA 开源项目构建的项目,其需公开注明 UUIA 的对应标识。** 7 | 8 | 使用 UUIA 的开源项目构建您的项目时 (包含使用开源的脚手架项目或前端项目),请以附带标识符的形式,在您项目成品的用户端(如微信小程序等)的启动页面(Splash Screen 或 关于页面)注明您使用了来自 UUIA 的内容。 9 | 标识符包含 : 10 | * **“Memeber of UUIA” 标识** 用于不和UUIA中心节点通信,但使用了 UUIA 开源社区内容的项目; 11 | * **“Powered by UUIA” 标识** 用于直接与UUIA中心节点通信,且使用了 UUIA 开源社区内容的项目。 12 |
14 | Memeber of UUIA
15 |
16 | Powered by UUIA
17 |
3 |
4 |
5 |
6 |
42 |
43 |
59 |
60 | ### 面向开发者——大平台
61 |
62 |
63 |
64 | ## 总结
65 | UUIA 包括
66 | - UUIA 服务框架
67 | - 一套完整的校园信息和身份鉴权 API 规范
68 | - 多语言版本 SDK
69 | - 多个主题的小程序客户端开源代码
70 | - 服务号网页端及推送能力一键部署
71 | - UUIA 开发者后台
72 | - UUIA 开发者社区
73 | - 丰富的社区插件
74 | - 实用的开发工具
75 | - UUIA+ 校际共享
76 |
77 | ## 愿景
78 | **依托开源社群之力用技术推动国内高校信息化统合化发展建设,并用创意让每位高校师生感到快乐。**
79 |
80 | # 快速上手
81 |
82 | ## 阶段一:开发准备
83 | ### 1. 小程序官网注册
84 | - 登录 [微信公众平台](https://mp.weixin.qq.com),注册一个小程序(QQ小程序的准备工作类似)
85 | - 在「开发-开发设置」里得到微信小程序的 AppID 和 AppSecret
86 |
87 | 
88 |
89 | ### 2. UUIA开放平台注册
90 | - 登录 [UUIA 开放平台](https://uuia.cheelem.com/dev) 注册开发者身份
91 | - 新建子节点并记录下您的uuiaAppId、 uuiaSecretKey明文 和 validationKey密文
92 |
93 | 
94 |
95 | ### 3. 阅读开发规范,API文档,开发准则
96 | - [UUIA SDK 使用指南](https://github.com/uuia/UUIA-Java-SDK)
97 | - [UUIA API 规范文档](https://github.com/uuia/UUIA/blob/master/API.md)
98 | - [UUIA LICENSE](https://github.com/uuia/UUIA/blob/master/UUIA-LICENSE.md)
99 |
100 | ## 阶段二:后端简单开发
101 | ### 4. 下载对应开发语言的 SDK 脚手架项目
102 | - [Java SDK](https://github.com/uuia/UUIA-Java-SDK)
103 | - [Python SDK](https://github.com/uuia/UUIA_SDK_In_Python3)
104 |
105 | ### 5. 根据提示完成本校数据获取逻辑代码
106 | - 爬虫、调用学校系统API等方式皆可
107 |
108 | ### 6. 回到开发者平台测试子节点连通性
109 | 
110 |
111 | ## 阶段三:客户端即刻部署
112 | ### 7. 下载客户端小程序代码
113 | - [Pure 简约主题](https://github.com/uuia/UUIA-Mini-APP)
114 |
115 | ### 8. 补全配置信息
116 | - 根据本校信息补全 `/uuia/config.js` 配置文件
117 |
118 | ### 9. 准备就绪
119 | - 尊享 UUIA 提供的日臻丰富的数据统计功能
120 |
121 | # 试用
122 |
123 | ## 微信小程序(东北大学版)
124 |
125 |
126 | ## 微信服务号
127 |
128 |
129 | # 如何贡献?
130 |
131 | 您可以通过以下三种方式为UUIA助力。
132 |
133 | ## 帮助UUIA服务框架变得更好
134 | 如果您对UUIA框架设计有好的想法,欢迎与我们联系或提交[PR](https://github.com/uuia/UUIA/compare),为优化 UUIA 贡献力量!
135 |
136 | ## 丰富 UUIA 开发者社区,让全国大学生都用上您开发的组件
137 | - [UUIA 开放平台](https://uuia.info) 静候您好玩实用的开源应用
138 | - [UUIA 插件开发规范](https://github.com/uuia/UUIA-Java-SDK/blob/master/PLUGIN.md)
139 |
140 | ## 好的意见与建议
141 | 如果您对 UUIA 的现状与未来发展有好的意见或建议抑或是对我们的工作有任何的疑问,欢迎提出 [Issue](https://github.com/uuia/UUIA/issues)。
142 |
143 | # 社群联络方式
144 |
145 | UUIA 开发者 QQ 交流群:
146 |
147 |
148 |
149 | # UUIA+
150 |
151 | UUIA+ 旨在探索除技术外跨校协同共享的可能性,我们将致力于整合校园优秀运营活动与模式,社科研究等数据利用方式以及相关法律法规政策等信息,为校园开发者的产品发展及个人能力提升进一步助力。
152 |
153 | - 运营推广
154 | - 数据研究
155 | - 法律法规
--------------------------------------------------------------------------------
/API.md:
--------------------------------------------------------------------------------
1 |
2 | # UUIA API 文档
3 |
4 | 本文阐述了 UUIA 子节点和中心服务器的通信规约, UUIA SDK 和脚手架项目已经为您封装好此规约,无需您实现。
5 |
6 | > 现提供 Java 版本和 Python 版本的脚手架项目。您可以 [转到UUIA开源组织查看](https://github.com/uuia)。
7 |
8 | > 您仅需补全脚手架项目代码中repository包中类所包含的 TODO 语句所在的方法,实现数据获取逻辑 和 凭据提取/存储逻辑,并按照需要返回的数据类填充所有必要属性即可。
9 |
10 | # API 文档介绍
11 | ## 独有标记
12 | - UUID: 在一个学校内唯一标识一个用户的身份标识(以后请求只通过uuid进行标识,请保存此标识)
13 |
14 | - group: API所属组标识
15 | - action: 组内API唯一标识
16 | - extraData: 额外数据是考虑到不同学校系统间的差异性推出的自定义字段,灵活使用
17 |
18 | ## 设计特点
19 | UUIA API 设计具有三个特点
20 | 1. 路径唯一: 全局有且仅有一个路径即为uuia,子节点的路由地址为 https://yoursite/uuia
21 | 2. 请求方法唯一: 皆为POST请求
22 | 3. 请求体返回体格式唯一: 皆为JSONObject
23 |
24 | 如此设计便于 UUIA 良好的延展性,便于子节点快速使用社区组件。
25 |
26 | ## 响应状态码定义
27 | |编码|信息|中文解释
28 | -|-|-
29 | |200|OK|成功
30 | |401|Unauthorized|
31 | |500|Internal Server Error|
32 | |504|Gateway Timeout|
33 |
34 | # 基础组接口 (group="base")
35 | 基础组即UUIA默认的子节点与中心节点通信的一组接口,通过实现这组接口,您可以迅速拥有适配良好的小程序客户端以及服务号的丰富能力。
36 |
37 | ## 1. 获取需要绑定的账户类型
38 | ### 1.1 说明
39 | 获得需要的密码说明及对应编号
40 |
41 | ### 1.2 请求体
42 | #### 参数说明
43 | 属性 | 类型 | 值 | 说明
44 | -|-|-|-
45 | group | String | base | 固定值
46 | action | String | bindType | 固定值
47 |
48 | ### 1.3 返回体
49 | #### 参数说明
50 | 属性 | 类型 | 必填 | 说明
51 | -|-|-|-
52 | code|int|是|返回请求状态编码
53 | message|String|是|返回请求状态信息
54 | data|JSONObject|是|返回请求的内容
55 |
56 | #### 返回data说明
57 | 属性 | 类型 | 必填 | 说明
58 | -|-|-|-
59 | accountTypes | JsonArray | 是 | 多组账户类型与编号
60 | -- accountType|JsonObject|是|一组账户类型与编号
61 | ---- comment|String|是|备注
62 | ---- code|String|是|编号,将主账号作为 "001"
63 | ---- ref|String|是|前置账号(相同账号的凭据),如没有则为 "000"
64 | ---- isSkip|boolean|是|可否跳过
65 |
66 | ### 示例
67 | #####
68 | ```json
69 | {
70 | "accountTypes": [{
71 | "comment": "教务处",
72 | "code": "001",
73 | "ref": "000",
74 | "isSkip": false
75 | },
76 | {
77 | "comment": "一卡通",
78 | "code": "002",
79 | "ref": "001",
80 | "isSkip": true
81 | }
82 | ]
83 | }
84 | ```
85 |
86 | ## 2. 验证用户身份
87 | ### 2.1 说明
88 | 验证用户身份接口
89 |
90 | ### 2.2 请求体
91 | #### 参数说明
92 | 属性 | 类型 | 值 | 说明
93 | -|-|-|-
94 | group | String | base | 固定值
95 | action | String | bind | 固定值
96 | uuid | String | | 身份标识
97 | data | JSONObject | | 账号凭据信息
98 |
99 | #### 请求data说明
100 | 属性 | 类型 | 说明
101 | -|-|-
102 | -- account|JsonObject|一组用户名与密码
103 | ---- username|String|用户名
104 | ---- password|String|密码
105 | ---- code|int|账号密码对应编号
106 |
107 | #### 示例
108 | ```json
109 | {
110 | "action": "bind",
111 | "uuid": "foo",
112 | "data": {
113 | "account": {
114 | "username": "20161234",
115 | "password": "mypassword",
116 | "code": "001"
117 | }
118 | }
119 | }
120 | ```
121 |
122 | ### 2.3 返回体
123 | #### 参数说明
124 | 属性 | 类型 | 必填 | 说明
125 | -|-|-|-
126 | code|int|是|返回请求状态编码
127 | message|String|是|返回请求状态信息
128 | data|JSONObject|是|返回请求的内容
129 |
130 | #### 返回data说明
131 | 属性 | 类型 |必填| 说明
132 | -|-|-|-
133 | uuid|String|是|身份标识
134 | isSuccess|boolean|是|是否成功
135 | errorMsg|String|否|错误信息描述(如用户名不存在,密码错误等)
136 |
137 | #### 示例
138 |
139 | 绑定成功情况
140 |
141 | ```json
142 | {
143 | "uuid": "walndlng932klfnal",
144 | "vaild": true
145 | }
146 | ```
147 |
148 | 绑定错误情况
149 |
150 | ```json
151 | {
152 | "uuid": "walndlng932klfnal",
153 | "vaild": false,
154 | "errorMsg": "密码错误"
155 | }
156 | ```
157 |
158 | ## 3. 用户信息
159 | ### 3.1 说明
160 | 获取用户身份信息
161 |
162 | ### 3.2 请求体
163 | #### 参数说明
164 | 属性 | 类型 | 值 | 说明
165 | -|-|-|-
166 | group | String | base | 固定值
167 | action | String | userInfo | 固定值
168 | uuid | String | | 身份标识
169 |
170 | ### 3.3 返回体
171 | #### 参数说明
172 | 属性 | 类型 | 必填 | 说明
173 | -|-|-|-
174 | code|int|是|返回请求状态编码
175 | message|String|是|返回请求状态信息
176 | data|JsonArray|是|返回请求的内容
177 |
178 | #### 返回data说明
179 | 属性 | 类型 | 必填 | 说明
180 | -|-|-|-
181 | uuid|String|是|身份标识
182 | name|String|是|学生姓名
183 | gender|String|否|性别
184 | college|String|否|所在学院
185 | major|String|否|学生专业
186 | grade|String|否|年级
187 | studentClass|String|否|班级
188 | studentID|String|否|学号
189 | studentType|String|否|学生类型
190 |
191 | #### 示例
192 |
193 | ```json
194 | {
195 | "uuid": "fdfg32fgfe12ff#!v",
196 | "name": "张三",
197 | "gender": 0,
198 | "college": "软件学院",
199 | "major": "软件工程",
200 | "grade": "2016",
201 | "studentClass": "软英1601",
202 | "studentId": "20165241",
203 | "studentType": "本科生"
204 | }
205 | ```
206 |
207 | ## 4.课程表
208 | ### 4.1 说明
209 | 获取用户课程表
210 |
211 | ### 4.2 请求参数
212 | #### 参数说明
213 | 属性 | 类型 | 值 | 说明
214 | -|-|-|-
215 | group | String | base | 固定值
216 | action | String | courseTable | 固定值
217 | uuid | String | | 身份标识
218 | data | JSONObject | | 学期信息(可选,默认本学期)
219 |
220 | #### 请求data说明
221 | 属性 | 类型 | 说明
222 | -|-|-
223 | semester | String | 学期编号
224 |
225 | ### 4.3 返回参数
226 | #### 参数说明
227 | 属性 | 类型 | 必填 | 说明
228 | -|-|-|-
229 | code|int|是|返回请求状态编码
230 | message|String|是|返回请求状态信息
231 | data|JsonArray|是|返回请求的内容
232 |
233 | #### 返回data说明
234 | 属性 | 类型 | 必填 | 说明
235 | -|-|-|-
236 | uuid|String|是|身份标识
237 | courses|JsonArray|是|学期课表
238 | -- course|JsonObject|是|课
239 | ---- name|String|是|课程名称
240 | ---- code|String|是|课程编号
241 | ---- teachers|String[]|是|课程授课老师
242 | ---- schedules|JsonArray|是|课程安排
243 | ------ schedule|JsonObject|是|课程安排
244 | -------- weeks|int[]|是|课程上课周数
245 | -------- day|int|是|课程上课天(星期日至星期六 0-6)
246 | -------- sections|int[]|是|课程上课节
247 | -------- classroom|String|否|课程上课地点
248 |
249 | #### 示例
250 |
251 | ```json
252 | {
253 | "uuid": "fdfg32fgfe12ff#!v",
254 | "courses": [{
255 | "name": "高等数学1",
256 | "code": "A001341490081",
257 | "teachers": ["张三", "李四"],
258 | "schedules": [{
259 | "weeks": [1, 2, 3, 4, 6, 7, 8],
260 | "day": 2,
261 | "section": [1, 2],
262 | "classroom": "信息A101"
263 | }, {
264 | "weeks": [1, 2, 3, 4, 5, 6, 7, 8],
265 | "day": 4,
266 | "section": [3, 4],
267 | "classroom": "一号A101"
268 | }, {
269 | "weeks": [9],
270 | "day": 5,
271 | "section": [7, 8],
272 | "classroom": "一号B203"
273 | }]
274 | }]
275 | }
276 | ```
277 |
278 | ## 5. 成绩
279 | ### 5.1 说明
280 | 获取用户成绩信息
281 |
282 | ### 5.2 请求体
283 | #### 参数说明
284 | 属性 | 类型 | 值 | 说明
285 | -|-|-|-
286 | group | String | base | 固定值
287 | action | String | score | 固定值
288 | uuid | String | | 身份标识
289 | data | JSONObject | | 学期信息(可选,默认本学期)
290 |
291 | #### 请求data说明
292 | 属性 | 类型 | 说明
293 | -|-|-
294 | semester | String | 学期编号
295 |
296 | ### 5.3 返回体
297 | #### 参数说明
298 | 属性 | 类型 | 必填 | 说明
299 | -|-|-|-
300 | code|int|是|返回请求状态编码
301 | message|String|是|返回请求状态信息
302 | data|JsonArray|是|返回请求的内容
303 |
304 | #### 返回data说明
305 | 属性 | 类型 | 必填 | 说明
306 | -|-|-|-
307 | uuid|String|是|身份标识
308 | gpa|String|是|绩点
309 | courses|JsonArray|是|成绩课程组
310 | -- course|JsonObject|是|一科课程成绩
311 | ---- name|String|是|课程名称
312 | ---- courseCode|String|是|课程编号
313 | ---- credit|String|是|课程学分
314 | ---- grade|float|是|课程成绩
315 | ---- extraData|JsonArray|是|课程其他信息
316 |
317 | #### 示例
318 |
319 | ```json
320 | {
321 | "uuid": "fdfg32fgfe12ff#!v",
322 | "gpa": "3.75",
323 | "courses": [{
324 | "name": "高等数学1",
325 | "courseCode": "A001231451542010",
326 | "credit": 2.0,
327 | "grade": 99,
328 | "extraData": [{
329 | "key": "期中成绩",
330 | "value": "96"
331 | }, {
332 | "key": "平时成绩",
333 | "value": "93"
334 | }]
335 | }]
336 | }
337 | ```
338 |
339 | ## 6. 考试日程
340 | ### 6.1 说明
341 | 获取用户考试安排
342 |
343 | ### 6.2 请求体
344 | #### 参数说明
345 | 属性 | 类型 | 值 | 说明
346 | -|-|-|-
347 | group | String | base | 固定值
348 | action | String | exam | 固定值
349 | uuid | String | | 身份标识
350 | data | JSONObject | | 学期信息(可选,默认本学期)
351 |
352 | #### 请求data说明
353 | 属性 | 类型 | 说明
354 | -|-|-
355 | semester | String | 学期编号
356 |
357 | ### 6.3 返回体
358 | #### 参数说明
359 | 属性 | 类型 | 必填 | 说明
360 | -|-|-|-
361 | code|int|是|返回请求状态编码
362 | message|String|是|返回请求状态信息
363 | data|JSONObject|是|返回请求的内容
364 |
365 | #### 返回data说明
366 | 属性 | 类型 | 必填 | 说明
367 | -|-|-|-
368 | uuid|String|是|身份标识
369 | courses|JsonArray|是|考试课程组
370 | -- name|String|是|课程名称
371 | -- courseCode|String|否|课程代码
372 | -- time|String|是|考试时间
373 | -- place|String|否|考试教学楼及教室
374 | -- extraData|JsonArray|是|课程其他信息
375 |
376 | #### 示例
377 |
378 | ```json
379 | {
380 | "uuid": "fdfg32fgfe12ff#!v",
381 | "courses": [{
382 | "name": "高等数学",
383 | "courseCode": "课程代码(可选)",
384 | "time": "13:00",
385 | "place": "一号A101",
386 | "extraData": [{
387 | "key": "座位号",
388 | "value": "68"
389 | }, {
390 | "key": "考试类型",
391 | "value": "考查"
392 | }]
393 | }]
394 | }
395 | ```
396 |
397 | ## 7. 校园卡
398 | ### 7.1 说明
399 | 获取用户一卡通信息
400 |
401 | ### 7.2 请求体
402 | #### 参数说明
403 | 属性 | 类型 | 值 | 说明
404 | -|-|-|-
405 | group | String | base | 固定值
406 | action | String | campusCard | 固定值
407 | uuid | String | | 身份标识
408 |
409 | ### 7.3 返回体
410 | #### 参数说明
411 | 属性 | 类型 | 必填 | 说明
412 | -|-|-|-
413 | code|int|是|返回请求状态编码
414 | message|String|是|返回请求状态信息
415 | data|JsonObject|是|返回请求的内容
416 |
417 | #### 返回data说明
418 | 属性 | 类型 | 必填 | 说明
419 | -|-|-|-
420 | uuid|String|是|身份标识
421 | studentId|String|否|学号
422 | name|String|是|学生姓名
423 | balance|String|是|一卡通余额
424 | extraData|JsonArray|是|一卡通其他信息
425 |
426 |
427 | #### 示例
428 | ```json
429 | {
430 | "studentId": "20161234",
431 | "name": "小明",
432 | "balance": 102.98,
433 | "extraData": [{
434 | "key": "补助金额",
435 | "value": "20"
436 | }, {
437 | "key": "校卡状态",
438 | "value": "已激活"
439 | }]
440 | }
441 | ```
442 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 2, June 1991
3 |
4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6 | Everyone is permitted to copy and distribute verbatim copies
7 | of this license document, but changing it is not allowed.
8 |
9 | Preamble
10 |
11 | The licenses for most software are designed to take away your
12 | freedom to share and change it. By contrast, the GNU General Public
13 | License is intended to guarantee your freedom to share and change free
14 | software--to make sure the software is free for all its users. This
15 | General Public License applies to most of the Free Software
16 | Foundation's software and to any other program whose authors commit to
17 | using it. (Some other Free Software Foundation software is covered by
18 | the GNU Lesser General Public License instead.) You can apply it to
19 | your programs, too.
20 |
21 | When we speak of free software, we are referring to freedom, not
22 | price. Our General Public Licenses are designed to make sure that you
23 | have the freedom to distribute copies of free software (and charge for
24 | this service if you wish), that you receive source code or can get it
25 | if you want it, that you can change the software or use pieces of it
26 | in new free programs; and that you know you can do these things.
27 |
28 | To protect your rights, we need to make restrictions that forbid
29 | anyone to deny you these rights or to ask you to surrender the rights.
30 | These restrictions translate to certain responsibilities for you if you
31 | distribute copies of the software, or if you modify it.
32 |
33 | For example, if you distribute copies of such a program, whether
34 | gratis or for a fee, you must give the recipients all the rights that
35 | you have. You must make sure that they, too, receive or can get the
36 | source code. And you must show them these terms so they know their
37 | rights.
38 |
39 | We protect your rights with two steps: (1) copyright the software, and
40 | (2) offer you this license which gives you legal permission to copy,
41 | distribute and/or modify the software.
42 |
43 | Also, for each author's protection and ours, we want to make certain
44 | that everyone understands that there is no warranty for this free
45 | software. If the software is modified by someone else and passed on, we
46 | want its recipients to know that what they have is not the original, so
47 | that any problems introduced by others will not reflect on the original
48 | authors' reputations.
49 |
50 | Finally, any free program is threatened constantly by software
51 | patents. We wish to avoid the danger that redistributors of a free
52 | program will individually obtain patent licenses, in effect making the
53 | program proprietary. To prevent this, we have made it clear that any
54 | patent must be licensed for everyone's free use or not licensed at all.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | GNU GENERAL PUBLIC LICENSE
60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61 |
62 | 0. This License applies to any program or other work which contains
63 | a notice placed by the copyright holder saying it may be distributed
64 | under the terms of this General Public License. The "Program", below,
65 | refers to any such program or work, and a "work based on the Program"
66 | means either the Program or any derivative work under copyright law:
67 | that is to say, a work containing the Program or a portion of it,
68 | either verbatim or with modifications and/or translated into another
69 | language. (Hereinafter, translation is included without limitation in
70 | the term "modification".) Each licensee is addressed as "you".
71 |
72 | Activities other than copying, distribution and modification are not
73 | covered by this License; they are outside its scope. The act of
74 | running the Program is not restricted, and the output from the Program
75 | is covered only if its contents constitute a work based on the
76 | Program (independent of having been made by running the Program).
77 | Whether that is true depends on what the Program does.
78 |
79 | 1. You may copy and distribute verbatim copies of the Program's
80 | source code as you receive it, in any medium, provided that you
81 | conspicuously and appropriately publish on each copy an appropriate
82 | copyright notice and disclaimer of warranty; keep intact all the
83 | notices that refer to this License and to the absence of any warranty;
84 | and give any other recipients of the Program a copy of this License
85 | along with the Program.
86 |
87 | You may charge a fee for the physical act of transferring a copy, and
88 | you may at your option offer warranty protection in exchange for a fee.
89 |
90 | 2. You may modify your copy or copies of the Program or any portion
91 | of it, thus forming a work based on the Program, and copy and
92 | distribute such modifications or work under the terms of Section 1
93 | above, provided that you also meet all of these conditions:
94 |
95 | a) You must cause the modified files to carry prominent notices
96 | stating that you changed the files and the date of any change.
97 |
98 | b) You must cause any work that you distribute or publish, that in
99 | whole or in part contains or is derived from the Program or any
100 | part thereof, to be licensed as a whole at no charge to all third
101 | parties under the terms of this License.
102 |
103 | c) If the modified program normally reads commands interactively
104 | when run, you must cause it, when started running for such
105 | interactive use in the most ordinary way, to print or display an
106 | announcement including an appropriate copyright notice and a
107 | notice that there is no warranty (or else, saying that you provide
108 | a warranty) and that users may redistribute the program under
109 | these conditions, and telling the user how to view a copy of this
110 | License. (Exception: if the Program itself is interactive but
111 | does not normally print such an announcement, your work based on
112 | the Program is not required to print an announcement.)
113 |
114 | These requirements apply to the modified work as a whole. If
115 | identifiable sections of that work are not derived from the Program,
116 | and can be reasonably considered independent and separate works in
117 | themselves, then this License, and its terms, do not apply to those
118 | sections when you distribute them as separate works. But when you
119 | distribute the same sections as part of a whole which is a work based
120 | on the Program, the distribution of the whole must be on the terms of
121 | this License, whose permissions for other licensees extend to the
122 | entire whole, and thus to each and every part regardless of who wrote it.
123 |
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 |
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 |
134 | 3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 |
138 | a) Accompany it with the complete corresponding machine-readable
139 | source code, which must be distributed under the terms of Sections
140 | 1 and 2 above on a medium customarily used for software interchange; or,
141 |
142 | b) Accompany it with a written offer, valid for at least three
143 | years, to give any third party, for a charge no more than your
144 | cost of physically performing source distribution, a complete
145 | machine-readable copy of the corresponding source code, to be
146 | distributed under the terms of Sections 1 and 2 above on a medium
147 | customarily used for software interchange; or,
148 |
149 | c) Accompany it with the information you received as to the offer
150 | to distribute corresponding source code. (This alternative is
151 | allowed only for noncommercial distribution and only if you
152 | received the program in object code or executable form with such
153 | an offer, in accord with Subsection b above.)
154 |
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it. For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable. However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 |
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 |
172 | 4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License. Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 |
180 | 5. You are not required to accept this License, since you have not
181 | signed it. However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works. These actions are
183 | prohibited by law if you do not accept this License. Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 |
189 | 6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions. You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 |
197 | 7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License. If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all. For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 |
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 |
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices. Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 |
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 |
229 | 8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded. In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 |
237 | 9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time. Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 |
242 | Each version is given a distinguishing version number. If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation. If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 |
250 | 10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission. For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this. Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 |
258 | NO WARRANTY
259 |
260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 |
270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 |
280 | END OF TERMS AND CONDITIONS
281 |
282 | How to Apply These Terms to Your New Programs
283 |
284 | If you develop a new program, and you want it to be of the greatest
285 | possible use to the public, the best way to achieve this is to make it
286 | free software which everyone can redistribute and change under these terms.
287 |
288 | To do so, attach the following notices to the program. It is safest
289 | to attach them to the start of each source file to most effectively
290 | convey the exclusion of warranty; and each file should have at least
291 | the "copyright" line and a pointer to where the full notice is found.
292 |
293 |