handler.py

import random
import traceback
import os

from liteTools import UserDefined, LL, TT, DT, HSF, ST, RT, ProxyGet, TaskError
from actions.teacherSign import teacherSign
from actions.workLog import workLog
from actions.sleepCheck import sleepCheck
from actions.collection import Collection
from actions.autoSign import AutoSign
from actions.sendMessage import SendMessage
from todayLoginService import TodayLoginService


class SignTask:
    userSessions = {}
    codeHeadCounts = 5
    statusMsg_lite = {
        0: '待命',
        1: '完成',
        2: '跳过',
        3: '出错',
        4: '缺失',
    }
    statusMsg = {
        0: "等待执行",
        1: "出现错误(等待重试)",
        100: "任务已被完成",
        101: "该任务正常执行完成",
        200: "用户设置不执行该任务",
        201: "该任务不在执行时间",
        300: "出错",
        301: "当前情况无法完成该任务",
        400: "没有找到需要执行的任务"
    }

    def __init__(self, userConfig: dict, maxTry: int = 3):
        '''
        :params userConfig: 用户配置
        :params maxTry: 最大尝试次数
        '''
        self.config: dict = userConfig
        self.msg: str = ""
        self.code: int = 0
        self.maxTry: int = int(maxTry)  # 最大触发次数
        self.attempts: int = 0  # 任务触发次数, 当达到最大触发次数, 可能哪怕执行失败也会触发消息推送等
        self.username = userConfig.get("username", "?username?")

        # 检查任务是否在执行时间
        if TT.isInTimeList(userConfig['taskTimeRange']):
            self.code = 0
        else:
            self.code = 201
            self.msg = '该任务不在执行时间'

    def execute(self):
        '''
        任务执行函数(含异常处理、重试次数等)
        '''
        # 检查是否已经完成该任务
        if not self.codeHead == 0:
            return
        self.attempts += 1
        LL.log(1, '即将在第%d轮尝试中为[%s]签到' % (self.attempts, self.username))

        # 执行签到
        try:
            # 执行前准备
            self._beforeExecute()
            # 执行签到任务
            self._execute()
        except TaskError as e:
            self.code = e.code
            self.msg = str(e)
        except Exception as e:
            self.code = 1
            self.msg = f"[{e}]\n{traceback.format_exc()}"
            LL.log(3, ST.notionStr(self.msg),
                   self.config['username']+'签到失败'+self.msg)
        finally:
            # 收尾工作
            self._afterExecute()

    def formatMsg(self, pattern: str = ""):
        return ST.stringFormating(pattern, self.webhook)

    def _login(self):
        '''
        登录, 更新self.session和self.host
        '''
        LL.log(1, '准备登录')
        uuid = self.uuid
        userSessions = SignTask.userSessions

        if userSessions.get(uuid):
            LL.log(1, '正在复用登录Session')
            uSession = userSessions[uuid]['session']
            uHost = userSessions[uuid]['host']
        else:
            LL.log(1, '正在尝试进行登录')
            today = TodayLoginService(self.config)
            today.login()
            uSession = today.session
            uHost = today.host

        userSessions[uuid] = {
            'session': uSession, 'host': uHost}
        LL.log(1, '登录完成')
        # 更新数据
        self.session = uSession
        self.host = uHost
        return

    def _beforeExecute(self):
        '''
        执行前准备工作
        '''
        # 随机延迟
        RT.randomSleep(self.config['delay'])

        # 用户自定义函数触发
        event = {
            "msg": f"『{self.username}』个人任务即将执行",  # 触发消息
            "from": "task start",  # 触发位置
            "code": 200,
        }
        UserDefined.trigger(event, self.webhook)

        # 登录
        self._login()

    def _execute(self):
        '''任务执行函数'''
        type_ = self.config.get('type', None)
        # 通过type判断当前属于 信息收集、签到、查寝
        # 信息收集
        if type_ == 0:
            # 以下代码是信息收集的代码
            LL.log(1, '即将开始信息收集填报')
            collection = Collection(self)
            collection.queryForm()
            collection.fillForm()
            msg = collection.submitForm()
        elif type_ == 1:
            # 以下代码是签到的代码
            LL.log(1, '即将开始签到')
            sign = AutoSign(self)
            sign.getUnSignTask()
            sign.getDetailTask()
            sign.fillForm()
            msg = sign.submitForm()
        elif type_ == 2:
            # 以下代码是查寝的代码
            LL.log(1, '即将开始查寝填报')
            check = sleepCheck(self)
            check.getUnSignedTasks()
            check.getDetailTask()
            check.fillForm()
            msg = check.submitForm()
        elif type_ == 3:
            # 以下代码是工作日志的代码
            raise TaskError('工作日志模块已失效')
            LL.log(1, '即将开始工作日志填报')
            work = workLog(today, user)
            work.checkHasLog()
            work.getFormsByWids()
            work.fillForms()
            msg = work.submitForms()
        elif type_ == 4:
            # 以下代码是政工签到的代码
            LL.log(1, '即将开始政工签到填报')
            check = teacherSign(self)
            check.getUnSignedTasks()
            check.getDetailTask()
            check.fillForm()
            msg = check.submitForm()
        else:
            raise Exception('任务类型出错，请检查您的user的type')

        self.msg = msg
        return msg

    def _afterExecute(self):
        '''
        执行后收尾工作
        '''
        LL.log(1, self.defaultFormatTitle + "\n" + self.defaultFormatMsg)

        # 消息推送(当本任务最后一次执行时)
        if self.codeHead != 0 or self.maxTry == self.attempts:
            sm = self.sendMsg
            sm.send(self.defaultFormatMsg, self.defaultFormatTitle)
            LL.log(1, f"『{self.username}』用户推送情况", sm.log_str)

        # 用户自定义函数触发
        event = {
            "msg": f"『{self.username}』个人任务执行完成",  # 触发消息
            "from": "task end",  # 触发位置
            "code": 201,
        }
        UserDefined.trigger(event, self.webhook)

    @ property
    def webhook(self):
        return {
            "scriptVersion": LL.prefix,  # 脚本版本

            "username": self.username,  # 用户账号
            "remarkName": self.config["remarkName"],  # 用户备注名

            "attempts": self.attempts,  # 执行尝试次数
            "maxtry": self.maxTry,  # 最大尝试次数

            "msg": self.msg,  # 任务执行消息
            "statusCode": self.code,
            "statusCodehead": self.codeHead,
            "statusMsg": self.statusMsg[self.code],  # 状态信息(完整版)
            "statusMsgLite": self.statusMsg_lite[self.codeHead],  # 状态信息(短版)
        }

    @property
    def defaultFormatTitle(self):
        return self.formatMsg("『用户签到情况({statusMsgLite})[{scriptVersion}]』")

    @property
    def defaultFormatMsg(self):
        return self.formatMsg("[{remarkName}|{username}]({attempts})\n>>{msg}")

    @ property
    def sendMsg(self):
        '''
        任务绑定的消息发送类
        :returns SendMessage
        '''
        return SendMessage(self.config.get('sendMessage'))

    @ property
    def uuid(self):
        '''
        根据用户名和学校给每个用户分配一个uuid。
        用于一个用户有多个任务时, 登录状态的Sesssion复用。
        '''
        return HSF.strHash(self.config.get('schoolName', '') + self.config.get('username', ''), 256)

    @ property
    def codeHead(self):
        return int(self.code/100)

    @ staticmethod
    def cleanSession(uuid=None):
        '''
        清理用户Session, 如果uuid为空, 则清理全部Session; 否则清理对应uuid的Session。
        '''
        if not uuid:
            SignTask.userSessions.clear()
        else:
            SignTask.userSessions.pop(uuid, None)


