<?php
/**
* @brief Profile Step Model
* @author <a href='https://www.invisioncommunity.com'>Invision Power Services, Inc.</a>
* @copyright (c) Invision Power Services, Inc.
* @license https://www.invisioncommunity.com/legal/standards/
* @package Invision Community
* @since 10 Mar 2017
*/
namespace IPS\Member;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
{
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
exit;
}
/**
* Profile Step Model
*/
class _ProfileStep extends \IPS\Node\Model
{
/**
* @brief [ActiveRecord] Multiton Store
*/
protected static $multitons;
/**
* @brief [ActiveRecord] Multiton Map
*/
protected static $multitonMap = array();
/**
* @brief [ActiveRecord] Database Table
*/
public static $databaseTable = 'core_profile_steps';
/**
* @brief [ActiveRecord] ID Database Column
*/
public static $databaseColumnId = 'id';
/**
* @brief [ActiveRecord] Database Prefix
*/
public static $databasePrefix = 'step_';
/**
* @brief [Node] Node Title
*/
public static $nodeTitle = 'profile_completion';
/**
* @brief [Node] Sortable
*/
public static $nodeSortable = TRUE;
/**
* @brief [Node] Positon Column
*/
public static $databaseColumnOrder = 'position';
/**
* @brief [Node] Title prefix. If specified, will look for a language key with "{$key}_title" as the key
*/
public static $titleLangPrefix = 'profile_step_title_';
/**
* Load Record
*
* @see \IPS\Db::build
* @param int|string $id ID
* @param string $idField The database column that the $id parameter pertains to (NULL will use static::$databaseColumnId)
* @param mixed $extraWhereClause Additional where clause(s) (see \IPS\Db::build for details) - if used will cause multiton store to be skipped and a query always ran
* @return static
* @throws \InvalidArgumentException
* @throws \OutOfRangeException
*/
public static function load( $id, $idField=NULL, $extraWhereClause=NULL )
{
if ( $idField === NULL AND $extraWhereClause === NULL )
{
$steps = static::getStore();
if ( isset( $steps[ $id ] ) )
{
return static::constructFromData( $steps[ $id ] );
}
else
{
throw new \OutOfRangeException;
}
}
else
{
return parent::load( $id, $idField, $extraWhereClause );
}
}
/**
* [Node] Return the custom badge for each row
*
* @return NULL|array Null for no badge, or an array of badge data (0 => CSS class type, 1 => language string, 2 => optional raw HTML to show instead of language string)
*/
protected function get__badge()
{
if( $this->required )
{
return array( 0 => 'positive ipsPos_right', 1 => 'required' );
}
return parent::get__badge();
}
/**
* Get data store
*
* @return array
* @note Note that all records are returned, even disabled promotion rules. Enable status needs to be checked in userland code when appropriate.
*/
public static function getStore()
{
if ( !isset( \IPS\Data\Store::i()->profileSteps ) )
{
\IPS\Data\Store::i()->profileSteps = iterator_to_array( \IPS\Db::i()->select( '*', 'core_profile_steps', NULL, "step_position ASC" )->setKeyField( 'step_id' ) );
}
return \IPS\Data\Store::i()->profileSteps;
}
/**
* Fetch All Root Nodes
*
* @param string|NULL $permissionCheck The permission key to check for or NULl to not check permissions
* @param \IPS\Member|NULL $member The member to check permissions for or NULL for the currently logged in member
* @param mixed $where Additional WHERE clause
* @return array
*/
public static function roots( $permissionCheck='view', $member=NULL, $where=array() )
{
if ( !count( $where ) )
{
$return = array();
foreach( static::getStore() AS $node )
{
$return[ $node['step_id'] ] = static::constructFromData( $node );
}
return $return;
}
else
{
return parent::roots( $permissionCheck, $member, $where );
}
}
/**
* Save Changed Columns
*
* @return void
*/
public function save()
{
parent::save();
unset( \IPS\Data\Store::i()->profileSteps );
}
/**
* [ActiveRecord] Delete Record
*
* @return void
*/
public function delete()
{
if ( method_exists( $this->extension, 'onDelete' ) )
{
$this->extension->onDelete( $this );
}
\IPS\Lang::deleteCustom( 'core', 'profile_step_title_' . $this->id );
\IPS\Lang::deleteCustom( 'core', 'profile_step_text_' . $this->id );
parent::delete();
unset( \IPS\Data\Store::i()->profileSteps );
}
/**
* Get the "subcompletion_act" field
*
* @return array
*/
public function get_subcompletion_act()
{
$return = ! empty( $this->_data['subcompletion_act'] ) ? json_decode( $this->_data['subcompletion_act'], TRUE ) : array();
if ( ! is_array( $return ) and ! empty( $this->_data['subcompletion_act'] ) )
{
$return = array( $this->_data['subcompletion_act'] );
}
return $return;
}
/**
* Set the "subcompletion_act" field
*
* @param string|array $value
* @return void
*/
public function set_subcompletion_act( $value )
{
$this->_data['subcompletion_act'] = ( is_array( $value ) ? json_encode( $value ) : $value );
}
/**
* Used sub actions by other items
*
* @return array array( 'key1', 'key2', 'key3' )
*/
public function usedSubActions()
{
$return = array();
foreach( static::loadAll() as $id => $object )
{
if ( $object->id !== $this->id and count( $object->subcompletion_act ) )
{
foreach( $object->subcompletion_act as $item )
{
$return[ $object->completion_act ][] = $item;
}
}
}
return $return;
}
/**
* Return the next step
*
* @return int
*/
public function getNextStep()
{
$nextOneIsIt = false;
$steps = array();
foreach( \IPS\Application::allExtensions( 'core', 'ProfileSteps' ) AS $extension )
{
if ( method_exists( $extension, 'wizard') AND count( $extension::wizard() ) )
{
$steps = array_merge( $steps, $extension::wizard() );
}
}
$steps = static::setOrder( $steps );
foreach( $steps as $key => $object )
{
if ( $nextOneIsIt )
{
return $key;
}
if ( $key === $this->key )
{
$nextOneIsIt = true;
}
}
/* Still here? */
return 'profile_done';
}
/**
* Load All Steps
*
* @return array
*/
public static function loadAll()
{
$return = array();
foreach( static::getStore() AS $id => $data )
{
$return[ $id ] = static::constructFromData( $data );
}
return $return;
}
/**
* @brief Actions Cache
*/
protected static $_actions = NULL;
/**
* @brief Sub actions cache
*/
protected static $_subActions = NULL;
/**
* Available parent actions to complete steps
*
* @return array array( 'key' => 'lang_string' )
*/
public static function actions()
{
if ( static::$_actions === NULL )
{
static::$_actions = array();
foreach( \IPS\Application::allExtensions( 'core', 'ProfileSteps' ) AS $key => $extension )
{
foreach( $extension::actions() AS $action => $lang )
{
static::$_actions[ $action ] = $lang;
}
}
}
return static::$_actions;
}
/**
* Available sub actions to complete steps
*
* @return array array( 'key' => 'lang_string' )
*/
public static function subActions()
{
if ( static::$_subActions === NULL )
{
static::$_subActions = array();
foreach( \IPS\Application::allExtensions( 'core', 'ProfileSteps' ) AS $key => $extension )
{
if ( method_exists( $extension, 'subActions' ) )
{
foreach( $extension::subActions() AS $parent => $row )
{
foreach( $row as $action => $lang )
{
static::$_subActions[ $parent ][ $action ] = $lang;
}
}
}
}
}
return static::$_subActions;
}
/**
* Can the actions have multiple choices?
*
* @param string $action Action key (basic_profile, etc)
* @return boolean
*/
public static function actionMultipleChoice( $action )
{
foreach( \IPS\Application::allExtensions( 'core', 'ProfileSteps' ) AS $key => $extension )
{
if ( method_exists( $extension, 'actionMultipleChoice' ) )
{
foreach( $extension::actions() AS $extensionAction => $lang )
{
if ( $action == $extensionAction )
{
return $extension::actionMultipleChoice( $action );
}
}
}
}
return FALSE;
}
/**
* Can be set as required?
*
* @return array
* @note This is intended for items which have their own independent settings and dedicated enable pages, such as MFA and Social Login integration
*/
public static function canBeRequired()
{
$return = array();
foreach( \IPS\Application::allExtensions( 'core', 'ProfileSteps' ) AS $key => $extension )
{
foreach( $extension::canBeRequired() AS $action )
{
$return[] = $action;
}
}
return $return;
}
/**
* Get the wizard step key
*
* @return string
*/
public function get_key()
{
return "profile_step_title_" . $this->id;
}
/**
* Get automated step title in the ACP
* @note It needs to fetch the parsed langauge so it does not end up storing the word hashes on save.
*
* @return string
*/
public function get_acpTitle()
{
if ( empty( $this->subcompletion_act ) )
{
return \IPS\Member::loggedIn()->language()->get( 'complete_profile_' . $this->completion_act );
}
$extension = $this->extension;
$subActions = $extension::subActions()[ $this->completion_act ];
$lang = array();
foreach( $this->subcompletion_act as $item )
{
if ( isset( $subActions[ $item ] ) )
{
$lang[] = \IPS\Member::loggedIn()->language()->addToStack( $subActions[ $item ] );
}
}
if ( count( $lang ) )
{
$result = \IPS\Member::loggedIn()->language()->get( 'complete_profile_' . $this->completion_act ) . ' (' . \IPS\Member::loggedIn()->language()->formatList( $lang ) . ')';
\IPS\Member::loggedIn()->language()->parseOutputForDisplay( $result );
return $result;
}
else
{
return \IPS\Member::loggedIn()->language()->get( 'complete_profile_' . $this->completion_act );
}
}
/**
* Get Extension
*
* @return mixed
*/
public function get_extension()
{
list( $app, $extension ) = explode( '_', $this->_data['extension'] );
$class = "\\IPS\\{$app}\\extensions\\core\\ProfileSteps\\{$extension}";
return new $class;
}
/**
* Has a specific step been completed?
*
* @param \IPS\Member|NULL The member to check, or NULL for currently logged in
* @return bool
*/
public function completed( \IPS\Member $member = NULL )
{
$member = $member ?: \IPS\Member::loggedIn();
return $this->extension->completed( $this, $member );
}
/**
* @brief Can add cache
*/
protected static $canAdd = NULL;
/**
* Can add new steps
*
* @return param
*/
public function canAdd()
{
if ( static::$canAdd === NULL )
{
$actions = static::actions();
$subActions = static::subActions();
$usedSubActions = $this->usedSubActions();
foreach( $actions as $key => $lang )
{
if ( isset( $subActions[ $key ] ) )
{
if ( isset( $usedSubActions[ $key ] ) )
{
if ( \count( $usedSubActions[ $key ] ) == \count( $subActions[ $key ] ) )
{
/* Nothing left to select, so skip this */
unset( $actions[ $key ] );
continue;
}
}
}
}
static::$canAdd = \count( $actions );
}
return static::$canAdd;
}
/**
* Form
*
* @param \IPS\Helpers\Form Form
* @return void
*/
public function form( &$form )
{
$form->add( new \IPS\Helpers\Form\Translatable( 'profile_step_title', NULL, FALSE, array( 'app' => 'core', 'key' => ( $this->id ) ? "profile_step_title_{$this->id}" : NULL ) ) );
$form->add( new \IPS\Helpers\Form\Translatable( 'profile_step_text', NULL, FALSE, array( 'app' => 'core', 'key' => ( $this->id ) ? "profile_step_text_{$this->id}" : NULL ) ) );
$actions = static::actions();
$subActions = static::subActions();
$toggles = array();
$subActionFormElements = array();
$usedSubActions = $this->usedSubActions();
foreach( $actions as $key => $lang )
{
if ( isset( $subActions[ $key ] ) )
{
$disabled = NULL;
if ( isset( $usedSubActions[ $key ] ) )
{
if ( \count( $usedSubActions[ $key ] ) >= \count( $subActions[ $key ] ) )
{
/* Nothing left to select, so skip this */
unset( $actions[ $key ] );
continue;
}
$disabled = $usedSubActions[ $key ];
}
$formClass = static::actionMultipleChoice( $key ) ? '\IPS\Helpers\Form\CheckboxSet' : '\IPS\Helpers\Form\Select';
$subActionFormElements[] = new $formClass( 'profile_step_subaction_' . $key, $this->subcompletion_act, TRUE, array( 'options' => $subActions[ $key ], 'disabled' => $disabled ), NULL, NULL, NULL, 'profile_step_subaction_' . $key );
$toggles[ $key ][] = 'profile_step_subaction_' . $key;
}
}
foreach( static::canBeRequired() AS $action )
{
$toggles[ $action ][] = 'step_required';
}
$form->add( new \IPS\Helpers\Form\Radio( 'profile_step_completion_act', $this->completion_act, FALSE, array( 'options' => $actions, 'toggles' => $toggles ) ) );
foreach( $subActionFormElements as $element )
{
$form->add( $element );
}
$form->add( new \IPS\Helpers\Form\YesNo( 'profile_step_required', $this->required, FALSE, array(), NULL, NULL, NULL, 'step_required' ) );
}
/**
* Format Form Values
* @param array Values
* @return array
*/
public function formatFormValues( $values )
{
$return = array();
if ( !$this->id )
{
/* Set initial position to the end of the list and save initial data */
try
{
$this->position = \IPS\Db::i()->select( 'MAX(step_position)', 'core_profile_steps' )->first() + 1;
}
catch( \Exception $e )
{
$this->position = 1;
}
$this->save();
}
if ( isset( $values[ 'profile_step_subaction_' . $values['profile_step_completion_act'] ] ) )
{
$values['profile_step_subcompletion_act'] = $values[ 'profile_step_subaction_' . $values['profile_step_completion_act'] ];
unset( $values[ 'profile_step_subaction_' . $values['profile_step_completion_act'] ] );
}
foreach( $values AS $key => $value )
{
$return[ str_replace( 'profile_', '', $key ) ] = $value;
}
try
{
$ext = static::findExtensionFromAction( $return['step_completion_act'] );
$ext = explode( '_', $ext );
$class = "\\IPS\\{$ext[0]}\\extensions\\core\\ProfileSteps\\{$ext[1]}";
$extension = new $class;
}
catch( \OutOfBoundsException $e )
{
throw new \InvalidArgumentException;
}
return $return;
}
/**
* Perform actions after saving the form
*
* @param array $values Values from the form
* @return void
*/
public function postSaveForm( $values )
{
$return = array();
foreach( $values AS $key => $value )
{
$return[ str_replace( 'profile_', '', $key ) ] = $value;
}
if ( array_key_exists( 'step_title', $return ) )
{
if ( is_array( $return['step_title'] ) )
{
foreach( $return['step_title'] AS $lang => $text )
{
if ( empty( $text ) )
{
$return['step_title'][ $lang ] = $this->acpTitle;
}
}
}
else
{
$return['step_title'] = array();
foreach( \IPS\Lang::languages() AS $lang )
{
$return['step_title'][ $lang->_id ] = $this->acpTitle;
}
}
}
else
{
$return['step_title'] = array();
foreach( \IPS\Lang::languages() AS $lang )
{
$return['step_title'][ $lang->_id ] = $this->acpTitle;
}
}
\IPS\Lang::saveCustom( 'core', "profile_step_title_{$this->id}", $return['step_title'] );
\IPS\Lang::saveCustom( 'core', "profile_step_text_{$this->id}", $return['step_text'] );
}
/**
* Find extension key from action key
*
* @param string The action key
* @return string The extension key
* @throws \OutOfBoundsException
*/
public static function findExtensionFromAction( $key )
{
foreach( \IPS\Application::allExtensions( 'core', 'ProfileSteps' ) AS $extkey => $extension )
{
foreach( $extension::actions() AS $action => $lang )
{
if ( $key == $action )
{
return $extkey;
}
}
}
throw new \OutOfBoundsException;
}
/**
* Resync
* Triggered when something happens externally that may affect these fields (such as a field being deleted, etc)
*
* return @void
*/
public static function resync()
{
$iterator = new \IPS\Patterns\ActiveRecordIterator( \IPS\Db::i()->select( '*', 'core_profile_steps' ), '\IPS\Member\ProfileStep' );
foreach( $iterator as $step )
{
$class = $step->extension;
if ( method_exists( $class, 'resync' ) )
{
$class->resync( $step );
}
}
}
/**
* Delete by application
* Deletes all steps tied to an application
*
* @param \IPS\Application $app The application being deleted
* @return void
*/
public static function deleteByApplication( \IPS\Application $app )
{
$iterator = new \IPS\Patterns\ActiveRecordIterator( \IPS\Db::i()->select( '*', 'core_profile_steps' ), '\IPS\Member\ProfileStep' );
foreach( $iterator as $step )
{
list( $application, $extension ) = explode( '_', $step->_data['extension'] );
if ( $application == $app->directory )
{
$step->delete();
}
}
}
/**
* Given an array of wizard steps, reorder them based on AdminCP order
*
* @param array $steps Wizard steps
* @return array
*/
public static function setOrder( $steps )
{
$finalSteps = array();
foreach( array_keys( static::loadAll() ) as $id )
{
if( isset( $steps['profile_step_title_' . $id ] ) )
{
$finalSteps['profile_step_title_' . $id ] = $steps['profile_step_title_' . $id ];
}
}
return $finalSteps;
}
}