| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134 |
- <?php
- // PLUGIN INFORMATION
- $GLOBALS['plugins']['Invites'] = array( // Plugin Name
- 'name' => 'Invites', // Plugin Name
- 'author' => 'CauseFX', // Who wrote the plugin
- 'category' => 'Management', // One to Two Word Description
- 'link' => '', // Link to plugin info
- 'license' => 'personal', // License Type use , for multiple
- 'idPrefix' => 'INVITES', // html element id prefix
- 'configPrefix' => 'INVITES', // config file prefix for array items without the hyphen
- 'version' => '1.1.0', // SemVer of plugin
- 'image' => 'api/plugins/invites/logo.png', // 1:1 non transparent image for plugin
- 'settings' => true, // does plugin need a settings modal?
- 'bind' => true, // use default bind to make settings page - true or false
- 'api' => 'api/v2/plugins/invites/settings', // api route for settings page
- 'homepage' => false // Is plugin for use on homepage? true or false
- );
- class Invites extends Organizr
- {
- public function __construct()
- {
- parent::__construct();
- $this->_pluginUpgradeCheck();
- }
- public function _pluginUpgradeCheck()
- {
- if ($this->hasDB()) {
- $compare = new Composer\Semver\Comparator;
- $oldVer = $this->config['INVITES-dbVersion'];
- // Upgrade check start for version below
- $versionCheck = '1.1.0';
- if ($compare->lessThan($oldVer, $versionCheck)) {
- $oldVer = $versionCheck;
- $this->_pluginUpgradeToVersion($versionCheck);
- }
- // End Upgrade check start for version above
- // Update config.php version if different to the installed version
- if ($GLOBALS['plugins']['Invites']['version'] !== $this->config['INVITES-dbVersion']) {
- $this->updateConfig(array('INVITES-dbVersion' => $oldVer));
- $this->setLoggerChannel('Invites Plugin');
- $this->logger->debug('Updated INVITES-dbVersion to ' . $oldVer);
- }
- return true;
- }
- }
- public function _pluginUpgradeToVersion($version = '1.1.0')
- {
- switch ($version) {
- case '1.1.0':
- $this->_addInvitedByColumnToDatabase();
- break;
- }
- $this->setResponse(200, 'Ran plugin update function for version: ' . $version);
- return true;
- }
- public function _addInvitedByColumnToDatabase()
- {
- $addColumn = $this->addColumnToDatabase('invites', 'invitedby', 'TEXT');
- $this->setLoggerChannel('Invites Plugin');
- if ($addColumn) {
- $this->logger->info('Updated Invites Database');
- } else {
- $this->logger->warning('Could not update Invites Database');
- }
- }
- public function _invitesPluginGetCodes()
- {
- if ($this->qualifyRequest(1, false)) {
- $response = [
- array(
- 'function' => 'fetchAll',
- 'query' => 'SELECT * FROM invites'
- )
- ];
- } else {
- $response = [
- array(
- 'function' => 'fetchAll',
- 'query' => array(
- 'SELECT * FROM invites WHERE invitedby = ?',
- $this->user['username']
- )
- )
- ];
- }
- return $this->processQueries($response);
- }
- public function _invitesPluginCreateCode($array)
- {
- $code = ($array['code']) ?? null;
- $username = ($array['username']) ?? null;
- $email = ($array['email']) ?? null;
- $invites = $this->_invitesPluginGetCodes();
- $inviteCount = count($invites);
- if (!$this->qualifyRequest(1, false)) {
- if ($this->config['INVITES-maximum-invites'] != 0 && $inviteCount >= $this->config['INVITES-maximum-invites']) {
- $this->setAPIResponse('error', 'Maximum number of invites reached', 409);
- return false;
- }
- }
- if (!$code) {
- $this->setAPIResponse('error', 'Code not supplied', 409);
- return false;
- }
- if (!$username) {
- $this->setAPIResponse('error', 'Username not supplied', 409);
- return false;
- }
- if (!$email) {
- $this->setAPIResponse('error', 'Email not supplied', 409);
- return false;
- }
- $newCode = [
- 'code' => $code,
- 'email' => $email,
- 'username' => $username,
- 'valid' => 'Yes',
- 'type' => $this->config['INVITES-type-include'],
- 'invitedby' => $this->user['username'],
- 'date' => gmdate('Y-m-d H:i:s')
- ];
- $response = [
- array(
- 'function' => 'query',
- 'query' => array(
- 'INSERT INTO [invites]',
- $newCode
- )
- )
- ];
- $query = $this->processQueries($response);
- if ($query) {
- $this->setLoggerChannel('Invites')->info('Added Invite [' . $code . ']');
- if ($this->config['PHPMAILER-enabled']) {
- $PhpMailer = new PhpMailer();
- $emailTemplate = array(
- 'type' => 'invite',
- 'body' => $this->config['PHPMAILER-emailTemplateInviteUser'],
- 'subject' => $this->config['PHPMAILER-emailTemplateInviteUserSubject'],
- 'user' => $username,
- 'password' => null,
- 'inviteCode' => $code,
- );
- $emailTemplate = $PhpMailer->_phpMailerPluginEmailTemplate($emailTemplate);
- $sendEmail = array(
- 'to' => $email,
- 'subject' => $emailTemplate['subject'],
- 'body' => $PhpMailer->_phpMailerPluginBuildEmail($emailTemplate),
- );
- $PhpMailer->_phpMailerPluginSendEmail($sendEmail);
- }
- $this->setAPIResponse('success', 'Invite Code: ' . $code . ' has been created', 200);
- return true;
- } else {
- return false;
- }
- }
- public function _invitesPluginVerifyCode($code)
- {
- $response = [
- array(
- 'function' => 'fetchAll',
- 'query' => array(
- 'SELECT * FROM invites WHERE valid = "Yes" AND code = ? COLLATE NOCASE',
- $code
- )
- )
- ];
- if ($this->processQueries($response)) {
- $this->setAPIResponse('success', 'Code has been verified', 200);
- return true;
- } else {
- $this->setAPIResponse('error', 'Code is invalid', 401);
- return false;
- }
- }
- public function _invitesPluginDeleteCode($code)
- {
- if ($this->qualifyRequest(1, false)) {
- $response = [
- array(
- 'function' => 'fetch',
- 'query' => array(
- 'SELECT * FROM invites WHERE code = ? COLLATE NOCASE',
- $code
- )
- )
- ];
- } else {
- if ($this->config['INVITES-allow-delete']) {
- $response = [
- array(
- 'function' => 'fetch',
- 'query' => array(
- 'SELECT * FROM invites WHERE invitedby = ? AND code = ? COLLATE NOCASE',
- $this->user['username'],
- $code
- )
- )
- ];
- } else {
- $this->setAPIResponse('error', 'You are not permitted to delete invites.', 409);
- return false;
- }
- }
- $info = $this->processQueries($response);
- if (!$info) {
- $this->setAPIResponse('error', 'Code not found', 404);
- return false;
- }
- $response = [
- array(
- 'function' => 'query',
- 'query' => array(
- 'DELETE FROM invites WHERE code = ? COLLATE NOCASE',
- $code
- )
- )
- ];
- $this->setAPIResponse('success', 'Code has been deleted', 200);
- return $this->processQueries($response);
- }
- public function _invitesPluginUseCode($code, $array)
- {
- $code = ($code) ?? null;
- $mail = $this->_getEmailFronInviteCode($code);
- $usedBy = ($array['usedby']) ?? null;
- $now = date("Y-m-d H:i:s");
- $currentIP = $this->userIP();
- if ($this->_invitesPluginVerifyCode($code)) {
- $updateCode = [
- 'valid' => 'No',
- 'usedby' => $usedBy,
- 'dateused' => $now,
- 'ip' => $currentIP
- ];
- $response = [
- array(
- 'function' => 'query',
- 'query' => array(
- 'UPDATE invites SET',
- $updateCode,
- 'WHERE code=? COLLATE NOCASE',
- $code
- )
- )
- ];
- $query = $this->processQueries($response);
- $this->setLoggerChannel('Invites')->info('Invite Used [' . $code . '] by ' . $usedBy);
- return $this->_invitesPluginAction($usedBy, 'share', $this->config['INVITES-type-include'], $mail);
- } else {
- return false;
- }
- }
- public function _invitesPluginLibraryList($type = null)
- {
- switch ($type) {
- case 'plex':
- if (!empty($this->config['plexToken']) && !empty($this->config['plexID'])) {
- $url = 'https://plex.tv/api/servers/' . $this->config['plexID'];
- try {
- $headers = array(
- "Accept" => "application/json",
- "X-Plex-Token" => $this->config['plexToken']
- );
- $response = Requests::get($url, $headers, array());
- libxml_use_internal_errors(true);
- if ($response->success) {
- $libraryList = array();
- $plex = simplexml_load_string($response->body);
- foreach ($plex->Server->Section as $child) {
- $libraryList['libraries'][(string)$child['title']] = (string)$child['id'];
- }
- if ($this->config['INVITES-plexLibraries'] !== '') {
- $noLongerId = 0;
- $libraries = explode(',', $this->config['INVITES-plexLibraries']);
- foreach ($libraries as $child) {
- if (!$this->search_for_value($child, $libraryList)) {
- $libraryList['libraries']['No Longer Exists - ' . $noLongerId] = $child;
- $noLongerId++;
- }
- }
- }
- $libraryList = array_change_key_case($libraryList, CASE_LOWER);
- return $libraryList;
- }
- } catch (Requests_Exception $e) {
- $this->setLoggerChannel('Plex')->error($e);
- return false;
- };
- }
- break;
- default:
- # code...
- break;
- }
- return false;
- }
- public function _invitesPluginGetSettings()
- {
- if ($this->config['plexID'] !== '' && $this->config['plexToken'] !== '' && $this->config['INVITES-type-include'] == 'plex') {
- $loop = $this->_invitesPluginLibraryList($this->config['INVITES-type-include'])['libraries'];
- foreach ($loop as $key => $value) {
- $libraryList[] = array(
- 'name' => $key,
- 'value' => $value
- );
- }
- } else {
- $libraryList = array(
- array(
- 'name' => 'Refresh page to update List',
- 'value' => '',
- 'disabled' => true,
- ),
- );
- }
- $komgaRoles = $this->_getKomgaRoles();
- $komgalibrary = $this->_getKomgaLibraries();
- $nextcloudRoles = $this->_getNextcloudGroups();
- return array(
- 'Backend' => array(
- array(
- 'type' => 'select',
- 'name' => 'INVITES-type-include',
- 'label' => 'Media Server',
- 'value' => $this->config['INVITES-type-include'],
- 'options' => array(
- array(
- 'name' => 'N/A',
- 'value' => 'n/a'
- ),
- array(
- 'name' => 'Plex',
- 'value' => 'plex'
- ),
- array(
- 'name' => 'Emby',
- 'value' => 'emby'
- )
- )
- ),
- array(
- 'type' => 'select',
- 'name' => 'INVITES-Auth-include',
- 'label' => 'Minimum Authentication',
- 'value' => $this->config['INVITES-Auth-include'],
- 'options' => $this->groupSelect()
- ),
- array(
- 'type' => 'switch',
- 'name' => 'INVITES-allow-delete-include',
- 'label' => 'Allow users to delete invites',
- 'help' => 'This must be disabled to enforce invitation limits.',
- 'value' => $this->config['INVITES-allow-delete-include']
- ),
- array(
- 'type' => 'number',
- 'name' => 'INVITES-maximum-invites',
- 'label' => 'Maximum number of invites permitted for users.',
- 'help' => 'Set to 0 to disable the limit.',
- 'value' => $this->config['INVITES-maximum-invites'],
- 'placeholder' => '0'
- ),
- ),
- 'Plex Settings' => array(
- array(
- 'type' => 'password-alt',
- 'name' => 'plexToken',
- 'label' => 'Plex Token',
- 'value' => $this->config['plexToken'],
- 'placeholder' => 'Use Get Token Button'
- ),
- array(
- 'type' => 'button',
- 'label' => 'Get Plex Token',
- 'icon' => 'fa fa-ticket',
- 'text' => 'Retrieve',
- 'attr' => 'onclick="PlexOAuth(oAuthSuccess,oAuthError, oAuthMaxRetry, null, null, \'#INVITES-settings-items [name=plexToken]\')"'
- ),
- array(
- 'type' => 'password-alt',
- 'name' => 'plexID',
- 'label' => 'Plex Machine',
- 'value' => $this->config['plexID'],
- 'placeholder' => 'Use Get Plex Machine Button'
- ),
- array(
- 'type' => 'button',
- 'label' => 'Get Plex Machine',
- 'icon' => 'fa fa-id-badge',
- 'text' => 'Retrieve',
- 'attr' => 'onclick="showPlexMachineForm(\'#INVITES-settings-items [name=plexID]\')"'
- ),
- array(
- 'type' => 'select2',
- 'class' => 'select2-multiple',
- 'id' => 'invite-select-' . $this->random_ascii_string(6),
- 'name' => 'INVITES-plexLibraries',
- 'label' => 'Libraries',
- 'value' => $this->config['INVITES-plexLibraries'],
- 'options' => $libraryList
- ),
- array(
- 'type' => 'text',
- 'name' => 'INVITES-plex-tv-labels',
- 'label' => 'TV Labels (comma separated)',
- 'value' => $this->config['INVITES-plex-tv-labels'],
- 'placeholder' => 'All'
- ),
- array(
- 'type' => 'text',
- 'name' => 'INVITES-plex-movies-labels',
- 'label' => 'Movies Labels (comma separated)',
- 'value' => $this->config['INVITES-plex-movies-labels'],
- 'placeholder' => 'All'
- ),
- array(
- 'type' => 'text',
- 'name' => 'INVITES-plex-music-labels',
- 'label' => 'Music Labels (comma separated)',
- 'value' => $this->config['INVITES-plex-music-labels'],
- 'placeholder' => 'All'
- ),
- array(
- 'type' => 'switch',
- 'name' => 'INVITES-add-plex-home',
- 'label' => 'When user subscribe add him to Plex Home',
- 'value' => $this->config['INVITES-add-plex-home']
- )
- ),
- 'Komga Settings' => array(
- array(
- 'type' => 'switch',
- 'name' => 'INVITES-komga-enabled',
- 'label' => 'Enable Komga for auto create account',
- 'value' => $this->config['INVITES-komga-enabled'],
- ),
- array(
- 'type' => 'input',
- 'name' => 'INVITES-komga-uri',
- 'label' => 'URL',
- 'value' => $this->config['INVITES-komga-uri'],
- 'placeholder' => 'http(s)://hostname:port'
- ),
- array(
- 'type' => 'password-alt',
- 'name' => 'INVITES-komga-api-key',
- 'label' => 'Komga Api Key',
- 'value' => $this->config['INVITES-komga-api-key']
- ),
- array(
- 'type' => 'password-alt',
- 'name' => 'INVITES-komga-default-user-password',
- 'label' => 'Default password for new user',
- 'value' => $this->config['INVITES-komga-default-user-password']
- ),
- array(
- 'type' => 'select2',
- 'class' => 'select2-multiple',
- 'id' => 'INVITES-select-' . $this->random_ascii_string(6),
- 'name' => 'INVITES-komga-roles',
- 'label' => 'Roles',
- 'value' => $this->config['INVITES-komga-roles'],
- 'options' => $komgaRoles
- ),
- array(
- 'type' => 'select2',
- 'class' => 'select2-multiple',
- 'id' => 'INVITES-select-' . $this->random_ascii_string(6),
- 'name' => 'INVITES-komga-libraryIds',
- 'label' => 'Libraries',
- 'value' => $this->config['INVITES-komga-libraryIds'],
- 'options' => $komgalibrary
- )
- ),
- 'Nextcloud Settings' => array(
- array(
- 'type' => 'switch',
- 'name' => 'INVITES-nextcloud-enabled',
- 'label' => 'Enable Nextcloud for auto create account',
- 'value' => $this->config['INVITES-nextcloud-enabled'],
- ),
- array(
- 'type' => 'switch',
- 'name' => 'INVITES-nextcloud-plex-sso',
- 'label' => 'Enable if you have Plex SSO app installed on Nextcloud',
- 'value' => $this->config['INVITES-nextcloud-plex-sso'],
- ),
- array(
- 'type' => 'input',
- 'name' => 'INVITES-nextcloud-url',
- 'label' => 'Nextcloud URI',
- 'value' => $this->config['INVITES-nextcloud-url']
- ),
- array(
- 'type' => 'input',
- 'name' => 'INVITES-nextcloud-admin-user',
- 'label' => 'Nextcloud Admin User',
- 'value' => $this->config['INVITES-nextcloud-admin-user']
- ),
- array(
- 'type' => 'password',
- 'name' => 'INVITES-nextcloud-admin-password',
- 'label' => 'Nextcloud Admin Password',
- 'value' => $this->config['INVITES-nextcloud-admin-password']
- ),
- array(
- 'type' => 'input',
- 'name' => 'INVITES-nextcloud-quota',
- 'label' => 'Storage quota for user after subscription (empty for no-limit)',
- 'value' => $this->config['INVITES-nextcloud-quota'],
- 'placeholder' => '10GB'
- ),
- array(
- 'type' => 'select2',
- 'class' => 'select2-multiple',
- 'id' => 'INVITES-select-' . $this->random_ascii_string(6),
- 'name' => 'INVITES-nextcloud-groups-member',
- 'label' => 'Nextcloud Groups after subscription',
- 'value' => $this->config['INVITES-nextcloud-groups-member'],
- 'options' => $nextcloudRoles
- )
- ),
- 'Emby Settings' => array(
- array(
- 'type' => 'password-alt',
- 'name' => 'embyToken',
- 'label' => 'Emby API key',
- 'value' => $this->config['embyToken'],
- 'placeholder' => 'enter key from emby'
- ),
- array(
- 'type' => 'text',
- 'name' => 'embyURL',
- 'label' => 'Emby server adress',
- 'value' => $this->config['embyURL'],
- 'placeholder' => 'localhost:8086'
- ),
- array(
- 'type' => 'text',
- 'name' => 'INVITES-EmbyTemplate',
- 'label' => 'Emby User to be used as template for new users',
- 'value' => $this->config['INVITES-EmbyTemplate'],
- 'placeholder' => 'AdamSmith'
- )
- ),
- 'FYI' => array(
- array(
- 'type' => 'html',
- 'label' => 'Note',
- 'html' => '<span lang="en">After enabling for the first time, please reload the page - Menu is located under User menu on top right</span>'
- )
- )
- );
- }
- public function _invitesPluginAction($username, $action = null, $type = null, $mail)
- {
- if ($action == null) {
- $this->setAPIResponse('error', 'No Action supplied', 409);
- return false;
- }
- switch ($type) {
- case 'plex':
- if (!empty($this->config['plexToken']) && !empty($this->config['plexID'])) {
- $url = "https://plex.tv/api/servers/" . $this->config['plexID'] . "/shared_servers/";
- if ($this->config['INVITES-plexLibraries'] !== "") {
- $libraries = explode(',', $this->config['INVITES-plexLibraries']);
- } else {
- $libraries = '';
- }
- if ($this->config['INVITES-plex-tv-labels'] !== "") {
- $tv_labels = "label=" . $this->config['INVITES-plex-tv-labels'];
- } else {
- $tv_labels = "";
- }
- if ($this->config['INVITES-plex-movies-labels'] !== "") {
- $movies_labels = "label=" . $this->config['INVITES-plex-movies-labels'];
- } else {
- $movies_labels = "";
- }
- if ($this->config['INVITES-plex-music-labels'] !== "") {
- $music_labels = "label=" . $this->config['INVITES-plex-music-labels'];
- } else {
- $music_labels = "";
- }
- $headers = array(
- "Accept" => "application/json",
- "Content-Type" => "application/json",
- "X-Plex-Token" => $this->config['plexToken']
- );
- $data = array(
- "server_id" => $this->config['plexID'],
- "shared_server" => array(
- "library_section_ids" => $libraries,
- "invited_email" => $username
- ),
- "sharing_settings" => array(
- "filterTelevision" => $tv_labels,
- "filterMovies" => $movies_labels,
- "filterMusic" => $music_labels
- )
- );
- try {
- switch ($action) {
- case 'share':
- $response = Requests::post($url, $headers, json_encode($data), array());
- if($this->config['INVITES-add-plex-home']) {
- $this->_addUserPlexHome($mail);
- }
- if($this->config['INVITES-komga-enabled']) {
- $this->_createKomgaAccount($mail);
- }
- if ($this->config['INVITES-nextcloud-enabled']) {
- $nextcloudAccountCreated = $this->_createNextcloudAccount($mail, $username);
- }
- break;
- case 'unshare':
- $id = (is_numeric($username) ? $username : $this->_invitesPluginConvertPlexName($username, "id"));
- $url = $url . $id;
- $response = Requests::delete($url, $headers, array());
- break;
- default:
- $this->setAPIResponse('error', 'No Action supplied', 409);
- return false;
- }
- if ($response->success) {
- $this->setLoggerChannel('Invites')->info('Plex User now has access to system');
- $this->setAPIResponse('success', 'Plex User now has access to system', 200);
- return true;
- } else {
- switch ($response->status_code) {
- case 400:
- $this->setLoggerChannel('Plex')->warning('Plex User already has access');
- $this->setAPIResponse('success', 'Plex User already has access', 200);
- return true;
- case 401:
- $this->setLoggerChannel('Plex')->warning('Incorrect Token');
- $this->setAPIResponse('error', 'Incorrect Token', 409);
- return false;
- case 404:
- $this->setLoggerChannel('Plex')->warning('Libraries not setup correctly');
- $this->setAPIResponse('error', 'Libraries not setup correct', 409);
- return false;
- default:
- $this->setLoggerChannel('Plex')->warning('An error occurred [' . $response->status_code . ']');
- $this->setAPIResponse('error', 'An Error Occurred', 409);
- return false;
- }
- }
- } catch (Requests_Exception $e) {
- $this->setLoggerChannel('Plex')->error($e);
- $this->setAPIResponse('error', $e->getMessage(), 409);
- return false;
- }
- } else {
- $this->setLoggerChannel('Plex')->warning('Plex Token/ID not set');
- $this->setAPIResponse('error', 'Plex Token/ID not set', 409);
- return false;
- }
- break;
- case 'emby':
- try {
- #add emby user to system
- $this->setAPIResponse('success', 'User now has access to system', 200);
- return true;
- } catch (Requests_Exception $e) {
- $this->setLoggerChannel('Emby')->error($e);
- $this->setAPIResponse('error', $e->getMessage(), 409);
- return false;
- }
- default:
- return false;
- }
- return false;
- }
- public function _invitesPluginConvertPlexName($user, $type)
- {
- $array = $this->userList('plex');
- switch ($type) {
- case "username":
- case "u":
- $plexUser = array_search($user, $array['users']);
- break;
- case "id":
- if (array_key_exists(strtolower($user), $array['users'])) {
- $plexUser = $array['users'][strtolower($user)];
- }
- break;
- default:
- $plexUser = false;
- }
- return (!empty($plexUser) ? $plexUser : null);
- }
- /**
- * Creates a new Komga user account using the provided email address.
- *
- * @param string $email The email address for the new Komga user account.
- * @return bool True if the account was successfully created, false otherwise.
- */
- private function _createKomgaAccount($email) {
- $this->logger->info('Try to create Komga account for ' . $email);
- if(!$this->_checkKomgaVar()) {
- return false;
- }
- if (empty($email)) {
- $this->setLoggerChannel('Invites')->info('User email empty');
- return false;
- }
- $endpoint = rtrim($this->config['INVITES-komga-uri'], '/') . '/api/v2/users';
- $apiKey = $this->config['INVITES-komga-api-key'];
- $password = $this->decrypt($this->config['INVITES-komga-default-user-password']);
- $rolesStr = $this->config['INVITES-komga-roles'] ?? '';
- $roles = array_values(array_filter(array_map('trim', explode(';', $rolesStr))));
- $libIdsStr = $this->config['INVITES-komga-libraryIds'] ?? '';
- $libraryIds = array_values(array_filter(array_map('trim', explode(';', $libIdsStr))));
- $headers = array(
- 'accept' => 'application/json',
- 'X-API-Key' => $apiKey,
- 'Content-Type' => 'application/json'
- );
- $payload = array(
- 'email' => $email,
- 'password' => $password,
- 'roles' => $roles,
- 'sharedLibraries' => array(
- 'all' => false,
- 'libraryIds' => $libraryIds
- )
- );
- try {
- $response = Requests::post($endpoint, $headers, json_encode($payload));
- if ($response->success) {
- $this->setLoggerChannel('Komga')->info('User created ' . $email . ' with roles: ' . implode(',', $roles) . ' and libraries: ' . implode(',', $libraryIds));
- return true;
- }
- $this->setLoggerChannel('Komga')->warning('User not created ' . $email . ' HTTP ' . $response->status_code);
- } catch (Requests_Exception $e) {
- $this->setLoggerChannel('Komga')->error('User not created ' . $email . ' Requests_Exception: ' . $e->getMessage());
- }
- return false;
- }
- /**
- * Retrieves a list of Komga roles
- *
- * @return array An array of associative arrays, each containing 'name' and 'value' for a Komga role.
- */
- public function _getKomgaRoles() {
- $komgaRoles = array();
- $roleNames = array(
- 'ADMIN' => 'Administrator',
- 'FILE_DOWNLOAD' => 'File download',
- 'PAGE_STREAMING' => 'Page streaming',
- 'KOBO_SYNC' => 'Kobo Sync',
- 'KOREADER_SYNC' => 'Koreader Sync'
- );
- foreach ($roleNames as $value => $name) {
- $komgaRoles[] = array(
- 'name' => $name,
- 'value' => $value
- );
- }
- return $komgaRoles;
- }
- /**
- * Fetches the list of Komga libraries from the Komga API.
- *
- * @return array|false Returns an array of libraries with 'name' and 'id' on success, or false on failure.
- */
- public function _getKomgaLibraries() {
- $this->logger->info('Try to fetch Komga libraries');
- if(!$this->_checkKomgaVar()) {
- return false;
- }
- $endpoint = rtrim($this->config['komgaURL'], '/') . '/api/v1/libraries';
- $apiKey = $this->config['INVITES-komga-api-key'];
- $libraryListDefault = array(
- array(
- 'name' => 'Refresh page to update List',
- 'value' => '',
- 'disabled' => true,
- ),
- );
- $headers = array(
- 'accept' => 'application/json',
- 'X-API-Key' => $apiKey
- );
- try {
- $response = Requests::get($endpoint, $headers);
- if ($response->success) {
- $libraries = json_decode($response->body, true);
- // Komga retourne un tableau d'objets librairie
- $result = array();
- foreach ($libraries as $library) {
- $result[] = array(
- 'name' => $library['name'],
- 'id' => $library['id']
- );
- }
- $this->logger->info('Fetched libraries: ' . json_encode($result));
- if(!empty($result)) {
- return $result;
- }
- } else {
- $this->logger->warning("Error HTTP ".$response->status_code.' body='.$response->body);
- }
- } catch (Requests_Exception $e) {
- $this->logger->warning("Exception: " . $e->getMessage());
- }
- return $libraryListDefault;
- }
- /**
- * Fetches the list of Nextcloud groups using the configured Nextcloud admin credentials.
- *
- * @return array|false Returns an array of groups with 'name' and 'value' keys on success,
- * or false on failure.
- */
- public function _getNextcloudGroups() {
- $this->logger->info('Try to fetch Nextcloud groups');
- if(!$this->_checkNextcloudVar()) {
- return false;
- }
- $url = rtrim($this->config['INVITES-nextcloud-url'], '/') . '/ocs/v1.php/cloud/groups';
- $adminUser = $this->config['INVITES-nextcloud-admin-user'];
- $adminPass = $this->decrypt($this->config['INVITES-nextcloud-admin-password']);
- $headers = array(
- 'OCS-APIRequest' => 'true',
- 'Accept' => 'application/json',
- );
- try {
- $options = array(
- 'auth' => array($adminUser, $adminPass),
- );
- $response = Requests::get($url, $headers, $options);
- if ($response->success) {
- $body = json_decode($response->body, true);
- if (isset($body['ocs']['data']['groups'])) {
- $this->logger->info('Fetched groups: ' . implode(', ', $body['ocs']['data']['groups']));
- $groups = $body['ocs']['data']['groups'];
- $result = array();
- foreach ($groups as $group) {
- $result[] = array(
- 'name' => $group,
- 'value' => $group
- );
- }
- return $result;
- } else {
- $this->logger->warning('Groups not found in response');
- }
- } else {
- $this->logger->warning("Error HTTP ".$response->status_code.' body='.$response->body);
- }
- } catch (Requests_Exception $e) {
- $this->logger->warning("Exception: " . $e->getMessage());
- }
- return false;
- }
- /**
- * Checks if all required Nextcloud configuration variables are set.
- *
- * @return bool Returns true if all required Nextcloud configuration variables are set; false otherwise.
- */
- public function _checkNextcloudVar() {
- if (empty($this->config['INVITES-nextcloud-enabled'])) {
- $this->logger->info('Nextcloud disabled in config');
- return false;
- }
- if (empty($this->config['INVITES-nextcloud-url'])) {
- $this->logger->info('Nextcloud URL missing');
- return false;
- }
- if (empty($this->config['INVITES-nextcloud-admin-user']) || empty($this->config['INVITES-nextcloud-admin-password'])) {
- $this->logger->info('Nextcloud admin credentials missing');
- return false;
- }
- return true;
- }
- /**
- * Checks if all required komga configuration variables are set.
- *
- * @return bool Returns true if all required komga configuration variables are set; false otherwise.
- */
- public function _checkKomgaVar() {
- if (empty($this->config['INVITES-komga-uri'])) {
- $this->setLoggerChannel('Invites')->info('Komga uri is missing');
- return false;
- }
- if (empty($this->config['INVITES-komga-api-key'])) {
- $this->setLoggerChannel('Invites')->info('Komga api key is missing');
- return false;
- }
- if (empty($this->config['INVITES-komga-roles'])) {
- $this->setLoggerChannel('Invites')->info('Komga roles empty');
- return false;
- }
- if (empty($this->config['INVITES-komga-libraryIds'])) {
- $this->setLoggerChannel('Invites')->info('Komga library empty');
- return false;
- }
- if (empty($this->config['INVITES-komga-default-user-password'])) {
- $this->setLoggerChannel('Invites')->info('Komga default user password empty');
- return false;
- }
- return true;
- }
- /**
- * Creates a Nextcloud account for a user based on their email and other parameters.
- *
- * @param string $email The email address of the user to create in Nextcloud.
- * @param string $displayName The display name for the Nextcloud user.
- * @param string $nextcloudGroupsMember A semicolon-separated list of Nextcloud groups to add the user to.
- * @param string $nextcloudQuota The storage quota to assign to the user (e.g., "5GB").
- *
- * @return bool Returns true if the account was successfully created, false otherwise.
- */
- public function _createNextcloudAccount($email, $displayName) {
- $this->logger->info('Try to create Nextcloud account');
- if(!$this->_checkNextcloudVar()) {
- return false;
- }
- $nextcloudGroupsMember = $this->config['INVITES-nextcloud-groups-member'] ?? '';
- $nextcloudQuota = $this->config['INVITES-nextcloud-quota'] ?? '';
- $userid = $email;
- if($this->config['INVITES-nextcloud-plex-sso']) {
- $plexUserId = $this->_getPlexUserIdByEmail($email);
- $this->logger->warning('plexUserId=' . $plexUserId);
- if (!empty($plexUserId)) {
- $userid = 'PlexTv-' . $plexUserId;
- }
- }
- try {
- $password = bin2hex(random_bytes(12));
- } catch (\Throwable $e) {
- $password = bin2hex(openssl_random_pseudo_bytes(12));
- }
- if (empty($password)) {
- $this->logger->warning('Error generating password');
- return false;
- }
- $url = rtrim($this->config['INVITES-nextcloud-url'], '/') . '/ocs/v1.php/cloud/users';
- $adminUser = $this->config['INVITES-nextcloud-admin-user'];
- $adminPass = $this->decrypt($this->config['INVITES-nextcloud-admin-password']);
- $headers = array(
- 'OCS-APIRequest' => 'true',
- 'Accept' => 'application/json',
- );
- $data = array(
- 'userid' => $userid,
- 'password' => $password,
- 'email' => $email,
- 'displayName' => $displayName,
- );
- if (!empty($nextcloudGroupsMember)) {
- $groups = array_values(array_filter(array_map('trim', explode(';', $nextcloudGroupsMember))));
- foreach ($groups as $group) {
- $data['groups[]'] = $group;
- }
- }
- if (!empty($nextcloudQuota)) {
- $data['quota'] = $nextcloudQuota;
- }
- try {
- $options = array(
- 'auth' => array($adminUser, $adminPass),
- );
- $response = Requests::post($url, $headers, $data, $options);
- if ($response->success) {
- $this->logger->info("User created ($email)");
- return true;
- }
- $this->logger->warning("Error ($email) HTTP ".$response->status_code.' body='.$response->body);
- } catch (Requests_Exception $e) {
- $this->logger->warning("Exception: " . $e->getMessage());
- }
- return false;
- }
- /**
- * Retrieves the Plex user ID associated with a given email address.
- *
- * @param string $email The email address to search for in the shared Plex users.
- * @return string|null The Plex user ID if found, or null if not found or on error.
- */
- public function _getPlexUserIdByEmail($email) {
- $this->logger->info("Try to get Plex userID for $email");
- if (empty($this->config['plexToken']) || empty($this->config['plexID'])) {
- $this->logger->warning("PlexToken ou plexID missing");
- return null;
- }
- $url = "https://clients.plex.tv/api/invites/requested";
- $headers = array(
- "Accept" => "application/json",
- "X-Plex-Token" => $this->config['plexToken']
- );
- try {
- $response = Requests::get($url, $headers);
- if ($response->success) {
- $xml = simplexml_load_string($response->body);
- // Parcourt les éléments <Invite> du MediaContainer
- foreach ($xml->Invite as $invite) {
- $inviteEmail = (string)$invite['email'];
- $inviteId = (string)$invite['id'];
- if (strcasecmp($inviteEmail, $email) === 0) {
- $this->logger->info("Find id=$inviteId for $email");
- return $inviteId;
- }
- }
- }
- $this->logger->warning("No userId found for $email");
- } catch (Requests_Exception $e) {
- $this->logger->warning("Exception: " . $e->getMessage());
- }
- return null;
- }
- /**
- * Retrieves the email address associated with a given invite code.
- *
- * @param string $inviteCode The invite code to look up.
- * @return string|false The email address associated with the invite code, or false if not found.
- */
- public function _getEmailFronInviteCode($inviteCode) {
- if (empty($inviteCode)) {
- $this->logger->warning('Invite code not found');
- return false;
- }
- $emailLookupQuery = [
- array(
- 'function' => 'fetch',
- 'query' => array(
- 'SELECT email FROM invites WHERE code = ? COLLATE NOCASE',
- $inviteCode
- )
- )
- ];
- $emailRow = $this->processQueries($emailLookupQuery);
- if ($emailRow && !empty($emailRow['email'])) {
- $this->logger->info("Email foud via the code [$inviteCode] : ".$emailRow['email']);
- return $emailRow['email'];
- } else {
- $this->logger->warning("No mail found for the code [$inviteCode]");
- return false;
- }
- }
- /**
- * Adds a user to Plex Home using the provided email address.
- *
- * @param string $email The email address of the user to invite.
- * @return array|false Returns the decoded response from Plex API on success, or false on failure.
- */
- public function _addUserPlexHome($email){
- if (empty($email) || empty($this->config['plexToken'])) {
- $this->logger->warning('_addUserPlexHome: email or plexToken missing');
- return false;
- }
- $url = 'https://clients.plex.tv/api/home/users?invitedEmail=' . urlencode($email) . '&skipFriendship=1&X-Plex-Token=' . urlencode($this->config['plexToken']);
- try {
- $response = Requests::post($url, $headers);
- if ($response->success) {
- $this->logger->info('User added on plex home');
- return json_decode($response->body, true);
- } else {
- $this->logger->info('_getPlexHomeUserByEmail: error (HTTP ' . $response->status_code . ')');
- }
- } catch (Requests_Exception $e) {
- $this->logger->info('_addUserPlexHome: ' . $e->getMessage());
- }
- return false;
- }
- }
|