gmddlZddlZddlmZddlZddlmZmZmZm Z m Z m Z ddl m Z ddlmZmZmZmZddlmZddlmZdZe j2Gd d e ZGd d e Zy) N) ElementTree) BASE_HEADERSCONFIGTIMEOUTlog logfilterutils) PlexObject) BadRequestNotFound Unauthorized Unsupported) PlayQueue)_codesvideoceZdZdZdZdZ d4fd ZdZd5dZdZ d Z d Z d6d Z d7d Z d5d Zd8dZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZefdZ efdZ!efd Z"efd!Z#efd"Z$efd#Z%efd$Z&efd%Z'efd&Z(efd'Z)efd(Z*efd)Z+efd*Z,efd+Z-efd,Z.efd-Z/d9d.Z0dddefd/Z1dddefd0Z2d9d1Z3e4d2Z5d:d3Z6xZ7S); PlexClientah Main class for interacting with a Plex client. This class can connect directly to the client and control it or proxy commands through your Plex Server. To better understand the Plex client API's read this page: https://github.com/plexinc/plex-media-player/wiki/Remote-control-API Parameters: server (:class:`~plexapi.server.PlexServer`): PlexServer this client is connected to (optional). data (ElementTree): Response from PlexServer used to build this object (optional). initpath (str): Path used to generate data. baseurl (str): HTTP URL to connect directly to this client. identifier (str): The resource/machine identifier for the desired client. May be necessary when connecting to a specific proxied client (optional). token (str): X-Plex-Token used for authentication (optional). session (:class:`~requests.Session`): requests.Session object if you want more control (optional). timeout (int): timeout in seconds on initial connect to client (default config.TIMEOUT). Attributes: TAG (str): 'Player' key (str): '/resources' device (str): Best guess on the type of device this is (PS, iPhone, Linux, etc). deviceClass (str): Device class (pc, phone, etc). machineIdentifier (str): Unique ID for this device. model (str): Unknown platform (str): Unknown platformVersion (str): Description product (str): Client Product (Plex for iOS, etc). protocol (str): Always seems ot be 'plex'. protocolCapabilities (list): List of client capabilities (navigation, playback, timeline, mirror, playqueues). protocolVersion (str): Protocol version (1, future proofing?) server (:class:`~plexapi.server.PlexServer`): Server this client is connected to. session (:class:`~requests.Session`): Session object used for connection. state (str): Unknown title (str): Name of this client (Johns iPhone, etc). token (str): X-Plex-Token used for authentication vendor (str): Unknown version (str): Device version (4.6.1, etc). _baseurl (str): HTTP address of the client. _token (str): Token used to access this client. _session (obj): Requests session object used to access this client. _proxyThroughServer (bool): Set to True after calling :func:`~plexapi.client.PlexClient.proxyThroughServer` (default False). Playerz /resourcesNc tt| ||||r|jdnd|_||_t j||_tjddjdk(|_ |r |jnd} |xs| xstj|_ | xst |_d|_d|_d|_g|_d|_| t/j0| nd|_t5|du|||gsHtjdd|_t jtjd |_|r |jr|j7| yyy) N/zlog.show_secretstrueFrzauth.client_baseurlzhttp://localhost:32433zauth.client_tokentimeout)superr__init__strip_baseurl_clientIdentifierr add_secret_tokenrgetlower _showSecrets_sessionrequestsSessionr_timeout_proxyThroughServer _commandId _last_call_timeline_cache_timeline_cache_timestampweakrefref_parentanyconnect) selfserverdatainitpathbaseurl identifiertokenr2sessionrparentserver_session __class__s #/opt/Tautulli/lib/plexapi/client.pyrzPlexClient.__init__As< j$(x@.5 c*4 !+**51 "JJ'92>DDF&P,2G>GX5E5E5G *7 #( !)*&.4.@w{{6*d D$h?@"JJ'<>VWDM#..vzz:M/NODK t}} LLL )%7cD|xjdz c_|jS)N)r*r3s r>_nextCommandIdzPlexClient._nextCommandIdXs 1r?cjs tdj_jj|}|t dj j r z%PlexClient.connect..is5xx||$78Dr2zPlexClient.connect\s xxMN Nzz$((Gz4 <1$--AB B  ! !!  F~-d.D.D-E^TXTaTaSbc!WF v r?c"|jS)z Alias to self.connect(). )r2rBs r>reloadzPlexClient.reloadys||~r?cB||_|jjd|_|jjd|_|jjd|_|jjd|_|jjddjd|_|jjd|_ |jjd |_ |jjd |_ |jjd xs|jjd |_ |jjd |_ |jjd|_|jjd|_|jjd|_|jjd|_|jjd|_t'j(t*|jjdd|_t'j(t*|jjdd|_t'j(t*|jjdd|_|jjd|_|jjd|_|jjd|_y)z/ Load attribute values from Plex XML response. deviceClassrFproductprotocolprotocolCapabilitiesr,protocolVersionplatformplatformVersiontitlenamedeviceprofilemodelstatevendorversionlocalrrelayedsecureaddressremotePublicAddressuserIDN)_datarGr"rTrFrUrVsplitrWrYrZr[r\r^r_r`rarbrcr castboolrdrerfrgrhrir3r5s r>rOzPlexClient._loadData}s ;;??=9!%1D!E{{y1   3 $(KKOO4JB$O$U$UVY$Z!#{{/@A  3 #{{/@A[[__W-H1H kkooh/ {{y1 [[__W- [[__W- kkooh/ {{y1 ZZdkkoogq&AB zz$  1(EF jjt{{x'CD {{y1 #';;??3H#I kkooh/ r?c jt}|jr|j|d<|j||S)z< Returns a dict of all default headers for Client requests. z X-Plex-Token)rr!update)r3kwargsheaderss r>_headerszPlexClient._headerss- ;;&*kkGN #vr?cZ|r||_|dur|js td||_y)a Tells this PlexClient instance to proxy all future commands through the PlexServer. Useful if you do not wish to connect directly to the Client device itself. Parameters: value (bool): Enable or disable proxying (optional, default True). Raises: :exc:`~plexapi.exceptions.Unsupported`: Cannot use client proxy with unknown server. Tz,Cannot use client proxy with unknown server.N)_serverrr))r3valuer4s r>proxyThroughServerzPlexClient.proxyThroughServers/ !DL D=LM M#( r?c |j|}|xs|jj}|xs |j}t j d|j j||jdi|xsi}||f||d|}|jdvrtj|jd}|jjdd} d|jd|d |jd| } |jd k(r t| |jd k(r t| t| t!j"|jj%d } | j'rt)j*| Sd S)z Main method used to handle HTTPS requests to the Plex client. This method helps by encoding the response to utf-8 and parsing the returned XML into and ElementTree object. Returns None if no data exists in the response. z%s %s)rrr)r  (z) z; iiutf8N)urlr%r"r(rdebug__name__upperrs status_codecodestextreplacer r r r cleanXMLStringencoderr fromstring) r3pathmethodrrrrqrresponsecodenameerrtextmessager5s r>rMzPlexClient.querys] hhtn,4==,,*T]] '6??002C8$--0'-R0#JwJ6J    6yy!5!56q9Hmm++D#6G(../r(2hll^1WIVG##s*"7++%%,w'' ))##HMM299&A/3zz|{%%d+EEr?c |jd}|jdd}d|ji}||jvr!t j d|j || |jn|}|r|jjn |j}tj}|dk(r||_ nH||jz dk\r6|jdvr(||_ |jtjd |j!|d <d |t#j$|} ||| S#t&j($r|jd vrYywxYw)aw Convenience wrapper around :func:`~plexapi.client.PlexClient.query` to more easily send simple commands to the client. Returns an ElementTree object containing the response. Parameters: command (str): Command to be sent in for format '/'. proxy (bool): Set True to proxy this command through the PlexServer. **params (dict): Additional GET parameters to include with the command. Raises: :exc:`~plexapi.exceptions.Unsupported`: When we detect the client doesn't support this capability. rrzX-Plex-Target-Client-IdentifierzHClient %s doesn't support %s controller. What your trying might not workN timeline/pollP)ptpzPlex Media Playerwait commandIDz/player/)rr)PlexampzPlex for Android (TV)zPlex for Android (Mobile)zPlex for Samsung)rrkrFrWrrr\r)rurMtimer+rU sendCommandClientTimelinerKrCr joinArgsr ParseError) r3commandproxyparams controllerrrrMtrKs r>rzPlexClient.sendCommandsL--$]]3'* 4d6L6LM T66 6 II`bfblblnx y,1M((u&+ "" IIK o %DO  B &4<<;W+WDO   ^//a  8"113{ %.."8!9: g. .%% ||    s. D88!EEc|js td|jr5|s |jr'd|vrdnd}|j||d|jS|j|S)z Build a URL string with proper token argument. Token will be appended to the URL if either includeToken is True or CONFIG.log.show_secrets is 'true'. z"PlexClient object missing baseurl.?&z X-Plex-Token=)rr r!r$)r3rK includeTokendelims r>rzPlexClient.urlsi}}AB B ;;LD,=,=#:C3Emm_SE% dkk]K K--&&r?c&|jdy)z& Open the context menu on the client. znavigation/contextMenuNrrBs r> contextMenuzPlexClient.contextMenu s 12r?c&|jdy)z Navigate back one position. znavigation/backNrrBs r>goBackzPlexClient.goBack  *+r?c&|jdy)z! Go directly to the home screen. znavigation/homeNrrBs r>goToHomezPlexClient.goToHomerr?c&|jdy)z) Go directly to the playing music panel. znavigation/musicNrrBs r> goToMusiczPlexClient.goToMusics +,r?c&|jdy)z! Move selection down a position. znavigation/moveDownNrrBs r>moveDownzPlexClient.moveDown ./r?c&|jdy)z! Move selection left a position. znavigation/moveLeftNrrBs r>moveLeftzPlexClient.moveLeftrr?c&|jdy)z" Move selection right a position. znavigation/moveRightNrrBs r> moveRightzPlexClient.moveRight! /0r?c&|jdy)z Move selection up a position. znavigation/moveUpNrrBs r>moveUpzPlexClient.moveUp% ,-r?c&|jdy)z& Jump to next letter in the alphabet. znavigation/nextLetterNrrBs r> nextLetterzPlexClient.nextLetter)s 01r?c&|jdy)z" Move selection down a full page. znavigation/pageDownNrrBs r>pageDownzPlexClient.pageDown-rr?c&|jdy)z Move selection up a full page. znavigation/pageUpNrrBs r>pageUpzPlexClient.pageUp1rr?c&|jdy)z* Jump to previous letter in the alphabet. znavigation/previousLetterNrrBs r>previousLetterzPlexClient.previousLetter5s 45r?c&|jdy)z) Select element at the current position. znavigation/selectNrrBs r>selectzPlexClient.select9rr?c&|jdy)z/ Toggle the on screen display during playback. znavigation/toggleOSDNrrBs r> toggleOSDzPlexClient.toggleOSD=rr?c 4|jjjd}|jj|dj d|d|j |dd|}|jj }|r||d<|jd i|y) z Navigate directly to the specified media page. Parameters: media (:class:`~plexapi.media.Media`): Media object to navigate to. **params (dict): Additional GET parameters to include with the command. :rArr)rFrgportrKrVr9N)zmirror/details)rurrkrFrrK createTokenr)r3mediar server_urlrr9s r> goToMediazPlexClient.goToMediaAs]]++11#6 !&!@!@!!}**3/rN99"1     ))+ $GG 5W5r?c*|jd|y)z Pause the currently playing media type. Parameters: mtype (str): Media type to take action against (music, photo, video). zplayback/pausetypeNrr3mtypes r>pausezPlexClient.pause]s )6r?c*|jd|y)z Start playback for the specified media type. Parameters: mtype (str): Media type to take action against (music, photo, video). z playback/playrNrrs r>playzPlexClient.playe u5r?c,|jd||y)z Refresh the specified Playqueue. Parameters: playQueueID (str): Playqueue ID. mtype (str): Media type to take action against (music, photo, video). zplayback/refreshPlayQueue) playQueueIDrNr)r3rrs r>refreshPlayQueuezPlexClient.refreshPlayQueuems  '[u  Nr?c,|jd||y)z Seek to the specified offset (ms) during playback. Parameters: offset (int): Position to seek to (milliseconds). mtype (str): Media type to take action against (music, photo, video). zplayback/seekTo)offsetrNr)r3rrs r>seekTozPlexClient.seekTows *6Fr?c*|jd|y)z Skip to the next playback item. Parameters: mtype (str): Media type to take action against (music, photo, video). zplayback/skipNextrNrrs r>skipNextzPlexClient.skipNext ,59r?c*|jd|y)z Skip to previous playback item. Parameters: mtype (str): Media type to take action against (music, photo, video). zplayback/skipPreviousrNrrs r> skipPreviouszPlexClient.skipPreviouss 0u=r?c,|jd||y)z Skip to the playback item with the specified key. Parameters: key (str): Key of the media item to skip to. mtype (str): Media type to take action against (music, photo, video). zplayback/skipTo)rKrNr)r3rKrs r>skipTozPlexClient.skipTos *%@r?c*|jd|y)z Step backward a chunk of time in the current playback item. Parameters: mtype (str): Media type to take action against (music, photo, video). zplayback/stepBackrNrrs r>stepBackzPlexClient.stepBackrr?c*|jd|y)z Step forward a chunk of time in the current playback item. Parameters: mtype (str): Media type to take action against (music, photo, video). zplayback/stepForwardrNrrs r> stepForwardzPlexClient.stepForwards /estopzPlexClient.stoprr?c*|j||y)z Enable repeat for the specified playback items. Parameters: repeat (int): Repeat mode (0=off, 1=repeatone, 2=repeatall). mtype (str): Media type to take action against (music, photo, video). )repeatrN setParameters)r3rrs r> setRepeatzPlexClient.setRepeat &6r?c*|j||y)z Enable shuffle for the specified playback items. Parameters: shuffle (int): Shuffle mode (0=off, 1=on) mtype (str): Media type to take action against (music, photo, video). )shufflerNr)r3rrs r> setShufflezPlexClient.setShuffles 7%8r?c*|j||y)z Enable volume for the current playback item. Parameters: volume (int): Volume level (0-100). mtype (str): Media type to take action against (music, photo, video). )volumerNr)r3rrs r> setVolumezPlexClient.setVolumerr?c*|j||y)a Select the audio stream for the current playback item (only video). Parameters: audioStreamID (str): ID of the audio stream from the media object. mtype (str): Media type to take action against (music, photo, video). ) audioStreamIDrN setStreams)r3rrs r>setAudioStreamzPlexClient.setAudioStream m5Ar?c*|j||y)a Select the subtitle stream for the current playback item (only video). Parameters: subtitleStreamID (str): ID of the subtitle stream from the media object. mtype (str): Media type to take action against (music, photo, video). )subtitleStreamIDrNr)r3rrs r>setSubtitleStreamzPlexClient.setSubtitleStreams )9Gr?c*|j||y)a Select the video stream for the current playback item (only video). Parameters: videoStreamID (str): ID of the video stream from the media object. mtype (str): Media type to take action against (music, photo, video). ) videoStreamIDrNr)r3rrs r>setVideoStreamzPlexClient.setVideoStreamrr?c |jjjd}|djd}t |dr |j }n6t |tr|jdj}n |j}|dk(rd}t |tr|n|jj|}d|jj|d|d jd|||jxs|jj|d |jd d |}|jj} | r| |d <|j di|y)aZ Start playback of the specified media item. See also: Parameters: media (:class:`~plexapi.media.Media`): Media item to be played back (movie, music, photo, playlist, playqueue). offset (int): Number of milliseconds at which to start playing with zero representing the beginning (default 0). **params (dict): Optional additional parameters to include in the playback request. See also: https://github.com/plexinc/plex-media-player/wiki/Remote-control-API#modified-commands rrr playlistTyperaudiomusiczcom.plexapp.plugins.libraryrAz /playQueues/z?window=100&own=1) providerIdentifierrFrVrgrrrKr containerKeyr9N)zplayback/playMedia)rurrkrhasattrr isinstanceritemslistTypecreatePlayQueuerFrK selectedItemrrr) r3rrrr server_port mediatype playqueuerr9s r> playMediazPlexClient.playMedias?]]++11#6  n**3/ 5. )**I%+!KKN33 !NN   I'y9Eu}}?\?\]b?c "?!&!@!@"1 !!}**3/99: 6 6 : :*9+@+@*AARS     ))+ $GG 99r?cdi}|||d<|||d<|||d<|||d<|jdi|y)a Set multiple playback parameters at once. Parameters: volume (int): Volume level (0-100; optional). shuffle (int): Shuffle mode (0=off, 1=on; optional). repeat (int): Repeat mode (0=off, 1=repeatone, 2=repeatall; optional). mtype (str): Media type to take action against (optional music, photo, video). Nrrrr)zplayback/setParametersr)r3rrrrrs r>rzPlexClient.setParameterss[  %F8    'F9   %F8   "F6NrzPlexClient.setStreams(s\  $&3F? #  ')9F% &  $&3F? #  "F6N9&9r?ctj}||jz dkDrK||_|jtj|xsg}|Dcgc]}t||c}|_|j Scc}w)zPoll the client's timelines, create, and return timeline objects. Some clients may not always respond to timeline requests, believe this to be a Plex bug. rAr)rr-rrrKr,)r3rr timelinesr5s r>rzPlexClient.timelines>sv IIK t-- - 1-.D *((););$(GM2IKT#U4N4$>#UD ###$VsA>cDtd|jDdS)z#Returns the active timeline object.c3@K|]}|jdk7s|yw)stoppedN)ra)rHrIs r>rJz&PlexClient.timeline..NsI1AGGy4HQIsN)rNrrBs r>timelinezPlexClient.timelineKsI 0I4PPr?cbt|jdd}t|dk(xs |xr|dk(S)zReturns True if any media is currently playing. Parameters: includePaused (bool): Set True to treat currently paused items as playing (optional; default True). raNplayingpaused)getattrrrm)r3 includePausedras r>isPlayingMediazPlexClient.isPlayingMediaPs5 w5EY&O=+NUh=NPPr?) NNNNNNTNNN)N)TN)NNN)F)r)T)8r __module__ __qualname____doc__TAGrKrrCr2rRrOrsrwrMrrrrrrrrrrrrrrrrr DEFAULT_MTYPErrrrrrrrrrrrrrrrrrrrpropertyrr# __classcell__)r=s@r>rrs*V C CFJKO*.:0<) F0.` '3,,-001.20.6.168(7'63@N$1G+:"/>!.A+:!.='6'47)69'473@B9FH3@B+:Z$(d-=((,dRV^k:, $QQQr?rceZdZdZdZdZy)rzGet the timeline's attributes.rc" ||_|jjd|_t j t |jjd|_t j t|jjd|_ |jjd|_ |jjd|_ t j t |jjd|_ |jjd|_ |jjd|_|jjd |_|jjd |_t j t |jjd |_t j t |jjd |_t j t |jjd |_t j t |jjd|_t j t |jjd|_t j t |jjd|_|jjd|_|jjd|_t j t |jjd|_t j t |jjd|_|jjd|_t j t|jjd|_|jjd|_|jjd|_|jjd|_t j t |jjd|_ t j t |jjd|_!|jjd|_"t j t |jjd|_#y)Nrg audioStreamIdautoPlayr  controllabledurationitemTyperKlocationrF partCount partIndexrplayQueueItemIDplayQueueVersionrrVr  ratingKeyr seekRangerra subtitleColorsubtitlePosition subtitleSizerrr)$rjrGr"rgr rlintr-rmr.r r/r0r1rKr2rFr3r4rr5r6rrVr r7rr8rrar9r:r;rrrrns r>rOzClientTimeline._loadData`s {{y1 "ZZT[[___-MN 4)DE  KKOON; KKOON; 3  (CD   3 ;;??5)  3 !%1D!EC)EFC)EF ::c4;;??=+IJ$zz#t{{?P/QR % 3 @R0S TJJsDKKOOF$;<   3 "&++//2F"GC)EFjjdkkooh&?@ 5zz$  (BC [[__W- ![[___= $ 0B C!JJsDKKOON,KLJJsDKKOOF$;< KKOOF+ jjdkkooh&?@ r?N)rr$r%r&rKrOrr?r>rr[s( CAr?r)rr. xml.etreerr&plexapirrrrrr plexapi.baser plexapi.exceptionsr r r rplexapi.playqueuerrequests.status_codesrrr(registerPlexObjectrrrr?r>rDsa !HH#NN'1 F QF QF QR#AZ#Ar?