nystudio107 / craft-disqus

src/services/DisqusService.php

<?php
/**
 * Disqus plugin for Craft CMS 3.x
 *
 * Integrates the Disqus commenting system into Craft 3 websites, including
 * Single Sign On (SSO) and custom login/logout URLs
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2017 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\disqus\services;

use Craft;
use craft\base\Component;
use craft\helpers\Html;
use craft\helpers\Template;
use craft\web\User;
use craft\web\View;
use nystudio107\disqus\Disqus;
use nystudio107\disqus\models\Settings;
use Twig\Markup;
use yii\base\Exception;
use yii\base\InvalidConfigException;

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   Disqus

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class DisqusService extends Component
{
    // Public Methods
    // =========================================================================

    /**
     * Output the Disqus Tag
     *
     * @param string $disqusIdentifier

Missing parameter comment

     * @param string $disqusTitle

Missing parameter comment

     * @param string $disqusUrl

Missing parameter comment

     * @param string $disqusCategoryId

Missing parameter comment

     * @param string $disqusLanguage

Missing parameter comment

     * @param array $scriptAttributes

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     *
     * @return Markup
     */
    public function outputEmbedTag(
        string $disqusIdentifier = "",
        string $disqusTitle = "",
        string $disqusUrl = "",
        string $disqusCategoryId = "",
        string $disqusLanguage = "",
        array  $scriptAttributes = [],
    ): Markup {
        /** @var Settings $settings */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $settings = Disqus::$plugin->getSettings();

The method getSettings() does not exist on null.

        $disqusShortname = $settings->getDisqusShortName();

        $vars = [
            'disqusShortname' => $disqusShortname,
            'disqusIdentifier' => $disqusIdentifier,
            'disqusTitle' => $disqusTitle,
            'disqusUrl' => $disqusUrl,
            'disqusCategoryId' => $disqusCategoryId,
            'disqusLanguage' => $disqusLanguage,
            'scriptAttributes' => Html::renderTagAttributes($scriptAttributes),
        ];
        $vars = array_merge($vars, $this->getSSOVars());
        $templateName = 'disqusEmbedTag';
        if ($settings->lazyLoadDisqus) {
            $templateName = 'disqusEmbedTagLazy';
        }

        return $this->renderPluginTemplate($templateName, $vars);
    }

    /**
     * Return the number of comments for a particular thread
     *
     * @param string $disqusIdentifier

Missing parameter comment

     *
     * @return int

Tag value for @return tag indented incorrectly; expected 7 spaces but found 1

     * @noinspection PhpComposerExtensionStubsInspection
     */
    public function getCommentsCount(
        string $disqusIdentifier = "",
    ): int {
        /** @var Settings $settings */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $settings = Disqus::$plugin->getSettings();
        if (!empty($settings->getDisqusPublicKey())) {
            $disqusShortname = $settings->getDisqusShortname();
            $apiKey = $settings->getDisqusPublicKey();

            $url = "https://disqus.com/api/3.0/threads/details.json?api_key="
                . $apiKey
                . "&forum=" . $disqusShortname
                . "&thread:ident="
                . $disqusIdentifier;

            $ch = curl_init();
            curl_setopt($ch, CURLOPT_URL, $url);
            curl_setopt($ch, CURLOPT_HEADER, 0);
            curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
            $return = curl_exec($ch);
            curl_close($ch);

            $json = json_decode($return, true);

It seems like $return can also be of type true; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check?

            if ($json !== null && !empty($json["code"]) && $json["code"] == 0) {
                return $json["response"]["posts"];
            } else {
                Craft::error(Craft::t('disqus', print_r($json, true)), __METHOD__);

It seems like print_r($json, true) can also be of type true; however, parameter $message of yii\BaseYii::t() does only seem to accept string, maybe add an additional type check?

                return 0;
            }
        } else {
            Craft::error(Craft::t('disqus', "Public API Key missing"), __METHOD__);

            return 0;
        }
    }

    // Protected Methods
    // =========================================================================

    /**
     * Return the SSO vars
     *
     * @return array
     */
    protected function getSSOVars(): array
    {
        /** @var Settings $settings */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $settings = Disqus::$plugin->getSettings();
        $vars = [
            'useSSO' => false,
            'useCustomLogin' => false,
        ];
        if ($settings->getUseSSO()) {
            $data = [];

            // Set the data array
            /** @var User $user */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

            $user = Craft::$app->getUser();
            $currentUser = $user->getIdentity();
            if ($currentUser) {
                $data['id'] = $currentUser->id;
                if (Craft::$app->getConfig()->getGeneral()->useEmailAsUsername) {
                    $data['username'] = $currentUser->getFullName();

The function craft\elements\User::getFullName() has been deprecated: in 4.0.0. [[fullName]] should be used instead.

                } else {
                    $data['username'] = $currentUser->username;
                }
                $data['email'] = $currentUser->email;
                try {
                    $data['avatar'] = $currentUser->getPhoto()->getUrl();
                } catch (InvalidConfigException $e) {

Consider adding a comment why this CATCH block is empty.

                }
            }

            // Encode the data array and generate the hMac
            $message = base64_encode(json_encode($data));
            $timestamp = time();
            $hMac = $this->disqusHmacSha1(
                $message
                . ' '
                . $timestamp,
                $settings->getDisqusSecretKey()
            );

            // Set the vars for the template
            $vars = array_merge($vars, [

The opening parenthesis of a multi-line function call should be the last content on the line.

                'useSSO' => true,
                'message' => $message,
                'hmac' => $hMac,
                'timestamp' => $timestamp,
                'disqusPublicKey' => $settings->getDisqusPublicKey(),
            ]);

For multi-line function calls, the closing parenthesis should be on a new line.

            // Set the vars for the custom login
            if ($settings->getCustomLogin()) {
                $vars = array_merge($vars, [

The opening parenthesis of a multi-line function call should be the last content on the line.

                    'useCustomLogin' => true,
                    'loginName' => $settings->getLoginName(),
                    'loginButton' => $settings->getLoginButton(),
                    'loginIcon' => $settings->getLoginIcon(),
                    'loginUrl' => $settings->getLoginUrl(),
                    'loginLogoutUrl' => $settings->getLoginLogoutUrl(),
                    'loginWidth' => $settings->getLoginWidth(),
                    'loginHeight' => $settings->getLoginHeight(),
                ]);

For multi-line function calls, the closing parenthesis should be on a new line.

            }
        }

        return $vars;
    }

    /**
     * Render a plugin template
     *
     * @param $templatePath

Missing parameter comment

     * @param $vars

Missing parameter comment

     *
     * @return Markup
     */
    protected function renderPluginTemplate($templatePath, $vars): Markup
    {
        // Stash the old template mode, and set it Control Panel template mode
        $oldMode = Craft::$app->view->getTemplateMode();
        try {
            Craft::$app->view->setTemplateMode(View::TEMPLATE_MODE_CP);
        } catch (Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }

        // Render the template with our vars passed in
        try {
            $htmlText = Craft::$app->view->renderTemplate('disqus/' . $templatePath, $vars);
        } catch (\Exception $e) {
            $htmlText = 'Error rendering template ' . $templatePath . ' -> ' . $e->getMessage();
            Craft::error(Craft::t('disqus', $htmlText), __METHOD__);
        }

        // Restore the old template mode
        try {
            Craft::$app->view->setTemplateMode($oldMode);
        } catch (Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }

        return Template::raw($htmlText);
    }

    /**
     * HMAC->SHA1
     * From:
     * https://github.com/disqus/DISQUS-API-Recipes/blob/master/sso/php/sso.php
     *
     * @param $data

Missing parameter comment

     * @param $key

Missing parameter comment

     *
     * @return string
     */
    protected function disqusHmacSha1($data, $key): string
    {
        $blockSize = 64;
        $hashFunc = 'sha1';
        if (strlen($key) > $blockSize) {
            $key = pack('H*', $hashFunc($key));
        }
        $key = str_pad($key, $blockSize, chr(0x00));
        $iPad = str_repeat(chr(0x36), $blockSize);
        $oPad = str_repeat(chr(0x5c), $blockSize);
        $hMac = pack(
            'H*',
            $hashFunc(
                ($key ^ $oPad) . pack(
                    'H*',
                    $hashFunc(
                        ($key ^ $iPad) . $data
                    )
                )
            )
        );

        return bin2hex($hMac);
    }
}