overseerr.php 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524
  1. <?php
  2. trait OverseerrHomepageItem
  3. {
  4. public function overseerrSettingsArray($infoOnly = false)
  5. {
  6. $homepageInformation = [
  7. 'name' => 'Overseerr',
  8. 'enabled' => strpos('personal', $this->config['license']) !== false,
  9. 'image' => 'plugins/images/tabs/overseerr.png',
  10. 'category' => 'Requests',
  11. 'settingsArray' => __FUNCTION__
  12. ];
  13. if ($infoOnly) {
  14. return $homepageInformation;
  15. }
  16. $homepageSettings = [
  17. 'debug' => true,
  18. 'settings' => [
  19. 'Enable' => [
  20. $this->settingsOption('enable', 'homepageOverseerrEnabled'),
  21. $this->settingsOption('auth', 'homepageOverseerrAuth'),
  22. $this->settingsOption('notice', '', ['title' => 'Attention', 'body' => 'Since Organizr supports multiple Request Providers, You must now select which service you want to submit requests through']),
  23. $this->settingsOption('select', 'defaultRequestService', ['label' => 'Default Request Service', 'options' => $this->requestServiceOptions()]),
  24. ],
  25. 'Connection' => [
  26. $this->settingsOption('url', 'overseerrURL'),
  27. $this->settingsOption('token', 'overseerrToken'),
  28. $this->settingsOption('username', 'overseerrFallbackUser', ['label' => 'Overseerr Fallback User', 'help' => 'Organizr will request an Overseerr User Token based off of this user credentials']),
  29. $this->settingsOption('password', 'overseerrFallbackPassword', ['label' => 'Overseerr Fallback Password',]),
  30. $this->settingsOption('disable-cert-check', 'overseerrDisableCertCheck'),
  31. $this->settingsOption('use-custom-certificate', 'overseerrUseCustomCertificate'),
  32. ],
  33. 'Misc Options' => [
  34. $this->settingsOption('auth', 'homepageOverseerrRequestAuth', ['label' => 'Minimum Group to Request']),
  35. $this->settingsOption('select', 'overseerrTvDefault', ['label' => 'TV Show Default Request', 'options' => $this->requestTvOptions(true)]),
  36. $this->settingsOption('switch', 'overseerrLimitUser', ['label' => 'Limit to User']),
  37. $this->settingsOption('limit', 'overseerrLimit'),
  38. $this->settingsOption('refresh', 'overseerrRefresh'),
  39. ],
  40. 'Default Filter' => [
  41. $this->settingsOption('switch', 'overseerrDefaultFilterAvailable', ['label' => 'Show Available', 'help' => 'Show All Available Overseerr Requests']),
  42. $this->settingsOption('switch', 'overseerrDefaultFilterUnavailable', ['label' => 'Show Unavailable', 'help' => 'Show All Unavailable Overseerr Requests']),
  43. $this->settingsOption('switch', 'overseerrDefaultFilterApproved', ['label' => 'Show Approved', 'help' => 'Show All Approved Overseerr Requests']),
  44. $this->settingsOption('switch', 'overseerrDefaultFilterUnapproved', ['label' => 'Show Unapproved', 'help' => 'Show All Unapproved Overseerr Requests']),
  45. $this->settingsOption('switch', 'overseerrDefaultFilterDenied', ['label' => 'Show Denied', 'help' => 'Show All Denied Overseerr Requests']),
  46. ],
  47. 'Test Connection' => [
  48. $this->settingsOption('blank', null, ['label' => 'Please Save before Testing']),
  49. $this->settingsOption('test', 'overseerr'),
  50. ]
  51. ]
  52. ];
  53. return array_merge($homepageInformation, $homepageSettings);
  54. }
  55. public function testConnectionOverseerr()
  56. {
  57. if (!$this->homepageItemPermissions($this->overseerrHomepagePermissions('test'), true)) {
  58. return false;
  59. }
  60. $headers = array(
  61. "Accept" => "application/json",
  62. "X-Api-Key" => $this->config['overseerrToken'],
  63. );
  64. $url = $this->qualifyURL($this->config['overseerrURL']);
  65. try {
  66. $options = $this->requestOptions($url, null, $this->config['overseerrDisableCertCheck'], $this->config['overseerrUseCustomCertificate']);
  67. $test = Requests::get($url . "/api/v1/settings/main", $headers, $options);
  68. if ($test->success) {
  69. $this->setAPIResponse('success', 'API Connection succeeded', 200);
  70. return true;
  71. } else {
  72. $this->setResponse(401, 'API Connection failed');
  73. return false;
  74. }
  75. } catch (Requests_Exception $e) {
  76. $this->writeLog('error', 'Overseerr Connect Function - Error: ' . $e->getMessage(), 'SYSTEM');
  77. $this->setResponse(500, $e->getMessage());
  78. return false;
  79. }
  80. }
  81. public function overseerrHomepagePermissions($key = null)
  82. {
  83. $permissions = [
  84. 'main' => [
  85. 'enabled' => [
  86. 'homepageOverseerrEnabled'
  87. ],
  88. 'auth' => [
  89. 'homepageOverseerrAuth'
  90. ],
  91. 'not_empty' => [
  92. 'overseerrURL',
  93. 'overseerrToken'
  94. ]
  95. ],
  96. 'request' => [
  97. 'enabled' => [
  98. 'homepageOverseerrEnabled'
  99. ],
  100. 'auth' => [
  101. 'homepageOverseerrAuth',
  102. 'homepageOverseerrRequestAuth'
  103. ],
  104. 'not_empty' => [
  105. 'overseerrURL',
  106. 'overseerrToken'
  107. ]
  108. ],
  109. 'test' => [
  110. 'not_empty' => [
  111. 'overseerrURL',
  112. 'overseerrToken'
  113. ]
  114. ]
  115. ];
  116. return $this->homepageCheckKeyPermissions($key, $permissions);
  117. }
  118. public function homepageOrderoverseerr()
  119. {
  120. if ($this->homepageItemPermissions($this->overseerrHomepagePermissions('main'))) {
  121. return '
  122. <div id="' . __FUNCTION__ . '">
  123. <div class="white-box homepage-loading-box"><h2 class="text-center" lang="en">Loading Requests...</h2></div>
  124. <script>
  125. // Overseerr Requests
  126. homepageRequests("overseerr", "' . $this->config['overseerrRefresh'] . '");
  127. // End Overseerr Requests
  128. </script>
  129. </div>
  130. ';
  131. }
  132. }
  133. public function getOverseerrRequests($limit = 50, $offset = 0)
  134. {
  135. if (!$this->homepageItemPermissions($this->overseerrHomepagePermissions('main'), true)) {
  136. return false;
  137. }
  138. $limit = is_numeric($limit) ? (int)$limit : 50;
  139. $offset = is_numeric($offset) ? (int)$offset : 0;
  140. $api['count'] = [
  141. 'movie' => 0,
  142. 'tv' => 0,
  143. 'limit' => $limit,
  144. 'offset' => $offset
  145. ];
  146. $headers = [
  147. "Accept" => "application/json",
  148. "X-Api-Key" => $this->config['overseerrToken'],
  149. ];
  150. $requests = [];
  151. $url = $this->qualifyURL($this->config['overseerrURL']);
  152. try {
  153. $options = $this->requestOptions($url, $this->config['overseerrRefresh'], $this->config['overseerrDisableCertCheck'], $this->config['overseerrUseCustomCertificate']);
  154. $request = Requests::get($url . "/api/v1/request?take=" . $limit, $headers, $options);
  155. if ($request->success) {
  156. $requestsData = json_decode($request->body, true);
  157. foreach ($requestsData['results'] as $key => $value) {
  158. $requester = ($value['requestedBy']['username'] !== '') ? $value['requestedBy']['username'] : $value['requestedBy']['plexUsername'];
  159. $requesterEmail = $value['requestedBy']['email'];
  160. $proceed = (($this->config['overseerrLimitUser']) && strtolower($this->user['username']) == strtolower($requester)) || (strtolower($requester) == strtolower($this->config['overseerrFallbackUser'])) || (!$this->config['overseerrLimitUser']) || $this->qualifyRequest(1);
  161. if ($proceed) {
  162. $requestItem = Requests::get($url . '/api/v1/' . $value['type'] . '/' . $value['media']['tmdbId'], $headers, $options);
  163. $requestsItemData = json_decode($requestItem->body, true);
  164. if ($requestItem->success) {
  165. $api['count'][$value['type']]++;
  166. $requests[] = array(
  167. 'id' => $value['media']['tmdbId'],
  168. 'title' => ($value['type'] == 'movie') ? $requestsItemData['title'] : $requestsItemData['name'],
  169. 'overview' => $requestsItemData['overview'],
  170. 'poster' => (isset($requestsItemData['posterPath']) && $requestsItemData['posterPath'] !== '') ? 'https://image.tmdb.org/t/p/w300/' . $requestsItemData['posterPath'] : 'plugins/images/cache/no-list.png',
  171. 'background' => (isset($requestsItemData['backdropPath']) && $requestsItemData['backdropPath'] !== '') ? 'https://image.tmdb.org/t/p/w1280/' . $requestsItemData['backdropPath'] : '',
  172. 'approved' => $value['status'] == 2,
  173. 'available' => $value['media']['status'] == 5,
  174. 'denied' => $value['status'] == 3,
  175. 'deniedReason' => 'n/a',
  176. 'user' => $requester,
  177. 'userAlias' => $value['requestedBy']['displayName'],
  178. 'request_id' => $value['id'],
  179. 'request_date' => $value['createdAt'],
  180. 'release_date' => ($value['type'] == 'movie') ? $requestsItemData['releaseDate'] : $requestsItemData['firstAirDate'],
  181. 'type' => $value['type'],
  182. 'icon' => 'mdi mdi-' . ($value['type'] == 'movie') ? 'filmstrip' : 'television',
  183. 'color' => ($value['type'] == 'movie') ? 'palette-Deep-Purple-900 bg white' : 'grayish-blue-bg',
  184. );
  185. }
  186. }
  187. }
  188. //sort here
  189. usort($requests, function ($item1, $item2) {
  190. if ($item1['request_date'] == $item2['request_date']) {
  191. return 0;
  192. }
  193. return $item1['request_date'] > $item2['request_date'] ? -1 : 1;
  194. });
  195. }
  196. } catch (Requests_Exception $e) {
  197. $this->writeLog('error', 'Overseerr Connect Function - Error: ' . $e->getMessage(), 'SYSTEM');
  198. $this->setResponse(500, $e->getMessage());
  199. return false;
  200. }
  201. $api['content'] = isset($requests) ? array_slice($requests, $offset, $limit) : false;
  202. $this->setResponse(200, null, $api);
  203. return $api;
  204. }
  205. public function getDefaultService($services)
  206. {
  207. if (empty($services)) {
  208. return null;
  209. } else {
  210. $default = false;
  211. foreach ($services as $service) {
  212. if ($service['isDefault']) {
  213. $default = (int)$service['id'];
  214. }
  215. }
  216. if ($default) {
  217. return $services[$default];
  218. } else {
  219. return $services[0];
  220. }
  221. }
  222. }
  223. public function addOverseerrRequest($id, $type, $seasons = null)
  224. {
  225. $id = ($id) ?? null;
  226. $type = ($type) ?? null;
  227. if (!$id) {
  228. $this->setAPIResponse('error', 'Id was not supplied', 422);
  229. return false;
  230. }
  231. if (!$type) {
  232. $this->setAPIResponse('error', 'Type was not supplied', 422);
  233. return false;
  234. }
  235. if (!$this->homepageItemPermissions($this->overseerrHomepagePermissions('main'), true)) {
  236. return false;
  237. }
  238. $url = $this->qualifyURL($this->config['overseerrURL']);
  239. try {
  240. if (!isset($_COOKIE['connect_sid']) && !isset($_COOKIE['connect.sid'])) {
  241. $this->setAPIResponse('error', 'User does not have Auth Cookie', 500);
  242. return false;
  243. }
  244. $headers = array(
  245. 'Accept' => 'application/json',
  246. 'Content-Type' => 'application/json',
  247. 'X-Api-Key' => $this->config['overseerrToken']
  248. );
  249. $cookieJar = new Requests_Cookie_Jar(['connect.sid' => $_COOKIE['connect_sid']]);
  250. $optionsUser = $this->requestOptions($url, null, $this->config['overseerrDisableCertCheck'], $this->config['overseerrUseCustomCertificate'], ['cookies' => $cookieJar]);
  251. $optionsAPI = $this->requestOptions($url, null, $this->config['overseerrDisableCertCheck'], $this->config['overseerrUseCustomCertificate']);
  252. // Check if requested already
  253. $searchResponse = Requests::get($url . '/api/v1/request/', $headers, $optionsAPI);
  254. if ($searchResponse->success) {
  255. $details = json_decode($searchResponse->body, true);
  256. if (count($details['results']) > 0) {
  257. foreach ($details['results'] as $k => $v) {
  258. if ($v['media']['tmdbId'] == $id) {
  259. if ($v['media']['status'] == 5) {
  260. $this->setAPIResponse('error', 'Request is already available', 409);
  261. return false;
  262. } else {
  263. $this->setAPIResponse('error', 'Request is already requested', 409);
  264. return false;
  265. }
  266. }
  267. }
  268. }
  269. } else {
  270. $this->setAPIResponse('error', 'Overseerr Connection Error Occurred', 500);
  271. return false;
  272. }
  273. // Get User info
  274. $response = Requests::get($url . '/api/v1/auth/me', [], $optionsUser);
  275. if ($response->success) {
  276. $userInfo = json_decode($response->body, true);
  277. } else {
  278. $this->setResponse(500, 'Error getting user information');
  279. return false;
  280. }
  281. switch ($type) {
  282. case 'season':
  283. case 'tv':
  284. if ($this->config['overseerrTvDefault'] == 'user') {
  285. if ($seasons) {
  286. if (strpos($seasons, ',') !== false) {
  287. $seasonsExplode = explode(',', $seasons);
  288. foreach ($seasonsExplode as $season) {
  289. $seasonsArray[] = (int)$season;
  290. }
  291. $seasons = $seasonsArray;
  292. } else {
  293. $seasonsArray[] = (int)$seasons;
  294. $seasons = $seasonsArray;
  295. }
  296. } else {
  297. $this->setResponse(500, 'Seasons requested was not supplied');
  298. return false;
  299. }
  300. }
  301. $response = Requests::get($url . '/api/v1/tv/' . $id, $headers, $optionsAPI);
  302. if ($response->success) {
  303. $seriesInfo = json_decode($response->body, true);
  304. } else {
  305. $this->setResponse(500, 'Error getting series information');
  306. return false;
  307. }
  308. if ($this->config['overseerrTvDefault'] == 'first') {
  309. $seasons = [1];
  310. } elseif ($this->config['overseerrTvDefault'] == 'last') {
  311. $lastSeason = end($seriesInfo['seasons']);
  312. $lastSeasonNumber = $lastSeason['seasonNumber'];
  313. $seasons = [$lastSeasonNumber];
  314. } elseif ($this->config['overseerrTvDefault'] == 'all') {
  315. $seasons = [];
  316. foreach ($seriesInfo['seasons'] as $season) {
  317. if ($season['seasonNumber'] !== 0) {
  318. $seasons[] = $season['seasonNumber'];
  319. }
  320. }
  321. }
  322. $response = Requests::get($url . '/api/v1/service/sonarr', $headers, $optionsAPI);
  323. if ($response->success) {
  324. $serviceInfo = $this->getDefaultService(json_decode($response->body, true));
  325. } else {
  326. $this->setResponse(500, 'Error getting service information');
  327. return false;
  328. }
  329. $add = [
  330. 'mediaId' => (int)$id,
  331. 'tvdbId' => $seriesInfo['externalIds']['tvdbId'],
  332. 'mediaType' => 'tv',
  333. 'is4k' => (bool)$serviceInfo['is4k'],
  334. 'seasons' => $seasons,
  335. 'serverId' => (int)$serviceInfo['id'],
  336. 'profileId' => (int)$serviceInfo['activeProfileId'],
  337. 'rootFolder' => $serviceInfo['activeDirectory'],
  338. 'languageProfileId' => (int)$serviceInfo['activeLanguageProfileId'],
  339. //'userId' => (int)$userInfo['id'],
  340. 'tags' => []
  341. ];
  342. break;
  343. default:
  344. $response = Requests::get($url . '/api/v1/service/radarr', $headers, $optionsAPI);
  345. if ($response->success) {
  346. $serviceInfo = $this->getDefaultService(json_decode($response->body, true));
  347. } else {
  348. $this->setResponse(500, 'Error getting service information');
  349. return false;
  350. }
  351. $add = [
  352. 'mediaId' => (int)$id,
  353. 'mediaType' => 'movie',
  354. 'is4k' => (bool)$serviceInfo['is4k'],
  355. 'serverId' => (int)$serviceInfo['id'],
  356. 'profileId' => (int)$serviceInfo['activeProfileId'],
  357. //'userId' => (int)$userInfo['id'],
  358. 'tags' => []
  359. ];
  360. break;
  361. }
  362. $response = Requests::post($url . "/api/v1/request", ['Accept' => 'application/json', 'Content-Type' => 'application/json'], json_encode($add), $optionsUser);
  363. if ($response->success) {
  364. $this->setAPIResponse('success', 'Overseerr Request submitted', 200);
  365. return true;
  366. } else {
  367. $message = 'Overseerr Error Occurred';
  368. if ($this->isJSON($response->body)) {
  369. $messageJSON = json_decode($response->body, true);
  370. $message = $messageJSON['message'] ?? $message;
  371. }
  372. $this->setAPIResponse('error', $message, 500);
  373. return false;
  374. }
  375. } catch (Requests_Exception $e) {
  376. $this->writeLog('error', 'Overseerr Connect Function - Error: ' . $e->getMessage(), 'SYSTEM');
  377. $this->setAPIResponse('error', $e->getMessage(), 500);
  378. return false;
  379. }
  380. }
  381. public function actionOverseerrRequest($id, $type, $action)
  382. {
  383. $id = ($id) ?? null;
  384. $type = ($type) ?? null;
  385. $action = ($action) ?? null;
  386. if (!$id) {
  387. $this->setAPIResponse('error', 'Id was not supplied', 422);
  388. return false;
  389. }
  390. if (!$type) {
  391. $this->setAPIResponse('error', 'Type was not supplied', 422);
  392. return false;
  393. }
  394. if (!$action) {
  395. $this->setAPIResponse('error', 'Action was not supplied', 422);
  396. return false;
  397. }
  398. if (!$this->homepageItemPermissions($this->overseerrHomepagePermissions('main'), true)) {
  399. return false;
  400. }
  401. $url = $this->qualifyURL($this->config['overseerrURL']);
  402. $headers = array(
  403. "Accept" => "application/json",
  404. "Content-Type" => "application/json",
  405. 'X-Api-Key' => $this->config['overseerrToken']
  406. );
  407. try {
  408. $options = $this->requestOptions($url, null, $this->config['overseerrDisableCertCheck'], $this->config['overseerrUseCustomCertificate']);
  409. switch ($action) {
  410. case 'approve':
  411. $response = Requests::post($url . "/api/v1/request/" . $id . "/approve", $headers, [], $options);
  412. $message = 'Overseerr Request has been approved';
  413. break;
  414. case 'pending':
  415. $response = Requests::post($url . '/api/v1/request/' . $id . '/pending', $headers, [], $options);
  416. $message = 'Overseerr Request has been approved';
  417. break;
  418. case 'available':
  419. $requestInfoResponse = Requests::get($url . '/api/v1/request/' . $id, $headers, $options);
  420. if ($requestInfoResponse->success) {
  421. $requestInfo = json_decode($requestInfoResponse->body, true);
  422. $mediaId = $requestInfo['media']['id'];
  423. } else {
  424. $this->setResponse(500, 'Error getting request information');
  425. return false;
  426. }
  427. $response = Requests::post($url . '/api/v1/media/' . $mediaId . '/available', $headers, [], $options);
  428. $message = 'Overseerr Request has been marked available';
  429. break;
  430. case 'unavailable':
  431. $requestInfoResponse = Requests::get($url . '/api/v1/request/' . $id, $headers, $options);
  432. if ($requestInfoResponse->success) {
  433. $requestInfo = json_decode($requestInfoResponse->body, true);
  434. $mediaId = $requestInfo['media']['id'];
  435. } else {
  436. $this->setResponse(500, 'Error getting request information');
  437. return false;
  438. }
  439. $response = Requests::post($url . "/api/v1/media/" . $mediaId . "/pending", $headers, [], $options);
  440. $message = 'Overseerr Request has been marked unavailable';
  441. break;
  442. case 'deny':
  443. $response = Requests::post($url . "/api/v1/request/" . $id . "/decline", $headers, [], $options);
  444. $message = 'Overseerr Request has been denied';
  445. break;
  446. case 'delete':
  447. $response = Requests::delete($url . "/api/v1/request/" . $id, $headers, $options);
  448. $message = 'Overseerr Request has been deleted';
  449. break;
  450. default:
  451. return false;
  452. }
  453. if ($response->success) {
  454. $this->setAPIResponse('success', $message, 200);
  455. return true;
  456. } else {
  457. $message = 'Overseerr Error Occurred';
  458. if ($this->isJSON($response->body)) {
  459. $messageJSON = json_decode($response->body, true);
  460. $message = $messageJSON['message'] ?? $message;
  461. }
  462. $this->setAPIResponse('error', $message, 500);
  463. return false;
  464. }
  465. } catch (Requests_Exception $e) {
  466. $this->writeLog('error', 'Overseerr Connect Function - Error: ' . $e->getMessage(), 'SYSTEM');
  467. $this->setAPIResponse('error', $e->getMessage(), 500);
  468. return false;
  469. }
  470. }
  471. public function getOverseerrMetadata($id, $type)
  472. {
  473. if (!$id) {
  474. $this->setAPIResponse('error', 'Id was not supplied', 422);
  475. return false;
  476. }
  477. if (!$type) {
  478. $this->setAPIResponse('error', 'Type was not supplied', 422);
  479. return false;
  480. }
  481. if (!$this->homepageItemPermissions($this->overseerrHomepagePermissions('request'), true)) {
  482. return false;
  483. }
  484. try {
  485. $url = $this->qualifyURL($this->config['overseerrURL']);
  486. $headers = array(
  487. 'Accept' => 'application/json',
  488. 'Content-Type' => 'application/json',
  489. 'X-Api-Key' => $this->config['overseerrToken']
  490. );
  491. $options = $this->requestOptions($url, null, $this->config['overseerrDisableCertCheck'], $this->config['overseerrUseCustomCertificate']);
  492. $response = Requests::get($url . '/api/v1/' . $type . '/' . $id, $headers, $options);
  493. if ($response->success) {
  494. $metadata = json_decode($response->body, true);
  495. $this->setResponse(200, null, $metadata);
  496. return $metadata;
  497. } else {
  498. $this->setResponse(500, 'Error getting series information');
  499. return false;
  500. }
  501. } catch (Requests_Exception $e) {
  502. $this->writeLog('error', 'Overseerr Connect Function - Error: ' . $e->getMessage(), 'SYSTEM');
  503. $this->setAPIResponse('error', $e->getMessage(), 500);
  504. return false;
  505. }
  506. }
  507. public function overseerrTVDefault($type)
  508. {
  509. return $type == $this->config['overseerrTvDefault'];
  510. }
  511. }