263 lines
8.1 KiB
PHP
263 lines
8.1 KiB
PHP
<?php
|
|
/**
|
|
* @file api.php Provides global methods to retrieve active users from the sessions table
|
|
*~TERABYTE_DOC_READY~
|
|
* $Copyright: (c) 2001 - 2011 Invision Power Services, Inc.$
|
|
* $License: This is NULLED!
|
|
* $Author: ips_terabyte $
|
|
* @since Friday 12th November 2010 16:58
|
|
* $LastChangedDate: 2011-08-26 11:38:16 -0400 (Fri, 26 Aug 2011) $
|
|
* @version v3.2.3
|
|
* $Revision: 9420 $
|
|
*/
|
|
|
|
/**
|
|
*
|
|
* @class session_api
|
|
* @brief Provides global methods to retrieve active users from the sessions table
|
|
*
|
|
*/
|
|
class session_api
|
|
{
|
|
/**
|
|
* Registry Object Shortcuts
|
|
*
|
|
* @var $registry
|
|
* @var $DB
|
|
* @var $settings
|
|
* @var $request
|
|
* @var $lang
|
|
* @var $member
|
|
* @var $memberData
|
|
* @var $cache
|
|
* @var $caches
|
|
*/
|
|
protected $registry;
|
|
protected $DB;
|
|
protected $settings;
|
|
protected $request;
|
|
protected $lang;
|
|
protected $member;
|
|
protected $memberData;
|
|
protected $cache;
|
|
protected $caches;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param object $registry Registry object
|
|
* @return @e void
|
|
*/
|
|
public function __construct( ipsRegistry $registry )
|
|
{
|
|
/* Make object */
|
|
$this->registry = $registry;
|
|
$this->DB = $this->registry->DB();
|
|
$this->settings =& $this->registry->fetchSettings();
|
|
$this->request =& $this->registry->fetchRequest();
|
|
$this->lang = $this->registry->getClass('class_localization');
|
|
$this->member = $this->registry->member();
|
|
$this->memberData =& $this->registry->member()->fetchMemberData();
|
|
$this->cache = $this->registry->cache();
|
|
$this->caches =& $this->registry->cache()->fetchCaches();
|
|
}
|
|
|
|
/**
|
|
* Returns a list (with buildProfilePhoto set) of users in an application
|
|
*
|
|
* @param string $app Application folder/key
|
|
* @param array $options Array of options to add/override checks for the query
|
|
* @return @e array Array of found sessions (members, guests, bots, anons)
|
|
*
|
|
* <b>Filters:</b>
|
|
* - cutoff: Specify a different cutoff time rather than using the default setting
|
|
* - addJoins: Add more joins for the query
|
|
* - addWhere: Add more checks for the 'where' part of the query (everything is joined with ' AND ')
|
|
* - overrideWhere: Specify manually the 'where' part of the query, the query must be already compiled
|
|
*
|
|
* <b>Example Usage:</b>
|
|
* @code
|
|
* $onlineUsers = $this->getUsersIn( 'forums', array( 'cutoff' => 90 ) );
|
|
* $onlineUsers = $this->getUsersIn( 'forums', array( 'cutoff' => 90, 'addJoins' => array( ... ), 'addWhere' => array( ... ) ) );
|
|
* $onlineUsers = $this->getUsersIn( 'forums', array( 'overrideWhere' => "s.current_appcomponent='forums' AND (s.running_time > TIME_A OR s.running_time < TIME_B)" ) );
|
|
* @endcode
|
|
*/
|
|
public function getUsersIn( $app, $options=array() )
|
|
{
|
|
/* Init vars and check options */
|
|
$return = array( 'stats' => array( 'total' => 0,
|
|
'members' => 0,
|
|
'guests' => 0,
|
|
'bots' => 0,
|
|
'anon' => 0 ),
|
|
'rows' => array( 'members' => array(),
|
|
'bots' => array(),
|
|
'guests' => array(),
|
|
'anon' => array() ),
|
|
'names' => array()
|
|
);
|
|
|
|
$cutoff = empty($options['cutoff']) ? $this->settings['au_cutoff'] : $options['cutoff'];
|
|
$limit = time() - ( $cutoff * 60 );
|
|
$rows = array();
|
|
$NOWJIM = IPS_UNIX_TIME_NOW;
|
|
$cached = array();
|
|
|
|
/* Sort joins */
|
|
$_joins = array( array( 'select' => 'm.*',
|
|
'from' => array( 'members' => 'm' ),
|
|
'where' => 'm.member_id=s.member_id',
|
|
'type' => 'left' ) );
|
|
|
|
if ( isset($options['addJoins']) && is_array($options['addJoins']) && count($options['addJoins']) )
|
|
{
|
|
$where = array_merge( $_joins, $options['addJoins'] );
|
|
}
|
|
|
|
/* Sort where.. override? */
|
|
if ( !empty($options['overrideWhere']) && is_string($options['overrideWhere']) )
|
|
{
|
|
$where = $options['overrideWhere'];
|
|
}
|
|
else
|
|
{
|
|
/* Normal where */
|
|
$where = array( "s.current_appcomponent='" . $app . "'", "s.running_time > " . $limit );
|
|
|
|
if ( isset($options['addWhere']) && is_array($options['addWhere']) && count($options['addWhere']) )
|
|
{
|
|
$where = array_merge( $where, $options['addWhere'] );
|
|
}
|
|
|
|
$where = implode( ' AND ', $where );
|
|
}
|
|
|
|
/* We're a member too? */
|
|
if ( $this->memberData['member_id'] )
|
|
{
|
|
$rows[ $NOWJIM . '.' . $this->memberData['member_id'] ] = array_merge( $this->memberData,
|
|
array( 'id' => $this->member->session_id,
|
|
'login_type' => substr($this->memberData['login_anonymous'],0, 1),
|
|
'running_time' => $NOWJIM,
|
|
'member_name' => $this->memberData['members_display_name'],
|
|
'member_group' => $this->memberData['member_group_id'],
|
|
'seo_name' => $this->memberData['members_seo_name'] )
|
|
);
|
|
}
|
|
|
|
/* Dee bee */
|
|
$this->DB->build( array( 'select' => 's.*, s.id as row_session_id',
|
|
'from' => array( 'sessions' => 's' ),
|
|
'where' => $where,
|
|
'add_join' => $_joins ) );
|
|
$this->DB->execute();
|
|
|
|
while( $session = $this->DB->fetch() )
|
|
{
|
|
if ( ! empty( $session['member_id'] ) AND $session['member_id'] == $this->memberData['member_id'] )
|
|
{
|
|
continue;
|
|
}
|
|
|
|
$session['id'] = $session['row_session_id'];
|
|
|
|
$rows[ $session['running_time'] . '.' . $session['id'] ] = $session;
|
|
}
|
|
|
|
/* No rows? */
|
|
if ( ! count( $rows ) )
|
|
{
|
|
return $return;
|
|
}
|
|
|
|
krsort( $rows );
|
|
|
|
/* Process them */
|
|
$filename = IPSLib::getAppDir( $app ) . '/extensions/coreExtensions.php';
|
|
|
|
if ( is_file( $filename ) )
|
|
{
|
|
$classToLoad = IPSLib::loadLibrary( $filename, 'publicSessions__' . $app, $app );
|
|
$loader = new $classToLoad();
|
|
|
|
if ( method_exists( $loader, 'parseOnlineEntries' ) )
|
|
{
|
|
$rows = $loader->parseOnlineEntries( $rows );
|
|
}
|
|
}
|
|
|
|
/* No rows? */
|
|
if ( ! count( $rows ) )
|
|
{
|
|
return $return;
|
|
}
|
|
|
|
/* Sort through */
|
|
foreach( $rows as $id => $result )
|
|
{
|
|
$last_date = $this->registry->getClass('class_localization')->getTime( $result['running_time'] );
|
|
|
|
/* ROBOT - or DODOT! */
|
|
if ( strstr( $result['id'], '_session' ) )
|
|
{
|
|
$botname = preg_replace( '/^(.+?)=/', "\\1", $result['id'] );
|
|
|
|
if ( ! $cached[ $result['member_name'] ] )
|
|
{
|
|
$result = IPSMember::buildProfilePhoto( $result );
|
|
$result['parsedMemberName'] = $result['member_name'];
|
|
$return['rows']['bots'][ $result['id'] ] = $result;
|
|
$return['names'][ $result['id'] ] = $result['parsedMemberName'];
|
|
|
|
$cached[ $result['member_name'] ] = 1;
|
|
}
|
|
|
|
$return['stats']['bots']++;
|
|
}
|
|
/* Guest */
|
|
else if ( ! $result['member_id'] )
|
|
{
|
|
$result = IPSMember::buildProfilePhoto( 0 );
|
|
$result['parsedMemberName'] = $this->lang->words['global_guestname'];
|
|
$return['rows']['guests'][ $result['id'] ] = $result;
|
|
|
|
$return['stats']['guests']++;
|
|
}
|
|
/* Member */
|
|
else
|
|
{
|
|
if ( empty( $cached[ $result['member_id'] ] ) )
|
|
{
|
|
$cached[ $result['member_id'] ] = 1;
|
|
|
|
$result = IPSMember::buildProfilePhoto( $result );
|
|
$result['parsedMemberName'] = IPSMember::makeNameFormatted( $result['member_name'], $result['member_group'] );
|
|
|
|
if ( $result['login_type'] )
|
|
{
|
|
if ( $this->memberData['g_access_cp'] )
|
|
{
|
|
$result['parsedMemberName'] = IPSMember::makeProfileLink( $result['parsedMemberName'], $result['member_id'], $result['seo_name'] );
|
|
$return['rows']['anon'][ $result['id'] ] = $result;
|
|
$return['names'][ $result['id'] ] = $result['parsedMemberName'];
|
|
}
|
|
|
|
$return['stats']['anon']++;
|
|
}
|
|
else
|
|
{
|
|
$result['parsedMemberName'] = IPSMember::makeProfileLink( $result['parsedMemberName'], $result['member_id'], $result['seo_name'] );
|
|
$return['rows']['members'][ $result['id'] ] = $result;
|
|
$return['names'][ $result['id'] ] = $result['parsedMemberName'];
|
|
|
|
$return['stats']['members']++;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
$return['stats']['total'] = intval( $return['stats']['bots'] ) + intval( $return['stats']['guests'] ) + intval( $return['stats']['anon'] ) + intval( $return['stats']['members'] );
|
|
|
|
return $return;
|
|
}
|
|
} |