g&w&ddlmZddlmZddlZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddl Z ddlZddlmZddlmZddlmZddlmZddlmZdd lmZdd lmZdd lmZdd lmZdd lmZddlmZddlmZddlmZGddeZy)) check_hash)openN)common)config)database)helpers) libraries)logger) mobile_app)notification_handler) notifiers)newsletter_handler) newsletters)plextv)usersceZdZdZddZdZdZdZddZddZ ddZ d Z d Z d Z d Zd ZdZ ddZddZddZdZddZddZdZdZy) API2c |jj|_d|_d|_d|_d|_d|_d|_d|_ d|_ d|_ d|_ d|_ d|_y)NFjsonerror) _api_docskeys_api_valid_methods_api_authenticated _api_out_type_api_msg _api_debug_api_cmd _api_apikey _api_callback_api_result_type_api_response_code_api_profileme _api_kwargs_api_appselfkwargss /opt/Tautulli/plexpy/api2.py__init__z API2.__init__2sv"&.."2"7"7"9"'#  ! '"&" c i}tj|tjD]\}}|jdr|jdr*|durDtjt ||rtjt ||nd||<rtjt ||rhlDGT[TbTbcjkoqrcsTtchhw~~gdA6F'G'M'M'OPz~DG    r+c"|jS)z- Return the api docs formatted with markdown.) _api_make_mdr's r)docs_mdz API2.docs_mdMs  ""r+c"|jS)zL Return the api docs as a dict where commands are keys, docstring are value.)rr>s r)r:z API2.docsRs~~r+cvtjjsd|_d|_ntjj sd|_d|_nt tjj dk7rd|_d|_nd|vrd|_d|_nd |vr+d d j|jz|_d |_ngd |vrc|jd |jvrFd |jd ddd jt|j|_d |_|jdd|_ |jdd|_ |jd d|_|jdd|_|jdd|_|jdd|_d|vr+t%j&|jdrd|_tjjr |jr|jdvr?|j(s/|jtjj k(rd|_n|j(r6t-j.|jr|jdk(rd|_n`|j(rFt-j0|jr't-j2|jd|_nd|_d|_|j*r'|j|jvrd|_||_n/|j*s#|jdvrd|_d|_||_|jr"t7j8d|jzt7j8d|j4z|j4S)z1 Sets class vars and remove unneeded parameters. zAPI not enabledizAPI key not generatedi zAPI key not generated correctlyapikeyzParameter apikey is requiredcmdz4Parameter cmd is required. Possible commands are: %sz, zUnknown command: z. Possible commands are: callbackNdebugF profilemeout_typerappT) get_apikeyr:r?register_devicezInvalid apikeyzTautulli APIv2 :: %s.z$Tautulli APIv2 :: Cleaned kwargs: %s)plexpyCONFIG API_ENABLEDrr"API_KEYlenr7rgetsortedpopr rrrr#rr bool_truer%rr get_temp_device_tokenget_mobile_device_by_token set_last_seenr$r api_debug)r'argsr(s r) _api_validatezAPI2._api_validateWs}}((-DM&)D #&&3DM&)D # && '2 -=DM&)D # V #:DM&)D # & RUYU^U^_c_v_vUwwDM&)D # f_E!2$:Q:Q!QPVPZPZ[`bdPegkgpgpqwx|yPyPrQhRSDM&)D ##ZZ D9!::h5 5$/  **We4$jjd;#ZZ F; F?w00E1BC DM == $ $T]]dmmOp>p==T%5%59N9N%N*.':#C#CDDTDT#UMM%66*.':#H#HIYIY#Z(()9)9:*.'!1 *-'&&4==DzAPI2.get_logs..s AdGr+)keyz/Tautulli APIv2 :: Searching log values for '%s'r0c3FK|]\}}dj||yw)z{}{}N)format).0rlvs r) z API2.get_logs..s%PdafmmAq&9%Ps!)ospathr7rNrOLOG_DIRr FILENAMEintrZrecompileIr readlinesr8stripreplace IndexErrorrRrsanitizeappendrTitemslowersearch)r'rmrorderregexstartendr(logfiletemplogregr;linetemp_loglevel_and_timeloglvltl_treadrdrgtldrlrsttl stringdicts ` r)get_logsz API2.get_logss8'',,v}}44fooFE #h    ORWW X**U"$$/C '3 1 &Q  &)-& -1ZZ-=*3A6<Y!Z!ZBZ2w B ! XX%Paggi%PP ::j)IIaL ! 2wY"g,*BBK&'*:*:4<<b;Q*RR&  & &T[sQ-MBK2M*M-M2AM<;M8M2A M<M?MMM c tjjtjd}tj |Dcgc]A}tjj tjj||r|C}}tjj}i}|jD]\}}t|tr_i} |jD]E\} } | jtjvrd} | dk(s| dk(rt| | | <A| | | <G| ||<|dk(s{|||d<|||d<|r|j!|S|Scc}w)a Gets all settings from the config file. ``` Required parameters: None Optional parameters: key (str): Name of a config section to return Returns: json: {"General": {"api_enabled": true, ...} "Advanced": {"cache_sizemb": "32", ...}, ... } ``` zdata/interfaces/N01General interfaceinterface_list)rurvr7rNPROG_DIRlistdirisdirrO_configr isinstancedictupperr_DO_NOT_DOWNLOAD_KEYSboolrS) r'ro interface_dirnamerconfsettingsrlrsrkkvvs r) get_settingszAPI2.get_settingssG$ V__6HI +-::m+DL4''-- ]D(IJLL}}$$JJL ?DAq!T"ggi#FBxxzV%A%AA!SyB#I $R" "" #  I~+8 K(0> ,- ? <<$ $3LsAEctjjsd|_y|sd|_yt t j tjjs|jnMtdt j tjjDs|jtj}|j|}|S)a Query the Tautulli database with raw SQL. Automatically makes a backup of the database if the latest backup is older then 24h. `api_sql` must be manually enabled in the config file while Tautulli is shut down. ``` Required parameters: query (str): The SQL query Optional parameters: None Returns: None ``` zSQL not enabled for the API.NzNo SQL query provided.c3K|]}tjjtjjtj j |tjdz kDxr|jdyw)iQz.dbN) rurvgetctimer7rNrO BACKUP_DIRreendswith)rrfile_s r)rtzAPI2.sql..Jsma27ww'' V]]5M5Mu(UVZ^ZcZcZehmZmn.u-.asB B ) rNrOAPI_SQLrrRrurr backup_dbanyrMonitorDatabaseselect)r'querydbrowss r)sqlzAPI2.sql,s }}$$:DM 4DM 2::fmm6678 NN a;=::fmmF^F^;_aa  % % 'yy r+cRtj}|r d|_|Sd|_|S)z1 Create a manual backup of the `config.ini` file.successr)r make_backupr!r'datas r) backup_configzAPI2.backup_configRs0!!#-1  8? r+cRtj}|r d|_|Sd|_|S)z0 Create a manual backup of the `plexpy.db` file.rr)rrr!rs r)rzAPI2.backup_dbZs0##%-1  8? r+c 6dt_d|_d|_y)z Restart Tautulli.restartzRestarting TautullirNrNSIGNALrr!r&s r)rz API2.restartbs" - )r+c 6dt_d|_d|_y)z Update Tautulli.updatezUpdating TautullirNrr&s r)rz API2.updateis! + )r+c Rtj}|r d|_|Sd|_|S)z% Refresh the Tautulli libraries list.rr)r refresh_librariesr!r'r(rs r)refresh_libraries_listzAPI2.refresh_libraries_listps.**,-1  8? r+c Rtj}|r d|_|Sd|_|S)z! Refresh the Tautulli users list.rr)r refresh_usersr!rs r)refresh_users_listzAPI2.refresh_users_listws.""$-1  8? r+Nc |sd|_d|_y|sd|_d|_y|rftj|tjtj kDr-dj tj ||_d|_y|r||}tj|||j||||} | rd|_d|_tj|jd tjd } tj} d tjj i} | j#| | j#| | Sd |_d|_y)a Registers the Tautulli Remote App. ``` Required parameters: device_id (str): The unique device identifier for the mobile device device_name (str): The device name of the mobile device Optional parameters: platform (str): The platform of the mobile devices version (str): The version of the app friendly_name (str): A friendly name to identify the mobile device onesignal_id (str): The OneSignal id for the mobile device min_version (str): The minimum Tautulli version supported by the mobile device, e.g. v2.5.6 Returns: json: {"pms_identifier": "08u2phnlkdshf890bhdlksghnljsahgleikjfg9t", "pms_ip": "10.10.10.1", "pms_is_remote": 0, "pms_name": "Winterfell-Server", "pms_platform": "Windows", "pms_plexpass": 1, "pms_port": 32400, "pms_ssl": 0, "pms_url": "http://10.10.10.1:32400", "pms_url_manual": 0, "pms_version": "1.20.0.3133-fede5bdc7" "server_id": "2ce060c87958445d8399a7a0c5663755", "tautulli_install_type": "git", "tautulli_branch": "master", "tautulli_commit": "14b98a32e085d969f010f0249c3d2f660db50880", "tautulli_platform": "Windows", "tautulli_platform_device_name": "Winterfell-PC", "tautulli_platform_linux_distro": "", "tautulli_platform_release": "10", "tautulli_platform_version": "10.0.18362", "tautulli_python_version": "3.8.3" "tautulli_version": "v2.5.6", } ``` z2Device registration failed: no device id provided.rNz4Device registration failed: no device name provided.z\Device registration failed: Tautulli version {} does not meet the minimum requirement of {}.) device_id device_name device_tokenplatformversion friendly_name onesignal_idzDevice registration successful.rT)r) return_info server_idz+Device registration failed: database error.)rr!rversion_to_tuplerRELEASErqr add_mobile_devicerset_temp_device_tokenrget_server_resourcesrNget_tautulli_inforOPMS_UUIDr) r'rrrrrr min_versionr(result plex_servertautullirs r)rMzAPI2.register_device~sJVPDM$+D ! RDM$+D !  W55kBWE]E]^d^l^lEmmKKQ6RXR`R`bmKn M$+D !  -$L-- :E;?;K;K7?6=z)rrTrS)r'headrdocrlrsrs r)r=zAPI2._api_make_md6s$Lnnn% A A JN "D aBQX -D FND   %(**r+c`d}tjttjdj dj dd}tjjrtjjr|tjjk(xr$t|tjj}|rmtjjrtjj}|S|}|tj_ tjj|Sd|_|Stjjrtjj}|S|}|tj_ tjj|S)a Get the apikey. Username and password are required if auth is enabled. Makes and saves the apikey if it does not exist. ``` Required parameters: None Optional parameters: username (str): Your Tautulli username password (str): Your Tautulli password Returns: string: "apikey" ``` Nr`rrBzYAuthentication is enabled, please add the correct username and password to the parameters)hashlibsha224strrandom getrandbitsencode hexdigestrNrO HTTP_USERNAME HTTP_PASSWORDrrQwriter)r'usernamepasswordrrC authenticateds r)rLzAPI2.get_apikeyjs9 F$6$6s$; < C CG LMWWYZ[\^_ == & &6==+F+F$ (C(CCy S[]c]j]j]x]xHyM==((!==00D  "D,2FMM)MM'') !|  }}$$}},, (. % ##% r+c|i}d|||diS)zr Formats the result to a predefined dict so we can change it the to the desired output by _api_out_as response)rrrrk)r' result_typerrds r) _api_respondszAPI2._api_respondss  <D{sDQRRr+cl|jdk(r|ddS|jr#|jjdr|ddS|jdk(r3d|jvridtjj d<|ddS|jd k(r5|ddj d|dd<|ddsd |dd i|dd<|jd k(rd tjj d< |jrtj|ddd}ntj|d}|j2dtjj d<|jdz|zdz}nD|jdk(r5dtjj d< t%j&|d}|j+d S#t$rW}tjdtj zd|_tj |d <d |d<Yd}~ld}~wwxYw#t$r|}tj(dd|_ ||d <d |d<t%j&|d}n3#t$r'}tj(d|zd|z}Yd}~nd}~wwxYwYd}~d}~wwxYw)!z, Formats the response to the desired output r?r r download_pms_image_proxy return_hashz image/jpegz Content-Typeget_geoip_lookuprrrzapplication/json;charset=UTF-8TF)indent sort_keys ensure_ascii)rNzapplication/javascript(z);zTautulli APIv2 :: rxmlzapplication/xml;charset=UTF-8)prettyz,Tautulli APIv2 :: Failed to parse xml resultz=Tautulli APIv2 :: Failed to parse xml result error message %sa? %s error r`)rr4r$cherrypyr headersrSrrrdumpsr Exceptionr api_exception traceback format_excr" xmltodictunparse api_errorr)r'outes r) _api_out_aszAPI2._api_out_ass ==I %z?6* * ]]t}}77 Dz?6* * ]]/ /D$4$44,BC ZZ , .zz*%''++F:,>?G&PQ$V$ ==T444/D""0tt4 <1 0 01 &4,/# ;C Ot44 AtG^G^%.D !&)D # c4 wwy! # 4 8 wwx (+$(?%  I -d6M6M&)D #  " "g -$2I2IS2P&)D #&&&)D ##'#:#:  2 2t?T?TZ^ZgZgnq 2 rsso <  UYUbUbdhdtdtvw!xy*-'??7;H$$4 ;  <$  jj( * #//&bAC   sg:J0!L)0 L&9A"L!!L&) N3M N M;M10M;1M53M;8N:M;;NN)F)rFrFrhrFrr)rF)rFrFNNrFNrF)rFrFrF)rFrFrFrF)rFrF)rNrF)__name__ __module__ __qualname__r*rr?r:r\rrrrrrrrrrMrrr=rLr r%r8rkr+r)rr1s  #  E N^@,\$L**TXIKZx,\,\2+h'RS<#|Wtr+r)hashing_passwordsriorrr1rrurrzrerrr rNrrrrr r r r r rrrrobjectrrkr+r)r?se$)  '% t6 tr+