Version 5.0.0 beta 1

This commit is contained in:
Neo committed 2025-12-19 16:27:35 -08:00
1 parent 25ddeb65d6
commit 15c7beabc5
6736 files changed
+627902 -497943

No files matched your search

@@ -11,28 +11,46 @@
namespace IPS\forums\extensions\core\AchievementAction;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
use IPS\core\Achievements\Actions\AchievementActionAbstract;
use IPS\core\Achievements\Rule;
use IPS\DateTime;
use IPS\Db;
use IPS\forums\Forum;
use IPS\forums\Topic\Post;
use IPS\Helpers\Form\Node;
use IPS\Helpers\Form\Number;
use IPS\Helpers\Form\Select;
use IPS\Http\Url;
use IPS\Member;
use IPS\Theme;
use OutOfRangeException;
use function count;
use function defined;
use function in_array;
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
{
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
exit;
}
/**
* Achievement Action Extension: Answer a member in a Q&A Forum is marked as the best answer
*/
class _AnswerMarkedBest extends \IPS\core\Achievements\Actions\AbstractAchievementAction
class AnswerMarkedBest extends AchievementActionAbstract
{
/**
* Get filter form elements
*
* @param array|NULL $filters Current filter values (if editing)
* @param \IPS\Http\Url $url The URL the form is being shown on
* @param Url $url The URL the form is being shown on
* @return array
*/
public function filters( ?array $filters, \IPS\Http\Url $url ): array
public function filters( ?array $filters, Url $url ): array
{
return [
'nodes' => new \IPS\Helpers\Form\Node( 'achievement_filter_AnswerMarkedBest_forum', ( $filters and isset( $filters['nodes'] ) and $filters['nodes'] ) ? $filters['nodes'] : NULL, FALSE, [
'nodes' => new Node( 'achievement_filter_AnswerMarkedBest_forum', ( $filters and isset( $filters['nodes'] ) and $filters['nodes'] ) ? $filters['nodes'] : NULL, FALSE, [
'url' => $url,
'class' => 'IPS\forums\Forum',
'showAllNodes' => TRUE,
@@ -40,8 +58,14 @@ class _AnswerMarkedBest extends \IPS\core\Achievements\Actions\AbstractAchieveme
'permissionCheck' => function( $forum ) {
return $forum->forums_bitoptions['bw_enable_answers'];
}
], NULL, \IPS\Member::loggedIn()->language()->addToStack('achievement_filter_AnswerMarkedBest_forum_prefix') ),
'milestone' => new \IPS\Helpers\Form\Number( 'achievement_filter_AnswerMarkedBest_nth', ( $filters and isset( $filters['milestone'] ) and $filters['milestone'] ) ? $filters['milestone'] : 0, FALSE, [], NULL, \IPS\Member::loggedIn()->language()->addToStack('achievement_filter_nth_their'), \IPS\Member::loggedIn()->language()->addToStack('achievement_filter_AnswerMarkedBest_nth_suffix') )
], NULL, Member::loggedIn()->language()->addToStack('achievement_filter_AnswerMarkedBest_forum_prefix') ),
'helpful_or_solved' => new Select( 'achievement_filter_AnswerMarkedBest_helpful_or_solved', ( $filters and isset( $filters['helpful_or_solved'] ) and $filters['helpful_or_solved'] ) ? $filters['helpful_or_solved'] : NULL, NULL, [
'options' => [
'helpful' => Member::loggedIn()->language()->addToStack('achievement_filter_AnswerMarkedBest_helpful_or_solved_helpful'),
'solved' => Member::loggedIn()->language()->addToStack('achievement_filter_AnswerMarkedBest_helpful_or_solved_solved')
]
] ),
'milestone' => new Number( 'achievement_filter_AnswerMarkedBest_nth', ( $filters and isset( $filters['milestone'] ) and $filters['milestone'] ) ? $filters['milestone'] : 0, FALSE, [], NULL, Member::loggedIn()->language()->addToStack('achievement_filter_nth_their'), Member::loggedIn()->language()->addToStack('achievement_filter_AnswerMarkedBest_nth_suffix') )
];
}
@@ -62,6 +86,10 @@ class _AnswerMarkedBest extends \IPS\core\Achievements\Actions\AbstractAchieveme
{
$return['milestone'] = $values['achievement_filter_AnswerMarkedBest_nth'];
}
if ( isset( $values['achievement_filter_AnswerMarkedBest_helpful_or_solved'] ) )
{
$return['helpful_or_solved'] = $values['achievement_filter_AnswerMarkedBest_helpful_or_solved'];
}
return $return;
}
@@ -72,14 +100,16 @@ class _AnswerMarkedBest extends \IPS\core\Achievements\Actions\AbstractAchieveme
* calls that BEFORE making its change in the database (or there is read/write separation), you will need to add
* 1 to the value being considered for milestones
*
* @param \IPS\Member $subject The subject member
* @param Member $subject The subject member
* @param array $filters The value returned by formatFilterValues()
* @param mixed $extra Any additional information about what is happening (e.g. if a post is being made: the post object)
* @return bool
*/
public function filtersMatch( \IPS\Member $subject, array $filters, $extra = NULL ): bool
public function filtersMatch( Member $subject, array $filters, mixed $extra = NULL ): bool
{
if ( isset( $filters['nodes'] ) and !\in_array( $extra->container()->_id, $filters['nodes'] ) )
$post = $extra['post'];
$type = $extra['type'] == 'helpful'? 'helpful' :'solved';
if ( isset( $filters['nodes'] ) and !in_array( $post->container()->_id, $filters['nodes'] ) )
{
return FALSE;
}
@@ -87,13 +117,13 @@ class _AnswerMarkedBest extends \IPS\core\Achievements\Actions\AbstractAchieveme
if ( isset( $filters['milestone'] ) )
{
$where = [
[ 'member_id=? AND app=?', $extra->author()->member_id, 'forums' ],
[ 'member_id=? AND app=? AND type=? AND hidden=0', $post->author()->member_id, 'forums', $type ],
];
if ( isset( $filters['nodes'] ) )
{
$where[] = [ \IPS\Db::i()->in( 'forum_id', $filters['nodes'] ) ];
$where[] = [ Db::i()->in( 'forum_id', $filters['nodes'] ) ];
}
$query = \IPS\Db::i()->select( 'COUNT(*)', 'core_solved_index', $where );
$query = Db::i()->select( 'COUNT(*)', 'core_solved_index', $where );
if ( isset( $filters['nodes'] ) )
{
$query->join( 'forums_topics', 'core_solved_index.item_id=forums_topics.tid' );
@@ -129,7 +159,7 @@ class _AnswerMarkedBest extends \IPS\core\Achievements\Actions\AbstractAchieveme
* @param array|NULL $filters Current filter values
* @return array
*/
public function awardOther( $extra = NULL, ?array $filters = NULL ): array
public function awardOther( mixed $extra = NULL, ?array $filters = NULL ): array
{
return [ $extra->item()->author() ];
}
@@ -138,13 +168,16 @@ class _AnswerMarkedBest extends \IPS\core\Achievements\Actions\AbstractAchieveme
* Get identifier to prevent the member being awarded points for the same action twice
* Must be unique within within of this domain, must not exceed 32 chars.
*
* @param \IPS\Member $subject The subject member
* @param Member $subject The subject member
* @param mixed $extra Any additional information about what is happening (e.g. if a post is being made: the post object)
* @return string
*/
public function identifier( \IPS\Member $subject, $extra = NULL ): string
public function identifier( Member $subject, mixed $extra = NULL ): string
{
return (string) $extra->pid;
$post = $extra['post'];
$type = $extra['type'] == 'helpful'? ':helpful' : ''; // Prevent existing rows from becoming obsolete by changing format to 123:solved
return $post->pid . $type;
}
/**
@@ -157,44 +190,57 @@ class _AnswerMarkedBest extends \IPS\core\Achievements\Actions\AbstractAchieveme
public function logRow( string $identifier, array $actor ): string
{
$sprintf = [];
try
if ( stristr( $identifier, ':') )
{
$post = \IPS\forums\Topic\Post::load( $identifier );
$sprintf = [ 'htmlsprintf' => [
\IPS\Theme::i()->getTemplate( 'global', 'core', 'global' )->basicUrl( $post->url(), TRUE, $post->item()->title, FALSE )
] ];
}
catch ( \OutOfRangeException $e )
{
$sprintf = [ 'sprintf' => [ \IPS\Member::loggedIn()->language()->addToStack('AchievementAction__AnswerMarkedBest_log_deleted') ] ];
}
if ( \in_array( 'subject', $actor ) )
{
return \IPS\Member::loggedIn()->language()->addToStack( 'AchievementAction__AnswerMarkedBest_log_subject', FALSE, $sprintf );
[ $identifier, $type ] = explode( ':', $identifier );
}
else
{
return \IPS\Member::loggedIn()->language()->addToStack( 'AchievementAction__AnswerMarkedBest_log_other', FALSE, $sprintf );
$type = 'solved';
}
try
{
$post = Post::load( $identifier );
$sprintf = [ 'htmlsprintf' => [
Theme::i()->getTemplate( 'global', 'core', 'global' )->basicUrl( $post->url(), TRUE, $post->item()->title, FALSE )
] ];
}
catch ( OutOfRangeException $e )
{
$sprintf = [ 'sprintf' => [ Member::loggedIn()->language()->addToStack('AchievementAction__AnswerMarkedBest_log_deleted') ] ];
}
if ( in_array( 'subject', $actor ) )
{
return $type === 'solved'
? Member::loggedIn()->language()->addToStack( 'AchievementAction__AnswerMarkedBest_log_subject', FALSE, $sprintf )
: Member::loggedIn()->language()->addToStack( 'AchievementAction__AnswerMarkedBest_log_subject_helpful', FALSE, $sprintf );
}
else
{
return $type === 'solved'
? Member::loggedIn()->language()->addToStack( 'AchievementAction__AnswerMarkedBest_log_other', FALSE, $sprintf )
: Member::loggedIn()->language()->addToStack( 'AchievementAction__AnswerMarkedBest_log_other_helpful', FALSE, $sprintf );
}
}
/**
* Get "description" for rule
*
* @param \IPS\core\Achievements\Rule $rule The rule
* @param Rule $rule The rule
* @return string|null
*/
public function ruleDescription( \IPS\core\Achievements\Rule $rule ): ?string
public function ruleDescription( Rule $rule ): ?string
{
$conditions = [];
if ( isset( $rule->filters['milestone'] ) )
{
$conditions[] = \IPS\Member::loggedIn()->language()->addToStack( 'achievements_title_filter_milestone', FALSE, [
$conditions[] = Member::loggedIn()->language()->addToStack( 'achievements_title_filter_milestone', FALSE, [
'htmlsprintf' => [
\IPS\Theme::i()->getTemplate( 'achievements' )->ruleDescriptionBadge( 'milestone', \IPS\Member::loggedIn()->language()->addToStack( 'achievements_title_filter_milestone_nth', FALSE, [ 'pluralize' => [ $rule->filters['milestone'] ] ] ) )
Theme::i()->getTemplate( 'achievements' )->ruleDescriptionBadge( 'milestone', Member::loggedIn()->language()->addToStack( 'achievements_title_filter_milestone_nth', FALSE, [ 'pluralize' => [ $rule->filters['milestone'] ] ] ) )
],
'sprintf' => \IPS\Member::loggedIn()->language()->addToStack( 'best_answer_post', FALSE, [ 'strtolower' => TRUE ] )
'sprintf' => Member::loggedIn()->language()->addToStack( 'best_answer_post', FALSE, [ 'strtolower' => TRUE ] )
] );
}
if ( isset( $rule->filters['nodes'] ) )
@@ -204,30 +250,32 @@ class _AnswerMarkedBest extends \IPS\core\Achievements\Actions\AbstractAchieveme
{
try
{
$forumNames[] = \IPS\forums\Forum::load( $id )->_title;
$forumNames[] = Forum::load( $id )->_title;
}
catch ( \OutOfRangeException $e ) {}
catch ( OutOfRangeException $e ) {}
}
if ( $forumNames )
{
$conditions[] = \IPS\Member::loggedIn()->language()->addToStack( 'achievements_title_filter_location', FALSE, [
$conditions[] = Member::loggedIn()->language()->addToStack( 'achievements_title_filter_location', FALSE, [
'htmlsprintf' => [
\IPS\Theme::i()->getTemplate( 'achievements' )->ruleDescriptionBadge( 'location',
\count( $forumNames ) === 1 ? $forumNames[0] : \IPS\Member::loggedIn()->language()->addToStack( 'achievements_title_filter_location_val', FALSE, [ 'sprintf' => [
\count( $forumNames ),
\IPS\Member::loggedIn()->language()->addToStack( \IPS\forum\Forum::$nodeTitle, FALSE, [ 'strtolower' => TRUE ] )
Theme::i()->getTemplate( 'achievements' )->ruleDescriptionBadge( 'location',
count( $forumNames ) === 1 ? $forumNames[0] : Member::loggedIn()->language()->addToStack( 'achievements_title_filter_location_val', FALSE, [ 'sprintf' => [
count( $forumNames ),
Member::loggedIn()->language()->addToStack( Forum::$nodeTitle, FALSE, [ 'strtolower' => TRUE ] )
] ] ),
\count( $forumNames ) === 1 ? NULL : $forumNames
count( $forumNames ) === 1 ? NULL : $forumNames
)
],
] );
}
}
return \IPS\Theme::i()->getTemplate( 'achievements' )->ruleDescription(
\IPS\Member::loggedIn()->language()->addToStack( 'AchievementAction__AnswerMarkedBest_title' ),
$conditions
);
$title = Member::loggedIn()->language()->addToStack( 'AchievementAction__AnswerMarkedBest_title' );
if ( isset( $rule->filters['helpful_or_solved'] ) and $rule->filters['helpful_or_solved'] == 'helpful' )
{
$title = Member::loggedIn()->language()->addToStack( 'AchievementAction__AnswerMarkedHelpful_title' );
}
return Theme::i()->getTemplate( 'achievements' )->ruleDescription( $title, $conditions );
}
/**
@@ -235,13 +283,13 @@ class _AnswerMarkedBest extends \IPS\core\Achievements\Actions\AbstractAchieveme
*
* @return array
*/
static public function rebuildData()
static public function rebuildData(): array
{
return [ [
'table' => 'core_solved_index',
'pkey' => 'id',
'date' => 'solved_date',
'where' => [ [ 'app=?', 'forums' ] ],
'where' => [ [ 'app=? AND type=?', 'forums', 'solved' ] ],
] ];
}
@@ -252,9 +300,9 @@ class _AnswerMarkedBest extends \IPS\core\Achievements\Actions\AbstractAchieveme
* @param array $data Data collected when starting rebuild [table, pkey...]
* @return void
*/
public static function rebuildRow( $row, $data )
public static function rebuildRow( array $row, array $data ) : void
{
$post = \IPS\forums\Topic\Post::load( $row['comment_id'] );
$post->author()->achievementAction( 'forums', 'AnswerMarkedBest', $post, \IPS\DateTime::ts( $row[ $data['date'] ] ) );
$post = Post::load( $row['comment_id'] );
$post->author()->achievementAction( 'forums', 'AnswerMarkedBest', $post, DateTime::ts( $row[ $data['date'] ] ) );
}
}