'UserWatchStats',
'enabled' => true,
'image' => 'plugins/images/homepage/userWatchStats.png',
'category' => 'Media Server',
'settingsArray' => __FUNCTION__
];
if ($infoOnly) {
return $homepageInformation;
}
$homepageSettings = [
'debug' => true,
'settings' => [
'Enable' => [
$this->settingsOption('enable', 'homepageUserWatchStatsEnabled'),
$this->settingsOption('auth', 'homepageUserWatchStatsAuth'),
],
'Connection' => [
$this->settingsOption('select', 'homepageUserWatchStatsService', ['label' => 'Media Server', 'options' => [
['name' => 'Plex (via Tautulli)', 'value' => 'plex'],
['name' => 'Emby', 'value' => 'emby'],
['name' => 'Jellyfin', 'value' => 'jellyfin']
]]),
$this->settingsOption('url', 'userWatchStatsURL'),
$this->settingsOption('token', 'userWatchStatsApikey'),
$this->settingsOption('disable-cert-check', 'userWatchStatsDisableCertCheck'),
$this->settingsOption('use-custom-certificate', 'userWatchStatsUseCustomCertificate'),
],
'Display Options' => [
$this->settingsOption('number', 'homepageUserWatchStatsRefresh', ['label' => 'Auto-refresh Interval (minutes)', 'min' => 1, 'max' => 60]),
$this->settingsOption('number', 'homepageUserWatchStatsDays', ['label' => 'Statistics Period (days)', 'min' => 1, 'max' => 365]),
$this->settingsOption('switch', 'homepageUserWatchStatsCompactView', ['label' => 'Use Compact View']),
$this->settingsOption('switch', 'homepageUserWatchStatsShowTopUsers', ['label' => 'Show Top Users']),
$this->settingsOption('switch', 'homepageUserWatchStatsShowMostWatched', ['label' => 'Show Most Watched']),
$this->settingsOption('switch', 'homepageUserWatchStatsShowRecentActivity', ['label' => 'Show Recent Activity']),
$this->settingsOption('number', 'homepageUserWatchStatsMaxItems', ['label' => 'Maximum Items to Display', 'min' => 5, 'max' => 50]),
],
'Test Connection' => [
$this->settingsOption('blank', null, ['label' => 'Please Save before Testing']),
$this->settingsOption('test', 'userWatchStats'),
]
]
];
return array_merge($homepageInformation, $homepageSettings);
}
public function testConnectionUserWatchStats()
{
if (!$this->homepageItemPermissions($this->userWatchStatsHomepagePermissions('test'), true)) {
return false;
}
$mediaServer = $this->config['homepageUserWatchStatsService'] ?? 'plex';
// Get URL and token from plugin-specific config
$url = $this->config['userWatchStatsURL'] ?? '';
$token = $this->config['userWatchStatsApikey'] ?? '';
$disableCert = $this->config['userWatchStatsDisableCertCheck'] ?? false;
$customCert = $this->config['userWatchStatsUseCustomCertificate'] ?? false;
if (empty($url) || empty($token)) {
$serverName = ucfirst($mediaServer) . ($mediaServer === 'plex' ? ' (Tautulli)' : '');
$this->setAPIResponse('error', $serverName . ' URL or API key not configured', 500);
return false;
}
// Test the connection based on media server type
try {
$options = $this->requestOptions($url, null, $disableCert, $customCert);
switch (strtolower($mediaServer)) {
case 'plex':
// Test Tautulli connection
$testUrl = $this->qualifyURL($url) . '/api/v2?apikey=' . $token . '&cmd=get_server_info';
$response = Requests::get($testUrl, [], $options);
if ($response->success) {
$data = json_decode($response->body, true);
if (isset($data['response']['result']) && $data['response']['result'] === 'success') {
$this->setAPIResponse('success', 'Successfully connected to Tautulli', 200);
return true;
}
}
break;
case 'emby':
// Test Emby connection
$testUrl = $this->qualifyURL($url) . '/emby/System/Info?api_key=' . $token;
$response = Requests::get($testUrl, [], $options);
if ($response->success) {
$data = json_decode($response->body, true);
if (isset($data['ServerName'])) {
$this->setAPIResponse('success', 'Successfully connected to Emby server: ' . $data['ServerName'], 200);
return true;
}
}
break;
case 'jellyfin':
// Test Jellyfin connection
$testUrl = $this->qualifyURL($url) . '/System/Info?api_key=' . $token;
$response = Requests::get($testUrl, [], $options);
if ($response->success) {
$data = json_decode($response->body, true);
if (isset($data['ServerName'])) {
$this->setAPIResponse('success', 'Successfully connected to Jellyfin server: ' . $data['ServerName'], 200);
return true;
}
}
break;
}
$this->setAPIResponse('error', 'Connection test failed - invalid response from server', 500);
return false;
} catch (Exception $e) {
$this->setAPIResponse('error', 'Connection test failed: ' . $e->getMessage(), 500);
return false;
}
}
public function userWatchStatsHomepagePermissions($key = null)
{
$permissions = [
'test' => [
'enabled' => [
'homepageUserWatchStatsEnabled',
],
'auth' => [
'homepageUserWatchStatsAuth',
],
'not_empty' => [
'userWatchStatsURL',
'userWatchStatsApikey'
]
],
'main' => [
'enabled' => [
'homepageUserWatchStatsEnabled'
],
'auth' => [
'homepageUserWatchStatsAuth'
],
'not_empty' => [
'userWatchStatsURL',
'userWatchStatsApikey'
]
]
];
return $this->homepageCheckKeyPermissions($key, $permissions);
}
public function homepageOrderUserWatchStats()
{
if ($this->homepageItemPermissions($this->userWatchStatsHomepagePermissions('main'))) {
$refreshInterval = ($this->config['homepageUserWatchStatsRefresh'] ?? 5) * 60000; // Convert minutes to milliseconds
$compactView = ($this->config['homepageUserWatchStatsCompactView'] ?? false) ? 'true' : 'false';
$days = $this->config['homepageUserWatchStatsDays'] ?? 30;
$maxItems = $this->config['homepageUserWatchStatsMaxItems'] ?? 10;
$showTopUsers = ($this->config['homepageUserWatchStatsShowTopUsers'] ?? true) ? 'true' : 'false';
$showMostWatched = ($this->config['homepageUserWatchStatsShowMostWatched'] ?? true) ? 'true' : 'false';
$showRecentActivity = ($this->config['homepageUserWatchStatsShowRecentActivity'] ?? true) ? 'true' : 'false';
return '
';
}
}
/**
* Main function to get watch statistics
*/
public function getUserWatchStats($options = null)
{
if (!$this->homepageItemPermissions($this->userWatchStatsHomepagePermissions('main'), true)) {
return false;
}
try {
$mediaServer = $this->config['homepageUserWatchStatsService'] ?? 'plex';
$days = intval($this->config['homepageUserWatchStatsDays'] ?? 30);
switch (strtolower($mediaServer)) {
case 'plex':
$stats = $this->getPlexWatchStats($days);
break;
case 'emby':
$stats = $this->getEmbyWatchStats($days);
break;
case 'jellyfin':
$stats = $this->getJellyfinWatchStats($days);
break;
default:
$stats = $this->getPlexWatchStats($days);
break;
}
if (isset($stats['error']) && $stats['error']) {
$this->setAPIResponse('error', $stats['message'], 500);
return false;
}
$this->setAPIResponse('success', 'Watch statistics retrieved successfully', 200, $stats);
return true;
} catch (Exception $e) {
$this->writeLog('error', 'User Watch Stats Error: ' . $e->getMessage(), 'SYSTEM');
$this->setAPIResponse('error', 'Failed to retrieve watch statistics: ' . $e->getMessage(), 500);
return false;
}
}
/**
* Get Plex watch statistics via Tautulli API
*/
private function getPlexWatchStats($days = 30)
{
$tautulliUrl = $this->config['userWatchStatsURL'] ?? '';
$tautulliToken = $this->config['userWatchStatsApikey'] ?? '';
if (empty($tautulliUrl) || empty($tautulliToken)) {
return ['error' => true, 'message' => 'Tautulli URL or API key not configured'];
}
$endDate = date('Y-m-d');
$startDate = date('Y-m-d', strtotime("-{$days} days"));
$stats = [
'period' => "{$days} days",
'start_date' => $startDate,
'end_date' => $endDate,
'most_watched' => $this->getTautulliMostWatched($tautulliUrl, $tautulliToken, $days),
'least_watched' => $this->getTautulliLeastWatched($tautulliUrl, $tautulliToken, $days),
'user_stats' => $this->getTautulliUserStats($tautulliUrl, $tautulliToken, $days),
'recent_activity' => $this->getTautulliRecentActivity($tautulliUrl, $tautulliToken),
'top_users' => $this->getTautulliTopUsers($tautulliUrl, $tautulliToken, $days)
];
return $stats;
}
/**
* Get most watched content from Tautulli
*/
private function getTautulliMostWatched($url, $token, $days)
{
$apiURL = rtrim($url, '/') . '/api/v2?apikey=' . $token . '&cmd=get_home_stats&time_range=' . $days . '&stats_type=plays&stats_count=10';
try {
$options = $this->requestOptions($url, null, $this->config['userWatchStatsDisableCertCheck'] ?? false, $this->config['userWatchStatsUseCustomCertificate'] ?? false);
$response = Requests::get($apiURL, [], $options);
if ($response->success) {
$data = json_decode($response->body, true);
return $data['response']['data'] ?? [];
}
} catch (Requests_Exception $e) {
$this->writeLog('error', 'Tautulli Most Watched Error: ' . $e->getMessage(), 'SYSTEM');
}
return [];
}
/**
* Get user statistics from Tautulli
*/
private function getTautulliUserStats($url, $token, $days)
{
$apiURL = rtrim($url, '/') . '/api/v2?apikey=' . $token . '&cmd=get_user_watch_time_stats&time_range=' . $days;
try {
$options = $this->requestOptions($url, null, $this->config['userWatchStatsDisableCertCheck'] ?? false, $this->config['userWatchStatsUseCustomCertificate'] ?? false);
$response = Requests::get($apiURL, [], $options);
if ($response->success) {
$data = json_decode($response->body, true);
return $data['response']['data'] ?? [];
}
} catch (Requests_Exception $e) {
$this->writeLog('error', 'Tautulli User Stats Error: ' . $e->getMessage(), 'SYSTEM');
}
return [];
}
/**
* Get top users from Tautulli
*/
private function getTautulliTopUsers($url, $token, $days)
{
$apiURL = rtrim($url, '/') . '/api/v2?apikey=' . $token . '&cmd=get_users&length=25';
try {
$options = $this->requestOptions($url, null, $this->config['userWatchStatsDisableCertCheck'] ?? false, $this->config['userWatchStatsUseCustomCertificate'] ?? false);
$response = Requests::get($apiURL, [], $options);
if ($response->success) {
$data = json_decode($response->body, true);
$users = $data['response']['data']['data'] ?? [];
// Sort by play count
usort($users, function($a, $b) {
return ($b['play_count'] ?? 0) - ($a['play_count'] ?? 0);
});
return array_slice($users, 0, 10);
}
} catch (Requests_Exception $e) {
$this->writeLog('error', 'Tautulli Top Users Error: ' . $e->getMessage(), 'SYSTEM');
}
return [];
}
/**
* Get recent activity from Tautulli
*/
private function getTautulliRecentActivity($url, $token)
{
$apiURL = rtrim($url, '/') . '/api/v2?apikey=' . $token . '&cmd=get_recently_added&count=10';
try {
$options = $this->requestOptions($url, null, $this->config['userWatchStatsDisableCertCheck'] ?? false, $this->config['userWatchStatsUseCustomCertificate'] ?? false);
$response = Requests::get($apiURL, [], $options);
if ($response->success) {
$data = json_decode($response->body, true);
return $data['response']['data']['recently_added'] ?? [];
}
} catch (Requests_Exception $e) {
$this->writeLog('error', 'Tautulli Recent Activity Error: ' . $e->getMessage(), 'SYSTEM');
}
return [];
}
/**
* Get least watched content (inverse of most watched)
*/
private function getTautulliLeastWatched($url, $token, $days)
{
$apiURL = rtrim($url, '/') . '/api/v2?apikey=' . $token . '&cmd=get_libraries';
try {
$options = $this->requestOptions($url, null, $this->config['userWatchStatsDisableCertCheck'] ?? false, $this->config['userWatchStatsUseCustomCertificate'] ?? false);
$response = Requests::get($apiURL, [], $options);
if ($response->success) {
$data = json_decode($response->body, true);
$libraries = $data['response']['data'] ?? [];
$leastWatched = [];
foreach ($libraries as $library) {
$libraryStats = $this->getTautulliLibraryStats($url, $token, $library['section_id'], $days);
if (!empty($libraryStats)) {
$leastWatched = array_merge($leastWatched, array_slice($libraryStats, -10));
}
}
return $leastWatched;
}
} catch (Requests_Exception $e) {
$this->writeLog('error', 'Tautulli Least Watched Error: ' . $e->getMessage(), 'SYSTEM');
}
return [];
}
/**
* Get library statistics for least watched calculation
*/
private function getTautulliLibraryStats($url, $token, $sectionId, $days)
{
$apiURL = rtrim($url, '/') . '/api/v2?apikey=' . $token . '&cmd=get_library_media_info§ion_id=' . $sectionId . '&length=50&order_column=play_count&order_dir=asc';
try {
$options = $this->requestOptions($url, null, $this->config['userWatchStatsDisableCertCheck'] ?? false, $this->config['userWatchStatsUseCustomCertificate'] ?? false);
$response = Requests::get($apiURL, [], $options);
if ($response->success) {
$data = json_decode($response->body, true);
return $data['response']['data']['data'] ?? [];
}
} catch (Requests_Exception $e) {
$this->writeLog('error', 'Tautulli Library Stats Error: ' . $e->getMessage(), 'SYSTEM');
}
return [];
}
/**
* Get Emby watch statistics
*/
private function getEmbyWatchStats($days = 30)
{
$embyUrl = $this->config['userWatchStatsURL'] ?? '';
$embyToken = $this->config['userWatchStatsApikey'] ?? '';
if (empty($embyUrl) || empty($embyToken)) {
return ['error' => true, 'message' => 'Emby URL or API key not configured'];
}
$endDate = date('Y-m-d');
$startDate = date('Y-m-d', strtotime("-{$days} days"));
$stats = [
'period' => "{$days} days",
'start_date' => $startDate,
'end_date' => $endDate,
'most_watched' => $this->getEmbyMostWatched($embyUrl, $embyToken, $days),
'least_watched' => [], // Emby doesn't have a direct least watched API
'user_stats' => $this->getEmbyUserStats($embyUrl, $embyToken, $days),
'recent_activity' => $this->getEmbyRecentActivity($embyUrl, $embyToken),
'top_users' => $this->getEmbyTopUsers($embyUrl, $embyToken, $days)
];
return $stats;
}
/**
* Get Jellyfin watch statistics
*/
private function getJellyfinWatchStats($days = 30)
{
$jellyfinUrl = $this->config['jellyfinURL'] ?? '';
$jellyfinToken = $this->config['jellyfinToken'] ?? '';
if (empty($jellyfinUrl) || empty($jellyfinToken)) {
return ['error' => true, 'message' => 'Jellyfin URL or API key not configured'];
}
// Implement Jellyfin-specific statistics gathering
return $this->getGenericMediaServerStats('jellyfin', $jellyfinUrl, $jellyfinToken, $days);
}
/**
* Generic media server stats for Emby/Jellyfin
*/
private function getGenericMediaServerStats($type, $url, $token, $days)
{
// Basic structure for now - can be expanded based on Emby/Jellyfin APIs
return [
'period' => "{$days} days",
'start_date' => date('Y-m-d', strtotime("-{$days} days")),
'end_date' => date('Y-m-d'),
'message' => ucfirst($type) . ' statistics coming soon',
'most_watched' => [],
'least_watched' => [],
'user_stats' => [],
'recent_activity' => [],
'top_users' => []
];
}
/**
* Format duration for display
*/
private function formatDuration($seconds)
{
if ($seconds < 3600) {
return gmdate('i:s', $seconds);
} else {
return gmdate('H:i:s', $seconds);
}
}
/**
* Get user avatar URL
*/
private function getUserAvatar($userId, $mediaServer = 'plex')
{
switch ($mediaServer) {
case 'plex':
return $this->getPlexUserAvatar($userId);
case 'emby':
return $this->getEmbyUserAvatar($userId);
case 'jellyfin':
return $this->getJellyfinUserAvatar($userId);
default:
return '/plugins/images/organizr/user-bg.png';
}
}
/**
* Get Plex user avatar
*/
private function getPlexUserAvatar($userId)
{
$tautulliUrl = $this->config['plexURL'] ?? '';
$tautulliToken = $this->config['plexToken'] ?? '';
if (empty($tautulliUrl) || empty($tautulliToken)) {
return '/plugins/images/organizr/user-bg.png';
}
$apiURL = rtrim($tautulliUrl, '/') . '/api/v2?apikey=' . $tautulliToken . '&cmd=get_user_thumb&user_id=' . $userId;
try {
$options = $this->requestOptions($tautulliUrl, null, $this->config['plexDisableCertCheck'] ?? false, $this->config['plexUseCustomCertificate'] ?? false);
$response = Requests::get($apiURL, [], $options);
if ($response->success) {
$data = json_decode($response->body, true);
return $data['response']['data']['thumb'] ?? '/plugins/images/organizr/user-bg.png';
}
} catch (Requests_Exception $e) {
$this->writeLog('error', 'Tautulli User Avatar Error: ' . $e->getMessage(), 'SYSTEM');
}
return '/plugins/images/organizr/user-bg.png';
}
/**
* Get most watched content from Emby
*/
private function getEmbyMostWatched($url, $token, $days)
{
$apiURL = rtrim($url, '/') . '/emby/Items?api_key=' . $token . '&SortBy=PlayCount&SortOrder=Descending&Limit=10&Recursive=true&IncludeItemTypes=Movie,Episode';
try {
$options = $this->requestOptions($url, null, $this->config['userWatchStatsDisableCertCheck'] ?? false, $this->config['userWatchStatsUseCustomCertificate'] ?? false);
$response = Requests::get($apiURL, [], $options);
if ($response->success) {
$data = json_decode($response->body, true);
$items = $data['Items'] ?? [];
$mostWatched = [];
foreach ($items as $item) {
$mostWatched[] = [
'title' => $item['Name'] ?? 'Unknown Title',
'play_count' => $item['UserData']['PlayCount'] ?? 0,
'type' => $item['Type'] ?? 'Unknown',
'year' => $item['ProductionYear'] ?? null
];
}
return $mostWatched;
}
} catch (Requests_Exception $e) {
$this->writeLog('error', 'Emby Most Watched Error: ' . $e->getMessage(), 'SYSTEM');
}
return [];
}
/**
* Get user statistics from Emby
*/
private function getEmbyUserStats($url, $token, $days)
{
$apiURL = rtrim($url, '/') . '/emby/Users?api_key=' . $token;
try {
$options = $this->requestOptions($url, null, $this->config['userWatchStatsDisableCertCheck'] ?? false, $this->config['userWatchStatsUseCustomCertificate'] ?? false);
$response = Requests::get($apiURL, [], $options);
if ($response->success) {
$data = json_decode($response->body, true);
return $data ?? [];
}
} catch (Requests_Exception $e) {
$this->writeLog('error', 'Emby User Stats Error: ' . $e->getMessage(), 'SYSTEM');
}
return [];
}
/**
* Get top users from Emby
*/
private function getEmbyTopUsers($url, $token, $days)
{
$apiURL = rtrim($url, '/') . '/emby/Users?api_key=' . $token;
try {
$options = $this->requestOptions($url, null, $this->config['userWatchStatsDisableCertCheck'] ?? false, $this->config['userWatchStatsUseCustomCertificate'] ?? false);
$response = Requests::get($apiURL, [], $options);
if ($response->success) {
$data = json_decode($response->body, true);
$users = $data ?? [];
$topUsers = [];
foreach ($users as $user) {
if (!isset($user['Policy']['IsHidden']) || !$user['Policy']['IsHidden']) {
$topUsers[] = [
'username' => $user['Name'] ?? 'Unknown User',
'friendly_name' => $user['Name'] ?? 'Unknown User',
'play_count' => 0, // Emby doesn't provide direct play count per user
'last_seen' => $user['LastActivityDate'] ?? null
];
}
}
return array_slice($topUsers, 0, 10);
}
} catch (Requests_Exception $e) {
$this->writeLog('error', 'Emby Top Users Error: ' . $e->getMessage(), 'SYSTEM');
}
return [];
}
/**
* Get recent activity from Emby
*/
private function getEmbyRecentActivity($url, $token)
{
$apiURL = rtrim($url, '/') . '/emby/Items/Latest?api_key=' . $token . '&Limit=10&Recursive=true&IncludeItemTypes=Movie,Episode';
try {
$options = $this->requestOptions($url, null, $this->config['userWatchStatsDisableCertCheck'] ?? false, $this->config['userWatchStatsUseCustomCertificate'] ?? false);
$response = Requests::get($apiURL, [], $options);
if ($response->success) {
$data = json_decode($response->body, true);
$recentActivity = [];
foreach ($data as $item) {
$recentActivity[] = [
'title' => $item['Name'] ?? 'Unknown Title',
'type' => $item['Type'] ?? 'Unknown',
'added_at' => $item['DateCreated'] ?? 'Unknown Date',
'year' => $item['ProductionYear'] ?? null
];
}
return $recentActivity;
}
} catch (Requests_Exception $e) {
$this->writeLog('error', 'Emby Recent Activity Error: ' . $e->getMessage(), 'SYSTEM');
}
return [];
}
/**
* Get Emby user avatar
*/
private function getEmbyUserAvatar($userId)
{
// Implement Emby avatar logic
return '/plugins/images/organizr/user-bg.png';
}
/**
* Get Jellyfin user avatar
*/
private function getJellyfinUserAvatar($userId)
{
// Implement Jellyfin avatar logic
return '/plugins/images/organizr/user-bg.png';
}
}