gs(ddlZddlZddlmZmZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddlmZddlZddlmZmZmZddlmZddlmZddlmZddlZddlZddlZddlZe j@dk\rddl!Z!ddl"Z"dd l"m#Z#dd l"m$Z$dd l"m%Z%dd l"m&Z&dd l"m'Z'ddl"m(Z(ddl"m)Z)ddl"m*Z*ddl"m+Z+ddl"m,Z,ddl"m-Z-ddl"m.Z.ddl"m/Z/ddl"m0Z0ddl"m1Z1ddl"m2Z2ddl"m3Z3ddl"m4Z4ddl"m5Z5ddl"m6Z6ddl"m7Z7ddl"m8Z8ddl"m9Z9dd l"m:Z:dd!l"m;Z;dd"l"mZ>dd$l?m@Z@mAZAmBZBmCZCmDZDmEZEdd%lFmGZGmHZHmIZImJZJdd&lKmLZLmMZMmNZNmOZOmPZPe%jd'k(rdd(l"mRZRne%jd)k(rdd*l"mSZSdaTd+ZUd,ZVGd-d.eWZXGd/d0eWZYy)1N)openBytesIO) urlencode) serve_file serve_fileobjserve_download)NotFound) make_hash)TemplateLookup)activity_pinger)activity_processor)commonconfigdatabase) datafactory)exporter)graphs)helpers) http_handler) libraries) log_reader)logger)newsletter_handler) newsletters) mobile_app)notification_handler) notifiers)plextv)plexivity_import)plexwatch_import) pmsconnect)users) versioncheck) web_socket)webstart)API2)checkedaddtoapiget_ipcreate_https_certificatesbuild_datatables_json sanitize_out)get_session_infoget_session_user_idallow_session_userallow_session_library)AuthController requireAuth member_of check_auth get_jwt_tokenWindows)windowsDarwin)macosc ttjjt t j d}tjjt |t jj}t|gddgtat j}tj}dt jxstj z}t#} tj%|}|j&d||||d|S#t($rN} t+j,d| zt.j0j3j'cYd} ~ Sd} ~ wwxYw) Nzdata/interfaces/unicodeh) directoriesdefault_filters error_handler?) http_root server_name cache_param_sessionz'WebUI :: Mako template render error: %s)TEMPLATE_LOOKUPospathjoinstrplexpyPROG_DIRCONFIG INTERFACEr mako_error_handler HTTP_ROOTrpms_nameCURRENT_VERSIONrRELEASEr2 get_templaterender Exceptionr exceptionmako exceptionshtml_error_template) template_namekwargs interface_dir template_dirrFrGrHrItemplatees /opt/Tautulli/plexpy/webserve.pyserve_templatergVs S%9;MN ww||C $6 8O8OP (l^V_adUe*<>  I""$K//A6>>BK!H>"// >x< Yd(0<4:< < >BQFG224;;==>s(+D E+AE& E+&E+ctjj|}t|j}t j d}i}t}|t|}|j}|j} | j} |j} | jdr|j| } | Vtjj!| } | j"j%dx} || <dd| | ft&j(| <| | f|vr2|j+| | fdj,|}| | dz xx|z cc<|j.}|)zDecorate tracebacks when Mako errors happen. Evil hack: walk the traceback frames, find compiled Mako templates, stuff their (transformed) source into linecache.cache. Nzmemory:Tz # {} line {} in {}: # {})r]r^ RichTracebackiter tracebacksysexc_infosetnexttb_framef_code co_filename tb_lineno startswithgetrd_get_module_info module_source splitlines linecachecacheaddformattb_next)contexterrorrich_tb rich_itertbsource annotatedcur_richfcofilenamelinenolinesinfoextras rfrTrTms< oo++E2GW&&'I  B FI . ? KK XX>>   y )JJx(E}}}55h?+/+=+=+H+H+NNx(-14,I )&!2 x01B;BBHMfqj!U*! ZZ! .& cTeZdZejdZejdZy) BaseRedirectcHtjtjN)cherrypy HTTPRedirectrPrUselfs rfindexzBaseRedirect.indexs##F$4$455rc|rddj|znd}|rdt|znd}tjtj dz|z|z)N/rEstatus)rNrrrrPrU)rargsrarMquerys rfrzBaseRedirect.statussQ'+sSXXd^#+1i''r##F$4$4x$?$$F$NOOrN)__name__ __module__ __qualname__rexposerrrJrrfrrs2 __66__PPrrc`eZdZeZdZejedZ ejee ddZ ejejjee dddZejejjee dedddZejed Zejejjeed Zejed Zejedd Zejejjee dedd Zejee dddZejeddZejedZejeddZejejjee dedZejejjee dedZejejjee dedZejedZejejjeeedddZejejjee deeddZ ejejjee ddZ!ejeddZ"ejee dddZ#ejee deddZ$ejeddZ%ejeddZ&ejedd Z'ejedd!Z(ejejjee dedd"Z)ejejjeed#dd$Z*ejejjeed%dd&Z+ejejjee ddd'Z,ejejjee dedd(Z-ejejjee dedd)Z.ejejjee dedd*Z/ejejjee dedd+Z0ejejjee dedd,Z1ejejjee dedd-Z2ejejjee ded.Z3ejejjee dd/Z4ejed0Z5ejejjeeed1dd2Z6ejejjee dd3Z7ejedd4Z8ejee ddd5Z9ejee dedd6Z:ejedd7Z;ejedd8Zejejjeeedd;Z?ejejjee dedd<Z@ejejjee dedd=ZAejejjee dedd>ZBejejjee dedd?ZCejejjee dedd@ZDejejjee deddAZEejejjee deddBZFejedCZGejejjeeeddDZHejeddEZIejejjeedFddGZJejeddHZKejejjee dedIddJZLejedKZMejejjeeedLZNejejjeeddMZOejejjeeddNZPejejjeeddOZQejejjeeddPZRejejjeeddQZSejejjeeddRZTejejjeeddSZUejejjeeddTZVejejjeeddUZWejejjeeddVZXejejjeeddWZYejejjeeddXZZejedYZ[ejedZZ\ejejjeedd[Z]ejejjee ded\dd]Z^ejee dd^Z_ejee ddd_Z`ejejjee dedd`Zaejejjee deedaZbejejjee deedbZcejejjee dedcZdejejjee deddZeejejjee dedeZfejejjee dddfZgejee ddgZhejedhZiejee dddiZjejee ddjZkejejjee ddkZlejejjee ddlZmejejjee ddmZnejejjee ddnZoejejjee ddoZpejee ddpZqejee ddqZrejee dddrZsejejjee ddsZtejejjee ddtZuejejjee dedduZvejee ddvZwejejjee deddwZxejejjee deddxZyejee dddyZzejejjee deddzZ{ejejjee dedd{Z|ejee ddd|Z}ejejjee ded}Z~ejejjee ddd~Zejejjee ddZejejjee dddZejee dddZejejjee ddZejee ddZejejjee dddZejee ddZejee ddZejejjee dddZejee dddZejejjee deddZejejjee deddZejdiddiejejjee de ddZejejjee ded dZejee dddZejee ddZejejjee dd dZejejjee de d dZejejjee dedZejee deddZejejjee dddZejejjee dedZdZejee ddZejee ddZejee ddZejee dddZejee ddZejee ddZejee dd dZejed dZejeddZejeddZejeddZejeddZejejjee deddZejejjee deddZejejjee dedddZejejjee dedddZejdZed ddZejdZejee dedZejee dedZejee deddZejee deddZejejjee dedZejejjee deddZejejjee deddZejejjee deddZejeddZejejjee dedddZejeddZejee dd dZejejjee deddZejejjee deddZejejjee deddZejejjee ddZejejjee dedddZejejjee deddd„Zejejjee ddÄZejejjee ddĄZejejjee ddńZejejjee dddƄZejejjee ddDŽZejejjee dedȄZejejjee dedɄZejejjee dedʄZejejjeedd˄Zejejjee ded̫d̈́Zejejjee dedΫdτZejejjee deeddЄZejejjee ddфZejejjee de dd҄Zejee dedӫdԄZejdՄZejejjee dedքZejejjee dedׄZejejjeedd؄ZejejjeeddلZejejjee ddڄZejejjee dedۄZejee dd܄Zejejjee dedd݄Zejejjee deddބZejee ddd߄Zejejjee deddZejejjee deddZejejjee dddZejdZejedZejee ddZejee d ddZejee ddZejejjedZejejjedZejejjee dedddZejee d ddZejejjee deddZejejjee de ddZejee dddZejee deddZejejjee deddZejee ddZy( WebInterfacec|tjjttj d|_y)Nzdata/)rLrMrNrOrPrQrbrs rf__init__zWebInterface.__init__s"WW\\#foo*>Hrc tjjr&tjtj dztjtj dz)Nhomewelcome)rPrRFIRST_RUN_COMPLETErrrUrras rfrzWebInterface.indexsI == + +''(8(86(AB B''(8(89(DE Eradminc tjjtjjtjjtjj tjj tjtjjd}tjjr:tjtjtjdztdd|S)N)pms_identifierpms_ippms_portpms_ssl pms_is_cloudrVlogging_ignore_intervalrz welcome.htmlWelcomer`titler)rPrRPMS_IDENTIFIERPMS_IPPMS_PORTPMS_SSL PMS_IS_CLOUDrrVLOGGING_IGNORE_INTERVALrinitialize_schedulerrrrUrgrrars rfrzWebInterface.welcomes%mm::mm** ..}},,"MM66((*'-}}'L'L  == + +  ' ' )''(8(86(AB B!iX^_ _rNc ||tj_||tj_tjj yr)rPrR PMS_TOKEN PMS_CLIENT_IDwrite)rtoken client_idras rfsave_pms_tokenzWebInterface.save_pms_tokens8  &+FMM #  *3FMM ' rget_server_listc r|dk( }|dk( }tj}|j||}|r|Sy)a Get all your servers that are published to Plex.tv. ``` Required parameters: None Optional parameters: None Returns: json: [{"clientIdentifier": "ds48g4r354a8v9byrrtr697g3g79w", "httpsRequired": "0", "ip": "xxx.xxx.xxx.xxx", "label": "Winterfell-Server", "local": "1", "port": "32400", "value": "xxx.xxx.xxx.xxx" }, {...}, {...} ] ``` false) include_cloud all_serversN)r#PlexTVdiscover)rrrraplex_tv servers_lists rfrzWebInterface.discoversT:+g56 &'12 --/''m4?(A    rc Dtjjtjjt j tjj tjjtjjd}tdd|S)N) home_sectionshome_refresh_intervalrVrupdate_show_changelogfirst_run_completez index.htmlHomer) rPrR HOME_SECTIONSHOME_REFRESH_INTERVALrrVrUPDATE_SHOW_CHANGELOGrrgrs rfrzWebInterface.homesi$]]88%+]]%H%H((*"MM66%+]]%H%H"(--"B"B  LvVVrc tjjrtjj}nd}tjjrtjj}nd}||d}|S)aj Get the date and time formats used by Tautulli. ``` Required parameters: None Optional parameters: None Returns: json: {"date_format": "YYYY-MM-DD", "time_format": "HH:mm", } ``` z YYYY-MM-DDzHH:mm) date_format time_format)rPrR DATE_FORMAT TIME_FORMAT)rrarrformatss rfget_date_formatszWebInterface.get_date_formatssZ* == $ $ --33K&K == $ $ --33K!K"-"-/rc tjtjj}|j }|r t d|Stjdt ddS)Nrzcurrent_activity.htmlr`dataz1Unable to retrieve data for get_current_activity.) r& PmsConnectrPrRrget_current_activityrgrwarnrra pms_connectresults rfrz!WebInterface.get_current_activity#sX!++&--2I2IJ 113 !0GfU U KKK L!0GdS Src tjtjj}|j }|r%t fd|dDd}td|StddS)Nrc34K|]}|dk(s |yw session_keyNrJ.0srs rf z=WebInterface.get_current_activity_instance..8s]!Q}=MQ\=\A] sessionszcurrent_activity_instance.html)r`session)r&rrPrRrrrqrg)rrrarrrs ` rfget_current_activity_instancez*WebInterface.get_current_activity_instance0sf!++&--2I2IJ 113 ]vj'9]_cdG!0PZab b!0PZ^_ _rc tj}|j|||}t|trddj |dS|durdddSdddS) a Stop a streaming session. ``` Required parameters: session_key (int): The session key of the session to terminate, OR session_id (str): The session id of the session to terminate Optional parameters: message (str): A custom message to send to the client Returns: None ``` )r session_idmessagerz Failed to terminate session: {}.rrTsuccesszSession terminated.zFailed to terminate session.)r&rterminate_session isinstancerOr~)rrrrrarrs rfrzWebInterface.terminate_session=sl&!++- ..;S]gn.o fc "%2T2[2[\b2cd d t^'4IJ J%2PQ Qrc Ftj|rd}n6tjjxstjj }d|vr*|j tjj}||z|rdt|zndz}tdd|S) Nzhttps://plex.tvz {machine_id}) machine_idrErzxml_shortcut.htmlzPlex XML)r`rurl) r bool_truerPrRPMS_URL_OVERRIDEPMS_URLr~rrrg)rendpointr#rabase_urlrs rf open_plex_xmlzWebInterface.open_plex_xmlZs   V $(H}}55N9N9NH X %&--2N2NOH!S9V+<%?,,. '4OP P%2UV Vrc t|s#tjtjtj j tj jd}|r( tj}|j|}n$tjdtddd|Stdd||S#tjd|ztddd|cYSxYw)N)get_file_sizesget_file_sizes_hold section_idz5Unable to retrieve library details for section_id %s z library.htmlLibrary)r`rrrz2Library page requested but no section_id received.)r5rrrPrUrRGET_FILE_SIZESGET_FILE_SIZES_HOLDrr* get_detailsrrrgdebug)rrQrarrBlibrary_detailss rflibraryzWebInterface.libraryBs%Z0''(8(89 9%mm::#)==#D#D   o(224 ".":":j":"Q LLM N!iVZcij jN)Rajpqq o SV``a%N)Z^gmnns '&C)C,c |r)tj}|j|}d}nd}d}tdd|tj j |S)NrPrAn error occured.zedit_library.htmlz Edit Library)r`rr server_idstatus_message)rr*rUrgrPrRr)rrQrarBrr\s rfedit_library_dialogz WebInterface.edit_library_dialogZs] $..0L!---DFNF0N,?~#)V]]5Q5Qbpr rrc $|jdd}|jdd}|jdd}|jdd}|jdd}|r- tj}|j||||||y y #Yy xYw) a Update a library section on Tautulli. ``` Required parameters: section_id (str): The id of the Plex library section custom_thumb (str): The URL for the custom library thumbnail custom_art (str): The URL for the custom library background art keep_history (int): 0 or 1 Optional parameters: None Returns: None ``` custom_thumbr custom_art do_notifyrdo_notify_created keep_history)rQr_r`rarbrczSuccessfully updated library.zFailed to update library.N)rwrr* set_config) rrQrar_r`rarbrcrBs rf edit_libraryzWebInterface.edit_libraryhs(zz."5 ZZ b1 JJ{A. "JJ':A>zz.!4  3(224 '':5A3=2;:K5A (C7  32s +B Bc t|stdddS|r'tj}|j |}nd}|rtd|dSt j dtdddS)Nuser_watch_time_stats.html Watch Statsr`rrrPz5Unable to retrieve data for library_watch_time_stats.)r5rgrr*get_watch_time_statsrrrrQrarBrs rflibrary_watch_time_statsz%WebInterface.library_watch_time_statss{%Z0!0LSW_lm m $..0L!66*6MFF !0LSYano o KKO P!0LSW_lm mrc t|stdddS|r'tj}|j |}nd}|rtd|dSt j dtdddS)Nlibrary_user_stats.html Player StatsrirPz/Unable to retrieve data for library_user_stats.)r5rgrr*get_user_statsrrrks rflibrary_user_statszWebInterface.library_user_statss{%Z0!0IPT\jk k $..0L!00J0GFF !0IPV^lm m KKI J!0IPT\jk krc t|stdddS|r(tj}|j ||}nd}|rtd|dSt j dtdddS)Nuser_recently_watched.htmlRecently Watchedri)rQlimitz5Unable to retrieve data for library_recently_watched.)r5rgrr*get_recently_watchedrr)rrQrurarBrs rflibrary_recently_watchedz%WebInterface.library_recently_watcheds~%Z0!0LSW_qr r $..0L!66*TY6ZFF !0LSYast t KKO P!0LSW_qr rrc t|stdddS|r(tj}|j ||}nd}|r|drtd|ddSt j dtdddS)Nzlibrary_recently_added.htmlzRecently Addedri)rQrrz3Unable to retrieve data for library_recently_added.)r5rgr&rrrr)rrQrurarrs rflibrary_recently_addedz#WebInterface.library_recently_addeds%Z0!0MTX`pq q $//1K ;;zY^;_FF f-.!0MTZ[kTluEF F KKM N!0MTX`pq qrc |jds-|jddk(rd|d<gd}t||d|d<tj|rd}nd}t j }|j |||||}|S) a Get the data on the Tautulli media info tables. ``` Required parameters: section_id (str): The id of the Plex library section, OR rating_key (str): The grandparent or parent rating key Optional parameters: section_type (str): "movie", "show", "artist", "photo" order_column (str): "added_at", "sort_title", "container", "bitrate", "video_codec", "video_resolution", "video_framerate", "audio_codec", "audio_channels", "file_size", "last_played", "play_count" order_dir (str): "desc" or "asc" start (int): Row to start from, 0 length (int): Number of items to return, 25 search (str): A string to search for, "Thrones" refresh (str): "true" to refresh the media info table Returns: json: {"draw": 1, "last_refreshed": 1678734670, "recordsTotal": 82, "recordsFiltered": 82, "filtered_file_size": 2616760056742, "total_file_size": 2616760056742, "data": [{"added_at": "1403553078", "audio_channels": "", "audio_codec": "", "bitrate": "", "container": "", "file_size": 253660175293, "grandparent_rating_key": "", "last_played": 1462380698, "media_index": "1", "media_type": "show", "parent_media_index": "", "parent_rating_key": "", "play_count": 15, "rating_key": "1219", "section_id": 2, "section_type": "show", "sort_title": "Game of Thrones", "thumb": "/library/metadata/1219/thumb/1436265995", "title": "Game of Thrones", "video_codec": "", "video_framerate": "", "video_resolution": "", "year": "2011" }, {...}, {...} ] } ``` r/ order_columnr sort_title) )added_atTF)r|TT) containerTT)bitrateTT) video_codecTT)video_resolutionTT)video_framerateTT) audio_codecTT)audio_channelsTT file_sizeTFr7TF) play_countTFTF)rQr2 rating_keyrefreshra)rwr0rrrr*get_datatables_media_info) rrQr2rrrarArBrs rfget_library_media_infoz#WebInterface.get_library_media_infos@zz+&zz.)W4)5~& 7J#8 L"YF;    W %GG **, 77:EQCM@G?E 8G  rget_collections_tablec ~|jdsgd}t||d|d<tjdd|i|}|S)a Get the data on the Tautulli collections tables. ``` Required parameters: section_id (str): The id of the Plex library section Optional parameters: None Returns: json: {"draw": 1, "recordsTotal": 5, "data": [...] } ``` r/)) titleSortTT)collectionModeTT)collectionSortTT) childCountTFrrQrJ)rwr0rget_collections_list)rrQrarArs rfrz!WebInterface.get_collections_list:sI2zz+&7J#8 K"XF; //P:PP rget_playlists_tablec |jdsgd}t||d|d<tjd||d|}|S)a Get the data on the Tautulli playlists tables. ``` Required parameters: section_id (str): The section id of the Plex library, OR user_id (str): The user id of the Plex user Optional parameters: None Returns: json: {"draw": 1, "recordsTotal": 5, "data": [...] } ``` r/)rTT) leafCountTT)r;TTr)rQuser_idrJ)rwr0rget_playlists_list)rrQrrarArs rfrzWebInterface.get_playlists_list_sU4zz+&4J#8 G"TF; --86=8068 rc tjj}t|d}t|d}t j |}t j |}|r||vs|r||vr|r|j |n|r|j |t|t|dtj_tj}|j||}|r|j|n|r|j|t|t|dtj_d|iSd}d|iS)N section_ids rating_keys)rr)rQrFr) rPrRrTrpr cast_to_intr}listrr*get_media_info_file_sizesremove) rrQrrarOrrrBrs rfrz&WebInterface.get_media_info_file_sizess,%mm??-m<= -m<= ((4 ((4 :[8jZ_jMj + +@D[@Qbfgrbs0tFMM -$..0L!;;zGQ<SF"":."":.@D[@Qbfgrbs0tFMM -6""F6""rc tj|}|rBtj}|j ||}|r|St j d|St j dy)ae Get a library's details. ``` Required parameters: section_id (str): The id of the Plex library section Optional parameters: include_last_accessed (bool): True to include the last_accessed value for the library. Returns: json: {"child_count": null, "count": 887, "deleted_section": 0, "do_notify": 1, "do_notify_created": 1, "is_active": 1, "keep_history": 1, "last_accessed": 1462693216, "library_art": "/:/resources/movie-fanart.jpg", "library_thumb": "/:/resources/movie.png", "parent_count": null, "row_id": 1, "section_id": 1, "section_name": "Movies", "section_type": "movie", "server_id": "ds48g4r354a8v9byrrtr697g3g79w" } ``` )rQinclude_last_accessedz(Unable to retrieve data for get_library.z5Library details requested but no section_id received.N)rrrr*rUrr)rrQrrarBrWs rf get_libraryzWebInterface.get_libraryslF!( 1 12G H $..0L*66*Mb7dO&& FG&& KKO Prc tj|d}|rCtj}|j |||}|r|St j d|St j dy)a Get a library's watch time statistics. ``` Required parameters: section_id (str): The id of the Plex library section Optional parameters: grouping (int): 0 or 1 query_days (str): Comma separated days, e.g. "1,7,30,0" Returns: json: [{"query_days": 1, "total_plays": 0, "total_time": 0 }, {"query_days": 7, "total_plays": 3, "total_time": 15694 }, {"query_days": 30, "total_plays": 35, "total_time": 63054 }, {"query_days": 0, "total_plays": 508, "total_time": 1183080 } ] ``` Tr<)rQr? query_daysz9Unable to retrieve data for get_library_watch_time_stats.z>Library watch time stats requested but no section_id received.N)rrrr*rjrr)rrQr?rrarBrs rfget_library_watch_time_statsz)WebInterface.get_library_watch_time_statssmH$$X4@ $..0L!66*W_BL7NF  WX KKX Yrc tj|d}|rBtj}|j ||}|r|St j d|St j dy)a/ Get a library's user statistics. ``` Required parameters: section_id (str): The id of the Plex library section Optional parameters: grouping (int): 0 or 1 Returns: json: [{"friendly_name": "Jon Snow", "total_plays": 170, "total_time": 349618, "user_id": 133788, "user_thumb": "https://plex.tv/users/k10w42309cynaopq/avatar", "username": "LordCommanderSnow" }, {"friendly_name": "DanyKhaleesi69", "total_plays": 42, "total_time": 50185, "user_id": 8008135, "user_thumb": "https://plex.tv/users/568gwwoib5t98a3a/avatar", "username: "DanyKhaleesi69" }, {...}, {...} ] ``` Tr<)rQr?z3Unable to retrieve data for get_library_user_stats.z8Library user stats requested but no section_id received.N)rrrr*rprr)rrQr?rarBrs rfget_library_user_statsz#WebInterface.get_library_user_statsseF$$X4@ $..0L!00JQY0ZF  QR KKR Src |r|s|r5tj}|j|||d}|rdddSdddSdddS) a Delete all Tautulli history for a specific library. ``` Required parameters: server_id (str): The Plex server identifier of the library section section_id (str): The id of the Plex library section Optional parameters: row_ids (str): Comma separated row ids to delete, e.g. "2,3,8" Returns: None ``` T)r[rQrow_ids purge_onlyrzDeleted library history.rrz$Failed to delete library(s) history.0No server id and section id or row ids received.rr*deleterr[rQrrarBrs rfdelete_all_library_historyz'WebInterface.delete_all_library_history8s[& *$..0L"))I*^erv)wG"+8RSS")6\]]%2de erc |r|s|r4tj}|j|||}|rdddSdddSdddS)a Delete a library section from Tautulli. Also erases all history for the library. ``` Required parameters: server_id (str): The Plex server identifier of the library section section_id (str): The id of the Plex library section Optional parameters: row_ids (str): Comma separated row ids to delete, e.g. "2,3,8" Returns: None ``` )r[rQrrzDeleted library.rrzFailed to delete library(s).rrrs rfdelete_libraryzWebInterface.delete_libraryUsX& *$..0L"))I*^e)fG"+8JKK")6TUU%2de erc tj}|j||}|r|rd|z}n|rd|z}ddzdSdddS) at Restore a deleted library section to Tautulli. ``` Required parameters: section_id (str): The id of the Plex library section section_name (str): The name of the Plex library section Optional parameters: None Returns: None ``` )rQr1z section_id %szsection_name %srzRe-added library with %s.rrz=Unable to re-add library. Invalid section_id or section_name.)rr*undelete)rrQr1rarBrmsgs rfundelete_libraryzWebInterface.undelete_libraryrsb&!**, &&*<&X $z1',6'4ORU4UV V!.mnnrc tjj}t|d}||vr3|r,t j }|j |}|rd|iSddiSyddiS)a2 Delete the media info table cache for a specific library. ``` Required parameters: section_id (str): The id of the Plex library section Optional parameters: None Returns: None ``` rrPrno data receivedz8Cannot delete media info cache while getting file sizes.N)rPrRrTrprr*delete_media_info_cache)rrQrarOrrB delete_rows rfrz$WebInterface.delete_media_info_caches}$%mm??-m<= [ ((224 )AAZAX %z22!#566 YZ Zrc ^tj}|j}|rd|iSddiS)Nrz7Unable to delete duplicate libraries from the database.)rr*delete_duplicate_librariesrHs rfrz'WebInterface.delete_duplicate_librariess:!**, 88: v& &XY Yrc tddS)Nz users.htmlUsersr+r,rs rfr'zWebInterface.userssLHHrget_users_tablec |jdsgd}t||d|d<tj|d}t j }|j ||}|S)ap Get the data on Tautulli users table. ``` Required parameters: None Optional parameters: grouping (int): 0 or 1 order_column (str): "user_thumb", "friendly_name", "last_seen", "ip_address", "platform", "player", "last_played", "plays", "duration" order_dir (str): "desc" or "asc" start (int): Row to start from, 0 length (int): Number of items to return, 25 search (str): A string to search for, "Jon Snow" Returns: json: {"draw": 1, "recordsTotal": 10, "recordsFiltered": 10, "data": [{"allow_guest": 1, "do_notify": 1, "duration": 2998290, "email": "Jon.Snow.1337@CastleBlack.com", "friendly_name": "Jon Snow", "guid": "com.plexapp.agents.thetvdb://121361/6/1?lang=en", "history_row_id": 1121, "ip_address": "xxx.xxx.xxx.xxx", "is_active": 1, "keep_history": 1, "last_played": "Game of Thrones - The Red Woman", "last_seen": 1462591869, "live": 0, "media_index": 1, "media_type": "episode", "originally_available_at": "2016-04-24", "parent_media_index": 6, "parent_title": "", "platform": "Chrome", "player": "Plex Web (Chrome)", "plays": 487, "rating_key": 153037, "row_id": 1, "thumb": "/library/metadata/153036/thumb/1462175062", "title": "Jon Snow", "transcode_decision": "transcode", "user_id": 133788, "user_thumb": "https://plex.tv/users/568gwwoib5t98a3a/avatar", "username": "LordCommanderSnow", "year": 2016 }, {...}, {...} ] } ``` r/) ) user_thumbFF friendly_nameTT)usernameTTr)emailTT last_seenTF ip_addressTTplatformTTplayerTTrr8r:rTr<r>)rwr0rrr'rr@)rr?rarA user_data user_lists rf get_user_listzWebInterface.get_user_listseDzz+& 5J#8 O"\F; $$X4@KKM 11(1S rc ltjdtj}|rdddSdddS)z" Manually refresh the users list. z$Manual users list refresh requested.rzUsers list refreshed.rrzUnable to refresh users list.)rrr' refresh_usersr%s rfrefresh_users_listzWebInterface.refresh_users_lists:  :;$$& '4KL L%2QR Rrc nt|s#tjtj|r( t j }|j|}n#tjdtdddStdd|S#tjd|ztdddcYSxYw)Nrz/Unable to retrieve user details for user_id %s z user.htmlUserr z,User page requested but no user_id received.) r4rrrPrUr'rrUrrrgrV)rrrar user_detailss rfuserzWebInterface.user*s"'*''(8(89 9  Z!KKM (44W4E LLG H! 6PTU UKvLYY Z MPWWX%KvTXYYs &B (B4c ~|r)tj}|j|}d}nd}d}tdd||S)NrrrZzedit_user.htmlz Edit User)r`rrr\)r'rrUrg)rrrrarrr\s rfedit_user_dialogzWebInterface.edit_user_dialog=sH  I**7*;FNF0N,/82>1< %> ">%%  &!9%%s .BBc t|stdddS|s|r'tj}|j |}nd}|rtd|dSt j dtdddS)Nrgrhrirz2Unable to retrieve data for user_watch_time_stats.)r4rgr'rrjrrrrrrarrs rfuser_watch_time_statsz"WebInterface.user_watch_time_statstsz"'*!0LSW_lm m d I33G3DFF !0LSYano o KKL M!0LSW_lm mrc t|stdddS|s|r'tj}|j |}nd}|rtd|dSt j dtdddS)Nzuser_player_stats.htmlrorirz.Unable to retrieve data for user_player_stats.)r4rgr'rget_player_statsrrrs rfuser_player_statszWebInterface.user_player_statssw"'*!0Ht[ij j d I///@FF !0Hv]kl l KKH I!0Ht[ij jrc t|stdddS|s|r(tj}|j ||}nd}|rtd|dSt j dtdddS)Nrsrtri)rruz6Unable to retrieve data for get_user_recently_watched.)r4rgr'rrvrr)rrrrurarrs rfget_user_recently_watchedz&WebInterface.get_user_recently_watcheds|"'*!0LSW_qr r d I33G53QFF !0LSYast t KKP Q!0LSW_qr rrc |jdsgd}t||d|d<tj}|j ||}|S)a Get the data on Tautulli users IP table. ``` Required parameters: user_id (str): The id of the Plex user Optional parameters: order_column (str): "last_seen", "first_seen", "ip_address", "platform", "player", "last_played", "play_count" order_dir (str): "desc" or "asc" start (int): Row to start from, 0 length (int): Number of items to return, 25 search (str): A string to search for, "xxx.xxx.xxx.xxx" Returns: json: {"draw": 1, "recordsTotal": 2344, "recordsFiltered": 10, "data": [{"friendly_name": "Jon Snow", "guid": "com.plexapp.agents.thetvdb://121361/6/1?lang=en", "id": 1121, "ip_address": "xxx.xxx.xxx.xxx", "last_played": "Game of Thrones - The Red Woman", "last_seen": 1462591869, "first_seen": 1583968210, "live": 0, "media_index": 1, "media_type": "episode", "originally_available_at": "2016-04-24", "parent_media_index": 6, "parent_title": "", "platform": "Chrome", "play_count": 149, "player": "Plex Web (Chrome)", "rating_key": 153037, "thumb": "/library/metadata/153036/thumb/1462175062", "transcode_decision": "transcode", "user_id": 133788, "year": 2016 }, {...}, {...} ] } ``` r/)r) first_seenTFrrrr6)rTTr)rra)rwr0r'rget_datatables_unique_ips)rrrarArhistorys rf get_user_ipszWebInterface.get_user_ipssRpzz+&6J#8 K"XF; KKM 55gf5Urc |jdsgd}t||d|d<t}tj}|j |||}|S)a Get the data on Tautulli user login table. ``` Required parameters: user_id (str): The id of the Plex user Optional parameters: order_column (str): "date", "time", "ip_address", "host", "os", "browser" order_dir (str): "desc" or "asc" start (int): Row to start from, 0 length (int): Number of items to return, 25 search (str): A string to search for, "xxx.xxx.xxx.xxx" Returns: json: {"draw": 1, "recordsTotal": 2344, "recordsFiltered": 10, "data": [{"browser": "Safari 7.0.3", "current": false, "expiry": "2021-06-30 18:48:03", "friendly_name": "Jon Snow", "host": "http://plexpy.castleblack.com", "ip_address": "xxx.xxx.xxx.xxx", "os": "Mac OS X", "row_id": 1, "timestamp": 1462591869, "user": "LordCommanderSnow", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_3) AppleWebKit/537.75.14 (KHTML, like Gecko) Version/7.0.3 Safari/7046A194A", "user_group": "guest", "user_id": 133788 }, {...}, {...} ] } ``` r/) timestampTFr)hostTT)rLTT)browserTTr)r jwt_tokenra)rwr0r:r'rget_datatables_user_login)rrrarArrrs rfget_user_loginszWebInterface.get_user_loginssd^zz+&3J #8 K"XF; !O KKM 55g@I=C6Erc ftj}|j|}|rdddSdddS)a& Logout Tautulli user sessions. ``` Required parameters: row_ids (str): Comma separated row ids to sign out, e.g. "2,3,8" Optional parameters: None Returns: None ``` rrzUsers session logged out.rrzUnable to logout user session.)r'rclear_user_login_token)rrrarrs rflogout_user_sessionz WebInterface.logout_user_session3s=$KKM 11'1B '4OP P%2RS Src tj|}|rBtj}|j ||}|r|St j d|St j dy)a Get a user's details. ``` Required parameters: user_id (str): The id of the Plex user Optional parameters: include_last_seen (bool): True to include the last_seen value for the user. Returns: json: {"allow_guest": 1, "deleted_user": 0, "do_notify": 1, "email": "Jon.Snow.1337@CastleBlack.com", "friendly_name": "Jon Snow", "is_active": 1, "is_admin": 0, "is_allow_sync": 1, "is_home_user": 1, "is_restricted": 0, "keep_history": 1, "last_seen": 1462591869, "row_id": 1, "shared_libraries": ["10", "1", "4", "5", "15", "20", "2"], "user_id": 133788, "user_thumb": "https://plex.tv/users/k10w42309cynaopq/avatar", "username": "LordCommanderSnow" } ``` )rinclude_last_seenz%Unable to retrieve data for get_user.z/User details requested but no user_id received.N)rrr'rrUrr)rrrrarrs rfget_userzWebInterface.get_userMsiH$--.?@  I$00CT1VL## CD## KKI Jrc tj|d}|rCtj}|j |||}|r|St j d|St j dy)a Get a user's watch time statistics. ``` Required parameters: user_id (str): The id of the Plex user Optional parameters: grouping (int): 0 or 1 query_days (str): Comma separated days, e.g. "1,7,30,0" Returns: json: [{"query_days": 1, "total_plays": 0, "total_time": 0 }, {"query_days": 7, "total_plays": 3, "total_time": 15694 }, {"query_days": 30, "total_plays": 35, "total_time": 63054 }, {"query_days": 0, "total_plays": 508, "total_time": 1183080 } ] ``` Tr<)rr?rz6Unable to retrieve data for get_user_watch_time_stats.8User watch time stats requested but no user_id received.N)rrr'rrjrr)rrr?rrarrs rfget_user_watch_time_statsz&WebInterface.get_user_watch_time_stats~sdH$$X4@  I33Ghcm3nF  TU KKR Src tj|d}|rBtj}|j ||}|r|St j d|St j dy)a Get a user's player statistics. ``` Required parameters: user_id (str): The id of the Plex user Optional parameters: grouping (int): 0 or 1 Returns: json: [{"platform": "Chrome", "platform_name": "chrome", "player_name": "Plex Web (Chrome)", "result_id": 1, "total_plays": 170, "total_time": 349618 }, {"platform": "Chromecast", "platform_name": "chromecast", "player_name": "Chromecast", "result_id": 2, "total_plays": 42, "total_time": 50185 }, {...}, {...} ] ``` Tr<)rr?z2Unable to retrieve data for get_user_player_stats.rN)rrr'rrrr)rrr?rarrs rfget_user_player_statsz"WebInterface.get_user_player_statssaF$$X4@  I//(/SF  PQ KKR Src ||s|r4tj}|j||d}|rdddSdddSdddS) aa Delete all Tautulli history for a specific user. ``` Required parameters: user_id (str): The id of the Plex user Optional parameters: row_ids (str): Comma separated row ids to delete, e.g. "2,3,8" Returns: None ``` T)rrrrzDeleted user history.rrz!Failed to delete user(s) history.No user id or row ids received.r'rrrrrrarrs rfdelete_all_user_historyz$WebInterface.delete_all_user_historysS$ g I&&wTX&YG"+8OPP")6YZZ%2ST Trc z|s|r3tj}|j||}|rdddSdddSdddS)as Delete a user from Tautulli. Also erases all history for the user. ``` Required parameters: user_id (str): The id of the Plex user Optional parameters: row_ids (str): Comma separated row ids to delete, e.g. "2,3,8" Returns: None ``` )rrrz Deleted user.rrzFailed to delete user(s).rrrs rf delete_userzWebInterface.delete_usersO$ g I&&w&HG"+HH")6QRR%2ST Trc tj}|j||}|r|rd|z}n|rd|z}ddzdSdddS) aW Restore a deleted user to Tautulli. ``` Required parameters: user_id (str): The id of the Plex user username (str): The username of the Plex user Optional parameters: None Returns: None ``` )rrz user_id %sz username %srzRe-added user with %s.rrz3Unable to re-add user. Invalid user_id or username.)r'rr)rrrrarrrs rf undelete_userzWebInterface.undelete_users^&KKM ##Gh#G !G+#h.'4Ls4RS S!.cddrc Bdtji}tdd|S)Ndatabase_is_importingz history.htmlHistoryr)r IS_IMPORTINGrgrs rfrzWebInterface.history7s( $X%:%: N)TZ[[rc |jdsgd}t||d|d<tj|d}tj|d}g}|r+tj|}|r@|j d|gn,|r*tj|}|r|j d|gd|vr|jd d vr|jdrt j}|j|jd|jd  } | d D cgc]} | d } } |j d | g|j d| g|j d| gn:tj|jdd} | r|j d| gd|vr:tj|jdd} | r|j d| gd|vr:tj|jdd} | r|j d| gd|vr:tj|jdd} | r|j d| gd|vr:tj|jdd}|r|j d|gd|vr:tj|jdd}|r|j d|gd|vr:tj|jdd}|r|j d|gd|vr:tj|jdd}|r|j d|gd |vr>tj|jd d}|rd |vr|j d!|gd"|vr>tj|jd"d}|rd |vr|j d#|gd$|vr`tj|jd$djd%d&}|r'|j d'|Dcgc] }d(|zd)z c}gtj}|j||||*}|Scc} wcc}w)+a Get the Tautulli history. ``` Required parameters: None Optional parameters: grouping (int): 0 or 1 include_activity (int): 0 or 1 user (str): "Jon Snow" user_id (int): 133788 rating_key (int): 4348 parent_rating_key (int): 544 grandparent_rating_key (int): 351 start_date (str): History for the exact date, "YYYY-MM-DD" before (str): History before and including the date, "YYYY-MM-DD" after (str): History after and including the date, "YYYY-MM-DD" section_id (int): 2 media_type (str): "movie", "episode", "track", "live", "collection", "playlist" transcode_decision (str): "direct play", "copy", "transcode", guid (str): Plex guid for an item, e.g. "com.plexapp.agents.thetvdb://121361/6/1" order_column (str): "date", "friendly_name", "ip_address", "platform", "player", "full_title", "started", "paused_counter", "stopped", "duration" order_dir (str): "desc" or "asc" start (int): Row to start from, 0 length (int): Number of items to return, 25 search (str): A string to search for, "Thrones" Returns: json: {"draw": 1, "recordsTotal": 1000, "recordsFiltered": 250, "total_duration": "42 days 5 hrs 18 mins", "filter_duration": "10 hrs 12 mins", "data": [{"date": 1462687607, "friendly_name": "Mother of Dragons", "full_title": "Game of Thrones - The Red Woman", "grandparent_rating_key": 351, "grandparent_title": "Game of Thrones", "original_title": "", "group_count": 1, "group_ids": "1124", "guid": "com.plexapp.agents.thetvdb://121361/6/1?lang=en", "ip_address": "xxx.xxx.xxx.xxx", "live": 0, "location": "wan", "machine_id": "lmd93nkn12k29j2lnm", "media_index": 17, "media_type": "episode", "originally_available_at": "2016-04-24", "parent_media_index": 7, "parent_rating_key": 544, "parent_title": "", "paused_counter": 0, "percent_complete": 84, "platform": "Windows", "play_duration": 263, "product": "Plex for Windows", "player": "Castle-PC", "rating_key": 4348, "reference_id": 1123, "relayed": 0, "row_id": 1124, "secure": 1, "session_key": null, "started": 1462688107, "state": null, "stopped": 1462688370, "thumb": "/library/metadata/4348/thumb/1462414561", "title": "The Red Woman", "transcode_decision": "transcode", "user": "DanyKhaleesi69", "user_id": 8008135, "watched_status": 0, "year": 2016 }, {...}, {...} ] } ``` r/) )dateTFrrr)productTTr) full_titleTT)startedTF)paused_counterTF)stoppedTFr:)watched_statusFFr Tr<zsession_history.user_idzsession_history.userrr) collectionplaylistrr children_listz&session_history_metadata.rating_key ORz-session_history_metadata.parent_rating_key ORz2session_history_metadata.grandparent_rating_key ORrzsession_history.rating_keyparent_rating_keyz!session_history.parent_rating_keygrandparent_rating_keyz&session_history.grandparent_rating_key start_datezAstrftime('%Y-%m-%d', datetime(started, 'unixepoch', 'localtime'))beforezCstrftime('%Y-%m-%d', datetime(started, 'unixepoch', 'localtime')) <afterzCstrftime('%Y-%m-%d', datetime(started, 'unixepoch', 'localtime')) > reference_idzsession_history.reference_idrQzsession_history.section_idallmedia_type_livetranscode_decisionz-session_history_media_info.transcode_decisionguidrErzsession_history_metadata.guidzLIKE %)ra custom_wherer?include_activity)rwr0rr split_stripappendr&rget_item_childrenpopsplitrr get_datatables_history)rrrr?r$rarAr#rrchildrrrrrrrQrr r!gr rs rf get_historyzWebInterface.get_history@sexzz+& $HI &&t,D##%;T$BC 6 !zz,'+EE&**UaJb(335 $66&**\BZgmgqgqr~g6A@F@WXuu\2X X##%M{$[\##%TVa$bc##%Y[f$gh$00L"1MN  '')Ez(RS & ( ,,VZZ8KR-PQJ##%H*$UV #v - ,,VZZ8PRT-UVJ##%Mz$Z[ 6 ! ,,VZZ b-IJJ##%hjt$uv v ((Hb)ABF##%jlr$st f '' 7B(?@E##%jlq$rs V #"..vzz."/MNL##%C\$RS 6 ! ,,VZZ b-IJJ##%A:$NO 6 ! ,,VZZ b-IJJe:5##%6 $CD 6 )!(!4!4VZZ@TVX5Y!Z !e3E&E##%TVh$ij V &&vzz&"'='C'CC'H'KLD##%DbfFg]^wQR{UXGXFg$hi"..0 55VR^?GZj6lkY^Ghs # Q*(Q/ c ltj}|j||}tdd||S)Nzstream_data.htmlz Stream Data)r`rrr)rr get_stream_detailsrg)rrow_idrrrar  stream_datas rfget_stream_datazWebInterface.get_stream_datas8#..0 "55fkJ ,>mZelpqqrr2c dd|vr|d}tj}|j||}|S)an Get the stream details from history or current stream. ``` Required parameters: row_id (int): The row ID number for the history item, OR session_key (int): The session key of the current stream Optional parameters: None Returns: json: {"aspect_ratio": "2.35", "audio_bitrate": 231, "audio_channels": 6, "audio_language": "English", "audio_language_code": "eng", "audio_codec": "aac", "audio_decision": "transcode", "bitrate": 2731, "container": "mp4", "current_session": "", "grandparent_title": "", "media_type": "movie", "optimized_version": "", "optimized_version_profile": "", "optimized_version_title": "", "original_title": "", "pre_tautulli": "", "quality_profile": "1.5 Mbps 480p", "stream_audio_bitrate": 203, "stream_audio_channels": 2, "stream_audio_language": "English", "stream_audio_language_code", "eng", "stream_audio_codec": "aac", "stream_audio_decision": "transcode", "stream_bitrate": 730, "stream_container": "mkv", "stream_container_decision": "transcode", "stream_subtitle_codec": "", "stream_subtitle_decision": "", "stream_video_bitrate": 527, "stream_video_codec": "h264", "stream_video_decision": "transcode", "stream_video_dynamic_range": "SDR", "stream_video_framerate": "24p", "stream_video_height": 306, "stream_video_resolution": "SD", "stream_video_width": 720, "subtitle_codec": "", "subtitles": "", "synced_version": "", "synced_version_profile": "", "title": "Frozen", "transcode_hw_decoding": "", "transcode_hw_encoding": "", "video_bitrate": 2500, "video_codec": "h264", "video_decision": "transcode", "video_dynamic_range": "SDR", "video_framerate": "24p", "video_height": 816, "video_resolution": "1080", "video_width": 1920 } ``` id)rr r/)rr0rrar r1s rfget_stream_data_apiz WebInterface.get_stream_data_apis;R 6>D\F"..0 "55fkJ rc ztj|sd}tj|}tdd|||S)Nzip_address_modal.htmlzIP Address Details)r`rrpublicra)r is_valid_ip is_public_iprg)rrrar7s rfget_ip_address_detailsz#WebInterface.get_ip_address_detailsMsC"":.J%%j1,CK_#-fVM Mrdelete_historyc |tj}|r"tj|}|rdddSdddSdddS)a0 Delete history rows from Tautulli. ``` Required parameters: row_ids (str): Comma separated row ids to delete, e.g. "65,110,2,3645" Optional parameters: None Returns: None ``` rrzDeleted history.rrzFailed to delete history.zNo row ids received.)rr rdelete_session_history_rows)rrrar rs rfdelete_history_rowsz WebInterface.delete_history_rowsXsL$#..0 ::7KG"+8JKK")6QRR%2HI Irc tddS)Nz graphs.htmlGraphsr+r,rs rfrzWebInterface.graphsysMJJrc Rtj}|j|}|S)a Get a list of all user and user ids. ``` Required parameters: None Optional parameters: None Returns: json: [{"friendly_name": "Jon Snow", "user_id": 133788}, {"friendly_name": "DanyKhaleesi69", "user_id": 8008135}, {"friendly_name": "Tyrion Lannister", "user_id": 696969}, {...}, ] ``` ra)r'rget_user_names)rrar user_namess rfrCzWebInterface.get_user_names~s(0KKM --V-< rc tj|d}tj}|j ||||}|r|St j d|S)as Get graph data by date. ``` Required parameters: None Optional parameters: time_range (str): The number of days of data to return y_axis (str): "plays" or "duration" user_id (str): Comma separated list of user id to filter the data grouping (int): 0 or 1 Returns: json: {"categories": ["YYYY-MM-DD", "YYYY-MM-DD", ...] "series": [{"name": "Movies", "data": [...]} {"name": "TV", "data": [...]}, {"name": "Music", "data": [...]}, {"name": "Live TV", "data": [...]} ] } ``` Tr<ry_axisrr?z.Unable to retrieve data for get_plays_by_date.)rrrr@get_total_plays_per_dayrrrrrrGr?ragraphrs rfget_plays_by_datezWebInterface.get_plays_by_dates^<$$X4@ ..*6<7>8@/B M KKH IMrc tj|d}tj}|j ||||}|r|St j d|S)a Get graph data by day of the week. ``` Required parameters: None Optional parameters: time_range (str): The number of days of data to return y_axis (str): "plays" or "duration" user_id (str): Comma separated list of user id to filter the data grouping (int): 0 or 1 Returns: json: {"categories": ["Sunday", "Monday", "Tuesday", ..., "Saturday"] "series": [{"name": "Movies", "data": [...]} {"name": "TV", "data": [...]}, {"name": "Music", "data": [...]}, {"name": "Live TV", "data": [...]} ] } ``` Tr<rFz3Unable to retrieve data for get_plays_by_dayofweek.)rrrr@get_total_plays_per_dayofweekrrrIs rfget_plays_by_dayofweekz#WebInterface.get_plays_by_dayofweek^<$$X4@ 44 F5H M KKM NMrc tj|d}tj}|j ||||}|r|St j d|S)az Get graph data by hour of the day. ``` Required parameters: None Optional parameters: time_range (str): The number of days of data to return y_axis (str): "plays" or "duration" user_id (str): Comma separated list of user id to filter the data grouping (int): 0 or 1 Returns: json: {"categories": ["00", "01", "02", ..., "23"] "series": [{"name": "Movies", "data": [...]} {"name": "TV", "data": [...]}, {"name": "Music", "data": [...]}, {"name": "Live TV", "data": [...]} ] } ``` Tr<rFz3Unable to retrieve data for get_plays_by_hourofday.)rrrr@get_total_plays_per_hourofdayrrrIs rfget_plays_by_hourofdayz#WebInterface.get_plays_by_hourofdayrOrc tj|d}tj}|j ||||}|r|St j d|S)a~ Get graph data by month. ``` Required parameters: None Optional parameters: time_range (str): The number of months of data to return y_axis (str): "plays" or "duration" user_id (str): Comma separated list of user id to filter the data grouping (int): 0 or 1 Returns: json: {"categories": ["Jan 2016", "Feb 2016", "Mar 2016", ...] "series": [{"name": "Movies", "data": [...]} {"name": "TV", "data": [...]}, {"name": "Music", "data": [...]}, {"name": "Live TV", "data": [...]} ] } ``` Tr<rFz0Unable to retrieve data for get_plays_per_month.)rrrr@get_total_plays_per_monthrrrrrGrr?rarJrs rfget_plays_per_monthz WebInterface.get_plays_per_month s^<$$X4@ 00J8>9@:B1D M KKJ KMrc tj|d}tj}|j ||||}|r|St j d|S)a Get graph data by top 10 platforms. ``` Required parameters: None Optional parameters: time_range (str): The number of days of data to return y_axis (str): "plays" or "duration" user_id (str): Comma separated list of user id to filter the data grouping (int): 0 or 1 Returns: json: {"categories": ["iOS", "Android", "Chrome", ...] "series": [{"name": "Movies", "data": [...]} {"name": "TV", "data": [...]}, {"name": "Music", "data": [...]}, {"name": "Live TV", "data": [...]} ] } ``` Tr<rFz:Unable to retrieve data for get_plays_by_top_10_platforms.)rrrr@#get_total_plays_by_top_10_platformsrrrUs rfget_plays_by_top_10_platformsz*WebInterface.get_plays_by_top_10_platformsK s^<$$X4@ ::jBHCJDL;N M KKT UMrc tj|d}tj}|j ||||}|r|St j d|S)a Get graph data by top 10 users. ``` Required parameters: None Optional parameters: time_range (str): The number of days of data to return y_axis (str): "plays" or "duration" user_id (str): Comma separated list of user id to filter the data grouping (int): 0 or 1 Returns: json: {"categories": ["Jon Snow", "DanyKhaleesi69", "A Girl", ...] "series": [{"name": "Movies", "data": [...]} {"name": "TV", "data": [...]}, {"name": "Music", "data": [...]}, {"name": "Live TV", "data": [...]} ] } ``` Tr<rFz6Unable to retrieve data for get_plays_by_top_10_users.)rrrr@get_total_plays_by_top_10_usersrrrUs rfget_plays_by_top_10_usersz&WebInterface.get_plays_by_top_10_usersw s^<$$X4@ 66*>D?F@H7J M KKP QMrc tj|d}tj}|j ||||}|r|St j d|S)aY Get graph data by stream type by date. ``` Required parameters: None Optional parameters: time_range (str): The number of days of data to return y_axis (str): "plays" or "duration" user_id (str): Comma separated list of user id to filter the data grouping (int): 0 or 1 Returns: json: {"categories": ["YYYY-MM-DD", "YYYY-MM-DD", ...] "series": [{"name": "Direct Play", "data": [...]} {"name": "Direct Stream", "data": [...]}, {"name": "Transcode", "data": [...]} ] } ``` Tr<rFz5Unable to retrieve data for get_plays_by_stream_type.)rrrr@get_total_plays_per_stream_typerrrUs rfget_plays_by_stream_typez%WebInterface.get_plays_by_stream_type s^:$$X4@ 66*>D?F@H7J M KKO PMrc tj}|j||}|r|Stjd|S)aQ Get graph data for concurrent streams by stream type by date. ``` Required parameters: None Optional parameters: time_range (str): The number of days of data to return user_id (str): Comma separated list of user id to filter the data Returns: json: {"categories": ["YYYY-MM-DD", "YYYY-MM-DD", ...] "series": [{"name": "Direct Play", "data": [...]} {"name": "Direct Stream", "data": [...]}, {"name": "Transcode", "data": [...]}, {"name": "Max. Concurrent Streams", "data": [...]} ] } ``` )rrzBUnable to retrieve data for get_concurrent_streams_by_stream_type.)rr@,get_total_concurrent_streams_per_stream_typerr)rrrrarJrs rf%get_concurrent_streams_by_stream_typez2WebInterface.get_concurrent_streams_by_stream_type s?: CCzcjCk M KK\ ]Mrc tj|d}tj}|j ||||}|r|St j d|S)aP Get graph data by source resolution. ``` Required parameters: None Optional parameters: time_range (str): The number of days of data to return y_axis (str): "plays" or "duration" user_id (str): Comma separated list of user id to filter the data grouping (int): 0 or 1 Returns: json: {"categories": ["720", "1080", "sd", ...] "series": [{"name": "Direct Play", "data": [...]} {"name": "Direct Stream", "data": [...]}, {"name": "Transcode", "data": [...]} ] } ``` Tr<rFz;Unable to retrieve data for get_plays_by_source_resolution.)rrrr@$get_total_plays_by_source_resolutionrrrUs rfget_plays_by_source_resolutionz+WebInterface.get_plays_by_source_resolution ^:$$X4@ ;;zCIDKEM<O M KKU VMrc tj|d}tj}|j ||||}|r|St j d|S)aP Get graph data by stream resolution. ``` Required parameters: None Optional parameters: time_range (str): The number of days of data to return y_axis (str): "plays" or "duration" user_id (str): Comma separated list of user id to filter the data grouping (int): 0 or 1 Returns: json: {"categories": ["720", "1080", "sd", ...] "series": [{"name": "Direct Play", "data": [...]} {"name": "Direct Stream", "data": [...]}, {"name": "Transcode", "data": [...]} ] } ``` Tr<rFz;Unable to retrieve data for get_plays_by_stream_resolution.)rrrr@$get_total_plays_by_stream_resolutionrrrUs rfget_plays_by_stream_resolutionz+WebInterface.get_plays_by_stream_resolution rfrc tj|d}tj}|j ||||}|r|St j d|S)al Get graph data by stream type by top 10 users. ``` Required parameters: None Optional parameters: time_range (str): The number of days of data to return y_axis (str): "plays" or "duration" user_id (str): Comma separated list of user id to filter the data grouping (int): 0 or 1 Returns: json: {"categories": ["Jon Snow", "DanyKhaleesi69", "A Girl", ...] "series": [{"name": "Direct Play", "data": [...]} {"name": "Direct Stream", "data": [...]}, {"name": "Transcode", "data": [...]} ] } ``` Tr<rFzD?F@H7J M KKV WMrc tj|d}tj}|j ||||}|r|St j d|S)ae Get graph data by stream type by top 10 platforms. ``` Required parameters: None Optional parameters: time_range (str): The number of days of data to return y_axis (str): "plays" or "duration" user_id (str): Comma separated list of user id to filter the data grouping (int): 0 or 1 Returns: json: {"categories": ["iOS", "Android", "Chrome", ...] "series": [{"name": "Direct Play", "data": [...]} {"name": "Direct Stream", "data": [...]}, {"name": "Transcode", "data": [...]} ] } ``` Tr<rFz@Unable to retrieve data for get_stream_type_by_top_10_platforms.)rrrr@#get_stream_type_by_top_10_platformsrrrUs rfrmz0WebInterface.get_stream_type_by_top_10_platformsu s^:$$X4@ ::jBHCJDL;N M KKZ [Mrc x|jdrt|dstdddStdd|S)Nrzhistory_table_modal.htmlz History Datar )rwr4rgrs rfhistory_table_modalz WebInterface.history_table_modal s@ ::i );F9))ZPW)X f%F   KK? @b\F rdelete_synced_itemc z|r5|r3tj}|j||}|rdddSdddSdddS)ak Delete a synced item from a device. ``` Required parameters: client_id (str): The client ID of the device to delete from sync_id (str): The sync ID of the synced item Optional parameters: None Returns: None ``` )rsync_idrz!Synced item deleted successfully.rrzFailed to delete synced item.zMissing client ID and sync ID.)r#r delete_sync)rrr{rarrs rfdelete_sync_rowszWebInterface.delete_sync_rows sP& mmoG ,,y',RJ"+8[\\")6UVV%2RS Src Ftj}tdd|S)Nz logs.htmlLog)r`rplex_log_files)rlist_plex_logsrg)rrars rflogszWebInterface.logs s"$224KuUcddrc tj|jd}|jdd}|d}|d}|ddd }|ddd }|d d } dg} g} | j} |d k(rtj } n&|dk(rtj } ntj} ttjjtjj| dd5}|jD]} |j!dd}|dj!dddj#}tj$|j!dddj'dd}| |d||g dddgd}||vr,||j/|d}| Dcgc] }|d|vs |} }n| } | r9| Dcgc],}|D]%}| j1|j1vs$|'.} }}|dk(rdn|dk(rd| j3fd|d k(r| ddd!} | |||z}t5j6t+| t+| |d"S#t($rlt+| dz }t+|t+|j-dz }dd|zztj$||dz}| |dxxd|zz cc<YwxYw#1swYWxYwcc}wcc}}w)#Nr/) json_kwargs log_levelrr"lengthorderrcolumndirsearchvalue tautulli_apiplex_websocketrutf-8encodingz - rjz :: :   z z
)DEBUGINFOWARNINGERROR12c|SrrJ)x sortcolumns rfz&WebInterface.get_log..! s AjMr)keydescri)recordsFiltered recordsTotalr)rprocess_json_kwargsrwr&r FILENAME_APIFILENAME_PLEX_WEBSOCKETFILENAMErrLrMrNrPrRLOG_DIR readlinesr)stripsanitizereplace IndexErrorlenlstriprlowersortjsondumps)rlogfilerar/rr"rr{ order_dir search_valuefiltfilteredfarrltemp_loglevel_and_timeloglvlrtlnll log_levelsrowrrowsrs @rfget_logzWebInterface.get_log s //FJJ{*3A6<.>qu.EEBHQK6B;.K   $E msJ3KA>I&K1 K+>K+*K09K0&A1KKKKK(c .|jdrd|djz}t|jdtjj } dt j|d|iS#tjd|zgcYSxYw)a Get the PMS logs. ``` Required parameters: None Optional parameters: window (int): The number of tail lines to return logfile (int): The name of the Plex log file, e.g. "Plex Media Server", "Plex Media Scanner" Returns: json: [["May 08, 2016 09:35:37", "DEBUG", "Auth: Came in with a super-token, authorization succeeded." ], [...], [...] ] ``` log_type Plex Media windowrT)rparsedlog_filez%Unable to retrieve Plex log file '%'.) rw capitalizeintrPrRPMS_LOGS_LINE_CAPr get_log_tailrr)rrrars rf get_plex_logzWebInterface.get_plex_log. s6 ::j !#fZ&8&C&C&EEGVZZ&--*I*IJK J336$Y`ab b  KK?'I JIs A66Bc |jdsgd}t||d|d<tj}|j |}|S)a[ Get the data on the Tautulli notification logs table. ``` Required parameters: None Optional parameters: order_column (str): "timestamp", "notifier_id", "agent_name", "notify_action", "subject_text", "body_text", order_dir (str): "desc" or "asc" start (int): Row to start from, 0 length (int): Number of items to return, 25 search (str): A string to search for, "Telegram" Returns: json: {"draw": 1, "recordsTotal": 1039, "recordsFiltered": 163, "data": [{"agent_id": 13, "agent_name": "telegram", "body_text": "DanyKhaleesi69 started playing The Red Woman.", "id": 1000, "notify_action": "on_play", "rating_key": 153037, "session_key": 147, "subject_text": "Tautulli (Winterfell-Server)", "success": 1, "timestamp": 1462253821, "user": "DanyKhaleesi69", "user_id": 8008135 }, {...}, {...} ] } ``` r/)rTT) notifier_idTT agent_nameTT notify_actionTT subject_textTT body_textTTrrB)rwr0rr get_notification_log)rrarAr notification_logss rfrz!WebInterface.get_notification_logT sU^zz+&5J #8 K"XF; "..0 (==V=L  rc |jdsgd}t||d|d<tj}|j |}|S)a; Get the data on the Tautulli newsletter logs table. ``` Required parameters: None Optional parameters: order_column (str): "timestamp", "newsletter_id", "agent_name", "notify_action", "subject_text", "start_date", "end_date", "uuid" order_dir (str): "desc" or "asc" start (int): Row to start from, 0 length (int): Number of items to return, 25 search (str): A string to search for, "Telegram" Returns: json: {"draw": 1, "recordsTotal": 1039, "recordsFiltered": 163, "data": [{"agent_id": 0, "agent_name": "recently_added", "end_date": "2018-03-18", "id": 7, "newsletter_id": 1, "notify_action": "on_cron", "start_date": "2018-03-05", "subject_text": "Recently Added to Plex (Winterfell-Server)! (2018-03-18)", "success": 1, "timestamp": 1462253821, "uuid": "7fe4g65i" }, {...}, {...} ] } ``` r/) r) newsletter_idTTrrrr)rTT)end_dateTT)uuidTTrrB)rwr0rr get_newsletter_log)rrarAr newsletter_logss rfrzWebInterface.get_newsletter_log sT\zz+&0J#8 K"XF; "..0 &999Hrc ltj}|j}|rdnd}|rdnd}||dS)z Delete the Tautulli notification logs. ``` Required paramters: None Optional parameters: None Returns: None ``` rrzCleared notification logs.z"Failed to clear notification logs.r)rr delete_notification_logrrar rresrs rfrz$WebInterface.delete_notification_log s?$#..0 557!iw.4*:^#..rc ltj}|j}|rdnd}|rdnd}||dS)z Delete the Tautulli newsletter logs. ``` Required paramters: None Optional parameters: None Returns: None ``` rrzCleared newsletter logs.z Failed to clear newsletter logs.r)rr delete_newsletter_logrs rfrz"WebInterface.delete_newsletter_log s?$#..0 335!iw,2(8Z#..rc ltj}|j}|rdnd}|rdnd}||dS)z Delete the Tautulli login logs. ``` Required paramters: None Optional parameters: None Returns: None ``` rrzCleared login logs.zFailed to clear login logs.r)r'rdelete_login_log)rrarrrrs rfrzWebInterface.delete_login_log s<$KKM ++-!iw'-#3P#..rc |dk(rtj}n&|dk(rtj}ntj} t t j jtjj|djd}d|z}tj|||d S#t$r-}d}d|z}tjd|d |d Yd}~6d}~wwxYw) NrrwrzCleared the %s file.rzFailed to clear the %s file.zFailed to clear the z file: .r)rrrrrrLrMrNrPrRrcloserr[r\)rrrarrrres rf delete_logszWebInterface.delete_logs s n $**H ( (55HH Q fmm33X> D J J LF(83C KK  !S11  QF08;C   8QO P P QsA,B// C%8#C  C%c tj t_tjtj_tjj t j tj tjjtjt jdtjt jdtjtjdz)N)consolelog_dirverbosezVerbose toggled, set to %sz4If you read this message, debug logging is availabler)rPVERBOSErR VERBOSE_LOGSrr initLoggerQUIETrrrVrrrUrs rf toggleVerbosezWebInterface.toggleVerbose4 s$^^+%+^^ " fll"2FMM>rc tjd|jddd|d|jddjddd|d y ) z0 Logs javascript errors from the web interface. z WebUI :: /rrirz. (rEr:)zjs error logged.)rr rpartition partition)rpagerfilelineras rf log_js_errorszWebInterface.log_js_errorsA sS  T__S5I"5M6=6:ooc6J26N6X6XY\6]^_6`6:< ="rc |dk(rtj}n&|dk(rtj}ntj} t t j jtjj|dd5}d|jzcdddS#1swYyxYw#t$r }Yd}~yd}~wwxYw)Nrrrrrz 
%s
zLog file not found.) rrrrrrLrMrNrPrRrreadr)rrrarrres rflogFilezWebInterface.logFileK s n $**H ( (55HH )bggll6==#8#8(CSSZ[ 2_`&1 2 2 2 )( )s0AB+B B+B($B+(B++ B>9B>c i}tjD]-}ttj|||j </tj D]6}tttj|||j <8tjjdk7rd|d<nd|d<dD]}tj||||<tdd|S)Nr http_password)rhome_stats_cardshome_library_cardsz settings.htmlSettingsr) rSETTINGSgetattrrPrRrCHECKED_SETTINGSr, HTTP_PASSWORDrrrg)rra settings_dictsettingrs rfsettingszWebInterface.settings^ s  MG-4V]]G-LM'--/ * M.. VG-4WV]]G5T-UM'--/ * V == & &" ,-3M/ *-/M/ *N @C!%M#,>!?M#  @O:Vcddrc d}d}d}d}d}d}d}|jddrd}d}|s4tjD]!} | j} | |vrd|| <d|| <#|j ddk(r|d=n,|j dddk7rt |d|d<| |d <|D cgc]} | j d s| d d| fc} D]\} } || || <|| =|j d tjjk7s,|j d tjjk7rd}|j dtjjk7sb|j dttjjk7s,|j dttjjk7s|j dttjjk7s|j dttjj k7s|j dtjj"k7sa|j dtjj$k7s5|j dttjj&k7rd}|j dttjj(k7s,|j dtjj$k7rd}|j dr|j dr|j dtjj*k7s|j dtjj,k7sX|j dtjj.k7s,|j dtjj0k7rd}|j drJt3|j5D]} | j ds|| =|dj7d|d<|j d rJt3|j5D]} | j d!s|| =|d j7d|d <|j d"rJt3|j5D]} | j d#s|| =|d"j7d|d"<|jd$ds|rd}d}d}|jd%drd}tj8tjz}|j;D cic]\} }| j=|vs| |}} }|rd|d&<tjj?|tjjA|rOtBjDd'k(rtGjHn'tBjDd(k(rtKjH|r8tMjNtjPrtSjT|r+tWjXt[j\dd)|rtj^|rr#get_server_resources WS_CONNECTEDr) reconnectr*restartrconnect_serverrr/rr rrKr"r'r)rrarstartup_changedr' reschedule https_changedrKrchecked_configr plain_config use_configk all_settingsvs rf configUpdatezWebInterface.configUpdateu s   !  ::k4 (I!N"("9"9 /!/!5!5!7!/-.F>*-.F>*  / ::o && 0'zz/2."4*3F?4K*L'7@=F& '=C(\q||TZG[!AB%(\ # $L*#)*#5F< z" # ::& '6==+G+G G +, 0L0LL"O ::n %)C)C C 23s6==;^;^7__ 78C @h@h > +, 0L0LL!N ::n %&**5H*Izz.)V]]-G-GGJJz*fmm.D.DDJJ|, 0H0HHJJ{+v}}/F/FF $  ::o &&++-( "<<(q  "'-_&=&C&CC&HF? # ::( )&++-( "<< *q  "*00B)C)I)I#)NF% & ::* +&++-( "<< *q  ",22F+G+M+Mc+RF' ( ::& -!N M $  ::nd + M)@)@@ #)<<>O41aQWWY,5N!Q$OO +,F' ( $$V,   )+##%H,!!#   ' ' )""$$&       * *tT B   ' ' )  %fmm&>&> @W@W X    I$?$? @ F F H    E$7$7 8 > > @#0ABB[)]BPs#]: ].] ]c tj}|jd}|jsdtj _yy)NT)return_responsei)r#rget_plextv_resourcesokrresponser)rrarrRs rfcheck_pms_tokenzWebInterface.check_pms_token s<--////E{{'*H   $rc Rtj}|j|}|S)N)update_channel)r#rget_plex_downloads)rrUrar downloadss rfget_pms_downloadszWebInterface.get_pms_downloads s(--/..n.M rc 0tjdddi|S)N return_serverTrJ)r#r?rs rfr?z!WebInterface.get_server_resources s**HHHHrc Btj}|rdddSdddS)/ Creates a manual backup of the plexpy.db file rzConfig backup successful.rrzConfig backup failed.)r make_backupr%s rf backup_configzWebInterface.backup_config! s- ##% '4OP P%2IJ Jrc tdS)Nzconfiguration_table.htmlr`r,rs rfget_configuration_tablez$WebInterface.get_configuration_table. s,FGGrc tdS)Nzscheduler_table.htmlr`r,rs rfget_scheduler_tablez WebInterface.get_scheduler_table3 s,BCCrc td|S)Nzqueue_modal.html)r`queuer,)rreras rfget_queue_modalzWebInterface.get_queue_modal8 s,>eLLrc tj}|j}tjj }|t jjtjjtjjtjjtjjtjjdS)N)plexpass pms_platformpms_update_channelpms_update_distropms_update_distro_build)r#rget_plexpass_statusr&rget_server_update_channelrPMS_PLATFORM_NAME_OVERRIDESrwrPrR PMS_PLATFORMPMS_UPDATE_CHANNELPMS_UPDATE_DISTROPMS_UPDATE_DISTRO_BUILD)rrarrhrUs rfget_server_update_paramsz%WebInterface.get_server_update_params= s--/..0#..0JJL$ & B B F FMM.. 0J0J!L&,mm&F&F%+]]%D%D+1==+P+P R Rrc Btj}|rdddSdddS)r\rzDatabase backup successful.rrzDatabase backup failed.)rr]r%s rf backup_dbzWebInterface.backup_dbM s- %%' '4QR R%2KL Lrc 2tj|}|S)aF Get a list of configured notifiers. ``` Required parameters: None Optional parameters: notify_action (str): The notification action to filter out Returns: json: [{"id": 1, "agent_id": 13, "agent_name": "telegram", "agent_label": "Telegram", "friendly_name": "", "active": 1 } ] ``` )r)r" get_notifiers)rrrars rfrxzWebInterface.get_notifiersZ s4((}E rc Dtj}td|S)Nznotifiers_table.html)r`notifiers_list)r"rxrgr%s rfget_notifiers_tablez WebInterface.get_notifiers_tablew s!((*,BSYZZrc Ftj|}|rdddSdddS)a Remove a notifier from the database. ``` Required parameters: notifier_id (int): The notifier to delete Optional parameters: None Returns: None ``` rrzNotifier deleted successfully.rrzFailed to delete notifier.)r"delete_notifierrrrars rfr~zWebInterface.delete_notifier} s/$**{C '4TU U%2NO Orc 4tj|d}|S)a  Get the configuration for an existing notification agent. ``` Required parameters: notifier_id (int): The notifier config to retrieve Optional parameters: None Returns: json: {"id": 1, "agent_id": 13, "agent_name": "telegram", "agent_label": "Telegram", "friendly_name": "", "config": {"incl_poster": 0, "html_support": 1, "chat_id": "123456", "bot_token": "13456789:fio9040NNo04jLEp-4S", "incl_subject": 1, "disable_web_preview": 0 }, "config_options": [{...}, ...] "actions": {"on_play": 0, "on_stop": 0, ... }, "notify_text": {"on_play": {"subject": "...", "body": "..." } "on_stop": {"subject": "...", "body": "..." } ... } } ``` Trmask_passwords)r"get_notifier_configrs rfrz WebInterface.get_notifier_config sX..;W[\ rc tj|d}tjDcgc]}|dD]}|d|d|dd}}}t d|| Scc}}w) NTr parametersnametyperrrrznotifier_config.html)r`notifierr)r"rrNOTIFICATION_PARAMETERSrg)rrrarcategoryparamrs rfget_notifier_config_modalz&WebInterface.get_notifier_config_modal s..;W[\!' > >HUaLbCHvf gWW  ,BV`jkk s Ac Jtjdd|i|}|rdd|dSdddS) a Add a new notification agent. ``` Required parameters: agent_id (int): The notification agent to add Optional parameters: None Returns: None ``` agent_idrzAdded notification agent.)rrrrz!Failed to add notification agent.rrJ)r"add_notifier_configrrrars rfrz WebInterface.add_notifier_config s:$..KKFK '4O`fg g%2UV Vrc Jtjd||d|}|rdddSdddS)a Configure an existing notification agent. ``` Required parameters: notifier_id (int): The notifier config to update agent_id (int): The agent of the notifier Optional parameters: Pass all the config options for the agent with the agent prefix: e.g. For Telegram: telegram_bot_token telegram_chat_id telegram_disable_web_preview telegram_html_support telegram_incl_poster telegram_incl_subject Notify actions (int): 0 or 1, e.g. on_play, on_stop, etc. Notify text (str): e.g. on_play_subject, on_play_body, etc. Returns: None ``` )rrrzSaved notification agent.rrz"Failed to save notification agent.rJ)r"set_notifier_config)rrrrars rfrz WebInterface.set_notifier_config s;:..d;QYd]cd '4OP P%2VW Wrc 2t|jr t|}g}tfdt j Dd}|D]7} t j||d| i|d\} } |j| | | d9td||S) Nc38K|]}|dk(r|dyw)r media_typesNrJ)rars rfrz7WebInterface.get_notify_text_preview..s); yM9m,;srJrT)subjectbodyrrrtest)rrrznotifier_text_preview.html)r`textagent) rOisdigitrrqr"available_notification_actionsr!build_notify_textr&rg) rrrrrrrarrr test_subject test_bodys ` rfget_notify_text_previewz$WebInterface.get_notify_text_preview s x= "8}H;i6^6^6`;<>@ & `J&:&L&LU\RV[hYegqXrV^RV 'X #L) KKzlT]^ _ `,Ht[effrc ~tjDcgc]}|dD]}|d|d|dd}}}|Scc}}w)a# Get the list of available notification parameters. ``` Required parameters: None Optional parameters: None Returns: json: { } ``` rrrrr)rr)rrarrrs rfget_notifier_parametersz$WebInterface.get_notifier_parameters#si0'-&D&D ;##+L#9 ;  %V}$V} %g;; ;;s 9c dtjjd<|dk(rdnd}|rztj|}|r>t j d||dd tjd||||d d |d d dSt j d|d|ddd|zdSt j d|zdddS)a Send a notification using Tautulli. ``` Required parameters: notifier_id (int): The ID number of the notification agent subject (str): The subject of the message body (str): The body of the message Optional parameters: None Returns: None ``` max-age=0,no-cache,no-store Cache-Controlrtest rr}Sending agent_labelz notification.T)rrrrmanual_triggerrNotification queued.rUnable to send z"notification, invalid notifier_id rrzInvalid notifier id %s.z7Unable to send %snotification, no notifier_id received.zNo notifier id received.rJ) rrRheadersr"rrrVr!add_notifier_each)rrrrrrarrs rfsend_notificationzWebInterface.send_notification@s&6S!!/2'61wr  44MH T8MCZ[\$66A;ER?F<@FJ A :@ A #,8NOO Y]_jkl")6OR]6]^^ LLRUYY Z%2LM Mrc ntj}|r |d}|r|Sytjdy)N notificationsz)Unable to retrieve browser notifications.)r"get_browser_notificationsrr)rrarrs rfrz&WebInterface.get_browser_notificationsjs;446 "?3M$$ KKC Drc dtjjd<tj}|j |||}|rdd|dSddd S) Nrr)app_id app_secret redirect_urirz;Confirm Authorization. Check pop-up blocker if no response.)rrrrz%Failed to retrieve authorization url.rr)rrRrr"FACEBOOK_get_authorization)rrrrrafacebook_notifierrs rf facebook_authzWebInterface.facebook_authzsh6S!!/2%..022&>H@L3N '0mvyz z%.UV Vrc dtjjd<tj}|j |}|rdj |Sy)NrrzFacebook authorization successful. Tautulli can send notification to Facebook. Your Facebook access token is:
{0}
You may close this page.zqFailed to request authorization from Facebook. Check the Tautulli logs for details.
You may close this page.)rrRrr"r_get_credentialsr~)rcoderafacebook access_tokens rffacebook_redirectzWebInterface.facebook_redirectsW6S!!/2%%'006 99? 9M NGrc tjjdk(rddiStjjr5tjj}dtj_dd|dSdd d S) NtemprwaitingrrzAuthorization successful.)rrrrz Failed to request authorization.r)rPrRFACEBOOK_TOKEN)rrars rffacebook_retrieve_tokenz$WebInterface.facebook_retrieve_tokensd == ' '6 1i( ( ]] ) )MM00E+-FMM ('0K]bc c%.PQ Qrc dtjjd<ddlm}|j |\}}|r*t j }|jdd||Stj||S)Nrrr) registerapp Registeredz Success :-))rrsubtitle) rrRr osxnotifyrr"OSXnotifyrr)rapprarrr osx_notifys rfosxnotifyregisterzWebInterface.osxnotifyregistersp6S!!/26++C0  "J   lQW  X  KK  rc ftjd|ij}|rdddSdddS)NhookrrzTest Zapier webhook sent.rrz#Failed to send test Zapier webhook.)r"ZAPIER _test_hook)r zapier_hookrars rfzapier_test_hookzWebInterface.zapier_test_hooks=""6;*?@KKM '0KL L%.ST Trc &|Dcgc]}|jds|dd|fc}D]\}}||||<||=tjj|tjj dt j _ycc}w)Nrr)rvrPrRr<rrrRr)rrarrHrIs rfset_notification_configz$WebInterface.set_notification_configs>D(\q||TZG[!AB%(\ # $L*#)*#5F< z" #  $$V,  #& )]s B Bc Dtj}td|S)Nzmobile_devices_table.html)r` devices_list)r get_mobile_devicesrgr%s rfget_mobile_devices_tablez%WebInterface.get_mobile_devices_tables!..0,GV\]]rc tj|rtj|ddddStj|}|durtj|ddd|dSdd dS) NT)rrzDevice registration cancelled.rrzDevice registered successfully.)rrrzDevice not registered.)rrr set_temp_device_tokenget_temp_device_token)r device_tokencancelrars rfverify_mobile_devicez!WebInterface.verify_mobile_devicesp   V $  , ,\$ G%2RS S11,? T>  , ,\$ G'4U_ef f%2JK Krc Htj|}td|S)N)mobile_device_idzmobile_device_config.html)r`device)r get_mobile_device_configrgrrrars rfget_mobile_device_config_modalz+WebInterface.get_mobile_device_config_modals$44FVW,GPVWWrc Htjdd|i|}|rdddSdddS)aq Configure an existing notification agent. ``` Required parameters: mobile_device_id (int): The mobile device config to update Optional parameters: friendly_name (str): A friendly name to identify the mobile device Returns: None ``` rrzSaved mobile device.rrzFailed to save mobile device.rJ)r set_mobile_device_configrs rfrz%WebInterface.set_mobile_device_configs9$44aFVaZ`a '4JK K%2QR Rrc Htj||}|rdddSdddS)a Remove a mobile device from the database. ``` Required parameters: mobile_device_id (int): The mobile device database id to delete, OR device_id (str): The unique device identifier for the mobile device Optional parameters: None Returns: None ``` )r device_idrzDeleted mobile device.rrzFailed to delete device.)r delete_mobile_device)rrrrars rfrz!WebInterface.delete_mobile_devices6&00BR;DF '4LM M%2LM Mrzresponse.timeoutic |sdddS|rtjj|} tjjtj j | dz} tjd| | tj|| }n|rtjjtj j |jdz}tjd|j|t|d5} |jjd} | sn| j| 0 ddd|sdd dS|j!d k(rt#j$| } | d k(rOt'j(t"j*||t-j.|d j1d ddS|rt-j2|d| dS|j!dk(rtt5j$||} | d k(rc tjrdddS|rtjj t j j|jdz}tjd|j|t|d5} |jjd}|sn|j|0 ddd|sdd dStj |t#j$| d d dS#1swY?xYw) a Import a Tautulli config file. ``` Required parameters: config_file (file): The config file to import (multipart/form-data) or config_path (str): The full path to the config file to import Optional parameters: backup (bool): true or false whether to backup the current config before importing Returns: json: {"result": "success", "message": "Config import has started. Check the logs to monitor any problems. " "Tautulli will restart automatically." } ``` rzTDatabase import is in progress. Please wait until it is finished to import a config.rz .import.iniz;Received config file '%s' for import. Saving to cache '%s'.rrNzNo config specified for import)rrrzgConfig import has started. Check the logs to monitor any problems. Tautulli will restart automatically.)rr rLrMrNrPrRrrrrrrrrrset_import_threadrr)r config_file config_pathrrarrs rf import_configzWebInterface.import_configs4  %uw w '',,v}}'>'> @T@TWd@deK KKU#,,k ;k4( "A&++006DGGDM   "%2RS S  Gd#|S#t0j6t8t:f$r(}t-j<d"|zd |d<Yd}~|Sd}~wwxYw)$a Get the PMS server identifier. ``` Required parameters: hostname (str): 'localhost' or '192.160.0.10' port (int): 32400 Optional parameters: ssl (int): 0 or 1 remote (int): 0 or 1 Returns: json: {'identifier': '08u2phnlkdshf890bhdlksghnljsahgleikjfg9t'} ``` ipportclientIdentifierhttpshttpz{scheme}://{hostname}:{port})schemehostnamerz /identityF)urls ssl_verifyGETxml)uri request_type output_formatMediaContainerrmachineIdentifier identifier)rrrrrpms_urlrNwsrjz/:/websockets/notificationszX-Plex-Token: %szsecure ca_certs cert_reqsrz!Testing %swebsocket connection...)headerssloptz%Websocket connection test successful.Tz$Websocket connection test failed: %sz&Unable to retrieve the PMS identifier.) rrr#rrr.r~r HTTPHandler make_requestgetElementsByTagName getAttributer?rrPrRrVERIFY_SSL_CERTcertifiwhere_ssl CERT_NONErrV websocketcreate_connectionrWebSocketExceptionrr[rr)rr#rr-sslmanualget_urltest_websocketrarserversrserverr"rr(request_handlerrequestxml_headrws_urlr2securer3test_wsres rf get_server_idzWebInterface.get_server_ids,$h4mmoG&&(G)J! 4LH,t 0JPVW]P^bfPf!'(:!;J $'V4;;6T\cg;h!".":":FK#M)663DIEJ7L&;;BHBL 3N !'y 1u #t $$^4#E]2264CFccF06==3J3JJKF!*!==88&0'--/%BF&14>>%BF!#!%LL!Dv!MN-"+"="=fV\b"c  %LM'+t M6M KK@ AM&88'9M- %Ka%OP',t M -sAH00I6I11I6c Vtjd}|jdd|S)a Get the PMS server information. ``` Required parameters: None Optional parameters: None 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" } ``` T) return_inforN)r#r?r()rrarEs rfget_server_infozWebInterface.get_server_info7s'<,,> >4( rc tj}|j|}|r|Stjd|S)z Get a specified PMS server preference. ``` Required parameters: pref (str): Name of preference Returns: string: Value of preference ``` )prefz,Unable to retrieve data for get_server_pref.)r&rget_server_prefrr)rrQrarrs rfrRzWebInterface.get_server_prefYs?!++- ,,$,7 M KKF GMrc d}|r3|tjjk(stj|rut j dk\rtjd}ntj}|s@|tjjk(r^tj|rutjdtjj|tj|rtj |d|S)Nr)rr zNew API key generated.T)r})rPrRAPI_KEYr get_mobile_device_by_tokenrn version_infosecrets token_urlsafe generate_uuidrr_BLACKLIST_WORDSr}rrr)rrraapikeys rfgenerate_api_keyzWebInterface.generate_api_keyqsFfmm&;&;;z?d?drx?y6) ..r2--/ Ffmm&;&;;z?d?drx?y  ,-##F+   V $  , ,V > rc tjtjdddd}nitjdk(rddddtjztj j tjtjd tjjd tjjd tjd }ntjd k(rddddtjtjtjtjd tjjd tjjdtjdtjd}ndddd}tjs tj stj"rtj$|d<|S)a Check for Tautulli updates. ``` Required parameters: None Optional parameters: None Returns: json {"result": "success", "update": true, "message": "An update for Tautulli is available." } ``` Nrz/You are running an unknown version of Tautulli.)rupdaterreleaserTz,A new release (%s) of Tautulli is available.zhttps://github.com/rz/releases/tag/)rr_r`rcurrent_releaselatest_release release_urlcommitFz)A newer version of Tautulli is available.z /compare/z...)rr_r`rcurrent_versionlatest_versioncommits_behind compare_urlzTautulli is up to date. install_type)r( check_updaterPUPDATE_AVAILABLELATEST_RELEASErrXranon_urlrRGIT_USERGIT_REPOrWLATEST_VERSIONCOMMITS_BEHINDDOCKERSNAPFROZEN INSTALL_TYPE)rrar_s rf update_checkzWebInterface.update_checks`, !!#  " " * ' $!RF  $ $ 1 ) $!%!ORXRgRg!g)/)>)>(.(=(=%,%5%5#]]33#]]33#224&5 F $ $ 0 ) $!&!L)/)?)?(.(=(=(.(=(=%,%5%5#]]33#]]33#33#22 4&5 F !* %!:F ==FKK6==%+%8%8F> " rc |}|j}|r |t_tjjj dr0dtjjj dzdz}nd}t d||||||S)Nrz shutdown.html)r`signalr new_http_rootrtimerquote)random_arnold_quotesrPSIGNALrRrUrrg)rrxrrzrarr{rys rfdo_state_changezWebInterface.do_state_changes))+ "FM == " " ( ( -&--"9"9"?"?"DDsJMMOFRW,97RW_df frc (|jdddS)Nshutdownz Shutting Downr~rs rfrzWebInterface.shutdowns##JDDrc (|jdddS)NrB Restartingrrs rfrBzWebInterface.restarts##I|R@@rc tjstjr&tjtj dzdtj _tj j|jdddS)Nrrjr_Updatingx) rPrrrsrrrUrRrrr~rs rfr_zWebInterface.updates` ==FKK''(8(86(AB B/0 + ##Hj#>>rc n|tjjk(r>tjd|zt j tjdz|tj_|tj_tjj|jdddS)NzAlready on the %s branchrcheckoutzSwitching Git Branchesr) rPrR GIT_BRANCHrrrrrU GIT_REMOTErr~)r git_remote git_branchras rfcheckout_git_branchz WebInterface.checkout_git_branchs 11 1 LL3j@ A''(8(86(AB B$.  #-   ##J0H#NNrc b|jddjtjdS)NresetzResetting to {}r)r~r~rrXrs rfreset_git_installzWebInterface.reset_git_installs*##G->-E-Efnn-UWZ[[rc tjrtjj|jdddS)NzImporting a Configr)r IMPORT_THREADr"r~rs rfrestart_import_configz"WebInterface.restart_import_configs5     & & (##D*>CCrc btj|}tj|}|r%tjtj k(rd}d}tj|r3dtj _tj jtj||S)NTFr) latest_onlysince_prev_release) rrrP PREV_RELEASErrXrRrrr(read_changelog)rrr update_shownras rf get_changelogzWebInterface.get_changelogs'' 4 $../AB &"5"5"GK!&    \ *23FMM / MM   !**{Wijjrc |rII $//1K"77:Zd7eHFi/&224L#88JUY8ZH &224L&666IK OOK (&666IK OOK (  %.CH\DZ.[++F,<,<==! hV\)/)U U#$++F,<,<==++J77rc tj}|j||}|rtd||dSt j dtdddS)Nrzinfo_children_list.htmlz Children List)r`rrrz.Unable to retrieve data for get_item_children.ri)r&rr'rgrrrrrrarrs rfr'zWebInterface.get_item_childrenJsf!++- ..*Q[.\ !0IPV-7P P KKH I!0IPT\kl lrc tj}|j|}|rtd||Stdd|S)Nrzinfo_collection_list.htmlri)r&rget_item_children_relatedrg)rrrrarrs rfrz&WebInterface.get_item_children_relatedXsL!++- 66*6M !0KRX`ef f!0KRV^cd drc |s|r)tj}|j|||}nd}|rtd|dSt j dtdddS)Nrr!rrgrhriz2Unable to retrieve data for item_watch_time_stats.)rr rjrgrrrrr!rra item_datars rfitem_watch_time_statsz"WebInterface.item_watch_time_statsdsi #//1I33zPTak3lFF !0LSYano o KKL M!0LSW_lm mrc |s|r)tj}|j|||}nd}|rtd|dSt j dtdddS)Nrrnroriz,Unable to retrieve data for item_user_stats.)rr rprgrrrs rfitem_user_statszWebInterface.item_user_statsssh #//1I--$[e-fFF !0IPV^lm m KKF G!0IPT\jk krc tj|d}|rDtj}|j ||||}|r|St j d|St j dy)a Get the watch time stats for the media item. ``` Required parameters: rating_key (str): Rating key of the item Optional parameters: media_type (str): Media type of the item (only required for a collection) grouping (int): 0 or 1 query_days (str): Comma separated days, e.g. "1,7,30,0" Returns: json: [ { "query_days": 1, "total_time": 0, "total_plays": 0 }, { "query_days": 7, "total_time": 0, "total_plays": 0 }, { "query_days": 30, "total_time": 0, "total_plays": 0 }, { "query_days": 0, "total_time": 57776, "total_plays": 13 } ] ``` Tr<)rrr?rz6Unable to retrieve data for get_item_watch_time_stats.z;Item watch time stats requested but no rating_key received.N)rrrr rjrr)rrrr?rrarrs rfget_item_watch_time_statsz&WebInterface.get_item_watch_time_statssrT$$X4@ #//1I33z?I=E?I4KF  TU KKU Vrc tj|d}|rCtj}|j |||}|r|St j d|St j dy)a Get the user stats for the media item. ``` Required parameters: rating_key (str): Rating key of the item Optional parameters: media_type (str): Media type of the item (only required for a collection) grouping (int): 0 or 1 Returns: json: [ { "friendly_name": "Jon Snow", "user_id": 1601089, "user_thumb": "", "username": "jsnow@thewinteriscoming.com", "total_plays": 6, "total_time": 28743 }, { "friendly_name": "DanyKhaleesi69", "user_id": 8008135, "user_thumb": "", "username": "DanyKhaleesi69", "total_plays": 5, "total_time": 18583 } ] ``` Tr<)rrr?z0Unable to retrieve data for get_item_user_stats.z5Item user stats requested but no rating_key received.N)rrrr rprr)rrrr?rarrs rfget_item_user_statsz WebInterface.get_item_user_statssoJ$$X4@ #//1I--9C7?.AF  NO KKO Prget_children_metadatac tj}|j||}|r|Stjd|S)a Get the metadata for the children of a media item. ``` Required parameters: rating_key (str): Rating key of the item media_type (str): Media type of the item Optional parameters: None Returns: json: {"children_count": 9, "children_type": "season", "title": "Game of Thrones", "children_list": [ {...}, {"actors": [], "added_at": "1403553078", "art": "/library/metadata/1219/art/1562110346", "audience_rating": "", "audience_rating_image": "", "banner": "", "collections": [], "content_rating": "", "directors": [], "duration": "", "full_title": "Season 1" "genres": [], "grandparent_rating_key": "", "grandparent_thumb": "", "grandparent_title": "", "guid": "com.plexapp.agents.thetvdb://121361/1?lang=en", "labels": [], "last_viewed_at": "1589992348", "library_name": "TV Shows", "media_index": "1", "media_type": "season", "original_title": "", "originally_available_at": "", "parent_media_index": "1", "parent_rating_key": "1219", "parent_thumb": "/library/metadata/1219/thumb/1562110346", "parent_title": "Game of Thrones", "rating": "", "rating_image": "", "rating_key": "1220", "section_id": "2", "sort_title": "", "studio": "", "summary": "", "tagline": "", "thumb": "/library/metadata/1220/thumb/1602176313", "title": "Season 1", "updated_at": "1602176313", "user_rating": "", "writers": [], "year": "" }, {...}, {...} ] } ``` rz:Unable to retrieve data for get_children_metadata_details.)r&rr'rr)rrrrarrs rfget_children_metadata_detailsz*WebInterface.get_children_metadata_detailssJL!++- 00J}d|j@_!|jE|||||||| |  }|r|dr{|dtjjd<tj0j8r:d|vr6tG|d5}|jI|ddddn #1swYnxYw|dcYStKd#tJ$r}tjd|d | d!d"tjjd<| tjvrVtj| }t jjtjd|} t| dcYd}~cYS| r%|jLd$| d||||||d| | d# | cYd}~cYSYd}~Yyd}~wwxYwwxYw)%a Gets an image from the PMS and saves it to the image cache directory. ``` Required parameters: img (str): /library/metadata/153037/thumb/1462175060 or rating_key (str): 54321 Optional parameters: width (str): 300 height (str): 450 opacity (str): 25 background (str): Hex color, e.g. 282828 blur (str): 3 img_format (str): png fallback (str): "poster", "cover", "art", "poster-live", "art-live", "art-live-full", "user" refresh (bool): True or False whether to refresh the image cache return_hash (bool): True or False to return the self-hosted image hash instead of the image Returns: None ``` zmax-age=2592000rzinterfaces/default/imagesr image/pngrM content_typezNo image input received.N return_hashartz/library/metadata/{}/artz/library/metadata/{}/thumbr!z /playlistsrjr compositer) imgrwidthheightopacity backgroundblurfallback add_to_dbimg_hashz{}.{}imagesindexesT) rrrrrr img_formatcliprrz Content-typerzPMS image request failedzFailed to get image z, falling back to rr) rrrrrrrrrrrrJ)'rrRrrrOrvrLrMrNrPrQrrDEFAULT_IMAGESrrrrrwr~rr)r!set_hash_image_inforRrexistsmkdir CACHE_IMAGESr r&rrF_silent get_imagerrr[r)rrrrrrrrrrrrrafpfbirpartsrating_key_idx img_splitimg_rating_keyrc_dirffprrrres rfrz!WebInterface.real_pms_image_proxyus66G!!/2 c3 CNN3N$Ofoovs;B2K@ @:6000++H5WW\\&//63?!r DD KK2 3 '' =(AB cH//6077 C299*E s~~f-E~~l+ "QYN S+, ,E #I((9Ve,-C&~6N^++ ';; % !# ) ) ^^Hj 1 V]]44h?ggll5"%ww~~e$ HHUO  &* M==--I:D48:D487>/@fQi@Fq H%%--n=}}11is6J!#t_/GGF1I.///"!9$#$>?? M SRZ[\=Z!!))/:v444 //9CfoovsCB%2KHH4444M$U6 'JTV`!%wTMFLMM M3$ Mst2K RBN'+N  N' N  N'R N'' R0BQ> R RQ>0R1R8R>RRc|rKdtjjd<t|dk\rk|ddk(rctj j ttjd} tt j j |g|dS|djd d}|tjvrOtj|}tj j tjd |}t|dStj | }|r%|j#||j$dd d i|Sy#t$rYywxYw)Nz max-age=3600rrrrdata/interfaces/default/rrrr)rrTrJ)rrRrrrLrMrNrOrPrQrr r)rrr!get_hash_image_infor_r)rrra resource_dirrrrimg_infos rfimagezWebInterface.images# 9GH   % %o 64yA~$q'X"5!ww||C,@B\] %277<< +Lt+L[fggAw}}S)!,H6000++H5WW\\&//63?!r DD+??RH h'0t00HHHH! s/*E EEc tj}tjj t j j|} t j jtjt j| tj|}tjD]}t||d|jt%||S#YYxYw#dtj _YyxYw)z+ Download the Tautulli configuration file. rz)Error downloading config. Check the logs.r)rrrLrMrNrPrRrrrr CONFIG_FILEConfig_DO_NOT_DOWNLOAD_KEYSsetattrrrRrr)rrar  config_copycfgrs rfdownload_configzWebInterface.download_config s oo ggll6==#:#:KH   MM   ! OOF.. < ?-- ,C33 &S"% & IIK k <<   ?'*H   $>s AC! AC(!C%(Dc Ftj}tjj t j j|} tj}|jjdtjt j||jjtj|} |jdt+||S#Y8xYw#t!j"ddt$j&_YyxYw)z& Download the Tautulli database file. zbegin immediatez7UPDATE users SET user_token = NULL, server_token = NULLz1Failed to remove tokens from downloaded database.rz+Error downloading database. Check the logs.r)rrrLrMrNrPrRrMonitorDatabase connectionexecuterrDB_FILErollbackactionrrrrRrr)rrar database_copydbs rfdownload_databasezWebInterface.download_database#s !))  V]]%<%s$ n $**H##C ( (55H..CH--C  IIKbggll6==+@+@(KRZ[[  s .CCc tjjsy|jdrd|dj z}|xsddz}t j jtjj|}|rKt j j|r,t j j|}t||Sd|zS)ak Download the Plex log file. ``` Required parameters: None Optional parameters: logfile (int): The name of the Plex log file, e.g. "Plex Media Server", "Plex Media Scanner" Returns: download ``` z(Plex log folder not set in the settings.rrzPlex Media Serverz.logrzPlex log file '%s' not found.) rPrRPMS_LOGS_FOLDERrwrrLrMrNisfilerr)rrrar log_file_path log_file_names rfdownload_plex_logzWebInterface.download_plex_logas$}},,= ::j !#fZ&8&C&C&EEG22f< V]]%B%BHM }5GG,,];M!-mD D2X= =rc &|jdS)z0 Delete and recreate the image cache directory. r)folder) delete_cachers rfdelete_image_cachezWebInterface.delete_image_caches    11rc tjjtjj |}d}d|r|dzndz} t j|d tj|tj|||d S#t$r2}d}d|z}tjd |d |d ||d cYd }~Sd }~wwxYw#t$r2}d}d|z}tjd|d |d ||d cYd }~Sd }~wwxYw)z* Delete and recreate the cache directory. rzCleared the %scache.rrT) ignore_errorsrzFailed to delete %s.zFailed to delete z: rrNzFailed to make %s.zFailed to create ) rLrMrNrPrRrrrmtreeOSErrorrr\makedirsr)rrra cache_dirrrres rfrzWebInterface.delete_caches GGLL!8!8&A $ BG 6 MM)4 8 6 KK "  C S11 6F(94C   9aH I$5 5  6 6F&2C   9aH I$5 5  6s<B C  C 'C?C C  D'D=DDc tj|}tj}|j |||}|rdd|j zdSdddS)a Delete the images uploaded to image hosting services. ``` Required parameters: None Optional parameters: rating_key (int): 1234 (Note: Must be the movie, show, season, artist, or album rating key) service (str): 'imgur' or 'cloudinary' delete_all (bool): 'true' to delete all images form the service Returns: json: {"result": "success", "message": "Deleted hosted images from Imgur."} ``` rservice delete_allrzDeleted hosted images from %s.rrzFailed to delete hosted images.)rrrr delete_img_inforrrr r!rar rs rfdelete_hosted_imagesz!WebInterface.delete_hosted_imagessd0&&z2 "..0 --Wak-l '4TW]WhWhWj4jk k%2ST Trc jtj}|j|||}|rdddSdddS)av Delete the 3rd party API lookup info. ``` Required parameters: None Optional parameters: rating_key (int): 1234 (Note: Must be the movie, show, artist, album, or track rating key) service (str): 'themoviedb' or 'tvmaze' or 'musicbrainz' delete_all (bool): 'true' to delete all images form the service Returns: json: {"result": "success", "message": "Deleted lookup info."} ``` rrzDeleted lookup info.rrzFailed to delete lookup info.)rr delete_lookup_infor#s rfr&zWebInterface.delete_lookup_infosF0#..0 00JPWdn0o '4JK K%2QR Rrc tdd|S)Nz search.htmlSearch)r`rrr,)rrras rfrzWebInterface.searchsMQVWWrrc tj}|j||}|r|Stjd|S)a& Get search results from the PMS. ``` Required parameters: query (str): The query string to search for Optional parameters: limit (int): The maximum number of items to return per media type Returns: json: {"results_count": 69, "results_list": {"movie": [{...}, {...}, ] }, {"episode": [{...}, {...}, ] }, {...} } ``` rruz+Unable to retrieve data for search_results.)r&rget_search_resultsrr)rrrurarrs rfsearch_resultszWebInterface.search_resultssB@!++- //e5/I M KKE FMrc 4tj}|j||}|r ||d|i|d<|dk(r&|r$|ddDcgc] }|d|k(r|c}|dd<|rtd|dSt j dtdddScc}w) Nr* results_listseason media_indexzinfo_search_results_list.htmlzSearch Result Listriz8Unable to retrieve data for get_search_results_children.)r&rr+rgrr) rrrur season_indexrarrr/s rfget_search_results_childrenz(WebInterface.get_search_results_childrens!++- //e5/I &0&2H2T%UF> "  !lEKNE[\dEe0Z639-3HL3X170ZF> "8 , !0OV\dxy y KKR S!0OVZbvw w0ZsBc |}tj|}tj}|j |}|r|r||d<|rt d||dSt jdt d||dS)Nr query_stringzupdate_metadata.htmlr)r`rr_rz,Unable to retrieve data for update_metadata.)rrrr get_search_queryrgrr)rrrr_rar4r s rfrzWebInterface.update_metadata/s ""6*"..0 ---D \$0E. ! !0Fe\bjpq q KKF G!0Fe\bjpq qrc tj|}|rctj}t j }|j ||}|j ||} |j|| ||}  rd| iSddiS)aI Update the metadata in the Tautulli database by matching rating keys. Also updates all parents or children of the media item if it is a show/season/episode or artist/album/track. ``` Required parameters: old_rating_key (str): 12345 new_rating_key (str): 54321 media_type (str): "movie", "show", "season", "episode", "artist", "album", "track" Optional parameters: None Returns: None ``` r) old_key_list new_key_listr single_updaterr)rrrr r&rget_rating_keys_listr) rold_rating_keynew_rating_keyrr9rar rr7r8rs rfupdate_metadata_detailsz$WebInterface.update_metadata_details@s, ))-8 &224L$//1K'<<cm<nL&;;~bl;mL!11|?K=G@M2OF v& &12 2rc tj}|j||}|r|Stjd|S)a Get a list of new rating keys for the PMS of all of the item's parent/children. ``` Required parameters: rating_key (str): '12345' media_type (str): "movie", "show", "season", "episode", "artist", "album", "track" Optional parameters: None Returns: json: {} ``` rz0Unable to retrieve data for get_new_rating_keys.)r&rr:rrrs rfget_new_rating_keysz WebInterface.get_new_rating_keysjsB*!++- 11ZT^1_ M KKJ KMrc tj}|j||}|r|Stjd|S)a Get a list of old rating keys from the Tautulli database for all of the item's parent/children. ``` Required parameters: rating_key (str): '12345' media_type (str): "movie", "show", "season", "episode", "artist", "album", "track" Optional parameters: None Returns: json: {} ``` rz0Unable to retrieve data for get_old_rating_keys.)rr r:rr)rrrrar rs rfget_old_rating_keysz WebInterface.get_old_rating_keyssB*#..0 22jU_2` M KKJ KMrc tj}|jd}|r|Stjdy)z Get all the current sessions. rz2Unable to retrieve data for get_pms_sessions_json.F)r&r get_sessionsrrrs rfget_pms_sessions_jsonz"WebInterface.get_pms_sessions_jsons: !++- ))&1 M KKL Mr get_metadatac tj}|j||}|r|Stjd|S)a( Get the metadata for a media item. ``` Required parameters: rating_key (str): Rating key of the item, OR sync_id (str): Sync ID of a synced item Optional parameters: None Returns: json: {"actors": [ "Emilia Clarke", "Lena Headey", "Sophie Turner", "Kit Harington", "Peter Dinklage", "Nikolaj Coster-Waldau", "Maisie Williams", "Iain Glen", "John Bradley", "Alfie Allen" ], "added_at": "1461572396", "art": "/library/metadata/1219/art/1462175063", "audience_rating": "7.4", "audience_rating_image": "themoviedb://image.rating", "banner": "/library/metadata/1219/banner/1462175063", "collections": [], "content_rating": "TV-MA", "directors": [ "Jeremy Podeswa" ], "duration": "2998290", "edition_title": "", "full_title": "Game of Thrones - The Red Woman", "genres": [ "Action/Adventure", "Drama", "Fantasy", "Romance" ], "grandparent_guid": "plex://show/5d9c086c46115600200aa2fe", "grandparent_guids": [ "imdb://tt0944947", "tmdb://1399", "tvdb://121361" ], "grandparent_rating_key": "1219", "grandparent_slug": "game-of-thrones", "grandparent_thumb": "/library/metadata/1219/thumb/1462175063", "grandparent_title": "Game of Thrones", "grandparent_year": "2011", "guid": "plex://episode/5d9c1276e9d5a1001f4ff2fa", "guids": [ "imdb://tt3658014", "tmdb://1156503", "tvdb://5469015" ], "labels": [], "last_viewed_at": "1462165717", "library_name": "TV Shows", "live": 0, "markers": [ { "id": 908, "type": "credits", "start_time_offset": 2923863, "end_time_offset": 2998197, "first": true, "final": true }, { "id": 908, "type": "intro", "start_time_offset": 1622, "end_time_offset": 109135, "first": null, "final": null } ], "media_index": "1", "media_info": [ { "aspect_ratio": "1.78", "audio_channel_layout": "5.1", "audio_channels": "6", "audio_codec": "ac3", "audio_profile": "", "bitrate": "10617", "channel_call_sign": "", "channel_id": "", "channel_identifier": "", "channel_title": "", "channel_thumb": "", "channel_vcn": "", "container": "mkv", "height": "1078", "id": "257925", "optimized_version": 0, "parts": [ { "file": "/media/TV Shows/Game of Thrones/Season 06/Game of Thrones - S06E01 - The Red Woman.mkv", "file_size": "3979115377", "id": "274169", "indexes": 1, "streams": [ { "id": "511663", "type": "1", "video_bit_depth": "8", "video_bitrate": "10233", "video_codec": "h264", "video_codec_level": "41", "video_color_primaries": "", "video_color_range": "tv", "video_color_space": "bt709", "video_color_trc": "", "video_dynamic_range": "SDR", "video_dovi_bl_present": 0, "video_dovi_el_present": 0, "video_dovi_level": 0, "video_dovi_present": 0, "video_dovi_profile": 0, "video_dovi_rpu_present": 0, "video_dovi_version": 0, "video_frame_rate": "23.976", "video_height": "1078", "video_language": "", "video_language_code": "", "video_profile": "high", "video_ref_frames": "4", "video_scan_type": "progressive", "video_width": "1920", "selected": 0 }, { "audio_bitrate": "384", "audio_bitrate_mode": "", "audio_channel_layout": "5.1(side)", "audio_channels": "6", "audio_codec": "ac3", "audio_language": "", "audio_language_code": "", "audio_profile": "", "audio_sample_rate": "48000", "id": "511664", "type": "2", "selected": 1 }, { "id": "511953", "subtitle_codec": "srt", "subtitle_container": "", "subtitle_forced": 0, "subtitle_format": "srt", "subtitle_language": "English", "subtitle_language_code": "eng", "subtitle_location": "external", "type": "3", "selected": 1 } ] } ], "video_codec": "h264", "video_framerate": "24p", "video_full_resolution": "1080p", "video_profile": "high", "video_resolution": "1080", "width": "1920" } ], "media_type": "episode", "original_title": "", "originally_available_at": "2016-04-24", "parent_guid": "plex://season/602e67e61d3358002c4120f7", "parent_guids": [ "tvdb://651357" ], "parent_media_index": "6", "parent_rating_key": "153036", "parent_slug": "game-of-thrones", "parent_thumb": "/library/metadata/153036/thumb/1462175062", "parent_title": "Season 6", "parent_year": "2016", "rating": "", "rating_image": "", "rating_key": "153037", "section_id": "2", "slug": "game-of-thrones", "sort_title": "Red Woman", "studio": "Revolution Sun Studios", "summary": "The fate of Jon Snow is revealed. Daenerys meets a strong man. Cersei sees her daughter once again.", "tagline": "", "thumb": "/library/metadata/153037/thumb/1462175060", "title": "The Red Woman", "updated_at": "1462175060", "user_rating": "9.0", "writers": [ "David Benioff", "D. B. Weiss" ], "year": "2016" } ``` )rr{z1Unable to retrieve data for get_metadata_details.)r&rrrr)rrr{rarrs rfrz!WebInterface.get_metadata_detailssJj!++- 33z.s bq!MBRVaBa brrc34K|]}|dk(s |yw)rNrJ)rrrs rfrz,WebInterface.get_activity..s `q!L/U_B_ `rr)stream_count_direct_playstream_count_direct_streamstream_count_transcodetotal_bandwidth lan_bandwidth wan_bandwidthr  transcoderbrjcopyrar`rc bandwidthlocationlanrdrez)Unable to retrieve data for get_activity.z,Unable to retrieve data for get_activity: %sN)r&rrPrRrrrqrrr_rrr[r\) rrrrarrcountsrres `` rf get_activityzWebInterface.get_activitysX& Q$//fmm6M6MNK 557F bF:,> bdfgg `F:,> `bdee678945-.+,+, . + WA-.+=78A=8/0F:;<A<9:a?:,-1D1DQ{^1TT-}-/73F3Fq~3VV//73F3Fq~3VV/ W f%  GH  Q   KaO P P Qs+AE!E!9CE! E!! F *FF  get_librariesc tj}|j}|r|Stjd|S)a Get a list of all libraries on your server. ``` Required parameters: None Optional parameters: None Returns: json: [{"art": "/:/resources/show-fanart.jpg", "child_count": "3745", "count": "62", "is_active": 1, "parent_count": "240", "section_id": "2", "section_name": "TV Shows", "section_type": "show", "thumb": "/:/resources/show.png" }, {...}, {...} ] ``` z4Unable to retrieve data for get_full_libraries_list.)r&rget_library_detailsrrrs rfget_full_libraries_listz$WebInterface.get_full_libraries_lists:>!++- 002 M KKN OMr get_usersc tj}|j}|r|Stjd|S)a Get a list of all users that have access to your server. ``` Required parameters: None Optional parameters: None Returns: json: [{"allow_guest": 1, "do_notify": 1, "email": "Jon.Snow.1337@CastleBlack.com", "filter_all": "", "filter_movies": "", "filter_music": "", "filter_photos": "", "filter_tv": "", "is_active": 1, "is_admin": 0, "is_allow_sync": 1, "is_home_user": 1, "is_restricted": 0, "keep_history": 1, "row_id": 1, "shared_libraries": ["1", "2", "3"], "thumb": "https://plex.tv/users/k10w42309cynaopq/avatar", "user_id": "133788", "username": "Jon Snow" }, {...}, {...} ] ``` z0Unable to retrieve data for get_full_users_list.)r'rrqrr)rrarrs rfget_full_users_listz WebInterface.get_full_users_lists8RKKM $$& M KKJ KMrc tj}|j||}|r|Stjd|S)a< Get a list of synced items on the PMS. ``` Required parameters: None Optional parameters: machine_id (str): The PMS identifier user_id (str): The id of the Plex user Returns: json: [{"audio_bitrate": "192", "client_id": "95434se643fsf24f-com-plexapp-android", "content_type": "video", "device_name": "Tyrion's iPad", "failure": "", "item_complete_count": "1", "item_count": "1", "item_downloaded_count": "1", "item_downloaded_percent_complete": 100, "metadata_type": "movie", "photo_quality": "74", "platform": "iOS", "rating_key": "154092", "root_title": "Movies", "state": "complete", "sync_id": "11617019", "sync_media_type": null, "sync_title": "Deadpool", "total_size": "560718134", "user": "DrukenDwarfMan", "user_id": "696969", "username": "DrukenDwarfMan", "video_bitrate": "4000" "video_quality": "100" }, {...}, {...} ] ``` rtz-Unable to retrieve data for get_synced_items.)r#rrvrr)rrrrarrs rfrvzWebInterface.get_synced_itemss@`--/))ZPW)X M KKG HMrc tj}|jd}|r|Stjdy)z- Return details for currently syncing items. rrUz5Unable to retrieve data for get_sync_transcode_queue.N)r&rget_sync_transcode_queuerrrs rfrvz%WebInterface.get_sync_transcode_queueVs: !++- 55F5K M KKO Prc |dvrd}n|dvrd}tj|d}tj} | j ||||||||| |  } | r| St j d| S) a Get the homepage watch statistics. ``` Required parameters: None Optional parameters: grouping (int): 0 or 1 time_range (int): The time range to calculate statistics, 30 stats_type (str): 'plays' or 'duration' stats_start (int) The row number of the stat item to start at, 0 stats_count (int): The number of stat items to return, 5 stat_id (str): A single stat to return, 'top_movies', 'popular_movies', 'top_tv', 'popular_tv', 'top_music', 'popular_music', 'top_libraries', 'top_users', 'top_platforms', 'last_watched', 'most_concurrent' section_id (int): The id of the Plex library section user_id (int): The id of the Plex user before (str): Stats before and including the date, "YYYY-MM-DD" after (str): Stats after and including the date, "YYYY-MM-DD" Returns: json: [{"stat_id": "top_movies", "stat_type": "total_plays", "rows": [{...}] }, {"stat_id": "popular_movies", "rows": [{...}] }, {"stat_id": "top_tv", "stat_type": "total_plays", "rows": [{"content_rating": "TV-MA", "friendly_name": "", "grandparent_thumb": "/library/metadata/1219/thumb/1462175063", "guid": "com.plexapp.agents.thetvdb://121361/6/1?lang=en", "labels": [], "last_play": 1462380698, "live": 0, "media_type": "episode", "platform": "", "rating_key": 1219, "row_id": 1116, "section_id": 2, "thumb": "", "title": "Game of Thrones", "total_duration": 213302, "total_plays": 69, "user": "", "users_watched": "" }, {...}, {...} ] }, {"stat_id": "popular_tv", "rows": [{...}] }, {"stat_id": "top_music", "stat_type": "total_plays", "rows": [{...}] }, {"stat_id": "popular_music", "rows": [{...}] }, {"stat_id": "last_watched", "rows": [{...}] }, {"stat_id": "top_libraries", "stat_type": "total_plays", "rows": [{...}] }, {"stat_id": "top_users", "stat_type": "total_plays", "rows": [{...}] }, {"stat_id": "top_platforms", "stat_type": "total_plays", "rows": [{...}] }, {"stat_id": "most_concurrent", "rows": [{...}] } ] ``` )r0r9)rjrr;Tr<) r?rr stats_startrstat_idrQrrrz+Unable to retrieve data for get_home_stats.)rrrr r rr)rr?rrryrrzrQrrrrar rs rfr zWebInterface.get_home_statscs|  ! J 8 ##J$$X4@"..0 ,,h8B8B9D9D5<8B5<4:38- : M KKE FMrarnoldc 4ddl}gd}|j|S)z Get to the chopper! rN)#z^To crush your enemies, see them driven before you, and to hear the lamentation of their women!z#Your clothes, give them to me, now!zDo it!zIf it bleeds, we can kill it.zSee you at the party Richter!zLet off some steam, Bennett.z I'll be back.zGet to the chopper!zHasta La Vista, Baby!zIt's not a tumor!zDillon, you son of a bitch!zBenny!! Screw you!!z5Stop whining! You kids are soft. You lack discipline.zNice night for a walk.z Stick around!z4I need your clothes, your boots and your motorcycle.z'No, it's not a tumor. It's not a tumor!zI LIED!zAre you Sarah Connor?zI'm a cop you idiot!z!Come with me if you want to live.z&Who is your daddy and what does he do?z'Oh, cookies! I can't wait to toss them.z0Make it quick because my horse is getting tired.z'What killed the dinosaurs? The Ice Age!z!That's for sleeping with my wife!z1Remember when I said I'd kill you last... I lied!z2You want to be a farmer? Here's a couple of acres.z,Now, this is the plan. Get your ass to Mars.z9I just had a terrible thought... What if this is a dream?z4Well, listen to this one: Rubber baby buggy bumpers!z!Take your toy back to the carpet!z,My name is John Kimble... And I love my car.z!I eat Green Berets for breakfast.zPut that cookie down! NOW!)randomchoice)rrar} quote_lists rfr|z!WebInterface.random_arnold_quotess # J}}Z((rc|r!d|dvrtjd i|Sdtjjd<t j tjddjdS) Nv2rapplication/json;charset=UTF-8 Content-Typerz Please use the /api/v2 endpoint.) result_typerrrJ) r+_api_runrrRrrr _api_respondsencode)rrras rfapizWebInterface.api st DDGO"46??,V, ,8XH   % %n 5::df22w7Y3[\\b\bcj\k lrc *tjS)aX Get info about the Tautulli server. ``` Required parameters: None Optional parameters: None Returns: json: {"tautulli_install_type": "git", "tautulli_version": "v2.8.1", "tautulli_branch": "master", "tautulli_commit": "2410eb33805aaac4bd1c5dad0f71e4f15afaf742", "tautulli_platform": "Windows", "tautulli_platform_release": "10", "tautulli_platform_version": "10.0.19043", "tautulli_platform_linux_distro": "", "tautulli_platform_device_name": "Winterfell-Server", "tautulli_python_version": "3.10.0" } ``` )rPget_tautulli_infors rfrzWebInterface.get_tautulli_infos:''))rc Ntj}|j}|S)aM Check for updates to the Plex Media Server. ``` Required parameters: None Optional parameters: None Returns: json: {"update_available": true, "platform": "Windows", "release_date": "1473721409", "version": "1.1.4.2757-24ffd60", "requirements": "...", "extra_info": "...", "changelog_added": "...", "changelog_fixed": "...", "label": "Download", "distro": "english", "distro_build": "windows-i386", "download_url": "https://downloads.plex.tv/...", } ``` )r#rget_plex_updaterJs rfget_pms_updatezWebInterface.get_pms_update1s">--/((* rc d}|sd}ntj|sd|z}|rd|dStj}|j |}|rd|dSdd|zdS) a Get the geolocation info for an IP address. ``` Required parameters: ip_address Optional parameters: None Returns: json: {"city": "Mountain View", "code": "US", "continent": "NA", "country": "United States", "latitude": 37.386, "longitude": -122.0838, "postal_code": "94035", "region": "California", "timezone": "America/Los_Angeles", "accuracy": null } ``` rzNo IP address provided.zInvalid IP address provided: %srrr)rrz+Failed to lookup GeoIP info for address: %s)rr8r#rget_geoip_lookup)rrrarrgeo_infos rfrzWebInterface.get_geoip_lookupTsr:/G$$Z07*DG %': :--/++J7 ': :!.[^h.hiirc 0tj|}|S)a  Get the connection info for an IP address. ``` Required parameters: ip_address Optional parameters: None Returns: json: {"host": "google-public-dns-a.google.com", "nets": [{"description": "Google Inc.", "address": "1600 Amphitheatre Parkway", "city": "Mountain View", "state": "CA", "postal_code": "94043", "country": "United States", ... }, {...} ] json: {"host": "Not available", "nets": [], "error": "IPv4 address 127.0.0.1 is already defined as Loopback via RFC 1122, Section 3.2.1.3." } ``` )r whois_lookup)rrra whois_infos rfget_whois_lookupzWebInterface.get_whois_lookupsD))*5 rc *tjSr)rget_plexpy_urlrs rfrzWebInterface.get_plexpy_urls%%''rc .tj}|S)aA Get a list of configured newsletters. ``` Required parameters: None Optional parameters: None Returns: json: [{"id": 1, "agent_id": 0, "agent_name": "recently_added", "agent_label": "Recently Added", "friendly_name": "", "cron": "0 0 * * 1", "active": 1 } ] ``` )rget_newslettersr%s rfrzWebInterface.get_newsletterss6,,. rc Dtj}td|S)Nznewsletters_table.html)r`newsletters_list)rrrgr%s rfget_newsletters_tablez"WebInterface.get_newsletters_tables!,,.,DW]^^rc Ftj|}|rdddSdddS)a Remove a newsletter from the database. ``` Required parameters: newsletter_id (int): The newsletter to delete Optional parameters: None Returns: None ``` rrz Newsletter deleted successfully.rrzFailed to delete newsletter.)rdelete_newsletterrrrars rfrzWebInterface.delete_newsletters/$..]K '4VW W%2PQ Qrc 4tj|d}|S)a Get the configuration for an existing notification agent. ``` Required parameters: newsletter_id (int): The newsletter config to retrieve Optional parameters: None Returns: json: {"id": 1, "agent_id": 0, "agent_name": "recently_added", "agent_label": "Recently Added", "friendly_name": "", "id_name": "", "cron": "0 0 * * 1", "active": 1, "subject": "Recently Added to {server_name}! ({end_date})", "body": "View the newsletter here: {newsletter_url}", "message": "", "config": {"custom_cron": 0, "filename": "newsletter_{newsletter_uuid}.html", "formatted": 1, "incl_libraries": ["1", "2"], "notifier_id": 1, "save_only": 0, "time_frame": 7, "time_frame_units": "days" }, "email_config": {...}, "config_options": [{...}, ...], "email_config_options": [{...}, ...] } ``` Trr)rget_newsletter_configrs rfrz"WebInterface.get_newsletter_configsT22_cd rc Jtj|d}td|S)NTrznewsletter_config.html)r` newsletter)rrrgrs rfget_newsletter_config_modalz(WebInterface.get_newsletter_config_modals&22_cd,DQWXXrc Jtjdd|i|}|rdd|dSdddS) a Add a new notification agent. ``` Required parameters: agent_id (int): The newsletter type to add Optional parameters: None Returns: None ``` rrzAdded newsletter.)rrrrzFailed to add newsletter.rrJ)radd_newsletter_configrs rfrz"WebInterface.add_newsletter_configs:$22OHOO '4GZ`a a%2MN Nrc Jtjd||d|}|rdddSdddS)a Configure an existing newsletter agent. ``` Required parameters: newsletter_id (int): The newsletter config to update agent_id (int): The newsletter type of the newsletter Optional parameters: Pass all the config options for the agent with the 'newsletter_config_' and 'newsletter_email_' prefix. Returns: None ``` )rrrzSaved newsletter.rrzFailed to save newsletter.rJ)rset_newsletter_config)rrrrars rfrz"WebInterface.set_newsletter_config3sC&22=t j d||dd tjd|||||d |d d d St j d|d|ddd|zd St j d|zddd S)a Send a newsletter using Tautulli. ``` Required parameters: newsletter_id (int): The ID number of the newsletter Optional parameters: None Returns: None ``` rrrrrrrrz newsletter.)rrrrrrzNewsletter queued.rrz"newsletter, invalid newsletter_id rrzInvalid newsletter id %s.z9Unable to send %snotification, no newsletter_id received.zNo newsletter id received.rJ) rrRrrrrrVradd_newsletter_each) rrrrrrrarrs rfsend_newsletterzWebInterface.send_newsletterOs"6S!!/2'61wr $::WJ 4MAZ[\"66B]ER?F<@?F B ;A B #,8LMM Y]_lmn")6QTa6abb LLTW[[ \%2NO Orc@tjjd}tjj dk(r'|j dd}tj|tjj dk(rtjjrut|dk\r|ddk(r|j|i|S|jddtjjk(r|j|i|Std d | S|j|i|S) N REQUEST_URIrz /newsletterz/newsletter_authrjrrrznewsletter_auth.htmlzNewsletter Login)r`rr() rrG wsgi_environrPrRNEWSLETTER_AUTHrrNEWSLETTER_PASSWORDrnewsletter_authr(rg)rrra request_urirs rfrzWebInterface.newsletterws&&33MB == ( (A -&..}>PQL'' 5 5 ]] * *a /FMM4U4U4yA~$q'W"4+t++T*577 (4''88 8rc|rt|dk\r|ddk(r|ddk(rftjjt t j d} ttjj|g|dddS|j|dSt|dk\r|dd k(r|d}d}nd}|d}tj|| }|Sy#t$rYywxYw) Nrrrrjrrrrr4)newsletter_uuidnewsletter_id_name) rrLrMrNrOrPrQrr rrget_newsletter)rrrarrrrs rfrzWebInterface.newsletter_auths 4yA~$q'W"47h&#%77<<FOO0DF`#aL)rww||L/T4PQPR8/Tcnoozz$q'**4yA~$q'T/%)!W""&%)""&q'+::?N`bJ + $s-C C&%C&c (d|d<tdd|S)Ntruepreviewznewsletter_preview.html Newsletter)r`rrar,rs rfnewsletter_previewzWebInterface.newsletter_previews$#y,E$0%+- -rc |r|dk7rtj|}|rtj||d|d|d|||d|d|d }tj|}tj|}|rQd t j jd <tj|j| jd S|j| Stjd|zytjdy)NNonerid_namerrrrr) rrrrrrrrrrr)rrz7Failed to retrieve newsletter: Invalid newsletter_id %sz>Failed to retrieve newsletter: invalid newsletter_id parameterz?Failed to retrieve newsletter: Missing newsletter_id parameter.z>Failed to retrieve newsletter: missing newsletter_id parameter)rrget_agent_classrrrrRrrrraw_datargenerate_newsletterrr) rrrrrrawrarnewsletter_agents rfreal_newsletterzWebInterface.real_newsletters ]f4$::WJ#.#>#>]R\]fRgHRS]H^FPQYFZJTHPGQR[G\DNvDVGQR[G\$^ "++G4'',@`H%%--n=::&6&?&?&?&PQXXY`aa';;G;LL LLRUbb cS VWOrc tddS)Nz support.htmlSupportr+r,rs rfsupportzWebInterface.supportsN)LLrcdtjjd<ddd}|s|rtjjdk(s7t j r'gtjjd<td|d d xs|jd vr>tj}|j||d d k(rd|d<|Sd|d<d|d<|S)af Get the current status of Tautulli. ``` Required parameters: None Optional parameters: check (str): database Returns: json: {"result": "success", "message": "Ok", } ``` rrrOkrz/api/v2z auth.requirerNrjcheckintegrity_checkrQz Database okrrrzDatabase not ok) rrRrrG path_inforP AUTH_ENABLEDrr9rwrrr_)rrrarrs rfrzWebInterface.statuss(6S!!/2%$7 6##--:v?R?R:<  ''7 d2Ah=&**W*=>!113 f%+,4(5F9%  (/F8$(9F9% rcfdtjjd<dtjd}|S)ap Get the current status of Tautulli's connection to the Plex server. ``` Required parameters: None Optional parameters: None Returns: json: {"result": "success", "connected": true, } ``` rrr)r connected)rrRrrPPLEX_SERVER_UP)rrrars rf server_statuszWebInterface.server_statuss0(6S!!/2%F4I4IJ rget_exports_tablec |jdsgd}t||d|d<tj||||}|S)a\ Get the data on the Tautulli export tables. ``` Required parameters: section_id (str): The id of the Plex library section, OR user_id (str): The id of the Plex user, OR rating_key (str): The rating key of the exported item Optional parameters: order_column (str): "added_at", "sort_title", "container", "bitrate", "video_codec", "video_resolution", "video_framerate", "audio_codec", "audio_channels", "file_size", "last_played", "play_count" order_dir (str): "desc" or "asc" start (int): Row to start from, 0 length (int): Number of items to return, 25 search (str): A string to search for, "Thrones" Returns: json: {"draw": 1, "recordsTotal": 10, "recordsFiltered": 3, "data": [{"timestamp": 1602823644, "art_level": 0, "complete": 1, "custom_fields": "", "exists": true, "export_id": 42, "exported_items": 28, "file_format": "json", "file_size": 57793562, "filename": null, "individual_files": 1, "logo_level": 0, "media_info_level": 1, "media_type": "collection", "media_type_title": "Collection", "metadata_level": 1, "rating_key": null, "section_id": 1, "thumb_level": 2, "title": "Library - Movies - Collection [1]", "total_items": 28, "user_id": null }, {...}, {...} ] } ``` r/) r)media_type_titleTT)rTTr) file_formatTT)metadata_levelTT)media_info_levelTT) custom_fieldsTTr)completeTFr)rQrrra)rwr0rget_export_datatable)rrQrrrarArs rfget_export_listzWebInterface.get_export_listsOvzz+& 5J#8 K"XF; ..*7>:D6<>  rc ltjj}|dk(rd}tdd||||||| S)N photo_album photoalbumzexport_modal.htmlzExport Metadata) r`rrQrrrsub_media_type export_type file_formats)rExport FILE_FORMATSrg) rrQrrrrrrars rfexport_metadata_modalz"WebInterface.export_metadata_modalbsG  33  &%J,?GX)3WQ[)3N*5LR Rrc 4tj||}|S)ae Get a list of available custom export fields. ``` Required parameters: media_type (str): The media type of the fields to return Optional parameters: sub_media_type (str): The child media type for collections (movie, show, artist, album, photoalbum), or playlists (video, audio, photo) Returns: json: {"metadata_fields": [{"field": "addedAt", "level": 1}, ... ], "media_info_fields": [{"field": "media.aspectRatio", "level": 1}, ... ] } ``` )rr)rget_custom_fields)rrrrars rfget_export_fieldszWebInterface.get_export_fieldsqs":!22jBPR rc  tj| } tj||||||||| | | |  j }t |t rdd|dSd|dS)a Export library or media metadata to a file ``` Required parameters: section_id (int): The section id of the library items to export, OR user_id (int): The user id of the playlist items to export, OR rating_key (int): The rating key of the media item to export Optional parameters: file_format (str): csv (default), json, xml, or m3u metadata_level (int): The level of metadata to export (default 1) media_info_level (int): The level of media info to export (default 1) thumb_level (int): The level of poster/cover images to export (default 0) art_level (int): The level of background artwork images to export (default 0) logo_level (int): The level of logo images to export (default 0) custom_fields (str): Comma separated list of custom fields to export in addition to the export level selected export_type (str): 'collection' or 'playlist' for library/user export, otherwise default to all library items individual_files (bool): Export each item as an individual file for library/user export. Returns: json: {"export_id": 1} ``` ) rQrrrrr thumb_level art_level logo_levelrrindividual_filesrzMetadata export has started.)rr export_idrr)rrrrexportrr)rrQrrrrrrrrrrrrars rfexport_metadatazWebInterface.export_metadatas}D#,,-=>J)0,6-80>2B-8+4,6/<-82B DEKFH  fc "'4Ragh h%&9 9rc ptj|}|r|ddk(r|dr|dstj|d|d|d}|d d k(r~t|d d 5}t j |}ddj |jzdzdj d|Dzdz}d}ddddjS|d dk(rt||ddS|d dk(rt||ddS|d dk(rt||ddSy|r|jddk(rd } n1|r|jdd!k(rd"} n|r|jdsd#} nd$} dtjjd%<tjd&| d'j!d S#1swYxYw)(a& Download an exported metadata file ``` Required parameters: export_id (int): The row id of the exported file to view Optional parameters: None Returns: download ``` rrrjrrrrrrcsvrrrzz c3fK|])}ddj|jzdz+yw)zN)rNvalues)rrs rfrz+WebInterface.view_export..s2-eVY)9)9#**,)G G' Q-es/1z
z z
z z
aNz{style}
{table}
)styletablerr)rrr'zapplication/xml;charset=UTF-8m3uztext/plain;charset=UTF-8r Export is still being processed.riExport failed to process.Export file does not exist.Invalid export_id provided.rrr)r get_exportget_export_filepathrr DictReaderrN fieldnamesr~rrwrrRrrrr) rrrarfilepathinfilereaderrrrs rf view_exportzWebInterface.view_exports $$y9 fZ(A-&2B6RdKe33F7OVKEXZ`akZlmHm$-(C':'f ^^F3F-',,V->->?@,-(,,-e]c-eee , ,E 'E'399U9SS &&0!( 1CRrss &%/!( 1CRqrr &%/!( 1CRlmm0&**Z0A58FJJz2b81 8 4338XH   % %n 5::SABII'R RI''s "AF,,F5c :tj|}|r|ddk(r|dr|ds|ds |ds|drtj|d |d }tj|}d j |}t }t j|d }tj|||jt|jd d|Stj|d |d |d} t| |dS|r|jddk(rd} n1|r|jddk(rd} n|r|jdsd} nd} dt j"j$d<t'j(d| dj+dS)a* Download an exported metadata file ``` Required parameters: export_id (int): The row id of the exported file to download Optional parameters: None Returns: download ``` rrrjrrrrrrrz{}.ziprzapplication/zip attachment)r dispositionrrrrrrirrrrrrrr)rrformat_export_directoryget_export_dirpathr~rzipfileZipFilerzipdirrrgetvaluerrrwrrRrrrr) rrrar directorydirpath zip_filenamebuffertemp_ziprrs rfdownload_exportzWebInterface.download_exports"$$y9 fZ(A-&2Bm${(;vl?SW]^pWq$<z)rbuild_export_docsrs rf exporter_docszWebInterface.exporter_docsVs3355@@r)NN)TTr)rrr)rF)rr9 )rxr)N10)NNNr)NF)NNN)NNr)NNNN)30Nr9N)12r9NN)rr9NN)rN)r)rrrrr)NrzTest notificationrrJ)NNNNFNr)NNF)NNr)NNNrrFF)FFF)NNNNN)rN)rr) NNiid000000rpngNFF)rrF)rrNN)F)rxrxrr) Nrr9rrrNNNN)Nrrrr)NNNFF)NNNNNN) NNNrrjrjrrrrrF)rrrr6authrrrr7rr8rtoolsjson_outrr-rrrrrrrrrrr!r&r(rr1rDrIrLrXr]rerlrqrwryrrrrrrrrrrrrr'rrrrrrrrrrrrrrrrrrr-r2r5r:r>rrCrKrNrRrVrYr\r_rbrerirkrmrorqrxr}rrrrrrrrrrrrrrMrSrXr?r^rarcrfrtrvrxr{r~rrrrrrrrrrrrrrrrrrrrrr rrrrLrOrRr]rvr~rrBr_rrrrrr'rrrrrrrrrrrrr rrrr$r&rr,r2rr=r?rArDrrrKrNrrSrVrXrZr\rlrprsrvrvr r|rrrrrrrrrrrrrrrrrrrrrrrrrrrrrrJrrfrrs2  DI__]FF__7#$`%`$__ ^^7#$%__ ^^7#$  ! !%! L__] W W__ ^^] Z>__] T T__] ` `__ ^^7#$ ZR%R2__7#$ \% \__]____]jj__] R R__ ^^7#$ Zg%g__ ^^7#$ ZL%L__ ^^7#$ ZR%R__]QQ__ ^^]^ #$Q% Qf__ ^^7#$^ !"#% 8__ ^^7#$W%W__]rr,__7#$ r% r__7#$ Z#3%#3J__]nn __]ll __]ss __]rr __ ^^7#$ Z\%\|__ ^^] %&'B__ ^^] #$!%!F__ ^^7#$#%#:__ ^^7#$ Z*Q%*QX__ ^^7#$ Z,Z%,Z\__ ^^7#$ Z*T%*TX__ ^^7#$ Zf%f2__ ^^7#$ Zf%f2__ ^^7#$ Zo%o2__ ^^7#$ Z[%[:__ ^^7#$Z%Z__]II__ ^^]^  R! Rh__ ^^7#$S%S__]ZZ"__7#$ }% }__7#$ Z%&%%&N__]nn __]kk __]ss __ ^^]^ ZA AF__ ^^]^ Z: :x__ ^^7#$ ZT%T,__ ^^7#$ Z+K%+KZ__ ^^7#$ Z+T%+TZ__ ^^7#$ Z*T%*TX__ ^^7#$ ZU%U0__ ^^7#$ ZU%U0__ ^^7#$ Ze%e8__]\\__ ^^]^ Zl l\__]rr__ ^^]  K!KZ__]MM__ ^^7#$ J %J:__]KK__ ^^]^ Z 0__ ^^] Z&&P__ ^^] Z&&P__ ^^] Z&&P__ ^^] Z&&P__ ^^] Z&&P__ ^^] Z&&P__ ^^] Z%%N__ ^^] Z  D__ ^^] Z%%N__ ^^] Z%%N__ ^^] Z%%N__ ^^] Z%%N__]kk__]OO__ ^^^]$__ ^^7#$ "#T$%T6__7#$e%e__7#$? %? B__ ^^7#$ Z % D__ ^^7#$^ Z7!% 7!r__ ^^7#$^ Z9% 9v__ ^^7#$ Z/%/*__ ^^7#$ Z/%/*__ ^^7#$ Z/%/*__ ^^7#$2%2(__7#$ ?% ?__]""__7#$ )% )"__7#$e%e*__ ^^7#$PC%PCd__ ^^7#$+%+ __ ^^7#$% __ ^^7#$I%I__ ^^7#$K%K__7#$H%H__7#$D%D__7#$M%M__ ^^7#$ R% R__ ^^7#$M%M__ ^^7#$ Z%2__7#$[%[__ ^^7#$ ZP%P(__ ^^7#$ Z)%)V__7#$l%l__ ^^7#$ ZW%W*__ ^^7#$ ZX%X@__7#$g%g(__ ^^7#$ Z%2__ ^^7#$%N%%NN__ ^^7#$ % __ ^^7#$ W% W__7#$ G% G__ ^^7#$R%R__7#$ % __ ^^7#$U%U__7#$ '% '__7#$^%^__ ^^7#$ L% L__7#$X%X __ ^^7#$ ZS%S*__ ^^7#$ ZN%N,X__2*D12 __ ^^7#$ Zdi@A`S%3 `SD__ ^^7#$ Z,C%,C\__7#$ % __7#$i%i__ ^^7#$ C% C__ ^^7#$ ZUV49X%Xt__ ^^7#$ Z%<__7#$ Z%*__ ^^7#$% __ ^^7#$ ZA%AF f__7#$E%E__7#$A%A__7#$?%?__7#$ O% O__7#$\%\__7#$D%D __7#$ k% k"__],8,8\__] m m__]ee__] n n__] l l__ ^^7#$ Z4W%4Wl__ ^^7#$ Z.Q%.Q`__ ^^7#$ %&J'%JX__ ^^7#$ %&#J'%#JJ__ 3 3 PTRW@EwM!wMr__4__7#$ Z=%=,__7#$ ZA%A0__7#$ Z\%\@__7#$ Z>%><__ ^^7#$ Z2%2__ ^^7#$ Z2%20__ ^^7#$ ZU%U<__ ^^7#$ ZS%S>__]XX__ ^^7#$ h#%#J__]xx(__7#$ r% r__ ^^7#$ Z#3%#3L__ ^^7#$ Z%4__ ^^7#$ Z%4__ ^^7#$ % __ ^^7#$ nY%Yv__ ^^7#$ "#X$%Xt__ ^^7#$ I% I__ ^^7#$ I% I__ ^^7#$ H% H__ ^^7#$G%G__ ^^7#$D%D__ ^^7#$ Z%<__ ^^7#$ Z%6__ ^^7#$ Z%,__ ^^] ZnQnQ` __ ^^7#$ o"%"H__ ^^7#$ k,%,\__ ^^7#$^ Z2% 2h__ ^^7#$Q%Q__ ^^7#$ ZFM>@IMq%qf__7#$ h()%()X__ll__ ^^7#$ Z*%*6__ ^^7#$ Z%>__ ^^] Z&j&jP__ ^^] ZB__ ^^7#$(%(__ ^^7#$ Z%4__7#$_%___ ^^7#$ ZR%R(__ ^^7#$ Z'%'R__7#$Y%Y__ ^^7#$ ZO%O*__ ^^7#$ ZP%P0__ ^^7#$#P%#PJ__99&__]0__7#$-%- __7#$LP+0P%P<__7#$M%M__ ^^ Z""H__ ^^ Z,__ ^^7#$ !"J#%JX__7#$NR>B*. R% R__ ^^7#$ Z%<__ ^^7#$ ZZ_;rKrgrTobjectrrrJrrfr1s$    "II&'&v "%%'##ttkk\\ ??i __ >. @ P6 P@oA6@oAr