ForumRole - Code Metrics - silverstripe/silverstripe-forum - Measure and Improve Code Quality continuously with Scrutinizer

ForumRole F
last analyzed 2017-05-09 23:47 UTC

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	408
Duplicated Lines	0 %
Coupling/Cohesion

Components	1
Dependencies	25
Importance

Changes
Metric	Value
wmc	62
lcom	1
cbo	25
dl	0
loc	408
rs	1.3043
c	0
b	0
f	0
25 Methods

Rating	Name	Size	Complexity
A	augmentSQL()	3	1
A	augmentDatabase()	21	3
A	onBeforeDelete()	9	3
A	ForumRank()	9	3
A	FirstNamePublic()	4	2
A	SurnamePublic()	4	2
A	OccupationPublic()	4	2
A	CompanyPublic()	4	2
A	CityPublic()	4	2
A	CountryPublic()	4	2
A	EmailPublic()	4	2
A	FullCountry()	6	1
A	NumPosts()	8	2
A	isModeratingForum()	5	2
A	Link()	4	1
B	getForumFields()	63	5
A	getForumValidator()	11	2
A	updateCMSFields()	20	3
A	IsSuspended()	8	2
A	IsBanned()	4	1
A	IsGhost()	4	2
A	canEdit()	16	4
A	Nickname()	10	4
C	getFormattedAvatar()	39	7
A	ForumSuspensionMessage()	13	2
How to fix Complexity

<?php
/**
 * ForumRole
 *
 * This decorator adds the needed fields and methods to the {@link Member}
 * object.
 *
 * @package forum
 */
class ForumRole extends DataExtension
{

    /**
     * Edit the given query object to support queries for this extension
     */
    public function augmentSQL(SQLQuery &$query)
    {
    }


    /**
     * Update the database schema as required by this extension
     */
    public function augmentDatabase()
    {
        $exist = DB::tableList();

        if (!empty($exist) && array_search('ForumMember', $exist) !== false) {
            DB::query("UPDATE \"Member\", \"ForumMember\" " .
                "SET \"Member\".\"ClassName\" = 'Member'," .
                "\"Member\".\"ForumRank\" = \"ForumMember\".\"ForumRank\"," .
                "\"Member\".\"Occupation\" = \"ForumMember\".\"Occupation\"," .
                "\"Member\".\"Country\" = \"ForumMember\".\"Country\"," .
                "\"Member\".\"Nickname\" = \"ForumMember\".\"Nickname\"," .
                "\"Member\".\"FirstNamePublic\" = \"ForumMember\".\"FirstNamePublic\"," .
                "\"Member\".\"SurnamePublic\" = \"ForumMember\".\"SurnamePublic\"," .
                "\"Member\".\"OccupationPublic\" = \"ForumMember\".\"OccupationPublic\"," .
                "\"Member\".\"CountryPublic\" = \"ForumMember\".\"CountryPublic\"," .
                "\"Member\".\"EmailPublic\" = \"ForumMember\".\"EmailPublic\"," .
                "\"Member\".\"AvatarID\" = \"ForumMember\".\"AvatarID\"," .
                "\"Member\".\"LastViewed\" = \"ForumMember\".\"LastViewed\"" .
                "WHERE \"Member\".\"ID\" = \"ForumMember\".\"ID\"");
            echo("<div style=\"padding:5px; color:white; background-color:blue;\">" . _t('ForumRole.TRANSFERSUCCEEDED', 'The data transfer has succeeded. However, to complete it, you must delete the ForumMember table. To do this, execute the query \"DROP TABLE \'ForumMember\'\".') . "</div>" );
        }
    }

    private static $db =  array(
        'ForumRank' => 'Varchar',
        'Occupation' => 'Varchar',
        'Company' => 'Varchar',
        'City' => 'Varchar',
        'Country' => 'Varchar',
        'Nickname' => 'Varchar',
        'FirstNamePublic' => 'Boolean',
        'SurnamePublic' => 'Boolean',
        'OccupationPublic' => 'Boolean',
        'CompanyPublic' => 'Boolean',
        'CityPublic' => 'Boolean',
        'CountryPublic' => 'Boolean',
        'EmailPublic' => 'Boolean',
        'LastViewed' => 'SS_Datetime',
        'Signature' => 'Text',
        'ForumStatus' => 'Enum("Normal, Banned, Ghost", "Normal")',
        'SuspendedUntil' => 'Date'
    );

    private static $has_one = array(
        'Avatar' => 'Image'
    );

    private static $has_many = array(
        'ForumPosts' => 'Post'
    );

