Helpers for common checks

[kraftner]

There are plenty of places where things like "Does the user have an avatar set?" or "Is this upload on/from the profile page?" are checked. Currently a lot of these checks are just C&P. Maybe it is worth having some central helper that does this in a reusable way.

[franz-josef-kaiser]

Added to the Backlog until we have a definitive list.

[franz-josef-kaiser]

There might be some class:

class AvatarMeta {

    const HAS_AVATAR = 1;
    const NO_AVATAR = 2;

    private $key;

    /** @type string $key */
    public function __construct( $key ) {
        $this->key = $key;
    }

    public function getKey() {
        return $this->key;
    }

    /** @type int $userID */
    public function hasAvatar( $userID ) {
        $meta = get_user_meta( $userID, $this->key, true );
        return empty( $meta )
            ? self::HAS_AVATAR
            : self::NO_AVATAR;
    }
}

This would allow for repetitive checks against the constant:

$meta = new AvatarMeta( apply_filters( 'wcm.avatar.meta_key', 'user_avatar' ) );
foreach ( $users as $user ) {
    var_dump( $meta->hasAvatar( $user->ID ) === AvatarMeta::HAS_AVATAR );
}

This would also remove the necessity of putting the key into the AvatarExistsLimitService.php. We still would need at least another use case and a clean up before taking this on.

[kraftner]

Okay let's start with a list of things that are being checked again and again all over the place that would be worth having in a unified way:

Are we on a profile page or doing something initiated from there? (either the users own one or from someone else)

Some of these checks directly ask WP (e.g. using get_current_screen()->base but some rely on data that can't be trusted like from $_POST so be careful to properly handle those different cases.

• wcm-avatar/src/Services/AdminStylesService.php

  Lines 55 to 58 in 4182c2c

  	return in_array( $screen, [
  	'profile.php',
  	'user-edit.php',
  	] );

• wcm-avatar/src/Services/AvatarScriptsService.php

  Lines 52 to 55 in 4182c2c

  	if ( ! in_array( $screen, [
  	'profile.php',
  	'user-edit.php',
  	] ) )

• wcm-avatar/src/Views/UploadView.php

  Lines 60 to 65 in 4182c2c

  	( defined( 'IS_PROFILE_PAGE' ) && ! IS_PROFILE_PAGE )
  	&& ! current_user_can( 'edit_users' )
  	)
  	or ! in_array( get_current_screen()->base, [
  	'profile',
  	'user-edit',

• PR: Fix check for User-ID on profile page #32 or currently

  wcm-avatar/src/Services/AvatarAddMetaService.php

  Lines 43 to 62 in 4182c2c

  	if (
  	// "Multi-File Uploader"
  	(
  	isset( $_REQUEST['user_id'] )
  	and isset( $_REQUEST['screen_id'] )
  	and in_array( $_REQUEST['screen_id'], [
  	'profile',
  	'user-edit',
  	] )
  	)
  	// "Browser Uploader"
  	or (
  	isset( $_REQUEST['html-upload'] )
  	and 'Upload' === $_POST['html-upload']
  	and in_array( get_current_screen()->base, [
  	'profile',
  	'user-edit',
  	] )
  	and isset( $_REQUEST['user_id'] )
  	)

• wcm-avatar/src/Services/AvatarDimensionLimitService.php

  Lines 28 to 33 in 4182c2c

  	// do not affect other screens
  	$screen = filter_input( INPUT_POST, 'screen_id', FILTER_SANITIZE_STRING );
  	if ( ! in_array( $screen, [ 'profile', 'user-edit' ], TRUE ) )
  	{
  	return $file;
  	}

• wcm-avatar/src/Services/AvatarExistsLimitService.php

  Lines 28 to 32 in 4182c2c

  	$screen = filter_input( INPUT_POST, 'screen_id', FILTER_SANITIZE_STRING );
  	if ( ! in_array( $screen, [ 'profile', 'user-edit' ], TRUE ) )
  	{
  	return $file;
  	}

• wcm-avatar/src/Services/AvatarRegisterMetaService.php

  Lines 44 to 49 in 4182c2c

  	$screen = get_current_screen()->id;
  	if ( in_array( $screen, [ 'profile', 'user-edit', ], true ) ) {
  	$user_id = $screen === 'profile'
  	? get_current_user_id()
  	: $GLOBALS['user_id'];

• wcm-avatar/Bootstrap.php

  Line 67 in 4182c2c

  foreach ( [ 'load-profile.php', 'load-user-edit.php', ] as $filter )

Is this profile from the current user or some other?

• wcm-avatar/src/Views/UploadView.php

  Line 134 in 4182c2c

  IS_PROFILE_PAGE ? 'profile' : 'user-edit',

• wcm-avatar/src/Templates/AvatarUploadTemplate.php

  Line 133 in 4182c2c

  $action = admin_url( IS_PROFILE_PAGE ? 'profile.php' : 'user-edit.php' );

Has a user a custom avatar set?

• wcm-avatar/src/Services/AvatarExistsLimitService.php

  Lines 49 to 59 in 4182c2c

  	/**
  	* @param int $user_id
  	*
  	* @return bool
  	*/
  	protected function userHasAvatar( $user_id ){
  	$meta = ! get_user_meta( $user_id, $this->key, true );
  	return empty( $meta );
  	}

• wcm-avatar/src/Services/AvatarReplacementService.php

  Lines 52 to 59 in 4182c2c

  	$att_id = get_user_meta(
  	$user->ID,
  	$this->key,
  	TRUE
  	);
  	if ( ! $att_id )
  	return '';

• wcm-avatar/src/Templates/AvatarUploadTemplate.php

  Lines 46 to 53 in 4182c2c

  	$att_id = get_user_meta( $user_id, $this->key, TRUE );
  	FALSE !== $att_id
  	and $att_id = absint( $att_id );
  	$hidden = (
  	is_int( $att_id )
  	and 0 !== $att_id
  	)

[kraftner]

Okay now that I've found #59, #60 and #64 it has become more and more obvious that we need some central way to check all those things. Way to much duplication happening already and to fix those bugs it would become even worse.