o _J@h2@sdZddlZddlZddlZddlZddlmZddlmZddl m Z ddl m Z ddl mZdd lmZdd lmZmZed ZGd d d eZdS)zAPScheduler implementation.N) EVENT_ALL)BackgroundScheduler)JobLookupError) make_response)get_debug_flag)api) fix_job_def pop_triggerZflask_apschedulerc@s&eZdZdZd?ddZeddZeddZed d Zed d Z ed dZ ddZ d@ddZ dAddZ ddZddZefddZddZdd ZdBd!d"ZdBd#d$ZdBd%d&ZdBd'd(ZdBd)d*ZdBd+d,ZdBd-d.ZdBd/d0Zd1d2Zd3d4Zd5d6Zd7d8Zd9d:Z d;d<Z!d=d>Z"dS)C APSchedulerz)Provides a scheduler integrated to Flask.NcCs\|pt|_t|_d|_dg|_d|_d|_ d|_ d|_ d|_ |r,| |dSdS)N*Fz /schedulerz scheduler.)r _schedulersocket gethostnamelower _host_name_authentication_callback allowed_hostsauth api_enabled api_prefixendpoint_prefixappinit_app)self schedulerrrN/var/www/html/venv/lib/python3.10/site-packages/flask_apscheduler/scheduler.py__init__$s zAPScheduler.__init__cC|jS)zGet the host name.)rrrrr host_name3zAPScheduler.host_namecC|jjS)z*Get true whether the scheduler is running.)r runningr rrrr$8zAPScheduler.runningcCr#)zGet the state of the scheduler.)r stater rrrr&=r%zAPScheduler.statecCr)zGet the base scheduler.)r r rrrrBr"zAPScheduler.schedulercCr#)z Get the base scheduler decorator)r Z scheduled_jobr rrrtaskGr%zAPScheduler.taskcCs4||_||j_|||jr|dSdS)z=Initialize the APScheduler with a Flask application instance.N)rZ apscheduler _load_config _load_jobsr _load_api)rrrrrrLs zAPScheduler.init_appFcCs`tr tjs dS|j|jvr'd|jvr'td|jdd|jdS|j j |ddS)z~ Start the scheduler. :param bool paused: if True, don't start job processing until resume is called. Nr z Host name z; is not allowed to start the APScheduler. Servers allowed: ,)paused) rwerkzeugZservingZis_running_from_reloaderr!rLOGGERdebugjoinr start)rr,rrrr1Xs  zAPScheduler.startTcC|j|dS)a  Shut down the scheduler. Does not interrupt any currently running jobs. :param bool wait: ``True`` to wait until all currently executing jobs have finished :raises SchedulerNotRunningError: if the scheduler has not been started yet N)r shutdown)rwaitrrrr3iszAPScheduler.shutdowncC|jdS)z Pause job processing in the scheduler. This will prevent the scheduler from waking up to do job processing until :meth:`resume` is called. It will not however stop any already running job processing. N)r pauser rrrr6sszAPScheduler.pausecCr5)z9 Resume job processing in the scheduler. N)r resumer rrrr7|szAPScheduler.resumecC|j||dS)a Add a listener for scheduler events. When a matching event occurs, ``callback`` is executed with the event object as its sole argument. If the ``mask`` parameter is not provided, the callback will receive events of all types. For further info: https://apscheduler.readthedocs.io/en/latest/userguide.html#scheduler-events :param callback: any callable that takes one argument :param int mask: bitmask that indicates which events should be listened to N)r add_listener)rcallbackmaskrrrr9s zAPScheduler.add_listenercCr2)z; Remove a previously added event listener. N)r remove_listener)rr:rrrr<szAPScheduler.remove_listenercKsDt|}||d<||d<|dp||d<t||jjdi|S)a Add the given job to the job list and wakes up the scheduler if it's already running. :param str id: explicit identifier for the job (for modifying it later) :param func: callable (or a textual reference to one) to run at the given time idfuncnameNr)dictgetr r add_job)rr=r>kwargsZjob_defrrrrBs zAPScheduler.add_jobcCr8)z Remove a job, preventing it from being run any more. :param str id: the identifier of the job :param str jobstore: alias of the job store that contains the job N)r remove_jobrr=jobstorerrrrDszAPScheduler.remove_jobcCr2)z Remove all jobs from the specified job store, or all job stores if none is given. :param str|unicode jobstore: alias of the job store N)r remove_all_jobsrrFrrrrGszAPScheduler.remove_all_jobscCs|j||S)a$ Return the Job that matches the given ``id``. :param str id: the identifier of the job :param str jobstore: alias of the job store that most likely contains the job :return: the Job by the given ID, or ``None`` if it wasn't found :rtype: Job )r get_jobrErrrrIs zAPScheduler.get_jobcCs |j|S)z Return a list of pending jobs (if the scheduler hasn't been started yet) and scheduled jobs, either from a specific job store or from all of them. :param str jobstore: alias of the job store :rtype: list[Job] )r get_jobsrHrrrrJs zAPScheduler.get_jobscKsJt|d|vrt|\}}|jj|||fi||jj||fi|S)z Modify the properties of a single job. Modifications are passed to this method as extra keyword arguments. :param str id: the identifier of the job :param str jobstore: alias of the job store that contains the job trigger)r r r Zreschedule_job modify_job)rr=rFchangesrKZ trigger_argsrrrrLs  zAPScheduler.modify_jobcCr8)z Pause the given job until it is explicitly resumed. :param str id: the identifier of the job :param str jobstore: alias of the job store that contains the job N)r pause_jobrErrrrNzAPScheduler.pause_jobcCr8)z Resume the schedule of the given job, or removes the job if its schedule is finished. :param str id: the identifier of the job :param str jobstore: alias of the job store that contains the job N)r resume_jobrErrrrPrOzAPScheduler.resume_jobcCs2|j||}|s t||j|ji|jdS)z Run the given job without scheduling it. :param id: the identifier of the job. :param str jobstore: alias of the job store that contains the job :return: N)r rIrr>argsrC)rr=rFjobrrrrun_jobszAPScheduler.run_jobcCs ||_|S)z A decorator that is used to register a function to authenticate a user. :param func: The callback to authenticate. )r)rr>rrr authenticateszAPScheduler.authenticatecCst}|jjd}|r||d<|jjd}|r||d<|jjd}|r*||d<|jjd}|r7||d<|jjdi||jjd |j|_|jjd |j|_|jjd |j|_|jjd |j|_|jjd |j |_ |jjd|j |_ dS)zF Load the configuration from the Flask configuration. ZSCHEDULER_JOBSTORESZ jobstoresZSCHEDULER_EXECUTORS executorsZSCHEDULER_JOB_DEFAULTS job_defaultsZSCHEDULER_TIMEZONEtimezoneZSCHEDULER_AUTHZSCHEDULER_VIEWS_ENABLEDZSCHEDULER_API_ENABLEDZSCHEDULER_API_PREFIXZSCHEDULER_ENDPOINT_PREFIXZSCHEDULER_ALLOWED_HOSTSNr) r@rconfigrAr configurerrrrr)roptionsZ job_storesrUrVrWrrrr( s(zAPScheduler._load_configcCsF|jjd}|s|jjd}|r|D] }|jdi|qdSdS)zH Load the job definitions from the Flask configuration. ZSCHEDULER_JOBSZJOBSNr)rrXrArB)rjobsrRrrrr))szAPScheduler._load_jobscCs|ddtjd|ddtjd|ddtjd|d d tjd|d d tjd|d dtjd|ddtjd|ddtj d|ddtj d|ddtj d|ddtj d|ddtj d|ddtjddS)z7 Add the routes for the scheduler API. get_scheduler_infoGETpause_schedulerz/pausePOSTresume_schedulerz/resumestart_schedulerz/startshutdown_schedulerz /shutdownrBz/jobsrIz/jobs/rJ delete_jobDELETE update_jobPATCHrNz/jobs//pauserPz/jobs//resumerSz/jobs//runN)_add_url_routerr\r_rarbrcrBrIrJrdrfrNrPrSr rrrr*6szAPScheduler._load_apicCs@|jr|j|}|jr|j|}|jj|||||gddS)z Add a Flask route. :param str endpoint: The endpoint name. :param str rule: The endpoint url. :param view_func: The endpoint func :param str method: The http method. )methodsN)rrrZ add_url_rule _apply_auth)rZendpointrule view_funcmethodrrrrhHs   zAPScheduler._add_url_routecstfdd}|S)z Apply decorator to authenticate the user who is making the request. :param view_func: The flask view func. csTjs |i|Sj}|durSjr|s#S|i|SN)rget_authorization_handle_authentication_errorr)rQrCZ auth_datarrlrr decoratedbs z*APScheduler._apply_auth..decorated) functoolswraps)rrlrrrrqrrj]szAPScheduler._apply_authcCs"td}|j|jd<d|_|S)z1 Return an authentication error. z Access DeniedzWWW-Authenticatei)rrZget_authenticate_headerheaders status_code)rresponserrrrpssz(APScheduler._handle_authentication_error)NN)F)Trn)#__name__ __module__ __qualname____doc__rpropertyr!r$r&rr'rr1r3r6r7rr9r<rBrDrGrIrJrLrNrPrSrTr(r)r*rhrjrprrrrr !sH              r )r{rsloggingrr-Zapscheduler.eventsrZ!apscheduler.schedulers.backgroundrZapscheduler.jobstores.baserZflaskrZ flask.helpersrr]rutilsr r getLoggerr.objectr rrrrs