    private static $belongs_many_many = array(
        'ModeratedForums' => 'Forum'
    );

    private static $defaults = array(
        'ForumRank' => 'Community Member'
    );

    private static $searchable_fields = array(
        'Nickname' => true
    );

    private static $indexes = array(
        'Nickname' => true
    );

    private static $field_labels = array(
        'SuspendedUntil' => "Suspend this member from writing on forums until the specified date"
    );

    public function onBeforeDelete()
    {
        parent::onBeforeDelete();

        $avatar = $this->owner->Avatar();
        if ($avatar && $avatar->exists()) {
            $avatar->delete();
        }
    }

    public function ForumRank()
    {
        $moderatedForums = $this->owner->ModeratedForums();
        if ($moderatedForums && $moderatedForums->Count() > 0) {
            return _t('MODERATOR', 'Forum Moderator');
        } else {
            return $this->owner->getField('ForumRank');
        }
    }

    public function FirstNamePublic()
    {
        return $this->owner->FirstNamePublic || Permission::check('ADMIN');
    }
    public function SurnamePublic()
    {
        return $this->owner->SurnamePublic || Permission::check('ADMIN');
    }
    public function OccupationPublic()
    {
        return $this->owner->OccupationPublic || Permission::check('ADMIN');
    }
    public function CompanyPublic()
    {
        return $this->owner->CompanyPublic || Permission::check('ADMIN');
    }
    public function CityPublic()
    {
        return $this->owner->CityPublic || Permission::check('ADMIN');
    }
    public function CountryPublic()
    {
        return $this->owner->CountryPublic || Permission::check('ADMIN');
    }
    public function EmailPublic()
    {
        return $this->owner->EmailPublic || Permission::check('ADMIN');
    }
    /**
     * Run the Country code through a converter to get the proper Country Name
     */
    public function FullCountry()
    {
        $locale = new Zend_Locale();
        $locale->setLocale($this->owner->Country);
        return $locale->getRegion();
    }
    public function NumPosts()
    {
        if (is_numeric($this->owner->ID)) {
            return $this->owner->ForumPosts()->Count();
        } else {
            return 0;
        }
    }

    /**
     * Checks if the current user is a moderator of the
     * given forum by looking in the moderator ID list.
     *
     * @param Forum object to check
     * @return boolean
     */
    public function isModeratingForum($forum)
    {
        $moderatorIds = $forum->Moderators() ? $forum->Moderators()->getIdList() : array();
        return in_array($this->owner->ID, $moderatorIds);
    }

    public function Link()
    {
        return "ForumMemberProfile/show/" . $this->owner->ID;
    }


    /**
     * Get the fields needed by the forum module
     *
     * @param bool $showIdentityURL Should a field for an OpenID or an i-name
     *                              be shown (always read-only)?
     * @return FieldList Returns a FieldList containing all needed fields for
     *                  the registration of new users
     */
    public function getForumFields($showIdentityURL = false, $addmode = false)
    {
        $gravatarText = (DataObject::get_one("ForumHolder", "\"AllowGravatars\" = 1")) ? '<small>'. _t('ForumRole.CANGRAVATAR', 'If you use Gravatars then leave this blank') .'</small>' : "";

        //Sets the upload folder to the Configurable one set via the ForumHolder or overridden via Config::inst()->update().
        $avatarField = new FileField('Avatar', _t('ForumRole.AVATAR', 'Avatar Image') .' '. $gravatarText);
        $avatarField->setFolderName(Config::inst()->get('ForumHolder', 'avatars_folder'));
        $avatarField->getValidator()->setAllowedExtensions(array('jpg', 'jpeg', 'gif', 'png'));

        $personalDetailsFields = new CompositeField(
            new HeaderField("PersonalDetails", _t('ForumRole.PERSONAL', 'Personal Details')),
            new LiteralField("Blurb", "<p id=\"helpful\">" . _t('ForumRole.TICK', 'Tick the fields to show in public profile') . "</p>"),
            new TextField("Nickname", _t('ForumRole.NICKNAME', 'Nickname')),
            new CheckableOption("FirstNamePublic", new TextField("FirstName", _t('ForumRole.FIRSTNAME', 'First name'))),
            new CheckableOption("SurnamePublic", new TextField("Surname", _t('ForumRole.SURNAME', 'Surname'))),
            new CheckableOption("OccupationPublic", new TextField("Occupation", _t('ForumRole.OCCUPATION', 'Occupation')), true),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            new CheckableOption('CompanyPublic', new TextField('Company', _t('ForumRole.COMPANY', 'Company')), true),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            new CheckableOption('CityPublic', new TextField('City', _t('ForumRole.CITY', 'City')), true),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            new CheckableOption("CountryPublic", new ForumCountryDropdownField("Country", _t('ForumRole.COUNTRY', 'Country')), true),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            new CheckableOption("EmailPublic", new EmailField("Email", _t('ForumRole.EMAIL', 'Email'))),
            new ConfirmedPasswordField("Password", _t('ForumRole.PASSWORD', 'Password')),
            $avatarField
        );
        // Don't show 'forum rank' at registration
        if (!$addmode) {
            $personalDetailsFields->push(
                new ReadonlyField("ForumRank", _t('ForumRole.RATING', 'User rating'))
            );
        }
        $personalDetailsFields->setID('PersonalDetailsFields');

        $fieldset = new FieldList(
            $personalDetailsFields
        );

        if ($showIdentityURL) {
            $fieldset->insertBefore(
                new ReadonlyField('IdentityURL', _t('ForumRole.OPENIDINAME', 'OpenID/i-name')),
                'Password'
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            );
            $fieldset->insertAfter(
                new LiteralField(
                    'PasswordOptionalMessage',
                    '<p>' . _t('ForumRole.PASSOPTMESSAGE', 'Since you provided an OpenID respectively an i-name the password is optional. If you enter one, you will be able to log in also with your e-mail address.') . '</p>'
                ),
                'IdentityURL'
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            );
        }

        if ($this->owner->IsSuspended()) {
            $fieldset->insertAfter(
                new LiteralField(
                    'SuspensionNote',
                    '<p class="message warning suspensionWarning">' . $this->ForumSuspensionMessage() . '</p>'
                ),
                'Blurb'
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            );
        }

        $this->owner->extend('updateForumFields', $fieldset);

        return $fieldset;
    }

