├── webhooks.py ├── accounts.json ├── index.py ├── .gitignore ├── README.md ├── xyb.py └── LICENSE /webhooks.py: -------------------------------------------------------------------------------- 1 | def on_sign_in(data): 2 | print("At sign in hook") 3 | print(data) 4 | 5 | 6 | def on_sign_out(data): 7 | print("At sign out hook") 8 | print(data) 9 | -------------------------------------------------------------------------------- /accounts.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "openid": "", 4 | "unionid": "", 5 | "username": "", 6 | "password": "", 7 | "location": { 8 | "province": "", 9 | "country": "", 10 | "city": "", 11 | "adcode": 0, 12 | "address": "", 13 | "lat": 0, 14 | "lng": 0 15 | } 16 | } 17 | ] -------------------------------------------------------------------------------- /index.py: -------------------------------------------------------------------------------- 1 | # Tencent cloud SCF function 2 | 3 | from xyb import XybSign 4 | 5 | 6 | def main_handler(event, context): 7 | sign_type = ("SignOut", "SignIn") 8 | if "TriggerName" in event and event["TriggerName"] in sign_type: 9 | tools = XybSign() 10 | tools.sign_in_all(True) if sign_type.index(event["TriggerName"]) else tools.sign_out_all(True) 11 | else: 12 | raise RuntimeError("触发器配置不正确，请参考配置说明") 13 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | 131 | .idea 132 | template.yaml 133 | dclib 134 | ignore 135 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # xybAutoSign 2 | 校友邦自动签到，支持批量签到签出与云函数部署 3 | 4 | **由于个人原因，该项目已经停止维护** 5 | 6 | ~~**如果在日志中看到`健康信息还未上传，请先上传`字样，请使用正规流程上传健康信息并签到，无法直接使用本工具进行新增签到**~~ 7 | 8 | ### 特性 9 | 10 | - 原生支持批量签到与签退 11 | - 同时支持账号密码和小程序登录方式 12 | - 友好的任务异常处理与日志信息输出 13 | - 支持API组件化使用 14 | - 支持Webhooks事件回调 15 | - 支持腾讯云函数(SCF)部署 16 | 17 | ----- 18 | 19 | ### 基本使用 20 | 21 | #### 需求与依赖 22 | 23 | - Python3.6及以上版本 24 | - 安装`requests`库 25 | 26 | 你可以参考以下任意一条pip命令完成安装 27 | 28 | ``` 29 | 1. pip install requests 30 | 2. python -m pip install requests 31 | ``` 32 | 33 | > 如果你运行在Linux环境，请视情况将`pip`和`python`替换为`pip3`和`python3` 34 | 35 | #### 配置用户信息 36 | 37 | 在编辑配置文件之前，你需要先确认你的校友邦账号的登录方式，目前支持小程序OpenID登录方式和账号密码登录方式，并确认签到地址的相关信息，并按照以下指引填写相关字段 38 | 39 | **若同时填写了两种方式，将优先采用账号密码登录** 40 | 41 | ##### 账号密码登录 42 | 43 | 账号密码登录方式，你需要配置用户名和密码 44 | 45 | - 用户名`username` 46 | - 密码`password` 47 | 48 | ##### 小程序OpenID登录 49 | 50 | 你需要提供你绑定微信帐号的信息 51 | 52 | - 小程序OpenID：`openid` 53 | - 小程序UnionID：`unionid` 54 | 55 | > 关于`openid`与`unionid`的获取，可参考[CncCbz/xybSign](https://github.com/CncCbz/xybSign/blob/main/README.md) 56 | > 57 | > `unionid`实际上并不会用于登陆验证流程，但为了保险起见建议正确填写 58 | 59 | ##### 地址信息 60 | 61 | 在`location`字段中配置以下字段，作为你的签到地址信息 62 | 63 | **`behavior`动作已经停用，部分字段已经废弃，但由于兼容性考虑在配置中仍会保留** 64 | 65 | - 省份`province`（已弃用） 66 | - 城市`country`（已弃用） 67 | - 区（县）`city`（已弃用） 68 | - 行政区划代码`adcode`，可自行百度进行在线查询，注意不要与邮政编码混淆 69 | - 详细地址`address` 70 | 71 | 如果你的实习**没有限制签到范围**，将无法获取到定位的坐标信息，则需要额外填写以下字段，未配置坐标信息将会提示相关异常，这通常会发生在集中安排的实习中 72 | 73 | - 纬度`lat` 74 | - 经度`lng` 75 | 76 | **特别注意：当同时配置经度和纬度为非`0`值时，将视为有效坐标，并无视实习获取的签到坐标，不再以签到范围的坐标为准。请在配置前再三确认你的配置场景，以免导致外勤签到** 77 | 78 | > 坐标可以通过[拾取坐标系统](https://api.map.baidu.com/lbsapi/getpoint/index.html)进行获取，需注意百度地图的坐标拾取结果是经度在前 79 | 80 | 在`accounts.json`配置用户信息，配置的JSON对象父元素为数组(列表)，错误的格式会导致解析错误，默认已经为其配置了一个空配置，请直接修改默认的空值作为第一个用户，以下是其中一个对象的参考示例 81 | 82 | **并非所有字段都是必填，请注意对照上文说明** 83 | 84 | ```javascript 85 | { 86 | //用于微信登陆 87 | "openid": "ooruxxxxxxxxxxxxxxxxxxxxxxl0", //校友邦openId 88 | "unionid": "oHYxxxxxxxxxxxxxxxxxxxxxxQhE", //校友邦unionId 89 | //用于账号密码登录 90 | "username": "xxxxxx", //用户名 91 | "password": "xxxxxx", //密码 92 | //以下是签到位置相关信息 93 | "location": { 94 | "province": "xx省", //省份，已弃用 95 | "country": "xx市", //城市，已弃用 96 | "city": "xx区", //区（县），已弃用 97 | "adcode": 440000, //行政区划代码 98 | "address": "xxxx" //详细地址 99 | //以下是无签到范围坐标信息时，需要填写的坐标 100 | "lat": 0, 101 | "lng": 0 102 | } 103 | } 104 | ``` 105 | 106 | #### 使用 107 | 108 | 直接运行`xyb.py`，将会自动进行批量签到，如需要进行签退，将`347`行位置修改为`xyb.sign_out_all()` 109 | 110 | ----- 111 | 112 | ### 高级用法 113 | 114 | #### Webhooks 115 | 116 | 可以在`webhooks.py`中找到预定义的两个hook函数，分别为`on_sign_in`和`on_sign_out`，分别为签到事件和签退事件回调，回调函数只有一个参数`data`，其格式为 117 | 118 | **受具体登录方式的影响，部分字段的值可能为空** 119 | 120 | ```javascript 121 | { 122 | "openid": "ooruxxxxxxxxxxxxxxxxxxxxxxl0", //校友邦openId，可能为空 123 | "username": "xxxxxx" //登录的用户名，可能为空 124 | "loginer_id": "00000", //用户ID，每个用户唯一 125 | "name": "xxx", //用户姓名 126 | "phone": "134xxxxxxxx", //用户手机号 127 | "train_type": true, //自主与集中实习类型，true为自主安排，false为集中实习 128 | "train_id": "00000", //实习ID 129 | "post_type": true, //签到范围限制，true为存在限制签到范围，false为不存在 130 | "sign_type": true, //签到与签出类型，true为签到，false为签出 131 | "result": true, //任务执行成功情况 132 | "is_sign_in": true, //当前是否已签到 133 | "is_sign_out": false //当前是否已签出 134 | } 135 | ``` 136 | 137 | 可以自行结合以上提供的事件信息进行额外联动操作，如执行命令，发送web请求，机器人通知，微信公众号通知等 138 | 139 | #### 腾讯云函数(SCF)部署 140 | 141 | 你需要在腾讯云拥有一个账号并[创建新的云函数](https://console.cloud.tencent.com/scf/list-create) ，其中必须配置如下 142 | 143 | - 创建方式为**自定义创建** 144 | - 函数类型为**事件函数** 145 | - 函数名称可自取 146 | - 部署方式为**代码部署** 147 | - 运行环境为**Python3.6** 148 | - 提交方法可使用**本地上传zip包**或者**本地上传文件夹**将本项目上传 149 | - 执行方法为`index.main_handler` 150 | 151 | 展开高级配置 152 | 153 | - 内存选择**64MB**或者**128MB** 154 | - 初始化超时时间建议**10秒以上** 155 | - 执行超时时间建议**3-30秒左右** 156 | - 以上内存与超时相关配置请结合账户的数量进行调整 157 | - 网络配置勾选**公网访问**(默认勾选无需额外操作) 158 | - 执行配置建议勾选**异步执行** 159 | 160 | 触发器配置在这里暂不创建，后续创建函数后再配置 161 | 162 | 函数创建完成后，进入并选择左侧的触发管理，进入触发器创建页，创建一个触发器，第一个为**签到**触发器 163 | 164 | - 触发版本选择默认流量即可 165 | - 触发方式选择**定时触发** 166 | - 定时任务名称为**SignIn** 167 | - 触发周期选择**自定义触发周期** 168 | - 在下面出现的Cron表达式中，定义每日签到的时间，表达式可参考[腾讯云文档](https://cloud.tencent.com/document/product/583/9708) ，一个每天上午10:00:13自动签到的例子为`13 0 10 * * * *` 169 | - 附加信息为否，并保持立即启用为勾选 170 | 171 | 创建好一个签到触发器后，便可以再创建一个签退触发器，其选项除了以下内容不一样之外，其余均与上述签到触发器保持一致 172 | 173 | - 定时任务名称为**SignOut** 174 | - Cron表达式中，定义每日签退的时间，表达式可参考[腾讯云文档](https://cloud.tencent.com/document/product/583/9708) ，一个每天下午19:00:40自动签退的例子为`40 0 19 * * * *` 175 | 176 | 创建好两个触发器后，便可以在相应的时间自动进行签到签退操作了 177 | 178 | *API文档将在后续更新中添加* 179 | 180 | ----- 181 | 182 | #### 鸣谢 183 | 184 | [CncCbz/xybSign](https://github.com/CncCbz/xybSign) 185 | 186 | -------------------------------------------------------------------------------- /xyb.py: -------------------------------------------------------------------------------- 1 | import re 2 | import json 3 | import time 4 | import random 5 | import hashlib 6 | import logging 7 | from typing import Tuple, List 8 | from collections import Counter 9 | from urllib.parse import quote 10 | 11 | import requests 12 | 13 | from webhooks import on_sign_in, on_sign_out 14 | 15 | 16 | def init_logger(logger: logging.Logger, fmt="%(asctime)s - %(name)s - %(levelname)s: %(message)s"): 17 | # logger.setLevel(logging.INFO) 18 | formatter = logging.Formatter(fmt) 19 | sh = logging.StreamHandler() 20 | sh.setFormatter(formatter) 21 | logger.addHandler(sh) 22 | 23 | 24 | class XybAccount: 25 | def __init__(self, **config): 26 | self.logger = logging.Logger("XybAccount", logging.INFO) 27 | init_logger(self.logger) 28 | self.train_init = False 29 | self.session = requests.Session() 30 | self.session.headers = XybSign.HEADERS 31 | self.open_id = config.get("openid") 32 | self.union_id = config.get("unionid") 33 | self.location = config.get("location") 34 | self.account = config.get("username") 35 | self.account_pass = config.get("password") 36 | self.session_id = "" 37 | self.loginer_id = "" 38 | self.user_name = "" 39 | self.phone = "" 40 | self.train_id = "" 41 | self.train_type = 0 42 | self.post_state = 0 43 | self.sign_lat = self.location.get("lat", 0) 44 | self.sign_lng = self.location.get("lng", 0) 45 | self.is_sign_in = False 46 | self.is_sign_out = False 47 | self.login() 48 | self.load_user_info() 49 | self.load_train() 50 | self.load_train_info() 51 | 52 | def _request_error(self, msg: str, debug_data=None): 53 | self.logger.error(msg) 54 | self.logger.info(debug_data) 55 | raise RuntimeError(msg) 56 | 57 | def _except_json_resp(self, resp: requests.models.Response): 58 | try: 59 | return resp.json() 60 | except ValueError: 61 | return { 62 | "code": 500, 63 | "text": resp.text 64 | } 65 | 66 | def login(self): 67 | """自动登录，根据配置情况进行OpenID或者账号密码登录""" 68 | 69 | if self.account and self.account_pass: 70 | self.logger.info("正在使用账号密码登录") 71 | self.login_phone() 72 | elif self.open_id and self.union_id: 73 | self.logger.info("正在使用OpenID登录") 74 | self.login_wx() 75 | else: 76 | self._request_error("未正确配置账户信息") 77 | 78 | def login_wx(self): 79 | """执行登录（使用OpenID），获得loginerId信息""" 80 | 81 | data = dict( 82 | openId=self.open_id, 83 | unionId=self.union_id 84 | ) 85 | self.session.headers.update(self.sign_header(data)) 86 | resp = self.session.post(url=XybSign.URL_LOGIN_WX, data=data) 87 | resp = self._except_json_resp(resp) 88 | if resp["code"] == "200": 89 | self.loginer_id = resp["data"]["loginerId"] 90 | self.session_id = resp["data"]["sessionId"] 91 | self.phone = resp["data"]["phone"] 92 | self.logger.info(f"已登录(OpenID)：{self.loginer_id}") 93 | else: 94 | self._request_error(f"登录失败：{self.open_id}", resp) 95 | 96 | def login_phone(self): 97 | """执行登录（使用手机号），获得loginerId信息""" 98 | 99 | pass_hash = hashlib.md5(self.account_pass.encode("utf-8")) 100 | data = dict( 101 | username=self.account, 102 | password=pass_hash.hexdigest() 103 | ) 104 | self.session.headers.update(self.sign_header(data)) 105 | resp = self.session.post(url=XybSign.URL_LOGIN_PHONE, data=data) 106 | resp = self._except_json_resp(resp) 107 | if resp["code"] == "200": 108 | self.loginer_id = resp["data"]["loginerId"] 109 | self.session_id = resp["data"]["sessionId"] 110 | self.phone = resp["data"]["phone"] 111 | self.logger.info(f"已登录(账户密码)：{self.loginer_id}") 112 | else: 113 | self._request_error(f"登录失败：{self.open_id}", resp) 114 | 115 | def sign_header(self, data: dict, noce: List[int] = None, now_time: int = None) -> dict: 116 | """ 117 | 请求签名 118 | 119 | :param data: 请求体数据 120 | :param noce: 随机数列表(下标不能超过密码本长度) 121 | :param now_time: 时间戳 122 | :return: 签名用Headers 123 | """ 124 | re_punctuation = re.compile("[`~!@#$%^&*()+=|{}':;',\\[\\].<>/?~！@#￥%……&*（）——+|{}【】‘；：”“’。，、？]") 125 | cookbook = ["5", "b", "f", "A", "J", "Q", "g", "a", "l", "p", "s", "q", "H", "4", "L", "Q", "g", "1", "6", "Q", 126 | "Z", "v", "w", "b", "c", "e", "2", "2", "m", "l", "E", "g", "G", "H", "I", "r", "o", "s", "d", "5", 127 | "7", "x", "t", "J", "S", "T", "F", "v", "w", "4", "8", "9", "0", "K", "E", "3", "4", "0", "m", "r", 128 | "i", "n"] 129 | except_key = ["content", "deviceName", "keyWord", "blogBody", "blogTitle", "getType", "responsibilities", 130 | "street", "text", "reason", "searchvalue", "key", "answers", "leaveReason", "personRemark", 131 | "selfAppraisal", "imgUrl", "wxname", "deviceId", "avatarTempPath", "file", "file", "model", 132 | "brand", "system", "deviceId", "platform"] 133 | noce = noce if noce else [random.randint(0, len(cookbook) - 1) for _ in range(20)] 134 | now_time = now_time if now_time else int(time.time()) 135 | sorted_data = dict(sorted(data.items(), key=lambda x: x[0])) 136 | 137 | sign_str = "" 138 | for k, v in sorted_data.items(): 139 | v = str(v) 140 | if k not in except_key and not re.search(re_punctuation, v): 141 | self.logger.debug(f"Add keys: {k}") 142 | sign_str += str(v) 143 | sign_str += str(now_time) 144 | sign_str += "".join([cookbook[i] for i in noce]) 145 | sign_str = re.sub(r'\s+', "", sign_str) 146 | sign_str = re.sub(r'\n+', "", sign_str) 147 | sign_str = re.sub(r'\r+', "", sign_str) 148 | sign_str = sign_str.replace("<", "") 149 | sign_str = sign_str.replace(">", "") 150 | sign_str = sign_str.replace("&", "") 151 | sign_str = sign_str.replace("-", "") 152 | sign_str = re.sub(f'\uD83C[\uDF00-\uDFFF]|\uD83D[\uDC00-\uDE4F]', "", sign_str) 153 | sign_str = quote(sign_str) 154 | sign = hashlib.md5(sign_str.encode('ascii')) 155 | 156 | return { 157 | "n": ",".join(except_key), 158 | "t": str(now_time), 159 | "s": "_".join([str(i) for i in noce]), 160 | "m": sign.hexdigest(), 161 | "v": "1.7.14" 162 | } 163 | 164 | def load_user_info(self): 165 | """获得用户信息，取得userName""" 166 | 167 | # Loginer 168 | self.session.headers.update(self.sign_header({})) 169 | resp = self.session.get(url=XybSign.URL_ACCOUNT) 170 | resp = self._except_json_resp(resp) 171 | if resp["code"] == "200": 172 | self.user_name = resp["data"]["loginer"] 173 | self.logger.name = f"XybAccount[{self.user_name}]" 174 | self.logger.info("拉取用户信息完成") 175 | else: 176 | self._request_error(f"无法获取用户信息：{self.open_id}", resp) 177 | 178 | def load_train(self): 179 | """获得train信息""" 180 | 181 | # TrainId 182 | self.session.headers.update(self.sign_header({})) 183 | resp = self.session.get(url=XybSign.URL_TRAIN) 184 | resp = self._except_json_resp(resp) 185 | if resp["code"] == "200": 186 | if "clockVo" in resp["data"]: 187 | self.train_id = resp["data"]["clockVo"]["traineeId"] 188 | self.logger.info( 189 | f"已载入默认实习：{resp['data']['clockVo']['planName']}({resp['data']['clockVo']['startDate']} - {resp['data']['clockVo']['endDate']})") 190 | else: 191 | self._request_error("未找到默认实习，实习可能已结束", resp["data"]) 192 | else: 193 | self._request_error("无法载入默认实习", resp) 194 | 195 | def load_train_info(self): 196 | """获得train详情""" 197 | 198 | # TrainInfo 199 | data = dict(traineeId=self.train_id) 200 | self.session.headers.update(self.sign_header(data)) 201 | resp = self.session.post(url=XybSign.URL_TRAIN_INFO, data=data) 202 | resp = self._except_json_resp(resp) 203 | if resp["code"] == "200": 204 | self.train_type = resp["data"]["clockRuleType"] 205 | self.post_state = resp["data"]["postInfo"]["state"] 206 | self.is_sign_in = bool(resp["data"]["clockInfo"]["inTime"]) 207 | self.is_sign_out = bool(resp["data"]["clockInfo"]["outTime"]) 208 | if not self.train_init: 209 | self.logger.info(f"实习类型：{'自主' if self.train_type else '集中'}，实习定位：{'有' if self.post_state else '无'}") 210 | if self.post_state: 211 | if self.sign_lat and self.sign_lng: 212 | self.logger.warning(f"配置了一个有效的签到坐标{self.sign_lat}, {self.sign_lng}，将不再使用实习坐标") 213 | else: 214 | self.sign_lat = resp["data"]["postInfo"]["lat"] 215 | self.sign_lng = resp["data"]["postInfo"]["lng"] 216 | self.logger.info(f"将使用获取到的实习坐标：{self.sign_lat}, {self.sign_lng}") 217 | self.logger.info( 218 | f"考勤状态：Sign in[{'√' if self.is_sign_in else 'x'}] || Sign out[{'√' if self.is_sign_out else 'x'}]") 219 | if not self.sign_lat: 220 | self._request_error("无定位信息，请按照文档手动添加签到定位信息") 221 | self.train_init = True 222 | else: 223 | self._request_error("无法加载实习信息", resp) 224 | 225 | def get_ip(self) -> str: 226 | """获得请求IP""" 227 | self.session.headers.update(self.sign_header({})) 228 | resp = self.session.get(url=XybSign.URL_IP) 229 | resp = self._except_json_resp(resp) 230 | if resp["code"] == "200": 231 | return resp["data"]["ip"] 232 | else: 233 | self._request_error(f"无法获得本机IP", resp) 234 | 235 | def sign_behavior(self): 236 | """签到行为记录(目前已弃用)""" 237 | data = { 238 | 'login': 1, 239 | 'appVersion': '1.5.75', 240 | 'operatingSystemVersion': 10, 241 | 'deviceModel': 'microsoft', 242 | 'operatingSystem': 'android', 243 | 'screenWidth': 415, 244 | 'screenHeight': 692, 245 | 'reportSrc': '2', 246 | 'eventTime': int(time.time()), 247 | 'eventType': 'click', 248 | 'eventName': 'clickSignEvent', 249 | 'clientIP': self.get_ip(), 250 | 'pageId': 30, 251 | 'itemID': 'none', 252 | 'itemType': '其他', 253 | 'stayTime': 'none', 254 | 'deviceToken': self.open_id, 255 | 'netType': 'WIFI', 256 | 'app': 'wx_student', 257 | 'preferName': '成长', 258 | 'pageName': '成长-签到', 259 | 'userName': self.user_name, 260 | 'userId': self.loginer_id, 261 | 'province': self.location['province'], 262 | 'country': self.location['country'], 263 | 'city': self.location['city'] 264 | } 265 | self.session.headers.update(self.sign_header(data)) 266 | resp = self.session.post(url=XybSign.URL_BEHAVIOR, data=data) 267 | resp = self._except_json_resp(resp) 268 | if resp["code"] != "200": 269 | self._request_error("发送签到信息失败", resp) 270 | 271 | def _prepare_sign(self, status: int) -> dict: 272 | """ 273 | 签到前准备，包括行为记录(已停用)和构建数据 274 | 275 | :param status: 签到/签出类型(1签出2签到) 276 | :return: 构建好的签到数据 277 | """ 278 | # self.sign_behavior() 279 | return { 280 | 'traineeId': self.train_id, 281 | 'adcode': self.location['adcode'], 282 | 'lat': self.sign_lat, 283 | 'lng': self.sign_lng, 284 | 'address': self.location['address'], 285 | 'deviceName': 'microsoft', 286 | 'punchInStatus': 1, 287 | 'clockStatus': status, 288 | 'imgUrl': '', 289 | 'reason': "" 290 | } 291 | 292 | def auto_sign(self, status: int): 293 | """ 294 | 签到签退自动触发型记录逻辑，非特殊不要直接使用 295 | 296 | 自动签到逻辑下，仅有未签到记录时才会自动签到，其余情况不会修改记录 297 | 298 | :param status: 签到/签出类型(1签出2签到) 299 | """ 300 | if status not in (1, 2): 301 | raise RuntimeError(f"传入的签到类型错误:{status}") 302 | data = self._prepare_sign(status) 303 | self.session.headers.update(self.sign_header(data)) 304 | resp = self.session.post(url=XybSign.URL_AUTO_CLOCK, data=data) 305 | resp = self._except_json_resp(resp) 306 | self.load_train_info() 307 | if resp["code"] != "200": 308 | self._request_error(f"无法进行【自动】{['签退', '签到'][status - 1]}", resp) 309 | 310 | def new_sign(self, status: int): 311 | """ 312 | 签到签退追加型记录逻辑，非特殊不要直接使用 313 | 314 | 会直接追加新的签到记录，新的记录可以是签到或者签退 315 | 316 | :param status: 签到/签出类型(1签出2签到) 317 | """ 318 | if status not in (1, 2): 319 | raise RuntimeError(f"传入的签到类型错误:{status}") 320 | data = self._prepare_sign(status) 321 | self.session.headers.update(self.sign_header(data)) 322 | resp = self.session.post(url=XybSign.URL_NEW_CLOCK, data=data) 323 | resp = self._except_json_resp(resp) 324 | self.load_train_info() 325 | if resp["code"] != "200": 326 | self._request_error(f"无法进行【新增】{['签退', '签到'][status - 1]}", resp) 327 | 328 | def update_sign(self, status: int): 329 | """ 330 | 签到签退更新型记录逻辑，非特殊不要直接使用 331 | 332 | 更新最近的签到/签退记录，已有签退记录时无法更新之前的签到记录 333 | 334 | :param status: 签到/签出类型(1签出2签到) 335 | """ 336 | if status not in (1, 2): 337 | raise RuntimeError(f"传入的签到类型错误:{status}") 338 | data = self._prepare_sign(status) 339 | self.session.headers.update(self.sign_header(data)) 340 | resp = self.session.post(url=XybSign.URL_UPDATE_CLOCK, data=data) 341 | resp = self._except_json_resp(resp) 342 | self.load_train_info() 343 | if resp["code"] != "200": 344 | self._request_error(f"无法进行【覆盖】{['签退', '签到'][status - 1]}", resp) 345 | 346 | def sign_in(self, overwrite=False) -> bool: 347 | """ 348 | 签到 349 | 350 | :param overwrite: 已经签到时是否覆盖 351 | :return 签到结果 352 | """ 353 | if self.is_sign_in: 354 | if overwrite: 355 | if not self.is_sign_out: 356 | self.update_sign(2) 357 | self.logger.info("签到完成：覆盖模式") 358 | return True 359 | else: 360 | self.logger.error("已签退，无法进行签到") 361 | return False 362 | else: 363 | self.logger.warning("已经进行过签到，本次操作未进行...") 364 | return False 365 | else: 366 | self.auto_sign(2) 367 | self.logger.info("签到完成：自动触发模式") 368 | return True 369 | 370 | def sign_out(self, overwrite=False) -> bool: 371 | """ 372 | 签退 373 | 374 | :param overwrite: 已经签退时是否覆盖 375 | :return 签退结果 376 | """ 377 | if self.is_sign_in: 378 | if self.is_sign_out: 379 | if overwrite: 380 | self.update_sign(1) 381 | self.logger.info("签退完成：覆盖模式") 382 | return True 383 | else: 384 | self.logger.warning("已经进行过签退，本次操作未进行...") 385 | return False 386 | else: 387 | self.new_sign(1) 388 | self.logger.info("签退完成：新增记录模式") 389 | return True 390 | else: 391 | self.logger.error("无法进行签退，必须先进行签到操作") 392 | return False 393 | 394 | 395 | class XybSign: 396 | URL_LOGIN_PHONE = "https://xcx.xybsyw.com/login/login.action" 397 | URL_LOGIN_WX = "https://xcx.xybsyw.com/login/login!wx.action" 398 | URL_ACCOUNT = "https://xcx.xybsyw.com/account/LoadAccountInfo.action" 399 | URL_IP = "https://xcx.xybsyw.com/behavior/Duration!getIp.action" 400 | URL_TRAIN = "https://xcx.xybsyw.com/student/clock/GetPlan!getDefault.action" 401 | URL_TRAIN_INFO = "https://xcx.xybsyw.com/student/clock/GetPlan!detail.action" 402 | URL_BEHAVIOR = "https://app.xybsyw.com/behavior/Duration.action" 403 | URL_AUTO_CLOCK = "https://xcx.xybsyw.com/student/clock/Post!autoClock.action" 404 | URL_NEW_CLOCK = "https://xcx.xybsyw.com/student/clock/PostNew.action" 405 | URL_UPDATE_CLOCK = "https://xcx.xybsyw.com/student/clock/Post!updateClock.action" 406 | 407 | HEADERS = { 408 | "User-Agent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2785.143 Safari/537.36 MicroMessenger/7.0.9.501 NetType/WIFI MiniProgramEnv/Windows WindowsWechat", 409 | "content-type": "application/x-www-form-urlencoded", 410 | "Accept-Encoding": "gzip, deflate" 411 | } 412 | 413 | def __init__(self, file="accounts.json"): 414 | self.logger = logging.Logger("XybSign", logging.INFO) 415 | init_logger(self.logger) 416 | with open(file, encoding="utf-8") as fp: 417 | accounts = json.load(fp) 418 | self._accounts = list() 419 | for acc in accounts: 420 | try: 421 | self._accounts.append(XybAccount(**acc)) 422 | except Exception as err: 423 | self.logger.error("载入账户时出现异常") 424 | self.logger.exception(err) 425 | self.logger.info(f"已载入 {len(self._accounts)} 个账号") 426 | 427 | def get_accounts(self) -> Tuple[XybAccount]: 428 | """获得账户OpenId列表，便于后续的登录操作""" 429 | return tuple(self._accounts) 430 | 431 | def _batch_task(self, sign_type: bool, *args): 432 | """ 433 | 批量任务 434 | 435 | :param sign_type: 签到/签出类型 436 | :param args: 任务参数 437 | """ 438 | counter = Counter() 439 | webhook_queue = list() 440 | for acc in self.get_accounts(): 441 | task_result = False 442 | try: 443 | ret = acc.sign_in(*args) if sign_type else acc.sign_out(*args) 444 | except RuntimeError as err: 445 | self.logger.error("签到/退失败") 446 | self.logger.exception(err) 447 | counter.update((False,)) 448 | else: 449 | counter.update((ret,)) 450 | task_result = ret 451 | finally: 452 | webhook_data = { 453 | "openid": acc.open_id, 454 | "username": acc.account, 455 | "loginer_id": acc.loginer_id, 456 | "name": acc.user_name, 457 | "phone": acc.phone, 458 | "train_type": bool(acc.train_type), 459 | "train_id": acc.train_id, 460 | "post_type": bool(acc.post_state), 461 | "sign_type": sign_type, 462 | "result": task_result, 463 | "is_sign_in": acc.is_sign_in, 464 | "is_sign_out": acc.is_sign_out 465 | } 466 | webhook_queue.append(webhook_data) 467 | self.logger.info(f"任务结束，{counter[True]}(成功) / {counter[False]}(失败)") 468 | self.webhook(sign_type, webhook_queue) 469 | 470 | def webhook(self, sign_type: bool, hook_data: list): 471 | """ 472 | 批量任务通知回调 473 | 474 | :param sign_type: 签到/签出类型 475 | :param hook_data: 回调数据 476 | """ 477 | 478 | counter = Counter() 479 | for data in hook_data: 480 | try: 481 | on_sign_in(data) if sign_type else on_sign_out(data) 482 | counter.update((True,)) 483 | except Exception as err: 484 | self.logger.error("调用Webhook时出现异常") 485 | self.logger.exception(err) 486 | counter.update((False,)) 487 | self.logger.info(f"Webhooks: {len(hook_data)} || {counter[True]}(完成) / {counter[False]}(失败)") 488 | 489 | def sign_in_all(self, overwrite=False): 490 | """ 491 | 批量签到 492 | 493 | :param overwrite: 已经签到时是否覆盖 494 | """ 495 | self.logger.info(f"开始批量签到 {len(self._accounts)} 个账户") 496 | self._batch_task(True, overwrite) 497 | 498 | def sign_out_all(self, overwrite=False): 499 | """ 500 | 批量签退 501 | 502 | :param overwrite: 已经签退时是否覆盖 503 | """ 504 | self.logger.info(f"开始批量签退 {len(self._accounts)} 个账户") 505 | self._batch_task(False, overwrite) 506 | 507 | 508 | if __name__ == '__main__': 509 | xyb = XybSign() 510 | xyb.sign_in_all() 511 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------