class MainHandler:
    def __init__(self, entranceType: str, event: dict = {}, context: dict = {}):
        '''
        初始化
        :params entranceType: 执行方式, 主要区分云函数与本地执行(因为云函数一般无法写入文件)
        '''
        self.entrance: str = entranceType
        self.event: dict = event
        self.context: dict = context
        # ==========参数初始化==========
        self.geneLogFile = True
        self.configDir = "config.yml"
        if self.entrance == "__main__" and event.get("args", {}).get("environment", None) == "qinglong":
            # 如果运行环境是『青龙面板』
            self.geneLogFile = False
            LL.log(1, "当前环境为青龙面板, 脚本不自行生成日志文件, 请从日志管理页面获取日志")
            self.configDir = event.get("args", {}).get("configfile", None)
            LL.log(1, f"当前环境为青龙面板, 根据命令参数确定配置文件位置「{self.configDir}」")
        elif self.entrance in ("handler", "main_handler"):
            # 如果运行入口是『云函数』(不可写入文件)
            self.geneLogFile = False
        # ==========参数初始化==========
        self.config: dict = self.loadConfig()
        self._setMsgOut()
        self._maxTry = self.config['maxTry']
        self.taskList = [SignTask(u, self._maxTry)
                         for u in self.config['users']]

    def execute(self):
        '''
        执行签到任务
        '''
        # 用户自定义函数触发
        event = {
            "msg": f"任务序列即将执行",  # 触发消息
            "from": "global start",  # 触发位置
            "code": 100,
        }
        UserDefined.trigger(event, self.webhook)
        LL.log(1, "任务开始执行")
        maxTry = self._maxTry
        for tryTimes in range(1, maxTry+1):
            '''自动重试'''
            LL.log(1, '正在进行第%d轮尝试' % tryTimes)
            for task in self.taskList:
                '''遍历执行任务'''
                # 执行
                task.execute()
                # 清理无用session
                self._cleanSession(task.uuid)
            # 清理session池
            SignTask.cleanSession()

        # 签到情况推送
        LL.log(1, self.defaultFormatTitle + "\n" + self.defaultFormatMsg)
        sm = self.sendMsg
        sm.send(msg=self.defaultFormatMsg, title=self.defaultFormatTitle, attachments=[(LL.msgOut.log.encode(encoding='utf-8'),
                                                                                        TT.formatStartTime("LOG#t=%Y-%m-%d--%H-%M-%S##.txt"))])
        LL.log(1, '全局推送情况', sm.log_str)
        # 用户自定义函数触发
        event = {
            "msg": f"任务序列执行完毕",  # 触发消息
            "from": "global end",  # 触发位置
            "code": 101,
        }
        UserDefined.trigger(event, self.webhook)
        LL.log(1, "==========函数执行完毕==========")

    def formatMsg(self, pattern: str = ""):
        return ST.stringFormating(pattern, self.webhook)

    def _cleanSession(self, uuid: str):
        '''
        登录状态内存释放: 如果同用户还有没有未执行的任务, 则删除session
        '''
        for i in self.taskList:
            if i.code == 0 and i.uuid == uuid:
                break
        else:
            SignTask.cleanSession(uuid)

    def _setMsgOut(self):
        '''
        设置日志输出
        :returns msgOut: FileOut
        '''
        if self.geneLogFile:
            logDir = self.config.get('logDir')
            if type(logDir) == str:
                logDir = os.path.join(logDir, TT.formatStartTime(
                    "LOG#t=%Y-%m-%d--%H-%M-%S##.txt"))
                LL.msgOut.setFileOut(logDir)
                return
        else:
            return

    def loadConfig(self):
        '''
        配置文件载入
        :returns config: dict
        '''
        # 检查config.yml是否存在
        if not os.path.isfile(self.configDir):
            if os.path.isfile("config.yml.sample"):
                raise Exception(
                    "读取配置文件出错, 请将「config.yml.sample」重命名为「config.yml」")
            elif os.path.isfile("sample_config.yml"):
                raise Exception(
                    "读取配置文件出错, 请将「sample_config.yml」重命名为「config.yml」")
            else:
                raise Exception("读取配置文件出错, 未找到「config.yml」")
        # 读取config.yml
        try:
            config = DT.loadYml(self.configDir)
        except Exception as e:
            errmsg = f"""读取配置文件出错
请尝试检查配置文件(建议下载VSCode并安装yaml插件进行检查)
错误信息: {e}"""
            LL.log(4, ST.notionStr(errmsg))
            raise e
        # 全局配置初始化
        defaultConfig = {
            'delay': (5, 10),
            'locationOffsetRange': 50,
            "shuffleTask": False
        }
        defaultConfig.update(config)
        config.update(defaultConfig)

        # 用户配置初始化
        if config['shuffleTask']:
            LL.log(1, "随机打乱任务列表")
            random.shuffle(config['users'])
        for user in config['users']:
            LL.log(1, f"正在初始化{user['username']}的配置")
            user: dict
            # 初始化静态配置项目
            defaultConfig = {
                'remarkName': '默认备注名',
                'model': 'OPPO R11 Plus',
                'appVersion': '9.0.14',
                'systemVersion': '4.4.4',
                'systemName': 'android',
                "signVersion": "first_v3",
                "calVersion": "firstv",
                'taskTimeRange': "1-7 1-12 1-31 0-23 0-59",
                'getHistorySign': False,
                'title': 0,
                'signLevel': 1,
                'abnormalReason': "回家",
                'qrUuid': None,
                'delay': config['delay']
            }
            defaultConfig.update(user)
            user.update(defaultConfig)

            # 用户设备ID
            user['deviceId'] = user.get(
                'deviceId', RT.genDeviceID(user.get('schoolName', '')+user.get('username', '')))

            # 用户代理
            user.setdefault('proxy')
            user['proxy'] = ProxyGet(user['proxy'])

            # 坐标随机偏移
            user['global_locationOffsetRange'] = config['locationOffsetRange']
            if 'lon' in user and 'lat' in user:
                user['lon'], user['lat'] = RT.locationOffset(
                    user['lon'], user['lat'], config['locationOffsetRange'])
        return config

    @property
    def webhook(self):
        codecount = self.codeCount
        return {
            "taskcount_all": sum(codecount),  # 全部任务数
            "taskcount_todo": codecount[0],  # 待命任务数
            "taskcount_done": codecount[1],  # 完成任务数
            "taskcount_skip": codecount[2],  # 跳过任务数
            "taskcount_error": codecount[3],  # 出错任务数
            "taskcount_notFound": codecount[4],  # 缺失任务数(没有找到相关任务)
            # 被执行任务数(没有被跳过的任务)
            "taskcount_executed": sum(codecount) - codecount[2],

            "scriptVersion": LL.prefix,  # 脚本版本
            "runTime": TT.formatStartTime(),  # 脚本启动时间(%Y-%m-%d %H:%M:%S格式)
            "usedTime": TT.executionSeconds(),  # 运行消耗时间(浮点数, 单位:秒)

            # 一个列表, 包含所有任务的webhook参数
            "taskWebhook": [i.webhook for i in self.taskList],
        }

    @property
    def defaultFormatTitle(self):
        return self.formatMsg("『全局签到情况({taskcount_done}/{taskcount_executed})[{scriptVersion}]』")

    @property
    def defaultFormatMsg(self):
        userMsg = []
        for i in self.taskList:
            if i.codeHead != 2:
                userMsg.append(i.defaultFormatMsg)
        return self.formatMsg("\n".join([
            "\n".join(userMsg),
            "运行于{runTime}, 用时{usedTime}秒",
            "{taskcount_all}任务| {taskcount_todo}待命, {taskcount_done}完成, {taskcount_skip}跳过, {taskcount_error}错误, {taskcount_notFound}缺失"
        ]))

    @ property
    def codeCount(self):
        """状态码统计"""
        codeList = [i.codeHead for i in self.taskList]
        codeCount = [0]*SignTask.codeHeadCounts
        for i in codeList:
            codeCount[i] += 1
        return codeCount

    @ property
    def sendMsg(self):
        '''
        全局绑定的消息发送类
        :returns SendMessage
        '''
        return SendMessage(self.config.get('sendMessage'))