    /**
     * Get the fields needed by the forum module
     *
     * @param bool $needPassword Should a password be required?
     * @return Validator Returns a Validator for the fields required for the
     *                              registration of new users
     */
    public function getForumValidator($needPassword = true)
    {
        if ($needPassword) {
            $validator = new RequiredFields("Nickname", "Email", "Password");
        } else {
            $validator = new RequiredFields("Nickname", "Email");
        }
        $this->owner->extend('updateForumValidator', $validator);

        return $validator;
    }

    public function updateCMSFields(FieldList $fields)
    {
        $allForums = DataObject::get('Forum');
        $fields->removeByName('ModeratedForums');
        $fields->addFieldToTab('Root.ModeratedForums', new CheckboxSetField('ModeratedForums', _t('ForumRole.MODERATEDFORUMS', 'Moderated forums'), ($allForums->exists() ? $allForums->map('ID', 'Title') : array())));
        $suspend = $fields->dataFieldByName('SuspendedUntil');
        $suspend->setConfig('showcalendar', true);

        if (Permission::checkMember($this->owner->ID, "ACCESS_FORUM")) {
            $avatarField = new FileField('Avatar', _t('ForumRole.UPLOADAVATAR', 'Upload avatar'));
            $avatarField->getValidator()->setAllowedExtensions(array('jpg', 'jpeg', 'gif', 'png'));

            $fields->addFieldToTab('Root.Forum', $avatarField);
            $fields->addFieldToTab('Root.Forum', new DropdownField("ForumRank", _t('ForumRole.FORUMRANK', "User rating"), array(
                "Community Member" => _t('ForumRole.COMMEMBER'),
                "Administrator" => _t('ForumRole.ADMIN', 'Administrator'),
                "Moderator" => _t('ForumRole.MOD', 'Moderator')
            )));
            $fields->addFieldToTab('Root.Forum', $this->owner->dbObject('ForumStatus')->scaffoldFormField());
        }
    }

    public function IsSuspended()
    {
        if ($this->owner->SuspendedUntil) {
            return strtotime(SS_Datetime::now()->Format('Y-m-d')) < strtotime($this->owner->SuspendedUntil);
        } else {
            return false;
        }
    }

    public function IsBanned()
    {
        return $this->owner->ForumStatus == 'Banned';
    }

    public function IsGhost()
    {
        return $this->owner->ForumStatus == 'Ghost' && $this->owner->ID !== Member::currentUserID();
    }

