2018-07-11 00:35:10 +00:00
< ? php
/**
2018-07-25 03:00:13 +00:00
* @ package Joomla . Members . Manager
2018-07-11 00:35:10 +00:00
*
2018-12-27 10:38:37 +00:00
* @ created 6 th July , 2018
2018-07-11 00:35:10 +00:00
* @ author Llewellyn van der Merwe < https :// www . joomlacomponentbuilder . com />
2018-07-25 03:00:13 +00:00
* @ github Joomla Members Manager < https :// github . com / vdm - io / Joomla - Members - Manager >
2018-07-11 00:35:10 +00:00
* @ copyright Copyright ( C ) 2015. All Rights Reserved
* @ license GNU / GPL Version 2 or later - http :// www . gnu . org / licenses / gpl - 2.0 . html
*/
2019-08-14 02:14:40 +00:00
2018-07-11 00:35:10 +00:00
// No direct access to this file
defined ( '_JEXEC' ) or die ( 'Restricted access' );
/**
* Members Model
*/
class MembersmanagerModelMembers extends JModelList
{
public function __construct ( $config = array ())
{
if ( empty ( $config [ 'filter_fields' ]))
{
$config [ 'filter_fields' ] = array (
'a.id' , 'id' ,
'a.published' , 'published' ,
'a.ordering' , 'ordering' ,
'a.created_by' , 'created_by' ,
'a.modified_by' , 'modified_by' ,
2019-04-04 11:58:49 +00:00
'a.account' , 'account'
2018-07-11 00:35:10 +00:00
);
}
parent :: __construct ( $config );
2019-04-04 11:58:49 +00:00
}
/**
* Load all the users found in Joomla into membersmanager
*
* @ since 2.7 . 5
*
* @ return bool true on success
*/
public function importJoomlaUsers ()
{
if (( $types = $this -> getMemberTypes ()) !== false )
{
// get all already set users
$active_users = (( $users = MembersmanagerHelper :: getVars ( 'member' , 1 , 'published' , 'user' )) !== false ) ? $users : array ();
// set so defaults
$userBucket = array ();
$trigger = false ;
foreach ( $types as $type => $groups )
{
$this -> loadMembers ( $userBucket , $type , $groups , $active_users , $trigger );
// trigger message to run import again
if ( $trigger )
{
JFactory :: getApplication () -> enqueueMessage ( JText :: _ ( 'COM_MEMBERSMANAGER_ONLY_ONE_THOUSAND_MEMBERS_CAN_BE_IMPORTED_AT_A_TIME_SINCE_YOU_HAVE_MORE_THEN_ONE_THOUSAND_USERS_YOU_WILL_NEED_TO_RUN_THE_IMPORT_AGAIN_UNTIL_YOU_SEE_A_GREEN_SUCCESS_MESSAGE' ), 'warning' );
return false ;
}
}
// now insert the members in table
if ( $this -> insertMembers ( $userBucket , $active_users ) || ! $trigger )
{
return true ;
}
JFactory :: getApplication () -> enqueueMessage ( JText :: _ ( 'COM_MEMBERSMANAGER_NO_USERS_WERE_FOUND_THAT_MATCH_THE_TARGET_GROUPS_SET_IN_THE_MEMBER_TYPES' ), 'warning' );
return false ;
}
JFactory :: getApplication () -> enqueueMessage ( JText :: _ ( 'COM_MEMBERSMANAGER_NO_MEMBER_TYPES_ARE_SET_PLEASE_SET_SOME_AND_TRY_AGAIN' ), 'warning' );
return false ;
}
/**
* Gets an array of objects of types of members .
*
* @ return object [] An array of results .
*
*/
protected function getMemberTypes ()
{
// get types that allow relationships
$query = $this -> _db -> getQuery ( true );
$query -> select ( array ( 'a.id' , 'a.groups_target' ));
$query -> from ( '#__membersmanager_type AS a' );
$query -> where ( $this -> _db -> quoteName ( 'a.published' ) . ' >= 1' );
$this -> _db -> setQuery ( $query );
$this -> _db -> execute ();
// only continue if we have member types and all relationship types
if (( $types = $this -> _db -> loadAssocList ( 'id' , 'groups_target' )) !== false && MembersmanagerHelper :: checkArray ( $types ))
{
return $types ;
}
return false ;
2018-07-11 00:35:10 +00:00
}
2019-04-04 11:58:49 +00:00
/**
* Load members
*
* @ return void
*
*/
protected function loadMembers ( & $userBucket , & $type , & $groups , & $active_users , & $trigger )
{
if ( ! $trigger && MembersmanagerHelper :: checkJson ( $groups ))
{
$groups = ( array ) json_decode ( $groups , true );
if ( MembersmanagerHelper :: checkArray ( $groups ))
{
foreach ( $groups as $group_id )
{
if (( $users = JAccess :: getUsersByGroup ( $group_id )) !== false && MembersmanagerHelper :: checkArray ( $users ))
{
foreach ( $users as $user_id )
{
// make sure this user is not already set
if ( ! in_array ( $user_id , $active_users ))
{
if ( ! isset ( $userBucket [ $user_id ]))
{
$userBucket [ $user_id ] = array ( $type );
}
else
{
$userBucket [ $user_id ][] = $type ;
}
}
else
{
// we need to do something here (TODO)
}
// if at any time we hit the 1000 mark we must reset
if ( count ( $userBucket ) >= 1000 )
{
$trigger = true ;
return $this -> insertMembers ( $userBucket , $active_users );
}
}
}
}
}
}
}
/**
* Insert the members into the members table
*
* @ return void
*
*/
protected function insertMembers ( & $userBucket , $users )
{
// check if we found users
if ( MembersmanagerHelper :: checkArray ( $userBucket ))
{
// Get a db connection.
$db = JFactory :: getDbo ();
$todayDate = JFactory :: getDate () -> toSql ();
// Create a new query object.
$query = $db -> getQuery ( true );
// Insert columns.
$columns = array ( 'user' , 'token' , 'name' , 'username' , 'useremail' , 'account' , 'type' , 'created_by' , 'created' , 'published' , 'access' , 'version' );
// Prepare the insert query.
$query -> insert ( $db -> quoteName ( '#__membersmanager_member' )) -> columns ( $db -> quoteName ( $columns ));
// limiting counter
$limiter = 0 ;
foreach ( $userBucket as $user_id => $values )
{
// set the type
$type = new JRegistry ;
$type -> loadArray ( $values );
// get user
$member = JFactory :: getUser ( $user_id );
// build unique token
$token = MembersmanagerHelper :: safeString ( $member -> name , 'L' , '-' , false , false );
while ( ! MembersmanagerHelper :: checkUnique ( 0 , 'token' , $token , 'member' ))
{
$token = JString :: increment ( $token , 'dash' );
}
// build member
$values = array ();
$values [] = ( int ) $user_id ;
$values [] = $db -> quote ( $token );
$values [] = $db -> quote ( $member -> name );
$values [] = $db -> quote ( $member -> username );
$values [] = $db -> quote ( $member -> email );
$values [] = 1 ;
$values [] = $db -> quote (( string ) $type );
$values [] = ( int ) $user_id ;
$values [] = $db -> quote ( $todayDate );
$values [] = 1 ;
$values [] = 1 ;
$values [] = 1 ;
// load values
$query -> values ( implode ( ',' , $values ));
// clear memory
unset ( $userBucket [ $user_id ]);
$limiter ++ ;
// check if we have 100 rows, the insert and start new
if ( $limiter >= 100 )
{
// reset counter
$limiter = 0 ;
// run query
$db -> setQuery ( $query );
$db -> execute ();
// reset query
$query = $db -> getQuery ( true );
// Prepare the new insert query.
$query -> insert ( $db -> quoteName ( '#__membersmanager_member' )) -> columns ( $db -> quoteName ( $columns ));
}
// make sure to update the user array that are active
$users [] = $user_id ;
}
// reset the bucket
$userBucket = array ();
// only run if queries remain
if ( $limiter > 0 )
{
$db -> setQuery ( $query );
$db -> execute ();
}
return true ;
}
return false ;
}
2018-07-11 00:35:10 +00:00
/**
* Method to auto - populate the model state .
*
* @ return void
*/
protected function populateState ( $ordering = null , $direction = null )
{
$app = JFactory :: getApplication ();
// Adjust the context to support modal layouts.
if ( $layout = $app -> input -> get ( 'layout' ))
{
$this -> context .= '.' . $layout ;
}
$account = $this -> getUserStateFromRequest ( $this -> context . '.filter.account' , 'filter_account' );
2019-04-04 11:58:49 +00:00
$this -> setState ( 'filter.account' , $account );
2018-07-11 00:35:10 +00:00
$sorting = $this -> getUserStateFromRequest ( $this -> context . '.filter.sorting' , 'filter_sorting' , 0 , 'int' );
$this -> setState ( 'filter.sorting' , $sorting );
$access = $this -> getUserStateFromRequest ( $this -> context . '.filter.access' , 'filter_access' , 0 , 'int' );
$this -> setState ( 'filter.access' , $access );
$search = $this -> getUserStateFromRequest ( $this -> context . '.filter.search' , 'filter_search' );
$this -> setState ( 'filter.search' , $search );
$published = $this -> getUserStateFromRequest ( $this -> context . '.filter.published' , 'filter_published' , '' );
$this -> setState ( 'filter.published' , $published );
$created_by = $this -> getUserStateFromRequest ( $this -> context . '.filter.created_by' , 'filter_created_by' , '' );
$this -> setState ( 'filter.created_by' , $created_by );
$created = $this -> getUserStateFromRequest ( $this -> context . '.filter.created' , 'filter_created' );
$this -> setState ( 'filter.created' , $created );
// List state information.
parent :: populateState ( $ordering , $direction );
}
/**
* Method to get an array of data items .
*
* @ return mixed An array of data items on success , false on failure .
*/
public function getItems ()
2018-09-19 12:29:53 +00:00
{
2018-07-11 00:35:10 +00:00
// check in items
$this -> checkInNow ();
// load parent items
$items = parent :: getItems ();
// set values to display correctly.
if ( MembersmanagerHelper :: checkArray ( $items ))
{
foreach ( $items as $nr => & $item )
{
$access = ( JFactory :: getUser () -> authorise ( 'member.access' , 'com_membersmanager.member.' . ( int ) $item -> id ) && JFactory :: getUser () -> authorise ( 'member.access' , 'com_membersmanager' ));
if ( ! $access )
{
unset ( $items [ $nr ]);
continue ;
}
2018-09-19 12:29:53 +00:00
// if linked to user get active name
if ( $item -> user > 0 && isset ( $item -> user_name ))
2018-07-25 03:00:13 +00:00
{
2018-09-19 12:29:53 +00:00
$item -> name = $item -> user_name ;
2018-07-25 03:00:13 +00:00
}
2018-09-19 12:29:53 +00:00
// always add surname
$item -> name = $item -> name . ' ' . $item -> surname ;
// if linked to user get active name
if ( $item -> user > 0 )
2018-07-25 03:00:13 +00:00
{
2018-09-19 12:29:53 +00:00
$item -> email = JFactory :: getUser ( $item -> user ) -> email ;
2018-07-25 03:00:13 +00:00
}
2018-12-27 10:38:37 +00:00
// convert type
$item -> type = MembersmanagerHelper :: jsonToString ( $item -> type , ', ' , 'type' , 'id' , 'name' );
2018-07-11 00:35:10 +00:00
}
}
// set account value for later
if ( MembersmanagerHelper :: checkArray ( $items ))
{
foreach ( $items as $nr => & $item )
{
// keep account type value
$item -> account_id = $item -> account ;
}
2018-09-19 12:29:53 +00:00
}
2018-07-11 00:35:10 +00:00
// set selection value to a translatable value
if ( MembersmanagerHelper :: checkArray ( $items ))
{
foreach ( $items as $nr => & $item )
{
// convert account
$item -> account = $this -> selectionTranslation ( $item -> account , 'account' );
}
}
2018-09-19 12:29:53 +00:00
2018-07-11 00:35:10 +00:00
// return items
return $items ;
}
/**
* Method to convert selection values to translatable string .
*
* @ return translatable string
*/
public function selectionTranslation ( $value , $name )
{
// Array of account language strings
if ( $name === 'account' )
{
$accountArray = array (
2018-07-25 03:00:13 +00:00
1 => 'COM_MEMBERSMANAGER_MEMBER_MAIN_LOGIN' ,
2 => 'COM_MEMBERSMANAGER_MEMBER_MAIN' ,
3 => 'COM_MEMBERSMANAGER_MEMBER_SUB' ,
4 => 'COM_MEMBERSMANAGER_MEMBER_SUB_LOGIN'
2018-07-11 00:35:10 +00:00
);
// Now check if value is found in this array
if ( isset ( $accountArray [ $value ]) && MembersmanagerHelper :: checkString ( $accountArray [ $value ]))
{
return $accountArray [ $value ];
}
}
return $value ;
}
/**
* Method to build an SQL query to load the list data .
*
* @ return string An SQL query
*/
protected function getListQuery ()
{
// Get the user object.
$user = JFactory :: getUser ();
// Create a new query object.
$db = JFactory :: getDBO ();
$query = $db -> getQuery ( true );
// Select some fields
$query -> select ( 'a.*' );
// From the membersmanager_item table
$query -> from ( $db -> quoteName ( '#__membersmanager_member' , 'a' ));
// From the users table.
$query -> select ( $db -> quoteName ( 'g.name' , 'user_name' ));
$query -> join ( 'LEFT' , $db -> quoteName ( '#__users' , 'g' ) . ' ON (' . $db -> quoteName ( 'a.user' ) . ' = ' . $db -> quoteName ( 'g.id' ) . ')' );
// From the membersmanager_member table.
2018-09-19 12:29:53 +00:00
$query -> select ( $db -> quoteName ( 'h.user' , 'main_member_user' ));
$query -> join ( 'LEFT' , $db -> quoteName ( '#__membersmanager_member' , 'h' ) . ' ON (' . $db -> quoteName ( 'a.main_member' ) . ' = ' . $db -> quoteName ( 'h.id' ) . ')' );
// From the membersmanager_type table.
$query -> select ( $db -> quoteName ( 'i.name' , 'type_name' ));
$query -> join ( 'LEFT' , $db -> quoteName ( '#__membersmanager_type' , 'i' ) . ' ON (' . $db -> quoteName ( 'a.type' ) . ' = ' . $db -> quoteName ( 'i.id' ) . ')' );
2018-07-11 00:35:10 +00:00
// Filter by published state
$published = $this -> getState ( 'filter.published' );
if ( is_numeric ( $published ))
{
$query -> where ( 'a.published = ' . ( int ) $published );
}
elseif ( $published === '' )
{
$query -> where ( '(a.published = 0 OR a.published = 1)' );
}
// Join over the asset groups.
$query -> select ( 'ag.title AS access_level' );
$query -> join ( 'LEFT' , '#__viewlevels AS ag ON ag.id = a.access' );
// Filter by access level.
if ( $access = $this -> getState ( 'filter.access' ))
{
$query -> where ( 'a.access = ' . ( int ) $access );
}
// Implement View Level Access
if ( ! $user -> authorise ( 'core.options' , 'com_membersmanager' ))
{
$groups = implode ( ',' , $user -> getAuthorisedViewLevels ());
$query -> where ( 'a.access IN (' . $groups . ')' );
}
// Filter by search.
$search = $this -> getState ( 'filter.search' );
if ( ! empty ( $search ))
{
if ( stripos ( $search , 'id:' ) === 0 )
{
$query -> where ( 'a.id = ' . ( int ) substr ( $search , 3 ));
}
else
{
$search = $db -> quote ( '%' . $db -> escape ( $search ) . '%' );
2018-12-27 10:38:37 +00:00
$query -> where ( '(a.name LIKE ' . $search . ' OR a.email LIKE ' . $search . ' OR a.account LIKE ' . $search . ' OR a.user LIKE ' . $search . ' OR a.token LIKE ' . $search . ' OR a.main_member LIKE ' . $search . ' OR a.useremail LIKE ' . $search . ' OR a.username LIKE ' . $search . ' OR a.surname LIKE ' . $search . ')' );
2018-07-11 00:35:10 +00:00
}
}
// Filter by Account.
if ( $account = $this -> getState ( 'filter.account' ))
{
$query -> where ( 'a.account = ' . $db -> quote ( $db -> escape ( $account )));
}
// Add the list ordering clause.
$orderCol = $this -> state -> get ( 'list.ordering' , 'a.id' );
$orderDirn = $this -> state -> get ( 'list.direction' , 'asc' );
if ( $orderCol != '' )
{
$query -> order ( $db -> escape ( $orderCol . ' ' . $orderDirn ));
}
return $query ;
}
/**
* Method to get list export data .
*
* @ return mixed An array of data items on success , false on failure .
*/
public function getExportData ( $pks )
{
// setup the query
if ( MembersmanagerHelper :: checkArray ( $pks ))
{
// Set a value to know this is exporting method.
$_export = true ;
// Get the user object.
$user = JFactory :: getUser ();
// Create a new query object.
$db = JFactory :: getDBO ();
$query = $db -> getQuery ( true );
// Select some fields
$query -> select ( 'a.*' );
// From the membersmanager_member table
$query -> from ( $db -> quoteName ( '#__membersmanager_member' , 'a' ));
$query -> where ( 'a.id IN (' . implode ( ',' , $pks ) . ')' );
// Implement View Level Access
if ( ! $user -> authorise ( 'core.options' , 'com_membersmanager' ))
{
$groups = implode ( ',' , $user -> getAuthorisedViewLevels ());
$query -> where ( 'a.access IN (' . $groups . ')' );
}
// Order the results by ordering
$query -> order ( 'a.ordering ASC' );
// Load the items
$db -> setQuery ( $query );
$db -> execute ();
if ( $db -> getNumRows ())
{
$items = $db -> loadObjectList ();
// Get the medium encryption key.
$mediumkey = MembersmanagerHelper :: getCryptKey ( 'medium' );
// Get the encryption object.
$medium = new FOFEncryptAes ( $mediumkey );
// set values to display correctly.
if ( MembersmanagerHelper :: checkArray ( $items ))
{
foreach ( $items as $nr => & $item )
{
$access = ( JFactory :: getUser () -> authorise ( 'member.access' , 'com_membersmanager.member.' . ( int ) $item -> id ) && JFactory :: getUser () -> authorise ( 'member.access' , 'com_membersmanager' ));
if ( ! $access )
{
unset ( $items [ $nr ]);
continue ;
}
2018-09-19 12:29:53 +00:00
// if linked to user get active name
if ( $item -> user > 0 && isset ( $item -> user_name ))
2018-07-25 03:00:13 +00:00
{
2018-09-19 12:29:53 +00:00
$item -> name = $item -> user_name ;
2018-07-25 03:00:13 +00:00
}
2018-09-19 12:29:53 +00:00
// always add surname
$item -> name = $item -> name . ' ' . $item -> surname ;
// if linked to user get active name
if ( $item -> user > 0 )
2018-07-25 03:00:13 +00:00
{
2018-09-19 12:29:53 +00:00
$item -> email = JFactory :: getUser ( $item -> user ) -> email ;
2018-07-25 03:00:13 +00:00
}
2018-07-11 00:35:10 +00:00
if ( $mediumkey && ! is_numeric ( $item -> profile_image ) && $item -> profile_image === base64_encode ( base64_decode ( $item -> profile_image , true )))
{
// decrypt profile_image
$item -> profile_image = $medium -> decryptString ( $item -> profile_image );
}
// unset the values we don't want exported.
unset ( $item -> asset_id );
unset ( $item -> checked_out );
unset ( $item -> checked_out_time );
}
}
// Add headers to items array.
$headers = $this -> getExImPortHeaders ();
if ( MembersmanagerHelper :: checkObject ( $headers ))
{
array_unshift ( $items , $headers );
}
// set account value for later
if ( MembersmanagerHelper :: checkArray ( $items ))
{
foreach ( $items as $nr => & $item )
{
// keep account type value
$item -> account_id = $item -> account ;
}
}
return $items ;
}
}
return false ;
}
/**
* Method to get header .
*
* @ return mixed An array of data items on success , false on failure .
*/
public function getExImPortHeaders ()
{
// Get a db connection.
$db = JFactory :: getDbo ();
// get the columns
$columns = $db -> getTableColumns ( " #__membersmanager_member " );
if ( MembersmanagerHelper :: checkArray ( $columns ))
{
// remove the headers you don't import/export.
unset ( $columns [ 'asset_id' ]);
unset ( $columns [ 'checked_out' ]);
unset ( $columns [ 'checked_out_time' ]);
$headers = new stdClass ();
foreach ( $columns as $column => $type )
{
$headers -> { $column } = $column ;
}
return $headers ;
}
return false ;
2018-09-19 12:29:53 +00:00
}
2018-07-11 00:35:10 +00:00
/**
* Method to get a store id based on model configuration state .
*
* @ return string A store id .
*
*/
protected function getStoreId ( $id = '' )
{
// Compile the store id.
$id .= ':' . $this -> getState ( 'filter.id' );
$id .= ':' . $this -> getState ( 'filter.search' );
$id .= ':' . $this -> getState ( 'filter.published' );
$id .= ':' . $this -> getState ( 'filter.ordering' );
$id .= ':' . $this -> getState ( 'filter.created_by' );
$id .= ':' . $this -> getState ( 'filter.modified_by' );
2019-04-04 11:58:49 +00:00
$id .= ':' . $this -> getState ( 'filter.account' );
2018-07-11 00:35:10 +00:00
return parent :: getStoreId ( $id );
}
/**
* Build an SQL query to checkin all items left checked out longer then a set time .
*
* @ return a bool
*
*/
protected function checkInNow ()
{
// Get set check in time
$time = JComponentHelper :: getParams ( 'com_membersmanager' ) -> get ( 'check_in' );
if ( $time )
{
// Get a db connection.
$db = JFactory :: getDbo ();
// reset query
$query = $db -> getQuery ( true );
$query -> select ( '*' );
$query -> from ( $db -> quoteName ( '#__membersmanager_member' ));
$db -> setQuery ( $query );
$db -> execute ();
if ( $db -> getNumRows ())
{
// Get Yesterdays date
$date = JFactory :: getDate () -> modify ( $time ) -> toSql ();
// reset query
$query = $db -> getQuery ( true );
// Fields to update.
$fields = array (
$db -> quoteName ( 'checked_out_time' ) . '=\'0000-00-00 00:00:00\'' ,
$db -> quoteName ( 'checked_out' ) . '=0'
);
// Conditions for which records should be updated.
$conditions = array (
$db -> quoteName ( 'checked_out' ) . '!=0' ,
$db -> quoteName ( 'checked_out_time' ) . '<\'' . $date . '\''
);
// Check table
$query -> update ( $db -> quoteName ( '#__membersmanager_member' )) -> set ( $fields ) -> where ( $conditions );
$db -> setQuery ( $query );
$db -> execute ();
}
}
return false ;
}
}