overseerr.php 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522
  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. $api['count'] = [
  139. 'movie' => 0,
  140. 'tv' => 0,
  141. 'limit' => (integer)$limit,
  142. 'offset' => (integer)$offset
  143. ];
  144. $headers = [
  145. "Accept" => "application/json",
  146. "X-Api-Key" => $this->config['overseerrToken'],
  147. ];
  148. $requests = [];
  149. $url = $this->qualifyURL($this->config['overseerrURL']);
  150. try {
  151. $options = $this->requestOptions($url, $this->config['overseerrRefresh'], $this->config['overseerrDisableCertCheck'], $this->config['overseerrUseCustomCertificate']);
  152. $request = Requests::get($url . "/api/v1/request?take=" . $limit, $headers, $options);
  153. if ($request->success) {
  154. $requestsData = json_decode($request->body, true);
  155. foreach ($requestsData['results'] as $key => $value) {
  156. $requester = ($value['requestedBy']['username'] !== '') ? $value['requestedBy']['username'] : $value['requestedBy']['plexUsername'];
  157. $requesterEmail = $value['requestedBy']['email'];
  158. $proceed = (($this->config['overseerrLimitUser']) && strtolower($this->user['username']) == strtolower($requester)) || (strtolower($requester) == strtolower($this->config['ombiFallbackUser'])) || (!$this->config['ombiLimitUser']) || $this->qualifyRequest(1);
  159. if ($proceed) {
  160. $requestItem = Requests::get($url . '/api/v1/' . $value['type'] . '/' . $value['media']['tmdbId'], $headers, $options);
  161. $requestsItemData = json_decode($requestItem->body, true);
  162. if ($requestItem->success) {
  163. $api['count'][$value['type']]++;
  164. $requests[] = array(
  165. 'id' => $value['media']['tmdbId'],
  166. 'title' => ($value['type'] == 'movie') ? $requestsItemData['title'] : $requestsItemData['name'],
  167. 'overview' => $requestsItemData['overview'],
  168. 'poster' => (isset($requestsItemData['posterPath']) && $requestsItemData['posterPath'] !== '') ? 'https://image.tmdb.org/t/p/w300/' . $requestsItemData['posterPath'] : 'plugins/images/cache/no-list.png',
  169. 'background' => (isset($requestsItemData['backdropPath']) && $requestsItemData['backdropPath'] !== '') ? 'https://image.tmdb.org/t/p/w1280/' . $requestsItemData['backdropPath'] : '',
  170. 'approved' => $value['status'] == 2,
  171. 'available' => $value['media']['status'] == 5,
  172. 'denied' => $value['status'] == 3,
  173. 'deniedReason' => 'n/a',
  174. 'user' => $requester,
  175. 'userAlias' => $value['requestedBy']['displayName'],
  176. 'request_id' => $value['id'],
  177. 'request_date' => $value['createdAt'],
  178. 'release_date' => ($value['type'] == 'movie') ? $requestsItemData['releaseDate'] : $requestsItemData['firstAirDate'],
  179. 'type' => $value['type'],
  180. 'icon' => 'mdi mdi-' . ($value['type'] == 'movie') ? 'filmstrip' : 'television',
  181. 'color' => ($value['type'] == 'movie') ? 'palette-Deep-Purple-900 bg white' : 'grayish-blue-bg',
  182. );
  183. }
  184. }
  185. }
  186. //sort here
  187. usort($requests, function ($item1, $item2) {
  188. if ($item1['request_date'] == $item2['request_date']) {
  189. return 0;
  190. }
  191. return $item1['request_date'] > $item2['request_date'] ? -1 : 1;
  192. });
  193. }
  194. } catch (Requests_Exception $e) {
  195. $this->writeLog('error', 'Overseerr Connect Function - Error: ' . $e->getMessage(), 'SYSTEM');
  196. $this->setResponse(500, $e->getMessage());
  197. return false;
  198. }
  199. $api['content'] = isset($requests) ? array_slice($requests, $offset, $limit) : false;
  200. $this->setResponse(200, null, $api);
  201. return $api;
  202. }
  203. public function getDefaultService($services)
  204. {
  205. if (empty($services)) {
  206. return null;
  207. } else {
  208. $default = false;
  209. foreach ($services as $service) {
  210. if ($service['isDefault']) {
  211. $default = (int)$service['id'];
  212. }
  213. }
  214. if ($default) {
  215. return $services[$default];
  216. } else {
  217. return $services[0];
  218. }
  219. }
  220. }
  221. public function addOverseerrRequest($id, $type, $seasons = null)
  222. {
  223. $id = ($id) ?? null;
  224. $type = ($type) ?? null;
  225. if (!$id) {
  226. $this->setAPIResponse('error', 'Id was not supplied', 422);
  227. return false;
  228. }
  229. if (!$type) {
  230. $this->setAPIResponse('error', 'Type was not supplied', 422);
  231. return false;
  232. }
  233. if (!$this->homepageItemPermissions($this->overseerrHomepagePermissions('main'), true)) {
  234. return false;
  235. }
  236. $url = $this->qualifyURL($this->config['overseerrURL']);
  237. try {
  238. if (!isset($_COOKIE['connect_sid']) && !isset($_COOKIE['connect.sid'])) {
  239. $this->setAPIResponse('error', 'User does not have Auth Cookie', 500);
  240. return false;
  241. }
  242. $headers = array(
  243. 'Accept' => 'application/json',
  244. 'Content-Type' => 'application/json',
  245. 'X-Api-Key' => $this->config['overseerrToken']
  246. );
  247. $cookieJar = new Requests_Cookie_Jar(['connect.sid' => $_COOKIE['connect_sid']]);
  248. $optionsUser = $this->requestOptions($url, null, $this->config['overseerrDisableCertCheck'], $this->config['overseerrUseCustomCertificate'], ['cookies' => $cookieJar]);
  249. $optionsAPI = $this->requestOptions($url, null, $this->config['overseerrDisableCertCheck'], $this->config['overseerrUseCustomCertificate']);
  250. // Check if requested already
  251. $searchResponse = Requests::get($url . '/api/v1/request/', $headers, $optionsAPI);
  252. if ($searchResponse->success) {
  253. $details = json_decode($searchResponse->body, true);
  254. if (count($details['results']) > 0) {
  255. foreach ($details['results'] as $k => $v) {
  256. if ($v['media']['tmdbId'] == $id) {
  257. if ($v['media']['status'] == 5) {
  258. $this->setAPIResponse('error', 'Request is already available', 409);
  259. return false;
  260. } else {
  261. $this->setAPIResponse('error', 'Request is already requested', 409);
  262. return false;
  263. }
  264. }
  265. }
  266. }
  267. } else {
  268. $this->setAPIResponse('error', 'Overseerr Connection Error Occurred', 500);
  269. return false;
  270. }
  271. // Get User info
  272. $response = Requests::get($url . '/api/v1/auth/me', [], $optionsUser);
  273. if ($response->success) {
  274. $userInfo = json_decode($response->body, true);
  275. } else {
  276. $this->setResponse(500, 'Error getting user information');
  277. return false;
  278. }
  279. switch ($type) {
  280. case 'season':
  281. case 'tv':
  282. if ($this->config['overseerrTvDefault'] == 'user') {
  283. if ($seasons) {
  284. if (strpos($seasons, ',') !== false) {
  285. $seasonsExplode = explode(',', $seasons);
  286. foreach ($seasonsExplode as $season) {
  287. $seasonsArray[] = (int)$season;
  288. }
  289. $seasons = $seasonsArray;
  290. } else {
  291. $seasonsArray[] = (int)$seasons;
  292. $seasons = $seasonsArray;
  293. }
  294. } else {
  295. $this->setResponse(500, 'Seasons requested was not supplied');
  296. return false;
  297. }
  298. }
  299. $response = Requests::get($url . '/api/v1/tv/' . $id, $headers, $optionsAPI);
  300. if ($response->success) {
  301. $seriesInfo = json_decode($response->body, true);
  302. } else {
  303. $this->setResponse(500, 'Error getting series information');
  304. return false;
  305. }
  306. if ($this->config['overseerrTvDefault'] == 'first') {
  307. $seasons = [1];
  308. } elseif ($this->config['overseerrTvDefault'] == 'last') {
  309. $lastSeason = end($seriesInfo['seasons']);
  310. $lastSeasonNumber = $lastSeason['seasonNumber'];
  311. $seasons = [$lastSeasonNumber];
  312. } elseif ($this->config['overseerrTvDefault'] == 'all') {
  313. $seasons = [];
  314. foreach ($seriesInfo['seasons'] as $season) {
  315. if ($season['seasonNumber'] !== 0) {
  316. $seasons[] = $season['seasonNumber'];
  317. }
  318. }
  319. }
  320. $response = Requests::get($url . '/api/v1/service/sonarr', $headers, $optionsAPI);
  321. if ($response->success) {
  322. $serviceInfo = $this->getDefaultService(json_decode($response->body, true));
  323. } else {
  324. $this->setResponse(500, 'Error getting service information');
  325. return false;
  326. }
  327. $add = [
  328. 'mediaId' => (int)$id,
  329. 'tvdbId' => $seriesInfo['externalIds']['tvdbId'],
  330. 'mediaType' => 'tv',
  331. 'is4k' => $serviceInfo['is4k'],
  332. 'seasons' => $seasons,
  333. 'serverId' => (int)$serviceInfo['id'],
  334. 'profileId' => (int)$serviceInfo['activeProfileId'],
  335. 'rootFolder' => $serviceInfo['activeDirectory'],
  336. 'languageProfileId' => (int)$serviceInfo['activeLanguageProfileId'],
  337. 'userId' => (int)$userInfo['id'],
  338. 'tags' => []
  339. ];
  340. break;
  341. default:
  342. $response = Requests::get($url . '/api/v1/service/radarr', $headers, $optionsAPI);
  343. if ($response->success) {
  344. $serviceInfo = $this->getDefaultService(json_decode($response->body, true));
  345. } else {
  346. $this->setResponse(500, 'Error getting service information');
  347. return false;
  348. }
  349. $add = [
  350. 'mediaId' => (int)$id,
  351. 'mediaType' => 'movie',
  352. 'is4k' => $serviceInfo['is4k'],
  353. 'serverId' => (int)$serviceInfo['id'],
  354. 'profileId' => (int)$serviceInfo['activeProfileId'],
  355. 'userId' => (int)$userInfo['id'],
  356. 'tags' => []
  357. ];
  358. break;
  359. }
  360. $response = Requests::post($url . "/api/v1/request", ['Accept' => 'application/json', 'Content-Type' => 'application/json'], json_encode($add), $optionsUser);
  361. if ($response->success) {
  362. $this->setAPIResponse('success', 'Overseerr Request submitted', 200);
  363. return true;
  364. } else {
  365. $message = 'Overseerr Error Occurred';
  366. if ($this->isJSON($response->body)) {
  367. $messageJSON = json_decode($response->body, true);
  368. $message = $messageJSON['message'] ?? $message;
  369. }
  370. $this->setAPIResponse('error', $message, 500);
  371. return false;
  372. }
  373. } catch (Requests_Exception $e) {
  374. $this->writeLog('error', 'Overseerr Connect Function - Error: ' . $e->getMessage(), 'SYSTEM');
  375. $this->setAPIResponse('error', $e->getMessage(), 500);
  376. return false;
  377. }
  378. }
  379. public function actionOverseerrRequest($id, $type, $action)
  380. {
  381. $id = ($id) ?? null;
  382. $type = ($type) ?? null;
  383. $action = ($action) ?? null;
  384. if (!$id) {
  385. $this->setAPIResponse('error', 'Id was not supplied', 422);
  386. return false;
  387. }
  388. if (!$type) {
  389. $this->setAPIResponse('error', 'Type was not supplied', 422);
  390. return false;
  391. }
  392. if (!$action) {
  393. $this->setAPIResponse('error', 'Action was not supplied', 422);
  394. return false;
  395. }
  396. if (!$this->homepageItemPermissions($this->overseerrHomepagePermissions('main'), true)) {
  397. return false;
  398. }
  399. $url = $this->qualifyURL($this->config['overseerrURL']);
  400. $headers = array(
  401. "Accept" => "application/json",
  402. "Content-Type" => "application/json",
  403. 'X-Api-Key' => $this->config['overseerrToken']
  404. );
  405. try {
  406. $options = $this->requestOptions($url, null, $this->config['overseerrDisableCertCheck'], $this->config['overseerrUseCustomCertificate']);
  407. switch ($action) {
  408. case 'approve':
  409. $response = Requests::post($url . "/api/v1/request/" . $id . "/approve", $headers, [], $options);
  410. $message = 'Overseerr Request has been approved';
  411. break;
  412. case 'pending':
  413. $response = Requests::post($url . '/api/v1/request/' . $id . '/pending', $headers, [], $options);
  414. $message = 'Overseerr Request has been approved';
  415. break;
  416. case 'available':
  417. $requestInfoResponse = Requests::get($url . '/api/v1/request/' . $id, $headers, $options);
  418. if ($requestInfoResponse->success) {
  419. $requestInfo = json_decode($requestInfoResponse->body, true);
  420. $mediaId = $requestInfo['media']['id'];
  421. } else {
  422. $this->setResponse(500, 'Error getting request information');
  423. return false;
  424. }
  425. $response = Requests::post($url . '/api/v1/media/' . $mediaId . '/available', $headers, [], $options);
  426. $message = 'Overseerr Request has been marked available';
  427. break;
  428. case 'unavailable':
  429. $requestInfoResponse = Requests::get($url . '/api/v1/request/' . $id, $headers, $options);
  430. if ($requestInfoResponse->success) {
  431. $requestInfo = json_decode($requestInfoResponse->body, true);
  432. $mediaId = $requestInfo['media']['id'];
  433. } else {
  434. $this->setResponse(500, 'Error getting request information');
  435. return false;
  436. }
  437. $response = Requests::post($url . "/api/v1/media/" . $mediaId . "/pending", $headers, [], $options);
  438. $message = 'Overseerr Request has been marked unavailable';
  439. break;
  440. case 'deny':
  441. $response = Requests::post($url . "/api/v1/request/" . $id . "/decline", $headers, [], $options);
  442. $message = 'Overseerr Request has been denied';
  443. break;
  444. case 'delete':
  445. $response = Requests::delete($url . "/api/v1/request/" . $id, $headers, $options);
  446. $message = 'Overseerr Request has been deleted';
  447. break;
  448. default:
  449. return false;
  450. }
  451. if ($response->success) {
  452. $this->setAPIResponse('success', $message, 200);
  453. return true;
  454. } else {
  455. $message = 'Overseerr Error Occurred';
  456. if ($this->isJSON($response->body)) {
  457. $messageJSON = json_decode($response->body, true);
  458. $message = $messageJSON['message'] ?? $message;
  459. }
  460. $this->setAPIResponse('error', $message, 500);
  461. return false;
  462. }
  463. } catch (Requests_Exception $e) {
  464. $this->writeLog('error', 'Overseerr Connect Function - Error: ' . $e->getMessage(), 'SYSTEM');
  465. $this->setAPIResponse('error', $e->getMessage(), 500);
  466. return false;
  467. }
  468. }
  469. public function getOverseerrMetadata($id, $type)
  470. {
  471. if (!$id) {
  472. $this->setAPIResponse('error', 'Id was not supplied', 422);
  473. return false;
  474. }
  475. if (!$type) {
  476. $this->setAPIResponse('error', 'Type was not supplied', 422);
  477. return false;
  478. }
  479. if (!$this->homepageItemPermissions($this->overseerrHomepagePermissions('request'), true)) {
  480. return false;
  481. }
  482. try {
  483. $url = $this->qualifyURL($this->config['overseerrURL']);
  484. $headers = array(
  485. 'Accept' => 'application/json',
  486. 'Content-Type' => 'application/json',
  487. 'X-Api-Key' => $this->config['overseerrToken']
  488. );
  489. $options = $this->requestOptions($url, null, $this->config['overseerrDisableCertCheck'], $this->config['overseerrUseCustomCertificate']);
  490. $response = Requests::get($url . '/api/v1/' . $type . '/' . $id, $headers, $options);
  491. if ($response->success) {
  492. $metadata = json_decode($response->body, true);
  493. $this->setResponse(200, null, $metadata);
  494. return $metadata;
  495. } else {
  496. $this->setResponse(500, 'Error getting series information');
  497. return false;
  498. }
  499. } catch (Requests_Exception $e) {
  500. $this->writeLog('error', 'Overseerr Connect Function - Error: ' . $e->getMessage(), 'SYSTEM');
  501. $this->setAPIResponse('error', $e->getMessage(), 500);
  502. return false;
  503. }
  504. }
  505. public function overseerrTVDefault($type)
  506. {
  507. return $type == $this->config['overseerrTvDefault'];
  508. }
  509. }