    /**
     * Can the current user edit the given member?
     *
     * @return true if this member can be edited, false otherwise
     */
    public function canEdit($member = null)
    {
        if (!$member) {
            $member = Member::currentUser();
        }

        if ($this->owner->ID == Member::currentUserID()) {
            return true;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        if ($member) {
            return $member->can('AdminCMS');
        }

        return false;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }


    /**
     * Used in preference to the Nickname field on templates
     *
     * Provides a default for the nickname field (first name, or "Anonymous
     * User" if that's not set)
     */
    public function Nickname()
    {
        if ($this->owner->Nickname) {
            return $this->owner->Nickname;
        } elseif ($this->owner->FirstNamePublic && $this->owner->FirstName) {
            return $this->owner->FirstName;
        } else {
            return _t('ForumRole.ANONYMOUS', 'Anonymous user');
        }
    }

    /**
     * Return the url of the avatar or gravatar of the selected user.
     * Checks to see if the current user has an avatar, if they do use it
     * otherwise query gravatar.com
     *
     * @return String
     */
    public function getFormattedAvatar()
    {
        $default = "forum/images/forummember_holder.gif";
        $currentTheme = Config::inst()->get('SSViewer', 'theme');

        if (file_exists('themes/' . $currentTheme . '_forum/images/forummember_holder.gif')) {
            $default = 'themes/' . $currentTheme . '_forum/images/forummember_holder.gif';
        }
        // if they have uploaded an image
        if ($this->owner->AvatarID) {
            $avatar = Image::get()->byID($this->owner->AvatarID);
            if (!$avatar) {
                return $default;
            }

            $resizedAvatar = $avatar->SetWidth(80);
            if (!$resizedAvatar) {
                return $default;
            }

            return $resizedAvatar->URL;
        }

        //If Gravatar is enabled, allow the selection of the type of default Gravatar.
        if ($holder = ForumHolder::get()->filter('AllowGravatars', 1)->first()) {
            // If the GravatarType is one of the special types, then set it otherwise use the
            //default image from above forummember_holder.gif
            if ($holder->GravatarType) {
                $default = $holder->GravatarType;
            } else {
                // we need to get the absolute path for the default forum image
                return $default;
            }
            // ok. no image but can we find a gravatar. Will return the default image as defined above if not.
            return "http://www.gravatar.com/avatar/".md5($this->owner->Email)."?default=".urlencode($default)."&amp;size=80";
        }

        return $default;
    }

    /**
     * Conditionally includes admin email address (hence we can't simply generate this
     * message in templates). We don't need to spam protect the email address as
     * the note only shows to logged-in users.
     *
     * @return String
     */
    public function ForumSuspensionMessage()
    {
        $msg = _t('ForumRole.SUSPENSIONNOTE', 'This forum account has been suspended.');
        $adminEmail = Config::inst()->get('Email', 'admin_email');

        if ($adminEmail) {
            $msg .= ' ' . sprintf(
                _t('ForumRole.SUSPENSIONEMAILNOTE', 'Please contact %s to resolve this issue.'),
                $adminEmail
            );
        }
        return $msg;
    }
}



/**
 * ForumRole_Validator
 *
 * This class is used to validate the new fields added by the
 * {@link ForumRole} decorator in the CMS backend.
 */
class ForumRole_Validator extends Extension
{

    /**
     * Client-side validation code
     *
     * @param string $js The javascript validation code
     * @return string Returns the needed javascript code for client-side
     *                validation.
     */
    public function updateJavascript(&$js, &$form)
    {

        $formID = $form->FormName();
        $passwordFieldName = $form->dataFieldByName('Password')->id();

        $passwordConfirmField = $form->dataFieldByName('ConfirmPassword');
        if (!$passwordConfirmField) {
            return;
        }

        $passwordConfirmFieldName = $passwordConfirmField->id();

        $passwordcheck = <<<JS
Behaviour.register({
	"#$formID": {
		validatePasswordConfirmation: function() {
			var passEl = _CURRENT_FORM.elements['Password'];
			var confEl = _CURRENT_FORM.elements['ConfirmPassword'];

			if(passEl.value == confEl.value) {
			  clearErrorMessage(confEl.parentNode);
				return true;
			} else {
				validationError(confEl, "Passwords don't match.", "error");
				return false;
			}
		},
		initialize: function() {
			var passEl = $('$passwordFieldName');
			var confEl = $('$passwordConfirmFieldName');

			confEl.value = passEl.value;
		}
	}
});
JS;
        Requirements::customScript(
            $passwordcheck,
            'func_validatePasswordConfirmation'
        );

        $js .= "\$('$formID').validatePasswordConfirmation();";
        return $js;
    }
}

silverstripe / silverstripe-forum

ForumRole F last analyzed 2017-05-09 23:47 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

25 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like

ForumRole F
last analyzed 2017-05-09 23:47 UTC
